1 //===-- DWARFContext.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 #ifndef LLVM_DEBUGINFO_DWARFCONTEXT_H
11 #define LLVM_DEBUGINFO_DWARFCONTEXT_H
13 #include "DWARFCompileUnit.h"
14 #include "DWARFDebugAranges.h"
15 #include "DWARFDebugLine.h"
16 #include "DWARFDebugRangeList.h"
17 #include "llvm/ADT/OwningPtr.h"
18 #include "llvm/ADT/SmallVector.h"
19 #include "llvm/DebugInfo/DIContext.h"
24 /// This data structure is the top level entity that deals with dwarf debug
25 /// information parsing. The actual data is supplied through pure virtual
26 /// methods that a concrete implementation provides.
27 class DWARFContext : public DIContext {
28 SmallVector<DWARFCompileUnit, 1> CUs;
29 OwningPtr<DWARFDebugAbbrev> Abbrev;
30 OwningPtr<DWARFDebugAranges> Aranges;
31 OwningPtr<DWARFDebugLine> Line;
33 SmallVector<DWARFCompileUnit, 1> DWOCUs;
34 OwningPtr<DWARFDebugAbbrev> AbbrevDWO;
36 DWARFContext(DWARFContext &) LLVM_DELETED_FUNCTION;
37 DWARFContext &operator=(DWARFContext &) LLVM_DELETED_FUNCTION;
39 /// Read compile units from the debug_info section and store them in CUs.
40 void parseCompileUnits();
42 /// Read compile units from the debug_info.dwo section and store them in
44 void parseDWOCompileUnits();
48 virtual void dump(raw_ostream &OS, DIDumpType DumpType = DIDT_All);
50 /// Get the number of compile units in this context.
51 unsigned getNumCompileUnits() {
57 /// Get the number of compile units in the DWO context.
58 unsigned getNumDWOCompileUnits() {
60 parseDWOCompileUnits();
64 /// Get the compile unit at the specified index for this compile unit.
65 DWARFCompileUnit *getCompileUnitAtIndex(unsigned index) {
71 /// Get the compile unit at the specified index for the DWO compile units.
72 DWARFCompileUnit *getDWOCompileUnitAtIndex(unsigned index) {
74 parseDWOCompileUnits();
75 return &DWOCUs[index];
78 /// Get a pointer to the parsed DebugAbbrev object.
79 const DWARFDebugAbbrev *getDebugAbbrev();
81 /// Get a pointer to the parsed dwo abbreviations object.
82 const DWARFDebugAbbrev *getDebugAbbrevDWO();
84 /// Get a pointer to the parsed DebugAranges object.
85 const DWARFDebugAranges *getDebugAranges();
87 /// Get a pointer to a parsed line table corresponding to a compile unit.
88 const DWARFDebugLine::LineTable *
89 getLineTableForCompileUnit(DWARFCompileUnit *cu);
91 virtual DILineInfo getLineInfoForAddress(uint64_t Address,
92 DILineInfoSpecifier Specifier = DILineInfoSpecifier());
93 virtual DILineInfoTable getLineInfoForAddressRange(uint64_t Address,
94 uint64_t Size, DILineInfoSpecifier Specifier = DILineInfoSpecifier());
95 virtual DIInliningInfo getInliningInfoForAddress(uint64_t Address,
96 DILineInfoSpecifier Specifier = DILineInfoSpecifier());
98 virtual bool isLittleEndian() const = 0;
99 virtual const RelocAddrMap &infoRelocMap() const = 0;
100 virtual const RelocAddrMap &lineRelocMap() const = 0;
101 virtual StringRef getInfoSection() = 0;
102 virtual StringRef getAbbrevSection() = 0;
103 virtual StringRef getARangeSection() = 0;
104 virtual StringRef getLineSection() = 0;
105 virtual StringRef getStringSection() = 0;
106 virtual StringRef getRangeSection() = 0;
108 // Sections for DWARF5 split dwarf proposal.
109 virtual StringRef getInfoDWOSection() = 0;
110 virtual StringRef getAbbrevDWOSection() = 0;
111 virtual StringRef getStringDWOSection() = 0;
112 virtual StringRef getStringOffsetDWOSection() = 0;
113 virtual StringRef getRangeDWOSection() = 0;
114 virtual StringRef getAddrSection() = 0;
115 virtual const RelocAddrMap &infoDWORelocMap() const = 0;
117 static bool isSupportedVersion(unsigned version) {
118 return version == 2 || version == 3;
121 /// Return the compile unit that includes an offset (relative to .debug_info).
122 DWARFCompileUnit *getCompileUnitForOffset(uint32_t Offset);
124 /// Return the compile unit which contains instruction with provided
126 DWARFCompileUnit *getCompileUnitForAddress(uint64_t Address);
129 /// DWARFContextInMemory is the simplest possible implementation of a
130 /// DWARFContext. It assumes all content is available in memory and stores
132 class DWARFContextInMemory : public DWARFContext {
133 virtual void anchor();
135 RelocAddrMap InfoRelocMap;
136 RelocAddrMap LineRelocMap;
137 StringRef InfoSection;
138 StringRef AbbrevSection;
139 StringRef ARangeSection;
140 StringRef LineSection;
141 StringRef StringSection;
142 StringRef RangeSection;
144 // Sections for DWARF5 split dwarf proposal.
145 RelocAddrMap InfoDWORelocMap;
146 StringRef InfoDWOSection;
147 StringRef AbbrevDWOSection;
148 StringRef StringDWOSection;
149 StringRef StringOffsetDWOSection;
150 StringRef RangeDWOSection;
151 StringRef AddrSection;
154 DWARFContextInMemory(object::ObjectFile *);
155 virtual bool isLittleEndian() const { return IsLittleEndian; }
156 virtual const RelocAddrMap &infoRelocMap() const { return InfoRelocMap; }
157 virtual const RelocAddrMap &lineRelocMap() const { return LineRelocMap; }
158 virtual StringRef getInfoSection() { return InfoSection; }
159 virtual StringRef getAbbrevSection() { return AbbrevSection; }
160 virtual StringRef getARangeSection() { return ARangeSection; }
161 virtual StringRef getLineSection() { return LineSection; }
162 virtual StringRef getStringSection() { return StringSection; }
163 virtual StringRef getRangeSection() { return RangeSection; }
165 // Sections for DWARF5 split dwarf proposal.
166 virtual StringRef getInfoDWOSection() { return InfoDWOSection; }
167 virtual StringRef getAbbrevDWOSection() { return AbbrevDWOSection; }
168 virtual StringRef getStringDWOSection() { return StringDWOSection; }
169 virtual StringRef getStringOffsetDWOSection() {
170 return StringOffsetDWOSection;
172 virtual StringRef getRangeDWOSection() { return RangeDWOSection; }
173 virtual StringRef getAddrSection() {
176 virtual const RelocAddrMap &infoDWORelocMap() const {
177 return InfoDWORelocMap;