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