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 "DWARFDebugRangeList.h"
  18 #include "llvm/ADT/OwningPtr.h"
  19 #include "llvm/ADT/SmallVector.h"
  20 #include "llvm/DebugInfo/DIContext.h"
  21
  22 namespace llvm {
  23
  24 /// DWARFContext
  25 /// This data structure is the top level entity that deals with dwarf debug
  26 /// information parsing. The actual data is supplied through pure virtual
  27 /// methods that a concrete implementation provides.
  28 class DWARFContext : public DIContext {
  29   SmallVector<DWARFCompileUnit, 1> CUs;
  30   OwningPtr<DWARFDebugAbbrev> Abbrev;
  31   OwningPtr<DWARFDebugAranges> Aranges;
  32   OwningPtr<DWARFDebugLine> Line;
  33   OwningPtr<DWARFDebugFrame> DebugFrame;
  34
  35   SmallVector<DWARFCompileUnit, 1> DWOCUs;
  36   OwningPtr<DWARFDebugAbbrev> AbbrevDWO;
  37
  38   DWARFContext(DWARFContext &) LLVM_DELETED_FUNCTION;
  39   DWARFContext &operator=(DWARFContext &) LLVM_DELETED_FUNCTION;
  40
  41   /// Read compile units from the debug_info section and store them in CUs.
  42   void parseCompileUnits();
  43
  44   /// Read compile units from the debug_info.dwo section and store them in
  45   /// DWOCUs.
  46   void parseDWOCompileUnits();
  47
  48 public:
  49   DWARFContext() {}
  50   virtual void dump(raw_ostream &OS, DIDumpType DumpType = DIDT_All);
  51
  52   /// Get the number of compile units in this context.
  53   unsigned getNumCompileUnits() {
  54     if (CUs.empty())
  55       parseCompileUnits();
  56     return CUs.size();
  57   }
  58
  59   /// Get the number of compile units in the DWO context.
  60   unsigned getNumDWOCompileUnits() {
  61     if (DWOCUs.empty())
  62       parseDWOCompileUnits();
  63     return DWOCUs.size();
  64   }
  65
  66   /// Get the compile unit at the specified index for this compile unit.
  67   DWARFCompileUnit *getCompileUnitAtIndex(unsigned index) {
  68     if (CUs.empty())
  69       parseCompileUnits();
  70     return &CUs[index];
  71   }
  72
  73   /// Get the compile unit at the specified index for the DWO compile units.
  74   DWARFCompileUnit *getDWOCompileUnitAtIndex(unsigned index) {
  75     if (DWOCUs.empty())
  76       parseDWOCompileUnits();
  77     return &DWOCUs[index];
  78   }
  79
  80   /// Get a pointer to the parsed DebugAbbrev object.
  81   const DWARFDebugAbbrev *getDebugAbbrev();
  82
  83   /// Get a pointer to the parsed dwo abbreviations object.
  84   const DWARFDebugAbbrev *getDebugAbbrevDWO();
  85
  86   /// Get a pointer to the parsed DebugAranges object.
  87   const DWARFDebugAranges *getDebugAranges();
  88
  89   /// Get a pointer to the parsed frame information object.
  90   const DWARFDebugFrame *getDebugFrame();
  91
  92   /// Get a pointer to a parsed line table corresponding to a compile unit.
  93   const DWARFDebugLine::LineTable *
  94   getLineTableForCompileUnit(DWARFCompileUnit *cu);
  95
  96   virtual DILineInfo getLineInfoForAddress(uint64_t Address,
  97       DILineInfoSpecifier Specifier = DILineInfoSpecifier());
  98   virtual DILineInfoTable getLineInfoForAddressRange(uint64_t Address,
  99       uint64_t Size, DILineInfoSpecifier Specifier = DILineInfoSpecifier());
 100   virtual DIInliningInfo getInliningInfoForAddress(uint64_t Address,
 101       DILineInfoSpecifier Specifier = DILineInfoSpecifier());
 102
 103   virtual bool isLittleEndian() const = 0;
 104   virtual uint8_t getAddressSize() const = 0;
 105   virtual const RelocAddrMap &infoRelocMap() const = 0;
 106   virtual const RelocAddrMap &lineRelocMap() const = 0;
 107   virtual StringRef getInfoSection() = 0;
 108   virtual StringRef getAbbrevSection() = 0;
 109   virtual StringRef getARangeSection() = 0;
 110   virtual StringRef getDebugFrameSection() = 0;
 111   virtual StringRef getLineSection() = 0;
 112   virtual StringRef getStringSection() = 0;
 113   virtual StringRef getRangeSection() = 0;
 114
 115   // Sections for DWARF5 split dwarf proposal.
 116   virtual StringRef getInfoDWOSection() = 0;
 117   virtual StringRef getAbbrevDWOSection() = 0;
 118   virtual StringRef getStringDWOSection() = 0;
 119   virtual StringRef getStringOffsetDWOSection() = 0;
 120   virtual StringRef getRangeDWOSection() = 0;
 121   virtual StringRef getAddrSection() = 0;
 122   virtual const RelocAddrMap &infoDWORelocMap() const = 0;
 123
 124   static bool isSupportedVersion(unsigned version) {
 125     return version == 2 || version == 3;
 126   }
 127 private:
 128   /// Return the compile unit that includes an offset (relative to .debug_info).
 129   DWARFCompileUnit *getCompileUnitForOffset(uint32_t Offset);
 130
 131   /// Return the compile unit which contains instruction with provided
 132   /// address.
 133   DWARFCompileUnit *getCompileUnitForAddress(uint64_t Address);
 134 };
 135
 136 /// DWARFContextInMemory is the simplest possible implementation of a
 137 /// DWARFContext. It assumes all content is available in memory and stores
 138 /// pointers to it.
 139 class DWARFContextInMemory : public DWARFContext {
 140   virtual void anchor();
 141   bool IsLittleEndian;
 142   uint8_t AddressSize;
 143   RelocAddrMap InfoRelocMap;
 144   RelocAddrMap LineRelocMap;
 145   StringRef InfoSection;
 146   StringRef AbbrevSection;
 147   StringRef ARangeSection;
 148   StringRef DebugFrameSection;
 149   StringRef LineSection;
 150   StringRef StringSection;
 151   StringRef RangeSection;
 152
 153   // Sections for DWARF5 split dwarf proposal.
 154   RelocAddrMap InfoDWORelocMap;
 155   StringRef InfoDWOSection;
 156   StringRef AbbrevDWOSection;
 157   StringRef StringDWOSection;
 158   StringRef StringOffsetDWOSection;
 159   StringRef RangeDWOSection;
 160   StringRef AddrSection;
 161
 162 public:
 163   DWARFContextInMemory(object::ObjectFile *);
 164   virtual bool isLittleEndian() const { return IsLittleEndian; }
 165   virtual uint8_t getAddressSize() const { return AddressSize; }
 166   virtual const RelocAddrMap &infoRelocMap() const { return InfoRelocMap; }
 167   virtual const RelocAddrMap &lineRelocMap() const { return LineRelocMap; }
 168   virtual StringRef getInfoSection() { return InfoSection; }
 169   virtual StringRef getAbbrevSection() { return AbbrevSection; }
 170   virtual StringRef getARangeSection() { return ARangeSection; }
 171   virtual StringRef getDebugFrameSection() { return DebugFrameSection; }
 172   virtual StringRef getLineSection() { return LineSection; }
 173   virtual StringRef getStringSection() { return StringSection; }
 174   virtual StringRef getRangeSection() { return RangeSection; }
 175
 176   // Sections for DWARF5 split dwarf proposal.
 177   virtual StringRef getInfoDWOSection() { return InfoDWOSection; }
 178   virtual StringRef getAbbrevDWOSection() { return AbbrevDWOSection; }
 179   virtual StringRef getStringDWOSection() { return StringDWOSection; }
 180   virtual StringRef getStringOffsetDWOSection() {
 181     return StringOffsetDWOSection;
 182   }
 183   virtual StringRef getRangeDWOSection() { return RangeDWOSection; }
 184   virtual StringRef getAddrSection() {
 185     return AddrSection;
 186   }
 187   virtual const RelocAddrMap &infoDWORelocMap() const {
 188     return InfoDWORelocMap;
 189   }
 190 };
 191
 192 }
 193
 194 #endif