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,
370 const MDNode *SPNode) {
371 DIE *SPDie = SPCU->getDIE(SPNode);
373 assert(SPDie && "Unable to find subprogram DIE!");
374 DISubprogram SP(SPNode);
376 // If we're updating an abstract DIE, then we will be adding the children and
377 // object pointer later on. But what we don't want to do is process the
378 // concrete DIE twice.
379 if (DIE *AbsSPDIE = AbstractSPDies.lookup(SPNode)) {
380 // Pick up abstract subprogram DIE.
381 SPDie = SPCU->createAndAddDIE(dwarf::DW_TAG_subprogram, *SPCU->getCUDie());
382 SPCU->addDIEEntry(SPDie, dwarf::DW_AT_abstract_origin, AbsSPDIE);
384 DISubprogram SPDecl = SP.getFunctionDeclaration();
385 if (!SPDecl.isSubprogram()) {
386 // There is not any need to generate specification DIE for a function
387 // defined at compile unit level. If a function is defined inside another
388 // function then gdb prefers the definition at top level and but does not
389 // expect specification DIE in parent function. So avoid creating
390 // specification DIE for a function defined inside a function.
391 DIScope SPContext = resolve(SP.getContext());
392 if (SP.isDefinition() && !SPContext.isCompileUnit() &&
393 !SPContext.isFile() &&
394 !isSubprogramContext(SPContext)) {
395 SPCU->addFlag(SPDie, dwarf::DW_AT_declaration);
398 DICompositeType SPTy = SP.getType();
399 DIArray Args = SPTy.getTypeArray();
400 uint16_t SPTag = SPTy.getTag();
401 if (SPTag == dwarf::DW_TAG_subroutine_type)
402 for (unsigned i = 1, N = Args.getNumElements(); i < N; ++i) {
404 SPCU->createAndAddDIE(dwarf::DW_TAG_formal_parameter, *SPDie);
405 DIType ATy = DIType(Args.getElement(i));
406 SPCU->addType(Arg, ATy);
407 if (ATy.isArtificial())
408 SPCU->addFlag(Arg, dwarf::DW_AT_artificial);
409 if (ATy.isObjectPointer())
410 SPCU->addDIEEntry(SPDie, dwarf::DW_AT_object_pointer, Arg);
412 DIE *SPDeclDie = SPDie;
414 SPCU->createAndAddDIE(dwarf::DW_TAG_subprogram, *SPCU->getCUDie());
415 SPCU->addDIEEntry(SPDie, dwarf::DW_AT_specification, SPDeclDie);
420 SPCU->addLabelAddress(SPDie, dwarf::DW_AT_low_pc,
421 Asm->GetTempSymbol("func_begin",
422 Asm->getFunctionNumber()));
423 SPCU->addLabelAddress(SPDie, dwarf::DW_AT_high_pc,
424 Asm->GetTempSymbol("func_end",
425 Asm->getFunctionNumber()));
426 const TargetRegisterInfo *RI = Asm->TM.getRegisterInfo();
427 MachineLocation Location(RI->getFrameRegister(*Asm->MF));
428 SPCU->addAddress(SPDie, dwarf::DW_AT_frame_base, Location);
430 // Add name to the name table, we do this here because we're guaranteed
431 // to have concrete versions of our DW_TAG_subprogram nodes.
432 addSubprogramNames(SPCU, SP, SPDie);
437 /// Check whether we should create a DIE for the given Scope, return true
438 /// if we don't create a DIE (the corresponding DIE is null).
439 bool DwarfDebug::isLexicalScopeDIENull(LexicalScope *Scope) {
440 if (Scope->isAbstractScope())
443 // We don't create a DIE if there is no Range.
444 const SmallVectorImpl<InsnRange> &Ranges = Scope->getRanges();
448 if (Ranges.size() > 1)
451 // We don't create a DIE if we have a single Range and the end label
453 SmallVectorImpl<InsnRange>::const_iterator RI = Ranges.begin();
454 MCSymbol *End = getLabelAfterInsn(RI->second);
458 // Construct new DW_TAG_lexical_block for this scope and attach
459 // DW_AT_low_pc/DW_AT_high_pc labels.
460 DIE *DwarfDebug::constructLexicalScopeDIE(CompileUnit *TheCU,
461 LexicalScope *Scope) {
462 if (isLexicalScopeDIENull(Scope))
465 DIE *ScopeDIE = new DIE(dwarf::DW_TAG_lexical_block);
466 if (Scope->isAbstractScope())
469 const SmallVectorImpl<InsnRange> &Ranges = Scope->getRanges();
470 // If we have multiple ranges, emit them into the range section.
471 if (Ranges.size() > 1) {
472 // .debug_range section has not been laid out yet. Emit offset in
473 // .debug_range as a uint, size 4, for now. emitDIE will handle
474 // DW_AT_ranges appropriately.
475 TheCU->addUInt(ScopeDIE, dwarf::DW_AT_ranges, dwarf::DW_FORM_data4,
476 DebugRangeSymbols.size()
477 * Asm->getDataLayout().getPointerSize());
478 for (SmallVectorImpl<InsnRange>::const_iterator RI = Ranges.begin(),
479 RE = Ranges.end(); RI != RE; ++RI) {
480 DebugRangeSymbols.push_back(getLabelBeforeInsn(RI->first));
481 DebugRangeSymbols.push_back(getLabelAfterInsn(RI->second));
484 // Terminate the range list.
485 DebugRangeSymbols.push_back(NULL);
486 DebugRangeSymbols.push_back(NULL);
490 // Construct the address range for this DIE.
491 SmallVectorImpl<InsnRange>::const_iterator RI = Ranges.begin();
492 MCSymbol *Start = getLabelBeforeInsn(RI->first);
493 MCSymbol *End = getLabelAfterInsn(RI->second);
494 assert(End && "End label should not be null!");
496 assert(Start->isDefined() && "Invalid starting label for an inlined scope!");
497 assert(End->isDefined() && "Invalid end label for an inlined scope!");
499 TheCU->addLabelAddress(ScopeDIE, dwarf::DW_AT_low_pc, Start);
500 TheCU->addLabelAddress(ScopeDIE, dwarf::DW_AT_high_pc, End);
505 // This scope represents inlined body of a function. Construct DIE to
506 // represent this concrete inlined copy of the function.
507 DIE *DwarfDebug::constructInlinedScopeDIE(CompileUnit *TheCU,
508 LexicalScope *Scope) {
509 const SmallVectorImpl<InsnRange> &Ranges = Scope->getRanges();
510 assert(Ranges.empty() == false &&
511 "LexicalScope does not have instruction markers!");
513 if (!Scope->getScopeNode())
515 DIScope DS(Scope->getScopeNode());
516 DISubprogram InlinedSP = getDISubprogram(DS);
517 DIE *OriginDIE = TheCU->getDIE(InlinedSP);
519 DEBUG(dbgs() << "Unable to find original DIE for an inlined subprogram.");
523 DIE *ScopeDIE = new DIE(dwarf::DW_TAG_inlined_subroutine);
524 TheCU->addDIEEntry(ScopeDIE, dwarf::DW_AT_abstract_origin, OriginDIE);
526 if (Ranges.size() > 1) {
527 // .debug_range section has not been laid out yet. Emit offset in
528 // .debug_range as a uint, size 4, for now. emitDIE will handle
529 // DW_AT_ranges appropriately.
530 TheCU->addUInt(ScopeDIE, dwarf::DW_AT_ranges, dwarf::DW_FORM_data4,
531 DebugRangeSymbols.size()
532 * Asm->getDataLayout().getPointerSize());
533 for (SmallVectorImpl<InsnRange>::const_iterator RI = Ranges.begin(),
534 RE = Ranges.end(); RI != RE; ++RI) {
535 DebugRangeSymbols.push_back(getLabelBeforeInsn(RI->first));
536 DebugRangeSymbols.push_back(getLabelAfterInsn(RI->second));
538 DebugRangeSymbols.push_back(NULL);
539 DebugRangeSymbols.push_back(NULL);
541 SmallVectorImpl<InsnRange>::const_iterator RI = Ranges.begin();
542 MCSymbol *StartLabel = getLabelBeforeInsn(RI->first);
543 MCSymbol *EndLabel = getLabelAfterInsn(RI->second);
545 if (StartLabel == 0 || EndLabel == 0)
546 llvm_unreachable("Unexpected Start and End labels for an inlined scope!");
548 assert(StartLabel->isDefined() &&
549 "Invalid starting label for an inlined scope!");
550 assert(EndLabel->isDefined() && "Invalid end label for an inlined scope!");
552 TheCU->addLabelAddress(ScopeDIE, dwarf::DW_AT_low_pc, StartLabel);
553 TheCU->addLabelAddress(ScopeDIE, dwarf::DW_AT_high_pc, EndLabel);
556 InlinedSubprogramDIEs.insert(OriginDIE);
558 // Add the call site information to the DIE.
559 DILocation DL(Scope->getInlinedAt());
560 TheCU->addUInt(ScopeDIE, dwarf::DW_AT_call_file, None,
561 getOrCreateSourceID(DL.getFilename(), DL.getDirectory(),
562 TheCU->getUniqueID()));
563 TheCU->addUInt(ScopeDIE, dwarf::DW_AT_call_line, None, DL.getLineNumber());
565 // Add name to the name table, we do this here because we're guaranteed
566 // to have concrete versions of our DW_TAG_inlined_subprogram nodes.
567 addSubprogramNames(TheCU, InlinedSP, ScopeDIE);
572 DIE *DwarfDebug::createScopeChildrenDIE(CompileUnit *TheCU, LexicalScope *Scope,
573 SmallVectorImpl<DIE*> &Children) {
574 DIE *ObjectPointer = NULL;
576 // Collect arguments for current function.
577 if (LScopes.isCurrentFunctionScope(Scope))
578 for (unsigned i = 0, N = CurrentFnArguments.size(); i < N; ++i)
579 if (DbgVariable *ArgDV = CurrentFnArguments[i])
581 TheCU->constructVariableDIE(ArgDV, Scope->isAbstractScope())) {
582 Children.push_back(Arg);
583 if (ArgDV->isObjectPointer()) ObjectPointer = Arg;
586 // Collect lexical scope children first.
587 const SmallVectorImpl<DbgVariable *> &Variables =ScopeVariables.lookup(Scope);
588 for (unsigned i = 0, N = Variables.size(); i < N; ++i)
590 TheCU->constructVariableDIE(Variables[i], Scope->isAbstractScope())) {
591 Children.push_back(Variable);
592 if (Variables[i]->isObjectPointer()) ObjectPointer = Variable;
594 const SmallVectorImpl<LexicalScope *> &Scopes = Scope->getChildren();
595 for (unsigned j = 0, M = Scopes.size(); j < M; ++j)
596 if (DIE *Nested = constructScopeDIE(TheCU, Scopes[j]))
597 Children.push_back(Nested);
598 return ObjectPointer;
601 // Construct a DIE for this scope.
602 DIE *DwarfDebug::constructScopeDIE(CompileUnit *TheCU, LexicalScope *Scope) {
603 if (!Scope || !Scope->getScopeNode())
606 DIScope DS(Scope->getScopeNode());
608 SmallVector<DIE *, 8> Children;
609 DIE *ObjectPointer = NULL;
610 bool ChildrenCreated = false;
612 // We try to create the scope DIE first, then the children DIEs. This will
613 // avoid creating un-used children then removing them later when we find out
614 // the scope DIE is null.
615 DIE *ScopeDIE = NULL;
616 if (Scope->getInlinedAt())
617 ScopeDIE = constructInlinedScopeDIE(TheCU, Scope);
618 else if (DS.isSubprogram()) {
619 ProcessedSPNodes.insert(DS);
620 if (Scope->isAbstractScope()) {
621 ScopeDIE = TheCU->getDIE(DS);
622 // Note down abstract DIE.
624 AbstractSPDies.insert(std::make_pair(DS, ScopeDIE));
627 ScopeDIE = updateSubprogramScopeDIE(TheCU, DS);
630 // Early exit when we know the scope DIE is going to be null.
631 if (isLexicalScopeDIENull(Scope))
634 // We create children here when we know the scope DIE is not going to be
635 // null and the children will be added to the scope DIE.
636 ObjectPointer = createScopeChildrenDIE(TheCU, Scope, Children);
637 ChildrenCreated = true;
639 // There is no need to emit empty lexical block DIE.
640 std::pair<ImportedEntityMap::const_iterator,
641 ImportedEntityMap::const_iterator> Range = std::equal_range(
642 ScopesWithImportedEntities.begin(), ScopesWithImportedEntities.end(),
643 std::pair<const MDNode *, const MDNode *>(DS, (const MDNode*)0),
645 if (Children.empty() && Range.first == Range.second)
647 ScopeDIE = constructLexicalScopeDIE(TheCU, Scope);
648 assert(ScopeDIE && "Scope DIE should not be null.");
649 for (ImportedEntityMap::const_iterator i = Range.first; i != Range.second;
651 constructImportedEntityDIE(TheCU, i->second, ScopeDIE);
655 assert(Children.empty() &&
656 "We create children only when the scope DIE is not null.");
659 if (!ChildrenCreated)
660 // We create children when the scope DIE is not null.
661 ObjectPointer = createScopeChildrenDIE(TheCU, Scope, Children);
664 for (SmallVectorImpl<DIE *>::iterator I = Children.begin(),
665 E = Children.end(); I != E; ++I)
666 ScopeDIE->addChild(*I);
668 if (DS.isSubprogram() && ObjectPointer != NULL)
669 TheCU->addDIEEntry(ScopeDIE, dwarf::DW_AT_object_pointer, ObjectPointer);
671 if (DS.isSubprogram())
672 TheCU->addPubTypes(DISubprogram(DS));
677 // Look up the source id with the given directory and source file names.
678 // If none currently exists, create a new id and insert it in the
679 // SourceIds map. This can update DirectoryNames and SourceFileNames maps
681 unsigned DwarfDebug::getOrCreateSourceID(StringRef FileName,
682 StringRef DirName, unsigned CUID) {
683 // If we use .loc in assembly, we can't separate .file entries according to
684 // compile units. Thus all files will belong to the default compile unit.
686 // FIXME: add a better feature test than hasRawTextSupport. Even better,
687 // extend .file to support this.
688 if (Asm->TM.hasMCUseLoc() && Asm->OutStreamer.hasRawTextSupport())
691 // If FE did not provide a file name, then assume stdin.
692 if (FileName.empty())
693 return getOrCreateSourceID("<stdin>", StringRef(), CUID);
695 // TODO: this might not belong here. See if we can factor this better.
696 if (DirName == CompilationDir)
699 // FileIDCUMap stores the current ID for the given compile unit.
700 unsigned SrcId = FileIDCUMap[CUID] + 1;
702 // We look up the CUID/file/dir by concatenating them with a zero byte.
703 SmallString<128> NamePair;
704 NamePair += utostr(CUID);
707 NamePair += '\0'; // Zero bytes are not allowed in paths.
708 NamePair += FileName;
710 StringMapEntry<unsigned> &Ent = SourceIdMap.GetOrCreateValue(NamePair, SrcId);
711 if (Ent.getValue() != SrcId)
712 return Ent.getValue();
714 FileIDCUMap[CUID] = SrcId;
715 // Print out a .file directive to specify files for .loc directives.
716 Asm->OutStreamer.EmitDwarfFileDirective(SrcId, DirName, FileName, CUID);
721 // Create new CompileUnit for the given metadata node with tag
722 // DW_TAG_compile_unit.
723 CompileUnit *DwarfDebug::constructCompileUnit(const MDNode *N) {
724 DICompileUnit DIUnit(N);
725 StringRef FN = DIUnit.getFilename();
726 CompilationDir = DIUnit.getDirectory();
728 DIE *Die = new DIE(dwarf::DW_TAG_compile_unit);
730 new CompileUnit(GlobalCUIndexCount++, Die, N, Asm, this, &InfoHolder);
732 FileIDCUMap[NewCU->getUniqueID()] = 0;
733 // Call this to emit a .file directive if it wasn't emitted for the source
734 // file this CU comes from yet.
735 getOrCreateSourceID(FN, CompilationDir, NewCU->getUniqueID());
737 NewCU->addString(Die, dwarf::DW_AT_producer, DIUnit.getProducer());
738 NewCU->addUInt(Die, dwarf::DW_AT_language, dwarf::DW_FORM_data2,
739 DIUnit.getLanguage());
740 NewCU->addString(Die, dwarf::DW_AT_name, FN);
742 // 2.17.1 requires that we use DW_AT_low_pc for a single entry point
743 // into an entity. We're using 0 (or a NULL label) for this. For
744 // split dwarf it's in the skeleton CU so omit it here.
745 if (!useSplitDwarf())
746 NewCU->addLabelAddress(Die, dwarf::DW_AT_low_pc, NULL);
748 // Define start line table label for each Compile Unit.
749 MCSymbol *LineTableStartSym = Asm->GetTempSymbol("line_table_start",
750 NewCU->getUniqueID());
751 Asm->OutStreamer.getContext().setMCLineTableSymbol(LineTableStartSym,
752 NewCU->getUniqueID());
754 // Use a single line table if we are using .loc and generating assembly.
756 (Asm->TM.hasMCUseLoc() && Asm->OutStreamer.hasRawTextSupport()) ||
757 (NewCU->getUniqueID() == 0);
759 if (!useSplitDwarf()) {
760 // DW_AT_stmt_list is a offset of line number information for this
761 // compile unit in debug_line section. For split dwarf this is
762 // left in the skeleton CU and so not included.
763 // The line table entries are not always emitted in assembly, so it
764 // is not okay to use line_table_start here.
765 if (Asm->MAI->doesDwarfUseRelocationsAcrossSections())
766 NewCU->addLabel(Die, dwarf::DW_AT_stmt_list, dwarf::DW_FORM_sec_offset,
767 UseTheFirstCU ? Asm->GetTempSymbol("section_line")
768 : LineTableStartSym);
769 else if (UseTheFirstCU)
770 NewCU->addUInt(Die, dwarf::DW_AT_stmt_list, dwarf::DW_FORM_data4, 0);
772 NewCU->addDelta(Die, dwarf::DW_AT_stmt_list, dwarf::DW_FORM_data4,
773 LineTableStartSym, DwarfLineSectionSym);
775 // If we're using split dwarf the compilation dir is going to be in the
776 // skeleton CU and so we don't need to duplicate it here.
777 if (!CompilationDir.empty())
778 NewCU->addString(Die, dwarf::DW_AT_comp_dir, CompilationDir);
780 // Flags to let the linker know we have emitted new style pubnames. Only
781 // emit it here if we don't have a skeleton CU for split dwarf.
782 if (GenerateGnuPubSections) {
783 if (Asm->MAI->doesDwarfUseRelocationsAcrossSections())
784 NewCU->addLabel(Die, dwarf::DW_AT_GNU_pubnames,
785 dwarf::DW_FORM_sec_offset,
786 Asm->GetTempSymbol("gnu_pubnames",
787 NewCU->getUniqueID()));
789 NewCU->addDelta(Die, dwarf::DW_AT_GNU_pubnames, dwarf::DW_FORM_data4,
790 Asm->GetTempSymbol("gnu_pubnames",
791 NewCU->getUniqueID()),
792 DwarfGnuPubNamesSectionSym);
794 if (Asm->MAI->doesDwarfUseRelocationsAcrossSections())
795 NewCU->addLabel(Die, dwarf::DW_AT_GNU_pubtypes,
796 dwarf::DW_FORM_sec_offset,
797 Asm->GetTempSymbol("gnu_pubtypes",
798 NewCU->getUniqueID()));
800 NewCU->addDelta(Die, dwarf::DW_AT_GNU_pubtypes, dwarf::DW_FORM_data4,
801 Asm->GetTempSymbol("gnu_pubtypes",
802 NewCU->getUniqueID()),
803 DwarfGnuPubTypesSectionSym);
807 if (DIUnit.isOptimized())
808 NewCU->addFlag(Die, dwarf::DW_AT_APPLE_optimized);
810 StringRef Flags = DIUnit.getFlags();
812 NewCU->addString(Die, dwarf::DW_AT_APPLE_flags, Flags);
814 if (unsigned RVer = DIUnit.getRunTimeVersion())
815 NewCU->addUInt(Die, dwarf::DW_AT_APPLE_major_runtime_vers,
816 dwarf::DW_FORM_data1, RVer);
821 InfoHolder.addUnit(NewCU);
823 CUMap.insert(std::make_pair(N, NewCU));
824 CUDieMap.insert(std::make_pair(Die, NewCU));
828 // Construct subprogram DIE.
829 void DwarfDebug::constructSubprogramDIE(CompileUnit *TheCU, const MDNode *N) {
830 // FIXME: We should only call this routine once, however, during LTO if a
831 // program is defined in multiple CUs we could end up calling it out of
832 // beginModule as we walk the CUs.
834 CompileUnit *&CURef = SPMap[N];
840 if (!SP.isDefinition())
841 // This is a method declaration which will be handled while constructing
845 DIE *SubprogramDie = TheCU->getOrCreateSubprogramDIE(SP);
847 // Expose as a global name.
848 TheCU->addGlobalName(SP.getName(), SubprogramDie, resolve(SP.getContext()));
851 void DwarfDebug::constructImportedEntityDIE(CompileUnit *TheCU,
853 DIImportedEntity Module(N);
854 if (!Module.Verify())
856 if (DIE *D = TheCU->getOrCreateContextDIE(Module.getContext()))
857 constructImportedEntityDIE(TheCU, Module, D);
860 void DwarfDebug::constructImportedEntityDIE(CompileUnit *TheCU, const MDNode *N,
862 DIImportedEntity Module(N);
863 if (!Module.Verify())
865 return constructImportedEntityDIE(TheCU, Module, Context);
868 void DwarfDebug::constructImportedEntityDIE(CompileUnit *TheCU,
869 const DIImportedEntity &Module,
871 assert(Module.Verify() &&
872 "Use one of the MDNode * overloads to handle invalid metadata");
873 assert(Context && "Should always have a context for an imported_module");
874 DIE *IMDie = new DIE(Module.getTag());
875 TheCU->insertDIE(Module, IMDie);
877 DIDescriptor Entity = Module.getEntity();
878 if (Entity.isNameSpace())
879 EntityDie = TheCU->getOrCreateNameSpace(DINameSpace(Entity));
880 else if (Entity.isSubprogram())
881 EntityDie = TheCU->getOrCreateSubprogramDIE(DISubprogram(Entity));
882 else if (Entity.isType())
883 EntityDie = TheCU->getOrCreateTypeDIE(DIType(Entity));
885 EntityDie = TheCU->getDIE(Entity);
886 unsigned FileID = getOrCreateSourceID(Module.getContext().getFilename(),
887 Module.getContext().getDirectory(),
888 TheCU->getUniqueID());
889 TheCU->addUInt(IMDie, dwarf::DW_AT_decl_file, None, FileID);
890 TheCU->addUInt(IMDie, dwarf::DW_AT_decl_line, None, Module.getLineNumber());
891 TheCU->addDIEEntry(IMDie, dwarf::DW_AT_import, EntityDie);
892 StringRef Name = Module.getName();
894 TheCU->addString(IMDie, dwarf::DW_AT_name, Name);
895 Context->addChild(IMDie);
898 // Emit all Dwarf sections that should come prior to the content. Create
899 // global DIEs and emit initial debug info sections. This is invoked by
900 // the target AsmPrinter.
901 void DwarfDebug::beginModule() {
902 if (DisableDebugInfoPrinting)
905 const Module *M = MMI->getModule();
907 // If module has named metadata anchors then use them, otherwise scan the
908 // module using debug info finder to collect debug info.
909 NamedMDNode *CU_Nodes = M->getNamedMetadata("llvm.dbg.cu");
912 TypeIdentifierMap = generateDITypeIdentifierMap(CU_Nodes);
914 // Emit initial sections so we can reference labels later.
917 for (unsigned i = 0, e = CU_Nodes->getNumOperands(); i != e; ++i) {
918 DICompileUnit CUNode(CU_Nodes->getOperand(i));
919 CompileUnit *CU = constructCompileUnit(CUNode);
920 DIArray ImportedEntities = CUNode.getImportedEntities();
921 for (unsigned i = 0, e = ImportedEntities.getNumElements(); i != e; ++i)
922 ScopesWithImportedEntities.push_back(std::make_pair(
923 DIImportedEntity(ImportedEntities.getElement(i)).getContext(),
924 ImportedEntities.getElement(i)));
925 std::sort(ScopesWithImportedEntities.begin(),
926 ScopesWithImportedEntities.end(), less_first());
927 DIArray GVs = CUNode.getGlobalVariables();
928 for (unsigned i = 0, e = GVs.getNumElements(); i != e; ++i)
929 CU->createGlobalVariableDIE(GVs.getElement(i));
930 DIArray SPs = CUNode.getSubprograms();
931 for (unsigned i = 0, e = SPs.getNumElements(); i != e; ++i)
932 constructSubprogramDIE(CU, SPs.getElement(i));
933 DIArray EnumTypes = CUNode.getEnumTypes();
934 for (unsigned i = 0, e = EnumTypes.getNumElements(); i != e; ++i)
935 CU->getOrCreateTypeDIE(EnumTypes.getElement(i));
936 DIArray RetainedTypes = CUNode.getRetainedTypes();
937 for (unsigned i = 0, e = RetainedTypes.getNumElements(); i != e; ++i)
938 CU->getOrCreateTypeDIE(RetainedTypes.getElement(i));
939 // Emit imported_modules last so that the relevant context is already
941 for (unsigned i = 0, e = ImportedEntities.getNumElements(); i != e; ++i)
942 constructImportedEntityDIE(CU, ImportedEntities.getElement(i));
945 // Tell MMI that we have debug info.
946 MMI->setDebugInfoAvailability(true);
948 // Prime section data.
949 SectionMap[Asm->getObjFileLowering().getTextSection()];
952 // Attach DW_AT_inline attribute with inlined subprogram DIEs.
953 void DwarfDebug::computeInlinedDIEs() {
954 // Attach DW_AT_inline attribute with inlined subprogram DIEs.
955 for (SmallPtrSet<DIE *, 4>::iterator AI = InlinedSubprogramDIEs.begin(),
956 AE = InlinedSubprogramDIEs.end(); AI != AE; ++AI) {
958 FirstCU->addUInt(ISP, dwarf::DW_AT_inline, None, dwarf::DW_INL_inlined);
960 for (DenseMap<const MDNode *, DIE *>::iterator AI = AbstractSPDies.begin(),
961 AE = AbstractSPDies.end(); AI != AE; ++AI) {
962 DIE *ISP = AI->second;
963 if (InlinedSubprogramDIEs.count(ISP))
965 FirstCU->addUInt(ISP, dwarf::DW_AT_inline, None, dwarf::DW_INL_inlined);
969 // Collect info for variables that were optimized out.
970 void DwarfDebug::collectDeadVariables() {
971 const Module *M = MMI->getModule();
973 if (NamedMDNode *CU_Nodes = M->getNamedMetadata("llvm.dbg.cu")) {
974 for (unsigned i = 0, e = CU_Nodes->getNumOperands(); i != e; ++i) {
975 DICompileUnit TheCU(CU_Nodes->getOperand(i));
976 DIArray Subprograms = TheCU.getSubprograms();
977 for (unsigned i = 0, e = Subprograms.getNumElements(); i != e; ++i) {
978 DISubprogram SP(Subprograms.getElement(i));
979 if (ProcessedSPNodes.count(SP) != 0)
981 if (!SP.isSubprogram())
983 if (!SP.isDefinition())
985 DIArray Variables = SP.getVariables();
986 if (Variables.getNumElements() == 0)
989 // Construct subprogram DIE and add variables DIEs.
990 CompileUnit *SPCU = CUMap.lookup(TheCU);
991 assert(SPCU && "Unable to find Compile Unit!");
992 // FIXME: See the comment in constructSubprogramDIE about duplicate
994 constructSubprogramDIE(SPCU, SP);
995 DIE *SPDIE = SPCU->getDIE(SP);
996 for (unsigned vi = 0, ve = Variables.getNumElements(); vi != ve; ++vi) {
997 DIVariable DV(Variables.getElement(vi));
998 if (!DV.isVariable())
1000 DbgVariable NewVar(DV, NULL, this);
1001 if (DIE *VariableDIE =
1002 SPCU->constructVariableDIE(&NewVar, false))
1003 SPDIE->addChild(VariableDIE);
1010 // Type Signature [7.27] and ODR Hash code.
1012 /// \brief Grabs the string in whichever attribute is passed in and returns
1013 /// a reference to it. Returns "" if the attribute doesn't exist.
1014 static StringRef getDIEStringAttr(DIE *Die, unsigned Attr) {
1015 DIEValue *V = Die->findAttribute(Attr);
1017 if (DIEString *S = dyn_cast_or_null<DIEString>(V))
1018 return S->getString();
1020 return StringRef("");
1023 /// Return true if the current DIE is contained within an anonymous namespace.
1024 static bool isContainedInAnonNamespace(DIE *Die) {
1025 DIE *Parent = Die->getParent();
1028 if (Parent->getTag() == dwarf::DW_TAG_namespace &&
1029 getDIEStringAttr(Parent, dwarf::DW_AT_name) == "")
1031 Parent = Parent->getParent();
1037 /// Test if the current CU language is C++ and that we have
1038 /// a named type that is not contained in an anonymous namespace.
1039 static bool shouldAddODRHash(CompileUnit *CU, DIE *Die) {
1040 return CU->getLanguage() == dwarf::DW_LANG_C_plus_plus &&
1041 getDIEStringAttr(Die, dwarf::DW_AT_name) != "" &&
1042 !isContainedInAnonNamespace(Die);
1045 void DwarfDebug::finalizeModuleInfo() {
1046 // Collect info for variables that were optimized out.
1047 collectDeadVariables();
1049 // Attach DW_AT_inline attribute with inlined subprogram DIEs.
1050 computeInlinedDIEs();
1052 // Split out type units and conditionally add an ODR tag to the split
1054 // FIXME: Do type splitting.
1055 for (unsigned i = 0, e = TypeUnits.size(); i != e; ++i) {
1056 DIE *Die = TypeUnits[i];
1058 // If we've requested ODR hashes and it's applicable for an ODR hash then
1059 // add the ODR signature now.
1060 // FIXME: This should be added onto the type unit, not the type, but this
1061 // works as an intermediate stage.
1062 if (GenerateODRHash && shouldAddODRHash(CUMap.begin()->second, Die))
1063 CUMap.begin()->second->addUInt(Die, dwarf::DW_AT_GNU_odr_signature,
1064 dwarf::DW_FORM_data8,
1065 Hash.computeDIEODRSignature(*Die));
1068 // Handle anything that needs to be done on a per-cu basis.
1069 for (DenseMap<const MDNode *, CompileUnit *>::iterator CUI = CUMap.begin(),
1071 CUI != CUE; ++CUI) {
1072 CompileUnit *TheCU = CUI->second;
1073 // Emit DW_AT_containing_type attribute to connect types with their
1074 // vtable holding type.
1075 TheCU->constructContainingTypeDIEs();
1077 // If we're splitting the dwarf out now that we've got the entire
1078 // CU then construct a skeleton CU based upon it.
1079 if (useSplitDwarf()) {
1081 if (GenerateCUHash) {
1083 ID = CUHash.computeCUSignature(*TheCU->getCUDie());
1085 // This should be a unique identifier when we want to build .dwp files.
1086 TheCU->addUInt(TheCU->getCUDie(), dwarf::DW_AT_GNU_dwo_id,
1087 dwarf::DW_FORM_data8, ID);
1088 // Now construct the skeleton CU associated.
1089 CompileUnit *SkCU = constructSkeletonCU(TheCU);
1090 // This should be a unique identifier when we want to build .dwp files.
1091 SkCU->addUInt(SkCU->getCUDie(), dwarf::DW_AT_GNU_dwo_id,
1092 dwarf::DW_FORM_data8, ID);
1096 // Compute DIE offsets and sizes.
1097 InfoHolder.computeSizeAndOffsets();
1098 if (useSplitDwarf())
1099 SkeletonHolder.computeSizeAndOffsets();
1102 void DwarfDebug::endSections() {
1103 // Filter labels by section.
1104 for (size_t n = 0; n < ArangeLabels.size(); n++) {
1105 const SymbolCU &SCU = ArangeLabels[n];
1106 if (SCU.Sym->isInSection()) {
1107 // Make a note of this symbol and it's section.
1108 const MCSection *Section = &SCU.Sym->getSection();
1109 if (!Section->getKind().isMetadata())
1110 SectionMap[Section].push_back(SCU);
1112 // Some symbols (e.g. common/bss on mach-o) can have no section but still
1113 // appear in the output. This sucks as we rely on sections to build
1114 // arange spans. We can do it without, but it's icky.
1115 SectionMap[NULL].push_back(SCU);
1119 // Build a list of sections used.
1120 std::vector<const MCSection *> Sections;
1121 for (SectionMapType::iterator it = SectionMap.begin(); it != SectionMap.end();
1123 const MCSection *Section = it->first;
1124 Sections.push_back(Section);
1127 // Sort the sections into order.
1128 // This is only done to ensure consistent output order across different runs.
1129 std::sort(Sections.begin(), Sections.end(), SectionSort);
1131 // Add terminating symbols for each section.
1132 for (unsigned ID=0;ID<Sections.size();ID++) {
1133 const MCSection *Section = Sections[ID];
1134 MCSymbol *Sym = NULL;
1137 // We can't call MCSection::getLabelEndName, as it's only safe to do so
1138 // if we know the section name up-front. For user-created sections, the resulting
1139 // label may not be valid to use as a label. (section names can use a greater
1140 // set of characters on some systems)
1141 Sym = Asm->GetTempSymbol("debug_end", ID);
1142 Asm->OutStreamer.SwitchSection(Section);
1143 Asm->OutStreamer.EmitLabel(Sym);
1146 // Insert a final terminator.
1147 SectionMap[Section].push_back(SymbolCU(NULL, Sym));
1151 // Emit all Dwarf sections that should come after the content.
1152 void DwarfDebug::endModule() {
1154 if (!FirstCU) return;
1156 // End any existing sections.
1157 // TODO: Does this need to happen?
1160 // Finalize the debug info for the module.
1161 finalizeModuleInfo();
1163 if (!useSplitDwarf()) {
1166 // Emit all the DIEs into a debug info section.
1169 // Corresponding abbreviations into a abbrev section.
1170 emitAbbreviations();
1172 // Emit info into a debug loc section.
1175 // Emit info into a debug aranges section.
1178 // Emit info into a debug ranges section.
1181 // Emit info into a debug macinfo section.
1185 // TODO: Fill this in for separated debug sections and separate
1186 // out information into new sections.
1188 if (useSplitDwarf())
1191 // Emit the debug info section and compile units.
1195 // Corresponding abbreviations into a abbrev section.
1196 emitAbbreviations();
1197 emitDebugAbbrevDWO();
1199 // Emit info into a debug loc section.
1202 // Emit info into a debug aranges section.
1205 // Emit info into a debug ranges section.
1208 // Emit info into a debug macinfo section.
1211 // Emit DWO addresses.
1212 InfoHolder.emitAddresses(Asm->getObjFileLowering().getDwarfAddrSection());
1216 // Emit info into the dwarf accelerator table sections.
1217 if (useDwarfAccelTables()) {
1220 emitAccelNamespaces();
1224 // Emit the pubnames and pubtypes sections if requested.
1225 if (HasDwarfPubSections) {
1226 emitDebugPubNames(GenerateGnuPubSections);
1227 emitDebugPubTypes(GenerateGnuPubSections);
1232 for (DenseMap<const MDNode *, CompileUnit *>::iterator I = CUMap.begin(),
1233 E = CUMap.end(); I != E; ++I)
1236 for (SmallVectorImpl<CompileUnit *>::iterator I = SkeletonCUs.begin(),
1237 E = SkeletonCUs.end(); I != E; ++I)
1240 // Reset these for the next Module if we have one.
1244 // Find abstract variable, if any, associated with Var.
1245 DbgVariable *DwarfDebug::findAbstractVariable(DIVariable &DV,
1246 DebugLoc ScopeLoc) {
1247 LLVMContext &Ctx = DV->getContext();
1248 // More then one inlined variable corresponds to one abstract variable.
1249 DIVariable Var = cleanseInlinedVariable(DV, Ctx);
1250 DbgVariable *AbsDbgVariable = AbstractVariables.lookup(Var);
1252 return AbsDbgVariable;
1254 LexicalScope *Scope = LScopes.findAbstractScope(ScopeLoc.getScope(Ctx));
1258 AbsDbgVariable = new DbgVariable(Var, NULL, this);
1259 addScopeVariable(Scope, AbsDbgVariable);
1260 AbstractVariables[Var] = AbsDbgVariable;
1261 return AbsDbgVariable;
1264 // If Var is a current function argument then add it to CurrentFnArguments list.
1265 bool DwarfDebug::addCurrentFnArgument(const MachineFunction *MF,
1266 DbgVariable *Var, LexicalScope *Scope) {
1267 if (!LScopes.isCurrentFunctionScope(Scope))
1269 DIVariable DV = Var->getVariable();
1270 if (DV.getTag() != dwarf::DW_TAG_arg_variable)
1272 unsigned ArgNo = DV.getArgNumber();
1276 size_t Size = CurrentFnArguments.size();
1278 CurrentFnArguments.resize(MF->getFunction()->arg_size());
1279 // llvm::Function argument size is not good indicator of how many
1280 // arguments does the function have at source level.
1282 CurrentFnArguments.resize(ArgNo * 2);
1283 CurrentFnArguments[ArgNo - 1] = Var;
1287 // Collect variable information from side table maintained by MMI.
1289 DwarfDebug::collectVariableInfoFromMMITable(const MachineFunction *MF,
1290 SmallPtrSet<const MDNode *, 16> &Processed) {
1291 MachineModuleInfo::VariableDbgInfoMapTy &VMap = MMI->getVariableDbgInfo();
1292 for (MachineModuleInfo::VariableDbgInfoMapTy::iterator VI = VMap.begin(),
1293 VE = VMap.end(); VI != VE; ++VI) {
1294 const MDNode *Var = VI->first;
1296 Processed.insert(Var);
1298 const std::pair<unsigned, DebugLoc> &VP = VI->second;
1300 LexicalScope *Scope = LScopes.findLexicalScope(VP.second);
1302 // If variable scope is not found then skip this variable.
1306 DbgVariable *AbsDbgVariable = findAbstractVariable(DV, VP.second);
1307 DbgVariable *RegVar = new DbgVariable(DV, AbsDbgVariable, this);
1308 RegVar->setFrameIndex(VP.first);
1309 if (!addCurrentFnArgument(MF, RegVar, Scope))
1310 addScopeVariable(Scope, RegVar);
1312 AbsDbgVariable->setFrameIndex(VP.first);
1316 // Return true if debug value, encoded by DBG_VALUE instruction, is in a
1318 static bool isDbgValueInDefinedReg(const MachineInstr *MI) {
1319 assert(MI->isDebugValue() && "Invalid DBG_VALUE machine instruction!");
1320 return MI->getNumOperands() == 3 &&
1321 MI->getOperand(0).isReg() && MI->getOperand(0).getReg() &&
1322 (MI->getOperand(1).isImm() ||
1323 (MI->getOperand(1).isReg() && MI->getOperand(1).getReg() == 0U));
1326 // Get .debug_loc entry for the instruction range starting at MI.
1327 static DotDebugLocEntry getDebugLocEntry(AsmPrinter *Asm,
1328 const MCSymbol *FLabel,
1329 const MCSymbol *SLabel,
1330 const MachineInstr *MI) {
1331 const MDNode *Var = MI->getOperand(MI->getNumOperands() - 1).getMetadata();
1333 assert(MI->getNumOperands() == 3);
1334 if (MI->getOperand(0).isReg()) {
1335 MachineLocation MLoc;
1336 // If the second operand is an immediate, this is a
1337 // register-indirect address.
1338 if (!MI->getOperand(1).isImm())
1339 MLoc.set(MI->getOperand(0).getReg());
1341 MLoc.set(MI->getOperand(0).getReg(), MI->getOperand(1).getImm());
1342 return DotDebugLocEntry(FLabel, SLabel, MLoc, Var);
1344 if (MI->getOperand(0).isImm())
1345 return DotDebugLocEntry(FLabel, SLabel, MI->getOperand(0).getImm());
1346 if (MI->getOperand(0).isFPImm())
1347 return DotDebugLocEntry(FLabel, SLabel, MI->getOperand(0).getFPImm());
1348 if (MI->getOperand(0).isCImm())
1349 return DotDebugLocEntry(FLabel, SLabel, MI->getOperand(0).getCImm());
1351 llvm_unreachable("Unexpected 3 operand DBG_VALUE instruction!");
1354 // Find variables for each lexical scope.
1356 DwarfDebug::collectVariableInfo(const MachineFunction *MF,
1357 SmallPtrSet<const MDNode *, 16> &Processed) {
1359 // Grab the variable info that was squirreled away in the MMI side-table.
1360 collectVariableInfoFromMMITable(MF, Processed);
1362 for (SmallVectorImpl<const MDNode*>::const_iterator
1363 UVI = UserVariables.begin(), UVE = UserVariables.end(); UVI != UVE;
1365 const MDNode *Var = *UVI;
1366 if (Processed.count(Var))
1369 // History contains relevant DBG_VALUE instructions for Var and instructions
1371 SmallVectorImpl<const MachineInstr*> &History = DbgValues[Var];
1372 if (History.empty())
1374 const MachineInstr *MInsn = History.front();
1377 LexicalScope *Scope = NULL;
1378 if (DV.getTag() == dwarf::DW_TAG_arg_variable &&
1379 DISubprogram(DV.getContext()).describes(MF->getFunction()))
1380 Scope = LScopes.getCurrentFunctionScope();
1381 else if (MDNode *IA = DV.getInlinedAt())
1382 Scope = LScopes.findInlinedScope(DebugLoc::getFromDILocation(IA));
1384 Scope = LScopes.findLexicalScope(cast<MDNode>(DV->getOperand(1)));
1385 // If variable scope is not found then skip this variable.
1389 Processed.insert(DV);
1390 assert(MInsn->isDebugValue() && "History must begin with debug value");
1391 DbgVariable *AbsVar = findAbstractVariable(DV, MInsn->getDebugLoc());
1392 DbgVariable *RegVar = new DbgVariable(DV, AbsVar, this);
1393 if (!addCurrentFnArgument(MF, RegVar, Scope))
1394 addScopeVariable(Scope, RegVar);
1396 AbsVar->setMInsn(MInsn);
1398 // Simplify ranges that are fully coalesced.
1399 if (History.size() <= 1 || (History.size() == 2 &&
1400 MInsn->isIdenticalTo(History.back()))) {
1401 RegVar->setMInsn(MInsn);
1405 // Handle multiple DBG_VALUE instructions describing one variable.
1406 RegVar->setDotDebugLocOffset(DotDebugLocEntries.size());
1408 for (SmallVectorImpl<const MachineInstr*>::const_iterator
1409 HI = History.begin(), HE = History.end(); HI != HE; ++HI) {
1410 const MachineInstr *Begin = *HI;
1411 assert(Begin->isDebugValue() && "Invalid History entry");
1413 // Check if DBG_VALUE is truncating a range.
1414 if (Begin->getNumOperands() > 1 && Begin->getOperand(0).isReg()
1415 && !Begin->getOperand(0).getReg())
1418 // Compute the range for a register location.
1419 const MCSymbol *FLabel = getLabelBeforeInsn(Begin);
1420 const MCSymbol *SLabel = 0;
1423 // If Begin is the last instruction in History then its value is valid
1424 // until the end of the function.
1425 SLabel = FunctionEndSym;
1427 const MachineInstr *End = HI[1];
1428 DEBUG(dbgs() << "DotDebugLoc Pair:\n"
1429 << "\t" << *Begin << "\t" << *End << "\n");
1430 if (End->isDebugValue())
1431 SLabel = getLabelBeforeInsn(End);
1433 // End is a normal instruction clobbering the range.
1434 SLabel = getLabelAfterInsn(End);
1435 assert(SLabel && "Forgot label after clobber instruction");
1440 // The value is valid until the next DBG_VALUE or clobber.
1441 DotDebugLocEntries.push_back(getDebugLocEntry(Asm, FLabel, SLabel,
1444 DotDebugLocEntries.push_back(DotDebugLocEntry());
1447 // Collect info for variables that were optimized out.
1448 LexicalScope *FnScope = LScopes.getCurrentFunctionScope();
1449 DIArray Variables = DISubprogram(FnScope->getScopeNode()).getVariables();
1450 for (unsigned i = 0, e = Variables.getNumElements(); i != e; ++i) {
1451 DIVariable DV(Variables.getElement(i));
1452 if (!DV || !DV.isVariable() || !Processed.insert(DV))
1454 if (LexicalScope *Scope = LScopes.findLexicalScope(DV.getContext()))
1455 addScopeVariable(Scope, new DbgVariable(DV, NULL, this));
1459 // Return Label preceding the instruction.
1460 MCSymbol *DwarfDebug::getLabelBeforeInsn(const MachineInstr *MI) {
1461 MCSymbol *Label = LabelsBeforeInsn.lookup(MI);
1462 assert(Label && "Didn't insert label before instruction");
1466 // Return Label immediately following the instruction.
1467 MCSymbol *DwarfDebug::getLabelAfterInsn(const MachineInstr *MI) {
1468 return LabelsAfterInsn.lookup(MI);
1471 // Process beginning of an instruction.
1472 void DwarfDebug::beginInstruction(const MachineInstr *MI) {
1473 // Check if source location changes, but ignore DBG_VALUE locations.
1474 if (!MI->isDebugValue()) {
1475 DebugLoc DL = MI->getDebugLoc();
1476 if (DL != PrevInstLoc && (!DL.isUnknown() || UnknownLocations)) {
1479 if (DL == PrologEndLoc) {
1480 Flags |= DWARF2_FLAG_PROLOGUE_END;
1481 PrologEndLoc = DebugLoc();
1483 if (PrologEndLoc.isUnknown())
1484 Flags |= DWARF2_FLAG_IS_STMT;
1486 if (!DL.isUnknown()) {
1487 const MDNode *Scope = DL.getScope(Asm->MF->getFunction()->getContext());
1488 recordSourceLine(DL.getLine(), DL.getCol(), Scope, Flags);
1490 recordSourceLine(0, 0, 0, 0);
1494 // Insert labels where requested.
1495 DenseMap<const MachineInstr*, MCSymbol*>::iterator I =
1496 LabelsBeforeInsn.find(MI);
1499 if (I == LabelsBeforeInsn.end())
1502 // Label already assigned.
1507 PrevLabel = MMI->getContext().CreateTempSymbol();
1508 Asm->OutStreamer.EmitLabel(PrevLabel);
1510 I->second = PrevLabel;
1513 // Process end of an instruction.
1514 void DwarfDebug::endInstruction(const MachineInstr *MI) {
1515 // Don't create a new label after DBG_VALUE instructions.
1516 // They don't generate code.
1517 if (!MI->isDebugValue())
1520 DenseMap<const MachineInstr*, MCSymbol*>::iterator I =
1521 LabelsAfterInsn.find(MI);
1524 if (I == LabelsAfterInsn.end())
1527 // Label already assigned.
1531 // We need a label after this instruction.
1533 PrevLabel = MMI->getContext().CreateTempSymbol();
1534 Asm->OutStreamer.EmitLabel(PrevLabel);
1536 I->second = PrevLabel;
1539 // Each LexicalScope has first instruction and last instruction to mark
1540 // beginning and end of a scope respectively. Create an inverse map that list
1541 // scopes starts (and ends) with an instruction. One instruction may start (or
1542 // end) multiple scopes. Ignore scopes that are not reachable.
1543 void DwarfDebug::identifyScopeMarkers() {
1544 SmallVector<LexicalScope *, 4> WorkList;
1545 WorkList.push_back(LScopes.getCurrentFunctionScope());
1546 while (!WorkList.empty()) {
1547 LexicalScope *S = WorkList.pop_back_val();
1549 const SmallVectorImpl<LexicalScope *> &Children = S->getChildren();
1550 if (!Children.empty())
1551 for (SmallVectorImpl<LexicalScope *>::const_iterator SI = Children.begin(),
1552 SE = Children.end(); SI != SE; ++SI)
1553 WorkList.push_back(*SI);
1555 if (S->isAbstractScope())
1558 const SmallVectorImpl<InsnRange> &Ranges = S->getRanges();
1561 for (SmallVectorImpl<InsnRange>::const_iterator RI = Ranges.begin(),
1562 RE = Ranges.end(); RI != RE; ++RI) {
1563 assert(RI->first && "InsnRange does not have first instruction!");
1564 assert(RI->second && "InsnRange does not have second instruction!");
1565 requestLabelBeforeInsn(RI->first);
1566 requestLabelAfterInsn(RI->second);
1571 // Get MDNode for DebugLoc's scope.
1572 static MDNode *getScopeNode(DebugLoc DL, const LLVMContext &Ctx) {
1573 if (MDNode *InlinedAt = DL.getInlinedAt(Ctx))
1574 return getScopeNode(DebugLoc::getFromDILocation(InlinedAt), Ctx);
1575 return DL.getScope(Ctx);
1578 // Walk up the scope chain of given debug loc and find line number info
1579 // for the function.
1580 static DebugLoc getFnDebugLoc(DebugLoc DL, const LLVMContext &Ctx) {
1581 const MDNode *Scope = getScopeNode(DL, Ctx);
1582 DISubprogram SP = getDISubprogram(Scope);
1583 if (SP.isSubprogram()) {
1584 // Check for number of operands since the compatibility is
1586 if (SP->getNumOperands() > 19)
1587 return DebugLoc::get(SP.getScopeLineNumber(), 0, SP);
1589 return DebugLoc::get(SP.getLineNumber(), 0, SP);
1595 // Gather pre-function debug information. Assumes being called immediately
1596 // after the function entry point has been emitted.
1597 void DwarfDebug::beginFunction(const MachineFunction *MF) {
1598 if (!MMI->hasDebugInfo()) return;
1599 LScopes.initialize(*MF);
1600 if (LScopes.empty()) return;
1601 identifyScopeMarkers();
1603 // Set DwarfCompileUnitID in MCContext to the Compile Unit this function
1605 LexicalScope *FnScope = LScopes.getCurrentFunctionScope();
1606 CompileUnit *TheCU = SPMap.lookup(FnScope->getScopeNode());
1607 assert(TheCU && "Unable to find compile unit!");
1608 if (Asm->TM.hasMCUseLoc() && Asm->OutStreamer.hasRawTextSupport())
1609 // Use a single line table if we are using .loc and generating assembly.
1610 Asm->OutStreamer.getContext().setDwarfCompileUnitID(0);
1612 Asm->OutStreamer.getContext().setDwarfCompileUnitID(TheCU->getUniqueID());
1614 FunctionBeginSym = Asm->GetTempSymbol("func_begin",
1615 Asm->getFunctionNumber());
1616 // Assumes in correct section after the entry point.
1617 Asm->OutStreamer.EmitLabel(FunctionBeginSym);
1619 assert(UserVariables.empty() && DbgValues.empty() && "Maps weren't cleaned");
1621 const TargetRegisterInfo *TRI = Asm->TM.getRegisterInfo();
1622 // LiveUserVar - Map physreg numbers to the MDNode they contain.
1623 std::vector<const MDNode*> LiveUserVar(TRI->getNumRegs());
1625 for (MachineFunction::const_iterator I = MF->begin(), E = MF->end();
1627 bool AtBlockEntry = true;
1628 for (MachineBasicBlock::const_iterator II = I->begin(), IE = I->end();
1630 const MachineInstr *MI = II;
1632 if (MI->isDebugValue()) {
1633 assert(MI->getNumOperands() > 1 && "Invalid machine instruction!");
1635 // Keep track of user variables.
1637 MI->getOperand(MI->getNumOperands() - 1).getMetadata();
1639 // Variable is in a register, we need to check for clobbers.
1640 if (isDbgValueInDefinedReg(MI))
1641 LiveUserVar[MI->getOperand(0).getReg()] = Var;
1643 // Check the history of this variable.
1644 SmallVectorImpl<const MachineInstr*> &History = DbgValues[Var];
1645 if (History.empty()) {
1646 UserVariables.push_back(Var);
1647 // The first mention of a function argument gets the FunctionBeginSym
1648 // label, so arguments are visible when breaking at function entry.
1650 if (DV.isVariable() && DV.getTag() == dwarf::DW_TAG_arg_variable &&
1651 DISubprogram(getDISubprogram(DV.getContext()))
1652 .describes(MF->getFunction()))
1653 LabelsBeforeInsn[MI] = FunctionBeginSym;
1655 // We have seen this variable before. Try to coalesce DBG_VALUEs.
1656 const MachineInstr *Prev = History.back();
1657 if (Prev->isDebugValue()) {
1658 // Coalesce identical entries at the end of History.
1659 if (History.size() >= 2 &&
1660 Prev->isIdenticalTo(History[History.size() - 2])) {
1661 DEBUG(dbgs() << "Coalescing identical DBG_VALUE entries:\n"
1663 << "\t" << *History[History.size() - 2] << "\n");
1667 // Terminate old register assignments that don't reach MI;
1668 MachineFunction::const_iterator PrevMBB = Prev->getParent();
1669 if (PrevMBB != I && (!AtBlockEntry || llvm::next(PrevMBB) != I) &&
1670 isDbgValueInDefinedReg(Prev)) {
1671 // Previous register assignment needs to terminate at the end of
1673 MachineBasicBlock::const_iterator LastMI =
1674 PrevMBB->getLastNonDebugInstr();
1675 if (LastMI == PrevMBB->end()) {
1676 // Drop DBG_VALUE for empty range.
1677 DEBUG(dbgs() << "Dropping DBG_VALUE for empty range:\n"
1678 << "\t" << *Prev << "\n");
1680 } else if (llvm::next(PrevMBB) != PrevMBB->getParent()->end())
1681 // Terminate after LastMI.
1682 History.push_back(LastMI);
1686 History.push_back(MI);
1688 // Not a DBG_VALUE instruction.
1690 AtBlockEntry = false;
1692 // First known non-DBG_VALUE and non-frame setup location marks
1693 // the beginning of the function body.
1694 if (!MI->getFlag(MachineInstr::FrameSetup) &&
1695 (PrologEndLoc.isUnknown() && !MI->getDebugLoc().isUnknown()))
1696 PrologEndLoc = MI->getDebugLoc();
1698 // Check if the instruction clobbers any registers with debug vars.
1699 for (MachineInstr::const_mop_iterator MOI = MI->operands_begin(),
1700 MOE = MI->operands_end(); MOI != MOE; ++MOI) {
1701 if (!MOI->isReg() || !MOI->isDef() || !MOI->getReg())
1703 for (MCRegAliasIterator AI(MOI->getReg(), TRI, true);
1704 AI.isValid(); ++AI) {
1706 const MDNode *Var = LiveUserVar[Reg];
1709 // Reg is now clobbered.
1710 LiveUserVar[Reg] = 0;
1712 // Was MD last defined by a DBG_VALUE referring to Reg?
1713 DbgValueHistoryMap::iterator HistI = DbgValues.find(Var);
1714 if (HistI == DbgValues.end())
1716 SmallVectorImpl<const MachineInstr*> &History = HistI->second;
1717 if (History.empty())
1719 const MachineInstr *Prev = History.back();
1720 // Sanity-check: Register assignments are terminated at the end of
1722 if (!Prev->isDebugValue() || Prev->getParent() != MI->getParent())
1724 // Is the variable still in Reg?
1725 if (!isDbgValueInDefinedReg(Prev) ||
1726 Prev->getOperand(0).getReg() != Reg)
1728 // Var is clobbered. Make sure the next instruction gets a label.
1729 History.push_back(MI);
1736 for (DbgValueHistoryMap::iterator I = DbgValues.begin(), E = DbgValues.end();
1738 SmallVectorImpl<const MachineInstr*> &History = I->second;
1739 if (History.empty())
1742 // Make sure the final register assignments are terminated.
1743 const MachineInstr *Prev = History.back();
1744 if (Prev->isDebugValue() && isDbgValueInDefinedReg(Prev)) {
1745 const MachineBasicBlock *PrevMBB = Prev->getParent();
1746 MachineBasicBlock::const_iterator LastMI =
1747 PrevMBB->getLastNonDebugInstr();
1748 if (LastMI == PrevMBB->end())
1749 // Drop DBG_VALUE for empty range.
1751 else if (PrevMBB != &PrevMBB->getParent()->back()) {
1752 // Terminate after LastMI.
1753 History.push_back(LastMI);
1756 // Request labels for the full history.
1757 for (unsigned i = 0, e = History.size(); i != e; ++i) {
1758 const MachineInstr *MI = History[i];
1759 if (MI->isDebugValue())
1760 requestLabelBeforeInsn(MI);
1762 requestLabelAfterInsn(MI);
1766 PrevInstLoc = DebugLoc();
1767 PrevLabel = FunctionBeginSym;
1769 // Record beginning of function.
1770 if (!PrologEndLoc.isUnknown()) {
1771 DebugLoc FnStartDL = getFnDebugLoc(PrologEndLoc,
1772 MF->getFunction()->getContext());
1773 recordSourceLine(FnStartDL.getLine(), FnStartDL.getCol(),
1774 FnStartDL.getScope(MF->getFunction()->getContext()),
1775 // We'd like to list the prologue as "not statements" but GDB behaves
1776 // poorly if we do that. Revisit this with caution/GDB (7.5+) testing.
1777 DWARF2_FLAG_IS_STMT);
1781 void DwarfDebug::addScopeVariable(LexicalScope *LS, DbgVariable *Var) {
1782 SmallVectorImpl<DbgVariable *> &Vars = ScopeVariables[LS];
1783 DIVariable DV = Var->getVariable();
1784 // Variables with positive arg numbers are parameters.
1785 if (unsigned ArgNum = DV.getArgNumber()) {
1786 // Keep all parameters in order at the start of the variable list to ensure
1787 // function types are correct (no out-of-order parameters)
1789 // This could be improved by only doing it for optimized builds (unoptimized
1790 // builds have the right order to begin with), searching from the back (this
1791 // would catch the unoptimized case quickly), or doing a binary search
1792 // rather than linear search.
1793 SmallVectorImpl<DbgVariable *>::iterator I = Vars.begin();
1794 while (I != Vars.end()) {
1795 unsigned CurNum = (*I)->getVariable().getArgNumber();
1796 // A local (non-parameter) variable has been found, insert immediately
1800 // A later indexed parameter has been found, insert immediately before it.
1801 if (CurNum > ArgNum)
1805 Vars.insert(I, Var);
1809 Vars.push_back(Var);
1812 // Gather and emit post-function debug information.
1813 void DwarfDebug::endFunction(const MachineFunction *MF) {
1814 if (!MMI->hasDebugInfo() || LScopes.empty()) return;
1816 // Define end label for subprogram.
1817 FunctionEndSym = Asm->GetTempSymbol("func_end",
1818 Asm->getFunctionNumber());
1819 // Assumes in correct section after the entry point.
1820 Asm->OutStreamer.EmitLabel(FunctionEndSym);
1821 // Set DwarfCompileUnitID in MCContext to default value.
1822 Asm->OutStreamer.getContext().setDwarfCompileUnitID(0);
1824 SmallPtrSet<const MDNode *, 16> ProcessedVars;
1825 collectVariableInfo(MF, ProcessedVars);
1827 LexicalScope *FnScope = LScopes.getCurrentFunctionScope();
1828 CompileUnit *TheCU = SPMap.lookup(FnScope->getScopeNode());
1829 assert(TheCU && "Unable to find compile unit!");
1831 // Construct abstract scopes.
1832 ArrayRef<LexicalScope *> AList = LScopes.getAbstractScopesList();
1833 for (unsigned i = 0, e = AList.size(); i != e; ++i) {
1834 LexicalScope *AScope = AList[i];
1835 DISubprogram SP(AScope->getScopeNode());
1836 if (SP.isSubprogram()) {
1837 // Collect info for variables that were optimized out.
1838 DIArray Variables = SP.getVariables();
1839 for (unsigned i = 0, e = Variables.getNumElements(); i != e; ++i) {
1840 DIVariable DV(Variables.getElement(i));
1841 if (!DV || !DV.isVariable() || !ProcessedVars.insert(DV))
1843 // Check that DbgVariable for DV wasn't created earlier, when
1844 // findAbstractVariable() was called for inlined instance of DV.
1845 LLVMContext &Ctx = DV->getContext();
1846 DIVariable CleanDV = cleanseInlinedVariable(DV, Ctx);
1847 if (AbstractVariables.lookup(CleanDV))
1849 if (LexicalScope *Scope = LScopes.findAbstractScope(DV.getContext()))
1850 addScopeVariable(Scope, new DbgVariable(DV, NULL, this));
1853 if (ProcessedSPNodes.count(AScope->getScopeNode()) == 0)
1854 constructScopeDIE(TheCU, AScope);
1857 DIE *CurFnDIE = constructScopeDIE(TheCU, FnScope);
1859 if (!MF->getTarget().Options.DisableFramePointerElim(*MF))
1860 TheCU->addFlag(CurFnDIE, dwarf::DW_AT_APPLE_omit_frame_ptr);
1863 for (ScopeVariablesMap::iterator
1864 I = ScopeVariables.begin(), E = ScopeVariables.end(); I != E; ++I)
1865 DeleteContainerPointers(I->second);
1866 ScopeVariables.clear();
1867 DeleteContainerPointers(CurrentFnArguments);
1868 UserVariables.clear();
1870 AbstractVariables.clear();
1871 LabelsBeforeInsn.clear();
1872 LabelsAfterInsn.clear();
1876 // Register a source line with debug info. Returns the unique label that was
1877 // emitted and which provides correspondence to the source line list.
1878 void DwarfDebug::recordSourceLine(unsigned Line, unsigned Col, const MDNode *S,
1884 DIDescriptor Scope(S);
1886 if (Scope.isCompileUnit()) {
1887 DICompileUnit CU(S);
1888 Fn = CU.getFilename();
1889 Dir = CU.getDirectory();
1890 } else if (Scope.isFile()) {
1892 Fn = F.getFilename();
1893 Dir = F.getDirectory();
1894 } else if (Scope.isSubprogram()) {
1896 Fn = SP.getFilename();
1897 Dir = SP.getDirectory();
1898 } else if (Scope.isLexicalBlockFile()) {
1899 DILexicalBlockFile DBF(S);
1900 Fn = DBF.getFilename();
1901 Dir = DBF.getDirectory();
1902 } else if (Scope.isLexicalBlock()) {
1903 DILexicalBlock DB(S);
1904 Fn = DB.getFilename();
1905 Dir = DB.getDirectory();
1907 llvm_unreachable("Unexpected scope info");
1909 Src = getOrCreateSourceID(Fn, Dir,
1910 Asm->OutStreamer.getContext().getDwarfCompileUnitID());
1912 Asm->OutStreamer.EmitDwarfLocDirective(Src, Line, Col, Flags, 0, 0, Fn);
1915 //===----------------------------------------------------------------------===//
1917 //===----------------------------------------------------------------------===//
1919 // Compute the size and offset of a DIE. The offset is relative to start of the
1920 // CU. It returns the offset after laying out the DIE.
1922 DwarfUnits::computeSizeAndOffset(DIE *Die, unsigned Offset) {
1923 // Get the children.
1924 const std::vector<DIE *> &Children = Die->getChildren();
1926 // Record the abbreviation.
1927 assignAbbrevNumber(Die->getAbbrev());
1929 // Get the abbreviation for this DIE.
1930 unsigned AbbrevNumber = Die->getAbbrevNumber();
1931 const DIEAbbrev *Abbrev = Abbreviations[AbbrevNumber - 1];
1934 Die->setOffset(Offset);
1936 // Start the size with the size of abbreviation code.
1937 Offset += MCAsmInfo::getULEB128Size(AbbrevNumber);
1939 const SmallVectorImpl<DIEValue*> &Values = Die->getValues();
1940 const SmallVectorImpl<DIEAbbrevData> &AbbrevData = Abbrev->getData();
1942 // Size the DIE attribute values.
1943 for (unsigned i = 0, N = Values.size(); i < N; ++i)
1944 // Size attribute value.
1945 Offset += Values[i]->SizeOf(Asm, AbbrevData[i].getForm());
1947 // Size the DIE children if any.
1948 if (!Children.empty()) {
1949 assert(Abbrev->getChildrenFlag() == dwarf::DW_CHILDREN_yes &&
1950 "Children flag not set");
1952 for (unsigned j = 0, M = Children.size(); j < M; ++j)
1953 Offset = computeSizeAndOffset(Children[j], Offset);
1955 // End of children marker.
1956 Offset += sizeof(int8_t);
1959 Die->setSize(Offset - Die->getOffset());
1963 // Compute the size and offset for each DIE.
1964 void DwarfUnits::computeSizeAndOffsets() {
1965 // Offset from the first CU in the debug info section is 0 initially.
1966 unsigned SecOffset = 0;
1968 // Iterate over each compile unit and set the size and offsets for each
1969 // DIE within each compile unit. All offsets are CU relative.
1970 for (SmallVectorImpl<CompileUnit *>::iterator I = CUs.begin(),
1971 E = CUs.end(); I != E; ++I) {
1972 (*I)->setDebugInfoOffset(SecOffset);
1974 // CU-relative offset is reset to 0 here.
1975 unsigned Offset = sizeof(int32_t) + // Length of Unit Info
1976 (*I)->getHeaderSize(); // Unit-specific headers
1978 // EndOffset here is CU-relative, after laying out
1979 // all of the CU DIE.
1980 unsigned EndOffset = computeSizeAndOffset((*I)->getCUDie(), Offset);
1981 SecOffset += EndOffset;
1985 // Emit initial Dwarf sections with a label at the start of each one.
1986 void DwarfDebug::emitSectionLabels() {
1987 const TargetLoweringObjectFile &TLOF = Asm->getObjFileLowering();
1989 // Dwarf sections base addresses.
1990 DwarfInfoSectionSym =
1991 emitSectionSym(Asm, TLOF.getDwarfInfoSection(), "section_info");
1992 DwarfAbbrevSectionSym =
1993 emitSectionSym(Asm, TLOF.getDwarfAbbrevSection(), "section_abbrev");
1994 if (useSplitDwarf())
1995 DwarfAbbrevDWOSectionSym =
1996 emitSectionSym(Asm, TLOF.getDwarfAbbrevDWOSection(),
1997 "section_abbrev_dwo");
1998 emitSectionSym(Asm, TLOF.getDwarfARangesSection());
2000 if (const MCSection *MacroInfo = TLOF.getDwarfMacroInfoSection())
2001 emitSectionSym(Asm, MacroInfo);
2003 DwarfLineSectionSym =
2004 emitSectionSym(Asm, TLOF.getDwarfLineSection(), "section_line");
2005 emitSectionSym(Asm, TLOF.getDwarfLocSection());
2006 if (GenerateGnuPubSections) {
2007 DwarfGnuPubNamesSectionSym =
2008 emitSectionSym(Asm, TLOF.getDwarfGnuPubNamesSection());
2009 DwarfGnuPubTypesSectionSym =
2010 emitSectionSym(Asm, TLOF.getDwarfGnuPubTypesSection());
2011 } else if (HasDwarfPubSections) {
2012 emitSectionSym(Asm, TLOF.getDwarfPubNamesSection());
2013 emitSectionSym(Asm, TLOF.getDwarfPubTypesSection());
2016 DwarfStrSectionSym =
2017 emitSectionSym(Asm, TLOF.getDwarfStrSection(), "info_string");
2018 if (useSplitDwarf()) {
2019 DwarfStrDWOSectionSym =
2020 emitSectionSym(Asm, TLOF.getDwarfStrDWOSection(), "skel_string");
2021 DwarfAddrSectionSym =
2022 emitSectionSym(Asm, TLOF.getDwarfAddrSection(), "addr_sec");
2024 DwarfDebugRangeSectionSym = emitSectionSym(Asm, TLOF.getDwarfRangesSection(),
2027 DwarfDebugLocSectionSym = emitSectionSym(Asm, TLOF.getDwarfLocSection(),
2028 "section_debug_loc");
2030 TextSectionSym = emitSectionSym(Asm, TLOF.getTextSection(), "text_begin");
2031 emitSectionSym(Asm, TLOF.getDataSection());
2034 // Recursively emits a debug information entry.
2035 void DwarfDebug::emitDIE(DIE *Die, ArrayRef<DIEAbbrev *> Abbrevs) {
2036 // Get the abbreviation for this DIE.
2037 unsigned AbbrevNumber = Die->getAbbrevNumber();
2038 const DIEAbbrev *Abbrev = Abbrevs[AbbrevNumber - 1];
2040 // Emit the code (index) for the abbreviation.
2041 if (Asm->isVerbose())
2042 Asm->OutStreamer.AddComment("Abbrev [" + Twine(AbbrevNumber) + "] 0x" +
2043 Twine::utohexstr(Die->getOffset()) + ":0x" +
2044 Twine::utohexstr(Die->getSize()) + " " +
2045 dwarf::TagString(Abbrev->getTag()));
2046 Asm->EmitULEB128(AbbrevNumber);
2048 const SmallVectorImpl<DIEValue*> &Values = Die->getValues();
2049 const SmallVectorImpl<DIEAbbrevData> &AbbrevData = Abbrev->getData();
2051 // Emit the DIE attribute values.
2052 for (unsigned i = 0, N = Values.size(); i < N; ++i) {
2053 dwarf::Attribute Attr = AbbrevData[i].getAttribute();
2054 dwarf::Form Form = AbbrevData[i].getForm();
2055 assert(Form && "Too many attributes for DIE (check abbreviation)");
2057 if (Asm->isVerbose())
2058 Asm->OutStreamer.AddComment(dwarf::AttributeString(Attr));
2061 case dwarf::DW_AT_abstract_origin:
2062 case dwarf::DW_AT_type:
2063 case dwarf::DW_AT_friend:
2064 case dwarf::DW_AT_specification:
2065 case dwarf::DW_AT_import:
2066 case dwarf::DW_AT_containing_type: {
2067 DIEEntry *E = cast<DIEEntry>(Values[i]);
2068 DIE *Origin = E->getEntry();
2069 unsigned Addr = Origin->getOffset();
2070 if (Form == dwarf::DW_FORM_ref_addr) {
2071 assert(!useSplitDwarf() && "TODO: dwo files can't have relocations.");
2072 // For DW_FORM_ref_addr, output the offset from beginning of debug info
2073 // section. Origin->getOffset() returns the offset from start of the
2075 CompileUnit *CU = CUDieMap.lookup(Origin->getCompileUnit());
2076 assert(CU && "CUDie should belong to a CU.");
2077 Addr += CU->getDebugInfoOffset();
2078 if (Asm->MAI->doesDwarfUseRelocationsAcrossSections())
2079 Asm->EmitLabelPlusOffset(DwarfInfoSectionSym, Addr,
2080 DIEEntry::getRefAddrSize(Asm));
2082 Asm->EmitLabelOffsetDifference(DwarfInfoSectionSym, Addr,
2083 DwarfInfoSectionSym,
2084 DIEEntry::getRefAddrSize(Asm));
2086 // Make sure Origin belong to the same CU.
2087 assert(Die->getCompileUnit() == Origin->getCompileUnit() &&
2088 "The referenced DIE should belong to the same CU in ref4");
2089 Asm->EmitInt32(Addr);
2093 case dwarf::DW_AT_ranges: {
2094 // DW_AT_range Value encodes offset in debug_range section.
2095 DIEInteger *V = cast<DIEInteger>(Values[i]);
2097 if (Asm->MAI->doesDwarfUseRelocationsAcrossSections()) {
2098 Asm->EmitLabelPlusOffset(DwarfDebugRangeSectionSym,
2102 Asm->EmitLabelOffsetDifference(DwarfDebugRangeSectionSym,
2104 DwarfDebugRangeSectionSym,
2109 case dwarf::DW_AT_location: {
2110 if (DIELabel *L = dyn_cast<DIELabel>(Values[i])) {
2111 if (Asm->MAI->doesDwarfUseRelocationsAcrossSections())
2112 Asm->EmitLabelReference(L->getValue(), 4);
2114 Asm->EmitLabelDifference(L->getValue(), DwarfDebugLocSectionSym, 4);
2116 Values[i]->EmitValue(Asm, Form);
2120 case dwarf::DW_AT_accessibility: {
2121 if (Asm->isVerbose()) {
2122 DIEInteger *V = cast<DIEInteger>(Values[i]);
2123 Asm->OutStreamer.AddComment(dwarf::AccessibilityString(V->getValue()));
2125 Values[i]->EmitValue(Asm, Form);
2129 // Emit an attribute using the defined form.
2130 Values[i]->EmitValue(Asm, Form);
2135 // Emit the DIE children if any.
2136 if (Abbrev->getChildrenFlag() == dwarf::DW_CHILDREN_yes) {
2137 const std::vector<DIE *> &Children = Die->getChildren();
2139 for (unsigned j = 0, M = Children.size(); j < M; ++j)
2140 emitDIE(Children[j], Abbrevs);
2142 if (Asm->isVerbose())
2143 Asm->OutStreamer.AddComment("End Of Children Mark");
2148 // Emit the various dwarf units to the unit section USection with
2149 // the abbreviations going into ASection.
2150 void DwarfUnits::emitUnits(DwarfDebug *DD,
2151 const MCSection *USection,
2152 const MCSection *ASection,
2153 const MCSymbol *ASectionSym) {
2154 Asm->OutStreamer.SwitchSection(USection);
2155 for (SmallVectorImpl<CompileUnit *>::iterator I = CUs.begin(),
2156 E = CUs.end(); I != E; ++I) {
2157 CompileUnit *TheCU = *I;
2158 DIE *Die = TheCU->getCUDie();
2160 // Emit the compile units header.
2162 .EmitLabel(Asm->GetTempSymbol(USection->getLabelBeginName(),
2163 TheCU->getUniqueID()));
2165 // Emit size of content not including length itself
2166 Asm->OutStreamer.AddComment("Length of Unit");
2167 Asm->EmitInt32(TheCU->getHeaderSize() + Die->getSize());
2169 TheCU->emitHeader(ASection, ASectionSym);
2171 DD->emitDIE(Die, Abbreviations);
2172 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol(USection->getLabelEndName(),
2173 TheCU->getUniqueID()));
2177 // Emit the debug info section.
2178 void DwarfDebug::emitDebugInfo() {
2179 DwarfUnits &Holder = useSplitDwarf() ? SkeletonHolder : InfoHolder;
2181 Holder.emitUnits(this, Asm->getObjFileLowering().getDwarfInfoSection(),
2182 Asm->getObjFileLowering().getDwarfAbbrevSection(),
2183 DwarfAbbrevSectionSym);
2186 // Emit the abbreviation section.
2187 void DwarfDebug::emitAbbreviations() {
2188 if (!useSplitDwarf())
2189 emitAbbrevs(Asm->getObjFileLowering().getDwarfAbbrevSection(),
2192 emitSkeletonAbbrevs(Asm->getObjFileLowering().getDwarfAbbrevSection());
2195 void DwarfDebug::emitAbbrevs(const MCSection *Section,
2196 std::vector<DIEAbbrev *> *Abbrevs) {
2197 // Check to see if it is worth the effort.
2198 if (!Abbrevs->empty()) {
2199 // Start the debug abbrev section.
2200 Asm->OutStreamer.SwitchSection(Section);
2202 MCSymbol *Begin = Asm->GetTempSymbol(Section->getLabelBeginName());
2203 Asm->OutStreamer.EmitLabel(Begin);
2205 // For each abbrevation.
2206 for (unsigned i = 0, N = Abbrevs->size(); i < N; ++i) {
2207 // Get abbreviation data
2208 const DIEAbbrev *Abbrev = Abbrevs->at(i);
2210 // Emit the abbrevations code (base 1 index.)
2211 Asm->EmitULEB128(Abbrev->getNumber(), "Abbreviation Code");
2213 // Emit the abbreviations data.
2217 // Mark end of abbreviations.
2218 Asm->EmitULEB128(0, "EOM(3)");
2220 MCSymbol *End = Asm->GetTempSymbol(Section->getLabelEndName());
2221 Asm->OutStreamer.EmitLabel(End);
2225 // Emit the last address of the section and the end of the line matrix.
2226 void DwarfDebug::emitEndOfLineMatrix(unsigned SectionEnd) {
2227 // Define last address of section.
2228 Asm->OutStreamer.AddComment("Extended Op");
2231 Asm->OutStreamer.AddComment("Op size");
2232 Asm->EmitInt8(Asm->getDataLayout().getPointerSize() + 1);
2233 Asm->OutStreamer.AddComment("DW_LNE_set_address");
2234 Asm->EmitInt8(dwarf::DW_LNE_set_address);
2236 Asm->OutStreamer.AddComment("Section end label");
2238 Asm->OutStreamer.EmitSymbolValue(Asm->GetTempSymbol("section_end",SectionEnd),
2239 Asm->getDataLayout().getPointerSize());
2241 // Mark end of matrix.
2242 Asm->OutStreamer.AddComment("DW_LNE_end_sequence");
2248 // Emit visible names into a hashed accelerator table section.
2249 void DwarfDebug::emitAccelNames() {
2250 DwarfAccelTable AT(DwarfAccelTable::Atom(dwarf::DW_ATOM_die_offset,
2251 dwarf::DW_FORM_data4));
2252 for (DenseMap<const MDNode *, CompileUnit *>::iterator I = CUMap.begin(),
2253 E = CUMap.end(); I != E; ++I) {
2254 CompileUnit *TheCU = I->second;
2255 const StringMap<std::vector<DIE*> > &Names = TheCU->getAccelNames();
2256 for (StringMap<std::vector<DIE*> >::const_iterator
2257 GI = Names.begin(), GE = Names.end(); GI != GE; ++GI) {
2258 StringRef Name = GI->getKey();
2259 const std::vector<DIE *> &Entities = GI->second;
2260 for (std::vector<DIE *>::const_iterator DI = Entities.begin(),
2261 DE = Entities.end(); DI != DE; ++DI)
2262 AT.AddName(Name, (*DI));
2266 AT.FinalizeTable(Asm, "Names");
2267 Asm->OutStreamer.SwitchSection(
2268 Asm->getObjFileLowering().getDwarfAccelNamesSection());
2269 MCSymbol *SectionBegin = Asm->GetTempSymbol("names_begin");
2270 Asm->OutStreamer.EmitLabel(SectionBegin);
2272 // Emit the full data.
2273 AT.Emit(Asm, SectionBegin, &InfoHolder);
2276 // Emit objective C classes and categories into a hashed accelerator table
2278 void DwarfDebug::emitAccelObjC() {
2279 DwarfAccelTable AT(DwarfAccelTable::Atom(dwarf::DW_ATOM_die_offset,
2280 dwarf::DW_FORM_data4));
2281 for (DenseMap<const MDNode *, CompileUnit *>::iterator I = CUMap.begin(),
2282 E = CUMap.end(); I != E; ++I) {
2283 CompileUnit *TheCU = I->second;
2284 const StringMap<std::vector<DIE*> > &Names = TheCU->getAccelObjC();
2285 for (StringMap<std::vector<DIE*> >::const_iterator
2286 GI = Names.begin(), GE = Names.end(); GI != GE; ++GI) {
2287 StringRef Name = GI->getKey();
2288 const std::vector<DIE *> &Entities = GI->second;
2289 for (std::vector<DIE *>::const_iterator DI = Entities.begin(),
2290 DE = Entities.end(); DI != DE; ++DI)
2291 AT.AddName(Name, (*DI));
2295 AT.FinalizeTable(Asm, "ObjC");
2296 Asm->OutStreamer.SwitchSection(Asm->getObjFileLowering()
2297 .getDwarfAccelObjCSection());
2298 MCSymbol *SectionBegin = Asm->GetTempSymbol("objc_begin");
2299 Asm->OutStreamer.EmitLabel(SectionBegin);
2301 // Emit the full data.
2302 AT.Emit(Asm, SectionBegin, &InfoHolder);
2305 // Emit namespace dies into a hashed accelerator table.
2306 void DwarfDebug::emitAccelNamespaces() {
2307 DwarfAccelTable AT(DwarfAccelTable::Atom(dwarf::DW_ATOM_die_offset,
2308 dwarf::DW_FORM_data4));
2309 for (DenseMap<const MDNode *, CompileUnit *>::iterator I = CUMap.begin(),
2310 E = CUMap.end(); I != E; ++I) {
2311 CompileUnit *TheCU = I->second;
2312 const StringMap<std::vector<DIE*> > &Names = TheCU->getAccelNamespace();
2313 for (StringMap<std::vector<DIE*> >::const_iterator
2314 GI = Names.begin(), GE = Names.end(); GI != GE; ++GI) {
2315 StringRef Name = GI->getKey();
2316 const std::vector<DIE *> &Entities = GI->second;
2317 for (std::vector<DIE *>::const_iterator DI = Entities.begin(),
2318 DE = Entities.end(); DI != DE; ++DI)
2319 AT.AddName(Name, (*DI));
2323 AT.FinalizeTable(Asm, "namespac");
2324 Asm->OutStreamer.SwitchSection(Asm->getObjFileLowering()
2325 .getDwarfAccelNamespaceSection());
2326 MCSymbol *SectionBegin = Asm->GetTempSymbol("namespac_begin");
2327 Asm->OutStreamer.EmitLabel(SectionBegin);
2329 // Emit the full data.
2330 AT.Emit(Asm, SectionBegin, &InfoHolder);
2333 // Emit type dies into a hashed accelerator table.
2334 void DwarfDebug::emitAccelTypes() {
2335 std::vector<DwarfAccelTable::Atom> Atoms;
2336 Atoms.push_back(DwarfAccelTable::Atom(dwarf::DW_ATOM_die_offset,
2337 dwarf::DW_FORM_data4));
2338 Atoms.push_back(DwarfAccelTable::Atom(dwarf::DW_ATOM_die_tag,
2339 dwarf::DW_FORM_data2));
2340 Atoms.push_back(DwarfAccelTable::Atom(dwarf::DW_ATOM_type_flags,
2341 dwarf::DW_FORM_data1));
2342 DwarfAccelTable AT(Atoms);
2343 for (DenseMap<const MDNode *, CompileUnit *>::iterator I = CUMap.begin(),
2344 E = CUMap.end(); I != E; ++I) {
2345 CompileUnit *TheCU = I->second;
2346 const StringMap<std::vector<std::pair<DIE*, unsigned > > > &Names
2347 = TheCU->getAccelTypes();
2348 for (StringMap<std::vector<std::pair<DIE*, unsigned> > >::const_iterator
2349 GI = Names.begin(), GE = Names.end(); GI != GE; ++GI) {
2350 StringRef Name = GI->getKey();
2351 const std::vector<std::pair<DIE *, unsigned> > &Entities = GI->second;
2352 for (std::vector<std::pair<DIE *, unsigned> >::const_iterator DI
2353 = Entities.begin(), DE = Entities.end(); DI !=DE; ++DI)
2354 AT.AddName(Name, (*DI).first, (*DI).second);
2358 AT.FinalizeTable(Asm, "types");
2359 Asm->OutStreamer.SwitchSection(Asm->getObjFileLowering()
2360 .getDwarfAccelTypesSection());
2361 MCSymbol *SectionBegin = Asm->GetTempSymbol("types_begin");
2362 Asm->OutStreamer.EmitLabel(SectionBegin);
2364 // Emit the full data.
2365 AT.Emit(Asm, SectionBegin, &InfoHolder);
2368 // Public name handling.
2369 // The format for the various pubnames:
2371 // dwarf pubnames - offset/name pairs where the offset is the offset into the CU
2372 // for the DIE that is named.
2374 // gnu pubnames - offset/index value/name tuples where the offset is the offset
2375 // into the CU and the index value is computed according to the type of value
2376 // for the DIE that is named.
2378 // For type units the offset is the offset of the skeleton DIE. For split dwarf
2379 // it's the offset within the debug_info/debug_types dwo section, however, the
2380 // reference in the pubname header doesn't change.
2382 /// computeIndexValue - Compute the gdb index value for the DIE and CU.
2383 static dwarf::PubIndexEntryDescriptor computeIndexValue(CompileUnit *CU,
2385 dwarf::GDBIndexEntryLinkage Linkage = dwarf::GIEL_STATIC;
2387 // We could have a specification DIE that has our most of our knowledge,
2388 // look for that now.
2389 DIEValue *SpecVal = Die->findAttribute(dwarf::DW_AT_specification);
2391 DIE *SpecDIE = cast<DIEEntry>(SpecVal)->getEntry();
2392 if (SpecDIE->findAttribute(dwarf::DW_AT_external))
2393 Linkage = dwarf::GIEL_EXTERNAL;
2394 } else if (Die->findAttribute(dwarf::DW_AT_external))
2395 Linkage = dwarf::GIEL_EXTERNAL;
2397 switch (Die->getTag()) {
2398 case dwarf::DW_TAG_class_type:
2399 case dwarf::DW_TAG_structure_type:
2400 case dwarf::DW_TAG_union_type:
2401 case dwarf::DW_TAG_enumeration_type:
2402 return dwarf::PubIndexEntryDescriptor(
2403 dwarf::GIEK_TYPE, CU->getLanguage() != dwarf::DW_LANG_C_plus_plus
2404 ? dwarf::GIEL_STATIC
2405 : dwarf::GIEL_EXTERNAL);
2406 case dwarf::DW_TAG_typedef:
2407 case dwarf::DW_TAG_base_type:
2408 case dwarf::DW_TAG_subrange_type:
2409 return dwarf::PubIndexEntryDescriptor(dwarf::GIEK_TYPE, dwarf::GIEL_STATIC);
2410 case dwarf::DW_TAG_namespace:
2411 return dwarf::GIEK_TYPE;
2412 case dwarf::DW_TAG_subprogram:
2413 return dwarf::PubIndexEntryDescriptor(dwarf::GIEK_FUNCTION, Linkage);
2414 case dwarf::DW_TAG_constant:
2415 case dwarf::DW_TAG_variable:
2416 return dwarf::PubIndexEntryDescriptor(dwarf::GIEK_VARIABLE, Linkage);
2417 case dwarf::DW_TAG_enumerator:
2418 return dwarf::PubIndexEntryDescriptor(dwarf::GIEK_VARIABLE,
2419 dwarf::GIEL_STATIC);
2421 return dwarf::GIEK_NONE;
2425 /// emitDebugPubNames - Emit visible names into a debug pubnames section.
2427 void DwarfDebug::emitDebugPubNames(bool GnuStyle) {
2428 const MCSection *ISec = Asm->getObjFileLowering().getDwarfInfoSection();
2429 const MCSection *PSec =
2430 GnuStyle ? Asm->getObjFileLowering().getDwarfGnuPubNamesSection()
2431 : Asm->getObjFileLowering().getDwarfPubNamesSection();
2433 typedef DenseMap<const MDNode*, CompileUnit*> CUMapType;
2434 for (CUMapType::iterator I = CUMap.begin(), E = CUMap.end(); I != E; ++I) {
2435 CompileUnit *TheCU = I->second;
2436 unsigned ID = TheCU->getUniqueID();
2438 // Start the dwarf pubnames section.
2439 Asm->OutStreamer.SwitchSection(PSec);
2441 // Emit a label so we can reference the beginning of this pubname section.
2443 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("gnu_pubnames",
2444 TheCU->getUniqueID()));
2447 Asm->OutStreamer.AddComment("Length of Public Names Info");
2448 Asm->EmitLabelDifference(Asm->GetTempSymbol("pubnames_end", ID),
2449 Asm->GetTempSymbol("pubnames_begin", ID), 4);
2451 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("pubnames_begin", ID));
2453 Asm->OutStreamer.AddComment("DWARF Version");
2454 Asm->EmitInt16(dwarf::DW_PUBNAMES_VERSION);
2456 Asm->OutStreamer.AddComment("Offset of Compilation Unit Info");
2457 Asm->EmitSectionOffset(Asm->GetTempSymbol(ISec->getLabelBeginName(), ID),
2458 DwarfInfoSectionSym);
2460 Asm->OutStreamer.AddComment("Compilation Unit Length");
2461 Asm->EmitLabelDifference(Asm->GetTempSymbol(ISec->getLabelEndName(), ID),
2462 Asm->GetTempSymbol(ISec->getLabelBeginName(), ID),
2465 // Emit the pubnames for this compilation unit.
2466 const StringMap<DIE*> &Globals = TheCU->getGlobalNames();
2467 for (StringMap<DIE*>::const_iterator
2468 GI = Globals.begin(), GE = Globals.end(); GI != GE; ++GI) {
2469 const char *Name = GI->getKeyData();
2470 DIE *Entity = GI->second;
2472 Asm->OutStreamer.AddComment("DIE offset");
2473 Asm->EmitInt32(Entity->getOffset());
2476 dwarf::PubIndexEntryDescriptor Desc = computeIndexValue(TheCU, Entity);
2477 Asm->OutStreamer.AddComment(
2478 Twine("Kind: ") + dwarf::GDBIndexEntryKindString(Desc.Kind) + ", " +
2479 dwarf::GDBIndexEntryLinkageString(Desc.Linkage));
2480 Asm->EmitInt8(Desc.toBits());
2483 if (Asm->isVerbose())
2484 Asm->OutStreamer.AddComment("External Name");
2485 Asm->OutStreamer.EmitBytes(StringRef(Name, GI->getKeyLength()+1));
2488 Asm->OutStreamer.AddComment("End Mark");
2490 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("pubnames_end", ID));
2494 void DwarfDebug::emitDebugPubTypes(bool GnuStyle) {
2495 const MCSection *ISec = Asm->getObjFileLowering().getDwarfInfoSection();
2496 const MCSection *PSec =
2497 GnuStyle ? Asm->getObjFileLowering().getDwarfGnuPubTypesSection()
2498 : Asm->getObjFileLowering().getDwarfPubTypesSection();
2500 for (DenseMap<const MDNode *, CompileUnit *>::iterator I = CUMap.begin(),
2503 CompileUnit *TheCU = I->second;
2504 // Start the dwarf pubtypes section.
2505 Asm->OutStreamer.SwitchSection(PSec);
2507 // Emit a label so we can reference the beginning of this pubtype section.
2509 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("gnu_pubtypes",
2510 TheCU->getUniqueID()));
2513 Asm->OutStreamer.AddComment("Length of Public Types Info");
2514 Asm->EmitLabelDifference(
2515 Asm->GetTempSymbol("pubtypes_end", TheCU->getUniqueID()),
2516 Asm->GetTempSymbol("pubtypes_begin", TheCU->getUniqueID()), 4);
2518 Asm->OutStreamer.EmitLabel(
2519 Asm->GetTempSymbol("pubtypes_begin", TheCU->getUniqueID()));
2521 if (Asm->isVerbose())
2522 Asm->OutStreamer.AddComment("DWARF Version");
2523 Asm->EmitInt16(dwarf::DW_PUBTYPES_VERSION);
2525 Asm->OutStreamer.AddComment("Offset of Compilation Unit Info");
2526 Asm->EmitSectionOffset(
2527 Asm->GetTempSymbol(ISec->getLabelBeginName(), TheCU->getUniqueID()),
2528 DwarfInfoSectionSym);
2530 Asm->OutStreamer.AddComment("Compilation Unit Length");
2531 Asm->EmitLabelDifference(
2532 Asm->GetTempSymbol(ISec->getLabelEndName(), TheCU->getUniqueID()),
2533 Asm->GetTempSymbol(ISec->getLabelBeginName(), TheCU->getUniqueID()), 4);
2535 // Emit the pubtypes.
2536 const StringMap<DIE *> &Globals = TheCU->getGlobalTypes();
2537 for (StringMap<DIE *>::const_iterator GI = Globals.begin(),
2540 const char *Name = GI->getKeyData();
2541 DIE *Entity = GI->second;
2543 if (Asm->isVerbose())
2544 Asm->OutStreamer.AddComment("DIE offset");
2545 Asm->EmitInt32(Entity->getOffset());
2548 dwarf::PubIndexEntryDescriptor Desc = computeIndexValue(TheCU, Entity);
2549 Asm->OutStreamer.AddComment(
2550 Twine("Kind: ") + dwarf::GDBIndexEntryKindString(Desc.Kind) + ", " +
2551 dwarf::GDBIndexEntryLinkageString(Desc.Linkage));
2552 Asm->EmitInt8(Desc.toBits());
2555 if (Asm->isVerbose())
2556 Asm->OutStreamer.AddComment("External Name");
2558 // Emit the name with a terminating null byte.
2559 Asm->OutStreamer.EmitBytes(StringRef(Name, GI->getKeyLength() + 1));
2562 Asm->OutStreamer.AddComment("End Mark");
2564 Asm->OutStreamer.EmitLabel(
2565 Asm->GetTempSymbol("pubtypes_end", TheCU->getUniqueID()));
2569 // Emit strings into a string section.
2570 void DwarfUnits::emitStrings(const MCSection *StrSection,
2571 const MCSection *OffsetSection = NULL,
2572 const MCSymbol *StrSecSym = NULL) {
2574 if (StringPool.empty()) return;
2576 // Start the dwarf str section.
2577 Asm->OutStreamer.SwitchSection(StrSection);
2579 // Get all of the string pool entries and put them in an array by their ID so
2580 // we can sort them.
2581 SmallVector<std::pair<unsigned,
2582 StringMapEntry<std::pair<MCSymbol*, unsigned> >*>, 64> Entries;
2584 for (StringMap<std::pair<MCSymbol*, unsigned> >::iterator
2585 I = StringPool.begin(), E = StringPool.end();
2587 Entries.push_back(std::make_pair(I->second.second, &*I));
2589 array_pod_sort(Entries.begin(), Entries.end());
2591 for (unsigned i = 0, e = Entries.size(); i != e; ++i) {
2592 // Emit a label for reference from debug information entries.
2593 Asm->OutStreamer.EmitLabel(Entries[i].second->getValue().first);
2595 // Emit the string itself with a terminating null byte.
2596 Asm->OutStreamer.EmitBytes(StringRef(Entries[i].second->getKeyData(),
2597 Entries[i].second->getKeyLength()+1));
2600 // If we've got an offset section go ahead and emit that now as well.
2601 if (OffsetSection) {
2602 Asm->OutStreamer.SwitchSection(OffsetSection);
2603 unsigned offset = 0;
2604 unsigned size = 4; // FIXME: DWARF64 is 8.
2605 for (unsigned i = 0, e = Entries.size(); i != e; ++i) {
2606 Asm->OutStreamer.EmitIntValue(offset, size);
2607 offset += Entries[i].second->getKeyLength() + 1;
2612 // Emit strings into a string section.
2613 void DwarfUnits::emitAddresses(const MCSection *AddrSection) {
2615 if (AddressPool.empty()) return;
2617 // Start the dwarf addr section.
2618 Asm->OutStreamer.SwitchSection(AddrSection);
2620 // Order the address pool entries by ID
2621 SmallVector<const MCExpr *, 64> Entries(AddressPool.size());
2623 for (DenseMap<const MCExpr *, unsigned>::iterator I = AddressPool.begin(),
2624 E = AddressPool.end();
2626 Entries[I->second] = I->first;
2628 for (unsigned i = 0, e = Entries.size(); i != e; ++i) {
2629 // Emit an expression for reference from debug information entries.
2630 if (const MCExpr *Expr = Entries[i])
2631 Asm->OutStreamer.EmitValue(Expr, Asm->getDataLayout().getPointerSize());
2633 Asm->OutStreamer.EmitIntValue(0, Asm->getDataLayout().getPointerSize());
2638 // Emit visible names into a debug str section.
2639 void DwarfDebug::emitDebugStr() {
2640 DwarfUnits &Holder = useSplitDwarf() ? SkeletonHolder : InfoHolder;
2641 Holder.emitStrings(Asm->getObjFileLowering().getDwarfStrSection());
2644 // Emit locations into the debug loc section.
2645 void DwarfDebug::emitDebugLoc() {
2646 if (DotDebugLocEntries.empty())
2649 for (SmallVectorImpl<DotDebugLocEntry>::iterator
2650 I = DotDebugLocEntries.begin(), E = DotDebugLocEntries.end();
2652 DotDebugLocEntry &Entry = *I;
2653 if (I + 1 != DotDebugLocEntries.end())
2657 // Start the dwarf loc section.
2658 Asm->OutStreamer.SwitchSection(
2659 Asm->getObjFileLowering().getDwarfLocSection());
2660 unsigned char Size = Asm->getDataLayout().getPointerSize();
2661 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("debug_loc", 0));
2663 for (SmallVectorImpl<DotDebugLocEntry>::iterator
2664 I = DotDebugLocEntries.begin(), E = DotDebugLocEntries.end();
2665 I != E; ++I, ++index) {
2666 DotDebugLocEntry &Entry = *I;
2667 if (Entry.isMerged()) continue;
2668 if (Entry.isEmpty()) {
2669 Asm->OutStreamer.EmitIntValue(0, Size);
2670 Asm->OutStreamer.EmitIntValue(0, Size);
2671 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("debug_loc", index));
2673 Asm->OutStreamer.EmitSymbolValue(Entry.getBeginSym(), Size);
2674 Asm->OutStreamer.EmitSymbolValue(Entry.getEndSym(), Size);
2675 DIVariable DV(Entry.getVariable());
2676 Asm->OutStreamer.AddComment("Loc expr size");
2677 MCSymbol *begin = Asm->OutStreamer.getContext().CreateTempSymbol();
2678 MCSymbol *end = Asm->OutStreamer.getContext().CreateTempSymbol();
2679 Asm->EmitLabelDifference(end, begin, 2);
2680 Asm->OutStreamer.EmitLabel(begin);
2681 if (Entry.isInt()) {
2682 DIBasicType BTy(DV.getType());
2684 (BTy.getEncoding() == dwarf::DW_ATE_signed
2685 || BTy.getEncoding() == dwarf::DW_ATE_signed_char)) {
2686 Asm->OutStreamer.AddComment("DW_OP_consts");
2687 Asm->EmitInt8(dwarf::DW_OP_consts);
2688 Asm->EmitSLEB128(Entry.getInt());
2690 Asm->OutStreamer.AddComment("DW_OP_constu");
2691 Asm->EmitInt8(dwarf::DW_OP_constu);
2692 Asm->EmitULEB128(Entry.getInt());
2694 } else if (Entry.isLocation()) {
2695 MachineLocation Loc = Entry.getLoc();
2696 if (!DV.hasComplexAddress())
2698 Asm->EmitDwarfRegOp(Loc, DV.isIndirect());
2700 // Complex address entry.
2701 unsigned N = DV.getNumAddrElements();
2703 if (N >= 2 && DV.getAddrElement(0) == DIBuilder::OpPlus) {
2704 if (Loc.getOffset()) {
2706 Asm->EmitDwarfRegOp(Loc, DV.isIndirect());
2707 Asm->OutStreamer.AddComment("DW_OP_deref");
2708 Asm->EmitInt8(dwarf::DW_OP_deref);
2709 Asm->OutStreamer.AddComment("DW_OP_plus_uconst");
2710 Asm->EmitInt8(dwarf::DW_OP_plus_uconst);
2711 Asm->EmitSLEB128(DV.getAddrElement(1));
2713 // If first address element is OpPlus then emit
2714 // DW_OP_breg + Offset instead of DW_OP_reg + Offset.
2715 MachineLocation TLoc(Loc.getReg(), DV.getAddrElement(1));
2716 Asm->EmitDwarfRegOp(TLoc, DV.isIndirect());
2720 Asm->EmitDwarfRegOp(Loc, DV.isIndirect());
2723 // Emit remaining complex address elements.
2724 for (; i < N; ++i) {
2725 uint64_t Element = DV.getAddrElement(i);
2726 if (Element == DIBuilder::OpPlus) {
2727 Asm->EmitInt8(dwarf::DW_OP_plus_uconst);
2728 Asm->EmitULEB128(DV.getAddrElement(++i));
2729 } else if (Element == DIBuilder::OpDeref) {
2731 Asm->EmitInt8(dwarf::DW_OP_deref);
2733 llvm_unreachable("unknown Opcode found in complex address");
2737 // else ... ignore constant fp. There is not any good way to
2738 // to represent them here in dwarf.
2739 Asm->OutStreamer.EmitLabel(end);
2744 struct SymbolCUSorter {
2745 SymbolCUSorter(const MCStreamer &s) : Streamer(s) {}
2746 const MCStreamer &Streamer;
2748 bool operator() (const SymbolCU &A, const SymbolCU &B) {
2749 unsigned IA = A.Sym ? Streamer.GetSymbolOrder(A.Sym) : 0;
2750 unsigned IB = B.Sym ? Streamer.GetSymbolOrder(B.Sym) : 0;
2752 // Symbols with no order assigned should be placed at the end.
2753 // (e.g. section end labels)
2755 IA = (unsigned)(-1);
2757 IB = (unsigned)(-1);
2762 static bool CUSort(const CompileUnit *A, const CompileUnit *B) {
2763 return (A->getUniqueID() < B->getUniqueID());
2767 const MCSymbol *Start, *End;
2770 // Emit a debug aranges section, containing a CU lookup for any
2771 // address we can tie back to a CU.
2772 void DwarfDebug::emitDebugARanges() {
2773 // Start the dwarf aranges section.
2775 .SwitchSection(Asm->getObjFileLowering().getDwarfARangesSection());
2777 typedef DenseMap<CompileUnit *, std::vector<ArangeSpan> > SpansType;
2781 // Build a list of sections used.
2782 std::vector<const MCSection *> Sections;
2783 for (SectionMapType::iterator it = SectionMap.begin(); it != SectionMap.end();
2785 const MCSection *Section = it->first;
2786 Sections.push_back(Section);
2789 // Sort the sections into order.
2790 // This is only done to ensure consistent output order across different runs.
2791 std::sort(Sections.begin(), Sections.end(), SectionSort);
2793 // Build a set of address spans, sorted by CU.
2794 for (size_t SecIdx=0;SecIdx<Sections.size();SecIdx++) {
2795 const MCSection *Section = Sections[SecIdx];
2796 SmallVector<SymbolCU, 8> &List = SectionMap[Section];
2797 if (List.size() < 2)
2800 // Sort the symbols by offset within the section.
2801 SymbolCUSorter sorter(Asm->OutStreamer);
2802 std::sort(List.begin(), List.end(), sorter);
2804 // If we have no section (e.g. common), just write out
2805 // individual spans for each symbol.
2806 if (Section == NULL) {
2807 for (size_t n = 0; n < List.size(); n++) {
2808 const SymbolCU &Cur = List[n];
2811 Span.Start = Cur.Sym;
2814 Spans[Cur.CU].push_back(Span);
2817 // Build spans between each label.
2818 const MCSymbol *StartSym = List[0].Sym;
2819 for (size_t n = 1; n < List.size(); n++) {
2820 const SymbolCU &Prev = List[n - 1];
2821 const SymbolCU &Cur = List[n];
2823 // Try and build the longest span we can within the same CU.
2824 if (Cur.CU != Prev.CU) {
2826 Span.Start = StartSym;
2828 Spans[Prev.CU].push_back(Span);
2835 const MCSection *ISec = Asm->getObjFileLowering().getDwarfInfoSection();
2836 unsigned PtrSize = Asm->getDataLayout().getPointerSize();
2838 // Build a list of CUs used.
2839 std::vector<CompileUnit *> CUs;
2840 for (SpansType::iterator it = Spans.begin(); it != Spans.end(); it++) {
2841 CompileUnit *CU = it->first;
2845 // Sort the CU list (again, to ensure consistent output order).
2846 std::sort(CUs.begin(), CUs.end(), CUSort);
2848 // Emit an arange table for each CU we used.
2849 for (size_t CUIdx=0;CUIdx<CUs.size();CUIdx++) {
2850 CompileUnit *CU = CUs[CUIdx];
2851 std::vector<ArangeSpan> &List = Spans[CU];
2853 // Emit size of content not including length itself.
2854 unsigned ContentSize
2855 = sizeof(int16_t) // DWARF ARange version number
2856 + sizeof(int32_t) // Offset of CU in the .debug_info section
2857 + sizeof(int8_t) // Pointer Size (in bytes)
2858 + sizeof(int8_t); // Segment Size (in bytes)
2860 unsigned TupleSize = PtrSize * 2;
2862 // 7.20 in the Dwarf specs requires the table to be aligned to a tuple.
2863 unsigned Padding = 0;
2864 while (((sizeof(int32_t) + ContentSize + Padding) % TupleSize) != 0)
2867 ContentSize += Padding;
2868 ContentSize += (List.size() + 1) * TupleSize;
2870 // For each compile unit, write the list of spans it covers.
2871 Asm->OutStreamer.AddComment("Length of ARange Set");
2872 Asm->EmitInt32(ContentSize);
2873 Asm->OutStreamer.AddComment("DWARF Arange version number");
2874 Asm->EmitInt16(dwarf::DW_ARANGES_VERSION);
2875 Asm->OutStreamer.AddComment("Offset Into Debug Info Section");
2876 Asm->EmitSectionOffset(
2877 Asm->GetTempSymbol(ISec->getLabelBeginName(), CU->getUniqueID()),
2878 DwarfInfoSectionSym);
2879 Asm->OutStreamer.AddComment("Address Size (in bytes)");
2880 Asm->EmitInt8(PtrSize);
2881 Asm->OutStreamer.AddComment("Segment Size (in bytes)");
2884 for (unsigned n = 0; n < Padding; n++)
2885 Asm->EmitInt8(0xff);
2887 for (unsigned n = 0; n < List.size(); n++) {
2888 const ArangeSpan &Span = List[n];
2889 Asm->EmitLabelReference(Span.Start, PtrSize);
2891 // Calculate the size as being from the span start to it's end.
2893 Asm->EmitLabelDifference(Span.End, Span.Start, PtrSize);
2895 // For symbols without an end marker (e.g. common), we
2896 // write a single arange entry containing just that one symbol.
2897 uint64_t Size = SymSize[Span.Start];
2901 Asm->OutStreamer.EmitIntValue(Size, PtrSize);
2905 Asm->OutStreamer.AddComment("ARange terminator");
2906 Asm->OutStreamer.EmitIntValue(0, PtrSize);
2907 Asm->OutStreamer.EmitIntValue(0, PtrSize);
2911 // Emit visible names into a debug ranges section.
2912 void DwarfDebug::emitDebugRanges() {
2913 // Start the dwarf ranges section.
2915 .SwitchSection(Asm->getObjFileLowering().getDwarfRangesSection());
2916 unsigned char Size = Asm->getDataLayout().getPointerSize();
2917 for (SmallVectorImpl<const MCSymbol *>::iterator
2918 I = DebugRangeSymbols.begin(), E = DebugRangeSymbols.end();
2921 Asm->OutStreamer.EmitSymbolValue(const_cast<MCSymbol*>(*I), Size);
2923 Asm->OutStreamer.EmitIntValue(0, Size);
2927 // Emit visible names into a debug macinfo section.
2928 void DwarfDebug::emitDebugMacInfo() {
2929 if (const MCSection *LineInfo =
2930 Asm->getObjFileLowering().getDwarfMacroInfoSection()) {
2931 // Start the dwarf macinfo section.
2932 Asm->OutStreamer.SwitchSection(LineInfo);
2936 // DWARF5 Experimental Separate Dwarf emitters.
2938 // This DIE has the following attributes: DW_AT_comp_dir, DW_AT_stmt_list,
2939 // DW_AT_low_pc, DW_AT_high_pc, DW_AT_ranges, DW_AT_dwo_name, DW_AT_dwo_id,
2940 // DW_AT_ranges_base, DW_AT_addr_base.
2941 CompileUnit *DwarfDebug::constructSkeletonCU(const CompileUnit *CU) {
2943 DIE *Die = new DIE(dwarf::DW_TAG_compile_unit);
2944 CompileUnit *NewCU = new CompileUnit(CU->getUniqueID(), Die, CU->getNode(),
2945 Asm, this, &SkeletonHolder);
2947 NewCU->addLocalString(Die, dwarf::DW_AT_GNU_dwo_name,
2948 DICompileUnit(CU->getNode()).getSplitDebugFilename());
2950 // Relocate to the beginning of the addr_base section, else 0 for the
2951 // beginning of the one for this compile unit.
2952 if (Asm->MAI->doesDwarfUseRelocationsAcrossSections())
2953 NewCU->addLabel(Die, dwarf::DW_AT_GNU_addr_base, dwarf::DW_FORM_sec_offset,
2954 DwarfAddrSectionSym);
2956 NewCU->addUInt(Die, dwarf::DW_AT_GNU_addr_base,
2957 dwarf::DW_FORM_sec_offset, 0);
2959 // 2.17.1 requires that we use DW_AT_low_pc for a single entry point
2960 // into an entity. We're using 0, or a NULL label for this.
2961 NewCU->addUInt(Die, dwarf::DW_AT_low_pc, dwarf::DW_FORM_addr, 0);
2963 // DW_AT_stmt_list is a offset of line number information for this
2964 // compile unit in debug_line section.
2965 // FIXME: Should handle multiple compile units.
2966 if (Asm->MAI->doesDwarfUseRelocationsAcrossSections())
2967 NewCU->addLabel(Die, dwarf::DW_AT_stmt_list, dwarf::DW_FORM_sec_offset,
2968 DwarfLineSectionSym);
2970 NewCU->addUInt(Die, dwarf::DW_AT_stmt_list, dwarf::DW_FORM_sec_offset, 0);
2972 if (!CompilationDir.empty())
2973 NewCU->addLocalString(Die, dwarf::DW_AT_comp_dir, CompilationDir);
2975 // Flags to let the linker know we have emitted new style pubnames.
2976 if (GenerateGnuPubSections) {
2977 if (Asm->MAI->doesDwarfUseRelocationsAcrossSections())
2978 NewCU->addLabel(Die, dwarf::DW_AT_GNU_pubnames, dwarf::DW_FORM_sec_offset,
2979 Asm->GetTempSymbol("gnu_pubnames", NewCU->getUniqueID()));
2981 NewCU->addDelta(Die, dwarf::DW_AT_GNU_pubnames, dwarf::DW_FORM_data4,
2982 Asm->GetTempSymbol("gnu_pubnames", NewCU->getUniqueID()),
2983 DwarfGnuPubNamesSectionSym);
2985 if (Asm->MAI->doesDwarfUseRelocationsAcrossSections())
2986 NewCU->addLabel(Die, dwarf::DW_AT_GNU_pubtypes, dwarf::DW_FORM_sec_offset,
2987 Asm->GetTempSymbol("gnu_pubtypes", NewCU->getUniqueID()));
2989 NewCU->addDelta(Die, dwarf::DW_AT_GNU_pubtypes, dwarf::DW_FORM_data4,
2990 Asm->GetTempSymbol("gnu_pubtypes", NewCU->getUniqueID()),
2991 DwarfGnuPubTypesSectionSym);
2994 // Flag if we've emitted any ranges and their location for the compile unit.
2995 if (DebugRangeSymbols.size()) {
2996 if (Asm->MAI->doesDwarfUseRelocationsAcrossSections())
2997 NewCU->addLabel(Die, dwarf::DW_AT_GNU_ranges_base,
2998 dwarf::DW_FORM_sec_offset, DwarfDebugRangeSectionSym);
3000 NewCU->addUInt(Die, dwarf::DW_AT_GNU_ranges_base, dwarf::DW_FORM_data4,
3004 SkeletonHolder.addUnit(NewCU);
3005 SkeletonCUs.push_back(NewCU);
3010 void DwarfDebug::emitSkeletonAbbrevs(const MCSection *Section) {
3011 assert(useSplitDwarf() && "No split dwarf debug info?");
3012 emitAbbrevs(Section, &SkeletonAbbrevs);
3015 // Emit the .debug_info.dwo section for separated dwarf. This contains the
3016 // compile units that would normally be in debug_info.
3017 void DwarfDebug::emitDebugInfoDWO() {
3018 assert(useSplitDwarf() && "No split dwarf debug info?");
3019 InfoHolder.emitUnits(this, Asm->getObjFileLowering().getDwarfInfoDWOSection(),
3020 Asm->getObjFileLowering().getDwarfAbbrevDWOSection(),
3021 DwarfAbbrevDWOSectionSym);
3024 // Emit the .debug_abbrev.dwo section for separated dwarf. This contains the
3025 // abbreviations for the .debug_info.dwo section.
3026 void DwarfDebug::emitDebugAbbrevDWO() {
3027 assert(useSplitDwarf() && "No split dwarf?");
3028 emitAbbrevs(Asm->getObjFileLowering().getDwarfAbbrevDWOSection(),
3032 // Emit the .debug_str.dwo section for separated dwarf. This contains the
3033 // string section and is identical in format to traditional .debug_str
3035 void DwarfDebug::emitDebugStrDWO() {
3036 assert(useSplitDwarf() && "No split dwarf?");
3037 const MCSection *OffSec = Asm->getObjFileLowering()
3038 .getDwarfStrOffDWOSection();
3039 const MCSymbol *StrSym = DwarfStrSectionSym;
3040 InfoHolder.emitStrings(Asm->getObjFileLowering().getDwarfStrDWOSection(),