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"
17 #include "DwarfAccelTable.h"
18 #include "DwarfCompileUnit.h"
19 #include "llvm/Constants.h"
20 #include "llvm/Module.h"
21 #include "llvm/Instructions.h"
22 #include "llvm/ADT/Triple.h"
23 #include "llvm/CodeGen/MachineFunction.h"
24 #include "llvm/CodeGen/MachineModuleInfo.h"
25 #include "llvm/MC/MCAsmInfo.h"
26 #include "llvm/MC/MCSection.h"
27 #include "llvm/MC/MCStreamer.h"
28 #include "llvm/MC/MCSymbol.h"
29 #include "llvm/Target/TargetData.h"
30 #include "llvm/Target/TargetFrameLowering.h"
31 #include "llvm/Target/TargetLoweringObjectFile.h"
32 #include "llvm/Target/TargetMachine.h"
33 #include "llvm/Target/TargetRegisterInfo.h"
34 #include "llvm/Target/TargetOptions.h"
35 #include "llvm/Analysis/DebugInfo.h"
36 #include "llvm/Analysis/DIBuilder.h"
37 #include "llvm/ADT/Statistic.h"
38 #include "llvm/ADT/STLExtras.h"
39 #include "llvm/ADT/StringExtras.h"
40 #include "llvm/Support/CommandLine.h"
41 #include "llvm/Support/Debug.h"
42 #include "llvm/Support/ErrorHandling.h"
43 #include "llvm/Support/ValueHandle.h"
44 #include "llvm/Support/FormattedStream.h"
45 #include "llvm/Support/Timer.h"
46 #include "llvm/Support/Path.h"
49 static cl::opt<bool> DisableDebugInfoPrinting("disable-debug-info-print",
51 cl::desc("Disable debug info printing"));
53 static cl::opt<bool> UnknownLocations("use-unknown-locations", cl::Hidden,
54 cl::desc("Make an absence of debug location information explicit."),
57 static cl::opt<bool> DwarfAccelTables("dwarf-accel-tables", cl::Hidden,
58 cl::desc("Output prototype dwarf accelerator tables."),
62 const char *DWARFGroupName = "DWARF Emission";
63 const char *DbgTimerName = "DWARF Debug Writer";
64 } // end anonymous namespace
66 //===----------------------------------------------------------------------===//
68 /// Configuration values for initial hash set sizes (log2).
70 static const unsigned InitAbbreviationsSetSize = 9; // log2(512)
74 DIType DbgVariable::getType() const {
75 DIType Ty = Var.getType();
76 // FIXME: isBlockByrefVariable should be reformulated in terms of complex
78 if (Var.isBlockByrefVariable()) {
79 /* Byref variables, in Blocks, are declared by the programmer as
80 "SomeType VarName;", but the compiler creates a
81 __Block_byref_x_VarName struct, and gives the variable VarName
82 either the struct, or a pointer to the struct, as its type. This
83 is necessary for various behind-the-scenes things the compiler
84 needs to do with by-reference variables in blocks.
86 However, as far as the original *programmer* is concerned, the
87 variable should still have type 'SomeType', as originally declared.
89 The following function dives into the __Block_byref_x_VarName
90 struct to find the original type of the variable. This will be
91 passed back to the code generating the type for the Debug
92 Information Entry for the variable 'VarName'. 'VarName' will then
93 have the original type 'SomeType' in its debug information.
95 The original type 'SomeType' will be the type of the field named
96 'VarName' inside the __Block_byref_x_VarName struct.
98 NOTE: In order for this to not completely fail on the debugger
99 side, the Debug Information Entry for the variable VarName needs to
100 have a DW_AT_location that tells the debugger how to unwind through
101 the pointers and __Block_byref_x_VarName struct to find the actual
102 value of the variable. The function addBlockByrefType does this. */
104 unsigned tag = Ty.getTag();
106 if (tag == dwarf::DW_TAG_pointer_type) {
107 DIDerivedType DTy = DIDerivedType(Ty);
108 subType = DTy.getTypeDerivedFrom();
111 DICompositeType blockStruct = DICompositeType(subType);
112 DIArray Elements = blockStruct.getTypeArray();
114 for (unsigned i = 0, N = Elements.getNumElements(); i < N; ++i) {
115 DIDescriptor Element = Elements.getElement(i);
116 DIDerivedType DT = DIDerivedType(Element);
117 if (getName() == DT.getName())
118 return (DT.getTypeDerivedFrom());
125 } // end llvm namespace
127 DwarfDebug::DwarfDebug(AsmPrinter *A, Module *M)
128 : Asm(A), MMI(Asm->MMI), FirstCU(0),
129 AbbreviationsSet(InitAbbreviationsSetSize),
131 NextStringPoolNumber = 0;
133 DwarfInfoSectionSym = DwarfAbbrevSectionSym = 0;
134 DwarfStrSectionSym = TextSectionSym = 0;
135 DwarfDebugRangeSectionSym = DwarfDebugLocSectionSym = 0;
136 FunctionBeginSym = FunctionEndSym = 0;
138 // Turn on accelerator tables for Darwin.
139 if (Triple(M->getTargetTriple()).isOSDarwin())
140 DwarfAccelTables = true;
143 NamedRegionTimer T(DbgTimerName, DWARFGroupName, TimePassesIsEnabled);
147 DwarfDebug::~DwarfDebug() {
150 /// EmitSectionSym - Switch to the specified MCSection and emit an assembler
151 /// temporary label to it if SymbolStem is specified.
152 static MCSymbol *EmitSectionSym(AsmPrinter *Asm, const MCSection *Section,
153 const char *SymbolStem = 0) {
154 Asm->OutStreamer.SwitchSection(Section);
155 if (!SymbolStem) return 0;
157 MCSymbol *TmpSym = Asm->GetTempSymbol(SymbolStem);
158 Asm->OutStreamer.EmitLabel(TmpSym);
162 MCSymbol *DwarfDebug::getStringPool() {
163 return Asm->GetTempSymbol("section_str");
166 MCSymbol *DwarfDebug::getStringPoolEntry(StringRef Str) {
167 std::pair<MCSymbol*, unsigned> &Entry = StringPool[Str];
168 if (Entry.first) return Entry.first;
170 Entry.second = NextStringPoolNumber++;
171 return Entry.first = Asm->GetTempSymbol("string", Entry.second);
174 /// assignAbbrevNumber - Define a unique number for the abbreviation.
176 void DwarfDebug::assignAbbrevNumber(DIEAbbrev &Abbrev) {
177 // Profile the node so that we can make it unique.
181 // Check the set for priors.
182 DIEAbbrev *InSet = AbbreviationsSet.GetOrInsertNode(&Abbrev);
184 // If it's newly added.
185 if (InSet == &Abbrev) {
186 // Add to abbreviation list.
187 Abbreviations.push_back(&Abbrev);
189 // Assign the vector position + 1 as its number.
190 Abbrev.setNumber(Abbreviations.size());
192 // Assign existing abbreviation number.
193 Abbrev.setNumber(InSet->getNumber());
197 /// getRealLinkageName - If special LLVM prefix that is used to inform the asm
198 /// printer to not emit usual symbol prefix before the symbol name is used then
199 /// return linkage name after skipping this special LLVM prefix.
200 static StringRef getRealLinkageName(StringRef LinkageName) {
202 if (LinkageName.startswith(StringRef(&One, 1)))
203 return LinkageName.substr(1);
207 static bool isObjCClass(StringRef Name) {
208 return Name.startswith("+") || Name.startswith("-");
211 static bool hasObjCCategory(StringRef Name) {
212 if (!isObjCClass(Name)) return false;
214 size_t pos = Name.find(')');
215 if (pos != std::string::npos) {
216 if (Name[pos+1] != ' ') return false;
222 static void getObjCClassCategory(StringRef In, StringRef &Class,
223 StringRef &Category) {
224 if (!hasObjCCategory(In)) {
225 Class = In.slice(In.find('[') + 1, In.find(' '));
230 Class = In.slice(In.find('[') + 1, In.find('('));
231 Category = In.slice(In.find('[') + 1, In.find(' '));
235 static StringRef getObjCMethodName(StringRef In) {
236 return In.slice(In.find(' ') + 1, In.find(']'));
239 // Add the various names to the Dwarf accelerator table names.
240 static void addSubprogramNames(CompileUnit *TheCU, DISubprogram SP,
242 if (!SP.isDefinition()) return;
244 TheCU->addAccelName(SP.getName(), Die);
246 // If the linkage name is different than the name, go ahead and output
247 // that as well into the name table.
248 if (SP.getLinkageName() != "" && SP.getName() != SP.getLinkageName())
249 TheCU->addAccelName(SP.getLinkageName(), Die);
251 // If this is an Objective-C selector name add it to the ObjC accelerator
253 if (isObjCClass(SP.getName())) {
254 StringRef Class, Category;
255 getObjCClassCategory(SP.getName(), Class, Category);
256 TheCU->addAccelObjC(Class, Die);
258 TheCU->addAccelObjC(Category, Die);
259 // Also add the base method name to the name table.
260 TheCU->addAccelName(getObjCMethodName(SP.getName()), Die);
264 /// updateSubprogramScopeDIE - Find DIE for the given subprogram and
265 /// attach appropriate DW_AT_low_pc and DW_AT_high_pc attributes.
266 /// If there are global variables in this scope then create and insert
267 /// DIEs for these variables.
268 DIE *DwarfDebug::updateSubprogramScopeDIE(CompileUnit *SPCU,
269 const MDNode *SPNode) {
270 DIE *SPDie = SPCU->getDIE(SPNode);
272 assert(SPDie && "Unable to find subprogram DIE!");
273 DISubprogram SP(SPNode);
275 DISubprogram SPDecl = SP.getFunctionDeclaration();
276 if (!SPDecl.isSubprogram()) {
277 // There is not any need to generate specification DIE for a function
278 // defined at compile unit level. If a function is defined inside another
279 // function then gdb prefers the definition at top level and but does not
280 // expect specification DIE in parent function. So avoid creating
281 // specification DIE for a function defined inside a function.
282 if (SP.isDefinition() && !SP.getContext().isCompileUnit() &&
283 !SP.getContext().isFile() &&
284 !isSubprogramContext(SP.getContext())) {
285 SPCU->addUInt(SPDie, dwarf::DW_AT_declaration, dwarf::DW_FORM_flag, 1);
288 DICompositeType SPTy = SP.getType();
289 DIArray Args = SPTy.getTypeArray();
290 unsigned SPTag = SPTy.getTag();
291 if (SPTag == dwarf::DW_TAG_subroutine_type)
292 for (unsigned i = 1, N = Args.getNumElements(); i < N; ++i) {
293 DIE *Arg = new DIE(dwarf::DW_TAG_formal_parameter);
294 DIType ATy = DIType(DIType(Args.getElement(i)));
295 SPCU->addType(Arg, ATy);
296 if (ATy.isArtificial())
297 SPCU->addUInt(Arg, dwarf::DW_AT_artificial, dwarf::DW_FORM_flag, 1);
298 SPDie->addChild(Arg);
300 DIE *SPDeclDie = SPDie;
301 SPDie = new DIE(dwarf::DW_TAG_subprogram);
302 SPCU->addDIEEntry(SPDie, dwarf::DW_AT_specification, dwarf::DW_FORM_ref4,
307 // Pick up abstract subprogram DIE.
308 if (DIE *AbsSPDIE = AbstractSPDies.lookup(SPNode)) {
309 SPDie = new DIE(dwarf::DW_TAG_subprogram);
310 SPCU->addDIEEntry(SPDie, dwarf::DW_AT_abstract_origin,
311 dwarf::DW_FORM_ref4, AbsSPDIE);
315 SPCU->addLabel(SPDie, dwarf::DW_AT_low_pc, dwarf::DW_FORM_addr,
316 Asm->GetTempSymbol("func_begin", Asm->getFunctionNumber()));
317 SPCU->addLabel(SPDie, dwarf::DW_AT_high_pc, dwarf::DW_FORM_addr,
318 Asm->GetTempSymbol("func_end", Asm->getFunctionNumber()));
319 const TargetRegisterInfo *RI = Asm->TM.getRegisterInfo();
320 MachineLocation Location(RI->getFrameRegister(*Asm->MF));
321 SPCU->addAddress(SPDie, dwarf::DW_AT_frame_base, Location);
323 // Add name to the name table, we do this here because we're guaranteed
324 // to have concrete versions of our DW_TAG_subprogram nodes.
325 addSubprogramNames(SPCU, SP, SPDie);
330 /// constructLexicalScope - Construct new DW_TAG_lexical_block
331 /// for this scope and attach DW_AT_low_pc/DW_AT_high_pc labels.
332 DIE *DwarfDebug::constructLexicalScopeDIE(CompileUnit *TheCU,
333 LexicalScope *Scope) {
334 DIE *ScopeDIE = new DIE(dwarf::DW_TAG_lexical_block);
335 if (Scope->isAbstractScope())
338 const SmallVector<InsnRange, 4> &Ranges = Scope->getRanges();
342 SmallVector<InsnRange, 4>::const_iterator RI = Ranges.begin();
343 if (Ranges.size() > 1) {
344 // .debug_range section has not been laid out yet. Emit offset in
345 // .debug_range as a uint, size 4, for now. emitDIE will handle
346 // DW_AT_ranges appropriately.
347 TheCU->addUInt(ScopeDIE, dwarf::DW_AT_ranges, dwarf::DW_FORM_data4,
348 DebugRangeSymbols.size()
349 * Asm->getTargetData().getPointerSize());
350 for (SmallVector<InsnRange, 4>::const_iterator RI = Ranges.begin(),
351 RE = Ranges.end(); RI != RE; ++RI) {
352 DebugRangeSymbols.push_back(getLabelBeforeInsn(RI->first));
353 DebugRangeSymbols.push_back(getLabelAfterInsn(RI->second));
355 DebugRangeSymbols.push_back(NULL);
356 DebugRangeSymbols.push_back(NULL);
360 const MCSymbol *Start = getLabelBeforeInsn(RI->first);
361 const MCSymbol *End = getLabelAfterInsn(RI->second);
363 if (End == 0) return 0;
365 assert(Start->isDefined() && "Invalid starting label for an inlined scope!");
366 assert(End->isDefined() && "Invalid end label for an inlined scope!");
368 TheCU->addLabel(ScopeDIE, dwarf::DW_AT_low_pc, dwarf::DW_FORM_addr, Start);
369 TheCU->addLabel(ScopeDIE, dwarf::DW_AT_high_pc, dwarf::DW_FORM_addr, End);
374 /// constructInlinedScopeDIE - This scope represents inlined body of
375 /// a function. Construct DIE to represent this concrete inlined copy
377 DIE *DwarfDebug::constructInlinedScopeDIE(CompileUnit *TheCU,
378 LexicalScope *Scope) {
379 const SmallVector<InsnRange, 4> &Ranges = Scope->getRanges();
380 assert(Ranges.empty() == false &&
381 "LexicalScope does not have instruction markers!");
383 if (!Scope->getScopeNode())
385 DIScope DS(Scope->getScopeNode());
386 DISubprogram InlinedSP = getDISubprogram(DS);
387 DIE *OriginDIE = TheCU->getDIE(InlinedSP);
389 DEBUG(dbgs() << "Unable to find original DIE for inlined subprogram.");
393 SmallVector<InsnRange, 4>::const_iterator RI = Ranges.begin();
394 const MCSymbol *StartLabel = getLabelBeforeInsn(RI->first);
395 const MCSymbol *EndLabel = getLabelAfterInsn(RI->second);
397 if (StartLabel == 0 || EndLabel == 0) {
398 llvm_unreachable("Unexpected Start and End labels for a inlined scope!");
400 assert(StartLabel->isDefined() &&
401 "Invalid starting label for an inlined scope!");
402 assert(EndLabel->isDefined() &&
403 "Invalid end label for an inlined scope!");
405 DIE *ScopeDIE = new DIE(dwarf::DW_TAG_inlined_subroutine);
406 TheCU->addDIEEntry(ScopeDIE, dwarf::DW_AT_abstract_origin,
407 dwarf::DW_FORM_ref4, OriginDIE);
409 if (Ranges.size() > 1) {
410 // .debug_range section has not been laid out yet. Emit offset in
411 // .debug_range as a uint, size 4, for now. emitDIE will handle
412 // DW_AT_ranges appropriately.
413 TheCU->addUInt(ScopeDIE, dwarf::DW_AT_ranges, dwarf::DW_FORM_data4,
414 DebugRangeSymbols.size()
415 * Asm->getTargetData().getPointerSize());
416 for (SmallVector<InsnRange, 4>::const_iterator RI = Ranges.begin(),
417 RE = Ranges.end(); RI != RE; ++RI) {
418 DebugRangeSymbols.push_back(getLabelBeforeInsn(RI->first));
419 DebugRangeSymbols.push_back(getLabelAfterInsn(RI->second));
421 DebugRangeSymbols.push_back(NULL);
422 DebugRangeSymbols.push_back(NULL);
424 TheCU->addLabel(ScopeDIE, dwarf::DW_AT_low_pc, dwarf::DW_FORM_addr,
426 TheCU->addLabel(ScopeDIE, dwarf::DW_AT_high_pc, dwarf::DW_FORM_addr,
430 InlinedSubprogramDIEs.insert(OriginDIE);
432 // Track the start label for this inlined function.
433 //.debug_inlined section specification does not clearly state how
434 // to emit inlined scope that is split into multiple instruction ranges.
435 // For now, use first instruction range and emit low_pc/high_pc pair and
436 // corresponding .debug_inlined section entry for this pair.
437 DenseMap<const MDNode *, SmallVector<InlineInfoLabels, 4> >::iterator
438 I = InlineInfo.find(InlinedSP);
440 if (I == InlineInfo.end()) {
441 InlineInfo[InlinedSP].push_back(std::make_pair(StartLabel, ScopeDIE));
442 InlinedSPNodes.push_back(InlinedSP);
444 I->second.push_back(std::make_pair(StartLabel, ScopeDIE));
446 DILocation DL(Scope->getInlinedAt());
447 TheCU->addUInt(ScopeDIE, dwarf::DW_AT_call_file, 0,
448 GetOrCreateSourceID(DL.getFilename(), DL.getDirectory()));
449 TheCU->addUInt(ScopeDIE, dwarf::DW_AT_call_line, 0, DL.getLineNumber());
451 // Add name to the name table, we do this here because we're guaranteed
452 // to have concrete versions of our DW_TAG_inlined_subprogram nodes.
453 addSubprogramNames(TheCU, InlinedSP, ScopeDIE);
458 /// constructScopeDIE - Construct a DIE for this scope.
459 DIE *DwarfDebug::constructScopeDIE(CompileUnit *TheCU, LexicalScope *Scope) {
460 if (!Scope || !Scope->getScopeNode())
463 SmallVector<DIE *, 8> Children;
465 // Collect arguments for current function.
466 if (LScopes.isCurrentFunctionScope(Scope))
467 for (unsigned i = 0, N = CurrentFnArguments.size(); i < N; ++i)
468 if (DbgVariable *ArgDV = CurrentFnArguments[i])
470 TheCU->constructVariableDIE(ArgDV, Scope->isAbstractScope()))
471 Children.push_back(Arg);
473 // Collect lexical scope children first.
474 const SmallVector<DbgVariable *, 8> &Variables = ScopeVariables.lookup(Scope);
475 for (unsigned i = 0, N = Variables.size(); i < N; ++i)
477 TheCU->constructVariableDIE(Variables[i], Scope->isAbstractScope()))
478 Children.push_back(Variable);
479 const SmallVector<LexicalScope *, 4> &Scopes = Scope->getChildren();
480 for (unsigned j = 0, M = Scopes.size(); j < M; ++j)
481 if (DIE *Nested = constructScopeDIE(TheCU, Scopes[j]))
482 Children.push_back(Nested);
483 DIScope DS(Scope->getScopeNode());
484 DIE *ScopeDIE = NULL;
485 if (Scope->getInlinedAt())
486 ScopeDIE = constructInlinedScopeDIE(TheCU, Scope);
487 else if (DS.isSubprogram()) {
488 ProcessedSPNodes.insert(DS);
489 if (Scope->isAbstractScope()) {
490 ScopeDIE = TheCU->getDIE(DS);
491 // Note down abstract DIE.
493 AbstractSPDies.insert(std::make_pair(DS, ScopeDIE));
496 ScopeDIE = updateSubprogramScopeDIE(TheCU, DS);
499 // There is no need to emit empty lexical block DIE.
500 if (Children.empty())
502 ScopeDIE = constructLexicalScopeDIE(TheCU, Scope);
505 if (!ScopeDIE) return NULL;
508 for (SmallVector<DIE *, 8>::iterator I = Children.begin(),
509 E = Children.end(); I != E; ++I)
510 ScopeDIE->addChild(*I);
512 if (DS.isSubprogram())
513 TheCU->addPubTypes(DISubprogram(DS));
518 /// GetOrCreateSourceID - Look up the source id with the given directory and
519 /// source file names. If none currently exists, create a new id and insert it
520 /// in the SourceIds map. This can update DirectoryNames and SourceFileNames
522 unsigned DwarfDebug::GetOrCreateSourceID(StringRef FileName,
524 // If FE did not provide a file name, then assume stdin.
525 if (FileName.empty())
526 return GetOrCreateSourceID("<stdin>", StringRef());
528 // TODO: this might not belong here. See if we can factor this better.
529 if (DirName == CompilationDir)
532 unsigned SrcId = SourceIdMap.size()+1;
534 // We look up the file/dir pair by concatenating them with a zero byte.
535 SmallString<128> NamePair;
537 NamePair += '\0'; // Zero bytes are not allowed in paths.
538 NamePair += FileName;
540 StringMapEntry<unsigned> &Ent = SourceIdMap.GetOrCreateValue(NamePair, SrcId);
541 if (Ent.getValue() != SrcId)
542 return Ent.getValue();
544 // Print out a .file directive to specify files for .loc directives.
545 Asm->OutStreamer.EmitDwarfFileDirective(SrcId, DirName, FileName);
550 /// constructCompileUnit - Create new CompileUnit for the given
551 /// metadata node with tag DW_TAG_compile_unit.
552 CompileUnit *DwarfDebug::constructCompileUnit(const MDNode *N) {
553 DICompileUnit DIUnit(N);
554 StringRef FN = DIUnit.getFilename();
555 CompilationDir = DIUnit.getDirectory();
556 unsigned ID = GetOrCreateSourceID(FN, CompilationDir);
558 DIE *Die = new DIE(dwarf::DW_TAG_compile_unit);
559 CompileUnit *NewCU = new CompileUnit(ID, DIUnit.getLanguage(), Die, Asm, this);
560 NewCU->addString(Die, dwarf::DW_AT_producer, DIUnit.getProducer());
561 NewCU->addUInt(Die, dwarf::DW_AT_language, dwarf::DW_FORM_data2,
562 DIUnit.getLanguage());
563 NewCU->addString(Die, dwarf::DW_AT_name, FN);
564 // 2.17.1 requires that we use DW_AT_low_pc for a single entry point
566 NewCU->addUInt(Die, dwarf::DW_AT_low_pc, dwarf::DW_FORM_addr, 0);
567 // DW_AT_stmt_list is a offset of line number information for this
568 // compile unit in debug_line section.
569 if (Asm->MAI->doesDwarfRequireRelocationForSectionOffset())
570 NewCU->addLabel(Die, dwarf::DW_AT_stmt_list, dwarf::DW_FORM_data4,
571 Asm->GetTempSymbol("section_line"));
573 NewCU->addUInt(Die, dwarf::DW_AT_stmt_list, dwarf::DW_FORM_data4, 0);
575 if (!CompilationDir.empty())
576 NewCU->addString(Die, dwarf::DW_AT_comp_dir, CompilationDir);
577 if (DIUnit.isOptimized())
578 NewCU->addUInt(Die, dwarf::DW_AT_APPLE_optimized, dwarf::DW_FORM_flag, 1);
580 StringRef Flags = DIUnit.getFlags();
582 NewCU->addString(Die, dwarf::DW_AT_APPLE_flags, Flags);
584 if (unsigned RVer = DIUnit.getRunTimeVersion())
585 NewCU->addUInt(Die, dwarf::DW_AT_APPLE_major_runtime_vers,
586 dwarf::DW_FORM_data1, RVer);
590 CUMap.insert(std::make_pair(N, NewCU));
594 /// construct SubprogramDIE - Construct subprogram DIE.
595 void DwarfDebug::constructSubprogramDIE(CompileUnit *TheCU,
597 CompileUnit *&CURef = SPMap[N];
603 if (!SP.isDefinition())
604 // This is a method declaration which will be handled while constructing
608 DIE *SubprogramDie = TheCU->getOrCreateSubprogramDIE(SP);
611 TheCU->insertDIE(N, SubprogramDie);
613 // Add to context owner.
614 TheCU->addToContextOwner(SubprogramDie, SP.getContext());
619 /// collectInfoFromNamedMDNodes - Collect debug info from named mdnodes such
620 /// as llvm.dbg.enum and llvm.dbg.ty
621 void DwarfDebug::collectInfoFromNamedMDNodes(Module *M) {
622 if (NamedMDNode *NMD = M->getNamedMetadata("llvm.dbg.sp"))
623 for (unsigned i = 0, e = NMD->getNumOperands(); i != e; ++i) {
624 const MDNode *N = NMD->getOperand(i);
625 if (CompileUnit *CU = CUMap.lookup(DISubprogram(N).getCompileUnit()))
626 constructSubprogramDIE(CU, N);
629 if (NamedMDNode *NMD = M->getNamedMetadata("llvm.dbg.gv"))
630 for (unsigned i = 0, e = NMD->getNumOperands(); i != e; ++i) {
631 const MDNode *N = NMD->getOperand(i);
632 if (CompileUnit *CU = CUMap.lookup(DIGlobalVariable(N).getCompileUnit()))
633 CU->createGlobalVariableDIE(N);
636 if (NamedMDNode *NMD = M->getNamedMetadata("llvm.dbg.enum"))
637 for (unsigned i = 0, e = NMD->getNumOperands(); i != e; ++i) {
638 DIType Ty(NMD->getOperand(i));
639 if (CompileUnit *CU = CUMap.lookup(Ty.getCompileUnit()))
640 CU->getOrCreateTypeDIE(Ty);
643 if (NamedMDNode *NMD = M->getNamedMetadata("llvm.dbg.ty"))
644 for (unsigned i = 0, e = NMD->getNumOperands(); i != e; ++i) {
645 DIType Ty(NMD->getOperand(i));
646 if (CompileUnit *CU = CUMap.lookup(Ty.getCompileUnit()))
647 CU->getOrCreateTypeDIE(Ty);
651 /// collectLegacyDebugInfo - Collect debug info using DebugInfoFinder.
652 /// FIXME - Remove this when dragon-egg and llvm-gcc switch to DIBuilder.
653 bool DwarfDebug::collectLegacyDebugInfo(Module *M) {
654 DebugInfoFinder DbgFinder;
655 DbgFinder.processModule(*M);
657 bool HasDebugInfo = false;
658 // Scan all the compile-units to see if there are any marked as the main
659 // unit. If not, we do not generate debug info.
660 for (DebugInfoFinder::iterator I = DbgFinder.compile_unit_begin(),
661 E = DbgFinder.compile_unit_end(); I != E; ++I) {
662 if (DICompileUnit(*I).isMain()) {
667 if (!HasDebugInfo) return false;
669 // Create all the compile unit DIEs.
670 for (DebugInfoFinder::iterator I = DbgFinder.compile_unit_begin(),
671 E = DbgFinder.compile_unit_end(); I != E; ++I)
672 constructCompileUnit(*I);
674 // Create DIEs for each global variable.
675 for (DebugInfoFinder::iterator I = DbgFinder.global_variable_begin(),
676 E = DbgFinder.global_variable_end(); I != E; ++I) {
677 const MDNode *N = *I;
678 if (CompileUnit *CU = CUMap.lookup(DIGlobalVariable(N).getCompileUnit()))
679 CU->createGlobalVariableDIE(N);
682 // Create DIEs for each subprogram.
683 for (DebugInfoFinder::iterator I = DbgFinder.subprogram_begin(),
684 E = DbgFinder.subprogram_end(); I != E; ++I) {
685 const MDNode *N = *I;
686 if (CompileUnit *CU = CUMap.lookup(DISubprogram(N).getCompileUnit()))
687 constructSubprogramDIE(CU, N);
693 /// beginModule - Emit all Dwarf sections that should come prior to the
694 /// content. Create global DIEs and emit initial debug info sections.
695 /// This is invoked by the target AsmPrinter.
696 void DwarfDebug::beginModule(Module *M) {
697 if (DisableDebugInfoPrinting)
700 // If module has named metadata anchors then use them, otherwise scan the
701 // module using debug info finder to collect debug info.
702 NamedMDNode *CU_Nodes = M->getNamedMetadata("llvm.dbg.cu");
704 for (unsigned i = 0, e = CU_Nodes->getNumOperands(); i != e; ++i) {
705 DICompileUnit CUNode(CU_Nodes->getOperand(i));
706 CompileUnit *CU = constructCompileUnit(CUNode);
707 DIArray GVs = CUNode.getGlobalVariables();
708 for (unsigned i = 0, e = GVs.getNumElements(); i != e; ++i)
709 CU->createGlobalVariableDIE(GVs.getElement(i));
710 DIArray SPs = CUNode.getSubprograms();
711 for (unsigned i = 0, e = SPs.getNumElements(); i != e; ++i)
712 constructSubprogramDIE(CU, SPs.getElement(i));
713 DIArray EnumTypes = CUNode.getEnumTypes();
714 for (unsigned i = 0, e = EnumTypes.getNumElements(); i != e; ++i)
715 CU->getOrCreateTypeDIE(EnumTypes.getElement(i));
716 DIArray RetainedTypes = CUNode.getRetainedTypes();
717 for (unsigned i = 0, e = RetainedTypes.getNumElements(); i != e; ++i)
718 CU->getOrCreateTypeDIE(RetainedTypes.getElement(i));
720 } else if (!collectLegacyDebugInfo(M))
723 collectInfoFromNamedMDNodes(M);
725 // Tell MMI that we have debug info.
726 MMI->setDebugInfoAvailability(true);
728 // Emit initial sections.
731 // Prime section data.
732 SectionMap.insert(Asm->getObjFileLowering().getTextSection());
735 /// endModule - Emit all Dwarf sections that should come after the content.
737 void DwarfDebug::endModule() {
738 if (!FirstCU) return;
739 const Module *M = MMI->getModule();
740 DenseMap<const MDNode *, LexicalScope *> DeadFnScopeMap;
742 // Collect info for variables that were optimized out.
743 if (NamedMDNode *CU_Nodes = M->getNamedMetadata("llvm.dbg.cu")) {
744 for (unsigned i = 0, e = CU_Nodes->getNumOperands(); i != e; ++i) {
745 DICompileUnit TheCU(CU_Nodes->getOperand(i));
746 DIArray Subprograms = TheCU.getSubprograms();
747 for (unsigned i = 0, e = Subprograms.getNumElements(); i != e; ++i) {
748 DISubprogram SP(Subprograms.getElement(i));
749 if (ProcessedSPNodes.count(SP) != 0) continue;
750 if (!SP.Verify()) continue;
751 if (!SP.isDefinition()) continue;
752 DIArray Variables = SP.getVariables();
753 if (Variables.getNumElements() == 0) continue;
755 LexicalScope *Scope =
756 new LexicalScope(NULL, DIDescriptor(SP), NULL, false);
757 DeadFnScopeMap[SP] = Scope;
759 // Construct subprogram DIE and add variables DIEs.
760 CompileUnit *SPCU = CUMap.lookup(TheCU);
761 assert(SPCU && "Unable to find Compile Unit!");
762 constructSubprogramDIE(SPCU, SP);
763 DIE *ScopeDIE = SPCU->getDIE(SP);
764 for (unsigned vi = 0, ve = Variables.getNumElements(); vi != ve; ++vi) {
765 DIVariable DV(Variables.getElement(vi));
766 if (!DV.Verify()) continue;
767 DbgVariable *NewVar = new DbgVariable(DV, NULL);
768 if (DIE *VariableDIE =
769 SPCU->constructVariableDIE(NewVar, Scope->isAbstractScope()))
770 ScopeDIE->addChild(VariableDIE);
776 // Attach DW_AT_inline attribute with inlined subprogram DIEs.
777 for (SmallPtrSet<DIE *, 4>::iterator AI = InlinedSubprogramDIEs.begin(),
778 AE = InlinedSubprogramDIEs.end(); AI != AE; ++AI) {
780 FirstCU->addUInt(ISP, dwarf::DW_AT_inline, 0, dwarf::DW_INL_inlined);
782 for (DenseMap<const MDNode *, DIE *>::iterator AI = AbstractSPDies.begin(),
783 AE = AbstractSPDies.end(); AI != AE; ++AI) {
784 DIE *ISP = AI->second;
785 if (InlinedSubprogramDIEs.count(ISP))
787 FirstCU->addUInt(ISP, dwarf::DW_AT_inline, 0, dwarf::DW_INL_inlined);
790 // Emit DW_AT_containing_type attribute to connect types with their
791 // vtable holding type.
792 for (DenseMap<const MDNode *, CompileUnit *>::iterator CUI = CUMap.begin(),
793 CUE = CUMap.end(); CUI != CUE; ++CUI) {
794 CompileUnit *TheCU = CUI->second;
795 TheCU->constructContainingTypeDIEs();
798 // Standard sections final addresses.
799 Asm->OutStreamer.SwitchSection(Asm->getObjFileLowering().getTextSection());
800 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("text_end"));
801 Asm->OutStreamer.SwitchSection(Asm->getObjFileLowering().getDataSection());
802 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("data_end"));
804 // End text sections.
805 for (unsigned i = 1, N = SectionMap.size(); i <= N; ++i) {
806 Asm->OutStreamer.SwitchSection(SectionMap[i]);
807 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("section_end", i));
810 // Compute DIE offsets and sizes.
811 computeSizeAndOffsets();
813 // Emit all the DIEs into a debug info section
816 // Corresponding abbreviations into a abbrev section.
819 // Emit info into a dwarf accelerator table sections.
820 if (DwarfAccelTables) {
823 emitAccelNamespaces();
827 // Emit info into a debug pubtypes section.
830 // Emit info into a debug loc section.
833 // Emit info into a debug aranges section.
836 // Emit info into a debug ranges section.
839 // Emit info into a debug macinfo section.
843 emitDebugInlineInfo();
845 // Emit info into a debug str section.
849 DeleteContainerSeconds(DeadFnScopeMap);
851 for (DenseMap<const MDNode *, CompileUnit *>::iterator I = CUMap.begin(),
852 E = CUMap.end(); I != E; ++I)
854 FirstCU = NULL; // Reset for the next Module, if any.
857 /// findAbstractVariable - Find abstract variable, if any, associated with Var.
858 DbgVariable *DwarfDebug::findAbstractVariable(DIVariable &DV,
860 LLVMContext &Ctx = DV->getContext();
861 // More then one inlined variable corresponds to one abstract variable.
862 DIVariable Var = cleanseInlinedVariable(DV, Ctx);
863 DbgVariable *AbsDbgVariable = AbstractVariables.lookup(Var);
865 return AbsDbgVariable;
867 LexicalScope *Scope = LScopes.findAbstractScope(ScopeLoc.getScope(Ctx));
871 AbsDbgVariable = new DbgVariable(Var, NULL);
872 addScopeVariable(Scope, AbsDbgVariable);
873 AbstractVariables[Var] = AbsDbgVariable;
874 return AbsDbgVariable;
877 /// addCurrentFnArgument - If Var is a current function argument then add
878 /// it to CurrentFnArguments list.
879 bool DwarfDebug::addCurrentFnArgument(const MachineFunction *MF,
880 DbgVariable *Var, LexicalScope *Scope) {
881 if (!LScopes.isCurrentFunctionScope(Scope))
883 DIVariable DV = Var->getVariable();
884 if (DV.getTag() != dwarf::DW_TAG_arg_variable)
886 unsigned ArgNo = DV.getArgNumber();
890 size_t Size = CurrentFnArguments.size();
892 CurrentFnArguments.resize(MF->getFunction()->arg_size());
893 // llvm::Function argument size is not good indicator of how many
894 // arguments does the function have at source level.
896 CurrentFnArguments.resize(ArgNo * 2);
897 CurrentFnArguments[ArgNo - 1] = Var;
901 /// collectVariableInfoFromMMITable - Collect variable information from
902 /// side table maintained by MMI.
904 DwarfDebug::collectVariableInfoFromMMITable(const MachineFunction *MF,
905 SmallPtrSet<const MDNode *, 16> &Processed) {
906 MachineModuleInfo::VariableDbgInfoMapTy &VMap = MMI->getVariableDbgInfo();
907 for (MachineModuleInfo::VariableDbgInfoMapTy::iterator VI = VMap.begin(),
908 VE = VMap.end(); VI != VE; ++VI) {
909 const MDNode *Var = VI->first;
911 Processed.insert(Var);
913 const std::pair<unsigned, DebugLoc> &VP = VI->second;
915 LexicalScope *Scope = LScopes.findLexicalScope(VP.second);
917 // If variable scope is not found then skip this variable.
921 DbgVariable *AbsDbgVariable = findAbstractVariable(DV, VP.second);
922 DbgVariable *RegVar = new DbgVariable(DV, AbsDbgVariable);
923 RegVar->setFrameIndex(VP.first);
924 if (!addCurrentFnArgument(MF, RegVar, Scope))
925 addScopeVariable(Scope, RegVar);
927 AbsDbgVariable->setFrameIndex(VP.first);
931 /// isDbgValueInDefinedReg - Return true if debug value, encoded by
932 /// DBG_VALUE instruction, is in a defined reg.
933 static bool isDbgValueInDefinedReg(const MachineInstr *MI) {
934 assert(MI->isDebugValue() && "Invalid DBG_VALUE machine instruction!");
935 return MI->getNumOperands() == 3 &&
936 MI->getOperand(0).isReg() && MI->getOperand(0).getReg() &&
937 MI->getOperand(1).isImm() && MI->getOperand(1).getImm() == 0;
940 /// getDebugLocEntry - Get .debug_loc entry for the instruction range starting
942 static DotDebugLocEntry getDebugLocEntry(AsmPrinter *Asm,
943 const MCSymbol *FLabel,
944 const MCSymbol *SLabel,
945 const MachineInstr *MI) {
946 const MDNode *Var = MI->getOperand(MI->getNumOperands() - 1).getMetadata();
948 if (MI->getNumOperands() != 3) {
949 MachineLocation MLoc = Asm->getDebugValueLocation(MI);
950 return DotDebugLocEntry(FLabel, SLabel, MLoc, Var);
952 if (MI->getOperand(0).isReg() && MI->getOperand(1).isImm()) {
953 MachineLocation MLoc;
954 MLoc.set(MI->getOperand(0).getReg(), MI->getOperand(1).getImm());
955 return DotDebugLocEntry(FLabel, SLabel, MLoc, Var);
957 if (MI->getOperand(0).isImm())
958 return DotDebugLocEntry(FLabel, SLabel, MI->getOperand(0).getImm());
959 if (MI->getOperand(0).isFPImm())
960 return DotDebugLocEntry(FLabel, SLabel, MI->getOperand(0).getFPImm());
961 if (MI->getOperand(0).isCImm())
962 return DotDebugLocEntry(FLabel, SLabel, MI->getOperand(0).getCImm());
964 llvm_unreachable("Unexpected 3 operand DBG_VALUE instruction!");
967 /// collectVariableInfo - Find variables for each lexical scope.
969 DwarfDebug::collectVariableInfo(const MachineFunction *MF,
970 SmallPtrSet<const MDNode *, 16> &Processed) {
972 /// collection info from MMI table.
973 collectVariableInfoFromMMITable(MF, Processed);
975 for (SmallVectorImpl<const MDNode*>::const_iterator
976 UVI = UserVariables.begin(), UVE = UserVariables.end(); UVI != UVE;
978 const MDNode *Var = *UVI;
979 if (Processed.count(Var))
982 // History contains relevant DBG_VALUE instructions for Var and instructions
984 SmallVectorImpl<const MachineInstr*> &History = DbgValues[Var];
987 const MachineInstr *MInsn = History.front();
990 LexicalScope *Scope = NULL;
991 if (DV.getTag() == dwarf::DW_TAG_arg_variable &&
992 DISubprogram(DV.getContext()).describes(MF->getFunction()))
993 Scope = LScopes.getCurrentFunctionScope();
995 if (DV.getVersion() <= LLVMDebugVersion9)
996 Scope = LScopes.findLexicalScope(MInsn->getDebugLoc());
998 if (MDNode *IA = DV.getInlinedAt())
999 Scope = LScopes.findInlinedScope(DebugLoc::getFromDILocation(IA));
1001 Scope = LScopes.findLexicalScope(cast<MDNode>(DV->getOperand(1)));
1004 // If variable scope is not found then skip this variable.
1008 Processed.insert(DV);
1009 assert(MInsn->isDebugValue() && "History must begin with debug value");
1010 DbgVariable *AbsVar = findAbstractVariable(DV, MInsn->getDebugLoc());
1011 DbgVariable *RegVar = new DbgVariable(DV, AbsVar);
1012 if (!addCurrentFnArgument(MF, RegVar, Scope))
1013 addScopeVariable(Scope, RegVar);
1015 AbsVar->setMInsn(MInsn);
1017 // Simple ranges that are fully coalesced.
1018 if (History.size() <= 1 || (History.size() == 2 &&
1019 MInsn->isIdenticalTo(History.back()))) {
1020 RegVar->setMInsn(MInsn);
1024 // handle multiple DBG_VALUE instructions describing one variable.
1025 RegVar->setDotDebugLocOffset(DotDebugLocEntries.size());
1027 for (SmallVectorImpl<const MachineInstr*>::const_iterator
1028 HI = History.begin(), HE = History.end(); HI != HE; ++HI) {
1029 const MachineInstr *Begin = *HI;
1030 assert(Begin->isDebugValue() && "Invalid History entry");
1032 // Check if DBG_VALUE is truncating a range.
1033 if (Begin->getNumOperands() > 1 && Begin->getOperand(0).isReg()
1034 && !Begin->getOperand(0).getReg())
1037 // Compute the range for a register location.
1038 const MCSymbol *FLabel = getLabelBeforeInsn(Begin);
1039 const MCSymbol *SLabel = 0;
1042 // If Begin is the last instruction in History then its value is valid
1043 // until the end of the function.
1044 SLabel = FunctionEndSym;
1046 const MachineInstr *End = HI[1];
1047 DEBUG(dbgs() << "DotDebugLoc Pair:\n"
1048 << "\t" << *Begin << "\t" << *End << "\n");
1049 if (End->isDebugValue())
1050 SLabel = getLabelBeforeInsn(End);
1052 // End is a normal instruction clobbering the range.
1053 SLabel = getLabelAfterInsn(End);
1054 assert(SLabel && "Forgot label after clobber instruction");
1059 // The value is valid until the next DBG_VALUE or clobber.
1060 DotDebugLocEntries.push_back(getDebugLocEntry(Asm, FLabel, SLabel,
1063 DotDebugLocEntries.push_back(DotDebugLocEntry());
1066 // Collect info for variables that were optimized out.
1067 LexicalScope *FnScope = LScopes.getCurrentFunctionScope();
1068 DIArray Variables = DISubprogram(FnScope->getScopeNode()).getVariables();
1069 for (unsigned i = 0, e = Variables.getNumElements(); i != e; ++i) {
1070 DIVariable DV(Variables.getElement(i));
1071 if (!DV || !DV.Verify() || !Processed.insert(DV))
1073 if (LexicalScope *Scope = LScopes.findLexicalScope(DV.getContext()))
1074 addScopeVariable(Scope, new DbgVariable(DV, NULL));
1078 /// getLabelBeforeInsn - Return Label preceding the instruction.
1079 const MCSymbol *DwarfDebug::getLabelBeforeInsn(const MachineInstr *MI) {
1080 MCSymbol *Label = LabelsBeforeInsn.lookup(MI);
1081 assert(Label && "Didn't insert label before instruction");
1085 /// getLabelAfterInsn - Return Label immediately following the instruction.
1086 const MCSymbol *DwarfDebug::getLabelAfterInsn(const MachineInstr *MI) {
1087 return LabelsAfterInsn.lookup(MI);
1090 /// beginInstruction - Process beginning of an instruction.
1091 void DwarfDebug::beginInstruction(const MachineInstr *MI) {
1092 // Check if source location changes, but ignore DBG_VALUE locations.
1093 if (!MI->isDebugValue()) {
1094 DebugLoc DL = MI->getDebugLoc();
1095 if (DL != PrevInstLoc && (!DL.isUnknown() || UnknownLocations)) {
1098 if (DL == PrologEndLoc) {
1099 Flags |= DWARF2_FLAG_PROLOGUE_END;
1100 PrologEndLoc = DebugLoc();
1102 if (PrologEndLoc.isUnknown())
1103 Flags |= DWARF2_FLAG_IS_STMT;
1105 if (!DL.isUnknown()) {
1106 const MDNode *Scope = DL.getScope(Asm->MF->getFunction()->getContext());
1107 recordSourceLine(DL.getLine(), DL.getCol(), Scope, Flags);
1109 recordSourceLine(0, 0, 0, 0);
1113 // Insert labels where requested.
1114 DenseMap<const MachineInstr*, MCSymbol*>::iterator I =
1115 LabelsBeforeInsn.find(MI);
1118 if (I == LabelsBeforeInsn.end())
1121 // Label already assigned.
1126 PrevLabel = MMI->getContext().CreateTempSymbol();
1127 Asm->OutStreamer.EmitLabel(PrevLabel);
1129 I->second = PrevLabel;
1132 /// endInstruction - Process end of an instruction.
1133 void DwarfDebug::endInstruction(const MachineInstr *MI) {
1134 // Don't create a new label after DBG_VALUE instructions.
1135 // They don't generate code.
1136 if (!MI->isDebugValue())
1139 DenseMap<const MachineInstr*, MCSymbol*>::iterator I =
1140 LabelsAfterInsn.find(MI);
1143 if (I == LabelsAfterInsn.end())
1146 // Label already assigned.
1150 // We need a label after this instruction.
1152 PrevLabel = MMI->getContext().CreateTempSymbol();
1153 Asm->OutStreamer.EmitLabel(PrevLabel);
1155 I->second = PrevLabel;
1158 /// identifyScopeMarkers() -
1159 /// Each LexicalScope has first instruction and last instruction to mark
1160 /// beginning and end of a scope respectively. Create an inverse map that list
1161 /// scopes starts (and ends) with an instruction. One instruction may start (or
1162 /// end) multiple scopes. Ignore scopes that are not reachable.
1163 void DwarfDebug::identifyScopeMarkers() {
1164 SmallVector<LexicalScope *, 4> WorkList;
1165 WorkList.push_back(LScopes.getCurrentFunctionScope());
1166 while (!WorkList.empty()) {
1167 LexicalScope *S = WorkList.pop_back_val();
1169 const SmallVector<LexicalScope *, 4> &Children = S->getChildren();
1170 if (!Children.empty())
1171 for (SmallVector<LexicalScope *, 4>::const_iterator SI = Children.begin(),
1172 SE = Children.end(); SI != SE; ++SI)
1173 WorkList.push_back(*SI);
1175 if (S->isAbstractScope())
1178 const SmallVector<InsnRange, 4> &Ranges = S->getRanges();
1181 for (SmallVector<InsnRange, 4>::const_iterator RI = Ranges.begin(),
1182 RE = Ranges.end(); RI != RE; ++RI) {
1183 assert(RI->first && "InsnRange does not have first instruction!");
1184 assert(RI->second && "InsnRange does not have second instruction!");
1185 requestLabelBeforeInsn(RI->first);
1186 requestLabelAfterInsn(RI->second);
1191 /// getScopeNode - Get MDNode for DebugLoc's scope.
1192 static MDNode *getScopeNode(DebugLoc DL, const LLVMContext &Ctx) {
1193 if (MDNode *InlinedAt = DL.getInlinedAt(Ctx))
1194 return getScopeNode(DebugLoc::getFromDILocation(InlinedAt), Ctx);
1195 return DL.getScope(Ctx);
1198 /// getFnDebugLoc - Walk up the scope chain of given debug loc and find
1199 /// line number info for the function.
1200 static DebugLoc getFnDebugLoc(DebugLoc DL, const LLVMContext &Ctx) {
1201 const MDNode *Scope = getScopeNode(DL, Ctx);
1202 DISubprogram SP = getDISubprogram(Scope);
1204 // Check for number of operands since the compatibility is
1206 if (SP->getNumOperands() > 19)
1207 return DebugLoc::get(SP.getScopeLineNumber(), 0, SP);
1209 return DebugLoc::get(SP.getLineNumber(), 0, SP);
1215 /// beginFunction - Gather pre-function debug information. Assumes being
1216 /// emitted immediately after the function entry point.
1217 void DwarfDebug::beginFunction(const MachineFunction *MF) {
1218 if (!MMI->hasDebugInfo()) return;
1219 LScopes.initialize(*MF);
1220 if (LScopes.empty()) return;
1221 identifyScopeMarkers();
1223 FunctionBeginSym = Asm->GetTempSymbol("func_begin",
1224 Asm->getFunctionNumber());
1225 // Assumes in correct section after the entry point.
1226 Asm->OutStreamer.EmitLabel(FunctionBeginSym);
1228 assert(UserVariables.empty() && DbgValues.empty() && "Maps weren't cleaned");
1230 const TargetRegisterInfo *TRI = Asm->TM.getRegisterInfo();
1231 /// LiveUserVar - Map physreg numbers to the MDNode they contain.
1232 std::vector<const MDNode*> LiveUserVar(TRI->getNumRegs());
1234 for (MachineFunction::const_iterator I = MF->begin(), E = MF->end();
1236 bool AtBlockEntry = true;
1237 for (MachineBasicBlock::const_iterator II = I->begin(), IE = I->end();
1239 const MachineInstr *MI = II;
1241 if (MI->isDebugValue()) {
1242 assert(MI->getNumOperands() > 1 && "Invalid machine instruction!");
1244 // Keep track of user variables.
1246 MI->getOperand(MI->getNumOperands() - 1).getMetadata();
1248 // Variable is in a register, we need to check for clobbers.
1249 if (isDbgValueInDefinedReg(MI))
1250 LiveUserVar[MI->getOperand(0).getReg()] = Var;
1252 // Check the history of this variable.
1253 SmallVectorImpl<const MachineInstr*> &History = DbgValues[Var];
1254 if (History.empty()) {
1255 UserVariables.push_back(Var);
1256 // The first mention of a function argument gets the FunctionBeginSym
1257 // label, so arguments are visible when breaking at function entry.
1259 if (DV.Verify() && DV.getTag() == dwarf::DW_TAG_arg_variable &&
1260 DISubprogram(getDISubprogram(DV.getContext()))
1261 .describes(MF->getFunction()))
1262 LabelsBeforeInsn[MI] = FunctionBeginSym;
1264 // We have seen this variable before. Try to coalesce DBG_VALUEs.
1265 const MachineInstr *Prev = History.back();
1266 if (Prev->isDebugValue()) {
1267 // Coalesce identical entries at the end of History.
1268 if (History.size() >= 2 &&
1269 Prev->isIdenticalTo(History[History.size() - 2])) {
1270 DEBUG(dbgs() << "Coalesce identical DBG_VALUE entries:\n"
1272 << "\t" << *History[History.size() - 2] << "\n");
1276 // Terminate old register assignments that don't reach MI;
1277 MachineFunction::const_iterator PrevMBB = Prev->getParent();
1278 if (PrevMBB != I && (!AtBlockEntry || llvm::next(PrevMBB) != I) &&
1279 isDbgValueInDefinedReg(Prev)) {
1280 // Previous register assignment needs to terminate at the end of
1282 MachineBasicBlock::const_iterator LastMI =
1283 PrevMBB->getLastNonDebugInstr();
1284 if (LastMI == PrevMBB->end()) {
1285 // Drop DBG_VALUE for empty range.
1286 DEBUG(dbgs() << "Drop DBG_VALUE for empty range:\n"
1287 << "\t" << *Prev << "\n");
1291 // Terminate after LastMI.
1292 History.push_back(LastMI);
1297 History.push_back(MI);
1299 // Not a DBG_VALUE instruction.
1301 AtBlockEntry = false;
1303 // First known non DBG_VALUE location marks beginning of function
1305 if (PrologEndLoc.isUnknown() && !MI->getDebugLoc().isUnknown())
1306 PrologEndLoc = MI->getDebugLoc();
1308 // Check if the instruction clobbers any registers with debug vars.
1309 for (MachineInstr::const_mop_iterator MOI = MI->operands_begin(),
1310 MOE = MI->operands_end(); MOI != MOE; ++MOI) {
1311 if (!MOI->isReg() || !MOI->isDef() || !MOI->getReg())
1313 for (const uint16_t *AI = TRI->getOverlaps(MOI->getReg());
1314 unsigned Reg = *AI; ++AI) {
1315 const MDNode *Var = LiveUserVar[Reg];
1318 // Reg is now clobbered.
1319 LiveUserVar[Reg] = 0;
1321 // Was MD last defined by a DBG_VALUE referring to Reg?
1322 DbgValueHistoryMap::iterator HistI = DbgValues.find(Var);
1323 if (HistI == DbgValues.end())
1325 SmallVectorImpl<const MachineInstr*> &History = HistI->second;
1326 if (History.empty())
1328 const MachineInstr *Prev = History.back();
1329 // Sanity-check: Register assignments are terminated at the end of
1331 if (!Prev->isDebugValue() || Prev->getParent() != MI->getParent())
1333 // Is the variable still in Reg?
1334 if (!isDbgValueInDefinedReg(Prev) ||
1335 Prev->getOperand(0).getReg() != Reg)
1337 // Var is clobbered. Make sure the next instruction gets a label.
1338 History.push_back(MI);
1345 for (DbgValueHistoryMap::iterator I = DbgValues.begin(), E = DbgValues.end();
1347 SmallVectorImpl<const MachineInstr*> &History = I->second;
1348 if (History.empty())
1351 // Make sure the final register assignments are terminated.
1352 const MachineInstr *Prev = History.back();
1353 if (Prev->isDebugValue() && isDbgValueInDefinedReg(Prev)) {
1354 const MachineBasicBlock *PrevMBB = Prev->getParent();
1355 MachineBasicBlock::const_iterator LastMI =
1356 PrevMBB->getLastNonDebugInstr();
1357 if (LastMI == PrevMBB->end())
1358 // Drop DBG_VALUE for empty range.
1361 // Terminate after LastMI.
1362 History.push_back(LastMI);
1365 // Request labels for the full history.
1366 for (unsigned i = 0, e = History.size(); i != e; ++i) {
1367 const MachineInstr *MI = History[i];
1368 if (MI->isDebugValue())
1369 requestLabelBeforeInsn(MI);
1371 requestLabelAfterInsn(MI);
1375 PrevInstLoc = DebugLoc();
1376 PrevLabel = FunctionBeginSym;
1378 // Record beginning of function.
1379 if (!PrologEndLoc.isUnknown()) {
1380 DebugLoc FnStartDL = getFnDebugLoc(PrologEndLoc,
1381 MF->getFunction()->getContext());
1382 recordSourceLine(FnStartDL.getLine(), FnStartDL.getCol(),
1383 FnStartDL.getScope(MF->getFunction()->getContext()),
1388 void DwarfDebug::addScopeVariable(LexicalScope *LS, DbgVariable *Var) {
1389 // SmallVector<DbgVariable *, 8> &Vars = ScopeVariables.lookup(LS);
1390 ScopeVariables[LS].push_back(Var);
1391 // Vars.push_back(Var);
1394 /// endFunction - Gather and emit post-function debug information.
1396 void DwarfDebug::endFunction(const MachineFunction *MF) {
1397 if (!MMI->hasDebugInfo() || LScopes.empty()) return;
1399 // Define end label for subprogram.
1400 FunctionEndSym = Asm->GetTempSymbol("func_end",
1401 Asm->getFunctionNumber());
1402 // Assumes in correct section after the entry point.
1403 Asm->OutStreamer.EmitLabel(FunctionEndSym);
1405 SmallPtrSet<const MDNode *, 16> ProcessedVars;
1406 collectVariableInfo(MF, ProcessedVars);
1408 LexicalScope *FnScope = LScopes.getCurrentFunctionScope();
1409 CompileUnit *TheCU = SPMap.lookup(FnScope->getScopeNode());
1410 assert(TheCU && "Unable to find compile unit!");
1412 // Construct abstract scopes.
1413 ArrayRef<LexicalScope *> AList = LScopes.getAbstractScopesList();
1414 for (unsigned i = 0, e = AList.size(); i != e; ++i) {
1415 LexicalScope *AScope = AList[i];
1416 DISubprogram SP(AScope->getScopeNode());
1418 // Collect info for variables that were optimized out.
1419 DIArray Variables = SP.getVariables();
1420 for (unsigned i = 0, e = Variables.getNumElements(); i != e; ++i) {
1421 DIVariable DV(Variables.getElement(i));
1422 if (!DV || !DV.Verify() || !ProcessedVars.insert(DV))
1424 if (LexicalScope *Scope = LScopes.findAbstractScope(DV.getContext()))
1425 addScopeVariable(Scope, new DbgVariable(DV, NULL));
1428 if (ProcessedSPNodes.count(AScope->getScopeNode()) == 0)
1429 constructScopeDIE(TheCU, AScope);
1432 DIE *CurFnDIE = constructScopeDIE(TheCU, FnScope);
1434 if (!MF->getTarget().Options.DisableFramePointerElim(*MF))
1435 TheCU->addUInt(CurFnDIE, dwarf::DW_AT_APPLE_omit_frame_ptr,
1436 dwarf::DW_FORM_flag, 1);
1438 DebugFrames.push_back(FunctionDebugFrameInfo(Asm->getFunctionNumber(),
1439 MMI->getFrameMoves()));
1442 for (DenseMap<LexicalScope *, SmallVector<DbgVariable *, 8> >::iterator
1443 I = ScopeVariables.begin(), E = ScopeVariables.end(); I != E; ++I)
1444 DeleteContainerPointers(I->second);
1445 ScopeVariables.clear();
1446 DeleteContainerPointers(CurrentFnArguments);
1447 UserVariables.clear();
1449 AbstractVariables.clear();
1450 LabelsBeforeInsn.clear();
1451 LabelsAfterInsn.clear();
1455 /// recordSourceLine - Register a source line with debug info. Returns the
1456 /// unique label that was emitted and which provides correspondence to
1457 /// the source line list.
1458 void DwarfDebug::recordSourceLine(unsigned Line, unsigned Col, const MDNode *S,
1464 DIDescriptor Scope(S);
1466 if (Scope.isCompileUnit()) {
1467 DICompileUnit CU(S);
1468 Fn = CU.getFilename();
1469 Dir = CU.getDirectory();
1470 } else if (Scope.isFile()) {
1472 Fn = F.getFilename();
1473 Dir = F.getDirectory();
1474 } else if (Scope.isSubprogram()) {
1476 Fn = SP.getFilename();
1477 Dir = SP.getDirectory();
1478 } else if (Scope.isLexicalBlockFile()) {
1479 DILexicalBlockFile DBF(S);
1480 Fn = DBF.getFilename();
1481 Dir = DBF.getDirectory();
1482 } else if (Scope.isLexicalBlock()) {
1483 DILexicalBlock DB(S);
1484 Fn = DB.getFilename();
1485 Dir = DB.getDirectory();
1487 llvm_unreachable("Unexpected scope info");
1489 Src = GetOrCreateSourceID(Fn, Dir);
1491 Asm->OutStreamer.EmitDwarfLocDirective(Src, Line, Col, Flags, 0, 0, Fn);
1494 //===----------------------------------------------------------------------===//
1496 //===----------------------------------------------------------------------===//
1498 /// computeSizeAndOffset - Compute the size and offset of a DIE.
1501 DwarfDebug::computeSizeAndOffset(DIE *Die, unsigned Offset, bool Last) {
1502 // Get the children.
1503 const std::vector<DIE *> &Children = Die->getChildren();
1505 // Record the abbreviation.
1506 assignAbbrevNumber(Die->getAbbrev());
1508 // Get the abbreviation for this DIE.
1509 unsigned AbbrevNumber = Die->getAbbrevNumber();
1510 const DIEAbbrev *Abbrev = Abbreviations[AbbrevNumber - 1];
1513 Die->setOffset(Offset);
1515 // Start the size with the size of abbreviation code.
1516 Offset += MCAsmInfo::getULEB128Size(AbbrevNumber);
1518 const SmallVector<DIEValue*, 32> &Values = Die->getValues();
1519 const SmallVector<DIEAbbrevData, 8> &AbbrevData = Abbrev->getData();
1521 // Size the DIE attribute values.
1522 for (unsigned i = 0, N = Values.size(); i < N; ++i)
1523 // Size attribute value.
1524 Offset += Values[i]->SizeOf(Asm, AbbrevData[i].getForm());
1526 // Size the DIE children if any.
1527 if (!Children.empty()) {
1528 assert(Abbrev->getChildrenFlag() == dwarf::DW_CHILDREN_yes &&
1529 "Children flag not set");
1531 for (unsigned j = 0, M = Children.size(); j < M; ++j)
1532 Offset = computeSizeAndOffset(Children[j], Offset, (j + 1) == M);
1534 // End of children marker.
1535 Offset += sizeof(int8_t);
1538 Die->setSize(Offset - Die->getOffset());
1542 /// computeSizeAndOffsets - Compute the size and offset of all the DIEs.
1544 void DwarfDebug::computeSizeAndOffsets() {
1545 for (DenseMap<const MDNode *, CompileUnit *>::iterator I = CUMap.begin(),
1546 E = CUMap.end(); I != E; ++I) {
1547 // Compute size of compile unit header.
1549 sizeof(int32_t) + // Length of Compilation Unit Info
1550 sizeof(int16_t) + // DWARF version number
1551 sizeof(int32_t) + // Offset Into Abbrev. Section
1552 sizeof(int8_t); // Pointer Size (in bytes)
1553 computeSizeAndOffset(I->second->getCUDie(), Offset, true);
1557 /// EmitSectionLabels - Emit initial Dwarf sections with a label at
1558 /// the start of each one.
1559 void DwarfDebug::EmitSectionLabels() {
1560 const TargetLoweringObjectFile &TLOF = Asm->getObjFileLowering();
1562 // Dwarf sections base addresses.
1563 DwarfInfoSectionSym =
1564 EmitSectionSym(Asm, TLOF.getDwarfInfoSection(), "section_info");
1565 DwarfAbbrevSectionSym =
1566 EmitSectionSym(Asm, TLOF.getDwarfAbbrevSection(), "section_abbrev");
1567 EmitSectionSym(Asm, TLOF.getDwarfARangesSection());
1569 if (const MCSection *MacroInfo = TLOF.getDwarfMacroInfoSection())
1570 EmitSectionSym(Asm, MacroInfo);
1572 EmitSectionSym(Asm, TLOF.getDwarfLineSection(), "section_line");
1573 EmitSectionSym(Asm, TLOF.getDwarfLocSection());
1574 EmitSectionSym(Asm, TLOF.getDwarfPubTypesSection());
1575 DwarfStrSectionSym =
1576 EmitSectionSym(Asm, TLOF.getDwarfStrSection(), "section_str");
1577 DwarfDebugRangeSectionSym = EmitSectionSym(Asm, TLOF.getDwarfRangesSection(),
1580 DwarfDebugLocSectionSym = EmitSectionSym(Asm, TLOF.getDwarfLocSection(),
1581 "section_debug_loc");
1583 TextSectionSym = EmitSectionSym(Asm, TLOF.getTextSection(), "text_begin");
1584 EmitSectionSym(Asm, TLOF.getDataSection());
1587 /// emitDIE - Recursively emits a debug information entry.
1589 void DwarfDebug::emitDIE(DIE *Die) {
1590 // Get the abbreviation for this DIE.
1591 unsigned AbbrevNumber = Die->getAbbrevNumber();
1592 const DIEAbbrev *Abbrev = Abbreviations[AbbrevNumber - 1];
1594 // Emit the code (index) for the abbreviation.
1595 if (Asm->isVerbose())
1596 Asm->OutStreamer.AddComment("Abbrev [" + Twine(AbbrevNumber) + "] 0x" +
1597 Twine::utohexstr(Die->getOffset()) + ":0x" +
1598 Twine::utohexstr(Die->getSize()) + " " +
1599 dwarf::TagString(Abbrev->getTag()));
1600 Asm->EmitULEB128(AbbrevNumber);
1602 const SmallVector<DIEValue*, 32> &Values = Die->getValues();
1603 const SmallVector<DIEAbbrevData, 8> &AbbrevData = Abbrev->getData();
1605 // Emit the DIE attribute values.
1606 for (unsigned i = 0, N = Values.size(); i < N; ++i) {
1607 unsigned Attr = AbbrevData[i].getAttribute();
1608 unsigned Form = AbbrevData[i].getForm();
1609 assert(Form && "Too many attributes for DIE (check abbreviation)");
1611 if (Asm->isVerbose())
1612 Asm->OutStreamer.AddComment(dwarf::AttributeString(Attr));
1615 case dwarf::DW_AT_abstract_origin: {
1616 DIEEntry *E = cast<DIEEntry>(Values[i]);
1617 DIE *Origin = E->getEntry();
1618 unsigned Addr = Origin->getOffset();
1619 Asm->EmitInt32(Addr);
1622 case dwarf::DW_AT_ranges: {
1623 // DW_AT_range Value encodes offset in debug_range section.
1624 DIEInteger *V = cast<DIEInteger>(Values[i]);
1626 if (Asm->MAI->doesDwarfUseLabelOffsetForRanges()) {
1627 Asm->EmitLabelPlusOffset(DwarfDebugRangeSectionSym,
1631 Asm->EmitLabelOffsetDifference(DwarfDebugRangeSectionSym,
1633 DwarfDebugRangeSectionSym,
1638 case dwarf::DW_AT_location: {
1639 if (DIELabel *L = dyn_cast<DIELabel>(Values[i]))
1640 Asm->EmitLabelDifference(L->getValue(), DwarfDebugLocSectionSym, 4);
1642 Values[i]->EmitValue(Asm, Form);
1645 case dwarf::DW_AT_accessibility: {
1646 if (Asm->isVerbose()) {
1647 DIEInteger *V = cast<DIEInteger>(Values[i]);
1648 Asm->OutStreamer.AddComment(dwarf::AccessibilityString(V->getValue()));
1650 Values[i]->EmitValue(Asm, Form);
1654 // Emit an attribute using the defined form.
1655 Values[i]->EmitValue(Asm, Form);
1660 // Emit the DIE children if any.
1661 if (Abbrev->getChildrenFlag() == dwarf::DW_CHILDREN_yes) {
1662 const std::vector<DIE *> &Children = Die->getChildren();
1664 for (unsigned j = 0, M = Children.size(); j < M; ++j)
1665 emitDIE(Children[j]);
1667 if (Asm->isVerbose())
1668 Asm->OutStreamer.AddComment("End Of Children Mark");
1673 /// emitDebugInfo - Emit the debug info section.
1675 void DwarfDebug::emitDebugInfo() {
1676 // Start debug info section.
1677 Asm->OutStreamer.SwitchSection(
1678 Asm->getObjFileLowering().getDwarfInfoSection());
1679 for (DenseMap<const MDNode *, CompileUnit *>::iterator I = CUMap.begin(),
1680 E = CUMap.end(); I != E; ++I) {
1681 CompileUnit *TheCU = I->second;
1682 DIE *Die = TheCU->getCUDie();
1684 // Emit the compile units header.
1685 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("info_begin",
1688 // Emit size of content not including length itself
1689 unsigned ContentSize = Die->getSize() +
1690 sizeof(int16_t) + // DWARF version number
1691 sizeof(int32_t) + // Offset Into Abbrev. Section
1692 sizeof(int8_t); // Pointer Size (in bytes)
1694 Asm->OutStreamer.AddComment("Length of Compilation Unit Info");
1695 Asm->EmitInt32(ContentSize);
1696 Asm->OutStreamer.AddComment("DWARF version number");
1697 Asm->EmitInt16(dwarf::DWARF_VERSION);
1698 Asm->OutStreamer.AddComment("Offset Into Abbrev. Section");
1699 Asm->EmitSectionOffset(Asm->GetTempSymbol("abbrev_begin"),
1700 DwarfAbbrevSectionSym);
1701 Asm->OutStreamer.AddComment("Address Size (in bytes)");
1702 Asm->EmitInt8(Asm->getTargetData().getPointerSize());
1705 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("info_end", TheCU->getID()));
1709 /// emitAbbreviations - Emit the abbreviation section.
1711 void DwarfDebug::emitAbbreviations() const {
1712 // Check to see if it is worth the effort.
1713 if (!Abbreviations.empty()) {
1714 // Start the debug abbrev section.
1715 Asm->OutStreamer.SwitchSection(
1716 Asm->getObjFileLowering().getDwarfAbbrevSection());
1718 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("abbrev_begin"));
1720 // For each abbrevation.
1721 for (unsigned i = 0, N = Abbreviations.size(); i < N; ++i) {
1722 // Get abbreviation data
1723 const DIEAbbrev *Abbrev = Abbreviations[i];
1725 // Emit the abbrevations code (base 1 index.)
1726 Asm->EmitULEB128(Abbrev->getNumber(), "Abbreviation Code");
1728 // Emit the abbreviations data.
1732 // Mark end of abbreviations.
1733 Asm->EmitULEB128(0, "EOM(3)");
1735 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("abbrev_end"));
1739 /// emitEndOfLineMatrix - Emit the last address of the section and the end of
1740 /// the line matrix.
1742 void DwarfDebug::emitEndOfLineMatrix(unsigned SectionEnd) {
1743 // Define last address of section.
1744 Asm->OutStreamer.AddComment("Extended Op");
1747 Asm->OutStreamer.AddComment("Op size");
1748 Asm->EmitInt8(Asm->getTargetData().getPointerSize() + 1);
1749 Asm->OutStreamer.AddComment("DW_LNE_set_address");
1750 Asm->EmitInt8(dwarf::DW_LNE_set_address);
1752 Asm->OutStreamer.AddComment("Section end label");
1754 Asm->OutStreamer.EmitSymbolValue(Asm->GetTempSymbol("section_end",SectionEnd),
1755 Asm->getTargetData().getPointerSize(),
1758 // Mark end of matrix.
1759 Asm->OutStreamer.AddComment("DW_LNE_end_sequence");
1765 /// emitAccelNames - Emit visible names into a hashed accelerator table
1767 void DwarfDebug::emitAccelNames() {
1768 DwarfAccelTable AT(DwarfAccelTable::Atom(DwarfAccelTable::eAtomTypeDIEOffset,
1769 dwarf::DW_FORM_data4));
1770 for (DenseMap<const MDNode *, CompileUnit *>::iterator I = CUMap.begin(),
1771 E = CUMap.end(); I != E; ++I) {
1772 CompileUnit *TheCU = I->second;
1773 const StringMap<std::vector<DIE*> > &Names = TheCU->getAccelNames();
1774 for (StringMap<std::vector<DIE*> >::const_iterator
1775 GI = Names.begin(), GE = Names.end(); GI != GE; ++GI) {
1776 const char *Name = GI->getKeyData();
1777 const std::vector<DIE *> &Entities = GI->second;
1778 for (std::vector<DIE *>::const_iterator DI = Entities.begin(),
1779 DE = Entities.end(); DI != DE; ++DI)
1780 AT.AddName(Name, (*DI));
1784 AT.FinalizeTable(Asm, "Names");
1785 Asm->OutStreamer.SwitchSection(
1786 Asm->getObjFileLowering().getDwarfAccelNamesSection());
1787 MCSymbol *SectionBegin = Asm->GetTempSymbol("names_begin");
1788 Asm->OutStreamer.EmitLabel(SectionBegin);
1790 // Emit the full data.
1791 AT.Emit(Asm, SectionBegin, this);
1794 /// emitAccelObjC - Emit objective C classes and categories into a hashed
1795 /// accelerator table section.
1796 void DwarfDebug::emitAccelObjC() {
1797 DwarfAccelTable AT(DwarfAccelTable::Atom(DwarfAccelTable::eAtomTypeDIEOffset,
1798 dwarf::DW_FORM_data4));
1799 for (DenseMap<const MDNode *, CompileUnit *>::iterator I = CUMap.begin(),
1800 E = CUMap.end(); I != E; ++I) {
1801 CompileUnit *TheCU = I->second;
1802 const StringMap<std::vector<DIE*> > &Names = TheCU->getAccelObjC();
1803 for (StringMap<std::vector<DIE*> >::const_iterator
1804 GI = Names.begin(), GE = Names.end(); GI != GE; ++GI) {
1805 const char *Name = GI->getKeyData();
1806 const std::vector<DIE *> &Entities = GI->second;
1807 for (std::vector<DIE *>::const_iterator DI = Entities.begin(),
1808 DE = Entities.end(); DI != DE; ++DI)
1809 AT.AddName(Name, (*DI));
1813 AT.FinalizeTable(Asm, "ObjC");
1814 Asm->OutStreamer.SwitchSection(Asm->getObjFileLowering()
1815 .getDwarfAccelObjCSection());
1816 MCSymbol *SectionBegin = Asm->GetTempSymbol("objc_begin");
1817 Asm->OutStreamer.EmitLabel(SectionBegin);
1819 // Emit the full data.
1820 AT.Emit(Asm, SectionBegin, this);
1823 /// emitAccelNamespace - Emit namespace dies into a hashed accelerator
1825 void DwarfDebug::emitAccelNamespaces() {
1826 DwarfAccelTable AT(DwarfAccelTable::Atom(DwarfAccelTable::eAtomTypeDIEOffset,
1827 dwarf::DW_FORM_data4));
1828 for (DenseMap<const MDNode *, CompileUnit *>::iterator I = CUMap.begin(),
1829 E = CUMap.end(); I != E; ++I) {
1830 CompileUnit *TheCU = I->second;
1831 const StringMap<std::vector<DIE*> > &Names = TheCU->getAccelNamespace();
1832 for (StringMap<std::vector<DIE*> >::const_iterator
1833 GI = Names.begin(), GE = Names.end(); GI != GE; ++GI) {
1834 const char *Name = GI->getKeyData();
1835 const std::vector<DIE *> &Entities = GI->second;
1836 for (std::vector<DIE *>::const_iterator DI = Entities.begin(),
1837 DE = Entities.end(); DI != DE; ++DI)
1838 AT.AddName(Name, (*DI));
1842 AT.FinalizeTable(Asm, "namespac");
1843 Asm->OutStreamer.SwitchSection(Asm->getObjFileLowering()
1844 .getDwarfAccelNamespaceSection());
1845 MCSymbol *SectionBegin = Asm->GetTempSymbol("namespac_begin");
1846 Asm->OutStreamer.EmitLabel(SectionBegin);
1848 // Emit the full data.
1849 AT.Emit(Asm, SectionBegin, this);
1852 /// emitAccelTypes() - Emit type dies into a hashed accelerator table.
1853 void DwarfDebug::emitAccelTypes() {
1854 std::vector<DwarfAccelTable::Atom> Atoms;
1855 Atoms.push_back(DwarfAccelTable::Atom(DwarfAccelTable::eAtomTypeDIEOffset,
1856 dwarf::DW_FORM_data4));
1857 Atoms.push_back(DwarfAccelTable::Atom(DwarfAccelTable::eAtomTypeTag,
1858 dwarf::DW_FORM_data2));
1859 Atoms.push_back(DwarfAccelTable::Atom(DwarfAccelTable::eAtomTypeTypeFlags,
1860 dwarf::DW_FORM_data1));
1861 DwarfAccelTable AT(Atoms);
1862 for (DenseMap<const MDNode *, CompileUnit *>::iterator I = CUMap.begin(),
1863 E = CUMap.end(); I != E; ++I) {
1864 CompileUnit *TheCU = I->second;
1865 const StringMap<std::vector<std::pair<DIE*, unsigned > > > &Names
1866 = TheCU->getAccelTypes();
1867 for (StringMap<std::vector<std::pair<DIE*, unsigned> > >::const_iterator
1868 GI = Names.begin(), GE = Names.end(); GI != GE; ++GI) {
1869 const char *Name = GI->getKeyData();
1870 const std::vector<std::pair<DIE *, unsigned> > &Entities = GI->second;
1871 for (std::vector<std::pair<DIE *, unsigned> >::const_iterator DI
1872 = Entities.begin(), DE = Entities.end(); DI !=DE; ++DI)
1873 AT.AddName(Name, (*DI).first, (*DI).second);
1877 AT.FinalizeTable(Asm, "types");
1878 Asm->OutStreamer.SwitchSection(Asm->getObjFileLowering()
1879 .getDwarfAccelTypesSection());
1880 MCSymbol *SectionBegin = Asm->GetTempSymbol("types_begin");
1881 Asm->OutStreamer.EmitLabel(SectionBegin);
1883 // Emit the full data.
1884 AT.Emit(Asm, SectionBegin, this);
1887 void DwarfDebug::emitDebugPubTypes() {
1888 for (DenseMap<const MDNode *, CompileUnit *>::iterator I = CUMap.begin(),
1889 E = CUMap.end(); I != E; ++I) {
1890 CompileUnit *TheCU = I->second;
1891 // Start the dwarf pubtypes section.
1892 Asm->OutStreamer.SwitchSection(
1893 Asm->getObjFileLowering().getDwarfPubTypesSection());
1894 Asm->OutStreamer.AddComment("Length of Public Types Info");
1895 Asm->EmitLabelDifference(
1896 Asm->GetTempSymbol("pubtypes_end", TheCU->getID()),
1897 Asm->GetTempSymbol("pubtypes_begin", TheCU->getID()), 4);
1899 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("pubtypes_begin",
1902 if (Asm->isVerbose()) Asm->OutStreamer.AddComment("DWARF Version");
1903 Asm->EmitInt16(dwarf::DWARF_VERSION);
1905 Asm->OutStreamer.AddComment("Offset of Compilation Unit Info");
1906 Asm->EmitSectionOffset(Asm->GetTempSymbol("info_begin", TheCU->getID()),
1907 DwarfInfoSectionSym);
1909 Asm->OutStreamer.AddComment("Compilation Unit Length");
1910 Asm->EmitLabelDifference(Asm->GetTempSymbol("info_end", TheCU->getID()),
1911 Asm->GetTempSymbol("info_begin", TheCU->getID()),
1914 const StringMap<DIE*> &Globals = TheCU->getGlobalTypes();
1915 for (StringMap<DIE*>::const_iterator
1916 GI = Globals.begin(), GE = Globals.end(); GI != GE; ++GI) {
1917 const char *Name = GI->getKeyData();
1918 DIE *Entity = GI->second;
1920 if (Asm->isVerbose()) Asm->OutStreamer.AddComment("DIE offset");
1921 Asm->EmitInt32(Entity->getOffset());
1923 if (Asm->isVerbose()) Asm->OutStreamer.AddComment("External Name");
1924 // Emit the name with a terminating null byte.
1925 Asm->OutStreamer.EmitBytes(StringRef(Name, GI->getKeyLength()+1), 0);
1928 Asm->OutStreamer.AddComment("End Mark");
1930 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("pubtypes_end",
1935 /// emitDebugStr - Emit visible names into a debug str section.
1937 void DwarfDebug::emitDebugStr() {
1938 // Check to see if it is worth the effort.
1939 if (StringPool.empty()) return;
1941 // Start the dwarf str section.
1942 Asm->OutStreamer.SwitchSection(
1943 Asm->getObjFileLowering().getDwarfStrSection());
1945 // Get all of the string pool entries and put them in an array by their ID so
1946 // we can sort them.
1947 SmallVector<std::pair<unsigned,
1948 StringMapEntry<std::pair<MCSymbol*, unsigned> >*>, 64> Entries;
1950 for (StringMap<std::pair<MCSymbol*, unsigned> >::iterator
1951 I = StringPool.begin(), E = StringPool.end(); I != E; ++I)
1952 Entries.push_back(std::make_pair(I->second.second, &*I));
1954 array_pod_sort(Entries.begin(), Entries.end());
1956 for (unsigned i = 0, e = Entries.size(); i != e; ++i) {
1957 // Emit a label for reference from debug information entries.
1958 Asm->OutStreamer.EmitLabel(Entries[i].second->getValue().first);
1960 // Emit the string itself with a terminating null byte.
1961 Asm->OutStreamer.EmitBytes(StringRef(Entries[i].second->getKeyData(),
1962 Entries[i].second->getKeyLength()+1),
1967 /// emitDebugLoc - Emit visible names into a debug loc section.
1969 void DwarfDebug::emitDebugLoc() {
1970 if (DotDebugLocEntries.empty())
1973 for (SmallVector<DotDebugLocEntry, 4>::iterator
1974 I = DotDebugLocEntries.begin(), E = DotDebugLocEntries.end();
1976 DotDebugLocEntry &Entry = *I;
1977 if (I + 1 != DotDebugLocEntries.end())
1981 // Start the dwarf loc section.
1982 Asm->OutStreamer.SwitchSection(
1983 Asm->getObjFileLowering().getDwarfLocSection());
1984 unsigned char Size = Asm->getTargetData().getPointerSize();
1985 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("debug_loc", 0));
1987 for (SmallVector<DotDebugLocEntry, 4>::iterator
1988 I = DotDebugLocEntries.begin(), E = DotDebugLocEntries.end();
1989 I != E; ++I, ++index) {
1990 DotDebugLocEntry &Entry = *I;
1991 if (Entry.isMerged()) continue;
1992 if (Entry.isEmpty()) {
1993 Asm->OutStreamer.EmitIntValue(0, Size, /*addrspace*/0);
1994 Asm->OutStreamer.EmitIntValue(0, Size, /*addrspace*/0);
1995 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("debug_loc", index));
1997 Asm->OutStreamer.EmitSymbolValue(Entry.Begin, Size, 0);
1998 Asm->OutStreamer.EmitSymbolValue(Entry.End, Size, 0);
1999 DIVariable DV(Entry.Variable);
2000 Asm->OutStreamer.AddComment("Loc expr size");
2001 MCSymbol *begin = Asm->OutStreamer.getContext().CreateTempSymbol();
2002 MCSymbol *end = Asm->OutStreamer.getContext().CreateTempSymbol();
2003 Asm->EmitLabelDifference(end, begin, 2);
2004 Asm->OutStreamer.EmitLabel(begin);
2005 if (Entry.isInt()) {
2006 DIBasicType BTy(DV.getType());
2008 (BTy.getEncoding() == dwarf::DW_ATE_signed
2009 || BTy.getEncoding() == dwarf::DW_ATE_signed_char)) {
2010 Asm->OutStreamer.AddComment("DW_OP_consts");
2011 Asm->EmitInt8(dwarf::DW_OP_consts);
2012 Asm->EmitSLEB128(Entry.getInt());
2014 Asm->OutStreamer.AddComment("DW_OP_constu");
2015 Asm->EmitInt8(dwarf::DW_OP_constu);
2016 Asm->EmitULEB128(Entry.getInt());
2018 } else if (Entry.isLocation()) {
2019 if (!DV.hasComplexAddress())
2021 Asm->EmitDwarfRegOp(Entry.Loc);
2023 // Complex address entry.
2024 unsigned N = DV.getNumAddrElements();
2026 if (N >= 2 && DV.getAddrElement(0) == DIBuilder::OpPlus) {
2027 if (Entry.Loc.getOffset()) {
2029 Asm->EmitDwarfRegOp(Entry.Loc);
2030 Asm->OutStreamer.AddComment("DW_OP_deref");
2031 Asm->EmitInt8(dwarf::DW_OP_deref);
2032 Asm->OutStreamer.AddComment("DW_OP_plus_uconst");
2033 Asm->EmitInt8(dwarf::DW_OP_plus_uconst);
2034 Asm->EmitSLEB128(DV.getAddrElement(1));
2036 // If first address element is OpPlus then emit
2037 // DW_OP_breg + Offset instead of DW_OP_reg + Offset.
2038 MachineLocation Loc(Entry.Loc.getReg(), DV.getAddrElement(1));
2039 Asm->EmitDwarfRegOp(Loc);
2043 Asm->EmitDwarfRegOp(Entry.Loc);
2046 // Emit remaining complex address elements.
2047 for (; i < N; ++i) {
2048 uint64_t Element = DV.getAddrElement(i);
2049 if (Element == DIBuilder::OpPlus) {
2050 Asm->EmitInt8(dwarf::DW_OP_plus_uconst);
2051 Asm->EmitULEB128(DV.getAddrElement(++i));
2052 } else if (Element == DIBuilder::OpDeref)
2053 Asm->EmitInt8(dwarf::DW_OP_deref);
2054 else llvm_unreachable("unknown Opcode found in complex address");
2058 // else ... ignore constant fp. There is not any good way to
2059 // to represent them here in dwarf.
2060 Asm->OutStreamer.EmitLabel(end);
2065 /// EmitDebugARanges - Emit visible names into a debug aranges section.
2067 void DwarfDebug::EmitDebugARanges() {
2068 // Start the dwarf aranges section.
2069 Asm->OutStreamer.SwitchSection(
2070 Asm->getObjFileLowering().getDwarfARangesSection());
2073 /// emitDebugRanges - Emit visible names into a debug ranges section.
2075 void DwarfDebug::emitDebugRanges() {
2076 // Start the dwarf ranges section.
2077 Asm->OutStreamer.SwitchSection(
2078 Asm->getObjFileLowering().getDwarfRangesSection());
2079 unsigned char Size = Asm->getTargetData().getPointerSize();
2080 for (SmallVector<const MCSymbol *, 8>::iterator
2081 I = DebugRangeSymbols.begin(), E = DebugRangeSymbols.end();
2084 Asm->OutStreamer.EmitSymbolValue(const_cast<MCSymbol*>(*I), Size, 0);
2086 Asm->OutStreamer.EmitIntValue(0, Size, /*addrspace*/0);
2090 /// emitDebugMacInfo - Emit visible names into a debug macinfo section.
2092 void DwarfDebug::emitDebugMacInfo() {
2093 if (const MCSection *LineInfo =
2094 Asm->getObjFileLowering().getDwarfMacroInfoSection()) {
2095 // Start the dwarf macinfo section.
2096 Asm->OutStreamer.SwitchSection(LineInfo);
2100 /// emitDebugInlineInfo - Emit inline info using following format.
2102 /// 1. length of section
2103 /// 2. Dwarf version number
2104 /// 3. address size.
2106 /// Entries (one "entry" for each function that was inlined):
2108 /// 1. offset into __debug_str section for MIPS linkage name, if exists;
2109 /// otherwise offset into __debug_str for regular function name.
2110 /// 2. offset into __debug_str section for regular function name.
2111 /// 3. an unsigned LEB128 number indicating the number of distinct inlining
2112 /// instances for the function.
2114 /// The rest of the entry consists of a {die_offset, low_pc} pair for each
2115 /// inlined instance; the die_offset points to the inlined_subroutine die in the
2116 /// __debug_info section, and the low_pc is the starting address for the
2117 /// inlining instance.
2118 void DwarfDebug::emitDebugInlineInfo() {
2119 if (!Asm->MAI->doesDwarfUseInlineInfoSection())
2125 Asm->OutStreamer.SwitchSection(
2126 Asm->getObjFileLowering().getDwarfDebugInlineSection());
2128 Asm->OutStreamer.AddComment("Length of Debug Inlined Information Entry");
2129 Asm->EmitLabelDifference(Asm->GetTempSymbol("debug_inlined_end", 1),
2130 Asm->GetTempSymbol("debug_inlined_begin", 1), 4);
2132 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("debug_inlined_begin", 1));
2134 Asm->OutStreamer.AddComment("Dwarf Version");
2135 Asm->EmitInt16(dwarf::DWARF_VERSION);
2136 Asm->OutStreamer.AddComment("Address Size (in bytes)");
2137 Asm->EmitInt8(Asm->getTargetData().getPointerSize());
2139 for (SmallVector<const MDNode *, 4>::iterator I = InlinedSPNodes.begin(),
2140 E = InlinedSPNodes.end(); I != E; ++I) {
2142 const MDNode *Node = *I;
2143 DenseMap<const MDNode *, SmallVector<InlineInfoLabels, 4> >::iterator II
2144 = InlineInfo.find(Node);
2145 SmallVector<InlineInfoLabels, 4> &Labels = II->second;
2146 DISubprogram SP(Node);
2147 StringRef LName = SP.getLinkageName();
2148 StringRef Name = SP.getName();
2150 Asm->OutStreamer.AddComment("MIPS linkage name");
2152 Asm->EmitSectionOffset(getStringPoolEntry(Name), DwarfStrSectionSym);
2154 Asm->EmitSectionOffset(getStringPoolEntry(getRealLinkageName(LName)),
2155 DwarfStrSectionSym);
2157 Asm->OutStreamer.AddComment("Function name");
2158 Asm->EmitSectionOffset(getStringPoolEntry(Name), DwarfStrSectionSym);
2159 Asm->EmitULEB128(Labels.size(), "Inline count");
2161 for (SmallVector<InlineInfoLabels, 4>::iterator LI = Labels.begin(),
2162 LE = Labels.end(); LI != LE; ++LI) {
2163 if (Asm->isVerbose()) Asm->OutStreamer.AddComment("DIE offset");
2164 Asm->EmitInt32(LI->second->getOffset());
2166 if (Asm->isVerbose()) Asm->OutStreamer.AddComment("low_pc");
2167 Asm->OutStreamer.EmitSymbolValue(LI->first,
2168 Asm->getTargetData().getPointerSize(),0);
2172 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("debug_inlined_end", 1));