lib/DebugInfo/DWARFContext.h

   1 //===-- DWARFContext.h ------------------------------------------*- 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_DEBUGINFO_DWARFCONTEXT_H
  11 #define LLVM_DEBUGINFO_DWARFCONTEXT_H
  12
  13 #include "DWARFCompileUnit.h"
  14 #include "DWARFDebugAranges.h"
  15 #include "DWARFDebugFrame.h"
  16 #include "DWARFDebugLine.h"
  17 #include "DWARFDebugLoc.h"
  18 #include "DWARFDebugRangeList.h"
  19 #include "DWARFTypeUnit.h"
  20 #include "llvm/ADT/MapVector.h"
  21 #include "llvm/ADT/SmallVector.h"
  22 #include "llvm/DebugInfo/DIContext.h"
  23
  24 namespace llvm {
  25
  26 /// DWARFContext
  27 /// This data structure is the top level entity that deals with dwarf debug
  28 /// information parsing. The actual data is supplied through pure virtual
  29 /// methods that a concrete implementation provides.
  30 class DWARFContext : public DIContext {
  31   typedef SmallVector<DWARFCompileUnit *, 1> CUVector;
  32   typedef SmallVector<DWARFTypeUnit *, 1> TUVector;
  33
  34   CUVector CUs;
  35   TUVector TUs;
  36   std::unique_ptr<DWARFDebugAbbrev> Abbrev;
  37   std::unique_ptr<DWARFDebugLoc> Loc;
  38   std::unique_ptr<DWARFDebugAranges> Aranges;
  39   std::unique_ptr<DWARFDebugLine> Line;
  40   std::unique_ptr<DWARFDebugFrame> DebugFrame;
  41
  42   CUVector DWOCUs;
  43   TUVector DWOTUs;
  44   std::unique_ptr<DWARFDebugAbbrev> AbbrevDWO;
  45
  46   DWARFContext(DWARFContext &) LLVM_DELETED_FUNCTION;
  47   DWARFContext &operator=(DWARFContext &) LLVM_DELETED_FUNCTION;
  48
  49   /// Read compile units from the debug_info section (if necessary)
  50   /// and store them in CUs.
  51   void parseCompileUnits();
  52
  53   /// Read type units from the debug_types sections (if necessary)
  54   /// and store them in TUs.
  55   void parseTypeUnits();
  56
  57   /// Read compile units from the debug_info.dwo section (if necessary)
  58   /// and store them in DWOCUs.
  59   void parseDWOCompileUnits();
  60
  61   /// Read type units from the debug_types.dwo section (if necessary)
  62   /// and store them in DWOTUs.
  63   void parseDWOTypeUnits();
  64
  65 public:
  66   struct Section {
  67     StringRef Data;
  68     RelocAddrMap Relocs;
  69   };
  70
  71   DWARFContext() : DIContext(CK_DWARF) {}
  72   virtual ~DWARFContext();
  73
  74   static bool classof(const DIContext *DICtx) {
  75     return DICtx->getKind() == CK_DWARF;
  76   }
  77
  78   void dump(raw_ostream &OS, DIDumpType DumpType = DIDT_All) override;
  79
  80   typedef iterator_range<CUVector::iterator> cu_iterator_range;
  81   typedef iterator_range<TUVector::iterator> tu_iterator_range;
  82
  83   /// Get compile units in this context.
  84   cu_iterator_range compile_units() {
  85     parseCompileUnits();
  86     return cu_iterator_range(CUs.begin(), CUs.end());
  87   }
  88
  89   /// Get type units in this context.
  90   tu_iterator_range type_units() {
  91     parseTypeUnits();
  92     return tu_iterator_range(TUs.begin(), TUs.end());
  93   }
  94
  95   /// Get compile units in the DWO context.
  96   cu_iterator_range dwo_compile_units() {
  97     parseDWOCompileUnits();
  98     return cu_iterator_range(DWOCUs.begin(), DWOCUs.end());
  99   }
 100
 101   /// Get type units in the DWO context.
 102   tu_iterator_range dwo_type_units() {
 103     parseDWOTypeUnits();
 104     return tu_iterator_range(DWOTUs.begin(), DWOTUs.end());
 105   }
 106
 107   /// Get the number of compile units in this context.
 108   unsigned getNumCompileUnits() {
 109     parseCompileUnits();
 110     return CUs.size();
 111   }
 112
 113   /// Get the number of compile units in this context.
 114   unsigned getNumTypeUnits() {
 115     parseTypeUnits();
 116     return TUs.size();
 117   }
 118
 119   /// Get the number of compile units in the DWO context.
 120   unsigned getNumDWOCompileUnits() {
 121     parseDWOCompileUnits();
 122     return DWOCUs.size();
 123   }
 124
 125   /// Get the number of compile units in the DWO context.
 126   unsigned getNumDWOTypeUnits() {
 127     parseDWOTypeUnits();
 128     return DWOTUs.size();
 129   }
 130
 131   /// Get the compile unit at the specified index for this compile unit.
 132   DWARFCompileUnit *getCompileUnitAtIndex(unsigned index) {
 133     parseCompileUnits();
 134     return CUs[index];
 135   }
 136
 137   /// Get the compile unit at the specified index for the DWO compile units.
 138   DWARFCompileUnit *getDWOCompileUnitAtIndex(unsigned index) {
 139     parseDWOCompileUnits();
 140     return DWOCUs[index];
 141   }
 142
 143   /// Get a pointer to the parsed DebugAbbrev object.
 144   const DWARFDebugAbbrev *getDebugAbbrev();
 145
 146   /// Get a pointer to the parsed DebugLoc object.
 147   const DWARFDebugLoc *getDebugLoc();
 148
 149   /// Get a pointer to the parsed dwo abbreviations object.
 150   const DWARFDebugAbbrev *getDebugAbbrevDWO();
 151
 152   /// Get a pointer to the parsed DebugAranges object.
 153   const DWARFDebugAranges *getDebugAranges();
 154
 155   /// Get a pointer to the parsed frame information object.
 156   const DWARFDebugFrame *getDebugFrame();
 157
 158   /// Get a pointer to a parsed line table corresponding to a compile unit.
 159   const DWARFDebugLine::LineTable *
 160   getLineTableForCompileUnit(DWARFCompileUnit *cu);
 161
 162   DILineInfo getLineInfoForAddress(uint64_t Address,
 163       DILineInfoSpecifier Specifier = DILineInfoSpecifier()) override;
 164   DILineInfoTable getLineInfoForAddressRange(uint64_t Address, uint64_t Size,
 165       DILineInfoSpecifier Specifier = DILineInfoSpecifier()) override;
 166   DIInliningInfo getInliningInfoForAddress(uint64_t Address,
 167       DILineInfoSpecifier Specifier = DILineInfoSpecifier()) override;
 168
 169   virtual bool isLittleEndian() const = 0;
 170   virtual uint8_t getAddressSize() const = 0;
 171   virtual const Section &getInfoSection() = 0;
 172   typedef MapVector<object::SectionRef, Section,
 173                     std::map<object::SectionRef, unsigned> > TypeSectionMap;
 174   virtual const TypeSectionMap &getTypesSections() = 0;
 175   virtual StringRef getAbbrevSection() = 0;
 176   virtual const Section &getLocSection() = 0;
 177   virtual StringRef getARangeSection() = 0;
 178   virtual StringRef getDebugFrameSection() = 0;
 179   virtual const Section &getLineSection() = 0;
 180   virtual const Section &getLineDWOSection() = 0;
 181   virtual StringRef getStringSection() = 0;
 182   virtual StringRef getRangeSection() = 0;
 183   virtual StringRef getPubNamesSection() = 0;
 184   virtual StringRef getPubTypesSection() = 0;
 185   virtual StringRef getGnuPubNamesSection() = 0;
 186   virtual StringRef getGnuPubTypesSection() = 0;
 187
 188   // Sections for DWARF5 split dwarf proposal.
 189   virtual const Section &getInfoDWOSection() = 0;
 190   virtual const TypeSectionMap &getTypesDWOSections() = 0;
 191   virtual StringRef getAbbrevDWOSection() = 0;
 192   virtual StringRef getStringDWOSection() = 0;
 193   virtual StringRef getStringOffsetDWOSection() = 0;
 194   virtual StringRef getRangeDWOSection() = 0;
 195   virtual StringRef getAddrSection() = 0;
 196
 197   static bool isSupportedVersion(unsigned version) {
 198     return version == 2 || version == 3 || version == 4;
 199   }
 200 private:
 201   /// Return the compile unit that includes an offset (relative to .debug_info).
 202   DWARFCompileUnit *getCompileUnitForOffset(uint32_t Offset);
 203
 204   /// Return the compile unit which contains instruction with provided
 205   /// address.
 206   DWARFCompileUnit *getCompileUnitForAddress(uint64_t Address);
 207 };
 208
 209 /// DWARFContextInMemory is the simplest possible implementation of a
 210 /// DWARFContext. It assumes all content is available in memory and stores
 211 /// pointers to it.
 212 class DWARFContextInMemory : public DWARFContext {
 213   virtual void anchor();
 214   bool IsLittleEndian;
 215   uint8_t AddressSize;
 216   Section InfoSection;
 217   TypeSectionMap TypesSections;
 218   StringRef AbbrevSection;
 219   Section LocSection;
 220   StringRef ARangeSection;
 221   StringRef DebugFrameSection;
 222   Section LineSection;
 223   Section LineDWOSection;
 224   StringRef StringSection;
 225   StringRef RangeSection;
 226   StringRef PubNamesSection;
 227   StringRef PubTypesSection;
 228   StringRef GnuPubNamesSection;
 229   StringRef GnuPubTypesSection;
 230
 231   // Sections for DWARF5 split dwarf proposal.
 232   Section InfoDWOSection;
 233   TypeSectionMap TypesDWOSections;
 234   StringRef AbbrevDWOSection;
 235   StringRef StringDWOSection;
 236   StringRef StringOffsetDWOSection;
 237   StringRef RangeDWOSection;
 238   StringRef AddrSection;
 239
 240   SmallVector<MemoryBuffer*, 4> UncompressedSections;
 241
 242 public:
 243   DWARFContextInMemory(object::ObjectFile *);
 244   ~DWARFContextInMemory();
 245   bool isLittleEndian() const override { return IsLittleEndian; }
 246   uint8_t getAddressSize() const override { return AddressSize; }
 247   const Section &getInfoSection() override { return InfoSection; }
 248   const TypeSectionMap &getTypesSections() override { return TypesSections; }
 249   StringRef getAbbrevSection() override { return AbbrevSection; }
 250   const Section &getLocSection() override { return LocSection; }
 251   StringRef getARangeSection() override { return ARangeSection; }
 252   StringRef getDebugFrameSection() override { return DebugFrameSection; }
 253   const Section &getLineSection() override { return LineSection; }
 254   const Section &getLineDWOSection() override { return LineDWOSection; }
 255   StringRef getStringSection() override { return StringSection; }
 256   StringRef getRangeSection() override { return RangeSection; }
 257   StringRef getPubNamesSection() override { return PubNamesSection; }
 258   StringRef getPubTypesSection() override { return PubTypesSection; }
 259   StringRef getGnuPubNamesSection() override { return GnuPubNamesSection; }
 260   StringRef getGnuPubTypesSection() override { return GnuPubTypesSection; }
 261
 262   // Sections for DWARF5 split dwarf proposal.
 263   const Section &getInfoDWOSection() override { return InfoDWOSection; }
 264   const TypeSectionMap &getTypesDWOSections() override {
 265     return TypesDWOSections;
 266   }
 267   StringRef getAbbrevDWOSection() override { return AbbrevDWOSection; }
 268   StringRef getStringDWOSection() override { return StringDWOSection; }
 269   StringRef getStringOffsetDWOSection() override {
 270     return StringOffsetDWOSection;
 271   }
 272   StringRef getRangeDWOSection() override { return RangeDWOSection; }
 273   StringRef getAddrSection() override {
 274     return AddrSection;
 275   }
 276 };
 277
 278 }
 279
 280 #endif