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