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 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<unsigned, DIE *> InlineInfoLabels;
179 ValueMap<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 /// DebugTimer - Timer for the Dwarf debug writer.
190 struct FunctionDebugFrameInfo {
192 std::vector<MachineMove> Moves;
194 FunctionDebugFrameInfo(unsigned Num, const std::vector<MachineMove> &M)
195 : Number(Num), Moves(M) {}
198 std::vector<FunctionDebugFrameInfo> DebugFrames;
200 /// getSourceDirectoryAndFileIds - Return the directory and file ids that
201 /// maps to the source id. Source id starts at 1.
202 std::pair<unsigned, unsigned>
203 getSourceDirectoryAndFileIds(unsigned SId) const {
204 return SourceIds[SId-1];
207 /// getNumSourceDirectories - Return the number of source directories in the
209 unsigned getNumSourceDirectories() const {
210 return DirectoryNames.size();
213 /// getSourceDirectoryName - Return the name of the directory corresponding
215 const std::string &getSourceDirectoryName(unsigned Id) const {
216 return DirectoryNames[Id - 1];
219 /// getSourceFileName - Return the name of the source file corresponding
221 const std::string &getSourceFileName(unsigned Id) const {
222 return SourceFileNames[Id - 1];
225 /// getNumSourceIds - Return the number of unique source ids.
226 unsigned getNumSourceIds() const {
227 return SourceIds.size();
230 /// assignAbbrevNumber - Define a unique number for the abbreviation.
232 void assignAbbrevNumber(DIEAbbrev &Abbrev);
234 /// createDIEEntry - Creates a new DIEEntry to be a proxy for a debug
235 /// information entry.
236 DIEEntry *createDIEEntry(DIE *Entry = NULL);
238 /// addUInt - Add an unsigned integer attribute data and value.
240 void addUInt(DIE *Die, unsigned Attribute, unsigned Form, uint64_t Integer);
242 /// addSInt - Add an signed integer attribute data and value.
244 void addSInt(DIE *Die, unsigned Attribute, unsigned Form, int64_t Integer);
246 /// addString - Add a string attribute data and value.
248 void addString(DIE *Die, unsigned Attribute, unsigned Form,
249 const StringRef Str);
251 /// addLabel - Add a Dwarf label attribute data and value.
253 void addLabel(DIE *Die, unsigned Attribute, unsigned Form,
254 const DWLabel &Label);
256 /// addObjectLabel - Add an non-Dwarf label attribute data and value.
258 void addObjectLabel(DIE *Die, unsigned Attribute, unsigned Form,
259 const std::string &Label);
261 /// addSectionOffset - Add a section offset label attribute data and value.
263 void addSectionOffset(DIE *Die, unsigned Attribute, unsigned Form,
264 const DWLabel &Label, const DWLabel &Section,
265 bool isEH = false, bool useSet = true);
267 /// addDelta - Add a label delta attribute data and value.
269 void addDelta(DIE *Die, unsigned Attribute, unsigned Form,
270 const DWLabel &Hi, const DWLabel &Lo);
272 /// addDIEEntry - Add a DIE attribute data and value.
274 void addDIEEntry(DIE *Die, unsigned Attribute, unsigned Form, DIE *Entry) {
275 Die->addValue(Attribute, Form, createDIEEntry(Entry));
278 /// addBlock - Add block data.
280 void addBlock(DIE *Die, unsigned Attribute, unsigned Form, DIEBlock *Block);
282 /// addSourceLine - Add location information to specified debug information
284 void addSourceLine(DIE *Die, const DIVariable *V);
285 void addSourceLine(DIE *Die, const DIGlobal *G);
286 void addSourceLine(DIE *Die, const DISubprogram *SP);
287 void addSourceLine(DIE *Die, const DIType *Ty);
289 /// addAddress - Add an address attribute to a die based on the location
291 void addAddress(DIE *Die, unsigned Attribute,
292 const MachineLocation &Location);
294 /// addComplexAddress - Start with the address based on the location provided,
295 /// and generate the DWARF information necessary to find the actual variable
296 /// (navigating the extra location information encoded in the type) based on
297 /// the starting location. Add the DWARF information to the die.
299 void addComplexAddress(DbgVariable *&DV, DIE *Die, unsigned Attribute,
300 const MachineLocation &Location);
302 // FIXME: Should be reformulated in terms of addComplexAddress.
303 /// addBlockByrefAddress - Start with the address based on the location
304 /// provided, and generate the DWARF information necessary to find the
305 /// actual Block variable (navigating the Block struct) based on the
306 /// starting location. Add the DWARF information to the die. Obsolete,
307 /// please use addComplexAddress instead.
309 void addBlockByrefAddress(DbgVariable *&DV, DIE *Die, unsigned Attribute,
310 const MachineLocation &Location);
312 /// addToContextOwner - Add Die into the list of its context owner's children.
313 void addToContextOwner(DIE *Die, DIDescriptor Context);
315 /// addType - Add a new type attribute to the specified entity.
316 void addType(DIE *Entity, DIType Ty);
318 /// getOrCreateTypeDIE - Find existing DIE or create new DIE for the
320 DIE *getOrCreateTypeDIE(DIType Ty);
322 void addPubTypes(DISubprogram SP);
324 /// constructTypeDIE - Construct basic type die from DIBasicType.
325 void constructTypeDIE(DIE &Buffer,
328 /// constructTypeDIE - Construct derived type die from DIDerivedType.
329 void constructTypeDIE(DIE &Buffer,
332 /// constructTypeDIE - Construct type DIE from DICompositeType.
333 void constructTypeDIE(DIE &Buffer,
334 DICompositeType CTy);
336 /// constructSubrangeDIE - Construct subrange DIE from DISubrange.
337 void constructSubrangeDIE(DIE &Buffer, DISubrange SR, DIE *IndexTy);
339 /// constructArrayTypeDIE - Construct array type DIE from DICompositeType.
340 void constructArrayTypeDIE(DIE &Buffer,
341 DICompositeType *CTy);
343 /// constructEnumTypeDIE - Construct enum type DIE from DIEnumerator.
344 DIE *constructEnumTypeDIE(DIEnumerator *ETy);
346 /// createGlobalVariableDIE - Create new DIE using GV.
347 DIE *createGlobalVariableDIE(const DIGlobalVariable &GV);
349 /// createMemberDIE - Create new member DIE.
350 DIE *createMemberDIE(const DIDerivedType &DT);
352 /// createSubprogramDIE - Create new DIE using SP.
353 DIE *createSubprogramDIE(const DISubprogram &SP);
355 /// createMemberSubprogramDIE - Create new member DIE using SP. This
356 /// routine always returns a die with DW_AT_declaration attribute.
358 DIE *createMemberSubprogramDIE(const DISubprogram &SP);
360 /// createRawSubprogramDIE - Create new partially incomplete DIE. This is
361 /// a helper routine used by createMemberSubprogramDIE and
362 /// createSubprogramDIE.
363 DIE *createRawSubprogramDIE(const DISubprogram &SP);
365 /// findCompileUnit - Get the compile unit for the given descriptor.
367 CompileUnit &findCompileUnit(DICompileUnit Unit) const;
369 /// getUpdatedDbgScope - Find or create DbgScope assicated with
370 /// the instruction. Initialize scope and update scope hierarchy.
371 DbgScope *getUpdatedDbgScope(MDNode *N, const MachineInstr *MI, MDNode *InlinedAt);
373 /// createDbgScope - Create DbgScope for the scope.
374 void createDbgScope(MDNode *Scope, MDNode *InlinedAt);
376 DbgScope *getOrCreateAbstractScope(MDNode *N);
378 /// findAbstractVariable - Find abstract variable associated with Var.
379 DbgVariable *findAbstractVariable(DIVariable &Var, unsigned FrameIdx,
382 /// updateSubprogramScopeDIE - Find DIE for the given subprogram and
383 /// attach appropriate DW_AT_low_pc and DW_AT_high_pc attributes.
384 /// If there are global variables in this scope then create and insert
385 /// DIEs for these variables.
386 DIE *updateSubprogramScopeDIE(MDNode *SPNode);
388 /// constructLexicalScope - Construct new DW_TAG_lexical_block
389 /// for this scope and attach DW_AT_low_pc/DW_AT_high_pc labels.
390 DIE *constructLexicalScopeDIE(DbgScope *Scope);
392 /// constructInlinedScopeDIE - This scope represents inlined body of
393 /// a function. Construct DIE to represent this concrete inlined copy
395 DIE *constructInlinedScopeDIE(DbgScope *Scope);
397 /// constructVariableDIE - Construct a DIE for the given DbgVariable.
398 DIE *constructVariableDIE(DbgVariable *DV, DbgScope *S);
400 /// constructScopeDIE - Construct a DIE for this scope.
401 DIE *constructScopeDIE(DbgScope *Scope);
403 /// emitInitial - Emit initial Dwarf declarations. This is necessary for cc
404 /// tools to recognize the object file contains Dwarf information.
407 /// emitDIE - Recusively Emits a debug information entry.
409 void emitDIE(DIE *Die);
411 /// computeSizeAndOffset - Compute the size and offset of a DIE.
413 unsigned computeSizeAndOffset(DIE *Die, unsigned Offset, bool Last);
415 /// computeSizeAndOffsets - Compute the size and offset of all the DIEs.
417 void computeSizeAndOffsets();
419 /// EmitDebugInfo - Emit the debug info section.
421 void emitDebugInfo();
423 /// emitAbbreviations - Emit the abbreviation section.
425 void emitAbbreviations() const;
427 /// emitEndOfLineMatrix - Emit the last address of the section and the end of
430 void emitEndOfLineMatrix(unsigned SectionEnd);
432 /// emitDebugLines - Emit source line information.
434 void emitDebugLines();
436 /// emitCommonDebugFrame - Emit common frame info into a debug frame section.
438 void emitCommonDebugFrame();
440 /// emitFunctionDebugFrame - Emit per function frame info into a debug frame
442 void emitFunctionDebugFrame(const FunctionDebugFrameInfo &DebugFrameInfo);
444 /// emitDebugPubNames - Emit visible names into a debug pubnames section.
446 void emitDebugPubNames();
448 /// emitDebugPubTypes - Emit visible types into a debug pubtypes section.
450 void emitDebugPubTypes();
452 /// emitDebugStr - Emit visible names into a debug str section.
456 /// emitDebugLoc - Emit visible names into a debug loc section.
460 /// EmitDebugARanges - Emit visible names into a debug aranges section.
462 void EmitDebugARanges();
464 /// emitDebugRanges - Emit visible names into a debug ranges section.
466 void emitDebugRanges();
468 /// emitDebugMacInfo - Emit visible names into a debug macinfo section.
470 void emitDebugMacInfo();
472 /// emitDebugInlineInfo - Emit inline info using following format.
474 /// 1. length of section
475 /// 2. Dwarf version number
478 /// Entries (one "entry" for each function that was inlined):
480 /// 1. offset into __debug_str section for MIPS linkage name, if exists;
481 /// otherwise offset into __debug_str for regular function name.
482 /// 2. offset into __debug_str section for regular function name.
483 /// 3. an unsigned LEB128 number indicating the number of distinct inlining
484 /// instances for the function.
486 /// The rest of the entry consists of a {die_offset, low_pc} pair for each
487 /// inlined instance; the die_offset points to the inlined_subroutine die in
488 /// the __debug_info section, and the low_pc is the starting address for the
489 /// inlining instance.
490 void emitDebugInlineInfo();
492 /// GetOrCreateSourceID - Look up the source id with the given directory and
493 /// source file names. If none currently exists, create a new id and insert it
494 /// in the SourceIds map. This can update DirectoryNames and SourceFileNames maps
496 unsigned GetOrCreateSourceID(StringRef DirName, StringRef FileName);
498 void constructCompileUnit(MDNode *N);
500 void constructGlobalVariableDIE(MDNode *N);
502 void constructSubprogramDIE(MDNode *N);
504 // FIXME: This should go away in favor of complex addresses.
505 /// Find the type the programmer originally declared the variable to be
506 /// and return that type. Obsolete, use GetComplexAddrType instead.
508 DIType getBlockByrefType(DIType Ty, std::string Name);
511 //===--------------------------------------------------------------------===//
512 // Main entry points.
514 DwarfDebug(raw_ostream &OS, AsmPrinter *A, const MCAsmInfo *T);
515 virtual ~DwarfDebug();
517 /// ShouldEmitDwarfDebug - Returns true if Dwarf debugging declarations should
519 bool ShouldEmitDwarfDebug() const { return shouldEmit; }
521 /// beginModule - Emit all Dwarf sections that should come prior to the
523 void beginModule(Module *M, MachineModuleInfo *MMI);
525 /// endModule - Emit all Dwarf sections that should come after the content.
529 /// beginFunction - Gather pre-function debug information. Assumes being
530 /// emitted immediately after the function entry point.
531 void beginFunction(MachineFunction *MF);
533 /// endFunction - Gather and emit post-function debug information.
535 void endFunction(MachineFunction *MF);
537 /// recordSourceLine - Records location information and associates it with a
538 /// label. Returns a unique label ID used to generate a label and provide
539 /// correspondence to the source line list.
540 unsigned recordSourceLine(unsigned Line, unsigned Col, MDNode *Scope);
542 /// getSourceLineCount - Return the number of source lines in the debug
544 unsigned getSourceLineCount() const {
548 /// getOrCreateSourceID - Public version of GetOrCreateSourceID. This can be
549 /// timed. Look up the source id with the given directory and source file
550 /// names. If none currently exists, create a new id and insert it in the
551 /// SourceIds map. This can update DirectoryNames and SourceFileNames maps as
553 unsigned getOrCreateSourceID(const std::string &DirName,
554 const std::string &FileName);
556 /// extractScopeInformation - Scan machine instructions in this function
557 /// and collect DbgScopes. Return true, if atleast one scope was found.
558 bool extractScopeInformation(MachineFunction *MF);
560 /// collectVariableInfo - Populate DbgScope entries with variables' info.
561 void collectVariableInfo();
563 /// beginScope - Process beginning of a scope starting at Label.
564 void beginScope(const MachineInstr *MI, unsigned Label);
566 /// endScope - Prcess end of a scope.
567 void endScope(const MachineInstr *MI);
569 } // End of namespace llvm