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