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() { return new (DIEValueAllocator) DIEBlock(); }
 150
 151   /// insertDIE - Insert DIE into the map.
 152   void insertDIE(const MDNode *N, DIE *D) {
 153     MDNodeToDieMap.insert(std::make_pair(N, D));
 154   }
 155
 156   /// getDIEEntry - Returns the debug information entry for the specified
 157   /// debug variable.
 158   DIEEntry *getDIEEntry(const MDNode *N) const {
 159     return MDNodeToDIEEntryMap.lookup(N);
 160   }
 161
 162   /// insertDIEEntry - Insert debug information entry into the map.
 163   void insertDIEEntry(const MDNode *N, DIEEntry *E) {
 164     MDNodeToDIEEntryMap.insert(std::make_pair(N, E));
 165   }
 166
 167   /// addDie - Adds or interns the DIE to the compile unit.
 168   ///
 169   void addDie(DIE *Buffer) { this->CUDie->addChild(Buffer); }
 170
 171   // getIndexTyDie - Get an anonymous type for index type.
 172   DIE *getIndexTyDie() { return IndexTyDie; }
 173
 174   // setIndexTyDie - Set D as anonymous type for index which can be reused
 175   // later.
 176   void setIndexTyDie(DIE *D) { IndexTyDie = D; }
 177
 178   /// addFlag - Add a flag that is true to the DIE.
 179   void addFlag(DIE *Die, uint16_t Attribute);
 180
 181   /// addUInt - Add an unsigned integer attribute data and value.
 182   ///
 183   void addUInt(DIE *Die, uint16_t Attribute, uint16_t Form, uint64_t Integer);
 184
 185   /// addSInt - Add an signed integer attribute data and value.
 186   ///
 187   void addSInt(DIE *Die, uint16_t Attribute, uint16_t Form, int64_t Integer);
 188
 189   /// addString - Add a string attribute data and value.
 190   ///
 191   void addString(DIE *Die, uint16_t Attribute, const StringRef Str);
 192
 193   /// addLocalString - Add a string attribute data and value.
 194   ///
 195   void addLocalString(DIE *Die, uint16_t Attribute, const StringRef Str);
 196
 197   /// addExpr - Add a Dwarf expression attribute data and value.
 198   ///
 199   void addExpr(DIE *Die, uint16_t Attribute, uint16_t Form, const MCExpr *Expr);
 200
 201   /// addLabel - Add a Dwarf label attribute data and value.
 202   ///
 203   void addLabel(DIE *Die, uint16_t Attribute, uint16_t Form,
 204                 const MCSymbol *Label);
 205
 206   /// addLabelAddress - Add a dwarf label attribute data and value using
 207   /// either DW_FORM_addr or DW_FORM_GNU_addr_index.
 208   ///
 209   void addLabelAddress(DIE *Die, uint16_t Attribute, MCSymbol *Label);
 210
 211   /// addOpAddress - Add a dwarf op address data and value using the
 212   /// form given and an op of either DW_FORM_addr or DW_FORM_GNU_addr_index.
 213   ///
 214   void addOpAddress(DIE *Die, const MCSymbol *Label);
 215   void addOpAddress(DIE *Die, const MCSymbolRefExpr *Label);
 216
 217   /// addDelta - Add a label delta attribute data and value.
 218   ///
 219   void addDelta(DIE *Die, uint16_t Attribute, uint16_t Form, const MCSymbol *Hi,
 220                 const MCSymbol *Lo);
 221
 222   /// addDIEEntry - Add a DIE attribute data and value.
 223   ///
 224   void addDIEEntry(DIE *Die, uint16_t Attribute, uint16_t Form, DIE *Entry);
 225
 226   /// addBlock - Add block data.
 227   ///
 228   void addBlock(DIE *Die, uint16_t Attribute, uint16_t Form, DIEBlock *Block);
 229
 230   /// addSourceLine - Add location information to specified debug information
 231   /// entry.
 232   void addSourceLine(DIE *Die, DIVariable V);
 233   void addSourceLine(DIE *Die, DIGlobalVariable G);
 234   void addSourceLine(DIE *Die, DISubprogram SP);
 235   void addSourceLine(DIE *Die, DIType Ty);
 236   void addSourceLine(DIE *Die, DINameSpace NS);
 237   void addSourceLine(DIE *Die, DIObjCProperty Ty);
 238
 239   /// addAddress - Add an address attribute to a die based on the location
 240   /// provided.
 241   void addAddress(DIE *Die, uint16_t Attribute, const MachineLocation &Location,
 242                   bool Indirect = false);
 243
 244   /// addConstantValue - Add constant value entry in variable DIE.
 245   void addConstantValue(DIE *Die, const MachineOperand &MO, DIType Ty);
 246   void addConstantValue(DIE *Die, const ConstantInt *CI, bool Unsigned);
 247   void addConstantValue(DIE *Die, const APInt &Val, bool Unsigned);
 248
 249   /// addConstantFPValue - Add constant value entry in variable DIE.
 250   void addConstantFPValue(DIE *Die, const MachineOperand &MO);
 251   void addConstantFPValue(DIE *Die, const ConstantFP *CFP);
 252
 253   /// addTemplateParams - Add template parameters in buffer.
 254   void addTemplateParams(DIE &Buffer, DIArray TParams);
 255
 256   /// addRegisterOp - Add register operand.
 257   void addRegisterOp(DIE *TheDie, unsigned Reg);
 258
 259   /// addRegisterOffset - Add register offset.
 260   void addRegisterOffset(DIE *TheDie, unsigned Reg, int64_t Offset);
 261
 262   /// addComplexAddress - Start with the address based on the location provided,
 263   /// and generate the DWARF information necessary to find the actual variable
 264   /// (navigating the extra location information encoded in the type) based on
 265   /// the starting location.  Add the DWARF information to the die.
 266   ///
 267   void addComplexAddress(const DbgVariable &DV, DIE *Die, uint16_t Attribute,
 268                          const MachineLocation &Location);
 269
 270   // FIXME: Should be reformulated in terms of addComplexAddress.
 271   /// addBlockByrefAddress - Start with the address based on the location
 272   /// provided, and generate the DWARF information necessary to find the
 273   /// actual Block variable (navigating the Block struct) based on the
 274   /// starting location.  Add the DWARF information to the die.  Obsolete,
 275   /// please use addComplexAddress instead.
 276   ///
 277   void addBlockByrefAddress(const DbgVariable &DV, DIE *Die, uint16_t Attribute,
 278                             const MachineLocation &Location);
 279
 280   /// addVariableAddress - Add DW_AT_location attribute for a
 281   /// DbgVariable based on provided MachineLocation.
 282   void addVariableAddress(const DbgVariable &DV, DIE *Die,
 283                           MachineLocation Location);
 284
 285   /// addToContextOwner - Add Die into the list of its context owner's children.
 286   void addToContextOwner(DIE *Die, DIScope Context);
 287
 288   /// addType - Add a new type attribute to the specified entity. This takes
 289   /// and attribute parameter because DW_AT_friend attributes are also
 290   /// type references.
 291   void addType(DIE *Entity, DIType Ty, uint16_t Attribute = dwarf::DW_AT_type);
 292
 293   /// getOrCreateNameSpace - Create a DIE for DINameSpace.
 294   DIE *getOrCreateNameSpace(DINameSpace NS);
 295
 296   /// getOrCreateSubprogramDIE - Create new DIE using SP.
 297   DIE *getOrCreateSubprogramDIE(DISubprogram SP);
 298
 299   /// getOrCreateTypeDIE - Find existing DIE or create new DIE for the
 300   /// given DIType.
 301   DIE *getOrCreateTypeDIE(const MDNode *N);
 302
 303   /// getOrCreateTemplateTypeParameterDIE - Find existing DIE or create new DIE
 304   /// for the given DITemplateTypeParameter.
 305   DIE *getOrCreateTemplateTypeParameterDIE(DITemplateTypeParameter TP);
 306
 307   /// getOrCreateTemplateValueParameterDIE - Find existing DIE or create
 308   /// new DIE for the given DITemplateValueParameter.
 309   DIE *getOrCreateTemplateValueParameterDIE(DITemplateValueParameter TVP);
 310
 311   /// createDIEEntry - Creates a new DIEEntry to be a proxy for a debug
 312   /// information entry.
 313   DIEEntry *createDIEEntry(DIE *Entry);
 314
 315   /// createGlobalVariableDIE - create global variable DIE.
 316   void createGlobalVariableDIE(const MDNode *N);
 317
 318   void addPubTypes(DISubprogram SP);
 319
 320   /// constructTypeDIE - Construct basic type die from DIBasicType.
 321   void constructTypeDIE(DIE &Buffer, DIBasicType BTy);
 322
 323   /// constructTypeDIE - Construct derived type die from DIDerivedType.
 324   void constructTypeDIE(DIE &Buffer, DIDerivedType DTy);
 325
 326   /// constructTypeDIE - Construct type DIE from DICompositeType.
 327   void constructTypeDIE(DIE &Buffer, DICompositeType CTy);
 328
 329   /// constructSubrangeDIE - Construct subrange DIE from DISubrange.
 330   void constructSubrangeDIE(DIE &Buffer, DISubrange SR, DIE *IndexTy);
 331
 332   /// constructArrayTypeDIE - Construct array type DIE from DICompositeType.
 333   void constructArrayTypeDIE(DIE &Buffer, DICompositeType *CTy);
 334
 335   /// constructEnumTypeDIE - Construct enum type DIE from DIEnumerator.
 336   DIE *constructEnumTypeDIE(DIEnumerator ETy);
 337
 338   /// constructContainingTypeDIEs - Construct DIEs for types that contain
 339   /// vtables.
 340   void constructContainingTypeDIEs();
 341
 342   /// constructVariableDIE - Construct a DIE for the given DbgVariable.
 343   DIE *constructVariableDIE(DbgVariable *DV, bool isScopeAbstract);
 344
 345   /// createMemberDIE - Create new member DIE.
 346   DIE *createMemberDIE(DIDerivedType DT);
 347
 348   /// createStaticMemberDIE - Create new static data member DIE.
 349   DIE *createStaticMemberDIE(DIDerivedType DT);
 350
 351   /// getOrCreateContextDIE - Get context owner's DIE.
 352   DIE *getOrCreateContextDIE(DIScope Context);
 353
 354 private:
 355
 356   // DIEValueAllocator - All DIEValues are allocated through this allocator.
 357   BumpPtrAllocator DIEValueAllocator;
 358   DIEInteger *DIEIntegerOne;
 359 };
 360
 361 } // end llvm namespace
 362 #endif