blob: f8234e93c58cc5c401a70e6a1b7b6a0a09f103de [file] [log] [blame]
Benjamin Kramer72c0d7f2011-09-13 19:42:23 +00001//===-- DWARFContext.cpp --------------------------------------------------===//
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#include "DWARFContext.h"
Alexey Samsonov71d94f82012-07-19 07:03:58 +000011#include "llvm/ADT/SmallString.h"
Alexey Samsonov784baa62013-04-17 14:27:04 +000012#include "llvm/ADT/StringSwitch.h"
Alexey Samsonov005159e2013-04-23 10:17:34 +000013#include "llvm/ADT/STLExtras.h"
14#include "llvm/Support/Compression.h"
Benjamin Kramerfe80f1d2011-09-15 18:02:20 +000015#include "llvm/Support/Dwarf.h"
Benjamin Kramer34f864f2011-09-15 16:57:13 +000016#include "llvm/Support/Format.h"
Alexey Samsonov71d94f82012-07-19 07:03:58 +000017#include "llvm/Support/Path.h"
Benjamin Kramer358f4fd2011-09-14 01:09:52 +000018#include "llvm/Support/raw_ostream.h"
Benjamin Kramer101b1c52011-09-15 20:43:22 +000019#include <algorithm>
Benjamin Kramer72c0d7f2011-09-13 19:42:23 +000020using namespace llvm;
Benjamin Kramerfe80f1d2011-09-15 18:02:20 +000021using namespace dwarf;
Rafael Espindola7486d922013-05-30 03:05:14 +000022using namespace object;
Benjamin Kramer72c0d7f2011-09-13 19:42:23 +000023
Eric Christophere9403c12012-10-16 23:46:25 +000024typedef DWARFDebugLine::LineTable DWARFLineTable;
25
Alexey Samsonoveb0c1792013-08-23 06:56:01 +000026DWARFContext::~DWARFContext() {
27 DeleteContainerPointers(CUs);
28 DeleteContainerPointers(DWOCUs);
29}
30
David Blaikie9ddf28d2013-09-24 19:50:00 +000031static void dumpPubSection(raw_ostream &OS, StringRef Name, StringRef Data,
Eric Christopherc839df02013-09-25 23:02:36 +000032 bool LittleEndian, bool GnuStyle) {
David Blaikie9ddf28d2013-09-24 19:50:00 +000033 OS << "\n." << Name << " contents:\n";
34 DataExtractor pubNames(Data, LittleEndian, 0);
35 uint32_t offset = 0;
36 OS << "Length: " << pubNames.getU32(&offset) << "\n";
37 OS << "Version: " << pubNames.getU16(&offset) << "\n";
38 OS << "Offset in .debug_info: " << pubNames.getU32(&offset) << "\n";
39 OS << "Size: " << pubNames.getU32(&offset) << "\n";
Eric Christopherc839df02013-09-25 23:02:36 +000040 if (GnuStyle)
41 OS << "Offset Linkage Kind Name\n";
42 else
Eric Christopher5972df22013-09-27 22:10:10 +000043 OS << "Offset Name\n";
Eric Christopherc839df02013-09-25 23:02:36 +000044
David Blaikie9ddf28d2013-09-24 19:50:00 +000045 while (offset < Data.size()) {
46 uint32_t dieRef = pubNames.getU32(&offset);
47 if (dieRef == 0)
48 break;
Eric Christopher5972df22013-09-27 22:10:10 +000049 OS << format("0x%8.8x ", dieRef);
Eric Christopherc839df02013-09-25 23:02:36 +000050 if (GnuStyle) {
51 PubIndexEntryDescriptor desc(pubNames.getU8(&offset));
Eric Christopher5972df22013-09-27 22:10:10 +000052 OS << format("%-8s", dwarf::GDBIndexEntryLinkageString(desc.Linkage))
Eric Christopherc839df02013-09-25 23:02:36 +000053 << ' ' << format("%-8s", dwarf::GDBIndexEntryKindString(desc.Kind))
Eric Christopher5972df22013-09-27 22:10:10 +000054 << ' ';
Eric Christopherc839df02013-09-25 23:02:36 +000055 }
Eric Christopher5972df22013-09-27 22:10:10 +000056 OS << '\"' << pubNames.getCStr(&offset) << "\"\n";
David Blaikie9ddf28d2013-09-24 19:50:00 +000057 }
58}
59
Eli Bendersky939a4e82013-01-25 20:26:43 +000060void DWARFContext::dump(raw_ostream &OS, DIDumpType DumpType) {
61 if (DumpType == DIDT_All || DumpType == DIDT_Abbrev) {
62 OS << ".debug_abbrev contents:\n";
63 getDebugAbbrev()->dump(OS);
64 }
Benjamin Kramer358f4fd2011-09-14 01:09:52 +000065
Eli Bendersky939a4e82013-01-25 20:26:43 +000066 if (DumpType == DIDT_All || DumpType == DIDT_Info) {
67 OS << "\n.debug_info contents:\n";
68 for (unsigned i = 0, e = getNumCompileUnits(); i != e; ++i)
69 getCompileUnitAtIndex(i)->dump(OS);
70 }
Benjamin Kramer358f4fd2011-09-14 01:09:52 +000071
David Blaikie438f5392013-09-23 22:44:47 +000072 if (DumpType == DIDT_All || DumpType == DIDT_Types) {
73 OS << "\n.debug_types contents:\n";
74 for (unsigned i = 0, e = getNumTypeUnits(); i != e; ++i)
75 getTypeUnitAtIndex(i)->dump(OS);
76 }
77
David Blaikie3df7d2f2013-06-19 21:37:13 +000078 if (DumpType == DIDT_All || DumpType == DIDT_Loc) {
David Blaikie438f5392013-09-23 22:44:47 +000079 OS << "\n.debug_loc contents:\n";
David Blaikie3df7d2f2013-06-19 21:37:13 +000080 getDebugLoc()->dump(OS);
81 }
82
Eli Bendersky60bdc5b2013-02-05 23:30:58 +000083 if (DumpType == DIDT_All || DumpType == DIDT_Frames) {
84 OS << "\n.debug_frame contents:\n";
85 getDebugFrame()->dump(OS);
86 }
87
Benjamin Kramer358f4fd2011-09-14 01:09:52 +000088 uint32_t offset = 0;
Eli Bendersky939a4e82013-01-25 20:26:43 +000089 if (DumpType == DIDT_All || DumpType == DIDT_Aranges) {
90 OS << "\n.debug_aranges contents:\n";
91 DataExtractor arangesData(getARangeSection(), isLittleEndian(), 0);
92 DWARFDebugArangeSet set;
93 while (set.extract(arangesData, &offset))
94 set.dump(OS);
95 }
Benjamin Kramerb848e972011-09-15 02:12:05 +000096
Alexey Samsonoveceb5b92012-08-27 07:17:47 +000097 uint8_t savedAddressByteSize = 0;
Eli Bendersky939a4e82013-01-25 20:26:43 +000098 if (DumpType == DIDT_All || DumpType == DIDT_Line) {
99 OS << "\n.debug_line contents:\n";
100 for (unsigned i = 0, e = getNumCompileUnits(); i != e; ++i) {
101 DWARFCompileUnit *cu = getCompileUnitAtIndex(i);
102 savedAddressByteSize = cu->getAddressByteSize();
103 unsigned stmtOffset =
104 cu->getCompileUnitDIE()->getAttributeValueAsUnsigned(cu, DW_AT_stmt_list,
105 -1U);
106 if (stmtOffset != -1U) {
David Blaikie9528b0e2013-09-23 17:42:01 +0000107 DataExtractor lineData(getLineSection().Data, isLittleEndian(),
Eli Bendersky939a4e82013-01-25 20:26:43 +0000108 savedAddressByteSize);
109 DWARFDebugLine::DumpingState state(OS);
David Blaikie9528b0e2013-09-23 17:42:01 +0000110 DWARFDebugLine::parseStatementTable(lineData, &getLineSection().Relocs, &stmtOffset, state);
Eli Bendersky939a4e82013-01-25 20:26:43 +0000111 }
Benjamin Kramerfe80f1d2011-09-15 18:02:20 +0000112 }
113 }
Benjamin Kramer34f864f2011-09-15 16:57:13 +0000114
Eli Bendersky939a4e82013-01-25 20:26:43 +0000115 if (DumpType == DIDT_All || DumpType == DIDT_Str) {
116 OS << "\n.debug_str contents:\n";
117 DataExtractor strData(getStringSection(), isLittleEndian(), 0);
118 offset = 0;
119 uint32_t strOffset = 0;
120 while (const char *s = strData.getCStr(&offset)) {
121 OS << format("0x%8.8x: \"%s\"\n", strOffset, s);
122 strOffset = offset;
123 }
Benjamin Kramer34f864f2011-09-15 16:57:13 +0000124 }
Alexey Samsonoveceb5b92012-08-27 07:17:47 +0000125
Eli Bendersky939a4e82013-01-25 20:26:43 +0000126 if (DumpType == DIDT_All || DumpType == DIDT_Ranges) {
127 OS << "\n.debug_ranges contents:\n";
128 // In fact, different compile units may have different address byte
129 // sizes, but for simplicity we just use the address byte size of the last
130 // compile unit (there is no easy and fast way to associate address range
131 // list and the compile unit it describes).
132 DataExtractor rangesData(getRangeSection(), isLittleEndian(),
133 savedAddressByteSize);
134 offset = 0;
135 DWARFDebugRangeList rangeList;
136 while (rangeList.extract(rangesData, &offset))
137 rangeList.dump(OS);
Eric Christopher82de10a2013-01-02 23:52:13 +0000138 }
Eric Christopher72f7bfb2013-01-15 23:56:56 +0000139
Eric Christopherc839df02013-09-25 23:02:36 +0000140 if (DumpType == DIDT_All || DumpType == DIDT_Pubnames)
141 dumpPubSection(OS, "debug_pubnames", getPubNamesSection(),
142 isLittleEndian(), false);
Krzysztof Parzyszeke38825f2013-02-12 16:20:28 +0000143
Eric Christopher7357f032013-09-25 23:02:41 +0000144 if (DumpType == DIDT_All || DumpType == DIDT_Pubtypes)
145 dumpPubSection(OS, "debug_pubtypes", getPubTypesSection(),
146 isLittleEndian(), false);
147
David Blaikie9ddf28d2013-09-24 19:50:00 +0000148 if (DumpType == DIDT_All || DumpType == DIDT_GnuPubnames)
149 dumpPubSection(OS, "debug_gnu_pubnames", getGnuPubNamesSection(),
Eric Christopherc839df02013-09-25 23:02:36 +0000150 isLittleEndian(), true /* GnuStyle */);
David Blaikie9ddf28d2013-09-24 19:50:00 +0000151
152 if (DumpType == DIDT_All || DumpType == DIDT_GnuPubtypes)
153 dumpPubSection(OS, "debug_gnu_pubtypes", getGnuPubTypesSection(),
Eric Christopherc839df02013-09-25 23:02:36 +0000154 isLittleEndian(), true /* GnuStyle */);
David Blaikie994c37f2013-09-19 23:01:29 +0000155
Eli Bendersky939a4e82013-01-25 20:26:43 +0000156 if (DumpType == DIDT_All || DumpType == DIDT_AbbrevDwo) {
Eric Christopher93f3fed2013-05-06 17:50:42 +0000157 const DWARFDebugAbbrev *D = getDebugAbbrevDWO();
158 if (D) {
159 OS << "\n.debug_abbrev.dwo contents:\n";
160 getDebugAbbrevDWO()->dump(OS);
Eli Bendersky939a4e82013-01-25 20:26:43 +0000161 }
162 }
163
Eric Christopher93f3fed2013-05-06 17:50:42 +0000164 if (DumpType == DIDT_All || DumpType == DIDT_InfoDwo)
165 if (getNumDWOCompileUnits()) {
166 OS << "\n.debug_info.dwo contents:\n";
167 for (unsigned i = 0, e = getNumDWOCompileUnits(); i != e; ++i)
Eric Christopher5a0c3662013-05-06 21:19:41 +0000168 getDWOCompileUnitAtIndex(i)->dump(OS);
Eli Bendersky939a4e82013-01-25 20:26:43 +0000169 }
Eric Christopher93f3fed2013-05-06 17:50:42 +0000170
171 if (DumpType == DIDT_All || DumpType == DIDT_StrDwo)
172 if (!getStringDWOSection().empty()) {
173 OS << "\n.debug_str.dwo contents:\n";
174 DataExtractor strDWOData(getStringDWOSection(), isLittleEndian(), 0);
175 offset = 0;
176 uint32_t strDWOOffset = 0;
177 while (const char *s = strDWOData.getCStr(&offset)) {
Eric Christopher5a0c3662013-05-06 21:19:41 +0000178 OS << format("0x%8.8x: \"%s\"\n", strDWOOffset, s);
179 strDWOOffset = offset;
Eric Christopher93f3fed2013-05-06 17:50:42 +0000180 }
181 }
182
183 if (DumpType == DIDT_All || DumpType == DIDT_StrOffsetsDwo)
184 if (!getStringOffsetDWOSection().empty()) {
185 OS << "\n.debug_str_offsets.dwo contents:\n";
186 DataExtractor strOffsetExt(getStringOffsetDWOSection(), isLittleEndian(), 0);
187 offset = 0;
Eric Christophere305e032013-05-06 21:19:44 +0000188 uint64_t size = getStringOffsetDWOSection().size();
189 while (offset < size) {
Eric Christopher5a0c3662013-05-06 21:19:41 +0000190 OS << format("0x%8.8x: ", offset);
191 OS << format("%8.8x\n", strOffsetExt.getU32(&offset));
Eric Christopher93f3fed2013-05-06 17:50:42 +0000192 }
193 }
Benjamin Kramer72c0d7f2011-09-13 19:42:23 +0000194}
195
196const DWARFDebugAbbrev *DWARFContext::getDebugAbbrev() {
197 if (Abbrev)
198 return Abbrev.get();
199
200 DataExtractor abbrData(getAbbrevSection(), isLittleEndian(), 0);
201
202 Abbrev.reset(new DWARFDebugAbbrev());
203 Abbrev->parse(abbrData);
204 return Abbrev.get();
205}
206
Eric Christopher82de10a2013-01-02 23:52:13 +0000207const DWARFDebugAbbrev *DWARFContext::getDebugAbbrevDWO() {
208 if (AbbrevDWO)
209 return AbbrevDWO.get();
210
211 DataExtractor abbrData(getAbbrevDWOSection(), isLittleEndian(), 0);
212 AbbrevDWO.reset(new DWARFDebugAbbrev());
213 AbbrevDWO->parse(abbrData);
214 return AbbrevDWO.get();
215}
216
David Blaikie3df7d2f2013-06-19 21:37:13 +0000217const DWARFDebugLoc *DWARFContext::getDebugLoc() {
218 if (Loc)
219 return Loc.get();
220
David Blaikie9528b0e2013-09-23 17:42:01 +0000221 DataExtractor LocData(getLocSection().Data, isLittleEndian(), 0);
222 Loc.reset(new DWARFDebugLoc(getLocSection().Relocs));
David Blaikie3df7d2f2013-06-19 21:37:13 +0000223 // assume all compile units have the same address byte size
224 if (getNumCompileUnits())
225 Loc->parse(LocData, getCompileUnitAtIndex(0)->getAddressByteSize());
226 return Loc.get();
227}
228
Benjamin Kramer358f4fd2011-09-14 01:09:52 +0000229const DWARFDebugAranges *DWARFContext::getDebugAranges() {
230 if (Aranges)
231 return Aranges.get();
232
233 DataExtractor arangesData(getARangeSection(), isLittleEndian(), 0);
234
235 Aranges.reset(new DWARFDebugAranges());
236 Aranges->extract(arangesData);
Alexey Samsonov63a450a2012-11-16 08:36:25 +0000237 // Generate aranges from DIEs: even if .debug_aranges section is present,
238 // it may describe only a small subset of compilation units, so we need to
239 // manually build aranges for the rest of them.
240 Aranges->generate(this);
Benjamin Kramer358f4fd2011-09-14 01:09:52 +0000241 return Aranges.get();
242}
243
Eli Bendersky60bdc5b2013-02-05 23:30:58 +0000244const DWARFDebugFrame *DWARFContext::getDebugFrame() {
245 if (DebugFrame)
246 return DebugFrame.get();
247
248 // There's a "bug" in the DWARFv3 standard with respect to the target address
249 // size within debug frame sections. While DWARF is supposed to be independent
250 // of its container, FDEs have fields with size being "target address size",
251 // which isn't specified in DWARF in general. It's only specified for CUs, but
252 // .eh_frame can appear without a .debug_info section. Follow the example of
253 // other tools (libdwarf) and extract this from the container (ObjectFile
254 // provides this information). This problem is fixed in DWARFv4
255 // See this dwarf-discuss discussion for more details:
256 // http://lists.dwarfstd.org/htdig.cgi/dwarf-discuss-dwarfstd.org/2011-December/001173.html
257 DataExtractor debugFrameData(getDebugFrameSection(), isLittleEndian(),
258 getAddressSize());
259 DebugFrame.reset(new DWARFDebugFrame());
260 DebugFrame->parse(debugFrameData);
261 return DebugFrame.get();
262}
263
Eric Christophere9403c12012-10-16 23:46:25 +0000264const DWARFLineTable *
Benjamin Kramerc26ed9b2011-09-15 20:43:18 +0000265DWARFContext::getLineTableForCompileUnit(DWARFCompileUnit *cu) {
266 if (!Line)
David Blaikie9528b0e2013-09-23 17:42:01 +0000267 Line.reset(new DWARFDebugLine(&getLineSection().Relocs));
Benjamin Kramerb848e972011-09-15 02:12:05 +0000268
Benjamin Kramerc26ed9b2011-09-15 20:43:18 +0000269 unsigned stmtOffset =
270 cu->getCompileUnitDIE()->getAttributeValueAsUnsigned(cu, DW_AT_stmt_list,
271 -1U);
272 if (stmtOffset == -1U)
273 return 0; // No line table for this compile unit.
Benjamin Kramerb848e972011-09-15 02:12:05 +0000274
Benjamin Kramerc26ed9b2011-09-15 20:43:18 +0000275 // See if the line table is cached.
Eric Christophere9403c12012-10-16 23:46:25 +0000276 if (const DWARFLineTable *lt = Line->getLineTable(stmtOffset))
Benjamin Kramerc26ed9b2011-09-15 20:43:18 +0000277 return lt;
278
279 // We have to parse it first.
David Blaikie9528b0e2013-09-23 17:42:01 +0000280 DataExtractor lineData(getLineSection().Data, isLittleEndian(),
Benjamin Kramerc26ed9b2011-09-15 20:43:18 +0000281 cu->getAddressByteSize());
282 return Line->getOrParseLineTable(lineData, stmtOffset);
Benjamin Kramerb848e972011-09-15 02:12:05 +0000283}
284
Benjamin Kramer72c0d7f2011-09-13 19:42:23 +0000285void DWARFContext::parseCompileUnits() {
286 uint32_t offset = 0;
David Blaikie9528b0e2013-09-23 17:42:01 +0000287 const DataExtractor &DIData = DataExtractor(getInfoSection().Data,
Eric Christopherb69b55f2012-10-16 23:46:23 +0000288 isLittleEndian(), 0);
289 while (DIData.isValidOffset(offset)) {
Alexey Samsonoveb0c1792013-08-23 06:56:01 +0000290 OwningPtr<DWARFCompileUnit> CU(new DWARFCompileUnit(
David Blaikie9528b0e2013-09-23 17:42:01 +0000291 getDebugAbbrev(), getInfoSection().Data, getAbbrevSection(),
Alexey Samsonoveb0c1792013-08-23 06:56:01 +0000292 getRangeSection(), getStringSection(), StringRef(), getAddrSection(),
David Blaikie9528b0e2013-09-23 17:42:01 +0000293 &getInfoSection().Relocs, isLittleEndian()));
Alexey Samsonoveb0c1792013-08-23 06:56:01 +0000294 if (!CU->extract(DIData, &offset)) {
Benjamin Kramer72c0d7f2011-09-13 19:42:23 +0000295 break;
296 }
Alexey Samsonoveb0c1792013-08-23 06:56:01 +0000297 CUs.push_back(CU.take());
David Blaikiecd7c4982013-09-23 22:44:40 +0000298 offset = CUs.back()->getNextUnitOffset();
Benjamin Kramer72c0d7f2011-09-13 19:42:23 +0000299 }
300}
Benjamin Kramer101b1c52011-09-15 20:43:22 +0000301
David Blaikie438f5392013-09-23 22:44:47 +0000302void DWARFContext::parseTypeUnits() {
303 const std::map<object::SectionRef, Section> &Sections = getTypesSections();
304 for (std::map<object::SectionRef, Section>::const_iterator
305 I = Sections.begin(),
306 E = Sections.end();
307 I != E; ++I) {
308 uint32_t offset = 0;
309 const DataExtractor &DIData =
310 DataExtractor(I->second.Data, isLittleEndian(), 0);
311 while (DIData.isValidOffset(offset)) {
312 OwningPtr<DWARFTypeUnit> TU(new DWARFTypeUnit(
313 getDebugAbbrev(), I->second.Data, getAbbrevSection(),
314 getRangeSection(), getStringSection(), StringRef(), getAddrSection(),
315 &I->second.Relocs, isLittleEndian()));
316 if (!TU->extract(DIData, &offset))
317 break;
318 TUs.push_back(TU.take());
319 offset = TUs.back()->getNextUnitOffset();
320 }
321 }
322}
323
Eric Christopher82de10a2013-01-02 23:52:13 +0000324void DWARFContext::parseDWOCompileUnits() {
325 uint32_t offset = 0;
David Blaikie9528b0e2013-09-23 17:42:01 +0000326 const DataExtractor &DIData =
327 DataExtractor(getInfoDWOSection().Data, isLittleEndian(), 0);
Eric Christopher82de10a2013-01-02 23:52:13 +0000328 while (DIData.isValidOffset(offset)) {
Alexey Samsonoveb0c1792013-08-23 06:56:01 +0000329 OwningPtr<DWARFCompileUnit> DWOCU(new DWARFCompileUnit(
David Blaikie9528b0e2013-09-23 17:42:01 +0000330 getDebugAbbrevDWO(), getInfoDWOSection().Data, getAbbrevDWOSection(),
Alexey Samsonoveb0c1792013-08-23 06:56:01 +0000331 getRangeDWOSection(), getStringDWOSection(),
David Blaikie9528b0e2013-09-23 17:42:01 +0000332 getStringOffsetDWOSection(), getAddrSection(),
333 &getInfoDWOSection().Relocs, isLittleEndian()));
Alexey Samsonoveb0c1792013-08-23 06:56:01 +0000334 if (!DWOCU->extract(DIData, &offset)) {
Eric Christopher82de10a2013-01-02 23:52:13 +0000335 break;
336 }
Alexey Samsonoveb0c1792013-08-23 06:56:01 +0000337 DWOCUs.push_back(DWOCU.take());
David Blaikiecd7c4982013-09-23 22:44:40 +0000338 offset = DWOCUs.back()->getNextUnitOffset();
Eric Christopher82de10a2013-01-02 23:52:13 +0000339 }
340}
341
Benjamin Kramer101b1c52011-09-15 20:43:22 +0000342namespace {
343 struct OffsetComparator {
Alexey Samsonoveb0c1792013-08-23 06:56:01 +0000344 bool operator()(const DWARFCompileUnit *LHS,
345 const DWARFCompileUnit *RHS) const {
346 return LHS->getOffset() < RHS->getOffset();
Benjamin Kramer101b1c52011-09-15 20:43:22 +0000347 }
Alexey Samsonoveb0c1792013-08-23 06:56:01 +0000348 bool operator()(const DWARFCompileUnit *LHS, uint32_t RHS) const {
349 return LHS->getOffset() < RHS;
Benjamin Kramer101b1c52011-09-15 20:43:22 +0000350 }
Alexey Samsonoveb0c1792013-08-23 06:56:01 +0000351 bool operator()(uint32_t LHS, const DWARFCompileUnit *RHS) const {
352 return LHS < RHS->getOffset();
Benjamin Kramer101b1c52011-09-15 20:43:22 +0000353 }
354 };
355}
356
Alexey Samsonov38a63812012-08-30 07:49:50 +0000357DWARFCompileUnit *DWARFContext::getCompileUnitForOffset(uint32_t Offset) {
Benjamin Kramer101b1c52011-09-15 20:43:22 +0000358 if (CUs.empty())
359 parseCompileUnits();
360
Alexey Samsonoveb0c1792013-08-23 06:56:01 +0000361 DWARFCompileUnit **CU =
362 std::lower_bound(CUs.begin(), CUs.end(), Offset, OffsetComparator());
363 if (CU != CUs.end()) {
364 return *CU;
365 }
Benjamin Kramer101b1c52011-09-15 20:43:22 +0000366 return 0;
367}
368
Alexey Samsonov38a63812012-08-30 07:49:50 +0000369DWARFCompileUnit *DWARFContext::getCompileUnitForAddress(uint64_t Address) {
Benjamin Kramer9013db32011-09-15 21:59:13 +0000370 // First, get the offset of the compile unit.
Alexey Samsonov38a63812012-08-30 07:49:50 +0000371 uint32_t CUOffset = getDebugAranges()->findAddress(Address);
Benjamin Kramer101b1c52011-09-15 20:43:22 +0000372 // Retrieve the compile unit.
Alexey Samsonov38a63812012-08-30 07:49:50 +0000373 return getCompileUnitForOffset(CUOffset);
374}
375
Eric Christophere9403c12012-10-16 23:46:25 +0000376static bool getFileNameForCompileUnit(DWARFCompileUnit *CU,
377 const DWARFLineTable *LineTable,
378 uint64_t FileIndex,
379 bool NeedsAbsoluteFilePath,
380 std::string &FileName) {
Alexey Samsonov38a63812012-08-30 07:49:50 +0000381 if (CU == 0 ||
382 LineTable == 0 ||
383 !LineTable->getFileNameByIndex(FileIndex, NeedsAbsoluteFilePath,
384 FileName))
385 return false;
386 if (NeedsAbsoluteFilePath && sys::path::is_relative(FileName)) {
387 // We may still need to append compilation directory of compile unit.
388 SmallString<16> AbsolutePath;
389 if (const char *CompilationDir = CU->getCompilationDir()) {
390 sys::path::append(AbsolutePath, CompilationDir);
391 }
392 sys::path::append(AbsolutePath, FileName);
393 FileName = AbsolutePath.str();
394 }
395 return true;
396}
397
Eric Christophere9403c12012-10-16 23:46:25 +0000398static bool getFileLineInfoForCompileUnit(DWARFCompileUnit *CU,
399 const DWARFLineTable *LineTable,
400 uint64_t Address,
401 bool NeedsAbsoluteFilePath,
402 std::string &FileName,
403 uint32_t &Line, uint32_t &Column) {
Alexey Samsonov5eae90d2012-09-04 08:12:33 +0000404 if (CU == 0 || LineTable == 0)
Alexey Samsonov38a63812012-08-30 07:49:50 +0000405 return false;
406 // Get the index of row we're looking for in the line table.
407 uint32_t RowIndex = LineTable->lookupAddress(Address);
408 if (RowIndex == -1U)
409 return false;
410 // Take file number and line/column from the row.
411 const DWARFDebugLine::Row &Row = LineTable->Rows[RowIndex];
412 if (!getFileNameForCompileUnit(CU, LineTable, Row.File,
413 NeedsAbsoluteFilePath, FileName))
414 return false;
415 Line = Row.Line;
416 Column = Row.Column;
417 return true;
418}
419
420DILineInfo DWARFContext::getLineInfoForAddress(uint64_t Address,
421 DILineInfoSpecifier Specifier) {
422 DWARFCompileUnit *CU = getCompileUnitForAddress(Address);
423 if (!CU)
Alexey Samsonov3e25c4a2012-07-02 05:54:45 +0000424 return DILineInfo();
Alexey Samsonov38a63812012-08-30 07:49:50 +0000425 std::string FileName = "<invalid>";
426 std::string FunctionName = "<invalid>";
427 uint32_t Line = 0;
428 uint32_t Column = 0;
429 if (Specifier.needs(DILineInfoSpecifier::FunctionName)) {
Alexey Samsonov5eae90d2012-09-04 08:12:33 +0000430 // The address may correspond to instruction in some inlined function,
431 // so we have to build the chain of inlined functions and take the
432 // name of the topmost function in it.
Alexey Samsonove6642902013-08-06 10:49:15 +0000433 const DWARFDebugInfoEntryInlinedChain &InlinedChain =
Alexey Samsonov5eae90d2012-09-04 08:12:33 +0000434 CU->getInlinedChainForAddress(Address);
Alexey Samsonove6642902013-08-06 10:49:15 +0000435 if (InlinedChain.DIEs.size() > 0) {
436 const DWARFDebugInfoEntryMinimal &TopFunctionDIE = InlinedChain.DIEs[0];
David Blaikiecd7c4982013-09-23 22:44:40 +0000437 if (const char *Name = TopFunctionDIE.getSubroutineName(InlinedChain.U))
Alexey Samsonov38a63812012-08-30 07:49:50 +0000438 FunctionName = Name;
Alexey Samsonov9d26b0b2012-07-17 15:28:35 +0000439 }
Alexey Samsonov3e25c4a2012-07-02 05:54:45 +0000440 }
Alexey Samsonov38a63812012-08-30 07:49:50 +0000441 if (Specifier.needs(DILineInfoSpecifier::FileLineInfo)) {
Eric Christophere9403c12012-10-16 23:46:25 +0000442 const DWARFLineTable *LineTable = getLineTableForCompileUnit(CU);
Alexey Samsonov38a63812012-08-30 07:49:50 +0000443 const bool NeedsAbsoluteFilePath =
444 Specifier.needs(DILineInfoSpecifier::AbsoluteFilePath);
Alexey Samsonov5eae90d2012-09-04 08:12:33 +0000445 getFileLineInfoForCompileUnit(CU, LineTable, Address,
446 NeedsAbsoluteFilePath,
Alexey Samsonov38a63812012-08-30 07:49:50 +0000447 FileName, Line, Column);
Alexey Samsonov3e25c4a2012-07-02 05:54:45 +0000448 }
Alexey Samsonov38a63812012-08-30 07:49:50 +0000449 return DILineInfo(StringRef(FileName), StringRef(FunctionName),
450 Line, Column);
Benjamin Kramer101b1c52011-09-15 20:43:22 +0000451}
David Blaikie2d24e2a2011-12-20 02:50:00 +0000452
Andrew Kaylore27a7872013-01-26 00:28:05 +0000453DILineInfoTable DWARFContext::getLineInfoForAddressRange(uint64_t Address,
454 uint64_t Size,
455 DILineInfoSpecifier Specifier) {
456 DILineInfoTable Lines;
457 DWARFCompileUnit *CU = getCompileUnitForAddress(Address);
458 if (!CU)
459 return Lines;
460
461 std::string FunctionName = "<invalid>";
462 if (Specifier.needs(DILineInfoSpecifier::FunctionName)) {
463 // The address may correspond to instruction in some inlined function,
464 // so we have to build the chain of inlined functions and take the
465 // name of the topmost function in it.
Alexey Samsonove6642902013-08-06 10:49:15 +0000466 const DWARFDebugInfoEntryInlinedChain &InlinedChain =
Andrew Kaylore27a7872013-01-26 00:28:05 +0000467 CU->getInlinedChainForAddress(Address);
Alexey Samsonove6642902013-08-06 10:49:15 +0000468 if (InlinedChain.DIEs.size() > 0) {
469 const DWARFDebugInfoEntryMinimal &TopFunctionDIE = InlinedChain.DIEs[0];
David Blaikiecd7c4982013-09-23 22:44:40 +0000470 if (const char *Name = TopFunctionDIE.getSubroutineName(InlinedChain.U))
Andrew Kaylore27a7872013-01-26 00:28:05 +0000471 FunctionName = Name;
472 }
473 }
474
Andrew Kaylore27a7872013-01-26 00:28:05 +0000475 // If the Specifier says we don't need FileLineInfo, just
476 // return the top-most function at the starting address.
477 if (!Specifier.needs(DILineInfoSpecifier::FileLineInfo)) {
David Blaikieeaad5cd2013-09-22 17:01:50 +0000478 Lines.push_back(
479 std::make_pair(Address, DILineInfo("<invalid>", FunctionName, 0, 0)));
Andrew Kaylore27a7872013-01-26 00:28:05 +0000480 return Lines;
481 }
482
483 const DWARFLineTable *LineTable = getLineTableForCompileUnit(CU);
484 const bool NeedsAbsoluteFilePath =
485 Specifier.needs(DILineInfoSpecifier::AbsoluteFilePath);
486
487 // Get the index of row we're looking for in the line table.
488 std::vector<uint32_t> RowVector;
489 if (!LineTable->lookupAddressRange(Address, Size, RowVector))
490 return Lines;
491
492 uint32_t NumRows = RowVector.size();
493 for (uint32_t i = 0; i < NumRows; ++i) {
494 uint32_t RowIndex = RowVector[i];
495 // Take file number and line/column from the row.
496 const DWARFDebugLine::Row &Row = LineTable->Rows[RowIndex];
497 std::string FileName = "<invalid>";
498 getFileNameForCompileUnit(CU, LineTable, Row.File,
499 NeedsAbsoluteFilePath, FileName);
David Blaikieeaad5cd2013-09-22 17:01:50 +0000500 Lines.push_back(std::make_pair(
501 Row.Address, DILineInfo(FileName, FunctionName, Row.Line, Row.Column)));
Andrew Kaylore27a7872013-01-26 00:28:05 +0000502 }
503
504 return Lines;
505}
506
Alexey Samsonov5eae90d2012-09-04 08:12:33 +0000507DIInliningInfo DWARFContext::getInliningInfoForAddress(uint64_t Address,
508 DILineInfoSpecifier Specifier) {
509 DWARFCompileUnit *CU = getCompileUnitForAddress(Address);
510 if (!CU)
511 return DIInliningInfo();
512
Alexey Samsonove6642902013-08-06 10:49:15 +0000513 const DWARFDebugInfoEntryInlinedChain &InlinedChain =
Alexey Samsonov5eae90d2012-09-04 08:12:33 +0000514 CU->getInlinedChainForAddress(Address);
Alexey Samsonove6642902013-08-06 10:49:15 +0000515 if (InlinedChain.DIEs.size() == 0)
Alexey Samsonov5eae90d2012-09-04 08:12:33 +0000516 return DIInliningInfo();
517
518 DIInliningInfo InliningInfo;
519 uint32_t CallFile = 0, CallLine = 0, CallColumn = 0;
Eric Christophere9403c12012-10-16 23:46:25 +0000520 const DWARFLineTable *LineTable = 0;
Alexey Samsonove6642902013-08-06 10:49:15 +0000521 for (uint32_t i = 0, n = InlinedChain.DIEs.size(); i != n; i++) {
522 const DWARFDebugInfoEntryMinimal &FunctionDIE = InlinedChain.DIEs[i];
Alexey Samsonov5eae90d2012-09-04 08:12:33 +0000523 std::string FileName = "<invalid>";
524 std::string FunctionName = "<invalid>";
525 uint32_t Line = 0;
526 uint32_t Column = 0;
527 // Get function name if necessary.
528 if (Specifier.needs(DILineInfoSpecifier::FunctionName)) {
David Blaikiecd7c4982013-09-23 22:44:40 +0000529 if (const char *Name = FunctionDIE.getSubroutineName(InlinedChain.U))
Alexey Samsonov5eae90d2012-09-04 08:12:33 +0000530 FunctionName = Name;
531 }
532 if (Specifier.needs(DILineInfoSpecifier::FileLineInfo)) {
533 const bool NeedsAbsoluteFilePath =
534 Specifier.needs(DILineInfoSpecifier::AbsoluteFilePath);
535 if (i == 0) {
536 // For the topmost frame, initialize the line table of this
537 // compile unit and fetch file/line info from it.
538 LineTable = getLineTableForCompileUnit(CU);
539 // For the topmost routine, get file/line info from line table.
540 getFileLineInfoForCompileUnit(CU, LineTable, Address,
541 NeedsAbsoluteFilePath,
542 FileName, Line, Column);
543 } else {
544 // Otherwise, use call file, call line and call column from
545 // previous DIE in inlined chain.
546 getFileNameForCompileUnit(CU, LineTable, CallFile,
547 NeedsAbsoluteFilePath, FileName);
548 Line = CallLine;
549 Column = CallColumn;
550 }
551 // Get call file/line/column of a current DIE.
552 if (i + 1 < n) {
David Blaikiecd7c4982013-09-23 22:44:40 +0000553 FunctionDIE.getCallerFrame(InlinedChain.U, CallFile, CallLine,
Alexey Samsonove6642902013-08-06 10:49:15 +0000554 CallColumn);
Alexey Samsonov5eae90d2012-09-04 08:12:33 +0000555 }
556 }
557 DILineInfo Frame(StringRef(FileName), StringRef(FunctionName),
558 Line, Column);
559 InliningInfo.addFrame(Frame);
560 }
561 return InliningInfo;
562}
563
Alexey Samsonov005159e2013-04-23 10:17:34 +0000564static bool consumeCompressedDebugSectionHeader(StringRef &data,
565 uint64_t &OriginalSize) {
566 // Consume "ZLIB" prefix.
567 if (!data.startswith("ZLIB"))
568 return false;
569 data = data.substr(4);
570 // Consume uncompressed section size (big-endian 8 bytes).
571 DataExtractor extractor(data, false, 8);
572 uint32_t Offset = 0;
573 OriginalSize = extractor.getU64(&Offset);
574 if (Offset == 0)
575 return false;
576 data = data.substr(Offset);
577 return true;
578}
579
Eric Christopherd1726a42012-11-12 21:40:38 +0000580DWARFContextInMemory::DWARFContextInMemory(object::ObjectFile *Obj) :
Eli Bendersky60bdc5b2013-02-05 23:30:58 +0000581 IsLittleEndian(Obj->isLittleEndian()),
582 AddressSize(Obj->getBytesInAddress()) {
Eric Christopherd1726a42012-11-12 21:40:38 +0000583 error_code ec;
584 for (object::section_iterator i = Obj->begin_sections(),
585 e = Obj->end_sections();
586 i != e; i.increment(ec)) {
587 StringRef name;
588 i->getName(name);
589 StringRef data;
590 i->getContents(data);
591
Eric Christopherd1726a42012-11-12 21:40:38 +0000592 name = name.substr(name.find_first_not_of("._")); // Skip . and _ prefixes.
Alexey Samsonov784baa62013-04-17 14:27:04 +0000593
Alexey Samsonov005159e2013-04-23 10:17:34 +0000594 // Check if debug info section is compressed with zlib.
595 if (name.startswith("zdebug_")) {
596 uint64_t OriginalSize;
597 if (!zlib::isAvailable() ||
598 !consumeCompressedDebugSectionHeader(data, OriginalSize))
599 continue;
600 OwningPtr<MemoryBuffer> UncompressedSection;
601 if (zlib::uncompress(data, UncompressedSection, OriginalSize) !=
602 zlib::StatusOK)
603 continue;
604 // Make data point to uncompressed section contents and save its contents.
605 name = name.substr(1);
606 data = UncompressedSection->getBuffer();
607 UncompressedSections.push_back(UncompressedSection.take());
608 }
609
Eric Christopher7357f032013-09-25 23:02:41 +0000610 StringRef *Section =
611 StringSwitch<StringRef *>(name)
612 .Case("debug_info", &InfoSection.Data)
613 .Case("debug_abbrev", &AbbrevSection)
614 .Case("debug_loc", &LocSection.Data)
615 .Case("debug_line", &LineSection.Data)
616 .Case("debug_aranges", &ARangeSection)
617 .Case("debug_frame", &DebugFrameSection)
618 .Case("debug_str", &StringSection)
619 .Case("debug_ranges", &RangeSection)
620 .Case("debug_pubnames", &PubNamesSection)
621 .Case("debug_pubtypes", &PubTypesSection)
622 .Case("debug_gnu_pubnames", &GnuPubNamesSection)
623 .Case("debug_gnu_pubtypes", &GnuPubTypesSection)
624 .Case("debug_info.dwo", &InfoDWOSection.Data)
625 .Case("debug_abbrev.dwo", &AbbrevDWOSection)
626 .Case("debug_str.dwo", &StringDWOSection)
627 .Case("debug_str_offsets.dwo", &StringOffsetDWOSection)
628 .Case("debug_addr", &AddrSection)
629 // Any more debug info sections go here.
630 .Default(0);
Rafael Espindola7486d922013-05-30 03:05:14 +0000631 if (Section) {
632 *Section = data;
633 if (name == "debug_ranges") {
634 // FIXME: Use the other dwo range section when we emit it.
635 RangeDWOSection = data;
636 }
David Blaikie438f5392013-09-23 22:44:47 +0000637 } else if (name == "debug_types") {
David Blaikie75331652013-09-23 23:39:55 +0000638 // Find debug_types data by section rather than name as there are
639 // multiple, comdat grouped, debug_types sections.
David Blaikie438f5392013-09-23 22:44:47 +0000640 TypesSections[*i].Data = data;
Eric Christopher82de10a2013-01-02 23:52:13 +0000641 }
Eric Christopherd1726a42012-11-12 21:40:38 +0000642
Rafael Espindola7486d922013-05-30 03:05:14 +0000643 section_iterator RelocatedSection = i->getRelocatedSection();
644 if (RelocatedSection == Obj->end_sections())
645 continue;
646
647 StringRef RelSecName;
648 RelocatedSection->getName(RelSecName);
649 RelSecName = RelSecName.substr(
650 RelSecName.find_first_not_of("._")); // Skip . and _ prefixes.
651
Andrew Kayloree7c0d22013-01-25 22:50:58 +0000652 // TODO: Add support for relocations in other sections as needed.
653 // Record relocations for the debug_info and debug_line sections.
Rafael Espindola7486d922013-05-30 03:05:14 +0000654 RelocAddrMap *Map = StringSwitch<RelocAddrMap*>(RelSecName)
David Blaikie9528b0e2013-09-23 17:42:01 +0000655 .Case("debug_info", &InfoSection.Relocs)
656 .Case("debug_loc", &LocSection.Relocs)
657 .Case("debug_info.dwo", &InfoDWOSection.Relocs)
658 .Case("debug_line", &LineSection.Relocs)
Alexey Samsonov784baa62013-04-17 14:27:04 +0000659 .Default(0);
David Blaikie438f5392013-09-23 22:44:47 +0000660 if (!Map) {
661 if (RelSecName != "debug_types")
662 continue;
David Blaikie75331652013-09-23 23:39:55 +0000663 // Find debug_types relocs by section rather than name as there are
664 // multiple, comdat grouped, debug_types sections.
David Blaikie438f5392013-09-23 22:44:47 +0000665 Map = &TypesSections[*RelocatedSection].Relocs;
666 }
Eric Christopherd1726a42012-11-12 21:40:38 +0000667
668 if (i->begin_relocations() != i->end_relocations()) {
669 uint64_t SectionSize;
Rafael Espindola7486d922013-05-30 03:05:14 +0000670 RelocatedSection->getSize(SectionSize);
Eric Christopherd1726a42012-11-12 21:40:38 +0000671 for (object::relocation_iterator reloc_i = i->begin_relocations(),
672 reloc_e = i->end_relocations();
673 reloc_i != reloc_e; reloc_i.increment(ec)) {
674 uint64_t Address;
Rafael Espindola956ca722013-04-25 12:28:45 +0000675 reloc_i->getOffset(Address);
Eric Christopherd1726a42012-11-12 21:40:38 +0000676 uint64_t Type;
677 reloc_i->getType(Type);
Andrew Kayloree7c0d22013-01-25 22:50:58 +0000678 uint64_t SymAddr = 0;
679 // ELF relocations may need the symbol address
680 if (Obj->isELF()) {
Rafael Espindola6c1202c2013-06-05 01:33:53 +0000681 object::symbol_iterator Sym = reloc_i->getSymbol();
682 Sym->getAddress(SymAddr);
Andrew Kayloree7c0d22013-01-25 22:50:58 +0000683 }
Eric Christopherd1726a42012-11-12 21:40:38 +0000684
685 object::RelocVisitor V(Obj->getFileFormatName());
686 // The section address is always 0 for debug sections.
Andrew Kayloree7c0d22013-01-25 22:50:58 +0000687 object::RelocToApply R(V.visit(Type, *reloc_i, 0, SymAddr));
Eric Christopherd1726a42012-11-12 21:40:38 +0000688 if (V.error()) {
689 SmallString<32> Name;
690 error_code ec(reloc_i->getTypeName(Name));
691 if (ec) {
692 errs() << "Aaaaaa! Nameless relocation! Aaaaaa!\n";
693 }
694 errs() << "error: failed to compute relocation: "
695 << Name << "\n";
696 continue;
697 }
698
699 if (Address + R.Width > SectionSize) {
700 errs() << "error: " << R.Width << "-byte relocation starting "
701 << Address << " bytes into section " << name << " which is "
702 << SectionSize << " bytes long.\n";
703 continue;
704 }
705 if (R.Width > 8) {
706 errs() << "error: can't handle a relocation of more than 8 bytes at "
707 "a time.\n";
708 continue;
709 }
710 DEBUG(dbgs() << "Writing " << format("%p", R.Value)
711 << " at " << format("%p", Address)
712 << " with width " << format("%d", R.Width)
713 << "\n");
Eric Christopher82de10a2013-01-02 23:52:13 +0000714 Map->insert(std::make_pair(Address, std::make_pair(R.Width, R.Value)));
Eric Christopherd1726a42012-11-12 21:40:38 +0000715 }
716 }
717 }
718}
719
Alexey Samsonov005159e2013-04-23 10:17:34 +0000720DWARFContextInMemory::~DWARFContextInMemory() {
721 DeleteContainerPointers(UncompressedSections);
722}
723
David Blaikie2d24e2a2011-12-20 02:50:00 +0000724void DWARFContextInMemory::anchor() { }