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