Release script: correctly symlink clang-tools-extra into the build (PR22765)
[oota-llvm.git] / tools / dsymutil / DwarfLinker.cpp
1 //===- tools/dsymutil/DwarfLinker.cpp - Dwarf debug info linker -----------===//
2 //
3 //                             The LLVM Linker
4 //
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
7 //
8 //===----------------------------------------------------------------------===//
9 #include "DebugMap.h"
10 #include "BinaryHolder.h"
11 #include "DebugMap.h"
12 #include "dsymutil.h"
13 #include "llvm/ADT/IntervalMap.h"
14 #include "llvm/ADT/StringMap.h"
15 #include "llvm/ADT/STLExtras.h"
16 #include "llvm/CodeGen/AsmPrinter.h"
17 #include "llvm/CodeGen/DIE.h"
18 #include "llvm/Config/config.h"
19 #include "llvm/DebugInfo/DWARF/DWARFContext.h"
20 #include "llvm/DebugInfo/DWARF/DWARFDebugInfoEntry.h"
21 #include "llvm/DebugInfo/DWARF/DWARFFormValue.h"
22 #include "llvm/MC/MCAsmBackend.h"
23 #include "llvm/MC/MCAsmInfo.h"
24 #include "llvm/MC/MCContext.h"
25 #include "llvm/MC/MCCodeEmitter.h"
26 #include "llvm/MC/MCDwarf.h"
27 #include "llvm/MC/MCInstrInfo.h"
28 #include "llvm/MC/MCObjectFileInfo.h"
29 #include "llvm/MC/MCRegisterInfo.h"
30 #include "llvm/MC/MCStreamer.h"
31 #include "llvm/MC/MCSubtargetInfo.h"
32 #include "llvm/Object/MachO.h"
33 #include "llvm/Support/Dwarf.h"
34 #include "llvm/Support/LEB128.h"
35 #include "llvm/Support/TargetRegistry.h"
36 #include "llvm/Target/TargetMachine.h"
37 #include "llvm/Target/TargetOptions.h"
38 #include <string>
39 #include <tuple>
40
41 namespace llvm {
42 namespace dsymutil {
43
44 namespace {
45
46 void warn(const Twine &Warning, const Twine &Context) {
47   errs() << Twine("while processing ") + Context + ":\n";
48   errs() << Twine("warning: ") + Warning + "\n";
49 }
50
51 bool error(const Twine &Error, const Twine &Context) {
52   errs() << Twine("while processing ") + Context + ":\n";
53   errs() << Twine("error: ") + Error + "\n";
54   return false;
55 }
56
57 template <typename KeyT, typename ValT>
58 using HalfOpenIntervalMap =
59     IntervalMap<KeyT, ValT, IntervalMapImpl::NodeSizer<KeyT, ValT>::LeafSize,
60                 IntervalMapHalfOpenInfo<KeyT>>;
61
62 typedef HalfOpenIntervalMap<uint64_t, int64_t> FunctionIntervals;
63
64 // FIXME: Delete this structure.
65 struct PatchLocation {
66   DIE::value_iterator I;
67
68   PatchLocation() = default;
69   PatchLocation(DIE::value_iterator I) : I(I) {}
70
71   void set(uint64_t New) const {
72     assert(I);
73     const auto &Old = *I;
74     assert(Old.getType() == DIEValue::isInteger);
75     *I = DIEValue(Old.getAttribute(), Old.getForm(), DIEInteger(New));
76   }
77
78   uint64_t get() const {
79     assert(I);
80     return I->getDIEInteger().getValue();
81   }
82 };
83
84 class CompileUnit;
85 struct DeclMapInfo;
86 class NonRelocatableStringpool;
87
88 /// A DeclContext is a named program scope that is used for ODR
89 /// uniquing of types.
90 /// The set of DeclContext for the ODR-subject parts of a Dwarf link
91 /// is expanded (and uniqued) with each new object file processed. We
92 /// need to determine the context of each DIE in an linked object file
93 /// to see if the corresponding type has already been emitted.
94 ///
95 /// The contexts are conceptually organised as a tree (eg. a function
96 /// scope is contained in a namespace scope that contains other
97 /// scopes), but storing/accessing them in an actual tree is too
98 /// inefficient: we need to be able to very quickly query a context
99 /// for a given child context by name. Storing a StringMap in each
100 /// DeclContext would be too space inefficient.
101 /// The solution here is to give each DeclContext a link to its parent
102 /// (this allows to walk up the tree), but to query the existance of a
103 /// specific DeclContext using a separate DenseMap keyed on the hash
104 /// of the fully qualified name of the context.
105 class DeclContext {
106   unsigned QualifiedNameHash;
107   uint32_t Line;
108   uint32_t ByteSize;
109   uint16_t Tag;
110   StringRef Name;
111   StringRef File;
112   const DeclContext &Parent;
113   const DWARFDebugInfoEntryMinimal *LastSeenDIE;
114   uint32_t LastSeenCompileUnitID;
115   uint32_t CanonicalDIEOffset;
116
117   friend DeclMapInfo;
118
119 public:
120   typedef DenseSet<DeclContext *, DeclMapInfo> Map;
121
122   DeclContext()
123       : QualifiedNameHash(0), Line(0), ByteSize(0),
124         Tag(dwarf::DW_TAG_compile_unit), Name(), File(), Parent(*this),
125         LastSeenDIE(nullptr), LastSeenCompileUnitID(0), CanonicalDIEOffset(0) {}
126
127   DeclContext(unsigned Hash, uint32_t Line, uint32_t ByteSize, uint16_t Tag,
128               StringRef Name, StringRef File, const DeclContext &Parent,
129               const DWARFDebugInfoEntryMinimal *LastSeenDIE = nullptr,
130               unsigned CUId = 0)
131       : QualifiedNameHash(Hash), Line(Line), ByteSize(ByteSize), Tag(Tag),
132         Name(Name), File(File), Parent(Parent), LastSeenDIE(LastSeenDIE),
133         LastSeenCompileUnitID(CUId), CanonicalDIEOffset(0) {}
134
135   uint32_t getQualifiedNameHash() const { return QualifiedNameHash; }
136
137   bool setLastSeenDIE(CompileUnit &U, const DWARFDebugInfoEntryMinimal *Die);
138
139   uint32_t getCanonicalDIEOffset() const { return CanonicalDIEOffset; }
140   void setCanonicalDIEOffset(uint32_t Offset) { CanonicalDIEOffset = Offset; }
141
142   uint16_t getTag() const { return Tag; }
143   StringRef getName() const { return Name; }
144 };
145
146 /// Info type for the DenseMap storing the DeclContext pointers.
147 struct DeclMapInfo : private DenseMapInfo<DeclContext *> {
148   using DenseMapInfo<DeclContext *>::getEmptyKey;
149   using DenseMapInfo<DeclContext *>::getTombstoneKey;
150
151   static unsigned getHashValue(const DeclContext *Ctxt) {
152     return Ctxt->QualifiedNameHash;
153   }
154
155   static bool isEqual(const DeclContext *LHS, const DeclContext *RHS) {
156     if (RHS == getEmptyKey() || RHS == getTombstoneKey())
157       return RHS == LHS;
158     return LHS->QualifiedNameHash == RHS->QualifiedNameHash &&
159            LHS->Line == RHS->Line && LHS->ByteSize == RHS->ByteSize &&
160            LHS->Name.data() == RHS->Name.data() &&
161            LHS->File.data() == RHS->File.data() &&
162            LHS->Parent.QualifiedNameHash == RHS->Parent.QualifiedNameHash;
163   }
164 };
165
166 /// This class gives a tree-like API to the DenseMap that stores the
167 /// DeclContext objects. It also holds the BumpPtrAllocator where
168 /// these objects will be allocated.
169 class DeclContextTree {
170   BumpPtrAllocator Allocator;
171   DeclContext Root;
172   DeclContext::Map Contexts;
173
174 public:
175   /// Get the child of \a Context described by \a DIE in \a Unit. The
176   /// required strings will be interned in \a StringPool.
177   /// \returns The child DeclContext along with one bit that is set if
178   /// this context is invalid.
179   /// FIXME: the invalid bit along the return value is to emulate some
180   /// dsymutil-classic functionality. See the fucntion definition for
181   /// a more thorough discussion of its use.
182   PointerIntPair<DeclContext *, 1>
183   getChildDeclContext(DeclContext &Context,
184                       const DWARFDebugInfoEntryMinimal *DIE, CompileUnit &Unit,
185                       NonRelocatableStringpool &StringPool);
186
187   DeclContext &getRoot() { return Root; }
188 };
189
190 /// \brief Stores all information relating to a compile unit, be it in
191 /// its original instance in the object file to its brand new cloned
192 /// and linked DIE tree.
193 class CompileUnit {
194 public:
195   /// \brief Information gathered about a DIE in the object file.
196   struct DIEInfo {
197     int64_t AddrAdjust; ///< Address offset to apply to the described entity.
198     DeclContext *Ctxt;  ///< ODR Declaration context.
199     DIE *Clone;         ///< Cloned version of that DIE.
200     uint32_t ParentIdx; ///< The index of this DIE's parent.
201     bool Keep;          ///< Is the DIE part of the linked output?
202     bool InDebugMap;    ///< Was this DIE's entity found in the map?
203   };
204
205   CompileUnit(DWARFUnit &OrigUnit, unsigned ID, bool CanUseODR)
206       : OrigUnit(OrigUnit), ID(ID), LowPc(UINT64_MAX), HighPc(0), RangeAlloc(),
207         Ranges(RangeAlloc) {
208     Info.resize(OrigUnit.getNumDIEs());
209
210     const auto *CUDie = OrigUnit.getUnitDIE(false);
211     unsigned Lang = CUDie->getAttributeValueAsUnsignedConstant(
212         &OrigUnit, dwarf::DW_AT_language, 0);
213     HasODR = CanUseODR && (Lang == dwarf::DW_LANG_C_plus_plus ||
214                            Lang == dwarf::DW_LANG_C_plus_plus_03 ||
215                            Lang == dwarf::DW_LANG_C_plus_plus_11 ||
216                            Lang == dwarf::DW_LANG_C_plus_plus_14 ||
217                            Lang == dwarf::DW_LANG_ObjC_plus_plus);
218   }
219
220   CompileUnit(CompileUnit &&RHS)
221       : OrigUnit(RHS.OrigUnit), Info(std::move(RHS.Info)),
222         CUDie(std::move(RHS.CUDie)), StartOffset(RHS.StartOffset),
223         NextUnitOffset(RHS.NextUnitOffset), RangeAlloc(), Ranges(RangeAlloc) {
224     // The CompileUnit container has been 'reserve()'d with the right
225     // size. We cannot move the IntervalMap anyway.
226     llvm_unreachable("CompileUnits should not be moved.");
227   }
228
229   DWARFUnit &getOrigUnit() const { return OrigUnit; }
230
231   unsigned getUniqueID() const { return ID; }
232
233   DIE *getOutputUnitDIE() const { return CUDie; }
234   void setOutputUnitDIE(DIE *Die) { CUDie = Die; }
235
236   bool hasODR() const { return HasODR; }
237
238   DIEInfo &getInfo(unsigned Idx) { return Info[Idx]; }
239   const DIEInfo &getInfo(unsigned Idx) const { return Info[Idx]; }
240
241   uint64_t getStartOffset() const { return StartOffset; }
242   uint64_t getNextUnitOffset() const { return NextUnitOffset; }
243   void setStartOffset(uint64_t DebugInfoSize) { StartOffset = DebugInfoSize; }
244
245   uint64_t getLowPc() const { return LowPc; }
246   uint64_t getHighPc() const { return HighPc; }
247
248   Optional<PatchLocation> getUnitRangesAttribute() const {
249     return UnitRangeAttribute;
250   }
251   const FunctionIntervals &getFunctionRanges() const { return Ranges; }
252   const std::vector<PatchLocation> &getRangesAttributes() const {
253     return RangeAttributes;
254   }
255
256   const std::vector<std::pair<PatchLocation, int64_t>> &
257   getLocationAttributes() const {
258     return LocationAttributes;
259   }
260
261   /// \brief Compute the end offset for this unit. Must be
262   /// called after the CU's DIEs have been cloned.
263   /// \returns the next unit offset (which is also the current
264   /// debug_info section size).
265   uint64_t computeNextUnitOffset();
266
267   /// \brief Keep track of a forward reference to DIE \p Die in \p
268   /// RefUnit by \p Attr. The attribute should be fixed up later to
269   /// point to the absolute offset of \p Die in the debug_info section
270   /// or to the canonical offset of \p Ctxt if it is non-null.
271   void noteForwardReference(DIE *Die, const CompileUnit *RefUnit,
272                             DeclContext *Ctxt, PatchLocation Attr);
273
274   /// \brief Apply all fixups recored by noteForwardReference().
275   void fixupForwardReferences();
276
277   /// \brief Add a function range [\p LowPC, \p HighPC) that is
278   /// relocatad by applying offset \p PCOffset.
279   void addFunctionRange(uint64_t LowPC, uint64_t HighPC, int64_t PCOffset);
280
281   /// \brief Keep track of a DW_AT_range attribute that we will need to
282   /// patch up later.
283   void noteRangeAttribute(const DIE &Die, PatchLocation Attr);
284
285   /// \brief Keep track of a location attribute pointing to a location
286   /// list in the debug_loc section.
287   void noteLocationAttribute(PatchLocation Attr, int64_t PcOffset);
288
289   /// \brief Add a name accelerator entry for \p Die with \p Name
290   /// which is stored in the string table at \p Offset.
291   void addNameAccelerator(const DIE *Die, const char *Name, uint32_t Offset,
292                           bool SkipPubnamesSection = false);
293
294   /// \brief Add a type accelerator entry for \p Die with \p Name
295   /// which is stored in the string table at \p Offset.
296   void addTypeAccelerator(const DIE *Die, const char *Name, uint32_t Offset);
297
298   struct AccelInfo {
299     StringRef Name;      ///< Name of the entry.
300     const DIE *Die;      ///< DIE this entry describes.
301     uint32_t NameOffset; ///< Offset of Name in the string pool.
302     bool SkipPubSection; ///< Emit this entry only in the apple_* sections.
303
304     AccelInfo(StringRef Name, const DIE *Die, uint32_t NameOffset,
305               bool SkipPubSection = false)
306         : Name(Name), Die(Die), NameOffset(NameOffset),
307           SkipPubSection(SkipPubSection) {}
308   };
309
310   const std::vector<AccelInfo> &getPubnames() const { return Pubnames; }
311   const std::vector<AccelInfo> &getPubtypes() const { return Pubtypes; }
312
313   /// Get the full path for file \a FileNum in the line table
314   const char *getResolvedPath(unsigned FileNum) {
315     if (FileNum >= ResolvedPaths.size())
316       return nullptr;
317     return ResolvedPaths[FileNum].size() ? ResolvedPaths[FileNum].c_str()
318                                          : nullptr;
319   }
320
321   /// Set the fully resolved path for the line-table's file \a FileNum
322   /// to \a Path.
323   void setResolvedPath(unsigned FileNum, const std::string &Path) {
324     if (ResolvedPaths.size() <= FileNum)
325       ResolvedPaths.resize(FileNum + 1);
326     ResolvedPaths[FileNum] = Path;
327   }
328
329 private:
330   DWARFUnit &OrigUnit;
331   unsigned ID;
332   std::vector<DIEInfo> Info; ///< DIE info indexed by DIE index.
333   DIE *CUDie;                ///< Root of the linked DIE tree.
334
335   uint64_t StartOffset;
336   uint64_t NextUnitOffset;
337
338   uint64_t LowPc;
339   uint64_t HighPc;
340
341   /// \brief A list of attributes to fixup with the absolute offset of
342   /// a DIE in the debug_info section.
343   ///
344   /// The offsets for the attributes in this array couldn't be set while
345   /// cloning because for cross-cu forward refences the target DIE's
346   /// offset isn't known you emit the reference attribute.
347   std::vector<std::tuple<DIE *, const CompileUnit *, DeclContext *,
348                          PatchLocation>> ForwardDIEReferences;
349
350   FunctionIntervals::Allocator RangeAlloc;
351   /// \brief The ranges in that interval map are the PC ranges for
352   /// functions in this unit, associated with the PC offset to apply
353   /// to the addresses to get the linked address.
354   FunctionIntervals Ranges;
355
356   /// \brief DW_AT_ranges attributes to patch after we have gathered
357   /// all the unit's function addresses.
358   /// @{
359   std::vector<PatchLocation> RangeAttributes;
360   Optional<PatchLocation> UnitRangeAttribute;
361   /// @}
362
363   /// \brief Location attributes that need to be transfered from th
364   /// original debug_loc section to the liked one. They are stored
365   /// along with the PC offset that is to be applied to their
366   /// function's address.
367   std::vector<std::pair<PatchLocation, int64_t>> LocationAttributes;
368
369   /// \brief Accelerator entries for the unit, both for the pub*
370   /// sections and the apple* ones.
371   /// @{
372   std::vector<AccelInfo> Pubnames;
373   std::vector<AccelInfo> Pubtypes;
374   /// @}
375
376   /// Cached resolved paths from the line table.
377   std::vector<std::string> ResolvedPaths;
378
379   /// Is this unit subject to the ODR rule?
380   bool HasODR;
381 };
382
383 uint64_t CompileUnit::computeNextUnitOffset() {
384   NextUnitOffset = StartOffset + 11 /* Header size */;
385   // The root DIE might be null, meaning that the Unit had nothing to
386   // contribute to the linked output. In that case, we will emit the
387   // unit header without any actual DIE.
388   if (CUDie)
389     NextUnitOffset += CUDie->getSize();
390   return NextUnitOffset;
391 }
392
393 /// \brief Keep track of a forward cross-cu reference from this unit
394 /// to \p Die that lives in \p RefUnit.
395 void CompileUnit::noteForwardReference(DIE *Die, const CompileUnit *RefUnit,
396                                        DeclContext *Ctxt, PatchLocation Attr) {
397   ForwardDIEReferences.emplace_back(Die, RefUnit, Ctxt, Attr);
398 }
399
400 /// \brief Apply all fixups recorded by noteForwardReference().
401 void CompileUnit::fixupForwardReferences() {
402   for (const auto &Ref : ForwardDIEReferences) {
403     DIE *RefDie;
404     const CompileUnit *RefUnit;
405     PatchLocation Attr;
406     DeclContext *Ctxt;
407     std::tie(RefDie, RefUnit, Ctxt, Attr) = Ref;
408     if (Ctxt && Ctxt->getCanonicalDIEOffset())
409       Attr.set(Ctxt->getCanonicalDIEOffset());
410     else
411       Attr.set(RefDie->getOffset() + RefUnit->getStartOffset());
412   }
413 }
414
415 void CompileUnit::addFunctionRange(uint64_t FuncLowPc, uint64_t FuncHighPc,
416                                    int64_t PcOffset) {
417   Ranges.insert(FuncLowPc, FuncHighPc, PcOffset);
418   this->LowPc = std::min(LowPc, FuncLowPc + PcOffset);
419   this->HighPc = std::max(HighPc, FuncHighPc + PcOffset);
420 }
421
422 void CompileUnit::noteRangeAttribute(const DIE &Die, PatchLocation Attr) {
423   if (Die.getTag() != dwarf::DW_TAG_compile_unit)
424     RangeAttributes.push_back(Attr);
425   else
426     UnitRangeAttribute = Attr;
427 }
428
429 void CompileUnit::noteLocationAttribute(PatchLocation Attr, int64_t PcOffset) {
430   LocationAttributes.emplace_back(Attr, PcOffset);
431 }
432
433 /// \brief Add a name accelerator entry for \p Die with \p Name
434 /// which is stored in the string table at \p Offset.
435 void CompileUnit::addNameAccelerator(const DIE *Die, const char *Name,
436                                      uint32_t Offset, bool SkipPubSection) {
437   Pubnames.emplace_back(Name, Die, Offset, SkipPubSection);
438 }
439
440 /// \brief Add a type accelerator entry for \p Die with \p Name
441 /// which is stored in the string table at \p Offset.
442 void CompileUnit::addTypeAccelerator(const DIE *Die, const char *Name,
443                                      uint32_t Offset) {
444   Pubtypes.emplace_back(Name, Die, Offset, false);
445 }
446
447 /// \brief A string table that doesn't need relocations.
448 ///
449 /// We are doing a final link, no need for a string table that
450 /// has relocation entries for every reference to it. This class
451 /// provides this ablitity by just associating offsets with
452 /// strings.
453 class NonRelocatableStringpool {
454 public:
455   /// \brief Entries are stored into the StringMap and simply linked
456   /// together through the second element of this pair in order to
457   /// keep track of insertion order.
458   typedef StringMap<std::pair<uint32_t, StringMapEntryBase *>, BumpPtrAllocator>
459       MapTy;
460
461   NonRelocatableStringpool()
462       : CurrentEndOffset(0), Sentinel(0), Last(&Sentinel) {
463     // Legacy dsymutil puts an empty string at the start of the line
464     // table.
465     getStringOffset("");
466   }
467
468   /// \brief Get the offset of string \p S in the string table. This
469   /// can insert a new element or return the offset of a preexisitng
470   /// one.
471   uint32_t getStringOffset(StringRef S);
472
473   /// \brief Get permanent storage for \p S (but do not necessarily
474   /// emit \p S in the output section).
475   /// \returns The StringRef that points to permanent storage to use
476   /// in place of \p S.
477   StringRef internString(StringRef S);
478
479   // \brief Return the first entry of the string table.
480   const MapTy::MapEntryTy *getFirstEntry() const {
481     return getNextEntry(&Sentinel);
482   }
483
484   // \brief Get the entry following \p E in the string table or null
485   // if \p E was the last entry.
486   const MapTy::MapEntryTy *getNextEntry(const MapTy::MapEntryTy *E) const {
487     return static_cast<const MapTy::MapEntryTy *>(E->getValue().second);
488   }
489
490   uint64_t getSize() { return CurrentEndOffset; }
491
492 private:
493   MapTy Strings;
494   uint32_t CurrentEndOffset;
495   MapTy::MapEntryTy Sentinel, *Last;
496 };
497
498 /// \brief Get the offset of string \p S in the string table. This
499 /// can insert a new element or return the offset of a preexisitng
500 /// one.
501 uint32_t NonRelocatableStringpool::getStringOffset(StringRef S) {
502   if (S.empty() && !Strings.empty())
503     return 0;
504
505   std::pair<uint32_t, StringMapEntryBase *> Entry(0, nullptr);
506   MapTy::iterator It;
507   bool Inserted;
508
509   // A non-empty string can't be at offset 0, so if we have an entry
510   // with a 0 offset, it must be a previously interned string.
511   std::tie(It, Inserted) = Strings.insert(std::make_pair(S, Entry));
512   if (Inserted || It->getValue().first == 0) {
513     // Set offset and chain at the end of the entries list.
514     It->getValue().first = CurrentEndOffset;
515     CurrentEndOffset += S.size() + 1; // +1 for the '\0'.
516     Last->getValue().second = &*It;
517     Last = &*It;
518   }
519   return It->getValue().first;
520 }
521
522 /// \brief Put \p S into the StringMap so that it gets permanent
523 /// storage, but do not actually link it in the chain of elements
524 /// that go into the output section. A latter call to
525 /// getStringOffset() with the same string will chain it though.
526 StringRef NonRelocatableStringpool::internString(StringRef S) {
527   std::pair<uint32_t, StringMapEntryBase *> Entry(0, nullptr);
528   auto InsertResult = Strings.insert(std::make_pair(S, Entry));
529   return InsertResult.first->getKey();
530 }
531
532 /// \brief The Dwarf streaming logic
533 ///
534 /// All interactions with the MC layer that is used to build the debug
535 /// information binary representation are handled in this class.
536 class DwarfStreamer {
537   /// \defgroup MCObjects MC layer objects constructed by the streamer
538   /// @{
539   std::unique_ptr<MCRegisterInfo> MRI;
540   std::unique_ptr<MCAsmInfo> MAI;
541   std::unique_ptr<MCObjectFileInfo> MOFI;
542   std::unique_ptr<MCContext> MC;
543   MCAsmBackend *MAB; // Owned by MCStreamer
544   std::unique_ptr<MCInstrInfo> MII;
545   std::unique_ptr<MCSubtargetInfo> MSTI;
546   MCCodeEmitter *MCE; // Owned by MCStreamer
547   MCStreamer *MS;     // Owned by AsmPrinter
548   std::unique_ptr<TargetMachine> TM;
549   std::unique_ptr<AsmPrinter> Asm;
550   /// @}
551
552   /// \brief the file we stream the linked Dwarf to.
553   std::unique_ptr<raw_fd_ostream> OutFile;
554
555   uint32_t RangesSectionSize;
556   uint32_t LocSectionSize;
557   uint32_t LineSectionSize;
558   uint32_t FrameSectionSize;
559
560   /// \brief Emit the pubnames or pubtypes section contribution for \p
561   /// Unit into \p Sec. The data is provided in \p Names.
562   void emitPubSectionForUnit(MCSection *Sec, StringRef Name,
563                              const CompileUnit &Unit,
564                              const std::vector<CompileUnit::AccelInfo> &Names);
565
566 public:
567   /// \brief Actually create the streamer and the ouptut file.
568   ///
569   /// This could be done directly in the constructor, but it feels
570   /// more natural to handle errors through return value.
571   bool init(Triple TheTriple, StringRef OutputFilename);
572
573   /// \brief Dump the file to the disk.
574   bool finish();
575
576   AsmPrinter &getAsmPrinter() const { return *Asm; }
577
578   /// \brief Set the current output section to debug_info and change
579   /// the MC Dwarf version to \p DwarfVersion.
580   void switchToDebugInfoSection(unsigned DwarfVersion);
581
582   /// \brief Emit the compilation unit header for \p Unit in the
583   /// debug_info section.
584   ///
585   /// As a side effect, this also switches the current Dwarf version
586   /// of the MC layer to the one of U.getOrigUnit().
587   void emitCompileUnitHeader(CompileUnit &Unit);
588
589   /// \brief Recursively emit the DIE tree rooted at \p Die.
590   void emitDIE(DIE &Die);
591
592   /// \brief Emit the abbreviation table \p Abbrevs to the
593   /// debug_abbrev section.
594   void emitAbbrevs(const std::vector<DIEAbbrev *> &Abbrevs);
595
596   /// \brief Emit the string table described by \p Pool.
597   void emitStrings(const NonRelocatableStringpool &Pool);
598
599   /// \brief Emit debug_ranges for \p FuncRange by translating the
600   /// original \p Entries.
601   void emitRangesEntries(
602       int64_t UnitPcOffset, uint64_t OrigLowPc,
603       FunctionIntervals::const_iterator FuncRange,
604       const std::vector<DWARFDebugRangeList::RangeListEntry> &Entries,
605       unsigned AddressSize);
606
607   /// \brief Emit debug_aranges entries for \p Unit and if \p
608   /// DoRangesSection is true, also emit the debug_ranges entries for
609   /// the DW_TAG_compile_unit's DW_AT_ranges attribute.
610   void emitUnitRangesEntries(CompileUnit &Unit, bool DoRangesSection);
611
612   uint32_t getRangesSectionSize() const { return RangesSectionSize; }
613
614   /// \brief Emit the debug_loc contribution for \p Unit by copying
615   /// the entries from \p Dwarf and offseting them. Update the
616   /// location attributes to point to the new entries.
617   void emitLocationsForUnit(const CompileUnit &Unit, DWARFContext &Dwarf);
618
619   /// \brief Emit the line table described in \p Rows into the
620   /// debug_line section.
621   void emitLineTableForUnit(MCDwarfLineTableParams Params,
622                             StringRef PrologueBytes, unsigned MinInstLength,
623                             std::vector<DWARFDebugLine::Row> &Rows,
624                             unsigned AdddressSize);
625
626   uint32_t getLineSectionSize() const { return LineSectionSize; }
627
628   /// \brief Emit the .debug_pubnames contribution for \p Unit.
629   void emitPubNamesForUnit(const CompileUnit &Unit);
630
631   /// \brief Emit the .debug_pubtypes contribution for \p Unit.
632   void emitPubTypesForUnit(const CompileUnit &Unit);
633
634   /// \brief Emit a CIE.
635   void emitCIE(StringRef CIEBytes);
636
637   /// \brief Emit an FDE with data \p Bytes.
638   void emitFDE(uint32_t CIEOffset, uint32_t AddreSize, uint32_t Address,
639                StringRef Bytes);
640
641   uint32_t getFrameSectionSize() const { return FrameSectionSize; }
642 };
643
644 bool DwarfStreamer::init(Triple TheTriple, StringRef OutputFilename) {
645   std::string ErrorStr;
646   std::string TripleName;
647   StringRef Context = "dwarf streamer init";
648
649   // Get the target.
650   const Target *TheTarget =
651       TargetRegistry::lookupTarget(TripleName, TheTriple, ErrorStr);
652   if (!TheTarget)
653     return error(ErrorStr, Context);
654   TripleName = TheTriple.getTriple();
655
656   // Create all the MC Objects.
657   MRI.reset(TheTarget->createMCRegInfo(TripleName));
658   if (!MRI)
659     return error(Twine("no register info for target ") + TripleName, Context);
660
661   MAI.reset(TheTarget->createMCAsmInfo(*MRI, TripleName));
662   if (!MAI)
663     return error("no asm info for target " + TripleName, Context);
664
665   MOFI.reset(new MCObjectFileInfo);
666   MC.reset(new MCContext(MAI.get(), MRI.get(), MOFI.get()));
667   MOFI->InitMCObjectFileInfo(TheTriple, Reloc::Default, CodeModel::Default,
668                              *MC);
669
670   MAB = TheTarget->createMCAsmBackend(*MRI, TripleName, "");
671   if (!MAB)
672     return error("no asm backend for target " + TripleName, Context);
673
674   MII.reset(TheTarget->createMCInstrInfo());
675   if (!MII)
676     return error("no instr info info for target " + TripleName, Context);
677
678   MSTI.reset(TheTarget->createMCSubtargetInfo(TripleName, "", ""));
679   if (!MSTI)
680     return error("no subtarget info for target " + TripleName, Context);
681
682   MCE = TheTarget->createMCCodeEmitter(*MII, *MRI, *MC);
683   if (!MCE)
684     return error("no code emitter for target " + TripleName, Context);
685
686   // Create the output file.
687   std::error_code EC;
688   OutFile =
689       llvm::make_unique<raw_fd_ostream>(OutputFilename, EC, sys::fs::F_None);
690   if (EC)
691     return error(Twine(OutputFilename) + ": " + EC.message(), Context);
692
693   MS = TheTarget->createMCObjectStreamer(TheTriple, *MC, *MAB, *OutFile, MCE,
694                                          *MSTI, false,
695                                          /*DWARFMustBeAtTheEnd*/ false);
696   if (!MS)
697     return error("no object streamer for target " + TripleName, Context);
698
699   // Finally create the AsmPrinter we'll use to emit the DIEs.
700   TM.reset(TheTarget->createTargetMachine(TripleName, "", "", TargetOptions()));
701   if (!TM)
702     return error("no target machine for target " + TripleName, Context);
703
704   Asm.reset(TheTarget->createAsmPrinter(*TM, std::unique_ptr<MCStreamer>(MS)));
705   if (!Asm)
706     return error("no asm printer for target " + TripleName, Context);
707
708   RangesSectionSize = 0;
709   LocSectionSize = 0;
710   LineSectionSize = 0;
711   FrameSectionSize = 0;
712
713   return true;
714 }
715
716 bool DwarfStreamer::finish() {
717   MS->Finish();
718   return true;
719 }
720
721 /// \brief Set the current output section to debug_info and change
722 /// the MC Dwarf version to \p DwarfVersion.
723 void DwarfStreamer::switchToDebugInfoSection(unsigned DwarfVersion) {
724   MS->SwitchSection(MOFI->getDwarfInfoSection());
725   MC->setDwarfVersion(DwarfVersion);
726 }
727
728 /// \brief Emit the compilation unit header for \p Unit in the
729 /// debug_info section.
730 ///
731 /// A Dwarf scetion header is encoded as:
732 ///  uint32_t   Unit length (omiting this field)
733 ///  uint16_t   Version
734 ///  uint32_t   Abbreviation table offset
735 ///  uint8_t    Address size
736 ///
737 /// Leading to a total of 11 bytes.
738 void DwarfStreamer::emitCompileUnitHeader(CompileUnit &Unit) {
739   unsigned Version = Unit.getOrigUnit().getVersion();
740   switchToDebugInfoSection(Version);
741
742   // Emit size of content not including length itself. The size has
743   // already been computed in CompileUnit::computeOffsets(). Substract
744   // 4 to that size to account for the length field.
745   Asm->EmitInt32(Unit.getNextUnitOffset() - Unit.getStartOffset() - 4);
746   Asm->EmitInt16(Version);
747   // We share one abbreviations table across all units so it's always at the
748   // start of the section.
749   Asm->EmitInt32(0);
750   Asm->EmitInt8(Unit.getOrigUnit().getAddressByteSize());
751 }
752
753 /// \brief Emit the \p Abbrevs array as the shared abbreviation table
754 /// for the linked Dwarf file.
755 void DwarfStreamer::emitAbbrevs(const std::vector<DIEAbbrev *> &Abbrevs) {
756   MS->SwitchSection(MOFI->getDwarfAbbrevSection());
757   Asm->emitDwarfAbbrevs(Abbrevs);
758 }
759
760 /// \brief Recursively emit the DIE tree rooted at \p Die.
761 void DwarfStreamer::emitDIE(DIE &Die) {
762   MS->SwitchSection(MOFI->getDwarfInfoSection());
763   Asm->emitDwarfDIE(Die);
764 }
765
766 /// \brief Emit the debug_str section stored in \p Pool.
767 void DwarfStreamer::emitStrings(const NonRelocatableStringpool &Pool) {
768   Asm->OutStreamer->SwitchSection(MOFI->getDwarfStrSection());
769   for (auto *Entry = Pool.getFirstEntry(); Entry;
770        Entry = Pool.getNextEntry(Entry))
771     Asm->OutStreamer->EmitBytes(
772         StringRef(Entry->getKey().data(), Entry->getKey().size() + 1));
773 }
774
775 /// \brief Emit the debug_range section contents for \p FuncRange by
776 /// translating the original \p Entries. The debug_range section
777 /// format is totally trivial, consisting just of pairs of address
778 /// sized addresses describing the ranges.
779 void DwarfStreamer::emitRangesEntries(
780     int64_t UnitPcOffset, uint64_t OrigLowPc,
781     FunctionIntervals::const_iterator FuncRange,
782     const std::vector<DWARFDebugRangeList::RangeListEntry> &Entries,
783     unsigned AddressSize) {
784   MS->SwitchSection(MC->getObjectFileInfo()->getDwarfRangesSection());
785
786   // Offset each range by the right amount.
787   int64_t PcOffset = FuncRange.value() + UnitPcOffset;
788   for (const auto &Range : Entries) {
789     if (Range.isBaseAddressSelectionEntry(AddressSize)) {
790       warn("unsupported base address selection operation",
791            "emitting debug_ranges");
792       break;
793     }
794     // Do not emit empty ranges.
795     if (Range.StartAddress == Range.EndAddress)
796       continue;
797
798     // All range entries should lie in the function range.
799     if (!(Range.StartAddress + OrigLowPc >= FuncRange.start() &&
800           Range.EndAddress + OrigLowPc <= FuncRange.stop()))
801       warn("inconsistent range data.", "emitting debug_ranges");
802     MS->EmitIntValue(Range.StartAddress + PcOffset, AddressSize);
803     MS->EmitIntValue(Range.EndAddress + PcOffset, AddressSize);
804     RangesSectionSize += 2 * AddressSize;
805   }
806
807   // Add the terminator entry.
808   MS->EmitIntValue(0, AddressSize);
809   MS->EmitIntValue(0, AddressSize);
810   RangesSectionSize += 2 * AddressSize;
811 }
812
813 /// \brief Emit the debug_aranges contribution of a unit and
814 /// if \p DoDebugRanges is true the debug_range contents for a
815 /// compile_unit level DW_AT_ranges attribute (Which are basically the
816 /// same thing with a different base address).
817 /// Just aggregate all the ranges gathered inside that unit.
818 void DwarfStreamer::emitUnitRangesEntries(CompileUnit &Unit,
819                                           bool DoDebugRanges) {
820   unsigned AddressSize = Unit.getOrigUnit().getAddressByteSize();
821   // Gather the ranges in a vector, so that we can simplify them. The
822   // IntervalMap will have coalesced the non-linked ranges, but here
823   // we want to coalesce the linked addresses.
824   std::vector<std::pair<uint64_t, uint64_t>> Ranges;
825   const auto &FunctionRanges = Unit.getFunctionRanges();
826   for (auto Range = FunctionRanges.begin(), End = FunctionRanges.end();
827        Range != End; ++Range)
828     Ranges.push_back(std::make_pair(Range.start() + Range.value(),
829                                     Range.stop() + Range.value()));
830
831   // The object addresses where sorted, but again, the linked
832   // addresses might end up in a different order.
833   std::sort(Ranges.begin(), Ranges.end());
834
835   if (!Ranges.empty()) {
836     MS->SwitchSection(MC->getObjectFileInfo()->getDwarfARangesSection());
837
838     MCSymbol *BeginLabel = Asm->createTempSymbol("Barange");
839     MCSymbol *EndLabel = Asm->createTempSymbol("Earange");
840
841     unsigned HeaderSize =
842         sizeof(int32_t) + // Size of contents (w/o this field
843         sizeof(int16_t) + // DWARF ARange version number
844         sizeof(int32_t) + // Offset of CU in the .debug_info section
845         sizeof(int8_t) +  // Pointer Size (in bytes)
846         sizeof(int8_t);   // Segment Size (in bytes)
847
848     unsigned TupleSize = AddressSize * 2;
849     unsigned Padding = OffsetToAlignment(HeaderSize, TupleSize);
850
851     Asm->EmitLabelDifference(EndLabel, BeginLabel, 4); // Arange length
852     Asm->OutStreamer->EmitLabel(BeginLabel);
853     Asm->EmitInt16(dwarf::DW_ARANGES_VERSION); // Version number
854     Asm->EmitInt32(Unit.getStartOffset());     // Corresponding unit's offset
855     Asm->EmitInt8(AddressSize);                // Address size
856     Asm->EmitInt8(0);                          // Segment size
857
858     Asm->OutStreamer->EmitFill(Padding, 0x0);
859
860     for (auto Range = Ranges.begin(), End = Ranges.end(); Range != End;
861          ++Range) {
862       uint64_t RangeStart = Range->first;
863       MS->EmitIntValue(RangeStart, AddressSize);
864       while ((Range + 1) != End && Range->second == (Range + 1)->first)
865         ++Range;
866       MS->EmitIntValue(Range->second - RangeStart, AddressSize);
867     }
868
869     // Emit terminator
870     Asm->OutStreamer->EmitIntValue(0, AddressSize);
871     Asm->OutStreamer->EmitIntValue(0, AddressSize);
872     Asm->OutStreamer->EmitLabel(EndLabel);
873   }
874
875   if (!DoDebugRanges)
876     return;
877
878   MS->SwitchSection(MC->getObjectFileInfo()->getDwarfRangesSection());
879   // Offset each range by the right amount.
880   int64_t PcOffset = -Unit.getLowPc();
881   // Emit coalesced ranges.
882   for (auto Range = Ranges.begin(), End = Ranges.end(); Range != End; ++Range) {
883     MS->EmitIntValue(Range->first + PcOffset, AddressSize);
884     while (Range + 1 != End && Range->second == (Range + 1)->first)
885       ++Range;
886     MS->EmitIntValue(Range->second + PcOffset, AddressSize);
887     RangesSectionSize += 2 * AddressSize;
888   }
889
890   // Add the terminator entry.
891   MS->EmitIntValue(0, AddressSize);
892   MS->EmitIntValue(0, AddressSize);
893   RangesSectionSize += 2 * AddressSize;
894 }
895
896 /// \brief Emit location lists for \p Unit and update attribtues to
897 /// point to the new entries.
898 void DwarfStreamer::emitLocationsForUnit(const CompileUnit &Unit,
899                                          DWARFContext &Dwarf) {
900   const auto &Attributes = Unit.getLocationAttributes();
901
902   if (Attributes.empty())
903     return;
904
905   MS->SwitchSection(MC->getObjectFileInfo()->getDwarfLocSection());
906
907   unsigned AddressSize = Unit.getOrigUnit().getAddressByteSize();
908   const DWARFSection &InputSec = Dwarf.getLocSection();
909   DataExtractor Data(InputSec.Data, Dwarf.isLittleEndian(), AddressSize);
910   DWARFUnit &OrigUnit = Unit.getOrigUnit();
911   const auto *OrigUnitDie = OrigUnit.getUnitDIE(false);
912   int64_t UnitPcOffset = 0;
913   uint64_t OrigLowPc = OrigUnitDie->getAttributeValueAsAddress(
914       &OrigUnit, dwarf::DW_AT_low_pc, -1ULL);
915   if (OrigLowPc != -1ULL)
916     UnitPcOffset = int64_t(OrigLowPc) - Unit.getLowPc();
917
918   for (const auto &Attr : Attributes) {
919     uint32_t Offset = Attr.first.get();
920     Attr.first.set(LocSectionSize);
921     // This is the quantity to add to the old location address to get
922     // the correct address for the new one.
923     int64_t LocPcOffset = Attr.second + UnitPcOffset;
924     while (Data.isValidOffset(Offset)) {
925       uint64_t Low = Data.getUnsigned(&Offset, AddressSize);
926       uint64_t High = Data.getUnsigned(&Offset, AddressSize);
927       LocSectionSize += 2 * AddressSize;
928       if (Low == 0 && High == 0) {
929         Asm->OutStreamer->EmitIntValue(0, AddressSize);
930         Asm->OutStreamer->EmitIntValue(0, AddressSize);
931         break;
932       }
933       Asm->OutStreamer->EmitIntValue(Low + LocPcOffset, AddressSize);
934       Asm->OutStreamer->EmitIntValue(High + LocPcOffset, AddressSize);
935       uint64_t Length = Data.getU16(&Offset);
936       Asm->OutStreamer->EmitIntValue(Length, 2);
937       // Just copy the bytes over.
938       Asm->OutStreamer->EmitBytes(
939           StringRef(InputSec.Data.substr(Offset, Length)));
940       Offset += Length;
941       LocSectionSize += Length + 2;
942     }
943   }
944 }
945
946 void DwarfStreamer::emitLineTableForUnit(MCDwarfLineTableParams Params,
947                                          StringRef PrologueBytes,
948                                          unsigned MinInstLength,
949                                          std::vector<DWARFDebugLine::Row> &Rows,
950                                          unsigned PointerSize) {
951   // Switch to the section where the table will be emitted into.
952   MS->SwitchSection(MC->getObjectFileInfo()->getDwarfLineSection());
953   MCSymbol *LineStartSym = MC->createTempSymbol();
954   MCSymbol *LineEndSym = MC->createTempSymbol();
955
956   // The first 4 bytes is the total length of the information for this
957   // compilation unit (not including these 4 bytes for the length).
958   Asm->EmitLabelDifference(LineEndSym, LineStartSym, 4);
959   Asm->OutStreamer->EmitLabel(LineStartSym);
960   // Copy Prologue.
961   MS->EmitBytes(PrologueBytes);
962   LineSectionSize += PrologueBytes.size() + 4;
963
964   SmallString<128> EncodingBuffer;
965   raw_svector_ostream EncodingOS(EncodingBuffer);
966
967   if (Rows.empty()) {
968     // We only have the dummy entry, dsymutil emits an entry with a 0
969     // address in that case.
970     MCDwarfLineAddr::Encode(*MC, Params, INT64_MAX, 0, EncodingOS);
971     MS->EmitBytes(EncodingOS.str());
972     LineSectionSize += EncodingBuffer.size();
973     MS->EmitLabel(LineEndSym);
974     return;
975   }
976
977   // Line table state machine fields
978   unsigned FileNum = 1;
979   unsigned LastLine = 1;
980   unsigned Column = 0;
981   unsigned IsStatement = 1;
982   unsigned Isa = 0;
983   uint64_t Address = -1ULL;
984
985   unsigned RowsSinceLastSequence = 0;
986
987   for (unsigned Idx = 0; Idx < Rows.size(); ++Idx) {
988     auto &Row = Rows[Idx];
989
990     int64_t AddressDelta;
991     if (Address == -1ULL) {
992       MS->EmitIntValue(dwarf::DW_LNS_extended_op, 1);
993       MS->EmitULEB128IntValue(PointerSize + 1);
994       MS->EmitIntValue(dwarf::DW_LNE_set_address, 1);
995       MS->EmitIntValue(Row.Address, PointerSize);
996       LineSectionSize += 2 + PointerSize + getULEB128Size(PointerSize + 1);
997       AddressDelta = 0;
998     } else {
999       AddressDelta = (Row.Address - Address) / MinInstLength;
1000     }
1001
1002     // FIXME: code copied and transfromed from
1003     // MCDwarf.cpp::EmitDwarfLineTable. We should find a way to share
1004     // this code, but the current compatibility requirement with
1005     // classic dsymutil makes it hard. Revisit that once this
1006     // requirement is dropped.
1007
1008     if (FileNum != Row.File) {
1009       FileNum = Row.File;
1010       MS->EmitIntValue(dwarf::DW_LNS_set_file, 1);
1011       MS->EmitULEB128IntValue(FileNum);
1012       LineSectionSize += 1 + getULEB128Size(FileNum);
1013     }
1014     if (Column != Row.Column) {
1015       Column = Row.Column;
1016       MS->EmitIntValue(dwarf::DW_LNS_set_column, 1);
1017       MS->EmitULEB128IntValue(Column);
1018       LineSectionSize += 1 + getULEB128Size(Column);
1019     }
1020
1021     // FIXME: We should handle the discriminator here, but dsymutil
1022     // doesn' consider it, thus ignore it for now.
1023
1024     if (Isa != Row.Isa) {
1025       Isa = Row.Isa;
1026       MS->EmitIntValue(dwarf::DW_LNS_set_isa, 1);
1027       MS->EmitULEB128IntValue(Isa);
1028       LineSectionSize += 1 + getULEB128Size(Isa);
1029     }
1030     if (IsStatement != Row.IsStmt) {
1031       IsStatement = Row.IsStmt;
1032       MS->EmitIntValue(dwarf::DW_LNS_negate_stmt, 1);
1033       LineSectionSize += 1;
1034     }
1035     if (Row.BasicBlock) {
1036       MS->EmitIntValue(dwarf::DW_LNS_set_basic_block, 1);
1037       LineSectionSize += 1;
1038     }
1039
1040     if (Row.PrologueEnd) {
1041       MS->EmitIntValue(dwarf::DW_LNS_set_prologue_end, 1);
1042       LineSectionSize += 1;
1043     }
1044
1045     if (Row.EpilogueBegin) {
1046       MS->EmitIntValue(dwarf::DW_LNS_set_epilogue_begin, 1);
1047       LineSectionSize += 1;
1048     }
1049
1050     int64_t LineDelta = int64_t(Row.Line) - LastLine;
1051     if (!Row.EndSequence) {
1052       MCDwarfLineAddr::Encode(*MC, Params, LineDelta, AddressDelta, EncodingOS);
1053       MS->EmitBytes(EncodingOS.str());
1054       LineSectionSize += EncodingBuffer.size();
1055       EncodingBuffer.resize(0);
1056       Address = Row.Address;
1057       LastLine = Row.Line;
1058       RowsSinceLastSequence++;
1059     } else {
1060       if (LineDelta) {
1061         MS->EmitIntValue(dwarf::DW_LNS_advance_line, 1);
1062         MS->EmitSLEB128IntValue(LineDelta);
1063         LineSectionSize += 1 + getSLEB128Size(LineDelta);
1064       }
1065       if (AddressDelta) {
1066         MS->EmitIntValue(dwarf::DW_LNS_advance_pc, 1);
1067         MS->EmitULEB128IntValue(AddressDelta);
1068         LineSectionSize += 1 + getULEB128Size(AddressDelta);
1069       }
1070       MCDwarfLineAddr::Encode(*MC, Params, INT64_MAX, 0, EncodingOS);
1071       MS->EmitBytes(EncodingOS.str());
1072       LineSectionSize += EncodingBuffer.size();
1073       EncodingBuffer.resize(0);
1074       Address = -1ULL;
1075       LastLine = FileNum = IsStatement = 1;
1076       RowsSinceLastSequence = Column = Isa = 0;
1077     }
1078   }
1079
1080   if (RowsSinceLastSequence) {
1081     MCDwarfLineAddr::Encode(*MC, Params, INT64_MAX, 0, EncodingOS);
1082     MS->EmitBytes(EncodingOS.str());
1083     LineSectionSize += EncodingBuffer.size();
1084     EncodingBuffer.resize(0);
1085   }
1086
1087   MS->EmitLabel(LineEndSym);
1088 }
1089
1090 /// \brief Emit the pubnames or pubtypes section contribution for \p
1091 /// Unit into \p Sec. The data is provided in \p Names.
1092 void DwarfStreamer::emitPubSectionForUnit(
1093     MCSection *Sec, StringRef SecName, const CompileUnit &Unit,
1094     const std::vector<CompileUnit::AccelInfo> &Names) {
1095   if (Names.empty())
1096     return;
1097
1098   // Start the dwarf pubnames section.
1099   Asm->OutStreamer->SwitchSection(Sec);
1100   MCSymbol *BeginLabel = Asm->createTempSymbol("pub" + SecName + "_begin");
1101   MCSymbol *EndLabel = Asm->createTempSymbol("pub" + SecName + "_end");
1102
1103   bool HeaderEmitted = false;
1104   // Emit the pubnames for this compilation unit.
1105   for (const auto &Name : Names) {
1106     if (Name.SkipPubSection)
1107       continue;
1108
1109     if (!HeaderEmitted) {
1110       // Emit the header.
1111       Asm->EmitLabelDifference(EndLabel, BeginLabel, 4); // Length
1112       Asm->OutStreamer->EmitLabel(BeginLabel);
1113       Asm->EmitInt16(dwarf::DW_PUBNAMES_VERSION); // Version
1114       Asm->EmitInt32(Unit.getStartOffset());      // Unit offset
1115       Asm->EmitInt32(Unit.getNextUnitOffset() - Unit.getStartOffset()); // Size
1116       HeaderEmitted = true;
1117     }
1118     Asm->EmitInt32(Name.Die->getOffset());
1119     Asm->OutStreamer->EmitBytes(
1120         StringRef(Name.Name.data(), Name.Name.size() + 1));
1121   }
1122
1123   if (!HeaderEmitted)
1124     return;
1125   Asm->EmitInt32(0); // End marker.
1126   Asm->OutStreamer->EmitLabel(EndLabel);
1127 }
1128
1129 /// \brief Emit .debug_pubnames for \p Unit.
1130 void DwarfStreamer::emitPubNamesForUnit(const CompileUnit &Unit) {
1131   emitPubSectionForUnit(MC->getObjectFileInfo()->getDwarfPubNamesSection(),
1132                         "names", Unit, Unit.getPubnames());
1133 }
1134
1135 /// \brief Emit .debug_pubtypes for \p Unit.
1136 void DwarfStreamer::emitPubTypesForUnit(const CompileUnit &Unit) {
1137   emitPubSectionForUnit(MC->getObjectFileInfo()->getDwarfPubTypesSection(),
1138                         "types", Unit, Unit.getPubtypes());
1139 }
1140
1141 /// \brief Emit a CIE into the debug_frame section.
1142 void DwarfStreamer::emitCIE(StringRef CIEBytes) {
1143   MS->SwitchSection(MC->getObjectFileInfo()->getDwarfFrameSection());
1144
1145   MS->EmitBytes(CIEBytes);
1146   FrameSectionSize += CIEBytes.size();
1147 }
1148
1149 /// \brief Emit a FDE into the debug_frame section. \p FDEBytes
1150 /// contains the FDE data without the length, CIE offset and address
1151 /// which will be replaced with the paramter values.
1152 void DwarfStreamer::emitFDE(uint32_t CIEOffset, uint32_t AddrSize,
1153                             uint32_t Address, StringRef FDEBytes) {
1154   MS->SwitchSection(MC->getObjectFileInfo()->getDwarfFrameSection());
1155
1156   MS->EmitIntValue(FDEBytes.size() + 4 + AddrSize, 4);
1157   MS->EmitIntValue(CIEOffset, 4);
1158   MS->EmitIntValue(Address, AddrSize);
1159   MS->EmitBytes(FDEBytes);
1160   FrameSectionSize += FDEBytes.size() + 8 + AddrSize;
1161 }
1162
1163 /// \brief The core of the Dwarf linking logic.
1164 ///
1165 /// The link of the dwarf information from the object files will be
1166 /// driven by the selection of 'root DIEs', which are DIEs that
1167 /// describe variables or functions that are present in the linked
1168 /// binary (and thus have entries in the debug map). All the debug
1169 /// information that will be linked (the DIEs, but also the line
1170 /// tables, ranges, ...) is derived from that set of root DIEs.
1171 ///
1172 /// The root DIEs are identified because they contain relocations that
1173 /// correspond to a debug map entry at specific places (the low_pc for
1174 /// a function, the location for a variable). These relocations are
1175 /// called ValidRelocs in the DwarfLinker and are gathered as a very
1176 /// first step when we start processing a DebugMapObject.
1177 class DwarfLinker {
1178 public:
1179   DwarfLinker(StringRef OutputFilename, const LinkOptions &Options)
1180       : OutputFilename(OutputFilename), Options(Options),
1181         BinHolder(Options.Verbose), LastCIEOffset(0) {}
1182
1183   ~DwarfLinker() {
1184     for (auto *Abbrev : Abbreviations)
1185       delete Abbrev;
1186   }
1187
1188   /// \brief Link the contents of the DebugMap.
1189   bool link(const DebugMap &);
1190
1191 private:
1192   /// \brief Called at the start of a debug object link.
1193   void startDebugObject(DWARFContext &, DebugMapObject &);
1194
1195   /// \brief Called at the end of a debug object link.
1196   void endDebugObject();
1197
1198   /// \defgroup FindValidRelocations Translate debug map into a list
1199   /// of relevant relocations
1200   ///
1201   /// @{
1202   struct ValidReloc {
1203     uint32_t Offset;
1204     uint32_t Size;
1205     uint64_t Addend;
1206     const DebugMapObject::DebugMapEntry *Mapping;
1207
1208     ValidReloc(uint32_t Offset, uint32_t Size, uint64_t Addend,
1209                const DebugMapObject::DebugMapEntry *Mapping)
1210         : Offset(Offset), Size(Size), Addend(Addend), Mapping(Mapping) {}
1211
1212     bool operator<(const ValidReloc &RHS) const { return Offset < RHS.Offset; }
1213   };
1214
1215   /// \brief The valid relocations for the current DebugMapObject.
1216   /// This vector is sorted by relocation offset.
1217   std::vector<ValidReloc> ValidRelocs;
1218
1219   /// \brief Index into ValidRelocs of the next relocation to
1220   /// consider. As we walk the DIEs in acsending file offset and as
1221   /// ValidRelocs is sorted by file offset, keeping this index
1222   /// uptodate is all we have to do to have a cheap lookup during the
1223   /// root DIE selection and during DIE cloning.
1224   unsigned NextValidReloc;
1225
1226   bool findValidRelocsInDebugInfo(const object::ObjectFile &Obj,
1227                                   const DebugMapObject &DMO);
1228
1229   bool findValidRelocs(const object::SectionRef &Section,
1230                        const object::ObjectFile &Obj,
1231                        const DebugMapObject &DMO);
1232
1233   void findValidRelocsMachO(const object::SectionRef &Section,
1234                             const object::MachOObjectFile &Obj,
1235                             const DebugMapObject &DMO);
1236   /// @}
1237
1238   /// \defgroup FindRootDIEs Find DIEs corresponding to debug map entries.
1239   ///
1240   /// @{
1241   /// \brief Recursively walk the \p DIE tree and look for DIEs to
1242   /// keep. Store that information in \p CU's DIEInfo.
1243   void lookForDIEsToKeep(const DWARFDebugInfoEntryMinimal &DIE,
1244                          const DebugMapObject &DMO, CompileUnit &CU,
1245                          unsigned Flags);
1246
1247   /// \brief Flags passed to DwarfLinker::lookForDIEsToKeep
1248   enum TravesalFlags {
1249     TF_Keep = 1 << 0,            ///< Mark the traversed DIEs as kept.
1250     TF_InFunctionScope = 1 << 1, ///< Current scope is a fucntion scope.
1251     TF_DependencyWalk = 1 << 2,  ///< Walking the dependencies of a kept DIE.
1252     TF_ParentWalk = 1 << 3,      ///< Walking up the parents of a kept DIE.
1253     TF_ODR = 1 << 4,             ///< Use the ODR whhile keeping dependants.
1254   };
1255
1256   /// \brief Mark the passed DIE as well as all the ones it depends on
1257   /// as kept.
1258   void keepDIEAndDenpendencies(const DWARFDebugInfoEntryMinimal &DIE,
1259                                CompileUnit::DIEInfo &MyInfo,
1260                                const DebugMapObject &DMO, CompileUnit &CU,
1261                                bool UseODR);
1262
1263   unsigned shouldKeepDIE(const DWARFDebugInfoEntryMinimal &DIE,
1264                          CompileUnit &Unit, CompileUnit::DIEInfo &MyInfo,
1265                          unsigned Flags);
1266
1267   unsigned shouldKeepVariableDIE(const DWARFDebugInfoEntryMinimal &DIE,
1268                                  CompileUnit &Unit,
1269                                  CompileUnit::DIEInfo &MyInfo, unsigned Flags);
1270
1271   unsigned shouldKeepSubprogramDIE(const DWARFDebugInfoEntryMinimal &DIE,
1272                                    CompileUnit &Unit,
1273                                    CompileUnit::DIEInfo &MyInfo,
1274                                    unsigned Flags);
1275
1276   bool hasValidRelocation(uint32_t StartOffset, uint32_t EndOffset,
1277                           CompileUnit::DIEInfo &Info);
1278   /// @}
1279
1280   /// \defgroup Linking Methods used to link the debug information
1281   ///
1282   /// @{
1283   /// \brief Recursively clone \p InputDIE into an tree of DIE objects
1284   /// where useless (as decided by lookForDIEsToKeep()) bits have been
1285   /// stripped out and addresses have been rewritten according to the
1286   /// debug map.
1287   ///
1288   /// \param OutOffset is the offset the cloned DIE in the output
1289   /// compile unit.
1290   /// \param PCOffset (while cloning a function scope) is the offset
1291   /// applied to the entry point of the function to get the linked address.
1292   ///
1293   /// \returns the root of the cloned tree.
1294   DIE *cloneDIE(const DWARFDebugInfoEntryMinimal &InputDIE, CompileUnit &U,
1295                 int64_t PCOffset, uint32_t OutOffset);
1296
1297   typedef DWARFAbbreviationDeclaration::AttributeSpec AttributeSpec;
1298
1299   /// \brief Information gathered and exchanged between the various
1300   /// clone*Attributes helpers about the attributes of a particular DIE.
1301   struct AttributesInfo {
1302     const char *Name, *MangledName;         ///< Names.
1303     uint32_t NameOffset, MangledNameOffset; ///< Offsets in the string pool.
1304
1305     uint64_t OrigHighPc; ///< Value of AT_high_pc in the input DIE
1306     int64_t PCOffset;    ///< Offset to apply to PC addresses inside a function.
1307
1308     bool HasLowPc;      ///< Does the DIE have a low_pc attribute?
1309     bool IsDeclaration; ///< Is this DIE only a declaration?
1310
1311     AttributesInfo()
1312         : Name(nullptr), MangledName(nullptr), NameOffset(0),
1313           MangledNameOffset(0), OrigHighPc(0), PCOffset(0), HasLowPc(false),
1314           IsDeclaration(false) {}
1315   };
1316
1317   /// \brief Helper for cloneDIE.
1318   unsigned cloneAttribute(DIE &Die, const DWARFDebugInfoEntryMinimal &InputDIE,
1319                           CompileUnit &U, const DWARFFormValue &Val,
1320                           const AttributeSpec AttrSpec, unsigned AttrSize,
1321                           AttributesInfo &AttrInfo);
1322
1323   /// \brief Helper for cloneDIE.
1324   unsigned cloneStringAttribute(DIE &Die, AttributeSpec AttrSpec,
1325                                 const DWARFFormValue &Val, const DWARFUnit &U);
1326
1327   /// \brief Helper for cloneDIE.
1328   unsigned
1329   cloneDieReferenceAttribute(DIE &Die,
1330                              const DWARFDebugInfoEntryMinimal &InputDIE,
1331                              AttributeSpec AttrSpec, unsigned AttrSize,
1332                              const DWARFFormValue &Val, CompileUnit &Unit);
1333
1334   /// \brief Helper for cloneDIE.
1335   unsigned cloneBlockAttribute(DIE &Die, AttributeSpec AttrSpec,
1336                                const DWARFFormValue &Val, unsigned AttrSize);
1337
1338   /// \brief Helper for cloneDIE.
1339   unsigned cloneAddressAttribute(DIE &Die, AttributeSpec AttrSpec,
1340                                  const DWARFFormValue &Val,
1341                                  const CompileUnit &Unit, AttributesInfo &Info);
1342
1343   /// \brief Helper for cloneDIE.
1344   unsigned cloneScalarAttribute(DIE &Die,
1345                                 const DWARFDebugInfoEntryMinimal &InputDIE,
1346                                 CompileUnit &U, AttributeSpec AttrSpec,
1347                                 const DWARFFormValue &Val, unsigned AttrSize,
1348                                 AttributesInfo &Info);
1349
1350   /// \brief Helper for cloneDIE.
1351   bool applyValidRelocs(MutableArrayRef<char> Data, uint32_t BaseOffset,
1352                         bool isLittleEndian);
1353
1354   /// \brief Assign an abbreviation number to \p Abbrev
1355   void AssignAbbrev(DIEAbbrev &Abbrev);
1356
1357   /// \brief FoldingSet that uniques the abbreviations.
1358   FoldingSet<DIEAbbrev> AbbreviationsSet;
1359   /// \brief Storage for the unique Abbreviations.
1360   /// This is passed to AsmPrinter::emitDwarfAbbrevs(), thus it cannot
1361   /// be changed to a vecot of unique_ptrs.
1362   std::vector<DIEAbbrev *> Abbreviations;
1363
1364   /// \brief Compute and emit debug_ranges section for \p Unit, and
1365   /// patch the attributes referencing it.
1366   void patchRangesForUnit(const CompileUnit &Unit, DWARFContext &Dwarf) const;
1367
1368   /// \brief Generate and emit the DW_AT_ranges attribute for a
1369   /// compile_unit if it had one.
1370   void generateUnitRanges(CompileUnit &Unit) const;
1371
1372   /// \brief Extract the line tables fromt he original dwarf, extract
1373   /// the relevant parts according to the linked function ranges and
1374   /// emit the result in the debug_line section.
1375   void patchLineTableForUnit(CompileUnit &Unit, DWARFContext &OrigDwarf);
1376
1377   /// \brief Emit the accelerator entries for \p Unit.
1378   void emitAcceleratorEntriesForUnit(CompileUnit &Unit);
1379
1380   /// \brief Patch the frame info for an object file and emit it.
1381   void patchFrameInfoForObject(const DebugMapObject &, DWARFContext &,
1382                                unsigned AddressSize);
1383
1384   /// \brief DIELoc objects that need to be destructed (but not freed!).
1385   std::vector<DIELoc *> DIELocs;
1386   /// \brief DIEBlock objects that need to be destructed (but not freed!).
1387   std::vector<DIEBlock *> DIEBlocks;
1388   /// \brief Allocator used for all the DIEValue objects.
1389   BumpPtrAllocator DIEAlloc;
1390   /// @}
1391
1392   /// ODR Contexts for that link.
1393   DeclContextTree ODRContexts;
1394
1395   /// \defgroup Helpers Various helper methods.
1396   ///
1397   /// @{
1398   const DWARFDebugInfoEntryMinimal *
1399   resolveDIEReference(const DWARFFormValue &RefValue, const DWARFUnit &Unit,
1400                       const DWARFDebugInfoEntryMinimal &DIE,
1401                       CompileUnit *&ReferencedCU);
1402
1403   CompileUnit *getUnitForOffset(unsigned Offset);
1404
1405   bool getDIENames(const DWARFDebugInfoEntryMinimal &Die, DWARFUnit &U,
1406                    AttributesInfo &Info);
1407
1408   void reportWarning(const Twine &Warning, const DWARFUnit *Unit = nullptr,
1409                      const DWARFDebugInfoEntryMinimal *DIE = nullptr) const;
1410
1411   bool createStreamer(Triple TheTriple, StringRef OutputFilename);
1412
1413   /// \brief Attempt to load a debug object from disk.
1414   ErrorOr<const object::ObjectFile &> loadObject(BinaryHolder &BinaryHolder,
1415                                                  DebugMapObject &Obj,
1416                                                  const DebugMap &Map);
1417   /// @}
1418
1419 private:
1420   std::string OutputFilename;
1421   LinkOptions Options;
1422   BinaryHolder BinHolder;
1423   std::unique_ptr<DwarfStreamer> Streamer;
1424
1425   /// The units of the current debug map object.
1426   std::vector<CompileUnit> Units;
1427
1428   /// The debug map object curently under consideration.
1429   DebugMapObject *CurrentDebugObject;
1430
1431   /// \brief The Dwarf string pool
1432   NonRelocatableStringpool StringPool;
1433
1434   /// \brief This map is keyed by the entry PC of functions in that
1435   /// debug object and the associated value is a pair storing the
1436   /// corresponding end PC and the offset to apply to get the linked
1437   /// address.
1438   ///
1439   /// See startDebugObject() for a more complete description of its use.
1440   std::map<uint64_t, std::pair<uint64_t, int64_t>> Ranges;
1441
1442   /// \brief The CIEs that have been emitted in the output
1443   /// section. The actual CIE data serves a the key to this StringMap,
1444   /// this takes care of comparing the semantics of CIEs defined in
1445   /// different object files.
1446   StringMap<uint32_t> EmittedCIEs;
1447
1448   /// Offset of the last CIE that has been emitted in the output
1449   /// debug_frame section.
1450   uint32_t LastCIEOffset;
1451 };
1452
1453 /// \brief Similar to DWARFUnitSection::getUnitForOffset(), but
1454 /// returning our CompileUnit object instead.
1455 CompileUnit *DwarfLinker::getUnitForOffset(unsigned Offset) {
1456   auto CU =
1457       std::upper_bound(Units.begin(), Units.end(), Offset,
1458                        [](uint32_t LHS, const CompileUnit &RHS) {
1459                          return LHS < RHS.getOrigUnit().getNextUnitOffset();
1460                        });
1461   return CU != Units.end() ? &*CU : nullptr;
1462 }
1463
1464 /// \brief Resolve the DIE attribute reference that has been
1465 /// extracted in \p RefValue. The resulting DIE migh be in another
1466 /// CompileUnit which is stored into \p ReferencedCU.
1467 /// \returns null if resolving fails for any reason.
1468 const DWARFDebugInfoEntryMinimal *DwarfLinker::resolveDIEReference(
1469     const DWARFFormValue &RefValue, const DWARFUnit &Unit,
1470     const DWARFDebugInfoEntryMinimal &DIE, CompileUnit *&RefCU) {
1471   assert(RefValue.isFormClass(DWARFFormValue::FC_Reference));
1472   uint64_t RefOffset = *RefValue.getAsReference(&Unit);
1473
1474   if ((RefCU = getUnitForOffset(RefOffset)))
1475     if (const auto *RefDie = RefCU->getOrigUnit().getDIEForOffset(RefOffset))
1476       return RefDie;
1477
1478   reportWarning("could not find referenced DIE", &Unit, &DIE);
1479   return nullptr;
1480 }
1481
1482 /// \returns whether the passed \a Attr type might contain a DIE
1483 /// reference suitable for ODR uniquing.
1484 static bool isODRAttribute(uint16_t Attr) {
1485   switch (Attr) {
1486   default:
1487     return false;
1488   case dwarf::DW_AT_type:
1489   case dwarf::DW_AT_containing_type:
1490   case dwarf::DW_AT_specification:
1491   case dwarf::DW_AT_abstract_origin:
1492   case dwarf::DW_AT_import:
1493     return true;
1494   }
1495   llvm_unreachable("Improper attribute.");
1496 }
1497
1498 /// Set the last DIE/CU a context was seen in and, possibly invalidate
1499 /// the context if it is ambiguous.
1500 ///
1501 /// In the current implementation, we don't handle overloaded
1502 /// functions well, because the argument types are not taken into
1503 /// account when computing the DeclContext tree.
1504 ///
1505 /// Some of this is mitigated byt using mangled names that do contain
1506 /// the arguments types, but sometimes (eg. with function templates)
1507 /// we don't have that. In that case, just do not unique anything that
1508 /// refers to the contexts we are not able to distinguish.
1509 ///
1510 /// If a context that is not a namespace appears twice in the same CU,
1511 /// we know it is ambiguous. Make it invalid.
1512 bool DeclContext::setLastSeenDIE(CompileUnit &U,
1513                                  const DWARFDebugInfoEntryMinimal *Die) {
1514   if (LastSeenCompileUnitID == U.getUniqueID()) {
1515     DWARFUnit &OrigUnit = U.getOrigUnit();
1516     uint32_t FirstIdx = OrigUnit.getDIEIndex(LastSeenDIE);
1517     U.getInfo(FirstIdx).Ctxt = nullptr;
1518     return false;
1519   }
1520
1521   LastSeenCompileUnitID = U.getUniqueID();
1522   LastSeenDIE = Die;
1523   return true;
1524 }
1525
1526 /// Get the child context of \a Context corresponding to \a DIE.
1527 ///
1528 /// \returns the child context or null if we shouldn't track children
1529 /// contexts. It also returns an additional bit meaning 'invalid'. An
1530 /// invalid context means it shouldn't be considered for uniquing, but
1531 /// its not returning null, because some children of that context
1532 /// might be uniquing candidates.
1533 /// FIXME: this is for dsymutil-classic compatibility, I don't think
1534 /// it buys us much.
1535 PointerIntPair<DeclContext *, 1> DeclContextTree::getChildDeclContext(
1536     DeclContext &Context, const DWARFDebugInfoEntryMinimal *DIE, CompileUnit &U,
1537     NonRelocatableStringpool &StringPool) {
1538   unsigned Tag = DIE->getTag();
1539
1540   // FIXME: dsymutil-classic compat: We should bail out here if we
1541   // have a specification or an abstract_origin. We will get the
1542   // parent context wrong here.
1543
1544   switch (Tag) {
1545   default:
1546     // By default stop gathering child contexts.
1547     return PointerIntPair<DeclContext *, 1>(nullptr);
1548   case dwarf::DW_TAG_compile_unit:
1549     // FIXME: Add support for DW_TAG_module.
1550     return PointerIntPair<DeclContext *, 1>(&Context);
1551   case dwarf::DW_TAG_subprogram:
1552     // Do not unique anything inside CU local functions.
1553     if ((Context.getTag() == dwarf::DW_TAG_namespace ||
1554          Context.getTag() == dwarf::DW_TAG_compile_unit) &&
1555         !DIE->getAttributeValueAsUnsignedConstant(&U.getOrigUnit(),
1556                                                   dwarf::DW_AT_external, 0))
1557       return PointerIntPair<DeclContext *, 1>(nullptr);
1558   // Fallthrough
1559   case dwarf::DW_TAG_member:
1560   case dwarf::DW_TAG_namespace:
1561   case dwarf::DW_TAG_structure_type:
1562   case dwarf::DW_TAG_class_type:
1563   case dwarf::DW_TAG_union_type:
1564   case dwarf::DW_TAG_enumeration_type:
1565   case dwarf::DW_TAG_typedef:
1566     // Artificial things might be ambiguous, because they might be
1567     // created on demand. For example implicitely defined constructors
1568     // are ambiguous because of the way we identify contexts, and they
1569     // won't be generated everytime everywhere.
1570     if (DIE->getAttributeValueAsUnsignedConstant(&U.getOrigUnit(),
1571                                                  dwarf::DW_AT_artificial, 0))
1572       return PointerIntPair<DeclContext *, 1>(nullptr);
1573     break;
1574   }
1575
1576   const char *Name = DIE->getName(&U.getOrigUnit(), DINameKind::LinkageName);
1577   const char *ShortName = DIE->getName(&U.getOrigUnit(), DINameKind::ShortName);
1578   StringRef NameRef;
1579   StringRef ShortNameRef;
1580   StringRef FileRef;
1581
1582   if (Name)
1583     NameRef = StringPool.internString(Name);
1584   else if (Tag == dwarf::DW_TAG_namespace)
1585     // FIXME: For dsymutil-classic compatibility. I think uniquing
1586     // within anonymous namespaces is wrong. There is no ODR guarantee
1587     // there.
1588     NameRef = StringPool.internString("(anonymous namespace)");
1589
1590   if (ShortName && ShortName != Name)
1591     ShortNameRef = StringPool.internString(ShortName);
1592   else
1593     ShortNameRef = NameRef;
1594
1595   if (Tag != dwarf::DW_TAG_class_type && Tag != dwarf::DW_TAG_structure_type &&
1596       Tag != dwarf::DW_TAG_union_type &&
1597       Tag != dwarf::DW_TAG_enumeration_type && NameRef.empty())
1598     return PointerIntPair<DeclContext *, 1>(nullptr);
1599
1600   std::string File;
1601   unsigned Line = 0;
1602   unsigned ByteSize = 0;
1603
1604   // Gather some discriminating data about the DeclContext we will be
1605   // creating: File, line number and byte size. This shouldn't be
1606   // necessary, because the ODR is just about names, but given that we
1607   // do some approximations with overloaded functions and anonymous
1608   // namespaces, use these additional data points to make the process safer.
1609   ByteSize = DIE->getAttributeValueAsUnsignedConstant(
1610       &U.getOrigUnit(), dwarf::DW_AT_byte_size, UINT64_MAX);
1611   if (Tag != dwarf::DW_TAG_namespace || !Name) {
1612     if (unsigned FileNum = DIE->getAttributeValueAsUnsignedConstant(
1613             &U.getOrigUnit(), dwarf::DW_AT_decl_file, 0)) {
1614       if (const auto *LT = U.getOrigUnit().getContext().getLineTableForUnit(
1615               &U.getOrigUnit())) {
1616         // FIXME: dsymutil-classic compatibility. I'd rather not
1617         // unique anything in anonymous namespaces, but if we do, then
1618         // verify that the file and line correspond.
1619         if (!Name && Tag == dwarf::DW_TAG_namespace)
1620           FileNum = 1;
1621
1622         // FIXME: Passing U.getOrigUnit().getCompilationDir()
1623         // instead of "" would allow more uniquing, but for now, do
1624         // it this way to match dsymutil-classic.
1625         if (LT->getFileNameByIndex(
1626                 FileNum, "",
1627                 DILineInfoSpecifier::FileLineInfoKind::AbsoluteFilePath,
1628                 File)) {
1629           Line = DIE->getAttributeValueAsUnsignedConstant(
1630               &U.getOrigUnit(), dwarf::DW_AT_decl_line, 0);
1631 #ifdef HAVE_REALPATH
1632           // Cache the resolved paths, because calling realpath is expansive.
1633           if (const char *ResolvedPath = U.getResolvedPath(FileNum)) {
1634             File = ResolvedPath;
1635           } else {
1636             char RealPath[PATH_MAX + 1];
1637             RealPath[PATH_MAX] = 0;
1638             if (::realpath(File.c_str(), RealPath))
1639               File = RealPath;
1640             U.setResolvedPath(FileNum, File);
1641           }
1642 #endif
1643           FileRef = StringPool.internString(File);
1644         }
1645       }
1646     }
1647   }
1648
1649   if (!Line && NameRef.empty())
1650     return PointerIntPair<DeclContext *, 1>(nullptr);
1651
1652   // FIXME: dsymutil-classic compat won't unique the same type
1653   // presented once as a struct and once as a class. Use the Tag in
1654   // the fully qualified name hash to get the same effect.
1655   // We hash NameRef, which is the mangled name, in order to get most
1656   // overloaded functions resolvec correctly.
1657   unsigned Hash = hash_combine(Context.getQualifiedNameHash(), Tag, NameRef);
1658
1659   // FIXME: dsymutil-classic compatibility: when we don't have a name,
1660   // use the filename.
1661   if (Tag == dwarf::DW_TAG_namespace && NameRef == "(anonymous namespace)")
1662     Hash = hash_combine(Hash, FileRef);
1663
1664   // Now look if this context already exists.
1665   DeclContext Key(Hash, Line, ByteSize, Tag, NameRef, FileRef, Context);
1666   auto ContextIter = Contexts.find(&Key);
1667
1668   if (ContextIter == Contexts.end()) {
1669     // The context wasn't found.
1670     bool Inserted;
1671     DeclContext *NewContext =
1672         new (Allocator) DeclContext(Hash, Line, ByteSize, Tag, NameRef, FileRef,
1673                                     Context, DIE, U.getUniqueID());
1674     std::tie(ContextIter, Inserted) = Contexts.insert(NewContext);
1675     assert(Inserted && "Failed to insert DeclContext");
1676     (void)Inserted;
1677   } else if (Tag != dwarf::DW_TAG_namespace &&
1678              !(*ContextIter)->setLastSeenDIE(U, DIE)) {
1679     // The context was found, but it is ambiguous with another context
1680     // in the same file. Mark it invalid.
1681     return PointerIntPair<DeclContext *, 1>(*ContextIter, /* Invalid= */ 1);
1682   }
1683
1684   assert(ContextIter != Contexts.end());
1685   // FIXME: dsymutil-classic compatibility. Union types aren't
1686   // uniques, but their children might be.
1687   if ((Tag == dwarf::DW_TAG_subprogram &&
1688        Context.getTag() != dwarf::DW_TAG_structure_type &&
1689        Context.getTag() != dwarf::DW_TAG_class_type) ||
1690       (Tag == dwarf::DW_TAG_union_type))
1691     return PointerIntPair<DeclContext *, 1>(*ContextIter, /* Invalid= */ 1);
1692
1693   return PointerIntPair<DeclContext *, 1>(*ContextIter);
1694 }
1695
1696 /// \brief Get the potential name and mangled name for the entity
1697 /// described by \p Die and store them in \Info if they are not
1698 /// already there.
1699 /// \returns is a name was found.
1700 bool DwarfLinker::getDIENames(const DWARFDebugInfoEntryMinimal &Die,
1701                               DWARFUnit &U, AttributesInfo &Info) {
1702   // FIXME: a bit wastefull as the first getName might return the
1703   // short name.
1704   if (!Info.MangledName &&
1705       (Info.MangledName = Die.getName(&U, DINameKind::LinkageName)))
1706     Info.MangledNameOffset = StringPool.getStringOffset(Info.MangledName);
1707
1708   if (!Info.Name && (Info.Name = Die.getName(&U, DINameKind::ShortName)))
1709     Info.NameOffset = StringPool.getStringOffset(Info.Name);
1710
1711   return Info.Name || Info.MangledName;
1712 }
1713
1714 /// \brief Report a warning to the user, optionaly including
1715 /// information about a specific \p DIE related to the warning.
1716 void DwarfLinker::reportWarning(const Twine &Warning, const DWARFUnit *Unit,
1717                                 const DWARFDebugInfoEntryMinimal *DIE) const {
1718   StringRef Context = "<debug map>";
1719   if (CurrentDebugObject)
1720     Context = CurrentDebugObject->getObjectFilename();
1721   warn(Warning, Context);
1722
1723   if (!Options.Verbose || !DIE)
1724     return;
1725
1726   errs() << "    in DIE:\n";
1727   DIE->dump(errs(), const_cast<DWARFUnit *>(Unit), 0 /* RecurseDepth */,
1728             6 /* Indent */);
1729 }
1730
1731 bool DwarfLinker::createStreamer(Triple TheTriple, StringRef OutputFilename) {
1732   if (Options.NoOutput)
1733     return true;
1734
1735   Streamer = llvm::make_unique<DwarfStreamer>();
1736   return Streamer->init(TheTriple, OutputFilename);
1737 }
1738
1739 /// \brief Recursive helper to gather the child->parent relationships in the
1740 /// original compile unit.
1741 static void gatherDIEParents(const DWARFDebugInfoEntryMinimal *DIE,
1742                              unsigned ParentIdx, CompileUnit &CU,
1743                              DeclContext *CurrentDeclContext,
1744                              NonRelocatableStringpool &StringPool,
1745                              DeclContextTree &Contexts) {
1746   unsigned MyIdx = CU.getOrigUnit().getDIEIndex(DIE);
1747   CompileUnit::DIEInfo &Info = CU.getInfo(MyIdx);
1748
1749   Info.ParentIdx = ParentIdx;
1750   if (CU.hasODR()) {
1751     if (CurrentDeclContext) {
1752       auto PtrInvalidPair = Contexts.getChildDeclContext(*CurrentDeclContext,
1753                                                          DIE, CU, StringPool);
1754       CurrentDeclContext = PtrInvalidPair.getPointer();
1755       Info.Ctxt =
1756           PtrInvalidPair.getInt() ? nullptr : PtrInvalidPair.getPointer();
1757     } else
1758       Info.Ctxt = CurrentDeclContext = nullptr;
1759   }
1760
1761   if (DIE->hasChildren())
1762     for (auto *Child = DIE->getFirstChild(); Child && !Child->isNULL();
1763          Child = Child->getSibling())
1764       gatherDIEParents(Child, MyIdx, CU, CurrentDeclContext, StringPool,
1765                        Contexts);
1766 }
1767
1768 static bool dieNeedsChildrenToBeMeaningful(uint32_t Tag) {
1769   switch (Tag) {
1770   default:
1771     return false;
1772   case dwarf::DW_TAG_subprogram:
1773   case dwarf::DW_TAG_lexical_block:
1774   case dwarf::DW_TAG_subroutine_type:
1775   case dwarf::DW_TAG_structure_type:
1776   case dwarf::DW_TAG_class_type:
1777   case dwarf::DW_TAG_union_type:
1778     return true;
1779   }
1780   llvm_unreachable("Invalid Tag");
1781 }
1782
1783 static unsigned getRefAddrSize(const DWARFUnit &U) {
1784   if (U.getVersion() == 2)
1785     return U.getAddressByteSize();
1786   return 4;
1787 }
1788
1789 void DwarfLinker::startDebugObject(DWARFContext &Dwarf, DebugMapObject &Obj) {
1790   Units.reserve(Dwarf.getNumCompileUnits());
1791   NextValidReloc = 0;
1792   // Iterate over the debug map entries and put all the ones that are
1793   // functions (because they have a size) into the Ranges map. This
1794   // map is very similar to the FunctionRanges that are stored in each
1795   // unit, with 2 notable differences:
1796   //  - obviously this one is global, while the other ones are per-unit.
1797   //  - this one contains not only the functions described in the DIE
1798   // tree, but also the ones that are only in the debug map.
1799   // The latter information is required to reproduce dsymutil's logic
1800   // while linking line tables. The cases where this information
1801   // matters look like bugs that need to be investigated, but for now
1802   // we need to reproduce dsymutil's behavior.
1803   // FIXME: Once we understood exactly if that information is needed,
1804   // maybe totally remove this (or try to use it to do a real
1805   // -gline-tables-only on Darwin.
1806   for (const auto &Entry : Obj.symbols()) {
1807     const auto &Mapping = Entry.getValue();
1808     if (Mapping.Size)
1809       Ranges[Mapping.ObjectAddress] = std::make_pair(
1810           Mapping.ObjectAddress + Mapping.Size,
1811           int64_t(Mapping.BinaryAddress) - Mapping.ObjectAddress);
1812   }
1813 }
1814
1815 void DwarfLinker::endDebugObject() {
1816   Units.clear();
1817   ValidRelocs.clear();
1818   Ranges.clear();
1819
1820   for (auto I = DIEBlocks.begin(), E = DIEBlocks.end(); I != E; ++I)
1821     (*I)->~DIEBlock();
1822   for (auto I = DIELocs.begin(), E = DIELocs.end(); I != E; ++I)
1823     (*I)->~DIELoc();
1824
1825   DIEBlocks.clear();
1826   DIELocs.clear();
1827   DIEAlloc.Reset();
1828 }
1829
1830 /// \brief Iterate over the relocations of the given \p Section and
1831 /// store the ones that correspond to debug map entries into the
1832 /// ValidRelocs array.
1833 void DwarfLinker::findValidRelocsMachO(const object::SectionRef &Section,
1834                                        const object::MachOObjectFile &Obj,
1835                                        const DebugMapObject &DMO) {
1836   StringRef Contents;
1837   Section.getContents(Contents);
1838   DataExtractor Data(Contents, Obj.isLittleEndian(), 0);
1839
1840   for (const object::RelocationRef &Reloc : Section.relocations()) {
1841     object::DataRefImpl RelocDataRef = Reloc.getRawDataRefImpl();
1842     MachO::any_relocation_info MachOReloc = Obj.getRelocation(RelocDataRef);
1843     unsigned RelocSize = 1 << Obj.getAnyRelocationLength(MachOReloc);
1844     uint64_t Offset64 = Reloc.getOffset();
1845     if ((RelocSize != 4 && RelocSize != 8)) {
1846       reportWarning(" unsupported relocation in debug_info section.");
1847       continue;
1848     }
1849     uint32_t Offset = Offset64;
1850     // Mach-o uses REL relocations, the addend is at the relocation offset.
1851     uint64_t Addend = Data.getUnsigned(&Offset, RelocSize);
1852
1853     auto Sym = Reloc.getSymbol();
1854     if (Sym != Obj.symbol_end()) {
1855       ErrorOr<StringRef> SymbolName = Sym->getName();
1856       if (!SymbolName) {
1857         reportWarning("error getting relocation symbol name.");
1858         continue;
1859       }
1860       if (const auto *Mapping = DMO.lookupSymbol(*SymbolName))
1861         ValidRelocs.emplace_back(Offset64, RelocSize, Addend, Mapping);
1862     } else if (const auto *Mapping = DMO.lookupObjectAddress(Addend)) {
1863       // Do not store the addend. The addend was the address of the
1864       // symbol in the object file, the address in the binary that is
1865       // stored in the debug map doesn't need to be offseted.
1866       ValidRelocs.emplace_back(Offset64, RelocSize, 0, Mapping);
1867     }
1868   }
1869 }
1870
1871 /// \brief Dispatch the valid relocation finding logic to the
1872 /// appropriate handler depending on the object file format.
1873 bool DwarfLinker::findValidRelocs(const object::SectionRef &Section,
1874                                   const object::ObjectFile &Obj,
1875                                   const DebugMapObject &DMO) {
1876   // Dispatch to the right handler depending on the file type.
1877   if (auto *MachOObj = dyn_cast<object::MachOObjectFile>(&Obj))
1878     findValidRelocsMachO(Section, *MachOObj, DMO);
1879   else
1880     reportWarning(Twine("unsupported object file type: ") + Obj.getFileName());
1881
1882   if (ValidRelocs.empty())
1883     return false;
1884
1885   // Sort the relocations by offset. We will walk the DIEs linearly in
1886   // the file, this allows us to just keep an index in the relocation
1887   // array that we advance during our walk, rather than resorting to
1888   // some associative container. See DwarfLinker::NextValidReloc.
1889   std::sort(ValidRelocs.begin(), ValidRelocs.end());
1890   return true;
1891 }
1892
1893 /// \brief Look for relocations in the debug_info section that match
1894 /// entries in the debug map. These relocations will drive the Dwarf
1895 /// link by indicating which DIEs refer to symbols present in the
1896 /// linked binary.
1897 /// \returns wether there are any valid relocations in the debug info.
1898 bool DwarfLinker::findValidRelocsInDebugInfo(const object::ObjectFile &Obj,
1899                                              const DebugMapObject &DMO) {
1900   // Find the debug_info section.
1901   for (const object::SectionRef &Section : Obj.sections()) {
1902     StringRef SectionName;
1903     Section.getName(SectionName);
1904     SectionName = SectionName.substr(SectionName.find_first_not_of("._"));
1905     if (SectionName != "debug_info")
1906       continue;
1907     return findValidRelocs(Section, Obj, DMO);
1908   }
1909   return false;
1910 }
1911
1912 /// \brief Checks that there is a relocation against an actual debug
1913 /// map entry between \p StartOffset and \p NextOffset.
1914 ///
1915 /// This function must be called with offsets in strictly ascending
1916 /// order because it never looks back at relocations it already 'went past'.
1917 /// \returns true and sets Info.InDebugMap if it is the case.
1918 bool DwarfLinker::hasValidRelocation(uint32_t StartOffset, uint32_t EndOffset,
1919                                      CompileUnit::DIEInfo &Info) {
1920   assert(NextValidReloc == 0 ||
1921          StartOffset > ValidRelocs[NextValidReloc - 1].Offset);
1922   if (NextValidReloc >= ValidRelocs.size())
1923     return false;
1924
1925   uint64_t RelocOffset = ValidRelocs[NextValidReloc].Offset;
1926
1927   // We might need to skip some relocs that we didn't consider. For
1928   // example the high_pc of a discarded DIE might contain a reloc that
1929   // is in the list because it actually corresponds to the start of a
1930   // function that is in the debug map.
1931   while (RelocOffset < StartOffset && NextValidReloc < ValidRelocs.size() - 1)
1932     RelocOffset = ValidRelocs[++NextValidReloc].Offset;
1933
1934   if (RelocOffset < StartOffset || RelocOffset >= EndOffset)
1935     return false;
1936
1937   const auto &ValidReloc = ValidRelocs[NextValidReloc++];
1938   const auto &Mapping = ValidReloc.Mapping->getValue();
1939   if (Options.Verbose)
1940     outs() << "Found valid debug map entry: " << ValidReloc.Mapping->getKey()
1941            << " " << format("\t%016" PRIx64 " => %016" PRIx64,
1942                             uint64_t(Mapping.ObjectAddress),
1943                             uint64_t(Mapping.BinaryAddress));
1944
1945   Info.AddrAdjust = int64_t(Mapping.BinaryAddress) + ValidReloc.Addend -
1946                     Mapping.ObjectAddress;
1947   Info.InDebugMap = true;
1948   return true;
1949 }
1950
1951 /// \brief Get the starting and ending (exclusive) offset for the
1952 /// attribute with index \p Idx descibed by \p Abbrev. \p Offset is
1953 /// supposed to point to the position of the first attribute described
1954 /// by \p Abbrev.
1955 /// \return [StartOffset, EndOffset) as a pair.
1956 static std::pair<uint32_t, uint32_t>
1957 getAttributeOffsets(const DWARFAbbreviationDeclaration *Abbrev, unsigned Idx,
1958                     unsigned Offset, const DWARFUnit &Unit) {
1959   DataExtractor Data = Unit.getDebugInfoExtractor();
1960
1961   for (unsigned i = 0; i < Idx; ++i)
1962     DWARFFormValue::skipValue(Abbrev->getFormByIndex(i), Data, &Offset, &Unit);
1963
1964   uint32_t End = Offset;
1965   DWARFFormValue::skipValue(Abbrev->getFormByIndex(Idx), Data, &End, &Unit);
1966
1967   return std::make_pair(Offset, End);
1968 }
1969
1970 /// \brief Check if a variable describing DIE should be kept.
1971 /// \returns updated TraversalFlags.
1972 unsigned DwarfLinker::shouldKeepVariableDIE(
1973     const DWARFDebugInfoEntryMinimal &DIE, CompileUnit &Unit,
1974     CompileUnit::DIEInfo &MyInfo, unsigned Flags) {
1975   const auto *Abbrev = DIE.getAbbreviationDeclarationPtr();
1976
1977   // Global variables with constant value can always be kept.
1978   if (!(Flags & TF_InFunctionScope) &&
1979       Abbrev->findAttributeIndex(dwarf::DW_AT_const_value) != -1U) {
1980     MyInfo.InDebugMap = true;
1981     return Flags | TF_Keep;
1982   }
1983
1984   uint32_t LocationIdx = Abbrev->findAttributeIndex(dwarf::DW_AT_location);
1985   if (LocationIdx == -1U)
1986     return Flags;
1987
1988   uint32_t Offset = DIE.getOffset() + getULEB128Size(Abbrev->getCode());
1989   const DWARFUnit &OrigUnit = Unit.getOrigUnit();
1990   uint32_t LocationOffset, LocationEndOffset;
1991   std::tie(LocationOffset, LocationEndOffset) =
1992       getAttributeOffsets(Abbrev, LocationIdx, Offset, OrigUnit);
1993
1994   // See if there is a relocation to a valid debug map entry inside
1995   // this variable's location. The order is important here. We want to
1996   // always check in the variable has a valid relocation, so that the
1997   // DIEInfo is filled. However, we don't want a static variable in a
1998   // function to force us to keep the enclosing function.
1999   if (!hasValidRelocation(LocationOffset, LocationEndOffset, MyInfo) ||
2000       (Flags & TF_InFunctionScope))
2001     return Flags;
2002
2003   if (Options.Verbose)
2004     DIE.dump(outs(), const_cast<DWARFUnit *>(&OrigUnit), 0, 8 /* Indent */);
2005
2006   return Flags | TF_Keep;
2007 }
2008
2009 /// \brief Check if a function describing DIE should be kept.
2010 /// \returns updated TraversalFlags.
2011 unsigned DwarfLinker::shouldKeepSubprogramDIE(
2012     const DWARFDebugInfoEntryMinimal &DIE, CompileUnit &Unit,
2013     CompileUnit::DIEInfo &MyInfo, unsigned Flags) {
2014   const auto *Abbrev = DIE.getAbbreviationDeclarationPtr();
2015
2016   Flags |= TF_InFunctionScope;
2017
2018   uint32_t LowPcIdx = Abbrev->findAttributeIndex(dwarf::DW_AT_low_pc);
2019   if (LowPcIdx == -1U)
2020     return Flags;
2021
2022   uint32_t Offset = DIE.getOffset() + getULEB128Size(Abbrev->getCode());
2023   const DWARFUnit &OrigUnit = Unit.getOrigUnit();
2024   uint32_t LowPcOffset, LowPcEndOffset;
2025   std::tie(LowPcOffset, LowPcEndOffset) =
2026       getAttributeOffsets(Abbrev, LowPcIdx, Offset, OrigUnit);
2027
2028   uint64_t LowPc =
2029       DIE.getAttributeValueAsAddress(&OrigUnit, dwarf::DW_AT_low_pc, -1ULL);
2030   assert(LowPc != -1ULL && "low_pc attribute is not an address.");
2031   if (LowPc == -1ULL ||
2032       !hasValidRelocation(LowPcOffset, LowPcEndOffset, MyInfo))
2033     return Flags;
2034
2035   if (Options.Verbose)
2036     DIE.dump(outs(), const_cast<DWARFUnit *>(&OrigUnit), 0, 8 /* Indent */);
2037
2038   Flags |= TF_Keep;
2039
2040   DWARFFormValue HighPcValue;
2041   if (!DIE.getAttributeValue(&OrigUnit, dwarf::DW_AT_high_pc, HighPcValue)) {
2042     reportWarning("Function without high_pc. Range will be discarded.\n",
2043                   &OrigUnit, &DIE);
2044     return Flags;
2045   }
2046
2047   uint64_t HighPc;
2048   if (HighPcValue.isFormClass(DWARFFormValue::FC_Address)) {
2049     HighPc = *HighPcValue.getAsAddress(&OrigUnit);
2050   } else {
2051     assert(HighPcValue.isFormClass(DWARFFormValue::FC_Constant));
2052     HighPc = LowPc + *HighPcValue.getAsUnsignedConstant();
2053   }
2054
2055   // Replace the debug map range with a more accurate one.
2056   Ranges[LowPc] = std::make_pair(HighPc, MyInfo.AddrAdjust);
2057   Unit.addFunctionRange(LowPc, HighPc, MyInfo.AddrAdjust);
2058   return Flags;
2059 }
2060
2061 /// \brief Check if a DIE should be kept.
2062 /// \returns updated TraversalFlags.
2063 unsigned DwarfLinker::shouldKeepDIE(const DWARFDebugInfoEntryMinimal &DIE,
2064                                     CompileUnit &Unit,
2065                                     CompileUnit::DIEInfo &MyInfo,
2066                                     unsigned Flags) {
2067   switch (DIE.getTag()) {
2068   case dwarf::DW_TAG_constant:
2069   case dwarf::DW_TAG_variable:
2070     return shouldKeepVariableDIE(DIE, Unit, MyInfo, Flags);
2071   case dwarf::DW_TAG_subprogram:
2072     return shouldKeepSubprogramDIE(DIE, Unit, MyInfo, Flags);
2073   case dwarf::DW_TAG_module:
2074   case dwarf::DW_TAG_imported_module:
2075   case dwarf::DW_TAG_imported_declaration:
2076   case dwarf::DW_TAG_imported_unit:
2077     // We always want to keep these.
2078     return Flags | TF_Keep;
2079   }
2080
2081   return Flags;
2082 }
2083
2084 /// \brief Mark the passed DIE as well as all the ones it depends on
2085 /// as kept.
2086 ///
2087 /// This function is called by lookForDIEsToKeep on DIEs that are
2088 /// newly discovered to be needed in the link. It recursively calls
2089 /// back to lookForDIEsToKeep while adding TF_DependencyWalk to the
2090 /// TraversalFlags to inform it that it's not doing the primary DIE
2091 /// tree walk.
2092 void DwarfLinker::keepDIEAndDenpendencies(const DWARFDebugInfoEntryMinimal &DIE,
2093                                           CompileUnit::DIEInfo &MyInfo,
2094                                           const DebugMapObject &DMO,
2095                                           CompileUnit &CU, bool UseODR) {
2096   const DWARFUnit &Unit = CU.getOrigUnit();
2097   MyInfo.Keep = true;
2098
2099   // First mark all the parent chain as kept.
2100   unsigned AncestorIdx = MyInfo.ParentIdx;
2101   while (!CU.getInfo(AncestorIdx).Keep) {
2102     unsigned ODRFlag = UseODR ? TF_ODR : 0;
2103     lookForDIEsToKeep(*Unit.getDIEAtIndex(AncestorIdx), DMO, CU,
2104                       TF_ParentWalk | TF_Keep | TF_DependencyWalk | ODRFlag);
2105     AncestorIdx = CU.getInfo(AncestorIdx).ParentIdx;
2106   }
2107
2108   // Then we need to mark all the DIEs referenced by this DIE's
2109   // attributes as kept.
2110   DataExtractor Data = Unit.getDebugInfoExtractor();
2111   const auto *Abbrev = DIE.getAbbreviationDeclarationPtr();
2112   uint32_t Offset = DIE.getOffset() + getULEB128Size(Abbrev->getCode());
2113
2114   // Mark all DIEs referenced through atttributes as kept.
2115   for (const auto &AttrSpec : Abbrev->attributes()) {
2116     DWARFFormValue Val(AttrSpec.Form);
2117
2118     if (!Val.isFormClass(DWARFFormValue::FC_Reference)) {
2119       DWARFFormValue::skipValue(AttrSpec.Form, Data, &Offset, &Unit);
2120       continue;
2121     }
2122
2123     Val.extractValue(Data, &Offset, &Unit);
2124     CompileUnit *ReferencedCU;
2125     if (const auto *RefDIE =
2126             resolveDIEReference(Val, Unit, DIE, ReferencedCU)) {
2127       uint32_t RefIdx = ReferencedCU->getOrigUnit().getDIEIndex(RefDIE);
2128       CompileUnit::DIEInfo &Info = ReferencedCU->getInfo(RefIdx);
2129       // If the referenced DIE has a DeclContext that has already been
2130       // emitted, then do not keep the one in this CU. We'll link to
2131       // the canonical DIE in cloneDieReferenceAttribute.
2132       // FIXME: compatibility with dsymutil-classic. UseODR shouldn't
2133       // be necessary and could be advantageously replaced by
2134       // ReferencedCU->hasODR() && CU.hasODR().
2135       // FIXME: compatibility with dsymutil-classic. There is no
2136       // reason not to unique ref_addr references.
2137       if (AttrSpec.Form != dwarf::DW_FORM_ref_addr && UseODR && Info.Ctxt &&
2138           Info.Ctxt != ReferencedCU->getInfo(Info.ParentIdx).Ctxt &&
2139           Info.Ctxt->getCanonicalDIEOffset() && isODRAttribute(AttrSpec.Attr))
2140         continue;
2141
2142       unsigned ODRFlag = UseODR ? TF_ODR : 0;
2143       lookForDIEsToKeep(*RefDIE, DMO, *ReferencedCU,
2144                         TF_Keep | TF_DependencyWalk | ODRFlag);
2145     }
2146   }
2147 }
2148
2149 /// \brief Recursively walk the \p DIE tree and look for DIEs to
2150 /// keep. Store that information in \p CU's DIEInfo.
2151 ///
2152 /// This function is the entry point of the DIE selection
2153 /// algorithm. It is expected to walk the DIE tree in file order and
2154 /// (though the mediation of its helper) call hasValidRelocation() on
2155 /// each DIE that might be a 'root DIE' (See DwarfLinker class
2156 /// comment).
2157 /// While walking the dependencies of root DIEs, this function is
2158 /// also called, but during these dependency walks the file order is
2159 /// not respected. The TF_DependencyWalk flag tells us which kind of
2160 /// traversal we are currently doing.
2161 void DwarfLinker::lookForDIEsToKeep(const DWARFDebugInfoEntryMinimal &DIE,
2162                                     const DebugMapObject &DMO, CompileUnit &CU,
2163                                     unsigned Flags) {
2164   unsigned Idx = CU.getOrigUnit().getDIEIndex(&DIE);
2165   CompileUnit::DIEInfo &MyInfo = CU.getInfo(Idx);
2166   bool AlreadyKept = MyInfo.Keep;
2167
2168   // If the Keep flag is set, we are marking a required DIE's
2169   // dependencies. If our target is already marked as kept, we're all
2170   // set.
2171   if ((Flags & TF_DependencyWalk) && AlreadyKept)
2172     return;
2173
2174   // We must not call shouldKeepDIE while called from keepDIEAndDenpendencies,
2175   // because it would screw up the relocation finding logic.
2176   if (!(Flags & TF_DependencyWalk))
2177     Flags = shouldKeepDIE(DIE, CU, MyInfo, Flags);
2178
2179   // If it is a newly kept DIE mark it as well as all its dependencies as kept.
2180   if (!AlreadyKept && (Flags & TF_Keep)) {
2181     bool UseOdr = (Flags & TF_DependencyWalk) ? (Flags & TF_ODR) : CU.hasODR();
2182     keepDIEAndDenpendencies(DIE, MyInfo, DMO, CU, UseOdr);
2183   }
2184   // The TF_ParentWalk flag tells us that we are currently walking up
2185   // the parent chain of a required DIE, and we don't want to mark all
2186   // the children of the parents as kept (consider for example a
2187   // DW_TAG_namespace node in the parent chain). There are however a
2188   // set of DIE types for which we want to ignore that directive and still
2189   // walk their children.
2190   if (dieNeedsChildrenToBeMeaningful(DIE.getTag()))
2191     Flags &= ~TF_ParentWalk;
2192
2193   if (!DIE.hasChildren() || (Flags & TF_ParentWalk))
2194     return;
2195
2196   for (auto *Child = DIE.getFirstChild(); Child && !Child->isNULL();
2197        Child = Child->getSibling())
2198     lookForDIEsToKeep(*Child, DMO, CU, Flags);
2199 }
2200
2201 /// \brief Assign an abbreviation numer to \p Abbrev.
2202 ///
2203 /// Our DIEs get freed after every DebugMapObject has been processed,
2204 /// thus the FoldingSet we use to unique DIEAbbrevs cannot refer to
2205 /// the instances hold by the DIEs. When we encounter an abbreviation
2206 /// that we don't know, we create a permanent copy of it.
2207 void DwarfLinker::AssignAbbrev(DIEAbbrev &Abbrev) {
2208   // Check the set for priors.
2209   FoldingSetNodeID ID;
2210   Abbrev.Profile(ID);
2211   void *InsertToken;
2212   DIEAbbrev *InSet = AbbreviationsSet.FindNodeOrInsertPos(ID, InsertToken);
2213
2214   // If it's newly added.
2215   if (InSet) {
2216     // Assign existing abbreviation number.
2217     Abbrev.setNumber(InSet->getNumber());
2218   } else {
2219     // Add to abbreviation list.
2220     Abbreviations.push_back(
2221         new DIEAbbrev(Abbrev.getTag(), Abbrev.hasChildren()));
2222     for (const auto &Attr : Abbrev.getData())
2223       Abbreviations.back()->AddAttribute(Attr.getAttribute(), Attr.getForm());
2224     AbbreviationsSet.InsertNode(Abbreviations.back(), InsertToken);
2225     // Assign the unique abbreviation number.
2226     Abbrev.setNumber(Abbreviations.size());
2227     Abbreviations.back()->setNumber(Abbreviations.size());
2228   }
2229 }
2230
2231 /// \brief Clone a string attribute described by \p AttrSpec and add
2232 /// it to \p Die.
2233 /// \returns the size of the new attribute.
2234 unsigned DwarfLinker::cloneStringAttribute(DIE &Die, AttributeSpec AttrSpec,
2235                                            const DWARFFormValue &Val,
2236                                            const DWARFUnit &U) {
2237   // Switch everything to out of line strings.
2238   const char *String = *Val.getAsCString(&U);
2239   unsigned Offset = StringPool.getStringOffset(String);
2240   Die.addValue(DIEAlloc, dwarf::Attribute(AttrSpec.Attr), dwarf::DW_FORM_strp,
2241                DIEInteger(Offset));
2242   return 4;
2243 }
2244
2245 /// \brief Clone an attribute referencing another DIE and add
2246 /// it to \p Die.
2247 /// \returns the size of the new attribute.
2248 unsigned DwarfLinker::cloneDieReferenceAttribute(
2249     DIE &Die, const DWARFDebugInfoEntryMinimal &InputDIE,
2250     AttributeSpec AttrSpec, unsigned AttrSize, const DWARFFormValue &Val,
2251     CompileUnit &Unit) {
2252   const DWARFUnit &U = Unit.getOrigUnit();
2253   uint32_t Ref = *Val.getAsReference(&U);
2254   DIE *NewRefDie = nullptr;
2255   CompileUnit *RefUnit = nullptr;
2256   DeclContext *Ctxt = nullptr;
2257
2258   const DWARFDebugInfoEntryMinimal *RefDie =
2259       resolveDIEReference(Val, U, InputDIE, RefUnit);
2260
2261   // If the referenced DIE is not found,  drop the attribute.
2262   if (!RefDie)
2263     return 0;
2264
2265   unsigned Idx = RefUnit->getOrigUnit().getDIEIndex(RefDie);
2266   CompileUnit::DIEInfo &RefInfo = RefUnit->getInfo(Idx);
2267
2268   // If we already have emitted an equivalent DeclContext, just point
2269   // at it.
2270   if (isODRAttribute(AttrSpec.Attr)) {
2271     Ctxt = RefInfo.Ctxt;
2272     if (Ctxt && Ctxt->getCanonicalDIEOffset()) {
2273       DIEInteger Attr(Ctxt->getCanonicalDIEOffset());
2274       Die.addValue(DIEAlloc, dwarf::Attribute(AttrSpec.Attr),
2275                    dwarf::DW_FORM_ref_addr, Attr);
2276       return getRefAddrSize(U);
2277     }
2278   }
2279
2280   if (!RefInfo.Clone) {
2281     assert(Ref > InputDIE.getOffset());
2282     // We haven't cloned this DIE yet. Just create an empty one and
2283     // store it. It'll get really cloned when we process it.
2284     RefInfo.Clone = DIE::get(DIEAlloc, dwarf::Tag(RefDie->getTag()));
2285   }
2286   NewRefDie = RefInfo.Clone;
2287
2288   if (AttrSpec.Form == dwarf::DW_FORM_ref_addr ||
2289       (Unit.hasODR() && isODRAttribute(AttrSpec.Attr))) {
2290     // We cannot currently rely on a DIEEntry to emit ref_addr
2291     // references, because the implementation calls back to DwarfDebug
2292     // to find the unit offset. (We don't have a DwarfDebug)
2293     // FIXME: we should be able to design DIEEntry reliance on
2294     // DwarfDebug away.
2295     uint64_t Attr;
2296     if (Ref < InputDIE.getOffset()) {
2297       // We must have already cloned that DIE.
2298       uint32_t NewRefOffset =
2299           RefUnit->getStartOffset() + NewRefDie->getOffset();
2300       Attr = NewRefOffset;
2301       Die.addValue(DIEAlloc, dwarf::Attribute(AttrSpec.Attr),
2302                    dwarf::DW_FORM_ref_addr, DIEInteger(Attr));
2303     } else {
2304       // A forward reference. Note and fixup later.
2305       Attr = 0xBADDEF;
2306       Unit.noteForwardReference(
2307           NewRefDie, RefUnit, Ctxt,
2308           Die.addValue(DIEAlloc, dwarf::Attribute(AttrSpec.Attr),
2309                        dwarf::DW_FORM_ref_addr, DIEInteger(Attr)));
2310     }
2311     return getRefAddrSize(U);
2312   }
2313
2314   Die.addValue(DIEAlloc, dwarf::Attribute(AttrSpec.Attr),
2315                dwarf::Form(AttrSpec.Form), DIEEntry(*NewRefDie));
2316   return AttrSize;
2317 }
2318
2319 /// \brief Clone an attribute of block form (locations, constants) and add
2320 /// it to \p Die.
2321 /// \returns the size of the new attribute.
2322 unsigned DwarfLinker::cloneBlockAttribute(DIE &Die, AttributeSpec AttrSpec,
2323                                           const DWARFFormValue &Val,
2324                                           unsigned AttrSize) {
2325   DIEValueList *Attr;
2326   DIEValue Value;
2327   DIELoc *Loc = nullptr;
2328   DIEBlock *Block = nullptr;
2329   // Just copy the block data over.
2330   if (AttrSpec.Form == dwarf::DW_FORM_exprloc) {
2331     Loc = new (DIEAlloc) DIELoc;
2332     DIELocs.push_back(Loc);
2333   } else {
2334     Block = new (DIEAlloc) DIEBlock;
2335     DIEBlocks.push_back(Block);
2336   }
2337   Attr = Loc ? static_cast<DIEValueList *>(Loc)
2338              : static_cast<DIEValueList *>(Block);
2339
2340   if (Loc)
2341     Value = DIEValue(dwarf::Attribute(AttrSpec.Attr),
2342                      dwarf::Form(AttrSpec.Form), Loc);
2343   else
2344     Value = DIEValue(dwarf::Attribute(AttrSpec.Attr),
2345                      dwarf::Form(AttrSpec.Form), Block);
2346   ArrayRef<uint8_t> Bytes = *Val.getAsBlock();
2347   for (auto Byte : Bytes)
2348     Attr->addValue(DIEAlloc, static_cast<dwarf::Attribute>(0),
2349                    dwarf::DW_FORM_data1, DIEInteger(Byte));
2350   // FIXME: If DIEBlock and DIELoc just reuses the Size field of
2351   // the DIE class, this if could be replaced by
2352   // Attr->setSize(Bytes.size()).
2353   if (Streamer) {
2354     if (Loc)
2355       Loc->ComputeSize(&Streamer->getAsmPrinter());
2356     else
2357       Block->ComputeSize(&Streamer->getAsmPrinter());
2358   }
2359   Die.addValue(DIEAlloc, Value);
2360   return AttrSize;
2361 }
2362
2363 /// \brief Clone an address attribute and add it to \p Die.
2364 /// \returns the size of the new attribute.
2365 unsigned DwarfLinker::cloneAddressAttribute(DIE &Die, AttributeSpec AttrSpec,
2366                                             const DWARFFormValue &Val,
2367                                             const CompileUnit &Unit,
2368                                             AttributesInfo &Info) {
2369   uint64_t Addr = *Val.getAsAddress(&Unit.getOrigUnit());
2370   if (AttrSpec.Attr == dwarf::DW_AT_low_pc) {
2371     if (Die.getTag() == dwarf::DW_TAG_inlined_subroutine ||
2372         Die.getTag() == dwarf::DW_TAG_lexical_block)
2373       Addr += Info.PCOffset;
2374     else if (Die.getTag() == dwarf::DW_TAG_compile_unit) {
2375       Addr = Unit.getLowPc();
2376       if (Addr == UINT64_MAX)
2377         return 0;
2378     }
2379     Info.HasLowPc = true;
2380   } else if (AttrSpec.Attr == dwarf::DW_AT_high_pc) {
2381     if (Die.getTag() == dwarf::DW_TAG_compile_unit) {
2382       if (uint64_t HighPc = Unit.getHighPc())
2383         Addr = HighPc;
2384       else
2385         return 0;
2386     } else
2387       // If we have a high_pc recorded for the input DIE, use
2388       // it. Otherwise (when no relocations where applied) just use the
2389       // one we just decoded.
2390       Addr = (Info.OrigHighPc ? Info.OrigHighPc : Addr) + Info.PCOffset;
2391   }
2392
2393   Die.addValue(DIEAlloc, static_cast<dwarf::Attribute>(AttrSpec.Attr),
2394                static_cast<dwarf::Form>(AttrSpec.Form), DIEInteger(Addr));
2395   return Unit.getOrigUnit().getAddressByteSize();
2396 }
2397
2398 /// \brief Clone a scalar attribute  and add it to \p Die.
2399 /// \returns the size of the new attribute.
2400 unsigned DwarfLinker::cloneScalarAttribute(
2401     DIE &Die, const DWARFDebugInfoEntryMinimal &InputDIE, CompileUnit &Unit,
2402     AttributeSpec AttrSpec, const DWARFFormValue &Val, unsigned AttrSize,
2403     AttributesInfo &Info) {
2404   uint64_t Value;
2405   if (AttrSpec.Attr == dwarf::DW_AT_high_pc &&
2406       Die.getTag() == dwarf::DW_TAG_compile_unit) {
2407     if (Unit.getLowPc() == -1ULL)
2408       return 0;
2409     // Dwarf >= 4 high_pc is an size, not an address.
2410     Value = Unit.getHighPc() - Unit.getLowPc();
2411   } else if (AttrSpec.Form == dwarf::DW_FORM_sec_offset)
2412     Value = *Val.getAsSectionOffset();
2413   else if (AttrSpec.Form == dwarf::DW_FORM_sdata)
2414     Value = *Val.getAsSignedConstant();
2415   else if (auto OptionalValue = Val.getAsUnsignedConstant())
2416     Value = *OptionalValue;
2417   else {
2418     reportWarning("Unsupported scalar attribute form. Dropping attribute.",
2419                   &Unit.getOrigUnit(), &InputDIE);
2420     return 0;
2421   }
2422   PatchLocation Patch =
2423       Die.addValue(DIEAlloc, dwarf::Attribute(AttrSpec.Attr),
2424                    dwarf::Form(AttrSpec.Form), DIEInteger(Value));
2425   if (AttrSpec.Attr == dwarf::DW_AT_ranges)
2426     Unit.noteRangeAttribute(Die, Patch);
2427   // A more generic way to check for location attributes would be
2428   // nice, but it's very unlikely that any other attribute needs a
2429   // location list.
2430   else if (AttrSpec.Attr == dwarf::DW_AT_location ||
2431            AttrSpec.Attr == dwarf::DW_AT_frame_base)
2432     Unit.noteLocationAttribute(Patch, Info.PCOffset);
2433   else if (AttrSpec.Attr == dwarf::DW_AT_declaration && Value)
2434     Info.IsDeclaration = true;
2435
2436   return AttrSize;
2437 }
2438
2439 /// \brief Clone \p InputDIE's attribute described by \p AttrSpec with
2440 /// value \p Val, and add it to \p Die.
2441 /// \returns the size of the cloned attribute.
2442 unsigned DwarfLinker::cloneAttribute(DIE &Die,
2443                                      const DWARFDebugInfoEntryMinimal &InputDIE,
2444                                      CompileUnit &Unit,
2445                                      const DWARFFormValue &Val,
2446                                      const AttributeSpec AttrSpec,
2447                                      unsigned AttrSize, AttributesInfo &Info) {
2448   const DWARFUnit &U = Unit.getOrigUnit();
2449
2450   switch (AttrSpec.Form) {
2451   case dwarf::DW_FORM_strp:
2452   case dwarf::DW_FORM_string:
2453     return cloneStringAttribute(Die, AttrSpec, Val, U);
2454   case dwarf::DW_FORM_ref_addr:
2455   case dwarf::DW_FORM_ref1:
2456   case dwarf::DW_FORM_ref2:
2457   case dwarf::DW_FORM_ref4:
2458   case dwarf::DW_FORM_ref8:
2459     return cloneDieReferenceAttribute(Die, InputDIE, AttrSpec, AttrSize, Val,
2460                                       Unit);
2461   case dwarf::DW_FORM_block:
2462   case dwarf::DW_FORM_block1:
2463   case dwarf::DW_FORM_block2:
2464   case dwarf::DW_FORM_block4:
2465   case dwarf::DW_FORM_exprloc:
2466     return cloneBlockAttribute(Die, AttrSpec, Val, AttrSize);
2467   case dwarf::DW_FORM_addr:
2468     return cloneAddressAttribute(Die, AttrSpec, Val, Unit, Info);
2469   case dwarf::DW_FORM_data1:
2470   case dwarf::DW_FORM_data2:
2471   case dwarf::DW_FORM_data4:
2472   case dwarf::DW_FORM_data8:
2473   case dwarf::DW_FORM_udata:
2474   case dwarf::DW_FORM_sdata:
2475   case dwarf::DW_FORM_sec_offset:
2476   case dwarf::DW_FORM_flag:
2477   case dwarf::DW_FORM_flag_present:
2478     return cloneScalarAttribute(Die, InputDIE, Unit, AttrSpec, Val, AttrSize,
2479                                 Info);
2480   default:
2481     reportWarning("Unsupported attribute form in cloneAttribute. Dropping.", &U,
2482                   &InputDIE);
2483   }
2484
2485   return 0;
2486 }
2487
2488 /// \brief Apply the valid relocations found by findValidRelocs() to
2489 /// the buffer \p Data, taking into account that Data is at \p BaseOffset
2490 /// in the debug_info section.
2491 ///
2492 /// Like for findValidRelocs(), this function must be called with
2493 /// monotonic \p BaseOffset values.
2494 ///
2495 /// \returns wether any reloc has been applied.
2496 bool DwarfLinker::applyValidRelocs(MutableArrayRef<char> Data,
2497                                    uint32_t BaseOffset, bool isLittleEndian) {
2498   assert((NextValidReloc == 0 ||
2499           BaseOffset > ValidRelocs[NextValidReloc - 1].Offset) &&
2500          "BaseOffset should only be increasing.");
2501   if (NextValidReloc >= ValidRelocs.size())
2502     return false;
2503
2504   // Skip relocs that haven't been applied.
2505   while (NextValidReloc < ValidRelocs.size() &&
2506          ValidRelocs[NextValidReloc].Offset < BaseOffset)
2507     ++NextValidReloc;
2508
2509   bool Applied = false;
2510   uint64_t EndOffset = BaseOffset + Data.size();
2511   while (NextValidReloc < ValidRelocs.size() &&
2512          ValidRelocs[NextValidReloc].Offset >= BaseOffset &&
2513          ValidRelocs[NextValidReloc].Offset < EndOffset) {
2514     const auto &ValidReloc = ValidRelocs[NextValidReloc++];
2515     assert(ValidReloc.Offset - BaseOffset < Data.size());
2516     assert(ValidReloc.Offset - BaseOffset + ValidReloc.Size <= Data.size());
2517     char Buf[8];
2518     uint64_t Value = ValidReloc.Mapping->getValue().BinaryAddress;
2519     Value += ValidReloc.Addend;
2520     for (unsigned i = 0; i != ValidReloc.Size; ++i) {
2521       unsigned Index = isLittleEndian ? i : (ValidReloc.Size - i - 1);
2522       Buf[i] = uint8_t(Value >> (Index * 8));
2523     }
2524     assert(ValidReloc.Size <= sizeof(Buf));
2525     memcpy(&Data[ValidReloc.Offset - BaseOffset], Buf, ValidReloc.Size);
2526     Applied = true;
2527   }
2528
2529   return Applied;
2530 }
2531
2532 static bool isTypeTag(uint16_t Tag) {
2533   switch (Tag) {
2534   case dwarf::DW_TAG_array_type:
2535   case dwarf::DW_TAG_class_type:
2536   case dwarf::DW_TAG_enumeration_type:
2537   case dwarf::DW_TAG_pointer_type:
2538   case dwarf::DW_TAG_reference_type:
2539   case dwarf::DW_TAG_string_type:
2540   case dwarf::DW_TAG_structure_type:
2541   case dwarf::DW_TAG_subroutine_type:
2542   case dwarf::DW_TAG_typedef:
2543   case dwarf::DW_TAG_union_type:
2544   case dwarf::DW_TAG_ptr_to_member_type:
2545   case dwarf::DW_TAG_set_type:
2546   case dwarf::DW_TAG_subrange_type:
2547   case dwarf::DW_TAG_base_type:
2548   case dwarf::DW_TAG_const_type:
2549   case dwarf::DW_TAG_constant:
2550   case dwarf::DW_TAG_file_type:
2551   case dwarf::DW_TAG_namelist:
2552   case dwarf::DW_TAG_packed_type:
2553   case dwarf::DW_TAG_volatile_type:
2554   case dwarf::DW_TAG_restrict_type:
2555   case dwarf::DW_TAG_interface_type:
2556   case dwarf::DW_TAG_unspecified_type:
2557   case dwarf::DW_TAG_shared_type:
2558     return true;
2559   default:
2560     break;
2561   }
2562   return false;
2563 }
2564
2565 /// \brief Recursively clone \p InputDIE's subtrees that have been
2566 /// selected to appear in the linked output.
2567 ///
2568 /// \param OutOffset is the Offset where the newly created DIE will
2569 /// lie in the linked compile unit.
2570 ///
2571 /// \returns the cloned DIE object or null if nothing was selected.
2572 DIE *DwarfLinker::cloneDIE(const DWARFDebugInfoEntryMinimal &InputDIE,
2573                            CompileUnit &Unit, int64_t PCOffset,
2574                            uint32_t OutOffset) {
2575   DWARFUnit &U = Unit.getOrigUnit();
2576   unsigned Idx = U.getDIEIndex(&InputDIE);
2577   CompileUnit::DIEInfo &Info = Unit.getInfo(Idx);
2578
2579   // Should the DIE appear in the output?
2580   if (!Unit.getInfo(Idx).Keep)
2581     return nullptr;
2582
2583   uint32_t Offset = InputDIE.getOffset();
2584   // The DIE might have been already created by a forward reference
2585   // (see cloneDieReferenceAttribute()).
2586   DIE *Die = Info.Clone;
2587   if (!Die)
2588     Die = Info.Clone = DIE::get(DIEAlloc, dwarf::Tag(InputDIE.getTag()));
2589   assert(Die->getTag() == InputDIE.getTag());
2590   Die->setOffset(OutOffset);
2591   if (Unit.hasODR() && Die->getTag() != dwarf::DW_TAG_namespace && Info.Ctxt &&
2592       Info.Ctxt != Unit.getInfo(Info.ParentIdx).Ctxt &&
2593       !Info.Ctxt->getCanonicalDIEOffset()) {
2594     // We are about to emit a DIE that is the root of its own valid
2595     // DeclContext tree. Make the current offset the canonical offset
2596     // for this context.
2597     Info.Ctxt->setCanonicalDIEOffset(OutOffset + Unit.getStartOffset());
2598   }
2599
2600   // Extract and clone every attribute.
2601   DataExtractor Data = U.getDebugInfoExtractor();
2602   uint32_t NextOffset = U.getDIEAtIndex(Idx + 1)->getOffset();
2603   AttributesInfo AttrInfo;
2604
2605   // We could copy the data only if we need to aply a relocation to
2606   // it. After testing, it seems there is no performance downside to
2607   // doing the copy unconditionally, and it makes the code simpler.
2608   SmallString<40> DIECopy(Data.getData().substr(Offset, NextOffset - Offset));
2609   Data = DataExtractor(DIECopy, Data.isLittleEndian(), Data.getAddressSize());
2610   // Modify the copy with relocated addresses.
2611   if (applyValidRelocs(DIECopy, Offset, Data.isLittleEndian())) {
2612     // If we applied relocations, we store the value of high_pc that was
2613     // potentially stored in the input DIE. If high_pc is an address
2614     // (Dwarf version == 2), then it might have been relocated to a
2615     // totally unrelated value (because the end address in the object
2616     // file might be start address of another function which got moved
2617     // independantly by the linker). The computation of the actual
2618     // high_pc value is done in cloneAddressAttribute().
2619     AttrInfo.OrigHighPc =
2620         InputDIE.getAttributeValueAsAddress(&U, dwarf::DW_AT_high_pc, 0);
2621   }
2622
2623   // Reset the Offset to 0 as we will be working on the local copy of
2624   // the data.
2625   Offset = 0;
2626
2627   const auto *Abbrev = InputDIE.getAbbreviationDeclarationPtr();
2628   Offset += getULEB128Size(Abbrev->getCode());
2629
2630   // We are entering a subprogram. Get and propagate the PCOffset.
2631   if (Die->getTag() == dwarf::DW_TAG_subprogram)
2632     PCOffset = Info.AddrAdjust;
2633   AttrInfo.PCOffset = PCOffset;
2634
2635   for (const auto &AttrSpec : Abbrev->attributes()) {
2636     DWARFFormValue Val(AttrSpec.Form);
2637     uint32_t AttrSize = Offset;
2638     Val.extractValue(Data, &Offset, &U);
2639     AttrSize = Offset - AttrSize;
2640
2641     OutOffset +=
2642         cloneAttribute(*Die, InputDIE, Unit, Val, AttrSpec, AttrSize, AttrInfo);
2643   }
2644
2645   // Look for accelerator entries.
2646   uint16_t Tag = InputDIE.getTag();
2647   // FIXME: This is slightly wrong. An inline_subroutine without a
2648   // low_pc, but with AT_ranges might be interesting to get into the
2649   // accelerator tables too. For now stick with dsymutil's behavior.
2650   if ((Info.InDebugMap || AttrInfo.HasLowPc) &&
2651       Tag != dwarf::DW_TAG_compile_unit &&
2652       getDIENames(InputDIE, Unit.getOrigUnit(), AttrInfo)) {
2653     if (AttrInfo.MangledName && AttrInfo.MangledName != AttrInfo.Name)
2654       Unit.addNameAccelerator(Die, AttrInfo.MangledName,
2655                               AttrInfo.MangledNameOffset,
2656                               Tag == dwarf::DW_TAG_inlined_subroutine);
2657     if (AttrInfo.Name)
2658       Unit.addNameAccelerator(Die, AttrInfo.Name, AttrInfo.NameOffset,
2659                               Tag == dwarf::DW_TAG_inlined_subroutine);
2660   } else if (isTypeTag(Tag) && !AttrInfo.IsDeclaration &&
2661              getDIENames(InputDIE, Unit.getOrigUnit(), AttrInfo)) {
2662     Unit.addTypeAccelerator(Die, AttrInfo.Name, AttrInfo.NameOffset);
2663   }
2664
2665   DIEAbbrev NewAbbrev = Die->generateAbbrev();
2666   // If a scope DIE is kept, we must have kept at least one child. If
2667   // it's not the case, we'll just be emitting one wasteful end of
2668   // children marker, but things won't break.
2669   if (InputDIE.hasChildren())
2670     NewAbbrev.setChildrenFlag(dwarf::DW_CHILDREN_yes);
2671   // Assign a permanent abbrev number
2672   AssignAbbrev(NewAbbrev);
2673   Die->setAbbrevNumber(NewAbbrev.getNumber());
2674
2675   // Add the size of the abbreviation number to the output offset.
2676   OutOffset += getULEB128Size(Die->getAbbrevNumber());
2677
2678   if (!Abbrev->hasChildren()) {
2679     // Update our size.
2680     Die->setSize(OutOffset - Die->getOffset());
2681     return Die;
2682   }
2683
2684   // Recursively clone children.
2685   for (auto *Child = InputDIE.getFirstChild(); Child && !Child->isNULL();
2686        Child = Child->getSibling()) {
2687     if (DIE *Clone = cloneDIE(*Child, Unit, PCOffset, OutOffset)) {
2688       Die->addChild(Clone);
2689       OutOffset = Clone->getOffset() + Clone->getSize();
2690     }
2691   }
2692
2693   // Account for the end of children marker.
2694   OutOffset += sizeof(int8_t);
2695   // Update our size.
2696   Die->setSize(OutOffset - Die->getOffset());
2697   return Die;
2698 }
2699
2700 /// \brief Patch the input object file relevant debug_ranges entries
2701 /// and emit them in the output file. Update the relevant attributes
2702 /// to point at the new entries.
2703 void DwarfLinker::patchRangesForUnit(const CompileUnit &Unit,
2704                                      DWARFContext &OrigDwarf) const {
2705   DWARFDebugRangeList RangeList;
2706   const auto &FunctionRanges = Unit.getFunctionRanges();
2707   unsigned AddressSize = Unit.getOrigUnit().getAddressByteSize();
2708   DataExtractor RangeExtractor(OrigDwarf.getRangeSection(),
2709                                OrigDwarf.isLittleEndian(), AddressSize);
2710   auto InvalidRange = FunctionRanges.end(), CurrRange = InvalidRange;
2711   DWARFUnit &OrigUnit = Unit.getOrigUnit();
2712   const auto *OrigUnitDie = OrigUnit.getUnitDIE(false);
2713   uint64_t OrigLowPc = OrigUnitDie->getAttributeValueAsAddress(
2714       &OrigUnit, dwarf::DW_AT_low_pc, -1ULL);
2715   // Ranges addresses are based on the unit's low_pc. Compute the
2716   // offset we need to apply to adapt to the the new unit's low_pc.
2717   int64_t UnitPcOffset = 0;
2718   if (OrigLowPc != -1ULL)
2719     UnitPcOffset = int64_t(OrigLowPc) - Unit.getLowPc();
2720
2721   for (const auto &RangeAttribute : Unit.getRangesAttributes()) {
2722     uint32_t Offset = RangeAttribute.get();
2723     RangeAttribute.set(Streamer->getRangesSectionSize());
2724     RangeList.extract(RangeExtractor, &Offset);
2725     const auto &Entries = RangeList.getEntries();
2726     const DWARFDebugRangeList::RangeListEntry &First = Entries.front();
2727
2728     if (CurrRange == InvalidRange || First.StartAddress < CurrRange.start() ||
2729         First.StartAddress >= CurrRange.stop()) {
2730       CurrRange = FunctionRanges.find(First.StartAddress + OrigLowPc);
2731       if (CurrRange == InvalidRange ||
2732           CurrRange.start() > First.StartAddress + OrigLowPc) {
2733         reportWarning("no mapping for range.");
2734         continue;
2735       }
2736     }
2737
2738     Streamer->emitRangesEntries(UnitPcOffset, OrigLowPc, CurrRange, Entries,
2739                                 AddressSize);
2740   }
2741 }
2742
2743 /// \brief Generate the debug_aranges entries for \p Unit and if the
2744 /// unit has a DW_AT_ranges attribute, also emit the debug_ranges
2745 /// contribution for this attribute.
2746 /// FIXME: this could actually be done right in patchRangesForUnit,
2747 /// but for the sake of initial bit-for-bit compatibility with legacy
2748 /// dsymutil, we have to do it in a delayed pass.
2749 void DwarfLinker::generateUnitRanges(CompileUnit &Unit) const {
2750   auto Attr = Unit.getUnitRangesAttribute();
2751   if (Attr)
2752     Attr->set(Streamer->getRangesSectionSize());
2753   Streamer->emitUnitRangesEntries(Unit, static_cast<bool>(Attr));
2754 }
2755
2756 /// \brief Insert the new line info sequence \p Seq into the current
2757 /// set of already linked line info \p Rows.
2758 static void insertLineSequence(std::vector<DWARFDebugLine::Row> &Seq,
2759                                std::vector<DWARFDebugLine::Row> &Rows) {
2760   if (Seq.empty())
2761     return;
2762
2763   if (!Rows.empty() && Rows.back().Address < Seq.front().Address) {
2764     Rows.insert(Rows.end(), Seq.begin(), Seq.end());
2765     Seq.clear();
2766     return;
2767   }
2768
2769   auto InsertPoint = std::lower_bound(
2770       Rows.begin(), Rows.end(), Seq.front(),
2771       [](const DWARFDebugLine::Row &LHS, const DWARFDebugLine::Row &RHS) {
2772         return LHS.Address < RHS.Address;
2773       });
2774
2775   // FIXME: this only removes the unneeded end_sequence if the
2776   // sequences have been inserted in order. using a global sort like
2777   // described in patchLineTableForUnit() and delaying the end_sequene
2778   // elimination to emitLineTableForUnit() we can get rid of all of them.
2779   if (InsertPoint != Rows.end() &&
2780       InsertPoint->Address == Seq.front().Address && InsertPoint->EndSequence) {
2781     *InsertPoint = Seq.front();
2782     Rows.insert(InsertPoint + 1, Seq.begin() + 1, Seq.end());
2783   } else {
2784     Rows.insert(InsertPoint, Seq.begin(), Seq.end());
2785   }
2786
2787   Seq.clear();
2788 }
2789
2790 static void patchStmtList(DIE &Die, DIEInteger Offset) {
2791   for (auto &V : Die.values())
2792     if (V.getAttribute() == dwarf::DW_AT_stmt_list) {
2793       V = DIEValue(V.getAttribute(), V.getForm(), Offset);
2794       return;
2795     }
2796
2797   llvm_unreachable("Didn't find DW_AT_stmt_list in cloned DIE!");
2798 }
2799
2800 /// \brief Extract the line table for \p Unit from \p OrigDwarf, and
2801 /// recreate a relocated version of these for the address ranges that
2802 /// are present in the binary.
2803 void DwarfLinker::patchLineTableForUnit(CompileUnit &Unit,
2804                                         DWARFContext &OrigDwarf) {
2805   const DWARFDebugInfoEntryMinimal *CUDie = Unit.getOrigUnit().getUnitDIE();
2806   uint64_t StmtList = CUDie->getAttributeValueAsSectionOffset(
2807       &Unit.getOrigUnit(), dwarf::DW_AT_stmt_list, -1ULL);
2808   if (StmtList == -1ULL)
2809     return;
2810
2811   // Update the cloned DW_AT_stmt_list with the correct debug_line offset.
2812   if (auto *OutputDIE = Unit.getOutputUnitDIE())
2813     patchStmtList(*OutputDIE, DIEInteger(Streamer->getLineSectionSize()));
2814
2815   // Parse the original line info for the unit.
2816   DWARFDebugLine::LineTable LineTable;
2817   uint32_t StmtOffset = StmtList;
2818   StringRef LineData = OrigDwarf.getLineSection().Data;
2819   DataExtractor LineExtractor(LineData, OrigDwarf.isLittleEndian(),
2820                               Unit.getOrigUnit().getAddressByteSize());
2821   LineTable.parse(LineExtractor, &OrigDwarf.getLineSection().Relocs,
2822                   &StmtOffset);
2823
2824   // This vector is the output line table.
2825   std::vector<DWARFDebugLine::Row> NewRows;
2826   NewRows.reserve(LineTable.Rows.size());
2827
2828   // Current sequence of rows being extracted, before being inserted
2829   // in NewRows.
2830   std::vector<DWARFDebugLine::Row> Seq;
2831   const auto &FunctionRanges = Unit.getFunctionRanges();
2832   auto InvalidRange = FunctionRanges.end(), CurrRange = InvalidRange;
2833
2834   // FIXME: This logic is meant to generate exactly the same output as
2835   // Darwin's classic dsynutil. There is a nicer way to implement this
2836   // by simply putting all the relocated line info in NewRows and simply
2837   // sorting NewRows before passing it to emitLineTableForUnit. This
2838   // should be correct as sequences for a function should stay
2839   // together in the sorted output. There are a few corner cases that
2840   // look suspicious though, and that required to implement the logic
2841   // this way. Revisit that once initial validation is finished.
2842
2843   // Iterate over the object file line info and extract the sequences
2844   // that correspond to linked functions.
2845   for (auto &Row : LineTable.Rows) {
2846     // Check wether we stepped out of the range. The range is
2847     // half-open, but consider accept the end address of the range if
2848     // it is marked as end_sequence in the input (because in that
2849     // case, the relocation offset is accurate and that entry won't
2850     // serve as the start of another function).
2851     if (CurrRange == InvalidRange || Row.Address < CurrRange.start() ||
2852         Row.Address > CurrRange.stop() ||
2853         (Row.Address == CurrRange.stop() && !Row.EndSequence)) {
2854       // We just stepped out of a known range. Insert a end_sequence
2855       // corresponding to the end of the range.
2856       uint64_t StopAddress = CurrRange != InvalidRange
2857                                  ? CurrRange.stop() + CurrRange.value()
2858                                  : -1ULL;
2859       CurrRange = FunctionRanges.find(Row.Address);
2860       bool CurrRangeValid =
2861           CurrRange != InvalidRange && CurrRange.start() <= Row.Address;
2862       if (!CurrRangeValid) {
2863         CurrRange = InvalidRange;
2864         if (StopAddress != -1ULL) {
2865           // Try harder by looking in the DebugMapObject function
2866           // ranges map. There are corner cases where this finds a
2867           // valid entry. It's unclear if this is right or wrong, but
2868           // for now do as dsymutil.
2869           // FIXME: Understand exactly what cases this addresses and
2870           // potentially remove it along with the Ranges map.
2871           auto Range = Ranges.lower_bound(Row.Address);
2872           if (Range != Ranges.begin() && Range != Ranges.end())
2873             --Range;
2874
2875           if (Range != Ranges.end() && Range->first <= Row.Address &&
2876               Range->second.first >= Row.Address) {
2877             StopAddress = Row.Address + Range->second.second;
2878           }
2879         }
2880       }
2881       if (StopAddress != -1ULL && !Seq.empty()) {
2882         // Insert end sequence row with the computed end address, but
2883         // the same line as the previous one.
2884         auto NextLine = Seq.back();
2885         NextLine.Address = StopAddress;
2886         NextLine.EndSequence = 1;
2887         NextLine.PrologueEnd = 0;
2888         NextLine.BasicBlock = 0;
2889         NextLine.EpilogueBegin = 0;
2890         Seq.push_back(NextLine);
2891         insertLineSequence(Seq, NewRows);
2892       }
2893
2894       if (!CurrRangeValid)
2895         continue;
2896     }
2897
2898     // Ignore empty sequences.
2899     if (Row.EndSequence && Seq.empty())
2900       continue;
2901
2902     // Relocate row address and add it to the current sequence.
2903     Row.Address += CurrRange.value();
2904     Seq.emplace_back(Row);
2905
2906     if (Row.EndSequence)
2907       insertLineSequence(Seq, NewRows);
2908   }
2909
2910   // Finished extracting, now emit the line tables.
2911   uint32_t PrologueEnd = StmtList + 10 + LineTable.Prologue.PrologueLength;
2912   // FIXME: LLVM hardcodes it's prologue values. We just copy the
2913   // prologue over and that works because we act as both producer and
2914   // consumer. It would be nicer to have a real configurable line
2915   // table emitter.
2916   if (LineTable.Prologue.Version != 2 ||
2917       LineTable.Prologue.DefaultIsStmt != DWARF2_LINE_DEFAULT_IS_STMT ||
2918       LineTable.Prologue.OpcodeBase > 13)
2919     reportWarning("line table paramters mismatch. Cannot emit.");
2920   else {
2921     MCDwarfLineTableParams Params;
2922     Params.DWARF2LineOpcodeBase = LineTable.Prologue.OpcodeBase;
2923     Params.DWARF2LineBase = LineTable.Prologue.LineBase;
2924     Params.DWARF2LineRange = LineTable.Prologue.LineRange;
2925     Streamer->emitLineTableForUnit(Params,
2926                                    LineData.slice(StmtList + 4, PrologueEnd),
2927                                    LineTable.Prologue.MinInstLength, NewRows,
2928                                    Unit.getOrigUnit().getAddressByteSize());
2929   }
2930 }
2931
2932 void DwarfLinker::emitAcceleratorEntriesForUnit(CompileUnit &Unit) {
2933   Streamer->emitPubNamesForUnit(Unit);
2934   Streamer->emitPubTypesForUnit(Unit);
2935 }
2936
2937 /// \brief Read the frame info stored in the object, and emit the
2938 /// patched frame descriptions for the linked binary.
2939 ///
2940 /// This is actually pretty easy as the data of the CIEs and FDEs can
2941 /// be considered as black boxes and moved as is. The only thing to do
2942 /// is to patch the addresses in the headers.
2943 void DwarfLinker::patchFrameInfoForObject(const DebugMapObject &DMO,
2944                                           DWARFContext &OrigDwarf,
2945                                           unsigned AddrSize) {
2946   StringRef FrameData = OrigDwarf.getDebugFrameSection();
2947   if (FrameData.empty())
2948     return;
2949
2950   DataExtractor Data(FrameData, OrigDwarf.isLittleEndian(), 0);
2951   uint32_t InputOffset = 0;
2952
2953   // Store the data of the CIEs defined in this object, keyed by their
2954   // offsets.
2955   DenseMap<uint32_t, StringRef> LocalCIES;
2956
2957   while (Data.isValidOffset(InputOffset)) {
2958     uint32_t EntryOffset = InputOffset;
2959     uint32_t InitialLength = Data.getU32(&InputOffset);
2960     if (InitialLength == 0xFFFFFFFF)
2961       return reportWarning("Dwarf64 bits no supported");
2962
2963     uint32_t CIEId = Data.getU32(&InputOffset);
2964     if (CIEId == 0xFFFFFFFF) {
2965       // This is a CIE, store it.
2966       StringRef CIEData = FrameData.substr(EntryOffset, InitialLength + 4);
2967       LocalCIES[EntryOffset] = CIEData;
2968       // The -4 is to account for the CIEId we just read.
2969       InputOffset += InitialLength - 4;
2970       continue;
2971     }
2972
2973     uint32_t Loc = Data.getUnsigned(&InputOffset, AddrSize);
2974
2975     // Some compilers seem to emit frame info that doesn't start at
2976     // the function entry point, thus we can't just lookup the address
2977     // in the debug map. Use the linker's range map to see if the FDE
2978     // describes something that we can relocate.
2979     auto Range = Ranges.upper_bound(Loc);
2980     if (Range != Ranges.begin())
2981       --Range;
2982     if (Range == Ranges.end() || Range->first > Loc ||
2983         Range->second.first <= Loc) {
2984       // The +4 is to account for the size of the InitialLength field itself.
2985       InputOffset = EntryOffset + InitialLength + 4;
2986       continue;
2987     }
2988
2989     // This is an FDE, and we have a mapping.
2990     // Have we already emitted a corresponding CIE?
2991     StringRef CIEData = LocalCIES[CIEId];
2992     if (CIEData.empty())
2993       return reportWarning("Inconsistent debug_frame content. Dropping.");
2994
2995     // Look if we already emitted a CIE that corresponds to the
2996     // referenced one (the CIE data is the key of that lookup).
2997     auto IteratorInserted = EmittedCIEs.insert(
2998         std::make_pair(CIEData, Streamer->getFrameSectionSize()));
2999     // If there is no CIE yet for this ID, emit it.
3000     if (IteratorInserted.second ||
3001         // FIXME: dsymutil-classic only caches the last used CIE for
3002         // reuse. Mimic that behavior for now. Just removing that
3003         // second half of the condition and the LastCIEOffset variable
3004         // makes the code DTRT.
3005         LastCIEOffset != IteratorInserted.first->getValue()) {
3006       LastCIEOffset = Streamer->getFrameSectionSize();
3007       IteratorInserted.first->getValue() = LastCIEOffset;
3008       Streamer->emitCIE(CIEData);
3009     }
3010
3011     // Emit the FDE with updated address and CIE pointer.
3012     // (4 + AddrSize) is the size of the CIEId + initial_location
3013     // fields that will get reconstructed by emitFDE().
3014     unsigned FDERemainingBytes = InitialLength - (4 + AddrSize);
3015     Streamer->emitFDE(IteratorInserted.first->getValue(), AddrSize,
3016                       Loc + Range->second.second,
3017                       FrameData.substr(InputOffset, FDERemainingBytes));
3018     InputOffset += FDERemainingBytes;
3019   }
3020 }
3021
3022 ErrorOr<const object::ObjectFile &>
3023 DwarfLinker::loadObject(BinaryHolder &BinaryHolder, DebugMapObject &Obj,
3024                         const DebugMap &Map) {
3025   auto ErrOrObjs =
3026       BinaryHolder.GetObjectFiles(Obj.getObjectFilename(), Obj.getTimestamp());
3027   if (std::error_code EC = ErrOrObjs.getError())
3028     reportWarning(Twine(Obj.getObjectFilename()) + ": " + EC.message());
3029   auto ErrOrObj = BinaryHolder.Get(Map.getTriple());
3030   if (std::error_code EC = ErrOrObj.getError())
3031     reportWarning(Twine(Obj.getObjectFilename()) + ": " + EC.message());
3032   return ErrOrObj;
3033 }
3034
3035 bool DwarfLinker::link(const DebugMap &Map) {
3036
3037   if (Map.begin() == Map.end()) {
3038     errs() << "Empty debug map.\n";
3039     return false;
3040   }
3041
3042   if (!createStreamer(Map.getTriple(), OutputFilename))
3043     return false;
3044
3045   // Size of the DIEs (and headers) generated for the linked output.
3046   uint64_t OutputDebugInfoSize = 0;
3047   // A unique ID that identifies each compile unit.
3048   unsigned UnitID = 0;
3049   for (const auto &Obj : Map.objects()) {
3050     CurrentDebugObject = Obj.get();
3051
3052     if (Options.Verbose)
3053       outs() << "DEBUG MAP OBJECT: " << Obj->getObjectFilename() << "\n";
3054     auto ErrOrObj = loadObject(BinHolder, *Obj, Map);
3055     if (!ErrOrObj)
3056       continue;
3057
3058     // Look for relocations that correspond to debug map entries.
3059     if (!findValidRelocsInDebugInfo(*ErrOrObj, *Obj)) {
3060       if (Options.Verbose)
3061         outs() << "No valid relocations found. Skipping.\n";
3062       continue;
3063     }
3064
3065     // Setup access to the debug info.
3066     DWARFContextInMemory DwarfContext(*ErrOrObj);
3067     startDebugObject(DwarfContext, *Obj);
3068
3069     // In a first phase, just read in the debug info and store the DIE
3070     // parent links that we will use during the next phase.
3071     for (const auto &CU : DwarfContext.compile_units()) {
3072       auto *CUDie = CU->getUnitDIE(false);
3073       if (Options.Verbose) {
3074         outs() << "Input compilation unit:";
3075         CUDie->dump(outs(), CU.get(), 0);
3076       }
3077       Units.emplace_back(*CU, UnitID++, !Options.NoODR);
3078       gatherDIEParents(CUDie, 0, Units.back(), &ODRContexts.getRoot(),
3079                        StringPool, ODRContexts);
3080     }
3081
3082     // Then mark all the DIEs that need to be present in the linked
3083     // output and collect some information about them. Note that this
3084     // loop can not be merged with the previous one becaue cross-cu
3085     // references require the ParentIdx to be setup for every CU in
3086     // the object file before calling this.
3087     for (auto &CurrentUnit : Units)
3088       lookForDIEsToKeep(*CurrentUnit.getOrigUnit().getUnitDIE(), *Obj,
3089                         CurrentUnit, 0);
3090
3091     // The calls to applyValidRelocs inside cloneDIE will walk the
3092     // reloc array again (in the same way findValidRelocsInDebugInfo()
3093     // did). We need to reset the NextValidReloc index to the beginning.
3094     NextValidReloc = 0;
3095
3096     // Construct the output DIE tree by cloning the DIEs we chose to
3097     // keep above. If there are no valid relocs, then there's nothing
3098     // to clone/emit.
3099     if (!ValidRelocs.empty())
3100       for (auto &CurrentUnit : Units) {
3101         const auto *InputDIE = CurrentUnit.getOrigUnit().getUnitDIE();
3102         CurrentUnit.setStartOffset(OutputDebugInfoSize);
3103         DIE *OutputDIE = cloneDIE(*InputDIE, CurrentUnit, 0 /* PCOffset */,
3104                                   11 /* Unit Header size */);
3105         CurrentUnit.setOutputUnitDIE(OutputDIE);
3106         OutputDebugInfoSize = CurrentUnit.computeNextUnitOffset();
3107         if (Options.NoOutput)
3108           continue;
3109         // FIXME: for compatibility with the classic dsymutil, we emit
3110         // an empty line table for the unit, even if the unit doesn't
3111         // actually exist in the DIE tree.
3112         patchLineTableForUnit(CurrentUnit, DwarfContext);
3113         if (!OutputDIE)
3114           continue;
3115         patchRangesForUnit(CurrentUnit, DwarfContext);
3116         Streamer->emitLocationsForUnit(CurrentUnit, DwarfContext);
3117         emitAcceleratorEntriesForUnit(CurrentUnit);
3118       }
3119
3120     // Emit all the compile unit's debug information.
3121     if (!ValidRelocs.empty() && !Options.NoOutput)
3122       for (auto &CurrentUnit : Units) {
3123         generateUnitRanges(CurrentUnit);
3124         CurrentUnit.fixupForwardReferences();
3125         Streamer->emitCompileUnitHeader(CurrentUnit);
3126         if (!CurrentUnit.getOutputUnitDIE())
3127           continue;
3128         Streamer->emitDIE(*CurrentUnit.getOutputUnitDIE());
3129       }
3130
3131     if (!ValidRelocs.empty() && !Options.NoOutput && !Units.empty())
3132       patchFrameInfoForObject(*Obj, DwarfContext,
3133                               Units[0].getOrigUnit().getAddressByteSize());
3134
3135     // Clean-up before starting working on the next object.
3136     endDebugObject();
3137   }
3138
3139   // Emit everything that's global.
3140   if (!Options.NoOutput) {
3141     Streamer->emitAbbrevs(Abbreviations);
3142     Streamer->emitStrings(StringPool);
3143   }
3144
3145   return Options.NoOutput ? true : Streamer->finish();
3146 }
3147 }
3148
3149 bool linkDwarf(StringRef OutputFilename, const DebugMap &DM,
3150                const LinkOptions &Options) {
3151   DwarfLinker Linker(OutputFilename, Options);
3152   return Linker.link(DM);
3153 }
3154 }
3155 }