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)) {
1096 unsigned Flags = DWARF2_FLAG_IS_STMT;
1098 if (DL == PrologEndLoc) {
1099 Flags |= DWARF2_FLAG_PROLOGUE_END;
1100 PrologEndLoc = DebugLoc();
1102 if (!DL.isUnknown()) {
1103 const MDNode *Scope = DL.getScope(Asm->MF->getFunction()->getContext());
1104 recordSourceLine(DL.getLine(), DL.getCol(), Scope, Flags);
1106 recordSourceLine(0, 0, 0, 0);
1110 // Insert labels where requested.
1111 DenseMap<const MachineInstr*, MCSymbol*>::iterator I =
1112 LabelsBeforeInsn.find(MI);
1115 if (I == LabelsBeforeInsn.end())
1118 // Label already assigned.
1123 PrevLabel = MMI->getContext().CreateTempSymbol();
1124 Asm->OutStreamer.EmitLabel(PrevLabel);
1126 I->second = PrevLabel;
1129 /// endInstruction - Process end of an instruction.
1130 void DwarfDebug::endInstruction(const MachineInstr *MI) {
1131 // Don't create a new label after DBG_VALUE instructions.
1132 // They don't generate code.
1133 if (!MI->isDebugValue())
1136 DenseMap<const MachineInstr*, MCSymbol*>::iterator I =
1137 LabelsAfterInsn.find(MI);
1140 if (I == LabelsAfterInsn.end())
1143 // Label already assigned.
1147 // We need a label after this instruction.
1149 PrevLabel = MMI->getContext().CreateTempSymbol();
1150 Asm->OutStreamer.EmitLabel(PrevLabel);
1152 I->second = PrevLabel;
1155 /// identifyScopeMarkers() -
1156 /// Each LexicalScope has first instruction and last instruction to mark
1157 /// beginning and end of a scope respectively. Create an inverse map that list
1158 /// scopes starts (and ends) with an instruction. One instruction may start (or
1159 /// end) multiple scopes. Ignore scopes that are not reachable.
1160 void DwarfDebug::identifyScopeMarkers() {
1161 SmallVector<LexicalScope *, 4> WorkList;
1162 WorkList.push_back(LScopes.getCurrentFunctionScope());
1163 while (!WorkList.empty()) {
1164 LexicalScope *S = WorkList.pop_back_val();
1166 const SmallVector<LexicalScope *, 4> &Children = S->getChildren();
1167 if (!Children.empty())
1168 for (SmallVector<LexicalScope *, 4>::const_iterator SI = Children.begin(),
1169 SE = Children.end(); SI != SE; ++SI)
1170 WorkList.push_back(*SI);
1172 if (S->isAbstractScope())
1175 const SmallVector<InsnRange, 4> &Ranges = S->getRanges();
1178 for (SmallVector<InsnRange, 4>::const_iterator RI = Ranges.begin(),
1179 RE = Ranges.end(); RI != RE; ++RI) {
1180 assert(RI->first && "InsnRange does not have first instruction!");
1181 assert(RI->second && "InsnRange does not have second instruction!");
1182 requestLabelBeforeInsn(RI->first);
1183 requestLabelAfterInsn(RI->second);
1188 /// getScopeNode - Get MDNode for DebugLoc's scope.
1189 static MDNode *getScopeNode(DebugLoc DL, const LLVMContext &Ctx) {
1190 if (MDNode *InlinedAt = DL.getInlinedAt(Ctx))
1191 return getScopeNode(DebugLoc::getFromDILocation(InlinedAt), Ctx);
1192 return DL.getScope(Ctx);
1195 /// getFnDebugLoc - Walk up the scope chain of given debug loc and find
1196 /// line number info for the function.
1197 static DebugLoc getFnDebugLoc(DebugLoc DL, const LLVMContext &Ctx) {
1198 const MDNode *Scope = getScopeNode(DL, Ctx);
1199 DISubprogram SP = getDISubprogram(Scope);
1201 return DebugLoc::get(SP.getLineNumber(), 0, SP);
1205 /// beginFunction - Gather pre-function debug information. Assumes being
1206 /// emitted immediately after the function entry point.
1207 void DwarfDebug::beginFunction(const MachineFunction *MF) {
1208 if (!MMI->hasDebugInfo()) return;
1209 LScopes.initialize(*MF);
1210 if (LScopes.empty()) return;
1211 identifyScopeMarkers();
1213 FunctionBeginSym = Asm->GetTempSymbol("func_begin",
1214 Asm->getFunctionNumber());
1215 // Assumes in correct section after the entry point.
1216 Asm->OutStreamer.EmitLabel(FunctionBeginSym);
1218 assert(UserVariables.empty() && DbgValues.empty() && "Maps weren't cleaned");
1220 const TargetRegisterInfo *TRI = Asm->TM.getRegisterInfo();
1221 /// LiveUserVar - Map physreg numbers to the MDNode they contain.
1222 std::vector<const MDNode*> LiveUserVar(TRI->getNumRegs());
1224 for (MachineFunction::const_iterator I = MF->begin(), E = MF->end();
1226 bool AtBlockEntry = true;
1227 for (MachineBasicBlock::const_iterator II = I->begin(), IE = I->end();
1229 const MachineInstr *MI = II;
1231 if (MI->isDebugValue()) {
1232 assert(MI->getNumOperands() > 1 && "Invalid machine instruction!");
1234 // Keep track of user variables.
1236 MI->getOperand(MI->getNumOperands() - 1).getMetadata();
1238 // Variable is in a register, we need to check for clobbers.
1239 if (isDbgValueInDefinedReg(MI))
1240 LiveUserVar[MI->getOperand(0).getReg()] = Var;
1242 // Check the history of this variable.
1243 SmallVectorImpl<const MachineInstr*> &History = DbgValues[Var];
1244 if (History.empty()) {
1245 UserVariables.push_back(Var);
1246 // The first mention of a function argument gets the FunctionBeginSym
1247 // label, so arguments are visible when breaking at function entry.
1249 if (DV.Verify() && DV.getTag() == dwarf::DW_TAG_arg_variable &&
1250 DISubprogram(getDISubprogram(DV.getContext()))
1251 .describes(MF->getFunction()))
1252 LabelsBeforeInsn[MI] = FunctionBeginSym;
1254 // We have seen this variable before. Try to coalesce DBG_VALUEs.
1255 const MachineInstr *Prev = History.back();
1256 if (Prev->isDebugValue()) {
1257 // Coalesce identical entries at the end of History.
1258 if (History.size() >= 2 &&
1259 Prev->isIdenticalTo(History[History.size() - 2])) {
1260 DEBUG(dbgs() << "Coalesce identical DBG_VALUE entries:\n"
1262 << "\t" << *History[History.size() - 2] << "\n");
1266 // Terminate old register assignments that don't reach MI;
1267 MachineFunction::const_iterator PrevMBB = Prev->getParent();
1268 if (PrevMBB != I && (!AtBlockEntry || llvm::next(PrevMBB) != I) &&
1269 isDbgValueInDefinedReg(Prev)) {
1270 // Previous register assignment needs to terminate at the end of
1272 MachineBasicBlock::const_iterator LastMI =
1273 PrevMBB->getLastNonDebugInstr();
1274 if (LastMI == PrevMBB->end()) {
1275 // Drop DBG_VALUE for empty range.
1276 DEBUG(dbgs() << "Drop DBG_VALUE for empty range:\n"
1277 << "\t" << *Prev << "\n");
1281 // Terminate after LastMI.
1282 History.push_back(LastMI);
1287 History.push_back(MI);
1289 // Not a DBG_VALUE instruction.
1291 AtBlockEntry = false;
1293 // First known non DBG_VALUE location marks beginning of function
1295 if (PrologEndLoc.isUnknown() && !MI->getDebugLoc().isUnknown())
1296 PrologEndLoc = MI->getDebugLoc();
1298 // Check if the instruction clobbers any registers with debug vars.
1299 for (MachineInstr::const_mop_iterator MOI = MI->operands_begin(),
1300 MOE = MI->operands_end(); MOI != MOE; ++MOI) {
1301 if (!MOI->isReg() || !MOI->isDef() || !MOI->getReg())
1303 for (const uint16_t *AI = TRI->getOverlaps(MOI->getReg());
1304 unsigned Reg = *AI; ++AI) {
1305 const MDNode *Var = LiveUserVar[Reg];
1308 // Reg is now clobbered.
1309 LiveUserVar[Reg] = 0;
1311 // Was MD last defined by a DBG_VALUE referring to Reg?
1312 DbgValueHistoryMap::iterator HistI = DbgValues.find(Var);
1313 if (HistI == DbgValues.end())
1315 SmallVectorImpl<const MachineInstr*> &History = HistI->second;
1316 if (History.empty())
1318 const MachineInstr *Prev = History.back();
1319 // Sanity-check: Register assignments are terminated at the end of
1321 if (!Prev->isDebugValue() || Prev->getParent() != MI->getParent())
1323 // Is the variable still in Reg?
1324 if (!isDbgValueInDefinedReg(Prev) ||
1325 Prev->getOperand(0).getReg() != Reg)
1327 // Var is clobbered. Make sure the next instruction gets a label.
1328 History.push_back(MI);
1335 for (DbgValueHistoryMap::iterator I = DbgValues.begin(), E = DbgValues.end();
1337 SmallVectorImpl<const MachineInstr*> &History = I->second;
1338 if (History.empty())
1341 // Make sure the final register assignments are terminated.
1342 const MachineInstr *Prev = History.back();
1343 if (Prev->isDebugValue() && isDbgValueInDefinedReg(Prev)) {
1344 const MachineBasicBlock *PrevMBB = Prev->getParent();
1345 MachineBasicBlock::const_iterator LastMI =
1346 PrevMBB->getLastNonDebugInstr();
1347 if (LastMI == PrevMBB->end())
1348 // Drop DBG_VALUE for empty range.
1351 // Terminate after LastMI.
1352 History.push_back(LastMI);
1355 // Request labels for the full history.
1356 for (unsigned i = 0, e = History.size(); i != e; ++i) {
1357 const MachineInstr *MI = History[i];
1358 if (MI->isDebugValue())
1359 requestLabelBeforeInsn(MI);
1361 requestLabelAfterInsn(MI);
1365 PrevInstLoc = DebugLoc();
1366 PrevLabel = FunctionBeginSym;
1368 // Record beginning of function.
1369 if (!PrologEndLoc.isUnknown()) {
1370 DebugLoc FnStartDL = getFnDebugLoc(PrologEndLoc,
1371 MF->getFunction()->getContext());
1372 recordSourceLine(FnStartDL.getLine(), FnStartDL.getCol(),
1373 FnStartDL.getScope(MF->getFunction()->getContext()),
1374 DWARF2_FLAG_IS_STMT);
1378 void DwarfDebug::addScopeVariable(LexicalScope *LS, DbgVariable *Var) {
1379 // SmallVector<DbgVariable *, 8> &Vars = ScopeVariables.lookup(LS);
1380 ScopeVariables[LS].push_back(Var);
1381 // Vars.push_back(Var);
1384 /// endFunction - Gather and emit post-function debug information.
1386 void DwarfDebug::endFunction(const MachineFunction *MF) {
1387 if (!MMI->hasDebugInfo() || LScopes.empty()) return;
1389 // Define end label for subprogram.
1390 FunctionEndSym = Asm->GetTempSymbol("func_end",
1391 Asm->getFunctionNumber());
1392 // Assumes in correct section after the entry point.
1393 Asm->OutStreamer.EmitLabel(FunctionEndSym);
1395 SmallPtrSet<const MDNode *, 16> ProcessedVars;
1396 collectVariableInfo(MF, ProcessedVars);
1398 LexicalScope *FnScope = LScopes.getCurrentFunctionScope();
1399 CompileUnit *TheCU = SPMap.lookup(FnScope->getScopeNode());
1400 assert(TheCU && "Unable to find compile unit!");
1402 // Construct abstract scopes.
1403 ArrayRef<LexicalScope *> AList = LScopes.getAbstractScopesList();
1404 for (unsigned i = 0, e = AList.size(); i != e; ++i) {
1405 LexicalScope *AScope = AList[i];
1406 DISubprogram SP(AScope->getScopeNode());
1408 // Collect info for variables that were optimized out.
1409 DIArray Variables = SP.getVariables();
1410 for (unsigned i = 0, e = Variables.getNumElements(); i != e; ++i) {
1411 DIVariable DV(Variables.getElement(i));
1412 if (!DV || !DV.Verify() || !ProcessedVars.insert(DV))
1414 if (LexicalScope *Scope = LScopes.findAbstractScope(DV.getContext()))
1415 addScopeVariable(Scope, new DbgVariable(DV, NULL));
1418 if (ProcessedSPNodes.count(AScope->getScopeNode()) == 0)
1419 constructScopeDIE(TheCU, AScope);
1422 DIE *CurFnDIE = constructScopeDIE(TheCU, FnScope);
1424 if (!MF->getTarget().Options.DisableFramePointerElim(*MF))
1425 TheCU->addUInt(CurFnDIE, dwarf::DW_AT_APPLE_omit_frame_ptr,
1426 dwarf::DW_FORM_flag, 1);
1428 DebugFrames.push_back(FunctionDebugFrameInfo(Asm->getFunctionNumber(),
1429 MMI->getFrameMoves()));
1432 for (DenseMap<LexicalScope *, SmallVector<DbgVariable *, 8> >::iterator
1433 I = ScopeVariables.begin(), E = ScopeVariables.end(); I != E; ++I)
1434 DeleteContainerPointers(I->second);
1435 ScopeVariables.clear();
1436 DeleteContainerPointers(CurrentFnArguments);
1437 UserVariables.clear();
1439 AbstractVariables.clear();
1440 LabelsBeforeInsn.clear();
1441 LabelsAfterInsn.clear();
1445 /// recordSourceLine - Register a source line with debug info. Returns the
1446 /// unique label that was emitted and which provides correspondence to
1447 /// the source line list.
1448 void DwarfDebug::recordSourceLine(unsigned Line, unsigned Col, const MDNode *S,
1454 DIDescriptor Scope(S);
1456 if (Scope.isCompileUnit()) {
1457 DICompileUnit CU(S);
1458 Fn = CU.getFilename();
1459 Dir = CU.getDirectory();
1460 } else if (Scope.isFile()) {
1462 Fn = F.getFilename();
1463 Dir = F.getDirectory();
1464 } else if (Scope.isSubprogram()) {
1466 Fn = SP.getFilename();
1467 Dir = SP.getDirectory();
1468 } else if (Scope.isLexicalBlockFile()) {
1469 DILexicalBlockFile DBF(S);
1470 Fn = DBF.getFilename();
1471 Dir = DBF.getDirectory();
1472 } else if (Scope.isLexicalBlock()) {
1473 DILexicalBlock DB(S);
1474 Fn = DB.getFilename();
1475 Dir = DB.getDirectory();
1477 llvm_unreachable("Unexpected scope info");
1479 Src = GetOrCreateSourceID(Fn, Dir);
1481 Asm->OutStreamer.EmitDwarfLocDirective(Src, Line, Col, Flags, 0, 0, Fn);
1484 //===----------------------------------------------------------------------===//
1486 //===----------------------------------------------------------------------===//
1488 /// computeSizeAndOffset - Compute the size and offset of a DIE.
1491 DwarfDebug::computeSizeAndOffset(DIE *Die, unsigned Offset, bool Last) {
1492 // Get the children.
1493 const std::vector<DIE *> &Children = Die->getChildren();
1495 // Record the abbreviation.
1496 assignAbbrevNumber(Die->getAbbrev());
1498 // Get the abbreviation for this DIE.
1499 unsigned AbbrevNumber = Die->getAbbrevNumber();
1500 const DIEAbbrev *Abbrev = Abbreviations[AbbrevNumber - 1];
1503 Die->setOffset(Offset);
1505 // Start the size with the size of abbreviation code.
1506 Offset += MCAsmInfo::getULEB128Size(AbbrevNumber);
1508 const SmallVector<DIEValue*, 32> &Values = Die->getValues();
1509 const SmallVector<DIEAbbrevData, 8> &AbbrevData = Abbrev->getData();
1511 // Size the DIE attribute values.
1512 for (unsigned i = 0, N = Values.size(); i < N; ++i)
1513 // Size attribute value.
1514 Offset += Values[i]->SizeOf(Asm, AbbrevData[i].getForm());
1516 // Size the DIE children if any.
1517 if (!Children.empty()) {
1518 assert(Abbrev->getChildrenFlag() == dwarf::DW_CHILDREN_yes &&
1519 "Children flag not set");
1521 for (unsigned j = 0, M = Children.size(); j < M; ++j)
1522 Offset = computeSizeAndOffset(Children[j], Offset, (j + 1) == M);
1524 // End of children marker.
1525 Offset += sizeof(int8_t);
1528 Die->setSize(Offset - Die->getOffset());
1532 /// computeSizeAndOffsets - Compute the size and offset of all the DIEs.
1534 void DwarfDebug::computeSizeAndOffsets() {
1535 for (DenseMap<const MDNode *, CompileUnit *>::iterator I = CUMap.begin(),
1536 E = CUMap.end(); I != E; ++I) {
1537 // Compute size of compile unit header.
1539 sizeof(int32_t) + // Length of Compilation Unit Info
1540 sizeof(int16_t) + // DWARF version number
1541 sizeof(int32_t) + // Offset Into Abbrev. Section
1542 sizeof(int8_t); // Pointer Size (in bytes)
1543 computeSizeAndOffset(I->second->getCUDie(), Offset, true);
1547 /// EmitSectionLabels - Emit initial Dwarf sections with a label at
1548 /// the start of each one.
1549 void DwarfDebug::EmitSectionLabels() {
1550 const TargetLoweringObjectFile &TLOF = Asm->getObjFileLowering();
1552 // Dwarf sections base addresses.
1553 DwarfInfoSectionSym =
1554 EmitSectionSym(Asm, TLOF.getDwarfInfoSection(), "section_info");
1555 DwarfAbbrevSectionSym =
1556 EmitSectionSym(Asm, TLOF.getDwarfAbbrevSection(), "section_abbrev");
1557 EmitSectionSym(Asm, TLOF.getDwarfARangesSection());
1559 if (const MCSection *MacroInfo = TLOF.getDwarfMacroInfoSection())
1560 EmitSectionSym(Asm, MacroInfo);
1562 EmitSectionSym(Asm, TLOF.getDwarfLineSection(), "section_line");
1563 EmitSectionSym(Asm, TLOF.getDwarfLocSection());
1564 EmitSectionSym(Asm, TLOF.getDwarfPubTypesSection());
1565 DwarfStrSectionSym =
1566 EmitSectionSym(Asm, TLOF.getDwarfStrSection(), "section_str");
1567 DwarfDebugRangeSectionSym = EmitSectionSym(Asm, TLOF.getDwarfRangesSection(),
1570 DwarfDebugLocSectionSym = EmitSectionSym(Asm, TLOF.getDwarfLocSection(),
1571 "section_debug_loc");
1573 TextSectionSym = EmitSectionSym(Asm, TLOF.getTextSection(), "text_begin");
1574 EmitSectionSym(Asm, TLOF.getDataSection());
1577 /// emitDIE - Recursively emits a debug information entry.
1579 void DwarfDebug::emitDIE(DIE *Die) {
1580 // Get the abbreviation for this DIE.
1581 unsigned AbbrevNumber = Die->getAbbrevNumber();
1582 const DIEAbbrev *Abbrev = Abbreviations[AbbrevNumber - 1];
1584 // Emit the code (index) for the abbreviation.
1585 if (Asm->isVerbose())
1586 Asm->OutStreamer.AddComment("Abbrev [" + Twine(AbbrevNumber) + "] 0x" +
1587 Twine::utohexstr(Die->getOffset()) + ":0x" +
1588 Twine::utohexstr(Die->getSize()) + " " +
1589 dwarf::TagString(Abbrev->getTag()));
1590 Asm->EmitULEB128(AbbrevNumber);
1592 const SmallVector<DIEValue*, 32> &Values = Die->getValues();
1593 const SmallVector<DIEAbbrevData, 8> &AbbrevData = Abbrev->getData();
1595 // Emit the DIE attribute values.
1596 for (unsigned i = 0, N = Values.size(); i < N; ++i) {
1597 unsigned Attr = AbbrevData[i].getAttribute();
1598 unsigned Form = AbbrevData[i].getForm();
1599 assert(Form && "Too many attributes for DIE (check abbreviation)");
1601 if (Asm->isVerbose())
1602 Asm->OutStreamer.AddComment(dwarf::AttributeString(Attr));
1605 case dwarf::DW_AT_abstract_origin: {
1606 DIEEntry *E = cast<DIEEntry>(Values[i]);
1607 DIE *Origin = E->getEntry();
1608 unsigned Addr = Origin->getOffset();
1609 Asm->EmitInt32(Addr);
1612 case dwarf::DW_AT_ranges: {
1613 // DW_AT_range Value encodes offset in debug_range section.
1614 DIEInteger *V = cast<DIEInteger>(Values[i]);
1616 if (Asm->MAI->doesDwarfUseLabelOffsetForRanges()) {
1617 Asm->EmitLabelPlusOffset(DwarfDebugRangeSectionSym,
1621 Asm->EmitLabelOffsetDifference(DwarfDebugRangeSectionSym,
1623 DwarfDebugRangeSectionSym,
1628 case dwarf::DW_AT_location: {
1629 if (DIELabel *L = dyn_cast<DIELabel>(Values[i]))
1630 Asm->EmitLabelDifference(L->getValue(), DwarfDebugLocSectionSym, 4);
1632 Values[i]->EmitValue(Asm, Form);
1635 case dwarf::DW_AT_accessibility: {
1636 if (Asm->isVerbose()) {
1637 DIEInteger *V = cast<DIEInteger>(Values[i]);
1638 Asm->OutStreamer.AddComment(dwarf::AccessibilityString(V->getValue()));
1640 Values[i]->EmitValue(Asm, Form);
1644 // Emit an attribute using the defined form.
1645 Values[i]->EmitValue(Asm, Form);
1650 // Emit the DIE children if any.
1651 if (Abbrev->getChildrenFlag() == dwarf::DW_CHILDREN_yes) {
1652 const std::vector<DIE *> &Children = Die->getChildren();
1654 for (unsigned j = 0, M = Children.size(); j < M; ++j)
1655 emitDIE(Children[j]);
1657 if (Asm->isVerbose())
1658 Asm->OutStreamer.AddComment("End Of Children Mark");
1663 /// emitDebugInfo - Emit the debug info section.
1665 void DwarfDebug::emitDebugInfo() {
1666 // Start debug info section.
1667 Asm->OutStreamer.SwitchSection(
1668 Asm->getObjFileLowering().getDwarfInfoSection());
1669 for (DenseMap<const MDNode *, CompileUnit *>::iterator I = CUMap.begin(),
1670 E = CUMap.end(); I != E; ++I) {
1671 CompileUnit *TheCU = I->second;
1672 DIE *Die = TheCU->getCUDie();
1674 // Emit the compile units header.
1675 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("info_begin",
1678 // Emit size of content not including length itself
1679 unsigned ContentSize = Die->getSize() +
1680 sizeof(int16_t) + // DWARF version number
1681 sizeof(int32_t) + // Offset Into Abbrev. Section
1682 sizeof(int8_t); // Pointer Size (in bytes)
1684 Asm->OutStreamer.AddComment("Length of Compilation Unit Info");
1685 Asm->EmitInt32(ContentSize);
1686 Asm->OutStreamer.AddComment("DWARF version number");
1687 Asm->EmitInt16(dwarf::DWARF_VERSION);
1688 Asm->OutStreamer.AddComment("Offset Into Abbrev. Section");
1689 Asm->EmitSectionOffset(Asm->GetTempSymbol("abbrev_begin"),
1690 DwarfAbbrevSectionSym);
1691 Asm->OutStreamer.AddComment("Address Size (in bytes)");
1692 Asm->EmitInt8(Asm->getTargetData().getPointerSize());
1695 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("info_end", TheCU->getID()));
1699 /// emitAbbreviations - Emit the abbreviation section.
1701 void DwarfDebug::emitAbbreviations() const {
1702 // Check to see if it is worth the effort.
1703 if (!Abbreviations.empty()) {
1704 // Start the debug abbrev section.
1705 Asm->OutStreamer.SwitchSection(
1706 Asm->getObjFileLowering().getDwarfAbbrevSection());
1708 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("abbrev_begin"));
1710 // For each abbrevation.
1711 for (unsigned i = 0, N = Abbreviations.size(); i < N; ++i) {
1712 // Get abbreviation data
1713 const DIEAbbrev *Abbrev = Abbreviations[i];
1715 // Emit the abbrevations code (base 1 index.)
1716 Asm->EmitULEB128(Abbrev->getNumber(), "Abbreviation Code");
1718 // Emit the abbreviations data.
1722 // Mark end of abbreviations.
1723 Asm->EmitULEB128(0, "EOM(3)");
1725 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("abbrev_end"));
1729 /// emitEndOfLineMatrix - Emit the last address of the section and the end of
1730 /// the line matrix.
1732 void DwarfDebug::emitEndOfLineMatrix(unsigned SectionEnd) {
1733 // Define last address of section.
1734 Asm->OutStreamer.AddComment("Extended Op");
1737 Asm->OutStreamer.AddComment("Op size");
1738 Asm->EmitInt8(Asm->getTargetData().getPointerSize() + 1);
1739 Asm->OutStreamer.AddComment("DW_LNE_set_address");
1740 Asm->EmitInt8(dwarf::DW_LNE_set_address);
1742 Asm->OutStreamer.AddComment("Section end label");
1744 Asm->OutStreamer.EmitSymbolValue(Asm->GetTempSymbol("section_end",SectionEnd),
1745 Asm->getTargetData().getPointerSize(),
1748 // Mark end of matrix.
1749 Asm->OutStreamer.AddComment("DW_LNE_end_sequence");
1755 /// emitAccelNames - Emit visible names into a hashed accelerator table
1757 void DwarfDebug::emitAccelNames() {
1758 DwarfAccelTable AT(DwarfAccelTable::Atom(DwarfAccelTable::eAtomTypeDIEOffset,
1759 dwarf::DW_FORM_data4));
1760 for (DenseMap<const MDNode *, CompileUnit *>::iterator I = CUMap.begin(),
1761 E = CUMap.end(); I != E; ++I) {
1762 CompileUnit *TheCU = I->second;
1763 const StringMap<std::vector<DIE*> > &Names = TheCU->getAccelNames();
1764 for (StringMap<std::vector<DIE*> >::const_iterator
1765 GI = Names.begin(), GE = Names.end(); GI != GE; ++GI) {
1766 const char *Name = GI->getKeyData();
1767 const std::vector<DIE *> &Entities = GI->second;
1768 for (std::vector<DIE *>::const_iterator DI = Entities.begin(),
1769 DE = Entities.end(); DI != DE; ++DI)
1770 AT.AddName(Name, (*DI));
1774 AT.FinalizeTable(Asm, "Names");
1775 Asm->OutStreamer.SwitchSection(
1776 Asm->getObjFileLowering().getDwarfAccelNamesSection());
1777 MCSymbol *SectionBegin = Asm->GetTempSymbol("names_begin");
1778 Asm->OutStreamer.EmitLabel(SectionBegin);
1780 // Emit the full data.
1781 AT.Emit(Asm, SectionBegin, this);
1784 /// emitAccelObjC - Emit objective C classes and categories into a hashed
1785 /// accelerator table section.
1786 void DwarfDebug::emitAccelObjC() {
1787 DwarfAccelTable AT(DwarfAccelTable::Atom(DwarfAccelTable::eAtomTypeDIEOffset,
1788 dwarf::DW_FORM_data4));
1789 for (DenseMap<const MDNode *, CompileUnit *>::iterator I = CUMap.begin(),
1790 E = CUMap.end(); I != E; ++I) {
1791 CompileUnit *TheCU = I->second;
1792 const StringMap<std::vector<DIE*> > &Names = TheCU->getAccelObjC();
1793 for (StringMap<std::vector<DIE*> >::const_iterator
1794 GI = Names.begin(), GE = Names.end(); GI != GE; ++GI) {
1795 const char *Name = GI->getKeyData();
1796 const std::vector<DIE *> &Entities = GI->second;
1797 for (std::vector<DIE *>::const_iterator DI = Entities.begin(),
1798 DE = Entities.end(); DI != DE; ++DI)
1799 AT.AddName(Name, (*DI));
1803 AT.FinalizeTable(Asm, "ObjC");
1804 Asm->OutStreamer.SwitchSection(Asm->getObjFileLowering()
1805 .getDwarfAccelObjCSection());
1806 MCSymbol *SectionBegin = Asm->GetTempSymbol("objc_begin");
1807 Asm->OutStreamer.EmitLabel(SectionBegin);
1809 // Emit the full data.
1810 AT.Emit(Asm, SectionBegin, this);
1813 /// emitAccelNamespace - Emit namespace dies into a hashed accelerator
1815 void DwarfDebug::emitAccelNamespaces() {
1816 DwarfAccelTable AT(DwarfAccelTable::Atom(DwarfAccelTable::eAtomTypeDIEOffset,
1817 dwarf::DW_FORM_data4));
1818 for (DenseMap<const MDNode *, CompileUnit *>::iterator I = CUMap.begin(),
1819 E = CUMap.end(); I != E; ++I) {
1820 CompileUnit *TheCU = I->second;
1821 const StringMap<std::vector<DIE*> > &Names = TheCU->getAccelNamespace();
1822 for (StringMap<std::vector<DIE*> >::const_iterator
1823 GI = Names.begin(), GE = Names.end(); GI != GE; ++GI) {
1824 const char *Name = GI->getKeyData();
1825 const std::vector<DIE *> &Entities = GI->second;
1826 for (std::vector<DIE *>::const_iterator DI = Entities.begin(),
1827 DE = Entities.end(); DI != DE; ++DI)
1828 AT.AddName(Name, (*DI));
1832 AT.FinalizeTable(Asm, "namespac");
1833 Asm->OutStreamer.SwitchSection(Asm->getObjFileLowering()
1834 .getDwarfAccelNamespaceSection());
1835 MCSymbol *SectionBegin = Asm->GetTempSymbol("namespac_begin");
1836 Asm->OutStreamer.EmitLabel(SectionBegin);
1838 // Emit the full data.
1839 AT.Emit(Asm, SectionBegin, this);
1842 /// emitAccelTypes() - Emit type dies into a hashed accelerator table.
1843 void DwarfDebug::emitAccelTypes() {
1844 std::vector<DwarfAccelTable::Atom> Atoms;
1845 Atoms.push_back(DwarfAccelTable::Atom(DwarfAccelTable::eAtomTypeDIEOffset,
1846 dwarf::DW_FORM_data4));
1847 Atoms.push_back(DwarfAccelTable::Atom(DwarfAccelTable::eAtomTypeTag,
1848 dwarf::DW_FORM_data2));
1849 Atoms.push_back(DwarfAccelTable::Atom(DwarfAccelTable::eAtomTypeTypeFlags,
1850 dwarf::DW_FORM_data1));
1851 DwarfAccelTable AT(Atoms);
1852 for (DenseMap<const MDNode *, CompileUnit *>::iterator I = CUMap.begin(),
1853 E = CUMap.end(); I != E; ++I) {
1854 CompileUnit *TheCU = I->second;
1855 const StringMap<std::vector<std::pair<DIE*, unsigned > > > &Names
1856 = TheCU->getAccelTypes();
1857 for (StringMap<std::vector<std::pair<DIE*, unsigned> > >::const_iterator
1858 GI = Names.begin(), GE = Names.end(); GI != GE; ++GI) {
1859 const char *Name = GI->getKeyData();
1860 const std::vector<std::pair<DIE *, unsigned> > &Entities = GI->second;
1861 for (std::vector<std::pair<DIE *, unsigned> >::const_iterator DI
1862 = Entities.begin(), DE = Entities.end(); DI !=DE; ++DI)
1863 AT.AddName(Name, (*DI).first, (*DI).second);
1867 AT.FinalizeTable(Asm, "types");
1868 Asm->OutStreamer.SwitchSection(Asm->getObjFileLowering()
1869 .getDwarfAccelTypesSection());
1870 MCSymbol *SectionBegin = Asm->GetTempSymbol("types_begin");
1871 Asm->OutStreamer.EmitLabel(SectionBegin);
1873 // Emit the full data.
1874 AT.Emit(Asm, SectionBegin, this);
1877 void DwarfDebug::emitDebugPubTypes() {
1878 for (DenseMap<const MDNode *, CompileUnit *>::iterator I = CUMap.begin(),
1879 E = CUMap.end(); I != E; ++I) {
1880 CompileUnit *TheCU = I->second;
1881 // Start the dwarf pubtypes section.
1882 Asm->OutStreamer.SwitchSection(
1883 Asm->getObjFileLowering().getDwarfPubTypesSection());
1884 Asm->OutStreamer.AddComment("Length of Public Types Info");
1885 Asm->EmitLabelDifference(
1886 Asm->GetTempSymbol("pubtypes_end", TheCU->getID()),
1887 Asm->GetTempSymbol("pubtypes_begin", TheCU->getID()), 4);
1889 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("pubtypes_begin",
1892 if (Asm->isVerbose()) Asm->OutStreamer.AddComment("DWARF Version");
1893 Asm->EmitInt16(dwarf::DWARF_VERSION);
1895 Asm->OutStreamer.AddComment("Offset of Compilation Unit Info");
1896 Asm->EmitSectionOffset(Asm->GetTempSymbol("info_begin", TheCU->getID()),
1897 DwarfInfoSectionSym);
1899 Asm->OutStreamer.AddComment("Compilation Unit Length");
1900 Asm->EmitLabelDifference(Asm->GetTempSymbol("info_end", TheCU->getID()),
1901 Asm->GetTempSymbol("info_begin", TheCU->getID()),
1904 const StringMap<DIE*> &Globals = TheCU->getGlobalTypes();
1905 for (StringMap<DIE*>::const_iterator
1906 GI = Globals.begin(), GE = Globals.end(); GI != GE; ++GI) {
1907 const char *Name = GI->getKeyData();
1908 DIE *Entity = GI->second;
1910 if (Asm->isVerbose()) Asm->OutStreamer.AddComment("DIE offset");
1911 Asm->EmitInt32(Entity->getOffset());
1913 if (Asm->isVerbose()) Asm->OutStreamer.AddComment("External Name");
1914 // Emit the name with a terminating null byte.
1915 Asm->OutStreamer.EmitBytes(StringRef(Name, GI->getKeyLength()+1), 0);
1918 Asm->OutStreamer.AddComment("End Mark");
1920 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("pubtypes_end",
1925 /// emitDebugStr - Emit visible names into a debug str section.
1927 void DwarfDebug::emitDebugStr() {
1928 // Check to see if it is worth the effort.
1929 if (StringPool.empty()) return;
1931 // Start the dwarf str section.
1932 Asm->OutStreamer.SwitchSection(
1933 Asm->getObjFileLowering().getDwarfStrSection());
1935 // Get all of the string pool entries and put them in an array by their ID so
1936 // we can sort them.
1937 SmallVector<std::pair<unsigned,
1938 StringMapEntry<std::pair<MCSymbol*, unsigned> >*>, 64> Entries;
1940 for (StringMap<std::pair<MCSymbol*, unsigned> >::iterator
1941 I = StringPool.begin(), E = StringPool.end(); I != E; ++I)
1942 Entries.push_back(std::make_pair(I->second.second, &*I));
1944 array_pod_sort(Entries.begin(), Entries.end());
1946 for (unsigned i = 0, e = Entries.size(); i != e; ++i) {
1947 // Emit a label for reference from debug information entries.
1948 Asm->OutStreamer.EmitLabel(Entries[i].second->getValue().first);
1950 // Emit the string itself with a terminating null byte.
1951 Asm->OutStreamer.EmitBytes(StringRef(Entries[i].second->getKeyData(),
1952 Entries[i].second->getKeyLength()+1),
1957 /// emitDebugLoc - Emit visible names into a debug loc section.
1959 void DwarfDebug::emitDebugLoc() {
1960 if (DotDebugLocEntries.empty())
1963 for (SmallVector<DotDebugLocEntry, 4>::iterator
1964 I = DotDebugLocEntries.begin(), E = DotDebugLocEntries.end();
1966 DotDebugLocEntry &Entry = *I;
1967 if (I + 1 != DotDebugLocEntries.end())
1971 // Start the dwarf loc section.
1972 Asm->OutStreamer.SwitchSection(
1973 Asm->getObjFileLowering().getDwarfLocSection());
1974 unsigned char Size = Asm->getTargetData().getPointerSize();
1975 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("debug_loc", 0));
1977 for (SmallVector<DotDebugLocEntry, 4>::iterator
1978 I = DotDebugLocEntries.begin(), E = DotDebugLocEntries.end();
1979 I != E; ++I, ++index) {
1980 DotDebugLocEntry &Entry = *I;
1981 if (Entry.isMerged()) continue;
1982 if (Entry.isEmpty()) {
1983 Asm->OutStreamer.EmitIntValue(0, Size, /*addrspace*/0);
1984 Asm->OutStreamer.EmitIntValue(0, Size, /*addrspace*/0);
1985 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("debug_loc", index));
1987 Asm->OutStreamer.EmitSymbolValue(Entry.Begin, Size, 0);
1988 Asm->OutStreamer.EmitSymbolValue(Entry.End, Size, 0);
1989 DIVariable DV(Entry.Variable);
1990 Asm->OutStreamer.AddComment("Loc expr size");
1991 MCSymbol *begin = Asm->OutStreamer.getContext().CreateTempSymbol();
1992 MCSymbol *end = Asm->OutStreamer.getContext().CreateTempSymbol();
1993 Asm->EmitLabelDifference(end, begin, 2);
1994 Asm->OutStreamer.EmitLabel(begin);
1995 if (Entry.isInt()) {
1996 DIBasicType BTy(DV.getType());
1998 (BTy.getEncoding() == dwarf::DW_ATE_signed
1999 || BTy.getEncoding() == dwarf::DW_ATE_signed_char)) {
2000 Asm->OutStreamer.AddComment("DW_OP_consts");
2001 Asm->EmitInt8(dwarf::DW_OP_consts);
2002 Asm->EmitSLEB128(Entry.getInt());
2004 Asm->OutStreamer.AddComment("DW_OP_constu");
2005 Asm->EmitInt8(dwarf::DW_OP_constu);
2006 Asm->EmitULEB128(Entry.getInt());
2008 } else if (Entry.isLocation()) {
2009 if (!DV.hasComplexAddress())
2011 Asm->EmitDwarfRegOp(Entry.Loc);
2013 // Complex address entry.
2014 unsigned N = DV.getNumAddrElements();
2016 if (N >= 2 && DV.getAddrElement(0) == DIBuilder::OpPlus) {
2017 if (Entry.Loc.getOffset()) {
2019 Asm->EmitDwarfRegOp(Entry.Loc);
2020 Asm->OutStreamer.AddComment("DW_OP_deref");
2021 Asm->EmitInt8(dwarf::DW_OP_deref);
2022 Asm->OutStreamer.AddComment("DW_OP_plus_uconst");
2023 Asm->EmitInt8(dwarf::DW_OP_plus_uconst);
2024 Asm->EmitSLEB128(DV.getAddrElement(1));
2026 // If first address element is OpPlus then emit
2027 // DW_OP_breg + Offset instead of DW_OP_reg + Offset.
2028 MachineLocation Loc(Entry.Loc.getReg(), DV.getAddrElement(1));
2029 Asm->EmitDwarfRegOp(Loc);
2033 Asm->EmitDwarfRegOp(Entry.Loc);
2036 // Emit remaining complex address elements.
2037 for (; i < N; ++i) {
2038 uint64_t Element = DV.getAddrElement(i);
2039 if (Element == DIBuilder::OpPlus) {
2040 Asm->EmitInt8(dwarf::DW_OP_plus_uconst);
2041 Asm->EmitULEB128(DV.getAddrElement(++i));
2042 } else if (Element == DIBuilder::OpDeref)
2043 Asm->EmitInt8(dwarf::DW_OP_deref);
2044 else llvm_unreachable("unknown Opcode found in complex address");
2048 // else ... ignore constant fp. There is not any good way to
2049 // to represent them here in dwarf.
2050 Asm->OutStreamer.EmitLabel(end);
2055 /// EmitDebugARanges - Emit visible names into a debug aranges section.
2057 void DwarfDebug::EmitDebugARanges() {
2058 // Start the dwarf aranges section.
2059 Asm->OutStreamer.SwitchSection(
2060 Asm->getObjFileLowering().getDwarfARangesSection());
2063 /// emitDebugRanges - Emit visible names into a debug ranges section.
2065 void DwarfDebug::emitDebugRanges() {
2066 // Start the dwarf ranges section.
2067 Asm->OutStreamer.SwitchSection(
2068 Asm->getObjFileLowering().getDwarfRangesSection());
2069 unsigned char Size = Asm->getTargetData().getPointerSize();
2070 for (SmallVector<const MCSymbol *, 8>::iterator
2071 I = DebugRangeSymbols.begin(), E = DebugRangeSymbols.end();
2074 Asm->OutStreamer.EmitSymbolValue(const_cast<MCSymbol*>(*I), Size, 0);
2076 Asm->OutStreamer.EmitIntValue(0, Size, /*addrspace*/0);
2080 /// emitDebugMacInfo - Emit visible names into a debug macinfo section.
2082 void DwarfDebug::emitDebugMacInfo() {
2083 if (const MCSection *LineInfo =
2084 Asm->getObjFileLowering().getDwarfMacroInfoSection()) {
2085 // Start the dwarf macinfo section.
2086 Asm->OutStreamer.SwitchSection(LineInfo);
2090 /// emitDebugInlineInfo - Emit inline info using following format.
2092 /// 1. length of section
2093 /// 2. Dwarf version number
2094 /// 3. address size.
2096 /// Entries (one "entry" for each function that was inlined):
2098 /// 1. offset into __debug_str section for MIPS linkage name, if exists;
2099 /// otherwise offset into __debug_str for regular function name.
2100 /// 2. offset into __debug_str section for regular function name.
2101 /// 3. an unsigned LEB128 number indicating the number of distinct inlining
2102 /// instances for the function.
2104 /// The rest of the entry consists of a {die_offset, low_pc} pair for each
2105 /// inlined instance; the die_offset points to the inlined_subroutine die in the
2106 /// __debug_info section, and the low_pc is the starting address for the
2107 /// inlining instance.
2108 void DwarfDebug::emitDebugInlineInfo() {
2109 if (!Asm->MAI->doesDwarfUseInlineInfoSection())
2115 Asm->OutStreamer.SwitchSection(
2116 Asm->getObjFileLowering().getDwarfDebugInlineSection());
2118 Asm->OutStreamer.AddComment("Length of Debug Inlined Information Entry");
2119 Asm->EmitLabelDifference(Asm->GetTempSymbol("debug_inlined_end", 1),
2120 Asm->GetTempSymbol("debug_inlined_begin", 1), 4);
2122 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("debug_inlined_begin", 1));
2124 Asm->OutStreamer.AddComment("Dwarf Version");
2125 Asm->EmitInt16(dwarf::DWARF_VERSION);
2126 Asm->OutStreamer.AddComment("Address Size (in bytes)");
2127 Asm->EmitInt8(Asm->getTargetData().getPointerSize());
2129 for (SmallVector<const MDNode *, 4>::iterator I = InlinedSPNodes.begin(),
2130 E = InlinedSPNodes.end(); I != E; ++I) {
2132 const MDNode *Node = *I;
2133 DenseMap<const MDNode *, SmallVector<InlineInfoLabels, 4> >::iterator II
2134 = InlineInfo.find(Node);
2135 SmallVector<InlineInfoLabels, 4> &Labels = II->second;
2136 DISubprogram SP(Node);
2137 StringRef LName = SP.getLinkageName();
2138 StringRef Name = SP.getName();
2140 Asm->OutStreamer.AddComment("MIPS linkage name");
2142 Asm->EmitSectionOffset(getStringPoolEntry(Name), DwarfStrSectionSym);
2144 Asm->EmitSectionOffset(getStringPoolEntry(getRealLinkageName(LName)),
2145 DwarfStrSectionSym);
2147 Asm->OutStreamer.AddComment("Function name");
2148 Asm->EmitSectionOffset(getStringPoolEntry(Name), DwarfStrSectionSym);
2149 Asm->EmitULEB128(Labels.size(), "Inline count");
2151 for (SmallVector<InlineInfoLabels, 4>::iterator LI = Labels.begin(),
2152 LE = Labels.end(); LI != LE; ++LI) {
2153 if (Asm->isVerbose()) Asm->OutStreamer.AddComment("DIE offset");
2154 Asm->EmitInt32(LI->second->getOffset());
2156 if (Asm->isVerbose()) Asm->OutStreamer.AddComment("low_pc");
2157 Asm->OutStreamer.EmitSymbolValue(LI->first,
2158 Asm->getTargetData().getPointerSize(),0);
2162 Asm->OutStreamer.EmitLabel(Asm->GetTempSymbol("debug_inlined_end", 1));