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