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