include/llvm/DebugInfo/DIContext.h

   1 //===-- DIContext.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 // This file defines DIContext, an abstract data structure that holds
  11 // debug information data.
  12 //
  13 //===----------------------------------------------------------------------===//
  14
  15 #ifndef LLVM_DEBUGINFO_DICONTEXT_H
  16 #define LLVM_DEBUGINFO_DICONTEXT_H
  17
  18 #include "llvm/ADT/DenseMap.h"
  19 #include "llvm/ADT/SmallVector.h"
  20 #include "llvm/Object/ObjectFile.h"
  21 #include "llvm/Object/RelocVisitor.h"
  22 #include "llvm/Support/Casting.h"
  23 #include "llvm/Support/DataTypes.h"
  24
  25 #include <string>
  26
  27 namespace llvm {
  28
  29 class raw_ostream;
  30
  31 /// DILineInfo - a format-neutral container for source line information.
  32 struct DILineInfo {
  33   std::string FileName;
  34   std::string FunctionName;
  35   uint32_t Line;
  36   uint32_t Column;
  37
  38   DILineInfo()
  39       : FileName("<invalid>"), FunctionName("<invalid>"), Line(0), Column(0) {}
  40
  41   bool operator==(const DILineInfo &RHS) const {
  42     return Line == RHS.Line && Column == RHS.Column &&
  43            FileName == RHS.FileName && FunctionName == RHS.FunctionName;
  44   }
  45   bool operator!=(const DILineInfo &RHS) const {
  46     return !(*this == RHS);
  47   }
  48 };
  49
  50 typedef SmallVector<std::pair<uint64_t, DILineInfo>, 16> DILineInfoTable;
  51
  52 /// DIInliningInfo - a format-neutral container for inlined code description.
  53 class DIInliningInfo {
  54   SmallVector<DILineInfo, 4> Frames;
  55  public:
  56   DIInliningInfo() {}
  57   DILineInfo getFrame(unsigned Index) const {
  58     assert(Index < Frames.size());
  59     return Frames[Index];
  60   }
  61   uint32_t getNumberOfFrames() const {
  62     return Frames.size();
  63   }
  64   void addFrame(const DILineInfo &Frame) {
  65     Frames.push_back(Frame);
  66   }
  67 };
  68
  69 /// DILineInfoSpecifier - controls which fields of DILineInfo container
  70 /// should be filled with data.
  71 class DILineInfoSpecifier {
  72   const uint32_t Flags;  // Or'ed flags that set the info we want to fetch.
  73 public:
  74   enum Specification {
  75     FileLineInfo = 1 << 0,
  76     AbsoluteFilePath = 1 << 1,
  77     FunctionName = 1 << 2
  78   };
  79   // Use file/line info by default.
  80   DILineInfoSpecifier(uint32_t flags = FileLineInfo) : Flags(flags) {}
  81   bool needs(Specification spec) const {
  82     return (Flags & spec) > 0;
  83   }
  84 };
  85
  86 /// Selects which debug sections get dumped.
  87 enum DIDumpType {
  88   DIDT_Null,
  89   DIDT_All,
  90   DIDT_Abbrev,
  91   DIDT_AbbrevDwo,
  92   DIDT_Aranges,
  93   DIDT_Frames,
  94   DIDT_Info,
  95   DIDT_InfoDwo,
  96   DIDT_Types,
  97   DIDT_TypesDwo,
  98   DIDT_Line,
  99   DIDT_LineDwo,
 100   DIDT_Loc,
 101   DIDT_LocDwo,
 102   DIDT_Ranges,
 103   DIDT_Pubnames,
 104   DIDT_Pubtypes,
 105   DIDT_GnuPubnames,
 106   DIDT_GnuPubtypes,
 107   DIDT_Str,
 108   DIDT_StrDwo,
 109   DIDT_StrOffsetsDwo
 110 };
 111
 112 // In place of applying the relocations to the data we've read from disk we use
 113 // a separate mapping table to the side and checking that at locations in the
 114 // dwarf where we expect relocated values. This adds a bit of complexity to the
 115 // dwarf parsing/extraction at the benefit of not allocating memory for the
 116 // entire size of the debug info sections.
 117 typedef DenseMap<uint64_t, std::pair<uint8_t, int64_t> > RelocAddrMap;
 118
 119 class DIContext {
 120 public:
 121   enum DIContextKind {
 122     CK_DWARF
 123   };
 124   DIContextKind getKind() const { return Kind; }
 125
 126   DIContext(DIContextKind K) : Kind(K) {}
 127   virtual ~DIContext();
 128
 129   /// getDWARFContext - get a context for binary DWARF data.
 130   static DIContext *getDWARFContext(object::ObjectFile *);
 131
 132   virtual void dump(raw_ostream &OS, DIDumpType DumpType = DIDT_All) = 0;
 133
 134   virtual DILineInfo getLineInfoForAddress(uint64_t Address,
 135       DILineInfoSpecifier Specifier = DILineInfoSpecifier()) = 0;
 136   virtual DILineInfoTable getLineInfoForAddressRange(uint64_t Address,
 137       uint64_t Size, DILineInfoSpecifier Specifier = DILineInfoSpecifier()) = 0;
 138   virtual DIInliningInfo getInliningInfoForAddress(uint64_t Address,
 139       DILineInfoSpecifier Specifier = DILineInfoSpecifier()) = 0;
 140 private:
 141   const DIContextKind Kind;
 142 };
 143
 144 }
 145
 146 #endif