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