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