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;
71 DotDebugLocEntry() : Begin(0), End(0), Variable(0), Merged(false) {}
72 DotDebugLocEntry(const MCSymbol *B, const MCSymbol *E, MachineLocation &L,
74 : Begin(B), End(E), Loc(L), Variable(V), Merged(false) {}
75 /// Empty entries are also used as a trigger to emit temp label. Such
76 /// labels are referenced is used to find debug_loc offset for a given DIE.
77 bool isEmpty() { return Begin == 0 && End == 0; }
78 bool isMerged() { return Merged; }
79 void Merge(DotDebugLocEntry *Next) {
80 if (!(Begin && Loc == Next->Loc && End == Next->Begin))
87 //===----------------------------------------------------------------------===//
88 /// DbgVariable - This class is used to track local variable information.
91 DIVariable Var; // Variable Descriptor.
92 DIE *TheDIE; // Variable DIE.
93 unsigned DotDebugLocOffset; // Offset in DotDebugLocEntries.
95 // AbsVar may be NULL.
96 DbgVariable(DIVariable V) : Var(V), TheDIE(0), DotDebugLocOffset(~0U) {}
99 DIVariable getVariable() const { return Var; }
100 void setDIE(DIE *D) { TheDIE = D; }
101 DIE *getDIE() const { return TheDIE; }
102 void setDotDebugLocOffset(unsigned O) { DotDebugLocOffset = O; }
103 unsigned getDotDebugLocOffset() const { return DotDebugLocOffset; }
104 StringRef getName() const { return Var.getName(); }
105 unsigned getTag() const { return Var.getTag(); }
106 bool variableHasComplexAddress() const {
107 assert(Var.Verify() && "Invalid complex DbgVariable!");
108 return Var.hasComplexAddress();
110 bool isBlockByrefVariable() const {
111 assert(Var.Verify() && "Invalid complex DbgVariable!");
112 return Var.isBlockByrefVariable();
114 unsigned getNumAddrElements() const {
115 assert(Var.Verify() && "Invalid complex DbgVariable!");
116 return Var.getNumAddrElements();
118 uint64_t getAddrElement(unsigned i) const {
119 return Var.getAddrElement(i);
121 DIType getType() const;
125 /// Asm - Target of Dwarf emission.
128 /// MMI - Collected machine module information.
129 MachineModuleInfo *MMI;
131 //===--------------------------------------------------------------------===//
132 // Attributes used to construct specific Dwarf sections.
135 CompileUnit *FirstCU;
136 DenseMap <const MDNode *, CompileUnit *> CUMap;
138 /// AbbreviationsSet - Used to uniquely define abbreviations.
140 FoldingSet<DIEAbbrev> AbbreviationsSet;
142 /// Abbreviations - A list of all the unique abbreviations in use.
144 std::vector<DIEAbbrev *> Abbreviations;
146 /// SourceIdMap - Source id map, i.e. pair of directory id and source file
147 /// id mapped to a unique id.
148 StringMap<unsigned> SourceIdMap;
150 /// StringPool - A String->Symbol mapping of strings used by indirect
152 StringMap<std::pair<MCSymbol*, unsigned> > StringPool;
153 unsigned NextStringPoolNumber;
155 MCSymbol *getStringPoolEntry(StringRef Str);
157 /// SectionMap - Provides a unique id per text section.
159 UniqueVector<const MCSection*> SectionMap;
161 /// CurrentFnDbgScope - Top level scope for the current function.
163 DbgScope *CurrentFnDbgScope;
165 /// CurrentFnArguments - List of Arguments (DbgValues) for current function.
166 SmallVector<DbgVariable *, 8> CurrentFnArguments;
168 /// DbgScopeMap - Tracks the scopes in the current function. Owns the
169 /// contained DbgScope*s.
171 DenseMap<const MDNode *, DbgScope *> DbgScopeMap;
173 /// ConcreteScopes - Tracks the concrete scopees in the current function.
174 /// These scopes are also included in DbgScopeMap.
175 DenseMap<const MDNode *, DbgScope *> ConcreteScopes;
177 /// AbstractScopes - Tracks the abstract scopes a module. These scopes are
178 /// not included DbgScopeMap. AbstractScopes owns its DbgScope*s.
179 DenseMap<const MDNode *, DbgScope *> AbstractScopes;
181 /// AbstractSPDies - Collection of abstract subprogram DIEs.
182 DenseMap<const MDNode *, DIE *> AbstractSPDies;
184 /// AbstractScopesList - Tracks abstract scopes constructed while processing
185 /// a function. This list is cleared during endFunction().
186 SmallVector<DbgScope *, 4>AbstractScopesList;
188 /// AbstractVariables - Collection on abstract variables. Owned by the
189 /// DbgScopes in AbstractScopes.
190 DenseMap<const MDNode *, DbgVariable *> AbstractVariables;
192 /// DbgVariableToFrameIndexMap - Tracks frame index used to find
193 /// variable's value.
194 DenseMap<const DbgVariable *, int> DbgVariableToFrameIndexMap;
196 /// DbgVariableToDbgInstMap - Maps DbgVariable to corresponding DBG_VALUE
197 /// machine instruction.
198 DenseMap<const DbgVariable *, const MachineInstr *> DbgVariableToDbgInstMap;
200 /// DotDebugLocEntries - Collection of DotDebugLocEntry.
201 SmallVector<DotDebugLocEntry, 4> DotDebugLocEntries;
203 /// UseDotDebugLocEntry - DW_AT_location attributes for the DIEs in this set
204 /// idetifies corresponding .debug_loc entry offset.
205 SmallPtrSet<const DIE *, 4> UseDotDebugLocEntry;
207 /// VarToAbstractVarMap - Maps DbgVariable with corresponding Abstract
208 /// DbgVariable, if any.
209 DenseMap<const DbgVariable *, const DbgVariable *> VarToAbstractVarMap;
211 /// InliendSubprogramDIEs - Collection of subprgram DIEs that are marked
212 /// (at the end of the module) as DW_AT_inline.
213 SmallPtrSet<DIE *, 4> InlinedSubprogramDIEs;
215 /// ContainingTypeMap - This map is used to keep track of subprogram DIEs that
216 /// need DW_AT_containing_type attribute. This attribute points to a DIE that
217 /// corresponds to the MDNode mapped with the subprogram DIE.
218 DenseMap<DIE *, const MDNode *> ContainingTypeMap;
220 /// InlineInfo - Keep track of inlined functions and their location. This
221 /// information is used to populate debug_inlined section.
222 typedef std::pair<const MCSymbol *, DIE *> InlineInfoLabels;
223 DenseMap<const MDNode *, SmallVector<InlineInfoLabels, 4> > InlineInfo;
224 SmallVector<const MDNode *, 4> InlinedSPNodes;
226 // ProcessedSPNodes - This is a collection of subprogram MDNodes that
227 // are processed to create DIEs.
228 SmallPtrSet<const MDNode *, 16> ProcessedSPNodes;
230 /// LabelsBeforeInsn - Maps instruction with label emitted before
232 DenseMap<const MachineInstr *, MCSymbol *> LabelsBeforeInsn;
234 /// LabelsAfterInsn - Maps instruction with label emitted after
236 DenseMap<const MachineInstr *, MCSymbol *> LabelsAfterInsn;
238 /// UserVariables - Every user variable mentioned by a DBG_VALUE instruction
239 /// in order of appearance.
240 SmallVector<const MDNode*, 8> UserVariables;
242 /// DbgValues - For each user variable, keep a list of DBG_VALUE
243 /// instructions in order. The list can also contain normal instructions that
244 /// clobber the previous DBG_VALUE.
245 typedef DenseMap<const MDNode*, SmallVector<const MachineInstr*, 4> >
247 DbgValueHistoryMap DbgValues;
249 SmallVector<const MCSymbol *, 8> DebugRangeSymbols;
251 /// Previous instruction's location information. This is used to determine
252 /// label location to indicate scope boundries in dwarf debug info.
253 DebugLoc PrevInstLoc;
256 /// PrologEndLoc - This location indicates end of function prologue and
257 /// beginning of function body.
258 DebugLoc PrologEndLoc;
260 struct FunctionDebugFrameInfo {
262 std::vector<MachineMove> Moves;
264 FunctionDebugFrameInfo(unsigned Num, const std::vector<MachineMove> &M)
265 : Number(Num), Moves(M) {}
268 std::vector<FunctionDebugFrameInfo> DebugFrames;
270 // DIEValueAllocator - All DIEValues are allocated through this allocator.
271 BumpPtrAllocator DIEValueAllocator;
273 // Section Symbols: these are assembler temporary labels that are emitted at
274 // the beginning of each supported dwarf section. These are used to form
275 // section offsets and are created by EmitSectionLabels.
276 MCSymbol *DwarfInfoSectionSym, *DwarfAbbrevSectionSym;
277 MCSymbol *DwarfStrSectionSym, *TextSectionSym, *DwarfDebugRangeSectionSym;
278 MCSymbol *DwarfDebugLocSectionSym;
279 MCSymbol *FunctionBeginSym, *FunctionEndSym;
283 /// assignAbbrevNumber - Define a unique number for the abbreviation.
285 void assignAbbrevNumber(DIEAbbrev &Abbrev);
287 /// getOrCreateDbgScope - Create DbgScope for the scope.
288 DbgScope *getOrCreateDbgScope(const MDNode *Scope, const MDNode *InlinedAt);
290 DbgScope *getOrCreateAbstractScope(const MDNode *N);
292 /// findAbstractVariable - Find abstract variable associated with Var.
293 DbgVariable *findAbstractVariable(DIVariable &Var, DebugLoc Loc);
295 /// updateSubprogramScopeDIE - Find DIE for the given subprogram and
296 /// attach appropriate DW_AT_low_pc and DW_AT_high_pc attributes.
297 /// If there are global variables in this scope then create and insert
298 /// DIEs for these variables.
299 DIE *updateSubprogramScopeDIE(const MDNode *SPNode);
301 /// constructLexicalScope - Construct new DW_TAG_lexical_block
302 /// for this scope and attach DW_AT_low_pc/DW_AT_high_pc labels.
303 DIE *constructLexicalScopeDIE(DbgScope *Scope);
305 /// constructInlinedScopeDIE - This scope represents inlined body of
306 /// a function. Construct DIE to represent this concrete inlined copy
308 DIE *constructInlinedScopeDIE(DbgScope *Scope);
310 /// constructVariableDIE - Construct a DIE for the given DbgVariable.
311 DIE *constructVariableDIE(DbgVariable *DV, DbgScope *S);
313 /// constructScopeDIE - Construct a DIE for this scope.
314 DIE *constructScopeDIE(DbgScope *Scope);
316 /// EmitSectionLabels - Emit initial Dwarf sections with a label at
317 /// the start of each one.
318 void EmitSectionLabels();
320 /// emitDIE - Recusively Emits a debug information entry.
322 void emitDIE(DIE *Die);
324 /// computeSizeAndOffset - Compute the size and offset of a DIE.
326 unsigned computeSizeAndOffset(DIE *Die, unsigned Offset, bool Last);
328 /// computeSizeAndOffsets - Compute the size and offset of all the DIEs.
330 void computeSizeAndOffsets();
332 /// EmitDebugInfo - Emit the debug info section.
334 void emitDebugInfo();
336 /// emitAbbreviations - Emit the abbreviation section.
338 void emitAbbreviations() const;
340 /// emitEndOfLineMatrix - Emit the last address of the section and the end of
343 void emitEndOfLineMatrix(unsigned SectionEnd);
345 /// emitDebugPubNames - Emit visible names into a debug pubnames section.
347 void emitDebugPubNames();
349 /// emitDebugPubTypes - Emit visible types into a debug pubtypes section.
351 void emitDebugPubTypes();
353 /// emitDebugStr - Emit visible names into a debug str section.
357 /// emitDebugLoc - Emit visible names into a debug loc section.
361 /// EmitDebugARanges - Emit visible names into a debug aranges section.
363 void EmitDebugARanges();
365 /// emitDebugRanges - Emit visible names into a debug ranges section.
367 void emitDebugRanges();
369 /// emitDebugMacInfo - Emit visible names into a debug macinfo section.
371 void emitDebugMacInfo();
373 /// emitDebugInlineInfo - Emit inline info using following format.
375 /// 1. length of section
376 /// 2. Dwarf version number
379 /// Entries (one "entry" for each function that was inlined):
381 /// 1. offset into __debug_str section for MIPS linkage name, if exists;
382 /// otherwise offset into __debug_str for regular function name.
383 /// 2. offset into __debug_str section for regular function name.
384 /// 3. an unsigned LEB128 number indicating the number of distinct inlining
385 /// instances for the function.
387 /// The rest of the entry consists of a {die_offset, low_pc} pair for each
388 /// inlined instance; the die_offset points to the inlined_subroutine die in
389 /// the __debug_info section, and the low_pc is the starting address for the
390 /// inlining instance.
391 void emitDebugInlineInfo();
393 /// constructCompileUnit - Create new CompileUnit for the given
394 /// metadata node with tag DW_TAG_compile_unit.
395 void constructCompileUnit(const MDNode *N);
397 /// getCompielUnit - Get CompileUnit DIE.
398 CompileUnit *getCompileUnit(const MDNode *N) const;
400 /// constructGlobalVariableDIE - Construct global variable DIE.
401 void constructGlobalVariableDIE(const MDNode *N);
403 /// construct SubprogramDIE - Construct subprogram DIE.
404 void constructSubprogramDIE(const MDNode *N);
406 /// recordSourceLine - Register a source line with debug info. Returns the
407 /// unique label that was emitted and which provides correspondence to
408 /// the source line list.
409 void recordSourceLine(unsigned Line, unsigned Col, const MDNode *Scope,
412 /// recordVariableFrameIndex - Record a variable's index.
413 void recordVariableFrameIndex(const DbgVariable *V, int Index);
415 /// findVariableFrameIndex - Return true if frame index for the variable
416 /// is found. Update FI to hold value of the index.
417 bool findVariableFrameIndex(const DbgVariable *V, int *FI);
419 /// findDbgScope - Find DbgScope for the debug loc attached with an
421 DbgScope *findDbgScope(const MachineInstr *MI);
423 /// identifyScopeMarkers() - Indentify instructions that are marking
424 /// beginning of or end of a scope.
425 void identifyScopeMarkers();
427 /// extractScopeInformation - Scan machine instructions in this function
428 /// and collect DbgScopes. Return true, if atleast one scope was found.
429 bool extractScopeInformation();
431 /// addCurrentFnArgument - If Var is an current function argument that add
432 /// it in CurrentFnArguments list.
433 bool addCurrentFnArgument(const MachineFunction *MF,
434 DbgVariable *Var, DbgScope *Scope);
436 /// collectVariableInfo - Populate DbgScope entries with variables' info.
437 void collectVariableInfo(const MachineFunction *,
438 SmallPtrSet<const MDNode *, 16> &ProcessedVars);
440 /// collectVariableInfoFromMMITable - Collect variable information from
441 /// side table maintained by MMI.
442 void collectVariableInfoFromMMITable(const MachineFunction * MF,
443 SmallPtrSet<const MDNode *, 16> &P);
445 /// requestLabelBeforeInsn - Ensure that a label will be emitted before MI.
446 void requestLabelBeforeInsn(const MachineInstr *MI) {
447 LabelsBeforeInsn.insert(std::make_pair(MI, (MCSymbol*)0));
450 /// getLabelBeforeInsn - Return Label preceding the instruction.
451 const MCSymbol *getLabelBeforeInsn(const MachineInstr *MI);
453 /// requestLabelAfterInsn - Ensure that a label will be emitted after MI.
454 void requestLabelAfterInsn(const MachineInstr *MI) {
455 LabelsAfterInsn.insert(std::make_pair(MI, (MCSymbol*)0));
458 /// getLabelAfterInsn - Return Label immediately following the instruction.
459 const MCSymbol *getLabelAfterInsn(const MachineInstr *MI);
462 //===--------------------------------------------------------------------===//
463 // Main entry points.
465 DwarfDebug(AsmPrinter *A, Module *M);
468 /// beginModule - Emit all Dwarf sections that should come prior to the
470 void beginModule(Module *M);
472 /// endModule - Emit all Dwarf sections that should come after the content.
476 /// beginFunction - Gather pre-function debug information. Assumes being
477 /// emitted immediately after the function entry point.
478 void beginFunction(const MachineFunction *MF);
480 /// endFunction - Gather and emit post-function debug information.
482 void endFunction(const MachineFunction *MF);
484 /// beginInstruction - Process beginning of an instruction.
485 void beginInstruction(const MachineInstr *MI);
487 /// endInstruction - Prcess end of an instruction.
488 void endInstruction(const MachineInstr *MI);
490 /// GetOrCreateSourceID - Look up the source id with the given directory and
491 /// source file names. If none currently exists, create a new id and insert it
492 /// in the SourceIds map.
493 unsigned GetOrCreateSourceID(StringRef DirName, StringRef FullName);
495 /// createSubprogramDIE - Create new DIE using SP.
496 DIE *createSubprogramDIE(DISubprogram SP);
498 } // End of namespace llvm