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 /// InlineInfo - Keep track of inlined functions and their location. This
204 /// information is used to populate debug_inlined section.
205 typedef std::pair<const MCSymbol *, DIE *> InlineInfoLabels;
206 DenseMap<const MDNode *, SmallVector<InlineInfoLabels, 4> > InlineInfo;
207 SmallVector<const MDNode *, 4> InlinedSPNodes;
209 // ProcessedSPNodes - This is a collection of subprogram MDNodes that
210 // are processed to create DIEs.
211 SmallPtrSet<const MDNode *, 16> ProcessedSPNodes;
213 /// LabelsBeforeInsn - Maps instruction with label emitted before
215 DenseMap<const MachineInstr *, MCSymbol *> LabelsBeforeInsn;
217 /// LabelsAfterInsn - Maps instruction with label emitted after
219 DenseMap<const MachineInstr *, MCSymbol *> LabelsAfterInsn;
221 /// UserVariables - Every user variable mentioned by a DBG_VALUE instruction
222 /// in order of appearance.
223 SmallVector<const MDNode*, 8> UserVariables;
225 /// DbgValues - For each user variable, keep a list of DBG_VALUE
226 /// instructions in order. The list can also contain normal instructions that
227 /// clobber the previous DBG_VALUE.
228 typedef DenseMap<const MDNode*, SmallVector<const MachineInstr*, 4> >
230 DbgValueHistoryMap DbgValues;
232 SmallVector<const MCSymbol *, 8> DebugRangeSymbols;
234 /// Previous instruction's location information. This is used to determine
235 /// label location to indicate scope boundries in dwarf debug info.
236 DebugLoc PrevInstLoc;
239 struct FunctionDebugFrameInfo {
241 std::vector<MachineMove> Moves;
243 FunctionDebugFrameInfo(unsigned Num, const std::vector<MachineMove> &M)
244 : Number(Num), Moves(M) {}
247 std::vector<FunctionDebugFrameInfo> DebugFrames;
249 // Section Symbols: these are assembler temporary labels that are emitted at
250 // the beginning of each supported dwarf section. These are used to form
251 // section offsets and are created by EmitSectionLabels.
252 MCSymbol *DwarfFrameSectionSym, *DwarfInfoSectionSym, *DwarfAbbrevSectionSym;
253 MCSymbol *DwarfStrSectionSym, *TextSectionSym, *DwarfDebugRangeSectionSym;
254 MCSymbol *DwarfDebugLocSectionSym;
255 MCSymbol *FunctionBeginSym, *FunctionEndSym;
257 DIEInteger *DIEIntegerOne;
260 /// getNumSourceIds - Return the number of unique source ids.
261 unsigned getNumSourceIds() const {
262 return SourceIdMap.size();
265 /// assignAbbrevNumber - Define a unique number for the abbreviation.
267 void assignAbbrevNumber(DIEAbbrev &Abbrev);
269 /// createDIEEntry - Creates a new DIEEntry to be a proxy for a debug
270 /// information entry.
271 DIEEntry *createDIEEntry(DIE *Entry);
273 /// addUInt - Add an unsigned integer attribute data and value.
275 void addUInt(DIE *Die, unsigned Attribute, unsigned Form, uint64_t Integer);
277 /// addSInt - Add an signed integer attribute data and value.
279 void addSInt(DIE *Die, unsigned Attribute, unsigned Form, int64_t Integer);
281 /// addString - Add a string attribute data and value.
283 void addString(DIE *Die, unsigned Attribute, unsigned Form,
284 const StringRef Str);
286 /// addLabel - Add a Dwarf label attribute data and value.
288 void addLabel(DIE *Die, unsigned Attribute, unsigned Form,
289 const MCSymbol *Label);
291 /// addDelta - Add a label delta attribute data and value.
293 void addDelta(DIE *Die, unsigned Attribute, unsigned Form,
294 const MCSymbol *Hi, const MCSymbol *Lo);
296 /// addDIEEntry - Add a DIE attribute data and value.
298 void addDIEEntry(DIE *Die, unsigned Attribute, unsigned Form, DIE *Entry);
300 /// addBlock - Add block data.
302 void addBlock(DIE *Die, unsigned Attribute, unsigned Form, DIEBlock *Block);
304 /// addSourceLine - Add location information to specified debug information
306 void addSourceLine(DIE *Die, DIVariable V);
307 void addSourceLine(DIE *Die, DIGlobalVariable G);
308 void addSourceLine(DIE *Die, DISubprogram SP);
309 void addSourceLine(DIE *Die, DIType Ty);
310 void addSourceLine(DIE *Die, DINameSpace NS);
312 /// addAddress - Add an address attribute to a die based on the location
314 void addAddress(DIE *Die, unsigned Attribute,
315 const MachineLocation &Location);
317 /// addRegisterAddress - Add register location entry in variable DIE.
318 bool addRegisterAddress(DIE *Die, const MachineOperand &MO);
320 /// addConstantValue - Add constant value entry in variable DIE.
321 bool addConstantValue(DIE *Die, const MachineOperand &MO);
322 bool addConstantValue(DIE *Die, ConstantInt *CI, bool Unsigned);
324 /// addConstantFPValue - Add constant value entry in variable DIE.
325 bool addConstantFPValue(DIE *Die, const MachineOperand &MO);
327 /// addComplexAddress - Start with the address based on the location provided,
328 /// and generate the DWARF information necessary to find the actual variable
329 /// (navigating the extra location information encoded in the type) based on
330 /// the starting location. Add the DWARF information to the die.
332 void addComplexAddress(DbgVariable *&DV, DIE *Die, unsigned Attribute,
333 const MachineLocation &Location);
335 // FIXME: Should be reformulated in terms of addComplexAddress.
336 /// addBlockByrefAddress - Start with the address based on the location
337 /// provided, and generate the DWARF information necessary to find the
338 /// actual Block variable (navigating the Block struct) based on the
339 /// starting location. Add the DWARF information to the die. Obsolete,
340 /// please use addComplexAddress instead.
342 void addBlockByrefAddress(DbgVariable *&DV, DIE *Die, unsigned Attribute,
343 const MachineLocation &Location);
345 /// addVariableAddress - Add DW_AT_location attribute for a DbgVariable based
346 /// on provided frame index.
347 void addVariableAddress(DbgVariable *&DV, DIE *Die, int64_t FI);
349 /// addToContextOwner - Add Die into the list of its context owner's children.
350 void addToContextOwner(DIE *Die, DIDescriptor Context);
352 /// addType - Add a new type attribute to the specified entity.
353 void addType(DIE *Entity, DIType Ty);
356 /// getOrCreateNameSpace - Create a DIE for DINameSpace.
357 DIE *getOrCreateNameSpace(DINameSpace NS);
359 /// getOrCreateTypeDIE - Find existing DIE or create new DIE for the
361 DIE *getOrCreateTypeDIE(DIType Ty);
363 /// getOrCreateTemplateTypeParameterDIE - Find existing DIE or create new DIE
364 /// for the given DITemplateTypeParameter.
365 DIE *getOrCreateTemplateTypeParameterDIE(DITemplateTypeParameter TP);
367 /// getOrCreateTemplateValueParameterDIE - Find existing DIE or create new DIE
368 /// for the given DITemplateValueParameter.
369 DIE *getOrCreateTemplateValueParameterDIE(DITemplateValueParameter TVP);
371 void addPubTypes(DISubprogram SP);
373 /// constructTypeDIE - Construct basic type die from DIBasicType.
374 void constructTypeDIE(DIE &Buffer,
377 /// constructTypeDIE - Construct derived type die from DIDerivedType.
378 void constructTypeDIE(DIE &Buffer,
381 /// constructTypeDIE - Construct type DIE from DICompositeType.
382 void constructTypeDIE(DIE &Buffer,
383 DICompositeType CTy);
385 /// constructSubrangeDIE - Construct subrange DIE from DISubrange.
386 void constructSubrangeDIE(DIE &Buffer, DISubrange SR, DIE *IndexTy);
388 /// constructArrayTypeDIE - Construct array type DIE from DICompositeType.
389 void constructArrayTypeDIE(DIE &Buffer,
390 DICompositeType *CTy);
392 /// constructEnumTypeDIE - Construct enum type DIE from DIEnumerator.
393 DIE *constructEnumTypeDIE(DIEnumerator ETy);
395 /// createMemberDIE - Create new member DIE.
396 DIE *createMemberDIE(DIDerivedType DT);
398 /// createSubprogramDIE - Create new DIE using SP.
399 DIE *createSubprogramDIE(DISubprogram SP);
401 /// getOrCreateDbgScope - Create DbgScope for the scope.
402 DbgScope *getOrCreateDbgScope(const MDNode *Scope, const MDNode *InlinedAt);
404 DbgScope *getOrCreateAbstractScope(const MDNode *N);
406 /// findAbstractVariable - Find abstract variable associated with Var.
407 DbgVariable *findAbstractVariable(DIVariable &Var, DebugLoc Loc);
409 /// updateSubprogramScopeDIE - Find DIE for the given subprogram and
410 /// attach appropriate DW_AT_low_pc and DW_AT_high_pc attributes.
411 /// If there are global variables in this scope then create and insert
412 /// DIEs for these variables.
413 DIE *updateSubprogramScopeDIE(const MDNode *SPNode);
415 /// constructLexicalScope - Construct new DW_TAG_lexical_block
416 /// for this scope and attach DW_AT_low_pc/DW_AT_high_pc labels.
417 DIE *constructLexicalScopeDIE(DbgScope *Scope);
419 /// constructInlinedScopeDIE - This scope represents inlined body of
420 /// a function. Construct DIE to represent this concrete inlined copy
422 DIE *constructInlinedScopeDIE(DbgScope *Scope);
424 /// constructVariableDIE - Construct a DIE for the given DbgVariable.
425 DIE *constructVariableDIE(DbgVariable *DV, DbgScope *S);
427 /// constructScopeDIE - Construct a DIE for this scope.
428 DIE *constructScopeDIE(DbgScope *Scope);
430 /// EmitSectionLabels - Emit initial Dwarf sections with a label at
431 /// the start of each one.
432 void EmitSectionLabels();
434 /// emitDIE - Recusively Emits a debug information entry.
436 void emitDIE(DIE *Die);
438 /// computeSizeAndOffset - Compute the size and offset of a DIE.
440 unsigned computeSizeAndOffset(DIE *Die, unsigned Offset, bool Last);
442 /// computeSizeAndOffsets - Compute the size and offset of all the DIEs.
444 void computeSizeAndOffsets();
446 /// EmitDebugInfo - Emit the debug info section.
448 void emitDebugInfo();
450 /// emitAbbreviations - Emit the abbreviation section.
452 void emitAbbreviations() const;
454 /// emitEndOfLineMatrix - Emit the last address of the section and the end of
457 void emitEndOfLineMatrix(unsigned SectionEnd);
459 /// emitCommonDebugFrame - Emit common frame info into a debug frame section.
461 void emitCommonDebugFrame();
463 /// emitFunctionDebugFrame - Emit per function frame info into a debug frame
465 void emitFunctionDebugFrame(const FunctionDebugFrameInfo &DebugFrameInfo);
467 /// emitDebugPubNames - Emit visible names into a debug pubnames section.
469 void emitDebugPubNames();
471 /// emitDebugPubTypes - Emit visible types into a debug pubtypes section.
473 void emitDebugPubTypes();
475 /// emitDebugStr - Emit visible names into a debug str section.
479 /// emitDebugLoc - Emit visible names into a debug loc section.
483 /// EmitDebugARanges - Emit visible names into a debug aranges section.
485 void EmitDebugARanges();
487 /// emitDebugRanges - Emit visible names into a debug ranges section.
489 void emitDebugRanges();
491 /// emitDebugMacInfo - Emit visible names into a debug macinfo section.
493 void emitDebugMacInfo();
495 /// emitDebugInlineInfo - Emit inline info using following format.
497 /// 1. length of section
498 /// 2. Dwarf version number
501 /// Entries (one "entry" for each function that was inlined):
503 /// 1. offset into __debug_str section for MIPS linkage name, if exists;
504 /// otherwise offset into __debug_str for regular function name.
505 /// 2. offset into __debug_str section for regular function name.
506 /// 3. an unsigned LEB128 number indicating the number of distinct inlining
507 /// instances for the function.
509 /// The rest of the entry consists of a {die_offset, low_pc} pair for each
510 /// inlined instance; the die_offset points to the inlined_subroutine die in
511 /// the __debug_info section, and the low_pc is the starting address for the
512 /// inlining instance.
513 void emitDebugInlineInfo();
515 /// GetOrCreateSourceID - Look up the source id with the given directory and
516 /// source file names. If none currently exists, create a new id and insert it
517 /// in the SourceIds map.
518 unsigned GetOrCreateSourceID(StringRef DirName, StringRef FullName);
520 /// constructCompileUnit - Create new CompileUnit for the given
521 /// metadata node with tag DW_TAG_compile_unit.
522 void constructCompileUnit(const MDNode *N);
524 /// getCompielUnit - Get CompileUnit DIE.
525 CompileUnit *getCompileUnit(const MDNode *N) const;
527 /// constructGlobalVariableDIE - Construct global variable DIE.
528 void constructGlobalVariableDIE(const MDNode *N);
530 /// construct SubprogramDIE - Construct subprogram DIE.
531 void constructSubprogramDIE(const MDNode *N);
533 /// recordSourceLine - Register a source line with debug info. Returns the
534 /// unique label that was emitted and which provides correspondence to
535 /// the source line list.
536 void recordSourceLine(unsigned Line, unsigned Col, const MDNode *Scope);
538 /// recordVariableFrameIndex - Record a variable's index.
539 void recordVariableFrameIndex(const DbgVariable *V, int Index);
541 /// findVariableFrameIndex - Return true if frame index for the variable
542 /// is found. Update FI to hold value of the index.
543 bool findVariableFrameIndex(const DbgVariable *V, int *FI);
545 /// findDbgScope - Find DbgScope for the debug loc attached with an
547 DbgScope *findDbgScope(const MachineInstr *MI);
549 /// identifyScopeMarkers() - Indentify instructions that are marking
550 /// beginning of or end of a scope.
551 void identifyScopeMarkers();
553 /// extractScopeInformation - Scan machine instructions in this function
554 /// and collect DbgScopes. Return true, if atleast one scope was found.
555 bool extractScopeInformation();
557 /// addCurrentFnArgument - If Var is an current function argument that add
558 /// it in CurrentFnArguments list.
559 bool addCurrentFnArgument(const MachineFunction *MF,
560 DbgVariable *Var, DbgScope *Scope);
562 /// collectVariableInfo - Populate DbgScope entries with variables' info.
563 void collectVariableInfo(const MachineFunction *,
564 SmallPtrSet<const MDNode *, 16> &ProcessedVars);
566 /// collectVariableInfoFromMMITable - Collect variable information from
567 /// side table maintained by MMI.
568 void collectVariableInfoFromMMITable(const MachineFunction * MF,
569 SmallPtrSet<const MDNode *, 16> &P);
571 /// requestLabelBeforeInsn - Ensure that a label will be emitted before MI.
572 void requestLabelBeforeInsn(const MachineInstr *MI) {
573 LabelsBeforeInsn.insert(std::make_pair(MI, (MCSymbol*)0));
576 /// getLabelBeforeInsn - Return Label preceding the instruction.
577 const MCSymbol *getLabelBeforeInsn(const MachineInstr *MI);
579 /// requestLabelAfterInsn - Ensure that a label will be emitted after MI.
580 void requestLabelAfterInsn(const MachineInstr *MI) {
581 LabelsAfterInsn.insert(std::make_pair(MI, (MCSymbol*)0));
584 /// getLabelAfterInsn - Return Label immediately following the instruction.
585 const MCSymbol *getLabelAfterInsn(const MachineInstr *MI);
588 //===--------------------------------------------------------------------===//
589 // Main entry points.
591 DwarfDebug(AsmPrinter *A, Module *M);
594 /// beginModule - Emit all Dwarf sections that should come prior to the
596 void beginModule(Module *M);
598 /// endModule - Emit all Dwarf sections that should come after the content.
602 /// beginFunction - Gather pre-function debug information. Assumes being
603 /// emitted immediately after the function entry point.
604 void beginFunction(const MachineFunction *MF);
606 /// endFunction - Gather and emit post-function debug information.
608 void endFunction(const MachineFunction *MF);
610 /// beginInstruction - Process beginning of an instruction.
611 void beginInstruction(const MachineInstr *MI);
613 /// endInstruction - Prcess end of an instruction.
614 void endInstruction(const MachineInstr *MI);
616 } // End of namespace llvm