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/ValueMap.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 unsigned LabelID; // Label in code ID number.
50 SrcLineInfo(unsigned L, unsigned C, unsigned S, unsigned I)
51 : Line(L), Column(C), SourceID(S), LabelID(I) {}
54 unsigned getLine() const { return Line; }
55 unsigned getColumn() const { return Column; }
56 unsigned getSourceID() const { return SourceID; }
57 unsigned getLabelID() const { return LabelID; }
60 class DwarfDebug : public Dwarf {
61 //===--------------------------------------------------------------------===//
62 // Attributes used to construct specific Dwarf sections.
65 /// CompileUnitMap - A map of global variables representing compile units to
67 DenseMap<Value *, CompileUnit *> CompileUnitMap;
69 /// CompileUnits - All the compile units in this module.
71 SmallVector<CompileUnit *, 8> CompileUnits;
73 /// ModuleCU - All DIEs are inserted in ModuleCU.
74 CompileUnit *ModuleCU;
76 /// AbbreviationsSet - Used to uniquely define abbreviations.
78 FoldingSet<DIEAbbrev> AbbreviationsSet;
80 /// Abbreviations - A list of all the unique abbreviations in use.
82 std::vector<DIEAbbrev *> Abbreviations;
84 /// DirectoryIdMap - Directory name to directory id map.
86 StringMap<unsigned> DirectoryIdMap;
88 /// DirectoryNames - A list of directory names.
89 SmallVector<std::string, 8> DirectoryNames;
91 /// SourceFileIdMap - Source file name to source file id map.
93 StringMap<unsigned> SourceFileIdMap;
95 /// SourceFileNames - A list of source file names.
96 SmallVector<std::string, 8> SourceFileNames;
98 /// SourceIdMap - Source id map, i.e. pair of directory id and source file
99 /// id mapped to a unique id.
100 DenseMap<std::pair<unsigned, unsigned>, unsigned> SourceIdMap;
102 /// SourceIds - Reverse map from source id to directory id + file id pair.
104 SmallVector<std::pair<unsigned, unsigned>, 8> SourceIds;
106 /// Lines - List of of source line correspondence.
107 std::vector<SrcLineInfo> Lines;
109 /// DIEValues - A list of all the unique values in use.
111 std::vector<DIEValue *> DIEValues;
113 /// StringPool - A UniqueVector of strings used by indirect references.
115 UniqueVector<std::string> StringPool;
117 /// SectionMap - Provides a unique id per text section.
119 UniqueVector<const MCSection*> SectionMap;
121 /// SectionSourceLines - Tracks line numbers per text section.
123 std::vector<std::vector<SrcLineInfo> > SectionSourceLines;
125 /// didInitial - Flag to indicate if initial emission has been done.
129 /// shouldEmit - Flag to indicate if debug information should be emitted.
133 // CurrentFnDbgScope - Top level scope for the current function.
135 DbgScope *CurrentFnDbgScope;
137 /// DbgScopeMap - Tracks the scopes in the current function.
139 ValueMap<MDNode *, DbgScope *> DbgScopeMap;
141 /// ConcreteScopes - Tracks the concrete scopees in the current function.
142 /// These scopes are also included in DbgScopeMap.
143 ValueMap<MDNode *, DbgScope *> ConcreteScopes;
145 /// AbstractScopes - Tracks the abstract scopes a module. These scopes are
146 /// not included DbgScopeMap.
147 ValueMap<MDNode *, DbgScope *> AbstractScopes;
148 SmallVector<DbgScope *, 4>AbstractScopesList;
150 /// AbstractVariables - Collection on abstract variables.
151 ValueMap<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 *, WeakVH> 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 /// ScopedGVs - Tracks global variables that are not at file scope.
167 /// For example void f() { static int b = 42; }
168 SmallVector<WeakVH, 4> ScopedGVs;
170 typedef SmallVector<DbgScope *, 2> ScopeVector;
171 typedef DenseMap<const MachineInstr *, ScopeVector>
174 /// DbgScopeBeginMap - Maps instruction with a list of DbgScopes it starts.
175 InsnToDbgScopeMapTy DbgScopeBeginMap;
177 /// DbgScopeEndMap - Maps instruction with a list DbgScopes it ends.
178 InsnToDbgScopeMapTy DbgScopeEndMap;
180 /// InlineInfo - Keep track of inlined functions and their location. This
181 /// information is used to populate debug_inlined section.
182 typedef std::pair<unsigned, DIE *> InlineInfoLabels;
183 ValueMap<MDNode *, SmallVector<InlineInfoLabels, 4> > InlineInfo;
184 SmallVector<MDNode *, 4> InlinedSPNodes;
186 /// CompileUnitOffsets - A vector of the offsets of the compile units. This is
187 /// used when calculating the "origin" of a concrete instance of an inlined
189 DenseMap<CompileUnit *, unsigned> CompileUnitOffsets;
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 = NULL);
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 DWLabel &Label);
260 /// addObjectLabel - Add an non-Dwarf label attribute data and value.
262 void addObjectLabel(DIE *Die, unsigned Attribute, unsigned Form,
263 const std::string &Label);
265 /// addSectionOffset - Add a section offset label attribute data and value.
267 void addSectionOffset(DIE *Die, unsigned Attribute, unsigned Form,
268 const DWLabel &Label, const DWLabel &Section,
269 bool isEH = false, bool useSet = true);
271 /// addDelta - Add a label delta attribute data and value.
273 void addDelta(DIE *Die, unsigned Attribute, unsigned Form,
274 const DWLabel &Hi, const DWLabel &Lo);
276 /// addDIEEntry - Add a DIE attribute data and value.
278 void addDIEEntry(DIE *Die, unsigned Attribute, unsigned Form, DIE *Entry) {
279 Die->addValue(Attribute, Form, createDIEEntry(Entry));
282 /// addBlock - Add block data.
284 void addBlock(DIE *Die, unsigned Attribute, unsigned Form, DIEBlock *Block);
286 /// addSourceLine - Add location information to specified debug information
288 void addSourceLine(DIE *Die, const DIVariable *V);
289 void addSourceLine(DIE *Die, const DIGlobal *G);
290 void addSourceLine(DIE *Die, const DISubprogram *SP);
291 void addSourceLine(DIE *Die, const DIType *Ty);
292 void addSourceLine(DIE *Die, const DINameSpace *NS);
294 /// addAddress - Add an address attribute to a die based on the location
296 void addAddress(DIE *Die, unsigned Attribute,
297 const MachineLocation &Location);
299 /// addComplexAddress - Start with the address based on the location provided,
300 /// and generate the DWARF information necessary to find the actual variable
301 /// (navigating the extra location information encoded in the type) based on
302 /// the starting location. Add the DWARF information to the die.
304 void addComplexAddress(DbgVariable *&DV, DIE *Die, unsigned Attribute,
305 const MachineLocation &Location);
307 // FIXME: Should be reformulated in terms of addComplexAddress.
308 /// addBlockByrefAddress - Start with the address based on the location
309 /// provided, and generate the DWARF information necessary to find the
310 /// actual Block variable (navigating the Block struct) based on the
311 /// starting location. Add the DWARF information to the die. Obsolete,
312 /// please use addComplexAddress instead.
314 void addBlockByrefAddress(DbgVariable *&DV, DIE *Die, unsigned Attribute,
315 const MachineLocation &Location);
317 /// addType - Add a new type attribute to the specified entity.
318 void addType(DIE *Entity, 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 /// getOrCreateNameSpace - Create a DIE for DINameSpace.
345 DIE *getOrCreateNameSpace(DINameSpace &NS);
347 /// createGlobalVariableDIE - Create new DIE using GV.
348 DIE *createGlobalVariableDIE(const DIGlobalVariable &GV);
350 /// createMemberDIE - Create new member DIE.
351 DIE *createMemberDIE(const DIDerivedType &DT);
353 /// createSubprogramDIE - Create new DIE using SP.
354 DIE *createSubprogramDIE(const DISubprogram &SP);
356 /// createMemberSubprogramDIE - Create new member DIE using SP. This
357 /// routine always returns a die with DW_AT_declaration attribute.
359 DIE *createMemberSubprogramDIE(const DISubprogram &SP);
361 /// createRawSubprogramDIE - Create new partially incomplete DIE. This is
362 /// a helper routine used by createMemberSubprogramDIE and
363 /// createSubprogramDIE.
364 DIE *createRawSubprogramDIE(const DISubprogram &SP);
366 /// findCompileUnit - Get the compile unit for the given descriptor.
368 CompileUnit &findCompileUnit(DICompileUnit Unit) const;
370 /// getUpdatedDbgScope - Find or create DbgScope assicated with
371 /// the instruction. Initialize scope and update scope hierarchy.
372 DbgScope *getUpdatedDbgScope(MDNode *N, const MachineInstr *MI, MDNode *InlinedAt);
374 /// createDbgScope - Create DbgScope for the scope.
375 void createDbgScope(MDNode *Scope, MDNode *InlinedAt);
377 DbgScope *getOrCreateAbstractScope(MDNode *N);
379 /// findAbstractVariable - Find abstract variable associated with Var.
380 DbgVariable *findAbstractVariable(DIVariable &Var, unsigned FrameIdx,
383 /// updateSubprogramScopeDIE - Find DIE for the given subprogram and
384 /// attach appropriate DW_AT_low_pc and DW_AT_high_pc attributes.
385 /// If there are global variables in this scope then create and insert
386 /// DIEs for these variables.
387 DIE *updateSubprogramScopeDIE(MDNode *SPNode);
389 /// constructLexicalScope - Construct new DW_TAG_lexical_block
390 /// for this scope and attach DW_AT_low_pc/DW_AT_high_pc labels.
391 DIE *constructLexicalScopeDIE(DbgScope *Scope);
393 /// constructInlinedScopeDIE - This scope represents inlined body of
394 /// a function. Construct DIE to represent this concrete inlined copy
396 DIE *constructInlinedScopeDIE(DbgScope *Scope);
398 /// constructVariableDIE - Construct a DIE for the given DbgVariable.
399 DIE *constructVariableDIE(DbgVariable *DV, DbgScope *S);
401 /// constructScopeDIE - Construct a DIE for this scope.
402 DIE *constructScopeDIE(DbgScope *Scope);
404 /// emitInitial - Emit initial Dwarf declarations. This is necessary for cc
405 /// tools to recognize the object file contains Dwarf information.
408 /// emitDIE - Recusively Emits a debug information entry.
410 void emitDIE(DIE *Die);
412 /// computeSizeAndOffset - Compute the size and offset of a DIE.
414 unsigned computeSizeAndOffset(DIE *Die, unsigned Offset, bool Last);
416 /// computeSizeAndOffsets - Compute the size and offset of all the DIEs.
418 void computeSizeAndOffsets();
420 /// EmitDebugInfo - Emit the debug info section.
422 void emitDebugInfo();
424 /// emitAbbreviations - Emit the abbreviation section.
426 void emitAbbreviations() const;
428 /// emitEndOfLineMatrix - Emit the last address of the section and the end of
431 void emitEndOfLineMatrix(unsigned SectionEnd);
433 /// emitDebugLines - Emit source line information.
435 void emitDebugLines();
437 /// emitCommonDebugFrame - Emit common frame info into a debug frame section.
439 void emitCommonDebugFrame();
441 /// emitFunctionDebugFrame - Emit per function frame info into a debug frame
443 void emitFunctionDebugFrame(const FunctionDebugFrameInfo &DebugFrameInfo);
445 /// emitDebugPubNames - Emit visible names into a debug pubnames section.
447 void emitDebugPubNames();
449 /// emitDebugPubTypes - Emit visible types into a debug pubtypes section.
451 void emitDebugPubTypes();
453 /// emitDebugStr - Emit visible names into a debug str section.
457 /// emitDebugLoc - Emit visible names into a debug loc section.
461 /// EmitDebugARanges - Emit visible names into a debug aranges section.
463 void EmitDebugARanges();
465 /// emitDebugRanges - Emit visible names into a debug ranges section.
467 void emitDebugRanges();
469 /// emitDebugMacInfo - Emit visible names into a debug macinfo section.
471 void emitDebugMacInfo();
473 /// emitDebugInlineInfo - Emit inline info using following format.
475 /// 1. length of section
476 /// 2. Dwarf version number
479 /// Entries (one "entry" for each function that was inlined):
481 /// 1. offset into __debug_str section for MIPS linkage name, if exists;
482 /// otherwise offset into __debug_str for regular function name.
483 /// 2. offset into __debug_str section for regular function name.
484 /// 3. an unsigned LEB128 number indicating the number of distinct inlining
485 /// instances for the function.
487 /// The rest of the entry consists of a {die_offset, low_pc} pair for each
488 /// inlined instance; the die_offset points to the inlined_subroutine die in
489 /// the __debug_info section, and the low_pc is the starting address for the
490 /// inlining instance.
491 void emitDebugInlineInfo();
493 /// GetOrCreateSourceID - Look up the source id with the given directory and
494 /// source file names. If none currently exists, create a new id and insert it
495 /// in the SourceIds map. This can update DirectoryNames and SourceFileNames maps
497 unsigned GetOrCreateSourceID(StringRef DirName, StringRef FileName);
499 void constructCompileUnit(MDNode *N);
501 void constructGlobalVariableDIE(MDNode *N);
503 void constructSubprogramDIE(MDNode *N);
505 // FIXME: This should go away in favor of complex addresses.
506 /// Find the type the programmer originally declared the variable to be
507 /// and return that type. Obsolete, use GetComplexAddrType instead.
509 DIType getBlockByrefType(DIType Ty, std::string Name);
512 //===--------------------------------------------------------------------===//
513 // Main entry points.
515 DwarfDebug(raw_ostream &OS, AsmPrinter *A, const MCAsmInfo *T);
516 virtual ~DwarfDebug();
518 /// ShouldEmitDwarfDebug - Returns true if Dwarf debugging declarations should
520 bool ShouldEmitDwarfDebug() const { return shouldEmit; }
522 /// beginModule - Emit all Dwarf sections that should come prior to the
524 void beginModule(Module *M, MachineModuleInfo *MMI);
526 /// endModule - Emit all Dwarf sections that should come after the content.
530 /// beginFunction - Gather pre-function debug information. Assumes being
531 /// emitted immediately after the function entry point.
532 void beginFunction(MachineFunction *MF);
534 /// endFunction - Gather and emit post-function debug information.
536 void endFunction(MachineFunction *MF);
538 /// recordSourceLine - Records location information and associates it with a
539 /// label. Returns a unique label ID used to generate a label and provide
540 /// correspondence to the source line list.
541 unsigned recordSourceLine(unsigned Line, unsigned Col, MDNode *Scope);
543 /// getSourceLineCount - Return the number of source lines in the debug
545 unsigned getSourceLineCount() const {
549 /// getOrCreateSourceID - Public version of GetOrCreateSourceID. This can be
550 /// timed. Look up the source id with the given directory and source file
551 /// names. If none currently exists, create a new id and insert it in the
552 /// SourceIds map. This can update DirectoryNames and SourceFileNames maps as
554 unsigned getOrCreateSourceID(const std::string &DirName,
555 const std::string &FileName);
557 /// extractScopeInformation - Scan machine instructions in this function
558 /// and collect DbgScopes. Return true, if atleast one scope was found.
559 bool extractScopeInformation(MachineFunction *MF);
561 /// collectVariableInfo - Populate DbgScope entries with variables' info.
562 void collectVariableInfo();
564 /// beginScope - Process beginning of a scope starting at Label.
565 void beginScope(const MachineInstr *MI, unsigned Label);
567 /// endScope - Prcess end of a scope.
568 void endScope(const MachineInstr *MI);
570 } // End of namespace llvm