1 //===- PDBFileBuilder.cpp - PDB File Creation -------------------*- C++ -*-===//
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/PDBFileBuilder.h"
11
12 #include "llvm/ADT/BitVector.h"
13
14 #include "llvm/DebugInfo/MSF/MSFBuilder.h"
15 #include "llvm/DebugInfo/PDB/GenericError.h"
16 #include "llvm/DebugInfo/PDB/Native/DbiStream.h"
17 #include "llvm/DebugInfo/PDB/Native/DbiStreamBuilder.h"
18 #include "llvm/DebugInfo/PDB/Native/GSIStreamBuilder.h"
19 #include "llvm/DebugInfo/PDB/Native/InfoStream.h"
20 #include "llvm/DebugInfo/PDB/Native/InfoStreamBuilder.h"
21 #include "llvm/DebugInfo/PDB/Native/PDBStringTableBuilder.h"
22 #include "llvm/DebugInfo/PDB/Native/RawError.h"
23 #include "llvm/DebugInfo/PDB/Native/TpiStream.h"
24 #include "llvm/DebugInfo/PDB/Native/TpiStreamBuilder.h"
25 #include "llvm/Support/BinaryStream.h"
26 #include "llvm/Support/BinaryStreamWriter.h"
27 #include "llvm/Support/JamCRC.h"
28 #include "llvm/Support/Path.h"
29
30 using namespace llvm;
31 using namespace llvm::codeview;
32 using namespace llvm::msf;
33 using namespace llvm::pdb;
34 using namespace llvm::support;
35
PDBFileBuilder(BumpPtrAllocator & Allocator)36 PDBFileBuilder::PDBFileBuilder(BumpPtrAllocator &Allocator)
37 : Allocator(Allocator), InjectedSourceHashTraits(Strings),
38 InjectedSourceTable(2, InjectedSourceHashTraits) {}
39
~PDBFileBuilder()40 PDBFileBuilder::~PDBFileBuilder() {}
41
initialize(uint32_t BlockSize)42 Error PDBFileBuilder::initialize(uint32_t BlockSize) {
43 auto ExpectedMsf = MSFBuilder::create(Allocator, BlockSize);
44 if (!ExpectedMsf)
45 return ExpectedMsf.takeError();
46 Msf = llvm::make_unique<MSFBuilder>(std::move(*ExpectedMsf));
47 return Error::success();
48 }
49
getMsfBuilder()50 MSFBuilder &PDBFileBuilder::getMsfBuilder() { return *Msf; }
51
getInfoBuilder()52 InfoStreamBuilder &PDBFileBuilder::getInfoBuilder() {
53 if (!Info)
54 Info = llvm::make_unique<InfoStreamBuilder>(*Msf, NamedStreams);
55 return *Info;
56 }
57
getDbiBuilder()58 DbiStreamBuilder &PDBFileBuilder::getDbiBuilder() {
59 if (!Dbi)
60 Dbi = llvm::make_unique<DbiStreamBuilder>(*Msf);
61 return *Dbi;
62 }
63
getTpiBuilder()64 TpiStreamBuilder &PDBFileBuilder::getTpiBuilder() {
65 if (!Tpi)
66 Tpi = llvm::make_unique<TpiStreamBuilder>(*Msf, StreamTPI);
67 return *Tpi;
68 }
69
getIpiBuilder()70 TpiStreamBuilder &PDBFileBuilder::getIpiBuilder() {
71 if (!Ipi)
72 Ipi = llvm::make_unique<TpiStreamBuilder>(*Msf, StreamIPI);
73 return *Ipi;
74 }
75
getStringTableBuilder()76 PDBStringTableBuilder &PDBFileBuilder::getStringTableBuilder() {
77 return Strings;
78 }
79
getGsiBuilder()80 GSIStreamBuilder &PDBFileBuilder::getGsiBuilder() {
81 if (!Gsi)
82 Gsi = llvm::make_unique<GSIStreamBuilder>(*Msf);
83 return *Gsi;
84 }
85
allocateNamedStream(StringRef Name,uint32_t Size)86 Expected<uint32_t> PDBFileBuilder::allocateNamedStream(StringRef Name,
87 uint32_t Size) {
88 auto ExpectedStream = Msf->addStream(Size);
89 if (ExpectedStream)
90 NamedStreams.set(Name, *ExpectedStream);
91 return ExpectedStream;
92 }
93
addNamedStream(StringRef Name,StringRef Data)94 Error PDBFileBuilder::addNamedStream(StringRef Name, StringRef Data) {
95 Expected<uint32_t> ExpectedIndex = allocateNamedStream(Name, Data.size());
96 if (!ExpectedIndex)
97 return ExpectedIndex.takeError();
98 assert(NamedStreamData.count(*ExpectedIndex) == 0);
99 NamedStreamData[*ExpectedIndex] = Data;
100 return Error::success();
101 }
102
addInjectedSource(StringRef Name,std::unique_ptr<MemoryBuffer> Buffer)103 void PDBFileBuilder::addInjectedSource(StringRef Name,
104 std::unique_ptr<MemoryBuffer> Buffer) {
105 // Stream names must be exact matches, since they get looked up in a hash
106 // table and the hash value is dependent on the exact contents of the string.
107 // link.exe lowercases a path and converts / to \, so we must do the same.
108 SmallString<64> VName;
109 sys::path::native(Name.lower(), VName);
110
111 uint32_t NI = getStringTableBuilder().insert(Name);
112 uint32_t VNI = getStringTableBuilder().insert(VName);
113
114 InjectedSourceDescriptor Desc;
115 Desc.Content = std::move(Buffer);
116 Desc.NameIndex = NI;
117 Desc.VNameIndex = VNI;
118 Desc.StreamName = "/src/files/";
119
120 Desc.StreamName += VName;
121
122 InjectedSources.push_back(std::move(Desc));
123 }
124
finalizeMsfLayout()125 Error PDBFileBuilder::finalizeMsfLayout() {
126
127 if (Ipi && Ipi->getRecordCount() > 0) {
128 // In theory newer PDBs always have an ID stream, but by saying that we're
129 // only going to *really* have an ID stream if there is at least one ID
130 // record, we leave open the opportunity to test older PDBs such as those
131 // that don't have an ID stream.
132 auto &Info = getInfoBuilder();
133 Info.addFeature(PdbRaw_FeatureSig::VC140);
134 }
135
136 uint32_t StringsLen = Strings.calculateSerializedSize();
137
138 Expected<uint32_t> SN = allocateNamedStream("/LinkInfo", 0);
139 if (!SN)
140 return SN.takeError();
141
142 if (Gsi) {
143 if (auto EC = Gsi->finalizeMsfLayout())
144 return EC;
145 if (Dbi) {
146 Dbi->setPublicsStreamIndex(Gsi->getPublicsStreamIndex());
147 Dbi->setGlobalsStreamIndex(Gsi->getGlobalsStreamIndex());
148 Dbi->setSymbolRecordStreamIndex(Gsi->getRecordStreamIdx());
149 }
150 }
151 if (Tpi) {
152 if (auto EC = Tpi->finalizeMsfLayout())
153 return EC;
154 }
155 if (Dbi) {
156 if (auto EC = Dbi->finalizeMsfLayout())
157 return EC;
158 }
159 SN = allocateNamedStream("/names", StringsLen);
160 if (!SN)
161 return SN.takeError();
162
163 if (Ipi) {
164 if (auto EC = Ipi->finalizeMsfLayout())
165 return EC;
166 }
167
168 // Do this last, since it relies on the named stream map being complete, and
169 // that can be updated by previous steps in the finalization.
170 if (Info) {
171 if (auto EC = Info->finalizeMsfLayout())
172 return EC;
173 }
174
175 if (!InjectedSources.empty()) {
176 for (const auto &IS : InjectedSources) {
177 JamCRC CRC(0);
178 CRC.update(makeArrayRef(IS.Content->getBufferStart(),
179 IS.Content->getBufferSize()));
180
181 SrcHeaderBlockEntry Entry;
182 ::memset(&Entry, 0, sizeof(SrcHeaderBlockEntry));
183 Entry.Size = sizeof(SrcHeaderBlockEntry);
184 Entry.FileSize = IS.Content->getBufferSize();
185 Entry.FileNI = IS.NameIndex;
186 Entry.VFileNI = IS.VNameIndex;
187 Entry.ObjNI = 1;
188 Entry.IsVirtual = 0;
189 Entry.Version =
190 static_cast<uint32_t>(PdbRaw_SrcHeaderBlockVer::SrcVerOne);
191 Entry.CRC = CRC.getCRC();
192 StringRef VName = getStringTableBuilder().getStringForId(IS.VNameIndex);
193 InjectedSourceTable.set_as(VName, std::move(Entry));
194 }
195
196 uint32_t SrcHeaderBlockSize =
197 sizeof(SrcHeaderBlockHeader) +
198 InjectedSourceTable.calculateSerializedLength();
199 SN = allocateNamedStream("/src/headerblock", SrcHeaderBlockSize);
200 if (!SN)
201 return SN.takeError();
202 for (const auto &IS : InjectedSources) {
203 SN = allocateNamedStream(IS.StreamName, IS.Content->getBufferSize());
204 if (!SN)
205 return SN.takeError();
206 }
207 }
208
209 // Do this last, since it relies on the named stream map being complete, and
210 // that can be updated by previous steps in the finalization.
211 if (Info) {
212 if (auto EC = Info->finalizeMsfLayout())
213 return EC;
214 }
215
216 return Error::success();
217 }
218
getNamedStreamIndex(StringRef Name) const219 Expected<uint32_t> PDBFileBuilder::getNamedStreamIndex(StringRef Name) const {
220 uint32_t SN = 0;
221 if (!NamedStreams.get(Name, SN))
222 return llvm::make_error<pdb::RawError>(raw_error_code::no_stream);
223 return SN;
224 }
225
commitSrcHeaderBlock(WritableBinaryStream & MsfBuffer,const msf::MSFLayout & Layout)226 void PDBFileBuilder::commitSrcHeaderBlock(WritableBinaryStream &MsfBuffer,
227 const msf::MSFLayout &Layout) {
228 assert(!InjectedSourceTable.empty());
229
230 uint32_t SN = cantFail(getNamedStreamIndex("/src/headerblock"));
231 auto Stream = WritableMappedBlockStream::createIndexedStream(
232 Layout, MsfBuffer, SN, Allocator);
233 BinaryStreamWriter Writer(*Stream);
234
235 SrcHeaderBlockHeader Header;
236 ::memset(&Header, 0, sizeof(Header));
237 Header.Version = static_cast<uint32_t>(PdbRaw_SrcHeaderBlockVer::SrcVerOne);
238 Header.Size = Writer.bytesRemaining();
239
240 cantFail(Writer.writeObject(Header));
241 cantFail(InjectedSourceTable.commit(Writer));
242
243 assert(Writer.bytesRemaining() == 0);
244 }
245
commitInjectedSources(WritableBinaryStream & MsfBuffer,const msf::MSFLayout & Layout)246 void PDBFileBuilder::commitInjectedSources(WritableBinaryStream &MsfBuffer,
247 const msf::MSFLayout &Layout) {
248 if (InjectedSourceTable.empty())
249 return;
250
251 commitSrcHeaderBlock(MsfBuffer, Layout);
252
253 for (const auto &IS : InjectedSources) {
254 uint32_t SN = cantFail(getNamedStreamIndex(IS.StreamName));
255
256 auto SourceStream = WritableMappedBlockStream::createIndexedStream(
257 Layout, MsfBuffer, SN, Allocator);
258 BinaryStreamWriter SourceWriter(*SourceStream);
259 assert(SourceWriter.bytesRemaining() == IS.Content->getBufferSize());
260 cantFail(SourceWriter.writeBytes(
261 arrayRefFromStringRef(IS.Content->getBuffer())));
262 }
263 }
264
commit(StringRef Filename)265 Error PDBFileBuilder::commit(StringRef Filename) {
266 assert(!Filename.empty());
267 if (auto EC = finalizeMsfLayout())
268 return EC;
269
270 MSFLayout Layout;
271 auto ExpectedMsfBuffer = Msf->commit(Filename, Layout);
272 if (!ExpectedMsfBuffer)
273 return ExpectedMsfBuffer.takeError();
274 FileBufferByteStream Buffer = std::move(*ExpectedMsfBuffer);
275
276 auto ExpectedSN = getNamedStreamIndex("/names");
277 if (!ExpectedSN)
278 return ExpectedSN.takeError();
279
280 auto NS = WritableMappedBlockStream::createIndexedStream(
281 Layout, Buffer, *ExpectedSN, Allocator);
282 BinaryStreamWriter NSWriter(*NS);
283 if (auto EC = Strings.commit(NSWriter))
284 return EC;
285
286 for (const auto &NSE : NamedStreamData) {
287 if (NSE.second.empty())
288 continue;
289
290 auto NS = WritableMappedBlockStream::createIndexedStream(
291 Layout, Buffer, NSE.first, Allocator);
292 BinaryStreamWriter NSW(*NS);
293 if (auto EC = NSW.writeBytes(arrayRefFromStringRef(NSE.second)))
294 return EC;
295 }
296
297 if (Info) {
298 if (auto EC = Info->commit(Layout, Buffer))
299 return EC;
300 }
301
302 if (Dbi) {
303 if (auto EC = Dbi->commit(Layout, Buffer))
304 return EC;
305 }
306
307 if (Tpi) {
308 if (auto EC = Tpi->commit(Layout, Buffer))
309 return EC;
310 }
311
312 if (Ipi) {
313 if (auto EC = Ipi->commit(Layout, Buffer))
314 return EC;
315 }
316
317 if (Gsi) {
318 if (auto EC = Gsi->commit(Layout, Buffer))
319 return EC;
320 }
321
322 auto InfoStreamBlocks = Layout.StreamMap[StreamPDB];
323 assert(!InfoStreamBlocks.empty());
324 uint64_t InfoStreamFileOffset =
325 blockToOffset(InfoStreamBlocks.front(), Layout.SB->BlockSize);
326 InfoStreamHeader *H = reinterpret_cast<InfoStreamHeader *>(
327 Buffer.getBufferStart() + InfoStreamFileOffset);
328
329 commitInjectedSources(Buffer, Layout);
330
331 // Set the build id at the very end, after every other byte of the PDB
332 // has been written.
333 // FIXME: Use a hash of the PDB rather than time(nullptr) for the signature.
334 H->Age = Info->getAge();
335 H->Guid = Info->getGuid();
336 Optional<uint32_t> Sig = Info->getSignature();
337 H->Signature = Sig.hasValue() ? *Sig : time(nullptr);
338
339 return Buffer.commit();
340 }
341