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"
30 class DbgConcreteScope;
33 class MachineFrameInfo;
34 class MachineModuleInfo;
46 class DIGlobalVariable;
53 class DICompositeType;
55 //===----------------------------------------------------------------------===//
56 /// SrcLineInfo - This class is used to record source line correspondence.
59 unsigned Line; // Source line number.
60 unsigned Column; // Source column.
61 unsigned SourceID; // Source ID number.
62 MCSymbol *Label; // Label in code ID number.
64 SrcLineInfo(unsigned L, unsigned C, unsigned S, MCSymbol *label)
65 : Line(L), Column(C), SourceID(S), Label(label) {}
68 unsigned getLine() const { return Line; }
69 unsigned getColumn() const { return Column; }
70 unsigned getSourceID() const { return SourceID; }
71 MCSymbol *getLabel() const { return Label; }
75 /// Asm - Target of Dwarf emission.
78 /// MMI - Collected machine module information.
79 MachineModuleInfo *MMI;
81 //===--------------------------------------------------------------------===//
82 // Attributes used to construct specific Dwarf sections.
86 DenseMap <const MDNode *, CompileUnit *> CUMap;
88 /// AbbreviationsSet - Used to uniquely define abbreviations.
90 FoldingSet<DIEAbbrev> AbbreviationsSet;
92 /// Abbreviations - A list of all the unique abbreviations in use.
94 std::vector<DIEAbbrev *> Abbreviations;
96 /// DirectoryIdMap - Directory name to directory id map.
98 StringMap<unsigned> DirectoryIdMap;
100 /// DirectoryNames - A list of directory names.
101 SmallVector<std::string, 8> DirectoryNames;
103 /// SourceFileIdMap - Source file name to source file id map.
105 StringMap<unsigned> SourceFileIdMap;
107 /// SourceFileNames - A list of source file names.
108 SmallVector<std::string, 8> SourceFileNames;
110 /// SourceIdMap - Source id map, i.e. pair of directory id and source file
111 /// id mapped to a unique id.
112 DenseMap<std::pair<unsigned, unsigned>, unsigned> SourceIdMap;
114 /// SourceIds - Reverse map from source id to directory id + file id pair.
116 SmallVector<std::pair<unsigned, unsigned>, 8> SourceIds;
118 /// Lines - List of source line correspondence.
119 std::vector<SrcLineInfo> Lines;
121 /// DIEBlocks - A list of all the DIEBlocks in use.
122 std::vector<DIEBlock *> DIEBlocks;
124 // DIEValueAllocator - All DIEValues are allocated through this allocator.
125 BumpPtrAllocator DIEValueAllocator;
127 /// StringPool - A String->Symbol mapping of strings used by indirect
129 StringMap<std::pair<MCSymbol*, unsigned> > StringPool;
130 unsigned NextStringPoolNumber;
132 MCSymbol *getStringPoolEntry(StringRef Str);
134 /// SectionMap - Provides a unique id per text section.
136 UniqueVector<const MCSection*> SectionMap;
138 /// SectionSourceLines - Tracks line numbers per text section.
140 std::vector<std::vector<SrcLineInfo> > SectionSourceLines;
142 // CurrentFnDbgScope - Top level scope for the current function.
144 DbgScope *CurrentFnDbgScope;
146 /// DbgScopeMap - Tracks the scopes in the current function. Owns the
147 /// contained DbgScope*s.
149 DenseMap<const MDNode *, DbgScope *> DbgScopeMap;
151 /// ConcreteScopes - Tracks the concrete scopees in the current function.
152 /// These scopes are also included in DbgScopeMap.
153 DenseMap<const MDNode *, DbgScope *> ConcreteScopes;
155 /// AbstractScopes - Tracks the abstract scopes a module. These scopes are
156 /// not included DbgScopeMap. AbstractScopes owns its DbgScope*s.
157 DenseMap<const MDNode *, DbgScope *> AbstractScopes;
159 /// AbstractScopesList - Tracks abstract scopes constructed while processing
160 /// a function. This list is cleared during endFunction().
161 SmallVector<DbgScope *, 4>AbstractScopesList;
163 /// AbstractVariables - Collection on abstract variables. Owned by the
164 /// DbgScopes in AbstractScopes.
165 DenseMap<const MDNode *, DbgVariable *> AbstractVariables;
167 /// DbgVariableToFrameIndexMap - Tracks frame index used to find
168 /// variable's value.
169 DenseMap<const DbgVariable *, int> DbgVariableToFrameIndexMap;
171 /// DbgVariableToDbgInstMap - Maps DbgVariable to corresponding DBG_VALUE
172 /// machine instruction.
173 DenseMap<const DbgVariable *, const MachineInstr *> DbgVariableToDbgInstMap;
175 /// DbgVariableLabelsMap - Maps DbgVariable to corresponding MCSymbol.
176 DenseMap<const DbgVariable *, const MCSymbol *> DbgVariableLabelsMap;
178 /// DotDebugLocEntry - This struct describes location entries emitted in
179 /// .debug_loc section.
180 typedef struct DotDebugLocEntry {
181 const MCSymbol *Begin;
184 DotDebugLocEntry() : Begin(0), End(0) {}
185 DotDebugLocEntry(const MCSymbol *B, const MCSymbol *E,
186 MachineLocation &L) : Begin(B), End(E), Loc(L) {}
187 /// Empty entries are also used as a trigger to emit temp label. Such
188 /// labels are referenced is used to find debug_loc offset for a given DIE.
189 bool isEmpty() { return Begin == 0 && End == 0; }
192 /// DotDebugLocEntries - Collection of DotDebugLocEntry.
193 SmallVector<DotDebugLocEntry, 4> DotDebugLocEntries;
195 /// UseDotDebugLocEntry - DW_AT_location attributes for the DIEs in this set
196 /// idetifies corresponding .debug_loc entry offset.
197 SmallPtrSet<const DIE *, 4> UseDotDebugLocEntry;
199 /// VarToAbstractVarMap - Maps DbgVariable with corresponding Abstract
200 /// DbgVariable, if any.
201 DenseMap<const DbgVariable *, const DbgVariable *> VarToAbstractVarMap;
203 /// InliendSubprogramDIEs - Collection of subprgram DIEs that are marked
204 /// (at the end of the module) as DW_AT_inline.
205 SmallPtrSet<DIE *, 4> InlinedSubprogramDIEs;
207 /// ContainingTypeMap - This map is used to keep track of subprogram DIEs that
208 /// need DW_AT_containing_type attribute. This attribute points to a DIE that
209 /// corresponds to the MDNode mapped with the subprogram DIE.
210 DenseMap<DIE *, const MDNode *> ContainingTypeMap;
212 typedef SmallVector<DbgScope *, 2> ScopeVector;
214 SmallPtrSet<const MachineInstr *, 8> InsnsEndScopeSet;
216 /// InlineInfo - Keep track of inlined functions and their location. This
217 /// information is used to populate debug_inlined section.
218 typedef std::pair<const MCSymbol *, DIE *> InlineInfoLabels;
219 DenseMap<const MDNode *, SmallVector<InlineInfoLabels, 4> > InlineInfo;
220 SmallVector<const MDNode *, 4> InlinedSPNodes;
222 // ProcessedSPNodes - This is a collection of subprogram MDNodes that
223 // are processed to create DIEs.
224 SmallPtrSet<const MDNode *, 16> ProcessedSPNodes;
226 /// LabelsBeforeInsn - Maps instruction with label emitted before
228 DenseMap<const MachineInstr *, MCSymbol *> LabelsBeforeInsn;
230 /// LabelsAfterInsn - Maps instruction with label emitted after
232 DenseMap<const MachineInstr *, MCSymbol *> LabelsAfterInsn;
234 /// insnNeedsLabel - Collection of instructions that need a label to mark
235 /// a debuggging information entity.
236 SmallPtrSet<const MachineInstr *, 8> InsnNeedsLabel;
238 SmallVector<const MCSymbol *, 8> DebugRangeSymbols;
240 /// Previous instruction's location information. This is used to determine
241 /// label location to indicate scope boundries in dwarf debug info.
242 DebugLoc PrevInstLoc;
245 struct FunctionDebugFrameInfo {
247 std::vector<MachineMove> Moves;
249 FunctionDebugFrameInfo(unsigned Num, const std::vector<MachineMove> &M)
250 : Number(Num), Moves(M) {}
253 std::vector<FunctionDebugFrameInfo> DebugFrames;
255 // Section Symbols: these are assembler temporary labels that are emitted at
256 // the beginning of each supported dwarf section. These are used to form
257 // section offsets and are created by EmitSectionLabels.
258 MCSymbol *DwarfFrameSectionSym, *DwarfInfoSectionSym, *DwarfAbbrevSectionSym;
259 MCSymbol *DwarfStrSectionSym, *TextSectionSym, *DwarfDebugRangeSectionSym;
260 MCSymbol *DwarfDebugLocSectionSym;
261 MCSymbol *FunctionBeginSym, *FunctionEndSym;
264 /// getSourceDirectoryAndFileIds - Return the directory and file ids that
265 /// maps to the source id. Source id starts at 1.
266 std::pair<unsigned, unsigned>
267 getSourceDirectoryAndFileIds(unsigned SId) const {
268 return SourceIds[SId-1];
271 /// getNumSourceDirectories - Return the number of source directories in the
273 unsigned getNumSourceDirectories() const {
274 return DirectoryNames.size();
277 /// getSourceDirectoryName - Return the name of the directory corresponding
279 const std::string &getSourceDirectoryName(unsigned Id) const {
280 return DirectoryNames[Id - 1];
283 /// getSourceFileName - Return the name of the source file corresponding
285 const std::string &getSourceFileName(unsigned Id) const {
286 return SourceFileNames[Id - 1];
289 /// getNumSourceIds - Return the number of unique source ids.
290 unsigned getNumSourceIds() const {
291 return SourceIds.size();
294 /// assignAbbrevNumber - Define a unique number for the abbreviation.
296 void assignAbbrevNumber(DIEAbbrev &Abbrev);
298 /// createDIEEntry - Creates a new DIEEntry to be a proxy for a debug
299 /// information entry.
300 DIEEntry *createDIEEntry(DIE *Entry);
302 /// addUInt - Add an unsigned integer attribute data and value.
304 void addUInt(DIE *Die, unsigned Attribute, unsigned Form, uint64_t Integer);
306 /// addSInt - Add an signed integer attribute data and value.
308 void addSInt(DIE *Die, unsigned Attribute, unsigned Form, int64_t Integer);
310 /// addString - Add a string attribute data and value.
312 void addString(DIE *Die, unsigned Attribute, unsigned Form,
313 const StringRef Str);
315 /// addLabel - Add a Dwarf label attribute data and value.
317 void addLabel(DIE *Die, unsigned Attribute, unsigned Form,
318 const MCSymbol *Label);
320 /// addDelta - Add a label delta attribute data and value.
322 void addDelta(DIE *Die, unsigned Attribute, unsigned Form,
323 const MCSymbol *Hi, const MCSymbol *Lo);
325 /// addDIEEntry - Add a DIE attribute data and value.
327 void addDIEEntry(DIE *Die, unsigned Attribute, unsigned Form, DIE *Entry);
329 /// addBlock - Add block data.
331 void addBlock(DIE *Die, unsigned Attribute, unsigned Form, DIEBlock *Block);
333 /// addSourceLine - Add location information to specified debug information
335 void addSourceLine(DIE *Die, const DIVariable *V);
336 void addSourceLine(DIE *Die, const DIGlobalVariable *G);
337 void addSourceLine(DIE *Die, const DISubprogram *SP);
338 void addSourceLine(DIE *Die, const DIType *Ty);
339 void addSourceLine(DIE *Die, const DINameSpace *NS);
341 /// addAddress - Add an address attribute to a die based on the location
343 void addAddress(DIE *Die, unsigned Attribute,
344 const MachineLocation &Location);
346 /// addRegisterAddress - Add register location entry in variable DIE.
347 bool addRegisterAddress(DIE *Die, const MCSymbol *VS, const MachineOperand &MO);
349 /// addConstantValue - Add constant value entry in variable DIE.
350 bool addConstantValue(DIE *Die, const MCSymbol *VS, const MachineOperand &MO);
352 /// addConstantFPValue - Add constant value entry in variable DIE.
353 bool addConstantFPValue(DIE *Die, const MCSymbol *VS, const MachineOperand &MO);
355 /// addComplexAddress - Start with the address based on the location provided,
356 /// and generate the DWARF information necessary to find the actual variable
357 /// (navigating the extra location information encoded in the type) based on
358 /// the starting location. Add the DWARF information to the die.
360 void addComplexAddress(DbgVariable *&DV, DIE *Die, unsigned Attribute,
361 const MachineLocation &Location);
363 // FIXME: Should be reformulated in terms of addComplexAddress.
364 /// addBlockByrefAddress - Start with the address based on the location
365 /// provided, and generate the DWARF information necessary to find the
366 /// actual Block variable (navigating the Block struct) based on the
367 /// starting location. Add the DWARF information to the die. Obsolete,
368 /// please use addComplexAddress instead.
370 void addBlockByrefAddress(DbgVariable *&DV, DIE *Die, unsigned Attribute,
371 const MachineLocation &Location);
373 /// addToContextOwner - Add Die into the list of its context owner's children.
374 void addToContextOwner(DIE *Die, DIDescriptor Context);
376 /// addType - Add a new type attribute to the specified entity.
377 void addType(DIE *Entity, DIType Ty);
380 /// getOrCreateNameSpace - Create a DIE for DINameSpace.
381 DIE *getOrCreateNameSpace(DINameSpace NS);
383 /// getOrCreateTypeDIE - Find existing DIE or create new DIE for the
385 DIE *getOrCreateTypeDIE(DIType Ty);
387 void addPubTypes(DISubprogram SP);
389 /// constructTypeDIE - Construct basic type die from DIBasicType.
390 void constructTypeDIE(DIE &Buffer,
393 /// constructTypeDIE - Construct derived type die from DIDerivedType.
394 void constructTypeDIE(DIE &Buffer,
397 /// constructTypeDIE - Construct type DIE from DICompositeType.
398 void constructTypeDIE(DIE &Buffer,
399 DICompositeType CTy);
401 /// constructSubrangeDIE - Construct subrange DIE from DISubrange.
402 void constructSubrangeDIE(DIE &Buffer, DISubrange SR, DIE *IndexTy);
404 /// constructArrayTypeDIE - Construct array type DIE from DICompositeType.
405 void constructArrayTypeDIE(DIE &Buffer,
406 DICompositeType *CTy);
408 /// constructEnumTypeDIE - Construct enum type DIE from DIEnumerator.
409 DIE *constructEnumTypeDIE(DIEnumerator ETy);
411 /// createGlobalVariableDIE - Create new DIE using GV.
412 DIE *createGlobalVariableDIE(const DIGlobalVariable &GV);
414 /// createMemberDIE - Create new member DIE.
415 DIE *createMemberDIE(const DIDerivedType &DT);
417 /// createSubprogramDIE - Create new DIE using SP.
418 DIE *createSubprogramDIE(const DISubprogram &SP, bool MakeDecl = false);
420 /// getOrCreateDbgScope - Create DbgScope for the scope.
421 DbgScope *getOrCreateDbgScope(const MDNode *Scope, const MDNode *InlinedAt);
423 DbgScope *getOrCreateAbstractScope(const MDNode *N);
425 /// findAbstractVariable - Find abstract variable associated with Var.
426 DbgVariable *findAbstractVariable(DIVariable &Var, DebugLoc Loc);
428 /// updateSubprogramScopeDIE - Find DIE for the given subprogram and
429 /// attach appropriate DW_AT_low_pc and DW_AT_high_pc attributes.
430 /// If there are global variables in this scope then create and insert
431 /// DIEs for these variables.
432 DIE *updateSubprogramScopeDIE(const MDNode *SPNode);
434 /// constructLexicalScope - Construct new DW_TAG_lexical_block
435 /// for this scope and attach DW_AT_low_pc/DW_AT_high_pc labels.
436 DIE *constructLexicalScopeDIE(DbgScope *Scope);
438 /// constructInlinedScopeDIE - This scope represents inlined body of
439 /// a function. Construct DIE to represent this concrete inlined copy
441 DIE *constructInlinedScopeDIE(DbgScope *Scope);
443 /// constructVariableDIE - Construct a DIE for the given DbgVariable.
444 DIE *constructVariableDIE(DbgVariable *DV, DbgScope *S);
446 /// constructScopeDIE - Construct a DIE for this scope.
447 DIE *constructScopeDIE(DbgScope *Scope);
449 /// EmitSectionLabels - Emit initial Dwarf sections with a label at
450 /// the start of each one.
451 void EmitSectionLabels();
453 /// emitDIE - Recusively Emits a debug information entry.
455 void emitDIE(DIE *Die);
457 /// computeSizeAndOffset - Compute the size and offset of a DIE.
459 unsigned computeSizeAndOffset(DIE *Die, unsigned Offset, bool Last);
461 /// computeSizeAndOffsets - Compute the size and offset of all the DIEs.
463 void computeSizeAndOffsets();
465 /// EmitDebugInfo - Emit the debug info section.
467 void emitDebugInfo();
469 /// emitAbbreviations - Emit the abbreviation section.
471 void emitAbbreviations() const;
473 /// emitEndOfLineMatrix - Emit the last address of the section and the end of
476 void emitEndOfLineMatrix(unsigned SectionEnd);
478 /// emitDebugLines - Emit source line information.
480 void emitDebugLines();
482 /// emitCommonDebugFrame - Emit common frame info into a debug frame section.
484 void emitCommonDebugFrame();
486 /// emitFunctionDebugFrame - Emit per function frame info into a debug frame
488 void emitFunctionDebugFrame(const FunctionDebugFrameInfo &DebugFrameInfo);
490 /// emitDebugPubNames - Emit visible names into a debug pubnames section.
492 void emitDebugPubNames();
494 /// emitDebugPubTypes - Emit visible types into a debug pubtypes section.
496 void emitDebugPubTypes();
498 /// emitDebugStr - Emit visible names into a debug str section.
502 /// emitDebugLoc - Emit visible names into a debug loc section.
506 /// EmitDebugARanges - Emit visible names into a debug aranges section.
508 void EmitDebugARanges();
510 /// emitDebugRanges - Emit visible names into a debug ranges section.
512 void emitDebugRanges();
514 /// emitDebugMacInfo - Emit visible names into a debug macinfo section.
516 void emitDebugMacInfo();
518 /// emitDebugInlineInfo - Emit inline info using following format.
520 /// 1. length of section
521 /// 2. Dwarf version number
524 /// Entries (one "entry" for each function that was inlined):
526 /// 1. offset into __debug_str section for MIPS linkage name, if exists;
527 /// otherwise offset into __debug_str for regular function name.
528 /// 2. offset into __debug_str section for regular function name.
529 /// 3. an unsigned LEB128 number indicating the number of distinct inlining
530 /// instances for the function.
532 /// The rest of the entry consists of a {die_offset, low_pc} pair for each
533 /// inlined instance; the die_offset points to the inlined_subroutine die in
534 /// the __debug_info section, and the low_pc is the starting address for the
535 /// inlining instance.
536 void emitDebugInlineInfo();
538 /// GetOrCreateSourceID - Look up the source id with the given directory and
539 /// source file names. If none currently exists, create a new id and insert it
540 /// in the SourceIds map. This can update DirectoryNames and SourceFileNames
542 unsigned GetOrCreateSourceID(StringRef DirName, StringRef FileName);
544 /// constructCompileUnit - Create new CompileUnit for the given
545 /// metadata node with tag DW_TAG_compile_unit.
546 void constructCompileUnit(const MDNode *N);
548 /// getCompielUnit - Get CompileUnit DIE.
549 CompileUnit *getCompileUnit(const MDNode *N) const;
551 /// constructGlobalVariableDIE - Construct global variable DIE.
552 void constructGlobalVariableDIE(const MDNode *N);
554 /// construct SubprogramDIE - Construct subprogram DIE.
555 void constructSubprogramDIE(const MDNode *N);
557 // FIXME: This should go away in favor of complex addresses.
558 /// Find the type the programmer originally declared the variable to be
559 /// and return that type. Obsolete, use GetComplexAddrType instead.
561 DIType getBlockByrefType(DIType Ty, std::string Name);
563 /// recordSourceLine - Register a source line with debug info. Returns the
564 /// unique label that was emitted and which provides correspondence to
565 /// the source line list.
566 MCSymbol *recordSourceLine(unsigned Line, unsigned Col, const MDNode *Scope);
568 /// getSourceLineCount - Return the number of source lines in the debug
570 unsigned getSourceLineCount() const {
574 /// recordVariableFrameIndex - Record a variable's index.
575 void recordVariableFrameIndex(const DbgVariable *V, int Index);
577 /// findVariableFrameIndex - Return true if frame index for the variable
578 /// is found. Update FI to hold value of the index.
579 bool findVariableFrameIndex(const DbgVariable *V, int *FI);
581 /// findVariableLabel - Find MCSymbol for the variable.
582 const MCSymbol *findVariableLabel(const DbgVariable *V);
584 /// findDbgScope - Find DbgScope for the debug loc attached with an
586 DbgScope *findDbgScope(const MachineInstr *MI);
588 /// identifyScopeMarkers() - Indentify instructions that are marking
589 /// beginning of or end of a scope.
590 void identifyScopeMarkers();
592 /// extractScopeInformation - Scan machine instructions in this function
593 /// and collect DbgScopes. Return true, if atleast one scope was found.
594 bool extractScopeInformation();
596 /// collectVariableInfo - Populate DbgScope entries with variables' info.
597 void collectVariableInfo(const MachineFunction *,
598 SmallPtrSet<const MDNode *, 16> &ProcessedVars);
600 /// collectVariableInfoFromMMITable - Collect variable information from
601 /// side table maintained by MMI.
602 void collectVariableInfoFromMMITable(const MachineFunction * MF,
603 SmallPtrSet<const MDNode *, 16> &P);
605 //===--------------------------------------------------------------------===//
606 // Main entry points.
608 DwarfDebug(AsmPrinter *A, Module *M);
611 /// beginModule - Emit all Dwarf sections that should come prior to the
613 void beginModule(Module *M);
615 /// endModule - Emit all Dwarf sections that should come after the content.
619 /// beginFunction - Gather pre-function debug information. Assumes being
620 /// emitted immediately after the function entry point.
621 void beginFunction(const MachineFunction *MF);
623 /// endFunction - Gather and emit post-function debug information.
625 void endFunction(const MachineFunction *MF);
627 /// getLabelBeforeInsn - Return Label preceding the instruction.
628 const MCSymbol *getLabelBeforeInsn(const MachineInstr *MI);
630 /// getLabelAfterInsn - Return Label immediately following the instruction.
631 const MCSymbol *getLabelAfterInsn(const MachineInstr *MI);
633 /// beginScope - Process beginning of a scope.
634 void beginScope(const MachineInstr *MI);
636 /// endScope - Prcess end of a scope.
637 void endScope(const MachineInstr *MI);
639 } // End of namespace llvm