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