blob: aa86f6aac0312b47bad723460d8d1dde69c177f5 [file] [log] [blame]
Benjamin Krameraa2f78f2011-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 Samsonov001ecd92014-04-25 21:30:03 +000011#include "DWARFDebugArangeSet.h"
12
Alexey Samsonove16e16a2012-07-19 07:03:58 +000013#include "llvm/ADT/SmallString.h"
Alexey Samsonov3d0e3ed2013-04-17 14:27:04 +000014#include "llvm/ADT/StringSwitch.h"
Alexey Samsonov068fc8a2013-04-23 10:17:34 +000015#include "llvm/Support/Compression.h"
Benjamin Kramer6dda0322011-09-15 18:02:20 +000016#include "llvm/Support/Dwarf.h"
Benjamin Kramer07d4b1c2011-09-15 16:57:13 +000017#include "llvm/Support/Format.h"
Alexey Samsonove16e16a2012-07-19 07:03:58 +000018#include "llvm/Support/Path.h"
Benjamin Kramera6002fd2011-09-14 01:09:52 +000019#include "llvm/Support/raw_ostream.h"
Benjamin Kramer2602ca62011-09-15 20:43:22 +000020#include <algorithm>
Benjamin Krameraa2f78f2011-09-13 19:42:23 +000021using namespace llvm;
Benjamin Kramer6dda0322011-09-15 18:02:20 +000022using namespace dwarf;
Rafael Espindola4f60a382013-05-30 03:05:14 +000023using namespace object;
Benjamin Krameraa2f78f2011-09-13 19:42:23 +000024
Chandler Carruthe96dd892014-04-21 22:55:11 +000025#define DEBUG_TYPE "dwarf"
26
Eric Christopher494109b2012-10-16 23:46:25 +000027typedef DWARFDebugLine::LineTable DWARFLineTable;
Alexey Samsonovdce67342014-05-15 21:24:32 +000028typedef DILineInfoSpecifier::FileLineInfoKind FileLineInfoKind;
29typedef DILineInfoSpecifier::FunctionNameKind FunctionNameKind;
Eric Christopher494109b2012-10-16 23:46:25 +000030
David Blaikieecd21ff2013-09-24 19:50:00 +000031static void dumpPubSection(raw_ostream &OS, StringRef Name, StringRef Data,
Eric Christopher0de53592013-09-25 23:02:36 +000032 bool LittleEndian, bool GnuStyle) {
David Blaikieecd21ff2013-09-24 19:50:00 +000033 OS << "\n." << Name << " contents:\n";
34 DataExtractor pubNames(Data, LittleEndian, 0);
35 uint32_t offset = 0;
David Blaikie8a263cb2013-11-26 00:22:37 +000036 while (pubNames.isValidOffset(offset)) {
37 OS << "length = " << format("0x%08x", pubNames.getU32(&offset));
38 OS << " version = " << format("0x%04x", pubNames.getU16(&offset));
39 OS << " unit_offset = " << format("0x%08x", pubNames.getU32(&offset));
40 OS << " unit_size = " << format("0x%08x", pubNames.getU32(&offset)) << '\n';
41 if (GnuStyle)
42 OS << "Offset Linkage Kind Name\n";
43 else
44 OS << "Offset Name\n";
Eric Christopher0de53592013-09-25 23:02:36 +000045
David Blaikie8a263cb2013-11-26 00:22:37 +000046 while (offset < Data.size()) {
47 uint32_t dieRef = pubNames.getU32(&offset);
48 if (dieRef == 0)
49 break;
50 OS << format("0x%8.8x ", dieRef);
51 if (GnuStyle) {
52 PubIndexEntryDescriptor desc(pubNames.getU8(&offset));
53 OS << format("%-8s", dwarf::GDBIndexEntryLinkageString(desc.Linkage))
54 << ' ' << format("%-8s", dwarf::GDBIndexEntryKindString(desc.Kind))
55 << ' ';
56 }
57 OS << '\"' << pubNames.getCStr(&offset) << "\"\n";
Eric Christopher0de53592013-09-25 23:02:36 +000058 }
David Blaikieecd21ff2013-09-24 19:50:00 +000059 }
60}
61
Eli Bendersky7a94daa2013-01-25 20:26:43 +000062void DWARFContext::dump(raw_ostream &OS, DIDumpType DumpType) {
63 if (DumpType == DIDT_All || DumpType == DIDT_Abbrev) {
64 OS << ".debug_abbrev contents:\n";
65 getDebugAbbrev()->dump(OS);
66 }
Benjamin Kramera6002fd2011-09-14 01:09:52 +000067
David Blaikie66865d62014-01-09 00:13:35 +000068 if (DumpType == DIDT_All || DumpType == DIDT_AbbrevDwo)
69 if (const DWARFDebugAbbrev *D = getDebugAbbrevDWO()) {
David Blaikie622dce42014-01-08 23:29:59 +000070 OS << "\n.debug_abbrev.dwo contents:\n";
David Blaikie66865d62014-01-09 00:13:35 +000071 D->dump(OS);
David Blaikie622dce42014-01-08 23:29:59 +000072 }
David Blaikie622dce42014-01-08 23:29:59 +000073
Eli Bendersky7a94daa2013-01-25 20:26:43 +000074 if (DumpType == DIDT_All || DumpType == DIDT_Info) {
75 OS << "\n.debug_info contents:\n";
Alexey Samsonov1eabf982014-03-13 07:52:54 +000076 for (const auto &CU : compile_units())
77 CU->dump(OS);
Eli Bendersky7a94daa2013-01-25 20:26:43 +000078 }
Benjamin Kramera6002fd2011-09-14 01:09:52 +000079
David Blaikie66865d62014-01-09 00:13:35 +000080 if ((DumpType == DIDT_All || DumpType == DIDT_InfoDwo) &&
81 getNumDWOCompileUnits()) {
82 OS << "\n.debug_info.dwo contents:\n";
Alexey Samsonov1eabf982014-03-13 07:52:54 +000083 for (const auto &DWOCU : dwo_compile_units())
84 DWOCU->dump(OS);
David Blaikie66865d62014-01-09 00:13:35 +000085 }
David Blaikie622dce42014-01-08 23:29:59 +000086
David Blaikie66865d62014-01-09 00:13:35 +000087 if ((DumpType == DIDT_All || DumpType == DIDT_Types) && getNumTypeUnits()) {
David Blaikie03c089c2013-09-23 22:44:47 +000088 OS << "\n.debug_types contents:\n";
Frederic Riss312a02e2014-09-29 13:56:39 +000089 for (const auto &TUS : type_unit_sections())
90 for (const auto &TU : TUS)
91 TU->dump(OS);
David Blaikie03c089c2013-09-23 22:44:47 +000092 }
93
Alexey Samsonov1eabf982014-03-13 07:52:54 +000094 if ((DumpType == DIDT_All || DumpType == DIDT_TypesDwo) &&
95 getNumDWOTypeUnits()) {
96 OS << "\n.debug_types.dwo contents:\n";
Frederic Riss312a02e2014-09-29 13:56:39 +000097 for (const auto &DWOTUS : dwo_type_unit_sections())
98 for (const auto &DWOTU : DWOTUS)
99 DWOTU->dump(OS);
Alexey Samsonov1eabf982014-03-13 07:52:54 +0000100 }
David Blaikie92d9d622014-01-09 05:08:24 +0000101
David Blaikie18e73502013-06-19 21:37:13 +0000102 if (DumpType == DIDT_All || DumpType == DIDT_Loc) {
David Blaikie03c089c2013-09-23 22:44:47 +0000103 OS << "\n.debug_loc contents:\n";
David Blaikie18e73502013-06-19 21:37:13 +0000104 getDebugLoc()->dump(OS);
105 }
106
David Blaikie9c550ac2014-03-25 01:44:02 +0000107 if (DumpType == DIDT_All || DumpType == DIDT_LocDwo) {
108 OS << "\n.debug_loc.dwo contents:\n";
109 getDebugLocDWO()->dump(OS);
110 }
111
Eli Benderskyfd08bc12013-02-05 23:30:58 +0000112 if (DumpType == DIDT_All || DumpType == DIDT_Frames) {
113 OS << "\n.debug_frame contents:\n";
114 getDebugFrame()->dump(OS);
115 }
116
Benjamin Kramera6002fd2011-09-14 01:09:52 +0000117 uint32_t offset = 0;
Eli Bendersky7a94daa2013-01-25 20:26:43 +0000118 if (DumpType == DIDT_All || DumpType == DIDT_Aranges) {
119 OS << "\n.debug_aranges contents:\n";
120 DataExtractor arangesData(getARangeSection(), isLittleEndian(), 0);
121 DWARFDebugArangeSet set;
122 while (set.extract(arangesData, &offset))
123 set.dump(OS);
124 }
Benjamin Kramer5acab502011-09-15 02:12:05 +0000125
Alexey Samsonov034e57a2012-08-27 07:17:47 +0000126 uint8_t savedAddressByteSize = 0;
Eli Bendersky7a94daa2013-01-25 20:26:43 +0000127 if (DumpType == DIDT_All || DumpType == DIDT_Line) {
128 OS << "\n.debug_line contents:\n";
Alexey Samsonov1eabf982014-03-13 07:52:54 +0000129 for (const auto &CU : compile_units()) {
130 savedAddressByteSize = CU->getAddressByteSize();
Eli Bendersky7a94daa2013-01-25 20:26:43 +0000131 unsigned stmtOffset =
Alexey Samsonov1eabf982014-03-13 07:52:54 +0000132 CU->getCompileUnitDIE()->getAttributeValueAsSectionOffset(
Alexey Samsonov96dc29c2014-03-13 08:19:59 +0000133 CU.get(), DW_AT_stmt_list, -1U);
Eli Bendersky7a94daa2013-01-25 20:26:43 +0000134 if (stmtOffset != -1U) {
David Blaikie1b5ee5d2013-09-23 17:42:01 +0000135 DataExtractor lineData(getLineSection().Data, isLittleEndian(),
Eli Bendersky7a94daa2013-01-25 20:26:43 +0000136 savedAddressByteSize);
Alexey Samsonov110d5952014-04-30 00:09:19 +0000137 DWARFDebugLine::LineTable LineTable;
138 LineTable.parse(lineData, &getLineSection().Relocs, &stmtOffset);
139 LineTable.dump(OS);
Eli Bendersky7a94daa2013-01-25 20:26:43 +0000140 }
Benjamin Kramer6dda0322011-09-15 18:02:20 +0000141 }
142 }
Benjamin Kramer07d4b1c2011-09-15 16:57:13 +0000143
David Blaikie1d4736e2014-02-24 23:58:54 +0000144 if (DumpType == DIDT_All || DumpType == DIDT_LineDwo) {
145 OS << "\n.debug_line.dwo contents:\n";
146 unsigned stmtOffset = 0;
147 DataExtractor lineData(getLineDWOSection().Data, isLittleEndian(),
148 savedAddressByteSize);
Alexey Samsonov110d5952014-04-30 00:09:19 +0000149 DWARFDebugLine::LineTable LineTable;
150 while (LineTable.Prologue.parse(lineData, &stmtOffset)) {
151 LineTable.dump(OS);
152 LineTable.clear();
153 }
David Blaikie1d4736e2014-02-24 23:58:54 +0000154 }
155
Eli Bendersky7a94daa2013-01-25 20:26:43 +0000156 if (DumpType == DIDT_All || DumpType == DIDT_Str) {
157 OS << "\n.debug_str contents:\n";
158 DataExtractor strData(getStringSection(), isLittleEndian(), 0);
159 offset = 0;
160 uint32_t strOffset = 0;
161 while (const char *s = strData.getCStr(&offset)) {
162 OS << format("0x%8.8x: \"%s\"\n", strOffset, s);
163 strOffset = offset;
164 }
Benjamin Kramer07d4b1c2011-09-15 16:57:13 +0000165 }
Alexey Samsonov034e57a2012-08-27 07:17:47 +0000166
David Blaikie66865d62014-01-09 00:13:35 +0000167 if ((DumpType == DIDT_All || DumpType == DIDT_StrDwo) &&
168 !getStringDWOSection().empty()) {
169 OS << "\n.debug_str.dwo contents:\n";
170 DataExtractor strDWOData(getStringDWOSection(), isLittleEndian(), 0);
171 offset = 0;
172 uint32_t strDWOOffset = 0;
173 while (const char *s = strDWOData.getCStr(&offset)) {
174 OS << format("0x%8.8x: \"%s\"\n", strDWOOffset, s);
175 strDWOOffset = offset;
David Blaikie622dce42014-01-08 23:29:59 +0000176 }
David Blaikie66865d62014-01-09 00:13:35 +0000177 }
David Blaikie622dce42014-01-08 23:29:59 +0000178
Eli Bendersky7a94daa2013-01-25 20:26:43 +0000179 if (DumpType == DIDT_All || DumpType == DIDT_Ranges) {
180 OS << "\n.debug_ranges contents:\n";
181 // In fact, different compile units may have different address byte
182 // sizes, but for simplicity we just use the address byte size of the last
183 // compile unit (there is no easy and fast way to associate address range
184 // list and the compile unit it describes).
185 DataExtractor rangesData(getRangeSection(), isLittleEndian(),
186 savedAddressByteSize);
187 offset = 0;
188 DWARFDebugRangeList rangeList;
189 while (rangeList.extract(rangesData, &offset))
190 rangeList.dump(OS);
Eric Christopherda4b2192013-01-02 23:52:13 +0000191 }
Eric Christopher962c9082013-01-15 23:56:56 +0000192
Eric Christopher0de53592013-09-25 23:02:36 +0000193 if (DumpType == DIDT_All || DumpType == DIDT_Pubnames)
194 dumpPubSection(OS, "debug_pubnames", getPubNamesSection(),
195 isLittleEndian(), false);
Krzysztof Parzyszek97438dc2013-02-12 16:20:28 +0000196
Eric Christopher4c7e6ba2013-09-25 23:02:41 +0000197 if (DumpType == DIDT_All || DumpType == DIDT_Pubtypes)
198 dumpPubSection(OS, "debug_pubtypes", getPubTypesSection(),
199 isLittleEndian(), false);
200
David Blaikieecd21ff2013-09-24 19:50:00 +0000201 if (DumpType == DIDT_All || DumpType == DIDT_GnuPubnames)
202 dumpPubSection(OS, "debug_gnu_pubnames", getGnuPubNamesSection(),
Eric Christopher0de53592013-09-25 23:02:36 +0000203 isLittleEndian(), true /* GnuStyle */);
David Blaikieecd21ff2013-09-24 19:50:00 +0000204
205 if (DumpType == DIDT_All || DumpType == DIDT_GnuPubtypes)
206 dumpPubSection(OS, "debug_gnu_pubtypes", getGnuPubTypesSection(),
Eric Christopher0de53592013-09-25 23:02:36 +0000207 isLittleEndian(), true /* GnuStyle */);
David Blaikie404d3042013-09-19 23:01:29 +0000208
David Blaikie66865d62014-01-09 00:13:35 +0000209 if ((DumpType == DIDT_All || DumpType == DIDT_StrOffsetsDwo) &&
210 !getStringOffsetDWOSection().empty()) {
211 OS << "\n.debug_str_offsets.dwo contents:\n";
212 DataExtractor strOffsetExt(getStringOffsetDWOSection(), isLittleEndian(),
213 0);
214 offset = 0;
215 uint64_t size = getStringOffsetDWOSection().size();
216 while (offset < size) {
217 OS << format("0x%8.8x: ", offset);
218 OS << format("%8.8x\n", strOffsetExt.getU32(&offset));
Eric Christopher92f3c0b2013-05-06 17:50:42 +0000219 }
David Blaikie66865d62014-01-09 00:13:35 +0000220 }
Benjamin Krameraa2f78f2011-09-13 19:42:23 +0000221}
222
223const DWARFDebugAbbrev *DWARFContext::getDebugAbbrev() {
224 if (Abbrev)
225 return Abbrev.get();
226
227 DataExtractor abbrData(getAbbrevSection(), isLittleEndian(), 0);
228
229 Abbrev.reset(new DWARFDebugAbbrev());
Alexey Samsonov4316df52014-04-25 21:10:56 +0000230 Abbrev->extract(abbrData);
Benjamin Krameraa2f78f2011-09-13 19:42:23 +0000231 return Abbrev.get();
232}
233
Eric Christopherda4b2192013-01-02 23:52:13 +0000234const DWARFDebugAbbrev *DWARFContext::getDebugAbbrevDWO() {
235 if (AbbrevDWO)
236 return AbbrevDWO.get();
237
238 DataExtractor abbrData(getAbbrevDWOSection(), isLittleEndian(), 0);
239 AbbrevDWO.reset(new DWARFDebugAbbrev());
Alexey Samsonov4316df52014-04-25 21:10:56 +0000240 AbbrevDWO->extract(abbrData);
Eric Christopherda4b2192013-01-02 23:52:13 +0000241 return AbbrevDWO.get();
242}
243
David Blaikie18e73502013-06-19 21:37:13 +0000244const DWARFDebugLoc *DWARFContext::getDebugLoc() {
245 if (Loc)
246 return Loc.get();
247
David Blaikie1b5ee5d2013-09-23 17:42:01 +0000248 DataExtractor LocData(getLocSection().Data, isLittleEndian(), 0);
249 Loc.reset(new DWARFDebugLoc(getLocSection().Relocs));
David Blaikie18e73502013-06-19 21:37:13 +0000250 // assume all compile units have the same address byte size
251 if (getNumCompileUnits())
252 Loc->parse(LocData, getCompileUnitAtIndex(0)->getAddressByteSize());
253 return Loc.get();
254}
255
David Blaikie9c550ac2014-03-25 01:44:02 +0000256const DWARFDebugLocDWO *DWARFContext::getDebugLocDWO() {
257 if (LocDWO)
258 return LocDWO.get();
259
260 DataExtractor LocData(getLocDWOSection().Data, isLittleEndian(), 0);
261 LocDWO.reset(new DWARFDebugLocDWO());
262 LocDWO->parse(LocData);
263 return LocDWO.get();
264}
265
Benjamin Kramera6002fd2011-09-14 01:09:52 +0000266const DWARFDebugAranges *DWARFContext::getDebugAranges() {
267 if (Aranges)
268 return Aranges.get();
269
Benjamin Kramera6002fd2011-09-14 01:09:52 +0000270 Aranges.reset(new DWARFDebugAranges());
Alexey Samsonova1694c12012-11-16 08:36:25 +0000271 Aranges->generate(this);
Benjamin Kramera6002fd2011-09-14 01:09:52 +0000272 return Aranges.get();
273}
274
Eli Benderskyfd08bc12013-02-05 23:30:58 +0000275const DWARFDebugFrame *DWARFContext::getDebugFrame() {
276 if (DebugFrame)
277 return DebugFrame.get();
278
279 // There's a "bug" in the DWARFv3 standard with respect to the target address
280 // size within debug frame sections. While DWARF is supposed to be independent
281 // of its container, FDEs have fields with size being "target address size",
282 // which isn't specified in DWARF in general. It's only specified for CUs, but
283 // .eh_frame can appear without a .debug_info section. Follow the example of
284 // other tools (libdwarf) and extract this from the container (ObjectFile
285 // provides this information). This problem is fixed in DWARFv4
286 // See this dwarf-discuss discussion for more details:
287 // http://lists.dwarfstd.org/htdig.cgi/dwarf-discuss-dwarfstd.org/2011-December/001173.html
288 DataExtractor debugFrameData(getDebugFrameSection(), isLittleEndian(),
289 getAddressSize());
290 DebugFrame.reset(new DWARFDebugFrame());
291 DebugFrame->parse(debugFrameData);
292 return DebugFrame.get();
293}
294
Eric Christopher494109b2012-10-16 23:46:25 +0000295const DWARFLineTable *
Frederic Rissec8a5ba2014-09-04 06:14:40 +0000296DWARFContext::getLineTableForUnit(DWARFUnit *cu) {
Benjamin Kramer679e1752011-09-15 20:43:18 +0000297 if (!Line)
David Blaikie1b5ee5d2013-09-23 17:42:01 +0000298 Line.reset(new DWARFDebugLine(&getLineSection().Relocs));
Benjamin Kramer5acab502011-09-15 02:12:05 +0000299
Benjamin Kramer679e1752011-09-15 20:43:18 +0000300 unsigned stmtOffset =
Alexey Samsonov48cbda52013-10-28 23:01:48 +0000301 cu->getCompileUnitDIE()->getAttributeValueAsSectionOffset(
302 cu, DW_AT_stmt_list, -1U);
Benjamin Kramer679e1752011-09-15 20:43:18 +0000303 if (stmtOffset == -1U)
Craig Topper2617dcc2014-04-15 06:32:26 +0000304 return nullptr; // No line table for this compile unit.
Benjamin Kramer5acab502011-09-15 02:12:05 +0000305
Benjamin Kramer679e1752011-09-15 20:43:18 +0000306 // See if the line table is cached.
Eric Christopher494109b2012-10-16 23:46:25 +0000307 if (const DWARFLineTable *lt = Line->getLineTable(stmtOffset))
Benjamin Kramer679e1752011-09-15 20:43:18 +0000308 return lt;
309
310 // We have to parse it first.
David Blaikie1b5ee5d2013-09-23 17:42:01 +0000311 DataExtractor lineData(getLineSection().Data, isLittleEndian(),
Benjamin Kramer679e1752011-09-15 20:43:18 +0000312 cu->getAddressByteSize());
313 return Line->getOrParseLineTable(lineData, stmtOffset);
Benjamin Kramer5acab502011-09-15 02:12:05 +0000314}
315
Benjamin Krameraa2f78f2011-09-13 19:42:23 +0000316void DWARFContext::parseCompileUnits() {
Alexey Samsonov8cd4c9d2014-10-08 00:07:53 +0000317 CUs.parse(*this, getInfoSection());
Benjamin Krameraa2f78f2011-09-13 19:42:23 +0000318}
Benjamin Kramer2602ca62011-09-15 20:43:22 +0000319
David Blaikie03c089c2013-09-23 22:44:47 +0000320void DWARFContext::parseTypeUnits() {
Alexey Samsonov1eabf982014-03-13 07:52:54 +0000321 if (!TUs.empty())
322 return;
323 for (const auto &I : getTypesSections()) {
Frederic Riss312a02e2014-09-29 13:56:39 +0000324 TUs.push_back(DWARFUnitSection<DWARFTypeUnit>());
Alexey Samsonov8cd4c9d2014-10-08 00:07:53 +0000325 TUs.back().parse(*this, I.second);
David Blaikie03c089c2013-09-23 22:44:47 +0000326 }
327}
328
Eric Christopherda4b2192013-01-02 23:52:13 +0000329void DWARFContext::parseDWOCompileUnits() {
Alexey Samsonov8cd4c9d2014-10-08 00:07:53 +0000330 DWOCUs.parseDWO(*this, getInfoDWOSection());
Eric Christopherda4b2192013-01-02 23:52:13 +0000331}
332
David Blaikie92d9d622014-01-09 05:08:24 +0000333void DWARFContext::parseDWOTypeUnits() {
Alexey Samsonov1eabf982014-03-13 07:52:54 +0000334 if (!DWOTUs.empty())
335 return;
336 for (const auto &I : getTypesDWOSections()) {
Frederic Riss312a02e2014-09-29 13:56:39 +0000337 DWOTUs.push_back(DWARFUnitSection<DWARFTypeUnit>());
Alexey Samsonov8cd4c9d2014-10-08 00:07:53 +0000338 DWOTUs.back().parseDWO(*this, I.second);
David Blaikie92d9d622014-01-09 05:08:24 +0000339 }
340}
341
Alexey Samsonov45be7932012-08-30 07:49:50 +0000342DWARFCompileUnit *DWARFContext::getCompileUnitForOffset(uint32_t Offset) {
Alexey Samsonov1eabf982014-03-13 07:52:54 +0000343 parseCompileUnits();
Frederic Riss4e126a02014-09-15 07:50:27 +0000344 return CUs.getUnitForOffset(Offset);
Benjamin Kramer2602ca62011-09-15 20:43:22 +0000345}
346
Alexey Samsonov45be7932012-08-30 07:49:50 +0000347DWARFCompileUnit *DWARFContext::getCompileUnitForAddress(uint64_t Address) {
Benjamin Kramer112ec172011-09-15 21:59:13 +0000348 // First, get the offset of the compile unit.
Alexey Samsonov45be7932012-08-30 07:49:50 +0000349 uint32_t CUOffset = getDebugAranges()->findAddress(Address);
Benjamin Kramer2602ca62011-09-15 20:43:22 +0000350 // Retrieve the compile unit.
Alexey Samsonov45be7932012-08-30 07:49:50 +0000351 return getCompileUnitForOffset(CUOffset);
352}
353
Alexey Samsonovd0109992014-04-18 21:36:39 +0000354static bool getFunctionNameForAddress(DWARFCompileUnit *CU, uint64_t Address,
Alexey Samsonovdce67342014-05-15 21:24:32 +0000355 FunctionNameKind Kind,
Alexey Samsonovd0109992014-04-18 21:36:39 +0000356 std::string &FunctionName) {
Alexey Samsonovdce67342014-05-15 21:24:32 +0000357 if (Kind == FunctionNameKind::None)
358 return false;
Alexey Samsonovd0109992014-04-18 21:36:39 +0000359 // The address may correspond to instruction in some inlined function,
360 // so we have to build the chain of inlined functions and take the
361 // name of the topmost function in it.
362 const DWARFDebugInfoEntryInlinedChain &InlinedChain =
363 CU->getInlinedChainForAddress(Address);
364 if (InlinedChain.DIEs.size() == 0)
365 return false;
366 const DWARFDebugInfoEntryMinimal &TopFunctionDIE = InlinedChain.DIEs[0];
Alexey Samsonovdce67342014-05-15 21:24:32 +0000367 if (const char *Name =
368 TopFunctionDIE.getSubroutineName(InlinedChain.U, Kind)) {
Alexey Samsonovd0109992014-04-18 21:36:39 +0000369 FunctionName = Name;
370 return true;
371 }
372 return false;
373}
374
Alexey Samsonov45be7932012-08-30 07:49:50 +0000375DILineInfo DWARFContext::getLineInfoForAddress(uint64_t Address,
Alexey Samsonovdce67342014-05-15 21:24:32 +0000376 DILineInfoSpecifier Spec) {
Alexey Samsonovd0109992014-04-18 21:36:39 +0000377 DILineInfo Result;
378
Alexey Samsonov45be7932012-08-30 07:49:50 +0000379 DWARFCompileUnit *CU = getCompileUnitForAddress(Address);
380 if (!CU)
Alexey Samsonovd0109992014-04-18 21:36:39 +0000381 return Result;
Alexey Samsonovdce67342014-05-15 21:24:32 +0000382 getFunctionNameForAddress(CU, Address, Spec.FNKind, Result.FunctionName);
383 if (Spec.FLIKind != FileLineInfoKind::None) {
Frederic Riss101b5e22014-09-19 15:11:51 +0000384 if (const DWARFLineTable *LineTable = getLineTableForUnit(CU))
385 LineTable->getFileLineInfoForAddress(Address, CU->getCompilationDir(),
386 Spec.FLIKind, Result);
Alexey Samsonovf4462fa2012-07-02 05:54:45 +0000387 }
Alexey Samsonovd0109992014-04-18 21:36:39 +0000388 return Result;
Benjamin Kramer2602ca62011-09-15 20:43:22 +0000389}
David Blaikiea379b1812011-12-20 02:50:00 +0000390
Alexey Samsonovdce67342014-05-15 21:24:32 +0000391DILineInfoTable
392DWARFContext::getLineInfoForAddressRange(uint64_t Address, uint64_t Size,
393 DILineInfoSpecifier Spec) {
Andrew Kaylor9a8ff812013-01-26 00:28:05 +0000394 DILineInfoTable Lines;
395 DWARFCompileUnit *CU = getCompileUnitForAddress(Address);
396 if (!CU)
397 return Lines;
398
399 std::string FunctionName = "<invalid>";
Alexey Samsonovdce67342014-05-15 21:24:32 +0000400 getFunctionNameForAddress(CU, Address, Spec.FNKind, FunctionName);
Andrew Kaylor9a8ff812013-01-26 00:28:05 +0000401
Andrew Kaylor9a8ff812013-01-26 00:28:05 +0000402 // If the Specifier says we don't need FileLineInfo, just
403 // return the top-most function at the starting address.
Alexey Samsonovdce67342014-05-15 21:24:32 +0000404 if (Spec.FLIKind == FileLineInfoKind::None) {
Alexey Samsonovd0109992014-04-18 21:36:39 +0000405 DILineInfo Result;
406 Result.FunctionName = FunctionName;
407 Lines.push_back(std::make_pair(Address, Result));
Andrew Kaylor9a8ff812013-01-26 00:28:05 +0000408 return Lines;
409 }
410
Frederic Rissec8a5ba2014-09-04 06:14:40 +0000411 const DWARFLineTable *LineTable = getLineTableForUnit(CU);
Andrew Kaylor9a8ff812013-01-26 00:28:05 +0000412
413 // Get the index of row we're looking for in the line table.
414 std::vector<uint32_t> RowVector;
415 if (!LineTable->lookupAddressRange(Address, Size, RowVector))
416 return Lines;
417
Alexey Samsonov1eabf982014-03-13 07:52:54 +0000418 for (uint32_t RowIndex : RowVector) {
Andrew Kaylor9a8ff812013-01-26 00:28:05 +0000419 // Take file number and line/column from the row.
420 const DWARFDebugLine::Row &Row = LineTable->Rows[RowIndex];
Alexey Samsonovd0109992014-04-18 21:36:39 +0000421 DILineInfo Result;
Frederic Riss101b5e22014-09-19 15:11:51 +0000422 LineTable->getFileNameByIndex(Row.File, CU->getCompilationDir(),
423 Spec.FLIKind, Result.FileName);
Alexey Samsonovd0109992014-04-18 21:36:39 +0000424 Result.FunctionName = FunctionName;
425 Result.Line = Row.Line;
426 Result.Column = Row.Column;
427 Lines.push_back(std::make_pair(Row.Address, Result));
Andrew Kaylor9a8ff812013-01-26 00:28:05 +0000428 }
429
430 return Lines;
431}
432
Alexey Samsonovdce67342014-05-15 21:24:32 +0000433DIInliningInfo
434DWARFContext::getInliningInfoForAddress(uint64_t Address,
435 DILineInfoSpecifier Spec) {
Alexey Samsonov5c39fdf2014-04-18 22:22:44 +0000436 DIInliningInfo InliningInfo;
437
Alexey Samsonovc942e6b2012-09-04 08:12:33 +0000438 DWARFCompileUnit *CU = getCompileUnitForAddress(Address);
439 if (!CU)
Alexey Samsonov5c39fdf2014-04-18 22:22:44 +0000440 return InliningInfo;
Alexey Samsonovc942e6b2012-09-04 08:12:33 +0000441
Alexey Samsonov5c39fdf2014-04-18 22:22:44 +0000442 const DWARFLineTable *LineTable = nullptr;
Alexey Samsonov3211e612013-08-06 10:49:15 +0000443 const DWARFDebugInfoEntryInlinedChain &InlinedChain =
Alexey Samsonovc942e6b2012-09-04 08:12:33 +0000444 CU->getInlinedChainForAddress(Address);
Alexey Samsonov5c39fdf2014-04-18 22:22:44 +0000445 if (InlinedChain.DIEs.size() == 0) {
446 // If there is no DIE for address (e.g. it is in unavailable .dwo file),
447 // try to at least get file/line info from symbol table.
Alexey Samsonovdce67342014-05-15 21:24:32 +0000448 if (Spec.FLIKind != FileLineInfoKind::None) {
Alexey Samsonov5c39fdf2014-04-18 22:22:44 +0000449 DILineInfo Frame;
Frederic Rissec8a5ba2014-09-04 06:14:40 +0000450 LineTable = getLineTableForUnit(CU);
Frederic Riss101b5e22014-09-19 15:11:51 +0000451 if (LineTable &&
452 LineTable->getFileLineInfoForAddress(Address, CU->getCompilationDir(),
453 Spec.FLIKind, Frame))
Alexey Samsonov5c39fdf2014-04-18 22:22:44 +0000454 InliningInfo.addFrame(Frame);
Alexey Samsonov5c39fdf2014-04-18 22:22:44 +0000455 }
456 return InliningInfo;
457 }
Alexey Samsonovc942e6b2012-09-04 08:12:33 +0000458
Alexey Samsonovc942e6b2012-09-04 08:12:33 +0000459 uint32_t CallFile = 0, CallLine = 0, CallColumn = 0;
Alexey Samsonov3211e612013-08-06 10:49:15 +0000460 for (uint32_t i = 0, n = InlinedChain.DIEs.size(); i != n; i++) {
461 const DWARFDebugInfoEntryMinimal &FunctionDIE = InlinedChain.DIEs[i];
Alexey Samsonovd0109992014-04-18 21:36:39 +0000462 DILineInfo Frame;
Alexey Samsonovc942e6b2012-09-04 08:12:33 +0000463 // Get function name if necessary.
Alexey Samsonovdce67342014-05-15 21:24:32 +0000464 if (const char *Name =
465 FunctionDIE.getSubroutineName(InlinedChain.U, Spec.FNKind))
466 Frame.FunctionName = Name;
467 if (Spec.FLIKind != FileLineInfoKind::None) {
Alexey Samsonovc942e6b2012-09-04 08:12:33 +0000468 if (i == 0) {
469 // For the topmost frame, initialize the line table of this
470 // compile unit and fetch file/line info from it.
Frederic Rissec8a5ba2014-09-04 06:14:40 +0000471 LineTable = getLineTableForUnit(CU);
Alexey Samsonovc942e6b2012-09-04 08:12:33 +0000472 // For the topmost routine, get file/line info from line table.
Frederic Riss101b5e22014-09-19 15:11:51 +0000473 if (LineTable)
474 LineTable->getFileLineInfoForAddress(Address, CU->getCompilationDir(),
475 Spec.FLIKind, Frame);
Alexey Samsonovc942e6b2012-09-04 08:12:33 +0000476 } else {
477 // Otherwise, use call file, call line and call column from
478 // previous DIE in inlined chain.
Frederic Riss101b5e22014-09-19 15:11:51 +0000479 if (LineTable)
480 LineTable->getFileNameByIndex(CallFile, CU->getCompilationDir(),
481 Spec.FLIKind, Frame.FileName);
Alexey Samsonovd0109992014-04-18 21:36:39 +0000482 Frame.Line = CallLine;
483 Frame.Column = CallColumn;
Alexey Samsonovc942e6b2012-09-04 08:12:33 +0000484 }
485 // Get call file/line/column of a current DIE.
486 if (i + 1 < n) {
David Blaikie07e22442013-09-23 22:44:40 +0000487 FunctionDIE.getCallerFrame(InlinedChain.U, CallFile, CallLine,
Alexey Samsonov3211e612013-08-06 10:49:15 +0000488 CallColumn);
Alexey Samsonovc942e6b2012-09-04 08:12:33 +0000489 }
490 }
Alexey Samsonovc942e6b2012-09-04 08:12:33 +0000491 InliningInfo.addFrame(Frame);
492 }
493 return InliningInfo;
494}
495
Alexey Samsonov068fc8a2013-04-23 10:17:34 +0000496static bool consumeCompressedDebugSectionHeader(StringRef &data,
497 uint64_t &OriginalSize) {
498 // Consume "ZLIB" prefix.
499 if (!data.startswith("ZLIB"))
500 return false;
501 data = data.substr(4);
502 // Consume uncompressed section size (big-endian 8 bytes).
503 DataExtractor extractor(data, false, 8);
504 uint32_t Offset = 0;
505 OriginalSize = extractor.getU64(&Offset);
506 if (Offset == 0)
507 return false;
508 data = data.substr(Offset);
509 return true;
510}
511
Alexey Samsonov4a7eb382014-10-20 20:28:51 +0000512DWARFContextInMemory::DWARFContextInMemory(const object::ObjectFile &Obj)
Rafael Espindolaa04bb5b2014-07-31 20:19:36 +0000513 : IsLittleEndian(Obj.isLittleEndian()),
514 AddressSize(Obj.getBytesInAddress()) {
515 for (const SectionRef &Section : Obj.sections()) {
Eric Christopher7370b552012-11-12 21:40:38 +0000516 StringRef name;
Alexey Samsonov063eb3f2014-03-13 13:52:54 +0000517 Section.getName(name);
David Majnemerdac39852014-09-26 22:32:16 +0000518 // Skip BSS and Virtual sections, they aren't interesting.
Rafael Espindola80291272014-10-08 15:28:58 +0000519 bool IsBSS = Section.isBSS();
David Majnemerdac39852014-09-26 22:32:16 +0000520 if (IsBSS)
521 continue;
Rafael Espindola80291272014-10-08 15:28:58 +0000522 bool IsVirtual = Section.isVirtual();
David Majnemerdac39852014-09-26 22:32:16 +0000523 if (IsVirtual)
524 continue;
Eric Christopher7370b552012-11-12 21:40:38 +0000525 StringRef data;
Alexey Samsonov063eb3f2014-03-13 13:52:54 +0000526 Section.getContents(data);
Eric Christopher7370b552012-11-12 21:40:38 +0000527
Eric Christopher7370b552012-11-12 21:40:38 +0000528 name = name.substr(name.find_first_not_of("._")); // Skip . and _ prefixes.
Alexey Samsonov3d0e3ed2013-04-17 14:27:04 +0000529
Alexey Samsonov068fc8a2013-04-23 10:17:34 +0000530 // Check if debug info section is compressed with zlib.
531 if (name.startswith("zdebug_")) {
532 uint64_t OriginalSize;
533 if (!zlib::isAvailable() ||
534 !consumeCompressedDebugSectionHeader(data, OriginalSize))
535 continue;
David Blaikiea505f242014-04-05 21:26:44 +0000536 UncompressedSections.resize(UncompressedSections.size() + 1);
537 if (zlib::uncompress(data, UncompressedSections.back(), OriginalSize) !=
538 zlib::StatusOK) {
539 UncompressedSections.pop_back();
Alexey Samsonov068fc8a2013-04-23 10:17:34 +0000540 continue;
David Blaikiea505f242014-04-05 21:26:44 +0000541 }
Alexey Samsonov068fc8a2013-04-23 10:17:34 +0000542 // Make data point to uncompressed section contents and save its contents.
543 name = name.substr(1);
David Blaikiea505f242014-04-05 21:26:44 +0000544 data = UncompressedSections.back();
Alexey Samsonov068fc8a2013-04-23 10:17:34 +0000545 }
546
Alexey Samsonov063eb3f2014-03-13 13:52:54 +0000547 StringRef *SectionData =
Eric Christopher4c7e6ba2013-09-25 23:02:41 +0000548 StringSwitch<StringRef *>(name)
549 .Case("debug_info", &InfoSection.Data)
550 .Case("debug_abbrev", &AbbrevSection)
551 .Case("debug_loc", &LocSection.Data)
552 .Case("debug_line", &LineSection.Data)
553 .Case("debug_aranges", &ARangeSection)
554 .Case("debug_frame", &DebugFrameSection)
555 .Case("debug_str", &StringSection)
556 .Case("debug_ranges", &RangeSection)
557 .Case("debug_pubnames", &PubNamesSection)
558 .Case("debug_pubtypes", &PubTypesSection)
559 .Case("debug_gnu_pubnames", &GnuPubNamesSection)
560 .Case("debug_gnu_pubtypes", &GnuPubTypesSection)
561 .Case("debug_info.dwo", &InfoDWOSection.Data)
562 .Case("debug_abbrev.dwo", &AbbrevDWOSection)
David Blaikie9c550ac2014-03-25 01:44:02 +0000563 .Case("debug_loc.dwo", &LocDWOSection.Data)
David Blaikie1d4736e2014-02-24 23:58:54 +0000564 .Case("debug_line.dwo", &LineDWOSection.Data)
Eric Christopher4c7e6ba2013-09-25 23:02:41 +0000565 .Case("debug_str.dwo", &StringDWOSection)
566 .Case("debug_str_offsets.dwo", &StringOffsetDWOSection)
567 .Case("debug_addr", &AddrSection)
568 // Any more debug info sections go here.
Craig Topper2617dcc2014-04-15 06:32:26 +0000569 .Default(nullptr);
Alexey Samsonov063eb3f2014-03-13 13:52:54 +0000570 if (SectionData) {
571 *SectionData = data;
Rafael Espindola4f60a382013-05-30 03:05:14 +0000572 if (name == "debug_ranges") {
573 // FIXME: Use the other dwo range section when we emit it.
574 RangeDWOSection = data;
575 }
David Blaikie03c089c2013-09-23 22:44:47 +0000576 } else if (name == "debug_types") {
David Blaikie427e4352013-09-23 23:39:55 +0000577 // Find debug_types data by section rather than name as there are
578 // multiple, comdat grouped, debug_types sections.
Alexey Samsonov063eb3f2014-03-13 13:52:54 +0000579 TypesSections[Section].Data = data;
David Blaikie92d9d622014-01-09 05:08:24 +0000580 } else if (name == "debug_types.dwo") {
Alexey Samsonov063eb3f2014-03-13 13:52:54 +0000581 TypesDWOSections[Section].Data = data;
Eric Christopherda4b2192013-01-02 23:52:13 +0000582 }
Eric Christopher7370b552012-11-12 21:40:38 +0000583
Alexey Samsonov063eb3f2014-03-13 13:52:54 +0000584 section_iterator RelocatedSection = Section.getRelocatedSection();
Rafael Espindolaa04bb5b2014-07-31 20:19:36 +0000585 if (RelocatedSection == Obj.section_end())
Rafael Espindola4f60a382013-05-30 03:05:14 +0000586 continue;
587
588 StringRef RelSecName;
589 RelocatedSection->getName(RelSecName);
590 RelSecName = RelSecName.substr(
591 RelSecName.find_first_not_of("._")); // Skip . and _ prefixes.
592
Andrew Kaylord55d7012013-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 Espindola4f60a382013-05-30 03:05:14 +0000595 RelocAddrMap *Map = StringSwitch<RelocAddrMap*>(RelSecName)
David Blaikie1b5ee5d2013-09-23 17:42:01 +0000596 .Case("debug_info", &InfoSection.Relocs)
597 .Case("debug_loc", &LocSection.Relocs)
598 .Case("debug_info.dwo", &InfoDWOSection.Relocs)
599 .Case("debug_line", &LineSection.Relocs)
Craig Topper2617dcc2014-04-15 06:32:26 +0000600 .Default(nullptr);
David Blaikie03c089c2013-09-23 22:44:47 +0000601 if (!Map) {
David Blaikie427e4352013-09-23 23:39:55 +0000602 // Find debug_types relocs by section rather than name as there are
603 // multiple, comdat grouped, debug_types sections.
David Blaikie92d9d622014-01-09 05:08:24 +0000604 if (RelSecName == "debug_types")
605 Map = &TypesSections[*RelocatedSection].Relocs;
606 else if (RelSecName == "debug_types.dwo")
607 Map = &TypesDWOSections[*RelocatedSection].Relocs;
608 else
609 continue;
David Blaikie03c089c2013-09-23 22:44:47 +0000610 }
Eric Christopher7370b552012-11-12 21:40:38 +0000611
Alexey Samsonov063eb3f2014-03-13 13:52:54 +0000612 if (Section.relocation_begin() != Section.relocation_end()) {
Rafael Espindola80291272014-10-08 15:28:58 +0000613 uint64_t SectionSize = RelocatedSection->getSize();
Alexey Samsonovaa4d2952014-03-14 14:22:49 +0000614 for (const RelocationRef &Reloc : Section.relocations()) {
Eric Christopher7370b552012-11-12 21:40:38 +0000615 uint64_t Address;
Alexey Samsonovaa4d2952014-03-14 14:22:49 +0000616 Reloc.getOffset(Address);
Eric Christopher7370b552012-11-12 21:40:38 +0000617 uint64_t Type;
Alexey Samsonovaa4d2952014-03-14 14:22:49 +0000618 Reloc.getType(Type);
Andrew Kaylord55d7012013-01-25 22:50:58 +0000619 uint64_t SymAddr = 0;
David Majnemer5fbe3242014-10-08 06:38:50 +0000620 object::symbol_iterator Sym = Reloc.getSymbol();
621 if (Sym != Obj.symbol_end())
Rafael Espindola806f0062013-06-05 01:33:53 +0000622 Sym->getAddress(SymAddr);
Eric Christopher7370b552012-11-12 21:40:38 +0000623
Eric Christopher47e079d2014-10-06 06:55:55 +0000624 object::RelocVisitor V(Obj);
David Majnemer5fbe3242014-10-08 06:38:50 +0000625 object::RelocToApply R(V.visit(Type, Reloc, SymAddr));
Eric Christopher7370b552012-11-12 21:40:38 +0000626 if (V.error()) {
627 SmallString<32> Name;
Rafael Espindoladb4ed0b2014-06-13 02:24:39 +0000628 std::error_code ec(Reloc.getTypeName(Name));
Eric Christopher7370b552012-11-12 21:40:38 +0000629 if (ec) {
630 errs() << "Aaaaaa! Nameless relocation! Aaaaaa!\n";
631 }
632 errs() << "error: failed to compute relocation: "
633 << Name << "\n";
634 continue;
635 }
636
637 if (Address + R.Width > SectionSize) {
638 errs() << "error: " << R.Width << "-byte relocation starting "
639 << Address << " bytes into section " << name << " which is "
640 << SectionSize << " bytes long.\n";
641 continue;
642 }
643 if (R.Width > 8) {
644 errs() << "error: can't handle a relocation of more than 8 bytes at "
645 "a time.\n";
646 continue;
647 }
648 DEBUG(dbgs() << "Writing " << format("%p", R.Value)
649 << " at " << format("%p", Address)
650 << " with width " << format("%d", R.Width)
651 << "\n");
Eric Christopherda4b2192013-01-02 23:52:13 +0000652 Map->insert(std::make_pair(Address, std::make_pair(R.Width, R.Value)));
Eric Christopher7370b552012-11-12 21:40:38 +0000653 }
654 }
655 }
656}
657
David Blaikiea379b1812011-12-20 02:50:00 +0000658void DWARFContextInMemory::anchor() { }