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