1 //===-- DIContext.h ---------------------------------------------*- C++ -*-===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This file defines DIContext, an abstract data structure that holds
11 // debug information data.
13 //===----------------------------------------------------------------------===//
15 #ifndef LLVM_DEBUGINFO_DICONTEXT_H
16 #define LLVM_DEBUGINFO_DICONTEXT_H
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"
31 /// DILineInfo - a format-neutral container for source line information.
34 std::string FunctionName;
39 : FileName("<invalid>"), FunctionName("<invalid>"), Line(0), Column(0) {}
41 bool operator==(const DILineInfo &RHS) const {
42 return Line == RHS.Line && Column == RHS.Column &&
43 FileName == RHS.FileName && FunctionName == RHS.FunctionName;
45 bool operator!=(const DILineInfo &RHS) const {
46 return !(*this == RHS);
50 typedef SmallVector<std::pair<uint64_t, DILineInfo>, 16> DILineInfoTable;
52 /// DIInliningInfo - a format-neutral container for inlined code description.
53 class DIInliningInfo {
54 SmallVector<DILineInfo, 4> Frames;
57 DILineInfo getFrame(unsigned Index) const {
58 assert(Index < Frames.size());
61 uint32_t getNumberOfFrames() const {
64 void addFrame(const DILineInfo &Frame) {
65 Frames.push_back(Frame);
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 };
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;
79 FileLineInfoKind FLIKind;
80 FunctionNameKind FNKind;
82 DILineInfoSpecifier(FileLineInfoKind FLIKind = FileLineInfoKind::Default,
83 FunctionNameKind FNKind = FunctionNameKind::None)
84 : FLIKind(FLIKind), FNKind(FNKind) {}
87 /// Selects which debug sections get dumped.
113 // In place of applying the relocations to the data we've read from disk we use
114 // a separate mapping table to the side and checking that at locations in the
115 // dwarf where we expect relocated values. This adds a bit of complexity to the
116 // dwarf parsing/extraction at the benefit of not allocating memory for the
117 // entire size of the debug info sections.
118 typedef DenseMap<uint64_t, std::pair<uint8_t, int64_t> > RelocAddrMap;
125 DIContextKind getKind() const { return Kind; }
127 DIContext(DIContextKind K) : Kind(K) {}
128 virtual ~DIContext();
130 /// getDWARFContext - get a context for binary DWARF data.
131 static DIContext *getDWARFContext(object::ObjectFile &);
133 virtual void dump(raw_ostream &OS, DIDumpType DumpType = DIDT_All) = 0;
135 virtual DILineInfo getLineInfoForAddress(uint64_t Address,
136 DILineInfoSpecifier Specifier = DILineInfoSpecifier()) = 0;
137 virtual DILineInfoTable getLineInfoForAddressRange(uint64_t Address,
138 uint64_t Size, DILineInfoSpecifier Specifier = DILineInfoSpecifier()) = 0;
139 virtual DIInliningInfo getInliningInfoForAddress(uint64_t Address,
140 DILineInfoSpecifier Specifier = DILineInfoSpecifier()) = 0;
142 const DIContextKind Kind;