1 //===-- llvm/CodeGen/DwarfDebug.cpp - Dwarf Debug Framework ---------------===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This file contains support for writing dwarf debug info into asm files.
12 //===----------------------------------------------------------------------===//
14 #include "ByteStreamer.h"
15 #include "DwarfDebug.h"
18 #include "DwarfUnit.h"
19 #include "llvm/ADT/STLExtras.h"
20 #include "llvm/ADT/Statistic.h"
21 #include "llvm/ADT/StringExtras.h"
22 #include "llvm/ADT/Triple.h"
23 #include "llvm/CodeGen/MachineFunction.h"
24 #include "llvm/CodeGen/MachineModuleInfo.h"
25 #include "llvm/IR/Constants.h"
26 #include "llvm/IR/DIBuilder.h"
27 #include "llvm/IR/DataLayout.h"
28 #include "llvm/IR/DebugInfo.h"
29 #include "llvm/IR/Instructions.h"
30 #include "llvm/IR/Module.h"
31 #include "llvm/IR/ValueHandle.h"
32 #include "llvm/MC/MCAsmInfo.h"
33 #include "llvm/MC/MCSection.h"
34 #include "llvm/MC/MCStreamer.h"
35 #include "llvm/MC/MCSymbol.h"
36 #include "llvm/Support/CommandLine.h"
37 #include "llvm/Support/Debug.h"
38 #include "llvm/Support/Dwarf.h"
39 #include "llvm/Support/ErrorHandling.h"
40 #include "llvm/Support/FormattedStream.h"
41 #include "llvm/Support/LEB128.h"
42 #include "llvm/Support/MD5.h"
43 #include "llvm/Support/Path.h"
44 #include "llvm/Support/Timer.h"
45 #include "llvm/Target/TargetFrameLowering.h"
46 #include "llvm/Target/TargetLoweringObjectFile.h"
47 #include "llvm/Target/TargetMachine.h"
48 #include "llvm/Target/TargetOptions.h"
49 #include "llvm/Target/TargetRegisterInfo.h"
52 #define DEBUG_TYPE "dwarfdebug"
55 DisableDebugInfoPrinting("disable-debug-info-print", cl::Hidden,
56 cl::desc("Disable debug info printing"));
58 static cl::opt<bool> UnknownLocations(
59 "use-unknown-locations", cl::Hidden,
60 cl::desc("Make an absence of debug location information explicit."),
64 GenerateGnuPubSections("generate-gnu-dwarf-pub-sections", cl::Hidden,
65 cl::desc("Generate GNU-style pubnames and pubtypes"),
68 static cl::opt<bool> GenerateARangeSection("generate-arange-section",
70 cl::desc("Generate dwarf aranges"),
74 enum DefaultOnOff { Default, Enable, Disable };
77 static cl::opt<DefaultOnOff>
78 DwarfAccelTables("dwarf-accel-tables", cl::Hidden,
79 cl::desc("Output prototype dwarf accelerator tables."),
80 cl::values(clEnumVal(Default, "Default for platform"),
81 clEnumVal(Enable, "Enabled"),
82 clEnumVal(Disable, "Disabled"), clEnumValEnd),
85 static cl::opt<DefaultOnOff>
86 SplitDwarf("split-dwarf", cl::Hidden,
87 cl::desc("Output DWARF5 split debug info."),
88 cl::values(clEnumVal(Default, "Default for platform"),
89 clEnumVal(Enable, "Enabled"),
90 clEnumVal(Disable, "Disabled"), clEnumValEnd),
93 static cl::opt<DefaultOnOff>
94 DwarfPubSections("generate-dwarf-pub-sections", cl::Hidden,
95 cl::desc("Generate DWARF pubnames and pubtypes sections"),
96 cl::values(clEnumVal(Default, "Default for platform"),
97 clEnumVal(Enable, "Enabled"),
98 clEnumVal(Disable, "Disabled"), clEnumValEnd),
101 static cl::opt<unsigned>
102 DwarfVersionNumber("dwarf-version", cl::Hidden,
103 cl::desc("Generate DWARF for dwarf version."), cl::init(0));
105 static const char *const DWARFGroupName = "DWARF Emission";
106 static const char *const DbgTimerName = "DWARF Debug Writer";
108 //===----------------------------------------------------------------------===//
110 /// resolve - Look in the DwarfDebug map for the MDNode that
111 /// corresponds to the reference.
112 template <typename T> T DbgVariable::resolve(DIRef<T> Ref) const {
113 return DD->resolve(Ref);
116 bool DbgVariable::isBlockByrefVariable() const {
117 assert(Var.isVariable() && "Invalid complex DbgVariable!");
118 return Var.isBlockByrefVariable(DD->getTypeIdentifierMap());
121 DIType DbgVariable::getType() const {
122 DIType Ty = Var.getType().resolve(DD->getTypeIdentifierMap());
123 // FIXME: isBlockByrefVariable should be reformulated in terms of complex
124 // addresses instead.
125 if (Var.isBlockByrefVariable(DD->getTypeIdentifierMap())) {
126 /* Byref variables, in Blocks, are declared by the programmer as
127 "SomeType VarName;", but the compiler creates a
128 __Block_byref_x_VarName struct, and gives the variable VarName
129 either the struct, or a pointer to the struct, as its type. This
130 is necessary for various behind-the-scenes things the compiler
131 needs to do with by-reference variables in blocks.
133 However, as far as the original *programmer* is concerned, the
134 variable should still have type 'SomeType', as originally declared.
136 The following function dives into the __Block_byref_x_VarName
137 struct to find the original type of the variable. This will be
138 passed back to the code generating the type for the Debug
139 Information Entry for the variable 'VarName'. 'VarName' will then
140 have the original type 'SomeType' in its debug information.
142 The original type 'SomeType' will be the type of the field named
143 'VarName' inside the __Block_byref_x_VarName struct.
145 NOTE: In order for this to not completely fail on the debugger
146 side, the Debug Information Entry for the variable VarName needs to
147 have a DW_AT_location that tells the debugger how to unwind through
148 the pointers and __Block_byref_x_VarName struct to find the actual
149 value of the variable. The function addBlockByrefType does this. */
151 uint16_t tag = Ty.getTag();
153 if (tag == dwarf::DW_TAG_pointer_type)
154 subType = resolve(DIDerivedType(Ty).getTypeDerivedFrom());
156 DIArray Elements = DICompositeType(subType).getTypeArray();
157 for (unsigned i = 0, N = Elements.getNumElements(); i < N; ++i) {
158 DIDerivedType DT(Elements.getElement(i));
159 if (getName() == DT.getName())
160 return (resolve(DT.getTypeDerivedFrom()));
166 static LLVM_CONSTEXPR DwarfAccelTable::Atom TypeAtoms[] = {
167 DwarfAccelTable::Atom(dwarf::DW_ATOM_die_offset, dwarf::DW_FORM_data4),
168 DwarfAccelTable::Atom(dwarf::DW_ATOM_die_tag, dwarf::DW_FORM_data2),
169 DwarfAccelTable::Atom(dwarf::DW_ATOM_type_flags, dwarf::DW_FORM_data1)};
171 DwarfDebug::DwarfDebug(AsmPrinter *A, Module *M)
172 : Asm(A), MMI(Asm->MMI), FirstCU(nullptr), PrevLabel(nullptr),
173 GlobalRangeCount(0), InfoHolder(A, "info_string", DIEValueAllocator),
174 UsedNonDefaultText(false),
175 SkeletonHolder(A, "skel_string", DIEValueAllocator),
176 AccelNames(DwarfAccelTable::Atom(dwarf::DW_ATOM_die_offset,
177 dwarf::DW_FORM_data4)),
178 AccelObjC(DwarfAccelTable::Atom(dwarf::DW_ATOM_die_offset,
179 dwarf::DW_FORM_data4)),
180 AccelNamespace(DwarfAccelTable::Atom(dwarf::DW_ATOM_die_offset,
181 dwarf::DW_FORM_data4)),
182 AccelTypes(TypeAtoms) {
184 DwarfInfoSectionSym = DwarfAbbrevSectionSym = DwarfStrSectionSym = nullptr;
185 DwarfDebugRangeSectionSym = DwarfDebugLocSectionSym = nullptr;
186 DwarfLineSectionSym = nullptr;
187 DwarfAddrSectionSym = nullptr;
188 DwarfAbbrevDWOSectionSym = DwarfStrDWOSectionSym = nullptr;
189 FunctionBeginSym = FunctionEndSym = nullptr;
193 // Turn on accelerator tables for Darwin by default, pubnames by
194 // default for non-Darwin, and handle split dwarf.
195 bool IsDarwin = Triple(A->getTargetTriple()).isOSDarwin();
197 if (DwarfAccelTables == Default)
198 HasDwarfAccelTables = IsDarwin;
200 HasDwarfAccelTables = DwarfAccelTables == Enable;
202 if (SplitDwarf == Default)
203 HasSplitDwarf = false;
205 HasSplitDwarf = SplitDwarf == Enable;
207 if (DwarfPubSections == Default)
208 HasDwarfPubSections = !IsDarwin;
210 HasDwarfPubSections = DwarfPubSections == Enable;
212 DwarfVersion = DwarfVersionNumber ? DwarfVersionNumber
213 : MMI->getModule()->getDwarfVersion();
216 NamedRegionTimer T(DbgTimerName, DWARFGroupName, TimePassesIsEnabled);
221 // Define out of line so we don't have to include DwarfUnit.h in DwarfDebug.h.
222 DwarfDebug::~DwarfDebug() { }
224 // Switch to the specified MCSection and emit an assembler
225 // temporary label to it if SymbolStem is specified.
226 static MCSymbol *emitSectionSym(AsmPrinter *Asm, const MCSection *Section,
227 const char *SymbolStem = nullptr) {
228 Asm->OutStreamer.SwitchSection(Section);
232 MCSymbol *TmpSym = Asm->GetTempSymbol(SymbolStem);
233 Asm->OutStreamer.EmitLabel(TmpSym);
237 static bool isObjCClass(StringRef Name) {
238 return Name.startswith("+") || Name.startswith("-");
241 static bool hasObjCCategory(StringRef Name) {
242 if (!isObjCClass(Name))
245 return Name.find(") ") != StringRef::npos;
248 static void getObjCClassCategory(StringRef In, StringRef &Class,
249 StringRef &Category) {
250 if (!hasObjCCategory(In)) {
251 Class = In.slice(In.find('[') + 1, In.find(' '));
256 Class = In.slice(In.find('[') + 1, In.find('('));
257 Category = In.slice(In.find('[') + 1, In.find(' '));
261 static StringRef getObjCMethodName(StringRef In) {
262 return In.slice(In.find(' ') + 1, In.find(']'));
265 // Helper for sorting sections into a stable output order.
266 static bool SectionSort(const MCSection *A, const MCSection *B) {
267 std::string LA = (A ? A->getLabelBeginName() : "");
268 std::string LB = (B ? B->getLabelBeginName() : "");
272 // Add the various names to the Dwarf accelerator table names.
273 // TODO: Determine whether or not we should add names for programs
274 // that do not have a DW_AT_name or DW_AT_linkage_name field - this
275 // is only slightly different than the lookup of non-standard ObjC names.
276 void DwarfDebug::addSubprogramNames(DISubprogram SP, DIE &Die) {
277 if (!SP.isDefinition())
279 addAccelName(SP.getName(), Die);
281 // If the linkage name is different than the name, go ahead and output
282 // that as well into the name table.
283 if (SP.getLinkageName() != "" && SP.getName() != SP.getLinkageName())
284 addAccelName(SP.getLinkageName(), Die);
286 // If this is an Objective-C selector name add it to the ObjC accelerator
288 if (isObjCClass(SP.getName())) {
289 StringRef Class, Category;
290 getObjCClassCategory(SP.getName(), Class, Category);
291 addAccelObjC(Class, Die);
293 addAccelObjC(Category, Die);
294 // Also add the base method name to the name table.
295 addAccelName(getObjCMethodName(SP.getName()), Die);
299 /// isSubprogramContext - Return true if Context is either a subprogram
300 /// or another context nested inside a subprogram.
301 bool DwarfDebug::isSubprogramContext(const MDNode *Context) {
304 DIDescriptor D(Context);
305 if (D.isSubprogram())
308 return isSubprogramContext(resolve(DIType(Context).getContext()));
312 // Find DIE for the given subprogram and attach appropriate DW_AT_low_pc
313 // and DW_AT_high_pc attributes. If there are global variables in this
314 // scope then create and insert DIEs for these variables.
315 DIE &DwarfDebug::updateSubprogramScopeDIE(DwarfCompileUnit &SPCU,
317 DIE *SPDie = SPCU.getOrCreateSubprogramDIE(SP);
319 attachLowHighPC(SPCU, *SPDie, FunctionBeginSym, FunctionEndSym);
321 const TargetRegisterInfo *RI = Asm->TM.getRegisterInfo();
322 MachineLocation Location(RI->getFrameRegister(*Asm->MF));
323 SPCU.addAddress(*SPDie, dwarf::DW_AT_frame_base, Location);
325 // Add name to the name table, we do this here because we're guaranteed
326 // to have concrete versions of our DW_TAG_subprogram nodes.
327 addSubprogramNames(SP, *SPDie);
332 /// Check whether we should create a DIE for the given Scope, return true
333 /// if we don't create a DIE (the corresponding DIE is null).
334 bool DwarfDebug::isLexicalScopeDIENull(LexicalScope *Scope) {
335 if (Scope->isAbstractScope())
338 // We don't create a DIE if there is no Range.
339 const SmallVectorImpl<InsnRange> &Ranges = Scope->getRanges();
343 if (Ranges.size() > 1)
346 // We don't create a DIE if we have a single Range and the end label
348 SmallVectorImpl<InsnRange>::const_iterator RI = Ranges.begin();
349 MCSymbol *End = getLabelAfterInsn(RI->second);
353 static void addSectionLabel(AsmPrinter &Asm, DwarfUnit &U, DIE &D,
354 dwarf::Attribute A, const MCSymbol *L,
355 const MCSymbol *Sec) {
356 if (Asm.MAI->doesDwarfUseRelocationsAcrossSections())
357 U.addSectionLabel(D, A, L);
359 U.addSectionDelta(D, A, L, Sec);
362 void DwarfDebug::addScopeRangeList(DwarfCompileUnit &TheCU, DIE &ScopeDIE,
363 const SmallVectorImpl<InsnRange> &Range) {
364 // Emit offset in .debug_range as a relocatable label. emitDIE will handle
365 // emitting it appropriately.
366 MCSymbol *RangeSym = Asm->GetTempSymbol("debug_ranges", GlobalRangeCount++);
368 // Under fission, ranges are specified by constant offsets relative to the
369 // CU's DW_AT_GNU_ranges_base.
371 TheCU.addSectionDelta(ScopeDIE, dwarf::DW_AT_ranges, RangeSym,
372 DwarfDebugRangeSectionSym);
374 addSectionLabel(*Asm, TheCU, ScopeDIE, dwarf::DW_AT_ranges, RangeSym,
375 DwarfDebugRangeSectionSym);
377 RangeSpanList List(RangeSym);
378 for (const InsnRange &R : Range) {
379 RangeSpan Span(getLabelBeforeInsn(R.first), getLabelAfterInsn(R.second));
380 List.addRange(std::move(Span));
383 // Add the range list to the set of ranges to be emitted.
384 TheCU.addRangeList(std::move(List));
387 void DwarfDebug::attachRangesOrLowHighPC(DwarfCompileUnit &TheCU, DIE &Die,
388 const SmallVectorImpl<InsnRange> &Ranges) {
389 assert(!Ranges.empty());
390 if (Ranges.size() == 1)
391 attachLowHighPC(TheCU, Die, getLabelBeforeInsn(Ranges.front().first),
392 getLabelAfterInsn(Ranges.front().second));
394 addScopeRangeList(TheCU, Die, Ranges);
397 // Construct new DW_TAG_lexical_block for this scope and attach
398 // DW_AT_low_pc/DW_AT_high_pc labels.
400 DwarfDebug::constructLexicalScopeDIE(DwarfCompileUnit &TheCU,
401 LexicalScope *Scope) {
402 if (isLexicalScopeDIENull(Scope))
405 auto ScopeDIE = make_unique<DIE>(dwarf::DW_TAG_lexical_block);
406 if (Scope->isAbstractScope())
409 attachRangesOrLowHighPC(TheCU, *ScopeDIE, Scope->getRanges());
414 // This scope represents inlined body of a function. Construct DIE to
415 // represent this concrete inlined copy of the function.
417 DwarfDebug::constructInlinedScopeDIE(DwarfCompileUnit &TheCU,
418 LexicalScope *Scope) {
419 assert(Scope->getScopeNode());
420 DIScope DS(Scope->getScopeNode());
421 DISubprogram InlinedSP = getDISubprogram(DS);
422 // Find the subprogram's DwarfCompileUnit in the SPMap in case the subprogram
423 // was inlined from another compile unit.
424 DIE *OriginDIE = AbstractSPDies[InlinedSP];
425 assert(OriginDIE && "Unable to find original DIE for an inlined subprogram.");
427 auto ScopeDIE = make_unique<DIE>(dwarf::DW_TAG_inlined_subroutine);
428 TheCU.addDIEEntry(*ScopeDIE, dwarf::DW_AT_abstract_origin, *OriginDIE);
430 attachRangesOrLowHighPC(TheCU, *ScopeDIE, Scope->getRanges());
432 InlinedSubprogramDIEs.insert(OriginDIE);
434 // Add the call site information to the DIE.
435 DILocation DL(Scope->getInlinedAt());
436 TheCU.addUInt(*ScopeDIE, dwarf::DW_AT_call_file, None,
437 TheCU.getOrCreateSourceID(DL.getFilename(), DL.getDirectory()));
438 TheCU.addUInt(*ScopeDIE, dwarf::DW_AT_call_line, None, DL.getLineNumber());
440 // Add name to the name table, we do this here because we're guaranteed
441 // to have concrete versions of our DW_TAG_inlined_subprogram nodes.
442 addSubprogramNames(InlinedSP, *ScopeDIE);
447 static std::unique_ptr<DIE> constructVariableDIE(DwarfCompileUnit &TheCU,
449 const LexicalScope &Scope,
450 DIE *&ObjectPointer) {
451 auto Var = TheCU.constructVariableDIE(DV, Scope.isAbstractScope());
452 if (DV.isObjectPointer())
453 ObjectPointer = Var.get();
457 DIE *DwarfDebug::createScopeChildrenDIE(
458 DwarfCompileUnit &TheCU, LexicalScope *Scope,
459 SmallVectorImpl<std::unique_ptr<DIE>> &Children) {
460 DIE *ObjectPointer = nullptr;
462 // Collect arguments for current function.
463 if (LScopes.isCurrentFunctionScope(Scope)) {
464 for (DbgVariable *ArgDV : CurrentFnArguments)
467 constructVariableDIE(TheCU, *ArgDV, *Scope, ObjectPointer));
469 // If this is a variadic function, add an unspecified parameter.
470 DISubprogram SP(Scope->getScopeNode());
471 DIArray FnArgs = SP.getType().getTypeArray();
472 if (FnArgs.getElement(FnArgs.getNumElements() - 1)
473 .isUnspecifiedParameter()) {
475 make_unique<DIE>(dwarf::DW_TAG_unspecified_parameters));
479 // Collect lexical scope children first.
480 for (DbgVariable *DV : ScopeVariables.lookup(Scope))
481 Children.push_back(constructVariableDIE(TheCU, *DV, *Scope, ObjectPointer));
483 for (LexicalScope *LS : Scope->getChildren())
484 if (std::unique_ptr<DIE> Nested = constructScopeDIE(TheCU, LS))
485 Children.push_back(std::move(Nested));
486 return ObjectPointer;
489 void DwarfDebug::createAndAddScopeChildren(DwarfCompileUnit &TheCU,
490 LexicalScope *Scope, DIE &ScopeDIE) {
491 // We create children when the scope DIE is not null.
492 SmallVector<std::unique_ptr<DIE>, 8> Children;
493 if (DIE *ObjectPointer = createScopeChildrenDIE(TheCU, Scope, Children))
494 TheCU.addDIEEntry(ScopeDIE, dwarf::DW_AT_object_pointer, *ObjectPointer);
497 for (auto &I : Children)
498 ScopeDIE.addChild(std::move(I));
501 void DwarfDebug::constructAbstractSubprogramScopeDIE(DwarfCompileUnit &TheCU,
502 LexicalScope *Scope) {
503 assert(Scope && Scope->getScopeNode());
504 assert(Scope->isAbstractScope());
505 assert(!Scope->getInlinedAt());
507 DISubprogram SP(Scope->getScopeNode());
509 ProcessedSPNodes.insert(SP);
511 DIE *&AbsDef = AbstractSPDies[SP];
515 // Find the subprogram's DwarfCompileUnit in the SPMap in case the subprogram
516 // was inlined from another compile unit.
517 DwarfCompileUnit &SPCU = *SPMap[SP];
520 // Some of this is duplicated from DwarfUnit::getOrCreateSubprogramDIE, with
521 // the important distinction that the DIDescriptor is not associated with the
522 // DIE (since the DIDescriptor will be associated with the concrete DIE, if
523 // any). It could be refactored to some common utility function.
524 if (DISubprogram SPDecl = SP.getFunctionDeclaration()) {
525 ContextDIE = &SPCU.getUnitDie();
526 SPCU.getOrCreateSubprogramDIE(SPDecl);
528 ContextDIE = SPCU.getOrCreateContextDIE(resolve(SP.getContext()));
530 // Passing null as the associated DIDescriptor because the abstract definition
531 // shouldn't be found by lookup.
532 AbsDef = &SPCU.createAndAddDIE(dwarf::DW_TAG_subprogram, *ContextDIE,
534 SPCU.applySubprogramAttributes(SP, *AbsDef);
535 SPCU.addGlobalName(SP.getName(), *AbsDef, resolve(SP.getContext()));
537 SPCU.addUInt(*AbsDef, dwarf::DW_AT_inline, None, dwarf::DW_INL_inlined);
538 createAndAddScopeChildren(SPCU, Scope, *AbsDef);
541 DIE &DwarfDebug::constructSubprogramScopeDIE(DwarfCompileUnit &TheCU,
542 LexicalScope *Scope) {
543 assert(Scope && Scope->getScopeNode());
544 assert(!Scope->getInlinedAt());
545 assert(!Scope->isAbstractScope());
546 DISubprogram Sub(Scope->getScopeNode());
548 assert(Sub.isSubprogram());
550 ProcessedSPNodes.insert(Sub);
552 DIE &ScopeDIE = updateSubprogramScopeDIE(TheCU, Sub);
554 createAndAddScopeChildren(TheCU, Scope, ScopeDIE);
559 // Construct a DIE for this scope.
560 std::unique_ptr<DIE> DwarfDebug::constructScopeDIE(DwarfCompileUnit &TheCU,
561 LexicalScope *Scope) {
562 if (!Scope || !Scope->getScopeNode())
565 DIScope DS(Scope->getScopeNode());
567 assert((Scope->getInlinedAt() || !DS.isSubprogram()) &&
568 "Only handle inlined subprograms here, use "
569 "constructSubprogramScopeDIE for non-inlined "
572 SmallVector<std::unique_ptr<DIE>, 8> Children;
574 // We try to create the scope DIE first, then the children DIEs. This will
575 // avoid creating un-used children then removing them later when we find out
576 // the scope DIE is null.
577 std::unique_ptr<DIE> ScopeDIE;
578 if (Scope->getParent() && DS.isSubprogram()) {
579 ScopeDIE = constructInlinedScopeDIE(TheCU, Scope);
582 // We create children when the scope DIE is not null.
583 createScopeChildrenDIE(TheCU, Scope, Children);
585 // Early exit when we know the scope DIE is going to be null.
586 if (isLexicalScopeDIENull(Scope))
589 // We create children here when we know the scope DIE is not going to be
590 // null and the children will be added to the scope DIE.
591 createScopeChildrenDIE(TheCU, Scope, Children);
593 // There is no need to emit empty lexical block DIE.
594 std::pair<ImportedEntityMap::const_iterator,
595 ImportedEntityMap::const_iterator> Range =
596 std::equal_range(ScopesWithImportedEntities.begin(),
597 ScopesWithImportedEntities.end(),
598 std::pair<const MDNode *, const MDNode *>(DS, nullptr),
600 if (Children.empty() && Range.first == Range.second)
602 ScopeDIE = constructLexicalScopeDIE(TheCU, Scope);
603 assert(ScopeDIE && "Scope DIE should not be null.");
604 for (ImportedEntityMap::const_iterator i = Range.first; i != Range.second;
606 constructImportedEntityDIE(TheCU, i->second, *ScopeDIE);
610 for (auto &I : Children)
611 ScopeDIE->addChild(std::move(I));
616 void DwarfDebug::addGnuPubAttributes(DwarfUnit &U, DIE &D) const {
617 if (!GenerateGnuPubSections)
620 U.addFlag(D, dwarf::DW_AT_GNU_pubnames);
623 // Create new DwarfCompileUnit for the given metadata node with tag
624 // DW_TAG_compile_unit.
625 DwarfCompileUnit &DwarfDebug::constructDwarfCompileUnit(DICompileUnit DIUnit) {
626 StringRef FN = DIUnit.getFilename();
627 CompilationDir = DIUnit.getDirectory();
629 auto OwnedUnit = make_unique<DwarfCompileUnit>(
630 InfoHolder.getUnits().size(), DIUnit, Asm, this, &InfoHolder);
631 DwarfCompileUnit &NewCU = *OwnedUnit;
632 DIE &Die = NewCU.getUnitDie();
633 InfoHolder.addUnit(std::move(OwnedUnit));
635 // LTO with assembly output shares a single line table amongst multiple CUs.
636 // To avoid the compilation directory being ambiguous, let the line table
637 // explicitly describe the directory of all files, never relying on the
638 // compilation directory.
639 if (!Asm->OutStreamer.hasRawTextSupport() || SingleCU)
640 Asm->OutStreamer.getContext().setMCLineTableCompilationDir(
641 NewCU.getUniqueID(), CompilationDir);
643 NewCU.addString(Die, dwarf::DW_AT_producer, DIUnit.getProducer());
644 NewCU.addUInt(Die, dwarf::DW_AT_language, dwarf::DW_FORM_data2,
645 DIUnit.getLanguage());
646 NewCU.addString(Die, dwarf::DW_AT_name, FN);
648 if (!useSplitDwarf()) {
649 NewCU.initStmtList(DwarfLineSectionSym);
651 // If we're using split dwarf the compilation dir is going to be in the
652 // skeleton CU and so we don't need to duplicate it here.
653 if (!CompilationDir.empty())
654 NewCU.addString(Die, dwarf::DW_AT_comp_dir, CompilationDir);
656 addGnuPubAttributes(NewCU, Die);
659 if (DIUnit.isOptimized())
660 NewCU.addFlag(Die, dwarf::DW_AT_APPLE_optimized);
662 StringRef Flags = DIUnit.getFlags();
664 NewCU.addString(Die, dwarf::DW_AT_APPLE_flags, Flags);
666 if (unsigned RVer = DIUnit.getRunTimeVersion())
667 NewCU.addUInt(Die, dwarf::DW_AT_APPLE_major_runtime_vers,
668 dwarf::DW_FORM_data1, RVer);
673 if (useSplitDwarf()) {
674 NewCU.initSection(Asm->getObjFileLowering().getDwarfInfoDWOSection(),
675 DwarfInfoDWOSectionSym);
676 NewCU.setSkeleton(constructSkeletonCU(NewCU));
678 NewCU.initSection(Asm->getObjFileLowering().getDwarfInfoSection(),
679 DwarfInfoSectionSym);
681 CUMap.insert(std::make_pair(DIUnit, &NewCU));
682 CUDieMap.insert(std::make_pair(&Die, &NewCU));
686 void DwarfDebug::constructImportedEntityDIE(DwarfCompileUnit &TheCU,
688 DIImportedEntity Module(N);
689 assert(Module.Verify());
690 if (DIE *D = TheCU.getOrCreateContextDIE(Module.getContext()))
691 constructImportedEntityDIE(TheCU, Module, *D);
694 void DwarfDebug::constructImportedEntityDIE(DwarfCompileUnit &TheCU,
695 const MDNode *N, DIE &Context) {
696 DIImportedEntity Module(N);
697 assert(Module.Verify());
698 return constructImportedEntityDIE(TheCU, Module, Context);
701 void DwarfDebug::constructImportedEntityDIE(DwarfCompileUnit &TheCU,
702 const DIImportedEntity &Module,
704 assert(Module.Verify() &&
705 "Use one of the MDNode * overloads to handle invalid metadata");
706 DIE &IMDie = TheCU.createAndAddDIE(Module.getTag(), Context, Module);
708 DIDescriptor Entity = resolve(Module.getEntity());
709 if (Entity.isNameSpace())
710 EntityDie = TheCU.getOrCreateNameSpace(DINameSpace(Entity));
711 else if (Entity.isSubprogram())
712 EntityDie = TheCU.getOrCreateSubprogramDIE(DISubprogram(Entity));
713 else if (Entity.isType())
714 EntityDie = TheCU.getOrCreateTypeDIE(DIType(Entity));
716 EntityDie = TheCU.getDIE(Entity);
717 TheCU.addSourceLine(IMDie, Module.getLineNumber(),
718 Module.getContext().getFilename(),
719 Module.getContext().getDirectory());
720 TheCU.addDIEEntry(IMDie, dwarf::DW_AT_import, *EntityDie);
721 StringRef Name = Module.getName();
723 TheCU.addString(IMDie, dwarf::DW_AT_name, Name);
726 // Emit all Dwarf sections that should come prior to the content. Create
727 // global DIEs and emit initial debug info sections. This is invoked by
728 // the target AsmPrinter.
729 void DwarfDebug::beginModule() {
730 if (DisableDebugInfoPrinting)
733 const Module *M = MMI->getModule();
735 // If module has named metadata anchors then use them, otherwise scan the
736 // module using debug info finder to collect debug info.
737 NamedMDNode *CU_Nodes = M->getNamedMetadata("llvm.dbg.cu");
740 TypeIdentifierMap = generateDITypeIdentifierMap(CU_Nodes);
742 // Emit initial sections so we can reference labels later.
745 SingleCU = CU_Nodes->getNumOperands() == 1;
747 for (MDNode *N : CU_Nodes->operands()) {
748 DICompileUnit CUNode(N);
749 DwarfCompileUnit &CU = constructDwarfCompileUnit(CUNode);
750 DIArray ImportedEntities = CUNode.getImportedEntities();
751 for (unsigned i = 0, e = ImportedEntities.getNumElements(); i != e; ++i)
752 ScopesWithImportedEntities.push_back(std::make_pair(
753 DIImportedEntity(ImportedEntities.getElement(i)).getContext(),
754 ImportedEntities.getElement(i)));
755 std::sort(ScopesWithImportedEntities.begin(),
756 ScopesWithImportedEntities.end(), less_first());
757 DIArray GVs = CUNode.getGlobalVariables();
758 for (unsigned i = 0, e = GVs.getNumElements(); i != e; ++i)
759 CU.createGlobalVariableDIE(DIGlobalVariable(GVs.getElement(i)));
760 DIArray SPs = CUNode.getSubprograms();
761 for (unsigned i = 0, e = SPs.getNumElements(); i != e; ++i)
762 SPMap.insert(std::make_pair(SPs.getElement(i), &CU));
763 DIArray EnumTypes = CUNode.getEnumTypes();
764 for (unsigned i = 0, e = EnumTypes.getNumElements(); i != e; ++i)
765 CU.getOrCreateTypeDIE(EnumTypes.getElement(i));
766 DIArray RetainedTypes = CUNode.getRetainedTypes();
767 for (unsigned i = 0, e = RetainedTypes.getNumElements(); i != e; ++i) {
768 DIType Ty(RetainedTypes.getElement(i));
769 // The retained types array by design contains pointers to
770 // MDNodes rather than DIRefs. Unique them here.
771 DIType UniqueTy(resolve(Ty.getRef()));
772 CU.getOrCreateTypeDIE(UniqueTy);
774 // Emit imported_modules last so that the relevant context is already
776 for (unsigned i = 0, e = ImportedEntities.getNumElements(); i != e; ++i)
777 constructImportedEntityDIE(CU, ImportedEntities.getElement(i));
780 // Tell MMI that we have debug info.
781 MMI->setDebugInfoAvailability(true);
783 // Prime section data.
784 SectionMap[Asm->getObjFileLowering().getTextSection()];
787 void DwarfDebug::finishSubprogramDefinitions() {
788 const Module *M = MMI->getModule();
790 NamedMDNode *CU_Nodes = M->getNamedMetadata("llvm.dbg.cu");
791 for (MDNode *N : CU_Nodes->operands()) {
792 DICompileUnit TheCU(N);
793 // Construct subprogram DIE and add variables DIEs.
794 DwarfCompileUnit *SPCU =
795 static_cast<DwarfCompileUnit *>(CUMap.lookup(TheCU));
796 DIArray Subprograms = TheCU.getSubprograms();
797 for (unsigned i = 0, e = Subprograms.getNumElements(); i != e; ++i) {
798 DISubprogram SP(Subprograms.getElement(i));
799 // Perhaps the subprogram is in another CU (such as due to comdat
800 // folding, etc), in which case ignore it here.
801 if (SPMap[SP] != SPCU)
803 DIE *D = SPCU->getDIE(SP);
804 if (DIE *AbsSPDIE = AbstractSPDies.lookup(SP)) {
806 // If this subprogram has an abstract definition, reference that
807 SPCU->addDIEEntry(*D, dwarf::DW_AT_abstract_origin, *AbsSPDIE);
810 // Lazily construct the subprogram if we didn't see either concrete or
811 // inlined versions during codegen.
812 D = SPCU->getOrCreateSubprogramDIE(SP);
813 // And attach the attributes
814 SPCU->applySubprogramAttributes(SP, *D);
815 SPCU->addGlobalName(SP.getName(), *D, resolve(SP.getContext()));
822 // Collect info for variables that were optimized out.
823 void DwarfDebug::collectDeadVariables() {
824 const Module *M = MMI->getModule();
826 if (NamedMDNode *CU_Nodes = M->getNamedMetadata("llvm.dbg.cu")) {
827 for (MDNode *N : CU_Nodes->operands()) {
828 DICompileUnit TheCU(N);
829 // Construct subprogram DIE and add variables DIEs.
830 DwarfCompileUnit *SPCU =
831 static_cast<DwarfCompileUnit *>(CUMap.lookup(TheCU));
832 assert(SPCU && "Unable to find Compile Unit!");
833 DIArray Subprograms = TheCU.getSubprograms();
834 for (unsigned i = 0, e = Subprograms.getNumElements(); i != e; ++i) {
835 DISubprogram SP(Subprograms.getElement(i));
836 if (ProcessedSPNodes.count(SP) != 0)
838 assert(SP.isSubprogram() &&
839 "CU's subprogram list contains a non-subprogram");
840 assert(SP.isDefinition() &&
841 "CU's subprogram list contains a subprogram declaration");
842 DIArray Variables = SP.getVariables();
843 if (Variables.getNumElements() == 0)
846 DIE *SPDIE = AbstractSPDies.lookup(SP);
848 SPDIE = SPCU->getDIE(SP);
850 for (unsigned vi = 0, ve = Variables.getNumElements(); vi != ve; ++vi) {
851 DIVariable DV(Variables.getElement(vi));
852 assert(DV.isVariable());
853 DbgVariable NewVar(DV, nullptr, this);
854 SPDIE->addChild(SPCU->constructVariableDIE(NewVar));
861 void DwarfDebug::finalizeModuleInfo() {
862 finishSubprogramDefinitions();
864 // Collect info for variables that were optimized out.
865 collectDeadVariables();
867 // Handle anything that needs to be done on a per-unit basis after
868 // all other generation.
869 for (const auto &TheU : getUnits()) {
870 // Emit DW_AT_containing_type attribute to connect types with their
871 // vtable holding type.
872 TheU->constructContainingTypeDIEs();
874 // Add CU specific attributes if we need to add any.
875 if (TheU->getUnitDie().getTag() == dwarf::DW_TAG_compile_unit) {
876 // If we're splitting the dwarf out now that we've got the entire
877 // CU then add the dwo id to it.
878 DwarfCompileUnit *SkCU =
879 static_cast<DwarfCompileUnit *>(TheU->getSkeleton());
880 if (useSplitDwarf()) {
881 // Emit a unique identifier for this CU.
882 uint64_t ID = DIEHash(Asm).computeCUSignature(TheU->getUnitDie());
883 TheU->addUInt(TheU->getUnitDie(), dwarf::DW_AT_GNU_dwo_id,
884 dwarf::DW_FORM_data8, ID);
885 SkCU->addUInt(SkCU->getUnitDie(), dwarf::DW_AT_GNU_dwo_id,
886 dwarf::DW_FORM_data8, ID);
888 // We don't keep track of which addresses are used in which CU so this
889 // is a bit pessimistic under LTO.
890 if (!AddrPool.isEmpty())
891 addSectionLabel(*Asm, *SkCU, SkCU->getUnitDie(),
892 dwarf::DW_AT_GNU_addr_base, DwarfAddrSectionSym,
893 DwarfAddrSectionSym);
894 if (!TheU->getRangeLists().empty())
895 addSectionLabel(*Asm, *SkCU, SkCU->getUnitDie(),
896 dwarf::DW_AT_GNU_ranges_base,
897 DwarfDebugRangeSectionSym, DwarfDebugRangeSectionSym);
900 // If we have code split among multiple sections or non-contiguous
901 // ranges of code then emit a DW_AT_ranges attribute on the unit that will
902 // remain in the .o file, otherwise add a DW_AT_low_pc.
903 // FIXME: We should use ranges allow reordering of code ala
904 // .subsections_via_symbols in mach-o. This would mean turning on
905 // ranges for all subprogram DIEs for mach-o.
906 DwarfCompileUnit &U =
907 SkCU ? *SkCU : static_cast<DwarfCompileUnit &>(*TheU);
908 unsigned NumRanges = TheU->getRanges().size();
911 addSectionLabel(*Asm, U, U.getUnitDie(), dwarf::DW_AT_ranges,
912 Asm->GetTempSymbol("cu_ranges", U.getUniqueID()),
913 DwarfDebugRangeSectionSym);
915 // A DW_AT_low_pc attribute may also be specified in combination with
916 // DW_AT_ranges to specify the default base address for use in
917 // location lists (see Section 2.6.2) and range lists (see Section
919 U.addUInt(U.getUnitDie(), dwarf::DW_AT_low_pc, dwarf::DW_FORM_addr,
922 RangeSpan &Range = TheU->getRanges().back();
923 U.addLocalLabelAddress(U.getUnitDie(), dwarf::DW_AT_low_pc,
925 U.addLabelDelta(U.getUnitDie(), dwarf::DW_AT_high_pc, Range.getEnd(),
932 // Compute DIE offsets and sizes.
933 InfoHolder.computeSizeAndOffsets();
935 SkeletonHolder.computeSizeAndOffsets();
938 void DwarfDebug::endSections() {
939 // Filter labels by section.
940 for (const SymbolCU &SCU : ArangeLabels) {
941 if (SCU.Sym->isInSection()) {
942 // Make a note of this symbol and it's section.
943 const MCSection *Section = &SCU.Sym->getSection();
944 if (!Section->getKind().isMetadata())
945 SectionMap[Section].push_back(SCU);
947 // Some symbols (e.g. common/bss on mach-o) can have no section but still
948 // appear in the output. This sucks as we rely on sections to build
949 // arange spans. We can do it without, but it's icky.
950 SectionMap[nullptr].push_back(SCU);
954 // Build a list of sections used.
955 std::vector<const MCSection *> Sections;
956 for (const auto &it : SectionMap) {
957 const MCSection *Section = it.first;
958 Sections.push_back(Section);
961 // Sort the sections into order.
962 // This is only done to ensure consistent output order across different runs.
963 std::sort(Sections.begin(), Sections.end(), SectionSort);
965 // Add terminating symbols for each section.
966 for (unsigned ID = 0, E = Sections.size(); ID != E; ID++) {
967 const MCSection *Section = Sections[ID];
968 MCSymbol *Sym = nullptr;
971 // We can't call MCSection::getLabelEndName, as it's only safe to do so
972 // if we know the section name up-front. For user-created sections, the
973 // resulting label may not be valid to use as a label. (section names can
974 // use a greater set of characters on some systems)
975 Sym = Asm->GetTempSymbol("debug_end", ID);
976 Asm->OutStreamer.SwitchSection(Section);
977 Asm->OutStreamer.EmitLabel(Sym);
980 // Insert a final terminator.
981 SectionMap[Section].push_back(SymbolCU(nullptr, Sym));
985 // Emit all Dwarf sections that should come after the content.
986 void DwarfDebug::endModule() {
987 assert(CurFn == nullptr);
988 assert(CurMI == nullptr);
993 // End any existing sections.
994 // TODO: Does this need to happen?
997 // Finalize the debug info for the module.
998 finalizeModuleInfo();
1002 // Emit all the DIEs into a debug info section.
1005 // Corresponding abbreviations into a abbrev section.
1006 emitAbbreviations();
1008 // Emit info into a debug aranges section.
1009 if (GenerateARangeSection)
1012 // Emit info into a debug ranges section.
1015 if (useSplitDwarf()) {
1018 emitDebugAbbrevDWO();
1020 // Emit DWO addresses.
1021 AddrPool.emit(*Asm, Asm->getObjFileLowering().getDwarfAddrSection());
1024 // Emit info into a debug loc section.
1027 // Emit info into the dwarf accelerator table sections.
1028 if (useDwarfAccelTables()) {
1031 emitAccelNamespaces();
1035 // Emit the pubnames and pubtypes sections if requested.
1036 if (HasDwarfPubSections) {
1037 emitDebugPubNames(GenerateGnuPubSections);
1038 emitDebugPubTypes(GenerateGnuPubSections);
1043 AbstractVariables.clear();
1045 // Reset these for the next Module if we have one.
1049 // Find abstract variable, if any, associated with Var.
1050 DbgVariable *DwarfDebug::findAbstractVariable(DIVariable &DV,
1051 DebugLoc ScopeLoc) {
1052 return findAbstractVariable(DV, ScopeLoc.getScope(DV->getContext()));
1055 DbgVariable *DwarfDebug::getExistingAbstractVariable(DIVariable &DV,
1056 DIVariable &Cleansed) {
1057 LLVMContext &Ctx = DV->getContext();
1058 // More then one inlined variable corresponds to one abstract variable.
1059 // FIXME: This duplication of variables when inlining should probably be
1060 // removed. It's done to allow each DIVariable to describe its location
1061 // because the DebugLoc on the dbg.value/declare isn't accurate. We should
1062 // make it accurate then remove this duplication/cleansing stuff.
1063 Cleansed = cleanseInlinedVariable(DV, Ctx);
1064 auto I = AbstractVariables.find(Cleansed);
1065 if (I != AbstractVariables.end())
1066 return I->second.get();
1070 DbgVariable *DwarfDebug::createAbstractVariable(DIVariable &Var,
1071 LexicalScope *Scope) {
1072 auto AbsDbgVariable = make_unique<DbgVariable>(Var, nullptr, this);
1073 addScopeVariable(Scope, AbsDbgVariable.get());
1074 return (AbstractVariables[Var] = std::move(AbsDbgVariable)).get();
1077 DbgVariable *DwarfDebug::getOrCreateAbstractVariable(DIVariable &DV,
1078 const MDNode *ScopeNode) {
1079 DIVariable Cleansed = DV;
1080 if (DbgVariable *Var = getExistingAbstractVariable(DV, Cleansed))
1083 return createAbstractVariable(Cleansed,
1084 LScopes.getOrCreateAbstractScope(ScopeNode));
1087 DbgVariable *DwarfDebug::findAbstractVariable(DIVariable &DV,
1088 const MDNode *ScopeNode) {
1089 DIVariable Cleansed = DV;
1090 if (DbgVariable *Var = getExistingAbstractVariable(DV, Cleansed))
1093 if (LexicalScope *Scope = LScopes.findAbstractScope(ScopeNode))
1094 return createAbstractVariable(Cleansed, Scope);
1098 // If Var is a current function argument then add it to CurrentFnArguments list.
1099 bool DwarfDebug::addCurrentFnArgument(DbgVariable *Var, LexicalScope *Scope) {
1100 if (!LScopes.isCurrentFunctionScope(Scope))
1102 DIVariable DV = Var->getVariable();
1103 if (DV.getTag() != dwarf::DW_TAG_arg_variable)
1105 unsigned ArgNo = DV.getArgNumber();
1109 size_t Size = CurrentFnArguments.size();
1111 CurrentFnArguments.resize(CurFn->getFunction()->arg_size());
1112 // llvm::Function argument size is not good indicator of how many
1113 // arguments does the function have at source level.
1115 CurrentFnArguments.resize(ArgNo * 2);
1116 CurrentFnArguments[ArgNo - 1] = Var;
1120 // Collect variable information from side table maintained by MMI.
1121 void DwarfDebug::collectVariableInfoFromMMITable(
1122 SmallPtrSet<const MDNode *, 16> &Processed) {
1123 for (const auto &VI : MMI->getVariableDbgInfo()) {
1126 Processed.insert(VI.Var);
1127 DIVariable DV(VI.Var);
1128 LexicalScope *Scope = LScopes.findLexicalScope(VI.Loc);
1130 // If variable scope is not found then skip this variable.
1134 DbgVariable *AbsDbgVariable = findAbstractVariable(DV, VI.Loc);
1135 DbgVariable *RegVar = new DbgVariable(DV, AbsDbgVariable, this);
1136 RegVar->setFrameIndex(VI.Slot);
1137 if (!addCurrentFnArgument(RegVar, Scope))
1138 addScopeVariable(Scope, RegVar);
1142 // Get .debug_loc entry for the instruction range starting at MI.
1143 static DebugLocEntry::Value getDebugLocValue(const MachineInstr *MI) {
1144 const MDNode *Var = MI->getDebugVariable();
1146 assert(MI->getNumOperands() == 3);
1147 if (MI->getOperand(0).isReg()) {
1148 MachineLocation MLoc;
1149 // If the second operand is an immediate, this is a
1150 // register-indirect address.
1151 if (!MI->getOperand(1).isImm())
1152 MLoc.set(MI->getOperand(0).getReg());
1154 MLoc.set(MI->getOperand(0).getReg(), MI->getOperand(1).getImm());
1155 return DebugLocEntry::Value(Var, MLoc);
1157 if (MI->getOperand(0).isImm())
1158 return DebugLocEntry::Value(Var, MI->getOperand(0).getImm());
1159 if (MI->getOperand(0).isFPImm())
1160 return DebugLocEntry::Value(Var, MI->getOperand(0).getFPImm());
1161 if (MI->getOperand(0).isCImm())
1162 return DebugLocEntry::Value(Var, MI->getOperand(0).getCImm());
1164 llvm_unreachable("Unexpected 3 operand DBG_VALUE instruction!");
1167 // Find variables for each lexical scope.
1169 DwarfDebug::collectVariableInfo(SmallPtrSet<const MDNode *, 16> &Processed) {
1170 LexicalScope *FnScope = LScopes.getCurrentFunctionScope();
1171 DwarfCompileUnit *TheCU = SPMap.lookup(FnScope->getScopeNode());
1173 // Grab the variable info that was squirreled away in the MMI side-table.
1174 collectVariableInfoFromMMITable(Processed);
1176 for (const auto &I : DbgValues) {
1177 DIVariable DV(I.first);
1178 if (Processed.count(DV))
1181 // Instruction ranges, specifying where DV is accessible.
1182 const auto &Ranges = I.second;
1186 LexicalScope *Scope = nullptr;
1187 if (DV.getTag() == dwarf::DW_TAG_arg_variable &&
1188 DISubprogram(DV.getContext()).describes(CurFn->getFunction()))
1189 Scope = LScopes.getCurrentFunctionScope();
1190 else if (MDNode *IA = DV.getInlinedAt()) {
1191 DebugLoc DL = DebugLoc::getFromDILocation(IA);
1192 Scope = LScopes.findInlinedScope(DebugLoc::get(
1193 DL.getLine(), DL.getCol(), DV.getContext(), IA));
1195 Scope = LScopes.findLexicalScope(DV.getContext());
1196 // If variable scope is not found then skip this variable.
1200 Processed.insert(DV);
1201 const MachineInstr *MInsn = Ranges.front().first;
1202 assert(MInsn->isDebugValue() && "History must begin with debug value");
1203 DbgVariable *AbsVar = findAbstractVariable(DV, Scope->getScopeNode());
1204 DbgVariable *RegVar = new DbgVariable(MInsn, AbsVar, this);
1205 if (!addCurrentFnArgument(RegVar, Scope))
1206 addScopeVariable(Scope, RegVar);
1208 // Check if the first DBG_VALUE is valid for the rest of the function.
1209 if (Ranges.size() == 1 && Ranges.front().second == nullptr)
1212 // Handle multiple DBG_VALUE instructions describing one variable.
1213 RegVar->setDotDebugLocOffset(DotDebugLocEntries.size());
1215 DotDebugLocEntries.resize(DotDebugLocEntries.size() + 1);
1216 DebugLocList &LocList = DotDebugLocEntries.back();
1218 Asm->GetTempSymbol("debug_loc", DotDebugLocEntries.size() - 1);
1219 SmallVector<DebugLocEntry, 4> &DebugLoc = LocList.List;
1220 for (auto I = Ranges.begin(), E = Ranges.end(); I != E; ++I) {
1221 const MachineInstr *Begin = I->first;
1222 const MachineInstr *End = I->second;
1223 assert(Begin->isDebugValue() && "Invalid History entry");
1225 // Check if a variable is unaccessible in this range.
1226 if (Begin->getNumOperands() > 1 && Begin->getOperand(0).isReg() &&
1227 !Begin->getOperand(0).getReg())
1230 const MCSymbol *StartLabel = getLabelBeforeInsn(Begin);
1231 assert(StartLabel && "Forgot label before DBG_VALUE starting a range!");
1233 const MCSymbol *EndLabel;
1235 EndLabel = getLabelAfterInsn(End);
1236 else if (std::next(I) == Ranges.end())
1237 EndLabel = FunctionEndSym;
1239 EndLabel = getLabelBeforeInsn(std::next(I)->first);
1240 assert(EndLabel && "Forgot label after instruction ending a range!");
1242 DEBUG(dbgs() << "DotDebugLoc Pair:\n"
1243 << "\t" << *Begin << "\t" << *End << "\n");
1244 DebugLocEntry Loc(StartLabel, EndLabel, getDebugLocValue(Begin), TheCU);
1245 if (DebugLoc.empty() || !DebugLoc.back().Merge(Loc))
1246 DebugLoc.push_back(std::move(Loc));
1250 // Collect info for variables that were optimized out.
1251 DIArray Variables = DISubprogram(FnScope->getScopeNode()).getVariables();
1252 for (unsigned i = 0, e = Variables.getNumElements(); i != e; ++i) {
1253 DIVariable DV(Variables.getElement(i));
1254 assert(DV.isVariable());
1255 if (!Processed.insert(DV))
1257 if (LexicalScope *Scope = LScopes.findLexicalScope(DV.getContext()))
1260 new DbgVariable(DV, findAbstractVariable(DV, Scope->getScopeNode()),
1265 // Return Label preceding the instruction.
1266 MCSymbol *DwarfDebug::getLabelBeforeInsn(const MachineInstr *MI) {
1267 MCSymbol *Label = LabelsBeforeInsn.lookup(MI);
1268 assert(Label && "Didn't insert label before instruction");
1272 // Return Label immediately following the instruction.
1273 MCSymbol *DwarfDebug::getLabelAfterInsn(const MachineInstr *MI) {
1274 return LabelsAfterInsn.lookup(MI);
1277 // Process beginning of an instruction.
1278 void DwarfDebug::beginInstruction(const MachineInstr *MI) {
1279 assert(CurMI == nullptr);
1281 // Check if source location changes, but ignore DBG_VALUE locations.
1282 if (!MI->isDebugValue()) {
1283 DebugLoc DL = MI->getDebugLoc();
1284 if (DL != PrevInstLoc && (!DL.isUnknown() || UnknownLocations)) {
1287 if (DL == PrologEndLoc) {
1288 Flags |= DWARF2_FLAG_PROLOGUE_END;
1289 PrologEndLoc = DebugLoc();
1291 if (PrologEndLoc.isUnknown())
1292 Flags |= DWARF2_FLAG_IS_STMT;
1294 if (!DL.isUnknown()) {
1295 const MDNode *Scope = DL.getScope(Asm->MF->getFunction()->getContext());
1296 recordSourceLine(DL.getLine(), DL.getCol(), Scope, Flags);
1298 recordSourceLine(0, 0, nullptr, 0);
1302 // Insert labels where requested.
1303 DenseMap<const MachineInstr *, MCSymbol *>::iterator I =
1304 LabelsBeforeInsn.find(MI);
1307 if (I == LabelsBeforeInsn.end())
1310 // Label already assigned.
1315 PrevLabel = MMI->getContext().CreateTempSymbol();
1316 Asm->OutStreamer.EmitLabel(PrevLabel);
1318 I->second = PrevLabel;
1321 // Process end of an instruction.
1322 void DwarfDebug::endInstruction() {
1323 assert(CurMI != nullptr);
1324 // Don't create a new label after DBG_VALUE instructions.
1325 // They don't generate code.
1326 if (!CurMI->isDebugValue())
1327 PrevLabel = nullptr;
1329 DenseMap<const MachineInstr *, MCSymbol *>::iterator I =
1330 LabelsAfterInsn.find(CurMI);
1334 if (I == LabelsAfterInsn.end())
1337 // Label already assigned.
1341 // We need a label after this instruction.
1343 PrevLabel = MMI->getContext().CreateTempSymbol();
1344 Asm->OutStreamer.EmitLabel(PrevLabel);
1346 I->second = PrevLabel;
1349 // Each LexicalScope has first instruction and last instruction to mark
1350 // beginning and end of a scope respectively. Create an inverse map that list
1351 // scopes starts (and ends) with an instruction. One instruction may start (or
1352 // end) multiple scopes. Ignore scopes that are not reachable.
1353 void DwarfDebug::identifyScopeMarkers() {
1354 SmallVector<LexicalScope *, 4> WorkList;
1355 WorkList.push_back(LScopes.getCurrentFunctionScope());
1356 while (!WorkList.empty()) {
1357 LexicalScope *S = WorkList.pop_back_val();
1359 const SmallVectorImpl<LexicalScope *> &Children = S->getChildren();
1360 if (!Children.empty())
1361 WorkList.append(Children.begin(), Children.end());
1363 if (S->isAbstractScope())
1366 for (const InsnRange &R : S->getRanges()) {
1367 assert(R.first && "InsnRange does not have first instruction!");
1368 assert(R.second && "InsnRange does not have second instruction!");
1369 requestLabelBeforeInsn(R.first);
1370 requestLabelAfterInsn(R.second);
1375 static DebugLoc findPrologueEndLoc(const MachineFunction *MF) {
1376 // First known non-DBG_VALUE and non-frame setup location marks
1377 // the beginning of the function body.
1378 for (const auto &MBB : *MF)
1379 for (const auto &MI : MBB)
1380 if (!MI.isDebugValue() && !MI.getFlag(MachineInstr::FrameSetup) &&
1381 !MI.getDebugLoc().isUnknown())
1382 return MI.getDebugLoc();
1386 // Gather pre-function debug information. Assumes being called immediately
1387 // after the function entry point has been emitted.
1388 void DwarfDebug::beginFunction(const MachineFunction *MF) {
1391 // If there's no debug info for the function we're not going to do anything.
1392 if (!MMI->hasDebugInfo())
1395 // Grab the lexical scopes for the function, if we don't have any of those
1396 // then we're not going to be able to do anything.
1397 LScopes.initialize(*MF);
1398 if (LScopes.empty())
1401 assert(DbgValues.empty() && "DbgValues map wasn't cleaned!");
1403 // Make sure that each lexical scope will have a begin/end label.
1404 identifyScopeMarkers();
1406 // Set DwarfDwarfCompileUnitID in MCContext to the Compile Unit this function
1407 // belongs to so that we add to the correct per-cu line table in the
1409 LexicalScope *FnScope = LScopes.getCurrentFunctionScope();
1410 DwarfCompileUnit *TheCU = SPMap.lookup(FnScope->getScopeNode());
1411 assert(TheCU && "Unable to find compile unit!");
1412 if (Asm->OutStreamer.hasRawTextSupport())
1413 // Use a single line table if we are generating assembly.
1414 Asm->OutStreamer.getContext().setDwarfCompileUnitID(0);
1416 Asm->OutStreamer.getContext().setDwarfCompileUnitID(TheCU->getUniqueID());
1418 // Emit a label for the function so that we have a beginning address.
1419 FunctionBeginSym = Asm->GetTempSymbol("func_begin", Asm->getFunctionNumber());
1420 // Assumes in correct section after the entry point.
1421 Asm->OutStreamer.EmitLabel(FunctionBeginSym);
1423 // Calculate history for local variables.
1424 calculateDbgValueHistory(MF, Asm->TM.getRegisterInfo(), DbgValues);
1426 // Request labels for the full history.
1427 for (const auto &I : DbgValues) {
1428 const auto &Ranges = I.second;
1432 // The first mention of a function argument gets the FunctionBeginSym
1433 // label, so arguments are visible when breaking at function entry.
1434 DIVariable DV(I.first);
1435 if (DV.isVariable() && DV.getTag() == dwarf::DW_TAG_arg_variable &&
1436 getDISubprogram(DV.getContext()).describes(MF->getFunction()))
1437 LabelsBeforeInsn[Ranges.front().first] = FunctionBeginSym;
1439 for (const auto &Range : Ranges) {
1440 requestLabelBeforeInsn(Range.first);
1442 requestLabelAfterInsn(Range.second);
1446 PrevInstLoc = DebugLoc();
1447 PrevLabel = FunctionBeginSym;
1449 // Record beginning of function.
1450 PrologEndLoc = findPrologueEndLoc(MF);
1451 if (!PrologEndLoc.isUnknown()) {
1452 DebugLoc FnStartDL =
1453 PrologEndLoc.getFnDebugLoc(MF->getFunction()->getContext());
1455 FnStartDL.getLine(), FnStartDL.getCol(),
1456 FnStartDL.getScope(MF->getFunction()->getContext()),
1457 // We'd like to list the prologue as "not statements" but GDB behaves
1458 // poorly if we do that. Revisit this with caution/GDB (7.5+) testing.
1459 DWARF2_FLAG_IS_STMT);
1463 void DwarfDebug::addScopeVariable(LexicalScope *LS, DbgVariable *Var) {
1464 SmallVectorImpl<DbgVariable *> &Vars = ScopeVariables[LS];
1465 DIVariable DV = Var->getVariable();
1466 // Variables with positive arg numbers are parameters.
1467 if (unsigned ArgNum = DV.getArgNumber()) {
1468 // Keep all parameters in order at the start of the variable list to ensure
1469 // function types are correct (no out-of-order parameters)
1471 // This could be improved by only doing it for optimized builds (unoptimized
1472 // builds have the right order to begin with), searching from the back (this
1473 // would catch the unoptimized case quickly), or doing a binary search
1474 // rather than linear search.
1475 SmallVectorImpl<DbgVariable *>::iterator I = Vars.begin();
1476 while (I != Vars.end()) {
1477 unsigned CurNum = (*I)->getVariable().getArgNumber();
1478 // A local (non-parameter) variable has been found, insert immediately
1482 // A later indexed parameter has been found, insert immediately before it.
1483 if (CurNum > ArgNum)
1487 Vars.insert(I, Var);
1491 Vars.push_back(Var);
1494 // Gather and emit post-function debug information.
1495 void DwarfDebug::endFunction(const MachineFunction *MF) {
1496 // Every beginFunction(MF) call should be followed by an endFunction(MF) call,
1497 // though the beginFunction may not be called at all.
1498 // We should handle both cases.
1502 assert(CurFn == MF);
1503 assert(CurFn != nullptr);
1505 if (!MMI->hasDebugInfo() || LScopes.empty()) {
1506 // If we don't have a lexical scope for this function then there will
1507 // be a hole in the range information. Keep note of this by setting the
1508 // previously used section to nullptr.
1509 PrevSection = nullptr;
1515 // Define end label for subprogram.
1516 FunctionEndSym = Asm->GetTempSymbol("func_end", Asm->getFunctionNumber());
1517 // Assumes in correct section after the entry point.
1518 Asm->OutStreamer.EmitLabel(FunctionEndSym);
1520 // Set DwarfDwarfCompileUnitID in MCContext to default value.
1521 Asm->OutStreamer.getContext().setDwarfCompileUnitID(0);
1523 SmallPtrSet<const MDNode *, 16> ProcessedVars;
1524 collectVariableInfo(ProcessedVars);
1526 LexicalScope *FnScope = LScopes.getCurrentFunctionScope();
1527 DwarfCompileUnit &TheCU = *SPMap.lookup(FnScope->getScopeNode());
1529 // Construct abstract scopes.
1530 for (LexicalScope *AScope : LScopes.getAbstractScopesList()) {
1531 DISubprogram SP(AScope->getScopeNode());
1532 if (!SP.isSubprogram())
1534 // Collect info for variables that were optimized out.
1535 DIArray Variables = SP.getVariables();
1536 for (unsigned i = 0, e = Variables.getNumElements(); i != e; ++i) {
1537 DIVariable DV(Variables.getElement(i));
1538 assert(DV && DV.isVariable());
1539 if (!ProcessedVars.insert(DV))
1541 getOrCreateAbstractVariable(DV, DV.getContext());
1543 constructAbstractSubprogramScopeDIE(TheCU, AScope);
1546 DIE &CurFnDIE = constructSubprogramScopeDIE(TheCU, FnScope);
1547 if (!CurFn->getTarget().Options.DisableFramePointerElim(*CurFn))
1548 TheCU.addFlag(CurFnDIE, dwarf::DW_AT_APPLE_omit_frame_ptr);
1550 // Add the range of this function to the list of ranges for the CU.
1551 RangeSpan Span(FunctionBeginSym, FunctionEndSym);
1552 TheCU.addRange(std::move(Span));
1553 PrevSection = Asm->getCurrentSection();
1557 // Ownership of DbgVariables is a bit subtle - ScopeVariables owns all the
1558 // DbgVariables except those that are also in AbstractVariables (since they
1559 // can be used cross-function)
1560 for (const auto &I : ScopeVariables)
1561 for (const auto *Var : I.second)
1562 if (!AbstractVariables.count(Var->getVariable()) || Var->getAbstractVariable())
1564 ScopeVariables.clear();
1565 DeleteContainerPointers(CurrentFnArguments);
1567 LabelsBeforeInsn.clear();
1568 LabelsAfterInsn.clear();
1569 PrevLabel = nullptr;
1573 // Register a source line with debug info. Returns the unique label that was
1574 // emitted and which provides correspondence to the source line list.
1575 void DwarfDebug::recordSourceLine(unsigned Line, unsigned Col, const MDNode *S,
1580 unsigned Discriminator = 0;
1581 if (DIScope Scope = DIScope(S)) {
1582 assert(Scope.isScope());
1583 Fn = Scope.getFilename();
1584 Dir = Scope.getDirectory();
1585 if (Scope.isLexicalBlock())
1586 Discriminator = DILexicalBlock(S).getDiscriminator();
1588 unsigned CUID = Asm->OutStreamer.getContext().getDwarfCompileUnitID();
1589 Src = static_cast<DwarfCompileUnit &>(*InfoHolder.getUnits()[CUID])
1590 .getOrCreateSourceID(Fn, Dir);
1592 Asm->OutStreamer.EmitDwarfLocDirective(Src, Line, Col, Flags, 0,
1596 //===----------------------------------------------------------------------===//
1598 //===----------------------------------------------------------------------===//
1600 // Emit initial Dwarf sections with a label at the start of each one.
1601 void DwarfDebug::emitSectionLabels() {
1602 const TargetLoweringObjectFile &TLOF = Asm->getObjFileLowering();
1604 // Dwarf sections base addresses.
1605 DwarfInfoSectionSym =
1606 emitSectionSym(Asm, TLOF.getDwarfInfoSection(), "section_info");
1607 if (useSplitDwarf())
1608 DwarfInfoDWOSectionSym =
1609 emitSectionSym(Asm, TLOF.getDwarfInfoDWOSection(), "section_info_dwo");
1610 DwarfAbbrevSectionSym =
1611 emitSectionSym(Asm, TLOF.getDwarfAbbrevSection(), "section_abbrev");
1612 if (useSplitDwarf())
1613 DwarfAbbrevDWOSectionSym = emitSectionSym(
1614 Asm, TLOF.getDwarfAbbrevDWOSection(), "section_abbrev_dwo");
1615 if (GenerateARangeSection)
1616 emitSectionSym(Asm, TLOF.getDwarfARangesSection());
1618 DwarfLineSectionSym =
1619 emitSectionSym(Asm, TLOF.getDwarfLineSection(), "section_line");
1620 if (GenerateGnuPubSections) {
1621 DwarfGnuPubNamesSectionSym =
1622 emitSectionSym(Asm, TLOF.getDwarfGnuPubNamesSection());
1623 DwarfGnuPubTypesSectionSym =
1624 emitSectionSym(Asm, TLOF.getDwarfGnuPubTypesSection());
1625 } else if (HasDwarfPubSections) {
1626 emitSectionSym(Asm, TLOF.getDwarfPubNamesSection());
1627 emitSectionSym(Asm, TLOF.getDwarfPubTypesSection());
1630 DwarfStrSectionSym =
1631 emitSectionSym(Asm, TLOF.getDwarfStrSection(), "info_string");
1632 if (useSplitDwarf()) {
1633 DwarfStrDWOSectionSym =
1634 emitSectionSym(Asm, TLOF.getDwarfStrDWOSection(), "skel_string");
1635 DwarfAddrSectionSym =
1636 emitSectionSym(Asm, TLOF.getDwarfAddrSection(), "addr_sec");
1637 DwarfDebugLocSectionSym =
1638 emitSectionSym(Asm, TLOF.getDwarfLocDWOSection(), "skel_loc");
1640 DwarfDebugLocSectionSym =
1641 emitSectionSym(Asm, TLOF.getDwarfLocSection(), "section_debug_loc");
1642 DwarfDebugRangeSectionSym =
1643 emitSectionSym(Asm, TLOF.getDwarfRangesSection(), "debug_range");
1646 // Recursively emits a debug information entry.
1647 void DwarfDebug::emitDIE(DIE &Die) {
1648 // Get the abbreviation for this DIE.
1649 const DIEAbbrev &Abbrev = Die.getAbbrev();
1651 // Emit the code (index) for the abbreviation.
1652 if (Asm->isVerbose())
1653 Asm->OutStreamer.AddComment("Abbrev [" + Twine(Abbrev.getNumber()) +
1654 "] 0x" + Twine::utohexstr(Die.getOffset()) +
1655 ":0x" + Twine::utohexstr(Die.getSize()) + " " +
1656 dwarf::TagString(Abbrev.getTag()));
1657 Asm->EmitULEB128(Abbrev.getNumber());
1659 const SmallVectorImpl<DIEValue *> &Values = Die.getValues();
1660 const SmallVectorImpl<DIEAbbrevData> &AbbrevData = Abbrev.getData();
1662 // Emit the DIE attribute values.
1663 for (unsigned i = 0, N = Values.size(); i < N; ++i) {
1664 dwarf::Attribute Attr = AbbrevData[i].getAttribute();
1665 dwarf::Form Form = AbbrevData[i].getForm();
1666 assert(Form && "Too many attributes for DIE (check abbreviation)");
1668 if (Asm->isVerbose()) {
1669 Asm->OutStreamer.AddComment(dwarf::AttributeString(Attr));
1670 if (Attr == dwarf::DW_AT_accessibility)
1671 Asm->OutStreamer.AddComment(dwarf::AccessibilityString(
1672 cast<DIEInteger>(Values[i])->getValue()));
1675 // Emit an attribute using the defined form.
1676 Values[i]->EmitValue(Asm, Form);
1679 // Emit the DIE children if any.
1680 if (Abbrev.hasChildren()) {
1681 for (auto &Child : Die.getChildren())
1684 Asm->OutStreamer.AddComment("End Of Children Mark");
1689 // Emit the debug info section.
1690 void DwarfDebug::emitDebugInfo() {
1691 DwarfFile &Holder = useSplitDwarf() ? SkeletonHolder : InfoHolder;
1693 Holder.emitUnits(this, DwarfAbbrevSectionSym);
1696 // Emit the abbreviation section.
1697 void DwarfDebug::emitAbbreviations() {
1698 DwarfFile &Holder = useSplitDwarf() ? SkeletonHolder : InfoHolder;
1700 Holder.emitAbbrevs(Asm->getObjFileLowering().getDwarfAbbrevSection());
1703 // Emit the last address of the section and the end of the line matrix.
1704 void DwarfDebug::emitEndOfLineMatrix(unsigned SectionEnd) {
1705 // Define last address of section.
1706 Asm->OutStreamer.AddComment("Extended Op");
1709 Asm->OutStreamer.AddComment("Op size");
1710 Asm->EmitInt8(Asm->getDataLayout().getPointerSize() + 1);
1711 Asm->OutStreamer.AddComment("DW_LNE_set_address");
1712 Asm->EmitInt8(dwarf::DW_LNE_set_address);
1714 Asm->OutStreamer.AddComment("Section end label");
1716 Asm->OutStreamer.EmitSymbolValue(
1717 Asm->GetTempSymbol("section_end", SectionEnd),
1718 Asm->getDataLayout().getPointerSize());
1720 // Mark end of matrix.
1721 Asm->OutStreamer.AddComment("DW_LNE_end_sequence");
1727 // Emit visible names into a hashed accelerator table section.
1728 void DwarfDebug::emitAccelNames() {
1729 AccelNames.FinalizeTable(Asm, "Names");
1730 Asm->OutStreamer.SwitchSection(
1731 Asm->getObjFileLowering().getDwarfAccelNamesSection());
1732 MCSymbol *SectionBegin = Asm->GetTempSymbol("names_begin");
1733 Asm->OutStreamer.EmitLabel(SectionBegin);
1735 // Emit the full data.
1736 AccelNames.Emit(Asm, SectionBegin, &InfoHolder);
1739 // Emit objective C classes and categories into a hashed accelerator table
1741 void DwarfDebug::emitAccelObjC() {
1742 AccelObjC.FinalizeTable(Asm, "ObjC");
1743 Asm->OutStreamer.SwitchSection(
1744 Asm->getObjFileLowering().getDwarfAccelObjCSection());
1745 MCSymbol *SectionBegin = Asm->GetTempSymbol("objc_begin");
1746 Asm->OutStreamer.EmitLabel(SectionBegin);
1748 // Emit the full data.
1749 AccelObjC.Emit(Asm, SectionBegin, &InfoHolder);
1752 // Emit namespace dies into a hashed accelerator table.
1753 void DwarfDebug::emitAccelNamespaces() {
1754 AccelNamespace.FinalizeTable(Asm, "namespac");
1755 Asm->OutStreamer.SwitchSection(
1756 Asm->getObjFileLowering().getDwarfAccelNamespaceSection());
1757 MCSymbol *SectionBegin = Asm->GetTempSymbol("namespac_begin");
1758 Asm->OutStreamer.EmitLabel(SectionBegin);
1760 // Emit the full data.
1761 AccelNamespace.Emit(Asm, SectionBegin, &InfoHolder);
1764 // Emit type dies into a hashed accelerator table.
1765 void DwarfDebug::emitAccelTypes() {
1767 AccelTypes.FinalizeTable(Asm, "types");
1768 Asm->OutStreamer.SwitchSection(
1769 Asm->getObjFileLowering().getDwarfAccelTypesSection());
1770 MCSymbol *SectionBegin = Asm->GetTempSymbol("types_begin");
1771 Asm->OutStreamer.EmitLabel(SectionBegin);
1773 // Emit the full data.
1774 AccelTypes.Emit(Asm, SectionBegin, &InfoHolder);
1777 // Public name handling.
1778 // The format for the various pubnames:
1780 // dwarf pubnames - offset/name pairs where the offset is the offset into the CU
1781 // for the DIE that is named.
1783 // gnu pubnames - offset/index value/name tuples where the offset is the offset
1784 // into the CU and the index value is computed according to the type of value
1785 // for the DIE that is named.
1787 // For type units the offset is the offset of the skeleton DIE. For split dwarf
1788 // it's the offset within the debug_info/debug_types dwo section, however, the
1789 // reference in the pubname header doesn't change.
1791 /// computeIndexValue - Compute the gdb index value for the DIE and CU.
1792 static dwarf::PubIndexEntryDescriptor computeIndexValue(DwarfUnit *CU,
1794 dwarf::GDBIndexEntryLinkage Linkage = dwarf::GIEL_STATIC;
1796 // We could have a specification DIE that has our most of our knowledge,
1797 // look for that now.
1798 DIEValue *SpecVal = Die->findAttribute(dwarf::DW_AT_specification);
1800 DIE &SpecDIE = cast<DIEEntry>(SpecVal)->getEntry();
1801 if (SpecDIE.findAttribute(dwarf::DW_AT_external))
1802 Linkage = dwarf::GIEL_EXTERNAL;
1803 } else if (Die->findAttribute(dwarf::DW_AT_external))
1804 Linkage = dwarf::GIEL_EXTERNAL;
1806 switch (Die->getTag()) {
1807 case dwarf::DW_TAG_class_type:
1808 case dwarf::DW_TAG_structure_type:
1809 case dwarf::DW_TAG_union_type:
1810 case dwarf::DW_TAG_enumeration_type:
1811 return dwarf::PubIndexEntryDescriptor(
1812 dwarf::GIEK_TYPE, CU->getLanguage() != dwarf::DW_LANG_C_plus_plus
1813 ? dwarf::GIEL_STATIC
1814 : dwarf::GIEL_EXTERNAL);
1815 case dwarf::DW_TAG_typedef:
1816 case dwarf::DW_TAG_base_type:
1817 case dwarf::DW_TAG_subrange_type:
1818 return dwarf::PubIndexEntryDescriptor(dwarf::GIEK_TYPE, dwarf::GIEL_STATIC);
1819 case dwarf::DW_TAG_namespace:
1820 return dwarf::GIEK_TYPE;
1821 case dwarf::DW_TAG_subprogram:
1822 return dwarf::PubIndexEntryDescriptor(dwarf::GIEK_FUNCTION, Linkage);
1823 case dwarf::DW_TAG_constant:
1824 case dwarf::DW_TAG_variable:
1825 return dwarf::PubIndexEntryDescriptor(dwarf::GIEK_VARIABLE, Linkage);
1826 case dwarf::DW_TAG_enumerator:
1827 return dwarf::PubIndexEntryDescriptor(dwarf::GIEK_VARIABLE,
1828 dwarf::GIEL_STATIC);
1830 return dwarf::GIEK_NONE;
1834 /// emitDebugPubNames - Emit visible names into a debug pubnames section.
1836 void DwarfDebug::emitDebugPubNames(bool GnuStyle) {
1837 const MCSection *PSec =
1838 GnuStyle ? Asm->getObjFileLowering().getDwarfGnuPubNamesSection()
1839 : Asm->getObjFileLowering().getDwarfPubNamesSection();
1841 emitDebugPubSection(GnuStyle, PSec, "Names", &DwarfUnit::getGlobalNames);
1844 void DwarfDebug::emitDebugPubSection(
1845 bool GnuStyle, const MCSection *PSec, StringRef Name,
1846 const StringMap<const DIE *> &(DwarfUnit::*Accessor)() const) {
1847 for (const auto &NU : CUMap) {
1848 DwarfCompileUnit *TheU = NU.second;
1850 const auto &Globals = (TheU->*Accessor)();
1852 if (Globals.empty())
1855 if (auto Skeleton = static_cast<DwarfCompileUnit *>(TheU->getSkeleton()))
1857 unsigned ID = TheU->getUniqueID();
1859 // Start the dwarf pubnames section.
1860 Asm->OutStreamer.SwitchSection(PSec);
1863 Asm->OutStreamer.AddComment("Length of Public " + Name + " Info");
1864 MCSymbol *BeginLabel = Asm->GetTempSymbol("pub" + Name + "_begin", ID);
1865 MCSymbol *EndLabel = Asm->GetTempSymbol("pub" + Name + "_end", ID);
1866 Asm->EmitLabelDifference(EndLabel, BeginLabel, 4);
1868 Asm->OutStreamer.EmitLabel(BeginLabel);
1870 Asm->OutStreamer.AddComment("DWARF Version");
1871 Asm->EmitInt16(dwarf::DW_PUBNAMES_VERSION);
1873 Asm->OutStreamer.AddComment("Offset of Compilation Unit Info");
1874 Asm->EmitSectionOffset(TheU->getLabelBegin(), TheU->getSectionSym());
1876 Asm->OutStreamer.AddComment("Compilation Unit Length");
1877 Asm->EmitLabelDifference(TheU->getLabelEnd(), TheU->getLabelBegin(), 4);
1879 // Emit the pubnames for this compilation unit.
1880 for (const auto &GI : Globals) {
1881 const char *Name = GI.getKeyData();
1882 const DIE *Entity = GI.second;
1884 Asm->OutStreamer.AddComment("DIE offset");
1885 Asm->EmitInt32(Entity->getOffset());
1888 dwarf::PubIndexEntryDescriptor Desc = computeIndexValue(TheU, Entity);
1889 Asm->OutStreamer.AddComment(
1890 Twine("Kind: ") + dwarf::GDBIndexEntryKindString(Desc.Kind) + ", " +
1891 dwarf::GDBIndexEntryLinkageString(Desc.Linkage));
1892 Asm->EmitInt8(Desc.toBits());
1895 Asm->OutStreamer.AddComment("External Name");
1896 Asm->OutStreamer.EmitBytes(StringRef(Name, GI.getKeyLength() + 1));
1899 Asm->OutStreamer.AddComment("End Mark");
1901 Asm->OutStreamer.EmitLabel(EndLabel);
1905 void DwarfDebug::emitDebugPubTypes(bool GnuStyle) {
1906 const MCSection *PSec =
1907 GnuStyle ? Asm->getObjFileLowering().getDwarfGnuPubTypesSection()
1908 : Asm->getObjFileLowering().getDwarfPubTypesSection();
1910 emitDebugPubSection(GnuStyle, PSec, "Types", &DwarfUnit::getGlobalTypes);
1913 // Emit visible names into a debug str section.
1914 void DwarfDebug::emitDebugStr() {
1915 DwarfFile &Holder = useSplitDwarf() ? SkeletonHolder : InfoHolder;
1916 Holder.emitStrings(Asm->getObjFileLowering().getDwarfStrSection());
1919 void DwarfDebug::emitDebugLocEntry(ByteStreamer &Streamer,
1920 const DebugLocEntry &Entry) {
1921 assert(Entry.getValues().size() == 1 &&
1922 "multi-value entries are not supported yet.");
1923 const DebugLocEntry::Value Value = Entry.getValues()[0];
1924 DIVariable DV(Value.getVariable());
1925 if (Value.isInt()) {
1926 DIBasicType BTy(resolve(DV.getType()));
1927 if (BTy.Verify() && (BTy.getEncoding() == dwarf::DW_ATE_signed ||
1928 BTy.getEncoding() == dwarf::DW_ATE_signed_char)) {
1929 Streamer.EmitInt8(dwarf::DW_OP_consts, "DW_OP_consts");
1930 Streamer.EmitSLEB128(Value.getInt());
1932 Streamer.EmitInt8(dwarf::DW_OP_constu, "DW_OP_constu");
1933 Streamer.EmitULEB128(Value.getInt());
1935 } else if (Value.isLocation()) {
1936 MachineLocation Loc = Value.getLoc();
1937 if (!DV.hasComplexAddress())
1939 Asm->EmitDwarfRegOp(Streamer, Loc, DV.isIndirect());
1941 // Complex address entry.
1942 unsigned N = DV.getNumAddrElements();
1944 if (N >= 2 && DV.getAddrElement(0) == DIBuilder::OpPlus) {
1945 if (Loc.getOffset()) {
1947 Asm->EmitDwarfRegOp(Streamer, Loc, DV.isIndirect());
1948 Streamer.EmitInt8(dwarf::DW_OP_deref, "DW_OP_deref");
1949 Streamer.EmitInt8(dwarf::DW_OP_plus_uconst, "DW_OP_plus_uconst");
1950 Streamer.EmitSLEB128(DV.getAddrElement(1));
1952 // If first address element is OpPlus then emit
1953 // DW_OP_breg + Offset instead of DW_OP_reg + Offset.
1954 MachineLocation TLoc(Loc.getReg(), DV.getAddrElement(1));
1955 Asm->EmitDwarfRegOp(Streamer, TLoc, DV.isIndirect());
1959 Asm->EmitDwarfRegOp(Streamer, Loc, DV.isIndirect());
1962 // Emit remaining complex address elements.
1963 for (; i < N; ++i) {
1964 uint64_t Element = DV.getAddrElement(i);
1965 if (Element == DIBuilder::OpPlus) {
1966 Streamer.EmitInt8(dwarf::DW_OP_plus_uconst, "DW_OP_plus_uconst");
1967 Streamer.EmitULEB128(DV.getAddrElement(++i));
1968 } else if (Element == DIBuilder::OpDeref) {
1970 Streamer.EmitInt8(dwarf::DW_OP_deref, "DW_OP_deref");
1972 llvm_unreachable("unknown Opcode found in complex address");
1976 // else ... ignore constant fp. There is not any good way to
1977 // to represent them here in dwarf.
1981 void DwarfDebug::emitDebugLocEntryLocation(const DebugLocEntry &Entry) {
1982 Asm->OutStreamer.AddComment("Loc expr size");
1983 MCSymbol *begin = Asm->OutStreamer.getContext().CreateTempSymbol();
1984 MCSymbol *end = Asm->OutStreamer.getContext().CreateTempSymbol();
1985 Asm->EmitLabelDifference(end, begin, 2);
1986 Asm->OutStreamer.EmitLabel(begin);
1988 APByteStreamer Streamer(*Asm);
1989 emitDebugLocEntry(Streamer, Entry);
1991 Asm->OutStreamer.EmitLabel(end);
1994 // Emit locations into the debug loc section.
1995 void DwarfDebug::emitDebugLoc() {
1996 // Start the dwarf loc section.
1997 Asm->OutStreamer.SwitchSection(
1998 Asm->getObjFileLowering().getDwarfLocSection());
1999 unsigned char Size = Asm->getDataLayout().getPointerSize();
2000 for (const auto &DebugLoc : DotDebugLocEntries) {
2001 Asm->OutStreamer.EmitLabel(DebugLoc.Label);
2002 for (const auto &Entry : DebugLoc.List) {
2003 // Set up the range. This range is relative to the entry point of the
2004 // compile unit. This is a hard coded 0 for low_pc when we're emitting
2005 // ranges, or the DW_AT_low_pc on the compile unit otherwise.
2006 const DwarfCompileUnit *CU = Entry.getCU();
2007 if (CU->getRanges().size() == 1) {
2008 // Grab the begin symbol from the first range as our base.
2009 const MCSymbol *Base = CU->getRanges()[0].getStart();
2010 Asm->EmitLabelDifference(Entry.getBeginSym(), Base, Size);
2011 Asm->EmitLabelDifference(Entry.getEndSym(), Base, Size);
2013 Asm->OutStreamer.EmitSymbolValue(Entry.getBeginSym(), Size);
2014 Asm->OutStreamer.EmitSymbolValue(Entry.getEndSym(), Size);
2017 emitDebugLocEntryLocation(Entry);
2019 Asm->OutStreamer.EmitIntValue(0, Size);
2020 Asm->OutStreamer.EmitIntValue(0, Size);
2024 void DwarfDebug::emitDebugLocDWO() {
2025 Asm->OutStreamer.SwitchSection(
2026 Asm->getObjFileLowering().getDwarfLocDWOSection());
2027 for (const auto &DebugLoc : DotDebugLocEntries) {
2028 Asm->OutStreamer.EmitLabel(DebugLoc.Label);
2029 for (const auto &Entry : DebugLoc.List) {
2030 // Just always use start_length for now - at least that's one address
2031 // rather than two. We could get fancier and try to, say, reuse an
2032 // address we know we've emitted elsewhere (the start of the function?
2033 // The start of the CU or CU subrange that encloses this range?)
2034 Asm->EmitInt8(dwarf::DW_LLE_start_length_entry);
2035 unsigned idx = AddrPool.getIndex(Entry.getBeginSym());
2036 Asm->EmitULEB128(idx);
2037 Asm->EmitLabelDifference(Entry.getEndSym(), Entry.getBeginSym(), 4);
2039 emitDebugLocEntryLocation(Entry);
2041 Asm->EmitInt8(dwarf::DW_LLE_end_of_list_entry);
2046 const MCSymbol *Start, *End;
2049 // Emit a debug aranges section, containing a CU lookup for any
2050 // address we can tie back to a CU.
2051 void DwarfDebug::emitDebugARanges() {
2052 // Start the dwarf aranges section.
2053 Asm->OutStreamer.SwitchSection(
2054 Asm->getObjFileLowering().getDwarfARangesSection());
2056 typedef DenseMap<DwarfCompileUnit *, std::vector<ArangeSpan>> SpansType;
2060 // Build a list of sections used.
2061 std::vector<const MCSection *> Sections;
2062 for (const auto &it : SectionMap) {
2063 const MCSection *Section = it.first;
2064 Sections.push_back(Section);
2067 // Sort the sections into order.
2068 // This is only done to ensure consistent output order across different runs.
2069 std::sort(Sections.begin(), Sections.end(), SectionSort);
2071 // Build a set of address spans, sorted by CU.
2072 for (const MCSection *Section : Sections) {
2073 SmallVector<SymbolCU, 8> &List = SectionMap[Section];
2074 if (List.size() < 2)
2077 // Sort the symbols by offset within the section.
2078 std::sort(List.begin(), List.end(),
2079 [&](const SymbolCU &A, const SymbolCU &B) {
2080 unsigned IA = A.Sym ? Asm->OutStreamer.GetSymbolOrder(A.Sym) : 0;
2081 unsigned IB = B.Sym ? Asm->OutStreamer.GetSymbolOrder(B.Sym) : 0;
2083 // Symbols with no order assigned should be placed at the end.
2084 // (e.g. section end labels)
2092 // If we have no section (e.g. common), just write out
2093 // individual spans for each symbol.
2095 for (const SymbolCU &Cur : List) {
2097 Span.Start = Cur.Sym;
2100 Spans[Cur.CU].push_back(Span);
2103 // Build spans between each label.
2104 const MCSymbol *StartSym = List[0].Sym;
2105 for (size_t n = 1, e = List.size(); n < e; n++) {
2106 const SymbolCU &Prev = List[n - 1];
2107 const SymbolCU &Cur = List[n];
2109 // Try and build the longest span we can within the same CU.
2110 if (Cur.CU != Prev.CU) {
2112 Span.Start = StartSym;
2114 Spans[Prev.CU].push_back(Span);
2121 unsigned PtrSize = Asm->getDataLayout().getPointerSize();
2123 // Build a list of CUs used.
2124 std::vector<DwarfCompileUnit *> CUs;
2125 for (const auto &it : Spans) {
2126 DwarfCompileUnit *CU = it.first;
2130 // Sort the CU list (again, to ensure consistent output order).
2131 std::sort(CUs.begin(), CUs.end(), [](const DwarfUnit *A, const DwarfUnit *B) {
2132 return A->getUniqueID() < B->getUniqueID();
2135 // Emit an arange table for each CU we used.
2136 for (DwarfCompileUnit *CU : CUs) {
2137 std::vector<ArangeSpan> &List = Spans[CU];
2139 // Emit size of content not including length itself.
2140 unsigned ContentSize =
2141 sizeof(int16_t) + // DWARF ARange version number
2142 sizeof(int32_t) + // Offset of CU in the .debug_info section
2143 sizeof(int8_t) + // Pointer Size (in bytes)
2144 sizeof(int8_t); // Segment Size (in bytes)
2146 unsigned TupleSize = PtrSize * 2;
2148 // 7.20 in the Dwarf specs requires the table to be aligned to a tuple.
2150 OffsetToAlignment(sizeof(int32_t) + ContentSize, TupleSize);
2152 ContentSize += Padding;
2153 ContentSize += (List.size() + 1) * TupleSize;
2155 // For each compile unit, write the list of spans it covers.
2156 Asm->OutStreamer.AddComment("Length of ARange Set");
2157 Asm->EmitInt32(ContentSize);
2158 Asm->OutStreamer.AddComment("DWARF Arange version number");
2159 Asm->EmitInt16(dwarf::DW_ARANGES_VERSION);
2160 Asm->OutStreamer.AddComment("Offset Into Debug Info Section");
2161 Asm->EmitSectionOffset(CU->getLocalLabelBegin(), CU->getLocalSectionSym());
2162 Asm->OutStreamer.AddComment("Address Size (in bytes)");
2163 Asm->EmitInt8(PtrSize);
2164 Asm->OutStreamer.AddComment("Segment Size (in bytes)");
2167 Asm->OutStreamer.EmitFill(Padding, 0xff);
2169 for (const ArangeSpan &Span : List) {
2170 Asm->EmitLabelReference(Span.Start, PtrSize);
2172 // Calculate the size as being from the span start to it's end.
2174 Asm->EmitLabelDifference(Span.End, Span.Start, PtrSize);
2176 // For symbols without an end marker (e.g. common), we
2177 // write a single arange entry containing just that one symbol.
2178 uint64_t Size = SymSize[Span.Start];
2182 Asm->OutStreamer.EmitIntValue(Size, PtrSize);
2186 Asm->OutStreamer.AddComment("ARange terminator");
2187 Asm->OutStreamer.EmitIntValue(0, PtrSize);
2188 Asm->OutStreamer.EmitIntValue(0, PtrSize);
2192 // Emit visible names into a debug ranges section.
2193 void DwarfDebug::emitDebugRanges() {
2194 // Start the dwarf ranges section.
2195 Asm->OutStreamer.SwitchSection(
2196 Asm->getObjFileLowering().getDwarfRangesSection());
2198 // Size for our labels.
2199 unsigned char Size = Asm->getDataLayout().getPointerSize();
2201 // Grab the specific ranges for the compile units in the module.
2202 for (const auto &I : CUMap) {
2203 DwarfCompileUnit *TheCU = I.second;
2205 // Iterate over the misc ranges for the compile units in the module.
2206 for (const RangeSpanList &List : TheCU->getRangeLists()) {
2207 // Emit our symbol so we can find the beginning of the range.
2208 Asm->OutStreamer.EmitLabel(List.getSym());
2210 for (const RangeSpan &Range : List.getRanges()) {
2211 const MCSymbol *Begin = Range.getStart();
2212 const MCSymbol *End = Range.getEnd();
2213 assert(Begin && "Range without a begin symbol?");
2214 assert(End && "Range without an end symbol?");
2215 if (TheCU->getRanges().size() == 1) {
2216 // Grab the begin symbol from the first range as our base.
2217 const MCSymbol *Base = TheCU->getRanges()[0].getStart();
2218 Asm->EmitLabelDifference(Begin, Base, Size);
2219 Asm->EmitLabelDifference(End, Base, Size);
2221 Asm->OutStreamer.EmitSymbolValue(Begin, Size);
2222 Asm->OutStreamer.EmitSymbolValue(End, Size);
2226 // And terminate the list with two 0 values.
2227 Asm->OutStreamer.EmitIntValue(0, Size);
2228 Asm->OutStreamer.EmitIntValue(0, Size);
2231 // Now emit a range for the CU itself.
2232 if (TheCU->getRanges().size() > 1) {
2233 Asm->OutStreamer.EmitLabel(
2234 Asm->GetTempSymbol("cu_ranges", TheCU->getUniqueID()));
2235 for (const RangeSpan &Range : TheCU->getRanges()) {
2236 const MCSymbol *Begin = Range.getStart();
2237 const MCSymbol *End = Range.getEnd();
2238 assert(Begin && "Range without a begin symbol?");
2239 assert(End && "Range without an end symbol?");
2240 Asm->OutStreamer.EmitSymbolValue(Begin, Size);
2241 Asm->OutStreamer.EmitSymbolValue(End, Size);
2243 // And terminate the list with two 0 values.
2244 Asm->OutStreamer.EmitIntValue(0, Size);
2245 Asm->OutStreamer.EmitIntValue(0, Size);
2250 // DWARF5 Experimental Separate Dwarf emitters.
2252 void DwarfDebug::initSkeletonUnit(const DwarfUnit &U, DIE &Die,
2253 std::unique_ptr<DwarfUnit> NewU) {
2254 NewU->addLocalString(Die, dwarf::DW_AT_GNU_dwo_name,
2255 U.getCUNode().getSplitDebugFilename());
2257 if (!CompilationDir.empty())
2258 NewU->addLocalString(Die, dwarf::DW_AT_comp_dir, CompilationDir);
2260 addGnuPubAttributes(*NewU, Die);
2262 SkeletonHolder.addUnit(std::move(NewU));
2265 // This DIE has the following attributes: DW_AT_comp_dir, DW_AT_stmt_list,
2266 // DW_AT_low_pc, DW_AT_high_pc, DW_AT_ranges, DW_AT_dwo_name, DW_AT_dwo_id,
2267 // DW_AT_addr_base, DW_AT_ranges_base.
2268 DwarfCompileUnit &DwarfDebug::constructSkeletonCU(const DwarfCompileUnit &CU) {
2270 auto OwnedUnit = make_unique<DwarfCompileUnit>(
2271 CU.getUniqueID(), CU.getCUNode(), Asm, this, &SkeletonHolder);
2272 DwarfCompileUnit &NewCU = *OwnedUnit;
2273 NewCU.initSection(Asm->getObjFileLowering().getDwarfInfoSection(),
2274 DwarfInfoSectionSym);
2276 NewCU.initStmtList(DwarfLineSectionSym);
2278 initSkeletonUnit(CU, NewCU.getUnitDie(), std::move(OwnedUnit));
2283 // This DIE has the following attributes: DW_AT_comp_dir, DW_AT_dwo_name,
2285 DwarfTypeUnit &DwarfDebug::constructSkeletonTU(DwarfTypeUnit &TU) {
2286 DwarfCompileUnit &CU = static_cast<DwarfCompileUnit &>(
2287 *SkeletonHolder.getUnits()[TU.getCU().getUniqueID()]);
2289 auto OwnedUnit = make_unique<DwarfTypeUnit>(TU.getUniqueID(), CU, Asm, this,
2291 DwarfTypeUnit &NewTU = *OwnedUnit;
2292 NewTU.setTypeSignature(TU.getTypeSignature());
2293 NewTU.setType(nullptr);
2295 Asm->getObjFileLowering().getDwarfTypesSection(TU.getTypeSignature()));
2297 initSkeletonUnit(TU, NewTU.getUnitDie(), std::move(OwnedUnit));
2301 // Emit the .debug_info.dwo section for separated dwarf. This contains the
2302 // compile units that would normally be in debug_info.
2303 void DwarfDebug::emitDebugInfoDWO() {
2304 assert(useSplitDwarf() && "No split dwarf debug info?");
2305 // Don't pass an abbrev symbol, using a constant zero instead so as not to
2306 // emit relocations into the dwo file.
2307 InfoHolder.emitUnits(this, /* AbbrevSymbol */ nullptr);
2310 // Emit the .debug_abbrev.dwo section for separated dwarf. This contains the
2311 // abbreviations for the .debug_info.dwo section.
2312 void DwarfDebug::emitDebugAbbrevDWO() {
2313 assert(useSplitDwarf() && "No split dwarf?");
2314 InfoHolder.emitAbbrevs(Asm->getObjFileLowering().getDwarfAbbrevDWOSection());
2317 void DwarfDebug::emitDebugLineDWO() {
2318 assert(useSplitDwarf() && "No split dwarf?");
2319 Asm->OutStreamer.SwitchSection(
2320 Asm->getObjFileLowering().getDwarfLineDWOSection());
2321 SplitTypeUnitFileTable.Emit(Asm->OutStreamer);
2324 // Emit the .debug_str.dwo section for separated dwarf. This contains the
2325 // string section and is identical in format to traditional .debug_str
2327 void DwarfDebug::emitDebugStrDWO() {
2328 assert(useSplitDwarf() && "No split dwarf?");
2329 const MCSection *OffSec =
2330 Asm->getObjFileLowering().getDwarfStrOffDWOSection();
2331 const MCSymbol *StrSym = DwarfStrSectionSym;
2332 InfoHolder.emitStrings(Asm->getObjFileLowering().getDwarfStrDWOSection(),
2336 MCDwarfDwoLineTable *DwarfDebug::getDwoLineTable(const DwarfCompileUnit &CU) {
2337 if (!useSplitDwarf())
2340 SplitTypeUnitFileTable.setCompilationDir(CU.getCUNode().getDirectory());
2341 return &SplitTypeUnitFileTable;
2344 static uint64_t makeTypeSignature(StringRef Identifier) {
2346 Hash.update(Identifier);
2347 // ... take the least significant 8 bytes and return those. Our MD5
2348 // implementation always returns its results in little endian, swap bytes
2350 MD5::MD5Result Result;
2352 return *reinterpret_cast<support::ulittle64_t *>(Result + 8);
2355 void DwarfDebug::addDwarfTypeUnitType(DwarfCompileUnit &CU,
2356 StringRef Identifier, DIE &RefDie,
2357 DICompositeType CTy) {
2358 // Fast path if we're building some type units and one has already used the
2359 // address pool we know we're going to throw away all this work anyway, so
2360 // don't bother building dependent types.
2361 if (!TypeUnitsUnderConstruction.empty() && AddrPool.hasBeenUsed())
2364 const DwarfTypeUnit *&TU = DwarfTypeUnits[CTy];
2366 CU.addDIETypeSignature(RefDie, *TU);
2370 bool TopLevelType = TypeUnitsUnderConstruction.empty();
2371 AddrPool.resetUsedFlag();
2374 make_unique<DwarfTypeUnit>(InfoHolder.getUnits().size(), CU, Asm, this,
2375 &InfoHolder, getDwoLineTable(CU));
2376 DwarfTypeUnit &NewTU = *OwnedUnit;
2377 DIE &UnitDie = NewTU.getUnitDie();
2379 TypeUnitsUnderConstruction.push_back(
2380 std::make_pair(std::move(OwnedUnit), CTy));
2382 NewTU.addUInt(UnitDie, dwarf::DW_AT_language, dwarf::DW_FORM_data2,
2385 uint64_t Signature = makeTypeSignature(Identifier);
2386 NewTU.setTypeSignature(Signature);
2388 if (!useSplitDwarf())
2389 CU.applyStmtList(UnitDie);
2391 // FIXME: Skip using COMDAT groups for type units in the .dwo file once tools
2392 // such as DWP ( http://gcc.gnu.org/wiki/DebugFissionDWP ) can cope with it.
2395 ? Asm->getObjFileLowering().getDwarfTypesDWOSection(Signature)
2396 : Asm->getObjFileLowering().getDwarfTypesSection(Signature));
2398 NewTU.setType(NewTU.createTypeDIE(CTy));
2401 auto TypeUnitsToAdd = std::move(TypeUnitsUnderConstruction);
2402 TypeUnitsUnderConstruction.clear();
2404 // Types referencing entries in the address table cannot be placed in type
2406 if (AddrPool.hasBeenUsed()) {
2408 // Remove all the types built while building this type.
2409 // This is pessimistic as some of these types might not be dependent on
2410 // the type that used an address.
2411 for (const auto &TU : TypeUnitsToAdd)
2412 DwarfTypeUnits.erase(TU.second);
2414 // Construct this type in the CU directly.
2415 // This is inefficient because all the dependent types will be rebuilt
2416 // from scratch, including building them in type units, discovering that
2417 // they depend on addresses, throwing them out and rebuilding them.
2418 CU.constructTypeDIE(RefDie, CTy);
2422 // If the type wasn't dependent on fission addresses, finish adding the type
2423 // and all its dependent types.
2424 for (auto &TU : TypeUnitsToAdd) {
2425 if (useSplitDwarf())
2426 TU.first->setSkeleton(constructSkeletonTU(*TU.first));
2427 InfoHolder.addUnit(std::move(TU.first));
2430 CU.addDIETypeSignature(RefDie, NewTU);
2433 void DwarfDebug::attachLowHighPC(DwarfCompileUnit &Unit, DIE &D,
2434 MCSymbol *Begin, MCSymbol *End) {
2435 assert(Begin && "Begin label should not be null!");
2436 assert(End && "End label should not be null!");
2437 assert(Begin->isDefined() && "Invalid starting label");
2438 assert(End->isDefined() && "Invalid end label");
2440 Unit.addLabelAddress(D, dwarf::DW_AT_low_pc, Begin);
2441 if (DwarfVersion < 4)
2442 Unit.addLabelAddress(D, dwarf::DW_AT_high_pc, End);
2444 Unit.addLabelDelta(D, dwarf::DW_AT_high_pc, End, Begin);
2447 // Accelerator table mutators - add each name along with its companion
2448 // DIE to the proper table while ensuring that the name that we're going
2449 // to reference is in the string table. We do this since the names we
2450 // add may not only be identical to the names in the DIE.
2451 void DwarfDebug::addAccelName(StringRef Name, const DIE &Die) {
2452 if (!useDwarfAccelTables())
2454 AccelNames.AddName(Name, InfoHolder.getStringPool().getSymbol(*Asm, Name),
2458 void DwarfDebug::addAccelObjC(StringRef Name, const DIE &Die) {
2459 if (!useDwarfAccelTables())
2461 AccelObjC.AddName(Name, InfoHolder.getStringPool().getSymbol(*Asm, Name),
2465 void DwarfDebug::addAccelNamespace(StringRef Name, const DIE &Die) {
2466 if (!useDwarfAccelTables())
2468 AccelNamespace.AddName(Name, InfoHolder.getStringPool().getSymbol(*Asm, Name),
2472 void DwarfDebug::addAccelType(StringRef Name, const DIE &Die, char Flags) {
2473 if (!useDwarfAccelTables())
2475 AccelTypes.AddName(Name, InfoHolder.getStringPool().getSymbol(*Asm, Name),