1 //===- NamedStreamMap.cpp - PDB Named Stream Map --------------------------===//
2 //
3 // The LLVM Compiler Infrastructure
4 //
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
7 //
8 //===----------------------------------------------------------------------===//
9
10 #include "llvm/DebugInfo/PDB/Native/NamedStreamMap.h"
11 #include "llvm/ADT/StringMap.h"
12 #include "llvm/ADT/StringRef.h"
13 #include "llvm/ADT/iterator_range.h"
14 #include "llvm/DebugInfo/PDB/Native/Hash.h"
15 #include "llvm/DebugInfo/PDB/Native/HashTable.h"
16 #include "llvm/DebugInfo/PDB/Native/RawError.h"
17 #include "llvm/Support/BinaryStreamReader.h"
18 #include "llvm/Support/BinaryStreamRef.h"
19 #include "llvm/Support/BinaryStreamWriter.h"
20 #include "llvm/Support/Endian.h"
21 #include "llvm/Support/Error.h"
22 #include <algorithm>
23 #include <cassert>
24 #include <cstdint>
25 #include <tuple>
26
27 using namespace llvm;
28 using namespace llvm::pdb;
29
NamedStreamMapTraits(NamedStreamMap & NS)30 NamedStreamMapTraits::NamedStreamMapTraits(NamedStreamMap &NS) : NS(&NS) {}
31
hashLookupKey(StringRef S) const32 uint16_t NamedStreamMapTraits::hashLookupKey(StringRef S) const {
33 // In the reference implementation, this uses
34 // HASH Hasher<ULONG*, USHORT*>::hashPbCb(PB pb, size_t cb, ULONG ulMod).
35 // Here, the type HASH is a typedef of unsigned short.
36 // ** It is not a bug that we truncate the result of hashStringV1, in fact
37 // it is a bug if we do not! **
38 return static_cast<uint16_t>(hashStringV1(S));
39 }
40
storageKeyToLookupKey(uint32_t Offset) const41 StringRef NamedStreamMapTraits::storageKeyToLookupKey(uint32_t Offset) const {
42 return NS->getString(Offset);
43 }
44
lookupKeyToStorageKey(StringRef S)45 uint32_t NamedStreamMapTraits::lookupKeyToStorageKey(StringRef S) {
46 return NS->appendStringData(S);
47 }
48
NamedStreamMap()49 NamedStreamMap::NamedStreamMap()
50 : HashTraits(*this), OffsetIndexMap(1, HashTraits) {}
51
load(BinaryStreamReader & Stream)52 Error NamedStreamMap::load(BinaryStreamReader &Stream) {
53 uint32_t StringBufferSize;
54 if (auto EC = Stream.readInteger(StringBufferSize))
55 return joinErrors(std::move(EC),
56 make_error<RawError>(raw_error_code::corrupt_file,
57 "Expected string buffer size"));
58
59 StringRef Buffer;
60 if (auto EC = Stream.readFixedString(Buffer, StringBufferSize))
61 return EC;
62 NamesBuffer.assign(Buffer.begin(), Buffer.end());
63
64 return OffsetIndexMap.load(Stream);
65 }
66
commit(BinaryStreamWriter & Writer) const67 Error NamedStreamMap::commit(BinaryStreamWriter &Writer) const {
68 // The first field is the number of bytes of string data.
69 if (auto EC = Writer.writeInteger<uint32_t>(NamesBuffer.size()))
70 return EC;
71
72 // Then the actual string data.
73 StringRef Data(NamesBuffer.data(), NamesBuffer.size());
74 if (auto EC = Writer.writeFixedString(Data))
75 return EC;
76
77 // And finally the Offset Index map.
78 if (auto EC = OffsetIndexMap.commit(Writer))
79 return EC;
80
81 return Error::success();
82 }
83
calculateSerializedLength() const84 uint32_t NamedStreamMap::calculateSerializedLength() const {
85 return sizeof(uint32_t) // String data size
86 + NamesBuffer.size() // String data
87 + OffsetIndexMap.calculateSerializedLength(); // Offset Index Map
88 }
89
size() const90 uint32_t NamedStreamMap::size() const { return OffsetIndexMap.size(); }
91
getString(uint32_t Offset) const92 StringRef NamedStreamMap::getString(uint32_t Offset) const {
93 assert(NamesBuffer.size() > Offset);
94 return StringRef(NamesBuffer.data() + Offset);
95 }
96
hashString(uint32_t Offset) const97 uint32_t NamedStreamMap::hashString(uint32_t Offset) const {
98 return hashStringV1(getString(Offset));
99 }
100
get(StringRef Stream,uint32_t & StreamNo) const101 bool NamedStreamMap::get(StringRef Stream, uint32_t &StreamNo) const {
102 auto Iter = OffsetIndexMap.find_as(Stream);
103 if (Iter == OffsetIndexMap.end())
104 return false;
105 StreamNo = (*Iter).second;
106 return true;
107 }
108
entries() const109 StringMap<uint32_t> NamedStreamMap::entries() const {
110 StringMap<uint32_t> Result;
111 for (const auto &Entry : OffsetIndexMap) {
112 StringRef Stream(NamesBuffer.data() + Entry.first);
113 Result.try_emplace(Stream, Entry.second);
114 }
115 return Result;
116 }
117
appendStringData(StringRef S)118 uint32_t NamedStreamMap::appendStringData(StringRef S) {
119 uint32_t Offset = NamesBuffer.size();
120 NamesBuffer.insert(NamesBuffer.end(), S.begin(), S.end());
121 NamesBuffer.push_back('\0');
122 return Offset;
123 }
124
set(StringRef Stream,uint32_t StreamNo)125 void NamedStreamMap::set(StringRef Stream, uint32_t StreamNo) {
126 OffsetIndexMap.set_as(Stream, support::ulittle32_t(StreamNo));
127 }
128