Fix a funky "declared with greater visibility than the type of its field"
[oota-llvm.git] / lib / CodeGen / AsmPrinter / DwarfDebug.h
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/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"
28 #include <string>
29
30 namespace llvm {
31
32 class CompileUnit;
33 class DbgVariable;
34 class DbgScope;
35 class DbgConcreteScope;
36 class MachineFrameInfo;
37 class MachineModuleInfo;
38 class MCAsmInfo;
39 class Timer;
40
41 //===----------------------------------------------------------------------===//
42 /// SrcLineInfo - This class is used to record source line correspondence.
43 ///
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.
49 public:
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
60 class 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   ValueMap<MDNode *, DbgScope *> DbgScopeMap;
143
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;
147
148   typedef DenseMap<const MachineInstr *, SmallVector<DbgScope *, 2> > 
149     InsnToDbgScopeMapTy;
150
151   /// DbgScopeBeginMap - Maps instruction with a list DbgScopes it starts.
152   InsnToDbgScopeMapTy DbgScopeBeginMap;
153
154   /// DbgScopeEndMap - Maps instruction with a list DbgScopes it ends.
155   InsnToDbgScopeMapTy DbgScopeEndMap;
156
157   /// DbgAbstractScopeMap - Tracks abstract instance scopes in the current
158   /// function.
159   ValueMap<MDNode *, DbgScope *> DbgAbstractScopeMap;
160
161   /// DbgConcreteScopeMap - Tracks concrete instance scopes in the current
162   /// function.
163   ValueMap<MDNode *,
164            SmallVector<DbgScope *, 8> > DbgConcreteScopeMap;
165
166   /// InlineInfo - Keep track of inlined functions and their location.  This
167   /// information is used to populate debug_inlined section.
168   ValueMap<MDNode *, SmallVector<unsigned, 4> > InlineInfo;
169
170   /// AbstractInstanceRootMap - Map of abstract instance roots of inlined
171   /// functions. These are subroutine entries that contain a DW_AT_inline
172   /// attribute.
173   DenseMap<const MDNode *, DbgScope *> AbstractInstanceRootMap;
174
175   /// AbstractInstanceRootList - List of abstract instance roots of inlined
176   /// functions. These are subroutine entries that contain a DW_AT_inline
177   /// attribute.
178   SmallVector<DbgScope *, 32> AbstractInstanceRootList;
179
180   /// LexicalScopeStack - A stack of lexical scopes. The top one is the current
181   /// scope.
182   SmallVector<DbgScope *, 16> LexicalScopeStack;
183
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
186   /// function.
187   DenseMap<CompileUnit *, unsigned> CompileUnitOffsets;
188
189   /// DebugTimer - Timer for the Dwarf debug writer.
190   Timer *DebugTimer;
191   
192   struct FunctionDebugFrameInfo {
193     unsigned Number;
194     std::vector<MachineMove> Moves;
195
196     FunctionDebugFrameInfo(unsigned Num, const std::vector<MachineMove> &M)
197       : Number(Num), Moves(M) {}
198   };
199
200   std::vector<FunctionDebugFrameInfo> DebugFrames;
201
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];
207   }
208
209   /// getNumSourceDirectories - Return the number of source directories in the
210   /// debug info.
211   unsigned getNumSourceDirectories() const {
212     return DirectoryNames.size();
213   }
214
215   /// getSourceDirectoryName - Return the name of the directory corresponding
216   /// to the id.
217   const std::string &getSourceDirectoryName(unsigned Id) const {
218     return DirectoryNames[Id - 1];
219   }
220
221   /// getSourceFileName - Return the name of the source file corresponding
222   /// to the id.
223   const std::string &getSourceFileName(unsigned Id) const {
224     return SourceFileNames[Id - 1];
225   }
226
227   /// getNumSourceIds - Return the number of unique source ids.
228   unsigned getNumSourceIds() const {
229     return SourceIds.size();
230   }
231
232   /// AssignAbbrevNumber - Define a unique number for the abbreviation.
233   ///
234   void AssignAbbrevNumber(DIEAbbrev &Abbrev);
235
236   /// CreateDIEEntry - Creates a new DIEEntry to be a proxy for a debug
237   /// information entry.
238   DIEEntry *CreateDIEEntry(DIE *Entry = NULL);
239
240   /// SetDIEEntry - Set a DIEEntry once the debug information entry is defined.
241   ///
242   void SetDIEEntry(DIEEntry *Value, DIE *Entry);
243
244   /// AddUInt - Add an unsigned integer attribute data and value.
245   ///
246   void AddUInt(DIE *Die, unsigned Attribute, unsigned Form, uint64_t Integer);
247
248   /// AddSInt - Add an signed integer attribute data and value.
249   ///
250   void AddSInt(DIE *Die, unsigned Attribute, unsigned Form, int64_t Integer);
251
252   /// AddString - Add a string attribute data and value.
253   ///
254   void AddString(DIE *Die, unsigned Attribute, unsigned Form,
255                  const std::string &String);
256
257   /// AddLabel - Add a Dwarf label attribute data and value.
258   ///
259   void AddLabel(DIE *Die, unsigned Attribute, unsigned Form,
260                 const DWLabel &Label);
261
262   /// AddObjectLabel - Add an non-Dwarf label attribute data and value.
263   ///
264   void AddObjectLabel(DIE *Die, unsigned Attribute, unsigned Form,
265                       const std::string &Label);
266
267   /// AddSectionOffset - Add a section offset label attribute data and value.
268   ///
269   void AddSectionOffset(DIE *Die, unsigned Attribute, unsigned Form,
270                         const DWLabel &Label, const DWLabel &Section,
271                         bool isEH = false, bool useSet = true);
272
273   /// AddDelta - Add a label delta attribute data and value.
274   ///
275   void AddDelta(DIE *Die, unsigned Attribute, unsigned Form,
276                 const DWLabel &Hi, const DWLabel &Lo);
277
278   /// AddDIEEntry - Add a DIE attribute data and value.
279   ///
280   void AddDIEEntry(DIE *Die, unsigned Attribute, unsigned Form, DIE *Entry) {
281     Die->AddValue(Attribute, Form, CreateDIEEntry(Entry));
282   }
283
284   /// AddBlock - Add block data.
285   ///
286   void AddBlock(DIE *Die, unsigned Attribute, unsigned Form, DIEBlock *Block);
287
288   /// AddSourceLine - Add location information to specified debug information
289   /// entry.
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);
294
295   /// AddAddress - Add an address attribute to a die based on the location
296   /// provided.
297   void AddAddress(DIE *Die, unsigned Attribute,
298                   const MachineLocation &Location);
299
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.
304   ///
305   void AddComplexAddress(DbgVariable *&DV, DIE *Die, unsigned Attribute,
306                          const MachineLocation &Location);
307
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.
314   ///
315   void AddBlockByrefAddress(DbgVariable *&DV, DIE *Die, unsigned Attribute,
316                             const MachineLocation &Location);
317
318   /// AddType - Add a new type attribute to the specified entity.
319   void AddType(CompileUnit *DW_Unit, DIE *Entity, DIType Ty);
320
321   /// ConstructTypeDIE - Construct basic type die from DIBasicType.
322   void ConstructTypeDIE(CompileUnit *DW_Unit, DIE &Buffer,
323                         DIBasicType BTy);
324
325   /// ConstructTypeDIE - Construct derived type die from DIDerivedType.
326   void ConstructTypeDIE(CompileUnit *DW_Unit, DIE &Buffer,
327                         DIDerivedType DTy);
328
329   /// ConstructTypeDIE - Construct type DIE from DICompositeType.
330   void ConstructTypeDIE(CompileUnit *DW_Unit, DIE &Buffer,
331                         DICompositeType CTy);
332
333   /// ConstructSubrangeDIE - Construct subrange DIE from DISubrange.
334   void ConstructSubrangeDIE(DIE &Buffer, DISubrange SR, DIE *IndexTy);
335
336   /// ConstructArrayTypeDIE - Construct array type DIE from DICompositeType.
337   void ConstructArrayTypeDIE(CompileUnit *DW_Unit, DIE &Buffer, 
338                              DICompositeType *CTy);
339
340   /// ConstructEnumTypeDIE - Construct enum type DIE from DIEnumerator.
341   DIE *ConstructEnumTypeDIE(CompileUnit *DW_Unit, DIEnumerator *ETy);
342
343   /// CreateGlobalVariableDIE - Create new DIE using GV.
344   DIE *CreateGlobalVariableDIE(CompileUnit *DW_Unit,
345                                const DIGlobalVariable &GV);
346
347   /// CreateMemberDIE - Create new member DIE.
348   DIE *CreateMemberDIE(CompileUnit *DW_Unit, const DIDerivedType &DT);
349
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);
355
356   /// FindCompileUnit - Get the compile unit for the given descriptor. 
357   ///
358   CompileUnit &FindCompileUnit(DICompileUnit Unit) const;
359
360   /// CreateDbgScopeVariable - Create a new scope variable.
361   ///
362   DIE *CreateDbgScopeVariable(DbgVariable *DV, CompileUnit *Unit);
363
364   /// getDbgScope - Returns the scope associated with the given descriptor.
365   ///
366   DbgScope *getOrCreateScope(MDNode *N);
367   DbgScope *getDbgScope(MDNode *N, const MachineInstr *MI, MDNode *InlinedAt);
368
369   /// ConstructDbgScope - Construct the components of a scope.
370   ///
371   void ConstructDbgScope(DbgScope *ParentScope,
372                          unsigned ParentStartID, unsigned ParentEndID,
373                          DIE *ParentDie, CompileUnit *Unit);
374
375   /// ConstructFunctionDbgScope - Construct the scope for the subprogram.
376   ///
377   void ConstructFunctionDbgScope(DbgScope *RootScope,
378                                  bool AbstractScope = false);
379
380   /// ConstructDefaultDbgScope - Construct a default scope for the subprogram.
381   ///
382   void ConstructDefaultDbgScope(MachineFunction *MF);
383
384   /// EmitInitial - Emit initial Dwarf declarations.  This is necessary for cc
385   /// tools to recognize the object file contains Dwarf information.
386   void EmitInitial();
387
388   /// EmitDIE - Recusively Emits a debug information entry.
389   ///
390   void EmitDIE(DIE *Die);
391
392   /// SizeAndOffsetDie - Compute the size and offset of a DIE.
393   ///
394   unsigned SizeAndOffsetDie(DIE *Die, unsigned Offset, bool Last);
395
396   /// SizeAndOffsets - Compute the size and offset of all the DIEs.
397   ///
398   void SizeAndOffsets();
399
400   /// EmitDebugInfo / EmitDebugInfoPerCU - Emit the debug info section.
401   ///
402   void EmitDebugInfoPerCU(CompileUnit *Unit);
403
404   void EmitDebugInfo();
405
406   /// EmitAbbreviations - Emit the abbreviation section.
407   ///
408   void EmitAbbreviations() const;
409
410   /// EmitEndOfLineMatrix - Emit the last address of the section and the end of
411   /// the line matrix.
412   ///
413   void EmitEndOfLineMatrix(unsigned SectionEnd);
414
415   /// EmitDebugLines - Emit source line information.
416   ///
417   void EmitDebugLines();
418
419   /// EmitCommonDebugFrame - Emit common frame info into a debug frame section.
420   ///
421   void EmitCommonDebugFrame();
422
423   /// EmitFunctionDebugFrame - Emit per function frame info into a debug frame
424   /// section.
425   void EmitFunctionDebugFrame(const FunctionDebugFrameInfo &DebugFrameInfo);
426
427   void EmitDebugPubNamesPerCU(CompileUnit *Unit);
428
429   /// EmitDebugPubNames - Emit visible names into a debug pubnames section.
430   ///
431   void EmitDebugPubNames();
432
433   /// EmitDebugStr - Emit visible names into a debug str section.
434   ///
435   void EmitDebugStr();
436
437   /// EmitDebugLoc - Emit visible names into a debug loc section.
438   ///
439   void EmitDebugLoc();
440
441   /// EmitDebugARanges - Emit visible names into a debug aranges section.
442   ///
443   void EmitDebugARanges();
444
445   /// EmitDebugRanges - Emit visible names into a debug ranges section.
446   ///
447   void EmitDebugRanges();
448
449   /// EmitDebugMacInfo - Emit visible names into a debug macinfo section.
450   ///
451   void EmitDebugMacInfo();
452
453   /// EmitDebugInlineInfo - Emit inline info using following format.
454   /// Section Header:
455   /// 1. length of section
456   /// 2. Dwarf version number
457   /// 3. address size.
458   ///
459   /// Entries (one "entry" for each function that was inlined):
460   ///
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.
466   /// 
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();
472
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
476   /// as well.
477   unsigned GetOrCreateSourceID(const char *DirName,
478                                const char *FileName);
479
480   void ConstructCompileUnit(MDNode *N);
481
482   void ConstructGlobalVariableDIE(MDNode *N);
483
484   void ConstructSubprogram(MDNode *N);
485
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.
489   ///
490   DIType GetBlockByrefType(DIType Ty, std::string Name);
491
492 public:
493   //===--------------------------------------------------------------------===//
494   // Main entry points.
495   //
496   DwarfDebug(raw_ostream &OS, AsmPrinter *A, const MCAsmInfo *T);
497   virtual ~DwarfDebug();
498
499   /// ShouldEmitDwarfDebug - Returns true if Dwarf debugging declarations should
500   /// be emitted.
501   bool ShouldEmitDwarfDebug() const { return shouldEmit; }
502
503   /// BeginModule - Emit all Dwarf sections that should come prior to the
504   /// content.
505   void BeginModule(Module *M, MachineModuleInfo *MMI);
506
507   /// EndModule - Emit all Dwarf sections that should come after the content.
508   ///
509   void EndModule();
510
511   /// BeginFunction - Gather pre-function debug information.  Assumes being
512   /// emitted immediately after the function entry point.
513   void BeginFunction(MachineFunction *MF);
514
515   /// EndFunction - Gather and emit post-function debug information.
516   ///
517   void EndFunction(MachineFunction *MF);
518
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);
523
524   /// getRecordSourceLineCount - Return the number of source lines in the debug
525   /// info.
526   unsigned getRecordSourceLineCount() const {
527     return Lines.size();
528   }
529                             
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
534   /// well.
535   unsigned getOrCreateSourceID(const std::string &DirName,
536                                const std::string &FileName);
537
538   /// RecordRegionStart - Indicate the start of a region.
539   unsigned RecordRegionStart(MDNode *N);
540
541   /// RecordRegionEnd - Indicate the end of a region.
542   unsigned RecordRegionEnd(MDNode *N);
543
544   /// RecordVariable - Indicate the declaration of  a local variable.
545   void RecordVariable(MDNode *N, unsigned FrameIndex);
546
547   //// RecordInlinedFnStart - Indicate the start of inlined subroutine.
548   unsigned RecordInlinedFnStart(DISubprogram &SP, DICompileUnit CU,
549                                 unsigned Line, unsigned Col);
550
551   /// RecordInlinedFnEnd - Indicate the end of inlined subroutine.
552   unsigned RecordInlinedFnEnd(DISubprogram &SP);
553
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);
557
558   /// CollectVariableInfo - Populate DbgScope entries with variables' info.
559   void CollectVariableInfo();
560
561   /// SetDbgScopeBeginLabels - Update DbgScope begin labels for the scopes that
562   /// start with this machine instruction.
563   void SetDbgScopeBeginLabels(const MachineInstr *MI, unsigned Label);
564
565   /// SetDbgScopeEndLabels - Update DbgScope end labels for the scopes that
566   /// end with this machine instruction.
567   void SetDbgScopeEndLabels(const MachineInstr *MI, unsigned Label);
568 };
569
570 } // End of namespace llvm
571
572 #endif