blob: baf2bb5b577289b656aa8d6b1017433ee53a26d3 [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
Eli Bendersky939a4e82013-01-25 20:26:43 +000031void DWARFContext::dump(raw_ostream &OS, DIDumpType DumpType) {
32 if (DumpType == DIDT_All || DumpType == DIDT_Abbrev) {
33 OS << ".debug_abbrev contents:\n";
34 getDebugAbbrev()->dump(OS);
35 }
Benjamin Kramer358f4fd2011-09-14 01:09:52 +000036
Eli Bendersky939a4e82013-01-25 20:26:43 +000037 if (DumpType == DIDT_All || DumpType == DIDT_Info) {
38 OS << "\n.debug_info contents:\n";
39 for (unsigned i = 0, e = getNumCompileUnits(); i != e; ++i)
40 getCompileUnitAtIndex(i)->dump(OS);
41 }
Benjamin Kramer358f4fd2011-09-14 01:09:52 +000042
David Blaikie3df7d2f2013-06-19 21:37:13 +000043 if (DumpType == DIDT_All || DumpType == DIDT_Loc) {
44 OS << ".debug_loc contents:\n";
45 getDebugLoc()->dump(OS);
46 }
47
Eli Bendersky60bdc5b2013-02-05 23:30:58 +000048 if (DumpType == DIDT_All || DumpType == DIDT_Frames) {
49 OS << "\n.debug_frame contents:\n";
50 getDebugFrame()->dump(OS);
51 }
52
Benjamin Kramer358f4fd2011-09-14 01:09:52 +000053 uint32_t offset = 0;
Eli Bendersky939a4e82013-01-25 20:26:43 +000054 if (DumpType == DIDT_All || DumpType == DIDT_Aranges) {
55 OS << "\n.debug_aranges contents:\n";
56 DataExtractor arangesData(getARangeSection(), isLittleEndian(), 0);
57 DWARFDebugArangeSet set;
58 while (set.extract(arangesData, &offset))
59 set.dump(OS);
60 }
Benjamin Kramerb848e972011-09-15 02:12:05 +000061
Alexey Samsonoveceb5b92012-08-27 07:17:47 +000062 uint8_t savedAddressByteSize = 0;
Eli Bendersky939a4e82013-01-25 20:26:43 +000063 if (DumpType == DIDT_All || DumpType == DIDT_Line) {
64 OS << "\n.debug_line contents:\n";
65 for (unsigned i = 0, e = getNumCompileUnits(); i != e; ++i) {
66 DWARFCompileUnit *cu = getCompileUnitAtIndex(i);
67 savedAddressByteSize = cu->getAddressByteSize();
68 unsigned stmtOffset =
69 cu->getCompileUnitDIE()->getAttributeValueAsUnsigned(cu, DW_AT_stmt_list,
70 -1U);
71 if (stmtOffset != -1U) {
72 DataExtractor lineData(getLineSection(), isLittleEndian(),
73 savedAddressByteSize);
74 DWARFDebugLine::DumpingState state(OS);
Andrew Kayloree7c0d22013-01-25 22:50:58 +000075 DWARFDebugLine::parseStatementTable(lineData, &lineRelocMap(), &stmtOffset, state);
Eli Bendersky939a4e82013-01-25 20:26:43 +000076 }
Benjamin Kramerfe80f1d2011-09-15 18:02:20 +000077 }
78 }
Benjamin Kramer34f864f2011-09-15 16:57:13 +000079
Eli Bendersky939a4e82013-01-25 20:26:43 +000080 if (DumpType == DIDT_All || DumpType == DIDT_Str) {
81 OS << "\n.debug_str contents:\n";
82 DataExtractor strData(getStringSection(), isLittleEndian(), 0);
83 offset = 0;
84 uint32_t strOffset = 0;
85 while (const char *s = strData.getCStr(&offset)) {
86 OS << format("0x%8.8x: \"%s\"\n", strOffset, s);
87 strOffset = offset;
88 }
Benjamin Kramer34f864f2011-09-15 16:57:13 +000089 }
Alexey Samsonoveceb5b92012-08-27 07:17:47 +000090
Eli Bendersky939a4e82013-01-25 20:26:43 +000091 if (DumpType == DIDT_All || DumpType == DIDT_Ranges) {
92 OS << "\n.debug_ranges contents:\n";
93 // In fact, different compile units may have different address byte
94 // sizes, but for simplicity we just use the address byte size of the last
95 // compile unit (there is no easy and fast way to associate address range
96 // list and the compile unit it describes).
97 DataExtractor rangesData(getRangeSection(), isLittleEndian(),
98 savedAddressByteSize);
99 offset = 0;
100 DWARFDebugRangeList rangeList;
101 while (rangeList.extract(rangesData, &offset))
102 rangeList.dump(OS);
Eric Christopher82de10a2013-01-02 23:52:13 +0000103 }
Eric Christopher72f7bfb2013-01-15 23:56:56 +0000104
Krzysztof Parzyszeke38825f2013-02-12 16:20:28 +0000105 if (DumpType == DIDT_All || DumpType == DIDT_Pubnames) {
106 OS << "\n.debug_pubnames contents:\n";
107 DataExtractor pubNames(getPubNamesSection(), isLittleEndian(), 0);
108 offset = 0;
109 OS << "Length: " << pubNames.getU32(&offset) << "\n";
110 OS << "Version: " << pubNames.getU16(&offset) << "\n";
111 OS << "Offset in .debug_info: " << pubNames.getU32(&offset) << "\n";
112 OS << "Size: " << pubNames.getU32(&offset) << "\n";
113 OS << "\n Offset Name\n";
114 while (offset < getPubNamesSection().size()) {
115 uint32_t n = pubNames.getU32(&offset);
116 if (n == 0)
117 break;
118 OS << format("%8x ", n);
119 OS << pubNames.getCStr(&offset) << "\n";
120 }
121 }
122
Eli Bendersky939a4e82013-01-25 20:26:43 +0000123 if (DumpType == DIDT_All || DumpType == DIDT_AbbrevDwo) {
Eric Christopher93f3fed2013-05-06 17:50:42 +0000124 const DWARFDebugAbbrev *D = getDebugAbbrevDWO();
125 if (D) {
126 OS << "\n.debug_abbrev.dwo contents:\n";
127 getDebugAbbrevDWO()->dump(OS);
Eli Bendersky939a4e82013-01-25 20:26:43 +0000128 }
129 }
130
Eric Christopher93f3fed2013-05-06 17:50:42 +0000131 if (DumpType == DIDT_All || DumpType == DIDT_InfoDwo)
132 if (getNumDWOCompileUnits()) {
133 OS << "\n.debug_info.dwo contents:\n";
134 for (unsigned i = 0, e = getNumDWOCompileUnits(); i != e; ++i)
Eric Christopher5a0c3662013-05-06 21:19:41 +0000135 getDWOCompileUnitAtIndex(i)->dump(OS);
Eli Bendersky939a4e82013-01-25 20:26:43 +0000136 }
Eric Christopher93f3fed2013-05-06 17:50:42 +0000137
138 if (DumpType == DIDT_All || DumpType == DIDT_StrDwo)
139 if (!getStringDWOSection().empty()) {
140 OS << "\n.debug_str.dwo contents:\n";
141 DataExtractor strDWOData(getStringDWOSection(), isLittleEndian(), 0);
142 offset = 0;
143 uint32_t strDWOOffset = 0;
144 while (const char *s = strDWOData.getCStr(&offset)) {
Eric Christopher5a0c3662013-05-06 21:19:41 +0000145 OS << format("0x%8.8x: \"%s\"\n", strDWOOffset, s);
146 strDWOOffset = offset;
Eric Christopher93f3fed2013-05-06 17:50:42 +0000147 }
148 }
149
150 if (DumpType == DIDT_All || DumpType == DIDT_StrOffsetsDwo)
151 if (!getStringOffsetDWOSection().empty()) {
152 OS << "\n.debug_str_offsets.dwo contents:\n";
153 DataExtractor strOffsetExt(getStringOffsetDWOSection(), isLittleEndian(), 0);
154 offset = 0;
Eric Christophere305e032013-05-06 21:19:44 +0000155 uint64_t size = getStringOffsetDWOSection().size();
156 while (offset < size) {
Eric Christopher5a0c3662013-05-06 21:19:41 +0000157 OS << format("0x%8.8x: ", offset);
158 OS << format("%8.8x\n", strOffsetExt.getU32(&offset));
Eric Christopher93f3fed2013-05-06 17:50:42 +0000159 }
160 }
Benjamin Kramer72c0d7f2011-09-13 19:42:23 +0000161}
162
163const DWARFDebugAbbrev *DWARFContext::getDebugAbbrev() {
164 if (Abbrev)
165 return Abbrev.get();
166
167 DataExtractor abbrData(getAbbrevSection(), isLittleEndian(), 0);
168
169 Abbrev.reset(new DWARFDebugAbbrev());
170 Abbrev->parse(abbrData);
171 return Abbrev.get();
172}
173
Eric Christopher82de10a2013-01-02 23:52:13 +0000174const DWARFDebugAbbrev *DWARFContext::getDebugAbbrevDWO() {
175 if (AbbrevDWO)
176 return AbbrevDWO.get();
177
178 DataExtractor abbrData(getAbbrevDWOSection(), isLittleEndian(), 0);
179 AbbrevDWO.reset(new DWARFDebugAbbrev());
180 AbbrevDWO->parse(abbrData);
181 return AbbrevDWO.get();
182}
183
David Blaikie3df7d2f2013-06-19 21:37:13 +0000184const DWARFDebugLoc *DWARFContext::getDebugLoc() {
185 if (Loc)
186 return Loc.get();
187
188 DataExtractor LocData(getLocSection(), isLittleEndian(), 0);
189 Loc.reset(new DWARFDebugLoc(locRelocMap()));
190 // assume all compile units have the same address byte size
191 if (getNumCompileUnits())
192 Loc->parse(LocData, getCompileUnitAtIndex(0)->getAddressByteSize());
193 return Loc.get();
194}
195
Benjamin Kramer358f4fd2011-09-14 01:09:52 +0000196const DWARFDebugAranges *DWARFContext::getDebugAranges() {
197 if (Aranges)
198 return Aranges.get();
199
200 DataExtractor arangesData(getARangeSection(), isLittleEndian(), 0);
201
202 Aranges.reset(new DWARFDebugAranges());
203 Aranges->extract(arangesData);
Alexey Samsonov63a450a2012-11-16 08:36:25 +0000204 // Generate aranges from DIEs: even if .debug_aranges section is present,
205 // it may describe only a small subset of compilation units, so we need to
206 // manually build aranges for the rest of them.
207 Aranges->generate(this);
Benjamin Kramer358f4fd2011-09-14 01:09:52 +0000208 return Aranges.get();
209}
210
Eli Bendersky60bdc5b2013-02-05 23:30:58 +0000211const DWARFDebugFrame *DWARFContext::getDebugFrame() {
212 if (DebugFrame)
213 return DebugFrame.get();
214
215 // There's a "bug" in the DWARFv3 standard with respect to the target address
216 // size within debug frame sections. While DWARF is supposed to be independent
217 // of its container, FDEs have fields with size being "target address size",
218 // which isn't specified in DWARF in general. It's only specified for CUs, but
219 // .eh_frame can appear without a .debug_info section. Follow the example of
220 // other tools (libdwarf) and extract this from the container (ObjectFile
221 // provides this information). This problem is fixed in DWARFv4
222 // See this dwarf-discuss discussion for more details:
223 // http://lists.dwarfstd.org/htdig.cgi/dwarf-discuss-dwarfstd.org/2011-December/001173.html
224 DataExtractor debugFrameData(getDebugFrameSection(), isLittleEndian(),
225 getAddressSize());
226 DebugFrame.reset(new DWARFDebugFrame());
227 DebugFrame->parse(debugFrameData);
228 return DebugFrame.get();
229}
230
Eric Christophere9403c12012-10-16 23:46:25 +0000231const DWARFLineTable *
Benjamin Kramerc26ed9b2011-09-15 20:43:18 +0000232DWARFContext::getLineTableForCompileUnit(DWARFCompileUnit *cu) {
233 if (!Line)
Andrew Kayloree7c0d22013-01-25 22:50:58 +0000234 Line.reset(new DWARFDebugLine(&lineRelocMap()));
Benjamin Kramerb848e972011-09-15 02:12:05 +0000235
Benjamin Kramerc26ed9b2011-09-15 20:43:18 +0000236 unsigned stmtOffset =
237 cu->getCompileUnitDIE()->getAttributeValueAsUnsigned(cu, DW_AT_stmt_list,
238 -1U);
239 if (stmtOffset == -1U)
240 return 0; // No line table for this compile unit.
Benjamin Kramerb848e972011-09-15 02:12:05 +0000241
Benjamin Kramerc26ed9b2011-09-15 20:43:18 +0000242 // See if the line table is cached.
Eric Christophere9403c12012-10-16 23:46:25 +0000243 if (const DWARFLineTable *lt = Line->getLineTable(stmtOffset))
Benjamin Kramerc26ed9b2011-09-15 20:43:18 +0000244 return lt;
245
246 // We have to parse it first.
247 DataExtractor lineData(getLineSection(), isLittleEndian(),
248 cu->getAddressByteSize());
249 return Line->getOrParseLineTable(lineData, stmtOffset);
Benjamin Kramerb848e972011-09-15 02:12:05 +0000250}
251
Benjamin Kramer72c0d7f2011-09-13 19:42:23 +0000252void DWARFContext::parseCompileUnits() {
253 uint32_t offset = 0;
Eric Christopherb69b55f2012-10-16 23:46:23 +0000254 const DataExtractor &DIData = DataExtractor(getInfoSection(),
255 isLittleEndian(), 0);
256 while (DIData.isValidOffset(offset)) {
Alexey Samsonoveb0c1792013-08-23 06:56:01 +0000257 OwningPtr<DWARFCompileUnit> CU(new DWARFCompileUnit(
258 getDebugAbbrev(), getInfoSection(), getAbbrevSection(),
259 getRangeSection(), getStringSection(), StringRef(), getAddrSection(),
260 &infoRelocMap(), isLittleEndian()));
261 if (!CU->extract(DIData, &offset)) {
Benjamin Kramer72c0d7f2011-09-13 19:42:23 +0000262 break;
263 }
Alexey Samsonoveb0c1792013-08-23 06:56:01 +0000264 CUs.push_back(CU.take());
265 offset = CUs.back()->getNextCompileUnitOffset();
Benjamin Kramer72c0d7f2011-09-13 19:42:23 +0000266 }
267}
Benjamin Kramer101b1c52011-09-15 20:43:22 +0000268
Eric Christopher82de10a2013-01-02 23:52:13 +0000269void DWARFContext::parseDWOCompileUnits() {
270 uint32_t offset = 0;
271 const DataExtractor &DIData = DataExtractor(getInfoDWOSection(),
272 isLittleEndian(), 0);
273 while (DIData.isValidOffset(offset)) {
Alexey Samsonoveb0c1792013-08-23 06:56:01 +0000274 OwningPtr<DWARFCompileUnit> DWOCU(new DWARFCompileUnit(
275 getDebugAbbrevDWO(), getInfoDWOSection(), getAbbrevDWOSection(),
276 getRangeDWOSection(), getStringDWOSection(),
277 getStringOffsetDWOSection(), getAddrSection(), &infoDWORelocMap(),
278 isLittleEndian()));
279 if (!DWOCU->extract(DIData, &offset)) {
Eric Christopher82de10a2013-01-02 23:52:13 +0000280 break;
281 }
Alexey Samsonoveb0c1792013-08-23 06:56:01 +0000282 DWOCUs.push_back(DWOCU.take());
283 offset = DWOCUs.back()->getNextCompileUnitOffset();
Eric Christopher82de10a2013-01-02 23:52:13 +0000284 }
285}
286
Benjamin Kramer101b1c52011-09-15 20:43:22 +0000287namespace {
288 struct OffsetComparator {
Alexey Samsonoveb0c1792013-08-23 06:56:01 +0000289 bool operator()(const DWARFCompileUnit *LHS,
290 const DWARFCompileUnit *RHS) const {
291 return LHS->getOffset() < RHS->getOffset();
Benjamin Kramer101b1c52011-09-15 20:43:22 +0000292 }
Alexey Samsonoveb0c1792013-08-23 06:56:01 +0000293 bool operator()(const DWARFCompileUnit *LHS, uint32_t RHS) const {
294 return LHS->getOffset() < RHS;
Benjamin Kramer101b1c52011-09-15 20:43:22 +0000295 }
Alexey Samsonoveb0c1792013-08-23 06:56:01 +0000296 bool operator()(uint32_t LHS, const DWARFCompileUnit *RHS) const {
297 return LHS < RHS->getOffset();
Benjamin Kramer101b1c52011-09-15 20:43:22 +0000298 }
299 };
300}
301
Alexey Samsonov38a63812012-08-30 07:49:50 +0000302DWARFCompileUnit *DWARFContext::getCompileUnitForOffset(uint32_t Offset) {
Benjamin Kramer101b1c52011-09-15 20:43:22 +0000303 if (CUs.empty())
304 parseCompileUnits();
305
Alexey Samsonoveb0c1792013-08-23 06:56:01 +0000306 DWARFCompileUnit **CU =
307 std::lower_bound(CUs.begin(), CUs.end(), Offset, OffsetComparator());
308 if (CU != CUs.end()) {
309 return *CU;
310 }
Benjamin Kramer101b1c52011-09-15 20:43:22 +0000311 return 0;
312}
313
Alexey Samsonov38a63812012-08-30 07:49:50 +0000314DWARFCompileUnit *DWARFContext::getCompileUnitForAddress(uint64_t Address) {
Benjamin Kramer9013db32011-09-15 21:59:13 +0000315 // First, get the offset of the compile unit.
Alexey Samsonov38a63812012-08-30 07:49:50 +0000316 uint32_t CUOffset = getDebugAranges()->findAddress(Address);
Benjamin Kramer101b1c52011-09-15 20:43:22 +0000317 // Retrieve the compile unit.
Alexey Samsonov38a63812012-08-30 07:49:50 +0000318 return getCompileUnitForOffset(CUOffset);
319}
320
Eric Christophere9403c12012-10-16 23:46:25 +0000321static bool getFileNameForCompileUnit(DWARFCompileUnit *CU,
322 const DWARFLineTable *LineTable,
323 uint64_t FileIndex,
324 bool NeedsAbsoluteFilePath,
325 std::string &FileName) {
Alexey Samsonov38a63812012-08-30 07:49:50 +0000326 if (CU == 0 ||
327 LineTable == 0 ||
328 !LineTable->getFileNameByIndex(FileIndex, NeedsAbsoluteFilePath,
329 FileName))
330 return false;
331 if (NeedsAbsoluteFilePath && sys::path::is_relative(FileName)) {
332 // We may still need to append compilation directory of compile unit.
333 SmallString<16> AbsolutePath;
334 if (const char *CompilationDir = CU->getCompilationDir()) {
335 sys::path::append(AbsolutePath, CompilationDir);
336 }
337 sys::path::append(AbsolutePath, FileName);
338 FileName = AbsolutePath.str();
339 }
340 return true;
341}
342
Eric Christophere9403c12012-10-16 23:46:25 +0000343static bool getFileLineInfoForCompileUnit(DWARFCompileUnit *CU,
344 const DWARFLineTable *LineTable,
345 uint64_t Address,
346 bool NeedsAbsoluteFilePath,
347 std::string &FileName,
348 uint32_t &Line, uint32_t &Column) {
Alexey Samsonov5eae90d2012-09-04 08:12:33 +0000349 if (CU == 0 || LineTable == 0)
Alexey Samsonov38a63812012-08-30 07:49:50 +0000350 return false;
351 // Get the index of row we're looking for in the line table.
352 uint32_t RowIndex = LineTable->lookupAddress(Address);
353 if (RowIndex == -1U)
354 return false;
355 // Take file number and line/column from the row.
356 const DWARFDebugLine::Row &Row = LineTable->Rows[RowIndex];
357 if (!getFileNameForCompileUnit(CU, LineTable, Row.File,
358 NeedsAbsoluteFilePath, FileName))
359 return false;
360 Line = Row.Line;
361 Column = Row.Column;
362 return true;
363}
364
365DILineInfo DWARFContext::getLineInfoForAddress(uint64_t Address,
366 DILineInfoSpecifier Specifier) {
367 DWARFCompileUnit *CU = getCompileUnitForAddress(Address);
368 if (!CU)
Alexey Samsonov3e25c4a2012-07-02 05:54:45 +0000369 return DILineInfo();
Alexey Samsonov38a63812012-08-30 07:49:50 +0000370 std::string FileName = "<invalid>";
371 std::string FunctionName = "<invalid>";
372 uint32_t Line = 0;
373 uint32_t Column = 0;
374 if (Specifier.needs(DILineInfoSpecifier::FunctionName)) {
Alexey Samsonov5eae90d2012-09-04 08:12:33 +0000375 // The address may correspond to instruction in some inlined function,
376 // so we have to build the chain of inlined functions and take the
377 // name of the topmost function in it.
Alexey Samsonove6642902013-08-06 10:49:15 +0000378 const DWARFDebugInfoEntryInlinedChain &InlinedChain =
Alexey Samsonov5eae90d2012-09-04 08:12:33 +0000379 CU->getInlinedChainForAddress(Address);
Alexey Samsonove6642902013-08-06 10:49:15 +0000380 if (InlinedChain.DIEs.size() > 0) {
381 const DWARFDebugInfoEntryMinimal &TopFunctionDIE = InlinedChain.DIEs[0];
382 if (const char *Name = TopFunctionDIE.getSubroutineName(InlinedChain.CU))
Alexey Samsonov38a63812012-08-30 07:49:50 +0000383 FunctionName = Name;
Alexey Samsonov9d26b0b2012-07-17 15:28:35 +0000384 }
Alexey Samsonov3e25c4a2012-07-02 05:54:45 +0000385 }
Alexey Samsonov38a63812012-08-30 07:49:50 +0000386 if (Specifier.needs(DILineInfoSpecifier::FileLineInfo)) {
Eric Christophere9403c12012-10-16 23:46:25 +0000387 const DWARFLineTable *LineTable = getLineTableForCompileUnit(CU);
Alexey Samsonov38a63812012-08-30 07:49:50 +0000388 const bool NeedsAbsoluteFilePath =
389 Specifier.needs(DILineInfoSpecifier::AbsoluteFilePath);
Alexey Samsonov5eae90d2012-09-04 08:12:33 +0000390 getFileLineInfoForCompileUnit(CU, LineTable, Address,
391 NeedsAbsoluteFilePath,
Alexey Samsonov38a63812012-08-30 07:49:50 +0000392 FileName, Line, Column);
Alexey Samsonov3e25c4a2012-07-02 05:54:45 +0000393 }
Alexey Samsonov38a63812012-08-30 07:49:50 +0000394 return DILineInfo(StringRef(FileName), StringRef(FunctionName),
395 Line, Column);
Benjamin Kramer101b1c52011-09-15 20:43:22 +0000396}
David Blaikie2d24e2a2011-12-20 02:50:00 +0000397
Andrew Kaylore27a7872013-01-26 00:28:05 +0000398DILineInfoTable DWARFContext::getLineInfoForAddressRange(uint64_t Address,
399 uint64_t Size,
400 DILineInfoSpecifier Specifier) {
401 DILineInfoTable Lines;
402 DWARFCompileUnit *CU = getCompileUnitForAddress(Address);
403 if (!CU)
404 return Lines;
405
406 std::string FunctionName = "<invalid>";
407 if (Specifier.needs(DILineInfoSpecifier::FunctionName)) {
408 // The address may correspond to instruction in some inlined function,
409 // so we have to build the chain of inlined functions and take the
410 // name of the topmost function in it.
Alexey Samsonove6642902013-08-06 10:49:15 +0000411 const DWARFDebugInfoEntryInlinedChain &InlinedChain =
Andrew Kaylore27a7872013-01-26 00:28:05 +0000412 CU->getInlinedChainForAddress(Address);
Alexey Samsonove6642902013-08-06 10:49:15 +0000413 if (InlinedChain.DIEs.size() > 0) {
414 const DWARFDebugInfoEntryMinimal &TopFunctionDIE = InlinedChain.DIEs[0];
415 if (const char *Name = TopFunctionDIE.getSubroutineName(InlinedChain.CU))
Andrew Kaylore27a7872013-01-26 00:28:05 +0000416 FunctionName = Name;
417 }
418 }
419
420 StringRef FuncNameRef = StringRef(FunctionName);
421
422 // If the Specifier says we don't need FileLineInfo, just
423 // return the top-most function at the starting address.
424 if (!Specifier.needs(DILineInfoSpecifier::FileLineInfo)) {
Alexey Samsonove6642902013-08-06 10:49:15 +0000425 Lines.push_back(std::make_pair(Address,
426 DILineInfo(StringRef("<invalid>"),
Andrew Kaylore27a7872013-01-26 00:28:05 +0000427 FuncNameRef, 0, 0)));
428 return Lines;
429 }
430
431 const DWARFLineTable *LineTable = getLineTableForCompileUnit(CU);
432 const bool NeedsAbsoluteFilePath =
433 Specifier.needs(DILineInfoSpecifier::AbsoluteFilePath);
434
435 // Get the index of row we're looking for in the line table.
436 std::vector<uint32_t> RowVector;
437 if (!LineTable->lookupAddressRange(Address, Size, RowVector))
438 return Lines;
439
440 uint32_t NumRows = RowVector.size();
441 for (uint32_t i = 0; i < NumRows; ++i) {
442 uint32_t RowIndex = RowVector[i];
443 // Take file number and line/column from the row.
444 const DWARFDebugLine::Row &Row = LineTable->Rows[RowIndex];
445 std::string FileName = "<invalid>";
446 getFileNameForCompileUnit(CU, LineTable, Row.File,
447 NeedsAbsoluteFilePath, FileName);
Alexey Samsonove6642902013-08-06 10:49:15 +0000448 Lines.push_back(std::make_pair(Row.Address,
Andrew Kaylore27a7872013-01-26 00:28:05 +0000449 DILineInfo(StringRef(FileName),
450 FuncNameRef, Row.Line, Row.Column)));
451 }
452
453 return Lines;
454}
455
Alexey Samsonov5eae90d2012-09-04 08:12:33 +0000456DIInliningInfo DWARFContext::getInliningInfoForAddress(uint64_t Address,
457 DILineInfoSpecifier Specifier) {
458 DWARFCompileUnit *CU = getCompileUnitForAddress(Address);
459 if (!CU)
460 return DIInliningInfo();
461
Alexey Samsonove6642902013-08-06 10:49:15 +0000462 const DWARFDebugInfoEntryInlinedChain &InlinedChain =
Alexey Samsonov5eae90d2012-09-04 08:12:33 +0000463 CU->getInlinedChainForAddress(Address);
Alexey Samsonove6642902013-08-06 10:49:15 +0000464 if (InlinedChain.DIEs.size() == 0)
Alexey Samsonov5eae90d2012-09-04 08:12:33 +0000465 return DIInliningInfo();
466
467 DIInliningInfo InliningInfo;
468 uint32_t CallFile = 0, CallLine = 0, CallColumn = 0;
Eric Christophere9403c12012-10-16 23:46:25 +0000469 const DWARFLineTable *LineTable = 0;
Alexey Samsonove6642902013-08-06 10:49:15 +0000470 for (uint32_t i = 0, n = InlinedChain.DIEs.size(); i != n; i++) {
471 const DWARFDebugInfoEntryMinimal &FunctionDIE = InlinedChain.DIEs[i];
Alexey Samsonov5eae90d2012-09-04 08:12:33 +0000472 std::string FileName = "<invalid>";
473 std::string FunctionName = "<invalid>";
474 uint32_t Line = 0;
475 uint32_t Column = 0;
476 // Get function name if necessary.
477 if (Specifier.needs(DILineInfoSpecifier::FunctionName)) {
Alexey Samsonove6642902013-08-06 10:49:15 +0000478 if (const char *Name = FunctionDIE.getSubroutineName(InlinedChain.CU))
Alexey Samsonov5eae90d2012-09-04 08:12:33 +0000479 FunctionName = Name;
480 }
481 if (Specifier.needs(DILineInfoSpecifier::FileLineInfo)) {
482 const bool NeedsAbsoluteFilePath =
483 Specifier.needs(DILineInfoSpecifier::AbsoluteFilePath);
484 if (i == 0) {
485 // For the topmost frame, initialize the line table of this
486 // compile unit and fetch file/line info from it.
487 LineTable = getLineTableForCompileUnit(CU);
488 // For the topmost routine, get file/line info from line table.
489 getFileLineInfoForCompileUnit(CU, LineTable, Address,
490 NeedsAbsoluteFilePath,
491 FileName, Line, Column);
492 } else {
493 // Otherwise, use call file, call line and call column from
494 // previous DIE in inlined chain.
495 getFileNameForCompileUnit(CU, LineTable, CallFile,
496 NeedsAbsoluteFilePath, FileName);
497 Line = CallLine;
498 Column = CallColumn;
499 }
500 // Get call file/line/column of a current DIE.
501 if (i + 1 < n) {
Alexey Samsonove6642902013-08-06 10:49:15 +0000502 FunctionDIE.getCallerFrame(InlinedChain.CU, CallFile, CallLine,
503 CallColumn);
Alexey Samsonov5eae90d2012-09-04 08:12:33 +0000504 }
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() { }