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/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"
31 /// DILineInfo - a format-neutral container for source line information.
33 SmallString<16> FileName;
34 SmallString<16> FunctionName;
39 : FileName("<invalid>"), FunctionName("<invalid>"),
41 DILineInfo(StringRef fileName, StringRef functionName, uint32_t line,
43 : FileName(fileName), FunctionName(functionName), Line(line),
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; }
51 bool operator==(const DILineInfo &RHS) const {
52 return Line == RHS.Line && Column == RHS.Column &&
53 FileName.equals(RHS.FileName) &&
54 FunctionName.equals(RHS.FunctionName);
56 bool operator!=(const DILineInfo &RHS) const {
57 return !(*this == RHS);
61 typedef SmallVector<std::pair<uint64_t, DILineInfo>, 16> DILineInfoTable;
63 /// DIInliningInfo - a format-neutral container for inlined code description.
64 class DIInliningInfo {
65 SmallVector<DILineInfo, 4> Frames;
68 DILineInfo getFrame(unsigned Index) const {
69 assert(Index < Frames.size());
72 uint32_t getNumberOfFrames() const {
75 void addFrame(const DILineInfo &Frame) {
76 Frames.push_back(Frame);
80 /// DILineInfoSpecifier - controls which fields of DILineInfo container
81 /// should be filled with data.
82 class DILineInfoSpecifier {
83 const uint32_t Flags; // Or'ed flags that set the info we want to fetch.
86 FileLineInfo = 1 << 0,
87 AbsoluteFilePath = 1 << 1,
90 // Use file/line info by default.
91 DILineInfoSpecifier(uint32_t flags = FileLineInfo) : Flags(flags) {}
92 bool needs(Specification spec) const {
93 return (Flags & spec) > 0;
97 /// Selects which debug sections get dumped.
122 // In place of applying the relocations to the data we've read from disk we use
123 // a separate mapping table to the side and checking that at locations in the
124 // dwarf where we expect relocated values. This adds a bit of complexity to the
125 // dwarf parsing/extraction at the benefit of not allocating memory for the
126 // entire size of the debug info sections.
127 typedef DenseMap<uint64_t, std::pair<uint8_t, int64_t> > RelocAddrMap;
134 DIContextKind getKind() const { return Kind; }
136 DIContext(DIContextKind K) : Kind(K) {}
137 virtual ~DIContext();
139 /// getDWARFContext - get a context for binary DWARF data.
140 static DIContext *getDWARFContext(object::ObjectFile *);
142 virtual void dump(raw_ostream &OS, DIDumpType DumpType = DIDT_All) = 0;
144 virtual DILineInfo getLineInfoForAddress(uint64_t Address,
145 DILineInfoSpecifier Specifier = DILineInfoSpecifier()) = 0;
146 virtual DILineInfoTable getLineInfoForAddressRange(uint64_t Address,
147 uint64_t Size, DILineInfoSpecifier Specifier = DILineInfoSpecifier()) = 0;
148 virtual DIInliningInfo getInliningInfoForAddress(uint64_t Address,
149 DILineInfoSpecifier Specifier = DILineInfoSpecifier()) = 0;
151 const DIContextKind Kind;