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/LexicalScopes.h"
19 #include "llvm/MC/MachineLocation.h"
20 #include "llvm/Analysis/DebugInfo.h"
22 #include "llvm/ADT/DenseMap.h"
23 #include "llvm/ADT/FoldingSet.h"
24 #include "llvm/ADT/SmallPtrSet.h"
25 #include "llvm/ADT/StringMap.h"
26 #include "llvm/ADT/UniqueVector.h"
27 #include "llvm/Support/Allocator.h"
28 #include "llvm/Support/DebugLoc.h"
33 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 // Translate tag to proper Dwarf tag.
140 unsigned getTag() const {
141 if (Var.getTag() == dwarf::DW_TAG_arg_variable)
142 return dwarf::DW_TAG_formal_parameter;
144 return dwarf::DW_TAG_variable;
146 /// isArtificial - Return true if DbgVariable is artificial.
147 bool isArtificial() const {
148 if (Var.isArtificial())
150 if (Var.getTag() == dwarf::DW_TAG_arg_variable
151 && getType().isArtificial())
155 bool variableHasComplexAddress() const {
156 assert(Var.Verify() && "Invalid complex DbgVariable!");
157 return Var.hasComplexAddress();
159 bool isBlockByrefVariable() const {
160 assert(Var.Verify() && "Invalid complex DbgVariable!");
161 return Var.isBlockByrefVariable();
163 unsigned getNumAddrElements() const {
164 assert(Var.Verify() && "Invalid complex DbgVariable!");
165 return Var.getNumAddrElements();
167 uint64_t getAddrElement(unsigned i) const {
168 return Var.getAddrElement(i);
170 DIType getType() const;
174 /// Asm - Target of Dwarf emission.
177 /// MMI - Collected machine module information.
178 MachineModuleInfo *MMI;
180 //===--------------------------------------------------------------------===//
181 // Attributes used to construct specific Dwarf sections.
184 CompileUnit *FirstCU;
185 DenseMap <const MDNode *, CompileUnit *> CUMap;
187 /// AbbreviationsSet - Used to uniquely define abbreviations.
189 FoldingSet<DIEAbbrev> AbbreviationsSet;
191 /// Abbreviations - A list of all the unique abbreviations in use.
193 std::vector<DIEAbbrev *> Abbreviations;
195 /// SourceIdMap - Source id map, i.e. pair of directory id and source file
196 /// id mapped to a unique id.
197 StringMap<unsigned> SourceIdMap;
199 /// StringPool - A String->Symbol mapping of strings used by indirect
201 StringMap<std::pair<MCSymbol*, unsigned> > StringPool;
202 unsigned NextStringPoolNumber;
204 MCSymbol *getStringPoolEntry(StringRef Str);
206 /// SectionMap - Provides a unique id per text section.
208 UniqueVector<const MCSection*> SectionMap;
210 /// CurrentFnArguments - List of Arguments (DbgValues) for current function.
211 SmallVector<DbgVariable *, 8> CurrentFnArguments;
213 LexicalScopes LScopes;
215 /// AbstractSPDies - Collection of abstract subprogram DIEs.
216 DenseMap<const MDNode *, DIE *> AbstractSPDies;
218 /// ScopeVariables - Collection of dbg variables of a scope.
219 DenseMap<LexicalScope *, SmallVector<DbgVariable *, 8> > ScopeVariables;
221 /// AbstractVariables - Collection on abstract variables.
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 /// InlineInfo - Keep track of inlined functions and their location. This
248 /// information is used to populate debug_inlined section.
249 typedef std::pair<const MCSymbol *, DIE *> InlineInfoLabels;
250 DenseMap<const MDNode *, SmallVector<InlineInfoLabels, 4> > InlineInfo;
251 SmallVector<const MDNode *, 4> InlinedSPNodes;
253 // ProcessedSPNodes - This is a collection of subprogram MDNodes that
254 // are processed to create DIEs.
255 SmallPtrSet<const MDNode *, 16> ProcessedSPNodes;
257 /// LabelsBeforeInsn - Maps instruction with label emitted before
259 DenseMap<const MachineInstr *, MCSymbol *> LabelsBeforeInsn;
261 /// LabelsAfterInsn - Maps instruction with label emitted after
263 DenseMap<const MachineInstr *, MCSymbol *> LabelsAfterInsn;
265 /// UserVariables - Every user variable mentioned by a DBG_VALUE instruction
266 /// in order of appearance.
267 SmallVector<const MDNode*, 8> UserVariables;
269 /// DbgValues - For each user variable, keep a list of DBG_VALUE
270 /// instructions in order. The list can also contain normal instructions that
271 /// clobber the previous DBG_VALUE.
272 typedef DenseMap<const MDNode*, SmallVector<const MachineInstr*, 4> >
274 DbgValueHistoryMap DbgValues;
276 SmallVector<const MCSymbol *, 8> DebugRangeSymbols;
278 /// Previous instruction's location information. This is used to determine
279 /// label location to indicate scope boundries in dwarf debug info.
280 DebugLoc PrevInstLoc;
283 /// PrologEndLoc - This location indicates end of function prologue and
284 /// beginning of function body.
285 DebugLoc PrologEndLoc;
287 struct FunctionDebugFrameInfo {
289 std::vector<MachineMove> Moves;
291 FunctionDebugFrameInfo(unsigned Num, const std::vector<MachineMove> &M)
292 : Number(Num), Moves(M) {}
295 std::vector<FunctionDebugFrameInfo> DebugFrames;
297 // DIEValueAllocator - All DIEValues are allocated through this allocator.
298 BumpPtrAllocator DIEValueAllocator;
300 // Section Symbols: these are assembler temporary labels that are emitted at
301 // the beginning of each supported dwarf section. These are used to form
302 // section offsets and are created by EmitSectionLabels.
303 MCSymbol *DwarfInfoSectionSym, *DwarfAbbrevSectionSym;
304 MCSymbol *DwarfStrSectionSym, *TextSectionSym, *DwarfDebugRangeSectionSym;
305 MCSymbol *DwarfDebugLocSectionSym;
306 MCSymbol *FunctionBeginSym, *FunctionEndSym;
310 /// assignAbbrevNumber - Define a unique number for the abbreviation.
312 void assignAbbrevNumber(DIEAbbrev &Abbrev);
314 void addScopeVariable(LexicalScope *LS, DbgVariable *Var);
316 /// findAbstractVariable - Find abstract variable associated with Var.
317 DbgVariable *findAbstractVariable(DIVariable &Var, DebugLoc Loc);
319 /// updateSubprogramScopeDIE - Find DIE for the given subprogram and
320 /// attach appropriate DW_AT_low_pc and DW_AT_high_pc attributes.
321 /// If there are global variables in this scope then create and insert
322 /// DIEs for these variables.
323 DIE *updateSubprogramScopeDIE(const MDNode *SPNode);
325 /// constructLexicalScope - Construct new DW_TAG_lexical_block
326 /// for this scope and attach DW_AT_low_pc/DW_AT_high_pc labels.
327 DIE *constructLexicalScopeDIE(LexicalScope *Scope);
329 /// constructInlinedScopeDIE - This scope represents inlined body of
330 /// a function. Construct DIE to represent this concrete inlined copy
332 DIE *constructInlinedScopeDIE(LexicalScope *Scope);
334 /// constructVariableDIE - Construct a DIE for the given DbgVariable.
335 DIE *constructVariableDIE(DbgVariable *DV, LexicalScope *S);
337 /// constructScopeDIE - Construct a DIE for this scope.
338 DIE *constructScopeDIE(LexicalScope *Scope);
340 /// EmitSectionLabels - Emit initial Dwarf sections with a label at
341 /// the start of each one.
342 void EmitSectionLabels();
344 /// emitDIE - Recusively Emits a debug information entry.
346 void emitDIE(DIE *Die);
348 /// computeSizeAndOffset - Compute the size and offset of a DIE.
350 unsigned computeSizeAndOffset(DIE *Die, unsigned Offset, bool Last);
352 /// computeSizeAndOffsets - Compute the size and offset of all the DIEs.
354 void computeSizeAndOffsets();
356 /// EmitDebugInfo - Emit the debug info section.
358 void emitDebugInfo();
360 /// emitAbbreviations - Emit the abbreviation section.
362 void emitAbbreviations() const;
364 /// emitEndOfLineMatrix - Emit the last address of the section and the end of
367 void emitEndOfLineMatrix(unsigned SectionEnd);
369 /// emitDebugPubNames - Emit visible names into a debug pubnames section.
371 void emitDebugPubNames();
373 /// emitDebugPubTypes - Emit visible types into a debug pubtypes section.
375 void emitDebugPubTypes();
377 /// emitDebugStr - Emit visible names into a debug str section.
381 /// emitDebugLoc - Emit visible names into a debug loc section.
385 /// EmitDebugARanges - Emit visible names into a debug aranges section.
387 void EmitDebugARanges();
389 /// emitDebugRanges - Emit visible names into a debug ranges section.
391 void emitDebugRanges();
393 /// emitDebugMacInfo - Emit visible names into a debug macinfo section.
395 void emitDebugMacInfo();
397 /// emitDebugInlineInfo - Emit inline info using following format.
399 /// 1. length of section
400 /// 2. Dwarf version number
403 /// Entries (one "entry" for each function that was inlined):
405 /// 1. offset into __debug_str section for MIPS linkage name, if exists;
406 /// otherwise offset into __debug_str for regular function name.
407 /// 2. offset into __debug_str section for regular function name.
408 /// 3. an unsigned LEB128 number indicating the number of distinct inlining
409 /// instances for the function.
411 /// The rest of the entry consists of a {die_offset, low_pc} pair for each
412 /// inlined instance; the die_offset points to the inlined_subroutine die in
413 /// the __debug_info section, and the low_pc is the starting address for the
414 /// inlining instance.
415 void emitDebugInlineInfo();
417 /// constructCompileUnit - Create new CompileUnit for the given
418 /// metadata node with tag DW_TAG_compile_unit.
419 void constructCompileUnit(const MDNode *N);
421 /// getCompielUnit - Get CompileUnit DIE.
422 CompileUnit *getCompileUnit(const MDNode *N) const;
424 /// constructGlobalVariableDIE - Construct global variable DIE.
425 void constructGlobalVariableDIE(const MDNode *N);
427 /// construct SubprogramDIE - Construct subprogram DIE.
428 void constructSubprogramDIE(const MDNode *N);
430 /// recordSourceLine - Register a source line with debug info. Returns the
431 /// unique label that was emitted and which provides correspondence to
432 /// the source line list.
433 void recordSourceLine(unsigned Line, unsigned Col, const MDNode *Scope,
436 /// recordVariableFrameIndex - Record a variable's index.
437 void recordVariableFrameIndex(const DbgVariable *V, int Index);
439 /// findVariableFrameIndex - Return true if frame index for the variable
440 /// is found. Update FI to hold value of the index.
441 bool findVariableFrameIndex(const DbgVariable *V, int *FI);
443 /// identifyScopeMarkers() - Indentify instructions that are marking
444 /// beginning of or end of a scope.
445 void identifyScopeMarkers();
447 /// addCurrentFnArgument - If Var is an current function argument that add
448 /// it in CurrentFnArguments list.
449 bool addCurrentFnArgument(const MachineFunction *MF,
450 DbgVariable *Var, LexicalScope *Scope);
452 /// collectVariableInfo - Populate LexicalScope entries with variables' info.
453 void collectVariableInfo(const MachineFunction *,
454 SmallPtrSet<const MDNode *, 16> &ProcessedVars);
456 /// collectVariableInfoFromMMITable - Collect variable information from
457 /// side table maintained by MMI.
458 void collectVariableInfoFromMMITable(const MachineFunction * MF,
459 SmallPtrSet<const MDNode *, 16> &P);
461 /// requestLabelBeforeInsn - Ensure that a label will be emitted before MI.
462 void requestLabelBeforeInsn(const MachineInstr *MI) {
463 LabelsBeforeInsn.insert(std::make_pair(MI, (MCSymbol*)0));
466 /// getLabelBeforeInsn - Return Label preceding the instruction.
467 const MCSymbol *getLabelBeforeInsn(const MachineInstr *MI);
469 /// requestLabelAfterInsn - Ensure that a label will be emitted after MI.
470 void requestLabelAfterInsn(const MachineInstr *MI) {
471 LabelsAfterInsn.insert(std::make_pair(MI, (MCSymbol*)0));
474 /// getLabelAfterInsn - Return Label immediately following the instruction.
475 const MCSymbol *getLabelAfterInsn(const MachineInstr *MI);
478 //===--------------------------------------------------------------------===//
479 // Main entry points.
481 DwarfDebug(AsmPrinter *A, Module *M);
484 /// beginModule - Emit all Dwarf sections that should come prior to the
486 void beginModule(Module *M);
488 /// endModule - Emit all Dwarf sections that should come after the content.
492 /// beginFunction - Gather pre-function debug information. Assumes being
493 /// emitted immediately after the function entry point.
494 void beginFunction(const MachineFunction *MF);
496 /// endFunction - Gather and emit post-function debug information.
498 void endFunction(const MachineFunction *MF);
500 /// beginInstruction - Process beginning of an instruction.
501 void beginInstruction(const MachineInstr *MI);
503 /// endInstruction - Prcess end of an instruction.
504 void endInstruction(const MachineInstr *MI);
506 /// GetOrCreateSourceID - Look up the source id with the given directory and
507 /// source file names. If none currently exists, create a new id and insert it
508 /// in the SourceIds map.
509 unsigned GetOrCreateSourceID(StringRef DirName, StringRef FullName);
511 /// createSubprogramDIE - Create new DIE using SP.
512 DIE *createSubprogramDIE(DISubprogram SP);
514 } // End of namespace llvm