[PDB] Use one func id DenseMap instead of per-source maps, NFC
[lldb.git] / lld / COFF / PDB.cpp
1 //===- PDB.cpp ------------------------------------------------------------===//
2 //
3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4 // See https://llvm.org/LICENSE.txt for license information.
5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6 //
7 //===----------------------------------------------------------------------===//
8
9 #include "PDB.h"
10 #include "Chunks.h"
11 #include "Config.h"
12 #include "DebugTypes.h"
13 #include "Driver.h"
14 #include "SymbolTable.h"
15 #include "Symbols.h"
16 #include "TypeMerger.h"
17 #include "Writer.h"
18 #include "lld/Common/ErrorHandler.h"
19 #include "lld/Common/Timer.h"
20 #include "llvm/DebugInfo/CodeView/DebugFrameDataSubsection.h"
21 #include "llvm/DebugInfo/CodeView/DebugSubsectionRecord.h"
22 #include "llvm/DebugInfo/CodeView/GlobalTypeTableBuilder.h"
23 #include "llvm/DebugInfo/CodeView/LazyRandomTypeCollection.h"
24 #include "llvm/DebugInfo/CodeView/MergingTypeTableBuilder.h"
25 #include "llvm/DebugInfo/CodeView/RecordName.h"
26 #include "llvm/DebugInfo/CodeView/SymbolDeserializer.h"
27 #include "llvm/DebugInfo/CodeView/SymbolRecordHelpers.h"
28 #include "llvm/DebugInfo/CodeView/SymbolSerializer.h"
29 #include "llvm/DebugInfo/CodeView/TypeIndexDiscovery.h"
30 #include "llvm/DebugInfo/MSF/MSFBuilder.h"
31 #include "llvm/DebugInfo/MSF/MSFCommon.h"
32 #include "llvm/DebugInfo/PDB/GenericError.h"
33 #include "llvm/DebugInfo/PDB/Native/DbiModuleDescriptorBuilder.h"
34 #include "llvm/DebugInfo/PDB/Native/DbiStream.h"
35 #include "llvm/DebugInfo/PDB/Native/DbiStreamBuilder.h"
36 #include "llvm/DebugInfo/PDB/Native/GSIStreamBuilder.h"
37 #include "llvm/DebugInfo/PDB/Native/InfoStream.h"
38 #include "llvm/DebugInfo/PDB/Native/InfoStreamBuilder.h"
39 #include "llvm/DebugInfo/PDB/Native/NativeSession.h"
40 #include "llvm/DebugInfo/PDB/Native/PDBFile.h"
41 #include "llvm/DebugInfo/PDB/Native/PDBFileBuilder.h"
42 #include "llvm/DebugInfo/PDB/Native/PDBStringTableBuilder.h"
43 #include "llvm/DebugInfo/PDB/Native/TpiHashing.h"
44 #include "llvm/DebugInfo/PDB/Native/TpiStream.h"
45 #include "llvm/DebugInfo/PDB/Native/TpiStreamBuilder.h"
46 #include "llvm/DebugInfo/PDB/PDB.h"
47 #include "llvm/Object/COFF.h"
48 #include "llvm/Object/CVDebugRecord.h"
49 #include "llvm/Support/BinaryByteStream.h"
50 #include "llvm/Support/CRC.h"
51 #include "llvm/Support/Endian.h"
52 #include "llvm/Support/Errc.h"
53 #include "llvm/Support/FormatAdapters.h"
54 #include "llvm/Support/FormatVariadic.h"
55 #include "llvm/Support/Path.h"
56 #include "llvm/Support/ScopedPrinter.h"
57 #include <memory>
58
59 using namespace llvm;
60 using namespace llvm::codeview;
61 using namespace lld;
62 using namespace lld::coff;
63
64 using llvm::object::coff_section;
65
66 static ExitOnError exitOnErr;
67
68 static Timer totalPdbLinkTimer("PDB Emission (Cumulative)", Timer::root());
69 Timer lld::coff::loadGHashTimer("Global Type Hashing", totalPdbLinkTimer);
70 Timer lld::coff::mergeGHashTimer("GHash Type Merging", totalPdbLinkTimer);
71 static Timer addObjectsTimer("Add Objects", totalPdbLinkTimer);
72 static Timer typeMergingTimer("Type Merging", addObjectsTimer);
73 static Timer symbolMergingTimer("Symbol Merging", addObjectsTimer);
74 static Timer publicsLayoutTimer("Publics Stream Layout", totalPdbLinkTimer);
75 static Timer tpiStreamLayoutTimer("TPI Stream Layout", totalPdbLinkTimer);
76 static Timer diskCommitTimer("Commit to Disk", totalPdbLinkTimer);
77
78 namespace {
79 class DebugSHandler;
80
81 class PDBLinker {
82   friend DebugSHandler;
83
84 public:
85   PDBLinker(SymbolTable *symtab)
86       : symtab(symtab), builder(bAlloc), tMerger(bAlloc) {
87     // This isn't strictly necessary, but link.exe usually puts an empty string
88     // as the first "valid" string in the string table, so we do the same in
89     // order to maintain as much byte-for-byte compatibility as possible.
90     pdbStrTab.insert("");
91   }
92
93   /// Emit the basic PDB structure: initial streams, headers, etc.
94   void initialize(llvm::codeview::DebugInfo *buildId);
95
96   /// Add natvis files specified on the command line.
97   void addNatvisFiles();
98
99   /// Add named streams specified on the command line.
100   void addNamedStreams();
101
102   /// Link CodeView from each object file in the symbol table into the PDB.
103   void addObjectsToPDB();
104
105   /// Add every live, defined public symbol to the PDB.
106   void addPublicsToPDB();
107
108   /// Link info for each import file in the symbol table into the PDB.
109   void addImportFilesToPDB(ArrayRef<OutputSection *> outputSections);
110
111   /// Link CodeView from a single object file into the target (output) PDB.
112   /// When a precompiled headers object is linked, its TPI map might be provided
113   /// externally.
114   void addDebug(TpiSource *source);
115
116   void addDebugSymbols(TpiSource *source);
117
118   void mergeSymbolRecords(TpiSource *source,
119                           std::vector<ulittle32_t *> &stringTableRefs,
120                           BinaryStreamRef symData);
121
122   /// Add the section map and section contributions to the PDB.
123   void addSections(ArrayRef<OutputSection *> outputSections,
124                    ArrayRef<uint8_t> sectionTable);
125
126   /// Write the PDB to disk and store the Guid generated for it in *Guid.
127   void commit(codeview::GUID *guid);
128
129   // Print statistics regarding the final PDB
130   void printStats();
131
132 private:
133   SymbolTable *symtab;
134
135   pdb::PDBFileBuilder builder;
136
137   TypeMerger tMerger;
138
139   /// PDBs use a single global string table for filenames in the file checksum
140   /// table.
141   DebugStringTableSubsection pdbStrTab;
142
143   llvm::SmallString<128> nativePath;
144
145   // For statistics
146   uint64_t globalSymbols = 0;
147   uint64_t moduleSymbols = 0;
148   uint64_t publicSymbols = 0;
149 };
150
151 class DebugSHandler {
152   PDBLinker &linker;
153
154   /// The object file whose .debug$S sections we're processing.
155   ObjFile &file;
156
157   /// The result of merging type indices.
158   TpiSource *source;
159
160   /// The DEBUG_S_STRINGTABLE subsection.  These strings are referred to by
161   /// index from other records in the .debug$S section.  All of these strings
162   /// need to be added to the global PDB string table, and all references to
163   /// these strings need to have their indices re-written to refer to the
164   /// global PDB string table.
165   DebugStringTableSubsectionRef cvStrTab;
166
167   /// The DEBUG_S_FILECHKSMS subsection.  As above, these are referred to
168   /// by other records in the .debug$S section and need to be merged into the
169   /// PDB.
170   DebugChecksumsSubsectionRef checksums;
171
172   /// The DEBUG_S_FRAMEDATA subsection(s).  There can be more than one of
173   /// these and they need not appear in any specific order.  However, they
174   /// contain string table references which need to be re-written, so we
175   /// collect them all here and re-write them after all subsections have been
176   /// discovered and processed.
177   std::vector<DebugFrameDataSubsectionRef> newFpoFrames;
178
179   /// Pointers to raw memory that we determine have string table references
180   /// that need to be re-written.  We first process all .debug$S subsections
181   /// to ensure that we can handle subsections written in any order, building
182   /// up this list as we go.  At the end, we use the string table (which must
183   /// have been discovered by now else it is an error) to re-write these
184   /// references.
185   std::vector<ulittle32_t *> stringTableReferences;
186
187   void mergeInlineeLines(const DebugSubsectionRecord &inlineeLines);
188
189 public:
190   DebugSHandler(PDBLinker &linker, ObjFile &file, TpiSource *source)
191       : linker(linker), file(file), source(source) {}
192
193   void handleDebugS(ArrayRef<uint8_t> relocatedDebugContents);
194
195   void finish();
196 };
197 }
198
199 // Visual Studio's debugger requires absolute paths in various places in the
200 // PDB to work without additional configuration:
201 // https://docs.microsoft.com/en-us/visualstudio/debugger/debug-source-files-common-properties-solution-property-pages-dialog-box
202 static void pdbMakeAbsolute(SmallVectorImpl<char> &fileName) {
203   // The default behavior is to produce paths that are valid within the context
204   // of the machine that you perform the link on.  If the linker is running on
205   // a POSIX system, we will output absolute POSIX paths.  If the linker is
206   // running on a Windows system, we will output absolute Windows paths.  If the
207   // user desires any other kind of behavior, they should explicitly pass
208   // /pdbsourcepath, in which case we will treat the exact string the user
209   // passed in as the gospel and not normalize, canonicalize it.
210   if (sys::path::is_absolute(fileName, sys::path::Style::windows) ||
211       sys::path::is_absolute(fileName, sys::path::Style::posix))
212     return;
213
214   // It's not absolute in any path syntax.  Relative paths necessarily refer to
215   // the local file system, so we can make it native without ending up with a
216   // nonsensical path.
217   if (config->pdbSourcePath.empty()) {
218     sys::path::native(fileName);
219     sys::fs::make_absolute(fileName);
220     return;
221   }
222
223   // Try to guess whether /PDBSOURCEPATH is a unix path or a windows path.
224   // Since PDB's are more of a Windows thing, we make this conservative and only
225   // decide that it's a unix path if we're fairly certain.  Specifically, if
226   // it starts with a forward slash.
227   SmallString<128> absoluteFileName = config->pdbSourcePath;
228   sys::path::Style guessedStyle = absoluteFileName.startswith("/")
229                                       ? sys::path::Style::posix
230                                       : sys::path::Style::windows;
231   sys::path::append(absoluteFileName, guessedStyle, fileName);
232   sys::path::native(absoluteFileName, guessedStyle);
233   sys::path::remove_dots(absoluteFileName, true, guessedStyle);
234
235   fileName = std::move(absoluteFileName);
236 }
237
238 static void addTypeInfo(pdb::TpiStreamBuilder &tpiBuilder,
239                         TypeCollection &typeTable) {
240   // Start the TPI or IPI stream header.
241   tpiBuilder.setVersionHeader(pdb::PdbTpiV80);
242
243   // Flatten the in memory type table and hash each type.
244   typeTable.ForEachRecord([&](TypeIndex ti, const CVType &type) {
245     auto hash = pdb::hashTypeRecord(type);
246     if (auto e = hash.takeError())
247       fatal("type hashing error");
248     tpiBuilder.addTypeRecord(type.RecordData, *hash);
249   });
250 }
251
252 static void addGHashTypeInfo(pdb::PDBFileBuilder &builder) {
253   // Start the TPI or IPI stream header.
254   builder.getTpiBuilder().setVersionHeader(pdb::PdbTpiV80);
255   builder.getIpiBuilder().setVersionHeader(pdb::PdbTpiV80);
256   for_each(TpiSource::instances, [&](TpiSource *source) {
257     builder.getTpiBuilder().addTypeRecords(source->mergedTpi.recs,
258                                            source->mergedTpi.recSizes,
259                                            source->mergedTpi.recHashes);
260     builder.getIpiBuilder().addTypeRecords(source->mergedIpi.recs,
261                                            source->mergedIpi.recSizes,
262                                            source->mergedIpi.recHashes);
263   });
264 }
265
266 static void
267 recordStringTableReferenceAtOffset(MutableArrayRef<uint8_t> contents,
268                                    uint32_t offset,
269                                    std::vector<ulittle32_t *> &strTableRefs) {
270   contents =
271       contents.drop_front(offset).take_front(sizeof(support::ulittle32_t));
272   ulittle32_t *index = reinterpret_cast<ulittle32_t *>(contents.data());
273   strTableRefs.push_back(index);
274 }
275
276 static void
277 recordStringTableReferences(SymbolKind kind, MutableArrayRef<uint8_t> contents,
278                             std::vector<ulittle32_t *> &strTableRefs) {
279   // For now we only handle S_FILESTATIC, but we may need the same logic for
280   // S_DEFRANGE and S_DEFRANGE_SUBFIELD.  However, I cannot seem to generate any
281   // PDBs that contain these types of records, so because of the uncertainty
282   // they are omitted here until we can prove that it's necessary.
283   switch (kind) {
284   case SymbolKind::S_FILESTATIC:
285     // FileStaticSym::ModFileOffset
286     recordStringTableReferenceAtOffset(contents, 8, strTableRefs);
287     break;
288   case SymbolKind::S_DEFRANGE:
289   case SymbolKind::S_DEFRANGE_SUBFIELD:
290     log("Not fixing up string table reference in S_DEFRANGE / "
291         "S_DEFRANGE_SUBFIELD record");
292     break;
293   default:
294     break;
295   }
296 }
297
298 static SymbolKind symbolKind(ArrayRef<uint8_t> recordData) {
299   const RecordPrefix *prefix =
300       reinterpret_cast<const RecordPrefix *>(recordData.data());
301   return static_cast<SymbolKind>(uint16_t(prefix->RecordKind));
302 }
303
304 /// MSVC translates S_PROC_ID_END to S_END, and S_[LG]PROC32_ID to S_[LG]PROC32
305 static void translateIdSymbols(MutableArrayRef<uint8_t> &recordData,
306                                TypeMerger &tMerger, TpiSource *source) {
307   RecordPrefix *prefix = reinterpret_cast<RecordPrefix *>(recordData.data());
308
309   SymbolKind kind = symbolKind(recordData);
310
311   if (kind == SymbolKind::S_PROC_ID_END) {
312     prefix->RecordKind = SymbolKind::S_END;
313     return;
314   }
315
316   // In an object file, GPROC32_ID has an embedded reference which refers to the
317   // single object file type index namespace.  This has already been translated
318   // to the PDB file's ID stream index space, but we need to convert this to a
319   // symbol that refers to the type stream index space.  So we remap again from
320   // ID index space to type index space.
321   if (kind == SymbolKind::S_GPROC32_ID || kind == SymbolKind::S_LPROC32_ID) {
322     SmallVector<TiReference, 1> refs;
323     auto content = recordData.drop_front(sizeof(RecordPrefix));
324     CVSymbol sym(recordData);
325     discoverTypeIndicesInSymbol(sym, refs);
326     assert(refs.size() == 1);
327     assert(refs.front().Count == 1);
328
329     TypeIndex *ti =
330         reinterpret_cast<TypeIndex *>(content.data() + refs[0].Offset);
331     // `ti` is the index of a FuncIdRecord or MemberFuncIdRecord which lives in
332     // the IPI stream, whose `FunctionType` member refers to the TPI stream.
333     // Note that LF_FUNC_ID and LF_MFUNC_ID have the same record layout, and
334     // in both cases we just need the second type index.
335     if (!ti->isSimple() && !ti->isNoneType()) {
336       if (config->debugGHashes) {
337         auto idToType = tMerger.funcIdToType.find(*ti);
338         if (idToType == tMerger.funcIdToType.end()) {
339           warn(formatv("S_[GL]PROC32_ID record in {0} refers to PDB item "
340                        "index {1:X} which is not a LF_[M]FUNC_ID record",
341                        source->file->getName(), ti->getIndex()));
342           *ti = TypeIndex(SimpleTypeKind::NotTranslated);
343         } else {
344           *ti = idToType->second;
345         }
346       } else {
347         CVType funcIdData = tMerger.getIDTable().getType(*ti);
348         ArrayRef<uint8_t> tiBuf = funcIdData.data().slice(8, 4);
349         assert(tiBuf.size() == 4 && "corrupt LF_[M]FUNC_ID record");
350         *ti = *reinterpret_cast<const TypeIndex *>(tiBuf.data());
351       }
352     }
353
354     kind = (kind == SymbolKind::S_GPROC32_ID) ? SymbolKind::S_GPROC32
355                                               : SymbolKind::S_LPROC32;
356     prefix->RecordKind = uint16_t(kind);
357   }
358 }
359
360 /// Copy the symbol record. In a PDB, symbol records must be 4 byte aligned.
361 /// The object file may not be aligned.
362 static MutableArrayRef<uint8_t>
363 copyAndAlignSymbol(const CVSymbol &sym, MutableArrayRef<uint8_t> &alignedMem) {
364   size_t size = alignTo(sym.length(), alignOf(CodeViewContainer::Pdb));
365   assert(size >= 4 && "record too short");
366   assert(size <= MaxRecordLength && "record too long");
367   assert(alignedMem.size() >= size && "didn't preallocate enough");
368
369   // Copy the symbol record and zero out any padding bytes.
370   MutableArrayRef<uint8_t> newData = alignedMem.take_front(size);
371   alignedMem = alignedMem.drop_front(size);
372   memcpy(newData.data(), sym.data().data(), sym.length());
373   memset(newData.data() + sym.length(), 0, size - sym.length());
374
375   // Update the record prefix length. It should point to the beginning of the
376   // next record.
377   auto *prefix = reinterpret_cast<RecordPrefix *>(newData.data());
378   prefix->RecordLen = size - 2;
379   return newData;
380 }
381
382 struct ScopeRecord {
383   ulittle32_t ptrParent;
384   ulittle32_t ptrEnd;
385 };
386
387 struct SymbolScope {
388   ScopeRecord *openingRecord;
389   uint32_t scopeOffset;
390 };
391
392 static void scopeStackOpen(SmallVectorImpl<SymbolScope> &stack,
393                            uint32_t curOffset, CVSymbol &sym) {
394   assert(symbolOpensScope(sym.kind()));
395   SymbolScope s;
396   s.scopeOffset = curOffset;
397   s.openingRecord = const_cast<ScopeRecord *>(
398       reinterpret_cast<const ScopeRecord *>(sym.content().data()));
399   s.openingRecord->ptrParent = stack.empty() ? 0 : stack.back().scopeOffset;
400   stack.push_back(s);
401 }
402
403 static void scopeStackClose(SmallVectorImpl<SymbolScope> &stack,
404                             uint32_t curOffset, InputFile *file) {
405   if (stack.empty()) {
406     warn("symbol scopes are not balanced in " + file->getName());
407     return;
408   }
409   SymbolScope s = stack.pop_back_val();
410   s.openingRecord->ptrEnd = curOffset;
411 }
412
413 static bool symbolGoesInModuleStream(const CVSymbol &sym, bool isGlobalScope) {
414   switch (sym.kind()) {
415   case SymbolKind::S_GDATA32:
416   case SymbolKind::S_CONSTANT:
417   case SymbolKind::S_GTHREAD32:
418   // We really should not be seeing S_PROCREF and S_LPROCREF in the first place
419   // since they are synthesized by the linker in response to S_GPROC32 and
420   // S_LPROC32, but if we do see them, don't put them in the module stream I
421   // guess.
422   case SymbolKind::S_PROCREF:
423   case SymbolKind::S_LPROCREF:
424     return false;
425   // S_UDT records go in the module stream if it is not a global S_UDT.
426   case SymbolKind::S_UDT:
427     return !isGlobalScope;
428   // S_GDATA32 does not go in the module stream, but S_LDATA32 does.
429   case SymbolKind::S_LDATA32:
430   case SymbolKind::S_LTHREAD32:
431   default:
432     return true;
433   }
434 }
435
436 static bool symbolGoesInGlobalsStream(const CVSymbol &sym,
437                                       bool isFunctionScope) {
438   switch (sym.kind()) {
439   case SymbolKind::S_CONSTANT:
440   case SymbolKind::S_GDATA32:
441   case SymbolKind::S_GTHREAD32:
442   case SymbolKind::S_GPROC32:
443   case SymbolKind::S_LPROC32:
444   // We really should not be seeing S_PROCREF and S_LPROCREF in the first place
445   // since they are synthesized by the linker in response to S_GPROC32 and
446   // S_LPROC32, but if we do see them, copy them straight through.
447   case SymbolKind::S_PROCREF:
448   case SymbolKind::S_LPROCREF:
449     return true;
450   // Records that go in the globals stream, unless they are function-local.
451   case SymbolKind::S_UDT:
452   case SymbolKind::S_LDATA32:
453   case SymbolKind::S_LTHREAD32:
454     return !isFunctionScope;
455   default:
456     return false;
457   }
458 }
459
460 static void addGlobalSymbol(pdb::GSIStreamBuilder &builder, uint16_t modIndex,
461                             unsigned symOffset, const CVSymbol &sym) {
462   switch (sym.kind()) {
463   case SymbolKind::S_CONSTANT:
464   case SymbolKind::S_UDT:
465   case SymbolKind::S_GDATA32:
466   case SymbolKind::S_GTHREAD32:
467   case SymbolKind::S_LTHREAD32:
468   case SymbolKind::S_LDATA32:
469   case SymbolKind::S_PROCREF:
470   case SymbolKind::S_LPROCREF:
471     builder.addGlobalSymbol(sym);
472     break;
473   case SymbolKind::S_GPROC32:
474   case SymbolKind::S_LPROC32: {
475     SymbolRecordKind k = SymbolRecordKind::ProcRefSym;
476     if (sym.kind() == SymbolKind::S_LPROC32)
477       k = SymbolRecordKind::LocalProcRef;
478     ProcRefSym ps(k);
479     ps.Module = modIndex;
480     // For some reason, MSVC seems to add one to this value.
481     ++ps.Module;
482     ps.Name = getSymbolName(sym);
483     ps.SumName = 0;
484     ps.SymOffset = symOffset;
485     builder.addGlobalSymbol(ps);
486     break;
487   }
488   default:
489     llvm_unreachable("Invalid symbol kind!");
490   }
491 }
492
493 void PDBLinker::mergeSymbolRecords(TpiSource *source,
494                                    std::vector<ulittle32_t *> &stringTableRefs,
495                                    BinaryStreamRef symData) {
496   ObjFile *file = source->file;
497   ArrayRef<uint8_t> symsBuffer;
498   cantFail(symData.readBytes(0, symData.getLength(), symsBuffer));
499   SmallVector<SymbolScope, 4> scopes;
500
501   // Iterate every symbol to check if any need to be realigned, and if so, how
502   // much space we need to allocate for them.
503   bool needsRealignment = false;
504   unsigned totalRealignedSize = 0;
505   auto ec = forEachCodeViewRecord<CVSymbol>(
506       symsBuffer, [&](CVSymbol sym) -> llvm::Error {
507         unsigned realignedSize =
508             alignTo(sym.length(), alignOf(CodeViewContainer::Pdb));
509         needsRealignment |= realignedSize != sym.length();
510         totalRealignedSize += realignedSize;
511         return Error::success();
512       });
513
514   // If any of the symbol record lengths was corrupt, ignore them all, warn
515   // about it, and move on.
516   if (ec) {
517     warn("corrupt symbol records in " + file->getName());
518     consumeError(std::move(ec));
519     return;
520   }
521
522   // If any symbol needed realignment, allocate enough contiguous memory for
523   // them all. Typically symbol subsections are small enough that this will not
524   // cause fragmentation.
525   MutableArrayRef<uint8_t> alignedSymbolMem;
526   if (needsRealignment) {
527     void *alignedData =
528         bAlloc.Allocate(totalRealignedSize, alignOf(CodeViewContainer::Pdb));
529     alignedSymbolMem = makeMutableArrayRef(
530         reinterpret_cast<uint8_t *>(alignedData), totalRealignedSize);
531   }
532
533   // Iterate again, this time doing the real work.
534   unsigned curSymOffset = file->moduleDBI->getNextSymbolOffset();
535   ArrayRef<uint8_t> bulkSymbols;
536   cantFail(forEachCodeViewRecord<CVSymbol>(
537       symsBuffer, [&](CVSymbol sym) -> llvm::Error {
538         // Align the record if required.
539         MutableArrayRef<uint8_t> recordBytes;
540         if (needsRealignment) {
541           recordBytes = copyAndAlignSymbol(sym, alignedSymbolMem);
542           sym = CVSymbol(recordBytes);
543         } else {
544           // Otherwise, we can actually mutate the symbol directly, since we
545           // copied it to apply relocations.
546           recordBytes = makeMutableArrayRef(
547               const_cast<uint8_t *>(sym.data().data()), sym.length());
548         }
549
550         // Re-map all the type index references.
551         if (!source->remapTypesInSymbolRecord(recordBytes)) {
552           log("error remapping types in symbol of kind 0x" +
553               utohexstr(sym.kind()) + ", ignoring");
554           return Error::success();
555         }
556
557         // An object file may have S_xxx_ID symbols, but these get converted to
558         // "real" symbols in a PDB.
559         translateIdSymbols(recordBytes, tMerger, source);
560         sym = CVSymbol(recordBytes);
561
562         // If this record refers to an offset in the object file's string table,
563         // add that item to the global PDB string table and re-write the index.
564         recordStringTableReferences(sym.kind(), recordBytes, stringTableRefs);
565
566         // Fill in "Parent" and "End" fields by maintaining a stack of scopes.
567         if (symbolOpensScope(sym.kind()))
568           scopeStackOpen(scopes, curSymOffset, sym);
569         else if (symbolEndsScope(sym.kind()))
570           scopeStackClose(scopes, curSymOffset, file);
571
572         // Add the symbol to the globals stream if necessary.  Do this before
573         // adding the symbol to the module since we may need to get the next
574         // symbol offset, and writing to the module's symbol stream will update
575         // that offset.
576         if (symbolGoesInGlobalsStream(sym, !scopes.empty())) {
577           addGlobalSymbol(builder.getGsiBuilder(),
578                           file->moduleDBI->getModuleIndex(), curSymOffset, sym);
579           ++globalSymbols;
580         }
581
582         if (symbolGoesInModuleStream(sym, scopes.empty())) {
583           // Add symbols to the module in bulk. If this symbol is contiguous
584           // with the previous run of symbols to add, combine the ranges. If
585           // not, close the previous range of symbols and start a new one.
586           if (sym.data().data() == bulkSymbols.end()) {
587             bulkSymbols = makeArrayRef(bulkSymbols.data(),
588                                        bulkSymbols.size() + sym.length());
589           } else {
590             file->moduleDBI->addSymbolsInBulk(bulkSymbols);
591             bulkSymbols = recordBytes;
592           }
593           curSymOffset += sym.length();
594           ++moduleSymbols;
595         }
596         return Error::success();
597       }));
598
599   // Add any remaining symbols we've accumulated.
600   file->moduleDBI->addSymbolsInBulk(bulkSymbols);
601 }
602
603 static pdb::SectionContrib createSectionContrib(const Chunk *c, uint32_t modi) {
604   OutputSection *os = c ? c->getOutputSection() : nullptr;
605   pdb::SectionContrib sc;
606   memset(&sc, 0, sizeof(sc));
607   sc.ISect = os ? os->sectionIndex : llvm::pdb::kInvalidStreamIndex;
608   sc.Off = c && os ? c->getRVA() - os->getRVA() : 0;
609   sc.Size = c ? c->getSize() : -1;
610   if (auto *secChunk = dyn_cast_or_null<SectionChunk>(c)) {
611     sc.Characteristics = secChunk->header->Characteristics;
612     sc.Imod = secChunk->file->moduleDBI->getModuleIndex();
613     ArrayRef<uint8_t> contents = secChunk->getContents();
614     JamCRC crc(0);
615     crc.update(contents);
616     sc.DataCrc = crc.getCRC();
617   } else {
618     sc.Characteristics = os ? os->header.Characteristics : 0;
619     sc.Imod = modi;
620   }
621   sc.RelocCrc = 0; // FIXME
622
623   return sc;
624 }
625
626 static uint32_t
627 translateStringTableIndex(uint32_t objIndex,
628                           const DebugStringTableSubsectionRef &objStrTable,
629                           DebugStringTableSubsection &pdbStrTable) {
630   auto expectedString = objStrTable.getString(objIndex);
631   if (!expectedString) {
632     warn("Invalid string table reference");
633     consumeError(expectedString.takeError());
634     return 0;
635   }
636
637   return pdbStrTable.insert(*expectedString);
638 }
639
640 void DebugSHandler::handleDebugS(ArrayRef<uint8_t> relocatedDebugContents) {
641   relocatedDebugContents =
642       SectionChunk::consumeDebugMagic(relocatedDebugContents, ".debug$S");
643
644   DebugSubsectionArray subsections;
645   BinaryStreamReader reader(relocatedDebugContents, support::little);
646   exitOnErr(reader.readArray(subsections, relocatedDebugContents.size()));
647
648   for (const DebugSubsectionRecord &ss : subsections) {
649     // Ignore subsections with the 'ignore' bit. Some versions of the Visual C++
650     // runtime have subsections with this bit set.
651     if (uint32_t(ss.kind()) & codeview::SubsectionIgnoreFlag)
652       continue;
653
654     switch (ss.kind()) {
655     case DebugSubsectionKind::StringTable: {
656       assert(!cvStrTab.valid() &&
657              "Encountered multiple string table subsections!");
658       exitOnErr(cvStrTab.initialize(ss.getRecordData()));
659       break;
660     }
661     case DebugSubsectionKind::FileChecksums:
662       assert(!checksums.valid() &&
663              "Encountered multiple checksum subsections!");
664       exitOnErr(checksums.initialize(ss.getRecordData()));
665       break;
666     case DebugSubsectionKind::Lines:
667       // We can add the relocated line table directly to the PDB without
668       // modification because the file checksum offsets will stay the same.
669       file.moduleDBI->addDebugSubsection(ss);
670       break;
671     case DebugSubsectionKind::InlineeLines:
672       // The inlinee lines subsection also has file checksum table references
673       // that can be used directly, but it contains function id references that
674       // must be remapped.
675       mergeInlineeLines(ss);
676       break;
677     case DebugSubsectionKind::FrameData: {
678       // We need to re-write string table indices here, so save off all
679       // frame data subsections until we've processed the entire list of
680       // subsections so that we can be sure we have the string table.
681       DebugFrameDataSubsectionRef fds;
682       exitOnErr(fds.initialize(ss.getRecordData()));
683       newFpoFrames.push_back(std::move(fds));
684       break;
685     }
686     case DebugSubsectionKind::Symbols: {
687       linker.mergeSymbolRecords(source, stringTableReferences,
688                                 ss.getRecordData());
689       break;
690     }
691
692     case DebugSubsectionKind::CrossScopeImports:
693     case DebugSubsectionKind::CrossScopeExports:
694       // These appear to relate to cross-module optimization, so we might use
695       // these for ThinLTO.
696       break;
697
698     case DebugSubsectionKind::ILLines:
699     case DebugSubsectionKind::FuncMDTokenMap:
700     case DebugSubsectionKind::TypeMDTokenMap:
701     case DebugSubsectionKind::MergedAssemblyInput:
702       // These appear to relate to .Net assembly info.
703       break;
704
705     case DebugSubsectionKind::CoffSymbolRVA:
706       // Unclear what this is for.
707       break;
708
709     default:
710       warn("ignoring unknown debug$S subsection kind 0x" +
711            utohexstr(uint32_t(ss.kind())) + " in file " + toString(&file));
712       break;
713     }
714   }
715 }
716
717 static Expected<StringRef>
718 getFileName(const DebugStringTableSubsectionRef &strings,
719             const DebugChecksumsSubsectionRef &checksums, uint32_t fileID) {
720   auto iter = checksums.getArray().at(fileID);
721   if (iter == checksums.getArray().end())
722     return make_error<CodeViewError>(cv_error_code::no_records);
723   uint32_t offset = iter->FileNameOffset;
724   return strings.getString(offset);
725 }
726
727 void DebugSHandler::mergeInlineeLines(
728     const DebugSubsectionRecord &inlineeSubsection) {
729   DebugInlineeLinesSubsectionRef inlineeLines;
730   exitOnErr(inlineeLines.initialize(inlineeSubsection.getRecordData()));
731   if (!source) {
732     warn("ignoring inlinee lines section in file that lacks type information");
733     return;
734   }
735
736   // Remap type indices in inlinee line records in place.
737   for (const InlineeSourceLine &line : inlineeLines) {
738     TypeIndex &inlinee = *const_cast<TypeIndex *>(&line.Header->Inlinee);
739     if (!source->remapTypeIndex(inlinee, TiRefKind::IndexRef)) {
740       log("bad inlinee line record in " + file.getName() +
741           " with bad inlinee index 0x" + utohexstr(inlinee.getIndex()));
742     }
743   }
744
745   // Add the modified inlinee line subsection directly.
746   file.moduleDBI->addDebugSubsection(inlineeSubsection);
747 }
748
749 void DebugSHandler::finish() {
750   pdb::DbiStreamBuilder &dbiBuilder = linker.builder.getDbiBuilder();
751
752   // We should have seen all debug subsections across the entire object file now
753   // which means that if a StringTable subsection and Checksums subsection were
754   // present, now is the time to handle them.
755   if (!cvStrTab.valid()) {
756     if (checksums.valid())
757       fatal(".debug$S sections with a checksums subsection must also contain a "
758             "string table subsection");
759
760     if (!stringTableReferences.empty())
761       warn("No StringTable subsection was encountered, but there are string "
762            "table references");
763     return;
764   }
765
766   // Rewrite string table indices in the Fpo Data and symbol records to refer to
767   // the global PDB string table instead of the object file string table.
768   for (DebugFrameDataSubsectionRef &fds : newFpoFrames) {
769     const ulittle32_t *reloc = fds.getRelocPtr();
770     for (codeview::FrameData fd : fds) {
771       fd.RvaStart += *reloc;
772       fd.FrameFunc =
773           translateStringTableIndex(fd.FrameFunc, cvStrTab, linker.pdbStrTab);
774       dbiBuilder.addNewFpoData(fd);
775     }
776   }
777
778   for (ulittle32_t *ref : stringTableReferences)
779     *ref = translateStringTableIndex(*ref, cvStrTab, linker.pdbStrTab);
780
781   // Make a new file checksum table that refers to offsets in the PDB-wide
782   // string table. Generally the string table subsection appears after the
783   // checksum table, so we have to do this after looping over all the
784   // subsections. The new checksum table must have the exact same layout and
785   // size as the original. Otherwise, the file references in the line and
786   // inlinee line tables will be incorrect.
787   auto newChecksums = std::make_unique<DebugChecksumsSubsection>(linker.pdbStrTab);
788   for (FileChecksumEntry &fc : checksums) {
789     SmallString<128> filename =
790         exitOnErr(cvStrTab.getString(fc.FileNameOffset));
791     pdbMakeAbsolute(filename);
792     exitOnErr(dbiBuilder.addModuleSourceFile(*file.moduleDBI, filename));
793     newChecksums->addChecksum(filename, fc.Kind, fc.Checksum);
794   }
795   assert(checksums.getArray().getUnderlyingStream().getLength() ==
796              newChecksums->calculateSerializedSize() &&
797          "file checksum table must have same layout");
798
799   file.moduleDBI->addDebugSubsection(std::move(newChecksums));
800 }
801
802 static void warnUnusable(InputFile *f, Error e) {
803   if (!config->warnDebugInfoUnusable) {
804     consumeError(std::move(e));
805     return;
806   }
807   auto msg = "Cannot use debug info for '" + toString(f) + "' [LNK4099]";
808   if (e)
809     warn(msg + "\n>>> failed to load reference " + toString(std::move(e)));
810   else
811     warn(msg);
812 }
813
814 // Allocate memory for a .debug$S / .debug$F section and relocate it.
815 static ArrayRef<uint8_t> relocateDebugChunk(SectionChunk &debugChunk) {
816   uint8_t *buffer = bAlloc.Allocate<uint8_t>(debugChunk.getSize());
817   assert(debugChunk.getOutputSectionIdx() == 0 &&
818          "debug sections should not be in output sections");
819   debugChunk.writeTo(buffer);
820   return makeArrayRef(buffer, debugChunk.getSize());
821 }
822
823 void PDBLinker::addDebugSymbols(TpiSource *source) {
824   // If this TpiSource doesn't have an object file, it must be from a type
825   // server PDB. Type server PDBs do not contain symbols, so stop here.
826   if (!source->file)
827     return;
828
829   ScopedTimer t(symbolMergingTimer);
830   pdb::DbiStreamBuilder &dbiBuilder = builder.getDbiBuilder();
831   DebugSHandler dsh(*this, *source->file, source);
832   // Now do all live .debug$S and .debug$F sections.
833   for (SectionChunk *debugChunk : source->file->getDebugChunks()) {
834     if (!debugChunk->live || debugChunk->getSize() == 0)
835       continue;
836
837     bool isDebugS = debugChunk->getSectionName() == ".debug$S";
838     bool isDebugF = debugChunk->getSectionName() == ".debug$F";
839     if (!isDebugS && !isDebugF)
840       continue;
841
842     ArrayRef<uint8_t> relocatedDebugContents = relocateDebugChunk(*debugChunk);
843
844     if (isDebugS) {
845       dsh.handleDebugS(relocatedDebugContents);
846     } else if (isDebugF) {
847       FixedStreamArray<object::FpoData> fpoRecords;
848       BinaryStreamReader reader(relocatedDebugContents, support::little);
849       uint32_t count = relocatedDebugContents.size() / sizeof(object::FpoData);
850       exitOnErr(reader.readArray(fpoRecords, count));
851
852       // These are already relocated and don't refer to the string table, so we
853       // can just copy it.
854       for (const object::FpoData &fd : fpoRecords)
855         dbiBuilder.addOldFpoData(fd);
856     }
857   }
858
859   // Do any post-processing now that all .debug$S sections have been processed.
860   dsh.finish();
861 }
862
863 // Add a module descriptor for every object file. We need to put an absolute
864 // path to the object into the PDB. If this is a plain object, we make its
865 // path absolute. If it's an object in an archive, we make the archive path
866 // absolute.
867 static void createModuleDBI(pdb::PDBFileBuilder &builder, ObjFile *file) {
868   pdb::DbiStreamBuilder &dbiBuilder = builder.getDbiBuilder();
869   SmallString<128> objName;
870
871   bool inArchive = !file->parentName.empty();
872   objName = inArchive ? file->parentName : file->getName();
873   pdbMakeAbsolute(objName);
874   StringRef modName = inArchive ? file->getName() : StringRef(objName);
875
876   file->moduleDBI = &exitOnErr(dbiBuilder.addModuleInfo(modName));
877   file->moduleDBI->setObjFileName(objName);
878
879   ArrayRef<Chunk *> chunks = file->getChunks();
880   uint32_t modi = file->moduleDBI->getModuleIndex();
881
882   for (Chunk *c : chunks) {
883     auto *secChunk = dyn_cast<SectionChunk>(c);
884     if (!secChunk || !secChunk->live)
885       continue;
886     pdb::SectionContrib sc = createSectionContrib(secChunk, modi);
887     file->moduleDBI->setFirstSectionContrib(sc);
888     break;
889   }
890 }
891
892 void PDBLinker::addDebug(TpiSource *source) {
893   // Before we can process symbol substreams from .debug$S, we need to process
894   // type information, file checksums, and the string table. Add type info to
895   // the PDB first, so that we can get the map from object file type and item
896   // indices to PDB type and item indices.  If we are using ghashes, types have
897   // already been merged.
898   if (!config->debugGHashes) {
899     ScopedTimer t(typeMergingTimer);
900     if (Error e = source->mergeDebugT(&tMerger)) {
901       // If type merging failed, ignore the symbols.
902       warnUnusable(source->file, std::move(e));
903       return;
904     }
905   }
906
907   // If type merging failed, ignore the symbols.
908   Error typeError = std::move(source->typeMergingError);
909   if (typeError) {
910     warnUnusable(source->file, std::move(typeError));
911     return;
912   }
913
914   addDebugSymbols(source);
915 }
916
917 static pdb::BulkPublic createPublic(Defined *def) {
918   pdb::BulkPublic pub;
919   pub.Name = def->getName().data();
920   pub.NameLen = def->getName().size();
921
922   PublicSymFlags flags = PublicSymFlags::None;
923   if (auto *d = dyn_cast<DefinedCOFF>(def)) {
924     if (d->getCOFFSymbol().isFunctionDefinition())
925       flags = PublicSymFlags::Function;
926   } else if (isa<DefinedImportThunk>(def)) {
927     flags = PublicSymFlags::Function;
928   }
929   pub.setFlags(flags);
930
931   OutputSection *os = def->getChunk()->getOutputSection();
932   assert(os && "all publics should be in final image");
933   pub.Offset = def->getRVA() - os->getRVA();
934   pub.Segment = os->sectionIndex;
935   return pub;
936 }
937
938 // Add all object files to the PDB. Merge .debug$T sections into IpiData and
939 // TpiData.
940 void PDBLinker::addObjectsToPDB() {
941   ScopedTimer t1(addObjectsTimer);
942
943   // Create module descriptors
944   for_each(ObjFile::instances,
945            [&](ObjFile *obj) { createModuleDBI(builder, obj); });
946
947   // Reorder dependency type sources to come first.
948   TpiSource::sortDependencies();
949
950   // Merge type information from input files using global type hashing.
951   if (config->debugGHashes)
952     tMerger.mergeTypesWithGHash();
953
954   // Merge dependencies and then regular objects.
955   for_each(TpiSource::dependencySources,
956            [&](TpiSource *source) { addDebug(source); });
957   for_each(TpiSource::objectSources,
958            [&](TpiSource *source) { addDebug(source); });
959
960   builder.getStringTableBuilder().setStrings(pdbStrTab);
961   t1.stop();
962
963   // Construct TPI and IPI stream contents.
964   ScopedTimer t2(tpiStreamLayoutTimer);
965   // Collect all the merged types.
966   if (config->debugGHashes) {
967     addGHashTypeInfo(builder);
968   } else {
969     addTypeInfo(builder.getTpiBuilder(), tMerger.getTypeTable());
970     addTypeInfo(builder.getIpiBuilder(), tMerger.getIDTable());
971   }
972   t2.stop();
973 }
974
975 void PDBLinker::addPublicsToPDB() {
976   ScopedTimer t3(publicsLayoutTimer);
977   // Compute the public symbols.
978   auto &gsiBuilder = builder.getGsiBuilder();
979   std::vector<pdb::BulkPublic> publics;
980   symtab->forEachSymbol([&publics](Symbol *s) {
981     // Only emit external, defined, live symbols that have a chunk. Static,
982     // non-external symbols do not appear in the symbol table.
983     auto *def = dyn_cast<Defined>(s);
984     if (def && def->isLive() && def->getChunk())
985       publics.push_back(createPublic(def));
986   });
987
988   if (!publics.empty()) {
989     publicSymbols = publics.size();
990     gsiBuilder.addPublicSymbols(std::move(publics));
991   }
992 }
993
994 void PDBLinker::printStats() {
995   if (!config->showSummary)
996     return;
997
998   SmallString<256> buffer;
999   raw_svector_ostream stream(buffer);
1000
1001   stream << center_justify("Summary", 80) << '\n'
1002          << std::string(80, '-') << '\n';
1003
1004   auto print = [&](uint64_t v, StringRef s) {
1005     stream << format_decimal(v, 15) << " " << s << '\n';
1006   };
1007
1008   print(ObjFile::instances.size(),
1009         "Input OBJ files (expanded from all cmd-line inputs)");
1010   print(TpiSource::countTypeServerPDBs(), "PDB type server dependencies");
1011   print(TpiSource::countPrecompObjs(), "Precomp OBJ dependencies");
1012   print(builder.getTpiBuilder().getRecordCount(), "Merged TPI records");
1013   print(builder.getIpiBuilder().getRecordCount(), "Merged IPI records");
1014   print(pdbStrTab.size(), "Output PDB strings");
1015   print(globalSymbols, "Global symbol records");
1016   print(moduleSymbols, "Module symbol records");
1017   print(publicSymbols, "Public symbol records");
1018
1019   auto printLargeInputTypeRecs = [&](StringRef name,
1020                                      ArrayRef<uint32_t> recCounts,
1021                                      TypeCollection &records) {
1022     // Figure out which type indices were responsible for the most duplicate
1023     // bytes in the input files. These should be frequently emitted LF_CLASS and
1024     // LF_FIELDLIST records.
1025     struct TypeSizeInfo {
1026       uint32_t typeSize;
1027       uint32_t dupCount;
1028       TypeIndex typeIndex;
1029       uint64_t totalInputSize() const { return uint64_t(dupCount) * typeSize; }
1030       bool operator<(const TypeSizeInfo &rhs) const {
1031         if (totalInputSize() == rhs.totalInputSize())
1032           return typeIndex < rhs.typeIndex;
1033         return totalInputSize() < rhs.totalInputSize();
1034       }
1035     };
1036     SmallVector<TypeSizeInfo, 0> tsis;
1037     for (auto e : enumerate(recCounts)) {
1038       TypeIndex typeIndex = TypeIndex::fromArrayIndex(e.index());
1039       uint32_t typeSize = records.getType(typeIndex).length();
1040       uint32_t dupCount = e.value();
1041       tsis.push_back({typeSize, dupCount, typeIndex});
1042     }
1043
1044     if (!tsis.empty()) {
1045       stream << "\nTop 10 types responsible for the most " << name
1046              << " input:\n";
1047       stream << "       index     total bytes   count     size\n";
1048       llvm::sort(tsis);
1049       unsigned i = 0;
1050       for (const auto &tsi : reverse(tsis)) {
1051         stream << formatv("  {0,10:X}: {1,14:N} = {2,5:N} * {3,6:N}\n",
1052                           tsi.typeIndex.getIndex(), tsi.totalInputSize(),
1053                           tsi.dupCount, tsi.typeSize);
1054         if (++i >= 10)
1055           break;
1056       }
1057       stream
1058           << "Run llvm-pdbutil to print details about a particular record:\n";
1059       stream << formatv("llvm-pdbutil dump -{0}s -{0}-index {1:X} {2}\n",
1060                         (name == "TPI" ? "type" : "id"),
1061                         tsis.back().typeIndex.getIndex(), config->pdbPath);
1062     }
1063   };
1064
1065   if (!config->debugGHashes) {
1066     // FIXME: Reimplement for ghash.
1067     printLargeInputTypeRecs("TPI", tMerger.tpiCounts, tMerger.getTypeTable());
1068     printLargeInputTypeRecs("IPI", tMerger.ipiCounts, tMerger.getIDTable());
1069   }
1070
1071   message(buffer);
1072 }
1073
1074 void PDBLinker::addNatvisFiles() {
1075   for (StringRef file : config->natvisFiles) {
1076     ErrorOr<std::unique_ptr<MemoryBuffer>> dataOrErr =
1077         MemoryBuffer::getFile(file);
1078     if (!dataOrErr) {
1079       warn("Cannot open input file: " + file);
1080       continue;
1081     }
1082     builder.addInjectedSource(file, std::move(*dataOrErr));
1083   }
1084 }
1085
1086 void PDBLinker::addNamedStreams() {
1087   for (const auto &streamFile : config->namedStreams) {
1088     const StringRef stream = streamFile.getKey(), file = streamFile.getValue();
1089     ErrorOr<std::unique_ptr<MemoryBuffer>> dataOrErr =
1090         MemoryBuffer::getFile(file);
1091     if (!dataOrErr) {
1092       warn("Cannot open input file: " + file);
1093       continue;
1094     }
1095     exitOnErr(builder.addNamedStream(stream, (*dataOrErr)->getBuffer()));
1096   }
1097 }
1098
1099 static codeview::CPUType toCodeViewMachine(COFF::MachineTypes machine) {
1100   switch (machine) {
1101   case COFF::IMAGE_FILE_MACHINE_AMD64:
1102     return codeview::CPUType::X64;
1103   case COFF::IMAGE_FILE_MACHINE_ARM:
1104     return codeview::CPUType::ARM7;
1105   case COFF::IMAGE_FILE_MACHINE_ARM64:
1106     return codeview::CPUType::ARM64;
1107   case COFF::IMAGE_FILE_MACHINE_ARMNT:
1108     return codeview::CPUType::ARMNT;
1109   case COFF::IMAGE_FILE_MACHINE_I386:
1110     return codeview::CPUType::Intel80386;
1111   default:
1112     llvm_unreachable("Unsupported CPU Type");
1113   }
1114 }
1115
1116 // Mimic MSVC which surrounds arguments containing whitespace with quotes.
1117 // Double double-quotes are handled, so that the resulting string can be
1118 // executed again on the cmd-line.
1119 static std::string quote(ArrayRef<StringRef> args) {
1120   std::string r;
1121   r.reserve(256);
1122   for (StringRef a : args) {
1123     if (!r.empty())
1124       r.push_back(' ');
1125     bool hasWS = a.find(' ') != StringRef::npos;
1126     bool hasQ = a.find('"') != StringRef::npos;
1127     if (hasWS || hasQ)
1128       r.push_back('"');
1129     if (hasQ) {
1130       SmallVector<StringRef, 4> s;
1131       a.split(s, '"');
1132       r.append(join(s, "\"\""));
1133     } else {
1134       r.append(std::string(a));
1135     }
1136     if (hasWS || hasQ)
1137       r.push_back('"');
1138   }
1139   return r;
1140 }
1141
1142 static void fillLinkerVerRecord(Compile3Sym &cs) {
1143   cs.Machine = toCodeViewMachine(config->machine);
1144   // Interestingly, if we set the string to 0.0.0.0, then when trying to view
1145   // local variables WinDbg emits an error that private symbols are not present.
1146   // By setting this to a valid MSVC linker version string, local variables are
1147   // displayed properly.   As such, even though it is not representative of
1148   // LLVM's version information, we need this for compatibility.
1149   cs.Flags = CompileSym3Flags::None;
1150   cs.VersionBackendBuild = 25019;
1151   cs.VersionBackendMajor = 14;
1152   cs.VersionBackendMinor = 10;
1153   cs.VersionBackendQFE = 0;
1154
1155   // MSVC also sets the frontend to 0.0.0.0 since this is specifically for the
1156   // linker module (which is by definition a backend), so we don't need to do
1157   // anything here.  Also, it seems we can use "LLVM Linker" for the linker name
1158   // without any problems.  Only the backend version has to be hardcoded to a
1159   // magic number.
1160   cs.VersionFrontendBuild = 0;
1161   cs.VersionFrontendMajor = 0;
1162   cs.VersionFrontendMinor = 0;
1163   cs.VersionFrontendQFE = 0;
1164   cs.Version = "LLVM Linker";
1165   cs.setLanguage(SourceLanguage::Link);
1166 }
1167
1168 static void addCommonLinkerModuleSymbols(StringRef path,
1169                                          pdb::DbiModuleDescriptorBuilder &mod) {
1170   ObjNameSym ons(SymbolRecordKind::ObjNameSym);
1171   EnvBlockSym ebs(SymbolRecordKind::EnvBlockSym);
1172   Compile3Sym cs(SymbolRecordKind::Compile3Sym);
1173   fillLinkerVerRecord(cs);
1174
1175   ons.Name = "* Linker *";
1176   ons.Signature = 0;
1177
1178   ArrayRef<StringRef> args = makeArrayRef(config->argv).drop_front();
1179   std::string argStr = quote(args);
1180   ebs.Fields.push_back("cwd");
1181   SmallString<64> cwd;
1182   if (config->pdbSourcePath.empty())
1183     sys::fs::current_path(cwd);
1184   else
1185     cwd = config->pdbSourcePath;
1186   ebs.Fields.push_back(cwd);
1187   ebs.Fields.push_back("exe");
1188   SmallString<64> exe = config->argv[0];
1189   pdbMakeAbsolute(exe);
1190   ebs.Fields.push_back(exe);
1191   ebs.Fields.push_back("pdb");
1192   ebs.Fields.push_back(path);
1193   ebs.Fields.push_back("cmd");
1194   ebs.Fields.push_back(argStr);
1195   mod.addSymbol(codeview::SymbolSerializer::writeOneSymbol(
1196       ons, bAlloc, CodeViewContainer::Pdb));
1197   mod.addSymbol(codeview::SymbolSerializer::writeOneSymbol(
1198       cs, bAlloc, CodeViewContainer::Pdb));
1199   mod.addSymbol(codeview::SymbolSerializer::writeOneSymbol(
1200       ebs, bAlloc, CodeViewContainer::Pdb));
1201 }
1202
1203 static void addLinkerModuleCoffGroup(PartialSection *sec,
1204                                      pdb::DbiModuleDescriptorBuilder &mod,
1205                                      OutputSection &os) {
1206   // If there's a section, there's at least one chunk
1207   assert(!sec->chunks.empty());
1208   const Chunk *firstChunk = *sec->chunks.begin();
1209   const Chunk *lastChunk = *sec->chunks.rbegin();
1210
1211   // Emit COFF group
1212   CoffGroupSym cgs(SymbolRecordKind::CoffGroupSym);
1213   cgs.Name = sec->name;
1214   cgs.Segment = os.sectionIndex;
1215   cgs.Offset = firstChunk->getRVA() - os.getRVA();
1216   cgs.Size = lastChunk->getRVA() + lastChunk->getSize() - firstChunk->getRVA();
1217   cgs.Characteristics = sec->characteristics;
1218
1219   // Somehow .idata sections & sections groups in the debug symbol stream have
1220   // the "write" flag set. However the section header for the corresponding
1221   // .idata section doesn't have it.
1222   if (cgs.Name.startswith(".idata"))
1223     cgs.Characteristics |= llvm::COFF::IMAGE_SCN_MEM_WRITE;
1224
1225   mod.addSymbol(codeview::SymbolSerializer::writeOneSymbol(
1226       cgs, bAlloc, CodeViewContainer::Pdb));
1227 }
1228
1229 static void addLinkerModuleSectionSymbol(pdb::DbiModuleDescriptorBuilder &mod,
1230                                          OutputSection &os) {
1231   SectionSym sym(SymbolRecordKind::SectionSym);
1232   sym.Alignment = 12; // 2^12 = 4KB
1233   sym.Characteristics = os.header.Characteristics;
1234   sym.Length = os.getVirtualSize();
1235   sym.Name = os.name;
1236   sym.Rva = os.getRVA();
1237   sym.SectionNumber = os.sectionIndex;
1238   mod.addSymbol(codeview::SymbolSerializer::writeOneSymbol(
1239       sym, bAlloc, CodeViewContainer::Pdb));
1240
1241   // Skip COFF groups in MinGW because it adds a significant footprint to the
1242   // PDB, due to each function being in its own section
1243   if (config->mingw)
1244     return;
1245
1246   // Output COFF groups for individual chunks of this section.
1247   for (PartialSection *sec : os.contribSections) {
1248     addLinkerModuleCoffGroup(sec, mod, os);
1249   }
1250 }
1251
1252 // Add all import files as modules to the PDB.
1253 void PDBLinker::addImportFilesToPDB(ArrayRef<OutputSection *> outputSections) {
1254   if (ImportFile::instances.empty())
1255     return;
1256
1257   std::map<std::string, llvm::pdb::DbiModuleDescriptorBuilder *> dllToModuleDbi;
1258
1259   for (ImportFile *file : ImportFile::instances) {
1260     if (!file->live)
1261       continue;
1262
1263     if (!file->thunkSym)
1264       continue;
1265
1266     if (!file->thunkLive)
1267         continue;
1268
1269     std::string dll = StringRef(file->dllName).lower();
1270     llvm::pdb::DbiModuleDescriptorBuilder *&mod = dllToModuleDbi[dll];
1271     if (!mod) {
1272       pdb::DbiStreamBuilder &dbiBuilder = builder.getDbiBuilder();
1273       SmallString<128> libPath = file->parentName;
1274       pdbMakeAbsolute(libPath);
1275       sys::path::native(libPath);
1276
1277       // Name modules similar to MSVC's link.exe.
1278       // The first module is the simple dll filename
1279       llvm::pdb::DbiModuleDescriptorBuilder &firstMod =
1280           exitOnErr(dbiBuilder.addModuleInfo(file->dllName));
1281       firstMod.setObjFileName(libPath);
1282       pdb::SectionContrib sc =
1283           createSectionContrib(nullptr, llvm::pdb::kInvalidStreamIndex);
1284       firstMod.setFirstSectionContrib(sc);
1285
1286       // The second module is where the import stream goes.
1287       mod = &exitOnErr(dbiBuilder.addModuleInfo("Import:" + file->dllName));
1288       mod->setObjFileName(libPath);
1289     }
1290
1291     DefinedImportThunk *thunk = cast<DefinedImportThunk>(file->thunkSym);
1292     Chunk *thunkChunk = thunk->getChunk();
1293     OutputSection *thunkOS = thunkChunk->getOutputSection();
1294
1295     ObjNameSym ons(SymbolRecordKind::ObjNameSym);
1296     Compile3Sym cs(SymbolRecordKind::Compile3Sym);
1297     Thunk32Sym ts(SymbolRecordKind::Thunk32Sym);
1298     ScopeEndSym es(SymbolRecordKind::ScopeEndSym);
1299
1300     ons.Name = file->dllName;
1301     ons.Signature = 0;
1302
1303     fillLinkerVerRecord(cs);
1304
1305     ts.Name = thunk->getName();
1306     ts.Parent = 0;
1307     ts.End = 0;
1308     ts.Next = 0;
1309     ts.Thunk = ThunkOrdinal::Standard;
1310     ts.Length = thunkChunk->getSize();
1311     ts.Segment = thunkOS->sectionIndex;
1312     ts.Offset = thunkChunk->getRVA() - thunkOS->getRVA();
1313
1314     mod->addSymbol(codeview::SymbolSerializer::writeOneSymbol(
1315         ons, bAlloc, CodeViewContainer::Pdb));
1316     mod->addSymbol(codeview::SymbolSerializer::writeOneSymbol(
1317         cs, bAlloc, CodeViewContainer::Pdb));
1318
1319     SmallVector<SymbolScope, 4> scopes;
1320     CVSymbol newSym = codeview::SymbolSerializer::writeOneSymbol(
1321         ts, bAlloc, CodeViewContainer::Pdb);
1322     scopeStackOpen(scopes, mod->getNextSymbolOffset(), newSym);
1323
1324     mod->addSymbol(newSym);
1325
1326     newSym = codeview::SymbolSerializer::writeOneSymbol(es, bAlloc,
1327                                                         CodeViewContainer::Pdb);
1328     scopeStackClose(scopes, mod->getNextSymbolOffset(), file);
1329
1330     mod->addSymbol(newSym);
1331
1332     pdb::SectionContrib sc =
1333         createSectionContrib(thunk->getChunk(), mod->getModuleIndex());
1334     mod->setFirstSectionContrib(sc);
1335   }
1336 }
1337
1338 // Creates a PDB file.
1339 void lld::coff::createPDB(SymbolTable *symtab,
1340                           ArrayRef<OutputSection *> outputSections,
1341                           ArrayRef<uint8_t> sectionTable,
1342                           llvm::codeview::DebugInfo *buildId) {
1343   ScopedTimer t1(totalPdbLinkTimer);
1344   PDBLinker pdb(symtab);
1345
1346   pdb.initialize(buildId);
1347   pdb.addObjectsToPDB();
1348   pdb.addImportFilesToPDB(outputSections);
1349   pdb.addSections(outputSections, sectionTable);
1350   pdb.addNatvisFiles();
1351   pdb.addNamedStreams();
1352   pdb.addPublicsToPDB();
1353
1354   ScopedTimer t2(diskCommitTimer);
1355   codeview::GUID guid;
1356   pdb.commit(&guid);
1357   memcpy(&buildId->PDB70.Signature, &guid, 16);
1358
1359   t2.stop();
1360   t1.stop();
1361   pdb.printStats();
1362 }
1363
1364 void PDBLinker::initialize(llvm::codeview::DebugInfo *buildId) {
1365   exitOnErr(builder.initialize(4096)); // 4096 is blocksize
1366
1367   buildId->Signature.CVSignature = OMF::Signature::PDB70;
1368   // Signature is set to a hash of the PDB contents when the PDB is done.
1369   memset(buildId->PDB70.Signature, 0, 16);
1370   buildId->PDB70.Age = 1;
1371
1372   // Create streams in MSF for predefined streams, namely
1373   // PDB, TPI, DBI and IPI.
1374   for (int i = 0; i < (int)pdb::kSpecialStreamCount; ++i)
1375     exitOnErr(builder.getMsfBuilder().addStream(0));
1376
1377   // Add an Info stream.
1378   auto &infoBuilder = builder.getInfoBuilder();
1379   infoBuilder.setVersion(pdb::PdbRaw_ImplVer::PdbImplVC70);
1380   infoBuilder.setHashPDBContentsToGUID(true);
1381
1382   // Add an empty DBI stream.
1383   pdb::DbiStreamBuilder &dbiBuilder = builder.getDbiBuilder();
1384   dbiBuilder.setAge(buildId->PDB70.Age);
1385   dbiBuilder.setVersionHeader(pdb::PdbDbiV70);
1386   dbiBuilder.setMachineType(config->machine);
1387   // Technically we are not link.exe 14.11, but there are known cases where
1388   // debugging tools on Windows expect Microsoft-specific version numbers or
1389   // they fail to work at all.  Since we know we produce PDBs that are
1390   // compatible with LINK 14.11, we set that version number here.
1391   dbiBuilder.setBuildNumber(14, 11);
1392 }
1393
1394 void PDBLinker::addSections(ArrayRef<OutputSection *> outputSections,
1395                             ArrayRef<uint8_t> sectionTable) {
1396   // It's not entirely clear what this is, but the * Linker * module uses it.
1397   pdb::DbiStreamBuilder &dbiBuilder = builder.getDbiBuilder();
1398   nativePath = config->pdbPath;
1399   pdbMakeAbsolute(nativePath);
1400   uint32_t pdbFilePathNI = dbiBuilder.addECName(nativePath);
1401   auto &linkerModule = exitOnErr(dbiBuilder.addModuleInfo("* Linker *"));
1402   linkerModule.setPdbFilePathNI(pdbFilePathNI);
1403   addCommonLinkerModuleSymbols(nativePath, linkerModule);
1404
1405   // Add section contributions. They must be ordered by ascending RVA.
1406   for (OutputSection *os : outputSections) {
1407     addLinkerModuleSectionSymbol(linkerModule, *os);
1408     for (Chunk *c : os->chunks) {
1409       pdb::SectionContrib sc =
1410           createSectionContrib(c, linkerModule.getModuleIndex());
1411       builder.getDbiBuilder().addSectionContrib(sc);
1412     }
1413   }
1414
1415   // The * Linker * first section contrib is only used along with /INCREMENTAL,
1416   // to provide trampolines thunks for incremental function patching. Set this
1417   // as "unused" because LLD doesn't support /INCREMENTAL link.
1418   pdb::SectionContrib sc =
1419       createSectionContrib(nullptr, llvm::pdb::kInvalidStreamIndex);
1420   linkerModule.setFirstSectionContrib(sc);
1421
1422   // Add Section Map stream.
1423   ArrayRef<object::coff_section> sections = {
1424       (const object::coff_section *)sectionTable.data(),
1425       sectionTable.size() / sizeof(object::coff_section)};
1426   dbiBuilder.createSectionMap(sections);
1427
1428   // Add COFF section header stream.
1429   exitOnErr(
1430       dbiBuilder.addDbgStream(pdb::DbgHeaderType::SectionHdr, sectionTable));
1431 }
1432
1433 void PDBLinker::commit(codeview::GUID *guid) {
1434   ExitOnError exitOnErr((config->pdbPath + ": ").str());
1435   // Write to a file.
1436   exitOnErr(builder.commit(config->pdbPath, guid));
1437 }
1438
1439 static uint32_t getSecrelReloc() {
1440   switch (config->machine) {
1441   case AMD64:
1442     return COFF::IMAGE_REL_AMD64_SECREL;
1443   case I386:
1444     return COFF::IMAGE_REL_I386_SECREL;
1445   case ARMNT:
1446     return COFF::IMAGE_REL_ARM_SECREL;
1447   case ARM64:
1448     return COFF::IMAGE_REL_ARM64_SECREL;
1449   default:
1450     llvm_unreachable("unknown machine type");
1451   }
1452 }
1453
1454 // Try to find a line table for the given offset Addr into the given chunk C.
1455 // If a line table was found, the line table, the string and checksum tables
1456 // that are used to interpret the line table, and the offset of Addr in the line
1457 // table are stored in the output arguments. Returns whether a line table was
1458 // found.
1459 static bool findLineTable(const SectionChunk *c, uint32_t addr,
1460                           DebugStringTableSubsectionRef &cvStrTab,
1461                           DebugChecksumsSubsectionRef &checksums,
1462                           DebugLinesSubsectionRef &lines,
1463                           uint32_t &offsetInLinetable) {
1464   ExitOnError exitOnErr;
1465   uint32_t secrelReloc = getSecrelReloc();
1466
1467   for (SectionChunk *dbgC : c->file->getDebugChunks()) {
1468     if (dbgC->getSectionName() != ".debug$S")
1469       continue;
1470
1471     // Build a mapping of SECREL relocations in dbgC that refer to `c`.
1472     DenseMap<uint32_t, uint32_t> secrels;
1473     for (const coff_relocation &r : dbgC->getRelocs()) {
1474       if (r.Type != secrelReloc)
1475         continue;
1476
1477       if (auto *s = dyn_cast_or_null<DefinedRegular>(
1478               c->file->getSymbols()[r.SymbolTableIndex]))
1479         if (s->getChunk() == c)
1480           secrels[r.VirtualAddress] = s->getValue();
1481     }
1482
1483     ArrayRef<uint8_t> contents =
1484         SectionChunk::consumeDebugMagic(dbgC->getContents(), ".debug$S");
1485     DebugSubsectionArray subsections;
1486     BinaryStreamReader reader(contents, support::little);
1487     exitOnErr(reader.readArray(subsections, contents.size()));
1488
1489     for (const DebugSubsectionRecord &ss : subsections) {
1490       switch (ss.kind()) {
1491       case DebugSubsectionKind::StringTable: {
1492         assert(!cvStrTab.valid() &&
1493                "Encountered multiple string table subsections!");
1494         exitOnErr(cvStrTab.initialize(ss.getRecordData()));
1495         break;
1496       }
1497       case DebugSubsectionKind::FileChecksums:
1498         assert(!checksums.valid() &&
1499                "Encountered multiple checksum subsections!");
1500         exitOnErr(checksums.initialize(ss.getRecordData()));
1501         break;
1502       case DebugSubsectionKind::Lines: {
1503         ArrayRef<uint8_t> bytes;
1504         auto ref = ss.getRecordData();
1505         exitOnErr(ref.readLongestContiguousChunk(0, bytes));
1506         size_t offsetInDbgC = bytes.data() - dbgC->getContents().data();
1507
1508         // Check whether this line table refers to C.
1509         auto i = secrels.find(offsetInDbgC);
1510         if (i == secrels.end())
1511           break;
1512
1513         // Check whether this line table covers Addr in C.
1514         DebugLinesSubsectionRef linesTmp;
1515         exitOnErr(linesTmp.initialize(BinaryStreamReader(ref)));
1516         uint32_t offsetInC = i->second + linesTmp.header()->RelocOffset;
1517         if (addr < offsetInC || addr >= offsetInC + linesTmp.header()->CodeSize)
1518           break;
1519
1520         assert(!lines.header() &&
1521                "Encountered multiple line tables for function!");
1522         exitOnErr(lines.initialize(BinaryStreamReader(ref)));
1523         offsetInLinetable = addr - offsetInC;
1524         break;
1525       }
1526       default:
1527         break;
1528       }
1529
1530       if (cvStrTab.valid() && checksums.valid() && lines.header())
1531         return true;
1532     }
1533   }
1534
1535   return false;
1536 }
1537
1538 // Use CodeView line tables to resolve a file and line number for the given
1539 // offset into the given chunk and return them, or None if a line table was
1540 // not found.
1541 Optional<std::pair<StringRef, uint32_t>>
1542 lld::coff::getFileLineCodeView(const SectionChunk *c, uint32_t addr) {
1543   ExitOnError exitOnErr;
1544
1545   DebugStringTableSubsectionRef cvStrTab;
1546   DebugChecksumsSubsectionRef checksums;
1547   DebugLinesSubsectionRef lines;
1548   uint32_t offsetInLinetable;
1549
1550   if (!findLineTable(c, addr, cvStrTab, checksums, lines, offsetInLinetable))
1551     return None;
1552
1553   Optional<uint32_t> nameIndex;
1554   Optional<uint32_t> lineNumber;
1555   for (LineColumnEntry &entry : lines) {
1556     for (const LineNumberEntry &ln : entry.LineNumbers) {
1557       LineInfo li(ln.Flags);
1558       if (ln.Offset > offsetInLinetable) {
1559         if (!nameIndex) {
1560           nameIndex = entry.NameIndex;
1561           lineNumber = li.getStartLine();
1562         }
1563         StringRef filename =
1564             exitOnErr(getFileName(cvStrTab, checksums, *nameIndex));
1565         return std::make_pair(filename, *lineNumber);
1566       }
1567       nameIndex = entry.NameIndex;
1568       lineNumber = li.getStartLine();
1569     }
1570   }
1571   if (!nameIndex)
1572     return None;
1573   StringRef filename = exitOnErr(getFileName(cvStrTab, checksums, *nameIndex));
1574   return std::make_pair(filename, *lineNumber);
1575 }