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