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