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 ConstantFP;
  31 class DbgVariable;
  32
  33 //===----------------------------------------------------------------------===//
  34 /// CompileUnit - This dwarf writer support class manages information associated
  35 /// with a source file.
  36 class CompileUnit {
  37   /// UniqueID - a numeric ID unique among all CUs in the module
  38   ///
  39   unsigned UniqueID;
  40
  41   /// Language - The DW_AT_language of the compile unit
  42   ///
  43   unsigned Language;
  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 informaton
  60   /// variables to debug information entries.
  61   DenseMap<const MDNode *, DIE *> MDNodeToDieMap;
  62
  63   /// MDNodeToDIEEntryMap - Tracks the mapping of unit level debug informaton
  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   /// getLowerBoundDefault - Return the default lower bound for an array. If the
  91   /// DWARF version doesn't handle the language, return -1.
  92   int64_t getDefaultLowerBound() const;
  93
  94   /// getOrCreateContextDIE - Get context owner's DIE.
  95   DIE *getOrCreateContextDIE(DIDescriptor Context);
  96
  97 public:
  98   CompileUnit(unsigned UID, unsigned L, DIE *D, AsmPrinter *A, DwarfDebug *DW,
  99               DwarfUnits *);
 100   ~CompileUnit();
 101
 102   // Accessors.
 103   unsigned getUniqueID()            const { return UniqueID; }
 104   unsigned getLanguage()            const { return Language; }
 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   /// hasContent - Return true if this compile unit has something to write out.
 124   ///
 125   bool hasContent() const { return !CUDie->getChildren().empty(); }
 126
 127   /// addGlobalName - Add a new global entity to the compile unit.
 128   ///
 129   void addGlobalName(StringRef Name, DIE *Die) { GlobalNames[Name] = Die; }
 130
 131   /// addGlobalType - Add a new global type to the compile unit.
 132   ///
 133   void addGlobalType(DIType Ty);
 134
 135
 136   /// addAccelName - Add a new name to the name accelerator table.
 137   void addAccelName(StringRef Name, DIE *Die) {
 138     std::vector<DIE*> &DIEs = AccelNames[Name];
 139     DIEs.push_back(Die);
 140   }
 141   void addAccelObjC(StringRef Name, DIE *Die) {
 142     std::vector<DIE*> &DIEs = AccelObjC[Name];
 143     DIEs.push_back(Die);
 144   }
 145   void addAccelNamespace(StringRef Name, DIE *Die) {
 146     std::vector<DIE*> &DIEs = AccelNamespace[Name];
 147     DIEs.push_back(Die);
 148   }
 149   void addAccelType(StringRef Name, std::pair<DIE *, unsigned> Die) {
 150     std::vector<std::pair<DIE*, unsigned > > &DIEs = AccelTypes[Name];
 151     DIEs.push_back(Die);
 152   }
 153
 154   /// getDIE - Returns the debug information entry map slot for the
 155   /// specified debug variable.
 156   DIE *getDIE(const MDNode *N) { return MDNodeToDieMap.lookup(N); }
 157
 158   DIEBlock *getDIEBlock() {
 159     return new (DIEValueAllocator) DIEBlock();
 160   }
 161
 162   /// insertDIE - Insert DIE into the map.
 163   void insertDIE(const MDNode *N, DIE *D) {
 164     MDNodeToDieMap.insert(std::make_pair(N, D));
 165   }
 166
 167   /// getDIEEntry - Returns the debug information entry for the specified
 168   /// debug variable.
 169   DIEEntry *getDIEEntry(const MDNode *N) {
 170     DenseMap<const MDNode *, DIEEntry *>::iterator I =
 171       MDNodeToDIEEntryMap.find(N);
 172     if (I == MDNodeToDIEEntryMap.end())
 173       return NULL;
 174     return I->second;
 175   }
 176
 177   /// insertDIEEntry - Insert debug information entry into the map.
 178   void insertDIEEntry(const MDNode *N, DIEEntry *E) {
 179     MDNodeToDIEEntryMap.insert(std::make_pair(N, E));
 180   }
 181
 182   /// addDie - Adds or interns the DIE to the compile unit.
 183   ///
 184   void addDie(DIE *Buffer) {
 185     this->CUDie->addChild(Buffer);
 186   }
 187
 188   // getIndexTyDie - Get an anonymous type for index type.
 189   DIE *getIndexTyDie() {
 190     return IndexTyDie;
 191   }
 192
 193   // setIndexTyDie - Set D as anonymous type for index which can be reused
 194   // later.
 195   void setIndexTyDie(DIE *D) {
 196     IndexTyDie = D;
 197   }
 198
 199   /// addFlag - Add a flag that is true to the DIE.
 200   void addFlag(DIE *Die, unsigned Attribute);
 201
 202   /// addUInt - Add an unsigned integer attribute data and value.
 203   ///
 204   void addUInt(DIE *Die, unsigned Attribute, unsigned Form, uint64_t Integer);
 205
 206   /// addSInt - Add an signed integer attribute data and value.
 207   ///
 208   void addSInt(DIE *Die, unsigned Attribute, unsigned Form, int64_t Integer);
 209
 210   /// addString - Add a string attribute data and value.
 211   ///
 212   void addString(DIE *Die, unsigned Attribute, const StringRef Str);
 213
 214   /// addLocalString - Add a string attribute data and value.
 215   ///
 216   void addLocalString(DIE *Die, unsigned Attribute, const StringRef Str);
 217
 218   /// addLabel - Add a Dwarf label attribute data and value.
 219   ///
 220   void addLabel(DIE *Die, unsigned Attribute, unsigned Form,
 221                 const MCSymbol *Label);
 222
 223   /// addLabelAddress - Add a dwarf label attribute data and value using
 224   /// either DW_FORM_addr or DW_FORM_GNU_addr_index.
 225   ///
 226   void addLabelAddress(DIE *Die, unsigned Attribute, MCSymbol *Label);
 227
 228   /// addOpAddress - Add a dwarf op address data and value using the
 229   /// form given and an op of either DW_FORM_addr or DW_FORM_GNU_addr_index.
 230   ///
 231   void addOpAddress(DIE *Die, MCSymbol *Label);
 232
 233   /// addDelta - Add a label delta attribute data and value.
 234   ///
 235   void addDelta(DIE *Die, unsigned Attribute, unsigned Form,
 236                 const MCSymbol *Hi, const MCSymbol *Lo);
 237
 238   /// addDIEEntry - Add a DIE attribute data and value.
 239   ///
 240   void addDIEEntry(DIE *Die, unsigned Attribute, unsigned Form, DIE *Entry);
 241
 242   /// addBlock - Add block data.
 243   ///
 244   void addBlock(DIE *Die, unsigned Attribute, unsigned Form, DIEBlock *Block);
 245
 246   /// addSourceLine - Add location information to specified debug information
 247   /// entry.
 248   void addSourceLine(DIE *Die, DIVariable V);
 249   void addSourceLine(DIE *Die, DIGlobalVariable G);
 250   void addSourceLine(DIE *Die, DISubprogram SP);
 251   void addSourceLine(DIE *Die, DIType Ty);
 252   void addSourceLine(DIE *Die, DINameSpace NS);
 253   void addSourceLine(DIE *Die, DIObjCProperty Ty);
 254
 255   /// addAddress - Add an address attribute to a die based on the location
 256   /// provided.
 257   void addAddress(DIE *Die, unsigned Attribute,
 258                   const MachineLocation &Location);
 259
 260   /// addConstantValue - Add constant value entry in variable DIE.
 261   bool addConstantValue(DIE *Die, const MachineOperand &MO, DIType Ty);
 262   bool addConstantValue(DIE *Die, const ConstantInt *CI, bool Unsigned);
 263   bool addConstantValue(DIE *Die, const APInt &Val, bool Unsigned);
 264
 265   /// addConstantFPValue - Add constant value entry in variable DIE.
 266   bool addConstantFPValue(DIE *Die, const MachineOperand &MO);
 267   bool addConstantFPValue(DIE *Die, const ConstantFP *CFP);
 268
 269   /// addTemplateParams - Add template parameters in buffer.
 270   void addTemplateParams(DIE &Buffer, DIArray TParams);
 271
 272   /// addRegisterOp - Add register operand.
 273   void addRegisterOp(DIE *TheDie, unsigned Reg);
 274
 275   /// addRegisterOffset - Add register offset.
 276   void addRegisterOffset(DIE *TheDie, unsigned Reg, int64_t Offset);
 277
 278   /// addComplexAddress - Start with the address based on the location provided,
 279   /// and generate the DWARF information necessary to find the actual variable
 280   /// (navigating the extra location information encoded in the type) based on
 281   /// the starting location.  Add the DWARF information to the die.
 282   ///
 283   void addComplexAddress(DbgVariable *&DV, DIE *Die, unsigned 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(DbgVariable *&DV, DIE *Die, unsigned Attribute,
 294                             const MachineLocation &Location);
 295
 296   /// addVariableAddress - Add DW_AT_location attribute for a
 297   /// DbgVariable based on provided MachineLocation.
 298   void addVariableAddress(DbgVariable *&DV, DIE *Die, MachineLocation Location);
 299
 300   /// addToContextOwner - Add Die into the list of its context owner's children.
 301   void addToContextOwner(DIE *Die, DIDescriptor Context);
 302
 303   /// addType - Add a new type attribute to the specified entity. This takes
 304   /// and attribute parameter because DW_AT_friend attributes are also
 305   /// type references.
 306   void addType(DIE *Entity, DIType Ty, unsigned 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   /// getOrCreateTemplateTypeParameterDIE - Find existing DIE or create new DIE
 319   /// for the given DITemplateTypeParameter.
 320   DIE *getOrCreateTemplateTypeParameterDIE(DITemplateTypeParameter TP);
 321
 322   /// getOrCreateTemplateValueParameterDIE - Find existing DIE or create
 323   /// new DIE for the given DITemplateValueParameter.
 324   DIE *getOrCreateTemplateValueParameterDIE(DITemplateValueParameter TVP);
 325
 326   /// createDIEEntry - Creates a new DIEEntry to be a proxy for a debug
 327   /// information entry.
 328   DIEEntry *createDIEEntry(DIE *Entry);
 329
 330   /// createGlobalVariableDIE - create global variable DIE.
 331   void createGlobalVariableDIE(const MDNode *N);
 332
 333   void addPubTypes(DISubprogram SP);
 334
 335   /// constructTypeDIE - Construct basic type die from DIBasicType.
 336   void constructTypeDIE(DIE &Buffer,
 337                         DIBasicType BTy);
 338
 339   /// constructTypeDIE - Construct derived type die from DIDerivedType.
 340   void constructTypeDIE(DIE &Buffer,
 341                         DIDerivedType DTy);
 342
 343   /// constructTypeDIE - Construct type DIE from DICompositeType.
 344   void constructTypeDIE(DIE &Buffer,
 345                         DICompositeType CTy);
 346
 347   /// constructSubrangeDIE - Construct subrange DIE from DISubrange.
 348   void constructSubrangeDIE(DIE &Buffer, DISubrange SR, DIE *IndexTy);
 349
 350   /// constructArrayTypeDIE - Construct array type DIE from DICompositeType.
 351   void constructArrayTypeDIE(DIE &Buffer,
 352                              DICompositeType *CTy);
 353
 354   /// constructEnumTypeDIE - Construct enum type DIE from DIEnumerator.
 355   DIE *constructEnumTypeDIE(DIEnumerator ETy);
 356
 357   /// constructContainingTypeDIEs - Construct DIEs for types that contain
 358   /// vtables.
 359   void constructContainingTypeDIEs();
 360
 361   /// constructVariableDIE - Construct a DIE for the given DbgVariable.
 362   DIE *constructVariableDIE(DbgVariable *DV, bool isScopeAbstract);
 363
 364   /// createMemberDIE - Create new member DIE.
 365   DIE *createMemberDIE(DIDerivedType DT);
 366
 367   /// createStaticMemberDIE - Create new static data member DIE.
 368   DIE *createStaticMemberDIE(DIDerivedType DT);
 369
 370 private:
 371
 372   // DIEValueAllocator - All DIEValues are allocated through this allocator.
 373   BumpPtrAllocator DIEValueAllocator;
 374   DIEInteger *DIEIntegerOne;
 375 };
 376
 377 } // end llvm namespace
 378 #endif