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