DwarfDebug.h revision 55202eaf6299c8be2aaa97697c6dfccbbbfcc81c
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 "llvm/CodeGen/AsmPrinter.h"
18#include "llvm/CodeGen/MachineLocation.h"
19#include "DIE.h"
20#include "llvm/ADT/DenseMap.h"
21#include "llvm/ADT/FoldingSet.h"
22#include "llvm/ADT/SmallPtrSet.h"
23#include "llvm/ADT/StringMap.h"
24#include "llvm/ADT/UniqueVector.h"
25#include "llvm/Support/Allocator.h"
26
27namespace llvm {
28
29class CompileUnit;
30class DbgConcreteScope;
31class DbgScope;
32class DbgVariable;
33class MachineFrameInfo;
34class MachineModuleInfo;
35class MachineOperand;
36class MCAsmInfo;
37class DIEAbbrev;
38class DIE;
39class DIEBlock;
40class DIEEntry;
41
42class DIEnumerator;
43class DIDescriptor;
44class DIVariable;
45class DIGlobal;
46class DIGlobalVariable;
47class DISubprogram;
48class DIBasicType;
49class DIDerivedType;
50class DIType;
51class DINameSpace;
52class DISubrange;
53class DICompositeType;
54
55//===----------------------------------------------------------------------===//
56/// SrcLineInfo - This class is used to record source line correspondence.
57///
58class SrcLineInfo {
59  unsigned Line;                     // Source line number.
60  unsigned Column;                   // Source column.
61  unsigned SourceID;                 // Source ID number.
62  MCSymbol *Label;                   // Label in code ID number.
63public:
64  SrcLineInfo(unsigned L, unsigned C, unsigned S, MCSymbol *label)
65    : Line(L), Column(C), SourceID(S), Label(label) {}
66
67  // Accessors
68  unsigned getLine() const { return Line; }
69  unsigned getColumn() const { return Column; }
70  unsigned getSourceID() const { return SourceID; }
71  MCSymbol *getLabel() const { return Label; }
72};
73
74class DwarfDebug {
75  /// Asm - Target of Dwarf emission.
76  AsmPrinter *Asm;
77
78  /// MMI - Collected machine module information.
79  MachineModuleInfo *MMI;
80
81  //===--------------------------------------------------------------------===//
82  // Attributes used to construct specific Dwarf sections.
83  //
84
85  CompileUnit *FirstCU;
86  DenseMap <const MDNode *, CompileUnit *> CUMap;
87
88  /// AbbreviationsSet - Used to uniquely define abbreviations.
89  ///
90  FoldingSet<DIEAbbrev> AbbreviationsSet;
91
92  /// Abbreviations - A list of all the unique abbreviations in use.
93  ///
94  std::vector<DIEAbbrev *> Abbreviations;
95
96  /// DirectoryIdMap - Directory name to directory id map.
97  ///
98  StringMap<unsigned> DirectoryIdMap;
99
100  /// DirectoryNames - A list of directory names.
101  SmallVector<std::string, 8> DirectoryNames;
102
103  /// SourceFileIdMap - Source file name to source file id map.
104  ///
105  StringMap<unsigned> SourceFileIdMap;
106
107  /// SourceFileNames - A list of source file names.
108  SmallVector<std::string, 8> SourceFileNames;
109
110  /// SourceIdMap - Source id map, i.e. pair of directory id and source file
111  /// id mapped to a unique id.
112  DenseMap<std::pair<unsigned, unsigned>, unsigned> SourceIdMap;
113
114  /// SourceIds - Reverse map from source id to directory id + file id pair.
115  ///
116  SmallVector<std::pair<unsigned, unsigned>, 8> SourceIds;
117
118  /// Lines - List of source line correspondence.
119  std::vector<SrcLineInfo> Lines;
120
121  /// DIEBlocks - A list of all the DIEBlocks in use.
122  std::vector<DIEBlock *> DIEBlocks;
123
124  // DIEValueAllocator - All DIEValues are allocated through this allocator.
125  BumpPtrAllocator DIEValueAllocator;
126
127  /// StringPool - A String->Symbol mapping of strings used by indirect
128  /// references.
129  StringMap<std::pair<MCSymbol*, unsigned> > StringPool;
130  unsigned NextStringPoolNumber;
131
132  MCSymbol *getStringPoolEntry(StringRef Str);
133
134  /// SectionMap - Provides a unique id per text section.
135  ///
136  UniqueVector<const MCSection*> SectionMap;
137
138  /// SectionSourceLines - Tracks line numbers per text section.
139  ///
140  std::vector<std::vector<SrcLineInfo> > SectionSourceLines;
141
142  // CurrentFnDbgScope - Top level scope for the current function.
143  //
144  DbgScope *CurrentFnDbgScope;
145
146  /// DbgScopeMap - Tracks the scopes in the current function.  Owns the
147  /// contained DbgScope*s.
148  ///
149  DenseMap<const MDNode *, DbgScope *> DbgScopeMap;
150
151  /// ConcreteScopes - Tracks the concrete scopees in the current function.
152  /// These scopes are also included in DbgScopeMap.
153  DenseMap<const MDNode *, DbgScope *> ConcreteScopes;
154
155  /// AbstractScopes - Tracks the abstract scopes a module. These scopes are
156  /// not included DbgScopeMap.  AbstractScopes owns its DbgScope*s.
157  DenseMap<const MDNode *, DbgScope *> AbstractScopes;
158
159  /// AbstractScopesList - Tracks abstract scopes constructed while processing
160  /// a function. This list is cleared during endFunction().
161  SmallVector<DbgScope *, 4>AbstractScopesList;
162
163  /// AbstractVariables - Collection on abstract variables.  Owned by the
164  /// DbgScopes in AbstractScopes.
165  DenseMap<const MDNode *, DbgVariable *> AbstractVariables;
166
167  /// DbgVariableToFrameIndexMap - Tracks frame index used to find
168  /// variable's value.
169  DenseMap<const DbgVariable *, int> DbgVariableToFrameIndexMap;
170
171  /// DbgVariableToDbgInstMap - Maps DbgVariable to corresponding DBG_VALUE
172  /// machine instruction.
173  DenseMap<const DbgVariable *, const MachineInstr *> DbgVariableToDbgInstMap;
174
175  /// DbgVariableLabelsMap - Maps DbgVariable to corresponding MCSymbol.
176  DenseMap<const DbgVariable *, const MCSymbol *> DbgVariableLabelsMap;
177
178  /// DotDebugLocEntry - This struct describes location entries emitted in
179  /// .debug_loc section.
180  typedef struct DotDebugLocEntry {
181    const MCSymbol *Begin;
182    const MCSymbol *End;
183    MachineLocation Loc;
184    DotDebugLocEntry() : Begin(0), End(0) {}
185    DotDebugLocEntry(const MCSymbol *B, const MCSymbol *E,
186                  MachineLocation &L) : Begin(B), End(E), Loc(L) {}
187    /// Empty entries are also used as a trigger to emit temp label. Such
188    /// labels are referenced is used to find debug_loc offset for a given DIE.
189    bool isEmpty() { return Begin == 0 && End == 0; }
190  } DotDebugLocEntry;
191
192  /// DotDebugLocEntries - Collection of DotDebugLocEntry.
193  SmallVector<DotDebugLocEntry, 4> DotDebugLocEntries;
194
195  /// UseDotDebugLocEntry - DW_AT_location attributes for the DIEs in this set
196  /// idetifies corresponding .debug_loc entry offset.
197  SmallPtrSet<const DIE *, 4> UseDotDebugLocEntry;
198
199  /// VarToAbstractVarMap - Maps DbgVariable with corresponding Abstract
200  /// DbgVariable, if any.
201  DenseMap<const DbgVariable *, const DbgVariable *> VarToAbstractVarMap;
202
203  /// InliendSubprogramDIEs - Collection of subprgram DIEs that are marked
204  /// (at the end of the module) as DW_AT_inline.
205  SmallPtrSet<DIE *, 4> InlinedSubprogramDIEs;
206
207  /// ContainingTypeMap - This map is used to keep track of subprogram DIEs that
208  /// need DW_AT_containing_type attribute. This attribute points to a DIE that
209  /// corresponds to the MDNode mapped with the subprogram DIE.
210  DenseMap<DIE *, const MDNode *> ContainingTypeMap;
211
212  typedef SmallVector<DbgScope *, 2> ScopeVector;
213  SmallPtrSet<const MachineInstr *, 8> InsnsBeginScopeSet;
214  SmallPtrSet<const MachineInstr *, 8> InsnsEndScopeSet;
215
216  /// InlineInfo - Keep track of inlined functions and their location.  This
217  /// information is used to populate debug_inlined section.
218  typedef std::pair<const MCSymbol *, DIE *> InlineInfoLabels;
219  DenseMap<const MDNode *, SmallVector<InlineInfoLabels, 4> > InlineInfo;
220  SmallVector<const MDNode *, 4> InlinedSPNodes;
221
222  /// LabelsBeforeInsn - Maps instruction with label emitted before
223  /// instruction.
224  DenseMap<const MachineInstr *, MCSymbol *> LabelsBeforeInsn;
225
226  /// LabelsAfterInsn - Maps instruction with label emitted after
227  /// instruction.
228  DenseMap<const MachineInstr *, MCSymbol *> LabelsAfterInsn;
229
230  /// insnNeedsLabel - Collection of instructions that need a label to mark
231  /// a debuggging information entity.
232  SmallPtrSet<const MachineInstr *, 8> InsnNeedsLabel;
233
234  SmallVector<const MCSymbol *, 8> DebugRangeSymbols;
235
236  /// Previous instruction's location information. This is used to determine
237  /// label location to indicate scope boundries in dwarf debug info.
238  DebugLoc PrevInstLoc;
239  MCSymbol *PrevLabel;
240
241  struct FunctionDebugFrameInfo {
242    unsigned Number;
243    std::vector<MachineMove> Moves;
244
245    FunctionDebugFrameInfo(unsigned Num, const std::vector<MachineMove> &M)
246      : Number(Num), Moves(M) {}
247  };
248
249  std::vector<FunctionDebugFrameInfo> DebugFrames;
250
251  // Section Symbols: these are assembler temporary labels that are emitted at
252  // the beginning of each supported dwarf section.  These are used to form
253  // section offsets and are created by EmitSectionLabels.
254  MCSymbol *DwarfFrameSectionSym, *DwarfInfoSectionSym, *DwarfAbbrevSectionSym;
255  MCSymbol *DwarfStrSectionSym, *TextSectionSym, *DwarfDebugRangeSectionSym;
256  MCSymbol *DwarfDebugLocSectionSym;
257  MCSymbol *FunctionBeginSym, *FunctionEndSym;
258private:
259
260  /// getSourceDirectoryAndFileIds - Return the directory and file ids that
261  /// maps to the source id. Source id starts at 1.
262  std::pair<unsigned, unsigned>
263  getSourceDirectoryAndFileIds(unsigned SId) const {
264    return SourceIds[SId-1];
265  }
266
267  /// getNumSourceDirectories - Return the number of source directories in the
268  /// debug info.
269  unsigned getNumSourceDirectories() const {
270    return DirectoryNames.size();
271  }
272
273  /// getSourceDirectoryName - Return the name of the directory corresponding
274  /// to the id.
275  const std::string &getSourceDirectoryName(unsigned Id) const {
276    return DirectoryNames[Id - 1];
277  }
278
279  /// getSourceFileName - Return the name of the source file corresponding
280  /// to the id.
281  const std::string &getSourceFileName(unsigned Id) const {
282    return SourceFileNames[Id - 1];
283  }
284
285  /// getNumSourceIds - Return the number of unique source ids.
286  unsigned getNumSourceIds() const {
287    return SourceIds.size();
288  }
289
290  /// assignAbbrevNumber - Define a unique number for the abbreviation.
291  ///
292  void assignAbbrevNumber(DIEAbbrev &Abbrev);
293
294  /// createDIEEntry - Creates a new DIEEntry to be a proxy for a debug
295  /// information entry.
296  DIEEntry *createDIEEntry(DIE *Entry);
297
298  /// addUInt - Add an unsigned integer attribute data and value.
299  ///
300  void addUInt(DIE *Die, unsigned Attribute, unsigned Form, uint64_t Integer);
301
302  /// addSInt - Add an signed integer attribute data and value.
303  ///
304  void addSInt(DIE *Die, unsigned Attribute, unsigned Form, int64_t Integer);
305
306  /// addString - Add a string attribute data and value.
307  ///
308  void addString(DIE *Die, unsigned Attribute, unsigned Form,
309                 const StringRef Str);
310
311  /// addLabel - Add a Dwarf label attribute data and value.
312  ///
313  void addLabel(DIE *Die, unsigned Attribute, unsigned Form,
314                const MCSymbol *Label);
315
316  /// addDelta - Add a label delta attribute data and value.
317  ///
318  void addDelta(DIE *Die, unsigned Attribute, unsigned Form,
319                const MCSymbol *Hi, const MCSymbol *Lo);
320
321  /// addDIEEntry - Add a DIE attribute data and value.
322  ///
323  void addDIEEntry(DIE *Die, unsigned Attribute, unsigned Form, DIE *Entry);
324
325  /// addBlock - Add block data.
326  ///
327  void addBlock(DIE *Die, unsigned Attribute, unsigned Form, DIEBlock *Block);
328
329  /// addSourceLine - Add location information to specified debug information
330  /// entry.
331  void addSourceLine(DIE *Die, const DIVariable *V);
332  void addSourceLine(DIE *Die, const DIGlobalVariable *G);
333  void addSourceLine(DIE *Die, const DISubprogram *SP);
334  void addSourceLine(DIE *Die, const DIType *Ty);
335  void addSourceLine(DIE *Die, const DINameSpace *NS);
336
337  /// addAddress - Add an address attribute to a die based on the location
338  /// provided.
339  void addAddress(DIE *Die, unsigned Attribute,
340                  const MachineLocation &Location);
341
342  /// addRegisterAddress - Add register location entry in variable DIE.
343  bool addRegisterAddress(DIE *Die, const MCSymbol *VS, const MachineOperand &MO);
344
345  /// addConstantValue - Add constant value entry in variable DIE.
346  bool addConstantValue(DIE *Die, const MCSymbol *VS, const MachineOperand &MO);
347
348  /// addConstantFPValue - Add constant value entry in variable DIE.
349  bool addConstantFPValue(DIE *Die, const MCSymbol *VS, const MachineOperand &MO);
350
351  /// addComplexAddress - Start with the address based on the location provided,
352  /// and generate the DWARF information necessary to find the actual variable
353  /// (navigating the extra location information encoded in the type) based on
354  /// the starting location.  Add the DWARF information to the die.
355  ///
356  void addComplexAddress(DbgVariable *&DV, DIE *Die, unsigned Attribute,
357                         const MachineLocation &Location);
358
359  // FIXME: Should be reformulated in terms of addComplexAddress.
360  /// addBlockByrefAddress - Start with the address based on the location
361  /// provided, and generate the DWARF information necessary to find the
362  /// actual Block variable (navigating the Block struct) based on the
363  /// starting location.  Add the DWARF information to the die.  Obsolete,
364  /// please use addComplexAddress instead.
365  ///
366  void addBlockByrefAddress(DbgVariable *&DV, DIE *Die, unsigned Attribute,
367                            const MachineLocation &Location);
368
369  /// addToContextOwner - Add Die into the list of its context owner's children.
370  void addToContextOwner(DIE *Die, DIDescriptor Context);
371
372  /// addType - Add a new type attribute to the specified entity.
373  void addType(DIE *Entity, DIType Ty);
374
375
376  /// getOrCreateNameSpace - Create a DIE for DINameSpace.
377  DIE *getOrCreateNameSpace(DINameSpace NS);
378
379  /// getOrCreateTypeDIE - Find existing DIE or create new DIE for the
380  /// given DIType.
381  DIE *getOrCreateTypeDIE(DIType Ty);
382
383  void addPubTypes(DISubprogram SP);
384
385  /// constructTypeDIE - Construct basic type die from DIBasicType.
386  void constructTypeDIE(DIE &Buffer,
387                        DIBasicType BTy);
388
389  /// constructTypeDIE - Construct derived type die from DIDerivedType.
390  void constructTypeDIE(DIE &Buffer,
391                        DIDerivedType DTy);
392
393  /// constructTypeDIE - Construct type DIE from DICompositeType.
394  void constructTypeDIE(DIE &Buffer,
395                        DICompositeType CTy);
396
397  /// constructSubrangeDIE - Construct subrange DIE from DISubrange.
398  void constructSubrangeDIE(DIE &Buffer, DISubrange SR, DIE *IndexTy);
399
400  /// constructArrayTypeDIE - Construct array type DIE from DICompositeType.
401  void constructArrayTypeDIE(DIE &Buffer,
402                             DICompositeType *CTy);
403
404  /// constructEnumTypeDIE - Construct enum type DIE from DIEnumerator.
405  DIE *constructEnumTypeDIE(DIEnumerator ETy);
406
407  /// createGlobalVariableDIE - Create new DIE using GV.
408  DIE *createGlobalVariableDIE(const DIGlobalVariable &GV);
409
410  /// createMemberDIE - Create new member DIE.
411  DIE *createMemberDIE(const DIDerivedType &DT);
412
413  /// createSubprogramDIE - Create new DIE using SP.
414  DIE *createSubprogramDIE(const DISubprogram &SP, bool MakeDecl = false);
415
416  /// getOrCreateDbgScope - Create DbgScope for the scope.
417  DbgScope *getOrCreateDbgScope(const MDNode *Scope, const MDNode *InlinedAt);
418
419  DbgScope *getOrCreateAbstractScope(const MDNode *N);
420
421  /// findAbstractVariable - Find abstract variable associated with Var.
422  DbgVariable *findAbstractVariable(DIVariable &Var, DebugLoc Loc);
423
424  /// updateSubprogramScopeDIE - Find DIE for the given subprogram and
425  /// attach appropriate DW_AT_low_pc and DW_AT_high_pc attributes.
426  /// If there are global variables in this scope then create and insert
427  /// DIEs for these variables.
428  DIE *updateSubprogramScopeDIE(const MDNode *SPNode);
429
430  /// constructLexicalScope - Construct new DW_TAG_lexical_block
431  /// for this scope and attach DW_AT_low_pc/DW_AT_high_pc labels.
432  DIE *constructLexicalScopeDIE(DbgScope *Scope);
433
434  /// constructInlinedScopeDIE - This scope represents inlined body of
435  /// a function. Construct DIE to represent this concrete inlined copy
436  /// of the function.
437  DIE *constructInlinedScopeDIE(DbgScope *Scope);
438
439  /// constructVariableDIE - Construct a DIE for the given DbgVariable.
440  DIE *constructVariableDIE(DbgVariable *DV, DbgScope *S);
441
442  /// constructScopeDIE - Construct a DIE for this scope.
443  DIE *constructScopeDIE(DbgScope *Scope);
444
445  /// EmitSectionLabels - Emit initial Dwarf sections with a label at
446  /// the start of each one.
447  void EmitSectionLabels();
448
449  /// emitDIE - Recusively Emits a debug information entry.
450  ///
451  void emitDIE(DIE *Die);
452
453  /// computeSizeAndOffset - Compute the size and offset of a DIE.
454  ///
455  unsigned computeSizeAndOffset(DIE *Die, unsigned Offset, bool Last);
456
457  /// computeSizeAndOffsets - Compute the size and offset of all the DIEs.
458  ///
459  void computeSizeAndOffsets();
460
461  /// EmitDebugInfo - Emit the debug info section.
462  ///
463  void emitDebugInfo();
464
465  /// emitAbbreviations - Emit the abbreviation section.
466  ///
467  void emitAbbreviations() const;
468
469  /// emitEndOfLineMatrix - Emit the last address of the section and the end of
470  /// the line matrix.
471  ///
472  void emitEndOfLineMatrix(unsigned SectionEnd);
473
474  /// emitDebugLines - Emit source line information.
475  ///
476  void emitDebugLines();
477
478  /// emitCommonDebugFrame - Emit common frame info into a debug frame section.
479  ///
480  void emitCommonDebugFrame();
481
482  /// emitFunctionDebugFrame - Emit per function frame info into a debug frame
483  /// section.
484  void emitFunctionDebugFrame(const FunctionDebugFrameInfo &DebugFrameInfo);
485
486  /// emitDebugPubNames - Emit visible names into a debug pubnames section.
487  ///
488  void emitDebugPubNames();
489
490  /// emitDebugPubTypes - Emit visible types into a debug pubtypes section.
491  ///
492  void emitDebugPubTypes();
493
494  /// emitDebugStr - Emit visible names into a debug str section.
495  ///
496  void emitDebugStr();
497
498  /// emitDebugLoc - Emit visible names into a debug loc section.
499  ///
500  void emitDebugLoc();
501
502  /// EmitDebugARanges - Emit visible names into a debug aranges section.
503  ///
504  void EmitDebugARanges();
505
506  /// emitDebugRanges - Emit visible names into a debug ranges section.
507  ///
508  void emitDebugRanges();
509
510  /// emitDebugMacInfo - Emit visible names into a debug macinfo section.
511  ///
512  void emitDebugMacInfo();
513
514  /// emitDebugInlineInfo - Emit inline info using following format.
515  /// Section Header:
516  /// 1. length of section
517  /// 2. Dwarf version number
518  /// 3. address size.
519  ///
520  /// Entries (one "entry" for each function that was inlined):
521  ///
522  /// 1. offset into __debug_str section for MIPS linkage name, if exists;
523  ///   otherwise offset into __debug_str for regular function name.
524  /// 2. offset into __debug_str section for regular function name.
525  /// 3. an unsigned LEB128 number indicating the number of distinct inlining
526  /// instances for the function.
527  ///
528  /// The rest of the entry consists of a {die_offset, low_pc}  pair for each
529  /// inlined instance; the die_offset points to the inlined_subroutine die in
530  /// the __debug_info section, and the low_pc is the starting address  for the
531  ///  inlining instance.
532  void emitDebugInlineInfo();
533
534  /// GetOrCreateSourceID - Look up the source id with the given directory and
535  /// source file names. If none currently exists, create a new id and insert it
536  /// in the SourceIds map. This can update DirectoryNames and SourceFileNames
537  /// maps as well.
538  unsigned GetOrCreateSourceID(StringRef DirName, StringRef FileName);
539
540  /// constructCompileUnit - Create new CompileUnit for the given
541  /// metadata node with tag DW_TAG_compile_unit.
542  void constructCompileUnit(const MDNode *N);
543
544  /// getCompielUnit - Get CompileUnit DIE.
545  CompileUnit *getCompileUnit(const MDNode *N) const;
546
547  /// constructGlobalVariableDIE - Construct global variable DIE.
548  void constructGlobalVariableDIE(const MDNode *N);
549
550  /// construct SubprogramDIE - Construct subprogram DIE.
551  void constructSubprogramDIE(const MDNode *N);
552
553  // FIXME: This should go away in favor of complex addresses.
554  /// Find the type the programmer originally declared the variable to be
555  /// and return that type.  Obsolete, use GetComplexAddrType instead.
556  ///
557  DIType getBlockByrefType(DIType Ty, std::string Name);
558
559  /// recordSourceLine - Register a source line with debug info. Returns the
560  /// unique label that was emitted and which provides correspondence to
561  /// the source line list.
562  MCSymbol *recordSourceLine(unsigned Line, unsigned Col, const MDNode *Scope);
563
564  /// getSourceLineCount - Return the number of source lines in the debug
565  /// info.
566  unsigned getSourceLineCount() const {
567    return Lines.size();
568  }
569
570  /// recordVariableFrameIndex - Record a variable's index.
571  void recordVariableFrameIndex(const DbgVariable *V, int Index);
572
573  /// findVariableFrameIndex - Return true if frame index for the variable
574  /// is found. Update FI to hold value of the index.
575  bool findVariableFrameIndex(const DbgVariable *V, int *FI);
576
577  /// findVariableLabel - Find MCSymbol for the variable.
578  const MCSymbol *findVariableLabel(const DbgVariable *V);
579
580  /// findDbgScope - Find DbgScope for the debug loc attached with an
581  /// instruction.
582  DbgScope *findDbgScope(const MachineInstr *MI);
583
584  /// identifyScopeMarkers() - Indentify instructions that are marking
585  /// beginning of or end of a scope.
586  void identifyScopeMarkers();
587
588  /// extractScopeInformation - Scan machine instructions in this function
589  /// and collect DbgScopes. Return true, if atleast one scope was found.
590  bool extractScopeInformation();
591
592  /// collectVariableInfo - Populate DbgScope entries with variables' info.
593  void collectVariableInfo(const MachineFunction *,
594                           SmallPtrSet<const MDNode *, 16> &ProcessedVars);
595
596  /// collectVariableInfoFromMMITable - Collect variable information from
597  /// side table maintained by MMI.
598  void collectVariableInfoFromMMITable(const MachineFunction * MF,
599                                       SmallPtrSet<const MDNode *, 16> &P);
600public:
601  //===--------------------------------------------------------------------===//
602  // Main entry points.
603  //
604  DwarfDebug(AsmPrinter *A, Module *M);
605  ~DwarfDebug();
606
607  /// beginModule - Emit all Dwarf sections that should come prior to the
608  /// content.
609  void beginModule(Module *M);
610
611  /// endModule - Emit all Dwarf sections that should come after the content.
612  ///
613  void endModule();
614
615  /// beginFunction - Gather pre-function debug information.  Assumes being
616  /// emitted immediately after the function entry point.
617  void beginFunction(const MachineFunction *MF);
618
619  /// endFunction - Gather and emit post-function debug information.
620  ///
621  void endFunction(const MachineFunction *MF);
622
623  /// getLabelBeforeInsn - Return Label preceding the instruction.
624  const MCSymbol *getLabelBeforeInsn(const MachineInstr *MI);
625
626  /// getLabelAfterInsn - Return Label immediately following the instruction.
627  const MCSymbol *getLabelAfterInsn(const MachineInstr *MI);
628
629  /// beginScope - Process beginning of a scope.
630  void beginScope(const MachineInstr *MI);
631
632  /// endScope - Prcess end of a scope.
633  void endScope(const MachineInstr *MI);
634};
635} // End of namespace llvm
636
637#endif
638