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