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 "DWARFDebugLine.h"
  16 #include "DWARFDebugRangeList.h"
  17 #include "llvm/DebugInfo/DIContext.h"
  18 #include "llvm/ADT/OwningPtr.h"
  19 #include "llvm/ADT/SmallVector.h"
  20
  21 namespace llvm {
  22
  23 /// DWARFContext
  24 /// This data structure is the top level entity that deals with dwarf debug
  25 /// information parsing. The actual data is supplied through pure virtual
  26 /// methods that a concrete implementation provides.
  27 class DWARFContext : public DIContext {
  28   bool IsLittleEndian;
  29
  30   SmallVector<DWARFCompileUnit, 1> CUs;
  31   OwningPtr<DWARFDebugAbbrev> Abbrev;
  32   OwningPtr<DWARFDebugAranges> Aranges;
  33   OwningPtr<DWARFDebugLine> Line;
  34
  35   DWARFContext(DWARFContext &); // = delete
  36   DWARFContext &operator=(DWARFContext &); // = delete
  37
  38   /// Read compile units from the debug_info section and store them in CUs.
  39   void parseCompileUnits();
  40 protected:
  41   DWARFContext(bool isLittleEndian) : IsLittleEndian(isLittleEndian) {}
  42 public:
  43   virtual void dump(raw_ostream &OS);
  44   /// Get the number of compile units in this context.
  45   unsigned getNumCompileUnits() {
  46     if (CUs.empty())
  47       parseCompileUnits();
  48     return CUs.size();
  49   }
  50   /// Get the compile unit at the specified index for this compile unit.
  51   DWARFCompileUnit *getCompileUnitAtIndex(unsigned index) {
  52     if (CUs.empty())
  53       parseCompileUnits();
  54     return &CUs[index];
  55   }
  56
  57   /// Get a pointer to the parsed DebugAbbrev object.
  58   const DWARFDebugAbbrev *getDebugAbbrev();
  59
  60   /// Get a pointer to the parsed DebugAranges object.
  61   const DWARFDebugAranges *getDebugAranges();
  62
  63   /// Get a pointer to a parsed line table corresponding to a compile unit.
  64   const DWARFDebugLine::LineTable *
  65   getLineTableForCompileUnit(DWARFCompileUnit *cu);
  66
  67   virtual DILineInfo getLineInfoForAddress(uint64_t Address,
  68       DILineInfoSpecifier Specifier = DILineInfoSpecifier());
  69
  70   bool isLittleEndian() const { return IsLittleEndian; }
  71
  72   virtual StringRef getInfoSection() = 0;
  73   virtual StringRef getAbbrevSection() = 0;
  74   virtual StringRef getARangeSection() = 0;
  75   virtual StringRef getLineSection() = 0;
  76   virtual StringRef getStringSection() = 0;
  77   virtual StringRef getRangeSection() = 0;
  78
  79   static bool isSupportedVersion(unsigned version) {
  80     return version == 2 || version == 3;
  81   }
  82 private:
  83   /// Return the compile unit that includes an offset (relative to .debug_info).
  84   DWARFCompileUnit *getCompileUnitForOffset(uint32_t Offset);
  85
  86   /// Return the compile unit which contains instruction with provided
  87   /// address.
  88   DWARFCompileUnit *getCompileUnitForAddress(uint64_t Address);
  89
  90   /// Fetches filename, line and column number for given address and
  91   /// compile unit. Returns true on success.
  92   bool getFileLineInfoForCompileUnit(DWARFCompileUnit *CU,
  93                                      uint64_t Address,
  94                                      bool NeedsAbsoluteFilePath,
  95                                      std::string &FileName,
  96                                      uint32_t &Line, uint32_t &Column);
  97 };
  98
  99 /// DWARFContextInMemory is the simplest possible implementation of a
 100 /// DWARFContext. It assumes all content is available in memory and stores
 101 /// pointers to it.
 102 class DWARFContextInMemory : public DWARFContext {
 103   virtual void anchor();
 104   StringRef InfoSection;
 105   StringRef AbbrevSection;
 106   StringRef ARangeSection;
 107   StringRef LineSection;
 108   StringRef StringSection;
 109   StringRef RangeSection;
 110 public:
 111   DWARFContextInMemory(bool isLittleEndian,
 112                        StringRef infoSection,
 113                        StringRef abbrevSection,
 114                        StringRef aRangeSection,
 115                        StringRef lineSection,
 116                        StringRef stringSection,
 117                        StringRef rangeSection)
 118     : DWARFContext(isLittleEndian),
 119       InfoSection(infoSection),
 120       AbbrevSection(abbrevSection),
 121       ARangeSection(aRangeSection),
 122       LineSection(lineSection),
 123       StringSection(stringSection),
 124       RangeSection(rangeSection)
 125     {}
 126
 127   virtual StringRef getInfoSection() { return InfoSection; }
 128   virtual StringRef getAbbrevSection() { return AbbrevSection; }
 129   virtual StringRef getARangeSection() { return ARangeSection; }
 130   virtual StringRef getLineSection() { return LineSection; }
 131   virtual StringRef getStringSection() { return StringSection; }
 132   virtual StringRef getRangeSection() { return RangeSection; }
 133 };
 134
 135 }
 136
 137 #endif