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