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."),
67 GenerateCUHash("generate-cu-hash", cl::Hidden,
68 cl::desc("Add the CU hash as the dwo_id."),
72 GenerateGnuPubSections("generate-gnu-dwarf-pub-sections", cl::Hidden,
73 cl::desc("Generate GNU-style pubnames and pubtypes"),
84 static cl::opt<DefaultOnOff>
85 DwarfAccelTables("dwarf-accel-tables", cl::Hidden,
86 cl::desc("Output prototype dwarf accelerator tables."),
87 cl::values(clEnumVal(Default, "Default for platform"),
88 clEnumVal(Enable, "Enabled"),
89 clEnumVal(Disable, "Disabled"), clEnumValEnd),
92 static cl::opt<DefaultOnOff>
93 SplitDwarf("split-dwarf", cl::Hidden,
94 cl::desc("Output prototype dwarf split debug info."),
95 cl::values(clEnumVal(Default, "Default for platform"),
96 clEnumVal(Enable, "Enabled"),
97 clEnumVal(Disable, "Disabled"), clEnumValEnd),
100 static cl::opt<DefaultOnOff>
101 DwarfPubSections("generate-dwarf-pub-sections", cl::Hidden,
102 cl::desc("Generate DWARF pubnames and pubtypes sections"),
103 cl::values(clEnumVal(Default, "Default for platform"),
104 clEnumVal(Enable, "Enabled"),
105 clEnumVal(Disable, "Disabled"), clEnumValEnd),
108 static const char *const DWARFGroupName = "DWARF Emission";
109 static const char *const DbgTimerName = "DWARF Debug Writer";
111 //===----------------------------------------------------------------------===//
113 // Configuration values for initial hash set sizes (log2).
115 static const unsigned InitAbbreviationsSetSize = 9; // log2(512)
119 /// resolve - Look in the DwarfDebug map for the MDNode that
120 /// corresponds to the reference.
121 template <typename T>
122 T DbgVariable::resolve(DIRef<T> Ref) const {
123 return DD->resolve(Ref);
126 DIType DbgVariable::getType() const {
127 DIType Ty = Var.getType();
128 // FIXME: isBlockByrefVariable should be reformulated in terms of complex
129 // addresses instead.
130 if (Var.isBlockByrefVariable()) {
131 /* Byref variables, in Blocks, are declared by the programmer as
132 "SomeType VarName;", but the compiler creates a
133 __Block_byref_x_VarName struct, and gives the variable VarName
134 either the struct, or a pointer to the struct, as its type. This
135 is necessary for various behind-the-scenes things the compiler
136 needs to do with by-reference variables in blocks.
138 However, as far as the original *programmer* is concerned, the
139 variable should still have type 'SomeType', as originally declared.
141 The following function dives into the __Block_byref_x_VarName
142 struct to find the original type of the variable. This will be
143 passed back to the code generating the type for the Debug
144 Information Entry for the variable 'VarName'. 'VarName' will then
145 have the original type 'SomeType' in its debug information.
147 The original type 'SomeType' will be the type of the field named
148 'VarName' inside the __Block_byref_x_VarName struct.
150 NOTE: In order for this to not completely fail on the debugger
151 side, the Debug Information Entry for the variable VarName needs to
152 have a DW_AT_location that tells the debugger how to unwind through
153 the pointers and __Block_byref_x_VarName struct to find the actual
154 value of the variable. The function addBlockByrefType does this. */
156 uint16_t tag = Ty.getTag();
158 if (tag == dwarf::DW_TAG_pointer_type)
159 subType = resolve(DIDerivedType(Ty).getTypeDerivedFrom());
161 DIArray Elements = DICompositeType(subType).getTypeArray();
162 for (unsigned i = 0, N = Elements.getNumElements(); i < N; ++i) {
163 DIDerivedType DT = DIDerivedType(Elements.getElement(i));
164 if (getName() == DT.getName())
165 return (resolve(DT.getTypeDerivedFrom()));
171 } // end llvm namespace
173 /// Return Dwarf Version by checking module flags.
174 static unsigned getDwarfVersionFromModule(const Module *M) {
175 Value *Val = M->getModuleFlag("Dwarf Version");
177 return dwarf::DWARF_VERSION;
178 return cast<ConstantInt>(Val)->getZExtValue();
181 DwarfDebug::DwarfDebug(AsmPrinter *A, Module *M)
182 : Asm(A), MMI(Asm->MMI), FirstCU(0),
183 AbbreviationsSet(InitAbbreviationsSetSize),
184 SourceIdMap(DIEValueAllocator),
185 PrevLabel(NULL), GlobalCUIndexCount(0),
186 InfoHolder(A, &AbbreviationsSet, Abbreviations, "info_string",
188 SkeletonAbbrevSet(InitAbbreviationsSetSize),
189 SkeletonHolder(A, &SkeletonAbbrevSet, SkeletonAbbrevs, "skel_string",
192 DwarfInfoSectionSym = DwarfAbbrevSectionSym = 0;
193 DwarfStrSectionSym = TextSectionSym = 0;
194 DwarfDebugRangeSectionSym = DwarfDebugLocSectionSym = DwarfLineSectionSym = 0;
195 DwarfAddrSectionSym = 0;
196 DwarfAbbrevDWOSectionSym = DwarfStrDWOSectionSym = 0;
197 FunctionBeginSym = FunctionEndSym = 0;
199 // Turn on accelerator tables for Darwin by default, pubnames by
200 // default for non-Darwin, and handle split dwarf.
201 bool IsDarwin = Triple(A->getTargetTriple()).isOSDarwin();
203 if (DwarfAccelTables == Default)
204 HasDwarfAccelTables = IsDarwin;
206 HasDwarfAccelTables = DwarfAccelTables == Enable;
208 if (SplitDwarf == Default)
209 HasSplitDwarf = false;
211 HasSplitDwarf = SplitDwarf == Enable;
213 if (DwarfPubSections == Default)
214 HasDwarfPubSections = !IsDarwin;
216 HasDwarfPubSections = DwarfPubSections == Enable;
218 DwarfVersion = getDwarfVersionFromModule(MMI->getModule());
221 NamedRegionTimer T(DbgTimerName, DWARFGroupName, TimePassesIsEnabled);
226 // Switch to the specified MCSection and emit an assembler
227 // temporary label to it if SymbolStem is specified.
228 static MCSymbol *emitSectionSym(AsmPrinter *Asm, const MCSection *Section,
229 const char *SymbolStem = 0) {
230 Asm->OutStreamer.SwitchSection(Section);
231 if (!SymbolStem) return 0;
233 MCSymbol *TmpSym = Asm->GetTempSymbol(SymbolStem);
234 Asm->OutStreamer.EmitLabel(TmpSym);
238 MCSymbol *DwarfUnits::getStringPoolSym() {
239 return Asm->GetTempSymbol(StringPref);
242 MCSymbol *DwarfUnits::getStringPoolEntry(StringRef Str) {
243 std::pair<MCSymbol*, unsigned> &Entry =
244 StringPool.GetOrCreateValue(Str).getValue();
245 if (Entry.first) return Entry.first;
247 Entry.second = NextStringPoolNumber++;
248 return Entry.first = Asm->GetTempSymbol(StringPref, Entry.second);
251 unsigned DwarfUnits::getStringPoolIndex(StringRef Str) {
252 std::pair<MCSymbol*, unsigned> &Entry =
253 StringPool.GetOrCreateValue(Str).getValue();
254 if (Entry.first) return Entry.second;
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)) return false;
299 return Name.find(") ") != StringRef::npos;
302 static void getObjCClassCategory(StringRef In, StringRef &Class,
303 StringRef &Category) {
304 if (!hasObjCCategory(In)) {
305 Class = In.slice(In.find('[') + 1, In.find(' '));
310 Class = In.slice(In.find('[') + 1, In.find('('));
311 Category = In.slice(In.find('[') + 1, In.find(' '));
315 static StringRef getObjCMethodName(StringRef In) {
316 return In.slice(In.find(' ') + 1, In.find(']'));
319 // Helper for sorting sections into a stable output order.
320 static bool SectionSort(const MCSection *A, const MCSection *B) {
321 std::string LA = (A ? A->getLabelBeginName() : "");
322 std::string LB = (B ? B->getLabelBeginName() : "");
326 // Add the various names to the Dwarf accelerator table names.
327 // TODO: Determine whether or not we should add names for programs
328 // that do not have a DW_AT_name or DW_AT_linkage_name field - this
329 // is only slightly different than the lookup of non-standard ObjC names.
330 static void addSubprogramNames(CompileUnit *TheCU, DISubprogram SP,
332 if (!SP.isDefinition()) return;
333 TheCU->addAccelName(SP.getName(), Die);
335 // If the linkage name is different than the name, go ahead and output
336 // that as well into the name table.
337 if (SP.getLinkageName() != "" && SP.getName() != SP.getLinkageName())
338 TheCU->addAccelName(SP.getLinkageName(), Die);
340 // If this is an Objective-C selector name add it to the ObjC accelerator
342 if (isObjCClass(SP.getName())) {
343 StringRef Class, Category;
344 getObjCClassCategory(SP.getName(), Class, Category);
345 TheCU->addAccelObjC(Class, Die);
347 TheCU->addAccelObjC(Category, Die);
348 // Also add the base method name to the name table.
349 TheCU->addAccelName(getObjCMethodName(SP.getName()), Die);
353 /// isSubprogramContext - Return true if Context is either a subprogram
354 /// or another context nested inside a subprogram.
355 bool DwarfDebug::isSubprogramContext(const MDNode *Context) {
358 DIDescriptor D(Context);
359 if (D.isSubprogram())
362 return isSubprogramContext(resolve(DIType(Context).getContext()));
366 // Find DIE for the given subprogram and attach appropriate DW_AT_low_pc
367 // and DW_AT_high_pc attributes. If there are global variables in this
368 // scope then create and insert DIEs for these variables.
369 DIE *DwarfDebug::updateSubprogramScopeDIE(CompileUnit *SPCU, DISubprogram SP) {
370 DIE *SPDie = SPCU->getDIE(SP);
372 assert(SPDie && "Unable to find subprogram DIE!");
374 // If we're updating an abstract DIE, then we will be adding the children and
375 // object pointer later on. But what we don't want to do is process the
376 // concrete DIE twice.
377 if (DIE *AbsSPDIE = AbstractSPDies.lookup(SP)) {
378 // Pick up abstract subprogram DIE.
379 SPDie = SPCU->createAndAddDIE(dwarf::DW_TAG_subprogram, *SPCU->getCUDie());
380 SPCU->addDIEEntry(SPDie, dwarf::DW_AT_abstract_origin, AbsSPDIE);
382 DISubprogram SPDecl = SP.getFunctionDeclaration();
383 if (!SPDecl.isSubprogram()) {
384 // There is not any need to generate specification DIE for a function
385 // defined at compile unit level. If a function is defined inside another
386 // function then gdb prefers the definition at top level and but does not
387 // expect specification DIE in parent function. So avoid creating
388 // specification DIE for a function defined inside a function.
389 DIScope SPContext = resolve(SP.getContext());
390 if (SP.isDefinition() && !SPContext.isCompileUnit() &&
391 !SPContext.isFile() &&
392 !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 = DIType(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(SPDie, dwarf::DW_AT_low_pc,
419 Asm->GetTempSymbol("func_begin",
420 Asm->getFunctionNumber()));
421 SPCU->addLabelAddress(SPDie, dwarf::DW_AT_high_pc,
422 Asm->GetTempSymbol("func_end",
423 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(),
477 RE = Ranges.end(); RI != RE; ++RI) {
478 DebugRangeSymbols.push_back(getLabelBeforeInsn(RI->first));
479 DebugRangeSymbols.push_back(getLabelAfterInsn(RI->second));
482 // Terminate the range list.
483 DebugRangeSymbols.push_back(NULL);
484 DebugRangeSymbols.push_back(NULL);
488 // Construct the address range for this DIE.
489 SmallVectorImpl<InsnRange>::const_iterator RI = Ranges.begin();
490 MCSymbol *Start = getLabelBeforeInsn(RI->first);
491 MCSymbol *End = getLabelAfterInsn(RI->second);
492 assert(End && "End label should not be null!");
494 assert(Start->isDefined() && "Invalid starting label for an inlined scope!");
495 assert(End->isDefined() && "Invalid end label for an inlined scope!");
497 TheCU->addLabelAddress(ScopeDIE, dwarf::DW_AT_low_pc, Start);
498 TheCU->addLabelAddress(ScopeDIE, dwarf::DW_AT_high_pc, End);
503 // This scope represents inlined body of a function. Construct DIE to
504 // represent this concrete inlined copy of the function.
505 DIE *DwarfDebug::constructInlinedScopeDIE(CompileUnit *TheCU,
506 LexicalScope *Scope) {
507 const SmallVectorImpl<InsnRange> &Ranges = Scope->getRanges();
508 assert(Ranges.empty() == false &&
509 "LexicalScope does not have instruction markers!");
511 if (!Scope->getScopeNode())
513 DIScope DS(Scope->getScopeNode());
514 DISubprogram InlinedSP = getDISubprogram(DS);
515 DIE *OriginDIE = TheCU->getDIE(InlinedSP);
517 DEBUG(dbgs() << "Unable to find original DIE for an inlined subprogram.");
521 DIE *ScopeDIE = new DIE(dwarf::DW_TAG_inlined_subroutine);
522 TheCU->addDIEEntry(ScopeDIE, dwarf::DW_AT_abstract_origin, OriginDIE);
524 if (Ranges.size() > 1) {
525 // .debug_range section has not been laid out yet. Emit offset in
526 // .debug_range as a uint, size 4, for now. emitDIE will handle
527 // DW_AT_ranges appropriately.
528 TheCU->addUInt(ScopeDIE, dwarf::DW_AT_ranges, dwarf::DW_FORM_data4,
529 DebugRangeSymbols.size()
530 * Asm->getDataLayout().getPointerSize());
531 for (SmallVectorImpl<InsnRange>::const_iterator RI = Ranges.begin(),
532 RE = Ranges.end(); RI != RE; ++RI) {
533 DebugRangeSymbols.push_back(getLabelBeforeInsn(RI->first));
534 DebugRangeSymbols.push_back(getLabelAfterInsn(RI->second));
536 DebugRangeSymbols.push_back(NULL);
537 DebugRangeSymbols.push_back(NULL);
539 SmallVectorImpl<InsnRange>::const_iterator RI = Ranges.begin();
540 MCSymbol *StartLabel = getLabelBeforeInsn(RI->first);
541 MCSymbol *EndLabel = getLabelAfterInsn(RI->second);
543 if (StartLabel == 0 || EndLabel == 0)
544 llvm_unreachable("Unexpected Start and End labels for an inlined scope!");
546 assert(StartLabel->isDefined() &&
547 "Invalid starting label for an inlined scope!");
548 assert(EndLabel->isDefined() && "Invalid end label for an inlined scope!");
550 TheCU->addLabelAddress(ScopeDIE, dwarf::DW_AT_low_pc, StartLabel);
551 TheCU->addLabelAddress(ScopeDIE, dwarf::DW_AT_high_pc, EndLabel);
554 InlinedSubprogramDIEs.insert(OriginDIE);
556 // Add the call site information to the DIE.
557 DILocation DL(Scope->getInlinedAt());
558 TheCU->addUInt(ScopeDIE, dwarf::DW_AT_call_file, None,
559 getOrCreateSourceID(DL.getFilename(), DL.getDirectory(),
560 TheCU->getUniqueID()));
561 TheCU->addUInt(ScopeDIE, dwarf::DW_AT_call_line, None, DL.getLineNumber());
563 // Add name to the name table, we do this here because we're guaranteed
564 // to have concrete versions of our DW_TAG_inlined_subprogram nodes.
565 addSubprogramNames(TheCU, InlinedSP, ScopeDIE);
570 DIE *DwarfDebug::createScopeChildrenDIE(CompileUnit *TheCU, LexicalScope *Scope,
571 SmallVectorImpl<DIE*> &Children) {
572 DIE *ObjectPointer = NULL;
574 // Collect arguments for current function.
575 if (LScopes.isCurrentFunctionScope(Scope))
576 for (unsigned i = 0, N = CurrentFnArguments.size(); i < N; ++i)
577 if (DbgVariable *ArgDV = CurrentFnArguments[i])
579 TheCU->constructVariableDIE(*ArgDV, Scope->isAbstractScope())) {
580 Children.push_back(Arg);
581 if (ArgDV->isObjectPointer()) ObjectPointer = Arg;
584 // Collect lexical scope children first.
585 const SmallVectorImpl<DbgVariable *> &Variables =ScopeVariables.lookup(Scope);
586 for (unsigned i = 0, N = Variables.size(); i < N; ++i)
588 TheCU->constructVariableDIE(*Variables[i], Scope->isAbstractScope())) {
589 Children.push_back(Variable);
590 if (Variables[i]->isObjectPointer()) ObjectPointer = Variable;
592 const SmallVectorImpl<LexicalScope *> &Scopes = Scope->getChildren();
593 for (unsigned j = 0, M = Scopes.size(); j < M; ++j)
594 if (DIE *Nested = constructScopeDIE(TheCU, Scopes[j]))
595 Children.push_back(Nested);
596 return ObjectPointer;
599 // Construct a DIE for this scope.
600 DIE *DwarfDebug::constructScopeDIE(CompileUnit *TheCU, LexicalScope *Scope) {
601 if (!Scope || !Scope->getScopeNode())
604 DIScope DS(Scope->getScopeNode());
606 SmallVector<DIE *, 8> Children;
607 DIE *ObjectPointer = NULL;
608 bool ChildrenCreated = false;
610 // We try to create the scope DIE first, then the children DIEs. This will
611 // avoid creating un-used children then removing them later when we find out
612 // the scope DIE is null.
613 DIE *ScopeDIE = NULL;
614 if (Scope->getInlinedAt())
615 ScopeDIE = constructInlinedScopeDIE(TheCU, Scope);
616 else if (DS.isSubprogram()) {
617 ProcessedSPNodes.insert(DS);
618 if (Scope->isAbstractScope()) {
619 ScopeDIE = TheCU->getDIE(DS);
620 // Note down abstract DIE.
622 AbstractSPDies.insert(std::make_pair(DS, ScopeDIE));
625 ScopeDIE = updateSubprogramScopeDIE(TheCU, DISubprogram(DS));
628 // Early exit when we know the scope DIE is going to be null.
629 if (isLexicalScopeDIENull(Scope))
632 // We create children here when we know the scope DIE is not going to be
633 // null and the children will be added to the scope DIE.
634 ObjectPointer = createScopeChildrenDIE(TheCU, Scope, Children);
635 ChildrenCreated = true;
637 // There is no need to emit empty lexical block DIE.
638 std::pair<ImportedEntityMap::const_iterator,
639 ImportedEntityMap::const_iterator> Range = std::equal_range(
640 ScopesWithImportedEntities.begin(), ScopesWithImportedEntities.end(),
641 std::pair<const MDNode *, const MDNode *>(DS, (const MDNode*)0),
643 if (Children.empty() && Range.first == Range.second)
645 ScopeDIE = constructLexicalScopeDIE(TheCU, Scope);
646 assert(ScopeDIE && "Scope DIE should not be null.");
647 for (ImportedEntityMap::const_iterator i = Range.first; i != Range.second;
649 constructImportedEntityDIE(TheCU, i->second, ScopeDIE);
653 assert(Children.empty() &&
654 "We create children only when the scope DIE is not null.");
657 if (!ChildrenCreated)
658 // We create children when the scope DIE is not null.
659 ObjectPointer = createScopeChildrenDIE(TheCU, Scope, Children);
662 for (SmallVectorImpl<DIE *>::iterator I = Children.begin(),
663 E = Children.end(); I != E; ++I)
664 ScopeDIE->addChild(*I);
666 if (DS.isSubprogram() && ObjectPointer != NULL)
667 TheCU->addDIEEntry(ScopeDIE, dwarf::DW_AT_object_pointer, ObjectPointer);
669 if (DS.isSubprogram())
670 TheCU->addPubTypes(DISubprogram(DS));
675 // Look up the source id with the given directory and source file names.
676 // If none currently exists, create a new id and insert it in the
677 // SourceIds map. This can update DirectoryNames and SourceFileNames maps
679 unsigned DwarfDebug::getOrCreateSourceID(StringRef FileName,
680 StringRef DirName, unsigned CUID) {
681 // If we use .loc in assembly, we can't separate .file entries according to
682 // compile units. Thus all files will belong to the default compile unit.
684 // FIXME: add a better feature test than hasRawTextSupport. Even better,
685 // extend .file to support this.
686 if (Asm->TM.hasMCUseLoc() && Asm->OutStreamer.hasRawTextSupport())
689 // If FE did not provide a file name, then assume stdin.
690 if (FileName.empty())
691 return getOrCreateSourceID("<stdin>", StringRef(), CUID);
693 // TODO: this might not belong here. See if we can factor this better.
694 if (DirName == CompilationDir)
697 // FileIDCUMap stores the current ID for the given compile unit.
698 unsigned SrcId = FileIDCUMap[CUID] + 1;
700 // We look up the CUID/file/dir by concatenating them with a zero byte.
701 SmallString<128> NamePair;
702 NamePair += utostr(CUID);
705 NamePair += '\0'; // Zero bytes are not allowed in paths.
706 NamePair += FileName;
708 StringMapEntry<unsigned> &Ent = SourceIdMap.GetOrCreateValue(NamePair, SrcId);
709 if (Ent.getValue() != SrcId)
710 return Ent.getValue();
712 FileIDCUMap[CUID] = SrcId;
713 // Print out a .file directive to specify files for .loc directives.
714 Asm->OutStreamer.EmitDwarfFileDirective(SrcId, DirName, FileName, CUID);
719 // Create new CompileUnit for the given metadata node with tag
720 // DW_TAG_compile_unit.
721 CompileUnit *DwarfDebug::constructCompileUnit(DICompileUnit DIUnit) {
722 StringRef FN = DIUnit.getFilename();
723 CompilationDir = DIUnit.getDirectory();
725 DIE *Die = new DIE(dwarf::DW_TAG_compile_unit);
726 CompileUnit *NewCU = new CompileUnit(GlobalCUIndexCount++, Die, DIUnit, Asm,
729 FileIDCUMap[NewCU->getUniqueID()] = 0;
730 // Call this to emit a .file directive if it wasn't emitted for the source
731 // file this CU comes from yet.
732 getOrCreateSourceID(FN, CompilationDir, NewCU->getUniqueID());
734 NewCU->addString(Die, dwarf::DW_AT_producer, DIUnit.getProducer());
735 NewCU->addUInt(Die, dwarf::DW_AT_language, dwarf::DW_FORM_data2,
736 DIUnit.getLanguage());
737 NewCU->addString(Die, dwarf::DW_AT_name, FN);
739 // 2.17.1 requires that we use DW_AT_low_pc for a single entry point
740 // into an entity. We're using 0 (or a NULL label) for this. For
741 // split dwarf it's in the skeleton CU so omit it here.
742 if (!useSplitDwarf())
743 NewCU->addLabelAddress(Die, dwarf::DW_AT_low_pc, NULL);
745 // Define start line table label for each Compile Unit.
746 MCSymbol *LineTableStartSym = Asm->GetTempSymbol("line_table_start",
747 NewCU->getUniqueID());
748 Asm->OutStreamer.getContext().setMCLineTableSymbol(LineTableStartSym,
749 NewCU->getUniqueID());
751 // Use a single line table if we are using .loc and generating assembly.
753 (Asm->TM.hasMCUseLoc() && Asm->OutStreamer.hasRawTextSupport()) ||
754 (NewCU->getUniqueID() == 0);
756 if (!useSplitDwarf()) {
757 // DW_AT_stmt_list is a offset of line number information for this
758 // compile unit in debug_line section. For split dwarf this is
759 // left in the skeleton CU and so not included.
760 // The line table entries are not always emitted in assembly, so it
761 // is not okay to use line_table_start here.
762 if (Asm->MAI->doesDwarfUseRelocationsAcrossSections())
763 NewCU->addLabel(Die, dwarf::DW_AT_stmt_list, dwarf::DW_FORM_sec_offset,
764 UseTheFirstCU ? Asm->GetTempSymbol("section_line")
765 : LineTableStartSym);
766 else if (UseTheFirstCU)
767 NewCU->addUInt(Die, dwarf::DW_AT_stmt_list, dwarf::DW_FORM_data4, 0);
769 NewCU->addDelta(Die, dwarf::DW_AT_stmt_list, dwarf::DW_FORM_data4,
770 LineTableStartSym, DwarfLineSectionSym);
772 // If we're using split dwarf the compilation dir is going to be in the
773 // skeleton CU and so we don't need to duplicate it here.
774 if (!CompilationDir.empty())
775 NewCU->addString(Die, dwarf::DW_AT_comp_dir, CompilationDir);
777 // Flags to let the linker know we have emitted new style pubnames. Only
778 // emit it here if we don't have a skeleton CU for split dwarf.
779 if (GenerateGnuPubSections) {
780 if (Asm->MAI->doesDwarfUseRelocationsAcrossSections())
781 NewCU->addLabel(Die, dwarf::DW_AT_GNU_pubnames,
782 dwarf::DW_FORM_sec_offset,
783 Asm->GetTempSymbol("gnu_pubnames",
784 NewCU->getUniqueID()));
786 NewCU->addDelta(Die, dwarf::DW_AT_GNU_pubnames, dwarf::DW_FORM_data4,
787 Asm->GetTempSymbol("gnu_pubnames",
788 NewCU->getUniqueID()),
789 DwarfGnuPubNamesSectionSym);
791 if (Asm->MAI->doesDwarfUseRelocationsAcrossSections())
792 NewCU->addLabel(Die, dwarf::DW_AT_GNU_pubtypes,
793 dwarf::DW_FORM_sec_offset,
794 Asm->GetTempSymbol("gnu_pubtypes",
795 NewCU->getUniqueID()));
797 NewCU->addDelta(Die, dwarf::DW_AT_GNU_pubtypes, dwarf::DW_FORM_data4,
798 Asm->GetTempSymbol("gnu_pubtypes",
799 NewCU->getUniqueID()),
800 DwarfGnuPubTypesSectionSym);
804 if (DIUnit.isOptimized())
805 NewCU->addFlag(Die, dwarf::DW_AT_APPLE_optimized);
807 StringRef Flags = DIUnit.getFlags();
809 NewCU->addString(Die, dwarf::DW_AT_APPLE_flags, Flags);
811 if (unsigned RVer = DIUnit.getRunTimeVersion())
812 NewCU->addUInt(Die, dwarf::DW_AT_APPLE_major_runtime_vers,
813 dwarf::DW_FORM_data1, RVer);
818 InfoHolder.addUnit(NewCU);
820 CUMap.insert(std::make_pair(DIUnit, NewCU));
821 CUDieMap.insert(std::make_pair(Die, NewCU));
825 // Construct subprogram DIE.
826 void DwarfDebug::constructSubprogramDIE(CompileUnit *TheCU, const MDNode *N) {
827 // FIXME: We should only call this routine once, however, during LTO if a
828 // program is defined in multiple CUs we could end up calling it out of
829 // beginModule as we walk the CUs.
831 CompileUnit *&CURef = SPMap[N];
837 if (!SP.isDefinition())
838 // This is a method declaration which will be handled while constructing
842 DIE *SubprogramDie = TheCU->getOrCreateSubprogramDIE(SP);
844 // Expose as a global name.
845 TheCU->addGlobalName(SP.getName(), SubprogramDie, resolve(SP.getContext()));
848 void DwarfDebug::constructImportedEntityDIE(CompileUnit *TheCU,
850 DIImportedEntity Module(N);
851 if (!Module.Verify())
853 if (DIE *D = TheCU->getOrCreateContextDIE(Module.getContext()))
854 constructImportedEntityDIE(TheCU, Module, D);
857 void DwarfDebug::constructImportedEntityDIE(CompileUnit *TheCU, const MDNode *N,
859 DIImportedEntity Module(N);
860 if (!Module.Verify())
862 return constructImportedEntityDIE(TheCU, Module, Context);
865 void DwarfDebug::constructImportedEntityDIE(CompileUnit *TheCU,
866 const DIImportedEntity &Module,
868 assert(Module.Verify() &&
869 "Use one of the MDNode * overloads to handle invalid metadata");
870 assert(Context && "Should always have a context for an imported_module");
871 DIE *IMDie = new DIE(Module.getTag());
872 TheCU->insertDIE(Module, IMDie);
874 DIDescriptor Entity = Module.getEntity();
875 if (Entity.isNameSpace())
876 EntityDie = TheCU->getOrCreateNameSpace(DINameSpace(Entity));
877 else if (Entity.isSubprogram())
878 EntityDie = TheCU->getOrCreateSubprogramDIE(DISubprogram(Entity));
879 else if (Entity.isType())
880 EntityDie = TheCU->getOrCreateTypeDIE(DIType(Entity));
882 EntityDie = TheCU->getDIE(Entity);
883 unsigned FileID = getOrCreateSourceID(Module.getContext().getFilename(),
884 Module.getContext().getDirectory(),
885 TheCU->getUniqueID());
886 TheCU->addUInt(IMDie, dwarf::DW_AT_decl_file, None, FileID);
887 TheCU->addUInt(IMDie, dwarf::DW_AT_decl_line, None, Module.getLineNumber());
888 TheCU->addDIEEntry(IMDie, dwarf::DW_AT_import, EntityDie);
889 StringRef Name = Module.getName();
891 TheCU->addString(IMDie, dwarf::DW_AT_name, Name);
892 Context->addChild(IMDie);
895 // Emit all Dwarf sections that should come prior to the content. Create
896 // global DIEs and emit initial debug info sections. This is invoked by
897 // the target AsmPrinter.
898 void DwarfDebug::beginModule() {
899 if (DisableDebugInfoPrinting)
902 const Module *M = MMI->getModule();
904 // If module has named metadata anchors then use them, otherwise scan the
905 // module using debug info finder to collect debug info.
906 NamedMDNode *CU_Nodes = M->getNamedMetadata("llvm.dbg.cu");
909 TypeIdentifierMap = generateDITypeIdentifierMap(CU_Nodes);
911 // Emit initial sections so we can reference labels later.
914 for (unsigned i = 0, e = CU_Nodes->getNumOperands(); i != e; ++i) {
915 DICompileUnit CUNode(CU_Nodes->getOperand(i));
916 CompileUnit *CU = constructCompileUnit(CUNode);
917 DIArray ImportedEntities = CUNode.getImportedEntities();
918 for (unsigned i = 0, e = ImportedEntities.getNumElements(); i != e; ++i)
919 ScopesWithImportedEntities.push_back(std::make_pair(
920 DIImportedEntity(ImportedEntities.getElement(i)).getContext(),
921 ImportedEntities.getElement(i)));
922 std::sort(ScopesWithImportedEntities.begin(),
923 ScopesWithImportedEntities.end(), less_first());
924 DIArray GVs = CUNode.getGlobalVariables();
925 for (unsigned i = 0, e = GVs.getNumElements(); i != e; ++i)
926 CU->createGlobalVariableDIE(GVs.getElement(i));
927 DIArray SPs = CUNode.getSubprograms();
928 for (unsigned i = 0, e = SPs.getNumElements(); i != e; ++i)
929 constructSubprogramDIE(CU, SPs.getElement(i));
930 DIArray EnumTypes = CUNode.getEnumTypes();
931 for (unsigned i = 0, e = EnumTypes.getNumElements(); i != e; ++i)
932 CU->getOrCreateTypeDIE(EnumTypes.getElement(i));
933 DIArray RetainedTypes = CUNode.getRetainedTypes();
934 for (unsigned i = 0, e = RetainedTypes.getNumElements(); i != e; ++i)
935 CU->getOrCreateTypeDIE(RetainedTypes.getElement(i));
936 // Emit imported_modules last so that the relevant context is already
938 for (unsigned i = 0, e = ImportedEntities.getNumElements(); i != e; ++i)
939 constructImportedEntityDIE(CU, ImportedEntities.getElement(i));
942 // Tell MMI that we have debug info.
943 MMI->setDebugInfoAvailability(true);
945 // Prime section data.
946 SectionMap[Asm->getObjFileLowering().getTextSection()];
949 // Attach DW_AT_inline attribute with inlined subprogram DIEs.
950 void DwarfDebug::computeInlinedDIEs() {
951 // Attach DW_AT_inline attribute with inlined subprogram DIEs.
952 for (SmallPtrSet<DIE *, 4>::iterator AI = InlinedSubprogramDIEs.begin(),
953 AE = InlinedSubprogramDIEs.end(); AI != AE; ++AI) {
955 FirstCU->addUInt(ISP, dwarf::DW_AT_inline, None, dwarf::DW_INL_inlined);
957 for (DenseMap<const MDNode *, DIE *>::iterator AI = AbstractSPDies.begin(),
958 AE = AbstractSPDies.end(); AI != AE; ++AI) {
959 DIE *ISP = AI->second;
960 if (InlinedSubprogramDIEs.count(ISP))
962 FirstCU->addUInt(ISP, dwarf::DW_AT_inline, None, dwarf::DW_INL_inlined);
966 // Collect info for variables that were optimized out.
967 void DwarfDebug::collectDeadVariables() {
968 const Module *M = MMI->getModule();
970 if (NamedMDNode *CU_Nodes = M->getNamedMetadata("llvm.dbg.cu")) {
971 for (unsigned i = 0, e = CU_Nodes->getNumOperands(); i != e; ++i) {
972 DICompileUnit TheCU(CU_Nodes->getOperand(i));
973 DIArray Subprograms = TheCU.getSubprograms();
974 for (unsigned i = 0, e = Subprograms.getNumElements(); i != e; ++i) {
975 DISubprogram SP(Subprograms.getElement(i));
976 if (ProcessedSPNodes.count(SP) != 0)
978 if (!SP.isSubprogram())
980 if (!SP.isDefinition())
982 DIArray Variables = SP.getVariables();
983 if (Variables.getNumElements() == 0)
986 // Construct subprogram DIE and add variables DIEs.
987 CompileUnit *SPCU = CUMap.lookup(TheCU);
988 assert(SPCU && "Unable to find Compile Unit!");
989 // FIXME: See the comment in constructSubprogramDIE about duplicate
991 constructSubprogramDIE(SPCU, SP);
992 DIE *SPDIE = SPCU->getDIE(SP);
993 for (unsigned vi = 0, ve = Variables.getNumElements(); vi != ve; ++vi) {
994 DIVariable DV(Variables.getElement(vi));
995 if (!DV.isVariable())
997 DbgVariable NewVar(DV, NULL, this);
998 if (DIE *VariableDIE =
999 SPCU->constructVariableDIE(NewVar, false))
1000 SPDIE->addChild(VariableDIE);
1007 // Type Signature [7.27] and ODR Hash code.
1009 /// \brief Grabs the string in whichever attribute is passed in and returns
1010 /// a reference to it. Returns "" if the attribute doesn't exist.
1011 static StringRef getDIEStringAttr(DIE *Die, unsigned Attr) {
1012 DIEValue *V = Die->findAttribute(Attr);
1014 if (DIEString *S = dyn_cast_or_null<DIEString>(V))
1015 return S->getString();
1017 return StringRef("");
1020 /// Return true if the current DIE is contained within an anonymous namespace.
1021 static bool isContainedInAnonNamespace(DIE *Die) {
1022 DIE *Parent = Die->getParent();
1025 if (Parent->getTag() == dwarf::DW_TAG_namespace &&
1026 getDIEStringAttr(Parent, dwarf::DW_AT_name) == "")
1028 Parent = Parent->getParent();
1034 /// Test if the current CU language is C++ and that we have
1035 /// a named type that is not contained in an anonymous namespace.
1036 static bool shouldAddODRHash(CompileUnit *CU, DIE *Die) {
1037 return CU->getLanguage() == dwarf::DW_LANG_C_plus_plus &&
1038 getDIEStringAttr(Die, dwarf::DW_AT_name) != "" &&
1039 !isContainedInAnonNamespace(Die);
1042 void DwarfDebug::finalizeModuleInfo() {
1043 // Collect info for variables that were optimized out.
1044 collectDeadVariables();
1046 // Attach DW_AT_inline attribute with inlined subprogram DIEs.
1047 computeInlinedDIEs();
1049 // Split out type units and conditionally add an ODR tag to the split
1051 // FIXME: Do type splitting.
1052 for (unsigned i = 0, e = TypeUnits.size(); i != e; ++i) {
1053 DIE *Die = TypeUnits[i];
1055 // If we've requested ODR hashes and it's applicable for an ODR hash then
1056 // add the ODR signature now.
1057 // FIXME: This should be added onto the type unit, not the type, but this
1058 // works as an intermediate stage.
1059 if (GenerateODRHash && shouldAddODRHash(CUMap.begin()->second, Die))
1060 CUMap.begin()->second->addUInt(Die, dwarf::DW_AT_GNU_odr_signature,
1061 dwarf::DW_FORM_data8,
1062 Hash.computeDIEODRSignature(*Die));
1065 // Handle anything that needs to be done on a per-cu basis.
1066 for (DenseMap<const MDNode *, CompileUnit *>::iterator CUI = CUMap.begin(),
1068 CUI != CUE; ++CUI) {
1069 CompileUnit *TheCU = CUI->second;
1070 // Emit DW_AT_containing_type attribute to connect types with their
1071 // vtable holding type.
1072 TheCU->constructContainingTypeDIEs();
1074 // If we're splitting the dwarf out now that we've got the entire
1075 // CU then construct a skeleton CU based upon it.
1076 if (useSplitDwarf()) {
1078 if (GenerateCUHash) {
1080 ID = CUHash.computeCUSignature(*TheCU->getCUDie());
1082 // This should be a unique identifier when we want to build .dwp files.
1083 TheCU->addUInt(TheCU->getCUDie(), dwarf::DW_AT_GNU_dwo_id,
1084 dwarf::DW_FORM_data8, ID);
1085 // Now construct the skeleton CU associated.
1086 CompileUnit *SkCU = constructSkeletonCU(TheCU);
1087 // This should be a unique identifier when we want to build .dwp files.
1088 SkCU->addUInt(SkCU->getCUDie(), dwarf::DW_AT_GNU_dwo_id,
1089 dwarf::DW_FORM_data8, ID);
1093 // Compute DIE offsets and sizes.
1094 InfoHolder.computeSizeAndOffsets();
1095 if (useSplitDwarf())
1096 SkeletonHolder.computeSizeAndOffsets();
1099 void DwarfDebug::endSections() {
1100 // Filter labels by section.
1101 for (size_t n = 0; n < ArangeLabels.size(); n++) {
1102 const SymbolCU &SCU = ArangeLabels[n];
1103 if (SCU.Sym->isInSection()) {
1104 // Make a note of this symbol and it's section.
1105 const MCSection *Section = &SCU.Sym->getSection();
1106 if (!Section->getKind().isMetadata())
1107 SectionMap[Section].push_back(SCU);
1109 // Some symbols (e.g. common/bss on mach-o) can have no section but still
1110 // appear in the output. This sucks as we rely on sections to build
1111 // arange spans. We can do it without, but it's icky.
1112 SectionMap[NULL].push_back(SCU);
1116 // Build a list of sections used.
1117 std::vector<const MCSection *> Sections;
1118 for (SectionMapType::iterator it = SectionMap.begin(); it != SectionMap.end();
1120 const MCSection *Section = it->first;
1121 Sections.push_back(Section);
1124 // Sort the sections into order.
1125 // This is only done to ensure consistent output order across different runs.
1126 std::sort(Sections.begin(), Sections.end(), SectionSort);
1128 // Add terminating symbols for each section.
1129 for (unsigned ID=0;ID<Sections.size();ID++) {
1130 const MCSection *Section = Sections[ID];
1131 MCSymbol *Sym = NULL;
1134 // We can't call MCSection::getLabelEndName, as it's only safe to do so
1135 // if we know the section name up-front. For user-created sections, the resulting
1136 // label may not be valid to use as a label. (section names can use a greater
1137 // set of characters on some systems)
1138 Sym = Asm->GetTempSymbol("debug_end", ID);
1139 Asm->OutStreamer.SwitchSection(Section);
1140 Asm->OutStreamer.EmitLabel(Sym);
1143 // Insert a final terminator.
1144 SectionMap[Section].push_back(SymbolCU(NULL, Sym));
1148 // Emit all Dwarf sections that should come after the content.
1149 void DwarfDebug::endModule() {
1151 if (!FirstCU) return;
1153 // End any existing sections.
1154 // TODO: Does this need to happen?
1157 // Finalize the debug info for the module.
1158 finalizeModuleInfo();
1160 if (!useSplitDwarf()) {
1163 // Emit all the DIEs into a debug info section.
1166 // Corresponding abbreviations into a abbrev section.
1167 emitAbbreviations();
1169 // Emit info into a debug loc section.
1172 // Emit info into a debug aranges section.
1175 // Emit info into a debug ranges section.
1178 // Emit info into a debug macinfo section.
1182 // TODO: Fill this in for separated debug sections and separate
1183 // out information into new sections.
1185 if (useSplitDwarf())
1188 // Emit the debug info section and compile units.
1192 // Corresponding abbreviations into a abbrev section.
1193 emitAbbreviations();
1194 emitDebugAbbrevDWO();
1196 // Emit info into a debug loc section.
1199 // Emit info into a debug aranges section.
1202 // Emit info into a debug ranges section.
1205 // Emit info into a debug macinfo section.
1208 // Emit DWO addresses.
1209 InfoHolder.emitAddresses(Asm->getObjFileLowering().getDwarfAddrSection());
1213 // Emit info into the dwarf accelerator table sections.
1214 if (useDwarfAccelTables()) {
1217 emitAccelNamespaces();
1221 // Emit the pubnames and pubtypes sections if requested.
1222 if (HasDwarfPubSections) {
1223 emitDebugPubNames(GenerateGnuPubSections);
1224 emitDebugPubTypes(GenerateGnuPubSections);
1229 for (DenseMap<const MDNode *, CompileUnit *>::iterator I = CUMap.begin(),
1230 E = CUMap.end(); I != E; ++I)
1233 for (SmallVectorImpl<CompileUnit *>::iterator I = SkeletonCUs.begin(),
1234 E = SkeletonCUs.end(); I != E; ++I)
1237 // Reset these for the next Module if we have one.
1241 // Find abstract variable, if any, associated with Var.
1242 DbgVariable *DwarfDebug::findAbstractVariable(DIVariable &DV,
1243 DebugLoc ScopeLoc) {
1244 LLVMContext &Ctx = DV->getContext();
1245 // More then one inlined variable corresponds to one abstract variable.
1246 DIVariable Var = cleanseInlinedVariable(DV, Ctx);
1247 DbgVariable *AbsDbgVariable = AbstractVariables.lookup(Var);
1249 return AbsDbgVariable;
1251 LexicalScope *Scope = LScopes.findAbstractScope(ScopeLoc.getScope(Ctx));
1255 AbsDbgVariable = new DbgVariable(Var, NULL, this);
1256 addScopeVariable(Scope, AbsDbgVariable);
1257 AbstractVariables[Var] = AbsDbgVariable;
1258 return AbsDbgVariable;
1261 // If Var is a current function argument then add it to CurrentFnArguments list.
1262 bool DwarfDebug::addCurrentFnArgument(const MachineFunction *MF,
1263 DbgVariable *Var, LexicalScope *Scope) {
1264 if (!LScopes.isCurrentFunctionScope(Scope))
1266 DIVariable DV = Var->getVariable();
1267 if (DV.getTag() != dwarf::DW_TAG_arg_variable)
1269 unsigned ArgNo = DV.getArgNumber();
1273 size_t Size = CurrentFnArguments.size();
1275 CurrentFnArguments.resize(MF->getFunction()->arg_size());
1276 // llvm::Function argument size is not good indicator of how many
1277 // arguments does the function have at source level.
1279 CurrentFnArguments.resize(ArgNo * 2);
1280 CurrentFnArguments[ArgNo - 1] = Var;
1284 // Collect variable information from side table maintained by MMI.
1286 DwarfDebug::collectVariableInfoFromMMITable(const MachineFunction *MF,
1287 SmallPtrSet<const MDNode *, 16> &Processed) {
1288 MachineModuleInfo::VariableDbgInfoMapTy &VMap = MMI->getVariableDbgInfo();
1289 for (MachineModuleInfo::VariableDbgInfoMapTy::iterator VI = VMap.begin(),
1290 VE = VMap.end(); VI != VE; ++VI) {
1291 const MDNode *Var = VI->first;
1293 Processed.insert(Var);
1295 const std::pair<unsigned, DebugLoc> &VP = VI->second;
1297 LexicalScope *Scope = LScopes.findLexicalScope(VP.second);
1299 // If variable scope is not found then skip this variable.
1303 DbgVariable *AbsDbgVariable = findAbstractVariable(DV, VP.second);
1304 DbgVariable *RegVar = new DbgVariable(DV, AbsDbgVariable, this);
1305 RegVar->setFrameIndex(VP.first);
1306 if (!addCurrentFnArgument(MF, RegVar, Scope))
1307 addScopeVariable(Scope, RegVar);
1309 AbsDbgVariable->setFrameIndex(VP.first);
1313 // Return true if debug value, encoded by DBG_VALUE instruction, is in a
1315 static bool isDbgValueInDefinedReg(const MachineInstr *MI) {
1316 assert(MI->isDebugValue() && "Invalid DBG_VALUE machine instruction!");
1317 return MI->getNumOperands() == 3 &&
1318 MI->getOperand(0).isReg() && MI->getOperand(0).getReg() &&
1319 (MI->getOperand(1).isImm() ||
1320 (MI->getOperand(1).isReg() && MI->getOperand(1).getReg() == 0U));
1323 // Get .debug_loc entry for the instruction range starting at MI.
1324 static DotDebugLocEntry getDebugLocEntry(AsmPrinter *Asm,
1325 const MCSymbol *FLabel,
1326 const MCSymbol *SLabel,
1327 const MachineInstr *MI) {
1328 const MDNode *Var = MI->getOperand(MI->getNumOperands() - 1).getMetadata();
1330 assert(MI->getNumOperands() == 3);
1331 if (MI->getOperand(0).isReg()) {
1332 MachineLocation MLoc;
1333 // If the second operand is an immediate, this is a
1334 // register-indirect address.
1335 if (!MI->getOperand(1).isImm())
1336 MLoc.set(MI->getOperand(0).getReg());
1338 MLoc.set(MI->getOperand(0).getReg(), MI->getOperand(1).getImm());
1339 return DotDebugLocEntry(FLabel, SLabel, MLoc, Var);
1341 if (MI->getOperand(0).isImm())
1342 return DotDebugLocEntry(FLabel, SLabel, MI->getOperand(0).getImm());
1343 if (MI->getOperand(0).isFPImm())
1344 return DotDebugLocEntry(FLabel, SLabel, MI->getOperand(0).getFPImm());
1345 if (MI->getOperand(0).isCImm())
1346 return DotDebugLocEntry(FLabel, SLabel, MI->getOperand(0).getCImm());
1348 llvm_unreachable("Unexpected 3 operand DBG_VALUE instruction!");
1351 // Find variables for each lexical scope.
1353 DwarfDebug::collectVariableInfo(const MachineFunction *MF,
1354 SmallPtrSet<const MDNode *, 16> &Processed) {
1356 // Grab the variable info that was squirreled away in the MMI side-table.
1357 collectVariableInfoFromMMITable(MF, Processed);
1359 for (SmallVectorImpl<const MDNode*>::const_iterator
1360 UVI = UserVariables.begin(), UVE = UserVariables.end(); UVI != UVE;
1362 const MDNode *Var = *UVI;
1363 if (Processed.count(Var))
1366 // History contains relevant DBG_VALUE instructions for Var and instructions
1368 SmallVectorImpl<const MachineInstr*> &History = DbgValues[Var];
1369 if (History.empty())
1371 const MachineInstr *MInsn = History.front();
1374 LexicalScope *Scope = NULL;
1375 if (DV.getTag() == dwarf::DW_TAG_arg_variable &&
1376 DISubprogram(DV.getContext()).describes(MF->getFunction()))
1377 Scope = LScopes.getCurrentFunctionScope();
1378 else if (MDNode *IA = DV.getInlinedAt())
1379 Scope = LScopes.findInlinedScope(DebugLoc::getFromDILocation(IA));
1381 Scope = LScopes.findLexicalScope(cast<MDNode>(DV->getOperand(1)));
1382 // If variable scope is not found then skip this variable.
1386 Processed.insert(DV);
1387 assert(MInsn->isDebugValue() && "History must begin with debug value");
1388 DbgVariable *AbsVar = findAbstractVariable(DV, MInsn->getDebugLoc());
1389 DbgVariable *RegVar = new DbgVariable(DV, AbsVar, this);
1390 if (!addCurrentFnArgument(MF, RegVar, Scope))
1391 addScopeVariable(Scope, RegVar);
1393 AbsVar->setMInsn(MInsn);
1395 // Simplify ranges that are fully coalesced.
1396 if (History.size() <= 1 || (History.size() == 2 &&
1397 MInsn->isIdenticalTo(History.back()))) {
1398 RegVar->setMInsn(MInsn);
1402 // Handle multiple DBG_VALUE instructions describing one variable.
1403 RegVar->setDotDebugLocOffset(DotDebugLocEntries.size());
1405 for (SmallVectorImpl<const MachineInstr*>::const_iterator
1406 HI = History.begin(), HE = History.end(); HI != HE; ++HI) {
1407 const MachineInstr *Begin = *HI;
1408 assert(Begin->isDebugValue() && "Invalid History entry");
1410 // Check if DBG_VALUE is truncating a range.
1411 if (Begin->getNumOperands() > 1 && Begin->getOperand(0).isReg()
1412 && !Begin->getOperand(0).getReg())
1415 // Compute the range for a register location.
1416 const MCSymbol *FLabel = getLabelBeforeInsn(Begin);
1417 const MCSymbol *SLabel = 0;
1420 // If Begin is the last instruction in History then its value is valid
1421 // until the end of the function.
1422 SLabel = FunctionEndSym;
1424 const MachineInstr *End = HI[1];
1425 DEBUG(dbgs() << "DotDebugLoc Pair:\n"
1426 << "\t" << *Begin << "\t" << *End << "\n");
1427 if (End->isDebugValue())
1428 SLabel = getLabelBeforeInsn(End);
1430 // End is a normal instruction clobbering the range.
1431 SLabel = getLabelAfterInsn(End);
1432 assert(SLabel && "Forgot label after clobber instruction");
1437 // The value is valid until the next DBG_VALUE or clobber.
1438 DotDebugLocEntries.push_back(getDebugLocEntry(Asm, FLabel, SLabel,
1441 DotDebugLocEntries.push_back(DotDebugLocEntry());
1444 // Collect info for variables that were optimized out.
1445 LexicalScope *FnScope = LScopes.getCurrentFunctionScope();
1446 DIArray Variables = DISubprogram(FnScope->getScopeNode()).getVariables();
1447 for (unsigned i = 0, e = Variables.getNumElements(); i != e; ++i) {
1448 DIVariable DV(Variables.getElement(i));
1449 if (!DV || !DV.isVariable() || !Processed.insert(DV))
1451 if (LexicalScope *Scope = LScopes.findLexicalScope(DV.getContext()))
1452 addScopeVariable(Scope, new DbgVariable(DV, NULL, this));
1456 // Return Label preceding the instruction.
1457 MCSymbol *DwarfDebug::getLabelBeforeInsn(const MachineInstr *MI) {
1458 MCSymbol *Label = LabelsBeforeInsn.lookup(MI);
1459 assert(Label && "Didn't insert label before instruction");
1463 // Return Label immediately following the instruction.
1464 MCSymbol *DwarfDebug::getLabelAfterInsn(const MachineInstr *MI) {
1465 return LabelsAfterInsn.lookup(MI);
1468 // Process beginning of an instruction.
1469 void DwarfDebug::beginInstruction(const MachineInstr *MI) {
1470 // Check if source location changes, but ignore DBG_VALUE locations.
1471 if (!MI->isDebugValue()) {
1472 DebugLoc DL = MI->getDebugLoc();
1473 if (DL != PrevInstLoc && (!DL.isUnknown() || UnknownLocations)) {
1476 if (DL == PrologEndLoc) {
1477 Flags |= DWARF2_FLAG_PROLOGUE_END;
1478 PrologEndLoc = DebugLoc();
1480 if (PrologEndLoc.isUnknown())
1481 Flags |= DWARF2_FLAG_IS_STMT;
1483 if (!DL.isUnknown()) {
1484 const MDNode *Scope = DL.getScope(Asm->MF->getFunction()->getContext());
1485 recordSourceLine(DL.getLine(), DL.getCol(), Scope, Flags);
1487 recordSourceLine(0, 0, 0, 0);
1491 // Insert labels where requested.
1492 DenseMap<const MachineInstr*, MCSymbol*>::iterator I =
1493 LabelsBeforeInsn.find(MI);
1496 if (I == LabelsBeforeInsn.end())
1499 // Label already assigned.
1504 PrevLabel = MMI->getContext().CreateTempSymbol();
1505 Asm->OutStreamer.EmitLabel(PrevLabel);
1507 I->second = PrevLabel;
1510 // Process end of an instruction.
1511 void DwarfDebug::endInstruction(const MachineInstr *MI) {
1512 // Don't create a new label after DBG_VALUE instructions.
1513 // They don't generate code.
1514 if (!MI->isDebugValue())
1517 DenseMap<const MachineInstr*, MCSymbol*>::iterator I =
1518 LabelsAfterInsn.find(MI);
1521 if (I == LabelsAfterInsn.end())
1524 // Label already assigned.
1528 // We need a label after this instruction.
1530 PrevLabel = MMI->getContext().CreateTempSymbol();
1531 Asm->OutStreamer.EmitLabel(PrevLabel);
1533 I->second = PrevLabel;
1536 // Each LexicalScope has first instruction and last instruction to mark
1537 // beginning and end of a scope respectively. Create an inverse map that list
1538 // scopes starts (and ends) with an instruction. One instruction may start (or
1539 // end) multiple scopes. Ignore scopes that are not reachable.
1540 void DwarfDebug::identifyScopeMarkers() {
1541 SmallVector<LexicalScope *, 4> WorkList;
1542 WorkList.push_back(LScopes.getCurrentFunctionScope());
1543 while (!WorkList.empty()) {
1544 LexicalScope *S = WorkList.pop_back_val();
1546 const SmallVectorImpl<LexicalScope *> &Children = S->getChildren();
1547 if (!Children.empty())
1548 for (SmallVectorImpl<LexicalScope *>::const_iterator SI = Children.begin(),
1549 SE = Children.end(); SI != SE; ++SI)
1550 WorkList.push_back(*SI);
1552 if (S->isAbstractScope())
1555 const SmallVectorImpl<InsnRange> &Ranges = S->getRanges();
1558 for (SmallVectorImpl<InsnRange>::const_iterator RI = Ranges.begin(),
1559 RE = Ranges.end(); RI != RE; ++RI) {
1560 assert(RI->first && "InsnRange does not have first instruction!");
1561 assert(RI->second && "InsnRange does not have second instruction!");
1562 requestLabelBeforeInsn(RI->first);
1563 requestLabelAfterInsn(RI->second);
1568 // Get MDNode for DebugLoc's scope.
1569 static MDNode *getScopeNode(DebugLoc DL, const LLVMContext &Ctx) {
1570 if (MDNode *InlinedAt = DL.getInlinedAt(Ctx))
1571 return getScopeNode(DebugLoc::getFromDILocation(InlinedAt), Ctx);
1572 return DL.getScope(Ctx);
1575 // Walk up the scope chain of given debug loc and find line number info
1576 // for the function.
1577 static DebugLoc getFnDebugLoc(DebugLoc DL, const LLVMContext &Ctx) {
1578 const MDNode *Scope = getScopeNode(DL, Ctx);
1579 DISubprogram SP = getDISubprogram(Scope);
1580 if (SP.isSubprogram()) {
1581 // Check for number of operands since the compatibility is
1583 if (SP->getNumOperands() > 19)
1584 return DebugLoc::get(SP.getScopeLineNumber(), 0, SP);
1586 return DebugLoc::get(SP.getLineNumber(), 0, SP);
1592 // Gather pre-function debug information. Assumes being called immediately
1593 // after the function entry point has been emitted.
1594 void DwarfDebug::beginFunction(const MachineFunction *MF) {
1596 // If there's no debug info for the function we're not going to do anything.
1597 if (!MMI->hasDebugInfo())
1600 // Grab the lexical scopes for the function, if we don't have any of those
1601 // then we're not going to be able to do anything.
1602 LScopes.initialize(*MF);
1603 if (LScopes.empty())
1606 assert(UserVariables.empty() && DbgValues.empty() && "Maps weren't cleaned");
1608 // Make sure that each lexical scope will have a begin/end label.
1609 identifyScopeMarkers();
1611 // Set DwarfCompileUnitID in MCContext to the Compile Unit this function
1612 // belongs to so that we add to the correct per-cu line table in the
1614 LexicalScope *FnScope = LScopes.getCurrentFunctionScope();
1615 CompileUnit *TheCU = SPMap.lookup(FnScope->getScopeNode());
1616 assert(TheCU && "Unable to find compile unit!");
1617 if (Asm->TM.hasMCUseLoc() && Asm->OutStreamer.hasRawTextSupport())
1618 // Use a single line table if we are using .loc and generating assembly.
1619 Asm->OutStreamer.getContext().setDwarfCompileUnitID(0);
1621 Asm->OutStreamer.getContext().setDwarfCompileUnitID(TheCU->getUniqueID());
1623 // Emit a label for the function so that we have a beginning address.
1624 FunctionBeginSym = Asm->GetTempSymbol("func_begin", Asm->getFunctionNumber());
1625 // Assumes in correct section after the entry point.
1626 Asm->OutStreamer.EmitLabel(FunctionBeginSym);
1628 const TargetRegisterInfo *TRI = Asm->TM.getRegisterInfo();
1629 // LiveUserVar - Map physreg numbers to the MDNode they contain.
1630 std::vector<const MDNode *> LiveUserVar(TRI->getNumRegs());
1632 for (MachineFunction::const_iterator I = MF->begin(), E = MF->end(); I != E;
1634 bool AtBlockEntry = true;
1635 for (MachineBasicBlock::const_iterator II = I->begin(), IE = I->end();
1637 const MachineInstr *MI = II;
1639 if (MI->isDebugValue()) {
1640 assert(MI->getNumOperands() > 1 && "Invalid machine instruction!");
1642 // Keep track of user variables.
1644 MI->getOperand(MI->getNumOperands() - 1).getMetadata();
1646 // Variable is in a register, we need to check for clobbers.
1647 if (isDbgValueInDefinedReg(MI))
1648 LiveUserVar[MI->getOperand(0).getReg()] = Var;
1650 // Check the history of this variable.
1651 SmallVectorImpl<const MachineInstr *> &History = DbgValues[Var];
1652 if (History.empty()) {
1653 UserVariables.push_back(Var);
1654 // The first mention of a function argument gets the FunctionBeginSym
1655 // label, so arguments are visible when breaking at function entry.
1657 if (DV.isVariable() && DV.getTag() == dwarf::DW_TAG_arg_variable &&
1658 DISubprogram(getDISubprogram(DV.getContext()))
1659 .describes(MF->getFunction()))
1660 LabelsBeforeInsn[MI] = FunctionBeginSym;
1662 // We have seen this variable before. Try to coalesce DBG_VALUEs.
1663 const MachineInstr *Prev = History.back();
1664 if (Prev->isDebugValue()) {
1665 // Coalesce identical entries at the end of History.
1666 if (History.size() >= 2 &&
1667 Prev->isIdenticalTo(History[History.size() - 2])) {
1668 DEBUG(dbgs() << "Coalescing identical DBG_VALUE entries:\n"
1669 << "\t" << *Prev << "\t"
1670 << *History[History.size() - 2] << "\n");
1674 // Terminate old register assignments that don't reach MI;
1675 MachineFunction::const_iterator PrevMBB = Prev->getParent();
1676 if (PrevMBB != I && (!AtBlockEntry || llvm::next(PrevMBB) != I) &&
1677 isDbgValueInDefinedReg(Prev)) {
1678 // Previous register assignment needs to terminate at the end of
1680 MachineBasicBlock::const_iterator LastMI =
1681 PrevMBB->getLastNonDebugInstr();
1682 if (LastMI == PrevMBB->end()) {
1683 // Drop DBG_VALUE for empty range.
1684 DEBUG(dbgs() << "Dropping DBG_VALUE for empty range:\n"
1685 << "\t" << *Prev << "\n");
1687 } else if (llvm::next(PrevMBB) != PrevMBB->getParent()->end())
1688 // Terminate after LastMI.
1689 History.push_back(LastMI);
1693 History.push_back(MI);
1695 // Not a DBG_VALUE instruction.
1697 AtBlockEntry = false;
1699 // First known non-DBG_VALUE and non-frame setup location marks
1700 // the beginning of the function body.
1701 if (!MI->getFlag(MachineInstr::FrameSetup) &&
1702 (PrologEndLoc.isUnknown() && !MI->getDebugLoc().isUnknown()))
1703 PrologEndLoc = MI->getDebugLoc();
1705 // Check if the instruction clobbers any registers with debug vars.
1706 for (MachineInstr::const_mop_iterator MOI = MI->operands_begin(),
1707 MOE = MI->operands_end();
1708 MOI != MOE; ++MOI) {
1709 if (!MOI->isReg() || !MOI->isDef() || !MOI->getReg())
1711 for (MCRegAliasIterator AI(MOI->getReg(), TRI, true); AI.isValid();
1714 const MDNode *Var = LiveUserVar[Reg];
1717 // Reg is now clobbered.
1718 LiveUserVar[Reg] = 0;
1720 // Was MD last defined by a DBG_VALUE referring to Reg?
1721 DbgValueHistoryMap::iterator HistI = DbgValues.find(Var);
1722 if (HistI == DbgValues.end())
1724 SmallVectorImpl<const MachineInstr *> &History = HistI->second;
1725 if (History.empty())
1727 const MachineInstr *Prev = History.back();
1728 // Sanity-check: Register assignments are terminated at the end of
1730 if (!Prev->isDebugValue() || Prev->getParent() != MI->getParent())
1732 // Is the variable still in Reg?
1733 if (!isDbgValueInDefinedReg(Prev) ||
1734 Prev->getOperand(0).getReg() != Reg)
1736 // Var is clobbered. Make sure the next instruction gets a label.
1737 History.push_back(MI);
1744 for (DbgValueHistoryMap::iterator I = DbgValues.begin(), E = DbgValues.end();
1746 SmallVectorImpl<const MachineInstr *> &History = I->second;
1747 if (History.empty())
1750 // Make sure the final register assignments are terminated.
1751 const MachineInstr *Prev = History.back();
1752 if (Prev->isDebugValue() && isDbgValueInDefinedReg(Prev)) {
1753 const MachineBasicBlock *PrevMBB = Prev->getParent();
1754 MachineBasicBlock::const_iterator LastMI =
1755 PrevMBB->getLastNonDebugInstr();
1756 if (LastMI == PrevMBB->end())
1757 // Drop DBG_VALUE for empty range.
1759 else if (PrevMBB != &PrevMBB->getParent()->back()) {
1760 // Terminate after LastMI.
1761 History.push_back(LastMI);
1764 // Request labels for the full history.
1765 for (unsigned i = 0, e = History.size(); i != e; ++i) {
1766 const MachineInstr *MI = History[i];
1767 if (MI->isDebugValue())
1768 requestLabelBeforeInsn(MI);
1770 requestLabelAfterInsn(MI);
1774 PrevInstLoc = DebugLoc();
1775 PrevLabel = FunctionBeginSym;
1777 // Record beginning of function.
1778 if (!PrologEndLoc.isUnknown()) {
1779 DebugLoc FnStartDL =
1780 getFnDebugLoc(PrologEndLoc, MF->getFunction()->getContext());
1782 FnStartDL.getLine(), FnStartDL.getCol(),
1783 FnStartDL.getScope(MF->getFunction()->getContext()),
1784 // We'd like to list the prologue as "not statements" but GDB behaves
1785 // poorly if we do that. Revisit this with caution/GDB (7.5+) testing.
1786 DWARF2_FLAG_IS_STMT);
1790 void DwarfDebug::addScopeVariable(LexicalScope *LS, DbgVariable *Var) {
1791 SmallVectorImpl<DbgVariable *> &Vars = ScopeVariables[LS];
1792 DIVariable DV = Var->getVariable();
1793 // Variables with positive arg numbers are parameters.
1794 if (unsigned ArgNum = DV.getArgNumber()) {
1795 // Keep all parameters in order at the start of the variable list to ensure
1796 // function types are correct (no out-of-order parameters)
1798 // This could be improved by only doing it for optimized builds (unoptimized
1799 // builds have the right order to begin with), searching from the back (this
1800 // would catch the unoptimized case quickly), or doing a binary search
1801 // rather than linear search.
1802 SmallVectorImpl<DbgVariable *>::iterator I = Vars.begin();
1803 while (I != Vars.end()) {
1804 unsigned CurNum = (*I)->getVariable().getArgNumber();
1805 // A local (non-parameter) variable has been found, insert immediately
1809 // A later indexed parameter has been found, insert immediately before it.
1810 if (CurNum > ArgNum)
1814 Vars.insert(I, Var);
1818 Vars.push_back(Var);
1821 // Gather and emit post-function debug information.
1822 void DwarfDebug::endFunction(const MachineFunction *MF) {
1823 if (!MMI->hasDebugInfo() || LScopes.empty()) return;
1825 // Define end label for subprogram.
1826 FunctionEndSym = Asm->GetTempSymbol("func_end",
1827 Asm->getFunctionNumber());
1828 // Assumes in correct section after the entry point.
1829 Asm->OutStreamer.EmitLabel(FunctionEndSym);
1830 // Set DwarfCompileUnitID in MCContext to default value.
1831 Asm->OutStreamer.getContext().setDwarfCompileUnitID(0);
1833 SmallPtrSet<const MDNode *, 16> ProcessedVars;
1834 collectVariableInfo(MF, ProcessedVars);
1836 LexicalScope *FnScope = LScopes.getCurrentFunctionScope();
1837 CompileUnit *TheCU = SPMap.lookup(FnScope->getScopeNode());
1838 assert(TheCU && "Unable to find compile unit!");
1840 // Construct abstract scopes.
1841 ArrayRef<LexicalScope *> AList = LScopes.getAbstractScopesList();
1842 for (unsigned i = 0, e = AList.size(); i != e; ++i) {
1843 LexicalScope *AScope = AList[i];
1844 DISubprogram SP(AScope->getScopeNode());
1845 if (SP.isSubprogram()) {
1846 // Collect info for variables that were optimized out.
1847 DIArray Variables = SP.getVariables();
1848 for (unsigned i = 0, e = Variables.getNumElements(); i != e; ++i) {
1849 DIVariable DV(Variables.getElement(i));
1850 if (!DV || !DV.isVariable() || !ProcessedVars.insert(DV))
1852 // Check that DbgVariable for DV wasn't created earlier, when
1853 // findAbstractVariable() was called for inlined instance of DV.
1854 LLVMContext &Ctx = DV->getContext();
1855 DIVariable CleanDV = cleanseInlinedVariable(DV, Ctx);
1856 if (AbstractVariables.lookup(CleanDV))
1858 if (LexicalScope *Scope = LScopes.findAbstractScope(DV.getContext()))
1859 addScopeVariable(Scope, new DbgVariable(DV, NULL, this));
1862 if (ProcessedSPNodes.count(AScope->getScopeNode()) == 0)
1863 constructScopeDIE(TheCU, AScope);
1866 DIE *CurFnDIE = constructScopeDIE(TheCU, FnScope);
1868 if (!MF->getTarget().Options.DisableFramePointerElim(*MF))
1869 TheCU->addFlag(CurFnDIE, dwarf::DW_AT_APPLE_omit_frame_ptr);
1872 for (ScopeVariablesMap::iterator
1873 I = ScopeVariables.begin(), E = ScopeVariables.end(); I != E; ++I)
1874 DeleteContainerPointers(I->second);
1875 ScopeVariables.clear();
1876 DeleteContainerPointers(CurrentFnArguments);
1877 UserVariables.clear();
1879 AbstractVariables.clear();
1880 LabelsBeforeInsn.clear();
1881 LabelsAfterInsn.clear();
1885 // Register a source line with debug info. Returns the unique label that was
1886 // emitted and which provides correspondence to the source line list.
1887 void DwarfDebug::recordSourceLine(unsigned Line, unsigned Col, const MDNode *S,
1893 DIDescriptor Scope(S);
1895 if (Scope.isCompileUnit()) {
1896 DICompileUnit CU(S);
1897 Fn = CU.getFilename();
1898 Dir = CU.getDirectory();
1899 } else if (Scope.isFile()) {
1901 Fn = F.getFilename();
1902 Dir = F.getDirectory();
1903 } else if (Scope.isSubprogram()) {
1905 Fn = SP.getFilename();
1906 Dir = SP.getDirectory();
1907 } else if (Scope.isLexicalBlockFile()) {
1908 DILexicalBlockFile DBF(S);
1909 Fn = DBF.getFilename();
1910 Dir = DBF.getDirectory();
1911 } else if (Scope.isLexicalBlock()) {
1912 DILexicalBlock DB(S);
1913 Fn = DB.getFilename();
1914 Dir = DB.getDirectory();
1916 llvm_unreachable("Unexpected scope info");
1918 Src = getOrCreateSourceID(Fn, Dir,
1919 Asm->OutStreamer.getContext().getDwarfCompileUnitID());
1921 Asm->OutStreamer.EmitDwarfLocDirective(Src, Line, Col, Flags, 0, 0, Fn);
1924 //===----------------------------------------------------------------------===//
1926 //===----------------------------------------------------------------------===//
1928 // Compute the size and offset of a DIE. The offset is relative to start of the
1929 // CU. It returns the offset after laying out the DIE.
1931 DwarfUnits::computeSizeAndOffset(DIE *Die, unsigned Offset) {
1932 // Get the children.
1933 const std::vector<DIE *> &Children = Die->getChildren();
1935 // Record the abbreviation.
1936 assignAbbrevNumber(Die->getAbbrev());
1938 // Get the abbreviation for this DIE.
1939 unsigned AbbrevNumber = Die->getAbbrevNumber();
1940 const DIEAbbrev *Abbrev = Abbreviations[AbbrevNumber - 1];
1943 Die->setOffset(Offset);
1945 // Start the size with the size of abbreviation code.
1946 Offset += MCAsmInfo::getULEB128Size(AbbrevNumber);
1948 const SmallVectorImpl<DIEValue*> &Values = Die->getValues();
1949 const SmallVectorImpl<DIEAbbrevData> &AbbrevData = Abbrev->getData();
1951 // Size the DIE attribute values.
1952 for (unsigned i = 0, N = Values.size(); i < N; ++i)
1953 // Size attribute value.
1954 Offset += Values[i]->SizeOf(Asm, AbbrevData[i].getForm());
1956 // Size the DIE children if any.
1957 if (!Children.empty()) {
1958 assert(Abbrev->getChildrenFlag() == dwarf::DW_CHILDREN_yes &&
1959 "Children flag not set");
1961 for (unsigned j = 0, M = Children.size(); j < M; ++j)
1962 Offset = computeSizeAndOffset(Children[j], Offset);
1964 // End of children marker.
1965 Offset += sizeof(int8_t);
1968 Die->setSize(Offset - Die->getOffset());
1972 // Compute the size and offset for each DIE.
1973 void DwarfUnits::computeSizeAndOffsets() {
1974 // Offset from the first CU in the debug info section is 0 initially.
1975 unsigned SecOffset = 0;
1977 // Iterate over each compile unit and set the size and offsets for each
1978 // DIE within each compile unit. All offsets are CU relative.
1979 for (SmallVectorImpl<CompileUnit *>::iterator I = CUs.begin(),
1980 E = CUs.end(); I != E; ++I) {
1981 (*I)->setDebugInfoOffset(SecOffset);
1983 // CU-relative offset is reset to 0 here.
1984 unsigned Offset = sizeof(int32_t) + // Length of Unit Info
1985 (*I)->getHeaderSize(); // Unit-specific headers
1987 // EndOffset here is CU-relative, after laying out
1988 // all of the CU DIE.
1989 unsigned EndOffset = computeSizeAndOffset((*I)->getCUDie(), Offset);
1990 SecOffset += EndOffset;
1994 // Emit initial Dwarf sections with a label at the start of each one.
1995 void DwarfDebug::emitSectionLabels() {
1996 const TargetLoweringObjectFile &TLOF = Asm->getObjFileLowering();
1998 // Dwarf sections base addresses.
1999 DwarfInfoSectionSym =
2000 emitSectionSym(Asm, TLOF.getDwarfInfoSection(), "section_info");
2001 DwarfAbbrevSectionSym =
2002 emitSectionSym(Asm, TLOF.getDwarfAbbrevSection(), "section_abbrev");
2003 if (useSplitDwarf())
2004 DwarfAbbrevDWOSectionSym =
2005 emitSectionSym(Asm, TLOF.getDwarfAbbrevDWOSection(),
2006 "section_abbrev_dwo");
2007 emitSectionSym(Asm, TLOF.getDwarfARangesSection());
2009 if (const MCSection *MacroInfo = TLOF.getDwarfMacroInfoSection())
2010 emitSectionSym(Asm, MacroInfo);
2012 DwarfLineSectionSym =
2013 emitSectionSym(Asm, TLOF.getDwarfLineSection(), "section_line");
2014 emitSectionSym(Asm, TLOF.getDwarfLocSection());
2015 if (GenerateGnuPubSections) {
2016 DwarfGnuPubNamesSectionSym =
2017 emitSectionSym(Asm, TLOF.getDwarfGnuPubNamesSection());
2018 DwarfGnuPubTypesSectionSym =
2019 emitSectionSym(Asm, TLOF.getDwarfGnuPubTypesSection());
2020 } else if (HasDwarfPubSections) {
2021 emitSectionSym(Asm, TLOF.getDwarfPubNamesSection());
2022 emitSectionSym(Asm, TLOF.getDwarfPubTypesSection());
2025 DwarfStrSectionSym =
2026 emitSectionSym(Asm, TLOF.getDwarfStrSection(), "info_string");
2027 if (useSplitDwarf()) {
2028 DwarfStrDWOSectionSym =
2029 emitSectionSym(Asm, TLOF.getDwarfStrDWOSection(), "skel_string");
2030 DwarfAddrSectionSym =
2031 emitSectionSym(Asm, TLOF.getDwarfAddrSection(), "addr_sec");
2033 DwarfDebugRangeSectionSym = emitSectionSym(Asm, TLOF.getDwarfRangesSection(),
2036 DwarfDebugLocSectionSym = emitSectionSym(Asm, TLOF.getDwarfLocSection(),
2037 "section_debug_loc");
2039 TextSectionSym = emitSectionSym(Asm, TLOF.getTextSection(), "text_begin");
2040 emitSectionSym(Asm, TLOF.getDataSection());
2043 // Recursively emits a debug information entry.
2044 void DwarfDebug::emitDIE(DIE *Die, ArrayRef<DIEAbbrev *> Abbrevs) {
2045 // Get the abbreviation for this DIE.
2046 unsigned AbbrevNumber = Die->getAbbrevNumber();
2047 const DIEAbbrev *Abbrev = Abbrevs[AbbrevNumber - 1];
2049 // Emit the code (index) for the abbreviation.
2050 if (Asm->isVerbose())
2051 Asm->OutStreamer.AddComment("Abbrev [" + Twine(AbbrevNumber) + "] 0x" +
2052 Twine::utohexstr(Die->getOffset()) + ":0x" +
2053 Twine::utohexstr(Die->getSize()) + " " +
2054 dwarf::TagString(Abbrev->getTag()));
2055 Asm->EmitULEB128(AbbrevNumber);
2057 const SmallVectorImpl<DIEValue*> &Values = Die->getValues();
2058 const SmallVectorImpl<DIEAbbrevData> &AbbrevData = Abbrev->getData();
2060 // Emit the DIE attribute values.
2061 for (unsigned i = 0, N = Values.size(); i < N; ++i) {
2062 dwarf::Attribute Attr = AbbrevData[i].getAttribute();
2063 dwarf::Form Form = AbbrevData[i].getForm();
2064 assert(Form && "Too many attributes for DIE (check abbreviation)");
2066 if (Asm->isVerbose())
2067 Asm->OutStreamer.AddComment(dwarf::AttributeString(Attr));
2070 case dwarf::DW_AT_abstract_origin:
2071 case dwarf::DW_AT_type:
2072 case dwarf::DW_AT_friend:
2073 case dwarf::DW_AT_specification:
2074 case dwarf::DW_AT_import:
2075 case dwarf::DW_AT_containing_type: {
2076 DIEEntry *E = cast<DIEEntry>(Values[i]);
2077 DIE *Origin = E->getEntry();
2078 unsigned Addr = Origin->getOffset();
2079 if (Form == dwarf::DW_FORM_ref_addr) {
2080 assert(!useSplitDwarf() && "TODO: dwo files can't have relocations.");
2081 // For DW_FORM_ref_addr, output the offset from beginning of debug info
2082 // section. Origin->getOffset() returns the offset from start of the
2084 CompileUnit *CU = CUDieMap.lookup(Origin->getCompileUnit());
2085 assert(CU && "CUDie should belong to a CU.");
2086 Addr += CU->getDebugInfoOffset();
2087 if (Asm->MAI->doesDwarfUseRelocationsAcrossSections())
2088 Asm->EmitLabelPlusOffset(DwarfInfoSectionSym, Addr,
2089 DIEEntry::getRefAddrSize(Asm));
2091 Asm->EmitLabelOffsetDifference(DwarfInfoSectionSym, Addr,
2092 DwarfInfoSectionSym,
2093 DIEEntry::getRefAddrSize(Asm));
2095 // Make sure Origin belong to the same CU.
2096 assert(Die->getCompileUnit() == Origin->getCompileUnit() &&
2097 "The referenced DIE should belong to the same CU in ref4");
2098 Asm->EmitInt32(Addr);
2102 case dwarf::DW_AT_ranges: {
2103 // DW_AT_range Value encodes offset in debug_range section.
2104 DIEInteger *V = cast<DIEInteger>(Values[i]);
2106 if (Asm->MAI->doesDwarfUseRelocationsAcrossSections()) {
2107 Asm->EmitLabelPlusOffset(DwarfDebugRangeSectionSym,
2111 Asm->EmitLabelOffsetDifference(DwarfDebugRangeSectionSym,
2113 DwarfDebugRangeSectionSym,
2118 case dwarf::DW_AT_location: {
2119 if (DIELabel *L = dyn_cast<DIELabel>(Values[i])) {
2120 if (Asm->MAI->doesDwarfUseRelocationsAcrossSections())
2121 Asm->EmitLabelReference(L->getValue(), 4);
2123 Asm->EmitLabelDifference(L->getValue(), DwarfDebugLocSectionSym, 4);
2125 Values[i]->EmitValue(Asm, Form);
2129 case dwarf::DW_AT_accessibility: {
2130 if (Asm->isVerbose()) {
2131 DIEInteger *V = cast<DIEInteger>(Values[i]);
2132 Asm->OutStreamer.AddComment(dwarf::AccessibilityString(V->getValue()));
2134 Values[i]->EmitValue(Asm, Form);
2138 // Emit an attribute using the defined form.
2139 Values[i]->EmitValue(Asm, Form);
2144 // Emit the DIE children if any.
2145 if (Abbrev->getChildrenFlag() == dwarf::DW_CHILDREN_yes) {
2146 const std::vector<DIE *> &Children = Die->getChildren();
2148 for (unsigned j = 0, M = Children.size(); j < M; ++j)
2149 emitDIE(Children[j], Abbrevs);
2151 if (Asm->isVerbose())
2152 Asm->OutStreamer.AddComment("End Of Children Mark");
2157 // Emit the various dwarf units to the unit section USection with
2158 // the abbreviations going into ASection.
2159 void DwarfUnits::emitUnits(DwarfDebug *DD,
2160 const MCSection *USection,
2161 const MCSection *ASection,
2162 const MCSymbol *ASectionSym) {
2163 Asm->OutStreamer.SwitchSection(USection);
2164 for (SmallVectorImpl<CompileUnit *>::iterator I = CUs.begin(),
2165 E = CUs.end(); I != E; ++I) {
2166 CompileUnit *TheCU = *I;
2167 DIE *Die = TheCU->getCUDie();
2169 // Emit the compile units header.
2171 .EmitLabel(Asm->GetTempSymbol(USection->getLabelBeginName(),
2172 TheCU->getUniqueID()));
2174 // Emit size of content not including length itself
2175 Asm->OutStreamer.AddComment("Length of Unit");
2176 Asm->EmitInt32(TheCU->getHeaderSize() + Die->getSize());
2178 TheCU->emitHeader(ASection, ASectionSym);
2180 DD->emitDIE(Die, Abbreviations);
2181 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol(USection->getLabelEndName(),
2182 TheCU->getUniqueID()));
2186 // Emit the debug info section.
2187 void DwarfDebug::emitDebugInfo() {
2188 DwarfUnits &Holder = useSplitDwarf() ? SkeletonHolder : InfoHolder;
2190 Holder.emitUnits(this, Asm->getObjFileLowering().getDwarfInfoSection(),
2191 Asm->getObjFileLowering().getDwarfAbbrevSection(),
2192 DwarfAbbrevSectionSym);
2195 // Emit the abbreviation section.
2196 void DwarfDebug::emitAbbreviations() {
2197 if (!useSplitDwarf())
2198 emitAbbrevs(Asm->getObjFileLowering().getDwarfAbbrevSection(),
2201 emitSkeletonAbbrevs(Asm->getObjFileLowering().getDwarfAbbrevSection());
2204 void DwarfDebug::emitAbbrevs(const MCSection *Section,
2205 std::vector<DIEAbbrev *> *Abbrevs) {
2206 // Check to see if it is worth the effort.
2207 if (!Abbrevs->empty()) {
2208 // Start the debug abbrev section.
2209 Asm->OutStreamer.SwitchSection(Section);
2211 MCSymbol *Begin = Asm->GetTempSymbol(Section->getLabelBeginName());
2212 Asm->OutStreamer.EmitLabel(Begin);
2214 // For each abbrevation.
2215 for (unsigned i = 0, N = Abbrevs->size(); i < N; ++i) {
2216 // Get abbreviation data
2217 const DIEAbbrev *Abbrev = Abbrevs->at(i);
2219 // Emit the abbrevations code (base 1 index.)
2220 Asm->EmitULEB128(Abbrev->getNumber(), "Abbreviation Code");
2222 // Emit the abbreviations data.
2226 // Mark end of abbreviations.
2227 Asm->EmitULEB128(0, "EOM(3)");
2229 MCSymbol *End = Asm->GetTempSymbol(Section->getLabelEndName());
2230 Asm->OutStreamer.EmitLabel(End);
2234 // Emit the last address of the section and the end of the line matrix.
2235 void DwarfDebug::emitEndOfLineMatrix(unsigned SectionEnd) {
2236 // Define last address of section.
2237 Asm->OutStreamer.AddComment("Extended Op");
2240 Asm->OutStreamer.AddComment("Op size");
2241 Asm->EmitInt8(Asm->getDataLayout().getPointerSize() + 1);
2242 Asm->OutStreamer.AddComment("DW_LNE_set_address");
2243 Asm->EmitInt8(dwarf::DW_LNE_set_address);
2245 Asm->OutStreamer.AddComment("Section end label");
2247 Asm->OutStreamer.EmitSymbolValue(Asm->GetTempSymbol("section_end",SectionEnd),
2248 Asm->getDataLayout().getPointerSize());
2250 // Mark end of matrix.
2251 Asm->OutStreamer.AddComment("DW_LNE_end_sequence");
2257 // Emit visible names into a hashed accelerator table section.
2258 void DwarfDebug::emitAccelNames() {
2259 DwarfAccelTable AT(DwarfAccelTable::Atom(dwarf::DW_ATOM_die_offset,
2260 dwarf::DW_FORM_data4));
2261 for (DenseMap<const MDNode *, CompileUnit *>::iterator I = CUMap.begin(),
2262 E = CUMap.end(); I != E; ++I) {
2263 CompileUnit *TheCU = I->second;
2264 const StringMap<std::vector<DIE*> > &Names = TheCU->getAccelNames();
2265 for (StringMap<std::vector<DIE*> >::const_iterator
2266 GI = Names.begin(), GE = Names.end(); GI != GE; ++GI) {
2267 StringRef Name = GI->getKey();
2268 const std::vector<DIE *> &Entities = GI->second;
2269 for (std::vector<DIE *>::const_iterator DI = Entities.begin(),
2270 DE = Entities.end(); DI != DE; ++DI)
2271 AT.AddName(Name, (*DI));
2275 AT.FinalizeTable(Asm, "Names");
2276 Asm->OutStreamer.SwitchSection(
2277 Asm->getObjFileLowering().getDwarfAccelNamesSection());
2278 MCSymbol *SectionBegin = Asm->GetTempSymbol("names_begin");
2279 Asm->OutStreamer.EmitLabel(SectionBegin);
2281 // Emit the full data.
2282 AT.Emit(Asm, SectionBegin, &InfoHolder);
2285 // Emit objective C classes and categories into a hashed accelerator table
2287 void DwarfDebug::emitAccelObjC() {
2288 DwarfAccelTable AT(DwarfAccelTable::Atom(dwarf::DW_ATOM_die_offset,
2289 dwarf::DW_FORM_data4));
2290 for (DenseMap<const MDNode *, CompileUnit *>::iterator I = CUMap.begin(),
2291 E = CUMap.end(); I != E; ++I) {
2292 CompileUnit *TheCU = I->second;
2293 const StringMap<std::vector<DIE*> > &Names = TheCU->getAccelObjC();
2294 for (StringMap<std::vector<DIE*> >::const_iterator
2295 GI = Names.begin(), GE = Names.end(); GI != GE; ++GI) {
2296 StringRef Name = GI->getKey();
2297 const std::vector<DIE *> &Entities = GI->second;
2298 for (std::vector<DIE *>::const_iterator DI = Entities.begin(),
2299 DE = Entities.end(); DI != DE; ++DI)
2300 AT.AddName(Name, (*DI));
2304 AT.FinalizeTable(Asm, "ObjC");
2305 Asm->OutStreamer.SwitchSection(Asm->getObjFileLowering()
2306 .getDwarfAccelObjCSection());
2307 MCSymbol *SectionBegin = Asm->GetTempSymbol("objc_begin");
2308 Asm->OutStreamer.EmitLabel(SectionBegin);
2310 // Emit the full data.
2311 AT.Emit(Asm, SectionBegin, &InfoHolder);
2314 // Emit namespace dies into a hashed accelerator table.
2315 void DwarfDebug::emitAccelNamespaces() {
2316 DwarfAccelTable AT(DwarfAccelTable::Atom(dwarf::DW_ATOM_die_offset,
2317 dwarf::DW_FORM_data4));
2318 for (DenseMap<const MDNode *, CompileUnit *>::iterator I = CUMap.begin(),
2319 E = CUMap.end(); I != E; ++I) {
2320 CompileUnit *TheCU = I->second;
2321 const StringMap<std::vector<DIE*> > &Names = TheCU->getAccelNamespace();
2322 for (StringMap<std::vector<DIE*> >::const_iterator
2323 GI = Names.begin(), GE = Names.end(); GI != GE; ++GI) {
2324 StringRef Name = GI->getKey();
2325 const std::vector<DIE *> &Entities = GI->second;
2326 for (std::vector<DIE *>::const_iterator DI = Entities.begin(),
2327 DE = Entities.end(); DI != DE; ++DI)
2328 AT.AddName(Name, (*DI));
2332 AT.FinalizeTable(Asm, "namespac");
2333 Asm->OutStreamer.SwitchSection(Asm->getObjFileLowering()
2334 .getDwarfAccelNamespaceSection());
2335 MCSymbol *SectionBegin = Asm->GetTempSymbol("namespac_begin");
2336 Asm->OutStreamer.EmitLabel(SectionBegin);
2338 // Emit the full data.
2339 AT.Emit(Asm, SectionBegin, &InfoHolder);
2342 // Emit type dies into a hashed accelerator table.
2343 void DwarfDebug::emitAccelTypes() {
2344 std::vector<DwarfAccelTable::Atom> Atoms;
2345 Atoms.push_back(DwarfAccelTable::Atom(dwarf::DW_ATOM_die_offset,
2346 dwarf::DW_FORM_data4));
2347 Atoms.push_back(DwarfAccelTable::Atom(dwarf::DW_ATOM_die_tag,
2348 dwarf::DW_FORM_data2));
2349 Atoms.push_back(DwarfAccelTable::Atom(dwarf::DW_ATOM_type_flags,
2350 dwarf::DW_FORM_data1));
2351 DwarfAccelTable AT(Atoms);
2352 for (DenseMap<const MDNode *, CompileUnit *>::iterator I = CUMap.begin(),
2353 E = CUMap.end(); I != E; ++I) {
2354 CompileUnit *TheCU = I->second;
2355 const StringMap<std::vector<std::pair<DIE*, unsigned > > > &Names
2356 = TheCU->getAccelTypes();
2357 for (StringMap<std::vector<std::pair<DIE*, unsigned> > >::const_iterator
2358 GI = Names.begin(), GE = Names.end(); GI != GE; ++GI) {
2359 StringRef Name = GI->getKey();
2360 const std::vector<std::pair<DIE *, unsigned> > &Entities = GI->second;
2361 for (std::vector<std::pair<DIE *, unsigned> >::const_iterator DI
2362 = Entities.begin(), DE = Entities.end(); DI !=DE; ++DI)
2363 AT.AddName(Name, (*DI).first, (*DI).second);
2367 AT.FinalizeTable(Asm, "types");
2368 Asm->OutStreamer.SwitchSection(Asm->getObjFileLowering()
2369 .getDwarfAccelTypesSection());
2370 MCSymbol *SectionBegin = Asm->GetTempSymbol("types_begin");
2371 Asm->OutStreamer.EmitLabel(SectionBegin);
2373 // Emit the full data.
2374 AT.Emit(Asm, SectionBegin, &InfoHolder);
2377 // Public name handling.
2378 // The format for the various pubnames:
2380 // dwarf pubnames - offset/name pairs where the offset is the offset into the CU
2381 // for the DIE that is named.
2383 // gnu pubnames - offset/index value/name tuples where the offset is the offset
2384 // into the CU and the index value is computed according to the type of value
2385 // for the DIE that is named.
2387 // For type units the offset is the offset of the skeleton DIE. For split dwarf
2388 // it's the offset within the debug_info/debug_types dwo section, however, the
2389 // reference in the pubname header doesn't change.
2391 /// computeIndexValue - Compute the gdb index value for the DIE and CU.
2392 static dwarf::PubIndexEntryDescriptor computeIndexValue(CompileUnit *CU,
2394 dwarf::GDBIndexEntryLinkage Linkage = dwarf::GIEL_STATIC;
2396 // We could have a specification DIE that has our most of our knowledge,
2397 // look for that now.
2398 DIEValue *SpecVal = Die->findAttribute(dwarf::DW_AT_specification);
2400 DIE *SpecDIE = cast<DIEEntry>(SpecVal)->getEntry();
2401 if (SpecDIE->findAttribute(dwarf::DW_AT_external))
2402 Linkage = dwarf::GIEL_EXTERNAL;
2403 } else if (Die->findAttribute(dwarf::DW_AT_external))
2404 Linkage = dwarf::GIEL_EXTERNAL;
2406 switch (Die->getTag()) {
2407 case dwarf::DW_TAG_class_type:
2408 case dwarf::DW_TAG_structure_type:
2409 case dwarf::DW_TAG_union_type:
2410 case dwarf::DW_TAG_enumeration_type:
2411 return dwarf::PubIndexEntryDescriptor(
2412 dwarf::GIEK_TYPE, CU->getLanguage() != dwarf::DW_LANG_C_plus_plus
2413 ? dwarf::GIEL_STATIC
2414 : dwarf::GIEL_EXTERNAL);
2415 case dwarf::DW_TAG_typedef:
2416 case dwarf::DW_TAG_base_type:
2417 case dwarf::DW_TAG_subrange_type:
2418 return dwarf::PubIndexEntryDescriptor(dwarf::GIEK_TYPE, dwarf::GIEL_STATIC);
2419 case dwarf::DW_TAG_namespace:
2420 return dwarf::GIEK_TYPE;
2421 case dwarf::DW_TAG_subprogram:
2422 return dwarf::PubIndexEntryDescriptor(dwarf::GIEK_FUNCTION, Linkage);
2423 case dwarf::DW_TAG_constant:
2424 case dwarf::DW_TAG_variable:
2425 return dwarf::PubIndexEntryDescriptor(dwarf::GIEK_VARIABLE, Linkage);
2426 case dwarf::DW_TAG_enumerator:
2427 return dwarf::PubIndexEntryDescriptor(dwarf::GIEK_VARIABLE,
2428 dwarf::GIEL_STATIC);
2430 return dwarf::GIEK_NONE;
2434 /// emitDebugPubNames - Emit visible names into a debug pubnames section.
2436 void DwarfDebug::emitDebugPubNames(bool GnuStyle) {
2437 const MCSection *ISec = Asm->getObjFileLowering().getDwarfInfoSection();
2438 const MCSection *PSec =
2439 GnuStyle ? Asm->getObjFileLowering().getDwarfGnuPubNamesSection()
2440 : Asm->getObjFileLowering().getDwarfPubNamesSection();
2442 typedef DenseMap<const MDNode*, CompileUnit*> CUMapType;
2443 for (CUMapType::iterator I = CUMap.begin(), E = CUMap.end(); I != E; ++I) {
2444 CompileUnit *TheCU = I->second;
2445 unsigned ID = TheCU->getUniqueID();
2447 // Start the dwarf pubnames section.
2448 Asm->OutStreamer.SwitchSection(PSec);
2450 // Emit a label so we can reference the beginning of this pubname section.
2452 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("gnu_pubnames",
2453 TheCU->getUniqueID()));
2456 Asm->OutStreamer.AddComment("Length of Public Names Info");
2457 Asm->EmitLabelDifference(Asm->GetTempSymbol("pubnames_end", ID),
2458 Asm->GetTempSymbol("pubnames_begin", ID), 4);
2460 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("pubnames_begin", ID));
2462 Asm->OutStreamer.AddComment("DWARF Version");
2463 Asm->EmitInt16(dwarf::DW_PUBNAMES_VERSION);
2465 Asm->OutStreamer.AddComment("Offset of Compilation Unit Info");
2466 Asm->EmitSectionOffset(Asm->GetTempSymbol(ISec->getLabelBeginName(), ID),
2467 DwarfInfoSectionSym);
2469 Asm->OutStreamer.AddComment("Compilation Unit Length");
2470 Asm->EmitLabelDifference(Asm->GetTempSymbol(ISec->getLabelEndName(), ID),
2471 Asm->GetTempSymbol(ISec->getLabelBeginName(), ID),
2474 // Emit the pubnames for this compilation unit.
2475 const StringMap<DIE*> &Globals = TheCU->getGlobalNames();
2476 for (StringMap<DIE*>::const_iterator
2477 GI = Globals.begin(), GE = Globals.end(); GI != GE; ++GI) {
2478 const char *Name = GI->getKeyData();
2479 DIE *Entity = GI->second;
2481 Asm->OutStreamer.AddComment("DIE offset");
2482 Asm->EmitInt32(Entity->getOffset());
2485 dwarf::PubIndexEntryDescriptor Desc = computeIndexValue(TheCU, Entity);
2486 Asm->OutStreamer.AddComment(
2487 Twine("Kind: ") + dwarf::GDBIndexEntryKindString(Desc.Kind) + ", " +
2488 dwarf::GDBIndexEntryLinkageString(Desc.Linkage));
2489 Asm->EmitInt8(Desc.toBits());
2492 if (Asm->isVerbose())
2493 Asm->OutStreamer.AddComment("External Name");
2494 Asm->OutStreamer.EmitBytes(StringRef(Name, GI->getKeyLength()+1));
2497 Asm->OutStreamer.AddComment("End Mark");
2499 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("pubnames_end", ID));
2503 void DwarfDebug::emitDebugPubTypes(bool GnuStyle) {
2504 const MCSection *ISec = Asm->getObjFileLowering().getDwarfInfoSection();
2505 const MCSection *PSec =
2506 GnuStyle ? Asm->getObjFileLowering().getDwarfGnuPubTypesSection()
2507 : Asm->getObjFileLowering().getDwarfPubTypesSection();
2509 for (DenseMap<const MDNode *, CompileUnit *>::iterator I = CUMap.begin(),
2512 CompileUnit *TheCU = I->second;
2513 // Start the dwarf pubtypes section.
2514 Asm->OutStreamer.SwitchSection(PSec);
2516 // Emit a label so we can reference the beginning of this pubtype section.
2518 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("gnu_pubtypes",
2519 TheCU->getUniqueID()));
2522 Asm->OutStreamer.AddComment("Length of Public Types Info");
2523 Asm->EmitLabelDifference(
2524 Asm->GetTempSymbol("pubtypes_end", TheCU->getUniqueID()),
2525 Asm->GetTempSymbol("pubtypes_begin", TheCU->getUniqueID()), 4);
2527 Asm->OutStreamer.EmitLabel(
2528 Asm->GetTempSymbol("pubtypes_begin", TheCU->getUniqueID()));
2530 if (Asm->isVerbose())
2531 Asm->OutStreamer.AddComment("DWARF Version");
2532 Asm->EmitInt16(dwarf::DW_PUBTYPES_VERSION);
2534 Asm->OutStreamer.AddComment("Offset of Compilation Unit Info");
2535 Asm->EmitSectionOffset(
2536 Asm->GetTempSymbol(ISec->getLabelBeginName(), TheCU->getUniqueID()),
2537 DwarfInfoSectionSym);
2539 Asm->OutStreamer.AddComment("Compilation Unit Length");
2540 Asm->EmitLabelDifference(
2541 Asm->GetTempSymbol(ISec->getLabelEndName(), TheCU->getUniqueID()),
2542 Asm->GetTempSymbol(ISec->getLabelBeginName(), TheCU->getUniqueID()), 4);
2544 // Emit the pubtypes.
2545 const StringMap<DIE *> &Globals = TheCU->getGlobalTypes();
2546 for (StringMap<DIE *>::const_iterator GI = Globals.begin(),
2549 const char *Name = GI->getKeyData();
2550 DIE *Entity = GI->second;
2552 if (Asm->isVerbose())
2553 Asm->OutStreamer.AddComment("DIE offset");
2554 Asm->EmitInt32(Entity->getOffset());
2557 dwarf::PubIndexEntryDescriptor Desc = computeIndexValue(TheCU, Entity);
2558 Asm->OutStreamer.AddComment(
2559 Twine("Kind: ") + dwarf::GDBIndexEntryKindString(Desc.Kind) + ", " +
2560 dwarf::GDBIndexEntryLinkageString(Desc.Linkage));
2561 Asm->EmitInt8(Desc.toBits());
2564 if (Asm->isVerbose())
2565 Asm->OutStreamer.AddComment("External Name");
2567 // Emit the name with a terminating null byte.
2568 Asm->OutStreamer.EmitBytes(StringRef(Name, GI->getKeyLength() + 1));
2571 Asm->OutStreamer.AddComment("End Mark");
2573 Asm->OutStreamer.EmitLabel(
2574 Asm->GetTempSymbol("pubtypes_end", TheCU->getUniqueID()));
2578 // Emit strings into a string section.
2579 void DwarfUnits::emitStrings(const MCSection *StrSection,
2580 const MCSection *OffsetSection = NULL,
2581 const MCSymbol *StrSecSym = NULL) {
2583 if (StringPool.empty()) return;
2585 // Start the dwarf str section.
2586 Asm->OutStreamer.SwitchSection(StrSection);
2588 // Get all of the string pool entries and put them in an array by their ID so
2589 // we can sort them.
2590 SmallVector<std::pair<unsigned,
2591 StringMapEntry<std::pair<MCSymbol*, unsigned> >*>, 64> Entries;
2593 for (StringMap<std::pair<MCSymbol*, unsigned> >::iterator
2594 I = StringPool.begin(), E = StringPool.end();
2596 Entries.push_back(std::make_pair(I->second.second, &*I));
2598 array_pod_sort(Entries.begin(), Entries.end());
2600 for (unsigned i = 0, e = Entries.size(); i != e; ++i) {
2601 // Emit a label for reference from debug information entries.
2602 Asm->OutStreamer.EmitLabel(Entries[i].second->getValue().first);
2604 // Emit the string itself with a terminating null byte.
2605 Asm->OutStreamer.EmitBytes(StringRef(Entries[i].second->getKeyData(),
2606 Entries[i].second->getKeyLength()+1));
2609 // If we've got an offset section go ahead and emit that now as well.
2610 if (OffsetSection) {
2611 Asm->OutStreamer.SwitchSection(OffsetSection);
2612 unsigned offset = 0;
2613 unsigned size = 4; // FIXME: DWARF64 is 8.
2614 for (unsigned i = 0, e = Entries.size(); i != e; ++i) {
2615 Asm->OutStreamer.EmitIntValue(offset, size);
2616 offset += Entries[i].second->getKeyLength() + 1;
2621 // Emit strings into a string section.
2622 void DwarfUnits::emitAddresses(const MCSection *AddrSection) {
2624 if (AddressPool.empty()) return;
2626 // Start the dwarf addr section.
2627 Asm->OutStreamer.SwitchSection(AddrSection);
2629 // Order the address pool entries by ID
2630 SmallVector<const MCExpr *, 64> Entries(AddressPool.size());
2632 for (DenseMap<const MCExpr *, unsigned>::iterator I = AddressPool.begin(),
2633 E = AddressPool.end();
2635 Entries[I->second] = I->first;
2637 for (unsigned i = 0, e = Entries.size(); i != e; ++i) {
2638 // Emit an expression for reference from debug information entries.
2639 if (const MCExpr *Expr = Entries[i])
2640 Asm->OutStreamer.EmitValue(Expr, Asm->getDataLayout().getPointerSize());
2642 Asm->OutStreamer.EmitIntValue(0, Asm->getDataLayout().getPointerSize());
2647 // Emit visible names into a debug str section.
2648 void DwarfDebug::emitDebugStr() {
2649 DwarfUnits &Holder = useSplitDwarf() ? SkeletonHolder : InfoHolder;
2650 Holder.emitStrings(Asm->getObjFileLowering().getDwarfStrSection());
2653 // Emit locations into the debug loc section.
2654 void DwarfDebug::emitDebugLoc() {
2655 if (DotDebugLocEntries.empty())
2658 for (SmallVectorImpl<DotDebugLocEntry>::iterator
2659 I = DotDebugLocEntries.begin(), E = DotDebugLocEntries.end();
2661 DotDebugLocEntry &Entry = *I;
2662 if (I + 1 != DotDebugLocEntries.end())
2666 // Start the dwarf loc section.
2667 Asm->OutStreamer.SwitchSection(
2668 Asm->getObjFileLowering().getDwarfLocSection());
2669 unsigned char Size = Asm->getDataLayout().getPointerSize();
2670 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("debug_loc", 0));
2672 for (SmallVectorImpl<DotDebugLocEntry>::iterator
2673 I = DotDebugLocEntries.begin(), E = DotDebugLocEntries.end();
2674 I != E; ++I, ++index) {
2675 DotDebugLocEntry &Entry = *I;
2676 if (Entry.isMerged()) continue;
2677 if (Entry.isEmpty()) {
2678 Asm->OutStreamer.EmitIntValue(0, Size);
2679 Asm->OutStreamer.EmitIntValue(0, Size);
2680 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("debug_loc", index));
2682 Asm->OutStreamer.EmitSymbolValue(Entry.getBeginSym(), Size);
2683 Asm->OutStreamer.EmitSymbolValue(Entry.getEndSym(), Size);
2684 DIVariable DV(Entry.getVariable());
2685 Asm->OutStreamer.AddComment("Loc expr size");
2686 MCSymbol *begin = Asm->OutStreamer.getContext().CreateTempSymbol();
2687 MCSymbol *end = Asm->OutStreamer.getContext().CreateTempSymbol();
2688 Asm->EmitLabelDifference(end, begin, 2);
2689 Asm->OutStreamer.EmitLabel(begin);
2690 if (Entry.isInt()) {
2691 DIBasicType BTy(DV.getType());
2693 (BTy.getEncoding() == dwarf::DW_ATE_signed
2694 || BTy.getEncoding() == dwarf::DW_ATE_signed_char)) {
2695 Asm->OutStreamer.AddComment("DW_OP_consts");
2696 Asm->EmitInt8(dwarf::DW_OP_consts);
2697 Asm->EmitSLEB128(Entry.getInt());
2699 Asm->OutStreamer.AddComment("DW_OP_constu");
2700 Asm->EmitInt8(dwarf::DW_OP_constu);
2701 Asm->EmitULEB128(Entry.getInt());
2703 } else if (Entry.isLocation()) {
2704 MachineLocation Loc = Entry.getLoc();
2705 if (!DV.hasComplexAddress())
2707 Asm->EmitDwarfRegOp(Loc, DV.isIndirect());
2709 // Complex address entry.
2710 unsigned N = DV.getNumAddrElements();
2712 if (N >= 2 && DV.getAddrElement(0) == DIBuilder::OpPlus) {
2713 if (Loc.getOffset()) {
2715 Asm->EmitDwarfRegOp(Loc, DV.isIndirect());
2716 Asm->OutStreamer.AddComment("DW_OP_deref");
2717 Asm->EmitInt8(dwarf::DW_OP_deref);
2718 Asm->OutStreamer.AddComment("DW_OP_plus_uconst");
2719 Asm->EmitInt8(dwarf::DW_OP_plus_uconst);
2720 Asm->EmitSLEB128(DV.getAddrElement(1));
2722 // If first address element is OpPlus then emit
2723 // DW_OP_breg + Offset instead of DW_OP_reg + Offset.
2724 MachineLocation TLoc(Loc.getReg(), DV.getAddrElement(1));
2725 Asm->EmitDwarfRegOp(TLoc, DV.isIndirect());
2729 Asm->EmitDwarfRegOp(Loc, DV.isIndirect());
2732 // Emit remaining complex address elements.
2733 for (; i < N; ++i) {
2734 uint64_t Element = DV.getAddrElement(i);
2735 if (Element == DIBuilder::OpPlus) {
2736 Asm->EmitInt8(dwarf::DW_OP_plus_uconst);
2737 Asm->EmitULEB128(DV.getAddrElement(++i));
2738 } else if (Element == DIBuilder::OpDeref) {
2740 Asm->EmitInt8(dwarf::DW_OP_deref);
2742 llvm_unreachable("unknown Opcode found in complex address");
2746 // else ... ignore constant fp. There is not any good way to
2747 // to represent them here in dwarf.
2748 Asm->OutStreamer.EmitLabel(end);
2753 struct SymbolCUSorter {
2754 SymbolCUSorter(const MCStreamer &s) : Streamer(s) {}
2755 const MCStreamer &Streamer;
2757 bool operator() (const SymbolCU &A, const SymbolCU &B) {
2758 unsigned IA = A.Sym ? Streamer.GetSymbolOrder(A.Sym) : 0;
2759 unsigned IB = B.Sym ? Streamer.GetSymbolOrder(B.Sym) : 0;
2761 // Symbols with no order assigned should be placed at the end.
2762 // (e.g. section end labels)
2764 IA = (unsigned)(-1);
2766 IB = (unsigned)(-1);
2771 static bool CUSort(const CompileUnit *A, const CompileUnit *B) {
2772 return (A->getUniqueID() < B->getUniqueID());
2776 const MCSymbol *Start, *End;
2779 // Emit a debug aranges section, containing a CU lookup for any
2780 // address we can tie back to a CU.
2781 void DwarfDebug::emitDebugARanges() {
2782 // Start the dwarf aranges section.
2784 .SwitchSection(Asm->getObjFileLowering().getDwarfARangesSection());
2786 typedef DenseMap<CompileUnit *, std::vector<ArangeSpan> > SpansType;
2790 // Build a list of sections used.
2791 std::vector<const MCSection *> Sections;
2792 for (SectionMapType::iterator it = SectionMap.begin(); it != SectionMap.end();
2794 const MCSection *Section = it->first;
2795 Sections.push_back(Section);
2798 // Sort the sections into order.
2799 // This is only done to ensure consistent output order across different runs.
2800 std::sort(Sections.begin(), Sections.end(), SectionSort);
2802 // Build a set of address spans, sorted by CU.
2803 for (size_t SecIdx=0;SecIdx<Sections.size();SecIdx++) {
2804 const MCSection *Section = Sections[SecIdx];
2805 SmallVector<SymbolCU, 8> &List = SectionMap[Section];
2806 if (List.size() < 2)
2809 // Sort the symbols by offset within the section.
2810 SymbolCUSorter sorter(Asm->OutStreamer);
2811 std::sort(List.begin(), List.end(), sorter);
2813 // If we have no section (e.g. common), just write out
2814 // individual spans for each symbol.
2815 if (Section == NULL) {
2816 for (size_t n = 0; n < List.size(); n++) {
2817 const SymbolCU &Cur = List[n];
2820 Span.Start = Cur.Sym;
2823 Spans[Cur.CU].push_back(Span);
2826 // Build spans between each label.
2827 const MCSymbol *StartSym = List[0].Sym;
2828 for (size_t n = 1; n < List.size(); n++) {
2829 const SymbolCU &Prev = List[n - 1];
2830 const SymbolCU &Cur = List[n];
2832 // Try and build the longest span we can within the same CU.
2833 if (Cur.CU != Prev.CU) {
2835 Span.Start = StartSym;
2837 Spans[Prev.CU].push_back(Span);
2844 const MCSection *ISec = Asm->getObjFileLowering().getDwarfInfoSection();
2845 unsigned PtrSize = Asm->getDataLayout().getPointerSize();
2847 // Build a list of CUs used.
2848 std::vector<CompileUnit *> CUs;
2849 for (SpansType::iterator it = Spans.begin(); it != Spans.end(); it++) {
2850 CompileUnit *CU = it->first;
2854 // Sort the CU list (again, to ensure consistent output order).
2855 std::sort(CUs.begin(), CUs.end(), CUSort);
2857 // Emit an arange table for each CU we used.
2858 for (size_t CUIdx=0;CUIdx<CUs.size();CUIdx++) {
2859 CompileUnit *CU = CUs[CUIdx];
2860 std::vector<ArangeSpan> &List = Spans[CU];
2862 // Emit size of content not including length itself.
2863 unsigned ContentSize
2864 = sizeof(int16_t) // DWARF ARange version number
2865 + sizeof(int32_t) // Offset of CU in the .debug_info section
2866 + sizeof(int8_t) // Pointer Size (in bytes)
2867 + sizeof(int8_t); // Segment Size (in bytes)
2869 unsigned TupleSize = PtrSize * 2;
2871 // 7.20 in the Dwarf specs requires the table to be aligned to a tuple.
2872 unsigned Padding = 0;
2873 while (((sizeof(int32_t) + ContentSize + Padding) % TupleSize) != 0)
2876 ContentSize += Padding;
2877 ContentSize += (List.size() + 1) * TupleSize;
2879 // For each compile unit, write the list of spans it covers.
2880 Asm->OutStreamer.AddComment("Length of ARange Set");
2881 Asm->EmitInt32(ContentSize);
2882 Asm->OutStreamer.AddComment("DWARF Arange version number");
2883 Asm->EmitInt16(dwarf::DW_ARANGES_VERSION);
2884 Asm->OutStreamer.AddComment("Offset Into Debug Info Section");
2885 Asm->EmitSectionOffset(
2886 Asm->GetTempSymbol(ISec->getLabelBeginName(), CU->getUniqueID()),
2887 DwarfInfoSectionSym);
2888 Asm->OutStreamer.AddComment("Address Size (in bytes)");
2889 Asm->EmitInt8(PtrSize);
2890 Asm->OutStreamer.AddComment("Segment Size (in bytes)");
2893 for (unsigned n = 0; n < Padding; n++)
2894 Asm->EmitInt8(0xff);
2896 for (unsigned n = 0; n < List.size(); n++) {
2897 const ArangeSpan &Span = List[n];
2898 Asm->EmitLabelReference(Span.Start, PtrSize);
2900 // Calculate the size as being from the span start to it's end.
2902 Asm->EmitLabelDifference(Span.End, Span.Start, PtrSize);
2904 // For symbols without an end marker (e.g. common), we
2905 // write a single arange entry containing just that one symbol.
2906 uint64_t Size = SymSize[Span.Start];
2910 Asm->OutStreamer.EmitIntValue(Size, PtrSize);
2914 Asm->OutStreamer.AddComment("ARange terminator");
2915 Asm->OutStreamer.EmitIntValue(0, PtrSize);
2916 Asm->OutStreamer.EmitIntValue(0, PtrSize);
2920 // Emit visible names into a debug ranges section.
2921 void DwarfDebug::emitDebugRanges() {
2922 // Start the dwarf ranges section.
2924 .SwitchSection(Asm->getObjFileLowering().getDwarfRangesSection());
2925 unsigned char Size = Asm->getDataLayout().getPointerSize();
2926 for (SmallVectorImpl<const MCSymbol *>::iterator
2927 I = DebugRangeSymbols.begin(), E = DebugRangeSymbols.end();
2930 Asm->OutStreamer.EmitSymbolValue(const_cast<MCSymbol*>(*I), Size);
2932 Asm->OutStreamer.EmitIntValue(0, Size);
2936 // Emit visible names into a debug macinfo section.
2937 void DwarfDebug::emitDebugMacInfo() {
2938 if (const MCSection *LineInfo =
2939 Asm->getObjFileLowering().getDwarfMacroInfoSection()) {
2940 // Start the dwarf macinfo section.
2941 Asm->OutStreamer.SwitchSection(LineInfo);
2945 // DWARF5 Experimental Separate Dwarf emitters.
2947 // This DIE has the following attributes: DW_AT_comp_dir, DW_AT_stmt_list,
2948 // DW_AT_low_pc, DW_AT_high_pc, DW_AT_ranges, DW_AT_dwo_name, DW_AT_dwo_id,
2949 // DW_AT_ranges_base, DW_AT_addr_base.
2950 CompileUnit *DwarfDebug::constructSkeletonCU(const CompileUnit *CU) {
2952 DIE *Die = new DIE(dwarf::DW_TAG_compile_unit);
2953 CompileUnit *NewCU = new CompileUnit(CU->getUniqueID(), Die, CU->getNode(),
2954 Asm, this, &SkeletonHolder);
2956 NewCU->addLocalString(Die, dwarf::DW_AT_GNU_dwo_name,
2957 CU->getNode().getSplitDebugFilename());
2959 // Relocate to the beginning of the addr_base section, else 0 for the
2960 // beginning of the one for this compile unit.
2961 if (Asm->MAI->doesDwarfUseRelocationsAcrossSections())
2962 NewCU->addLabel(Die, dwarf::DW_AT_GNU_addr_base, dwarf::DW_FORM_sec_offset,
2963 DwarfAddrSectionSym);
2965 NewCU->addUInt(Die, dwarf::DW_AT_GNU_addr_base,
2966 dwarf::DW_FORM_sec_offset, 0);
2968 // 2.17.1 requires that we use DW_AT_low_pc for a single entry point
2969 // into an entity. We're using 0, or a NULL label for this.
2970 NewCU->addUInt(Die, dwarf::DW_AT_low_pc, dwarf::DW_FORM_addr, 0);
2972 // DW_AT_stmt_list is a offset of line number information for this
2973 // compile unit in debug_line section.
2974 // FIXME: Should handle multiple compile units.
2975 if (Asm->MAI->doesDwarfUseRelocationsAcrossSections())
2976 NewCU->addLabel(Die, dwarf::DW_AT_stmt_list, dwarf::DW_FORM_sec_offset,
2977 DwarfLineSectionSym);
2979 NewCU->addUInt(Die, dwarf::DW_AT_stmt_list, dwarf::DW_FORM_sec_offset, 0);
2981 if (!CompilationDir.empty())
2982 NewCU->addLocalString(Die, dwarf::DW_AT_comp_dir, CompilationDir);
2984 // Flags to let the linker know we have emitted new style pubnames.
2985 if (GenerateGnuPubSections) {
2986 if (Asm->MAI->doesDwarfUseRelocationsAcrossSections())
2987 NewCU->addLabel(Die, dwarf::DW_AT_GNU_pubnames, dwarf::DW_FORM_sec_offset,
2988 Asm->GetTempSymbol("gnu_pubnames", NewCU->getUniqueID()));
2990 NewCU->addDelta(Die, dwarf::DW_AT_GNU_pubnames, dwarf::DW_FORM_data4,
2991 Asm->GetTempSymbol("gnu_pubnames", NewCU->getUniqueID()),
2992 DwarfGnuPubNamesSectionSym);
2994 if (Asm->MAI->doesDwarfUseRelocationsAcrossSections())
2995 NewCU->addLabel(Die, dwarf::DW_AT_GNU_pubtypes, dwarf::DW_FORM_sec_offset,
2996 Asm->GetTempSymbol("gnu_pubtypes", NewCU->getUniqueID()));
2998 NewCU->addDelta(Die, dwarf::DW_AT_GNU_pubtypes, dwarf::DW_FORM_data4,
2999 Asm->GetTempSymbol("gnu_pubtypes", NewCU->getUniqueID()),
3000 DwarfGnuPubTypesSectionSym);
3003 // Flag if we've emitted any ranges and their location for the compile unit.
3004 if (DebugRangeSymbols.size()) {
3005 if (Asm->MAI->doesDwarfUseRelocationsAcrossSections())
3006 NewCU->addLabel(Die, dwarf::DW_AT_GNU_ranges_base,
3007 dwarf::DW_FORM_sec_offset, DwarfDebugRangeSectionSym);
3009 NewCU->addUInt(Die, dwarf::DW_AT_GNU_ranges_base, dwarf::DW_FORM_data4,
3013 SkeletonHolder.addUnit(NewCU);
3014 SkeletonCUs.push_back(NewCU);
3019 void DwarfDebug::emitSkeletonAbbrevs(const MCSection *Section) {
3020 assert(useSplitDwarf() && "No split dwarf debug info?");
3021 emitAbbrevs(Section, &SkeletonAbbrevs);
3024 // Emit the .debug_info.dwo section for separated dwarf. This contains the
3025 // compile units that would normally be in debug_info.
3026 void DwarfDebug::emitDebugInfoDWO() {
3027 assert(useSplitDwarf() && "No split dwarf debug info?");
3028 InfoHolder.emitUnits(this, Asm->getObjFileLowering().getDwarfInfoDWOSection(),
3029 Asm->getObjFileLowering().getDwarfAbbrevDWOSection(),
3030 DwarfAbbrevDWOSectionSym);
3033 // Emit the .debug_abbrev.dwo section for separated dwarf. This contains the
3034 // abbreviations for the .debug_info.dwo section.
3035 void DwarfDebug::emitDebugAbbrevDWO() {
3036 assert(useSplitDwarf() && "No split dwarf?");
3037 emitAbbrevs(Asm->getObjFileLowering().getDwarfAbbrevDWOSection(),
3041 // Emit the .debug_str.dwo section for separated dwarf. This contains the
3042 // string section and is identical in format to traditional .debug_str
3044 void DwarfDebug::emitDebugStrDWO() {
3045 assert(useSplitDwarf() && "No split dwarf?");
3046 const MCSection *OffSec = Asm->getObjFileLowering()
3047 .getDwarfStrOffDWOSection();
3048 const MCSymbol *StrSym = DwarfStrSectionSym;
3049 InfoHolder.emitStrings(Asm->getObjFileLowering().getDwarfStrDWOSection(),