DwarfDebug.h revision b2b31a6f93f5329c86e41c04ec8c33799d012f9e
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  /// ProcessedArgs - Collection of arguments already processed.
235  SmallPtrSet<const MDNode *, 8> ProcessedArgs;
236
237  SmallVector<const MCSymbol *, 8> DebugRangeSymbols;
238
239  /// Previous instruction's location information. This is used to determine
240  /// label location to indicate scope boundries in dwarf debug info.
241  DebugLoc PrevInstLoc;
242  MCSymbol *PrevLabel;
243
244  struct FunctionDebugFrameInfo {
245    unsigned Number;
246    std::vector<MachineMove> Moves;
247
248    FunctionDebugFrameInfo(unsigned Num, const std::vector<MachineMove> &M)
249      : Number(Num), Moves(M) {}
250  };
251
252  std::vector<FunctionDebugFrameInfo> DebugFrames;
253
254  // Section Symbols: these are assembler temporary labels that are emitted at
255  // the beginning of each supported dwarf section.  These are used to form
256  // section offsets and are created by EmitSectionLabels.
257  MCSymbol *DwarfFrameSectionSym, *DwarfInfoSectionSym, *DwarfAbbrevSectionSym;
258  MCSymbol *DwarfStrSectionSym, *TextSectionSym, *DwarfDebugRangeSectionSym;
259  MCSymbol *DwarfDebugLocSectionSym;
260  MCSymbol *FunctionBeginSym, *FunctionEndSym;
261private:
262
263  /// getSourceDirectoryAndFileIds - Return the directory and file ids that
264  /// maps to the source id. Source id starts at 1.
265  std::pair<unsigned, unsigned>
266  getSourceDirectoryAndFileIds(unsigned SId) const {
267    return SourceIds[SId-1];
268  }
269
270  /// getNumSourceDirectories - Return the number of source directories in the
271  /// debug info.
272  unsigned getNumSourceDirectories() const {
273    return DirectoryNames.size();
274  }
275
276  /// getSourceDirectoryName - Return the name of the directory corresponding
277  /// to the id.
278  const std::string &getSourceDirectoryName(unsigned Id) const {
279    return DirectoryNames[Id - 1];
280  }
281
282  /// getSourceFileName - Return the name of the source file corresponding
283  /// to the id.
284  const std::string &getSourceFileName(unsigned Id) const {
285    return SourceFileNames[Id - 1];
286  }
287
288  /// getNumSourceIds - Return the number of unique source ids.
289  unsigned getNumSourceIds() const {
290    return SourceIds.size();
291  }
292
293  /// assignAbbrevNumber - Define a unique number for the abbreviation.
294  ///
295  void assignAbbrevNumber(DIEAbbrev &Abbrev);
296
297  /// createDIEEntry - Creates a new DIEEntry to be a proxy for a debug
298  /// information entry.
299  DIEEntry *createDIEEntry(DIE *Entry);
300
301  /// addUInt - Add an unsigned integer attribute data and value.
302  ///
303  void addUInt(DIE *Die, unsigned Attribute, unsigned Form, uint64_t Integer);
304
305  /// addSInt - Add an signed integer attribute data and value.
306  ///
307  void addSInt(DIE *Die, unsigned Attribute, unsigned Form, int64_t Integer);
308
309  /// addString - Add a string attribute data and value.
310  ///
311  void addString(DIE *Die, unsigned Attribute, unsigned Form,
312                 const StringRef Str);
313
314  /// addLabel - Add a Dwarf label attribute data and value.
315  ///
316  void addLabel(DIE *Die, unsigned Attribute, unsigned Form,
317                const MCSymbol *Label);
318
319  /// addDelta - Add a label delta attribute data and value.
320  ///
321  void addDelta(DIE *Die, unsigned Attribute, unsigned Form,
322                const MCSymbol *Hi, const MCSymbol *Lo);
323
324  /// addDIEEntry - Add a DIE attribute data and value.
325  ///
326  void addDIEEntry(DIE *Die, unsigned Attribute, unsigned Form, DIE *Entry);
327
328  /// addBlock - Add block data.
329  ///
330  void addBlock(DIE *Die, unsigned Attribute, unsigned Form, DIEBlock *Block);
331
332  /// addSourceLine - Add location information to specified debug information
333  /// entry.
334  void addSourceLine(DIE *Die, const DIVariable *V);
335  void addSourceLine(DIE *Die, const DIGlobalVariable *G);
336  void addSourceLine(DIE *Die, const DISubprogram *SP);
337  void addSourceLine(DIE *Die, const DIType *Ty);
338  void addSourceLine(DIE *Die, const DINameSpace *NS);
339
340  /// addAddress - Add an address attribute to a die based on the location
341  /// provided.
342  void addAddress(DIE *Die, unsigned Attribute,
343                  const MachineLocation &Location);
344
345  /// addRegisterAddress - Add register location entry in variable DIE.
346  bool addRegisterAddress(DIE *Die, const MCSymbol *VS, const MachineOperand &MO);
347
348  /// addConstantValue - Add constant value entry in variable DIE.
349  bool addConstantValue(DIE *Die, const MCSymbol *VS, const MachineOperand &MO);
350
351  /// addConstantFPValue - Add constant value entry in variable DIE.
352  bool addConstantFPValue(DIE *Die, const MCSymbol *VS, const MachineOperand &MO);
353
354  /// addComplexAddress - Start with the address based on the location provided,
355  /// and generate the DWARF information necessary to find the actual variable
356  /// (navigating the extra location information encoded in the type) based on
357  /// the starting location.  Add the DWARF information to the die.
358  ///
359  void addComplexAddress(DbgVariable *&DV, DIE *Die, unsigned Attribute,
360                         const MachineLocation &Location);
361
362  // FIXME: Should be reformulated in terms of addComplexAddress.
363  /// addBlockByrefAddress - Start with the address based on the location
364  /// provided, and generate the DWARF information necessary to find the
365  /// actual Block variable (navigating the Block struct) based on the
366  /// starting location.  Add the DWARF information to the die.  Obsolete,
367  /// please use addComplexAddress instead.
368  ///
369  void addBlockByrefAddress(DbgVariable *&DV, DIE *Die, unsigned Attribute,
370                            const MachineLocation &Location);
371
372  /// addToContextOwner - Add Die into the list of its context owner's children.
373  void addToContextOwner(DIE *Die, DIDescriptor Context);
374
375  /// addType - Add a new type attribute to the specified entity.
376  void addType(DIE *Entity, DIType Ty);
377
378
379  /// getOrCreateNameSpace - Create a DIE for DINameSpace.
380  DIE *getOrCreateNameSpace(DINameSpace NS);
381
382  /// getOrCreateTypeDIE - Find existing DIE or create new DIE for the
383  /// given DIType.
384  DIE *getOrCreateTypeDIE(DIType Ty);
385
386  void addPubTypes(DISubprogram SP);
387
388  /// constructTypeDIE - Construct basic type die from DIBasicType.
389  void constructTypeDIE(DIE &Buffer,
390                        DIBasicType BTy);
391
392  /// constructTypeDIE - Construct derived type die from DIDerivedType.
393  void constructTypeDIE(DIE &Buffer,
394                        DIDerivedType DTy);
395
396  /// constructTypeDIE - Construct type DIE from DICompositeType.
397  void constructTypeDIE(DIE &Buffer,
398                        DICompositeType CTy);
399
400  /// constructSubrangeDIE - Construct subrange DIE from DISubrange.
401  void constructSubrangeDIE(DIE &Buffer, DISubrange SR, DIE *IndexTy);
402
403  /// constructArrayTypeDIE - Construct array type DIE from DICompositeType.
404  void constructArrayTypeDIE(DIE &Buffer,
405                             DICompositeType *CTy);
406
407  /// constructEnumTypeDIE - Construct enum type DIE from DIEnumerator.
408  DIE *constructEnumTypeDIE(DIEnumerator ETy);
409
410  /// createGlobalVariableDIE - Create new DIE using GV.
411  DIE *createGlobalVariableDIE(const DIGlobalVariable &GV);
412
413  /// createMemberDIE - Create new member DIE.
414  DIE *createMemberDIE(const DIDerivedType &DT);
415
416  /// createSubprogramDIE - Create new DIE using SP.
417  DIE *createSubprogramDIE(const DISubprogram &SP, bool MakeDecl = false);
418
419  /// getOrCreateDbgScope - Create DbgScope for the scope.
420  DbgScope *getOrCreateDbgScope(const MDNode *Scope, const MDNode *InlinedAt);
421
422  DbgScope *getOrCreateAbstractScope(const MDNode *N);
423
424  /// findAbstractVariable - Find abstract variable associated with Var.
425  DbgVariable *findAbstractVariable(DIVariable &Var, DebugLoc Loc);
426
427  /// updateSubprogramScopeDIE - Find DIE for the given subprogram and
428  /// attach appropriate DW_AT_low_pc and DW_AT_high_pc attributes.
429  /// If there are global variables in this scope then create and insert
430  /// DIEs for these variables.
431  DIE *updateSubprogramScopeDIE(const MDNode *SPNode);
432
433  /// constructLexicalScope - Construct new DW_TAG_lexical_block
434  /// for this scope and attach DW_AT_low_pc/DW_AT_high_pc labels.
435  DIE *constructLexicalScopeDIE(DbgScope *Scope);
436
437  /// constructInlinedScopeDIE - This scope represents inlined body of
438  /// a function. Construct DIE to represent this concrete inlined copy
439  /// of the function.
440  DIE *constructInlinedScopeDIE(DbgScope *Scope);
441
442  /// constructVariableDIE - Construct a DIE for the given DbgVariable.
443  DIE *constructVariableDIE(DbgVariable *DV, DbgScope *S);
444
445  /// constructScopeDIE - Construct a DIE for this scope.
446  DIE *constructScopeDIE(DbgScope *Scope);
447
448  /// EmitSectionLabels - Emit initial Dwarf sections with a label at
449  /// the start of each one.
450  void EmitSectionLabels();
451
452  /// emitDIE - Recusively Emits a debug information entry.
453  ///
454  void emitDIE(DIE *Die);
455
456  /// computeSizeAndOffset - Compute the size and offset of a DIE.
457  ///
458  unsigned computeSizeAndOffset(DIE *Die, unsigned Offset, bool Last);
459
460  /// computeSizeAndOffsets - Compute the size and offset of all the DIEs.
461  ///
462  void computeSizeAndOffsets();
463
464  /// EmitDebugInfo - Emit the debug info section.
465  ///
466  void emitDebugInfo();
467
468  /// emitAbbreviations - Emit the abbreviation section.
469  ///
470  void emitAbbreviations() const;
471
472  /// emitEndOfLineMatrix - Emit the last address of the section and the end of
473  /// the line matrix.
474  ///
475  void emitEndOfLineMatrix(unsigned SectionEnd);
476
477  /// emitDebugLines - Emit source line information.
478  ///
479  void emitDebugLines();
480
481  /// emitCommonDebugFrame - Emit common frame info into a debug frame section.
482  ///
483  void emitCommonDebugFrame();
484
485  /// emitFunctionDebugFrame - Emit per function frame info into a debug frame
486  /// section.
487  void emitFunctionDebugFrame(const FunctionDebugFrameInfo &DebugFrameInfo);
488
489  /// emitDebugPubNames - Emit visible names into a debug pubnames section.
490  ///
491  void emitDebugPubNames();
492
493  /// emitDebugPubTypes - Emit visible types into a debug pubtypes section.
494  ///
495  void emitDebugPubTypes();
496
497  /// emitDebugStr - Emit visible names into a debug str section.
498  ///
499  void emitDebugStr();
500
501  /// emitDebugLoc - Emit visible names into a debug loc section.
502  ///
503  void emitDebugLoc();
504
505  /// EmitDebugARanges - Emit visible names into a debug aranges section.
506  ///
507  void EmitDebugARanges();
508
509  /// emitDebugRanges - Emit visible names into a debug ranges section.
510  ///
511  void emitDebugRanges();
512
513  /// emitDebugMacInfo - Emit visible names into a debug macinfo section.
514  ///
515  void emitDebugMacInfo();
516
517  /// emitDebugInlineInfo - Emit inline info using following format.
518  /// Section Header:
519  /// 1. length of section
520  /// 2. Dwarf version number
521  /// 3. address size.
522  ///
523  /// Entries (one "entry" for each function that was inlined):
524  ///
525  /// 1. offset into __debug_str section for MIPS linkage name, if exists;
526  ///   otherwise offset into __debug_str for regular function name.
527  /// 2. offset into __debug_str section for regular function name.
528  /// 3. an unsigned LEB128 number indicating the number of distinct inlining
529  /// instances for the function.
530  ///
531  /// The rest of the entry consists of a {die_offset, low_pc}  pair for each
532  /// inlined instance; the die_offset points to the inlined_subroutine die in
533  /// the __debug_info section, and the low_pc is the starting address  for the
534  ///  inlining instance.
535  void emitDebugInlineInfo();
536
537  /// GetOrCreateSourceID - Look up the source id with the given directory and
538  /// source file names. If none currently exists, create a new id and insert it
539  /// in the SourceIds map. This can update DirectoryNames and SourceFileNames
540  /// maps as well.
541  unsigned GetOrCreateSourceID(StringRef DirName, StringRef FileName);
542
543  /// constructCompileUnit - Create new CompileUnit for the given
544  /// metadata node with tag DW_TAG_compile_unit.
545  void constructCompileUnit(const MDNode *N);
546
547  /// getCompielUnit - Get CompileUnit DIE.
548  CompileUnit *getCompileUnit(const MDNode *N) const;
549
550  /// constructGlobalVariableDIE - Construct global variable DIE.
551  void constructGlobalVariableDIE(const MDNode *N);
552
553  /// construct SubprogramDIE - Construct subprogram DIE.
554  void constructSubprogramDIE(const MDNode *N);
555
556  // FIXME: This should go away in favor of complex addresses.
557  /// Find the type the programmer originally declared the variable to be
558  /// and return that type.  Obsolete, use GetComplexAddrType instead.
559  ///
560  DIType getBlockByrefType(DIType Ty, std::string Name);
561
562  /// recordSourceLine - Register a source line with debug info. Returns the
563  /// unique label that was emitted and which provides correspondence to
564  /// the source line list.
565  MCSymbol *recordSourceLine(unsigned Line, unsigned Col, const MDNode *Scope);
566
567  /// getSourceLineCount - Return the number of source lines in the debug
568  /// info.
569  unsigned getSourceLineCount() const {
570    return Lines.size();
571  }
572
573  /// recordVariableFrameIndex - Record a variable's index.
574  void recordVariableFrameIndex(const DbgVariable *V, int Index);
575
576  /// findVariableFrameIndex - Return true if frame index for the variable
577  /// is found. Update FI to hold value of the index.
578  bool findVariableFrameIndex(const DbgVariable *V, int *FI);
579
580  /// findVariableLabel - Find MCSymbol for the variable.
581  const MCSymbol *findVariableLabel(const DbgVariable *V);
582
583  /// findDbgScope - Find DbgScope for the debug loc attached with an
584  /// instruction.
585  DbgScope *findDbgScope(const MachineInstr *MI);
586
587  /// identifyScopeMarkers() - Indentify instructions that are marking
588  /// beginning of or end of a scope.
589  void identifyScopeMarkers();
590
591  /// extractScopeInformation - Scan machine instructions in this function
592  /// and collect DbgScopes. Return true, if atleast one scope was found.
593  bool extractScopeInformation();
594
595  /// collectVariableInfo - Populate DbgScope entries with variables' info.
596  void collectVariableInfo(const MachineFunction *);
597
598  /// collectVariableInfoFromMMITable - Collect variable information from
599  /// side table maintained by MMI.
600  void collectVariableInfoFromMMITable(const MachineFunction * MF,
601                                       SmallPtrSet<const MDNode *, 16> &P);
602public:
603  //===--------------------------------------------------------------------===//
604  // Main entry points.
605  //
606  DwarfDebug(AsmPrinter *A, Module *M);
607  ~DwarfDebug();
608
609  /// beginModule - Emit all Dwarf sections that should come prior to the
610  /// content.
611  void beginModule(Module *M);
612
613  /// endModule - Emit all Dwarf sections that should come after the content.
614  ///
615  void endModule();
616
617  /// beginFunction - Gather pre-function debug information.  Assumes being
618  /// emitted immediately after the function entry point.
619  void beginFunction(const MachineFunction *MF);
620
621  /// endFunction - Gather and emit post-function debug information.
622  ///
623  void endFunction(const MachineFunction *MF);
624
625  /// getLabelBeforeInsn - Return Label preceding the instruction.
626  const MCSymbol *getLabelBeforeInsn(const MachineInstr *MI);
627
628  /// getLabelAfterInsn - Return Label immediately following the instruction.
629  const MCSymbol *getLabelAfterInsn(const MachineInstr *MI);
630
631  /// beginScope - Process beginning of a scope.
632  void beginScope(const MachineInstr *MI);
633
634  /// endScope - Prcess end of a scope.
635  void endScope(const MachineInstr *MI);
636};
637} // End of namespace llvm
638
639#endif
640