lib/CodeGen/AsmPrinter/DwarfUnit.h

   1 //===-- llvm/CodeGen/DwarfUnit.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 LLVM_LIB_CODEGEN_ASMPRINTER_DWARFUNIT_H
  15 #define LLVM_LIB_CODEGEN_ASMPRINTER_DWARFUNIT_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/StringMap.h"
  22 #include "llvm/CodeGen/AsmPrinter.h"
  23 #include "llvm/IR/DIBuilder.h"
  24 #include "llvm/IR/DebugInfo.h"
  25 #include "llvm/MC/MCExpr.h"
  26 #include "llvm/MC/MCSection.h"
  27 #include "llvm/MC/MCDwarf.h"
  28
  29 namespace llvm {
  30
  31 class MachineLocation;
  32 class MachineOperand;
  33 class ConstantInt;
  34 class ConstantFP;
  35 class DbgVariable;
  36 class DwarfCompileUnit;
  37
  38 // Data structure to hold a range for range lists.
  39 class RangeSpan {
  40 public:
  41   RangeSpan(MCSymbol *S, MCSymbol *E) : Start(S), End(E) {}
  42   const MCSymbol *getStart() const { return Start; }
  43   const MCSymbol *getEnd() const { return End; }
  44   void setEnd(const MCSymbol *E) { End = E; }
  45
  46 private:
  47   const MCSymbol *Start, *End;
  48 };
  49
  50 class RangeSpanList {
  51 private:
  52   // Index for locating within the debug_range section this particular span.
  53   MCSymbol *RangeSym;
  54   // List of ranges.
  55   SmallVector<RangeSpan, 2> Ranges;
  56
  57 public:
  58   RangeSpanList(MCSymbol *Sym) : RangeSym(Sym) {}
  59   MCSymbol *getSym() const { return RangeSym; }
  60   const SmallVectorImpl<RangeSpan> &getRanges() const { return Ranges; }
  61   void addRange(RangeSpan Range) { Ranges.push_back(Range); }
  62 };
  63
  64 //===----------------------------------------------------------------------===//
  65 /// Unit - This dwarf writer support class manages information associated
  66 /// with a source file.
  67 class DwarfUnit {
  68 protected:
  69   /// UniqueID - a numeric ID unique among all CUs in the module
  70   unsigned UniqueID;
  71
  72   /// Node - MDNode for the compile unit.
  73   DICompileUnit CUNode;
  74
  75   /// Unit debug information entry.
  76   DIE UnitDie;
  77
  78   /// Offset of the UnitDie from beginning of debug info section.
  79   unsigned DebugInfoOffset;
  80
  81   /// Asm - Target of Dwarf emission.
  82   AsmPrinter *Asm;
  83
  84   // Holders for some common dwarf information.
  85   DwarfDebug *DD;
  86   DwarfFile *DU;
  87
  88   /// IndexTyDie - An anonymous type for index type.  Owned by UnitDie.
  89   DIE *IndexTyDie;
  90
  91   /// MDNodeToDieMap - Tracks the mapping of unit level debug information
  92   /// variables to debug information entries.
  93   DenseMap<const MDNode *, DIE *> MDNodeToDieMap;
  94
  95   /// MDNodeToDIEEntryMap - Tracks the mapping of unit level debug information
  96   /// descriptors to debug information entries using a DIEEntry proxy.
  97   DenseMap<const MDNode *, DIEEntry *> MDNodeToDIEEntryMap;
  98
  99   /// GlobalNames - A map of globally visible named entities for this unit.
 100   StringMap<const DIE *> GlobalNames;
 101
 102   /// GlobalTypes - A map of globally visible types for this unit.
 103   StringMap<const DIE *> GlobalTypes;
 104
 105   /// DIEBlocks - A list of all the DIEBlocks in use.
 106   std::vector<DIEBlock *> DIEBlocks;
 107
 108   /// DIELocs - A list of all the DIELocs in use.
 109   std::vector<DIELoc *> DIELocs;
 110
 111   /// ContainingTypeMap - This map is used to keep track of subprogram DIEs that
 112   /// need DW_AT_containing_type attribute. This attribute points to a DIE that
 113   /// corresponds to the MDNode mapped with the subprogram DIE.
 114   DenseMap<DIE *, const MDNode *> ContainingTypeMap;
 115
 116   // List of ranges for a given compile unit.
 117   SmallVector<RangeSpan, 1> CURanges;
 118
 119   // List of range lists for a given compile unit, separate from the ranges for
 120   // the CU itself.
 121   SmallVector<RangeSpanList, 1> CURangeLists;
 122
 123   // DIEValueAllocator - All DIEValues are allocated through this allocator.
 124   BumpPtrAllocator DIEValueAllocator;
 125
 126   // DIEIntegerOne - A preallocated DIEValue because 1 is used frequently.
 127   DIEInteger *DIEIntegerOne;
 128
 129   /// The section this unit will be emitted in.
 130   const MCSection *Section;
 131
 132   DwarfUnit(unsigned UID, dwarf::Tag, DICompileUnit CU, AsmPrinter *A,
 133             DwarfDebug *DW, DwarfFile *DWU);
 134
 135   void initSection(const MCSection *Section);
 136 public:
 137   virtual ~DwarfUnit();
 138
 139   const MCSection *getSection() const {
 140     assert(Section);
 141     return Section;
 142   }
 143
 144   // Accessors.
 145   unsigned getUniqueID() const { return UniqueID; }
 146   uint16_t getLanguage() const { return CUNode.getLanguage(); }
 147   DICompileUnit getCUNode() const { return CUNode; }
 148   DIE &getUnitDie() { return UnitDie; }
 149   const StringMap<const DIE *> &getGlobalNames() const { return GlobalNames; }
 150   const StringMap<const DIE *> &getGlobalTypes() const { return GlobalTypes; }
 151
 152   unsigned getDebugInfoOffset() const { return DebugInfoOffset; }
 153   void setDebugInfoOffset(unsigned DbgInfoOff) { DebugInfoOffset = DbgInfoOff; }
 154
 155   /// hasContent - Return true if this compile unit has something to write out.
 156   bool hasContent() const { return !UnitDie.getChildren().empty(); }
 157
 158   /// getRanges - Get the list of ranges for this unit.
 159   const SmallVectorImpl<RangeSpan> &getRanges() const { return CURanges; }
 160   SmallVectorImpl<RangeSpan> &getRanges() { return CURanges; }
 161
 162   /// addRangeList - Add an address range list to the list of range lists.
 163   void addRangeList(RangeSpanList Ranges) {
 164     CURangeLists.push_back(std::move(Ranges));
 165   }
 166
 167   /// getRangeLists - Get the vector of range lists.
 168   const SmallVectorImpl<RangeSpanList> &getRangeLists() const {
 169     return CURangeLists;
 170   }
 171   SmallVectorImpl<RangeSpanList> &getRangeLists() { return CURangeLists; }
 172
 173   /// getParentContextString - Get a string containing the language specific
 174   /// context for a global name.
 175   std::string getParentContextString(DIScope Context) const;
 176
 177   /// Add a new global name to the compile unit.
 178   void addGlobalName(StringRef Name, DIE &Die, DIScope Context);
 179
 180   /// Add a new global type to the compile unit.
 181   void addGlobalType(DIType Ty, const DIE &Die, DIScope Context);
 182
 183   /// addAccelNamespace - Add a new name to the namespace accelerator table.
 184   void addAccelNamespace(StringRef Name, const DIE &Die);
 185
 186   /// getDIE - Returns the debug information entry map slot for the
 187   /// specified debug variable. We delegate the request to DwarfDebug
 188   /// when the MDNode can be part of the type system, since DIEs for
 189   /// the type system can be shared across CUs and the mappings are
 190   /// kept in DwarfDebug.
 191   DIE *getDIE(DIDescriptor D) const;
 192
 193   /// getDIELoc - Returns a fresh newly allocated DIELoc.
 194   DIELoc *getDIELoc() { return new (DIEValueAllocator) DIELoc(); }
 195
 196   /// insertDIE - Insert DIE into the map. We delegate the request to DwarfDebug
 197   /// when the MDNode can be part of the type system, since DIEs for
 198   /// the type system can be shared across CUs and the mappings are
 199   /// kept in DwarfDebug.
 200   void insertDIE(DIDescriptor Desc, DIE *D);
 201
 202   /// addFlag - Add a flag that is true to the DIE.
 203   void addFlag(DIE &Die, dwarf::Attribute Attribute);
 204
 205   /// addUInt - Add an unsigned integer attribute data and value.
 206   void addUInt(DIE &Die, dwarf::Attribute Attribute, Optional<dwarf::Form> Form,
 207                uint64_t Integer);
 208
 209   void addUInt(DIE &Block, dwarf::Form Form, uint64_t Integer);
 210
 211   /// addSInt - Add an signed integer attribute data and value.
 212   void addSInt(DIE &Die, dwarf::Attribute Attribute, Optional<dwarf::Form> Form,
 213                int64_t Integer);
 214
 215   void addSInt(DIELoc &Die, Optional<dwarf::Form> Form, int64_t Integer);
 216
 217   /// addString - Add a string attribute data and value.
 218   void addString(DIE &Die, dwarf::Attribute Attribute, StringRef Str);
 219
 220   /// addLocalString - Add a string attribute data and value.
 221   void addLocalString(DIE &Die, dwarf::Attribute Attribute,
 222                       StringRef Str);
 223
 224   /// addExpr - Add a Dwarf expression attribute data and value.
 225   void addExpr(DIELoc &Die, dwarf::Form Form, const MCExpr *Expr);
 226
 227   /// addLabel - Add a Dwarf label attribute data and value.
 228   void addLabel(DIE &Die, dwarf::Attribute Attribute, dwarf::Form Form,
 229                 const MCSymbol *Label);
 230
 231   void addLabel(DIELoc &Die, dwarf::Form Form, const MCSymbol *Label);
 232
 233   /// addLocationList - Add a Dwarf loclistptr attribute data and value.
 234   void addLocationList(DIE &Die, dwarf::Attribute Attribute, unsigned Index);
 235
 236   /// addSectionOffset - Add an offset into a section attribute data and value.
 237   ///
 238   void addSectionOffset(DIE &Die, dwarf::Attribute Attribute, uint64_t Integer);
 239
 240   /// addOpAddress - Add a dwarf op address data and value using the
 241   /// form given and an op of either DW_FORM_addr or DW_FORM_GNU_addr_index.
 242   void addOpAddress(DIELoc &Die, const MCSymbol *Label);
 243
 244   /// addLabelDelta - Add a label delta attribute data and value.
 245   void addLabelDelta(DIE &Die, dwarf::Attribute Attribute, const MCSymbol *Hi,
 246                      const MCSymbol *Lo);
 247
 248   /// addDIEEntry - Add a DIE attribute data and value.
 249   void addDIEEntry(DIE &Die, dwarf::Attribute Attribute, DIE &Entry);
 250
 251   /// addDIEEntry - Add a DIE attribute data and value.
 252   void addDIEEntry(DIE &Die, dwarf::Attribute Attribute, DIEEntry *Entry);
 253
 254   void addDIETypeSignature(DIE &Die, const DwarfTypeUnit &Type);
 255
 256   /// addBlock - Add block data.
 257   void addBlock(DIE &Die, dwarf::Attribute Attribute, DIELoc *Block);
 258
 259   /// addBlock - Add block data.
 260   void addBlock(DIE &Die, dwarf::Attribute Attribute, DIEBlock *Block);
 261
 262   /// addSourceLine - Add location information to specified debug information
 263   /// entry.
 264   void addSourceLine(DIE &Die, unsigned Line, StringRef File,
 265                      StringRef Directory);
 266   void addSourceLine(DIE &Die, DIVariable V);
 267   void addSourceLine(DIE &Die, DIGlobalVariable G);
 268   void addSourceLine(DIE &Die, DISubprogram SP);
 269   void addSourceLine(DIE &Die, DIType Ty);
 270   void addSourceLine(DIE &Die, DINameSpace NS);
 271   void addSourceLine(DIE &Die, DIObjCProperty Ty);
 272
 273   /// addAddress - Add an address attribute to a die based on the location
 274   /// provided.
 275   void addAddress(DIE &Die, dwarf::Attribute Attribute,
 276                   const MachineLocation &Location, bool Indirect = false);
 277
 278   /// addConstantValue - Add constant value entry in variable DIE.
 279   void addConstantValue(DIE &Die, const MachineOperand &MO, DIType Ty);
 280   void addConstantValue(DIE &Die, const ConstantInt *CI, DIType Ty);
 281   void addConstantValue(DIE &Die, const APInt &Val, DIType Ty);
 282   void addConstantValue(DIE &Die, const APInt &Val, bool Unsigned);
 283   void addConstantValue(DIE &Die, bool Unsigned, uint64_t Val);
 284
 285   /// addConstantFPValue - Add constant value entry in variable DIE.
 286   void addConstantFPValue(DIE &Die, const MachineOperand &MO);
 287   void addConstantFPValue(DIE &Die, const ConstantFP *CFP);
 288
 289   /// addTemplateParams - Add template parameters in buffer.
 290   void addTemplateParams(DIE &Buffer, DIArray TParams);
 291
 292   /// addRegisterOp - Add register operand.
 293   void addRegisterOpPiece(DIELoc &TheDie, unsigned Reg,
 294                           unsigned SizeInBits = 0, unsigned OffsetInBits = 0);
 295
 296   /// addRegisterOffset - Add register offset.
 297   void addRegisterOffset(DIELoc &TheDie, unsigned Reg, int64_t Offset);
 298
 299   /// addComplexAddress - Start with the address based on the location provided,
 300   /// and generate the DWARF information necessary to find the actual variable
 301   /// (navigating the extra location information encoded in the type) based on
 302   /// the starting location.  Add the DWARF information to the die.
 303   void addComplexAddress(const DbgVariable &DV, DIE &Die,
 304                          dwarf::Attribute Attribute,
 305                          const MachineLocation &Location);
 306
 307   // FIXME: Should be reformulated in terms of addComplexAddress.
 308   /// addBlockByrefAddress - Start with the address based on the location
 309   /// provided, and generate the DWARF information necessary to find the
 310   /// actual Block variable (navigating the Block struct) based on the
 311   /// starting location.  Add the DWARF information to the die.  Obsolete,
 312   /// please use addComplexAddress instead.
 313   void addBlockByrefAddress(const DbgVariable &DV, DIE &Die,
 314                             dwarf::Attribute Attribute,
 315                             const MachineLocation &Location);
 316
 317   /// addVariableAddress - Add DW_AT_location attribute for a
 318   /// DbgVariable based on provided MachineLocation.
 319   void addVariableAddress(const DbgVariable &DV, DIE &Die,
 320                           MachineLocation Location);
 321
 322   /// addType - Add a new type attribute to the specified entity. This takes
 323   /// and attribute parameter because DW_AT_friend attributes are also
 324   /// type references.
 325   void addType(DIE &Entity, DIType Ty,
 326                dwarf::Attribute Attribute = dwarf::DW_AT_type);
 327
 328   /// getOrCreateNameSpace - Create a DIE for DINameSpace.
 329   DIE *getOrCreateNameSpace(DINameSpace NS);
 330
 331   /// getOrCreateSubprogramDIE - Create new DIE using SP.
 332   DIE *getOrCreateSubprogramDIE(DISubprogram SP);
 333
 334   void applySubprogramAttributes(DISubprogram SP, DIE &SPDie);
 335   void applySubprogramAttributesToDefinition(DISubprogram SP, DIE &SPDie);
 336   void applyVariableAttributes(const DbgVariable &Var, DIE &VariableDie);
 337
 338   /// getOrCreateTypeDIE - Find existing DIE or create new DIE for the
 339   /// given DIType.
 340   DIE *getOrCreateTypeDIE(const MDNode *N);
 341
 342   /// getOrCreateContextDIE - Get context owner's DIE.
 343   DIE *createTypeDIE(DICompositeType Ty);
 344
 345   /// getOrCreateContextDIE - Get context owner's DIE.
 346   DIE *getOrCreateContextDIE(DIScope Context);
 347
 348   /// constructContainingTypeDIEs - Construct DIEs for types that contain
 349   /// vtables.
 350   void constructContainingTypeDIEs();
 351
 352   /// constructSubprogramArguments - Construct function argument DIEs.
 353   void constructSubprogramArguments(DIE &Buffer, DITypeArray Args);
 354
 355   /// Create a DIE with the given Tag, add the DIE to its parent, and
 356   /// call insertDIE if MD is not null.
 357   DIE &createAndAddDIE(unsigned Tag, DIE &Parent,
 358                        DIDescriptor N = DIDescriptor());
 359
 360   /// Compute the size of a header for this unit, not including the initial
 361   /// length field.
 362   virtual unsigned getHeaderSize() const {
 363     return sizeof(int16_t) + // DWARF version number
 364            sizeof(int32_t) + // Offset Into Abbrev. Section
 365            sizeof(int8_t);   // Pointer Size (in bytes)
 366   }
 367
 368   /// Emit the header for this unit, not including the initial length field.
 369   virtual void emitHeader(const MCSymbol *ASectionSym) const;
 370
 371   virtual DwarfCompileUnit &getCU() = 0;
 372
 373   /// constructTypeDIE - Construct type DIE from DICompositeType.
 374   void constructTypeDIE(DIE &Buffer, DICompositeType CTy);
 375
 376 protected:
 377   /// getOrCreateStaticMemberDIE - Create new static data member DIE.
 378   DIE *getOrCreateStaticMemberDIE(DIDerivedType DT);
 379
 380   /// Look up the source ID with the given directory and source file names. If
 381   /// none currently exists, create a new ID and insert it in the line table.
 382   virtual unsigned getOrCreateSourceID(StringRef File, StringRef Directory) = 0;
 383
 384   /// resolve - Look in the DwarfDebug map for the MDNode that
 385   /// corresponds to the reference.
 386   template <typename T> T resolve(DIRef<T> Ref) const {
 387     return DD->resolve(Ref);
 388   }
 389
 390 private:
 391   /// constructTypeDIE - Construct basic type die from DIBasicType.
 392   void constructTypeDIE(DIE &Buffer, DIBasicType BTy);
 393
 394   /// constructTypeDIE - Construct derived type die from DIDerivedType.
 395   void constructTypeDIE(DIE &Buffer, DIDerivedType DTy);
 396
 397   /// constructSubrangeDIE - Construct subrange DIE from DISubrange.
 398   void constructSubrangeDIE(DIE &Buffer, DISubrange SR, DIE *IndexTy);
 399
 400   /// constructArrayTypeDIE - Construct array type DIE from DICompositeType.
 401   void constructArrayTypeDIE(DIE &Buffer, DICompositeType CTy);
 402
 403   /// constructEnumTypeDIE - Construct enum type DIE from DIEnumerator.
 404   void constructEnumTypeDIE(DIE &Buffer, DICompositeType CTy);
 405
 406   /// constructMemberDIE - Construct member DIE from DIDerivedType.
 407   void constructMemberDIE(DIE &Buffer, DIDerivedType DT);
 408
 409   /// constructTemplateTypeParameterDIE - Construct new DIE for the given
 410   /// DITemplateTypeParameter.
 411   void constructTemplateTypeParameterDIE(DIE &Buffer,
 412                                          DITemplateTypeParameter TP);
 413
 414   /// constructTemplateValueParameterDIE - Construct new DIE for the given
 415   /// DITemplateValueParameter.
 416   void constructTemplateValueParameterDIE(DIE &Buffer,
 417                                           DITemplateValueParameter TVP);
 418
 419   /// getLowerBoundDefault - Return the default lower bound for an array. If the
 420   /// DWARF version doesn't handle the language, return -1.
 421   int64_t getDefaultLowerBound() const;
 422
 423   /// getDIEEntry - Returns the debug information entry for the specified
 424   /// debug variable.
 425   DIEEntry *getDIEEntry(const MDNode *N) const {
 426     return MDNodeToDIEEntryMap.lookup(N);
 427   }
 428
 429   /// insertDIEEntry - Insert debug information entry into the map.
 430   void insertDIEEntry(const MDNode *N, DIEEntry *E) {
 431     MDNodeToDIEEntryMap.insert(std::make_pair(N, E));
 432   }
 433
 434   // getIndexTyDie - Get an anonymous type for index type.
 435   DIE *getIndexTyDie();
 436
 437   // setIndexTyDie - Set D as anonymous type for index which can be reused
 438   // later.
 439   void setIndexTyDie(DIE *D) { IndexTyDie = D; }
 440
 441   /// createDIEEntry - Creates a new DIEEntry to be a proxy for a debug
 442   /// information entry.
 443   DIEEntry *createDIEEntry(DIE &Entry);
 444
 445   /// If this is a named finished type then include it in the list of types for
 446   /// the accelerator tables.
 447   void updateAcceleratorTables(DIScope Context, DIType Ty, const DIE &TyDIE);
 448 };
 449
 450 class DwarfTypeUnit : public DwarfUnit {
 451 private:
 452   uint64_t TypeSignature;
 453   const DIE *Ty;
 454   DwarfCompileUnit &CU;
 455   MCDwarfDwoLineTable *SplitLineTable;
 456
 457 public:
 458   DwarfTypeUnit(unsigned UID, DwarfCompileUnit &CU, AsmPrinter *A,
 459                 DwarfDebug *DW, DwarfFile *DWU,
 460                 MCDwarfDwoLineTable *SplitLineTable = nullptr);
 461
 462   void setTypeSignature(uint64_t Signature) { TypeSignature = Signature; }
 463   uint64_t getTypeSignature() const { return TypeSignature; }
 464   void setType(const DIE *Ty) { this->Ty = Ty; }
 465
 466   /// Emit the header for this unit, not including the initial length field.
 467   void emitHeader(const MCSymbol *ASectionSym) const override;
 468   unsigned getHeaderSize() const override {
 469     return DwarfUnit::getHeaderSize() + sizeof(uint64_t) + // Type Signature
 470            sizeof(uint32_t);                               // Type DIE Offset
 471   }
 472   using DwarfUnit::initSection;
 473   DwarfCompileUnit &getCU() override { return CU; }
 474
 475 protected:
 476   unsigned getOrCreateSourceID(StringRef File, StringRef Directory) override;
 477 };
 478 } // end llvm namespace
 479 #endif