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