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