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 "llvm/ADT/DenseMap.h"
  19 #include "llvm/ADT/OwningPtr.h"
  20 #include "llvm/ADT/StringMap.h"
  21 #include "llvm/DebugInfo.h"
  22 #include "llvm/MC/MCExpr.h"
  23
  24 namespace llvm {
  25
  26 class DwarfDebug;
  27 class DwarfUnits;
  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   /// Die - 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   /// Offset of the CUDie from beginning of debug info section.
  91   unsigned DebugInfoOffset;
  92
  93   /// getLowerBoundDefault - Return the default lower bound for an array. If the
  94   /// DWARF version doesn't handle the language, return -1.
  95   int64_t getDefaultLowerBound() const;
  96
  97 public:
  98   CompileUnit(unsigned UID, DIE *D, const MDNode *N, AsmPrinter *A,
  99               DwarfDebug *DW, DwarfUnits *DWU);
 100   ~CompileUnit();
 101
 102   // Accessors.
 103   unsigned getUniqueID() const { return UniqueID; }
 104   uint16_t getLanguage() const { return DICompileUnit(Node).getLanguage(); }
 105   const MDNode *getNode() const { return Node; }
 106   DIE *getCUDie() const { return CUDie.get(); }
 107   unsigned getDebugInfoOffset() const { return DebugInfoOffset; }
 108   const StringMap<DIE *> &getGlobalNames() const { return GlobalNames; }
 109   const StringMap<DIE *> &getGlobalTypes() const { return GlobalTypes; }
 110
 111   const StringMap<std::vector<DIE *> > &getAccelNames() const {
 112     return AccelNames;
 113   }
 114   const StringMap<std::vector<DIE *> > &getAccelObjC() const {
 115     return AccelObjC;
 116   }
 117   const StringMap<std::vector<DIE *> > &getAccelNamespace() const {
 118     return AccelNamespace;
 119   }
 120   const StringMap<std::vector<std::pair<DIE *, unsigned> > > &
 121   getAccelTypes() const {
 122     return AccelTypes;
 123   }
 124
 125   void setDebugInfoOffset(unsigned DbgInfoOff) { DebugInfoOffset = DbgInfoOff; }
 126   /// hasContent - Return true if this compile unit has something to write out.
 127   ///
 128   bool hasContent() const { return !CUDie->getChildren().empty(); }
 129
 130   /// addGlobalName - Add a new global entity to the compile unit.
 131   ///
 132   void addGlobalName(StringRef Name, DIE *Die);
 133
 134   /// addGlobalType - Add a new global type to the compile unit.
 135   ///
 136   void addGlobalType(DIType Ty);
 137
 138   /// addAccelName - Add a new name to the name accelerator table.
 139   void addAccelName(StringRef Name, DIE *Die);
 140
 141   /// addAccelObjC - Add a new name to the ObjC accelerator table.
 142   void addAccelObjC(StringRef Name, DIE *Die);
 143
 144   /// addAccelNamespace - Add a new name to the namespace accelerator table.
 145   void addAccelNamespace(StringRef Name, DIE *Die);
 146
 147   /// addAccelType - Add a new type to the type accelerator table.
 148   void addAccelType(StringRef Name, std::pair<DIE *, unsigned> Die);
 149
 150   /// getDIE - Returns the debug information entry map slot for the
 151   /// specified debug variable.
 152   DIE *getDIE(const MDNode *N) const { return MDNodeToDieMap.lookup(N); }
 153
 154   DIEBlock *getDIEBlock() {
 155     return new (DIEValueAllocator) DIEBlock();
 156   }
 157
 158   /// insertDIE - Insert DIE into the map.
 159   void insertDIE(const MDNode *N, DIE *D) {
 160     MDNodeToDieMap.insert(std::make_pair(N, D));
 161   }
 162
 163   /// getDIEEntry - Returns the debug information entry for the specified
 164   /// debug variable.
 165   DIEEntry *getDIEEntry(const MDNode *N) const {
 166     return MDNodeToDIEEntryMap.lookup(N);
 167   }
 168
 169   /// insertDIEEntry - Insert debug information entry into the map.
 170   void insertDIEEntry(const MDNode *N, DIEEntry *E) {
 171     MDNodeToDIEEntryMap.insert(std::make_pair(N, E));
 172   }
 173
 174   /// addDie - Adds or interns the DIE to the compile unit.
 175   ///
 176   void addDie(DIE *Buffer) {
 177     this->CUDie->addChild(Buffer);
 178   }
 179
 180   // getIndexTyDie - Get an anonymous type for index type.
 181   DIE *getIndexTyDie() {
 182     return IndexTyDie;
 183   }
 184
 185   // setIndexTyDie - Set D as anonymous type for index which can be reused
 186   // later.
 187   void setIndexTyDie(DIE *D) {
 188     IndexTyDie = D;
 189   }
 190
 191   /// addFlag - Add a flag that is true to the DIE.
 192   void addFlag(DIE *Die, uint16_t Attribute);
 193
 194   /// addUInt - Add an unsigned integer attribute data and value.
 195   ///
 196   void addUInt(DIE *Die, uint16_t Attribute, uint16_t Form, uint64_t Integer);
 197
 198   /// addSInt - Add an signed integer attribute data and value.
 199   ///
 200   void addSInt(DIE *Die, uint16_t Attribute, uint16_t Form, int64_t Integer);
 201
 202   /// addString - Add a string attribute data and value.
 203   ///
 204   void addString(DIE *Die, uint16_t Attribute, const StringRef Str);
 205
 206   /// addLocalString - Add a string attribute data and value.
 207   ///
 208   void addLocalString(DIE *Die, uint16_t Attribute, const StringRef Str);
 209
 210   /// addExpr - Add a Dwarf expression attribute data and value.
 211   ///
 212   void addExpr(DIE *Die, uint16_t Attribute, uint16_t Form,
 213                const MCExpr *Expr);
 214
 215   /// addLabel - Add a Dwarf label attribute data and value.
 216   ///
 217   void addLabel(DIE *Die, uint16_t Attribute, uint16_t Form,
 218                 const MCSymbol *Label);
 219
 220   /// addLabelAddress - Add a dwarf label attribute data and value using
 221   /// either DW_FORM_addr or DW_FORM_GNU_addr_index.
 222   ///
 223   void addLabelAddress(DIE *Die, uint16_t Attribute, MCSymbol *Label);
 224
 225   /// addOpAddress - Add a dwarf op address data and value using the
 226   /// form given and an op of either DW_FORM_addr or DW_FORM_GNU_addr_index.
 227   ///
 228   void addOpAddress(DIE *Die, const MCSymbol *Label);
 229   void addOpAddress(DIE *Die, const MCSymbolRefExpr *Label);
 230
 231   /// addDelta - Add a label delta attribute data and value.
 232   ///
 233   void addDelta(DIE *Die, uint16_t Attribute, uint16_t Form,
 234                 const MCSymbol *Hi, const MCSymbol *Lo);
 235
 236   /// addDIEEntry - Add a DIE attribute data and value.
 237   ///
 238   void addDIEEntry(DIE *Die, uint16_t Attribute, uint16_t Form, DIE *Entry);
 239
 240   /// addBlock - Add block data.
 241   ///
 242   void addBlock(DIE *Die, uint16_t Attribute, uint16_t Form, DIEBlock *Block);
 243
 244   /// addSourceLine - Add location information to specified debug information
 245   /// entry.
 246   void addSourceLine(DIE *Die, DIVariable V);
 247   void addSourceLine(DIE *Die, DIGlobalVariable G);
 248   void addSourceLine(DIE *Die, DISubprogram SP);
 249   void addSourceLine(DIE *Die, DIType Ty);
 250   void addSourceLine(DIE *Die, DINameSpace NS);
 251   void addSourceLine(DIE *Die, DIObjCProperty Ty);
 252
 253   /// addAddress - Add an address attribute to a die based on the location
 254   /// provided.
 255   void addAddress(DIE *Die, uint16_t Attribute,
 256                   const MachineLocation &Location, bool Indirect = false);
 257
 258   /// addConstantValue - Add constant value entry in variable DIE.
 259   void addConstantValue(DIE *Die, const MachineOperand &MO, DIType Ty);
 260   void addConstantValue(DIE *Die, const ConstantInt *CI, bool Unsigned);
 261   void addConstantValue(DIE *Die, const APInt &Val, bool Unsigned);
 262
 263   /// addConstantFPValue - Add constant value entry in variable DIE.
 264   void addConstantFPValue(DIE *Die, const MachineOperand &MO);
 265   void addConstantFPValue(DIE *Die, const ConstantFP *CFP);
 266
 267   /// addTemplateParams - Add template parameters in buffer.
 268   void addTemplateParams(DIE &Buffer, DIArray TParams);
 269
 270   /// addRegisterOp - Add register operand.
 271   void addRegisterOp(DIE *TheDie, unsigned Reg);
 272
 273   /// addRegisterOffset - Add register offset.
 274   void addRegisterOffset(DIE *TheDie, unsigned Reg, int64_t Offset);
 275
 276   /// addComplexAddress - Start with the address based on the location provided,
 277   /// and generate the DWARF information necessary to find the actual variable
 278   /// (navigating the extra location information encoded in the type) based on
 279   /// the starting location.  Add the DWARF information to the die.
 280   ///
 281   void addComplexAddress(const DbgVariable &DV, DIE *Die, uint16_t Attribute,
 282                          const MachineLocation &Location);
 283
 284   // FIXME: Should be reformulated in terms of addComplexAddress.
 285   /// addBlockByrefAddress - Start with the address based on the location
 286   /// provided, and generate the DWARF information necessary to find the
 287   /// actual Block variable (navigating the Block struct) based on the
 288   /// starting location.  Add the DWARF information to the die.  Obsolete,
 289   /// please use addComplexAddress instead.
 290   ///
 291   void addBlockByrefAddress(const DbgVariable &DV, DIE *Die, uint16_t Attribute,
 292                             const MachineLocation &Location);
 293
 294   /// addVariableAddress - Add DW_AT_location attribute for a
 295   /// DbgVariable based on provided MachineLocation.
 296   void addVariableAddress(const DbgVariable &DV, DIE *Die,
 297                           MachineLocation Location);
 298
 299   /// addToContextOwner - Add Die into the list of its context owner's children.
 300   void addToContextOwner(DIE *Die, DIDescriptor Context);
 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, uint16_t Attribute = dwarf::DW_AT_type);
 306
 307   /// getOrCreateNameSpace - Create a DIE for DINameSpace.
 308   DIE *getOrCreateNameSpace(DINameSpace NS);
 309
 310   /// getOrCreateSubprogramDIE - Create new DIE using SP.
 311   DIE *getOrCreateSubprogramDIE(DISubprogram SP);
 312
 313   /// getOrCreateTypeDIE - Find existing DIE or create new DIE for the
 314   /// given DIType.
 315   DIE *getOrCreateTypeDIE(const MDNode *N);
 316
 317   /// getOrCreateTemplateTypeParameterDIE - Find existing DIE or create new DIE
 318   /// for the given DITemplateTypeParameter.
 319   DIE *getOrCreateTemplateTypeParameterDIE(DITemplateTypeParameter TP);
 320
 321   /// getOrCreateTemplateValueParameterDIE - Find existing DIE or create
 322   /// new DIE for the given DITemplateValueParameter.
 323   DIE *getOrCreateTemplateValueParameterDIE(DITemplateValueParameter TVP);
 324
 325   /// createDIEEntry - Creates a new DIEEntry to be a proxy for a debug
 326   /// information entry.
 327   DIEEntry *createDIEEntry(DIE *Entry);
 328
 329   /// createGlobalVariableDIE - create global variable DIE.
 330   void createGlobalVariableDIE(const MDNode *N);
 331
 332   void addPubTypes(DISubprogram SP);
 333
 334   /// constructTypeDIE - Construct basic type die from DIBasicType.
 335   void constructTypeDIE(DIE &Buffer,
 336                         DIBasicType BTy);
 337
 338   /// constructTypeDIE - Construct derived type die from DIDerivedType.
 339   void constructTypeDIE(DIE &Buffer,
 340                         DIDerivedType DTy);
 341
 342   /// constructTypeDIE - Construct type DIE from DICompositeType.
 343   void constructTypeDIE(DIE &Buffer,
 344                         DICompositeType CTy);
 345
 346   /// constructSubrangeDIE - Construct subrange DIE from DISubrange.
 347   void constructSubrangeDIE(DIE &Buffer, DISubrange SR, DIE *IndexTy);
 348
 349   /// constructArrayTypeDIE - Construct array type DIE from DICompositeType.
 350   void constructArrayTypeDIE(DIE &Buffer,
 351                              DICompositeType *CTy);
 352
 353   /// constructEnumTypeDIE - Construct enum type DIE from DIEnumerator.
 354   DIE *constructEnumTypeDIE(DIEnumerator ETy);
 355
 356   /// constructContainingTypeDIEs - Construct DIEs for types that contain
 357   /// vtables.
 358   void constructContainingTypeDIEs();
 359
 360   /// constructVariableDIE - Construct a DIE for the given DbgVariable.
 361   DIE *constructVariableDIE(DbgVariable *DV, bool isScopeAbstract);
 362
 363   /// createMemberDIE - Create new member DIE.
 364   DIE *createMemberDIE(DIDerivedType DT);
 365
 366   /// createStaticMemberDIE - Create new static data member DIE.
 367   DIE *createStaticMemberDIE(DIDerivedType DT);
 368
 369   /// getOrCreateContextDIE - Get context owner's DIE.
 370   DIE *getOrCreateContextDIE(DIDescriptor Context);
 371
 372 private:
 373
 374   // DIEValueAllocator - All DIEValues are allocated through this allocator.
 375   BumpPtrAllocator DIEValueAllocator;
 376   DIEInteger *DIEIntegerOne;
 377 };
 378
 379 } // end llvm namespace
 380 #endif