DwarfDebug.h revision 3d910835fc5da1ccddefd7cc5978ffe8c903cbf0
1//===-- llvm/CodeGen/DwarfDebug.h - Dwarf Debug Framework ------*- C++ -*--===//
2//
3//                     The LLVM Compiler Infrastructure
4//
5// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
7//
8//===----------------------------------------------------------------------===//
9//
10// This file contains support for writing dwarf debug info into asm files.
11//
12//===----------------------------------------------------------------------===//
13
14#ifndef CODEGEN_ASMPRINTER_DWARFDEBUG_H__
15#define CODEGEN_ASMPRINTER_DWARFDEBUG_H__
16
17#include "DIE.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"
28#include <string>
29
30namespace llvm {
31
32class CompileUnit;
33class DbgVariable;
34class DbgScope;
35class DbgConcreteScope;
36class MachineFrameInfo;
37class MachineModuleInfo;
38class MCAsmInfo;
39class Timer;
40
41//===----------------------------------------------------------------------===//
42/// SrcLineInfo - This class is used to record source line correspondence.
43///
44class 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.
49public:
50  SrcLineInfo(unsigned L, unsigned C, unsigned S, unsigned I)
51    : Line(L), Column(C), SourceID(S), LabelID(I) {}
52
53  // Accessors
54  unsigned getLine() const { return Line; }
55  unsigned getColumn() const { return Column; }
56  unsigned getSourceID() const { return SourceID; }
57  unsigned getLabelID() const { return LabelID; }
58};
59
60class VISIBILITY_HIDDEN DwarfDebug : public Dwarf {
61  //===--------------------------------------------------------------------===//
62  // Attributes used to construct specific Dwarf sections.
63  //
64
65  /// CompileUnitMap - A map of global variables representing compile units to
66  /// compile units.
67  DenseMap<Value *, CompileUnit *> CompileUnitMap;
68
69  /// CompileUnits - All the compile units in this module.
70  ///
71  SmallVector<CompileUnit *, 8> CompileUnits;
72
73  /// ModuleCU - All DIEs are inserted in ModuleCU.
74  CompileUnit *ModuleCU;
75
76  /// AbbreviationsSet - Used to uniquely define abbreviations.
77  ///
78  FoldingSet<DIEAbbrev> AbbreviationsSet;
79
80  /// Abbreviations - A list of all the unique abbreviations in use.
81  ///
82  std::vector<DIEAbbrev *> Abbreviations;
83
84  /// DirectoryIdMap - Directory name to directory id map.
85  ///
86  StringMap<unsigned> DirectoryIdMap;
87
88  /// DirectoryNames - A list of directory names.
89  SmallVector<std::string, 8> DirectoryNames;
90
91  /// SourceFileIdMap - Source file name to source file id map.
92  ///
93  StringMap<unsigned> SourceFileIdMap;
94
95  /// SourceFileNames - A list of source file names.
96  SmallVector<std::string, 8> SourceFileNames;
97
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;
101
102  /// SourceIds - Reverse map from source id to directory id + file id pair.
103  ///
104  SmallVector<std::pair<unsigned, unsigned>, 8> SourceIds;
105
106  /// Lines - List of of source line correspondence.
107  std::vector<SrcLineInfo> Lines;
108
109  /// ValuesSet - Used to uniquely define values.
110  ///
111  FoldingSet<DIEValue> ValuesSet;
112
113  /// Values - A list of all the unique values in use.
114  ///
115  std::vector<DIEValue *> Values;
116
117  /// StringPool - A UniqueVector of strings used by indirect references.
118  ///
119  UniqueVector<std::string> StringPool;
120
121  /// SectionMap - Provides a unique id per text section.
122  ///
123  UniqueVector<const MCSection*> SectionMap;
124
125  /// SectionSourceLines - Tracks line numbers per text section.
126  ///
127  std::vector<std::vector<SrcLineInfo> > SectionSourceLines;
128
129  /// didInitial - Flag to indicate if initial emission has been done.
130  ///
131  bool didInitial;
132
133  /// shouldEmit - Flag to indicate if debug information should be emitted.
134  ///
135  bool shouldEmit;
136
137  // FunctionDbgScope - Top level scope for the current function.
138  //
139  DbgScope *FunctionDbgScope;
140
141  /// DbgScopeMap - Tracks the scopes in the current function.
142  DenseMap<MDNode *, DbgScope *> DbgScopeMap;
143
144  /// DbgAbstractScopeMap - Tracks abstract instance scopes in the current
145  /// function.
146  DenseMap<MDNode *, DbgScope *> DbgAbstractScopeMap;
147
148  /// DbgConcreteScopeMap - Tracks concrete instance scopes in the current
149  /// function.
150  DenseMap<MDNode *,
151           SmallVector<DbgScope *, 8> > DbgConcreteScopeMap;
152
153  /// InlineInfo - Keep track of inlined functions and their location.  This
154  /// information is used to populate debug_inlined section.
155  DenseMap<MDNode *, SmallVector<unsigned, 4> > InlineInfo;
156
157  /// AbstractInstanceRootMap - Map of abstract instance roots of inlined
158  /// functions. These are subroutine entries that contain a DW_AT_inline
159  /// attribute.
160  DenseMap<const MDNode *, DbgScope *> AbstractInstanceRootMap;
161
162  /// AbstractInstanceRootList - List of abstract instance roots of inlined
163  /// functions. These are subroutine entries that contain a DW_AT_inline
164  /// attribute.
165  SmallVector<DbgScope *, 32> AbstractInstanceRootList;
166
167  /// LexicalScopeStack - A stack of lexical scopes. The top one is the current
168  /// scope.
169  SmallVector<DbgScope *, 16> LexicalScopeStack;
170
171  /// CompileUnitOffsets - A vector of the offsets of the compile units. This is
172  /// used when calculating the "origin" of a concrete instance of an inlined
173  /// function.
174  DenseMap<CompileUnit *, unsigned> CompileUnitOffsets;
175
176  /// DebugTimer - Timer for the Dwarf debug writer.
177  Timer *DebugTimer;
178
179  struct FunctionDebugFrameInfo {
180    unsigned Number;
181    std::vector<MachineMove> Moves;
182
183    FunctionDebugFrameInfo(unsigned Num, const std::vector<MachineMove> &M)
184      : Number(Num), Moves(M) {}
185  };
186
187  std::vector<FunctionDebugFrameInfo> DebugFrames;
188
189  /// getSourceDirectoryAndFileIds - Return the directory and file ids that
190  /// maps to the source id. Source id starts at 1.
191  std::pair<unsigned, unsigned>
192  getSourceDirectoryAndFileIds(unsigned SId) const {
193    return SourceIds[SId-1];
194  }
195
196  /// getNumSourceDirectories - Return the number of source directories in the
197  /// debug info.
198  unsigned getNumSourceDirectories() const {
199    return DirectoryNames.size();
200  }
201
202  /// getSourceDirectoryName - Return the name of the directory corresponding
203  /// to the id.
204  const std::string &getSourceDirectoryName(unsigned Id) const {
205    return DirectoryNames[Id - 1];
206  }
207
208  /// getSourceFileName - Return the name of the source file corresponding
209  /// to the id.
210  const std::string &getSourceFileName(unsigned Id) const {
211    return SourceFileNames[Id - 1];
212  }
213
214  /// getNumSourceIds - Return the number of unique source ids.
215  unsigned getNumSourceIds() const {
216    return SourceIds.size();
217  }
218
219  /// AssignAbbrevNumber - Define a unique number for the abbreviation.
220  ///
221  void AssignAbbrevNumber(DIEAbbrev &Abbrev);
222
223  /// CreateDIEEntry - Creates a new DIEEntry to be a proxy for a debug
224  /// information entry.
225  DIEEntry *CreateDIEEntry(DIE *Entry = NULL);
226
227  /// SetDIEEntry - Set a DIEEntry once the debug information entry is defined.
228  ///
229  void SetDIEEntry(DIEEntry *Value, DIE *Entry);
230
231  /// AddUInt - Add an unsigned integer attribute data and value.
232  ///
233  void AddUInt(DIE *Die, unsigned Attribute, unsigned Form, uint64_t Integer);
234
235  /// AddSInt - Add an signed integer attribute data and value.
236  ///
237  void AddSInt(DIE *Die, unsigned Attribute, unsigned Form, int64_t Integer);
238
239  /// AddString - Add a string attribute data and value.
240  ///
241  void AddString(DIE *Die, unsigned Attribute, unsigned Form,
242                 const std::string &String);
243
244  /// AddLabel - Add a Dwarf label attribute data and value.
245  ///
246  void AddLabel(DIE *Die, unsigned Attribute, unsigned Form,
247                const DWLabel &Label);
248
249  /// AddObjectLabel - Add an non-Dwarf label attribute data and value.
250  ///
251  void AddObjectLabel(DIE *Die, unsigned Attribute, unsigned Form,
252                      const std::string &Label);
253
254  /// AddSectionOffset - Add a section offset label attribute data and value.
255  ///
256  void AddSectionOffset(DIE *Die, unsigned Attribute, unsigned Form,
257                        const DWLabel &Label, const DWLabel &Section,
258                        bool isEH = false, bool useSet = true);
259
260  /// AddDelta - Add a label delta attribute data and value.
261  ///
262  void AddDelta(DIE *Die, unsigned Attribute, unsigned Form,
263                const DWLabel &Hi, const DWLabel &Lo);
264
265  /// AddDIEEntry - Add a DIE attribute data and value.
266  ///
267  void AddDIEEntry(DIE *Die, unsigned Attribute, unsigned Form, DIE *Entry) {
268    Die->AddValue(Attribute, Form, CreateDIEEntry(Entry));
269  }
270
271  /// AddBlock - Add block data.
272  ///
273  void AddBlock(DIE *Die, unsigned Attribute, unsigned Form, DIEBlock *Block);
274
275  /// AddSourceLine - Add location information to specified debug information
276  /// entry.
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
282  /// AddAddress - Add an address attribute to a die based on the location
283  /// provided.
284  void AddAddress(DIE *Die, unsigned Attribute,
285                  const MachineLocation &Location);
286
287  /// AddComplexAddress - Start with the address based on the location provided,
288  /// and generate the DWARF information necessary to find the actual variable
289  /// (navigating the extra location information encoded in the type) based on
290  /// the starting location.  Add the DWARF information to the die.
291  ///
292  void AddComplexAddress(DbgVariable *&DV, DIE *Die, unsigned Attribute,
293                         const MachineLocation &Location);
294
295  // FIXME: Should be reformulated in terms of AddComplexAddress.
296  /// AddBlockByrefAddress - Start with the address based on the location
297  /// provided, and generate the DWARF information necessary to find the
298  /// actual Block variable (navigating the Block struct) based on the
299  /// starting location.  Add the DWARF information to the die.  Obsolete,
300  /// please use AddComplexAddress instead.
301  ///
302  void AddBlockByrefAddress(DbgVariable *&DV, DIE *Die, unsigned Attribute,
303                            const MachineLocation &Location);
304
305  /// AddType - Add a new type attribute to the specified entity.
306  void AddType(CompileUnit *DW_Unit, DIE *Entity, DIType Ty);
307
308  /// ConstructTypeDIE - Construct basic type die from DIBasicType.
309  void ConstructTypeDIE(CompileUnit *DW_Unit, DIE &Buffer,
310                        DIBasicType BTy);
311
312  /// ConstructTypeDIE - Construct derived type die from DIDerivedType.
313  void ConstructTypeDIE(CompileUnit *DW_Unit, DIE &Buffer,
314                        DIDerivedType DTy);
315
316  /// ConstructTypeDIE - Construct type DIE from DICompositeType.
317  void ConstructTypeDIE(CompileUnit *DW_Unit, DIE &Buffer,
318                        DICompositeType CTy);
319
320  /// ConstructSubrangeDIE - Construct subrange DIE from DISubrange.
321  void ConstructSubrangeDIE(DIE &Buffer, DISubrange SR, DIE *IndexTy);
322
323  /// ConstructArrayTypeDIE - Construct array type DIE from DICompositeType.
324  void ConstructArrayTypeDIE(CompileUnit *DW_Unit, DIE &Buffer,
325                             DICompositeType *CTy);
326
327  /// ConstructEnumTypeDIE - Construct enum type DIE from DIEnumerator.
328  DIE *ConstructEnumTypeDIE(CompileUnit *DW_Unit, DIEnumerator *ETy);
329
330  /// CreateGlobalVariableDIE - Create new DIE using GV.
331  DIE *CreateGlobalVariableDIE(CompileUnit *DW_Unit,
332                               const DIGlobalVariable &GV);
333
334  /// CreateMemberDIE - Create new member DIE.
335  DIE *CreateMemberDIE(CompileUnit *DW_Unit, const DIDerivedType &DT);
336
337  /// CreateSubprogramDIE - Create new DIE using SP.
338  DIE *CreateSubprogramDIE(CompileUnit *DW_Unit,
339                           const DISubprogram &SP,
340                           bool IsConstructor = false,
341                           bool IsInlined = false);
342
343  /// FindCompileUnit - Get the compile unit for the given descriptor.
344  ///
345  CompileUnit &FindCompileUnit(DICompileUnit Unit) const;
346
347  /// CreateDbgScopeVariable - Create a new scope variable.
348  ///
349  DIE *CreateDbgScopeVariable(DbgVariable *DV, CompileUnit *Unit);
350
351  /// getOrCreateScope - Returns the scope associated with the given descriptor.
352  ///
353  DbgScope *getOrCreateScope(MDNode *N);
354
355  /// ConstructDbgScope - Construct the components of a scope.
356  ///
357  void ConstructDbgScope(DbgScope *ParentScope,
358                         unsigned ParentStartID, unsigned ParentEndID,
359                         DIE *ParentDie, CompileUnit *Unit);
360
361  /// ConstructFunctionDbgScope - Construct the scope for the subprogram.
362  ///
363  void ConstructFunctionDbgScope(DbgScope *RootScope,
364                                 bool AbstractScope = false);
365
366  /// ConstructDefaultDbgScope - Construct a default scope for the subprogram.
367  ///
368  void ConstructDefaultDbgScope(MachineFunction *MF);
369
370  /// EmitInitial - Emit initial Dwarf declarations.  This is necessary for cc
371  /// tools to recognize the object file contains Dwarf information.
372  void EmitInitial();
373
374  /// EmitDIE - Recusively Emits a debug information entry.
375  ///
376  void EmitDIE(DIE *Die);
377
378  /// SizeAndOffsetDie - Compute the size and offset of a DIE.
379  ///
380  unsigned SizeAndOffsetDie(DIE *Die, unsigned Offset, bool Last);
381
382  /// SizeAndOffsets - Compute the size and offset of all the DIEs.
383  ///
384  void SizeAndOffsets();
385
386  /// EmitDebugInfo / EmitDebugInfoPerCU - Emit the debug info section.
387  ///
388  void EmitDebugInfoPerCU(CompileUnit *Unit);
389
390  void EmitDebugInfo();
391
392  /// EmitAbbreviations - Emit the abbreviation section.
393  ///
394  void EmitAbbreviations() const;
395
396  /// EmitEndOfLineMatrix - Emit the last address of the section and the end of
397  /// the line matrix.
398  ///
399  void EmitEndOfLineMatrix(unsigned SectionEnd);
400
401  /// EmitDebugLines - Emit source line information.
402  ///
403  void EmitDebugLines();
404
405  /// EmitCommonDebugFrame - Emit common frame info into a debug frame section.
406  ///
407  void EmitCommonDebugFrame();
408
409  /// EmitFunctionDebugFrame - Emit per function frame info into a debug frame
410  /// section.
411  void EmitFunctionDebugFrame(const FunctionDebugFrameInfo &DebugFrameInfo);
412
413  void EmitDebugPubNamesPerCU(CompileUnit *Unit);
414
415  /// EmitDebugPubNames - Emit visible names into a debug pubnames section.
416  ///
417  void EmitDebugPubNames();
418
419  /// EmitDebugStr - Emit visible names into a debug str section.
420  ///
421  void EmitDebugStr();
422
423  /// EmitDebugLoc - Emit visible names into a debug loc section.
424  ///
425  void EmitDebugLoc();
426
427  /// EmitDebugARanges - Emit visible names into a debug aranges section.
428  ///
429  void EmitDebugARanges();
430
431  /// EmitDebugRanges - Emit visible names into a debug ranges section.
432  ///
433  void EmitDebugRanges();
434
435  /// EmitDebugMacInfo - Emit visible names into a debug macinfo section.
436  ///
437  void EmitDebugMacInfo();
438
439  /// EmitDebugInlineInfo - Emit inline info using following format.
440  /// Section Header:
441  /// 1. length of section
442  /// 2. Dwarf version number
443  /// 3. address size.
444  ///
445  /// Entries (one "entry" for each function that was inlined):
446  ///
447  /// 1. offset into __debug_str section for MIPS linkage name, if exists;
448  ///   otherwise offset into __debug_str for regular function name.
449  /// 2. offset into __debug_str section for regular function name.
450  /// 3. an unsigned LEB128 number indicating the number of distinct inlining
451  /// instances for the function.
452  ///
453  /// The rest of the entry consists of a {die_offset, low_pc}  pair for each
454  /// inlined instance; the die_offset points to the inlined_subroutine die in
455  /// the __debug_info section, and the low_pc is the starting address  for the
456  ///  inlining instance.
457  void EmitDebugInlineInfo();
458
459  /// GetOrCreateSourceID - Look up the source id with the given directory and
460  /// source file names. If none currently exists, create a new id and insert it
461  /// in the SourceIds map. This can update DirectoryNames and SourceFileNames maps
462  /// as well.
463  unsigned GetOrCreateSourceID(const char *DirName,
464                               const char *FileName);
465
466  void ConstructCompileUnit(MDNode *N);
467
468  void ConstructGlobalVariableDIE(MDNode *N);
469
470  void ConstructSubprogram(MDNode *N);
471
472  // FIXME: This should go away in favor of complex addresses.
473  /// Find the type the programmer originally declared the variable to be
474  /// and return that type.  Obsolete, use GetComplexAddrType instead.
475  ///
476  DIType GetBlockByrefType(DIType Ty, std::string Name);
477
478public:
479  //===--------------------------------------------------------------------===//
480  // Main entry points.
481  //
482  DwarfDebug(raw_ostream &OS, AsmPrinter *A, const MCAsmInfo *T);
483  virtual ~DwarfDebug();
484
485  /// ShouldEmitDwarfDebug - Returns true if Dwarf debugging declarations should
486  /// be emitted.
487  bool ShouldEmitDwarfDebug() const { return shouldEmit; }
488
489  /// BeginModule - Emit all Dwarf sections that should come prior to the
490  /// content.
491  void BeginModule(Module *M, MachineModuleInfo *MMI);
492
493  /// EndModule - Emit all Dwarf sections that should come after the content.
494  ///
495  void EndModule();
496
497  /// BeginFunction - Gather pre-function debug information.  Assumes being
498  /// emitted immediately after the function entry point.
499  void BeginFunction(MachineFunction *MF);
500
501  /// EndFunction - Gather and emit post-function debug information.
502  ///
503  void EndFunction(MachineFunction *MF);
504
505  /// RecordSourceLine - Records location information and associates it with a
506  /// label. Returns a unique label ID used to generate a label and provide
507  /// correspondence to the source line list.
508  unsigned RecordSourceLine(Value *V, unsigned Line, unsigned Col);
509
510  /// RecordSourceLine - Records location information and associates it with a
511  /// label. Returns a unique label ID used to generate a label and provide
512  /// correspondence to the source line list.
513  unsigned RecordSourceLine(unsigned Line, unsigned Col, MDNode *Scope);
514
515  /// getRecordSourceLineCount - Return the number of source lines in the debug
516  /// info.
517  unsigned getRecordSourceLineCount() const {
518    return Lines.size();
519  }
520
521  /// getOrCreateSourceID - Public version of GetOrCreateSourceID. This can be
522  /// timed. Look up the source id with the given directory and source file
523  /// names. If none currently exists, create a new id and insert it in the
524  /// SourceIds map. This can update DirectoryNames and SourceFileNames maps as
525  /// well.
526  unsigned getOrCreateSourceID(const std::string &DirName,
527                               const std::string &FileName);
528
529  /// RecordRegionStart - Indicate the start of a region.
530  unsigned RecordRegionStart(MDNode *N);
531
532  /// RecordRegionEnd - Indicate the end of a region.
533  unsigned RecordRegionEnd(MDNode *N);
534
535  /// RecordVariable - Indicate the declaration of  a local variable.
536  void RecordVariable(MDNode *N, unsigned FrameIndex);
537
538  //// RecordInlinedFnStart - Indicate the start of inlined subroutine.
539  unsigned RecordInlinedFnStart(DISubprogram &SP, DICompileUnit CU,
540                                unsigned Line, unsigned Col);
541
542  /// RecordInlinedFnEnd - Indicate the end of inlined subroutine.
543  unsigned RecordInlinedFnEnd(DISubprogram &SP);
544
545};
546
547} // End of namespace llvm
548
549#endif
550