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