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