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"
20 #include "llvm/ADT/DenseMap.h"
21 #include "llvm/ADT/FoldingSet.h"
22 #include "llvm/ADT/SmallPtrSet.h"
23 #include "llvm/ADT/StringMap.h"
24 #include "llvm/ADT/UniqueVector.h"
25 #include "llvm/Support/Allocator.h"
26 #include "llvm/Support/DebugLoc.h"
31 class DbgConcreteScope;
34 class MachineFrameInfo;
35 class MachineModuleInfo;
47 class DIGlobalVariable;
54 class DICompositeType;
55 class DITemplateTypeParameter;
56 class DITemplateValueParameter;
58 //===----------------------------------------------------------------------===//
59 /// SrcLineInfo - This class is used to record source line correspondence.
62 unsigned Line; // Source line number.
63 unsigned Column; // Source column.
64 unsigned SourceID; // Source ID number.
65 MCSymbol *Label; // Label in code ID number.
67 SrcLineInfo(unsigned L, unsigned C, unsigned S, MCSymbol *label)
68 : Line(L), Column(C), SourceID(S), Label(label) {}
71 unsigned getLine() const { return Line; }
72 unsigned getColumn() const { return Column; }
73 unsigned getSourceID() const { return SourceID; }
74 MCSymbol *getLabel() const { return Label; }
77 /// DotDebugLocEntry - This struct describes location entries emitted in
78 /// .debug_loc section.
79 typedef struct DotDebugLocEntry {
80 const MCSymbol *Begin;
84 DotDebugLocEntry() : Begin(0), End(0), Merged(false) {}
85 DotDebugLocEntry(const MCSymbol *B, const MCSymbol *E, MachineLocation &L)
86 : Begin(B), End(E), Loc(L), Merged(false) {}
87 /// Empty entries are also used as a trigger to emit temp label. Such
88 /// labels are referenced is used to find debug_loc offset for a given DIE.
89 bool isEmpty() { return Begin == 0 && End == 0; }
90 bool isMerged() { return Merged; }
91 void Merge(DotDebugLocEntry *Next) {
92 if (!(Begin && Loc == Next->Loc && End == Next->Begin))
100 /// Asm - Target of Dwarf emission.
103 /// MMI - Collected machine module information.
104 MachineModuleInfo *MMI;
106 //===--------------------------------------------------------------------===//
107 // Attributes used to construct specific Dwarf sections.
110 CompileUnit *FirstCU;
111 DenseMap <const MDNode *, CompileUnit *> CUMap;
113 /// AbbreviationsSet - Used to uniquely define abbreviations.
115 FoldingSet<DIEAbbrev> AbbreviationsSet;
117 /// Abbreviations - A list of all the unique abbreviations in use.
119 std::vector<DIEAbbrev *> Abbreviations;
121 /// SourceIdMap - Source id map, i.e. pair of directory id and source file
122 /// id mapped to a unique id.
123 StringMap<unsigned> SourceIdMap;
125 /// DIEBlocks - A list of all the DIEBlocks in use.
126 std::vector<DIEBlock *> DIEBlocks;
128 // DIEValueAllocator - All DIEValues are allocated through this allocator.
129 BumpPtrAllocator DIEValueAllocator;
131 /// StringPool - A String->Symbol mapping of strings used by indirect
133 StringMap<std::pair<MCSymbol*, unsigned> > StringPool;
134 unsigned NextStringPoolNumber;
136 MCSymbol *getStringPoolEntry(StringRef Str);
138 /// SectionMap - Provides a unique id per text section.
140 UniqueVector<const MCSection*> SectionMap;
142 /// CurrentFnDbgScope - Top level scope for the current function.
144 DbgScope *CurrentFnDbgScope;
146 /// CurrentFnArguments - List of Arguments (DbgValues) for current function.
147 SmallVector<DbgVariable *, 8> CurrentFnArguments;
149 /// DbgScopeMap - Tracks the scopes in the current function. Owns the
150 /// contained DbgScope*s.
152 DenseMap<const MDNode *, DbgScope *> DbgScopeMap;
154 /// ConcreteScopes - Tracks the concrete scopees in the current function.
155 /// These scopes are also included in DbgScopeMap.
156 DenseMap<const MDNode *, DbgScope *> ConcreteScopes;
158 /// AbstractScopes - Tracks the abstract scopes a module. These scopes are
159 /// not included DbgScopeMap. AbstractScopes owns its DbgScope*s.
160 DenseMap<const MDNode *, DbgScope *> AbstractScopes;
162 /// AbstractSPDies - Collection of abstract subprogram DIEs.
163 DenseMap<const MDNode *, DIE *> AbstractSPDies;
165 /// AbstractScopesList - Tracks abstract scopes constructed while processing
166 /// a function. This list is cleared during endFunction().
167 SmallVector<DbgScope *, 4>AbstractScopesList;
169 /// AbstractVariables - Collection on abstract variables. Owned by the
170 /// DbgScopes in AbstractScopes.
171 DenseMap<const MDNode *, DbgVariable *> AbstractVariables;
173 /// DbgVariableToFrameIndexMap - Tracks frame index used to find
174 /// variable's value.
175 DenseMap<const DbgVariable *, int> DbgVariableToFrameIndexMap;
177 /// DbgVariableToDbgInstMap - Maps DbgVariable to corresponding DBG_VALUE
178 /// machine instruction.
179 DenseMap<const DbgVariable *, const MachineInstr *> DbgVariableToDbgInstMap;
181 /// DotDebugLocEntries - Collection of DotDebugLocEntry.
182 SmallVector<DotDebugLocEntry, 4> DotDebugLocEntries;
184 /// UseDotDebugLocEntry - DW_AT_location attributes for the DIEs in this set
185 /// idetifies corresponding .debug_loc entry offset.
186 SmallPtrSet<const DIE *, 4> UseDotDebugLocEntry;
188 /// VarToAbstractVarMap - Maps DbgVariable with corresponding Abstract
189 /// DbgVariable, if any.
190 DenseMap<const DbgVariable *, const DbgVariable *> VarToAbstractVarMap;
192 /// InliendSubprogramDIEs - Collection of subprgram DIEs that are marked
193 /// (at the end of the module) as DW_AT_inline.
194 SmallPtrSet<DIE *, 4> InlinedSubprogramDIEs;
196 /// ContainingTypeMap - This map is used to keep track of subprogram DIEs that
197 /// need DW_AT_containing_type attribute. This attribute points to a DIE that
198 /// corresponds to the MDNode mapped with the subprogram DIE.
199 DenseMap<DIE *, const MDNode *> ContainingTypeMap;
201 typedef SmallVector<DbgScope *, 2> ScopeVector;
203 SmallPtrSet<const MachineInstr *, 8> InsnsEndScopeSet;
205 /// InlineInfo - Keep track of inlined functions and their location. This
206 /// information is used to populate debug_inlined section.
207 typedef std::pair<const MCSymbol *, DIE *> InlineInfoLabels;
208 DenseMap<const MDNode *, SmallVector<InlineInfoLabels, 4> > InlineInfo;
209 SmallVector<const MDNode *, 4> InlinedSPNodes;
211 // ProcessedSPNodes - This is a collection of subprogram MDNodes that
212 // are processed to create DIEs.
213 SmallPtrSet<const MDNode *, 16> ProcessedSPNodes;
215 /// LabelsBeforeInsn - Maps instruction with label emitted before
217 DenseMap<const MachineInstr *, MCSymbol *> LabelsBeforeInsn;
219 /// LabelsAfterInsn - Maps instruction with label emitted after
221 DenseMap<const MachineInstr *, MCSymbol *> LabelsAfterInsn;
223 /// insnNeedsLabel - Collection of instructions that need a label to mark
224 /// a debuggging information entity.
225 SmallPtrSet<const MachineInstr *, 8> InsnNeedsLabel;
227 SmallVector<const MCSymbol *, 8> DebugRangeSymbols;
229 /// Previous instruction's location information. This is used to determine
230 /// label location to indicate scope boundries in dwarf debug info.
231 DebugLoc PrevInstLoc;
234 struct FunctionDebugFrameInfo {
236 std::vector<MachineMove> Moves;
238 FunctionDebugFrameInfo(unsigned Num, const std::vector<MachineMove> &M)
239 : Number(Num), Moves(M) {}
242 std::vector<FunctionDebugFrameInfo> DebugFrames;
244 // Section Symbols: these are assembler temporary labels that are emitted at
245 // the beginning of each supported dwarf section. These are used to form
246 // section offsets and are created by EmitSectionLabels.
247 MCSymbol *DwarfFrameSectionSym, *DwarfInfoSectionSym, *DwarfAbbrevSectionSym;
248 MCSymbol *DwarfStrSectionSym, *TextSectionSym, *DwarfDebugRangeSectionSym;
249 MCSymbol *DwarfDebugLocSectionSym;
250 MCSymbol *FunctionBeginSym, *FunctionEndSym;
252 DIEInteger *DIEIntegerOne;
255 /// getNumSourceIds - Return the number of unique source ids.
256 unsigned getNumSourceIds() const {
257 return SourceIdMap.size();
260 /// assignAbbrevNumber - Define a unique number for the abbreviation.
262 void assignAbbrevNumber(DIEAbbrev &Abbrev);
264 /// createDIEEntry - Creates a new DIEEntry to be a proxy for a debug
265 /// information entry.
266 DIEEntry *createDIEEntry(DIE *Entry);
268 /// addUInt - Add an unsigned integer attribute data and value.
270 void addUInt(DIE *Die, unsigned Attribute, unsigned Form, uint64_t Integer);
272 /// addSInt - Add an signed integer attribute data and value.
274 void addSInt(DIE *Die, unsigned Attribute, unsigned Form, int64_t Integer);
276 /// addString - Add a string attribute data and value.
278 void addString(DIE *Die, unsigned Attribute, unsigned Form,
279 const StringRef Str);
281 /// addLabel - Add a Dwarf label attribute data and value.
283 void addLabel(DIE *Die, unsigned Attribute, unsigned Form,
284 const MCSymbol *Label);
286 /// addDelta - Add a label delta attribute data and value.
288 void addDelta(DIE *Die, unsigned Attribute, unsigned Form,
289 const MCSymbol *Hi, const MCSymbol *Lo);
291 /// addDIEEntry - Add a DIE attribute data and value.
293 void addDIEEntry(DIE *Die, unsigned Attribute, unsigned Form, DIE *Entry);
295 /// addBlock - Add block data.
297 void addBlock(DIE *Die, unsigned Attribute, unsigned Form, DIEBlock *Block);
299 /// addSourceLine - Add location information to specified debug information
301 void addSourceLine(DIE *Die, DIVariable V);
302 void addSourceLine(DIE *Die, DIGlobalVariable G);
303 void addSourceLine(DIE *Die, DISubprogram SP);
304 void addSourceLine(DIE *Die, DIType Ty);
305 void addSourceLine(DIE *Die, DINameSpace NS);
307 /// addAddress - Add an address attribute to a die based on the location
309 void addAddress(DIE *Die, unsigned Attribute,
310 const MachineLocation &Location);
312 /// addRegisterAddress - Add register location entry in variable DIE.
313 bool addRegisterAddress(DIE *Die, const MachineOperand &MO);
315 /// addConstantValue - Add constant value entry in variable DIE.
316 bool addConstantValue(DIE *Die, const MachineOperand &MO);
317 bool addConstantValue(DIE *Die, ConstantInt *CI, bool Unsigned);
319 /// addConstantFPValue - Add constant value entry in variable DIE.
320 bool addConstantFPValue(DIE *Die, const MachineOperand &MO);
322 /// addComplexAddress - Start with the address based on the location provided,
323 /// and generate the DWARF information necessary to find the actual variable
324 /// (navigating the extra location information encoded in the type) based on
325 /// the starting location. Add the DWARF information to the die.
327 void addComplexAddress(DbgVariable *&DV, DIE *Die, unsigned Attribute,
328 const MachineLocation &Location);
330 // FIXME: Should be reformulated in terms of addComplexAddress.
331 /// addBlockByrefAddress - Start with the address based on the location
332 /// provided, and generate the DWARF information necessary to find the
333 /// actual Block variable (navigating the Block struct) based on the
334 /// starting location. Add the DWARF information to the die. Obsolete,
335 /// please use addComplexAddress instead.
337 void addBlockByrefAddress(DbgVariable *&DV, DIE *Die, unsigned Attribute,
338 const MachineLocation &Location);
340 /// addVariableAddress - Add DW_AT_location attribute for a DbgVariable based
341 /// on provided frame index.
342 void addVariableAddress(DbgVariable *&DV, DIE *Die, int64_t FI);
344 /// addToContextOwner - Add Die into the list of its context owner's children.
345 void addToContextOwner(DIE *Die, DIDescriptor Context);
347 /// addType - Add a new type attribute to the specified entity.
348 void addType(DIE *Entity, DIType Ty);
351 /// getOrCreateNameSpace - Create a DIE for DINameSpace.
352 DIE *getOrCreateNameSpace(DINameSpace NS);
354 /// getOrCreateTypeDIE - Find existing DIE or create new DIE for the
356 DIE *getOrCreateTypeDIE(DIType Ty);
358 /// getOrCreateTemplateTypeParameterDIE - Find existing DIE or create new DIE
359 /// for the given DITemplateTypeParameter.
360 DIE *getOrCreateTemplateTypeParameterDIE(DITemplateTypeParameter TP);
362 /// getOrCreateTemplateValueParameterDIE - Find existing DIE or create new DIE
363 /// for the given DITemplateValueParameter.
364 DIE *getOrCreateTemplateValueParameterDIE(DITemplateValueParameter TVP);
366 void addPubTypes(DISubprogram SP);
368 /// constructTypeDIE - Construct basic type die from DIBasicType.
369 void constructTypeDIE(DIE &Buffer,
372 /// constructTypeDIE - Construct derived type die from DIDerivedType.
373 void constructTypeDIE(DIE &Buffer,
376 /// constructTypeDIE - Construct type DIE from DICompositeType.
377 void constructTypeDIE(DIE &Buffer,
378 DICompositeType CTy);
380 /// constructSubrangeDIE - Construct subrange DIE from DISubrange.
381 void constructSubrangeDIE(DIE &Buffer, DISubrange SR, DIE *IndexTy);
383 /// constructArrayTypeDIE - Construct array type DIE from DICompositeType.
384 void constructArrayTypeDIE(DIE &Buffer,
385 DICompositeType *CTy);
387 /// constructEnumTypeDIE - Construct enum type DIE from DIEnumerator.
388 DIE *constructEnumTypeDIE(DIEnumerator ETy);
390 /// createMemberDIE - Create new member DIE.
391 DIE *createMemberDIE(DIDerivedType DT);
393 /// createSubprogramDIE - Create new DIE using SP.
394 DIE *createSubprogramDIE(DISubprogram SP);
396 /// getOrCreateDbgScope - Create DbgScope for the scope.
397 DbgScope *getOrCreateDbgScope(const MDNode *Scope, const MDNode *InlinedAt);
399 DbgScope *getOrCreateAbstractScope(const MDNode *N);
401 /// findAbstractVariable - Find abstract variable associated with Var.
402 DbgVariable *findAbstractVariable(DIVariable &Var, DebugLoc Loc);
404 /// updateSubprogramScopeDIE - Find DIE for the given subprogram and
405 /// attach appropriate DW_AT_low_pc and DW_AT_high_pc attributes.
406 /// If there are global variables in this scope then create and insert
407 /// DIEs for these variables.
408 DIE *updateSubprogramScopeDIE(const MDNode *SPNode);
410 /// constructLexicalScope - Construct new DW_TAG_lexical_block
411 /// for this scope and attach DW_AT_low_pc/DW_AT_high_pc labels.
412 DIE *constructLexicalScopeDIE(DbgScope *Scope);
414 /// constructInlinedScopeDIE - This scope represents inlined body of
415 /// a function. Construct DIE to represent this concrete inlined copy
417 DIE *constructInlinedScopeDIE(DbgScope *Scope);
419 /// constructVariableDIE - Construct a DIE for the given DbgVariable.
420 DIE *constructVariableDIE(DbgVariable *DV, DbgScope *S);
422 /// constructScopeDIE - Construct a DIE for this scope.
423 DIE *constructScopeDIE(DbgScope *Scope);
425 /// EmitSectionLabels - Emit initial Dwarf sections with a label at
426 /// the start of each one.
427 void EmitSectionLabels();
429 /// emitDIE - Recusively Emits a debug information entry.
431 void emitDIE(DIE *Die);
433 /// computeSizeAndOffset - Compute the size and offset of a DIE.
435 unsigned computeSizeAndOffset(DIE *Die, unsigned Offset, bool Last);
437 /// computeSizeAndOffsets - Compute the size and offset of all the DIEs.
439 void computeSizeAndOffsets();
441 /// EmitDebugInfo - Emit the debug info section.
443 void emitDebugInfo();
445 /// emitAbbreviations - Emit the abbreviation section.
447 void emitAbbreviations() const;
449 /// emitEndOfLineMatrix - Emit the last address of the section and the end of
452 void emitEndOfLineMatrix(unsigned SectionEnd);
454 /// emitCommonDebugFrame - Emit common frame info into a debug frame section.
456 void emitCommonDebugFrame();
458 /// emitFunctionDebugFrame - Emit per function frame info into a debug frame
460 void emitFunctionDebugFrame(const FunctionDebugFrameInfo &DebugFrameInfo);
462 /// emitDebugPubNames - Emit visible names into a debug pubnames section.
464 void emitDebugPubNames();
466 /// emitDebugPubTypes - Emit visible types into a debug pubtypes section.
468 void emitDebugPubTypes();
470 /// emitDebugStr - Emit visible names into a debug str section.
474 /// emitDebugLoc - Emit visible names into a debug loc section.
478 /// EmitDebugARanges - Emit visible names into a debug aranges section.
480 void EmitDebugARanges();
482 /// emitDebugRanges - Emit visible names into a debug ranges section.
484 void emitDebugRanges();
486 /// emitDebugMacInfo - Emit visible names into a debug macinfo section.
488 void emitDebugMacInfo();
490 /// emitDebugInlineInfo - Emit inline info using following format.
492 /// 1. length of section
493 /// 2. Dwarf version number
496 /// Entries (one "entry" for each function that was inlined):
498 /// 1. offset into __debug_str section for MIPS linkage name, if exists;
499 /// otherwise offset into __debug_str for regular function name.
500 /// 2. offset into __debug_str section for regular function name.
501 /// 3. an unsigned LEB128 number indicating the number of distinct inlining
502 /// instances for the function.
504 /// The rest of the entry consists of a {die_offset, low_pc} pair for each
505 /// inlined instance; the die_offset points to the inlined_subroutine die in
506 /// the __debug_info section, and the low_pc is the starting address for the
507 /// inlining instance.
508 void emitDebugInlineInfo();
510 /// GetOrCreateSourceID - Look up the source id with the given directory and
511 /// source file names. If none currently exists, create a new id and insert it
512 /// in the SourceIds map.
513 unsigned GetOrCreateSourceID(StringRef FullName);
515 /// constructCompileUnit - Create new CompileUnit for the given
516 /// metadata node with tag DW_TAG_compile_unit.
517 void constructCompileUnit(const MDNode *N);
519 /// getCompielUnit - Get CompileUnit DIE.
520 CompileUnit *getCompileUnit(const MDNode *N) const;
522 /// constructGlobalVariableDIE - Construct global variable DIE.
523 void constructGlobalVariableDIE(const MDNode *N);
525 /// construct SubprogramDIE - Construct subprogram DIE.
526 void constructSubprogramDIE(const MDNode *N);
528 /// recordSourceLine - Register a source line with debug info. Returns the
529 /// unique label that was emitted and which provides correspondence to
530 /// the source line list.
531 MCSymbol *recordSourceLine(unsigned Line, unsigned Col, const MDNode *Scope);
533 /// recordVariableFrameIndex - Record a variable's index.
534 void recordVariableFrameIndex(const DbgVariable *V, int Index);
536 /// findVariableFrameIndex - Return true if frame index for the variable
537 /// is found. Update FI to hold value of the index.
538 bool findVariableFrameIndex(const DbgVariable *V, int *FI);
540 /// findDbgScope - Find DbgScope for the debug loc attached with an
542 DbgScope *findDbgScope(const MachineInstr *MI);
544 /// identifyScopeMarkers() - Indentify instructions that are marking
545 /// beginning of or end of a scope.
546 void identifyScopeMarkers();
548 /// extractScopeInformation - Scan machine instructions in this function
549 /// and collect DbgScopes. Return true, if atleast one scope was found.
550 bool extractScopeInformation();
552 /// addCurrentFnArgument - If Var is an current function argument that add
553 /// it in CurrentFnArguments list.
554 bool addCurrentFnArgument(const MachineFunction *MF,
555 DbgVariable *Var, DbgScope *Scope);
557 /// collectVariableInfo - Populate DbgScope entries with variables' info.
558 void collectVariableInfo(const MachineFunction *,
559 SmallPtrSet<const MDNode *, 16> &ProcessedVars);
561 /// collectVariableInfoFromMMITable - Collect variable information from
562 /// side table maintained by MMI.
563 void collectVariableInfoFromMMITable(const MachineFunction * MF,
564 SmallPtrSet<const MDNode *, 16> &P);
566 //===--------------------------------------------------------------------===//
567 // Main entry points.
569 DwarfDebug(AsmPrinter *A, Module *M);
572 /// beginModule - Emit all Dwarf sections that should come prior to the
574 void beginModule(Module *M);
576 /// endModule - Emit all Dwarf sections that should come after the content.
580 /// beginFunction - Gather pre-function debug information. Assumes being
581 /// emitted immediately after the function entry point.
582 void beginFunction(const MachineFunction *MF);
584 /// endFunction - Gather and emit post-function debug information.
586 void endFunction(const MachineFunction *MF);
588 /// getLabelBeforeInsn - Return Label preceding the instruction.
589 const MCSymbol *getLabelBeforeInsn(const MachineInstr *MI);
591 /// getLabelAfterInsn - Return Label immediately following the instruction.
592 const MCSymbol *getLabelAfterInsn(const MachineInstr *MI);
594 /// beginInstruction - Process beginning of an instruction.
595 void beginInstruction(const MachineInstr *MI);
597 /// endInstruction - Prcess end of an instruction.
598 void endInstruction(const MachineInstr *MI);
600 } // End of namespace llvm