blob: 6ecd0a75a1d702eb51712742129a84a11914a3ab [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
Eli Bendersky939a4e82013-01-25 20:26:43 +000026void DWARFContext::dump(raw_ostream &OS, DIDumpType DumpType) {
27 if (DumpType == DIDT_All || DumpType == DIDT_Abbrev) {
28 OS << ".debug_abbrev contents:\n";
29 getDebugAbbrev()->dump(OS);
30 }
Benjamin Kramer358f4fd2011-09-14 01:09:52 +000031
Eli Bendersky939a4e82013-01-25 20:26:43 +000032 if (DumpType == DIDT_All || DumpType == DIDT_Info) {
33 OS << "\n.debug_info contents:\n";
34 for (unsigned i = 0, e = getNumCompileUnits(); i != e; ++i)
35 getCompileUnitAtIndex(i)->dump(OS);
36 }
Benjamin Kramer358f4fd2011-09-14 01:09:52 +000037
David Blaikie3df7d2f2013-06-19 21:37:13 +000038 if (DumpType == DIDT_All || DumpType == DIDT_Loc) {
39 OS << ".debug_loc contents:\n";
40 getDebugLoc()->dump(OS);
41 }
42
Eli Bendersky60bdc5b2013-02-05 23:30:58 +000043 if (DumpType == DIDT_All || DumpType == DIDT_Frames) {
44 OS << "\n.debug_frame contents:\n";
45 getDebugFrame()->dump(OS);
46 }
47
Benjamin Kramer358f4fd2011-09-14 01:09:52 +000048 uint32_t offset = 0;
Eli Bendersky939a4e82013-01-25 20:26:43 +000049 if (DumpType == DIDT_All || DumpType == DIDT_Aranges) {
50 OS << "\n.debug_aranges contents:\n";
51 DataExtractor arangesData(getARangeSection(), isLittleEndian(), 0);
52 DWARFDebugArangeSet set;
53 while (set.extract(arangesData, &offset))
54 set.dump(OS);
55 }
Benjamin Kramerb848e972011-09-15 02:12:05 +000056
Alexey Samsonoveceb5b92012-08-27 07:17:47 +000057 uint8_t savedAddressByteSize = 0;
Eli Bendersky939a4e82013-01-25 20:26:43 +000058 if (DumpType == DIDT_All || DumpType == DIDT_Line) {
59 OS << "\n.debug_line contents:\n";
60 for (unsigned i = 0, e = getNumCompileUnits(); i != e; ++i) {
61 DWARFCompileUnit *cu = getCompileUnitAtIndex(i);
62 savedAddressByteSize = cu->getAddressByteSize();
63 unsigned stmtOffset =
64 cu->getCompileUnitDIE()->getAttributeValueAsUnsigned(cu, DW_AT_stmt_list,
65 -1U);
66 if (stmtOffset != -1U) {
67 DataExtractor lineData(getLineSection(), isLittleEndian(),
68 savedAddressByteSize);
69 DWARFDebugLine::DumpingState state(OS);
Andrew Kayloree7c0d22013-01-25 22:50:58 +000070 DWARFDebugLine::parseStatementTable(lineData, &lineRelocMap(), &stmtOffset, state);
Eli Bendersky939a4e82013-01-25 20:26:43 +000071 }
Benjamin Kramerfe80f1d2011-09-15 18:02:20 +000072 }
73 }
Benjamin Kramer34f864f2011-09-15 16:57:13 +000074
Eli Bendersky939a4e82013-01-25 20:26:43 +000075 if (DumpType == DIDT_All || DumpType == DIDT_Str) {
76 OS << "\n.debug_str contents:\n";
77 DataExtractor strData(getStringSection(), isLittleEndian(), 0);
78 offset = 0;
79 uint32_t strOffset = 0;
80 while (const char *s = strData.getCStr(&offset)) {
81 OS << format("0x%8.8x: \"%s\"\n", strOffset, s);
82 strOffset = offset;
83 }
Benjamin Kramer34f864f2011-09-15 16:57:13 +000084 }
Alexey Samsonoveceb5b92012-08-27 07:17:47 +000085
Eli Bendersky939a4e82013-01-25 20:26:43 +000086 if (DumpType == DIDT_All || DumpType == DIDT_Ranges) {
87 OS << "\n.debug_ranges contents:\n";
88 // In fact, different compile units may have different address byte
89 // sizes, but for simplicity we just use the address byte size of the last
90 // compile unit (there is no easy and fast way to associate address range
91 // list and the compile unit it describes).
92 DataExtractor rangesData(getRangeSection(), isLittleEndian(),
93 savedAddressByteSize);
94 offset = 0;
95 DWARFDebugRangeList rangeList;
96 while (rangeList.extract(rangesData, &offset))
97 rangeList.dump(OS);
Eric Christopher82de10a2013-01-02 23:52:13 +000098 }
Eric Christopher72f7bfb2013-01-15 23:56:56 +000099
Krzysztof Parzyszeke38825f2013-02-12 16:20:28 +0000100 if (DumpType == DIDT_All || DumpType == DIDT_Pubnames) {
101 OS << "\n.debug_pubnames contents:\n";
102 DataExtractor pubNames(getPubNamesSection(), isLittleEndian(), 0);
103 offset = 0;
104 OS << "Length: " << pubNames.getU32(&offset) << "\n";
105 OS << "Version: " << pubNames.getU16(&offset) << "\n";
106 OS << "Offset in .debug_info: " << pubNames.getU32(&offset) << "\n";
107 OS << "Size: " << pubNames.getU32(&offset) << "\n";
108 OS << "\n Offset Name\n";
109 while (offset < getPubNamesSection().size()) {
110 uint32_t n = pubNames.getU32(&offset);
111 if (n == 0)
112 break;
113 OS << format("%8x ", n);
114 OS << pubNames.getCStr(&offset) << "\n";
115 }
116 }
117
Eli Bendersky939a4e82013-01-25 20:26:43 +0000118 if (DumpType == DIDT_All || DumpType == DIDT_AbbrevDwo) {
Eric Christopher93f3fed2013-05-06 17:50:42 +0000119 const DWARFDebugAbbrev *D = getDebugAbbrevDWO();
120 if (D) {
121 OS << "\n.debug_abbrev.dwo contents:\n";
122 getDebugAbbrevDWO()->dump(OS);
Eli Bendersky939a4e82013-01-25 20:26:43 +0000123 }
124 }
125
Eric Christopher93f3fed2013-05-06 17:50:42 +0000126 if (DumpType == DIDT_All || DumpType == DIDT_InfoDwo)
127 if (getNumDWOCompileUnits()) {
128 OS << "\n.debug_info.dwo contents:\n";
129 for (unsigned i = 0, e = getNumDWOCompileUnits(); i != e; ++i)
Eric Christopher5a0c3662013-05-06 21:19:41 +0000130 getDWOCompileUnitAtIndex(i)->dump(OS);
Eli Bendersky939a4e82013-01-25 20:26:43 +0000131 }
Eric Christopher93f3fed2013-05-06 17:50:42 +0000132
133 if (DumpType == DIDT_All || DumpType == DIDT_StrDwo)
134 if (!getStringDWOSection().empty()) {
135 OS << "\n.debug_str.dwo contents:\n";
136 DataExtractor strDWOData(getStringDWOSection(), isLittleEndian(), 0);
137 offset = 0;
138 uint32_t strDWOOffset = 0;
139 while (const char *s = strDWOData.getCStr(&offset)) {
Eric Christopher5a0c3662013-05-06 21:19:41 +0000140 OS << format("0x%8.8x: \"%s\"\n", strDWOOffset, s);
141 strDWOOffset = offset;
Eric Christopher93f3fed2013-05-06 17:50:42 +0000142 }
143 }
144
145 if (DumpType == DIDT_All || DumpType == DIDT_StrOffsetsDwo)
146 if (!getStringOffsetDWOSection().empty()) {
147 OS << "\n.debug_str_offsets.dwo contents:\n";
148 DataExtractor strOffsetExt(getStringOffsetDWOSection(), isLittleEndian(), 0);
149 offset = 0;
Eric Christophere305e032013-05-06 21:19:44 +0000150 uint64_t size = getStringOffsetDWOSection().size();
151 while (offset < size) {
Eric Christopher5a0c3662013-05-06 21:19:41 +0000152 OS << format("0x%8.8x: ", offset);
153 OS << format("%8.8x\n", strOffsetExt.getU32(&offset));
Eric Christopher93f3fed2013-05-06 17:50:42 +0000154 }
155 }
Benjamin Kramer72c0d7f2011-09-13 19:42:23 +0000156}
157
158const DWARFDebugAbbrev *DWARFContext::getDebugAbbrev() {
159 if (Abbrev)
160 return Abbrev.get();
161
162 DataExtractor abbrData(getAbbrevSection(), isLittleEndian(), 0);
163
164 Abbrev.reset(new DWARFDebugAbbrev());
165 Abbrev->parse(abbrData);
166 return Abbrev.get();
167}
168
Eric Christopher82de10a2013-01-02 23:52:13 +0000169const DWARFDebugAbbrev *DWARFContext::getDebugAbbrevDWO() {
170 if (AbbrevDWO)
171 return AbbrevDWO.get();
172
173 DataExtractor abbrData(getAbbrevDWOSection(), isLittleEndian(), 0);
174 AbbrevDWO.reset(new DWARFDebugAbbrev());
175 AbbrevDWO->parse(abbrData);
176 return AbbrevDWO.get();
177}
178
David Blaikie3df7d2f2013-06-19 21:37:13 +0000179const DWARFDebugLoc *DWARFContext::getDebugLoc() {
180 if (Loc)
181 return Loc.get();
182
183 DataExtractor LocData(getLocSection(), isLittleEndian(), 0);
184 Loc.reset(new DWARFDebugLoc(locRelocMap()));
185 // assume all compile units have the same address byte size
186 if (getNumCompileUnits())
187 Loc->parse(LocData, getCompileUnitAtIndex(0)->getAddressByteSize());
188 return Loc.get();
189}
190
Benjamin Kramer358f4fd2011-09-14 01:09:52 +0000191const DWARFDebugAranges *DWARFContext::getDebugAranges() {
192 if (Aranges)
193 return Aranges.get();
194
195 DataExtractor arangesData(getARangeSection(), isLittleEndian(), 0);
196
197 Aranges.reset(new DWARFDebugAranges());
198 Aranges->extract(arangesData);
Alexey Samsonov63a450a2012-11-16 08:36:25 +0000199 // Generate aranges from DIEs: even if .debug_aranges section is present,
200 // it may describe only a small subset of compilation units, so we need to
201 // manually build aranges for the rest of them.
202 Aranges->generate(this);
Benjamin Kramer358f4fd2011-09-14 01:09:52 +0000203 return Aranges.get();
204}
205
Eli Bendersky60bdc5b2013-02-05 23:30:58 +0000206const DWARFDebugFrame *DWARFContext::getDebugFrame() {
207 if (DebugFrame)
208 return DebugFrame.get();
209
210 // There's a "bug" in the DWARFv3 standard with respect to the target address
211 // size within debug frame sections. While DWARF is supposed to be independent
212 // of its container, FDEs have fields with size being "target address size",
213 // which isn't specified in DWARF in general. It's only specified for CUs, but
214 // .eh_frame can appear without a .debug_info section. Follow the example of
215 // other tools (libdwarf) and extract this from the container (ObjectFile
216 // provides this information). This problem is fixed in DWARFv4
217 // See this dwarf-discuss discussion for more details:
218 // http://lists.dwarfstd.org/htdig.cgi/dwarf-discuss-dwarfstd.org/2011-December/001173.html
219 DataExtractor debugFrameData(getDebugFrameSection(), isLittleEndian(),
220 getAddressSize());
221 DebugFrame.reset(new DWARFDebugFrame());
222 DebugFrame->parse(debugFrameData);
223 return DebugFrame.get();
224}
225
Eric Christophere9403c12012-10-16 23:46:25 +0000226const DWARFLineTable *
Benjamin Kramerc26ed9b2011-09-15 20:43:18 +0000227DWARFContext::getLineTableForCompileUnit(DWARFCompileUnit *cu) {
228 if (!Line)
Andrew Kayloree7c0d22013-01-25 22:50:58 +0000229 Line.reset(new DWARFDebugLine(&lineRelocMap()));
Benjamin Kramerb848e972011-09-15 02:12:05 +0000230
Benjamin Kramerc26ed9b2011-09-15 20:43:18 +0000231 unsigned stmtOffset =
232 cu->getCompileUnitDIE()->getAttributeValueAsUnsigned(cu, DW_AT_stmt_list,
233 -1U);
234 if (stmtOffset == -1U)
235 return 0; // No line table for this compile unit.
Benjamin Kramerb848e972011-09-15 02:12:05 +0000236
Benjamin Kramerc26ed9b2011-09-15 20:43:18 +0000237 // See if the line table is cached.
Eric Christophere9403c12012-10-16 23:46:25 +0000238 if (const DWARFLineTable *lt = Line->getLineTable(stmtOffset))
Benjamin Kramerc26ed9b2011-09-15 20:43:18 +0000239 return lt;
240
241 // We have to parse it first.
242 DataExtractor lineData(getLineSection(), isLittleEndian(),
243 cu->getAddressByteSize());
244 return Line->getOrParseLineTable(lineData, stmtOffset);
Benjamin Kramerb848e972011-09-15 02:12:05 +0000245}
246
Benjamin Kramer72c0d7f2011-09-13 19:42:23 +0000247void DWARFContext::parseCompileUnits() {
248 uint32_t offset = 0;
Eric Christopherb69b55f2012-10-16 23:46:23 +0000249 const DataExtractor &DIData = DataExtractor(getInfoSection(),
250 isLittleEndian(), 0);
251 while (DIData.isValidOffset(offset)) {
Eric Christopher82de10a2013-01-02 23:52:13 +0000252 CUs.push_back(DWARFCompileUnit(getDebugAbbrev(), getInfoSection(),
253 getAbbrevSection(), getRangeSection(),
Eric Christopher72f7bfb2013-01-15 23:56:56 +0000254 getStringSection(), StringRef(),
255 getAddrSection(),
Eric Christopherdd8e9f32013-01-07 19:32:41 +0000256 &infoRelocMap(),
Eric Christopher82de10a2013-01-02 23:52:13 +0000257 isLittleEndian()));
Eric Christopherb69b55f2012-10-16 23:46:23 +0000258 if (!CUs.back().extract(DIData, &offset)) {
Benjamin Kramer72c0d7f2011-09-13 19:42:23 +0000259 CUs.pop_back();
260 break;
261 }
262
263 offset = CUs.back().getNextCompileUnitOffset();
264 }
265}
Benjamin Kramer101b1c52011-09-15 20:43:22 +0000266
Eric Christopher82de10a2013-01-02 23:52:13 +0000267void DWARFContext::parseDWOCompileUnits() {
268 uint32_t offset = 0;
269 const DataExtractor &DIData = DataExtractor(getInfoDWOSection(),
270 isLittleEndian(), 0);
271 while (DIData.isValidOffset(offset)) {
272 DWOCUs.push_back(DWARFCompileUnit(getDebugAbbrevDWO(), getInfoDWOSection(),
273 getAbbrevDWOSection(),
274 getRangeDWOSection(),
275 getStringDWOSection(),
Eric Christopherdd8e9f32013-01-07 19:32:41 +0000276 getStringOffsetDWOSection(),
Eric Christopher72f7bfb2013-01-15 23:56:56 +0000277 getAddrSection(),
Eric Christopher82de10a2013-01-02 23:52:13 +0000278 &infoDWORelocMap(),
279 isLittleEndian()));
280 if (!DWOCUs.back().extract(DIData, &offset)) {
281 DWOCUs.pop_back();
282 break;
283 }
284
285 offset = DWOCUs.back().getNextCompileUnitOffset();
286 }
287}
288
Benjamin Kramer101b1c52011-09-15 20:43:22 +0000289namespace {
290 struct OffsetComparator {
291 bool operator()(const DWARFCompileUnit &LHS,
292 const DWARFCompileUnit &RHS) const {
293 return LHS.getOffset() < RHS.getOffset();
294 }
295 bool operator()(const DWARFCompileUnit &LHS, uint32_t RHS) const {
296 return LHS.getOffset() < RHS;
297 }
298 bool operator()(uint32_t LHS, const DWARFCompileUnit &RHS) const {
299 return LHS < RHS.getOffset();
300 }
301 };
302}
303
Alexey Samsonov38a63812012-08-30 07:49:50 +0000304DWARFCompileUnit *DWARFContext::getCompileUnitForOffset(uint32_t Offset) {
Benjamin Kramer101b1c52011-09-15 20:43:22 +0000305 if (CUs.empty())
306 parseCompileUnits();
307
Alexey Samsonov38a63812012-08-30 07:49:50 +0000308 DWARFCompileUnit *CU = std::lower_bound(CUs.begin(), CUs.end(), Offset,
309 OffsetComparator());
310 if (CU != CUs.end())
311 return &*CU;
Benjamin Kramer101b1c52011-09-15 20:43:22 +0000312 return 0;
313}
314
Alexey Samsonov38a63812012-08-30 07:49:50 +0000315DWARFCompileUnit *DWARFContext::getCompileUnitForAddress(uint64_t Address) {
Benjamin Kramer9013db32011-09-15 21:59:13 +0000316 // First, get the offset of the compile unit.
Alexey Samsonov38a63812012-08-30 07:49:50 +0000317 uint32_t CUOffset = getDebugAranges()->findAddress(Address);
Benjamin Kramer101b1c52011-09-15 20:43:22 +0000318 // Retrieve the compile unit.
Alexey Samsonov38a63812012-08-30 07:49:50 +0000319 return getCompileUnitForOffset(CUOffset);
320}
321
Eric Christophere9403c12012-10-16 23:46:25 +0000322static bool getFileNameForCompileUnit(DWARFCompileUnit *CU,
323 const DWARFLineTable *LineTable,
324 uint64_t FileIndex,
325 bool NeedsAbsoluteFilePath,
326 std::string &FileName) {
Alexey Samsonov38a63812012-08-30 07:49:50 +0000327 if (CU == 0 ||
328 LineTable == 0 ||
329 !LineTable->getFileNameByIndex(FileIndex, NeedsAbsoluteFilePath,
330 FileName))
331 return false;
332 if (NeedsAbsoluteFilePath && sys::path::is_relative(FileName)) {
333 // We may still need to append compilation directory of compile unit.
334 SmallString<16> AbsolutePath;
335 if (const char *CompilationDir = CU->getCompilationDir()) {
336 sys::path::append(AbsolutePath, CompilationDir);
337 }
338 sys::path::append(AbsolutePath, FileName);
339 FileName = AbsolutePath.str();
340 }
341 return true;
342}
343
Eric Christophere9403c12012-10-16 23:46:25 +0000344static bool getFileLineInfoForCompileUnit(DWARFCompileUnit *CU,
345 const DWARFLineTable *LineTable,
346 uint64_t Address,
347 bool NeedsAbsoluteFilePath,
348 std::string &FileName,
349 uint32_t &Line, uint32_t &Column) {
Alexey Samsonov5eae90d2012-09-04 08:12:33 +0000350 if (CU == 0 || LineTable == 0)
Alexey Samsonov38a63812012-08-30 07:49:50 +0000351 return false;
352 // Get the index of row we're looking for in the line table.
353 uint32_t RowIndex = LineTable->lookupAddress(Address);
354 if (RowIndex == -1U)
355 return false;
356 // Take file number and line/column from the row.
357 const DWARFDebugLine::Row &Row = LineTable->Rows[RowIndex];
358 if (!getFileNameForCompileUnit(CU, LineTable, Row.File,
359 NeedsAbsoluteFilePath, FileName))
360 return false;
361 Line = Row.Line;
362 Column = Row.Column;
363 return true;
364}
365
366DILineInfo DWARFContext::getLineInfoForAddress(uint64_t Address,
367 DILineInfoSpecifier Specifier) {
368 DWARFCompileUnit *CU = getCompileUnitForAddress(Address);
369 if (!CU)
Alexey Samsonov3e25c4a2012-07-02 05:54:45 +0000370 return DILineInfo();
Alexey Samsonov38a63812012-08-30 07:49:50 +0000371 std::string FileName = "<invalid>";
372 std::string FunctionName = "<invalid>";
373 uint32_t Line = 0;
374 uint32_t Column = 0;
375 if (Specifier.needs(DILineInfoSpecifier::FunctionName)) {
Alexey Samsonov5eae90d2012-09-04 08:12:33 +0000376 // The address may correspond to instruction in some inlined function,
377 // so we have to build the chain of inlined functions and take the
378 // name of the topmost function in it.
379 const DWARFDebugInfoEntryMinimal::InlinedChain &InlinedChain =
380 CU->getInlinedChainForAddress(Address);
381 if (InlinedChain.size() > 0) {
382 const DWARFDebugInfoEntryMinimal &TopFunctionDIE = InlinedChain[0];
383 if (const char *Name = TopFunctionDIE.getSubroutineName(CU))
Alexey Samsonov38a63812012-08-30 07:49:50 +0000384 FunctionName = Name;
Alexey Samsonov9d26b0b2012-07-17 15:28:35 +0000385 }
Alexey Samsonov3e25c4a2012-07-02 05:54:45 +0000386 }
Alexey Samsonov38a63812012-08-30 07:49:50 +0000387 if (Specifier.needs(DILineInfoSpecifier::FileLineInfo)) {
Eric Christophere9403c12012-10-16 23:46:25 +0000388 const DWARFLineTable *LineTable = getLineTableForCompileUnit(CU);
Alexey Samsonov38a63812012-08-30 07:49:50 +0000389 const bool NeedsAbsoluteFilePath =
390 Specifier.needs(DILineInfoSpecifier::AbsoluteFilePath);
Alexey Samsonov5eae90d2012-09-04 08:12:33 +0000391 getFileLineInfoForCompileUnit(CU, LineTable, Address,
392 NeedsAbsoluteFilePath,
Alexey Samsonov38a63812012-08-30 07:49:50 +0000393 FileName, Line, Column);
Alexey Samsonov3e25c4a2012-07-02 05:54:45 +0000394 }
Alexey Samsonov38a63812012-08-30 07:49:50 +0000395 return DILineInfo(StringRef(FileName), StringRef(FunctionName),
396 Line, Column);
Benjamin Kramer101b1c52011-09-15 20:43:22 +0000397}
David Blaikie2d24e2a2011-12-20 02:50:00 +0000398
Andrew Kaylore27a7872013-01-26 00:28:05 +0000399DILineInfoTable DWARFContext::getLineInfoForAddressRange(uint64_t Address,
400 uint64_t Size,
401 DILineInfoSpecifier Specifier) {
402 DILineInfoTable Lines;
403 DWARFCompileUnit *CU = getCompileUnitForAddress(Address);
404 if (!CU)
405 return Lines;
406
407 std::string FunctionName = "<invalid>";
408 if (Specifier.needs(DILineInfoSpecifier::FunctionName)) {
409 // The address may correspond to instruction in some inlined function,
410 // so we have to build the chain of inlined functions and take the
411 // name of the topmost function in it.
412 const DWARFDebugInfoEntryMinimal::InlinedChain &InlinedChain =
413 CU->getInlinedChainForAddress(Address);
414 if (InlinedChain.size() > 0) {
415 const DWARFDebugInfoEntryMinimal &TopFunctionDIE = InlinedChain[0];
416 if (const char *Name = TopFunctionDIE.getSubroutineName(CU))
417 FunctionName = Name;
418 }
419 }
420
421 StringRef FuncNameRef = StringRef(FunctionName);
422
423 // If the Specifier says we don't need FileLineInfo, just
424 // return the top-most function at the starting address.
425 if (!Specifier.needs(DILineInfoSpecifier::FileLineInfo)) {
426 Lines.push_back(std::make_pair(Address,
427 DILineInfo(StringRef("<invalid>"),
428 FuncNameRef, 0, 0)));
429 return Lines;
430 }
431
432 const DWARFLineTable *LineTable = getLineTableForCompileUnit(CU);
433 const bool NeedsAbsoluteFilePath =
434 Specifier.needs(DILineInfoSpecifier::AbsoluteFilePath);
435
436 // Get the index of row we're looking for in the line table.
437 std::vector<uint32_t> RowVector;
438 if (!LineTable->lookupAddressRange(Address, Size, RowVector))
439 return Lines;
440
441 uint32_t NumRows = RowVector.size();
442 for (uint32_t i = 0; i < NumRows; ++i) {
443 uint32_t RowIndex = RowVector[i];
444 // Take file number and line/column from the row.
445 const DWARFDebugLine::Row &Row = LineTable->Rows[RowIndex];
446 std::string FileName = "<invalid>";
447 getFileNameForCompileUnit(CU, LineTable, Row.File,
448 NeedsAbsoluteFilePath, FileName);
449 Lines.push_back(std::make_pair(Row.Address,
450 DILineInfo(StringRef(FileName),
451 FuncNameRef, Row.Line, Row.Column)));
452 }
453
454 return Lines;
455}
456
Alexey Samsonov5eae90d2012-09-04 08:12:33 +0000457DIInliningInfo DWARFContext::getInliningInfoForAddress(uint64_t Address,
458 DILineInfoSpecifier Specifier) {
459 DWARFCompileUnit *CU = getCompileUnitForAddress(Address);
460 if (!CU)
461 return DIInliningInfo();
462
463 const DWARFDebugInfoEntryMinimal::InlinedChain &InlinedChain =
464 CU->getInlinedChainForAddress(Address);
465 if (InlinedChain.size() == 0)
466 return DIInliningInfo();
467
468 DIInliningInfo InliningInfo;
469 uint32_t CallFile = 0, CallLine = 0, CallColumn = 0;
Eric Christophere9403c12012-10-16 23:46:25 +0000470 const DWARFLineTable *LineTable = 0;
Alexey Samsonov5eae90d2012-09-04 08:12:33 +0000471 for (uint32_t i = 0, n = InlinedChain.size(); i != n; i++) {
472 const DWARFDebugInfoEntryMinimal &FunctionDIE = InlinedChain[i];
473 std::string FileName = "<invalid>";
474 std::string FunctionName = "<invalid>";
475 uint32_t Line = 0;
476 uint32_t Column = 0;
477 // Get function name if necessary.
478 if (Specifier.needs(DILineInfoSpecifier::FunctionName)) {
479 if (const char *Name = FunctionDIE.getSubroutineName(CU))
480 FunctionName = Name;
481 }
482 if (Specifier.needs(DILineInfoSpecifier::FileLineInfo)) {
483 const bool NeedsAbsoluteFilePath =
484 Specifier.needs(DILineInfoSpecifier::AbsoluteFilePath);
485 if (i == 0) {
486 // For the topmost frame, initialize the line table of this
487 // compile unit and fetch file/line info from it.
488 LineTable = getLineTableForCompileUnit(CU);
489 // For the topmost routine, get file/line info from line table.
490 getFileLineInfoForCompileUnit(CU, LineTable, Address,
491 NeedsAbsoluteFilePath,
492 FileName, Line, Column);
493 } else {
494 // Otherwise, use call file, call line and call column from
495 // previous DIE in inlined chain.
496 getFileNameForCompileUnit(CU, LineTable, CallFile,
497 NeedsAbsoluteFilePath, FileName);
498 Line = CallLine;
499 Column = CallColumn;
500 }
501 // Get call file/line/column of a current DIE.
502 if (i + 1 < n) {
503 FunctionDIE.getCallerFrame(CU, CallFile, CallLine, CallColumn);
504 }
505 }
506 DILineInfo Frame(StringRef(FileName), StringRef(FunctionName),
507 Line, Column);
508 InliningInfo.addFrame(Frame);
509 }
510 return InliningInfo;
511}
512
Alexey Samsonov005159e2013-04-23 10:17:34 +0000513static bool consumeCompressedDebugSectionHeader(StringRef &data,
514 uint64_t &OriginalSize) {
515 // Consume "ZLIB" prefix.
516 if (!data.startswith("ZLIB"))
517 return false;
518 data = data.substr(4);
519 // Consume uncompressed section size (big-endian 8 bytes).
520 DataExtractor extractor(data, false, 8);
521 uint32_t Offset = 0;
522 OriginalSize = extractor.getU64(&Offset);
523 if (Offset == 0)
524 return false;
525 data = data.substr(Offset);
526 return true;
527}
528
Eric Christopherd1726a42012-11-12 21:40:38 +0000529DWARFContextInMemory::DWARFContextInMemory(object::ObjectFile *Obj) :
Eli Bendersky60bdc5b2013-02-05 23:30:58 +0000530 IsLittleEndian(Obj->isLittleEndian()),
531 AddressSize(Obj->getBytesInAddress()) {
Eric Christopherd1726a42012-11-12 21:40:38 +0000532 error_code ec;
533 for (object::section_iterator i = Obj->begin_sections(),
534 e = Obj->end_sections();
535 i != e; i.increment(ec)) {
536 StringRef name;
537 i->getName(name);
538 StringRef data;
539 i->getContents(data);
540
Eric Christopherd1726a42012-11-12 21:40:38 +0000541 name = name.substr(name.find_first_not_of("._")); // Skip . and _ prefixes.
Alexey Samsonov784baa62013-04-17 14:27:04 +0000542
Alexey Samsonov005159e2013-04-23 10:17:34 +0000543 // Check if debug info section is compressed with zlib.
544 if (name.startswith("zdebug_")) {
545 uint64_t OriginalSize;
546 if (!zlib::isAvailable() ||
547 !consumeCompressedDebugSectionHeader(data, OriginalSize))
548 continue;
549 OwningPtr<MemoryBuffer> UncompressedSection;
550 if (zlib::uncompress(data, UncompressedSection, OriginalSize) !=
551 zlib::StatusOK)
552 continue;
553 // Make data point to uncompressed section contents and save its contents.
554 name = name.substr(1);
555 data = UncompressedSection->getBuffer();
556 UncompressedSections.push_back(UncompressedSection.take());
557 }
558
Alexey Samsonov784baa62013-04-17 14:27:04 +0000559 StringRef *Section = StringSwitch<StringRef*>(name)
560 .Case("debug_info", &InfoSection)
561 .Case("debug_abbrev", &AbbrevSection)
David Blaikie3df7d2f2013-06-19 21:37:13 +0000562 .Case("debug_loc", &LocSection)
Alexey Samsonov784baa62013-04-17 14:27:04 +0000563 .Case("debug_line", &LineSection)
564 .Case("debug_aranges", &ARangeSection)
565 .Case("debug_frame", &DebugFrameSection)
566 .Case("debug_str", &StringSection)
567 .Case("debug_ranges", &RangeSection)
568 .Case("debug_pubnames", &PubNamesSection)
569 .Case("debug_info.dwo", &InfoDWOSection)
570 .Case("debug_abbrev.dwo", &AbbrevDWOSection)
571 .Case("debug_str.dwo", &StringDWOSection)
572 .Case("debug_str_offsets.dwo", &StringOffsetDWOSection)
573 .Case("debug_addr", &AddrSection)
574 // Any more debug info sections go here.
575 .Default(0);
Rafael Espindola7486d922013-05-30 03:05:14 +0000576 if (Section) {
577 *Section = data;
578 if (name == "debug_ranges") {
579 // FIXME: Use the other dwo range section when we emit it.
580 RangeDWOSection = data;
581 }
Eric Christopher82de10a2013-01-02 23:52:13 +0000582 }
Eric Christopherd1726a42012-11-12 21:40:38 +0000583
Rafael Espindola7486d922013-05-30 03:05:14 +0000584 section_iterator RelocatedSection = i->getRelocatedSection();
585 if (RelocatedSection == Obj->end_sections())
586 continue;
587
588 StringRef RelSecName;
589 RelocatedSection->getName(RelSecName);
590 RelSecName = RelSecName.substr(
591 RelSecName.find_first_not_of("._")); // Skip . and _ prefixes.
592
Andrew Kayloree7c0d22013-01-25 22:50:58 +0000593 // TODO: Add support for relocations in other sections as needed.
594 // Record relocations for the debug_info and debug_line sections.
Rafael Espindola7486d922013-05-30 03:05:14 +0000595 RelocAddrMap *Map = StringSwitch<RelocAddrMap*>(RelSecName)
Alexey Samsonov784baa62013-04-17 14:27:04 +0000596 .Case("debug_info", &InfoRelocMap)
David Blaikie3df7d2f2013-06-19 21:37:13 +0000597 .Case("debug_loc", &LocRelocMap)
Alexey Samsonov784baa62013-04-17 14:27:04 +0000598 .Case("debug_info.dwo", &InfoDWORelocMap)
599 .Case("debug_line", &LineRelocMap)
600 .Default(0);
601 if (!Map)
Eric Christopherd1726a42012-11-12 21:40:38 +0000602 continue;
603
604 if (i->begin_relocations() != i->end_relocations()) {
605 uint64_t SectionSize;
Rafael Espindola7486d922013-05-30 03:05:14 +0000606 RelocatedSection->getSize(SectionSize);
Eric Christopherd1726a42012-11-12 21:40:38 +0000607 for (object::relocation_iterator reloc_i = i->begin_relocations(),
608 reloc_e = i->end_relocations();
609 reloc_i != reloc_e; reloc_i.increment(ec)) {
610 uint64_t Address;
Rafael Espindola956ca722013-04-25 12:28:45 +0000611 reloc_i->getOffset(Address);
Eric Christopherd1726a42012-11-12 21:40:38 +0000612 uint64_t Type;
613 reloc_i->getType(Type);
Andrew Kayloree7c0d22013-01-25 22:50:58 +0000614 uint64_t SymAddr = 0;
615 // ELF relocations may need the symbol address
616 if (Obj->isELF()) {
Rafael Espindola6c1202c2013-06-05 01:33:53 +0000617 object::symbol_iterator Sym = reloc_i->getSymbol();
618 Sym->getAddress(SymAddr);
Andrew Kayloree7c0d22013-01-25 22:50:58 +0000619 }
Eric Christopherd1726a42012-11-12 21:40:38 +0000620
621 object::RelocVisitor V(Obj->getFileFormatName());
622 // The section address is always 0 for debug sections.
Andrew Kayloree7c0d22013-01-25 22:50:58 +0000623 object::RelocToApply R(V.visit(Type, *reloc_i, 0, SymAddr));
Eric Christopherd1726a42012-11-12 21:40:38 +0000624 if (V.error()) {
625 SmallString<32> Name;
626 error_code ec(reloc_i->getTypeName(Name));
627 if (ec) {
628 errs() << "Aaaaaa! Nameless relocation! Aaaaaa!\n";
629 }
630 errs() << "error: failed to compute relocation: "
631 << Name << "\n";
632 continue;
633 }
634
635 if (Address + R.Width > SectionSize) {
636 errs() << "error: " << R.Width << "-byte relocation starting "
637 << Address << " bytes into section " << name << " which is "
638 << SectionSize << " bytes long.\n";
639 continue;
640 }
641 if (R.Width > 8) {
642 errs() << "error: can't handle a relocation of more than 8 bytes at "
643 "a time.\n";
644 continue;
645 }
646 DEBUG(dbgs() << "Writing " << format("%p", R.Value)
647 << " at " << format("%p", Address)
648 << " with width " << format("%d", R.Width)
649 << "\n");
Eric Christopher82de10a2013-01-02 23:52:13 +0000650 Map->insert(std::make_pair(Address, std::make_pair(R.Width, R.Value)));
Eric Christopherd1726a42012-11-12 21:40:38 +0000651 }
652 }
653 }
654}
655
Alexey Samsonov005159e2013-04-23 10:17:34 +0000656DWARFContextInMemory::~DWARFContextInMemory() {
657 DeleteContainerPointers(UncompressedSections);
658}
659
David Blaikie2d24e2a2011-12-20 02:50:00 +0000660void DWARFContextInMemory::anchor() { }