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__
18 #include "DwarfPrinter.h"
19 #include "llvm/CodeGen/AsmPrinter.h"
20 #include "llvm/CodeGen/MachineLocation.h"
21 #include "llvm/Analysis/DebugInfo.h"
22 #include "llvm/Support/raw_ostream.h"
23 #include "llvm/ADT/DenseMap.h"
24 #include "llvm/ADT/FoldingSet.h"
25 #include "llvm/ADT/SmallSet.h"
26 #include "llvm/ADT/StringMap.h"
27 #include "llvm/ADT/UniqueVector.h"
33 class DbgConcreteScope;
36 class MachineFrameInfo;
37 class MachineModuleInfo;
41 //===----------------------------------------------------------------------===//
42 /// SrcLineInfo - This class is used to record source line correspondence.
45 unsigned Line; // Source line number.
46 unsigned Column; // Source column.
47 unsigned SourceID; // Source ID number.
48 MCSymbol *Label; // Label in code ID number.
50 SrcLineInfo(unsigned L, unsigned C, unsigned S, MCSymbol *label)
51 : Line(L), Column(C), SourceID(S), Label(label) {}
54 unsigned getLine() const { return Line; }
55 unsigned getColumn() const { return Column; }
56 unsigned getSourceID() const { return SourceID; }
57 MCSymbol *getLabel() const { return Label; }
60 class DwarfDebug : public DwarfPrinter {
61 //===--------------------------------------------------------------------===//
62 // Attributes used to construct specific Dwarf sections.
65 /// ModuleCU - All DIEs are inserted in ModuleCU.
66 CompileUnit *ModuleCU;
68 /// AbbreviationsSet - Used to uniquely define abbreviations.
70 FoldingSet<DIEAbbrev> AbbreviationsSet;
72 /// Abbreviations - A list of all the unique abbreviations in use.
74 std::vector<DIEAbbrev *> Abbreviations;
76 /// DirectoryIdMap - Directory name to directory id map.
78 StringMap<unsigned> DirectoryIdMap;
80 /// DirectoryNames - A list of directory names.
81 SmallVector<std::string, 8> DirectoryNames;
83 /// SourceFileIdMap - Source file name to source file id map.
85 StringMap<unsigned> SourceFileIdMap;
87 /// SourceFileNames - A list of source file names.
88 SmallVector<std::string, 8> SourceFileNames;
90 /// SourceIdMap - Source id map, i.e. pair of directory id and source file
91 /// id mapped to a unique id.
92 DenseMap<std::pair<unsigned, unsigned>, unsigned> SourceIdMap;
94 /// SourceIds - Reverse map from source id to directory id + file id pair.
96 SmallVector<std::pair<unsigned, unsigned>, 8> SourceIds;
98 /// Lines - List of source line correspondence.
99 std::vector<SrcLineInfo> Lines;
101 /// DIEValues - A list of all the unique values in use.
103 std::vector<DIEValue *> DIEValues;
105 /// StringPool - A String->Symbol mapping of strings used by indirect
107 StringMap<std::pair<MCSymbol*, unsigned> > StringPool;
108 unsigned NextStringPoolNumber;
110 MCSymbol *getStringPoolEntry(StringRef Str);
112 /// SectionMap - Provides a unique id per text section.
114 UniqueVector<const MCSection*> SectionMap;
116 /// SectionSourceLines - Tracks line numbers per text section.
118 std::vector<std::vector<SrcLineInfo> > SectionSourceLines;
120 /// didInitial - Flag to indicate if initial emission has been done.
124 /// shouldEmit - Flag to indicate if debug information should be emitted.
128 // CurrentFnDbgScope - Top level scope for the current function.
130 DbgScope *CurrentFnDbgScope;
132 /// DbgScopeMap - Tracks the scopes in the current function. Owns the
133 /// contained DbgScope*s.
135 DenseMap<MDNode *, DbgScope *> DbgScopeMap;
137 /// ConcreteScopes - Tracks the concrete scopees in the current function.
138 /// These scopes are also included in DbgScopeMap.
139 DenseMap<MDNode *, DbgScope *> ConcreteScopes;
141 /// AbstractScopes - Tracks the abstract scopes a module. These scopes are
142 /// not included DbgScopeMap. AbstractScopes owns its DbgScope*s.
143 DenseMap<MDNode *, DbgScope *> AbstractScopes;
145 /// AbstractScopesList - Tracks abstract scopes constructed while processing
146 /// a function. This list is cleared during endFunction().
147 SmallVector<DbgScope *, 4>AbstractScopesList;
149 /// AbstractVariables - Collection on abstract variables. Owned by the
150 /// DbgScopes in AbstractScopes.
151 DenseMap<MDNode *, DbgVariable *> AbstractVariables;
153 /// InliendSubprogramDIEs - Collection of subprgram DIEs that are marked
154 /// (at the end of the module) as DW_AT_inline.
155 SmallPtrSet<DIE *, 4> InlinedSubprogramDIEs;
157 DenseMap<DIE *, MDNode *> ContainingTypeMap;
159 /// AbstractSubprogramDIEs - Collection of abstruct subprogram DIEs.
160 SmallPtrSet<DIE *, 4> AbstractSubprogramDIEs;
162 /// TopLevelDIEs - Collection of top level DIEs.
163 SmallPtrSet<DIE *, 4> TopLevelDIEs;
164 SmallVector<DIE *, 4> TopLevelDIEsVector;
166 typedef SmallVector<DbgScope *, 2> ScopeVector;
167 typedef DenseMap<const MachineInstr *, ScopeVector>
170 /// DbgScopeBeginMap - Maps instruction with a list of DbgScopes it starts.
171 InsnToDbgScopeMapTy DbgScopeBeginMap;
173 /// DbgScopeEndMap - Maps instruction with a list DbgScopes it ends.
174 InsnToDbgScopeMapTy DbgScopeEndMap;
176 /// InlineInfo - Keep track of inlined functions and their location. This
177 /// information is used to populate debug_inlined section.
178 typedef std::pair<MCSymbol*, DIE *> InlineInfoLabels;
179 DenseMap<MDNode*, SmallVector<InlineInfoLabels, 4> > InlineInfo;
180 SmallVector<MDNode *, 4> InlinedSPNodes;
182 /// CompileUnitOffsets - A vector of the offsets of the compile units. This is
183 /// used when calculating the "origin" of a concrete instance of an inlined
185 DenseMap<CompileUnit *, unsigned> CompileUnitOffsets;
187 /// Previous instruction's location information. This is used to determine
188 /// label location to indicate scope boundries in dwarf debug info.
189 mutable const MDNode *PrevDILoc;
191 /// DebugTimer - Timer for the Dwarf debug writer.
194 struct FunctionDebugFrameInfo {
196 std::vector<MachineMove> Moves;
198 FunctionDebugFrameInfo(unsigned Num, const std::vector<MachineMove> &M)
199 : Number(Num), Moves(M) {}
202 std::vector<FunctionDebugFrameInfo> DebugFrames;
204 /// getSourceDirectoryAndFileIds - Return the directory and file ids that
205 /// maps to the source id. Source id starts at 1.
206 std::pair<unsigned, unsigned>
207 getSourceDirectoryAndFileIds(unsigned SId) const {
208 return SourceIds[SId-1];
211 /// getNumSourceDirectories - Return the number of source directories in the
213 unsigned getNumSourceDirectories() const {
214 return DirectoryNames.size();
217 /// getSourceDirectoryName - Return the name of the directory corresponding
219 const std::string &getSourceDirectoryName(unsigned Id) const {
220 return DirectoryNames[Id - 1];
223 /// getSourceFileName - Return the name of the source file corresponding
225 const std::string &getSourceFileName(unsigned Id) const {
226 return SourceFileNames[Id - 1];
229 /// getNumSourceIds - Return the number of unique source ids.
230 unsigned getNumSourceIds() const {
231 return SourceIds.size();
234 /// assignAbbrevNumber - Define a unique number for the abbreviation.
236 void assignAbbrevNumber(DIEAbbrev &Abbrev);
238 /// createDIEEntry - Creates a new DIEEntry to be a proxy for a debug
239 /// information entry.
240 DIEEntry *createDIEEntry(DIE *Entry);
242 /// addUInt - Add an unsigned integer attribute data and value.
244 void addUInt(DIE *Die, unsigned Attribute, unsigned Form, uint64_t Integer);
246 /// addSInt - Add an signed integer attribute data and value.
248 void addSInt(DIE *Die, unsigned Attribute, unsigned Form, int64_t Integer);
250 /// addString - Add a string attribute data and value.
252 void addString(DIE *Die, unsigned Attribute, unsigned Form,
253 const StringRef Str);
255 /// addLabel - Add a Dwarf label attribute data and value.
257 void addLabel(DIE *Die, unsigned Attribute, unsigned Form,
258 const MCSymbol *Label);
260 /// addDelta - Add a label delta attribute data and value.
262 void addDelta(DIE *Die, unsigned Attribute, unsigned Form,
263 const MCSymbol *Hi, const MCSymbol *Lo);
265 /// addDIEEntry - Add a DIE attribute data and value.
267 void addDIEEntry(DIE *Die, unsigned Attribute, unsigned Form, DIE *Entry) {
268 Die->addValue(Attribute, Form, createDIEEntry(Entry));
271 /// addBlock - Add block data.
273 void addBlock(DIE *Die, unsigned Attribute, unsigned Form, DIEBlock *Block);
275 /// addSourceLine - Add location information to specified debug information
277 void addSourceLine(DIE *Die, const DIVariable *V);
278 void addSourceLine(DIE *Die, const DIGlobal *G);
279 void addSourceLine(DIE *Die, const DISubprogram *SP);
280 void addSourceLine(DIE *Die, const DIType *Ty);
281 void addSourceLine(DIE *Die, const DINameSpace *NS);
283 /// addAddress - Add an address attribute to a die based on the location
285 void addAddress(DIE *Die, unsigned Attribute,
286 const MachineLocation &Location);
288 /// addComplexAddress - Start with the address based on the location provided,
289 /// and generate the DWARF information necessary to find the actual variable
290 /// (navigating the extra location information encoded in the type) based on
291 /// the starting location. Add the DWARF information to the die.
293 void addComplexAddress(DbgVariable *&DV, DIE *Die, unsigned Attribute,
294 const MachineLocation &Location);
296 // FIXME: Should be reformulated in terms of addComplexAddress.
297 /// addBlockByrefAddress - Start with the address based on the location
298 /// provided, and generate the DWARF information necessary to find the
299 /// actual Block variable (navigating the Block struct) based on the
300 /// starting location. Add the DWARF information to the die. Obsolete,
301 /// please use addComplexAddress instead.
303 void addBlockByrefAddress(DbgVariable *&DV, DIE *Die, unsigned Attribute,
304 const MachineLocation &Location);
306 /// addToContextOwner - Add Die into the list of its context owner's children.
307 void addToContextOwner(DIE *Die, DIDescriptor Context);
309 /// addType - Add a new type attribute to the specified entity.
310 void addType(DIE *Entity, DIType Ty);
313 /// getOrCreateNameSpace - Create a DIE for DINameSpace.
314 DIE *getOrCreateNameSpace(DINameSpace NS);
316 /// getOrCreateTypeDIE - Find existing DIE or create new DIE for the
318 DIE *getOrCreateTypeDIE(DIType Ty);
320 void addPubTypes(DISubprogram SP);
322 /// constructTypeDIE - Construct basic type die from DIBasicType.
323 void constructTypeDIE(DIE &Buffer,
326 /// constructTypeDIE - Construct derived type die from DIDerivedType.
327 void constructTypeDIE(DIE &Buffer,
330 /// constructTypeDIE - Construct type DIE from DICompositeType.
331 void constructTypeDIE(DIE &Buffer,
332 DICompositeType CTy);
334 /// constructSubrangeDIE - Construct subrange DIE from DISubrange.
335 void constructSubrangeDIE(DIE &Buffer, DISubrange SR, DIE *IndexTy);
337 /// constructArrayTypeDIE - Construct array type DIE from DICompositeType.
338 void constructArrayTypeDIE(DIE &Buffer,
339 DICompositeType *CTy);
341 /// constructEnumTypeDIE - Construct enum type DIE from DIEnumerator.
342 DIE *constructEnumTypeDIE(DIEnumerator ETy);
344 /// createGlobalVariableDIE - Create new DIE using GV.
345 DIE *createGlobalVariableDIE(const DIGlobalVariable &GV);
347 /// createMemberDIE - Create new member DIE.
348 DIE *createMemberDIE(const DIDerivedType &DT);
350 /// createSubprogramDIE - Create new DIE using SP.
351 DIE *createSubprogramDIE(const DISubprogram &SP, bool MakeDecl = false);
353 /// getUpdatedDbgScope - Find or create DbgScope assicated with
354 /// the instruction. Initialize scope and update scope hierarchy.
355 DbgScope *getUpdatedDbgScope(MDNode *N, const MachineInstr *MI, MDNode *InlinedAt);
357 /// createDbgScope - Create DbgScope for the scope.
358 void createDbgScope(MDNode *Scope, MDNode *InlinedAt);
360 DbgScope *getOrCreateAbstractScope(MDNode *N);
362 /// findAbstractVariable - Find abstract variable associated with Var.
363 DbgVariable *findAbstractVariable(DIVariable &Var, unsigned FrameIdx,
365 DbgVariable *findAbstractVariable(DIVariable &Var, const MachineInstr *MI,
368 /// updateSubprogramScopeDIE - Find DIE for the given subprogram and
369 /// attach appropriate DW_AT_low_pc and DW_AT_high_pc attributes.
370 /// If there are global variables in this scope then create and insert
371 /// DIEs for these variables.
372 DIE *updateSubprogramScopeDIE(MDNode *SPNode);
374 /// constructLexicalScope - Construct new DW_TAG_lexical_block
375 /// for this scope and attach DW_AT_low_pc/DW_AT_high_pc labels.
376 DIE *constructLexicalScopeDIE(DbgScope *Scope);
378 /// constructInlinedScopeDIE - This scope represents inlined body of
379 /// a function. Construct DIE to represent this concrete inlined copy
381 DIE *constructInlinedScopeDIE(DbgScope *Scope);
383 /// constructVariableDIE - Construct a DIE for the given DbgVariable.
384 DIE *constructVariableDIE(DbgVariable *DV, DbgScope *S);
386 /// constructScopeDIE - Construct a DIE for this scope.
387 DIE *constructScopeDIE(DbgScope *Scope);
389 /// emitInitial - Emit initial Dwarf declarations. This is necessary for cc
390 /// tools to recognize the object file contains Dwarf information.
393 /// emitDIE - Recusively Emits a debug information entry.
395 void emitDIE(DIE *Die);
397 /// computeSizeAndOffset - Compute the size and offset of a DIE.
399 unsigned computeSizeAndOffset(DIE *Die, unsigned Offset, bool Last);
401 /// computeSizeAndOffsets - Compute the size and offset of all the DIEs.
403 void computeSizeAndOffsets();
405 /// EmitDebugInfo - Emit the debug info section.
407 void emitDebugInfo();
409 /// emitAbbreviations - Emit the abbreviation section.
411 void emitAbbreviations() const;
413 /// emitEndOfLineMatrix - Emit the last address of the section and the end of
416 void emitEndOfLineMatrix(unsigned SectionEnd);
418 /// emitDebugLines - Emit source line information.
420 void emitDebugLines();
422 /// emitCommonDebugFrame - Emit common frame info into a debug frame section.
424 void emitCommonDebugFrame();
426 /// emitFunctionDebugFrame - Emit per function frame info into a debug frame
428 void emitFunctionDebugFrame(const FunctionDebugFrameInfo &DebugFrameInfo);
430 /// emitDebugPubNames - Emit visible names into a debug pubnames section.
432 void emitDebugPubNames();
434 /// emitDebugPubTypes - Emit visible types into a debug pubtypes section.
436 void emitDebugPubTypes();
438 /// emitDebugStr - Emit visible names into a debug str section.
442 /// emitDebugLoc - Emit visible names into a debug loc section.
446 /// EmitDebugARanges - Emit visible names into a debug aranges section.
448 void EmitDebugARanges();
450 /// emitDebugRanges - Emit visible names into a debug ranges section.
452 void emitDebugRanges();
454 /// emitDebugMacInfo - Emit visible names into a debug macinfo section.
456 void emitDebugMacInfo();
458 /// emitDebugInlineInfo - Emit inline info using following format.
460 /// 1. length of section
461 /// 2. Dwarf version number
464 /// Entries (one "entry" for each function that was inlined):
466 /// 1. offset into __debug_str section for MIPS linkage name, if exists;
467 /// otherwise offset into __debug_str for regular function name.
468 /// 2. offset into __debug_str section for regular function name.
469 /// 3. an unsigned LEB128 number indicating the number of distinct inlining
470 /// instances for the function.
472 /// The rest of the entry consists of a {die_offset, low_pc} pair for each
473 /// inlined instance; the die_offset points to the inlined_subroutine die in
474 /// the __debug_info section, and the low_pc is the starting address for the
475 /// inlining instance.
476 void emitDebugInlineInfo();
478 /// GetOrCreateSourceID - Look up the source id with the given directory and
479 /// source file names. If none currently exists, create a new id and insert it
480 /// in the SourceIds map. This can update DirectoryNames and SourceFileNames maps
482 unsigned GetOrCreateSourceID(StringRef DirName, StringRef FileName);
484 void constructCompileUnit(MDNode *N);
486 void constructGlobalVariableDIE(MDNode *N);
488 void constructSubprogramDIE(MDNode *N);
490 // FIXME: This should go away in favor of complex addresses.
491 /// Find the type the programmer originally declared the variable to be
492 /// and return that type. Obsolete, use GetComplexAddrType instead.
494 DIType getBlockByrefType(DIType Ty, std::string Name);
497 //===--------------------------------------------------------------------===//
498 // Main entry points.
500 DwarfDebug(raw_ostream &OS, AsmPrinter *A, const MCAsmInfo *T);
501 virtual ~DwarfDebug();
503 /// ShouldEmitDwarfDebug - Returns true if Dwarf debugging declarations should
505 bool ShouldEmitDwarfDebug() const { return shouldEmit; }
507 /// beginModule - Emit all Dwarf sections that should come prior to the
509 void beginModule(Module *M, MachineModuleInfo *MMI);
511 /// endModule - Emit all Dwarf sections that should come after the content.
515 /// beginFunction - Gather pre-function debug information. Assumes being
516 /// emitted immediately after the function entry point.
517 void beginFunction(const MachineFunction *MF);
519 /// endFunction - Gather and emit post-function debug information.
521 void endFunction(const MachineFunction *MF);
523 /// recordSourceLine - Register a source line with debug info. Returns the
524 /// unique label that was emitted and which provides correspondence to
525 /// the source line list.
526 MCSymbol *recordSourceLine(unsigned Line, unsigned Col, MDNode *Scope);
528 /// getSourceLineCount - Return the number of source lines in the debug
530 unsigned getSourceLineCount() const {
534 /// getOrCreateSourceID - Public version of GetOrCreateSourceID. This can be
535 /// timed. Look up the source id with the given directory and source file
536 /// names. If none currently exists, create a new id and insert it in the
537 /// SourceIds map. This can update DirectoryNames and SourceFileNames maps as
539 unsigned getOrCreateSourceID(const std::string &DirName,
540 const std::string &FileName);
542 /// extractScopeInformation - Scan machine instructions in this function
543 /// and collect DbgScopes. Return true, if atleast one scope was found.
544 bool extractScopeInformation();
546 /// collectVariableInfo - Populate DbgScope entries with variables' info.
547 void collectVariableInfo();
549 /// beginScope - Process beginning of a scope.
550 void beginScope(const MachineInstr *MI);
552 /// endScope - Prcess end of a scope.
553 void endScope(const MachineInstr *MI);
555 } // End of namespace llvm