lib/CodeGen/AsmPrinter/DwarfDebug.h

   1 //===- llvm/CodeGen/DwarfDebug.h - Dwarf Debug Framework --------*- 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 debug info into asm files.
  11 //
  12 //===----------------------------------------------------------------------===//
  13
  14 #ifndef LLVM_LIB_CODEGEN_ASMPRINTER_DWARFDEBUG_H
  15 #define LLVM_LIB_CODEGEN_ASMPRINTER_DWARFDEBUG_H
  16
  17 #include "AddressPool.h"
  18 #include "DbgValueHistoryCalculator.h"
  19 #include "DebugHandlerBase.h"
  20 #include "DebugLocStream.h"
  21 #include "DwarfFile.h"
  22 #include "llvm/ADT/ArrayRef.h"
  23 #include "llvm/ADT/DenseMap.h"
  24 #include "llvm/ADT/DenseSet.h"
  25 #include "llvm/ADT/MapVector.h"
  26 #include "llvm/ADT/STLExtras.h"
  27 #include "llvm/ADT/SetVector.h"
  28 #include "llvm/ADT/SmallPtrSet.h"
  29 #include "llvm/ADT/SmallVector.h"
  30 #include "llvm/ADT/StringMap.h"
  31 #include "llvm/ADT/StringRef.h"
  32 #include "llvm/BinaryFormat/Dwarf.h"
  33 #include "llvm/CodeGen/AccelTable.h"
  34 #include "llvm/CodeGen/MachineInstr.h"
  35 #include "llvm/IR/DebugInfoMetadata.h"
  36 #include "llvm/IR/DebugLoc.h"
  37 #include "llvm/IR/Metadata.h"
  38 #include "llvm/MC/MCDwarf.h"
  39 #include "llvm/Support/Allocator.h"
  40 #include "llvm/Target/TargetOptions.h"
  41 #include <cassert>
  42 #include <cstdint>
  43 #include <limits>
  44 #include <memory>
  45 #include <utility>
  46 #include <vector>
  47
  48 namespace llvm {
  49
  50 class AsmPrinter;
  51 class ByteStreamer;
  52 class DebugLocEntry;
  53 class DIE;
  54 class DwarfCompileUnit;
  55 class DwarfTypeUnit;
  56 class DwarfUnit;
  57 class LexicalScope;
  58 class MachineFunction;
  59 class MCSection;
  60 class MCSymbol;
  61 class MDNode;
  62 class Module;
  63
  64 //===----------------------------------------------------------------------===//
  65 /// This class is used to track local variable information.
  66 ///
  67 /// Variables can be created from allocas, in which case they're generated from
  68 /// the MMI table.  Such variables can have multiple expressions and frame
  69 /// indices.
  70 ///
  71 /// Variables can be created from \c DBG_VALUE instructions.  Those whose
  72 /// location changes over time use \a DebugLocListIndex, while those with a
  73 /// single instruction use \a MInsn and (optionally) a single entry of \a Expr.
  74 ///
  75 /// Variables that have been optimized out use none of these fields.
  76 class DbgVariable {
  77   const DILocalVariable *Var;                /// Variable Descriptor.
  78   const DILocation *IA;                      /// Inlined at location.
  79   DIE *TheDIE = nullptr;                     /// Variable DIE.
  80   unsigned DebugLocListIndex = ~0u;          /// Offset in DebugLocs.
  81   const MachineInstr *MInsn = nullptr;       /// DBG_VALUE instruction.
  82
  83   struct FrameIndexExpr {
  84     int FI;
  85     const DIExpression *Expr;
  86   };
  87   mutable SmallVector<FrameIndexExpr, 1>
  88       FrameIndexExprs; /// Frame index + expression.
  89
  90 public:
  91   /// Construct a DbgVariable.
  92   ///
  93   /// Creates a variable without any DW_AT_location.  Call \a initializeMMI()
  94   /// for MMI entries, or \a initializeDbgValue() for DBG_VALUE instructions.
  95   DbgVariable(const DILocalVariable *V, const DILocation *IA)
  96       : Var(V), IA(IA) {}
  97
  98   /// Initialize from the MMI table.
  99   void initializeMMI(const DIExpression *E, int FI) {
 100     assert(FrameIndexExprs.empty() && "Already initialized?");
 101     assert(!MInsn && "Already initialized?");
 102
 103     assert((!E || E->isValid()) && "Expected valid expression");
 104     assert(FI != std::numeric_limits<int>::max() && "Expected valid index");
 105
 106     FrameIndexExprs.push_back({FI, E});
 107   }
 108
 109   /// Initialize from a DBG_VALUE instruction.
 110   void initializeDbgValue(const MachineInstr *DbgValue) {
 111     assert(FrameIndexExprs.empty() && "Already initialized?");
 112     assert(!MInsn && "Already initialized?");
 113
 114     assert(Var == DbgValue->getDebugVariable() && "Wrong variable");
 115     assert(IA == DbgValue->getDebugLoc()->getInlinedAt() && "Wrong inlined-at");
 116
 117     MInsn = DbgValue;
 118     if (auto *E = DbgValue->getDebugExpression())
 119       if (E->getNumElements())
 120         FrameIndexExprs.push_back({0, E});
 121   }
 122
 123   // Accessors.
 124   const DILocalVariable *getVariable() const { return Var; }
 125   const DILocation *getInlinedAt() const { return IA; }
 126
 127   const DIExpression *getSingleExpression() const {
 128     assert(MInsn && FrameIndexExprs.size() <= 1);
 129     return FrameIndexExprs.size() ? FrameIndexExprs[0].Expr : nullptr;
 130   }
 131
 132   void setDIE(DIE &D) { TheDIE = &D; }
 133   DIE *getDIE() const { return TheDIE; }
 134   void setDebugLocListIndex(unsigned O) { DebugLocListIndex = O; }
 135   unsigned getDebugLocListIndex() const { return DebugLocListIndex; }
 136   StringRef getName() const { return Var->getName(); }
 137   const MachineInstr *getMInsn() const { return MInsn; }
 138   /// Get the FI entries, sorted by fragment offset.
 139   ArrayRef<FrameIndexExpr> getFrameIndexExprs() const;
 140   bool hasFrameIndexExprs() const { return !FrameIndexExprs.empty(); }
 141   void addMMIEntry(const DbgVariable &V);
 142
 143   // Translate tag to proper Dwarf tag.
 144   dwarf::Tag getTag() const {
 145     // FIXME: Why don't we just infer this tag and store it all along?
 146     if (Var->isParameter())
 147       return dwarf::DW_TAG_formal_parameter;
 148
 149     return dwarf::DW_TAG_variable;
 150   }
 151
 152   /// Return true if DbgVariable is artificial.
 153   bool isArtificial() const {
 154     if (Var->isArtificial())
 155       return true;
 156     if (getType()->isArtificial())
 157       return true;
 158     return false;
 159   }
 160
 161   bool isObjectPointer() const {
 162     if (Var->isObjectPointer())
 163       return true;
 164     if (getType()->isObjectPointer())
 165       return true;
 166     return false;
 167   }
 168
 169   bool hasComplexAddress() const {
 170     assert(MInsn && "Expected DBG_VALUE, not MMI variable");
 171     assert((FrameIndexExprs.empty() ||
 172             (FrameIndexExprs.size() == 1 &&
 173              FrameIndexExprs[0].Expr->getNumElements())) &&
 174            "Invalid Expr for DBG_VALUE");
 175     return !FrameIndexExprs.empty();
 176   }
 177
 178   bool isBlockByrefVariable() const;
 179   const DIType *getType() const;
 180
 181 private:
 182   template <typename T> T *resolve(TypedDINodeRef<T> Ref) const {
 183     return Ref.resolve();
 184   }
 185 };
 186
 187 /// Helper used to pair up a symbol and its DWARF compile unit.
 188 struct SymbolCU {
 189   SymbolCU(DwarfCompileUnit *CU, const MCSymbol *Sym) : Sym(Sym), CU(CU) {}
 190
 191   const MCSymbol *Sym;
 192   DwarfCompileUnit *CU;
 193 };
 194
 195 /// Collects and handles dwarf debug information.
 196 class DwarfDebug : public DebugHandlerBase {
 197   /// All DIEValues are allocated through this allocator.
 198   BumpPtrAllocator DIEValueAllocator;
 199
 200   /// Maps MDNode with its corresponding DwarfCompileUnit.
 201   MapVector<const MDNode *, DwarfCompileUnit *> CUMap;
 202
 203   /// Maps a CU DIE with its corresponding DwarfCompileUnit.
 204   DenseMap<const DIE *, DwarfCompileUnit *> CUDieMap;
 205
 206   /// List of all labels used in aranges generation.
 207   std::vector<SymbolCU> ArangeLabels;
 208
 209   /// Size of each symbol emitted (for those symbols that have a specific size).
 210   DenseMap<const MCSymbol *, uint64_t> SymSize;
 211
 212   /// Collection of abstract variables.
 213   SmallVector<std::unique_ptr<DbgVariable>, 64> ConcreteVariables;
 214
 215   /// Collection of DebugLocEntry. Stored in a linked list so that DIELocLists
 216   /// can refer to them in spite of insertions into this list.
 217   DebugLocStream DebugLocs;
 218
 219   /// This is a collection of subprogram MDNodes that are processed to
 220   /// create DIEs.
 221   SetVector<const DISubprogram *, SmallVector<const DISubprogram *, 16>,
 222             SmallPtrSet<const DISubprogram *, 16>>
 223       ProcessedSPNodes;
 224
 225   /// If nonnull, stores the current machine function we're processing.
 226   const MachineFunction *CurFn = nullptr;
 227
 228   /// If nonnull, stores the CU in which the previous subprogram was contained.
 229   const DwarfCompileUnit *PrevCU;
 230
 231   /// As an optimization, there is no need to emit an entry in the directory
 232   /// table for the same directory as DW_AT_comp_dir.
 233   StringRef CompilationDir;
 234
 235   /// Holder for the file specific debug information.
 236   DwarfFile InfoHolder;
 237
 238   /// Holders for the various debug information flags that we might need to
 239   /// have exposed. See accessor functions below for description.
 240
 241   /// Map from MDNodes for user-defined types to their type signatures. Also
 242   /// used to keep track of which types we have emitted type units for.
 243   DenseMap<const MDNode *, uint64_t> TypeSignatures;
 244
 245   SmallVector<
 246       std::pair<std::unique_ptr<DwarfTypeUnit>, const DICompositeType *>, 1>
 247       TypeUnitsUnderConstruction;
 248
 249   /// Whether to use the GNU TLS opcode (instead of the standard opcode).
 250   bool UseGNUTLSOpcode;
 251
 252   /// Whether to use DWARF 2 bitfields (instead of the DWARF 4 format).
 253   bool UseDWARF2Bitfields;
 254
 255   /// Whether to emit all linkage names, or just abstract subprograms.
 256   bool UseAllLinkageNames;
 257
 258   /// DWARF5 Experimental Options
 259   /// @{
 260   bool HasDwarfAccelTables;
 261   bool HasAppleExtensionAttributes;
 262   bool HasSplitDwarf;
 263
 264   /// Whether to generate the DWARF v5 string offsets table.
 265   /// It consists of a series of contributions, each preceded by a header.
 266   /// The pre-DWARF v5 string offsets table for split dwarf is, in contrast,
 267   /// a monolithic sequence of string offsets.
 268   bool UseSegmentedStringOffsetsTable;
 269
 270   /// Separated Dwarf Variables
 271   /// In general these will all be for bits that are left in the
 272   /// original object file, rather than things that are meant
 273   /// to be in the .dwo sections.
 274
 275   /// Holder for the skeleton information.
 276   DwarfFile SkeletonHolder;
 277
 278   /// Store file names for type units under fission in a line table
 279   /// header that will be emitted into debug_line.dwo.
 280   // FIXME: replace this with a map from comp_dir to table so that we
 281   // can emit multiple tables during LTO each of which uses directory
 282   // 0, referencing the comp_dir of all the type units that use it.
 283   MCDwarfDwoLineTable SplitTypeUnitFileTable;
 284   /// @}
 285
 286   /// True iff there are multiple CUs in this module.
 287   bool SingleCU;
 288   bool IsDarwin;
 289
 290   AddressPool AddrPool;
 291
 292   /// Apple accelerator tables.
 293   AppleAccelTable<AppleAccelTableOffsetData> AccelNames;
 294   AppleAccelTable<AppleAccelTableOffsetData> AccelObjC;
 295   AppleAccelTable<AppleAccelTableOffsetData> AccelNamespace;
 296   AppleAccelTable<AppleAccelTableTypeData> AccelTypes;
 297
 298   // Identify a debugger for "tuning" the debug info.
 299   DebuggerKind DebuggerTuning = DebuggerKind::Default;
 300
 301   MCDwarfDwoLineTable *getDwoLineTable(const DwarfCompileUnit &);
 302
 303   const SmallVectorImpl<std::unique_ptr<DwarfCompileUnit>> &getUnits() {
 304     return InfoHolder.getUnits();
 305   }
 306
 307   using InlinedVariable = DbgValueHistoryMap::InlinedVariable;
 308
 309   void ensureAbstractVariableIsCreated(DwarfCompileUnit &CU, InlinedVariable Var,
 310                                        const MDNode *Scope);
 311   void ensureAbstractVariableIsCreatedIfScoped(DwarfCompileUnit &CU, InlinedVariable Var,
 312                                                const MDNode *Scope);
 313
 314   DbgVariable *createConcreteVariable(DwarfCompileUnit &TheCU,
 315                                       LexicalScope &Scope, InlinedVariable IV);
 316
 317   /// Construct a DIE for this abstract scope.
 318   void constructAbstractSubprogramScopeDIE(DwarfCompileUnit &SrcCU, LexicalScope *Scope);
 319
 320   void finishVariableDefinitions();
 321
 322   void finishSubprogramDefinitions();
 323
 324   /// Finish off debug information after all functions have been
 325   /// processed.
 326   void finalizeModuleInfo();
 327
 328   /// Emit the debug info section.
 329   void emitDebugInfo();
 330
 331   /// Emit the abbreviation section.
 332   void emitAbbreviations();
 333
 334   /// Emit the string offsets table header.
 335   void emitStringOffsetsTableHeader();
 336
 337   /// Emit a specified accelerator table.
 338   template <typename AccelTableT>
 339   void emitAccel(AccelTableT &Accel, MCSection *Section, StringRef TableName);
 340
 341   /// Emit visible names into a hashed accelerator table section.
 342   void emitAccelNames();
 343
 344   /// Emit objective C classes and categories into a hashed
 345   /// accelerator table section.
 346   void emitAccelObjC();
 347
 348   /// Emit namespace dies into a hashed accelerator table.
 349   void emitAccelNamespaces();
 350
 351   /// Emit type dies into a hashed accelerator table.
 352   void emitAccelTypes();
 353
 354   /// Emit visible names and types into debug pubnames and pubtypes sections.
 355   void emitDebugPubSections();
 356
 357   void emitDebugPubSection(bool GnuStyle, StringRef Name,
 358                            DwarfCompileUnit *TheU,
 359                            const StringMap<const DIE *> &Globals);
 360
 361   /// Emit null-terminated strings into a debug str section.
 362   void emitDebugStr();
 363
 364   /// Emit variable locations into a debug loc section.
 365   void emitDebugLoc();
 366
 367   /// Emit variable locations into a debug loc dwo section.
 368   void emitDebugLocDWO();
 369
 370   /// Emit address ranges into a debug aranges section.
 371   void emitDebugARanges();
 372
 373   /// Emit address ranges into a debug ranges section.
 374   void emitDebugRanges();
 375
 376   /// Emit macros into a debug macinfo section.
 377   void emitDebugMacinfo();
 378   void emitMacro(DIMacro &M);
 379   void emitMacroFile(DIMacroFile &F, DwarfCompileUnit &U);
 380   void handleMacroNodes(DIMacroNodeArray Nodes, DwarfCompileUnit &U);
 381
 382   /// DWARF 5 Experimental Split Dwarf Emitters
 383
 384   /// Initialize common features of skeleton units.
 385   void initSkeletonUnit(const DwarfUnit &U, DIE &Die,
 386                         std::unique_ptr<DwarfCompileUnit> NewU);
 387
 388   /// Construct the split debug info compile unit for the debug info
 389   /// section.
 390   DwarfCompileUnit &constructSkeletonCU(const DwarfCompileUnit &CU);
 391
 392   /// Emit the debug info dwo section.
 393   void emitDebugInfoDWO();
 394
 395   /// Emit the debug abbrev dwo section.
 396   void emitDebugAbbrevDWO();
 397
 398   /// Emit the debug line dwo section.
 399   void emitDebugLineDWO();
 400
 401   /// Emit the dwo stringoffsets table header.
 402   void emitStringOffsetsTableHeaderDWO();
 403
 404   /// Emit the debug str dwo section.
 405   void emitDebugStrDWO();
 406
 407   /// Flags to let the linker know we have emitted new style pubnames. Only
 408   /// emit it here if we don't have a skeleton CU for split dwarf.
 409   void addGnuPubAttributes(DwarfCompileUnit &U, DIE &D) const;
 410
 411   /// Create new DwarfCompileUnit for the given metadata node with tag
 412   /// DW_TAG_compile_unit.
 413   DwarfCompileUnit &getOrCreateDwarfCompileUnit(const DICompileUnit *DIUnit);
 414
 415   /// Construct imported_module or imported_declaration DIE.
 416   void constructAndAddImportedEntityDIE(DwarfCompileUnit &TheCU,
 417                                         const DIImportedEntity *N);
 418
 419   /// Register a source line with debug info. Returns the unique
 420   /// label that was emitted and which provides correspondence to the
 421   /// source line list.
 422   void recordSourceLine(unsigned Line, unsigned Col, const MDNode *Scope,
 423                         unsigned Flags);
 424
 425   /// Populate LexicalScope entries with variables' info.
 426   void collectVariableInfo(DwarfCompileUnit &TheCU, const DISubprogram *SP,
 427                            DenseSet<InlinedVariable> &ProcessedVars);
 428
 429   /// Build the location list for all DBG_VALUEs in the
 430   /// function that describe the same variable.
 431   void buildLocationList(SmallVectorImpl<DebugLocEntry> &DebugLoc,
 432                          const DbgValueHistoryMap::InstrRanges &Ranges);
 433
 434   /// Collect variable information from the side table maintained by MF.
 435   void collectVariableInfoFromMFTable(DwarfCompileUnit &TheCU,
 436                                       DenseSet<InlinedVariable> &P);
 437
 438 protected:
 439   /// Gather pre-function debug information.
 440   void beginFunctionImpl(const MachineFunction *MF) override;
 441
 442   /// Gather and emit post-function debug information.
 443   void endFunctionImpl(const MachineFunction *MF) override;
 444
 445   void skippedNonDebugFunction() override;
 446
 447 public:
 448   //===--------------------------------------------------------------------===//
 449   // Main entry points.
 450   //
 451   DwarfDebug(AsmPrinter *A, Module *M);
 452
 453   ~DwarfDebug() override;
 454
 455   /// Emit all Dwarf sections that should come prior to the
 456   /// content.
 457   void beginModule();
 458
 459   /// Emit all Dwarf sections that should come after the content.
 460   void endModule() override;
 461
 462   /// Process beginning of an instruction.
 463   void beginInstruction(const MachineInstr *MI) override;
 464
 465   /// Perform an MD5 checksum of \p Identifier and return the lower 64 bits.
 466   static uint64_t makeTypeSignature(StringRef Identifier);
 467
 468   /// Add a DIE to the set of types that we're going to pull into
 469   /// type units.
 470   void addDwarfTypeUnitType(DwarfCompileUnit &CU, StringRef Identifier,
 471                             DIE &Die, const DICompositeType *CTy);
 472
 473   /// Add a label so that arange data can be generated for it.
 474   void addArangeLabel(SymbolCU SCU) { ArangeLabels.push_back(SCU); }
 475
 476   /// For symbols that have a size designated (e.g. common symbols),
 477   /// this tracks that size.
 478   void setSymbolSize(const MCSymbol *Sym, uint64_t Size) override {
 479     SymSize[Sym] = Size;
 480   }
 481
 482   /// Returns whether we should emit all DW_AT_[MIPS_]linkage_name.
 483   /// If not, we still might emit certain cases.
 484   bool useAllLinkageNames() const { return UseAllLinkageNames; }
 485
 486   /// Returns whether to use DW_OP_GNU_push_tls_address, instead of the
 487   /// standard DW_OP_form_tls_address opcode
 488   bool useGNUTLSOpcode() const { return UseGNUTLSOpcode; }
 489
 490   /// Returns whether to use the DWARF2 format for bitfields instyead of the
 491   /// DWARF4 format.
 492   bool useDWARF2Bitfields() const { return UseDWARF2Bitfields; }
 493
 494   // Experimental DWARF5 features.
 495
 496   /// Returns whether or not to emit tables that dwarf consumers can
 497   /// use to accelerate lookup.
 498   bool useDwarfAccelTables() const { return HasDwarfAccelTables; }
 499
 500   bool useAppleExtensionAttributes() const {
 501     return HasAppleExtensionAttributes;
 502   }
 503
 504   /// Returns whether or not to change the current debug info for the
 505   /// split dwarf proposal support.
 506   bool useSplitDwarf() const { return HasSplitDwarf; }
 507
 508   /// Returns whether to generate a string offsets table with (possibly shared)
 509   /// contributions from each CU and type unit. This implies the use of
 510   /// DW_FORM_strx* indirect references with DWARF v5 and beyond. Note that
 511   /// DW_FORM_GNU_str_index is also an indirect reference, but it is used with
 512   /// a pre-DWARF v5 implementation of split DWARF sections, which uses a
 513   /// monolithic string offsets table.
 514   bool useSegmentedStringOffsetsTable() const {
 515     return UseSegmentedStringOffsetsTable;
 516   }
 517
 518   bool shareAcrossDWOCUs() const;
 519
 520   /// Returns the Dwarf Version.
 521   uint16_t getDwarfVersion() const;
 522
 523   /// Returns the previous CU that was being updated
 524   const DwarfCompileUnit *getPrevCU() const { return PrevCU; }
 525   void setPrevCU(const DwarfCompileUnit *PrevCU) { this->PrevCU = PrevCU; }
 526
 527   /// Returns the entries for the .debug_loc section.
 528   const DebugLocStream &getDebugLocs() const { return DebugLocs; }
 529
 530   /// Emit an entry for the debug loc section. This can be used to
 531   /// handle an entry that's going to be emitted into the debug loc section.
 532   void emitDebugLocEntry(ByteStreamer &Streamer,
 533                          const DebugLocStream::Entry &Entry);
 534
 535   /// Emit the location for a debug loc entry, including the size header.
 536   void emitDebugLocEntryLocation(const DebugLocStream::Entry &Entry);
 537
 538   /// Find the MDNode for the given reference.
 539   template <typename T> T *resolve(TypedDINodeRef<T> Ref) const {
 540     return Ref.resolve();
 541   }
 542
 543   void addSubprogramNames(const DISubprogram *SP, DIE &Die);
 544
 545   AddressPool &getAddressPool() { return AddrPool; }
 546
 547   void addAccelName(StringRef Name, const DIE &Die);
 548
 549   void addAccelObjC(StringRef Name, const DIE &Die);
 550
 551   void addAccelNamespace(StringRef Name, const DIE &Die);
 552
 553   void addAccelType(StringRef Name, const DIE &Die, char Flags);
 554
 555   const MachineFunction *getCurrentFunction() const { return CurFn; }
 556
 557   /// A helper function to check whether the DIE for a given Scope is
 558   /// going to be null.
 559   bool isLexicalScopeDIENull(LexicalScope *Scope);
 560
 561   /// Find the matching DwarfCompileUnit for the given CU DIE.
 562   DwarfCompileUnit *lookupCU(const DIE *Die) { return CUDieMap.lookup(Die); }
 563
 564   /// \defgroup DebuggerTuning Predicates to tune DWARF for a given debugger.
 565   ///
 566   /// Returns whether we are "tuning" for a given debugger.
 567   /// @{
 568   bool tuneForGDB() const { return DebuggerTuning == DebuggerKind::GDB; }
 569   bool tuneForLLDB() const { return DebuggerTuning == DebuggerKind::LLDB; }
 570   bool tuneForSCE() const { return DebuggerTuning == DebuggerKind::SCE; }
 571   /// @}
 572 };
 573
 574 } // end namespace llvm
 575
 576 #endif // LLVM_LIB_CODEGEN_ASMPRINTER_DWARFDEBUG_H