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 /// A DINameKind is passed to name search methods to specify a
  70 /// preference regarding the type of name resolution the caller wants.
  71 enum class DINameKind { None, ShortName, LinkageName };
  72
  73 /// DILineInfoSpecifier - controls which fields of DILineInfo container
  74 /// should be filled with data.
  75 struct DILineInfoSpecifier {
  76   enum class FileLineInfoKind { None, Default, AbsoluteFilePath };
  77   typedef DINameKind FunctionNameKind;
  78
  79   FileLineInfoKind FLIKind;
  80   FunctionNameKind FNKind;
  81
  82   DILineInfoSpecifier(FileLineInfoKind FLIKind = FileLineInfoKind::Default,
  83                       FunctionNameKind FNKind = FunctionNameKind::None)
  84       : FLIKind(FLIKind), FNKind(FNKind) {}
  85 };
  86
  87 /// Selects which debug sections get dumped.
  88 enum DIDumpType {
  89   DIDT_Null,
  90   DIDT_All,
  91   DIDT_Abbrev,
  92   DIDT_AbbrevDwo,
  93   DIDT_Aranges,
  94   DIDT_Frames,
  95   DIDT_Info,
  96   DIDT_InfoDwo,
  97   DIDT_Types,
  98   DIDT_TypesDwo,
  99   DIDT_Line,
 100   DIDT_LineDwo,
 101   DIDT_Loc,
 102   DIDT_LocDwo,
 103   DIDT_Ranges,
 104   DIDT_Pubnames,
 105   DIDT_Pubtypes,
 106   DIDT_GnuPubnames,
 107   DIDT_GnuPubtypes,
 108   DIDT_Str,
 109   DIDT_StrDwo,
 110   DIDT_StrOffsetsDwo,
 111   DIDT_AppleNames,
 112   DIDT_AppleTypes,
 113   DIDT_AppleNamespaces,
 114   DIDT_AppleObjC
 115 };
 116
 117 // In place of applying the relocations to the data we've read from disk we use
 118 // a separate mapping table to the side and checking that at locations in the
 119 // dwarf where we expect relocated values. This adds a bit of complexity to the
 120 // dwarf parsing/extraction at the benefit of not allocating memory for the
 121 // entire size of the debug info sections.
 122 typedef DenseMap<uint64_t, std::pair<uint8_t, int64_t> > RelocAddrMap;
 123
 124 class DIContext {
 125 public:
 126   enum DIContextKind {
 127     CK_DWARF
 128   };
 129   DIContextKind getKind() const { return Kind; }
 130
 131   DIContext(DIContextKind K) : Kind(K) {}
 132   virtual ~DIContext();
 133
 134   /// getDWARFContext - get a context for binary DWARF data.
 135   static DIContext *getDWARFContext(const object::ObjectFile &Obj);
 136
 137   virtual void dump(raw_ostream &OS, DIDumpType DumpType = DIDT_All) = 0;
 138
 139   virtual DILineInfo getLineInfoForAddress(uint64_t Address,
 140       DILineInfoSpecifier Specifier = DILineInfoSpecifier()) = 0;
 141   virtual DILineInfoTable getLineInfoForAddressRange(uint64_t Address,
 142       uint64_t Size, DILineInfoSpecifier Specifier = DILineInfoSpecifier()) = 0;
 143   virtual DIInliningInfo getInliningInfoForAddress(uint64_t Address,
 144       DILineInfoSpecifier Specifier = DILineInfoSpecifier()) = 0;
 145 private:
 146   const DIContextKind Kind;
 147 };
 148
 149 }
 150
 151 #endif