lib/CodeGen/AsmPrinter/DwarfDebug.h

   1 //===-- llvm/CodeGen/DwarfDebug.h - Dwarf Debug Framework ------*- C++ -*--===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file is distributed under the University of Illinois Open Source
   6 // License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9 //
  10 // This file contains support for writing dwarf debug info into asm files.
  11 //
  12 //===----------------------------------------------------------------------===//
  13
  14 #ifndef CODEGEN_ASMPRINTER_DWARFDEBUG_H__
  15 #define CODEGEN_ASMPRINTER_DWARFDEBUG_H__
  16
  17 #include "DIE.h"
  18 #include "DwarfPrinter.h"
  19 #include "llvm/CodeGen/AsmPrinter.h"
  20 #include "llvm/CodeGen/MachineLocation.h"
  21 #include "llvm/Analysis/DebugInfo.h"
  22 #include "llvm/Support/raw_ostream.h"
  23 #include "llvm/ADT/DenseMap.h"
  24 #include "llvm/ADT/FoldingSet.h"
  25 #include "llvm/ADT/SmallSet.h"
  26 #include "llvm/ADT/StringMap.h"
  27 #include "llvm/ADT/UniqueVector.h"
  28 #include <string>
  29
  30 namespace llvm {
  31
  32 class CompileUnit;
  33 class DbgConcreteScope;
  34 class DbgScope;
  35 class DbgVariable;
  36 class MachineFrameInfo;
  37 class MachineModuleInfo;
  38 class MCAsmInfo;
  39 class Timer;
  40
  41 //===----------------------------------------------------------------------===//
  42 /// SrcLineInfo - This class is used to record source line correspondence.
  43 ///
  44 class SrcLineInfo {
  45   unsigned Line;                     // Source line number.
  46   unsigned Column;                   // Source column.
  47   unsigned SourceID;                 // Source ID number.
  48   MCSymbol *Label;                   // Label in code ID number.
  49 public:
  50   SrcLineInfo(unsigned L, unsigned C, unsigned S, MCSymbol *label)
  51     : Line(L), Column(C), SourceID(S), Label(label) {}
  52
  53   // Accessors
  54   unsigned getLine() const { return Line; }
  55   unsigned getColumn() const { return Column; }
  56   unsigned getSourceID() const { return SourceID; }
  57   MCSymbol *getLabel() const { return Label; }
  58 };
  59
  60 class DwarfDebug : public DwarfPrinter {
  61   //===--------------------------------------------------------------------===//
  62   // Attributes used to construct specific Dwarf sections.
  63   //
  64
  65   /// ModuleCU - All DIEs are inserted in ModuleCU.
  66   CompileUnit *ModuleCU;
  67
  68   /// AbbreviationsSet - Used to uniquely define abbreviations.
  69   ///
  70   FoldingSet<DIEAbbrev> AbbreviationsSet;
  71
  72   /// Abbreviations - A list of all the unique abbreviations in use.
  73   ///
  74   std::vector<DIEAbbrev *> Abbreviations;
  75
  76   /// DirectoryIdMap - Directory name to directory id map.
  77   ///
  78   StringMap<unsigned> DirectoryIdMap;
  79
  80   /// DirectoryNames - A list of directory names.
  81   SmallVector<std::string, 8> DirectoryNames;
  82
  83   /// SourceFileIdMap - Source file name to source file id map.
  84   ///
  85   StringMap<unsigned> SourceFileIdMap;
  86
  87   /// SourceFileNames - A list of source file names.
  88   SmallVector<std::string, 8> SourceFileNames;
  89
  90   /// SourceIdMap - Source id map, i.e. pair of directory id and source file
  91   /// id mapped to a unique id.
  92   DenseMap<std::pair<unsigned, unsigned>, unsigned> SourceIdMap;
  93
  94   /// SourceIds - Reverse map from source id to directory id + file id pair.
  95   ///
  96   SmallVector<std::pair<unsigned, unsigned>, 8> SourceIds;
  97
  98   /// Lines - List of source line correspondence.
  99   std::vector<SrcLineInfo> Lines;
 100
 101   /// DIEValues - A list of all the unique values in use.
 102   ///
 103   std::vector<DIEValue *> DIEValues;
 104
 105   /// StringPool - A String->Symbol mapping of strings used by indirect
 106   /// references.
 107   StringMap<std::pair<MCSymbol*, unsigned> > StringPool;
 108   unsigned NextStringPoolNumber;
 109
 110   MCSymbol *getStringPoolEntry(StringRef Str);
 111
 112   /// SectionMap - Provides a unique id per text section.
 113   ///
 114   UniqueVector<const MCSection*> SectionMap;
 115
 116   /// SectionSourceLines - Tracks line numbers per text section.
 117   ///
 118   std::vector<std::vector<SrcLineInfo> > SectionSourceLines;
 119
 120   /// didInitial - Flag to indicate if initial emission has been done.
 121   ///
 122   bool didInitial;
 123
 124   /// shouldEmit - Flag to indicate if debug information should be emitted.
 125   ///
 126   bool shouldEmit;
 127
 128   // CurrentFnDbgScope - Top level scope for the current function.
 129   //
 130   DbgScope *CurrentFnDbgScope;
 131
 132   /// DbgScopeMap - Tracks the scopes in the current function.  Owns the
 133   /// contained DbgScope*s.
 134   ///
 135   DenseMap<MDNode *, DbgScope *> DbgScopeMap;
 136
 137   /// ConcreteScopes - Tracks the concrete scopees in the current function.
 138   /// These scopes are also included in DbgScopeMap.
 139   DenseMap<MDNode *, DbgScope *> ConcreteScopes;
 140
 141   /// AbstractScopes - Tracks the abstract scopes a module. These scopes are
 142   /// not included DbgScopeMap.  AbstractScopes owns its DbgScope*s.
 143   DenseMap<MDNode *, DbgScope *> AbstractScopes;
 144
 145   /// AbstractScopesList - Tracks abstract scopes constructed while processing
 146   /// a function. This list is cleared during endFunction().
 147   SmallVector<DbgScope *, 4>AbstractScopesList;
 148
 149   /// AbstractVariables - Collection on abstract variables.  Owned by the
 150   /// DbgScopes in AbstractScopes.
 151   DenseMap<MDNode *, DbgVariable *> AbstractVariables;
 152
 153   /// InliendSubprogramDIEs - Collection of subprgram DIEs that are marked
 154   /// (at the end of the module) as DW_AT_inline.
 155   SmallPtrSet<DIE *, 4> InlinedSubprogramDIEs;
 156
 157   DenseMap<DIE *, MDNode *> ContainingTypeMap;
 158
 159   /// AbstractSubprogramDIEs - Collection of abstruct subprogram DIEs.
 160   SmallPtrSet<DIE *, 4> AbstractSubprogramDIEs;
 161
 162   /// TopLevelDIEs - Collection of top level DIEs.
 163   SmallPtrSet<DIE *, 4> TopLevelDIEs;
 164   SmallVector<DIE *, 4> TopLevelDIEsVector;
 165
 166   typedef SmallVector<DbgScope *, 2> ScopeVector;
 167   typedef DenseMap<const MachineInstr *, ScopeVector>
 168     InsnToDbgScopeMapTy;
 169
 170   /// DbgScopeBeginMap - Maps instruction with a list of DbgScopes it starts.
 171   InsnToDbgScopeMapTy DbgScopeBeginMap;
 172
 173   /// DbgScopeEndMap - Maps instruction with a list DbgScopes it ends.
 174   InsnToDbgScopeMapTy DbgScopeEndMap;
 175
 176   /// InlineInfo - Keep track of inlined functions and their location.  This
 177   /// information is used to populate debug_inlined section.
 178   typedef std::pair<MCSymbol*, DIE *> InlineInfoLabels;
 179   DenseMap<MDNode*, SmallVector<InlineInfoLabels, 4> > InlineInfo;
 180   SmallVector<MDNode *, 4> InlinedSPNodes;
 181
 182   /// CompileUnitOffsets - A vector of the offsets of the compile units. This is
 183   /// used when calculating the "origin" of a concrete instance of an inlined
 184   /// function.
 185   DenseMap<CompileUnit *, unsigned> CompileUnitOffsets;
 186
 187   /// DebugTimer - Timer for the Dwarf debug writer.
 188   Timer *DebugTimer;
 189
 190   struct FunctionDebugFrameInfo {
 191     unsigned Number;
 192     std::vector<MachineMove> Moves;
 193
 194     FunctionDebugFrameInfo(unsigned Num, const std::vector<MachineMove> &M)
 195       : Number(Num), Moves(M) {}
 196   };
 197
 198   std::vector<FunctionDebugFrameInfo> DebugFrames;
 199
 200   /// getSourceDirectoryAndFileIds - Return the directory and file ids that
 201   /// maps to the source id. Source id starts at 1.
 202   std::pair<unsigned, unsigned>
 203   getSourceDirectoryAndFileIds(unsigned SId) const {
 204     return SourceIds[SId-1];
 205   }
 206
 207   /// getNumSourceDirectories - Return the number of source directories in the
 208   /// debug info.
 209   unsigned getNumSourceDirectories() const {
 210     return DirectoryNames.size();
 211   }
 212
 213   /// getSourceDirectoryName - Return the name of the directory corresponding
 214   /// to the id.
 215   const std::string &getSourceDirectoryName(unsigned Id) const {
 216     return DirectoryNames[Id - 1];
 217   }
 218
 219   /// getSourceFileName - Return the name of the source file corresponding
 220   /// to the id.
 221   const std::string &getSourceFileName(unsigned Id) const {
 222     return SourceFileNames[Id - 1];
 223   }
 224
 225   /// getNumSourceIds - Return the number of unique source ids.
 226   unsigned getNumSourceIds() const {
 227     return SourceIds.size();
 228   }
 229
 230   /// assignAbbrevNumber - Define a unique number for the abbreviation.
 231   ///
 232   void assignAbbrevNumber(DIEAbbrev &Abbrev);
 233
 234   /// createDIEEntry - Creates a new DIEEntry to be a proxy for a debug
 235   /// information entry.
 236   DIEEntry *createDIEEntry(DIE *Entry);
 237
 238   /// addUInt - Add an unsigned integer attribute data and value.
 239   ///
 240   void addUInt(DIE *Die, unsigned Attribute, unsigned Form, uint64_t Integer);
 241
 242   /// addSInt - Add an signed integer attribute data and value.
 243   ///
 244   void addSInt(DIE *Die, unsigned Attribute, unsigned Form, int64_t Integer);
 245
 246   /// addString - Add a string attribute data and value.
 247   ///
 248   void addString(DIE *Die, unsigned Attribute, unsigned Form,
 249                  const StringRef Str);
 250
 251   /// addLabel - Add a Dwarf label attribute data and value.
 252   ///
 253   void addLabel(DIE *Die, unsigned Attribute, unsigned Form,
 254                 const MCSymbol *Label);
 255
 256   /// addDelta - Add a label delta attribute data and value.
 257   ///
 258   void addDelta(DIE *Die, unsigned Attribute, unsigned Form,
 259                 const MCSymbol *Hi, const MCSymbol *Lo);
 260
 261   /// addDIEEntry - Add a DIE attribute data and value.
 262   ///
 263   void addDIEEntry(DIE *Die, unsigned Attribute, unsigned Form, DIE *Entry) {
 264     Die->addValue(Attribute, Form, createDIEEntry(Entry));
 265   }
 266
 267   /// addBlock - Add block data.
 268   ///
 269   void addBlock(DIE *Die, unsigned Attribute, unsigned Form, DIEBlock *Block);
 270
 271   /// addSourceLine - Add location information to specified debug information
 272   /// entry.
 273   void addSourceLine(DIE *Die, const DIVariable *V);
 274   void addSourceLine(DIE *Die, const DIGlobal *G);
 275   void addSourceLine(DIE *Die, const DISubprogram *SP);
 276   void addSourceLine(DIE *Die, const DIType *Ty);
 277   void addSourceLine(DIE *Die, const DINameSpace *NS);
 278
 279   /// addAddress - Add an address attribute to a die based on the location
 280   /// provided.
 281   void addAddress(DIE *Die, unsigned Attribute,
 282                   const MachineLocation &Location);
 283
 284   /// addComplexAddress - Start with the address based on the location provided,
 285   /// and generate the DWARF information necessary to find the actual variable
 286   /// (navigating the extra location information encoded in the type) based on
 287   /// the starting location.  Add the DWARF information to the die.
 288   ///
 289   void addComplexAddress(DbgVariable *&DV, DIE *Die, unsigned Attribute,
 290                          const MachineLocation &Location);
 291
 292   // FIXME: Should be reformulated in terms of addComplexAddress.
 293   /// addBlockByrefAddress - Start with the address based on the location
 294   /// provided, and generate the DWARF information necessary to find the
 295   /// actual Block variable (navigating the Block struct) based on the
 296   /// starting location.  Add the DWARF information to the die.  Obsolete,
 297   /// please use addComplexAddress instead.
 298   ///
 299   void addBlockByrefAddress(DbgVariable *&DV, DIE *Die, unsigned Attribute,
 300                             const MachineLocation &Location);
 301
 302   /// addToContextOwner - Add Die into the list of its context owner's children.
 303   void addToContextOwner(DIE *Die, DIDescriptor Context);
 304
 305   /// addType - Add a new type attribute to the specified entity.
 306   void addType(DIE *Entity, DIType Ty);
 307
 308
 309   /// getOrCreateNameSpace - Create a DIE for DINameSpace.
 310   DIE *getOrCreateNameSpace(DINameSpace NS);
 311
 312   /// getOrCreateTypeDIE - Find existing DIE or create new DIE for the
 313   /// given DIType.
 314   DIE *getOrCreateTypeDIE(DIType Ty);
 315
 316   void addPubTypes(DISubprogram SP);
 317
 318   /// constructTypeDIE - Construct basic type die from DIBasicType.
 319   void constructTypeDIE(DIE &Buffer,
 320                         DIBasicType BTy);
 321
 322   /// constructTypeDIE - Construct derived type die from DIDerivedType.
 323   void constructTypeDIE(DIE &Buffer,
 324                         DIDerivedType DTy);
 325
 326   /// constructTypeDIE - Construct type DIE from DICompositeType.
 327   void constructTypeDIE(DIE &Buffer,
 328                         DICompositeType CTy);
 329
 330   /// constructSubrangeDIE - Construct subrange DIE from DISubrange.
 331   void constructSubrangeDIE(DIE &Buffer, DISubrange SR, DIE *IndexTy);
 332
 333   /// constructArrayTypeDIE - Construct array type DIE from DICompositeType.
 334   void constructArrayTypeDIE(DIE &Buffer,
 335                              DICompositeType *CTy);
 336
 337   /// constructEnumTypeDIE - Construct enum type DIE from DIEnumerator.
 338   DIE *constructEnumTypeDIE(DIEnumerator ETy);
 339
 340   /// createGlobalVariableDIE - Create new DIE using GV.
 341   DIE *createGlobalVariableDIE(const DIGlobalVariable &GV);
 342
 343   /// createMemberDIE - Create new member DIE.
 344   DIE *createMemberDIE(const DIDerivedType &DT);
 345
 346   /// createSubprogramDIE - Create new DIE using SP.
 347   DIE *createSubprogramDIE(const DISubprogram &SP, bool MakeDecl = false);
 348
 349   /// getUpdatedDbgScope - Find or create DbgScope assicated with
 350   /// the instruction. Initialize scope and update scope hierarchy.
 351   DbgScope *getUpdatedDbgScope(MDNode *N, const MachineInstr *MI, MDNode *InlinedAt);
 352
 353   /// createDbgScope - Create DbgScope for the scope.
 354   void createDbgScope(MDNode *Scope, MDNode *InlinedAt);
 355
 356   DbgScope *getOrCreateAbstractScope(MDNode *N);
 357
 358   /// findAbstractVariable - Find abstract variable associated with Var.
 359   DbgVariable *findAbstractVariable(DIVariable &Var, unsigned FrameIdx,
 360                                     DILocation &Loc);
 361   DbgVariable *findAbstractVariable(DIVariable &Var, const MachineInstr *MI,
 362                                     DILocation &Loc);
 363
 364   /// updateSubprogramScopeDIE - Find DIE for the given subprogram and
 365   /// attach appropriate DW_AT_low_pc and DW_AT_high_pc attributes.
 366   /// If there are global variables in this scope then create and insert
 367   /// DIEs for these variables.
 368   DIE *updateSubprogramScopeDIE(MDNode *SPNode);
 369
 370   /// constructLexicalScope - Construct new DW_TAG_lexical_block
 371   /// for this scope and attach DW_AT_low_pc/DW_AT_high_pc labels.
 372   DIE *constructLexicalScopeDIE(DbgScope *Scope);
 373
 374   /// constructInlinedScopeDIE - This scope represents inlined body of
 375   /// a function. Construct DIE to represent this concrete inlined copy
 376   /// of the function.
 377   DIE *constructInlinedScopeDIE(DbgScope *Scope);
 378
 379   /// constructVariableDIE - Construct a DIE for the given DbgVariable.
 380   DIE *constructVariableDIE(DbgVariable *DV, DbgScope *S);
 381
 382   /// constructScopeDIE - Construct a DIE for this scope.
 383   DIE *constructScopeDIE(DbgScope *Scope);
 384
 385   /// emitInitial - Emit initial Dwarf declarations.  This is necessary for cc
 386   /// tools to recognize the object file contains Dwarf information.
 387   void emitInitial();
 388
 389   /// emitDIE - Recusively Emits a debug information entry.
 390   ///
 391   void emitDIE(DIE *Die);
 392
 393   /// computeSizeAndOffset - Compute the size and offset of a DIE.
 394   ///
 395   unsigned computeSizeAndOffset(DIE *Die, unsigned Offset, bool Last);
 396
 397   /// computeSizeAndOffsets - Compute the size and offset of all the DIEs.
 398   ///
 399   void computeSizeAndOffsets();
 400
 401   /// EmitDebugInfo - Emit the debug info section.
 402   ///
 403   void emitDebugInfo();
 404
 405   /// emitAbbreviations - Emit the abbreviation section.
 406   ///
 407   void emitAbbreviations() const;
 408
 409   /// emitEndOfLineMatrix - Emit the last address of the section and the end of
 410   /// the line matrix.
 411   ///
 412   void emitEndOfLineMatrix(unsigned SectionEnd);
 413
 414   /// emitDebugLines - Emit source line information.
 415   ///
 416   void emitDebugLines();
 417
 418   /// emitCommonDebugFrame - Emit common frame info into a debug frame section.
 419   ///
 420   void emitCommonDebugFrame();
 421
 422   /// emitFunctionDebugFrame - Emit per function frame info into a debug frame
 423   /// section.
 424   void emitFunctionDebugFrame(const FunctionDebugFrameInfo &DebugFrameInfo);
 425
 426   /// emitDebugPubNames - Emit visible names into a debug pubnames section.
 427   ///
 428   void emitDebugPubNames();
 429
 430   /// emitDebugPubTypes - Emit visible types into a debug pubtypes section.
 431   ///
 432   void emitDebugPubTypes();
 433
 434   /// emitDebugStr - Emit visible names into a debug str section.
 435   ///
 436   void emitDebugStr();
 437
 438   /// emitDebugLoc - Emit visible names into a debug loc section.
 439   ///
 440   void emitDebugLoc();
 441
 442   /// EmitDebugARanges - Emit visible names into a debug aranges section.
 443   ///
 444   void EmitDebugARanges();
 445
 446   /// emitDebugRanges - Emit visible names into a debug ranges section.
 447   ///
 448   void emitDebugRanges();
 449
 450   /// emitDebugMacInfo - Emit visible names into a debug macinfo section.
 451   ///
 452   void emitDebugMacInfo();
 453
 454   /// emitDebugInlineInfo - Emit inline info using following format.
 455   /// Section Header:
 456   /// 1. length of section
 457   /// 2. Dwarf version number
 458   /// 3. address size.
 459   ///
 460   /// Entries (one "entry" for each function that was inlined):
 461   ///
 462   /// 1. offset into __debug_str section for MIPS linkage name, if exists;
 463   ///   otherwise offset into __debug_str for regular function name.
 464   /// 2. offset into __debug_str section for regular function name.
 465   /// 3. an unsigned LEB128 number indicating the number of distinct inlining
 466   /// instances for the function.
 467   ///
 468   /// The rest of the entry consists of a {die_offset, low_pc}  pair for each
 469   /// inlined instance; the die_offset points to the inlined_subroutine die in
 470   /// the __debug_info section, and the low_pc is the starting address  for the
 471   ///  inlining instance.
 472   void emitDebugInlineInfo();
 473
 474   /// GetOrCreateSourceID - Look up the source id with the given directory and
 475   /// source file names. If none currently exists, create a new id and insert it
 476   /// in the SourceIds map. This can update DirectoryNames and SourceFileNames maps
 477   /// as well.
 478   unsigned GetOrCreateSourceID(StringRef DirName, StringRef FileName);
 479
 480   void constructCompileUnit(MDNode *N);
 481
 482   void constructGlobalVariableDIE(MDNode *N);
 483
 484   void constructSubprogramDIE(MDNode *N);
 485
 486   // FIXME: This should go away in favor of complex addresses.
 487   /// Find the type the programmer originally declared the variable to be
 488   /// and return that type.  Obsolete, use GetComplexAddrType instead.
 489   ///
 490   DIType getBlockByrefType(DIType Ty, std::string Name);
 491
 492 public:
 493   //===--------------------------------------------------------------------===//
 494   // Main entry points.
 495   //
 496   DwarfDebug(raw_ostream &OS, AsmPrinter *A, const MCAsmInfo *T);
 497   virtual ~DwarfDebug();
 498
 499   /// ShouldEmitDwarfDebug - Returns true if Dwarf debugging declarations should
 500   /// be emitted.
 501   bool ShouldEmitDwarfDebug() const { return shouldEmit; }
 502
 503   /// beginModule - Emit all Dwarf sections that should come prior to the
 504   /// content.
 505   void beginModule(Module *M, MachineModuleInfo *MMI);
 506
 507   /// endModule - Emit all Dwarf sections that should come after the content.
 508   ///
 509   void endModule();
 510
 511   /// beginFunction - Gather pre-function debug information.  Assumes being
 512   /// emitted immediately after the function entry point.
 513   void beginFunction(const MachineFunction *MF);
 514
 515   /// endFunction - Gather and emit post-function debug information.
 516   ///
 517   void endFunction(const MachineFunction *MF);
 518
 519   /// recordSourceLine - Register a source line with debug info. Returns the
 520   /// unique label that was emitted and which provides correspondence to
 521   /// the source line list.
 522   MCSymbol *recordSourceLine(unsigned Line, unsigned Col, MDNode *Scope);
 523
 524   /// getSourceLineCount - Return the number of source lines in the debug
 525   /// info.
 526   unsigned getSourceLineCount() const {
 527     return Lines.size();
 528   }
 529
 530   /// getOrCreateSourceID - Public version of GetOrCreateSourceID. This can be
 531   /// timed. Look up the source id with the given directory and source file
 532   /// names. If none currently exists, create a new id and insert it in the
 533   /// SourceIds map. This can update DirectoryNames and SourceFileNames maps as
 534   /// well.
 535   unsigned getOrCreateSourceID(const std::string &DirName,
 536                                const std::string &FileName);
 537
 538   /// extractScopeInformation - Scan machine instructions in this function
 539   /// and collect DbgScopes. Return true, if atleast one scope was found.
 540   bool extractScopeInformation();
 541
 542   /// collectVariableInfo - Populate DbgScope entries with variables' info.
 543   void collectVariableInfo();
 544
 545   /// beginScope - Process beginning of a scope starting at Label.
 546   void beginScope(const MachineInstr *MI, MCSymbol *Label);
 547
 548   /// endScope - Prcess end of a scope.
 549   void endScope(const MachineInstr *MI);
 550 };
 551 } // End of namespace llvm
 552
 553 #endif