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   /// A label at the start of the non-dwo section related to this unit.
 133   MCSymbol *SectionSym;
 134
 135   /// The start of the unit within its section.
 136   MCSymbol *LabelBegin;
 137
 138   /// The end of the unit within its section.
 139   MCSymbol *LabelEnd;
 140
 141   DwarfUnit(unsigned UID, dwarf::Tag, DICompileUnit CU, AsmPrinter *A,
 142             DwarfDebug *DW, DwarfFile *DWU);
 143
 144 public:
 145   virtual ~DwarfUnit();
 146
 147   /// Pass in the SectionSym even though we could recreate it in every compile
 148   /// unit (type units will have actually distinct symbols once they're in
 149   /// comdat sections).
 150   void initSection(const MCSection *Section, MCSymbol *SectionSym) {
 151     assert(!this->Section);
 152     this->Section = Section;
 153     this->SectionSym = SectionSym;
 154     this->LabelBegin =
 155         Asm->GetTempSymbol(Section->getLabelBeginName(), getUniqueID());
 156     this->LabelEnd =
 157         Asm->GetTempSymbol(Section->getLabelEndName(), getUniqueID());
 158   }
 159
 160   const MCSection *getSection() const {
 161     assert(Section);
 162     return Section;
 163   }
 164
 165   MCSymbol *getSectionSym() const {
 166     assert(Section);
 167     return SectionSym;
 168   }
 169
 170   MCSymbol *getLabelBegin() const {
 171     assert(Section);
 172     return LabelBegin;
 173   }
 174
 175   MCSymbol *getLabelEnd() const {
 176     assert(Section);
 177     return LabelEnd;
 178   }
 179
 180   // Accessors.
 181   unsigned getUniqueID() const { return UniqueID; }
 182   uint16_t getLanguage() const { return CUNode.getLanguage(); }
 183   DICompileUnit getCUNode() const { return CUNode; }
 184   DIE &getUnitDie() { return UnitDie; }
 185   const StringMap<const DIE *> &getGlobalNames() const { return GlobalNames; }
 186   const StringMap<const DIE *> &getGlobalTypes() const { return GlobalTypes; }
 187
 188   unsigned getDebugInfoOffset() const { return DebugInfoOffset; }
 189   void setDebugInfoOffset(unsigned DbgInfoOff) { DebugInfoOffset = DbgInfoOff; }
 190
 191   /// hasContent - Return true if this compile unit has something to write out.
 192   bool hasContent() const { return !UnitDie.getChildren().empty(); }
 193
 194   /// getRanges - Get the list of ranges for this unit.
 195   const SmallVectorImpl<RangeSpan> &getRanges() const { return CURanges; }
 196   SmallVectorImpl<RangeSpan> &getRanges() { return CURanges; }
 197
 198   /// addRangeList - Add an address range list to the list of range lists.
 199   void addRangeList(RangeSpanList Ranges) {
 200     CURangeLists.push_back(std::move(Ranges));
 201   }
 202
 203   /// getRangeLists - Get the vector of range lists.
 204   const SmallVectorImpl<RangeSpanList> &getRangeLists() const {
 205     return CURangeLists;
 206   }
 207   SmallVectorImpl<RangeSpanList> &getRangeLists() { return CURangeLists; }
 208
 209   /// getParentContextString - Get a string containing the language specific
 210   /// context for a global name.
 211   std::string getParentContextString(DIScope Context) const;
 212
 213   /// addGlobalName - Add a new global entity to the compile unit.
 214   ///
 215   void addGlobalName(StringRef Name, DIE &Die, DIScope Context);
 216
 217   /// addAccelNamespace - Add a new name to the namespace accelerator table.
 218   void addAccelNamespace(StringRef Name, const DIE &Die);
 219
 220   /// getDIE - Returns the debug information entry map slot for the
 221   /// specified debug variable. We delegate the request to DwarfDebug
 222   /// when the MDNode can be part of the type system, since DIEs for
 223   /// the type system can be shared across CUs and the mappings are
 224   /// kept in DwarfDebug.
 225   DIE *getDIE(DIDescriptor D) const;
 226
 227   /// getDIELoc - Returns a fresh newly allocated DIELoc.
 228   DIELoc *getDIELoc() { return new (DIEValueAllocator) DIELoc(); }
 229
 230   /// insertDIE - Insert DIE into the map. We delegate the request to DwarfDebug
 231   /// when the MDNode can be part of the type system, since DIEs for
 232   /// the type system can be shared across CUs and the mappings are
 233   /// kept in DwarfDebug.
 234   void insertDIE(DIDescriptor Desc, DIE *D);
 235
 236   /// addFlag - Add a flag that is true to the DIE.
 237   void addFlag(DIE &Die, dwarf::Attribute Attribute);
 238
 239   /// addUInt - Add an unsigned integer attribute data and value.
 240   void addUInt(DIE &Die, dwarf::Attribute Attribute, Optional<dwarf::Form> Form,
 241                uint64_t Integer);
 242
 243   void addUInt(DIE &Block, dwarf::Form Form, uint64_t Integer);
 244
 245   /// addSInt - Add an signed integer attribute data and value.
 246   void addSInt(DIE &Die, dwarf::Attribute Attribute, Optional<dwarf::Form> Form,
 247                int64_t Integer);
 248
 249   void addSInt(DIELoc &Die, Optional<dwarf::Form> Form, int64_t Integer);
 250
 251   /// addString - Add a string attribute data and value.
 252   void addString(DIE &Die, dwarf::Attribute Attribute, StringRef Str);
 253
 254   /// addLocalString - Add a string attribute data and value.
 255   void addLocalString(DIE &Die, dwarf::Attribute Attribute,
 256                       StringRef Str);
 257
 258   /// addExpr - Add a Dwarf expression attribute data and value.
 259   void addExpr(DIELoc &Die, dwarf::Form Form, const MCExpr *Expr);
 260
 261   /// addLabel - Add a Dwarf label attribute data and value.
 262   void addLabel(DIE &Die, dwarf::Attribute Attribute, dwarf::Form Form,
 263                 const MCSymbol *Label);
 264
 265   void addLabel(DIELoc &Die, dwarf::Form Form, const MCSymbol *Label);
 266
 267   /// addLocationList - Add a Dwarf loclistptr attribute data and value.
 268   void addLocationList(DIE &Die, dwarf::Attribute Attribute, unsigned Index);
 269
 270   /// addSectionOffset - Add an offset into a section attribute data and value.
 271   ///
 272   void addSectionOffset(DIE &Die, dwarf::Attribute Attribute, uint64_t Integer);
 273
 274   /// addOpAddress - Add a dwarf op address data and value using the
 275   /// form given and an op of either DW_FORM_addr or DW_FORM_GNU_addr_index.
 276   void addOpAddress(DIELoc &Die, const MCSymbol *Label);
 277
 278   /// addLabelDelta - Add a label delta attribute data and value.
 279   void addLabelDelta(DIE &Die, dwarf::Attribute Attribute, const MCSymbol *Hi,
 280                      const MCSymbol *Lo);
 281
 282   /// addDIEEntry - Add a DIE attribute data and value.
 283   void addDIEEntry(DIE &Die, dwarf::Attribute Attribute, DIE &Entry);
 284
 285   /// addDIEEntry - Add a DIE attribute data and value.
 286   void addDIEEntry(DIE &Die, dwarf::Attribute Attribute, DIEEntry *Entry);
 287
 288   void addDIETypeSignature(DIE &Die, const DwarfTypeUnit &Type);
 289
 290   /// addBlock - Add block data.
 291   void addBlock(DIE &Die, dwarf::Attribute Attribute, DIELoc *Block);
 292
 293   /// addBlock - Add block data.
 294   void addBlock(DIE &Die, dwarf::Attribute Attribute, DIEBlock *Block);
 295
 296   /// addSourceLine - Add location information to specified debug information
 297   /// entry.
 298   void addSourceLine(DIE &Die, unsigned Line, StringRef File,
 299                      StringRef Directory);
 300   void addSourceLine(DIE &Die, DIVariable V);
 301   void addSourceLine(DIE &Die, DIGlobalVariable G);
 302   void addSourceLine(DIE &Die, DISubprogram SP);
 303   void addSourceLine(DIE &Die, DIType Ty);
 304   void addSourceLine(DIE &Die, DINameSpace NS);
 305   void addSourceLine(DIE &Die, DIObjCProperty Ty);
 306
 307   /// addAddress - Add an address attribute to a die based on the location
 308   /// provided.
 309   void addAddress(DIE &Die, dwarf::Attribute Attribute,
 310                   const MachineLocation &Location, bool Indirect = false);
 311
 312   /// addConstantValue - Add constant value entry in variable DIE.
 313   void addConstantValue(DIE &Die, const MachineOperand &MO, DIType Ty);
 314   void addConstantValue(DIE &Die, const ConstantInt *CI, DIType Ty);
 315   void addConstantValue(DIE &Die, const APInt &Val, DIType Ty);
 316   void addConstantValue(DIE &Die, const APInt &Val, bool Unsigned);
 317   void addConstantValue(DIE &Die, bool Unsigned, uint64_t Val);
 318
 319   /// addConstantFPValue - Add constant value entry in variable DIE.
 320   void addConstantFPValue(DIE &Die, const MachineOperand &MO);
 321   void addConstantFPValue(DIE &Die, const ConstantFP *CFP);
 322
 323   /// addTemplateParams - Add template parameters in buffer.
 324   void addTemplateParams(DIE &Buffer, DIArray TParams);
 325
 326   /// addRegisterOp - Add register operand.
 327   void addRegisterOpPiece(DIELoc &TheDie, unsigned Reg,
 328                           unsigned SizeInBits = 0, unsigned OffsetInBits = 0);
 329
 330   /// addRegisterOffset - Add register offset.
 331   void addRegisterOffset(DIELoc &TheDie, unsigned Reg, int64_t Offset);
 332
 333   /// addComplexAddress - Start with the address based on the location provided,
 334   /// and generate the DWARF information necessary to find the actual variable
 335   /// (navigating the extra location information encoded in the type) based on
 336   /// the starting location.  Add the DWARF information to the die.
 337   void addComplexAddress(const DbgVariable &DV, DIE &Die,
 338                          dwarf::Attribute Attribute,
 339                          const MachineLocation &Location);
 340
 341   // FIXME: Should be reformulated in terms of addComplexAddress.
 342   /// addBlockByrefAddress - Start with the address based on the location
 343   /// provided, and generate the DWARF information necessary to find the
 344   /// actual Block variable (navigating the Block struct) based on the
 345   /// starting location.  Add the DWARF information to the die.  Obsolete,
 346   /// please use addComplexAddress instead.
 347   void addBlockByrefAddress(const DbgVariable &DV, DIE &Die,
 348                             dwarf::Attribute Attribute,
 349                             const MachineLocation &Location);
 350
 351   /// addVariableAddress - Add DW_AT_location attribute for a
 352   /// DbgVariable based on provided MachineLocation.
 353   void addVariableAddress(const DbgVariable &DV, DIE &Die,
 354                           MachineLocation Location);
 355
 356   /// addType - Add a new type attribute to the specified entity. This takes
 357   /// and attribute parameter because DW_AT_friend attributes are also
 358   /// type references.
 359   void addType(DIE &Entity, DIType Ty,
 360                dwarf::Attribute Attribute = dwarf::DW_AT_type);
 361
 362   /// getOrCreateNameSpace - Create a DIE for DINameSpace.
 363   DIE *getOrCreateNameSpace(DINameSpace NS);
 364
 365   /// getOrCreateSubprogramDIE - Create new DIE using SP.
 366   DIE *getOrCreateSubprogramDIE(DISubprogram SP);
 367
 368   void applySubprogramAttributes(DISubprogram SP, DIE &SPDie);
 369   void applySubprogramAttributesToDefinition(DISubprogram SP, DIE &SPDie);
 370   void applyVariableAttributes(const DbgVariable &Var, DIE &VariableDie);
 371
 372   /// getOrCreateTypeDIE - Find existing DIE or create new DIE for the
 373   /// given DIType.
 374   DIE *getOrCreateTypeDIE(const MDNode *N);
 375
 376   /// getOrCreateContextDIE - Get context owner's DIE.
 377   DIE *createTypeDIE(DICompositeType Ty);
 378
 379   /// getOrCreateContextDIE - Get context owner's DIE.
 380   DIE *getOrCreateContextDIE(DIScope Context);
 381
 382   /// constructContainingTypeDIEs - Construct DIEs for types that contain
 383   /// vtables.
 384   void constructContainingTypeDIEs();
 385
 386   /// constructSubprogramArguments - Construct function argument DIEs.
 387   void constructSubprogramArguments(DIE &Buffer, DITypeArray Args);
 388
 389   /// Create a DIE with the given Tag, add the DIE to its parent, and
 390   /// call insertDIE if MD is not null.
 391   DIE &createAndAddDIE(unsigned Tag, DIE &Parent,
 392                        DIDescriptor N = DIDescriptor());
 393
 394   /// Compute the size of a header for this unit, not including the initial
 395   /// length field.
 396   virtual unsigned getHeaderSize() const {
 397     return sizeof(int16_t) + // DWARF version number
 398            sizeof(int32_t) + // Offset Into Abbrev. Section
 399            sizeof(int8_t);   // Pointer Size (in bytes)
 400   }
 401
 402   /// Emit the header for this unit, not including the initial length field.
 403   virtual void emitHeader(const MCSymbol *ASectionSym) const;
 404
 405   virtual DwarfCompileUnit &getCU() = 0;
 406
 407   /// constructTypeDIE - Construct type DIE from DICompositeType.
 408   void constructTypeDIE(DIE &Buffer, DICompositeType CTy);
 409
 410 protected:
 411   /// getOrCreateStaticMemberDIE - Create new static data member DIE.
 412   DIE *getOrCreateStaticMemberDIE(DIDerivedType DT);
 413
 414   /// Look up the source ID with the given directory and source file names. If
 415   /// none currently exists, create a new ID and insert it in the line table.
 416   virtual unsigned getOrCreateSourceID(StringRef File, StringRef Directory) = 0;
 417
 418   /// resolve - Look in the DwarfDebug map for the MDNode that
 419   /// corresponds to the reference.
 420   template <typename T> T resolve(DIRef<T> Ref) const {
 421     return DD->resolve(Ref);
 422   }
 423
 424 private:
 425   /// constructTypeDIE - Construct basic type die from DIBasicType.
 426   void constructTypeDIE(DIE &Buffer, DIBasicType BTy);
 427
 428   /// constructTypeDIE - Construct derived type die from DIDerivedType.
 429   void constructTypeDIE(DIE &Buffer, DIDerivedType DTy);
 430
 431   /// constructSubrangeDIE - Construct subrange DIE from DISubrange.
 432   void constructSubrangeDIE(DIE &Buffer, DISubrange SR, DIE *IndexTy);
 433
 434   /// constructArrayTypeDIE - Construct array type DIE from DICompositeType.
 435   void constructArrayTypeDIE(DIE &Buffer, DICompositeType CTy);
 436
 437   /// constructEnumTypeDIE - Construct enum type DIE from DIEnumerator.
 438   void constructEnumTypeDIE(DIE &Buffer, DICompositeType CTy);
 439
 440   /// constructMemberDIE - Construct member DIE from DIDerivedType.
 441   void constructMemberDIE(DIE &Buffer, DIDerivedType DT);
 442
 443   /// constructTemplateTypeParameterDIE - Construct new DIE for the given
 444   /// DITemplateTypeParameter.
 445   void constructTemplateTypeParameterDIE(DIE &Buffer,
 446                                          DITemplateTypeParameter TP);
 447
 448   /// constructTemplateValueParameterDIE - Construct new DIE for the given
 449   /// DITemplateValueParameter.
 450   void constructTemplateValueParameterDIE(DIE &Buffer,
 451                                           DITemplateValueParameter TVP);
 452
 453   /// getLowerBoundDefault - Return the default lower bound for an array. If the
 454   /// DWARF version doesn't handle the language, return -1.
 455   int64_t getDefaultLowerBound() const;
 456
 457   /// getDIEEntry - Returns the debug information entry for the specified
 458   /// debug variable.
 459   DIEEntry *getDIEEntry(const MDNode *N) const {
 460     return MDNodeToDIEEntryMap.lookup(N);
 461   }
 462
 463   /// insertDIEEntry - Insert debug information entry into the map.
 464   void insertDIEEntry(const MDNode *N, DIEEntry *E) {
 465     MDNodeToDIEEntryMap.insert(std::make_pair(N, E));
 466   }
 467
 468   // getIndexTyDie - Get an anonymous type for index type.
 469   DIE *getIndexTyDie() { return IndexTyDie; }
 470
 471   // setIndexTyDie - Set D as anonymous type for index which can be reused
 472   // later.
 473   void setIndexTyDie(DIE *D) { IndexTyDie = D; }
 474
 475   /// createDIEEntry - Creates a new DIEEntry to be a proxy for a debug
 476   /// information entry.
 477   DIEEntry *createDIEEntry(DIE &Entry);
 478
 479   /// If this is a named finished type then include it in the list of types for
 480   /// the accelerator tables.
 481   void updateAcceleratorTables(DIScope Context, DIType Ty, const DIE &TyDIE);
 482 };
 483
 484 class DwarfTypeUnit : public DwarfUnit {
 485 private:
 486   uint64_t TypeSignature;
 487   const DIE *Ty;
 488   DwarfCompileUnit &CU;
 489   MCDwarfDwoLineTable *SplitLineTable;
 490
 491 public:
 492   DwarfTypeUnit(unsigned UID, DwarfCompileUnit &CU, AsmPrinter *A,
 493                 DwarfDebug *DW, DwarfFile *DWU,
 494                 MCDwarfDwoLineTable *SplitLineTable = nullptr);
 495
 496   void setTypeSignature(uint64_t Signature) { TypeSignature = Signature; }
 497   uint64_t getTypeSignature() const { return TypeSignature; }
 498   void setType(const DIE *Ty) { this->Ty = Ty; }
 499
 500   /// Emit the header for this unit, not including the initial length field.
 501   void emitHeader(const MCSymbol *ASectionSym) const override;
 502   unsigned getHeaderSize() const override {
 503     return DwarfUnit::getHeaderSize() + sizeof(uint64_t) + // Type Signature
 504            sizeof(uint32_t);                               // Type DIE Offset
 505   }
 506   void initSection(const MCSection *Section);
 507   // Bring in the base function (taking two args, including the section symbol)
 508   // for use when building DWO type units (they don't go in unique comdat
 509   // sections)
 510   using DwarfUnit::initSection;
 511   DwarfCompileUnit &getCU() override { return CU; }
 512
 513 protected:
 514   unsigned getOrCreateSourceID(StringRef File, StringRef Directory) override;
 515 };
 516 } // end llvm namespace
 517 #endif