lib/CodeGen/AsmPrinter/DwarfCompileUnit.h

   1 //===-- llvm/CodeGen/DwarfCompileUnit.h - Dwarf Compile Unit ---*- 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 compile unit.
  11 //
  12 //===----------------------------------------------------------------------===//
  13
  14 #ifndef CODEGEN_ASMPRINTER_DWARFCOMPILEUNIT_H
  15 #define CODEGEN_ASMPRINTER_DWARFCOMPILEUNIT_H
  16
  17 #include "DIE.h"
  18 #include "DwarfDebug.h"
  19 #include "llvm/ADT/DenseMap.h"
  20 #include "llvm/ADT/Optional.h"
  21 #include "llvm/ADT/OwningPtr.h"
  22 #include "llvm/ADT/StringMap.h"
  23 #include "llvm/DebugInfo.h"
  24 #include "llvm/MC/MCExpr.h"
  25
  26 namespace llvm {
  27
  28 class MachineLocation;
  29 class MachineOperand;
  30 class ConstantInt;
  31 class ConstantFP;
  32 class DbgVariable;
  33
  34 //===----------------------------------------------------------------------===//
  35 /// CompileUnit - This dwarf writer support class manages information associated
  36 /// with a source file.
  37 class CompileUnit {
  38   /// UniqueID - a numeric ID unique among all CUs in the module
  39   ///
  40   unsigned UniqueID;
  41
  42   /// Node - MDNode for the compile unit.
  43   DICompileUnit Node;
  44
  45   /// Language - Language for the translation unit associated with this CU.
  46   uint16_t Language;
  47
  48   /// CUDie - Compile unit debug information entry.
  49   ///
  50   const OwningPtr<DIE> CUDie;
  51
  52   /// Asm - Target of Dwarf emission.
  53   AsmPrinter *Asm;
  54
  55   // Holders for some common dwarf information.
  56   DwarfDebug *DD;
  57   DwarfUnits *DU;
  58
  59   /// IndexTyDie - An anonymous type for index type.  Owned by CUDie.
  60   DIE *IndexTyDie;
  61
  62   /// MDNodeToDieMap - Tracks the mapping of unit level debug information
  63   /// variables to debug information entries.
  64   DenseMap<const MDNode *, DIE *> MDNodeToDieMap;
  65
  66   /// MDNodeToDIEEntryMap - Tracks the mapping of unit level debug information
  67   /// descriptors to debug information entries using a DIEEntry proxy.
  68   DenseMap<const MDNode *, DIEEntry *> MDNodeToDIEEntryMap;
  69
  70   /// GlobalNames - A map of globally visible named entities for this unit.
  71   ///
  72   StringMap<const DIE *> GlobalNames;
  73
  74   /// GlobalTypes - A map of globally visible types for this unit.
  75   ///
  76   StringMap<const DIE *> GlobalTypes;
  77
  78   /// AccelNames - A map of names for the name accelerator table.
  79   ///
  80   StringMap<std::vector<const DIE *> > AccelNames;
  81   StringMap<std::vector<const DIE *> > AccelObjC;
  82   StringMap<std::vector<const DIE *> > AccelNamespace;
  83   StringMap<std::vector<std::pair<const DIE *, unsigned> > > AccelTypes;
  84
  85   /// DIEBlocks - A list of all the DIEBlocks in use.
  86   std::vector<DIEBlock *> DIEBlocks;
  87
  88   /// ContainingTypeMap - This map is used to keep track of subprogram DIEs that
  89   /// need DW_AT_containing_type attribute. This attribute points to a DIE that
  90   /// corresponds to the MDNode mapped with the subprogram DIE.
  91   DenseMap<DIE *, const MDNode *> ContainingTypeMap;
  92
  93   // DIEValueAllocator - All DIEValues are allocated through this allocator.
  94   BumpPtrAllocator DIEValueAllocator;
  95
  96   // DIEIntegerOne - A preallocated DIEValue because 1 is used frequently.
  97   DIEInteger *DIEIntegerOne;
  98
  99 public:
 100   CompileUnit(unsigned UID, DIE *D, DICompileUnit CU, AsmPrinter *A,
 101               DwarfDebug *DW, DwarfUnits *DWU);
 102   CompileUnit(unsigned UID, DIE *D, uint16_t Language, AsmPrinter *A,
 103               DwarfDebug *DW, DwarfUnits *DWU);
 104   ~CompileUnit();
 105
 106   // Accessors.
 107   unsigned getUniqueID() const { return UniqueID; }
 108   uint16_t getLanguage() const { return Language; }
 109   DICompileUnit getNode() const { return Node; }
 110   DIE *getCUDie() const { return CUDie.get(); }
 111   const StringMap<const DIE *> &getGlobalNames() const { return GlobalNames; }
 112   const StringMap<const DIE *> &getGlobalTypes() const { return GlobalTypes; }
 113
 114   const StringMap<std::vector<const DIE *> > &getAccelNames() const {
 115     return AccelNames;
 116   }
 117   const StringMap<std::vector<const DIE *> > &getAccelObjC() const {
 118     return AccelObjC;
 119   }
 120   const StringMap<std::vector<const DIE *> > &getAccelNamespace() const {
 121     return AccelNamespace;
 122   }
 123   const StringMap<std::vector<std::pair<const DIE *, unsigned> > > &
 124   getAccelTypes() const {
 125     return AccelTypes;
 126   }
 127
 128   unsigned getDebugInfoOffset() const { return DebugInfoOffset; }
 129   void setDebugInfoOffset(unsigned DbgInfoOff) { DebugInfoOffset = DbgInfoOff; }
 130
 131   /// hasContent - Return true if this compile unit has something to write out.
 132   ///
 133   bool hasContent() const { return !CUDie->getChildren().empty(); }
 134
 135   /// getParentContextString - Get a string containing the language specific
 136   /// context for a global name.
 137   std::string getParentContextString(DIScope Context) const;
 138
 139   /// addGlobalName - Add a new global entity to the compile unit.
 140   ///
 141   void addGlobalName(StringRef Name, DIE *Die, DIScope Context);
 142
 143   /// addGlobalType - Add a new global type to the compile unit.
 144   ///
 145   void addGlobalType(DIType Ty);
 146
 147   /// addPubTypes - Add a set of types from the subprogram to the global types.
 148   void addPubTypes(DISubprogram SP);
 149
 150   /// addAccelName - Add a new name to the name accelerator table.
 151   void addAccelName(StringRef Name, const DIE *Die);
 152
 153   /// addAccelObjC - Add a new name to the ObjC accelerator table.
 154   void addAccelObjC(StringRef Name, const DIE *Die);
 155
 156   /// addAccelNamespace - Add a new name to the namespace accelerator table.
 157   void addAccelNamespace(StringRef Name, const DIE *Die);
 158
 159   /// addAccelType - Add a new type to the type accelerator table.
 160   void addAccelType(StringRef Name, std::pair<const DIE *, unsigned> Die);
 161
 162   /// getDIE - Returns the debug information entry map slot for the
 163   /// specified debug variable. We delegate the request to DwarfDebug
 164   /// when the MDNode can be part of the type system, since DIEs for
 165   /// the type system can be shared across CUs and the mappings are
 166   /// kept in DwarfDebug.
 167   DIE *getDIE(DIDescriptor D) const;
 168
 169   DIEBlock *getDIEBlock() { return new (DIEValueAllocator) DIEBlock(); }
 170
 171   /// insertDIE - Insert DIE into the map. We delegate the request to DwarfDebug
 172   /// when the MDNode can be part of the type system, since DIEs for
 173   /// the type system can be shared across CUs and the mappings are
 174   /// kept in DwarfDebug.
 175   void insertDIE(DIDescriptor Desc, DIE *D);
 176
 177   /// addDie - Adds or interns the DIE to the compile unit.
 178   ///
 179   void addDie(DIE *Buffer) { CUDie->addChild(Buffer); }
 180
 181   /// addFlag - Add a flag that is true to the DIE.
 182   void addFlag(DIE *Die, dwarf::Attribute Attribute);
 183
 184   /// addUInt - Add an unsigned integer attribute data and value.
 185   ///
 186   void addUInt(DIE *Die, dwarf::Attribute Attribute, Optional<dwarf::Form> Form,
 187                uint64_t Integer);
 188
 189   void addUInt(DIEBlock *Block, dwarf::Form Form, uint64_t Integer);
 190
 191   /// addSInt - Add an signed integer attribute data and value.
 192   ///
 193   void addSInt(DIE *Die, dwarf::Attribute Attribute, Optional<dwarf::Form> Form,
 194                int64_t Integer);
 195
 196   void addSInt(DIEBlock *Die, Optional<dwarf::Form> Form, int64_t Integer);
 197
 198   /// addString - Add a string attribute data and value.
 199   ///
 200   void addString(DIE *Die, dwarf::Attribute Attribute, const StringRef Str);
 201
 202   /// addLocalString - Add a string attribute data and value.
 203   ///
 204   void addLocalString(DIE *Die, dwarf::Attribute Attribute,
 205                       const StringRef Str);
 206
 207   /// addExpr - Add a Dwarf expression attribute data and value.
 208   ///
 209   void addExpr(DIEBlock *Die, dwarf::Form Form, const MCExpr *Expr);
 210
 211   /// addLabel - Add a Dwarf label attribute data and value.
 212   ///
 213   void addLabel(DIE *Die, dwarf::Attribute Attribute, dwarf::Form Form,
 214                 const MCSymbol *Label);
 215
 216   void addLabel(DIEBlock *Die, dwarf::Form Form, const MCSymbol *Label);
 217
 218   /// addLabelAddress - Add a dwarf label attribute data and value using
 219   /// either DW_FORM_addr or DW_FORM_GNU_addr_index.
 220   ///
 221   void addLabelAddress(DIE *Die, dwarf::Attribute Attribute, MCSymbol *Label);
 222
 223   /// addOpAddress - Add a dwarf op address data and value using the
 224   /// form given and an op of either DW_FORM_addr or DW_FORM_GNU_addr_index.
 225   ///
 226   void addOpAddress(DIEBlock *Die, const MCSymbol *Label);
 227
 228   /// addDelta - Add a label delta attribute data and value.
 229   ///
 230   void addDelta(DIE *Die, dwarf::Attribute Attribute, dwarf::Form Form,
 231                 const MCSymbol *Hi, const MCSymbol *Lo);
 232
 233   /// addDIEEntry - Add a DIE attribute data and value.
 234   ///
 235   void addDIEEntry(DIE *Die, dwarf::Attribute Attribute, DIE *Entry);
 236
 237   /// addDIEEntry - Add a DIE attribute data and value.
 238   ///
 239   void addDIEEntry(DIE *Die, dwarf::Attribute Attribute, DIEEntry *Entry);
 240
 241   /// addBlock - Add block data.
 242   ///
 243   void addBlock(DIE *Die, dwarf::Attribute Attribute, DIEBlock *Block);
 244
 245   /// addSourceLine - Add location information to specified debug information
 246   /// entry.
 247   void addSourceLine(DIE *Die, DIVariable V);
 248   void addSourceLine(DIE *Die, DIGlobalVariable G);
 249   void addSourceLine(DIE *Die, DISubprogram SP);
 250   void addSourceLine(DIE *Die, DIType Ty);
 251   void addSourceLine(DIE *Die, DINameSpace NS);
 252   void addSourceLine(DIE *Die, DIObjCProperty Ty);
 253
 254   /// addAddress - Add an address attribute to a die based on the location
 255   /// provided.
 256   void addAddress(DIE *Die, dwarf::Attribute Attribute,
 257                   const MachineLocation &Location, bool Indirect = false);
 258
 259   /// addConstantValue - Add constant value entry in variable DIE.
 260   void addConstantValue(DIE *Die, const MachineOperand &MO, DIType Ty);
 261   void addConstantValue(DIE *Die, const ConstantInt *CI, bool Unsigned);
 262   void addConstantValue(DIE *Die, const APInt &Val, bool Unsigned);
 263
 264   /// addConstantFPValue - Add constant value entry in variable DIE.
 265   void addConstantFPValue(DIE *Die, const MachineOperand &MO);
 266   void addConstantFPValue(DIE *Die, const ConstantFP *CFP);
 267
 268   /// addTemplateParams - Add template parameters in buffer.
 269   void addTemplateParams(DIE &Buffer, DIArray TParams);
 270
 271   /// addRegisterOp - Add register operand.
 272   void addRegisterOp(DIEBlock *TheDie, unsigned Reg);
 273
 274   /// addRegisterOffset - Add register offset.
 275   void addRegisterOffset(DIEBlock *TheDie, unsigned Reg, int64_t Offset);
 276
 277   /// addComplexAddress - Start with the address based on the location provided,
 278   /// and generate the DWARF information necessary to find the actual variable
 279   /// (navigating the extra location information encoded in the type) based on
 280   /// the starting location.  Add the DWARF information to the die.
 281   ///
 282   void addComplexAddress(const DbgVariable &DV, DIE *Die,
 283                          dwarf::Attribute Attribute,
 284                          const MachineLocation &Location);
 285
 286   // FIXME: Should be reformulated in terms of addComplexAddress.
 287   /// addBlockByrefAddress - Start with the address based on the location
 288   /// provided, and generate the DWARF information necessary to find the
 289   /// actual Block variable (navigating the Block struct) based on the
 290   /// starting location.  Add the DWARF information to the die.  Obsolete,
 291   /// please use addComplexAddress instead.
 292   ///
 293   void addBlockByrefAddress(const DbgVariable &DV, DIE *Die,
 294                             dwarf::Attribute Attribute,
 295                             const MachineLocation &Location);
 296
 297   /// addVariableAddress - Add DW_AT_location attribute for a
 298   /// DbgVariable based on provided MachineLocation.
 299   void addVariableAddress(const DbgVariable &DV, DIE *Die,
 300                           MachineLocation Location);
 301
 302   /// addType - Add a new type attribute to the specified entity. This takes
 303   /// and attribute parameter because DW_AT_friend attributes are also
 304   /// type references.
 305   void addType(DIE *Entity, DIType Ty,
 306                dwarf::Attribute Attribute = dwarf::DW_AT_type);
 307
 308   /// getOrCreateNameSpace - Create a DIE for DINameSpace.
 309   DIE *getOrCreateNameSpace(DINameSpace NS);
 310
 311   /// getOrCreateSubprogramDIE - Create new DIE using SP.
 312   DIE *getOrCreateSubprogramDIE(DISubprogram SP);
 313
 314   /// getOrCreateTypeDIE - Find existing DIE or create new DIE for the
 315   /// given DIType.
 316   DIE *getOrCreateTypeDIE(const MDNode *N);
 317
 318   /// getOrCreateContextDIE - Get context owner's DIE.
 319   DIE *createTypeDIE(DICompositeType Ty);
 320
 321   /// getOrCreateContextDIE - Get context owner's DIE.
 322   DIE *getOrCreateContextDIE(DIScope Context);
 323
 324   /// createGlobalVariableDIE - create global variable DIE.
 325   void createGlobalVariableDIE(DIGlobalVariable GV);
 326
 327   /// constructContainingTypeDIEs - Construct DIEs for types that contain
 328   /// vtables.
 329   void constructContainingTypeDIEs();
 330
 331   /// constructVariableDIE - Construct a DIE for the given DbgVariable.
 332   DIE *constructVariableDIE(DbgVariable &DV, bool isScopeAbstract);
 333
 334   /// Create a DIE with the given Tag, add the DIE to its parent, and
 335   /// call insertDIE if MD is not null.
 336   DIE *createAndAddDIE(unsigned Tag, DIE &Parent,
 337                        DIDescriptor N = DIDescriptor());
 338
 339   /// constructTypeDIEImpl - Construct type DIE that is not a type unit
 340   /// reference from a DICompositeType.
 341   void constructTypeDIEImpl(DIE &Buffer, DICompositeType CTy);
 342
 343   /// Compute the size of a header for this unit, not including the initial
 344   /// length field.
 345   unsigned getHeaderSize() const {
 346     return sizeof(int16_t) + // DWARF version number
 347            sizeof(int32_t) + // Offset Into Abbrev. Section
 348            sizeof(int8_t);   // Pointer Size (in bytes)
 349   }
 350
 351   /// Emit the header for this unit, not including the initial length field.
 352   void emitHeader(const MCSection *ASection, const MCSymbol *ASectionSym);
 353
 354 private:
 355   /// constructTypeDIE - Construct basic type die from DIBasicType.
 356   void constructTypeDIE(DIE &Buffer, DIBasicType BTy);
 357
 358   /// constructTypeDIE - Construct derived type die from DIDerivedType.
 359   void constructTypeDIE(DIE &Buffer, DIDerivedType DTy);
 360
 361   /// constructTypeDIE - Construct type DIE from DICompositeType.
 362   void constructTypeDIE(DIE &Buffer, DICompositeType CTy);
 363
 364   /// constructSubrangeDIE - Construct subrange DIE from DISubrange.
 365   void constructSubrangeDIE(DIE &Buffer, DISubrange SR, DIE *IndexTy);
 366
 367   /// constructArrayTypeDIE - Construct array type DIE from DICompositeType.
 368   void constructArrayTypeDIE(DIE &Buffer, DICompositeType CTy);
 369
 370   /// constructEnumTypeDIE - Construct enum type DIE from DIEnumerator.
 371   void constructEnumTypeDIE(DIE &Buffer, DICompositeType CTy);
 372
 373   /// constructMemberDIE - Construct member DIE from DIDerivedType.
 374   void constructMemberDIE(DIE &Buffer, DIDerivedType DT);
 375
 376   /// constructTemplateTypeParameterDIE - Construct new DIE for the given
 377   /// DITemplateTypeParameter.
 378   void constructTemplateTypeParameterDIE(DIE &Buffer,
 379                                          DITemplateTypeParameter TP);
 380
 381   /// constructTemplateValueParameterDIE - Construct new DIE for the given
 382   /// DITemplateValueParameter.
 383   void constructTemplateValueParameterDIE(DIE &Buffer,
 384                                           DITemplateValueParameter TVP);
 385
 386   /// getOrCreateStaticMemberDIE - Create new static data member DIE.
 387   DIE *getOrCreateStaticMemberDIE(DIDerivedType DT);
 388
 389   /// Offset of the CUDie from beginning of debug info section.
 390   unsigned DebugInfoOffset;
 391
 392   /// getLowerBoundDefault - Return the default lower bound for an array. If the
 393   /// DWARF version doesn't handle the language, return -1.
 394   int64_t getDefaultLowerBound() const;
 395
 396   /// getDIEEntry - Returns the debug information entry for the specified
 397   /// debug variable.
 398   DIEEntry *getDIEEntry(const MDNode *N) const {
 399     return MDNodeToDIEEntryMap.lookup(N);
 400   }
 401
 402   /// insertDIEEntry - Insert debug information entry into the map.
 403   void insertDIEEntry(const MDNode *N, DIEEntry *E) {
 404     MDNodeToDIEEntryMap.insert(std::make_pair(N, E));
 405   }
 406
 407   // getIndexTyDie - Get an anonymous type for index type.
 408   DIE *getIndexTyDie() { return IndexTyDie; }
 409
 410   // setIndexTyDie - Set D as anonymous type for index which can be reused
 411   // later.
 412   void setIndexTyDie(DIE *D) { IndexTyDie = D; }
 413
 414   /// createDIEEntry - Creates a new DIEEntry to be a proxy for a debug
 415   /// information entry.
 416   DIEEntry *createDIEEntry(DIE *Entry);
 417
 418   /// resolve - Look in the DwarfDebug map for the MDNode that
 419   /// corresponds to the reference.
 420   template <typename T> T resolve(DIRef<T> Ref) const {
 421     return DD->resolve(Ref);
 422   }
 423
 424   /// If this is a named finished type then include it in the list of types for
 425   /// the accelerator tables.
 426   void updateAcceleratorTables(DIType Ty, const DIE *TyDIE);
 427 };
 428
 429 } // end llvm namespace
 430 #endif