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"
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.
128 DbgVariable *AbsVar; // Corresponding Abstract variable, if any.
129 const MachineInstr *MInsn; // DBG_VALUE instruction of the variable.
132 // AbsVar may be NULL.
133 DbgVariable(DIVariable V, DbgVariable *AV)
134 : Var(V), TheDIE(0), DotDebugLocOffset(~0U), AbsVar(AV), MInsn(0),
138 DIVariable getVariable() const { return Var; }
139 void setDIE(DIE *D) { TheDIE = D; }
140 DIE *getDIE() const { return TheDIE; }
141 void setDotDebugLocOffset(unsigned O) { DotDebugLocOffset = O; }
142 unsigned getDotDebugLocOffset() const { return DotDebugLocOffset; }
143 StringRef getName() const { return Var.getName(); }
144 DbgVariable *getAbstractVariable() const { return AbsVar; }
145 const MachineInstr *getMInsn() const { return MInsn; }
146 void setMInsn(const MachineInstr *M) { MInsn = M; }
147 int getFrameIndex() const { return FrameIndex; }
148 void setFrameIndex(int FI) { FrameIndex = FI; }
149 // Translate tag to proper Dwarf tag.
150 unsigned getTag() const {
151 if (Var.getTag() == dwarf::DW_TAG_arg_variable)
152 return dwarf::DW_TAG_formal_parameter;
154 return dwarf::DW_TAG_variable;
156 /// isArtificial - Return true if DbgVariable is artificial.
157 bool isArtificial() const {
158 if (Var.isArtificial())
160 if (Var.getTag() == dwarf::DW_TAG_arg_variable
161 && getType().isArtificial())
165 bool variableHasComplexAddress() const {
166 assert(Var.Verify() && "Invalid complex DbgVariable!");
167 return Var.hasComplexAddress();
169 bool isBlockByrefVariable() const {
170 assert(Var.Verify() && "Invalid complex DbgVariable!");
171 return Var.isBlockByrefVariable();
173 unsigned getNumAddrElements() const {
174 assert(Var.Verify() && "Invalid complex DbgVariable!");
175 return Var.getNumAddrElements();
177 uint64_t getAddrElement(unsigned i) const {
178 return Var.getAddrElement(i);
180 DIType getType() const;
184 /// Asm - Target of Dwarf emission.
187 /// MMI - Collected machine module information.
188 MachineModuleInfo *MMI;
190 //===--------------------------------------------------------------------===//
191 // Attributes used to construct specific Dwarf sections.
194 CompileUnit *FirstCU;
196 /// Maps MDNode with its corresponding CompileUnit.
197 DenseMap <const MDNode *, CompileUnit *> CUMap;
199 /// Maps subprogram MDNode with its corresponding CompileUnit.
200 DenseMap <const MDNode *, CompileUnit *> SPMap;
202 /// AbbreviationsSet - Used to uniquely define abbreviations.
204 FoldingSet<DIEAbbrev> AbbreviationsSet;
206 /// Abbreviations - A list of all the unique abbreviations in use.
208 std::vector<DIEAbbrev *> Abbreviations;
210 /// SourceIdMap - Source id map, i.e. pair of source filename and directory
211 /// mapped to a unique id.
212 std::map<std::pair<std::string, std::string>, unsigned> SourceIdMap;
214 /// StringPool - A String->Symbol mapping of strings used by indirect
216 StringMap<std::pair<MCSymbol*, unsigned> > StringPool;
217 unsigned NextStringPoolNumber;
219 /// SectionMap - Provides a unique id per text section.
221 UniqueVector<const MCSection*> SectionMap;
223 /// CurrentFnArguments - List of Arguments (DbgValues) for current function.
224 SmallVector<DbgVariable *, 8> CurrentFnArguments;
226 LexicalScopes LScopes;
228 /// AbstractSPDies - Collection of abstract subprogram DIEs.
229 DenseMap<const MDNode *, DIE *> AbstractSPDies;
231 /// ScopeVariables - Collection of dbg variables of a scope.
232 DenseMap<LexicalScope *, SmallVector<DbgVariable *, 8> > ScopeVariables;
234 /// AbstractVariables - Collection on abstract variables.
235 DenseMap<const MDNode *, DbgVariable *> AbstractVariables;
237 /// DotDebugLocEntries - Collection of DotDebugLocEntry.
238 SmallVector<DotDebugLocEntry, 4> DotDebugLocEntries;
240 /// InlinedSubprogramDIEs - Collection of subprogram DIEs that are marked
241 /// (at the end of the module) as DW_AT_inline.
242 SmallPtrSet<DIE *, 4> InlinedSubprogramDIEs;
244 /// InlineInfo - Keep track of inlined functions and their location. This
245 /// information is used to populate debug_inlined section.
246 typedef std::pair<const MCSymbol *, DIE *> InlineInfoLabels;
247 DenseMap<const MDNode *, SmallVector<InlineInfoLabels, 4> > InlineInfo;
248 SmallVector<const MDNode *, 4> InlinedSPNodes;
250 // ProcessedSPNodes - This is a collection of subprogram MDNodes that
251 // are processed to create DIEs.
252 SmallPtrSet<const MDNode *, 16> ProcessedSPNodes;
254 /// LabelsBeforeInsn - Maps instruction with label emitted before
256 DenseMap<const MachineInstr *, MCSymbol *> LabelsBeforeInsn;
258 /// LabelsAfterInsn - Maps instruction with label emitted after
260 DenseMap<const MachineInstr *, MCSymbol *> LabelsAfterInsn;
262 /// UserVariables - Every user variable mentioned by a DBG_VALUE instruction
263 /// in order of appearance.
264 SmallVector<const MDNode*, 8> UserVariables;
266 /// DbgValues - For each user variable, keep a list of DBG_VALUE
267 /// instructions in order. The list can also contain normal instructions that
268 /// clobber the previous DBG_VALUE.
269 typedef DenseMap<const MDNode*, SmallVector<const MachineInstr*, 4> >
271 DbgValueHistoryMap DbgValues;
273 SmallVector<const MCSymbol *, 8> DebugRangeSymbols;
275 /// Previous instruction's location information. This is used to determine
276 /// label location to indicate scope boundries in dwarf debug info.
277 DebugLoc PrevInstLoc;
280 /// PrologEndLoc - This location indicates end of function prologue and
281 /// beginning of function body.
282 DebugLoc PrologEndLoc;
284 struct FunctionDebugFrameInfo {
286 std::vector<MachineMove> Moves;
288 FunctionDebugFrameInfo(unsigned Num, const std::vector<MachineMove> &M)
289 : Number(Num), Moves(M) {}
292 std::vector<FunctionDebugFrameInfo> DebugFrames;
294 // DIEValueAllocator - All DIEValues are allocated through this allocator.
295 BumpPtrAllocator DIEValueAllocator;
297 // Section Symbols: these are assembler temporary labels that are emitted at
298 // the beginning of each supported dwarf section. These are used to form
299 // section offsets and are created by EmitSectionLabels.
300 MCSymbol *DwarfInfoSectionSym, *DwarfAbbrevSectionSym;
301 MCSymbol *DwarfStrSectionSym, *TextSectionSym, *DwarfDebugRangeSectionSym;
302 MCSymbol *DwarfDebugLocSectionSym;
303 MCSymbol *FunctionBeginSym, *FunctionEndSym;
305 // As an optimization, there is no need to emit an entry in the directory
306 // table for the same directory as DW_at_comp_dir.
307 StringRef CompilationDir;
311 /// assignAbbrevNumber - Define a unique number for the abbreviation.
313 void assignAbbrevNumber(DIEAbbrev &Abbrev);
315 void addScopeVariable(LexicalScope *LS, DbgVariable *Var);
317 /// findAbstractVariable - Find abstract variable associated with Var.
318 DbgVariable *findAbstractVariable(DIVariable &Var, DebugLoc Loc);
320 /// updateSubprogramScopeDIE - Find DIE for the given subprogram and
321 /// attach appropriate DW_AT_low_pc and DW_AT_high_pc attributes.
322 /// If there are global variables in this scope then create and insert
323 /// DIEs for these variables.
324 DIE *updateSubprogramScopeDIE(CompileUnit *SPCU, const MDNode *SPNode);
326 /// constructLexicalScope - Construct new DW_TAG_lexical_block
327 /// for this scope and attach DW_AT_low_pc/DW_AT_high_pc labels.
328 DIE *constructLexicalScopeDIE(CompileUnit *TheCU, LexicalScope *Scope);
330 /// constructInlinedScopeDIE - This scope represents inlined body of
331 /// a function. Construct DIE to represent this concrete inlined copy
333 DIE *constructInlinedScopeDIE(CompileUnit *TheCU, LexicalScope *Scope);
335 /// constructVariableDIE - Construct a DIE for the given DbgVariable.
336 DIE *constructVariableDIE(DbgVariable *DV, LexicalScope *S);
338 /// constructScopeDIE - Construct a DIE for this scope.
339 DIE *constructScopeDIE(CompileUnit *TheCU, LexicalScope *Scope);
341 /// EmitSectionLabels - Emit initial Dwarf sections with a label at
342 /// the start of each one.
343 void EmitSectionLabels();
345 /// emitDIE - Recursively Emits a debug information entry.
347 void emitDIE(DIE *Die);
349 /// computeSizeAndOffset - Compute the size and offset of a DIE.
351 unsigned computeSizeAndOffset(DIE *Die, unsigned Offset, bool Last);
353 /// computeSizeAndOffsets - Compute the size and offset of all the DIEs.
355 void computeSizeAndOffsets();
357 /// EmitDebugInfo - Emit the debug info section.
359 void emitDebugInfo();
361 /// emitAbbreviations - Emit the abbreviation section.
363 void emitAbbreviations() const;
365 /// emitEndOfLineMatrix - Emit the last address of the section and the end of
368 void emitEndOfLineMatrix(unsigned SectionEnd);
370 /// emitAccelNames - Emit visible names into a hashed accelerator table
372 void emitAccelNames();
374 /// emitAccelObjC - Emit objective C classes and categories into a hashed
375 /// accelerator table section.
376 void emitAccelObjC();
378 /// emitAccelNamespace - Emit namespace dies into a hashed accelerator
380 void emitAccelNamespaces();
382 /// emitAccelTypes() - Emit type dies into a hashed accelerator table.
384 void emitAccelTypes();
386 /// emitDebugPubTypes - Emit visible types into a debug pubtypes section.
388 void emitDebugPubTypes();
390 /// emitDebugStr - Emit visible names into a debug str section.
394 /// emitDebugLoc - Emit visible names into a debug loc section.
398 /// EmitDebugARanges - Emit visible names into a debug aranges section.
400 void EmitDebugARanges();
402 /// emitDebugRanges - Emit visible names into a debug ranges section.
404 void emitDebugRanges();
406 /// emitDebugMacInfo - Emit visible names into a debug macinfo section.
408 void emitDebugMacInfo();
410 /// emitDebugInlineInfo - Emit inline info using following format.
412 /// 1. length of section
413 /// 2. Dwarf version number
416 /// Entries (one "entry" for each function that was inlined):
418 /// 1. offset into __debug_str section for MIPS linkage name, if exists;
419 /// otherwise offset into __debug_str for regular function name.
420 /// 2. offset into __debug_str section for regular function name.
421 /// 3. an unsigned LEB128 number indicating the number of distinct inlining
422 /// instances for the function.
424 /// The rest of the entry consists of a {die_offset, low_pc} pair for each
425 /// inlined instance; the die_offset points to the inlined_subroutine die in
426 /// the __debug_info section, and the low_pc is the starting address for the
427 /// inlining instance.
428 void emitDebugInlineInfo();
430 /// constructCompileUnit - Create new CompileUnit for the given
431 /// metadata node with tag DW_TAG_compile_unit.
432 CompileUnit *constructCompileUnit(const MDNode *N);
434 /// construct SubprogramDIE - Construct subprogram DIE.
435 void constructSubprogramDIE(CompileUnit *TheCU, const MDNode *N);
437 /// recordSourceLine - Register a source line with debug info. Returns the
438 /// unique label that was emitted and which provides correspondence to
439 /// the source line list.
440 void recordSourceLine(unsigned Line, unsigned Col, const MDNode *Scope,
443 /// identifyScopeMarkers() - Indentify instructions that are marking the
444 /// beginning of or ending 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 /// collectInfoFromNamedMDNodes - Collect debug info from named mdnodes such
485 /// as llvm.dbg.enum and llvm.dbg.ty
486 void collectInfoFromNamedMDNodes(Module *M);
488 /// collectLegacyDebugInfo - Collect debug info using DebugInfoFinder.
489 /// FIXME - Remove this when DragonEgg switches to DIBuilder.
490 bool collectLegacyDebugInfo(Module *M);
492 /// beginModule - Emit all Dwarf sections that should come prior to the
494 void beginModule(Module *M);
496 /// endModule - Emit all Dwarf sections that should come after the content.
500 /// beginFunction - Gather pre-function debug information. Assumes being
501 /// emitted immediately after the function entry point.
502 void beginFunction(const MachineFunction *MF);
504 /// endFunction - Gather and emit post-function debug information.
506 void endFunction(const MachineFunction *MF);
508 /// beginInstruction - Process beginning of an instruction.
509 void beginInstruction(const MachineInstr *MI);
511 /// endInstruction - Prcess end of an instruction.
512 void endInstruction(const MachineInstr *MI);
514 /// GetOrCreateSourceID - Look up the source id with the given directory and
515 /// source file names. If none currently exists, create a new id and insert it
516 /// in the SourceIds map.
517 unsigned GetOrCreateSourceID(StringRef DirName, StringRef FullName);
519 /// createSubprogramDIE - Create new DIE using SP.
520 DIE *createSubprogramDIE(DISubprogram SP);
522 /// getStringPool - returns the entry into the start of the pool.
523 MCSymbol *getStringPool();
525 /// getStringPoolEntry - returns an entry into the string pool with the given
527 MCSymbol *getStringPoolEntry(StringRef Str);
529 } // End of namespace llvm