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