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