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_LIB_DEBUGINFO_DWARFCONTEXT_H
11 #define LLVM_LIB_DEBUGINFO_DWARFCONTEXT_H
13 #include "DWARFCompileUnit.h"
14 #include "DWARFDebugAranges.h"
15 #include "DWARFDebugFrame.h"
16 #include "DWARFDebugLine.h"
17 #include "DWARFDebugLoc.h"
18 #include "DWARFDebugRangeList.h"
19 #include "DWARFTypeUnit.h"
20 #include "llvm/ADT/MapVector.h"
21 #include "llvm/ADT/SmallVector.h"
22 #include "llvm/DebugInfo/DIContext.h"
27 /// This data structure is the top level entity that deals with dwarf debug
28 /// information parsing. The actual data is supplied through pure virtual
29 /// methods that a concrete implementation provides.
30 class DWARFContext : public DIContext {
31 typedef SmallVector<std::unique_ptr<DWARFCompileUnit>, 1> CUVector;
32 typedef SmallVector<std::unique_ptr<DWARFTypeUnit>, 1> TUVector;
36 std::unique_ptr<DWARFDebugAbbrev> Abbrev;
37 std::unique_ptr<DWARFDebugLoc> Loc;
38 std::unique_ptr<DWARFDebugAranges> Aranges;
39 std::unique_ptr<DWARFDebugLine> Line;
40 std::unique_ptr<DWARFDebugFrame> DebugFrame;
44 std::unique_ptr<DWARFDebugAbbrev> AbbrevDWO;
45 std::unique_ptr<DWARFDebugLocDWO> LocDWO;
47 DWARFContext(DWARFContext &) LLVM_DELETED_FUNCTION;
48 DWARFContext &operator=(DWARFContext &) LLVM_DELETED_FUNCTION;
50 /// Read compile units from the debug_info section (if necessary)
51 /// and store them in CUs.
52 void parseCompileUnits();
54 /// Read type units from the debug_types sections (if necessary)
55 /// and store them in TUs.
56 void parseTypeUnits();
58 /// Read compile units from the debug_info.dwo section (if necessary)
59 /// and store them in DWOCUs.
60 void parseDWOCompileUnits();
62 /// Read type units from the debug_types.dwo section (if necessary)
63 /// and store them in DWOTUs.
64 void parseDWOTypeUnits();
72 DWARFContext() : DIContext(CK_DWARF) {}
74 static bool classof(const DIContext *DICtx) {
75 return DICtx->getKind() == CK_DWARF;
78 void dump(raw_ostream &OS, DIDumpType DumpType = DIDT_All) override;
80 typedef iterator_range<CUVector::iterator> cu_iterator_range;
81 typedef iterator_range<TUVector::iterator> tu_iterator_range;
83 /// Get compile units in this context.
84 cu_iterator_range compile_units() {
86 return cu_iterator_range(CUs.begin(), CUs.end());
89 /// Get type units in this context.
90 tu_iterator_range type_units() {
92 return tu_iterator_range(TUs.begin(), TUs.end());
95 /// Get compile units in the DWO context.
96 cu_iterator_range dwo_compile_units() {
97 parseDWOCompileUnits();
98 return cu_iterator_range(DWOCUs.begin(), DWOCUs.end());
101 /// Get type units in the DWO context.
102 tu_iterator_range dwo_type_units() {
104 return tu_iterator_range(DWOTUs.begin(), DWOTUs.end());
107 /// Get the number of compile units in this context.
108 unsigned getNumCompileUnits() {
113 /// Get the number of compile units in this context.
114 unsigned getNumTypeUnits() {
119 /// Get the number of compile units in the DWO context.
120 unsigned getNumDWOCompileUnits() {
121 parseDWOCompileUnits();
122 return DWOCUs.size();
125 /// Get the number of compile units in the DWO context.
126 unsigned getNumDWOTypeUnits() {
128 return DWOTUs.size();
131 /// Get the compile unit at the specified index for this compile unit.
132 DWARFCompileUnit *getCompileUnitAtIndex(unsigned index) {
134 return CUs[index].get();
137 /// Get the compile unit at the specified index for the DWO compile units.
138 DWARFCompileUnit *getDWOCompileUnitAtIndex(unsigned index) {
139 parseDWOCompileUnits();
140 return DWOCUs[index].get();
143 /// Get a pointer to the parsed DebugAbbrev object.
144 const DWARFDebugAbbrev *getDebugAbbrev();
146 /// Get a pointer to the parsed DebugLoc object.
147 const DWARFDebugLoc *getDebugLoc();
149 /// Get a pointer to the parsed dwo abbreviations object.
150 const DWARFDebugAbbrev *getDebugAbbrevDWO();
152 /// Get a pointer to the parsed DebugLoc object.
153 const DWARFDebugLocDWO *getDebugLocDWO();
155 /// Get a pointer to the parsed DebugAranges object.
156 const DWARFDebugAranges *getDebugAranges();
158 /// Get a pointer to the parsed frame information object.
159 const DWARFDebugFrame *getDebugFrame();
161 /// Get a pointer to a parsed line table corresponding to a compile unit.
162 const DWARFDebugLine::LineTable *getLineTableForUnit(DWARFUnit *cu);
164 DILineInfo getLineInfoForAddress(uint64_t Address,
165 DILineInfoSpecifier Specifier = DILineInfoSpecifier()) override;
166 DILineInfoTable getLineInfoForAddressRange(uint64_t Address, uint64_t Size,
167 DILineInfoSpecifier Specifier = DILineInfoSpecifier()) override;
168 DIInliningInfo getInliningInfoForAddress(uint64_t Address,
169 DILineInfoSpecifier Specifier = DILineInfoSpecifier()) override;
171 virtual bool isLittleEndian() const = 0;
172 virtual uint8_t getAddressSize() const = 0;
173 virtual const Section &getInfoSection() = 0;
174 typedef MapVector<object::SectionRef, Section,
175 std::map<object::SectionRef, unsigned> > TypeSectionMap;
176 virtual const TypeSectionMap &getTypesSections() = 0;
177 virtual StringRef getAbbrevSection() = 0;
178 virtual const Section &getLocSection() = 0;
179 virtual const Section &getLocDWOSection() = 0;
180 virtual StringRef getARangeSection() = 0;
181 virtual StringRef getDebugFrameSection() = 0;
182 virtual const Section &getLineSection() = 0;
183 virtual const Section &getLineDWOSection() = 0;
184 virtual StringRef getStringSection() = 0;
185 virtual StringRef getRangeSection() = 0;
186 virtual StringRef getPubNamesSection() = 0;
187 virtual StringRef getPubTypesSection() = 0;
188 virtual StringRef getGnuPubNamesSection() = 0;
189 virtual StringRef getGnuPubTypesSection() = 0;
191 // Sections for DWARF5 split dwarf proposal.
192 virtual const Section &getInfoDWOSection() = 0;
193 virtual const TypeSectionMap &getTypesDWOSections() = 0;
194 virtual StringRef getAbbrevDWOSection() = 0;
195 virtual StringRef getStringDWOSection() = 0;
196 virtual StringRef getStringOffsetDWOSection() = 0;
197 virtual StringRef getRangeDWOSection() = 0;
198 virtual StringRef getAddrSection() = 0;
200 static bool isSupportedVersion(unsigned version) {
201 return version == 2 || version == 3 || version == 4;
204 /// Return the compile unit that includes an offset (relative to .debug_info).
205 DWARFCompileUnit *getCompileUnitForOffset(uint32_t Offset);
207 /// Return the compile unit which contains instruction with provided
209 DWARFCompileUnit *getCompileUnitForAddress(uint64_t Address);
212 /// DWARFContextInMemory is the simplest possible implementation of a
213 /// DWARFContext. It assumes all content is available in memory and stores
215 class DWARFContextInMemory : public DWARFContext {
216 virtual void anchor();
220 TypeSectionMap TypesSections;
221 StringRef AbbrevSection;
223 Section LocDWOSection;
224 StringRef ARangeSection;
225 StringRef DebugFrameSection;
227 Section LineDWOSection;
228 StringRef StringSection;
229 StringRef RangeSection;
230 StringRef PubNamesSection;
231 StringRef PubTypesSection;
232 StringRef GnuPubNamesSection;
233 StringRef GnuPubTypesSection;
235 // Sections for DWARF5 split dwarf proposal.
236 Section InfoDWOSection;
237 TypeSectionMap TypesDWOSections;
238 StringRef AbbrevDWOSection;
239 StringRef StringDWOSection;
240 StringRef StringOffsetDWOSection;
241 StringRef RangeDWOSection;
242 StringRef AddrSection;
244 SmallVector<SmallString<32>, 4> UncompressedSections;
247 DWARFContextInMemory(object::ObjectFile &);
248 bool isLittleEndian() const override { return IsLittleEndian; }
249 uint8_t getAddressSize() const override { return AddressSize; }
250 const Section &getInfoSection() override { return InfoSection; }
251 const TypeSectionMap &getTypesSections() override { return TypesSections; }
252 StringRef getAbbrevSection() override { return AbbrevSection; }
253 const Section &getLocSection() override { return LocSection; }
254 const Section &getLocDWOSection() override { return LocDWOSection; }
255 StringRef getARangeSection() override { return ARangeSection; }
256 StringRef getDebugFrameSection() override { return DebugFrameSection; }
257 const Section &getLineSection() override { return LineSection; }
258 const Section &getLineDWOSection() override { return LineDWOSection; }
259 StringRef getStringSection() override { return StringSection; }
260 StringRef getRangeSection() override { return RangeSection; }
261 StringRef getPubNamesSection() override { return PubNamesSection; }
262 StringRef getPubTypesSection() override { return PubTypesSection; }
263 StringRef getGnuPubNamesSection() override { return GnuPubNamesSection; }
264 StringRef getGnuPubTypesSection() override { return GnuPubTypesSection; }
266 // Sections for DWARF5 split dwarf proposal.
267 const Section &getInfoDWOSection() override { return InfoDWOSection; }
268 const TypeSectionMap &getTypesDWOSections() override {
269 return TypesDWOSections;
271 StringRef getAbbrevDWOSection() override { return AbbrevDWOSection; }
272 StringRef getStringDWOSection() override { return StringDWOSection; }
273 StringRef getStringOffsetDWOSection() override {
274 return StringOffsetDWOSection;
276 StringRef getRangeDWOSection() override { return RangeDWOSection; }
277 StringRef getAddrSection() override {