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 #define DEBUG_TYPE "dwarfdebug"
15 #include "DwarfDebug.h"
18 #include "DwarfAccelTable.h"
19 #include "DwarfCompileUnit.h"
20 #include "llvm/ADT/STLExtras.h"
21 #include "llvm/ADT/Statistic.h"
22 #include "llvm/ADT/StringExtras.h"
23 #include "llvm/ADT/Triple.h"
24 #include "llvm/CodeGen/MachineFunction.h"
25 #include "llvm/CodeGen/MachineModuleInfo.h"
26 #include "llvm/DIBuilder.h"
27 #include "llvm/DebugInfo.h"
28 #include "llvm/IR/Constants.h"
29 #include "llvm/IR/DataLayout.h"
30 #include "llvm/IR/Instructions.h"
31 #include "llvm/IR/Module.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/MD5.h"
42 #include "llvm/Support/Path.h"
43 #include "llvm/Support/Timer.h"
44 #include "llvm/Support/ValueHandle.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"
53 DisableDebugInfoPrinting("disable-debug-info-print", cl::Hidden,
54 cl::desc("Disable debug info printing"));
56 static cl::opt<bool> UnknownLocations(
57 "use-unknown-locations", cl::Hidden,
58 cl::desc("Make an absence of debug location information explicit."),
62 GenerateODRHash("generate-odr-hash", cl::Hidden,
63 cl::desc("Add an ODR hash to external type DIEs."),
66 static cl::opt<bool> GenerateCUHash("generate-cu-hash", cl::Hidden,
67 cl::desc("Add the CU hash as the dwo_id."),
71 GenerateGnuPubSections("generate-gnu-dwarf-pub-sections", cl::Hidden,
72 cl::desc("Generate GNU-style pubnames and pubtypes"),
83 static cl::opt<DefaultOnOff>
84 DwarfAccelTables("dwarf-accel-tables", cl::Hidden,
85 cl::desc("Output prototype dwarf accelerator tables."),
86 cl::values(clEnumVal(Default, "Default for platform"),
87 clEnumVal(Enable, "Enabled"),
88 clEnumVal(Disable, "Disabled"), clEnumValEnd),
91 static cl::opt<DefaultOnOff>
92 SplitDwarf("split-dwarf", cl::Hidden,
93 cl::desc("Output prototype dwarf split debug info."),
94 cl::values(clEnumVal(Default, "Default for platform"),
95 clEnumVal(Enable, "Enabled"),
96 clEnumVal(Disable, "Disabled"), clEnumValEnd),
99 static cl::opt<DefaultOnOff>
100 DwarfPubSections("generate-dwarf-pub-sections", cl::Hidden,
101 cl::desc("Generate DWARF pubnames and pubtypes sections"),
102 cl::values(clEnumVal(Default, "Default for platform"),
103 clEnumVal(Enable, "Enabled"),
104 clEnumVal(Disable, "Disabled"), clEnumValEnd),
107 static const char *const DWARFGroupName = "DWARF Emission";
108 static const char *const DbgTimerName = "DWARF Debug Writer";
110 //===----------------------------------------------------------------------===//
112 // Configuration values for initial hash set sizes (log2).
114 static const unsigned InitAbbreviationsSetSize = 9; // log2(512)
118 /// resolve - Look in the DwarfDebug map for the MDNode that
119 /// corresponds to the reference.
120 template <typename T> T DbgVariable::resolve(DIRef<T> Ref) const {
121 return DD->resolve(Ref);
124 DIType DbgVariable::getType() const {
125 DIType Ty = Var.getType();
126 // FIXME: isBlockByrefVariable should be reformulated in terms of complex
127 // addresses instead.
128 if (Var.isBlockByrefVariable()) {
129 /* Byref variables, in Blocks, are declared by the programmer as
130 "SomeType VarName;", but the compiler creates a
131 __Block_byref_x_VarName struct, and gives the variable VarName
132 either the struct, or a pointer to the struct, as its type. This
133 is necessary for various behind-the-scenes things the compiler
134 needs to do with by-reference variables in blocks.
136 However, as far as the original *programmer* is concerned, the
137 variable should still have type 'SomeType', as originally declared.
139 The following function dives into the __Block_byref_x_VarName
140 struct to find the original type of the variable. This will be
141 passed back to the code generating the type for the Debug
142 Information Entry for the variable 'VarName'. 'VarName' will then
143 have the original type 'SomeType' in its debug information.
145 The original type 'SomeType' will be the type of the field named
146 'VarName' inside the __Block_byref_x_VarName struct.
148 NOTE: In order for this to not completely fail on the debugger
149 side, the Debug Information Entry for the variable VarName needs to
150 have a DW_AT_location that tells the debugger how to unwind through
151 the pointers and __Block_byref_x_VarName struct to find the actual
152 value of the variable. The function addBlockByrefType does this. */
154 uint16_t tag = Ty.getTag();
156 if (tag == dwarf::DW_TAG_pointer_type)
157 subType = resolve(DIDerivedType(Ty).getTypeDerivedFrom());
159 DIArray Elements = DICompositeType(subType).getTypeArray();
160 for (unsigned i = 0, N = Elements.getNumElements(); i < N; ++i) {
161 DIDerivedType DT(Elements.getElement(i));
162 if (getName() == DT.getName())
163 return (resolve(DT.getTypeDerivedFrom()));
169 } // end llvm namespace
171 /// Return Dwarf Version by checking module flags.
172 static unsigned getDwarfVersionFromModule(const Module *M) {
173 Value *Val = M->getModuleFlag("Dwarf Version");
175 return dwarf::DWARF_VERSION;
176 return cast<ConstantInt>(Val)->getZExtValue();
179 DwarfDebug::DwarfDebug(AsmPrinter *A, Module *M)
180 : Asm(A), MMI(Asm->MMI), FirstCU(0),
181 AbbreviationsSet(InitAbbreviationsSetSize),
182 SourceIdMap(DIEValueAllocator), PrevLabel(NULL), GlobalCUIndexCount(0),
183 InfoHolder(A, &AbbreviationsSet, Abbreviations, "info_string",
185 SkeletonAbbrevSet(InitAbbreviationsSetSize),
186 SkeletonHolder(A, &SkeletonAbbrevSet, SkeletonAbbrevs, "skel_string",
189 DwarfInfoSectionSym = DwarfAbbrevSectionSym = 0;
190 DwarfStrSectionSym = TextSectionSym = 0;
191 DwarfDebugRangeSectionSym = DwarfDebugLocSectionSym = DwarfLineSectionSym = 0;
192 DwarfAddrSectionSym = 0;
193 DwarfAbbrevDWOSectionSym = DwarfStrDWOSectionSym = 0;
194 FunctionBeginSym = FunctionEndSym = 0;
196 // Turn on accelerator tables for Darwin by default, pubnames by
197 // default for non-Darwin, and handle split dwarf.
198 bool IsDarwin = Triple(A->getTargetTriple()).isOSDarwin();
200 if (DwarfAccelTables == Default)
201 HasDwarfAccelTables = IsDarwin;
203 HasDwarfAccelTables = DwarfAccelTables == Enable;
205 if (SplitDwarf == Default)
206 HasSplitDwarf = false;
208 HasSplitDwarf = SplitDwarf == Enable;
210 if (DwarfPubSections == Default)
211 HasDwarfPubSections = !IsDarwin;
213 HasDwarfPubSections = DwarfPubSections == Enable;
215 DwarfVersion = getDwarfVersionFromModule(MMI->getModule());
218 NamedRegionTimer T(DbgTimerName, DWARFGroupName, TimePassesIsEnabled);
223 // Switch to the specified MCSection and emit an assembler
224 // temporary label to it if SymbolStem is specified.
225 static MCSymbol *emitSectionSym(AsmPrinter *Asm, const MCSection *Section,
226 const char *SymbolStem = 0) {
227 Asm->OutStreamer.SwitchSection(Section);
231 MCSymbol *TmpSym = Asm->GetTempSymbol(SymbolStem);
232 Asm->OutStreamer.EmitLabel(TmpSym);
236 MCSymbol *DwarfUnits::getStringPoolSym() {
237 return Asm->GetTempSymbol(StringPref);
240 MCSymbol *DwarfUnits::getStringPoolEntry(StringRef Str) {
241 std::pair<MCSymbol *, unsigned> &Entry =
242 StringPool.GetOrCreateValue(Str).getValue();
246 Entry.second = NextStringPoolNumber++;
247 return Entry.first = Asm->GetTempSymbol(StringPref, Entry.second);
250 unsigned DwarfUnits::getStringPoolIndex(StringRef Str) {
251 std::pair<MCSymbol *, unsigned> &Entry =
252 StringPool.GetOrCreateValue(Str).getValue();
256 Entry.second = NextStringPoolNumber++;
257 Entry.first = Asm->GetTempSymbol(StringPref, Entry.second);
261 unsigned DwarfUnits::getAddrPoolIndex(const MCSymbol *Sym) {
262 return getAddrPoolIndex(MCSymbolRefExpr::Create(Sym, Asm->OutContext));
265 unsigned DwarfUnits::getAddrPoolIndex(const MCExpr *Sym) {
266 std::pair<DenseMap<const MCExpr *, unsigned>::iterator, bool> P =
267 AddressPool.insert(std::make_pair(Sym, NextAddrPoolNumber));
269 ++NextAddrPoolNumber;
270 return P.first->second;
273 // Define a unique number for the abbreviation.
275 void DwarfUnits::assignAbbrevNumber(DIEAbbrev &Abbrev) {
276 // Check the set for priors.
277 DIEAbbrev *InSet = AbbreviationsSet->GetOrInsertNode(&Abbrev);
279 // If it's newly added.
280 if (InSet == &Abbrev) {
281 // Add to abbreviation list.
282 Abbreviations.push_back(&Abbrev);
284 // Assign the vector position + 1 as its number.
285 Abbrev.setNumber(Abbreviations.size());
287 // Assign existing abbreviation number.
288 Abbrev.setNumber(InSet->getNumber());
292 static bool isObjCClass(StringRef Name) {
293 return Name.startswith("+") || Name.startswith("-");
296 static bool hasObjCCategory(StringRef Name) {
297 if (!isObjCClass(Name))
300 return Name.find(") ") != StringRef::npos;
303 static void getObjCClassCategory(StringRef In, StringRef &Class,
304 StringRef &Category) {
305 if (!hasObjCCategory(In)) {
306 Class = In.slice(In.find('[') + 1, In.find(' '));
311 Class = In.slice(In.find('[') + 1, In.find('('));
312 Category = In.slice(In.find('[') + 1, In.find(' '));
316 static StringRef getObjCMethodName(StringRef In) {
317 return In.slice(In.find(' ') + 1, In.find(']'));
320 // Helper for sorting sections into a stable output order.
321 static bool SectionSort(const MCSection *A, const MCSection *B) {
322 std::string LA = (A ? A->getLabelBeginName() : "");
323 std::string LB = (B ? B->getLabelBeginName() : "");
327 // Add the various names to the Dwarf accelerator table names.
328 // TODO: Determine whether or not we should add names for programs
329 // that do not have a DW_AT_name or DW_AT_linkage_name field - this
330 // is only slightly different than the lookup of non-standard ObjC names.
331 static void addSubprogramNames(CompileUnit *TheCU, DISubprogram SP, DIE *Die) {
332 if (!SP.isDefinition())
334 TheCU->addAccelName(SP.getName(), Die);
336 // If the linkage name is different than the name, go ahead and output
337 // that as well into the name table.
338 if (SP.getLinkageName() != "" && SP.getName() != SP.getLinkageName())
339 TheCU->addAccelName(SP.getLinkageName(), Die);
341 // If this is an Objective-C selector name add it to the ObjC accelerator
343 if (isObjCClass(SP.getName())) {
344 StringRef Class, Category;
345 getObjCClassCategory(SP.getName(), Class, Category);
346 TheCU->addAccelObjC(Class, Die);
348 TheCU->addAccelObjC(Category, Die);
349 // Also add the base method name to the name table.
350 TheCU->addAccelName(getObjCMethodName(SP.getName()), Die);
354 /// isSubprogramContext - Return true if Context is either a subprogram
355 /// or another context nested inside a subprogram.
356 bool DwarfDebug::isSubprogramContext(const MDNode *Context) {
359 DIDescriptor D(Context);
360 if (D.isSubprogram())
363 return isSubprogramContext(resolve(DIType(Context).getContext()));
367 // Find DIE for the given subprogram and attach appropriate DW_AT_low_pc
368 // and DW_AT_high_pc attributes. If there are global variables in this
369 // scope then create and insert DIEs for these variables.
370 DIE *DwarfDebug::updateSubprogramScopeDIE(CompileUnit *SPCU, DISubprogram SP) {
371 DIE *SPDie = SPCU->getDIE(SP);
373 assert(SPDie && "Unable to find subprogram DIE!");
375 // If we're updating an abstract DIE, then we will be adding the children and
376 // object pointer later on. But what we don't want to do is process the
377 // concrete DIE twice.
378 if (DIE *AbsSPDIE = AbstractSPDies.lookup(SP)) {
379 // Pick up abstract subprogram DIE.
380 SPDie = SPCU->createAndAddDIE(dwarf::DW_TAG_subprogram, *SPCU->getCUDie());
381 SPCU->addDIEEntry(SPDie, dwarf::DW_AT_abstract_origin, AbsSPDIE);
383 DISubprogram SPDecl = SP.getFunctionDeclaration();
384 if (!SPDecl.isSubprogram()) {
385 // There is not any need to generate specification DIE for a function
386 // defined at compile unit level. If a function is defined inside another
387 // function then gdb prefers the definition at top level and but does not
388 // expect specification DIE in parent function. So avoid creating
389 // specification DIE for a function defined inside a function.
390 DIScope SPContext = resolve(SP.getContext());
391 if (SP.isDefinition() && !SPContext.isCompileUnit() &&
392 !SPContext.isFile() && !isSubprogramContext(SPContext)) {
393 SPCU->addFlag(SPDie, dwarf::DW_AT_declaration);
396 DICompositeType SPTy = SP.getType();
397 DIArray Args = SPTy.getTypeArray();
398 uint16_t SPTag = SPTy.getTag();
399 if (SPTag == dwarf::DW_TAG_subroutine_type)
400 for (unsigned i = 1, N = Args.getNumElements(); i < N; ++i) {
402 SPCU->createAndAddDIE(dwarf::DW_TAG_formal_parameter, *SPDie);
403 DIType ATy(Args.getElement(i));
404 SPCU->addType(Arg, ATy);
405 if (ATy.isArtificial())
406 SPCU->addFlag(Arg, dwarf::DW_AT_artificial);
407 if (ATy.isObjectPointer())
408 SPCU->addDIEEntry(SPDie, dwarf::DW_AT_object_pointer, Arg);
410 DIE *SPDeclDie = SPDie;
412 SPCU->createAndAddDIE(dwarf::DW_TAG_subprogram, *SPCU->getCUDie());
413 SPCU->addDIEEntry(SPDie, dwarf::DW_AT_specification, SPDeclDie);
418 SPCU->addLabelAddress(
419 SPDie, dwarf::DW_AT_low_pc,
420 Asm->GetTempSymbol("func_begin", Asm->getFunctionNumber()));
421 SPCU->addLabelAddress(
422 SPDie, dwarf::DW_AT_high_pc,
423 Asm->GetTempSymbol("func_end", Asm->getFunctionNumber()));
424 const TargetRegisterInfo *RI = Asm->TM.getRegisterInfo();
425 MachineLocation Location(RI->getFrameRegister(*Asm->MF));
426 SPCU->addAddress(SPDie, dwarf::DW_AT_frame_base, Location);
428 // Add name to the name table, we do this here because we're guaranteed
429 // to have concrete versions of our DW_TAG_subprogram nodes.
430 addSubprogramNames(SPCU, SP, SPDie);
435 /// Check whether we should create a DIE for the given Scope, return true
436 /// if we don't create a DIE (the corresponding DIE is null).
437 bool DwarfDebug::isLexicalScopeDIENull(LexicalScope *Scope) {
438 if (Scope->isAbstractScope())
441 // We don't create a DIE if there is no Range.
442 const SmallVectorImpl<InsnRange> &Ranges = Scope->getRanges();
446 if (Ranges.size() > 1)
449 // We don't create a DIE if we have a single Range and the end label
451 SmallVectorImpl<InsnRange>::const_iterator RI = Ranges.begin();
452 MCSymbol *End = getLabelAfterInsn(RI->second);
456 // Construct new DW_TAG_lexical_block for this scope and attach
457 // DW_AT_low_pc/DW_AT_high_pc labels.
458 DIE *DwarfDebug::constructLexicalScopeDIE(CompileUnit *TheCU,
459 LexicalScope *Scope) {
460 if (isLexicalScopeDIENull(Scope))
463 DIE *ScopeDIE = new DIE(dwarf::DW_TAG_lexical_block);
464 if (Scope->isAbstractScope())
467 const SmallVectorImpl<InsnRange> &Ranges = Scope->getRanges();
468 // If we have multiple ranges, emit them into the range section.
469 if (Ranges.size() > 1) {
470 // .debug_range section has not been laid out yet. Emit offset in
471 // .debug_range as a uint, size 4, for now. emitDIE will handle
472 // DW_AT_ranges appropriately.
473 TheCU->addUInt(ScopeDIE, dwarf::DW_AT_ranges, dwarf::DW_FORM_data4,
474 DebugRangeSymbols.size() *
475 Asm->getDataLayout().getPointerSize());
476 for (SmallVectorImpl<InsnRange>::const_iterator RI = Ranges.begin(),
479 DebugRangeSymbols.push_back(getLabelBeforeInsn(RI->first));
480 DebugRangeSymbols.push_back(getLabelAfterInsn(RI->second));
483 // Terminate the range list.
484 DebugRangeSymbols.push_back(NULL);
485 DebugRangeSymbols.push_back(NULL);
489 // Construct the address range for this DIE.
490 SmallVectorImpl<InsnRange>::const_iterator RI = Ranges.begin();
491 MCSymbol *Start = getLabelBeforeInsn(RI->first);
492 MCSymbol *End = getLabelAfterInsn(RI->second);
493 assert(End && "End label should not be null!");
495 assert(Start->isDefined() && "Invalid starting label for an inlined scope!");
496 assert(End->isDefined() && "Invalid end label for an inlined scope!");
498 TheCU->addLabelAddress(ScopeDIE, dwarf::DW_AT_low_pc, Start);
499 TheCU->addLabelAddress(ScopeDIE, dwarf::DW_AT_high_pc, End);
504 // This scope represents inlined body of a function. Construct DIE to
505 // represent this concrete inlined copy of the function.
506 DIE *DwarfDebug::constructInlinedScopeDIE(CompileUnit *TheCU,
507 LexicalScope *Scope) {
508 const SmallVectorImpl<InsnRange> &Ranges = Scope->getRanges();
509 assert(Ranges.empty() == false &&
510 "LexicalScope does not have instruction markers!");
512 if (!Scope->getScopeNode())
514 DIScope DS(Scope->getScopeNode());
515 DISubprogram InlinedSP = getDISubprogram(DS);
516 DIE *OriginDIE = TheCU->getDIE(InlinedSP);
518 DEBUG(dbgs() << "Unable to find original DIE for an inlined subprogram.");
522 DIE *ScopeDIE = new DIE(dwarf::DW_TAG_inlined_subroutine);
523 TheCU->addDIEEntry(ScopeDIE, dwarf::DW_AT_abstract_origin, OriginDIE);
525 if (Ranges.size() > 1) {
526 // .debug_range section has not been laid out yet. Emit offset in
527 // .debug_range as a uint, size 4, for now. emitDIE will handle
528 // DW_AT_ranges appropriately.
529 TheCU->addUInt(ScopeDIE, dwarf::DW_AT_ranges, dwarf::DW_FORM_data4,
530 DebugRangeSymbols.size() *
531 Asm->getDataLayout().getPointerSize());
532 for (SmallVectorImpl<InsnRange>::const_iterator RI = Ranges.begin(),
535 DebugRangeSymbols.push_back(getLabelBeforeInsn(RI->first));
536 DebugRangeSymbols.push_back(getLabelAfterInsn(RI->second));
538 DebugRangeSymbols.push_back(NULL);
539 DebugRangeSymbols.push_back(NULL);
541 SmallVectorImpl<InsnRange>::const_iterator RI = Ranges.begin();
542 MCSymbol *StartLabel = getLabelBeforeInsn(RI->first);
543 MCSymbol *EndLabel = getLabelAfterInsn(RI->second);
545 if (StartLabel == 0 || EndLabel == 0)
546 llvm_unreachable("Unexpected Start and End labels for an inlined scope!");
548 assert(StartLabel->isDefined() &&
549 "Invalid starting label for an inlined scope!");
550 assert(EndLabel->isDefined() && "Invalid end label for an inlined scope!");
552 TheCU->addLabelAddress(ScopeDIE, dwarf::DW_AT_low_pc, StartLabel);
553 TheCU->addLabelAddress(ScopeDIE, dwarf::DW_AT_high_pc, EndLabel);
556 InlinedSubprogramDIEs.insert(OriginDIE);
558 // Add the call site information to the DIE.
559 DILocation DL(Scope->getInlinedAt());
560 TheCU->addUInt(ScopeDIE, dwarf::DW_AT_call_file, None,
561 getOrCreateSourceID(DL.getFilename(), DL.getDirectory(),
562 TheCU->getUniqueID()));
563 TheCU->addUInt(ScopeDIE, dwarf::DW_AT_call_line, None, DL.getLineNumber());
565 // Add name to the name table, we do this here because we're guaranteed
566 // to have concrete versions of our DW_TAG_inlined_subprogram nodes.
567 addSubprogramNames(TheCU, InlinedSP, ScopeDIE);
572 DIE *DwarfDebug::createScopeChildrenDIE(CompileUnit *TheCU, LexicalScope *Scope,
573 SmallVectorImpl<DIE *> &Children) {
574 DIE *ObjectPointer = NULL;
576 // Collect arguments for current function.
577 if (LScopes.isCurrentFunctionScope(Scope))
578 for (unsigned i = 0, N = CurrentFnArguments.size(); i < N; ++i)
579 if (DbgVariable *ArgDV = CurrentFnArguments[i])
581 TheCU->constructVariableDIE(*ArgDV, Scope->isAbstractScope())) {
582 Children.push_back(Arg);
583 if (ArgDV->isObjectPointer())
587 // Collect lexical scope children first.
588 const SmallVectorImpl<DbgVariable *> &Variables =
589 ScopeVariables.lookup(Scope);
590 for (unsigned i = 0, N = Variables.size(); i < N; ++i)
591 if (DIE *Variable = TheCU->constructVariableDIE(*Variables[i],
592 Scope->isAbstractScope())) {
593 Children.push_back(Variable);
594 if (Variables[i]->isObjectPointer())
595 ObjectPointer = Variable;
597 const SmallVectorImpl<LexicalScope *> &Scopes = Scope->getChildren();
598 for (unsigned j = 0, M = Scopes.size(); j < M; ++j)
599 if (DIE *Nested = constructScopeDIE(TheCU, Scopes[j]))
600 Children.push_back(Nested);
601 return ObjectPointer;
604 // Construct a DIE for this scope.
605 DIE *DwarfDebug::constructScopeDIE(CompileUnit *TheCU, LexicalScope *Scope) {
606 if (!Scope || !Scope->getScopeNode())
609 DIScope DS(Scope->getScopeNode());
611 SmallVector<DIE *, 8> Children;
612 DIE *ObjectPointer = NULL;
613 bool ChildrenCreated = false;
615 // We try to create the scope DIE first, then the children DIEs. This will
616 // avoid creating un-used children then removing them later when we find out
617 // the scope DIE is null.
618 DIE *ScopeDIE = NULL;
619 if (Scope->getInlinedAt())
620 ScopeDIE = constructInlinedScopeDIE(TheCU, Scope);
621 else if (DS.isSubprogram()) {
622 ProcessedSPNodes.insert(DS);
623 if (Scope->isAbstractScope()) {
624 ScopeDIE = TheCU->getDIE(DS);
625 // Note down abstract DIE.
627 AbstractSPDies.insert(std::make_pair(DS, ScopeDIE));
629 ScopeDIE = updateSubprogramScopeDIE(TheCU, DISubprogram(DS));
631 // Early exit when we know the scope DIE is going to be null.
632 if (isLexicalScopeDIENull(Scope))
635 // We create children here when we know the scope DIE is not going to be
636 // null and the children will be added to the scope DIE.
637 ObjectPointer = createScopeChildrenDIE(TheCU, Scope, Children);
638 ChildrenCreated = true;
640 // There is no need to emit empty lexical block DIE.
641 std::pair<ImportedEntityMap::const_iterator,
642 ImportedEntityMap::const_iterator> Range =
644 ScopesWithImportedEntities.begin(),
645 ScopesWithImportedEntities.end(),
646 std::pair<const MDNode *, const MDNode *>(DS, (const MDNode *)0),
648 if (Children.empty() && Range.first == Range.second)
650 ScopeDIE = constructLexicalScopeDIE(TheCU, Scope);
651 assert(ScopeDIE && "Scope DIE should not be null.");
652 for (ImportedEntityMap::const_iterator i = Range.first; i != Range.second;
654 constructImportedEntityDIE(TheCU, i->second, ScopeDIE);
658 assert(Children.empty() &&
659 "We create children only when the scope DIE is not null.");
662 if (!ChildrenCreated)
663 // We create children when the scope DIE is not null.
664 ObjectPointer = createScopeChildrenDIE(TheCU, Scope, Children);
667 for (SmallVectorImpl<DIE *>::iterator I = Children.begin(),
670 ScopeDIE->addChild(*I);
672 if (DS.isSubprogram() && ObjectPointer != NULL)
673 TheCU->addDIEEntry(ScopeDIE, dwarf::DW_AT_object_pointer, ObjectPointer);
675 if (DS.isSubprogram())
676 TheCU->addPubTypes(DISubprogram(DS));
681 // Look up the source id with the given directory and source file names.
682 // If none currently exists, create a new id and insert it in the
683 // SourceIds map. This can update DirectoryNames and SourceFileNames maps
685 unsigned DwarfDebug::getOrCreateSourceID(StringRef FileName, StringRef DirName,
687 // If we use .loc in assembly, we can't separate .file entries according to
688 // compile units. Thus all files will belong to the default compile unit.
690 // FIXME: add a better feature test than hasRawTextSupport. Even better,
691 // extend .file to support this.
692 if (Asm->TM.hasMCUseLoc() && Asm->OutStreamer.hasRawTextSupport())
695 // If FE did not provide a file name, then assume stdin.
696 if (FileName.empty())
697 return getOrCreateSourceID("<stdin>", StringRef(), CUID);
699 // TODO: this might not belong here. See if we can factor this better.
700 if (DirName == CompilationDir)
703 // FileIDCUMap stores the current ID for the given compile unit.
704 unsigned SrcId = FileIDCUMap[CUID] + 1;
706 // We look up the CUID/file/dir by concatenating them with a zero byte.
707 SmallString<128> NamePair;
708 NamePair += utostr(CUID);
711 NamePair += '\0'; // Zero bytes are not allowed in paths.
712 NamePair += FileName;
714 StringMapEntry<unsigned> &Ent = SourceIdMap.GetOrCreateValue(NamePair, SrcId);
715 if (Ent.getValue() != SrcId)
716 return Ent.getValue();
718 FileIDCUMap[CUID] = SrcId;
719 // Print out a .file directive to specify files for .loc directives.
720 Asm->OutStreamer.EmitDwarfFileDirective(SrcId, DirName, FileName, CUID);
725 // Create new CompileUnit for the given metadata node with tag
726 // DW_TAG_compile_unit.
727 CompileUnit *DwarfDebug::constructCompileUnit(DICompileUnit DIUnit) {
728 StringRef FN = DIUnit.getFilename();
729 CompilationDir = DIUnit.getDirectory();
731 DIE *Die = new DIE(dwarf::DW_TAG_compile_unit);
732 CompileUnit *NewCU = new CompileUnit(GlobalCUIndexCount++, Die, DIUnit, Asm,
735 FileIDCUMap[NewCU->getUniqueID()] = 0;
736 // Call this to emit a .file directive if it wasn't emitted for the source
737 // file this CU comes from yet.
738 getOrCreateSourceID(FN, CompilationDir, NewCU->getUniqueID());
740 NewCU->addString(Die, dwarf::DW_AT_producer, DIUnit.getProducer());
741 NewCU->addUInt(Die, dwarf::DW_AT_language, dwarf::DW_FORM_data2,
742 DIUnit.getLanguage());
743 NewCU->addString(Die, dwarf::DW_AT_name, FN);
745 // 2.17.1 requires that we use DW_AT_low_pc for a single entry point
746 // into an entity. We're using 0 (or a NULL label) for this. For
747 // split dwarf it's in the skeleton CU so omit it here.
748 if (!useSplitDwarf())
749 NewCU->addLabelAddress(Die, dwarf::DW_AT_low_pc, NULL);
751 // Define start line table label for each Compile Unit.
752 MCSymbol *LineTableStartSym =
753 Asm->GetTempSymbol("line_table_start", NewCU->getUniqueID());
754 Asm->OutStreamer.getContext().setMCLineTableSymbol(LineTableStartSym,
755 NewCU->getUniqueID());
757 // Use a single line table if we are using .loc and generating assembly.
759 (Asm->TM.hasMCUseLoc() && Asm->OutStreamer.hasRawTextSupport()) ||
760 (NewCU->getUniqueID() == 0);
762 if (!useSplitDwarf()) {
763 // DW_AT_stmt_list is a offset of line number information for this
764 // compile unit in debug_line section. For split dwarf this is
765 // left in the skeleton CU and so not included.
766 // The line table entries are not always emitted in assembly, so it
767 // is not okay to use line_table_start here.
768 if (Asm->MAI->doesDwarfUseRelocationsAcrossSections())
769 NewCU->addLabel(Die, dwarf::DW_AT_stmt_list, dwarf::DW_FORM_sec_offset,
770 UseTheFirstCU ? Asm->GetTempSymbol("section_line")
771 : LineTableStartSym);
772 else if (UseTheFirstCU)
773 NewCU->addUInt(Die, dwarf::DW_AT_stmt_list, dwarf::DW_FORM_data4, 0);
775 NewCU->addDelta(Die, dwarf::DW_AT_stmt_list, dwarf::DW_FORM_data4,
776 LineTableStartSym, DwarfLineSectionSym);
778 // If we're using split dwarf the compilation dir is going to be in the
779 // skeleton CU and so we don't need to duplicate it here.
780 if (!CompilationDir.empty())
781 NewCU->addString(Die, dwarf::DW_AT_comp_dir, CompilationDir);
783 // Flags to let the linker know we have emitted new style pubnames. Only
784 // emit it here if we don't have a skeleton CU for split dwarf.
785 if (GenerateGnuPubSections) {
786 if (Asm->MAI->doesDwarfUseRelocationsAcrossSections())
788 Die, dwarf::DW_AT_GNU_pubnames, dwarf::DW_FORM_sec_offset,
789 Asm->GetTempSymbol("gnu_pubnames", NewCU->getUniqueID()));
792 Die, dwarf::DW_AT_GNU_pubnames, dwarf::DW_FORM_data4,
793 Asm->GetTempSymbol("gnu_pubnames", NewCU->getUniqueID()),
794 DwarfGnuPubNamesSectionSym);
796 if (Asm->MAI->doesDwarfUseRelocationsAcrossSections())
798 Die, dwarf::DW_AT_GNU_pubtypes, dwarf::DW_FORM_sec_offset,
799 Asm->GetTempSymbol("gnu_pubtypes", NewCU->getUniqueID()));
802 Die, dwarf::DW_AT_GNU_pubtypes, dwarf::DW_FORM_data4,
803 Asm->GetTempSymbol("gnu_pubtypes", NewCU->getUniqueID()),
804 DwarfGnuPubTypesSectionSym);
808 if (DIUnit.isOptimized())
809 NewCU->addFlag(Die, dwarf::DW_AT_APPLE_optimized);
811 StringRef Flags = DIUnit.getFlags();
813 NewCU->addString(Die, dwarf::DW_AT_APPLE_flags, Flags);
815 if (unsigned RVer = DIUnit.getRunTimeVersion())
816 NewCU->addUInt(Die, dwarf::DW_AT_APPLE_major_runtime_vers,
817 dwarf::DW_FORM_data1, RVer);
822 InfoHolder.addUnit(NewCU);
824 CUMap.insert(std::make_pair(DIUnit, NewCU));
825 CUDieMap.insert(std::make_pair(Die, NewCU));
829 // Construct subprogram DIE.
830 void DwarfDebug::constructSubprogramDIE(CompileUnit *TheCU, const MDNode *N) {
831 // FIXME: We should only call this routine once, however, during LTO if a
832 // program is defined in multiple CUs we could end up calling it out of
833 // beginModule as we walk the CUs.
835 CompileUnit *&CURef = SPMap[N];
841 if (!SP.isDefinition())
842 // This is a method declaration which will be handled while constructing
846 DIE *SubprogramDie = TheCU->getOrCreateSubprogramDIE(SP);
848 // Expose as a global name.
849 TheCU->addGlobalName(SP.getName(), SubprogramDie, resolve(SP.getContext()));
852 void DwarfDebug::constructImportedEntityDIE(CompileUnit *TheCU,
854 DIImportedEntity Module(N);
855 if (!Module.Verify())
857 if (DIE *D = TheCU->getOrCreateContextDIE(Module.getContext()))
858 constructImportedEntityDIE(TheCU, Module, D);
861 void DwarfDebug::constructImportedEntityDIE(CompileUnit *TheCU, const MDNode *N,
863 DIImportedEntity Module(N);
864 if (!Module.Verify())
866 return constructImportedEntityDIE(TheCU, Module, Context);
869 void DwarfDebug::constructImportedEntityDIE(CompileUnit *TheCU,
870 const DIImportedEntity &Module,
872 assert(Module.Verify() &&
873 "Use one of the MDNode * overloads to handle invalid metadata");
874 assert(Context && "Should always have a context for an imported_module");
875 DIE *IMDie = new DIE(Module.getTag());
876 TheCU->insertDIE(Module, IMDie);
878 DIDescriptor Entity = Module.getEntity();
879 if (Entity.isNameSpace())
880 EntityDie = TheCU->getOrCreateNameSpace(DINameSpace(Entity));
881 else if (Entity.isSubprogram())
882 EntityDie = TheCU->getOrCreateSubprogramDIE(DISubprogram(Entity));
883 else if (Entity.isType())
884 EntityDie = TheCU->getOrCreateTypeDIE(DIType(Entity));
886 EntityDie = TheCU->getDIE(Entity);
887 unsigned FileID = getOrCreateSourceID(Module.getContext().getFilename(),
888 Module.getContext().getDirectory(),
889 TheCU->getUniqueID());
890 TheCU->addUInt(IMDie, dwarf::DW_AT_decl_file, None, FileID);
891 TheCU->addUInt(IMDie, dwarf::DW_AT_decl_line, None, Module.getLineNumber());
892 TheCU->addDIEEntry(IMDie, dwarf::DW_AT_import, EntityDie);
893 StringRef Name = Module.getName();
895 TheCU->addString(IMDie, dwarf::DW_AT_name, Name);
896 Context->addChild(IMDie);
899 // Emit all Dwarf sections that should come prior to the content. Create
900 // global DIEs and emit initial debug info sections. This is invoked by
901 // the target AsmPrinter.
902 void DwarfDebug::beginModule() {
903 if (DisableDebugInfoPrinting)
906 const Module *M = MMI->getModule();
908 // If module has named metadata anchors then use them, otherwise scan the
909 // module using debug info finder to collect debug info.
910 NamedMDNode *CU_Nodes = M->getNamedMetadata("llvm.dbg.cu");
913 TypeIdentifierMap = generateDITypeIdentifierMap(CU_Nodes);
915 // Emit initial sections so we can reference labels later.
918 for (unsigned i = 0, e = CU_Nodes->getNumOperands(); i != e; ++i) {
919 DICompileUnit CUNode(CU_Nodes->getOperand(i));
920 CompileUnit *CU = constructCompileUnit(CUNode);
921 DIArray ImportedEntities = CUNode.getImportedEntities();
922 for (unsigned i = 0, e = ImportedEntities.getNumElements(); i != e; ++i)
923 ScopesWithImportedEntities.push_back(std::make_pair(
924 DIImportedEntity(ImportedEntities.getElement(i)).getContext(),
925 ImportedEntities.getElement(i)));
926 std::sort(ScopesWithImportedEntities.begin(),
927 ScopesWithImportedEntities.end(), less_first());
928 DIArray GVs = CUNode.getGlobalVariables();
929 for (unsigned i = 0, e = GVs.getNumElements(); i != e; ++i)
930 CU->createGlobalVariableDIE(DIGlobalVariable(GVs.getElement(i)));
931 DIArray SPs = CUNode.getSubprograms();
932 for (unsigned i = 0, e = SPs.getNumElements(); i != e; ++i)
933 constructSubprogramDIE(CU, SPs.getElement(i));
934 DIArray EnumTypes = CUNode.getEnumTypes();
935 for (unsigned i = 0, e = EnumTypes.getNumElements(); i != e; ++i)
936 CU->getOrCreateTypeDIE(EnumTypes.getElement(i));
937 DIArray RetainedTypes = CUNode.getRetainedTypes();
938 for (unsigned i = 0, e = RetainedTypes.getNumElements(); i != e; ++i)
939 CU->getOrCreateTypeDIE(RetainedTypes.getElement(i));
940 // Emit imported_modules last so that the relevant context is already
942 for (unsigned i = 0, e = ImportedEntities.getNumElements(); i != e; ++i)
943 constructImportedEntityDIE(CU, ImportedEntities.getElement(i));
946 // Tell MMI that we have debug info.
947 MMI->setDebugInfoAvailability(true);
949 // Prime section data.
950 SectionMap[Asm->getObjFileLowering().getTextSection()];
953 // Attach DW_AT_inline attribute with inlined subprogram DIEs.
954 void DwarfDebug::computeInlinedDIEs() {
955 // Attach DW_AT_inline attribute with inlined subprogram DIEs.
956 for (SmallPtrSet<DIE *, 4>::iterator AI = InlinedSubprogramDIEs.begin(),
957 AE = InlinedSubprogramDIEs.end();
960 FirstCU->addUInt(ISP, dwarf::DW_AT_inline, None, dwarf::DW_INL_inlined);
962 for (DenseMap<const MDNode *, DIE *>::iterator AI = AbstractSPDies.begin(),
963 AE = AbstractSPDies.end();
965 DIE *ISP = AI->second;
966 if (InlinedSubprogramDIEs.count(ISP))
968 FirstCU->addUInt(ISP, dwarf::DW_AT_inline, None, dwarf::DW_INL_inlined);
972 // Collect info for variables that were optimized out.
973 void DwarfDebug::collectDeadVariables() {
974 const Module *M = MMI->getModule();
976 if (NamedMDNode *CU_Nodes = M->getNamedMetadata("llvm.dbg.cu")) {
977 for (unsigned i = 0, e = CU_Nodes->getNumOperands(); i != e; ++i) {
978 DICompileUnit TheCU(CU_Nodes->getOperand(i));
979 DIArray Subprograms = TheCU.getSubprograms();
980 for (unsigned i = 0, e = Subprograms.getNumElements(); i != e; ++i) {
981 DISubprogram SP(Subprograms.getElement(i));
982 if (ProcessedSPNodes.count(SP) != 0)
984 if (!SP.isSubprogram())
986 if (!SP.isDefinition())
988 DIArray Variables = SP.getVariables();
989 if (Variables.getNumElements() == 0)
992 // Construct subprogram DIE and add variables DIEs.
993 CompileUnit *SPCU = CUMap.lookup(TheCU);
994 assert(SPCU && "Unable to find Compile Unit!");
995 // FIXME: See the comment in constructSubprogramDIE about duplicate
997 constructSubprogramDIE(SPCU, SP);
998 DIE *SPDIE = SPCU->getDIE(SP);
999 for (unsigned vi = 0, ve = Variables.getNumElements(); vi != ve; ++vi) {
1000 DIVariable DV(Variables.getElement(vi));
1001 if (!DV.isVariable())
1003 DbgVariable NewVar(DV, NULL, this);
1004 if (DIE *VariableDIE = SPCU->constructVariableDIE(NewVar, false))
1005 SPDIE->addChild(VariableDIE);
1012 // Type Signature [7.27] and ODR Hash code.
1014 /// \brief Grabs the string in whichever attribute is passed in and returns
1015 /// a reference to it. Returns "" if the attribute doesn't exist.
1016 static StringRef getDIEStringAttr(DIE *Die, unsigned Attr) {
1017 DIEValue *V = Die->findAttribute(Attr);
1019 if (DIEString *S = dyn_cast_or_null<DIEString>(V))
1020 return S->getString();
1022 return StringRef("");
1025 /// Return true if the current DIE is contained within an anonymous namespace.
1026 static bool isContainedInAnonNamespace(DIE *Die) {
1027 DIE *Parent = Die->getParent();
1030 if (Parent->getTag() == dwarf::DW_TAG_namespace &&
1031 getDIEStringAttr(Parent, dwarf::DW_AT_name) == "")
1033 Parent = Parent->getParent();
1039 /// Test if the current CU language is C++ and that we have
1040 /// a named type that is not contained in an anonymous namespace.
1041 static bool shouldAddODRHash(CompileUnit *CU, DIE *Die) {
1042 return CU->getLanguage() == dwarf::DW_LANG_C_plus_plus &&
1043 getDIEStringAttr(Die, dwarf::DW_AT_name) != "" &&
1044 !isContainedInAnonNamespace(Die);
1047 void DwarfDebug::finalizeModuleInfo() {
1048 // Collect info for variables that were optimized out.
1049 collectDeadVariables();
1051 // Attach DW_AT_inline attribute with inlined subprogram DIEs.
1052 computeInlinedDIEs();
1054 // Handle anything that needs to be done on a per-cu basis.
1055 for (DenseMap<const MDNode *, CompileUnit *>::iterator CUI = CUMap.begin(),
1057 CUI != CUE; ++CUI) {
1058 CompileUnit *TheCU = CUI->second;
1059 // Emit DW_AT_containing_type attribute to connect types with their
1060 // vtable holding type.
1061 TheCU->constructContainingTypeDIEs();
1063 // If we're splitting the dwarf out now that we've got the entire
1064 // CU then construct a skeleton CU based upon it.
1065 if (useSplitDwarf()) {
1067 if (GenerateCUHash) {
1069 ID = CUHash.computeCUSignature(*TheCU->getCUDie());
1071 // This should be a unique identifier when we want to build .dwp files.
1072 TheCU->addUInt(TheCU->getCUDie(), dwarf::DW_AT_GNU_dwo_id,
1073 dwarf::DW_FORM_data8, ID);
1074 // Now construct the skeleton CU associated.
1075 CompileUnit *SkCU = constructSkeletonCU(TheCU);
1076 // This should be a unique identifier when we want to build .dwp files.
1077 SkCU->addUInt(SkCU->getCUDie(), dwarf::DW_AT_GNU_dwo_id,
1078 dwarf::DW_FORM_data8, ID);
1082 // Compute DIE offsets and sizes.
1083 InfoHolder.computeSizeAndOffsets();
1084 if (useSplitDwarf())
1085 SkeletonHolder.computeSizeAndOffsets();
1088 void DwarfDebug::endSections() {
1089 // Filter labels by section.
1090 for (size_t n = 0; n < ArangeLabels.size(); n++) {
1091 const SymbolCU &SCU = ArangeLabels[n];
1092 if (SCU.Sym->isInSection()) {
1093 // Make a note of this symbol and it's section.
1094 const MCSection *Section = &SCU.Sym->getSection();
1095 if (!Section->getKind().isMetadata())
1096 SectionMap[Section].push_back(SCU);
1098 // Some symbols (e.g. common/bss on mach-o) can have no section but still
1099 // appear in the output. This sucks as we rely on sections to build
1100 // arange spans. We can do it without, but it's icky.
1101 SectionMap[NULL].push_back(SCU);
1105 // Build a list of sections used.
1106 std::vector<const MCSection *> Sections;
1107 for (SectionMapType::iterator it = SectionMap.begin(); it != SectionMap.end();
1109 const MCSection *Section = it->first;
1110 Sections.push_back(Section);
1113 // Sort the sections into order.
1114 // This is only done to ensure consistent output order across different runs.
1115 std::sort(Sections.begin(), Sections.end(), SectionSort);
1117 // Add terminating symbols for each section.
1118 for (unsigned ID = 0; ID < Sections.size(); ID++) {
1119 const MCSection *Section = Sections[ID];
1120 MCSymbol *Sym = NULL;
1123 // We can't call MCSection::getLabelEndName, as it's only safe to do so
1124 // if we know the section name up-front. For user-created sections, the
1126 // label may not be valid to use as a label. (section names can use a
1128 // set of characters on some systems)
1129 Sym = Asm->GetTempSymbol("debug_end", ID);
1130 Asm->OutStreamer.SwitchSection(Section);
1131 Asm->OutStreamer.EmitLabel(Sym);
1134 // Insert a final terminator.
1135 SectionMap[Section].push_back(SymbolCU(NULL, Sym));
1139 // Emit all Dwarf sections that should come after the content.
1140 void DwarfDebug::endModule() {
1145 // End any existing sections.
1146 // TODO: Does this need to happen?
1149 // Finalize the debug info for the module.
1150 finalizeModuleInfo();
1154 // Emit all the DIEs into a debug info section.
1157 // Corresponding abbreviations into a abbrev section.
1158 emitAbbreviations();
1160 // Emit info into a debug loc section.
1163 // Emit info into a debug aranges section.
1166 // Emit info into a debug ranges section.
1169 // Emit info into a debug macinfo section.
1172 if (useSplitDwarf()) {
1175 emitDebugAbbrevDWO();
1176 // Emit DWO addresses.
1177 InfoHolder.emitAddresses(Asm->getObjFileLowering().getDwarfAddrSection());
1180 // Emit info into the dwarf accelerator table sections.
1181 if (useDwarfAccelTables()) {
1184 emitAccelNamespaces();
1188 // Emit the pubnames and pubtypes sections if requested.
1189 if (HasDwarfPubSections) {
1190 emitDebugPubNames(GenerateGnuPubSections);
1191 emitDebugPubTypes(GenerateGnuPubSections);
1196 for (DenseMap<const MDNode *, CompileUnit *>::iterator I = CUMap.begin(),
1201 for (SmallVectorImpl<CompileUnit *>::iterator I = SkeletonCUs.begin(),
1202 E = SkeletonCUs.end();
1206 // Reset these for the next Module if we have one.
1210 // Find abstract variable, if any, associated with Var.
1211 DbgVariable *DwarfDebug::findAbstractVariable(DIVariable &DV,
1212 DebugLoc ScopeLoc) {
1213 LLVMContext &Ctx = DV->getContext();
1214 // More then one inlined variable corresponds to one abstract variable.
1215 DIVariable Var = cleanseInlinedVariable(DV, Ctx);
1216 DbgVariable *AbsDbgVariable = AbstractVariables.lookup(Var);
1218 return AbsDbgVariable;
1220 LexicalScope *Scope = LScopes.findAbstractScope(ScopeLoc.getScope(Ctx));
1224 AbsDbgVariable = new DbgVariable(Var, NULL, this);
1225 addScopeVariable(Scope, AbsDbgVariable);
1226 AbstractVariables[Var] = AbsDbgVariable;
1227 return AbsDbgVariable;
1230 // If Var is a current function argument then add it to CurrentFnArguments list.
1231 bool DwarfDebug::addCurrentFnArgument(const MachineFunction *MF,
1232 DbgVariable *Var, LexicalScope *Scope) {
1233 if (!LScopes.isCurrentFunctionScope(Scope))
1235 DIVariable DV = Var->getVariable();
1236 if (DV.getTag() != dwarf::DW_TAG_arg_variable)
1238 unsigned ArgNo = DV.getArgNumber();
1242 size_t Size = CurrentFnArguments.size();
1244 CurrentFnArguments.resize(MF->getFunction()->arg_size());
1245 // llvm::Function argument size is not good indicator of how many
1246 // arguments does the function have at source level.
1248 CurrentFnArguments.resize(ArgNo * 2);
1249 CurrentFnArguments[ArgNo - 1] = Var;
1253 // Collect variable information from side table maintained by MMI.
1254 void DwarfDebug::collectVariableInfoFromMMITable(
1255 const MachineFunction *MF, SmallPtrSet<const MDNode *, 16> &Processed) {
1256 MachineModuleInfo::VariableDbgInfoMapTy &VMap = MMI->getVariableDbgInfo();
1257 for (MachineModuleInfo::VariableDbgInfoMapTy::iterator VI = VMap.begin(),
1260 const MDNode *Var = VI->first;
1263 Processed.insert(Var);
1265 const std::pair<unsigned, DebugLoc> &VP = VI->second;
1267 LexicalScope *Scope = LScopes.findLexicalScope(VP.second);
1269 // If variable scope is not found then skip this variable.
1273 DbgVariable *AbsDbgVariable = findAbstractVariable(DV, VP.second);
1274 DbgVariable *RegVar = new DbgVariable(DV, AbsDbgVariable, this);
1275 RegVar->setFrameIndex(VP.first);
1276 if (!addCurrentFnArgument(MF, RegVar, Scope))
1277 addScopeVariable(Scope, RegVar);
1279 AbsDbgVariable->setFrameIndex(VP.first);
1283 // Return true if debug value, encoded by DBG_VALUE instruction, is in a
1285 static bool isDbgValueInDefinedReg(const MachineInstr *MI) {
1286 assert(MI->isDebugValue() && "Invalid DBG_VALUE machine instruction!");
1287 return MI->getNumOperands() == 3 && MI->getOperand(0).isReg() &&
1288 MI->getOperand(0).getReg() &&
1289 (MI->getOperand(1).isImm() ||
1290 (MI->getOperand(1).isReg() && MI->getOperand(1).getReg() == 0U));
1293 // Get .debug_loc entry for the instruction range starting at MI.
1294 static DotDebugLocEntry getDebugLocEntry(AsmPrinter *Asm,
1295 const MCSymbol *FLabel,
1296 const MCSymbol *SLabel,
1297 const MachineInstr *MI) {
1298 const MDNode *Var = MI->getOperand(MI->getNumOperands() - 1).getMetadata();
1300 assert(MI->getNumOperands() == 3);
1301 if (MI->getOperand(0).isReg()) {
1302 MachineLocation MLoc;
1303 // If the second operand is an immediate, this is a
1304 // register-indirect address.
1305 if (!MI->getOperand(1).isImm())
1306 MLoc.set(MI->getOperand(0).getReg());
1308 MLoc.set(MI->getOperand(0).getReg(), MI->getOperand(1).getImm());
1309 return DotDebugLocEntry(FLabel, SLabel, MLoc, Var);
1311 if (MI->getOperand(0).isImm())
1312 return DotDebugLocEntry(FLabel, SLabel, MI->getOperand(0).getImm());
1313 if (MI->getOperand(0).isFPImm())
1314 return DotDebugLocEntry(FLabel, SLabel, MI->getOperand(0).getFPImm());
1315 if (MI->getOperand(0).isCImm())
1316 return DotDebugLocEntry(FLabel, SLabel, MI->getOperand(0).getCImm());
1318 llvm_unreachable("Unexpected 3 operand DBG_VALUE instruction!");
1321 // Find variables for each lexical scope.
1323 DwarfDebug::collectVariableInfo(const MachineFunction *MF,
1324 SmallPtrSet<const MDNode *, 16> &Processed) {
1326 // Grab the variable info that was squirreled away in the MMI side-table.
1327 collectVariableInfoFromMMITable(MF, Processed);
1329 for (SmallVectorImpl<const MDNode *>::const_iterator
1330 UVI = UserVariables.begin(),
1331 UVE = UserVariables.end();
1332 UVI != UVE; ++UVI) {
1333 const MDNode *Var = *UVI;
1334 if (Processed.count(Var))
1337 // History contains relevant DBG_VALUE instructions for Var and instructions
1339 SmallVectorImpl<const MachineInstr *> &History = DbgValues[Var];
1340 if (History.empty())
1342 const MachineInstr *MInsn = History.front();
1345 LexicalScope *Scope = NULL;
1346 if (DV.getTag() == dwarf::DW_TAG_arg_variable &&
1347 DISubprogram(DV.getContext()).describes(MF->getFunction()))
1348 Scope = LScopes.getCurrentFunctionScope();
1349 else if (MDNode *IA = DV.getInlinedAt())
1350 Scope = LScopes.findInlinedScope(DebugLoc::getFromDILocation(IA));
1352 Scope = LScopes.findLexicalScope(cast<MDNode>(DV->getOperand(1)));
1353 // If variable scope is not found then skip this variable.
1357 Processed.insert(DV);
1358 assert(MInsn->isDebugValue() && "History must begin with debug value");
1359 DbgVariable *AbsVar = findAbstractVariable(DV, MInsn->getDebugLoc());
1360 DbgVariable *RegVar = new DbgVariable(DV, AbsVar, this);
1361 if (!addCurrentFnArgument(MF, RegVar, Scope))
1362 addScopeVariable(Scope, RegVar);
1364 AbsVar->setMInsn(MInsn);
1366 // Simplify ranges that are fully coalesced.
1367 if (History.size() <= 1 ||
1368 (History.size() == 2 && MInsn->isIdenticalTo(History.back()))) {
1369 RegVar->setMInsn(MInsn);
1373 // Handle multiple DBG_VALUE instructions describing one variable.
1374 RegVar->setDotDebugLocOffset(DotDebugLocEntries.size());
1376 for (SmallVectorImpl<const MachineInstr *>::const_iterator
1377 HI = History.begin(),
1380 const MachineInstr *Begin = *HI;
1381 assert(Begin->isDebugValue() && "Invalid History entry");
1383 // Check if DBG_VALUE is truncating a range.
1384 if (Begin->getNumOperands() > 1 && Begin->getOperand(0).isReg() &&
1385 !Begin->getOperand(0).getReg())
1388 // Compute the range for a register location.
1389 const MCSymbol *FLabel = getLabelBeforeInsn(Begin);
1390 const MCSymbol *SLabel = 0;
1393 // If Begin is the last instruction in History then its value is valid
1394 // until the end of the function.
1395 SLabel = FunctionEndSym;
1397 const MachineInstr *End = HI[1];
1398 DEBUG(dbgs() << "DotDebugLoc Pair:\n"
1399 << "\t" << *Begin << "\t" << *End << "\n");
1400 if (End->isDebugValue())
1401 SLabel = getLabelBeforeInsn(End);
1403 // End is a normal instruction clobbering the range.
1404 SLabel = getLabelAfterInsn(End);
1405 assert(SLabel && "Forgot label after clobber instruction");
1410 // The value is valid until the next DBG_VALUE or clobber.
1411 DotDebugLocEntries.push_back(
1412 getDebugLocEntry(Asm, FLabel, SLabel, Begin));
1414 DotDebugLocEntries.push_back(DotDebugLocEntry());
1417 // Collect info for variables that were optimized out.
1418 LexicalScope *FnScope = LScopes.getCurrentFunctionScope();
1419 DIArray Variables = DISubprogram(FnScope->getScopeNode()).getVariables();
1420 for (unsigned i = 0, e = Variables.getNumElements(); i != e; ++i) {
1421 DIVariable DV(Variables.getElement(i));
1422 if (!DV || !DV.isVariable() || !Processed.insert(DV))
1424 if (LexicalScope *Scope = LScopes.findLexicalScope(DV.getContext()))
1425 addScopeVariable(Scope, new DbgVariable(DV, NULL, this));
1429 // Return Label preceding the instruction.
1430 MCSymbol *DwarfDebug::getLabelBeforeInsn(const MachineInstr *MI) {
1431 MCSymbol *Label = LabelsBeforeInsn.lookup(MI);
1432 assert(Label && "Didn't insert label before instruction");
1436 // Return Label immediately following the instruction.
1437 MCSymbol *DwarfDebug::getLabelAfterInsn(const MachineInstr *MI) {
1438 return LabelsAfterInsn.lookup(MI);
1441 // Process beginning of an instruction.
1442 void DwarfDebug::beginInstruction(const MachineInstr *MI) {
1443 // Check if source location changes, but ignore DBG_VALUE locations.
1444 if (!MI->isDebugValue()) {
1445 DebugLoc DL = MI->getDebugLoc();
1446 if (DL != PrevInstLoc && (!DL.isUnknown() || UnknownLocations)) {
1449 if (DL == PrologEndLoc) {
1450 Flags |= DWARF2_FLAG_PROLOGUE_END;
1451 PrologEndLoc = DebugLoc();
1453 if (PrologEndLoc.isUnknown())
1454 Flags |= DWARF2_FLAG_IS_STMT;
1456 if (!DL.isUnknown()) {
1457 const MDNode *Scope = DL.getScope(Asm->MF->getFunction()->getContext());
1458 recordSourceLine(DL.getLine(), DL.getCol(), Scope, Flags);
1460 recordSourceLine(0, 0, 0, 0);
1464 // Insert labels where requested.
1465 DenseMap<const MachineInstr *, MCSymbol *>::iterator I =
1466 LabelsBeforeInsn.find(MI);
1469 if (I == LabelsBeforeInsn.end())
1472 // Label already assigned.
1477 PrevLabel = MMI->getContext().CreateTempSymbol();
1478 Asm->OutStreamer.EmitLabel(PrevLabel);
1480 I->second = PrevLabel;
1483 // Process end of an instruction.
1484 void DwarfDebug::endInstruction(const MachineInstr *MI) {
1485 // Don't create a new label after DBG_VALUE instructions.
1486 // They don't generate code.
1487 if (!MI->isDebugValue())
1490 DenseMap<const MachineInstr *, MCSymbol *>::iterator I =
1491 LabelsAfterInsn.find(MI);
1494 if (I == LabelsAfterInsn.end())
1497 // Label already assigned.
1501 // We need a label after this instruction.
1503 PrevLabel = MMI->getContext().CreateTempSymbol();
1504 Asm->OutStreamer.EmitLabel(PrevLabel);
1506 I->second = PrevLabel;
1509 // Each LexicalScope has first instruction and last instruction to mark
1510 // beginning and end of a scope respectively. Create an inverse map that list
1511 // scopes starts (and ends) with an instruction. One instruction may start (or
1512 // end) multiple scopes. Ignore scopes that are not reachable.
1513 void DwarfDebug::identifyScopeMarkers() {
1514 SmallVector<LexicalScope *, 4> WorkList;
1515 WorkList.push_back(LScopes.getCurrentFunctionScope());
1516 while (!WorkList.empty()) {
1517 LexicalScope *S = WorkList.pop_back_val();
1519 const SmallVectorImpl<LexicalScope *> &Children = S->getChildren();
1520 if (!Children.empty())
1521 for (SmallVectorImpl<LexicalScope *>::const_iterator
1522 SI = Children.begin(),
1523 SE = Children.end();
1525 WorkList.push_back(*SI);
1527 if (S->isAbstractScope())
1530 const SmallVectorImpl<InsnRange> &Ranges = S->getRanges();
1533 for (SmallVectorImpl<InsnRange>::const_iterator RI = Ranges.begin(),
1536 assert(RI->first && "InsnRange does not have first instruction!");
1537 assert(RI->second && "InsnRange does not have second instruction!");
1538 requestLabelBeforeInsn(RI->first);
1539 requestLabelAfterInsn(RI->second);
1544 // Get MDNode for DebugLoc's scope.
1545 static MDNode *getScopeNode(DebugLoc DL, const LLVMContext &Ctx) {
1546 if (MDNode *InlinedAt = DL.getInlinedAt(Ctx))
1547 return getScopeNode(DebugLoc::getFromDILocation(InlinedAt), Ctx);
1548 return DL.getScope(Ctx);
1551 // Walk up the scope chain of given debug loc and find line number info
1552 // for the function.
1553 static DebugLoc getFnDebugLoc(DebugLoc DL, const LLVMContext &Ctx) {
1554 const MDNode *Scope = getScopeNode(DL, Ctx);
1555 DISubprogram SP = getDISubprogram(Scope);
1556 if (SP.isSubprogram()) {
1557 // Check for number of operands since the compatibility is
1559 if (SP->getNumOperands() > 19)
1560 return DebugLoc::get(SP.getScopeLineNumber(), 0, SP);
1562 return DebugLoc::get(SP.getLineNumber(), 0, SP);
1568 // Gather pre-function debug information. Assumes being called immediately
1569 // after the function entry point has been emitted.
1570 void DwarfDebug::beginFunction(const MachineFunction *MF) {
1572 // If there's no debug info for the function we're not going to do anything.
1573 if (!MMI->hasDebugInfo())
1576 // Grab the lexical scopes for the function, if we don't have any of those
1577 // then we're not going to be able to do anything.
1578 LScopes.initialize(*MF);
1579 if (LScopes.empty())
1582 assert(UserVariables.empty() && DbgValues.empty() && "Maps weren't cleaned");
1584 // Make sure that each lexical scope will have a begin/end label.
1585 identifyScopeMarkers();
1587 // Set DwarfCompileUnitID in MCContext to the Compile Unit this function
1588 // belongs to so that we add to the correct per-cu line table in the
1590 LexicalScope *FnScope = LScopes.getCurrentFunctionScope();
1591 CompileUnit *TheCU = SPMap.lookup(FnScope->getScopeNode());
1592 assert(TheCU && "Unable to find compile unit!");
1593 if (Asm->TM.hasMCUseLoc() && Asm->OutStreamer.hasRawTextSupport())
1594 // Use a single line table if we are using .loc and generating assembly.
1595 Asm->OutStreamer.getContext().setDwarfCompileUnitID(0);
1597 Asm->OutStreamer.getContext().setDwarfCompileUnitID(TheCU->getUniqueID());
1599 // Emit a label for the function so that we have a beginning address.
1600 FunctionBeginSym = Asm->GetTempSymbol("func_begin", Asm->getFunctionNumber());
1601 // Assumes in correct section after the entry point.
1602 Asm->OutStreamer.EmitLabel(FunctionBeginSym);
1604 const TargetRegisterInfo *TRI = Asm->TM.getRegisterInfo();
1605 // LiveUserVar - Map physreg numbers to the MDNode they contain.
1606 std::vector<const MDNode *> LiveUserVar(TRI->getNumRegs());
1608 for (MachineFunction::const_iterator I = MF->begin(), E = MF->end(); I != E;
1610 bool AtBlockEntry = true;
1611 for (MachineBasicBlock::const_iterator II = I->begin(), IE = I->end();
1613 const MachineInstr *MI = II;
1615 if (MI->isDebugValue()) {
1616 assert(MI->getNumOperands() > 1 && "Invalid machine instruction!");
1618 // Keep track of user variables.
1620 MI->getOperand(MI->getNumOperands() - 1).getMetadata();
1622 // Variable is in a register, we need to check for clobbers.
1623 if (isDbgValueInDefinedReg(MI))
1624 LiveUserVar[MI->getOperand(0).getReg()] = Var;
1626 // Check the history of this variable.
1627 SmallVectorImpl<const MachineInstr *> &History = DbgValues[Var];
1628 if (History.empty()) {
1629 UserVariables.push_back(Var);
1630 // The first mention of a function argument gets the FunctionBeginSym
1631 // label, so arguments are visible when breaking at function entry.
1633 if (DV.isVariable() && DV.getTag() == dwarf::DW_TAG_arg_variable &&
1634 getDISubprogram(DV.getContext()).describes(MF->getFunction()))
1635 LabelsBeforeInsn[MI] = FunctionBeginSym;
1637 // We have seen this variable before. Try to coalesce DBG_VALUEs.
1638 const MachineInstr *Prev = History.back();
1639 if (Prev->isDebugValue()) {
1640 // Coalesce identical entries at the end of History.
1641 if (History.size() >= 2 &&
1642 Prev->isIdenticalTo(History[History.size() - 2])) {
1643 DEBUG(dbgs() << "Coalescing identical DBG_VALUE entries:\n"
1644 << "\t" << *Prev << "\t"
1645 << *History[History.size() - 2] << "\n");
1649 // Terminate old register assignments that don't reach MI;
1650 MachineFunction::const_iterator PrevMBB = Prev->getParent();
1651 if (PrevMBB != I && (!AtBlockEntry || llvm::next(PrevMBB) != I) &&
1652 isDbgValueInDefinedReg(Prev)) {
1653 // Previous register assignment needs to terminate at the end of
1655 MachineBasicBlock::const_iterator LastMI =
1656 PrevMBB->getLastNonDebugInstr();
1657 if (LastMI == PrevMBB->end()) {
1658 // Drop DBG_VALUE for empty range.
1659 DEBUG(dbgs() << "Dropping DBG_VALUE for empty range:\n"
1660 << "\t" << *Prev << "\n");
1662 } else if (llvm::next(PrevMBB) != PrevMBB->getParent()->end())
1663 // Terminate after LastMI.
1664 History.push_back(LastMI);
1668 History.push_back(MI);
1670 // Not a DBG_VALUE instruction.
1672 AtBlockEntry = false;
1674 // First known non-DBG_VALUE and non-frame setup location marks
1675 // the beginning of the function body.
1676 if (!MI->getFlag(MachineInstr::FrameSetup) &&
1677 (PrologEndLoc.isUnknown() && !MI->getDebugLoc().isUnknown()))
1678 PrologEndLoc = MI->getDebugLoc();
1680 // Check if the instruction clobbers any registers with debug vars.
1681 for (MachineInstr::const_mop_iterator MOI = MI->operands_begin(),
1682 MOE = MI->operands_end();
1683 MOI != MOE; ++MOI) {
1684 if (!MOI->isReg() || !MOI->isDef() || !MOI->getReg())
1686 for (MCRegAliasIterator AI(MOI->getReg(), TRI, true); AI.isValid();
1689 const MDNode *Var = LiveUserVar[Reg];
1692 // Reg is now clobbered.
1693 LiveUserVar[Reg] = 0;
1695 // Was MD last defined by a DBG_VALUE referring to Reg?
1696 DbgValueHistoryMap::iterator HistI = DbgValues.find(Var);
1697 if (HistI == DbgValues.end())
1699 SmallVectorImpl<const MachineInstr *> &History = HistI->second;
1700 if (History.empty())
1702 const MachineInstr *Prev = History.back();
1703 // Sanity-check: Register assignments are terminated at the end of
1705 if (!Prev->isDebugValue() || Prev->getParent() != MI->getParent())
1707 // Is the variable still in Reg?
1708 if (!isDbgValueInDefinedReg(Prev) ||
1709 Prev->getOperand(0).getReg() != Reg)
1711 // Var is clobbered. Make sure the next instruction gets a label.
1712 History.push_back(MI);
1719 for (DbgValueHistoryMap::iterator I = DbgValues.begin(), E = DbgValues.end();
1721 SmallVectorImpl<const MachineInstr *> &History = I->second;
1722 if (History.empty())
1725 // Make sure the final register assignments are terminated.
1726 const MachineInstr *Prev = History.back();
1727 if (Prev->isDebugValue() && isDbgValueInDefinedReg(Prev)) {
1728 const MachineBasicBlock *PrevMBB = Prev->getParent();
1729 MachineBasicBlock::const_iterator LastMI =
1730 PrevMBB->getLastNonDebugInstr();
1731 if (LastMI == PrevMBB->end())
1732 // Drop DBG_VALUE for empty range.
1734 else if (PrevMBB != &PrevMBB->getParent()->back()) {
1735 // Terminate after LastMI.
1736 History.push_back(LastMI);
1739 // Request labels for the full history.
1740 for (unsigned i = 0, e = History.size(); i != e; ++i) {
1741 const MachineInstr *MI = History[i];
1742 if (MI->isDebugValue())
1743 requestLabelBeforeInsn(MI);
1745 requestLabelAfterInsn(MI);
1749 PrevInstLoc = DebugLoc();
1750 PrevLabel = FunctionBeginSym;
1752 // Record beginning of function.
1753 if (!PrologEndLoc.isUnknown()) {
1754 DebugLoc FnStartDL =
1755 getFnDebugLoc(PrologEndLoc, MF->getFunction()->getContext());
1757 FnStartDL.getLine(), FnStartDL.getCol(),
1758 FnStartDL.getScope(MF->getFunction()->getContext()),
1759 // We'd like to list the prologue as "not statements" but GDB behaves
1760 // poorly if we do that. Revisit this with caution/GDB (7.5+) testing.
1761 DWARF2_FLAG_IS_STMT);
1765 void DwarfDebug::addScopeVariable(LexicalScope *LS, DbgVariable *Var) {
1766 SmallVectorImpl<DbgVariable *> &Vars = ScopeVariables[LS];
1767 DIVariable DV = Var->getVariable();
1768 // Variables with positive arg numbers are parameters.
1769 if (unsigned ArgNum = DV.getArgNumber()) {
1770 // Keep all parameters in order at the start of the variable list to ensure
1771 // function types are correct (no out-of-order parameters)
1773 // This could be improved by only doing it for optimized builds (unoptimized
1774 // builds have the right order to begin with), searching from the back (this
1775 // would catch the unoptimized case quickly), or doing a binary search
1776 // rather than linear search.
1777 SmallVectorImpl<DbgVariable *>::iterator I = Vars.begin();
1778 while (I != Vars.end()) {
1779 unsigned CurNum = (*I)->getVariable().getArgNumber();
1780 // A local (non-parameter) variable has been found, insert immediately
1784 // A later indexed parameter has been found, insert immediately before it.
1785 if (CurNum > ArgNum)
1789 Vars.insert(I, Var);
1793 Vars.push_back(Var);
1796 // Gather and emit post-function debug information.
1797 void DwarfDebug::endFunction(const MachineFunction *MF) {
1798 if (!MMI->hasDebugInfo() || LScopes.empty())
1801 // Define end label for subprogram.
1802 FunctionEndSym = Asm->GetTempSymbol("func_end", Asm->getFunctionNumber());
1803 // Assumes in correct section after the entry point.
1804 Asm->OutStreamer.EmitLabel(FunctionEndSym);
1805 // Set DwarfCompileUnitID in MCContext to default value.
1806 Asm->OutStreamer.getContext().setDwarfCompileUnitID(0);
1808 SmallPtrSet<const MDNode *, 16> ProcessedVars;
1809 collectVariableInfo(MF, ProcessedVars);
1811 LexicalScope *FnScope = LScopes.getCurrentFunctionScope();
1812 CompileUnit *TheCU = SPMap.lookup(FnScope->getScopeNode());
1813 assert(TheCU && "Unable to find compile unit!");
1815 // Construct abstract scopes.
1816 ArrayRef<LexicalScope *> AList = LScopes.getAbstractScopesList();
1817 for (unsigned i = 0, e = AList.size(); i != e; ++i) {
1818 LexicalScope *AScope = AList[i];
1819 DISubprogram SP(AScope->getScopeNode());
1820 if (SP.isSubprogram()) {
1821 // Collect info for variables that were optimized out.
1822 DIArray Variables = SP.getVariables();
1823 for (unsigned i = 0, e = Variables.getNumElements(); i != e; ++i) {
1824 DIVariable DV(Variables.getElement(i));
1825 if (!DV || !DV.isVariable() || !ProcessedVars.insert(DV))
1827 // Check that DbgVariable for DV wasn't created earlier, when
1828 // findAbstractVariable() was called for inlined instance of DV.
1829 LLVMContext &Ctx = DV->getContext();
1830 DIVariable CleanDV = cleanseInlinedVariable(DV, Ctx);
1831 if (AbstractVariables.lookup(CleanDV))
1833 if (LexicalScope *Scope = LScopes.findAbstractScope(DV.getContext()))
1834 addScopeVariable(Scope, new DbgVariable(DV, NULL, this));
1837 if (ProcessedSPNodes.count(AScope->getScopeNode()) == 0)
1838 constructScopeDIE(TheCU, AScope);
1841 DIE *CurFnDIE = constructScopeDIE(TheCU, FnScope);
1843 if (!MF->getTarget().Options.DisableFramePointerElim(*MF))
1844 TheCU->addFlag(CurFnDIE, dwarf::DW_AT_APPLE_omit_frame_ptr);
1847 for (ScopeVariablesMap::iterator I = ScopeVariables.begin(),
1848 E = ScopeVariables.end();
1850 DeleteContainerPointers(I->second);
1851 ScopeVariables.clear();
1852 DeleteContainerPointers(CurrentFnArguments);
1853 UserVariables.clear();
1855 AbstractVariables.clear();
1856 LabelsBeforeInsn.clear();
1857 LabelsAfterInsn.clear();
1861 // Register a source line with debug info. Returns the unique label that was
1862 // emitted and which provides correspondence to the source line list.
1863 void DwarfDebug::recordSourceLine(unsigned Line, unsigned Col, const MDNode *S,
1869 DIDescriptor Scope(S);
1871 if (Scope.isCompileUnit()) {
1872 DICompileUnit CU(S);
1873 Fn = CU.getFilename();
1874 Dir = CU.getDirectory();
1875 } else if (Scope.isFile()) {
1877 Fn = F.getFilename();
1878 Dir = F.getDirectory();
1879 } else if (Scope.isSubprogram()) {
1881 Fn = SP.getFilename();
1882 Dir = SP.getDirectory();
1883 } else if (Scope.isLexicalBlockFile()) {
1884 DILexicalBlockFile DBF(S);
1885 Fn = DBF.getFilename();
1886 Dir = DBF.getDirectory();
1887 } else if (Scope.isLexicalBlock()) {
1888 DILexicalBlock DB(S);
1889 Fn = DB.getFilename();
1890 Dir = DB.getDirectory();
1892 llvm_unreachable("Unexpected scope info");
1894 Src = getOrCreateSourceID(
1895 Fn, Dir, Asm->OutStreamer.getContext().getDwarfCompileUnitID());
1897 Asm->OutStreamer.EmitDwarfLocDirective(Src, Line, Col, Flags, 0, 0, Fn);
1900 //===----------------------------------------------------------------------===//
1902 //===----------------------------------------------------------------------===//
1904 // Compute the size and offset of a DIE. The offset is relative to start of the
1905 // CU. It returns the offset after laying out the DIE.
1906 unsigned DwarfUnits::computeSizeAndOffset(DIE *Die, unsigned Offset) {
1907 // Get the children.
1908 const std::vector<DIE *> &Children = Die->getChildren();
1910 // Record the abbreviation.
1911 assignAbbrevNumber(Die->getAbbrev());
1913 // Get the abbreviation for this DIE.
1914 unsigned AbbrevNumber = Die->getAbbrevNumber();
1915 const DIEAbbrev *Abbrev = Abbreviations[AbbrevNumber - 1];
1918 Die->setOffset(Offset);
1920 // Start the size with the size of abbreviation code.
1921 Offset += MCAsmInfo::getULEB128Size(AbbrevNumber);
1923 const SmallVectorImpl<DIEValue *> &Values = Die->getValues();
1924 const SmallVectorImpl<DIEAbbrevData> &AbbrevData = Abbrev->getData();
1926 // Size the DIE attribute values.
1927 for (unsigned i = 0, N = Values.size(); i < N; ++i)
1928 // Size attribute value.
1929 Offset += Values[i]->SizeOf(Asm, AbbrevData[i].getForm());
1931 // Size the DIE children if any.
1932 if (!Children.empty()) {
1933 assert(Abbrev->getChildrenFlag() == dwarf::DW_CHILDREN_yes &&
1934 "Children flag not set");
1936 for (unsigned j = 0, M = Children.size(); j < M; ++j)
1937 Offset = computeSizeAndOffset(Children[j], Offset);
1939 // End of children marker.
1940 Offset += sizeof(int8_t);
1943 Die->setSize(Offset - Die->getOffset());
1947 // Compute the size and offset for each DIE.
1948 void DwarfUnits::computeSizeAndOffsets() {
1949 // Offset from the first CU in the debug info section is 0 initially.
1950 unsigned SecOffset = 0;
1952 // Iterate over each compile unit and set the size and offsets for each
1953 // DIE within each compile unit. All offsets are CU relative.
1954 for (SmallVectorImpl<CompileUnit *>::iterator I = CUs.begin(), E = CUs.end();
1956 (*I)->setDebugInfoOffset(SecOffset);
1958 // CU-relative offset is reset to 0 here.
1959 unsigned Offset = sizeof(int32_t) + // Length of Unit Info
1960 (*I)->getHeaderSize(); // Unit-specific headers
1962 // EndOffset here is CU-relative, after laying out
1963 // all of the CU DIE.
1964 unsigned EndOffset = computeSizeAndOffset((*I)->getCUDie(), Offset);
1965 SecOffset += EndOffset;
1969 // Emit initial Dwarf sections with a label at the start of each one.
1970 void DwarfDebug::emitSectionLabels() {
1971 const TargetLoweringObjectFile &TLOF = Asm->getObjFileLowering();
1973 // Dwarf sections base addresses.
1974 DwarfInfoSectionSym =
1975 emitSectionSym(Asm, TLOF.getDwarfInfoSection(), "section_info");
1976 DwarfAbbrevSectionSym =
1977 emitSectionSym(Asm, TLOF.getDwarfAbbrevSection(), "section_abbrev");
1978 if (useSplitDwarf())
1979 DwarfAbbrevDWOSectionSym = emitSectionSym(
1980 Asm, TLOF.getDwarfAbbrevDWOSection(), "section_abbrev_dwo");
1981 emitSectionSym(Asm, TLOF.getDwarfARangesSection());
1983 if (const MCSection *MacroInfo = TLOF.getDwarfMacroInfoSection())
1984 emitSectionSym(Asm, MacroInfo);
1986 DwarfLineSectionSym =
1987 emitSectionSym(Asm, TLOF.getDwarfLineSection(), "section_line");
1988 emitSectionSym(Asm, TLOF.getDwarfLocSection());
1989 if (GenerateGnuPubSections) {
1990 DwarfGnuPubNamesSectionSym =
1991 emitSectionSym(Asm, TLOF.getDwarfGnuPubNamesSection());
1992 DwarfGnuPubTypesSectionSym =
1993 emitSectionSym(Asm, TLOF.getDwarfGnuPubTypesSection());
1994 } else if (HasDwarfPubSections) {
1995 emitSectionSym(Asm, TLOF.getDwarfPubNamesSection());
1996 emitSectionSym(Asm, TLOF.getDwarfPubTypesSection());
1999 DwarfStrSectionSym =
2000 emitSectionSym(Asm, TLOF.getDwarfStrSection(), "info_string");
2001 if (useSplitDwarf()) {
2002 DwarfStrDWOSectionSym =
2003 emitSectionSym(Asm, TLOF.getDwarfStrDWOSection(), "skel_string");
2004 DwarfAddrSectionSym =
2005 emitSectionSym(Asm, TLOF.getDwarfAddrSection(), "addr_sec");
2007 DwarfDebugRangeSectionSym =
2008 emitSectionSym(Asm, TLOF.getDwarfRangesSection(), "debug_range");
2010 DwarfDebugLocSectionSym =
2011 emitSectionSym(Asm, TLOF.getDwarfLocSection(), "section_debug_loc");
2013 TextSectionSym = emitSectionSym(Asm, TLOF.getTextSection(), "text_begin");
2014 emitSectionSym(Asm, TLOF.getDataSection());
2017 // Recursively emits a debug information entry.
2018 void DwarfDebug::emitDIE(DIE *Die, ArrayRef<DIEAbbrev *> Abbrevs) {
2019 // Get the abbreviation for this DIE.
2020 unsigned AbbrevNumber = Die->getAbbrevNumber();
2021 const DIEAbbrev *Abbrev = Abbrevs[AbbrevNumber - 1];
2023 // Emit the code (index) for the abbreviation.
2024 if (Asm->isVerbose())
2025 Asm->OutStreamer.AddComment("Abbrev [" + Twine(AbbrevNumber) + "] 0x" +
2026 Twine::utohexstr(Die->getOffset()) + ":0x" +
2027 Twine::utohexstr(Die->getSize()) + " " +
2028 dwarf::TagString(Abbrev->getTag()));
2029 Asm->EmitULEB128(AbbrevNumber);
2031 const SmallVectorImpl<DIEValue *> &Values = Die->getValues();
2032 const SmallVectorImpl<DIEAbbrevData> &AbbrevData = Abbrev->getData();
2034 // Emit the DIE attribute values.
2035 for (unsigned i = 0, N = Values.size(); i < N; ++i) {
2036 dwarf::Attribute Attr = AbbrevData[i].getAttribute();
2037 dwarf::Form Form = AbbrevData[i].getForm();
2038 assert(Form && "Too many attributes for DIE (check abbreviation)");
2040 if (Asm->isVerbose())
2041 Asm->OutStreamer.AddComment(dwarf::AttributeString(Attr));
2044 case dwarf::DW_AT_abstract_origin:
2045 case dwarf::DW_AT_type:
2046 case dwarf::DW_AT_friend:
2047 case dwarf::DW_AT_specification:
2048 case dwarf::DW_AT_import:
2049 case dwarf::DW_AT_containing_type: {
2050 DIEEntry *E = cast<DIEEntry>(Values[i]);
2051 DIE *Origin = E->getEntry();
2052 unsigned Addr = Origin->getOffset();
2053 if (Form == dwarf::DW_FORM_ref_addr) {
2054 assert(!useSplitDwarf() && "TODO: dwo files can't have relocations.");
2055 // For DW_FORM_ref_addr, output the offset from beginning of debug info
2056 // section. Origin->getOffset() returns the offset from start of the
2058 CompileUnit *CU = CUDieMap.lookup(Origin->getUnit());
2059 assert(CU && "CUDie should belong to a CU.");
2060 Addr += CU->getDebugInfoOffset();
2061 if (Asm->MAI->doesDwarfUseRelocationsAcrossSections())
2062 Asm->EmitLabelPlusOffset(DwarfInfoSectionSym, Addr,
2063 DIEEntry::getRefAddrSize(Asm));
2065 Asm->EmitLabelOffsetDifference(DwarfInfoSectionSym, Addr,
2066 DwarfInfoSectionSym,
2067 DIEEntry::getRefAddrSize(Asm));
2069 // Make sure Origin belong to the same CU.
2070 assert(Die->getUnit() == Origin->getUnit() &&
2071 "The referenced DIE should belong to the same CU in ref4");
2072 Asm->EmitInt32(Addr);
2076 case dwarf::DW_AT_ranges: {
2077 // DW_AT_range Value encodes offset in debug_range section.
2078 DIEInteger *V = cast<DIEInteger>(Values[i]);
2080 if (Asm->MAI->doesDwarfUseRelocationsAcrossSections()) {
2081 Asm->EmitLabelPlusOffset(DwarfDebugRangeSectionSym, V->getValue(), 4);
2083 Asm->EmitLabelOffsetDifference(DwarfDebugRangeSectionSym, V->getValue(),
2084 DwarfDebugRangeSectionSym, 4);
2088 case dwarf::DW_AT_location: {
2089 if (DIELabel *L = dyn_cast<DIELabel>(Values[i])) {
2090 if (Asm->MAI->doesDwarfUseRelocationsAcrossSections())
2091 Asm->EmitSectionOffset(L->getValue(), DwarfDebugLocSectionSym);
2093 Asm->EmitLabelDifference(L->getValue(), DwarfDebugLocSectionSym, 4);
2095 Values[i]->EmitValue(Asm, Form);
2099 case dwarf::DW_AT_accessibility: {
2100 if (Asm->isVerbose()) {
2101 DIEInteger *V = cast<DIEInteger>(Values[i]);
2102 Asm->OutStreamer.AddComment(dwarf::AccessibilityString(V->getValue()));
2104 Values[i]->EmitValue(Asm, Form);
2108 // Emit an attribute using the defined form.
2109 Values[i]->EmitValue(Asm, Form);
2114 // Emit the DIE children if any.
2115 if (Abbrev->getChildrenFlag() == dwarf::DW_CHILDREN_yes) {
2116 const std::vector<DIE *> &Children = Die->getChildren();
2118 for (unsigned j = 0, M = Children.size(); j < M; ++j)
2119 emitDIE(Children[j], Abbrevs);
2121 if (Asm->isVerbose())
2122 Asm->OutStreamer.AddComment("End Of Children Mark");
2127 // Emit the various dwarf units to the unit section USection with
2128 // the abbreviations going into ASection.
2129 void DwarfUnits::emitUnits(DwarfDebug *DD, const MCSection *USection,
2130 const MCSection *ASection,
2131 const MCSymbol *ASectionSym) {
2132 Asm->OutStreamer.SwitchSection(USection);
2133 for (SmallVectorImpl<CompileUnit *>::iterator I = CUs.begin(), E = CUs.end();
2135 CompileUnit *TheCU = *I;
2136 DIE *Die = TheCU->getCUDie();
2138 // Emit the compile units header.
2139 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol(USection->getLabelBeginName(),
2140 TheCU->getUniqueID()));
2142 // Emit size of content not including length itself
2143 Asm->OutStreamer.AddComment("Length of Unit");
2144 Asm->EmitInt32(TheCU->getHeaderSize() + Die->getSize());
2146 TheCU->emitHeader(ASection, ASectionSym);
2148 DD->emitDIE(Die, Abbreviations);
2149 Asm->OutStreamer.EmitLabel(
2150 Asm->GetTempSymbol(USection->getLabelEndName(), TheCU->getUniqueID()));
2154 // Emit the debug info section.
2155 void DwarfDebug::emitDebugInfo() {
2156 DwarfUnits &Holder = useSplitDwarf() ? SkeletonHolder : InfoHolder;
2158 Holder.emitUnits(this, Asm->getObjFileLowering().getDwarfInfoSection(),
2159 Asm->getObjFileLowering().getDwarfAbbrevSection(),
2160 DwarfAbbrevSectionSym);
2163 // Emit the abbreviation section.
2164 void DwarfDebug::emitAbbreviations() {
2165 if (!useSplitDwarf())
2166 emitAbbrevs(Asm->getObjFileLowering().getDwarfAbbrevSection(),
2169 emitSkeletonAbbrevs(Asm->getObjFileLowering().getDwarfAbbrevSection());
2172 void DwarfDebug::emitAbbrevs(const MCSection *Section,
2173 std::vector<DIEAbbrev *> *Abbrevs) {
2174 // Check to see if it is worth the effort.
2175 if (!Abbrevs->empty()) {
2176 // Start the debug abbrev section.
2177 Asm->OutStreamer.SwitchSection(Section);
2179 MCSymbol *Begin = Asm->GetTempSymbol(Section->getLabelBeginName());
2180 Asm->OutStreamer.EmitLabel(Begin);
2182 // For each abbrevation.
2183 for (unsigned i = 0, N = Abbrevs->size(); i < N; ++i) {
2184 // Get abbreviation data
2185 const DIEAbbrev *Abbrev = Abbrevs->at(i);
2187 // Emit the abbrevations code (base 1 index.)
2188 Asm->EmitULEB128(Abbrev->getNumber(), "Abbreviation Code");
2190 // Emit the abbreviations data.
2194 // Mark end of abbreviations.
2195 Asm->EmitULEB128(0, "EOM(3)");
2197 MCSymbol *End = Asm->GetTempSymbol(Section->getLabelEndName());
2198 Asm->OutStreamer.EmitLabel(End);
2202 // Emit the last address of the section and the end of the line matrix.
2203 void DwarfDebug::emitEndOfLineMatrix(unsigned SectionEnd) {
2204 // Define last address of section.
2205 Asm->OutStreamer.AddComment("Extended Op");
2208 Asm->OutStreamer.AddComment("Op size");
2209 Asm->EmitInt8(Asm->getDataLayout().getPointerSize() + 1);
2210 Asm->OutStreamer.AddComment("DW_LNE_set_address");
2211 Asm->EmitInt8(dwarf::DW_LNE_set_address);
2213 Asm->OutStreamer.AddComment("Section end label");
2215 Asm->OutStreamer.EmitSymbolValue(
2216 Asm->GetTempSymbol("section_end", SectionEnd),
2217 Asm->getDataLayout().getPointerSize());
2219 // Mark end of matrix.
2220 Asm->OutStreamer.AddComment("DW_LNE_end_sequence");
2226 // Emit visible names into a hashed accelerator table section.
2227 void DwarfDebug::emitAccelNames() {
2229 DwarfAccelTable::Atom(dwarf::DW_ATOM_die_offset, dwarf::DW_FORM_data4));
2230 for (DenseMap<const MDNode *, CompileUnit *>::iterator I = CUMap.begin(),
2233 CompileUnit *TheCU = I->second;
2234 const StringMap<std::vector<const DIE *> > &Names = TheCU->getAccelNames();
2235 for (StringMap<std::vector<const DIE *> >::const_iterator
2239 StringRef Name = GI->getKey();
2240 const std::vector<const DIE *> &Entities = GI->second;
2241 for (std::vector<const DIE *>::const_iterator DI = Entities.begin(),
2242 DE = Entities.end();
2244 AT.AddName(Name, *DI);
2248 AT.FinalizeTable(Asm, "Names");
2249 Asm->OutStreamer.SwitchSection(
2250 Asm->getObjFileLowering().getDwarfAccelNamesSection());
2251 MCSymbol *SectionBegin = Asm->GetTempSymbol("names_begin");
2252 Asm->OutStreamer.EmitLabel(SectionBegin);
2254 // Emit the full data.
2255 AT.Emit(Asm, SectionBegin, &InfoHolder);
2258 // Emit objective C classes and categories into a hashed accelerator table
2260 void DwarfDebug::emitAccelObjC() {
2262 DwarfAccelTable::Atom(dwarf::DW_ATOM_die_offset, dwarf::DW_FORM_data4));
2263 for (DenseMap<const MDNode *, CompileUnit *>::iterator I = CUMap.begin(),
2266 CompileUnit *TheCU = I->second;
2267 const StringMap<std::vector<const DIE *> > &Names = TheCU->getAccelObjC();
2268 for (StringMap<std::vector<const DIE *> >::const_iterator
2272 StringRef Name = GI->getKey();
2273 const std::vector<const DIE *> &Entities = GI->second;
2274 for (std::vector<const DIE *>::const_iterator DI = Entities.begin(),
2275 DE = Entities.end();
2277 AT.AddName(Name, *DI);
2281 AT.FinalizeTable(Asm, "ObjC");
2282 Asm->OutStreamer.SwitchSection(
2283 Asm->getObjFileLowering().getDwarfAccelObjCSection());
2284 MCSymbol *SectionBegin = Asm->GetTempSymbol("objc_begin");
2285 Asm->OutStreamer.EmitLabel(SectionBegin);
2287 // Emit the full data.
2288 AT.Emit(Asm, SectionBegin, &InfoHolder);
2291 // Emit namespace dies into a hashed accelerator table.
2292 void DwarfDebug::emitAccelNamespaces() {
2294 DwarfAccelTable::Atom(dwarf::DW_ATOM_die_offset, dwarf::DW_FORM_data4));
2295 for (DenseMap<const MDNode *, CompileUnit *>::iterator I = CUMap.begin(),
2298 CompileUnit *TheCU = I->second;
2299 const StringMap<std::vector<const DIE *> > &Names =
2300 TheCU->getAccelNamespace();
2301 for (StringMap<std::vector<const DIE *> >::const_iterator
2305 StringRef Name = GI->getKey();
2306 const std::vector<const DIE *> &Entities = GI->second;
2307 for (std::vector<const DIE *>::const_iterator DI = Entities.begin(),
2308 DE = Entities.end();
2310 AT.AddName(Name, *DI);
2314 AT.FinalizeTable(Asm, "namespac");
2315 Asm->OutStreamer.SwitchSection(
2316 Asm->getObjFileLowering().getDwarfAccelNamespaceSection());
2317 MCSymbol *SectionBegin = Asm->GetTempSymbol("namespac_begin");
2318 Asm->OutStreamer.EmitLabel(SectionBegin);
2320 // Emit the full data.
2321 AT.Emit(Asm, SectionBegin, &InfoHolder);
2324 // Emit type dies into a hashed accelerator table.
2325 void DwarfDebug::emitAccelTypes() {
2326 std::vector<DwarfAccelTable::Atom> Atoms;
2328 DwarfAccelTable::Atom(dwarf::DW_ATOM_die_offset, dwarf::DW_FORM_data4));
2330 DwarfAccelTable::Atom(dwarf::DW_ATOM_die_tag, dwarf::DW_FORM_data2));
2332 DwarfAccelTable::Atom(dwarf::DW_ATOM_type_flags, dwarf::DW_FORM_data1));
2333 DwarfAccelTable AT(Atoms);
2334 for (DenseMap<const MDNode *, CompileUnit *>::iterator I = CUMap.begin(),
2337 CompileUnit *TheCU = I->second;
2338 const StringMap<std::vector<std::pair<const DIE *, unsigned> > > &Names =
2339 TheCU->getAccelTypes();
2341 std::vector<std::pair<const DIE *, unsigned> > >::const_iterator
2345 StringRef Name = GI->getKey();
2346 const std::vector<std::pair<const DIE *, unsigned> > &Entities =
2348 for (std::vector<std::pair<const DIE *, unsigned> >::const_iterator
2349 DI = Entities.begin(),
2350 DE = Entities.end();
2352 AT.AddName(Name, DI->first, DI->second);
2356 AT.FinalizeTable(Asm, "types");
2357 Asm->OutStreamer.SwitchSection(
2358 Asm->getObjFileLowering().getDwarfAccelTypesSection());
2359 MCSymbol *SectionBegin = Asm->GetTempSymbol("types_begin");
2360 Asm->OutStreamer.EmitLabel(SectionBegin);
2362 // Emit the full data.
2363 AT.Emit(Asm, SectionBegin, &InfoHolder);
2366 // Public name handling.
2367 // The format for the various pubnames:
2369 // dwarf pubnames - offset/name pairs where the offset is the offset into the CU
2370 // for the DIE that is named.
2372 // gnu pubnames - offset/index value/name tuples where the offset is the offset
2373 // into the CU and the index value is computed according to the type of value
2374 // for the DIE that is named.
2376 // For type units the offset is the offset of the skeleton DIE. For split dwarf
2377 // it's the offset within the debug_info/debug_types dwo section, however, the
2378 // reference in the pubname header doesn't change.
2380 /// computeIndexValue - Compute the gdb index value for the DIE and CU.
2381 static dwarf::PubIndexEntryDescriptor computeIndexValue(CompileUnit *CU,
2383 dwarf::GDBIndexEntryLinkage Linkage = dwarf::GIEL_STATIC;
2385 // We could have a specification DIE that has our most of our knowledge,
2386 // look for that now.
2387 DIEValue *SpecVal = Die->findAttribute(dwarf::DW_AT_specification);
2389 DIE *SpecDIE = cast<DIEEntry>(SpecVal)->getEntry();
2390 if (SpecDIE->findAttribute(dwarf::DW_AT_external))
2391 Linkage = dwarf::GIEL_EXTERNAL;
2392 } else if (Die->findAttribute(dwarf::DW_AT_external))
2393 Linkage = dwarf::GIEL_EXTERNAL;
2395 switch (Die->getTag()) {
2396 case dwarf::DW_TAG_class_type:
2397 case dwarf::DW_TAG_structure_type:
2398 case dwarf::DW_TAG_union_type:
2399 case dwarf::DW_TAG_enumeration_type:
2400 return dwarf::PubIndexEntryDescriptor(
2401 dwarf::GIEK_TYPE, CU->getLanguage() != dwarf::DW_LANG_C_plus_plus
2402 ? dwarf::GIEL_STATIC
2403 : dwarf::GIEL_EXTERNAL);
2404 case dwarf::DW_TAG_typedef:
2405 case dwarf::DW_TAG_base_type:
2406 case dwarf::DW_TAG_subrange_type:
2407 return dwarf::PubIndexEntryDescriptor(dwarf::GIEK_TYPE, dwarf::GIEL_STATIC);
2408 case dwarf::DW_TAG_namespace:
2409 return dwarf::GIEK_TYPE;
2410 case dwarf::DW_TAG_subprogram:
2411 return dwarf::PubIndexEntryDescriptor(dwarf::GIEK_FUNCTION, Linkage);
2412 case dwarf::DW_TAG_constant:
2413 case dwarf::DW_TAG_variable:
2414 return dwarf::PubIndexEntryDescriptor(dwarf::GIEK_VARIABLE, Linkage);
2415 case dwarf::DW_TAG_enumerator:
2416 return dwarf::PubIndexEntryDescriptor(dwarf::GIEK_VARIABLE,
2417 dwarf::GIEL_STATIC);
2419 return dwarf::GIEK_NONE;
2423 /// emitDebugPubNames - Emit visible names into a debug pubnames section.
2425 void DwarfDebug::emitDebugPubNames(bool GnuStyle) {
2426 const MCSection *ISec = Asm->getObjFileLowering().getDwarfInfoSection();
2427 const MCSection *PSec =
2428 GnuStyle ? Asm->getObjFileLowering().getDwarfGnuPubNamesSection()
2429 : Asm->getObjFileLowering().getDwarfPubNamesSection();
2431 typedef DenseMap<const MDNode *, CompileUnit *> CUMapType;
2432 for (CUMapType::iterator I = CUMap.begin(), E = CUMap.end(); I != E; ++I) {
2433 CompileUnit *TheCU = I->second;
2434 unsigned ID = TheCU->getUniqueID();
2436 // Start the dwarf pubnames section.
2437 Asm->OutStreamer.SwitchSection(PSec);
2439 // Emit a label so we can reference the beginning of this pubname section.
2441 Asm->OutStreamer.EmitLabel(
2442 Asm->GetTempSymbol("gnu_pubnames", TheCU->getUniqueID()));
2445 Asm->OutStreamer.AddComment("Length of Public Names Info");
2446 Asm->EmitLabelDifference(Asm->GetTempSymbol("pubnames_end", ID),
2447 Asm->GetTempSymbol("pubnames_begin", ID), 4);
2449 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("pubnames_begin", ID));
2451 Asm->OutStreamer.AddComment("DWARF Version");
2452 Asm->EmitInt16(dwarf::DW_PUBNAMES_VERSION);
2454 Asm->OutStreamer.AddComment("Offset of Compilation Unit Info");
2455 Asm->EmitSectionOffset(Asm->GetTempSymbol(ISec->getLabelBeginName(), ID),
2456 DwarfInfoSectionSym);
2458 Asm->OutStreamer.AddComment("Compilation Unit Length");
2459 Asm->EmitLabelDifference(Asm->GetTempSymbol(ISec->getLabelEndName(), ID),
2460 Asm->GetTempSymbol(ISec->getLabelBeginName(), ID),
2463 // Emit the pubnames for this compilation unit.
2464 const StringMap<DIE *> &Globals = TheCU->getGlobalNames();
2465 for (StringMap<DIE *>::const_iterator GI = Globals.begin(),
2468 const char *Name = GI->getKeyData();
2469 DIE *Entity = GI->second;
2471 Asm->OutStreamer.AddComment("DIE offset");
2472 Asm->EmitInt32(Entity->getOffset());
2475 dwarf::PubIndexEntryDescriptor Desc = computeIndexValue(TheCU, Entity);
2476 Asm->OutStreamer.AddComment(
2477 Twine("Kind: ") + dwarf::GDBIndexEntryKindString(Desc.Kind) + ", " +
2478 dwarf::GDBIndexEntryLinkageString(Desc.Linkage));
2479 Asm->EmitInt8(Desc.toBits());
2482 if (Asm->isVerbose())
2483 Asm->OutStreamer.AddComment("External Name");
2484 Asm->OutStreamer.EmitBytes(StringRef(Name, GI->getKeyLength() + 1));
2487 Asm->OutStreamer.AddComment("End Mark");
2489 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("pubnames_end", ID));
2493 void DwarfDebug::emitDebugPubTypes(bool GnuStyle) {
2494 const MCSection *ISec = Asm->getObjFileLowering().getDwarfInfoSection();
2495 const MCSection *PSec =
2496 GnuStyle ? Asm->getObjFileLowering().getDwarfGnuPubTypesSection()
2497 : Asm->getObjFileLowering().getDwarfPubTypesSection();
2499 for (DenseMap<const MDNode *, CompileUnit *>::iterator I = CUMap.begin(),
2502 CompileUnit *TheCU = I->second;
2503 // Start the dwarf pubtypes section.
2504 Asm->OutStreamer.SwitchSection(PSec);
2506 // Emit a label so we can reference the beginning of this pubtype section.
2508 Asm->OutStreamer.EmitLabel(
2509 Asm->GetTempSymbol("gnu_pubtypes", TheCU->getUniqueID()));
2512 Asm->OutStreamer.AddComment("Length of Public Types Info");
2513 Asm->EmitLabelDifference(
2514 Asm->GetTempSymbol("pubtypes_end", TheCU->getUniqueID()),
2515 Asm->GetTempSymbol("pubtypes_begin", TheCU->getUniqueID()), 4);
2517 Asm->OutStreamer.EmitLabel(
2518 Asm->GetTempSymbol("pubtypes_begin", TheCU->getUniqueID()));
2520 if (Asm->isVerbose())
2521 Asm->OutStreamer.AddComment("DWARF Version");
2522 Asm->EmitInt16(dwarf::DW_PUBTYPES_VERSION);
2524 Asm->OutStreamer.AddComment("Offset of Compilation Unit Info");
2525 Asm->EmitSectionOffset(
2526 Asm->GetTempSymbol(ISec->getLabelBeginName(), TheCU->getUniqueID()),
2527 DwarfInfoSectionSym);
2529 Asm->OutStreamer.AddComment("Compilation Unit Length");
2530 Asm->EmitLabelDifference(
2531 Asm->GetTempSymbol(ISec->getLabelEndName(), TheCU->getUniqueID()),
2532 Asm->GetTempSymbol(ISec->getLabelBeginName(), TheCU->getUniqueID()), 4);
2534 // Emit the pubtypes.
2535 const StringMap<DIE *> &Globals = TheCU->getGlobalTypes();
2536 for (StringMap<DIE *>::const_iterator GI = Globals.begin(),
2539 const char *Name = GI->getKeyData();
2540 DIE *Entity = GI->second;
2542 if (Asm->isVerbose())
2543 Asm->OutStreamer.AddComment("DIE offset");
2544 Asm->EmitInt32(Entity->getOffset());
2547 dwarf::PubIndexEntryDescriptor Desc = computeIndexValue(TheCU, Entity);
2548 Asm->OutStreamer.AddComment(
2549 Twine("Kind: ") + dwarf::GDBIndexEntryKindString(Desc.Kind) + ", " +
2550 dwarf::GDBIndexEntryLinkageString(Desc.Linkage));
2551 Asm->EmitInt8(Desc.toBits());
2554 if (Asm->isVerbose())
2555 Asm->OutStreamer.AddComment("External Name");
2557 // Emit the name with a terminating null byte.
2558 Asm->OutStreamer.EmitBytes(StringRef(Name, GI->getKeyLength() + 1));
2561 Asm->OutStreamer.AddComment("End Mark");
2563 Asm->OutStreamer.EmitLabel(
2564 Asm->GetTempSymbol("pubtypes_end", TheCU->getUniqueID()));
2568 // Emit strings into a string section.
2569 void DwarfUnits::emitStrings(const MCSection *StrSection,
2570 const MCSection *OffsetSection = NULL,
2571 const MCSymbol *StrSecSym = NULL) {
2573 if (StringPool.empty())
2576 // Start the dwarf str section.
2577 Asm->OutStreamer.SwitchSection(StrSection);
2579 // Get all of the string pool entries and put them in an array by their ID so
2580 // we can sort them.
2582 std::pair<unsigned, StringMapEntry<std::pair<MCSymbol *, unsigned> > *>,
2585 for (StringMap<std::pair<MCSymbol *, unsigned> >::iterator
2586 I = StringPool.begin(),
2587 E = StringPool.end();
2589 Entries.push_back(std::make_pair(I->second.second, &*I));
2591 array_pod_sort(Entries.begin(), Entries.end());
2593 for (unsigned i = 0, e = Entries.size(); i != e; ++i) {
2594 // Emit a label for reference from debug information entries.
2595 Asm->OutStreamer.EmitLabel(Entries[i].second->getValue().first);
2597 // Emit the string itself with a terminating null byte.
2598 Asm->OutStreamer.EmitBytes(
2599 StringRef(Entries[i].second->getKeyData(),
2600 Entries[i].second->getKeyLength() + 1));
2603 // If we've got an offset section go ahead and emit that now as well.
2604 if (OffsetSection) {
2605 Asm->OutStreamer.SwitchSection(OffsetSection);
2606 unsigned offset = 0;
2607 unsigned size = 4; // FIXME: DWARF64 is 8.
2608 for (unsigned i = 0, e = Entries.size(); i != e; ++i) {
2609 Asm->OutStreamer.EmitIntValue(offset, size);
2610 offset += Entries[i].second->getKeyLength() + 1;
2616 // Emit addresses into the section given.
2617 void DwarfUnits::emitAddresses(const MCSection *AddrSection) {
2619 if (AddressPool.empty())
2622 // Start the dwarf addr section.
2623 Asm->OutStreamer.SwitchSection(AddrSection);
2625 // Order the address pool entries by ID
2626 SmallVector<const MCExpr *, 64> Entries(AddressPool.size());
2628 for (DenseMap<const MCExpr *, unsigned>::iterator I = AddressPool.begin(),
2629 E = AddressPool.end();
2631 Entries[I->second] = I->first;
2633 for (unsigned i = 0, e = Entries.size(); i != e; ++i) {
2634 // Emit an expression for reference from debug information entries.
2635 if (const MCExpr *Expr = Entries[i])
2636 Asm->OutStreamer.EmitValue(Expr, Asm->getDataLayout().getPointerSize());
2638 Asm->OutStreamer.EmitIntValue(0, Asm->getDataLayout().getPointerSize());
2642 // Emit visible names into a debug str section.
2643 void DwarfDebug::emitDebugStr() {
2644 DwarfUnits &Holder = useSplitDwarf() ? SkeletonHolder : InfoHolder;
2645 Holder.emitStrings(Asm->getObjFileLowering().getDwarfStrSection());
2648 // Emit locations into the debug loc section.
2649 void DwarfDebug::emitDebugLoc() {
2650 if (DotDebugLocEntries.empty())
2653 for (SmallVectorImpl<DotDebugLocEntry>::iterator
2654 I = DotDebugLocEntries.begin(),
2655 E = DotDebugLocEntries.end();
2657 DotDebugLocEntry &Entry = *I;
2658 if (I + 1 != DotDebugLocEntries.end())
2662 // Start the dwarf loc section.
2663 Asm->OutStreamer.SwitchSection(
2664 Asm->getObjFileLowering().getDwarfLocSection());
2665 unsigned char Size = Asm->getDataLayout().getPointerSize();
2666 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("debug_loc", 0));
2668 for (SmallVectorImpl<DotDebugLocEntry>::iterator
2669 I = DotDebugLocEntries.begin(),
2670 E = DotDebugLocEntries.end();
2671 I != E; ++I, ++index) {
2672 DotDebugLocEntry &Entry = *I;
2673 if (Entry.isMerged())
2675 if (Entry.isEmpty()) {
2676 Asm->OutStreamer.EmitIntValue(0, Size);
2677 Asm->OutStreamer.EmitIntValue(0, Size);
2678 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("debug_loc", index));
2680 Asm->OutStreamer.EmitSymbolValue(Entry.getBeginSym(), Size);
2681 Asm->OutStreamer.EmitSymbolValue(Entry.getEndSym(), Size);
2682 DIVariable DV(Entry.getVariable());
2683 Asm->OutStreamer.AddComment("Loc expr size");
2684 MCSymbol *begin = Asm->OutStreamer.getContext().CreateTempSymbol();
2685 MCSymbol *end = Asm->OutStreamer.getContext().CreateTempSymbol();
2686 Asm->EmitLabelDifference(end, begin, 2);
2687 Asm->OutStreamer.EmitLabel(begin);
2688 if (Entry.isInt()) {
2689 DIBasicType BTy(DV.getType());
2690 if (BTy.Verify() && (BTy.getEncoding() == dwarf::DW_ATE_signed ||
2691 BTy.getEncoding() == dwarf::DW_ATE_signed_char)) {
2692 Asm->OutStreamer.AddComment("DW_OP_consts");
2693 Asm->EmitInt8(dwarf::DW_OP_consts);
2694 Asm->EmitSLEB128(Entry.getInt());
2696 Asm->OutStreamer.AddComment("DW_OP_constu");
2697 Asm->EmitInt8(dwarf::DW_OP_constu);
2698 Asm->EmitULEB128(Entry.getInt());
2700 } else if (Entry.isLocation()) {
2701 MachineLocation Loc = Entry.getLoc();
2702 if (!DV.hasComplexAddress())
2704 Asm->EmitDwarfRegOp(Loc, DV.isIndirect());
2706 // Complex address entry.
2707 unsigned N = DV.getNumAddrElements();
2709 if (N >= 2 && DV.getAddrElement(0) == DIBuilder::OpPlus) {
2710 if (Loc.getOffset()) {
2712 Asm->EmitDwarfRegOp(Loc, DV.isIndirect());
2713 Asm->OutStreamer.AddComment("DW_OP_deref");
2714 Asm->EmitInt8(dwarf::DW_OP_deref);
2715 Asm->OutStreamer.AddComment("DW_OP_plus_uconst");
2716 Asm->EmitInt8(dwarf::DW_OP_plus_uconst);
2717 Asm->EmitSLEB128(DV.getAddrElement(1));
2719 // If first address element is OpPlus then emit
2720 // DW_OP_breg + Offset instead of DW_OP_reg + Offset.
2721 MachineLocation TLoc(Loc.getReg(), DV.getAddrElement(1));
2722 Asm->EmitDwarfRegOp(TLoc, DV.isIndirect());
2726 Asm->EmitDwarfRegOp(Loc, DV.isIndirect());
2729 // Emit remaining complex address elements.
2730 for (; i < N; ++i) {
2731 uint64_t Element = DV.getAddrElement(i);
2732 if (Element == DIBuilder::OpPlus) {
2733 Asm->EmitInt8(dwarf::DW_OP_plus_uconst);
2734 Asm->EmitULEB128(DV.getAddrElement(++i));
2735 } else if (Element == DIBuilder::OpDeref) {
2737 Asm->EmitInt8(dwarf::DW_OP_deref);
2739 llvm_unreachable("unknown Opcode found in complex address");
2743 // else ... ignore constant fp. There is not any good way to
2744 // to represent them here in dwarf.
2745 Asm->OutStreamer.EmitLabel(end);
2750 struct SymbolCUSorter {
2751 SymbolCUSorter(const MCStreamer &s) : Streamer(s) {}
2752 const MCStreamer &Streamer;
2754 bool operator()(const SymbolCU &A, const SymbolCU &B) {
2755 unsigned IA = A.Sym ? Streamer.GetSymbolOrder(A.Sym) : 0;
2756 unsigned IB = B.Sym ? Streamer.GetSymbolOrder(B.Sym) : 0;
2758 // Symbols with no order assigned should be placed at the end.
2759 // (e.g. section end labels)
2761 IA = (unsigned)(-1);
2763 IB = (unsigned)(-1);
2768 static bool CUSort(const CompileUnit *A, const CompileUnit *B) {
2769 return (A->getUniqueID() < B->getUniqueID());
2773 const MCSymbol *Start, *End;
2776 // Emit a debug aranges section, containing a CU lookup for any
2777 // address we can tie back to a CU.
2778 void DwarfDebug::emitDebugARanges() {
2779 // Start the dwarf aranges section.
2780 Asm->OutStreamer.SwitchSection(
2781 Asm->getObjFileLowering().getDwarfARangesSection());
2783 typedef DenseMap<CompileUnit *, std::vector<ArangeSpan> > SpansType;
2787 // Build a list of sections used.
2788 std::vector<const MCSection *> Sections;
2789 for (SectionMapType::iterator it = SectionMap.begin(); it != SectionMap.end();
2791 const MCSection *Section = it->first;
2792 Sections.push_back(Section);
2795 // Sort the sections into order.
2796 // This is only done to ensure consistent output order across different runs.
2797 std::sort(Sections.begin(), Sections.end(), SectionSort);
2799 // Build a set of address spans, sorted by CU.
2800 for (size_t SecIdx = 0; SecIdx < Sections.size(); SecIdx++) {
2801 const MCSection *Section = Sections[SecIdx];
2802 SmallVector<SymbolCU, 8> &List = SectionMap[Section];
2803 if (List.size() < 2)
2806 // Sort the symbols by offset within the section.
2807 SymbolCUSorter sorter(Asm->OutStreamer);
2808 std::sort(List.begin(), List.end(), sorter);
2810 // If we have no section (e.g. common), just write out
2811 // individual spans for each symbol.
2812 if (Section == NULL) {
2813 for (size_t n = 0; n < List.size(); n++) {
2814 const SymbolCU &Cur = List[n];
2817 Span.Start = Cur.Sym;
2820 Spans[Cur.CU].push_back(Span);
2823 // Build spans between each label.
2824 const MCSymbol *StartSym = List[0].Sym;
2825 for (size_t n = 1; n < List.size(); n++) {
2826 const SymbolCU &Prev = List[n - 1];
2827 const SymbolCU &Cur = List[n];
2829 // Try and build the longest span we can within the same CU.
2830 if (Cur.CU != Prev.CU) {
2832 Span.Start = StartSym;
2834 Spans[Prev.CU].push_back(Span);
2841 const MCSection *ISec = Asm->getObjFileLowering().getDwarfInfoSection();
2842 unsigned PtrSize = Asm->getDataLayout().getPointerSize();
2844 // Build a list of CUs used.
2845 std::vector<CompileUnit *> CUs;
2846 for (SpansType::iterator it = Spans.begin(); it != Spans.end(); it++) {
2847 CompileUnit *CU = it->first;
2851 // Sort the CU list (again, to ensure consistent output order).
2852 std::sort(CUs.begin(), CUs.end(), CUSort);
2854 // Emit an arange table for each CU we used.
2855 for (size_t CUIdx = 0; CUIdx < CUs.size(); CUIdx++) {
2856 CompileUnit *CU = CUs[CUIdx];
2857 std::vector<ArangeSpan> &List = Spans[CU];
2859 // Emit size of content not including length itself.
2860 unsigned ContentSize =
2861 sizeof(int16_t) + // DWARF ARange version number
2862 sizeof(int32_t) + // Offset of CU in the .debug_info section
2863 sizeof(int8_t) + // Pointer Size (in bytes)
2864 sizeof(int8_t); // Segment Size (in bytes)
2866 unsigned TupleSize = PtrSize * 2;
2868 // 7.20 in the Dwarf specs requires the table to be aligned to a tuple.
2869 unsigned Padding = 0;
2870 while (((sizeof(int32_t) + ContentSize + Padding) % TupleSize) != 0)
2873 ContentSize += Padding;
2874 ContentSize += (List.size() + 1) * TupleSize;
2876 // For each compile unit, write the list of spans it covers.
2877 Asm->OutStreamer.AddComment("Length of ARange Set");
2878 Asm->EmitInt32(ContentSize);
2879 Asm->OutStreamer.AddComment("DWARF Arange version number");
2880 Asm->EmitInt16(dwarf::DW_ARANGES_VERSION);
2881 Asm->OutStreamer.AddComment("Offset Into Debug Info Section");
2882 Asm->EmitSectionOffset(
2883 Asm->GetTempSymbol(ISec->getLabelBeginName(), CU->getUniqueID()),
2884 DwarfInfoSectionSym);
2885 Asm->OutStreamer.AddComment("Address Size (in bytes)");
2886 Asm->EmitInt8(PtrSize);
2887 Asm->OutStreamer.AddComment("Segment Size (in bytes)");
2890 for (unsigned n = 0; n < Padding; n++)
2891 Asm->EmitInt8(0xff);
2893 for (unsigned n = 0; n < List.size(); n++) {
2894 const ArangeSpan &Span = List[n];
2895 Asm->EmitLabelReference(Span.Start, PtrSize);
2897 // Calculate the size as being from the span start to it's end.
2899 Asm->EmitLabelDifference(Span.End, Span.Start, PtrSize);
2901 // For symbols without an end marker (e.g. common), we
2902 // write a single arange entry containing just that one symbol.
2903 uint64_t Size = SymSize[Span.Start];
2907 Asm->OutStreamer.EmitIntValue(Size, PtrSize);
2911 Asm->OutStreamer.AddComment("ARange terminator");
2912 Asm->OutStreamer.EmitIntValue(0, PtrSize);
2913 Asm->OutStreamer.EmitIntValue(0, PtrSize);
2917 // Emit visible names into a debug ranges section.
2918 void DwarfDebug::emitDebugRanges() {
2919 // Start the dwarf ranges section.
2920 Asm->OutStreamer.SwitchSection(
2921 Asm->getObjFileLowering().getDwarfRangesSection());
2922 unsigned char Size = Asm->getDataLayout().getPointerSize();
2923 for (SmallVectorImpl<const MCSymbol *>::iterator
2924 I = DebugRangeSymbols.begin(),
2925 E = DebugRangeSymbols.end();
2928 Asm->OutStreamer.EmitSymbolValue(const_cast<MCSymbol *>(*I), Size);
2930 Asm->OutStreamer.EmitIntValue(0, Size);
2934 // Emit visible names into a debug macinfo section.
2935 void DwarfDebug::emitDebugMacInfo() {
2936 if (const MCSection *LineInfo =
2937 Asm->getObjFileLowering().getDwarfMacroInfoSection()) {
2938 // Start the dwarf macinfo section.
2939 Asm->OutStreamer.SwitchSection(LineInfo);
2943 // DWARF5 Experimental Separate Dwarf emitters.
2945 // This DIE has the following attributes: DW_AT_comp_dir, DW_AT_stmt_list,
2946 // DW_AT_low_pc, DW_AT_high_pc, DW_AT_ranges, DW_AT_dwo_name, DW_AT_dwo_id,
2947 // DW_AT_ranges_base, DW_AT_addr_base.
2948 CompileUnit *DwarfDebug::constructSkeletonCU(const CompileUnit *CU) {
2950 DIE *Die = new DIE(dwarf::DW_TAG_compile_unit);
2951 CompileUnit *NewCU = new CompileUnit(CU->getUniqueID(), Die, CU->getNode(),
2952 Asm, this, &SkeletonHolder);
2954 NewCU->addLocalString(Die, dwarf::DW_AT_GNU_dwo_name,
2955 CU->getNode().getSplitDebugFilename());
2957 // Relocate to the beginning of the addr_base section, else 0 for the
2958 // beginning of the one for this compile unit.
2959 if (Asm->MAI->doesDwarfUseRelocationsAcrossSections())
2960 NewCU->addLabel(Die, dwarf::DW_AT_GNU_addr_base, dwarf::DW_FORM_sec_offset,
2961 DwarfAddrSectionSym);
2963 NewCU->addUInt(Die, dwarf::DW_AT_GNU_addr_base, dwarf::DW_FORM_sec_offset,
2966 // 2.17.1 requires that we use DW_AT_low_pc for a single entry point
2967 // into an entity. We're using 0, or a NULL label for this.
2968 NewCU->addUInt(Die, dwarf::DW_AT_low_pc, dwarf::DW_FORM_addr, 0);
2970 // DW_AT_stmt_list is a offset of line number information for this
2971 // compile unit in debug_line section.
2972 // FIXME: Should handle multiple compile units.
2973 if (Asm->MAI->doesDwarfUseRelocationsAcrossSections())
2974 NewCU->addLabel(Die, dwarf::DW_AT_stmt_list, dwarf::DW_FORM_sec_offset,
2975 DwarfLineSectionSym);
2977 NewCU->addUInt(Die, dwarf::DW_AT_stmt_list, dwarf::DW_FORM_sec_offset, 0);
2979 if (!CompilationDir.empty())
2980 NewCU->addLocalString(Die, dwarf::DW_AT_comp_dir, CompilationDir);
2982 // Flags to let the linker know we have emitted new style pubnames.
2983 if (GenerateGnuPubSections) {
2984 if (Asm->MAI->doesDwarfUseRelocationsAcrossSections())
2985 NewCU->addLabel(Die, dwarf::DW_AT_GNU_pubnames, dwarf::DW_FORM_sec_offset,
2986 Asm->GetTempSymbol("gnu_pubnames", NewCU->getUniqueID()));
2988 NewCU->addDelta(Die, dwarf::DW_AT_GNU_pubnames, dwarf::DW_FORM_data4,
2989 Asm->GetTempSymbol("gnu_pubnames", NewCU->getUniqueID()),
2990 DwarfGnuPubNamesSectionSym);
2992 if (Asm->MAI->doesDwarfUseRelocationsAcrossSections())
2993 NewCU->addLabel(Die, dwarf::DW_AT_GNU_pubtypes, dwarf::DW_FORM_sec_offset,
2994 Asm->GetTempSymbol("gnu_pubtypes", NewCU->getUniqueID()));
2996 NewCU->addDelta(Die, dwarf::DW_AT_GNU_pubtypes, dwarf::DW_FORM_data4,
2997 Asm->GetTempSymbol("gnu_pubtypes", NewCU->getUniqueID()),
2998 DwarfGnuPubTypesSectionSym);
3001 // Flag if we've emitted any ranges and their location for the compile unit.
3002 if (DebugRangeSymbols.size()) {
3003 if (Asm->MAI->doesDwarfUseRelocationsAcrossSections())
3004 NewCU->addLabel(Die, dwarf::DW_AT_GNU_ranges_base,
3005 dwarf::DW_FORM_sec_offset, DwarfDebugRangeSectionSym);
3007 NewCU->addUInt(Die, dwarf::DW_AT_GNU_ranges_base, dwarf::DW_FORM_data4,
3011 SkeletonHolder.addUnit(NewCU);
3012 SkeletonCUs.push_back(NewCU);
3017 void DwarfDebug::emitSkeletonAbbrevs(const MCSection *Section) {
3018 assert(useSplitDwarf() && "No split dwarf debug info?");
3019 emitAbbrevs(Section, &SkeletonAbbrevs);
3022 // Emit the .debug_info.dwo section for separated dwarf. This contains the
3023 // compile units that would normally be in debug_info.
3024 void DwarfDebug::emitDebugInfoDWO() {
3025 assert(useSplitDwarf() && "No split dwarf debug info?");
3026 InfoHolder.emitUnits(this, Asm->getObjFileLowering().getDwarfInfoDWOSection(),
3027 Asm->getObjFileLowering().getDwarfAbbrevDWOSection(),
3028 DwarfAbbrevDWOSectionSym);
3031 // Emit the .debug_abbrev.dwo section for separated dwarf. This contains the
3032 // abbreviations for the .debug_info.dwo section.
3033 void DwarfDebug::emitDebugAbbrevDWO() {
3034 assert(useSplitDwarf() && "No split dwarf?");
3035 emitAbbrevs(Asm->getObjFileLowering().getDwarfAbbrevDWOSection(),
3039 // Emit the .debug_str.dwo section for separated dwarf. This contains the
3040 // string section and is identical in format to traditional .debug_str
3042 void DwarfDebug::emitDebugStrDWO() {
3043 assert(useSplitDwarf() && "No split dwarf?");
3044 const MCSection *OffSec =
3045 Asm->getObjFileLowering().getDwarfStrOffDWOSection();
3046 const MCSymbol *StrSym = DwarfStrSectionSym;
3047 InfoHolder.emitStrings(Asm->getObjFileLowering().getDwarfStrDWOSection(),
3051 void DwarfDebug::addTypeUnitType(DIE *RefDie, DICompositeType CTy) {
3052 DenseMap<const MDNode*, std::pair<uint64_t, SmallVectorImpl<DIE*>* > >::iterator I = TypeUnits.find(CTy);
3053 SmallVector<DIE *, 8> References;
3054 References.push_back(RefDie);
3055 if (I != TypeUnits.end()) {
3056 if (I->second.second) {
3057 I->second.second->push_back(RefDie);
3061 DIE *UnitDie = new DIE(dwarf::DW_TAG_type_unit);
3062 CompileUnit *NewCU =
3063 new CompileUnit(GlobalCUIndexCount++, UnitDie,
3064 dwarf::DW_LANG_C_plus_plus, Asm, this, &InfoHolder);
3065 CUDieMap.insert(std::make_pair(UnitDie, NewCU));
3066 NewCU->addUInt(UnitDie, dwarf::DW_AT_language, dwarf::DW_FORM_data2,
3067 dwarf::DW_LANG_C_plus_plus);
3069 // Register the type in the TypeUnits map with a vector of references to be
3070 // populated whenever a reference is required.
3071 I = TypeUnits.insert(std::make_pair(CTy, std::make_pair(0, &References)))
3074 // Construct the type, this may, recursively, require more type units that
3075 // may in turn require this type again - in which case they will add DIEs to
3076 // the References vector.
3077 DIE *Die = NewCU->createTypeDIE(CTy);
3079 if (GenerateODRHash && shouldAddODRHash(NewCU, Die))
3080 NewCU->addUInt(UnitDie, dwarf::DW_AT_GNU_odr_signature,
3081 dwarf::DW_FORM_data8,
3082 DIEHash().computeDIEODRSignature(*Die));
3083 // FIXME: This won't handle circularly referential structures, as the DIE
3084 // may have references to other DIEs still under construction and missing
3085 // their signature. Hashing should walk through the signatures to their
3086 // referenced type, or possibly walk the precomputed hashes of related types
3088 uint64_t Signature = DIEHash().computeTypeSignature(*Die);
3090 // Remove the References vector and add the type hash.
3091 I->second.first = Signature;
3092 I->second.second = NULL;
3095 InfoHolder.addUnit(NewCU);
3098 // Populate all the signatures.
3099 for (unsigned i = 0, e = References.size(); i != e; ++i) {
3100 CUMap.begin()->second->addUInt(References[i], dwarf::DW_AT_signature,
3101 dwarf::DW_FORM_ref_sig8, I->second.first);