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"
35 class DbgConcreteScope;
36 class MachineFrameInfo;
37 class MachineModuleInfo;
41 //===----------------------------------------------------------------------===//
42 /// SrcLineInfo - This class is used to record source line correspondence.
44 class VISIBILITY_HIDDEN SrcLineInfo {
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 VISIBILITY_HIDDEN 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 /// ValuesSet - Used to uniquely define values.
111 FoldingSet<DIEValue> ValuesSet;
113 /// Values - A list of all the unique values in use.
115 std::vector<DIEValue *> Values;
117 /// StringPool - A UniqueVector of strings used by indirect references.
119 UniqueVector<std::string> StringPool;
121 /// SectionMap - Provides a unique id per text section.
123 UniqueVector<const MCSection*> SectionMap;
125 /// SectionSourceLines - Tracks line numbers per text section.
127 std::vector<std::vector<SrcLineInfo> > SectionSourceLines;
129 /// didInitial - Flag to indicate if initial emission has been done.
133 /// shouldEmit - Flag to indicate if debug information should be emitted.
137 // FunctionDbgScope - Top level scope for the current function.
139 DbgScope *FunctionDbgScope;
141 /// DbgScopeMap - Tracks the scopes in the current function.
142 DenseMap<MDNode *, DbgScope *> DbgScopeMap;
144 /// ScopedGVs - Tracks global variables that are not at file scope.
145 /// For example void f() { static int b = 42; }
146 SmallVector<WeakVH, 4> ScopedGVs;
148 typedef DenseMap<const MachineInstr *, SmallVector<DbgScope *, 2> >
151 /// DbgScopeBeginMap - Maps instruction with a list DbgScopes it starts.
152 InsnToDbgScopeMapTy DbgScopeBeginMap;
154 /// DbgScopeEndMap - Maps instruction with a list DbgScopes it ends.
155 InsnToDbgScopeMapTy DbgScopeEndMap;
157 /// DbgAbstractScopeMap - Tracks abstract instance scopes in the current
159 DenseMap<MDNode *, DbgScope *> DbgAbstractScopeMap;
161 /// DbgConcreteScopeMap - Tracks concrete instance scopes in the current
164 SmallVector<DbgScope *, 8> > DbgConcreteScopeMap;
166 /// InlineInfo - Keep track of inlined functions and their location. This
167 /// information is used to populate debug_inlined section.
168 DenseMap<MDNode *, SmallVector<unsigned, 4> > InlineInfo;
170 /// AbstractInstanceRootMap - Map of abstract instance roots of inlined
171 /// functions. These are subroutine entries that contain a DW_AT_inline
173 DenseMap<const MDNode *, DbgScope *> AbstractInstanceRootMap;
175 /// AbstractInstanceRootList - List of abstract instance roots of inlined
176 /// functions. These are subroutine entries that contain a DW_AT_inline
178 SmallVector<DbgScope *, 32> AbstractInstanceRootList;
180 /// LexicalScopeStack - A stack of lexical scopes. The top one is the current
182 SmallVector<DbgScope *, 16> LexicalScopeStack;
184 /// CompileUnitOffsets - A vector of the offsets of the compile units. This is
185 /// used when calculating the "origin" of a concrete instance of an inlined
187 DenseMap<CompileUnit *, unsigned> CompileUnitOffsets;
189 /// DebugTimer - Timer for the Dwarf debug writer.
192 struct FunctionDebugFrameInfo {
194 std::vector<MachineMove> Moves;
196 FunctionDebugFrameInfo(unsigned Num, const std::vector<MachineMove> &M)
197 : Number(Num), Moves(M) {}
200 std::vector<FunctionDebugFrameInfo> DebugFrames;
202 /// getSourceDirectoryAndFileIds - Return the directory and file ids that
203 /// maps to the source id. Source id starts at 1.
204 std::pair<unsigned, unsigned>
205 getSourceDirectoryAndFileIds(unsigned SId) const {
206 return SourceIds[SId-1];
209 /// getNumSourceDirectories - Return the number of source directories in the
211 unsigned getNumSourceDirectories() const {
212 return DirectoryNames.size();
215 /// getSourceDirectoryName - Return the name of the directory corresponding
217 const std::string &getSourceDirectoryName(unsigned Id) const {
218 return DirectoryNames[Id - 1];
221 /// getSourceFileName - Return the name of the source file corresponding
223 const std::string &getSourceFileName(unsigned Id) const {
224 return SourceFileNames[Id - 1];
227 /// getNumSourceIds - Return the number of unique source ids.
228 unsigned getNumSourceIds() const {
229 return SourceIds.size();
232 /// AssignAbbrevNumber - Define a unique number for the abbreviation.
234 void AssignAbbrevNumber(DIEAbbrev &Abbrev);
236 /// CreateDIEEntry - Creates a new DIEEntry to be a proxy for a debug
237 /// information entry.
238 DIEEntry *CreateDIEEntry(DIE *Entry = NULL);
240 /// SetDIEEntry - Set a DIEEntry once the debug information entry is defined.
242 void SetDIEEntry(DIEEntry *Value, DIE *Entry);
244 /// AddUInt - Add an unsigned integer attribute data and value.
246 void AddUInt(DIE *Die, unsigned Attribute, unsigned Form, uint64_t Integer);
248 /// AddSInt - Add an signed integer attribute data and value.
250 void AddSInt(DIE *Die, unsigned Attribute, unsigned Form, int64_t Integer);
252 /// AddString - Add a string attribute data and value.
254 void AddString(DIE *Die, unsigned Attribute, unsigned Form,
255 const std::string &String);
257 /// AddLabel - Add a Dwarf label attribute data and value.
259 void AddLabel(DIE *Die, unsigned Attribute, unsigned Form,
260 const DWLabel &Label);
262 /// AddObjectLabel - Add an non-Dwarf label attribute data and value.
264 void AddObjectLabel(DIE *Die, unsigned Attribute, unsigned Form,
265 const std::string &Label);
267 /// AddSectionOffset - Add a section offset label attribute data and value.
269 void AddSectionOffset(DIE *Die, unsigned Attribute, unsigned Form,
270 const DWLabel &Label, const DWLabel &Section,
271 bool isEH = false, bool useSet = true);
273 /// AddDelta - Add a label delta attribute data and value.
275 void AddDelta(DIE *Die, unsigned Attribute, unsigned Form,
276 const DWLabel &Hi, const DWLabel &Lo);
278 /// AddDIEEntry - Add a DIE attribute data and value.
280 void AddDIEEntry(DIE *Die, unsigned Attribute, unsigned Form, DIE *Entry) {
281 Die->AddValue(Attribute, Form, CreateDIEEntry(Entry));
284 /// AddBlock - Add block data.
286 void AddBlock(DIE *Die, unsigned Attribute, unsigned Form, DIEBlock *Block);
288 /// AddSourceLine - Add location information to specified debug information
290 void AddSourceLine(DIE *Die, const DIVariable *V);
291 void AddSourceLine(DIE *Die, const DIGlobal *G);
292 void AddSourceLine(DIE *Die, const DISubprogram *SP);
293 void AddSourceLine(DIE *Die, const DIType *Ty);
295 /// AddAddress - Add an address attribute to a die based on the location
297 void AddAddress(DIE *Die, unsigned Attribute,
298 const MachineLocation &Location);
300 /// AddComplexAddress - Start with the address based on the location provided,
301 /// and generate the DWARF information necessary to find the actual variable
302 /// (navigating the extra location information encoded in the type) based on
303 /// the starting location. Add the DWARF information to the die.
305 void AddComplexAddress(DbgVariable *&DV, DIE *Die, unsigned Attribute,
306 const MachineLocation &Location);
308 // FIXME: Should be reformulated in terms of AddComplexAddress.
309 /// AddBlockByrefAddress - Start with the address based on the location
310 /// provided, and generate the DWARF information necessary to find the
311 /// actual Block variable (navigating the Block struct) based on the
312 /// starting location. Add the DWARF information to the die. Obsolete,
313 /// please use AddComplexAddress instead.
315 void AddBlockByrefAddress(DbgVariable *&DV, DIE *Die, unsigned Attribute,
316 const MachineLocation &Location);
318 /// AddType - Add a new type attribute to the specified entity.
319 void AddType(CompileUnit *DW_Unit, DIE *Entity, DIType Ty);
321 /// ConstructTypeDIE - Construct basic type die from DIBasicType.
322 void ConstructTypeDIE(CompileUnit *DW_Unit, DIE &Buffer,
325 /// ConstructTypeDIE - Construct derived type die from DIDerivedType.
326 void ConstructTypeDIE(CompileUnit *DW_Unit, DIE &Buffer,
329 /// ConstructTypeDIE - Construct type DIE from DICompositeType.
330 void ConstructTypeDIE(CompileUnit *DW_Unit, DIE &Buffer,
331 DICompositeType CTy);
333 /// ConstructSubrangeDIE - Construct subrange DIE from DISubrange.
334 void ConstructSubrangeDIE(DIE &Buffer, DISubrange SR, DIE *IndexTy);
336 /// ConstructArrayTypeDIE - Construct array type DIE from DICompositeType.
337 void ConstructArrayTypeDIE(CompileUnit *DW_Unit, DIE &Buffer,
338 DICompositeType *CTy);
340 /// ConstructEnumTypeDIE - Construct enum type DIE from DIEnumerator.
341 DIE *ConstructEnumTypeDIE(CompileUnit *DW_Unit, DIEnumerator *ETy);
343 /// CreateGlobalVariableDIE - Create new DIE using GV.
344 DIE *CreateGlobalVariableDIE(CompileUnit *DW_Unit,
345 const DIGlobalVariable &GV);
347 /// CreateMemberDIE - Create new member DIE.
348 DIE *CreateMemberDIE(CompileUnit *DW_Unit, const DIDerivedType &DT);
350 /// CreateSubprogramDIE - Create new DIE using SP.
351 DIE *CreateSubprogramDIE(CompileUnit *DW_Unit,
352 const DISubprogram &SP,
353 bool IsConstructor = false,
354 bool IsInlined = false);
356 /// FindCompileUnit - Get the compile unit for the given descriptor.
358 CompileUnit &FindCompileUnit(DICompileUnit Unit) const;
360 /// CreateDbgScopeVariable - Create a new scope variable.
362 DIE *CreateDbgScopeVariable(DbgVariable *DV, CompileUnit *Unit);
364 /// getDbgScope - Returns the scope associated with the given descriptor.
366 DbgScope *getOrCreateScope(MDNode *N);
367 DbgScope *getDbgScope(MDNode *N, const MachineInstr *MI);
369 /// ConstructDbgScope - Construct the components of a scope.
371 void ConstructDbgScope(DbgScope *ParentScope,
372 unsigned ParentStartID, unsigned ParentEndID,
373 DIE *ParentDie, CompileUnit *Unit);
375 /// ConstructFunctionDbgScope - Construct the scope for the subprogram.
377 void ConstructFunctionDbgScope(DbgScope *RootScope,
378 bool AbstractScope = false);
380 /// ConstructDefaultDbgScope - Construct a default scope for the subprogram.
382 void ConstructDefaultDbgScope(MachineFunction *MF);
384 /// EmitInitial - Emit initial Dwarf declarations. This is necessary for cc
385 /// tools to recognize the object file contains Dwarf information.
388 /// EmitDIE - Recusively Emits a debug information entry.
390 void EmitDIE(DIE *Die);
392 /// SizeAndOffsetDie - Compute the size and offset of a DIE.
394 unsigned SizeAndOffsetDie(DIE *Die, unsigned Offset, bool Last);
396 /// SizeAndOffsets - Compute the size and offset of all the DIEs.
398 void SizeAndOffsets();
400 /// EmitDebugInfo / EmitDebugInfoPerCU - Emit the debug info section.
402 void EmitDebugInfoPerCU(CompileUnit *Unit);
404 void EmitDebugInfo();
406 /// EmitAbbreviations - Emit the abbreviation section.
408 void EmitAbbreviations() const;
410 /// EmitEndOfLineMatrix - Emit the last address of the section and the end of
413 void EmitEndOfLineMatrix(unsigned SectionEnd);
415 /// EmitDebugLines - Emit source line information.
417 void EmitDebugLines();
419 /// EmitCommonDebugFrame - Emit common frame info into a debug frame section.
421 void EmitCommonDebugFrame();
423 /// EmitFunctionDebugFrame - Emit per function frame info into a debug frame
425 void EmitFunctionDebugFrame(const FunctionDebugFrameInfo &DebugFrameInfo);
427 void EmitDebugPubNamesPerCU(CompileUnit *Unit);
429 /// EmitDebugPubNames - Emit visible names into a debug pubnames section.
431 void EmitDebugPubNames();
433 /// EmitDebugStr - Emit visible names into a debug str section.
437 /// EmitDebugLoc - Emit visible names into a debug loc section.
441 /// EmitDebugARanges - Emit visible names into a debug aranges section.
443 void EmitDebugARanges();
445 /// EmitDebugRanges - Emit visible names into a debug ranges section.
447 void EmitDebugRanges();
449 /// EmitDebugMacInfo - Emit visible names into a debug macinfo section.
451 void EmitDebugMacInfo();
453 /// EmitDebugInlineInfo - Emit inline info using following format.
455 /// 1. length of section
456 /// 2. Dwarf version number
459 /// Entries (one "entry" for each function that was inlined):
461 /// 1. offset into __debug_str section for MIPS linkage name, if exists;
462 /// otherwise offset into __debug_str for regular function name.
463 /// 2. offset into __debug_str section for regular function name.
464 /// 3. an unsigned LEB128 number indicating the number of distinct inlining
465 /// instances for the function.
467 /// The rest of the entry consists of a {die_offset, low_pc} pair for each
468 /// inlined instance; the die_offset points to the inlined_subroutine die in
469 /// the __debug_info section, and the low_pc is the starting address for the
470 /// inlining instance.
471 void EmitDebugInlineInfo();
473 /// GetOrCreateSourceID - Look up the source id with the given directory and
474 /// source file names. If none currently exists, create a new id and insert it
475 /// in the SourceIds map. This can update DirectoryNames and SourceFileNames maps
477 unsigned GetOrCreateSourceID(const char *DirName,
478 const char *FileName);
480 void ConstructCompileUnit(MDNode *N);
482 void ConstructGlobalVariableDIE(MDNode *N);
484 void ConstructSubprogram(MDNode *N);
486 // FIXME: This should go away in favor of complex addresses.
487 /// Find the type the programmer originally declared the variable to be
488 /// and return that type. Obsolete, use GetComplexAddrType instead.
490 DIType GetBlockByrefType(DIType Ty, std::string Name);
493 //===--------------------------------------------------------------------===//
494 // Main entry points.
496 DwarfDebug(raw_ostream &OS, AsmPrinter *A, const MCAsmInfo *T);
497 virtual ~DwarfDebug();
499 /// ShouldEmitDwarfDebug - Returns true if Dwarf debugging declarations should
501 bool ShouldEmitDwarfDebug() const { return shouldEmit; }
503 /// BeginModule - Emit all Dwarf sections that should come prior to the
505 void BeginModule(Module *M, MachineModuleInfo *MMI);
507 /// EndModule - Emit all Dwarf sections that should come after the content.
511 /// BeginFunction - Gather pre-function debug information. Assumes being
512 /// emitted immediately after the function entry point.
513 void BeginFunction(MachineFunction *MF);
515 /// EndFunction - Gather and emit post-function debug information.
517 void EndFunction(MachineFunction *MF);
519 /// RecordSourceLine - Records location information and associates it with a
520 /// label. Returns a unique label ID used to generate a label and provide
521 /// correspondence to the source line list.
522 unsigned RecordSourceLine(unsigned Line, unsigned Col, MDNode *Scope);
524 /// getRecordSourceLineCount - Return the number of source lines in the debug
526 unsigned getRecordSourceLineCount() const {
530 /// getOrCreateSourceID - Public version of GetOrCreateSourceID. This can be
531 /// timed. Look up the source id with the given directory and source file
532 /// names. If none currently exists, create a new id and insert it in the
533 /// SourceIds map. This can update DirectoryNames and SourceFileNames maps as
535 unsigned getOrCreateSourceID(const std::string &DirName,
536 const std::string &FileName);
538 /// RecordRegionStart - Indicate the start of a region.
539 unsigned RecordRegionStart(MDNode *N);
541 /// RecordRegionEnd - Indicate the end of a region.
542 unsigned RecordRegionEnd(MDNode *N);
544 /// RecordVariable - Indicate the declaration of a local variable.
545 void RecordVariable(MDNode *N, unsigned FrameIndex);
547 //// RecordInlinedFnStart - Indicate the start of inlined subroutine.
548 unsigned RecordInlinedFnStart(DISubprogram &SP, DICompileUnit CU,
549 unsigned Line, unsigned Col);
551 /// RecordInlinedFnEnd - Indicate the end of inlined subroutine.
552 unsigned RecordInlinedFnEnd(DISubprogram &SP);
554 /// ExtractScopeInformation - Scan machine instructions in this function
555 /// and collect DbgScopes. Return true, if atleast one scope was found.
556 bool ExtractScopeInformation(MachineFunction *MF);
558 /// CollectVariableInfo - Populate DbgScope entries with variables' info.
559 void CollectVariableInfo();
561 /// SetDbgScopeBeginLabels - Update DbgScope begin labels for the scopes that
562 /// start with this machine instruction.
563 void SetDbgScopeBeginLabels(const MachineInstr *MI, unsigned Label);
565 /// SetDbgScopeEndLabels - Update DbgScope end labels for the scopes that
566 /// end with this machine instruction.
567 void SetDbgScopeEndLabels(const MachineInstr *MI, unsigned Label);
570 } // End of namespace llvm