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