1 //===-- llvm/CodeGen/DwarfDebug.h - Dwarf Debug Framework ------*- C++ -*--===//
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 #ifndef CODEGEN_ASMPRINTER_DWARFDEBUG_H__
15 #define CODEGEN_ASMPRINTER_DWARFDEBUG_H__
17 #include "llvm/CodeGen/AsmPrinter.h"
18 #include "llvm/CodeGen/MachineLocation.h"
19 #include "llvm/Analysis/DebugInfo.h"
21 #include "llvm/ADT/DenseMap.h"
22 #include "llvm/ADT/FoldingSet.h"
23 #include "llvm/ADT/SmallPtrSet.h"
24 #include "llvm/ADT/StringMap.h"
25 #include "llvm/ADT/UniqueVector.h"
26 #include "llvm/Support/Allocator.h"
27 #include "llvm/Support/DebugLoc.h"
32 class DbgConcreteScope;
35 class MachineFrameInfo;
36 class MachineModuleInfo;
44 //===----------------------------------------------------------------------===//
45 /// SrcLineInfo - This class is used to record source line correspondence.
48 unsigned Line; // Source line number.
49 unsigned Column; // Source column.
50 unsigned SourceID; // Source ID number.
51 MCSymbol *Label; // Label in code ID number.
53 SrcLineInfo(unsigned L, unsigned C, unsigned S, MCSymbol *label)
54 : Line(L), Column(C), SourceID(S), Label(label) {}
57 unsigned getLine() const { return Line; }
58 unsigned getColumn() const { return Column; }
59 unsigned getSourceID() const { return SourceID; }
60 MCSymbol *getLabel() const { return Label; }
63 /// DotDebugLocEntry - This struct describes location entries emitted in
64 /// .debug_loc section.
65 typedef struct DotDebugLocEntry {
66 const MCSymbol *Begin;
69 const MDNode *Variable;
78 enum EntryType EntryKind;
82 const ConstantFP *CFP;
83 const ConstantInt *CIP;
86 : Begin(0), End(0), Variable(0), Merged(false),
87 Constant(false) { Constants.Int = 0;}
88 DotDebugLocEntry(const MCSymbol *B, const MCSymbol *E, MachineLocation &L,
90 : Begin(B), End(E), Loc(L), Variable(V), Merged(false),
91 Constant(false) { Constants.Int = 0; EntryKind = E_Location; }
92 DotDebugLocEntry(const MCSymbol *B, const MCSymbol *E, int64_t i)
93 : Begin(B), End(E), Variable(0), Merged(false),
94 Constant(true) { Constants.Int = i; EntryKind = E_Integer; }
95 DotDebugLocEntry(const MCSymbol *B, const MCSymbol *E, const ConstantFP *FPtr)
96 : Begin(B), End(E), Variable(0), Merged(false),
97 Constant(true) { Constants.CFP = FPtr; EntryKind = E_ConstantFP; }
98 DotDebugLocEntry(const MCSymbol *B, const MCSymbol *E, const ConstantInt *IPtr)
99 : Begin(B), End(E), Variable(0), Merged(false),
100 Constant(true) { Constants.CIP = IPtr; EntryKind = E_ConstantInt; }
102 /// Empty entries are also used as a trigger to emit temp label. Such
103 /// labels are referenced is used to find debug_loc offset for a given DIE.
104 bool isEmpty() { return Begin == 0 && End == 0; }
105 bool isMerged() { return Merged; }
106 void Merge(DotDebugLocEntry *Next) {
107 if (!(Begin && Loc == Next->Loc && End == Next->Begin))
112 bool isLocation() const { return EntryKind == E_Location; }
113 bool isInt() const { return EntryKind == E_Integer; }
114 bool isConstantFP() const { return EntryKind == E_ConstantFP; }
115 bool isConstantInt() const { return EntryKind == E_ConstantInt; }
116 int64_t getInt() { return Constants.Int; }
117 const ConstantFP *getConstantFP() { return Constants.CFP; }
118 const ConstantInt *getConstantInt() { return Constants.CIP; }
121 //===----------------------------------------------------------------------===//
122 /// DbgVariable - This class is used to track local variable information.
125 DIVariable Var; // Variable Descriptor.
126 DIE *TheDIE; // Variable DIE.
127 unsigned DotDebugLocOffset; // Offset in DotDebugLocEntries.
129 // AbsVar may be NULL.
130 DbgVariable(DIVariable V) : Var(V), TheDIE(0), DotDebugLocOffset(~0U) {}
133 DIVariable getVariable() const { return Var; }
134 void setDIE(DIE *D) { TheDIE = D; }
135 DIE *getDIE() const { return TheDIE; }
136 void setDotDebugLocOffset(unsigned O) { DotDebugLocOffset = O; }
137 unsigned getDotDebugLocOffset() const { return DotDebugLocOffset; }
138 StringRef getName() const { return Var.getName(); }
139 unsigned getTag() const { return Var.getTag(); }
140 bool variableHasComplexAddress() const {
141 assert(Var.Verify() && "Invalid complex DbgVariable!");
142 return Var.hasComplexAddress();
144 bool isBlockByrefVariable() const {
145 assert(Var.Verify() && "Invalid complex DbgVariable!");
146 return Var.isBlockByrefVariable();
148 unsigned getNumAddrElements() const {
149 assert(Var.Verify() && "Invalid complex DbgVariable!");
150 return Var.getNumAddrElements();
152 uint64_t getAddrElement(unsigned i) const {
153 return Var.getAddrElement(i);
155 DIType getType() const;
159 /// Asm - Target of Dwarf emission.
162 /// MMI - Collected machine module information.
163 MachineModuleInfo *MMI;
165 //===--------------------------------------------------------------------===//
166 // Attributes used to construct specific Dwarf sections.
169 CompileUnit *FirstCU;
170 DenseMap <const MDNode *, CompileUnit *> CUMap;
172 /// AbbreviationsSet - Used to uniquely define abbreviations.
174 FoldingSet<DIEAbbrev> AbbreviationsSet;
176 /// Abbreviations - A list of all the unique abbreviations in use.
178 std::vector<DIEAbbrev *> Abbreviations;
180 /// SourceIdMap - Source id map, i.e. pair of directory id and source file
181 /// id mapped to a unique id.
182 StringMap<unsigned> SourceIdMap;
184 /// StringPool - A String->Symbol mapping of strings used by indirect
186 StringMap<std::pair<MCSymbol*, unsigned> > StringPool;
187 unsigned NextStringPoolNumber;
189 MCSymbol *getStringPoolEntry(StringRef Str);
191 /// SectionMap - Provides a unique id per text section.
193 UniqueVector<const MCSection*> SectionMap;
195 /// CurrentFnDbgScope - Top level scope for the current function.
197 DbgScope *CurrentFnDbgScope;
199 /// CurrentFnArguments - List of Arguments (DbgValues) for current function.
200 SmallVector<DbgVariable *, 8> CurrentFnArguments;
202 /// DbgScopeMap - Tracks the scopes in the current function. Owns the
203 /// contained DbgScope*s.
204 DenseMap<const MDNode *, DbgScope *> DbgScopeMap;
206 /// InlinedDbgScopeMap - Tracks inlined function scopes in current function.
207 DenseMap<DebugLoc, DbgScope *> InlinedDbgScopeMap;
209 /// AbstractScopes - Tracks the abstract scopes a module. These scopes are
210 /// not included DbgScopeMap. AbstractScopes owns its DbgScope*s.
211 DenseMap<const MDNode *, DbgScope *> AbstractScopes;
213 /// AbstractSPDies - Collection of abstract subprogram DIEs.
214 DenseMap<const MDNode *, DIE *> AbstractSPDies;
216 /// AbstractScopesList - Tracks abstract scopes constructed while processing
217 /// a function. This list is cleared during endFunction().
218 SmallVector<DbgScope *, 4>AbstractScopesList;
220 /// AbstractVariables - Collection on abstract variables. Owned by the
221 /// DbgScopes in AbstractScopes.
222 DenseMap<const MDNode *, DbgVariable *> AbstractVariables;
224 /// DbgVariableToFrameIndexMap - Tracks frame index used to find
225 /// variable's value.
226 DenseMap<const DbgVariable *, int> DbgVariableToFrameIndexMap;
228 /// DbgVariableToDbgInstMap - Maps DbgVariable to corresponding DBG_VALUE
229 /// machine instruction.
230 DenseMap<const DbgVariable *, const MachineInstr *> DbgVariableToDbgInstMap;
232 /// DotDebugLocEntries - Collection of DotDebugLocEntry.
233 SmallVector<DotDebugLocEntry, 4> DotDebugLocEntries;
235 /// UseDotDebugLocEntry - DW_AT_location attributes for the DIEs in this set
236 /// idetifies corresponding .debug_loc entry offset.
237 SmallPtrSet<const DIE *, 4> UseDotDebugLocEntry;
239 /// VarToAbstractVarMap - Maps DbgVariable with corresponding Abstract
240 /// DbgVariable, if any.
241 DenseMap<const DbgVariable *, const DbgVariable *> VarToAbstractVarMap;
243 /// InliendSubprogramDIEs - Collection of subprgram DIEs that are marked
244 /// (at the end of the module) as DW_AT_inline.
245 SmallPtrSet<DIE *, 4> InlinedSubprogramDIEs;
247 /// ContainingTypeMap - This map is used to keep track of subprogram DIEs that
248 /// need DW_AT_containing_type attribute. This attribute points to a DIE that
249 /// corresponds to the MDNode mapped with the subprogram DIE.
250 DenseMap<DIE *, const MDNode *> ContainingTypeMap;
252 /// InlineInfo - Keep track of inlined functions and their location. This
253 /// information is used to populate debug_inlined section.
254 typedef std::pair<const MCSymbol *, DIE *> InlineInfoLabels;
255 DenseMap<const MDNode *, SmallVector<InlineInfoLabels, 4> > InlineInfo;
256 SmallVector<const MDNode *, 4> InlinedSPNodes;
258 // ProcessedSPNodes - This is a collection of subprogram MDNodes that
259 // are processed to create DIEs.
260 SmallPtrSet<const MDNode *, 16> ProcessedSPNodes;
262 /// LabelsBeforeInsn - Maps instruction with label emitted before
264 DenseMap<const MachineInstr *, MCSymbol *> LabelsBeforeInsn;
266 /// LabelsAfterInsn - Maps instruction with label emitted after
268 DenseMap<const MachineInstr *, MCSymbol *> LabelsAfterInsn;
270 /// UserVariables - Every user variable mentioned by a DBG_VALUE instruction
271 /// in order of appearance.
272 SmallVector<const MDNode*, 8> UserVariables;
274 /// DbgValues - For each user variable, keep a list of DBG_VALUE
275 /// instructions in order. The list can also contain normal instructions that
276 /// clobber the previous DBG_VALUE.
277 typedef DenseMap<const MDNode*, SmallVector<const MachineInstr*, 4> >
279 DbgValueHistoryMap DbgValues;
281 SmallVector<const MCSymbol *, 8> DebugRangeSymbols;
283 /// Previous instruction's location information. This is used to determine
284 /// label location to indicate scope boundries in dwarf debug info.
285 DebugLoc PrevInstLoc;
288 /// PrologEndLoc - This location indicates end of function prologue and
289 /// beginning of function body.
290 DebugLoc PrologEndLoc;
292 struct FunctionDebugFrameInfo {
294 std::vector<MachineMove> Moves;
296 FunctionDebugFrameInfo(unsigned Num, const std::vector<MachineMove> &M)
297 : Number(Num), Moves(M) {}
300 std::vector<FunctionDebugFrameInfo> DebugFrames;
302 // DIEValueAllocator - All DIEValues are allocated through this allocator.
303 BumpPtrAllocator DIEValueAllocator;
305 // Section Symbols: these are assembler temporary labels that are emitted at
306 // the beginning of each supported dwarf section. These are used to form
307 // section offsets and are created by EmitSectionLabels.
308 MCSymbol *DwarfInfoSectionSym, *DwarfAbbrevSectionSym;
309 MCSymbol *DwarfStrSectionSym, *TextSectionSym, *DwarfDebugRangeSectionSym;
310 MCSymbol *DwarfDebugLocSectionSym;
311 MCSymbol *FunctionBeginSym, *FunctionEndSym;
315 /// assignAbbrevNumber - Define a unique number for the abbreviation.
317 void assignAbbrevNumber(DIEAbbrev &Abbrev);
319 /// getOrCreateDbgScope - Create DbgScope for the scope.
320 DbgScope *getOrCreateDbgScope(DebugLoc DL);
322 DbgScope *getOrCreateAbstractScope(const MDNode *N);
324 /// findAbstractVariable - Find abstract variable associated with Var.
325 DbgVariable *findAbstractVariable(DIVariable &Var, DebugLoc Loc);
327 /// updateSubprogramScopeDIE - Find DIE for the given subprogram and
328 /// attach appropriate DW_AT_low_pc and DW_AT_high_pc attributes.
329 /// If there are global variables in this scope then create and insert
330 /// DIEs for these variables.
331 DIE *updateSubprogramScopeDIE(const MDNode *SPNode);
333 /// constructLexicalScope - Construct new DW_TAG_lexical_block
334 /// for this scope and attach DW_AT_low_pc/DW_AT_high_pc labels.
335 DIE *constructLexicalScopeDIE(DbgScope *Scope);
337 /// constructInlinedScopeDIE - This scope represents inlined body of
338 /// a function. Construct DIE to represent this concrete inlined copy
340 DIE *constructInlinedScopeDIE(DbgScope *Scope);
342 /// constructVariableDIE - Construct a DIE for the given DbgVariable.
343 DIE *constructVariableDIE(DbgVariable *DV, DbgScope *S);
345 /// constructScopeDIE - Construct a DIE for this scope.
346 DIE *constructScopeDIE(DbgScope *Scope);
348 /// EmitSectionLabels - Emit initial Dwarf sections with a label at
349 /// the start of each one.
350 void EmitSectionLabels();
352 /// emitDIE - Recusively Emits a debug information entry.
354 void emitDIE(DIE *Die);
356 /// computeSizeAndOffset - Compute the size and offset of a DIE.
358 unsigned computeSizeAndOffset(DIE *Die, unsigned Offset, bool Last);
360 /// computeSizeAndOffsets - Compute the size and offset of all the DIEs.
362 void computeSizeAndOffsets();
364 /// EmitDebugInfo - Emit the debug info section.
366 void emitDebugInfo();
368 /// emitAbbreviations - Emit the abbreviation section.
370 void emitAbbreviations() const;
372 /// emitEndOfLineMatrix - Emit the last address of the section and the end of
375 void emitEndOfLineMatrix(unsigned SectionEnd);
377 /// emitDebugPubNames - Emit visible names into a debug pubnames section.
379 void emitDebugPubNames();
381 /// emitDebugPubTypes - Emit visible types into a debug pubtypes section.
383 void emitDebugPubTypes();
385 /// emitDebugStr - Emit visible names into a debug str section.
389 /// emitDebugLoc - Emit visible names into a debug loc section.
393 /// EmitDebugARanges - Emit visible names into a debug aranges section.
395 void EmitDebugARanges();
397 /// emitDebugRanges - Emit visible names into a debug ranges section.
399 void emitDebugRanges();
401 /// emitDebugMacInfo - Emit visible names into a debug macinfo section.
403 void emitDebugMacInfo();
405 /// emitDebugInlineInfo - Emit inline info using following format.
407 /// 1. length of section
408 /// 2. Dwarf version number
411 /// Entries (one "entry" for each function that was inlined):
413 /// 1. offset into __debug_str section for MIPS linkage name, if exists;
414 /// otherwise offset into __debug_str for regular function name.
415 /// 2. offset into __debug_str section for regular function name.
416 /// 3. an unsigned LEB128 number indicating the number of distinct inlining
417 /// instances for the function.
419 /// The rest of the entry consists of a {die_offset, low_pc} pair for each
420 /// inlined instance; the die_offset points to the inlined_subroutine die in
421 /// the __debug_info section, and the low_pc is the starting address for the
422 /// inlining instance.
423 void emitDebugInlineInfo();
425 /// constructCompileUnit - Create new CompileUnit for the given
426 /// metadata node with tag DW_TAG_compile_unit.
427 void constructCompileUnit(const MDNode *N);
429 /// getCompielUnit - Get CompileUnit DIE.
430 CompileUnit *getCompileUnit(const MDNode *N) const;
432 /// constructGlobalVariableDIE - Construct global variable DIE.
433 void constructGlobalVariableDIE(const MDNode *N);
435 /// construct SubprogramDIE - Construct subprogram DIE.
436 void constructSubprogramDIE(const MDNode *N);
438 /// recordSourceLine - Register a source line with debug info. Returns the
439 /// unique label that was emitted and which provides correspondence to
440 /// the source line list.
441 void recordSourceLine(unsigned Line, unsigned Col, const MDNode *Scope,
444 /// recordVariableFrameIndex - Record a variable's index.
445 void recordVariableFrameIndex(const DbgVariable *V, int Index);
447 /// findVariableFrameIndex - Return true if frame index for the variable
448 /// is found. Update FI to hold value of the index.
449 bool findVariableFrameIndex(const DbgVariable *V, int *FI);
451 /// findDbgScope - Find DbgScope for the debug loc.
452 DbgScope *findDbgScope(DebugLoc DL);
454 /// identifyScopeMarkers() - Indentify instructions that are marking
455 /// beginning of or end of a scope.
456 void identifyScopeMarkers();
458 /// extractScopeInformation - Scan machine instructions in this function
459 /// and collect DbgScopes. Return true, if atleast one scope was found.
460 bool extractScopeInformation();
462 /// addCurrentFnArgument - If Var is an current function argument that add
463 /// it in CurrentFnArguments list.
464 bool addCurrentFnArgument(const MachineFunction *MF,
465 DbgVariable *Var, DbgScope *Scope);
467 /// collectVariableInfo - Populate DbgScope entries with variables' info.
468 void collectVariableInfo(const MachineFunction *,
469 SmallPtrSet<const MDNode *, 16> &ProcessedVars);
471 /// collectVariableInfoFromMMITable - Collect variable information from
472 /// side table maintained by MMI.
473 void collectVariableInfoFromMMITable(const MachineFunction * MF,
474 SmallPtrSet<const MDNode *, 16> &P);
476 /// requestLabelBeforeInsn - Ensure that a label will be emitted before MI.
477 void requestLabelBeforeInsn(const MachineInstr *MI) {
478 LabelsBeforeInsn.insert(std::make_pair(MI, (MCSymbol*)0));
481 /// getLabelBeforeInsn - Return Label preceding the instruction.
482 const MCSymbol *getLabelBeforeInsn(const MachineInstr *MI);
484 /// requestLabelAfterInsn - Ensure that a label will be emitted after MI.
485 void requestLabelAfterInsn(const MachineInstr *MI) {
486 LabelsAfterInsn.insert(std::make_pair(MI, (MCSymbol*)0));
489 /// getLabelAfterInsn - Return Label immediately following the instruction.
490 const MCSymbol *getLabelAfterInsn(const MachineInstr *MI);
493 //===--------------------------------------------------------------------===//
494 // Main entry points.
496 DwarfDebug(AsmPrinter *A, Module *M);
499 /// beginModule - Emit all Dwarf sections that should come prior to the
501 void beginModule(Module *M);
503 /// endModule - Emit all Dwarf sections that should come after the content.
507 /// beginFunction - Gather pre-function debug information. Assumes being
508 /// emitted immediately after the function entry point.
509 void beginFunction(const MachineFunction *MF);
511 /// endFunction - Gather and emit post-function debug information.
513 void endFunction(const MachineFunction *MF);
515 /// beginInstruction - Process beginning of an instruction.
516 void beginInstruction(const MachineInstr *MI);
518 /// endInstruction - Prcess end of an instruction.
519 void endInstruction(const MachineInstr *MI);
521 /// GetOrCreateSourceID - Look up the source id with the given directory and
522 /// source file names. If none currently exists, create a new id and insert it
523 /// in the SourceIds map.
524 unsigned GetOrCreateSourceID(StringRef DirName, StringRef FullName);
526 /// createSubprogramDIE - Create new DIE using SP.
527 DIE *createSubprogramDIE(DISubprogram SP);
529 } // End of namespace llvm