lib/CodeGen/AsmPrinter/DwarfFile.h

   1 //===-- llvm/CodeGen/DwarfFile.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 #ifndef LLVM_LIB_CODEGEN_ASMPRINTER_DWARFFILE_H
  11 #define LLVM_LIB_CODEGEN_ASMPRINTER_DWARFFILE_H
  12
  13 #include "llvm/ADT/DenseMap.h"
  14 #include "llvm/ADT/FoldingSet.h"
  15 #include "llvm/ADT/SmallVector.h"
  16 #include "llvm/ADT/StringMap.h"
  17 #include "llvm/Support/Allocator.h"
  18 #include "AddressPool.h"
  19 #include "DwarfStringPool.h"
  20
  21 #include <vector>
  22 #include <string>
  23 #include <memory>
  24
  25 namespace llvm {
  26 class AsmPrinter;
  27 class DbgVariable;
  28 class DwarfUnit;
  29 class DIEAbbrev;
  30 class MCSymbol;
  31 class DIE;
  32 class DISubprogram;
  33 class LexicalScope;
  34 class StringRef;
  35 class DwarfDebug;
  36 class MCSection;
  37 class DwarfFile {
  38   // Target of Dwarf emission, used for sizing of abbreviations.
  39   AsmPrinter *Asm;
  40
  41   DwarfDebug &DD;
  42
  43   // Used to uniquely define abbreviations.
  44   FoldingSet<DIEAbbrev> AbbreviationsSet;
  45
  46   // A list of all the unique abbreviations in use.
  47   std::vector<DIEAbbrev *> Abbreviations;
  48
  49   // A pointer to all units in the section.
  50   SmallVector<std::unique_ptr<DwarfUnit>, 1> CUs;
  51
  52   DwarfStringPool StrPool;
  53
  54   // Collection of dbg variables of a scope.
  55   DenseMap<LexicalScope *, SmallVector<DbgVariable *, 8>> ScopeVariables;
  56
  57   // Collection of abstract subprogram DIEs.
  58   DenseMap<const MDNode *, DIE *> AbstractSPDies;
  59
  60   /// Maps MDNodes for type system with the corresponding DIEs. These DIEs can
  61   /// be shared across CUs, that is why we keep the map here instead
  62   /// of in DwarfCompileUnit.
  63   DenseMap<const MDNode *, DIE *> MDTypeNodeToDieMap;
  64
  65 public:
  66   DwarfFile(AsmPrinter *AP, DwarfDebug &DD, StringRef Pref,
  67             BumpPtrAllocator &DA);
  68
  69   ~DwarfFile();
  70
  71   const SmallVectorImpl<std::unique_ptr<DwarfUnit>> &getUnits() { return CUs; }
  72
  73   /// \brief Compute the size and offset of a DIE given an incoming Offset.
  74   unsigned computeSizeAndOffset(DIE &Die, unsigned Offset);
  75
  76   /// \brief Compute the size and offset of all the DIEs.
  77   void computeSizeAndOffsets();
  78
  79   /// \brief Define a unique number for the abbreviation.
  80   void assignAbbrevNumber(DIEAbbrev &Abbrev);
  81
  82   /// \brief Add a unit to the list of CUs.
  83   void addUnit(std::unique_ptr<DwarfUnit> U);
  84
  85   /// \brief Emit all of the units to the section listed with the given
  86   /// abbreviation section.
  87   void emitUnits(const MCSymbol *ASectionSym);
  88
  89   /// \brief Emit a set of abbreviations to the specific section.
  90   void emitAbbrevs(const MCSection *);
  91
  92   /// \brief Emit all of the strings to the section given.
  93   void emitStrings(const MCSection *StrSection,
  94                    const MCSection *OffsetSection = nullptr);
  95
  96   /// \brief Returns the string pool.
  97   DwarfStringPool &getStringPool() { return StrPool; }
  98
  99   void addScopeVariable(LexicalScope *LS, DbgVariable *Var);
 100
 101   DenseMap<LexicalScope *, SmallVector<DbgVariable *, 8>> &getScopeVariables() {
 102     return ScopeVariables;
 103   }
 104
 105   DenseMap<const MDNode *, DIE *> &getAbstractSPDies() {
 106     return AbstractSPDies;
 107   }
 108
 109   void insertDIE(const MDNode *TypeMD, DIE *Die) {
 110     MDTypeNodeToDieMap.insert(std::make_pair(TypeMD, Die));
 111   }
 112   DIE *getDIE(const MDNode *TypeMD) {
 113     return MDTypeNodeToDieMap.lookup(TypeMD);
 114   }
 115 };
 116 }
 117 #endif