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::getExistingAbstractVariable(DIVariable &DV,
1051 DIVariable &Cleansed) {
1052 LLVMContext &Ctx = DV->getContext();
1053 // More then one inlined variable corresponds to one abstract variable.
1054 // FIXME: This duplication of variables when inlining should probably be
1055 // removed. It's done to allow each DIVariable to describe its location
1056 // because the DebugLoc on the dbg.value/declare isn't accurate. We should
1057 // make it accurate then remove this duplication/cleansing stuff.
1058 Cleansed = cleanseInlinedVariable(DV, Ctx);
1059 auto I = AbstractVariables.find(Cleansed);
1060 if (I != AbstractVariables.end())
1061 return I->second.get();
1065 DbgVariable *DwarfDebug::createAbstractVariable(DIVariable &Var,
1066 LexicalScope *Scope) {
1067 auto AbsDbgVariable = make_unique<DbgVariable>(Var, nullptr, this);
1068 addScopeVariable(Scope, AbsDbgVariable.get());
1069 return (AbstractVariables[Var] = std::move(AbsDbgVariable)).get();
1072 DbgVariable *DwarfDebug::getOrCreateAbstractVariable(DIVariable &DV,
1073 const MDNode *ScopeNode) {
1074 DIVariable Cleansed = DV;
1075 if (DbgVariable *Var = getExistingAbstractVariable(DV, Cleansed))
1078 return createAbstractVariable(Cleansed,
1079 LScopes.getOrCreateAbstractScope(ScopeNode));
1082 DbgVariable *DwarfDebug::findAbstractVariable(DIVariable &DV,
1083 const MDNode *ScopeNode) {
1084 DIVariable Cleansed = DV;
1085 if (DbgVariable *Var = getExistingAbstractVariable(DV, Cleansed))
1088 if (LexicalScope *Scope = LScopes.findAbstractScope(ScopeNode))
1089 return createAbstractVariable(Cleansed, Scope);
1093 // If Var is a current function argument then add it to CurrentFnArguments list.
1094 bool DwarfDebug::addCurrentFnArgument(DbgVariable *Var, LexicalScope *Scope) {
1095 if (!LScopes.isCurrentFunctionScope(Scope))
1097 DIVariable DV = Var->getVariable();
1098 if (DV.getTag() != dwarf::DW_TAG_arg_variable)
1100 unsigned ArgNo = DV.getArgNumber();
1104 size_t Size = CurrentFnArguments.size();
1106 CurrentFnArguments.resize(CurFn->getFunction()->arg_size());
1107 // llvm::Function argument size is not good indicator of how many
1108 // arguments does the function have at source level.
1110 CurrentFnArguments.resize(ArgNo * 2);
1111 CurrentFnArguments[ArgNo - 1] = Var;
1115 // Collect variable information from side table maintained by MMI.
1116 void DwarfDebug::collectVariableInfoFromMMITable(
1117 SmallPtrSet<const MDNode *, 16> &Processed) {
1118 for (const auto &VI : MMI->getVariableDbgInfo()) {
1121 Processed.insert(VI.Var);
1122 DIVariable DV(VI.Var);
1123 LexicalScope *Scope = LScopes.findLexicalScope(VI.Loc);
1125 // If variable scope is not found then skip this variable.
1129 DbgVariable *AbsDbgVariable =
1130 findAbstractVariable(DV, Scope->getScopeNode());
1131 DbgVariable *RegVar = new DbgVariable(DV, AbsDbgVariable, this);
1132 RegVar->setFrameIndex(VI.Slot);
1133 addScopeVariable(Scope, RegVar);
1137 // Get .debug_loc entry for the instruction range starting at MI.
1138 static DebugLocEntry::Value getDebugLocValue(const MachineInstr *MI) {
1139 const MDNode *Var = MI->getDebugVariable();
1141 assert(MI->getNumOperands() == 3);
1142 if (MI->getOperand(0).isReg()) {
1143 MachineLocation MLoc;
1144 // If the second operand is an immediate, this is a
1145 // register-indirect address.
1146 if (!MI->getOperand(1).isImm())
1147 MLoc.set(MI->getOperand(0).getReg());
1149 MLoc.set(MI->getOperand(0).getReg(), MI->getOperand(1).getImm());
1150 return DebugLocEntry::Value(Var, MLoc);
1152 if (MI->getOperand(0).isImm())
1153 return DebugLocEntry::Value(Var, MI->getOperand(0).getImm());
1154 if (MI->getOperand(0).isFPImm())
1155 return DebugLocEntry::Value(Var, MI->getOperand(0).getFPImm());
1156 if (MI->getOperand(0).isCImm())
1157 return DebugLocEntry::Value(Var, MI->getOperand(0).getCImm());
1159 llvm_unreachable("Unexpected 3 operand DBG_VALUE instruction!");
1162 // Find variables for each lexical scope.
1164 DwarfDebug::collectVariableInfo(SmallPtrSet<const MDNode *, 16> &Processed) {
1165 LexicalScope *FnScope = LScopes.getCurrentFunctionScope();
1166 DwarfCompileUnit *TheCU = SPMap.lookup(FnScope->getScopeNode());
1168 // Grab the variable info that was squirreled away in the MMI side-table.
1169 collectVariableInfoFromMMITable(Processed);
1171 for (const auto &I : DbgValues) {
1172 DIVariable DV(I.first);
1173 if (Processed.count(DV))
1176 // Instruction ranges, specifying where DV is accessible.
1177 const auto &Ranges = I.second;
1181 LexicalScope *Scope = nullptr;
1182 if (DV.getTag() == dwarf::DW_TAG_arg_variable &&
1183 DISubprogram(DV.getContext()).describes(CurFn->getFunction()))
1184 Scope = LScopes.getCurrentFunctionScope();
1185 else if (MDNode *IA = DV.getInlinedAt()) {
1186 DebugLoc DL = DebugLoc::getFromDILocation(IA);
1187 Scope = LScopes.findInlinedScope(DebugLoc::get(
1188 DL.getLine(), DL.getCol(), DV.getContext(), IA));
1190 Scope = LScopes.findLexicalScope(DV.getContext());
1191 // If variable scope is not found then skip this variable.
1195 Processed.insert(DV);
1196 const MachineInstr *MInsn = Ranges.front().first;
1197 assert(MInsn->isDebugValue() && "History must begin with debug value");
1198 DbgVariable *AbsVar = findAbstractVariable(DV, Scope->getScopeNode());
1199 DbgVariable *RegVar = new DbgVariable(MInsn, AbsVar, this);
1200 addScopeVariable(Scope, RegVar);
1202 // Check if the first DBG_VALUE is valid for the rest of the function.
1203 if (Ranges.size() == 1 && Ranges.front().second == nullptr)
1206 // Handle multiple DBG_VALUE instructions describing one variable.
1207 RegVar->setDotDebugLocOffset(DotDebugLocEntries.size());
1209 DotDebugLocEntries.resize(DotDebugLocEntries.size() + 1);
1210 DebugLocList &LocList = DotDebugLocEntries.back();
1212 Asm->GetTempSymbol("debug_loc", DotDebugLocEntries.size() - 1);
1213 SmallVector<DebugLocEntry, 4> &DebugLoc = LocList.List;
1214 for (auto I = Ranges.begin(), E = Ranges.end(); I != E; ++I) {
1215 const MachineInstr *Begin = I->first;
1216 const MachineInstr *End = I->second;
1217 assert(Begin->isDebugValue() && "Invalid History entry");
1219 // Check if a variable is unaccessible in this range.
1220 if (Begin->getNumOperands() > 1 && Begin->getOperand(0).isReg() &&
1221 !Begin->getOperand(0).getReg())
1224 const MCSymbol *StartLabel = getLabelBeforeInsn(Begin);
1225 assert(StartLabel && "Forgot label before DBG_VALUE starting a range!");
1227 const MCSymbol *EndLabel;
1229 EndLabel = getLabelAfterInsn(End);
1230 else if (std::next(I) == Ranges.end())
1231 EndLabel = FunctionEndSym;
1233 EndLabel = getLabelBeforeInsn(std::next(I)->first);
1234 assert(EndLabel && "Forgot label after instruction ending a range!");
1236 DEBUG(dbgs() << "DotDebugLoc Pair:\n"
1237 << "\t" << *Begin << "\t" << *End << "\n");
1238 DebugLocEntry Loc(StartLabel, EndLabel, getDebugLocValue(Begin), TheCU);
1239 if (DebugLoc.empty() || !DebugLoc.back().Merge(Loc))
1240 DebugLoc.push_back(std::move(Loc));
1244 // Collect info for variables that were optimized out.
1245 DIArray Variables = DISubprogram(FnScope->getScopeNode()).getVariables();
1246 for (unsigned i = 0, e = Variables.getNumElements(); i != e; ++i) {
1247 DIVariable DV(Variables.getElement(i));
1248 assert(DV.isVariable());
1249 if (!Processed.insert(DV))
1251 if (LexicalScope *Scope = LScopes.findLexicalScope(DV.getContext())) {
1252 auto *RegVar = new DbgVariable(
1253 DV, findAbstractVariable(DV, Scope->getScopeNode()), this);
1254 addScopeVariable(Scope, RegVar);
1259 // Return Label preceding the instruction.
1260 MCSymbol *DwarfDebug::getLabelBeforeInsn(const MachineInstr *MI) {
1261 MCSymbol *Label = LabelsBeforeInsn.lookup(MI);
1262 assert(Label && "Didn't insert label before instruction");
1266 // Return Label immediately following the instruction.
1267 MCSymbol *DwarfDebug::getLabelAfterInsn(const MachineInstr *MI) {
1268 return LabelsAfterInsn.lookup(MI);
1271 // Process beginning of an instruction.
1272 void DwarfDebug::beginInstruction(const MachineInstr *MI) {
1273 assert(CurMI == nullptr);
1275 // Check if source location changes, but ignore DBG_VALUE locations.
1276 if (!MI->isDebugValue()) {
1277 DebugLoc DL = MI->getDebugLoc();
1278 if (DL != PrevInstLoc && (!DL.isUnknown() || UnknownLocations)) {
1281 if (DL == PrologEndLoc) {
1282 Flags |= DWARF2_FLAG_PROLOGUE_END;
1283 PrologEndLoc = DebugLoc();
1285 if (PrologEndLoc.isUnknown())
1286 Flags |= DWARF2_FLAG_IS_STMT;
1288 if (!DL.isUnknown()) {
1289 const MDNode *Scope = DL.getScope(Asm->MF->getFunction()->getContext());
1290 recordSourceLine(DL.getLine(), DL.getCol(), Scope, Flags);
1292 recordSourceLine(0, 0, nullptr, 0);
1296 // Insert labels where requested.
1297 DenseMap<const MachineInstr *, MCSymbol *>::iterator I =
1298 LabelsBeforeInsn.find(MI);
1301 if (I == LabelsBeforeInsn.end())
1304 // Label already assigned.
1309 PrevLabel = MMI->getContext().CreateTempSymbol();
1310 Asm->OutStreamer.EmitLabel(PrevLabel);
1312 I->second = PrevLabel;
1315 // Process end of an instruction.
1316 void DwarfDebug::endInstruction() {
1317 assert(CurMI != nullptr);
1318 // Don't create a new label after DBG_VALUE instructions.
1319 // They don't generate code.
1320 if (!CurMI->isDebugValue())
1321 PrevLabel = nullptr;
1323 DenseMap<const MachineInstr *, MCSymbol *>::iterator I =
1324 LabelsAfterInsn.find(CurMI);
1328 if (I == LabelsAfterInsn.end())
1331 // Label already assigned.
1335 // We need a label after this instruction.
1337 PrevLabel = MMI->getContext().CreateTempSymbol();
1338 Asm->OutStreamer.EmitLabel(PrevLabel);
1340 I->second = PrevLabel;
1343 // Each LexicalScope has first instruction and last instruction to mark
1344 // beginning and end of a scope respectively. Create an inverse map that list
1345 // scopes starts (and ends) with an instruction. One instruction may start (or
1346 // end) multiple scopes. Ignore scopes that are not reachable.
1347 void DwarfDebug::identifyScopeMarkers() {
1348 SmallVector<LexicalScope *, 4> WorkList;
1349 WorkList.push_back(LScopes.getCurrentFunctionScope());
1350 while (!WorkList.empty()) {
1351 LexicalScope *S = WorkList.pop_back_val();
1353 const SmallVectorImpl<LexicalScope *> &Children = S->getChildren();
1354 if (!Children.empty())
1355 WorkList.append(Children.begin(), Children.end());
1357 if (S->isAbstractScope())
1360 for (const InsnRange &R : S->getRanges()) {
1361 assert(R.first && "InsnRange does not have first instruction!");
1362 assert(R.second && "InsnRange does not have second instruction!");
1363 requestLabelBeforeInsn(R.first);
1364 requestLabelAfterInsn(R.second);
1369 static DebugLoc findPrologueEndLoc(const MachineFunction *MF) {
1370 // First known non-DBG_VALUE and non-frame setup location marks
1371 // the beginning of the function body.
1372 for (const auto &MBB : *MF)
1373 for (const auto &MI : MBB)
1374 if (!MI.isDebugValue() && !MI.getFlag(MachineInstr::FrameSetup) &&
1375 !MI.getDebugLoc().isUnknown())
1376 return MI.getDebugLoc();
1380 // Gather pre-function debug information. Assumes being called immediately
1381 // after the function entry point has been emitted.
1382 void DwarfDebug::beginFunction(const MachineFunction *MF) {
1385 // If there's no debug info for the function we're not going to do anything.
1386 if (!MMI->hasDebugInfo())
1389 // Grab the lexical scopes for the function, if we don't have any of those
1390 // then we're not going to be able to do anything.
1391 LScopes.initialize(*MF);
1392 if (LScopes.empty())
1395 assert(DbgValues.empty() && "DbgValues map wasn't cleaned!");
1397 // Make sure that each lexical scope will have a begin/end label.
1398 identifyScopeMarkers();
1400 // Set DwarfDwarfCompileUnitID in MCContext to the Compile Unit this function
1401 // belongs to so that we add to the correct per-cu line table in the
1403 LexicalScope *FnScope = LScopes.getCurrentFunctionScope();
1404 DwarfCompileUnit *TheCU = SPMap.lookup(FnScope->getScopeNode());
1405 assert(TheCU && "Unable to find compile unit!");
1406 if (Asm->OutStreamer.hasRawTextSupport())
1407 // Use a single line table if we are generating assembly.
1408 Asm->OutStreamer.getContext().setDwarfCompileUnitID(0);
1410 Asm->OutStreamer.getContext().setDwarfCompileUnitID(TheCU->getUniqueID());
1412 // Emit a label for the function so that we have a beginning address.
1413 FunctionBeginSym = Asm->GetTempSymbol("func_begin", Asm->getFunctionNumber());
1414 // Assumes in correct section after the entry point.
1415 Asm->OutStreamer.EmitLabel(FunctionBeginSym);
1417 // Calculate history for local variables.
1418 calculateDbgValueHistory(MF, Asm->TM.getRegisterInfo(), DbgValues);
1420 // Request labels for the full history.
1421 for (const auto &I : DbgValues) {
1422 const auto &Ranges = I.second;
1426 // The first mention of a function argument gets the FunctionBeginSym
1427 // label, so arguments are visible when breaking at function entry.
1428 DIVariable DV(I.first);
1429 if (DV.isVariable() && DV.getTag() == dwarf::DW_TAG_arg_variable &&
1430 getDISubprogram(DV.getContext()).describes(MF->getFunction()))
1431 LabelsBeforeInsn[Ranges.front().first] = FunctionBeginSym;
1433 for (const auto &Range : Ranges) {
1434 requestLabelBeforeInsn(Range.first);
1436 requestLabelAfterInsn(Range.second);
1440 PrevInstLoc = DebugLoc();
1441 PrevLabel = FunctionBeginSym;
1443 // Record beginning of function.
1444 PrologEndLoc = findPrologueEndLoc(MF);
1445 if (!PrologEndLoc.isUnknown()) {
1446 DebugLoc FnStartDL =
1447 PrologEndLoc.getFnDebugLoc(MF->getFunction()->getContext());
1449 FnStartDL.getLine(), FnStartDL.getCol(),
1450 FnStartDL.getScope(MF->getFunction()->getContext()),
1451 // We'd like to list the prologue as "not statements" but GDB behaves
1452 // poorly if we do that. Revisit this with caution/GDB (7.5+) testing.
1453 DWARF2_FLAG_IS_STMT);
1457 void DwarfDebug::addScopeVariable(LexicalScope *LS, DbgVariable *Var) {
1458 if (addCurrentFnArgument(Var, LS))
1460 SmallVectorImpl<DbgVariable *> &Vars = ScopeVariables[LS];
1461 DIVariable DV = Var->getVariable();
1462 // Variables with positive arg numbers are parameters.
1463 if (unsigned ArgNum = DV.getArgNumber()) {
1464 // Keep all parameters in order at the start of the variable list to ensure
1465 // function types are correct (no out-of-order parameters)
1467 // This could be improved by only doing it for optimized builds (unoptimized
1468 // builds have the right order to begin with), searching from the back (this
1469 // would catch the unoptimized case quickly), or doing a binary search
1470 // rather than linear search.
1471 SmallVectorImpl<DbgVariable *>::iterator I = Vars.begin();
1472 while (I != Vars.end()) {
1473 unsigned CurNum = (*I)->getVariable().getArgNumber();
1474 // A local (non-parameter) variable has been found, insert immediately
1478 // A later indexed parameter has been found, insert immediately before it.
1479 if (CurNum > ArgNum)
1483 Vars.insert(I, Var);
1487 Vars.push_back(Var);
1490 // Gather and emit post-function debug information.
1491 void DwarfDebug::endFunction(const MachineFunction *MF) {
1492 // Every beginFunction(MF) call should be followed by an endFunction(MF) call,
1493 // though the beginFunction may not be called at all.
1494 // We should handle both cases.
1498 assert(CurFn == MF);
1499 assert(CurFn != nullptr);
1501 if (!MMI->hasDebugInfo() || LScopes.empty()) {
1502 // If we don't have a lexical scope for this function then there will
1503 // be a hole in the range information. Keep note of this by setting the
1504 // previously used section to nullptr.
1505 PrevSection = nullptr;
1511 // Define end label for subprogram.
1512 FunctionEndSym = Asm->GetTempSymbol("func_end", Asm->getFunctionNumber());
1513 // Assumes in correct section after the entry point.
1514 Asm->OutStreamer.EmitLabel(FunctionEndSym);
1516 // Set DwarfDwarfCompileUnitID in MCContext to default value.
1517 Asm->OutStreamer.getContext().setDwarfCompileUnitID(0);
1519 SmallPtrSet<const MDNode *, 16> ProcessedVars;
1520 collectVariableInfo(ProcessedVars);
1522 LexicalScope *FnScope = LScopes.getCurrentFunctionScope();
1523 DwarfCompileUnit &TheCU = *SPMap.lookup(FnScope->getScopeNode());
1525 // Construct abstract scopes.
1526 for (LexicalScope *AScope : LScopes.getAbstractScopesList()) {
1527 DISubprogram SP(AScope->getScopeNode());
1528 if (!SP.isSubprogram())
1530 // Collect info for variables that were optimized out.
1531 DIArray Variables = SP.getVariables();
1532 for (unsigned i = 0, e = Variables.getNumElements(); i != e; ++i) {
1533 DIVariable DV(Variables.getElement(i));
1534 assert(DV && DV.isVariable());
1535 if (!ProcessedVars.insert(DV))
1537 getOrCreateAbstractVariable(DV, DV.getContext());
1539 constructAbstractSubprogramScopeDIE(TheCU, AScope);
1542 DIE &CurFnDIE = constructSubprogramScopeDIE(TheCU, FnScope);
1543 if (!CurFn->getTarget().Options.DisableFramePointerElim(*CurFn))
1544 TheCU.addFlag(CurFnDIE, dwarf::DW_AT_APPLE_omit_frame_ptr);
1546 // Add the range of this function to the list of ranges for the CU.
1547 RangeSpan Span(FunctionBeginSym, FunctionEndSym);
1548 TheCU.addRange(std::move(Span));
1549 PrevSection = Asm->getCurrentSection();
1553 // Ownership of DbgVariables is a bit subtle - ScopeVariables owns all the
1554 // DbgVariables except those that are also in AbstractVariables (since they
1555 // can be used cross-function)
1556 for (const auto &I : ScopeVariables)
1557 for (const auto *Var : I.second)
1558 if (!AbstractVariables.count(Var->getVariable()) || Var->getAbstractVariable())
1560 ScopeVariables.clear();
1561 DeleteContainerPointers(CurrentFnArguments);
1563 LabelsBeforeInsn.clear();
1564 LabelsAfterInsn.clear();
1565 PrevLabel = nullptr;
1569 // Register a source line with debug info. Returns the unique label that was
1570 // emitted and which provides correspondence to the source line list.
1571 void DwarfDebug::recordSourceLine(unsigned Line, unsigned Col, const MDNode *S,
1576 unsigned Discriminator = 0;
1577 if (DIScope Scope = DIScope(S)) {
1578 assert(Scope.isScope());
1579 Fn = Scope.getFilename();
1580 Dir = Scope.getDirectory();
1581 if (Scope.isLexicalBlock())
1582 Discriminator = DILexicalBlock(S).getDiscriminator();
1584 unsigned CUID = Asm->OutStreamer.getContext().getDwarfCompileUnitID();
1585 Src = static_cast<DwarfCompileUnit &>(*InfoHolder.getUnits()[CUID])
1586 .getOrCreateSourceID(Fn, Dir);
1588 Asm->OutStreamer.EmitDwarfLocDirective(Src, Line, Col, Flags, 0,
1592 //===----------------------------------------------------------------------===//
1594 //===----------------------------------------------------------------------===//
1596 // Emit initial Dwarf sections with a label at the start of each one.
1597 void DwarfDebug::emitSectionLabels() {
1598 const TargetLoweringObjectFile &TLOF = Asm->getObjFileLowering();
1600 // Dwarf sections base addresses.
1601 DwarfInfoSectionSym =
1602 emitSectionSym(Asm, TLOF.getDwarfInfoSection(), "section_info");
1603 if (useSplitDwarf())
1604 DwarfInfoDWOSectionSym =
1605 emitSectionSym(Asm, TLOF.getDwarfInfoDWOSection(), "section_info_dwo");
1606 DwarfAbbrevSectionSym =
1607 emitSectionSym(Asm, TLOF.getDwarfAbbrevSection(), "section_abbrev");
1608 if (useSplitDwarf())
1609 DwarfAbbrevDWOSectionSym = emitSectionSym(
1610 Asm, TLOF.getDwarfAbbrevDWOSection(), "section_abbrev_dwo");
1611 if (GenerateARangeSection)
1612 emitSectionSym(Asm, TLOF.getDwarfARangesSection());
1614 DwarfLineSectionSym =
1615 emitSectionSym(Asm, TLOF.getDwarfLineSection(), "section_line");
1616 if (GenerateGnuPubSections) {
1617 DwarfGnuPubNamesSectionSym =
1618 emitSectionSym(Asm, TLOF.getDwarfGnuPubNamesSection());
1619 DwarfGnuPubTypesSectionSym =
1620 emitSectionSym(Asm, TLOF.getDwarfGnuPubTypesSection());
1621 } else if (HasDwarfPubSections) {
1622 emitSectionSym(Asm, TLOF.getDwarfPubNamesSection());
1623 emitSectionSym(Asm, TLOF.getDwarfPubTypesSection());
1626 DwarfStrSectionSym =
1627 emitSectionSym(Asm, TLOF.getDwarfStrSection(), "info_string");
1628 if (useSplitDwarf()) {
1629 DwarfStrDWOSectionSym =
1630 emitSectionSym(Asm, TLOF.getDwarfStrDWOSection(), "skel_string");
1631 DwarfAddrSectionSym =
1632 emitSectionSym(Asm, TLOF.getDwarfAddrSection(), "addr_sec");
1633 DwarfDebugLocSectionSym =
1634 emitSectionSym(Asm, TLOF.getDwarfLocDWOSection(), "skel_loc");
1636 DwarfDebugLocSectionSym =
1637 emitSectionSym(Asm, TLOF.getDwarfLocSection(), "section_debug_loc");
1638 DwarfDebugRangeSectionSym =
1639 emitSectionSym(Asm, TLOF.getDwarfRangesSection(), "debug_range");
1642 // Recursively emits a debug information entry.
1643 void DwarfDebug::emitDIE(DIE &Die) {
1644 // Get the abbreviation for this DIE.
1645 const DIEAbbrev &Abbrev = Die.getAbbrev();
1647 // Emit the code (index) for the abbreviation.
1648 if (Asm->isVerbose())
1649 Asm->OutStreamer.AddComment("Abbrev [" + Twine(Abbrev.getNumber()) +
1650 "] 0x" + Twine::utohexstr(Die.getOffset()) +
1651 ":0x" + Twine::utohexstr(Die.getSize()) + " " +
1652 dwarf::TagString(Abbrev.getTag()));
1653 Asm->EmitULEB128(Abbrev.getNumber());
1655 const SmallVectorImpl<DIEValue *> &Values = Die.getValues();
1656 const SmallVectorImpl<DIEAbbrevData> &AbbrevData = Abbrev.getData();
1658 // Emit the DIE attribute values.
1659 for (unsigned i = 0, N = Values.size(); i < N; ++i) {
1660 dwarf::Attribute Attr = AbbrevData[i].getAttribute();
1661 dwarf::Form Form = AbbrevData[i].getForm();
1662 assert(Form && "Too many attributes for DIE (check abbreviation)");
1664 if (Asm->isVerbose()) {
1665 Asm->OutStreamer.AddComment(dwarf::AttributeString(Attr));
1666 if (Attr == dwarf::DW_AT_accessibility)
1667 Asm->OutStreamer.AddComment(dwarf::AccessibilityString(
1668 cast<DIEInteger>(Values[i])->getValue()));
1671 // Emit an attribute using the defined form.
1672 Values[i]->EmitValue(Asm, Form);
1675 // Emit the DIE children if any.
1676 if (Abbrev.hasChildren()) {
1677 for (auto &Child : Die.getChildren())
1680 Asm->OutStreamer.AddComment("End Of Children Mark");
1685 // Emit the debug info section.
1686 void DwarfDebug::emitDebugInfo() {
1687 DwarfFile &Holder = useSplitDwarf() ? SkeletonHolder : InfoHolder;
1689 Holder.emitUnits(this, DwarfAbbrevSectionSym);
1692 // Emit the abbreviation section.
1693 void DwarfDebug::emitAbbreviations() {
1694 DwarfFile &Holder = useSplitDwarf() ? SkeletonHolder : InfoHolder;
1696 Holder.emitAbbrevs(Asm->getObjFileLowering().getDwarfAbbrevSection());
1699 // Emit the last address of the section and the end of the line matrix.
1700 void DwarfDebug::emitEndOfLineMatrix(unsigned SectionEnd) {
1701 // Define last address of section.
1702 Asm->OutStreamer.AddComment("Extended Op");
1705 Asm->OutStreamer.AddComment("Op size");
1706 Asm->EmitInt8(Asm->getDataLayout().getPointerSize() + 1);
1707 Asm->OutStreamer.AddComment("DW_LNE_set_address");
1708 Asm->EmitInt8(dwarf::DW_LNE_set_address);
1710 Asm->OutStreamer.AddComment("Section end label");
1712 Asm->OutStreamer.EmitSymbolValue(
1713 Asm->GetTempSymbol("section_end", SectionEnd),
1714 Asm->getDataLayout().getPointerSize());
1716 // Mark end of matrix.
1717 Asm->OutStreamer.AddComment("DW_LNE_end_sequence");
1723 // Emit visible names into a hashed accelerator table section.
1724 void DwarfDebug::emitAccelNames() {
1725 AccelNames.FinalizeTable(Asm, "Names");
1726 Asm->OutStreamer.SwitchSection(
1727 Asm->getObjFileLowering().getDwarfAccelNamesSection());
1728 MCSymbol *SectionBegin = Asm->GetTempSymbol("names_begin");
1729 Asm->OutStreamer.EmitLabel(SectionBegin);
1731 // Emit the full data.
1732 AccelNames.Emit(Asm, SectionBegin, &InfoHolder);
1735 // Emit objective C classes and categories into a hashed accelerator table
1737 void DwarfDebug::emitAccelObjC() {
1738 AccelObjC.FinalizeTable(Asm, "ObjC");
1739 Asm->OutStreamer.SwitchSection(
1740 Asm->getObjFileLowering().getDwarfAccelObjCSection());
1741 MCSymbol *SectionBegin = Asm->GetTempSymbol("objc_begin");
1742 Asm->OutStreamer.EmitLabel(SectionBegin);
1744 // Emit the full data.
1745 AccelObjC.Emit(Asm, SectionBegin, &InfoHolder);
1748 // Emit namespace dies into a hashed accelerator table.
1749 void DwarfDebug::emitAccelNamespaces() {
1750 AccelNamespace.FinalizeTable(Asm, "namespac");
1751 Asm->OutStreamer.SwitchSection(
1752 Asm->getObjFileLowering().getDwarfAccelNamespaceSection());
1753 MCSymbol *SectionBegin = Asm->GetTempSymbol("namespac_begin");
1754 Asm->OutStreamer.EmitLabel(SectionBegin);
1756 // Emit the full data.
1757 AccelNamespace.Emit(Asm, SectionBegin, &InfoHolder);
1760 // Emit type dies into a hashed accelerator table.
1761 void DwarfDebug::emitAccelTypes() {
1763 AccelTypes.FinalizeTable(Asm, "types");
1764 Asm->OutStreamer.SwitchSection(
1765 Asm->getObjFileLowering().getDwarfAccelTypesSection());
1766 MCSymbol *SectionBegin = Asm->GetTempSymbol("types_begin");
1767 Asm->OutStreamer.EmitLabel(SectionBegin);
1769 // Emit the full data.
1770 AccelTypes.Emit(Asm, SectionBegin, &InfoHolder);
1773 // Public name handling.
1774 // The format for the various pubnames:
1776 // dwarf pubnames - offset/name pairs where the offset is the offset into the CU
1777 // for the DIE that is named.
1779 // gnu pubnames - offset/index value/name tuples where the offset is the offset
1780 // into the CU and the index value is computed according to the type of value
1781 // for the DIE that is named.
1783 // For type units the offset is the offset of the skeleton DIE. For split dwarf
1784 // it's the offset within the debug_info/debug_types dwo section, however, the
1785 // reference in the pubname header doesn't change.
1787 /// computeIndexValue - Compute the gdb index value for the DIE and CU.
1788 static dwarf::PubIndexEntryDescriptor computeIndexValue(DwarfUnit *CU,
1790 dwarf::GDBIndexEntryLinkage Linkage = dwarf::GIEL_STATIC;
1792 // We could have a specification DIE that has our most of our knowledge,
1793 // look for that now.
1794 DIEValue *SpecVal = Die->findAttribute(dwarf::DW_AT_specification);
1796 DIE &SpecDIE = cast<DIEEntry>(SpecVal)->getEntry();
1797 if (SpecDIE.findAttribute(dwarf::DW_AT_external))
1798 Linkage = dwarf::GIEL_EXTERNAL;
1799 } else if (Die->findAttribute(dwarf::DW_AT_external))
1800 Linkage = dwarf::GIEL_EXTERNAL;
1802 switch (Die->getTag()) {
1803 case dwarf::DW_TAG_class_type:
1804 case dwarf::DW_TAG_structure_type:
1805 case dwarf::DW_TAG_union_type:
1806 case dwarf::DW_TAG_enumeration_type:
1807 return dwarf::PubIndexEntryDescriptor(
1808 dwarf::GIEK_TYPE, CU->getLanguage() != dwarf::DW_LANG_C_plus_plus
1809 ? dwarf::GIEL_STATIC
1810 : dwarf::GIEL_EXTERNAL);
1811 case dwarf::DW_TAG_typedef:
1812 case dwarf::DW_TAG_base_type:
1813 case dwarf::DW_TAG_subrange_type:
1814 return dwarf::PubIndexEntryDescriptor(dwarf::GIEK_TYPE, dwarf::GIEL_STATIC);
1815 case dwarf::DW_TAG_namespace:
1816 return dwarf::GIEK_TYPE;
1817 case dwarf::DW_TAG_subprogram:
1818 return dwarf::PubIndexEntryDescriptor(dwarf::GIEK_FUNCTION, Linkage);
1819 case dwarf::DW_TAG_constant:
1820 case dwarf::DW_TAG_variable:
1821 return dwarf::PubIndexEntryDescriptor(dwarf::GIEK_VARIABLE, Linkage);
1822 case dwarf::DW_TAG_enumerator:
1823 return dwarf::PubIndexEntryDescriptor(dwarf::GIEK_VARIABLE,
1824 dwarf::GIEL_STATIC);
1826 return dwarf::GIEK_NONE;
1830 /// emitDebugPubNames - Emit visible names into a debug pubnames section.
1832 void DwarfDebug::emitDebugPubNames(bool GnuStyle) {
1833 const MCSection *PSec =
1834 GnuStyle ? Asm->getObjFileLowering().getDwarfGnuPubNamesSection()
1835 : Asm->getObjFileLowering().getDwarfPubNamesSection();
1837 emitDebugPubSection(GnuStyle, PSec, "Names", &DwarfUnit::getGlobalNames);
1840 void DwarfDebug::emitDebugPubSection(
1841 bool GnuStyle, const MCSection *PSec, StringRef Name,
1842 const StringMap<const DIE *> &(DwarfUnit::*Accessor)() const) {
1843 for (const auto &NU : CUMap) {
1844 DwarfCompileUnit *TheU = NU.second;
1846 const auto &Globals = (TheU->*Accessor)();
1848 if (Globals.empty())
1851 if (auto Skeleton = static_cast<DwarfCompileUnit *>(TheU->getSkeleton()))
1853 unsigned ID = TheU->getUniqueID();
1855 // Start the dwarf pubnames section.
1856 Asm->OutStreamer.SwitchSection(PSec);
1859 Asm->OutStreamer.AddComment("Length of Public " + Name + " Info");
1860 MCSymbol *BeginLabel = Asm->GetTempSymbol("pub" + Name + "_begin", ID);
1861 MCSymbol *EndLabel = Asm->GetTempSymbol("pub" + Name + "_end", ID);
1862 Asm->EmitLabelDifference(EndLabel, BeginLabel, 4);
1864 Asm->OutStreamer.EmitLabel(BeginLabel);
1866 Asm->OutStreamer.AddComment("DWARF Version");
1867 Asm->EmitInt16(dwarf::DW_PUBNAMES_VERSION);
1869 Asm->OutStreamer.AddComment("Offset of Compilation Unit Info");
1870 Asm->EmitSectionOffset(TheU->getLabelBegin(), TheU->getSectionSym());
1872 Asm->OutStreamer.AddComment("Compilation Unit Length");
1873 Asm->EmitLabelDifference(TheU->getLabelEnd(), TheU->getLabelBegin(), 4);
1875 // Emit the pubnames for this compilation unit.
1876 for (const auto &GI : Globals) {
1877 const char *Name = GI.getKeyData();
1878 const DIE *Entity = GI.second;
1880 Asm->OutStreamer.AddComment("DIE offset");
1881 Asm->EmitInt32(Entity->getOffset());
1884 dwarf::PubIndexEntryDescriptor Desc = computeIndexValue(TheU, Entity);
1885 Asm->OutStreamer.AddComment(
1886 Twine("Kind: ") + dwarf::GDBIndexEntryKindString(Desc.Kind) + ", " +
1887 dwarf::GDBIndexEntryLinkageString(Desc.Linkage));
1888 Asm->EmitInt8(Desc.toBits());
1891 Asm->OutStreamer.AddComment("External Name");
1892 Asm->OutStreamer.EmitBytes(StringRef(Name, GI.getKeyLength() + 1));
1895 Asm->OutStreamer.AddComment("End Mark");
1897 Asm->OutStreamer.EmitLabel(EndLabel);
1901 void DwarfDebug::emitDebugPubTypes(bool GnuStyle) {
1902 const MCSection *PSec =
1903 GnuStyle ? Asm->getObjFileLowering().getDwarfGnuPubTypesSection()
1904 : Asm->getObjFileLowering().getDwarfPubTypesSection();
1906 emitDebugPubSection(GnuStyle, PSec, "Types", &DwarfUnit::getGlobalTypes);
1909 // Emit visible names into a debug str section.
1910 void DwarfDebug::emitDebugStr() {
1911 DwarfFile &Holder = useSplitDwarf() ? SkeletonHolder : InfoHolder;
1912 Holder.emitStrings(Asm->getObjFileLowering().getDwarfStrSection());
1915 void DwarfDebug::emitDebugLocEntry(ByteStreamer &Streamer,
1916 const DebugLocEntry &Entry) {
1917 assert(Entry.getValues().size() == 1 &&
1918 "multi-value entries are not supported yet.");
1919 const DebugLocEntry::Value Value = Entry.getValues()[0];
1920 DIVariable DV(Value.getVariable());
1921 if (Value.isInt()) {
1922 DIBasicType BTy(resolve(DV.getType()));
1923 if (BTy.Verify() && (BTy.getEncoding() == dwarf::DW_ATE_signed ||
1924 BTy.getEncoding() == dwarf::DW_ATE_signed_char)) {
1925 Streamer.EmitInt8(dwarf::DW_OP_consts, "DW_OP_consts");
1926 Streamer.EmitSLEB128(Value.getInt());
1928 Streamer.EmitInt8(dwarf::DW_OP_constu, "DW_OP_constu");
1929 Streamer.EmitULEB128(Value.getInt());
1931 } else if (Value.isLocation()) {
1932 MachineLocation Loc = Value.getLoc();
1933 if (!DV.hasComplexAddress())
1935 Asm->EmitDwarfRegOp(Streamer, Loc, DV.isIndirect());
1937 // Complex address entry.
1938 unsigned N = DV.getNumAddrElements();
1940 if (N >= 2 && DV.getAddrElement(0) == DIBuilder::OpPlus) {
1941 if (Loc.getOffset()) {
1943 Asm->EmitDwarfRegOp(Streamer, Loc, DV.isIndirect());
1944 Streamer.EmitInt8(dwarf::DW_OP_deref, "DW_OP_deref");
1945 Streamer.EmitInt8(dwarf::DW_OP_plus_uconst, "DW_OP_plus_uconst");
1946 Streamer.EmitSLEB128(DV.getAddrElement(1));
1948 // If first address element is OpPlus then emit
1949 // DW_OP_breg + Offset instead of DW_OP_reg + Offset.
1950 MachineLocation TLoc(Loc.getReg(), DV.getAddrElement(1));
1951 Asm->EmitDwarfRegOp(Streamer, TLoc, DV.isIndirect());
1955 Asm->EmitDwarfRegOp(Streamer, Loc, DV.isIndirect());
1958 // Emit remaining complex address elements.
1959 for (; i < N; ++i) {
1960 uint64_t Element = DV.getAddrElement(i);
1961 if (Element == DIBuilder::OpPlus) {
1962 Streamer.EmitInt8(dwarf::DW_OP_plus_uconst, "DW_OP_plus_uconst");
1963 Streamer.EmitULEB128(DV.getAddrElement(++i));
1964 } else if (Element == DIBuilder::OpDeref) {
1966 Streamer.EmitInt8(dwarf::DW_OP_deref, "DW_OP_deref");
1968 llvm_unreachable("unknown Opcode found in complex address");
1972 // else ... ignore constant fp. There is not any good way to
1973 // to represent them here in dwarf.
1977 void DwarfDebug::emitDebugLocEntryLocation(const DebugLocEntry &Entry) {
1978 Asm->OutStreamer.AddComment("Loc expr size");
1979 MCSymbol *begin = Asm->OutStreamer.getContext().CreateTempSymbol();
1980 MCSymbol *end = Asm->OutStreamer.getContext().CreateTempSymbol();
1981 Asm->EmitLabelDifference(end, begin, 2);
1982 Asm->OutStreamer.EmitLabel(begin);
1984 APByteStreamer Streamer(*Asm);
1985 emitDebugLocEntry(Streamer, Entry);
1987 Asm->OutStreamer.EmitLabel(end);
1990 // Emit locations into the debug loc section.
1991 void DwarfDebug::emitDebugLoc() {
1992 // Start the dwarf loc section.
1993 Asm->OutStreamer.SwitchSection(
1994 Asm->getObjFileLowering().getDwarfLocSection());
1995 unsigned char Size = Asm->getDataLayout().getPointerSize();
1996 for (const auto &DebugLoc : DotDebugLocEntries) {
1997 Asm->OutStreamer.EmitLabel(DebugLoc.Label);
1998 for (const auto &Entry : DebugLoc.List) {
1999 // Set up the range. This range is relative to the entry point of the
2000 // compile unit. This is a hard coded 0 for low_pc when we're emitting
2001 // ranges, or the DW_AT_low_pc on the compile unit otherwise.
2002 const DwarfCompileUnit *CU = Entry.getCU();
2003 if (CU->getRanges().size() == 1) {
2004 // Grab the begin symbol from the first range as our base.
2005 const MCSymbol *Base = CU->getRanges()[0].getStart();
2006 Asm->EmitLabelDifference(Entry.getBeginSym(), Base, Size);
2007 Asm->EmitLabelDifference(Entry.getEndSym(), Base, Size);
2009 Asm->OutStreamer.EmitSymbolValue(Entry.getBeginSym(), Size);
2010 Asm->OutStreamer.EmitSymbolValue(Entry.getEndSym(), Size);
2013 emitDebugLocEntryLocation(Entry);
2015 Asm->OutStreamer.EmitIntValue(0, Size);
2016 Asm->OutStreamer.EmitIntValue(0, Size);
2020 void DwarfDebug::emitDebugLocDWO() {
2021 Asm->OutStreamer.SwitchSection(
2022 Asm->getObjFileLowering().getDwarfLocDWOSection());
2023 for (const auto &DebugLoc : DotDebugLocEntries) {
2024 Asm->OutStreamer.EmitLabel(DebugLoc.Label);
2025 for (const auto &Entry : DebugLoc.List) {
2026 // Just always use start_length for now - at least that's one address
2027 // rather than two. We could get fancier and try to, say, reuse an
2028 // address we know we've emitted elsewhere (the start of the function?
2029 // The start of the CU or CU subrange that encloses this range?)
2030 Asm->EmitInt8(dwarf::DW_LLE_start_length_entry);
2031 unsigned idx = AddrPool.getIndex(Entry.getBeginSym());
2032 Asm->EmitULEB128(idx);
2033 Asm->EmitLabelDifference(Entry.getEndSym(), Entry.getBeginSym(), 4);
2035 emitDebugLocEntryLocation(Entry);
2037 Asm->EmitInt8(dwarf::DW_LLE_end_of_list_entry);
2042 const MCSymbol *Start, *End;
2045 // Emit a debug aranges section, containing a CU lookup for any
2046 // address we can tie back to a CU.
2047 void DwarfDebug::emitDebugARanges() {
2048 // Start the dwarf aranges section.
2049 Asm->OutStreamer.SwitchSection(
2050 Asm->getObjFileLowering().getDwarfARangesSection());
2052 typedef DenseMap<DwarfCompileUnit *, std::vector<ArangeSpan>> SpansType;
2056 // Build a list of sections used.
2057 std::vector<const MCSection *> Sections;
2058 for (const auto &it : SectionMap) {
2059 const MCSection *Section = it.first;
2060 Sections.push_back(Section);
2063 // Sort the sections into order.
2064 // This is only done to ensure consistent output order across different runs.
2065 std::sort(Sections.begin(), Sections.end(), SectionSort);
2067 // Build a set of address spans, sorted by CU.
2068 for (const MCSection *Section : Sections) {
2069 SmallVector<SymbolCU, 8> &List = SectionMap[Section];
2070 if (List.size() < 2)
2073 // Sort the symbols by offset within the section.
2074 std::sort(List.begin(), List.end(),
2075 [&](const SymbolCU &A, const SymbolCU &B) {
2076 unsigned IA = A.Sym ? Asm->OutStreamer.GetSymbolOrder(A.Sym) : 0;
2077 unsigned IB = B.Sym ? Asm->OutStreamer.GetSymbolOrder(B.Sym) : 0;
2079 // Symbols with no order assigned should be placed at the end.
2080 // (e.g. section end labels)
2088 // If we have no section (e.g. common), just write out
2089 // individual spans for each symbol.
2091 for (const SymbolCU &Cur : List) {
2093 Span.Start = Cur.Sym;
2096 Spans[Cur.CU].push_back(Span);
2099 // Build spans between each label.
2100 const MCSymbol *StartSym = List[0].Sym;
2101 for (size_t n = 1, e = List.size(); n < e; n++) {
2102 const SymbolCU &Prev = List[n - 1];
2103 const SymbolCU &Cur = List[n];
2105 // Try and build the longest span we can within the same CU.
2106 if (Cur.CU != Prev.CU) {
2108 Span.Start = StartSym;
2110 Spans[Prev.CU].push_back(Span);
2117 unsigned PtrSize = Asm->getDataLayout().getPointerSize();
2119 // Build a list of CUs used.
2120 std::vector<DwarfCompileUnit *> CUs;
2121 for (const auto &it : Spans) {
2122 DwarfCompileUnit *CU = it.first;
2126 // Sort the CU list (again, to ensure consistent output order).
2127 std::sort(CUs.begin(), CUs.end(), [](const DwarfUnit *A, const DwarfUnit *B) {
2128 return A->getUniqueID() < B->getUniqueID();
2131 // Emit an arange table for each CU we used.
2132 for (DwarfCompileUnit *CU : CUs) {
2133 std::vector<ArangeSpan> &List = Spans[CU];
2135 // Emit size of content not including length itself.
2136 unsigned ContentSize =
2137 sizeof(int16_t) + // DWARF ARange version number
2138 sizeof(int32_t) + // Offset of CU in the .debug_info section
2139 sizeof(int8_t) + // Pointer Size (in bytes)
2140 sizeof(int8_t); // Segment Size (in bytes)
2142 unsigned TupleSize = PtrSize * 2;
2144 // 7.20 in the Dwarf specs requires the table to be aligned to a tuple.
2146 OffsetToAlignment(sizeof(int32_t) + ContentSize, TupleSize);
2148 ContentSize += Padding;
2149 ContentSize += (List.size() + 1) * TupleSize;
2151 // For each compile unit, write the list of spans it covers.
2152 Asm->OutStreamer.AddComment("Length of ARange Set");
2153 Asm->EmitInt32(ContentSize);
2154 Asm->OutStreamer.AddComment("DWARF Arange version number");
2155 Asm->EmitInt16(dwarf::DW_ARANGES_VERSION);
2156 Asm->OutStreamer.AddComment("Offset Into Debug Info Section");
2157 Asm->EmitSectionOffset(CU->getLocalLabelBegin(), CU->getLocalSectionSym());
2158 Asm->OutStreamer.AddComment("Address Size (in bytes)");
2159 Asm->EmitInt8(PtrSize);
2160 Asm->OutStreamer.AddComment("Segment Size (in bytes)");
2163 Asm->OutStreamer.EmitFill(Padding, 0xff);
2165 for (const ArangeSpan &Span : List) {
2166 Asm->EmitLabelReference(Span.Start, PtrSize);
2168 // Calculate the size as being from the span start to it's end.
2170 Asm->EmitLabelDifference(Span.End, Span.Start, PtrSize);
2172 // For symbols without an end marker (e.g. common), we
2173 // write a single arange entry containing just that one symbol.
2174 uint64_t Size = SymSize[Span.Start];
2178 Asm->OutStreamer.EmitIntValue(Size, PtrSize);
2182 Asm->OutStreamer.AddComment("ARange terminator");
2183 Asm->OutStreamer.EmitIntValue(0, PtrSize);
2184 Asm->OutStreamer.EmitIntValue(0, PtrSize);
2188 // Emit visible names into a debug ranges section.
2189 void DwarfDebug::emitDebugRanges() {
2190 // Start the dwarf ranges section.
2191 Asm->OutStreamer.SwitchSection(
2192 Asm->getObjFileLowering().getDwarfRangesSection());
2194 // Size for our labels.
2195 unsigned char Size = Asm->getDataLayout().getPointerSize();
2197 // Grab the specific ranges for the compile units in the module.
2198 for (const auto &I : CUMap) {
2199 DwarfCompileUnit *TheCU = I.second;
2201 // Iterate over the misc ranges for the compile units in the module.
2202 for (const RangeSpanList &List : TheCU->getRangeLists()) {
2203 // Emit our symbol so we can find the beginning of the range.
2204 Asm->OutStreamer.EmitLabel(List.getSym());
2206 for (const RangeSpan &Range : List.getRanges()) {
2207 const MCSymbol *Begin = Range.getStart();
2208 const MCSymbol *End = Range.getEnd();
2209 assert(Begin && "Range without a begin symbol?");
2210 assert(End && "Range without an end symbol?");
2211 if (TheCU->getRanges().size() == 1) {
2212 // Grab the begin symbol from the first range as our base.
2213 const MCSymbol *Base = TheCU->getRanges()[0].getStart();
2214 Asm->EmitLabelDifference(Begin, Base, Size);
2215 Asm->EmitLabelDifference(End, Base, Size);
2217 Asm->OutStreamer.EmitSymbolValue(Begin, Size);
2218 Asm->OutStreamer.EmitSymbolValue(End, Size);
2222 // And terminate the list with two 0 values.
2223 Asm->OutStreamer.EmitIntValue(0, Size);
2224 Asm->OutStreamer.EmitIntValue(0, Size);
2227 // Now emit a range for the CU itself.
2228 if (TheCU->getRanges().size() > 1) {
2229 Asm->OutStreamer.EmitLabel(
2230 Asm->GetTempSymbol("cu_ranges", TheCU->getUniqueID()));
2231 for (const RangeSpan &Range : TheCU->getRanges()) {
2232 const MCSymbol *Begin = Range.getStart();
2233 const MCSymbol *End = Range.getEnd();
2234 assert(Begin && "Range without a begin symbol?");
2235 assert(End && "Range without an end symbol?");
2236 Asm->OutStreamer.EmitSymbolValue(Begin, Size);
2237 Asm->OutStreamer.EmitSymbolValue(End, Size);
2239 // And terminate the list with two 0 values.
2240 Asm->OutStreamer.EmitIntValue(0, Size);
2241 Asm->OutStreamer.EmitIntValue(0, Size);
2246 // DWARF5 Experimental Separate Dwarf emitters.
2248 void DwarfDebug::initSkeletonUnit(const DwarfUnit &U, DIE &Die,
2249 std::unique_ptr<DwarfUnit> NewU) {
2250 NewU->addLocalString(Die, dwarf::DW_AT_GNU_dwo_name,
2251 U.getCUNode().getSplitDebugFilename());
2253 if (!CompilationDir.empty())
2254 NewU->addLocalString(Die, dwarf::DW_AT_comp_dir, CompilationDir);
2256 addGnuPubAttributes(*NewU, Die);
2258 SkeletonHolder.addUnit(std::move(NewU));
2261 // This DIE has the following attributes: DW_AT_comp_dir, DW_AT_stmt_list,
2262 // DW_AT_low_pc, DW_AT_high_pc, DW_AT_ranges, DW_AT_dwo_name, DW_AT_dwo_id,
2263 // DW_AT_addr_base, DW_AT_ranges_base.
2264 DwarfCompileUnit &DwarfDebug::constructSkeletonCU(const DwarfCompileUnit &CU) {
2266 auto OwnedUnit = make_unique<DwarfCompileUnit>(
2267 CU.getUniqueID(), CU.getCUNode(), Asm, this, &SkeletonHolder);
2268 DwarfCompileUnit &NewCU = *OwnedUnit;
2269 NewCU.initSection(Asm->getObjFileLowering().getDwarfInfoSection(),
2270 DwarfInfoSectionSym);
2272 NewCU.initStmtList(DwarfLineSectionSym);
2274 initSkeletonUnit(CU, NewCU.getUnitDie(), std::move(OwnedUnit));
2279 // This DIE has the following attributes: DW_AT_comp_dir, DW_AT_dwo_name,
2281 DwarfTypeUnit &DwarfDebug::constructSkeletonTU(DwarfTypeUnit &TU) {
2282 DwarfCompileUnit &CU = static_cast<DwarfCompileUnit &>(
2283 *SkeletonHolder.getUnits()[TU.getCU().getUniqueID()]);
2285 auto OwnedUnit = make_unique<DwarfTypeUnit>(TU.getUniqueID(), CU, Asm, this,
2287 DwarfTypeUnit &NewTU = *OwnedUnit;
2288 NewTU.setTypeSignature(TU.getTypeSignature());
2289 NewTU.setType(nullptr);
2291 Asm->getObjFileLowering().getDwarfTypesSection(TU.getTypeSignature()));
2293 initSkeletonUnit(TU, NewTU.getUnitDie(), std::move(OwnedUnit));
2297 // Emit the .debug_info.dwo section for separated dwarf. This contains the
2298 // compile units that would normally be in debug_info.
2299 void DwarfDebug::emitDebugInfoDWO() {
2300 assert(useSplitDwarf() && "No split dwarf debug info?");
2301 // Don't pass an abbrev symbol, using a constant zero instead so as not to
2302 // emit relocations into the dwo file.
2303 InfoHolder.emitUnits(this, /* AbbrevSymbol */ nullptr);
2306 // Emit the .debug_abbrev.dwo section for separated dwarf. This contains the
2307 // abbreviations for the .debug_info.dwo section.
2308 void DwarfDebug::emitDebugAbbrevDWO() {
2309 assert(useSplitDwarf() && "No split dwarf?");
2310 InfoHolder.emitAbbrevs(Asm->getObjFileLowering().getDwarfAbbrevDWOSection());
2313 void DwarfDebug::emitDebugLineDWO() {
2314 assert(useSplitDwarf() && "No split dwarf?");
2315 Asm->OutStreamer.SwitchSection(
2316 Asm->getObjFileLowering().getDwarfLineDWOSection());
2317 SplitTypeUnitFileTable.Emit(Asm->OutStreamer);
2320 // Emit the .debug_str.dwo section for separated dwarf. This contains the
2321 // string section and is identical in format to traditional .debug_str
2323 void DwarfDebug::emitDebugStrDWO() {
2324 assert(useSplitDwarf() && "No split dwarf?");
2325 const MCSection *OffSec =
2326 Asm->getObjFileLowering().getDwarfStrOffDWOSection();
2327 const MCSymbol *StrSym = DwarfStrSectionSym;
2328 InfoHolder.emitStrings(Asm->getObjFileLowering().getDwarfStrDWOSection(),
2332 MCDwarfDwoLineTable *DwarfDebug::getDwoLineTable(const DwarfCompileUnit &CU) {
2333 if (!useSplitDwarf())
2336 SplitTypeUnitFileTable.setCompilationDir(CU.getCUNode().getDirectory());
2337 return &SplitTypeUnitFileTable;
2340 static uint64_t makeTypeSignature(StringRef Identifier) {
2342 Hash.update(Identifier);
2343 // ... take the least significant 8 bytes and return those. Our MD5
2344 // implementation always returns its results in little endian, swap bytes
2346 MD5::MD5Result Result;
2348 return *reinterpret_cast<support::ulittle64_t *>(Result + 8);
2351 void DwarfDebug::addDwarfTypeUnitType(DwarfCompileUnit &CU,
2352 StringRef Identifier, DIE &RefDie,
2353 DICompositeType CTy) {
2354 // Fast path if we're building some type units and one has already used the
2355 // address pool we know we're going to throw away all this work anyway, so
2356 // don't bother building dependent types.
2357 if (!TypeUnitsUnderConstruction.empty() && AddrPool.hasBeenUsed())
2360 const DwarfTypeUnit *&TU = DwarfTypeUnits[CTy];
2362 CU.addDIETypeSignature(RefDie, *TU);
2366 bool TopLevelType = TypeUnitsUnderConstruction.empty();
2367 AddrPool.resetUsedFlag();
2370 make_unique<DwarfTypeUnit>(InfoHolder.getUnits().size(), CU, Asm, this,
2371 &InfoHolder, getDwoLineTable(CU));
2372 DwarfTypeUnit &NewTU = *OwnedUnit;
2373 DIE &UnitDie = NewTU.getUnitDie();
2375 TypeUnitsUnderConstruction.push_back(
2376 std::make_pair(std::move(OwnedUnit), CTy));
2378 NewTU.addUInt(UnitDie, dwarf::DW_AT_language, dwarf::DW_FORM_data2,
2381 uint64_t Signature = makeTypeSignature(Identifier);
2382 NewTU.setTypeSignature(Signature);
2384 if (!useSplitDwarf())
2385 CU.applyStmtList(UnitDie);
2387 // FIXME: Skip using COMDAT groups for type units in the .dwo file once tools
2388 // such as DWP ( http://gcc.gnu.org/wiki/DebugFissionDWP ) can cope with it.
2391 ? Asm->getObjFileLowering().getDwarfTypesDWOSection(Signature)
2392 : Asm->getObjFileLowering().getDwarfTypesSection(Signature));
2394 NewTU.setType(NewTU.createTypeDIE(CTy));
2397 auto TypeUnitsToAdd = std::move(TypeUnitsUnderConstruction);
2398 TypeUnitsUnderConstruction.clear();
2400 // Types referencing entries in the address table cannot be placed in type
2402 if (AddrPool.hasBeenUsed()) {
2404 // Remove all the types built while building this type.
2405 // This is pessimistic as some of these types might not be dependent on
2406 // the type that used an address.
2407 for (const auto &TU : TypeUnitsToAdd)
2408 DwarfTypeUnits.erase(TU.second);
2410 // Construct this type in the CU directly.
2411 // This is inefficient because all the dependent types will be rebuilt
2412 // from scratch, including building them in type units, discovering that
2413 // they depend on addresses, throwing them out and rebuilding them.
2414 CU.constructTypeDIE(RefDie, CTy);
2418 // If the type wasn't dependent on fission addresses, finish adding the type
2419 // and all its dependent types.
2420 for (auto &TU : TypeUnitsToAdd) {
2421 if (useSplitDwarf())
2422 TU.first->setSkeleton(constructSkeletonTU(*TU.first));
2423 InfoHolder.addUnit(std::move(TU.first));
2426 CU.addDIETypeSignature(RefDie, NewTU);
2429 void DwarfDebug::attachLowHighPC(DwarfCompileUnit &Unit, DIE &D,
2430 MCSymbol *Begin, MCSymbol *End) {
2431 assert(Begin && "Begin label should not be null!");
2432 assert(End && "End label should not be null!");
2433 assert(Begin->isDefined() && "Invalid starting label");
2434 assert(End->isDefined() && "Invalid end label");
2436 Unit.addLabelAddress(D, dwarf::DW_AT_low_pc, Begin);
2437 if (DwarfVersion < 4)
2438 Unit.addLabelAddress(D, dwarf::DW_AT_high_pc, End);
2440 Unit.addLabelDelta(D, dwarf::DW_AT_high_pc, End, Begin);
2443 // Accelerator table mutators - add each name along with its companion
2444 // DIE to the proper table while ensuring that the name that we're going
2445 // to reference is in the string table. We do this since the names we
2446 // add may not only be identical to the names in the DIE.
2447 void DwarfDebug::addAccelName(StringRef Name, const DIE &Die) {
2448 if (!useDwarfAccelTables())
2450 AccelNames.AddName(Name, InfoHolder.getStringPool().getSymbol(*Asm, Name),
2454 void DwarfDebug::addAccelObjC(StringRef Name, const DIE &Die) {
2455 if (!useDwarfAccelTables())
2457 AccelObjC.AddName(Name, InfoHolder.getStringPool().getSymbol(*Asm, Name),
2461 void DwarfDebug::addAccelNamespace(StringRef Name, const DIE &Die) {
2462 if (!useDwarfAccelTables())
2464 AccelNamespace.AddName(Name, InfoHolder.getStringPool().getSymbol(*Asm, Name),
2468 void DwarfDebug::addAccelType(StringRef Name, const DIE &Die, char Flags) {
2469 if (!useDwarfAccelTables())
2471 AccelTypes.AddName(Name, InfoHolder.getStringPool().getSymbol(*Asm, Name),