blob: 580e6f1df636c063c4031ecd2d97cbc8a176eaf3 [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"
Chandler Carruth8a8cd2b2014-01-07 11:48:04 +000011#include "llvm/ADT/STLExtras.h"
Alexey Samsonove16e16a2012-07-19 07:03:58 +000012#include "llvm/ADT/SmallString.h"
Alexey Samsonov3d0e3ed2013-04-17 14:27:04 +000013#include "llvm/ADT/StringSwitch.h"
Alexey Samsonov068fc8a2013-04-23 10:17:34 +000014#include "llvm/Support/Compression.h"
Benjamin Kramer6dda0322011-09-15 18:02:20 +000015#include "llvm/Support/Dwarf.h"
Benjamin Kramer07d4b1c2011-09-15 16:57:13 +000016#include "llvm/Support/Format.h"
Alexey Samsonove16e16a2012-07-19 07:03:58 +000017#include "llvm/Support/Path.h"
Benjamin Kramera6002fd2011-09-14 01:09:52 +000018#include "llvm/Support/raw_ostream.h"
Benjamin Kramer2602ca62011-09-15 20:43:22 +000019#include <algorithm>
Benjamin Krameraa2f78f2011-09-13 19:42:23 +000020using namespace llvm;
Benjamin Kramer6dda0322011-09-15 18:02:20 +000021using namespace dwarf;
Rafael Espindola4f60a382013-05-30 03:05:14 +000022using namespace object;
Benjamin Krameraa2f78f2011-09-13 19:42:23 +000023
Eric Christopher494109b2012-10-16 23:46:25 +000024typedef DWARFDebugLine::LineTable DWARFLineTable;
25
Alexey Samsonova9debbf2013-08-23 06:56:01 +000026DWARFContext::~DWARFContext() {
27 DeleteContainerPointers(CUs);
Benjamin Kramer41fe88e2013-09-29 11:24:02 +000028 DeleteContainerPointers(TUs);
Alexey Samsonova9debbf2013-08-23 06:56:01 +000029 DeleteContainerPointers(DWOCUs);
30}
31
David Blaikieecd21ff2013-09-24 19:50:00 +000032static void dumpPubSection(raw_ostream &OS, StringRef Name, StringRef Data,
Eric Christopher0de53592013-09-25 23:02:36 +000033 bool LittleEndian, bool GnuStyle) {
David Blaikieecd21ff2013-09-24 19:50:00 +000034 OS << "\n." << Name << " contents:\n";
35 DataExtractor pubNames(Data, LittleEndian, 0);
36 uint32_t offset = 0;
David Blaikie8a263cb2013-11-26 00:22:37 +000037 while (pubNames.isValidOffset(offset)) {
38 OS << "length = " << format("0x%08x", pubNames.getU32(&offset));
39 OS << " version = " << format("0x%04x", pubNames.getU16(&offset));
40 OS << " unit_offset = " << format("0x%08x", pubNames.getU32(&offset));
41 OS << " unit_size = " << format("0x%08x", pubNames.getU32(&offset)) << '\n';
42 if (GnuStyle)
43 OS << "Offset Linkage Kind Name\n";
44 else
45 OS << "Offset Name\n";
Eric Christopher0de53592013-09-25 23:02:36 +000046
David Blaikie8a263cb2013-11-26 00:22:37 +000047 while (offset < Data.size()) {
48 uint32_t dieRef = pubNames.getU32(&offset);
49 if (dieRef == 0)
50 break;
51 OS << format("0x%8.8x ", dieRef);
52 if (GnuStyle) {
53 PubIndexEntryDescriptor desc(pubNames.getU8(&offset));
54 OS << format("%-8s", dwarf::GDBIndexEntryLinkageString(desc.Linkage))
55 << ' ' << format("%-8s", dwarf::GDBIndexEntryKindString(desc.Kind))
56 << ' ';
57 }
58 OS << '\"' << pubNames.getCStr(&offset) << "\"\n";
Eric Christopher0de53592013-09-25 23:02:36 +000059 }
David Blaikieecd21ff2013-09-24 19:50:00 +000060 }
61}
62
Eli Bendersky7a94daa2013-01-25 20:26:43 +000063void DWARFContext::dump(raw_ostream &OS, DIDumpType DumpType) {
64 if (DumpType == DIDT_All || DumpType == DIDT_Abbrev) {
65 OS << ".debug_abbrev contents:\n";
66 getDebugAbbrev()->dump(OS);
67 }
Benjamin Kramera6002fd2011-09-14 01:09:52 +000068
David Blaikie622dce42014-01-08 23:29:59 +000069 if (DumpType == DIDT_All || DumpType == DIDT_AbbrevDwo) {
70 const DWARFDebugAbbrev *D = getDebugAbbrevDWO();
71 if (D) {
72 OS << "\n.debug_abbrev.dwo contents:\n";
73 getDebugAbbrevDWO()->dump(OS);
74 }
75 }
76
Eli Bendersky7a94daa2013-01-25 20:26:43 +000077 if (DumpType == DIDT_All || DumpType == DIDT_Info) {
78 OS << "\n.debug_info contents:\n";
79 for (unsigned i = 0, e = getNumCompileUnits(); i != e; ++i)
80 getCompileUnitAtIndex(i)->dump(OS);
81 }
Benjamin Kramera6002fd2011-09-14 01:09:52 +000082
David Blaikie622dce42014-01-08 23:29:59 +000083 if (DumpType == DIDT_All || DumpType == DIDT_InfoDwo)
84 if (getNumDWOCompileUnits()) {
85 OS << "\n.debug_info.dwo contents:\n";
86 for (unsigned i = 0, e = getNumDWOCompileUnits(); i != e; ++i)
87 getDWOCompileUnitAtIndex(i)->dump(OS);
88 }
89
David Blaikie03c089c2013-09-23 22:44:47 +000090 if (DumpType == DIDT_All || DumpType == DIDT_Types) {
91 OS << "\n.debug_types contents:\n";
92 for (unsigned i = 0, e = getNumTypeUnits(); i != e; ++i)
93 getTypeUnitAtIndex(i)->dump(OS);
94 }
95
David Blaikie18e73502013-06-19 21:37:13 +000096 if (DumpType == DIDT_All || DumpType == DIDT_Loc) {
David Blaikie03c089c2013-09-23 22:44:47 +000097 OS << "\n.debug_loc contents:\n";
David Blaikie18e73502013-06-19 21:37:13 +000098 getDebugLoc()->dump(OS);
99 }
100
Eli Benderskyfd08bc12013-02-05 23:30:58 +0000101 if (DumpType == DIDT_All || DumpType == DIDT_Frames) {
102 OS << "\n.debug_frame contents:\n";
103 getDebugFrame()->dump(OS);
104 }
105
Benjamin Kramera6002fd2011-09-14 01:09:52 +0000106 uint32_t offset = 0;
Eli Bendersky7a94daa2013-01-25 20:26:43 +0000107 if (DumpType == DIDT_All || DumpType == DIDT_Aranges) {
108 OS << "\n.debug_aranges contents:\n";
109 DataExtractor arangesData(getARangeSection(), isLittleEndian(), 0);
110 DWARFDebugArangeSet set;
111 while (set.extract(arangesData, &offset))
112 set.dump(OS);
113 }
Benjamin Kramer5acab502011-09-15 02:12:05 +0000114
Alexey Samsonov034e57a2012-08-27 07:17:47 +0000115 uint8_t savedAddressByteSize = 0;
Eli Bendersky7a94daa2013-01-25 20:26:43 +0000116 if (DumpType == DIDT_All || DumpType == DIDT_Line) {
117 OS << "\n.debug_line contents:\n";
118 for (unsigned i = 0, e = getNumCompileUnits(); i != e; ++i) {
119 DWARFCompileUnit *cu = getCompileUnitAtIndex(i);
120 savedAddressByteSize = cu->getAddressByteSize();
121 unsigned stmtOffset =
Alexey Samsonov48cbda52013-10-28 23:01:48 +0000122 cu->getCompileUnitDIE()->getAttributeValueAsSectionOffset(
123 cu, DW_AT_stmt_list, -1U);
Eli Bendersky7a94daa2013-01-25 20:26:43 +0000124 if (stmtOffset != -1U) {
David Blaikie1b5ee5d2013-09-23 17:42:01 +0000125 DataExtractor lineData(getLineSection().Data, isLittleEndian(),
Eli Bendersky7a94daa2013-01-25 20:26:43 +0000126 savedAddressByteSize);
127 DWARFDebugLine::DumpingState state(OS);
David Blaikie1b5ee5d2013-09-23 17:42:01 +0000128 DWARFDebugLine::parseStatementTable(lineData, &getLineSection().Relocs, &stmtOffset, state);
Eli Bendersky7a94daa2013-01-25 20:26:43 +0000129 }
Benjamin Kramer6dda0322011-09-15 18:02:20 +0000130 }
131 }
Benjamin Kramer07d4b1c2011-09-15 16:57:13 +0000132
Eli Bendersky7a94daa2013-01-25 20:26:43 +0000133 if (DumpType == DIDT_All || DumpType == DIDT_Str) {
134 OS << "\n.debug_str contents:\n";
135 DataExtractor strData(getStringSection(), isLittleEndian(), 0);
136 offset = 0;
137 uint32_t strOffset = 0;
138 while (const char *s = strData.getCStr(&offset)) {
139 OS << format("0x%8.8x: \"%s\"\n", strOffset, s);
140 strOffset = offset;
141 }
Benjamin Kramer07d4b1c2011-09-15 16:57:13 +0000142 }
Alexey Samsonov034e57a2012-08-27 07:17:47 +0000143
David Blaikie622dce42014-01-08 23:29:59 +0000144 if (DumpType == DIDT_All || DumpType == DIDT_StrDwo)
145 if (!getStringDWOSection().empty()) {
146 OS << "\n.debug_str.dwo contents:\n";
147 DataExtractor strDWOData(getStringDWOSection(), isLittleEndian(), 0);
148 offset = 0;
149 uint32_t strDWOOffset = 0;
150 while (const char *s = strDWOData.getCStr(&offset)) {
151 OS << format("0x%8.8x: \"%s\"\n", strDWOOffset, s);
152 strDWOOffset = offset;
153 }
154 }
155
Eli Bendersky7a94daa2013-01-25 20:26:43 +0000156 if (DumpType == DIDT_All || DumpType == DIDT_Ranges) {
157 OS << "\n.debug_ranges contents:\n";
158 // In fact, different compile units may have different address byte
159 // sizes, but for simplicity we just use the address byte size of the last
160 // compile unit (there is no easy and fast way to associate address range
161 // list and the compile unit it describes).
162 DataExtractor rangesData(getRangeSection(), isLittleEndian(),
163 savedAddressByteSize);
164 offset = 0;
165 DWARFDebugRangeList rangeList;
166 while (rangeList.extract(rangesData, &offset))
167 rangeList.dump(OS);
Eric Christopherda4b2192013-01-02 23:52:13 +0000168 }
Eric Christopher962c9082013-01-15 23:56:56 +0000169
Eric Christopher0de53592013-09-25 23:02:36 +0000170 if (DumpType == DIDT_All || DumpType == DIDT_Pubnames)
171 dumpPubSection(OS, "debug_pubnames", getPubNamesSection(),
172 isLittleEndian(), false);
Krzysztof Parzyszek97438dc2013-02-12 16:20:28 +0000173
Eric Christopher4c7e6ba2013-09-25 23:02:41 +0000174 if (DumpType == DIDT_All || DumpType == DIDT_Pubtypes)
175 dumpPubSection(OS, "debug_pubtypes", getPubTypesSection(),
176 isLittleEndian(), false);
177
David Blaikieecd21ff2013-09-24 19:50:00 +0000178 if (DumpType == DIDT_All || DumpType == DIDT_GnuPubnames)
179 dumpPubSection(OS, "debug_gnu_pubnames", getGnuPubNamesSection(),
Eric Christopher0de53592013-09-25 23:02:36 +0000180 isLittleEndian(), true /* GnuStyle */);
David Blaikieecd21ff2013-09-24 19:50:00 +0000181
182 if (DumpType == DIDT_All || DumpType == DIDT_GnuPubtypes)
183 dumpPubSection(OS, "debug_gnu_pubtypes", getGnuPubTypesSection(),
Eric Christopher0de53592013-09-25 23:02:36 +0000184 isLittleEndian(), true /* GnuStyle */);
David Blaikie404d3042013-09-19 23:01:29 +0000185
Eric Christopher92f3c0b2013-05-06 17:50:42 +0000186 if (DumpType == DIDT_All || DumpType == DIDT_StrOffsetsDwo)
187 if (!getStringOffsetDWOSection().empty()) {
188 OS << "\n.debug_str_offsets.dwo contents:\n";
189 DataExtractor strOffsetExt(getStringOffsetDWOSection(), isLittleEndian(), 0);
190 offset = 0;
Eric Christopher0cdce832013-05-06 21:19:44 +0000191 uint64_t size = getStringOffsetDWOSection().size();
192 while (offset < size) {
Eric Christopher34ea3362013-05-06 21:19:41 +0000193 OS << format("0x%8.8x: ", offset);
194 OS << format("%8.8x\n", strOffsetExt.getU32(&offset));
Eric Christopher92f3c0b2013-05-06 17:50:42 +0000195 }
196 }
Benjamin Krameraa2f78f2011-09-13 19:42:23 +0000197}
198
199const DWARFDebugAbbrev *DWARFContext::getDebugAbbrev() {
200 if (Abbrev)
201 return Abbrev.get();
202
203 DataExtractor abbrData(getAbbrevSection(), isLittleEndian(), 0);
204
205 Abbrev.reset(new DWARFDebugAbbrev());
206 Abbrev->parse(abbrData);
207 return Abbrev.get();
208}
209
Eric Christopherda4b2192013-01-02 23:52:13 +0000210const DWARFDebugAbbrev *DWARFContext::getDebugAbbrevDWO() {
211 if (AbbrevDWO)
212 return AbbrevDWO.get();
213
214 DataExtractor abbrData(getAbbrevDWOSection(), isLittleEndian(), 0);
215 AbbrevDWO.reset(new DWARFDebugAbbrev());
216 AbbrevDWO->parse(abbrData);
217 return AbbrevDWO.get();
218}
219
David Blaikie18e73502013-06-19 21:37:13 +0000220const DWARFDebugLoc *DWARFContext::getDebugLoc() {
221 if (Loc)
222 return Loc.get();
223
David Blaikie1b5ee5d2013-09-23 17:42:01 +0000224 DataExtractor LocData(getLocSection().Data, isLittleEndian(), 0);
225 Loc.reset(new DWARFDebugLoc(getLocSection().Relocs));
David Blaikie18e73502013-06-19 21:37:13 +0000226 // assume all compile units have the same address byte size
227 if (getNumCompileUnits())
228 Loc->parse(LocData, getCompileUnitAtIndex(0)->getAddressByteSize());
229 return Loc.get();
230}
231
Benjamin Kramera6002fd2011-09-14 01:09:52 +0000232const DWARFDebugAranges *DWARFContext::getDebugAranges() {
233 if (Aranges)
234 return Aranges.get();
235
Benjamin Kramera6002fd2011-09-14 01:09:52 +0000236 Aranges.reset(new DWARFDebugAranges());
Alexey Samsonova1694c12012-11-16 08:36:25 +0000237 Aranges->generate(this);
Benjamin Kramera6002fd2011-09-14 01:09:52 +0000238 return Aranges.get();
239}
240
Eli Benderskyfd08bc12013-02-05 23:30:58 +0000241const DWARFDebugFrame *DWARFContext::getDebugFrame() {
242 if (DebugFrame)
243 return DebugFrame.get();
244
245 // There's a "bug" in the DWARFv3 standard with respect to the target address
246 // size within debug frame sections. While DWARF is supposed to be independent
247 // of its container, FDEs have fields with size being "target address size",
248 // which isn't specified in DWARF in general. It's only specified for CUs, but
249 // .eh_frame can appear without a .debug_info section. Follow the example of
250 // other tools (libdwarf) and extract this from the container (ObjectFile
251 // provides this information). This problem is fixed in DWARFv4
252 // See this dwarf-discuss discussion for more details:
253 // http://lists.dwarfstd.org/htdig.cgi/dwarf-discuss-dwarfstd.org/2011-December/001173.html
254 DataExtractor debugFrameData(getDebugFrameSection(), isLittleEndian(),
255 getAddressSize());
256 DebugFrame.reset(new DWARFDebugFrame());
257 DebugFrame->parse(debugFrameData);
258 return DebugFrame.get();
259}
260
Eric Christopher494109b2012-10-16 23:46:25 +0000261const DWARFLineTable *
Benjamin Kramer679e1752011-09-15 20:43:18 +0000262DWARFContext::getLineTableForCompileUnit(DWARFCompileUnit *cu) {
263 if (!Line)
David Blaikie1b5ee5d2013-09-23 17:42:01 +0000264 Line.reset(new DWARFDebugLine(&getLineSection().Relocs));
Benjamin Kramer5acab502011-09-15 02:12:05 +0000265
Benjamin Kramer679e1752011-09-15 20:43:18 +0000266 unsigned stmtOffset =
Alexey Samsonov48cbda52013-10-28 23:01:48 +0000267 cu->getCompileUnitDIE()->getAttributeValueAsSectionOffset(
268 cu, DW_AT_stmt_list, -1U);
Benjamin Kramer679e1752011-09-15 20:43:18 +0000269 if (stmtOffset == -1U)
270 return 0; // No line table for this compile unit.
Benjamin Kramer5acab502011-09-15 02:12:05 +0000271
Benjamin Kramer679e1752011-09-15 20:43:18 +0000272 // See if the line table is cached.
Eric Christopher494109b2012-10-16 23:46:25 +0000273 if (const DWARFLineTable *lt = Line->getLineTable(stmtOffset))
Benjamin Kramer679e1752011-09-15 20:43:18 +0000274 return lt;
275
276 // We have to parse it first.
David Blaikie1b5ee5d2013-09-23 17:42:01 +0000277 DataExtractor lineData(getLineSection().Data, isLittleEndian(),
Benjamin Kramer679e1752011-09-15 20:43:18 +0000278 cu->getAddressByteSize());
279 return Line->getOrParseLineTable(lineData, stmtOffset);
Benjamin Kramer5acab502011-09-15 02:12:05 +0000280}
281
Benjamin Krameraa2f78f2011-09-13 19:42:23 +0000282void DWARFContext::parseCompileUnits() {
283 uint32_t offset = 0;
David Blaikie1b5ee5d2013-09-23 17:42:01 +0000284 const DataExtractor &DIData = DataExtractor(getInfoSection().Data,
Eric Christopher02509482012-10-16 23:46:23 +0000285 isLittleEndian(), 0);
286 while (DIData.isValidOffset(offset)) {
Alexey Samsonova9debbf2013-08-23 06:56:01 +0000287 OwningPtr<DWARFCompileUnit> CU(new DWARFCompileUnit(
David Blaikie1b5ee5d2013-09-23 17:42:01 +0000288 getDebugAbbrev(), getInfoSection().Data, getAbbrevSection(),
Alexey Samsonova9debbf2013-08-23 06:56:01 +0000289 getRangeSection(), getStringSection(), StringRef(), getAddrSection(),
David Blaikie1b5ee5d2013-09-23 17:42:01 +0000290 &getInfoSection().Relocs, isLittleEndian()));
Alexey Samsonova9debbf2013-08-23 06:56:01 +0000291 if (!CU->extract(DIData, &offset)) {
Benjamin Krameraa2f78f2011-09-13 19:42:23 +0000292 break;
293 }
Alexey Samsonova9debbf2013-08-23 06:56:01 +0000294 CUs.push_back(CU.take());
David Blaikie07e22442013-09-23 22:44:40 +0000295 offset = CUs.back()->getNextUnitOffset();
Benjamin Krameraa2f78f2011-09-13 19:42:23 +0000296 }
297}
Benjamin Kramer2602ca62011-09-15 20:43:22 +0000298
David Blaikie03c089c2013-09-23 22:44:47 +0000299void DWARFContext::parseTypeUnits() {
David Blaikiebc563272013-12-13 21:33:40 +0000300 const TypeSectionMap &Sections = getTypesSections();
301 for (TypeSectionMap::const_iterator I = Sections.begin(), E = Sections.end();
David Blaikie03c089c2013-09-23 22:44:47 +0000302 I != E; ++I) {
303 uint32_t offset = 0;
304 const DataExtractor &DIData =
305 DataExtractor(I->second.Data, isLittleEndian(), 0);
306 while (DIData.isValidOffset(offset)) {
307 OwningPtr<DWARFTypeUnit> TU(new DWARFTypeUnit(
308 getDebugAbbrev(), I->second.Data, getAbbrevSection(),
309 getRangeSection(), getStringSection(), StringRef(), getAddrSection(),
310 &I->second.Relocs, isLittleEndian()));
311 if (!TU->extract(DIData, &offset))
312 break;
313 TUs.push_back(TU.take());
314 offset = TUs.back()->getNextUnitOffset();
315 }
316 }
317}
318
Eric Christopherda4b2192013-01-02 23:52:13 +0000319void DWARFContext::parseDWOCompileUnits() {
320 uint32_t offset = 0;
David Blaikie1b5ee5d2013-09-23 17:42:01 +0000321 const DataExtractor &DIData =
322 DataExtractor(getInfoDWOSection().Data, isLittleEndian(), 0);
Eric Christopherda4b2192013-01-02 23:52:13 +0000323 while (DIData.isValidOffset(offset)) {
Alexey Samsonova9debbf2013-08-23 06:56:01 +0000324 OwningPtr<DWARFCompileUnit> DWOCU(new DWARFCompileUnit(
David Blaikie1b5ee5d2013-09-23 17:42:01 +0000325 getDebugAbbrevDWO(), getInfoDWOSection().Data, getAbbrevDWOSection(),
Alexey Samsonova9debbf2013-08-23 06:56:01 +0000326 getRangeDWOSection(), getStringDWOSection(),
David Blaikie1b5ee5d2013-09-23 17:42:01 +0000327 getStringOffsetDWOSection(), getAddrSection(),
328 &getInfoDWOSection().Relocs, isLittleEndian()));
Alexey Samsonova9debbf2013-08-23 06:56:01 +0000329 if (!DWOCU->extract(DIData, &offset)) {
Eric Christopherda4b2192013-01-02 23:52:13 +0000330 break;
331 }
Alexey Samsonova9debbf2013-08-23 06:56:01 +0000332 DWOCUs.push_back(DWOCU.take());
David Blaikie07e22442013-09-23 22:44:40 +0000333 offset = DWOCUs.back()->getNextUnitOffset();
Eric Christopherda4b2192013-01-02 23:52:13 +0000334 }
335}
336
Benjamin Kramer2602ca62011-09-15 20:43:22 +0000337namespace {
338 struct OffsetComparator {
Alexey Samsonova9debbf2013-08-23 06:56:01 +0000339 bool operator()(const DWARFCompileUnit *LHS,
340 const DWARFCompileUnit *RHS) const {
341 return LHS->getOffset() < RHS->getOffset();
Benjamin Kramer2602ca62011-09-15 20:43:22 +0000342 }
Alexey Samsonova9debbf2013-08-23 06:56:01 +0000343 bool operator()(const DWARFCompileUnit *LHS, uint32_t RHS) const {
344 return LHS->getOffset() < RHS;
Benjamin Kramer2602ca62011-09-15 20:43:22 +0000345 }
Alexey Samsonova9debbf2013-08-23 06:56:01 +0000346 bool operator()(uint32_t LHS, const DWARFCompileUnit *RHS) const {
347 return LHS < RHS->getOffset();
Benjamin Kramer2602ca62011-09-15 20:43:22 +0000348 }
349 };
350}
351
Alexey Samsonov45be7932012-08-30 07:49:50 +0000352DWARFCompileUnit *DWARFContext::getCompileUnitForOffset(uint32_t Offset) {
Benjamin Kramer2602ca62011-09-15 20:43:22 +0000353 if (CUs.empty())
354 parseCompileUnits();
355
Alexey Samsonova9debbf2013-08-23 06:56:01 +0000356 DWARFCompileUnit **CU =
357 std::lower_bound(CUs.begin(), CUs.end(), Offset, OffsetComparator());
358 if (CU != CUs.end()) {
359 return *CU;
360 }
Benjamin Kramer2602ca62011-09-15 20:43:22 +0000361 return 0;
362}
363
Alexey Samsonov45be7932012-08-30 07:49:50 +0000364DWARFCompileUnit *DWARFContext::getCompileUnitForAddress(uint64_t Address) {
Benjamin Kramer112ec172011-09-15 21:59:13 +0000365 // First, get the offset of the compile unit.
Alexey Samsonov45be7932012-08-30 07:49:50 +0000366 uint32_t CUOffset = getDebugAranges()->findAddress(Address);
Benjamin Kramer2602ca62011-09-15 20:43:22 +0000367 // Retrieve the compile unit.
Alexey Samsonov45be7932012-08-30 07:49:50 +0000368 return getCompileUnitForOffset(CUOffset);
369}
370
Eric Christopher494109b2012-10-16 23:46:25 +0000371static bool getFileNameForCompileUnit(DWARFCompileUnit *CU,
372 const DWARFLineTable *LineTable,
373 uint64_t FileIndex,
374 bool NeedsAbsoluteFilePath,
375 std::string &FileName) {
Alexey Samsonov45be7932012-08-30 07:49:50 +0000376 if (CU == 0 ||
377 LineTable == 0 ||
378 !LineTable->getFileNameByIndex(FileIndex, NeedsAbsoluteFilePath,
379 FileName))
380 return false;
381 if (NeedsAbsoluteFilePath && sys::path::is_relative(FileName)) {
382 // We may still need to append compilation directory of compile unit.
383 SmallString<16> AbsolutePath;
384 if (const char *CompilationDir = CU->getCompilationDir()) {
385 sys::path::append(AbsolutePath, CompilationDir);
386 }
387 sys::path::append(AbsolutePath, FileName);
388 FileName = AbsolutePath.str();
389 }
390 return true;
391}
392
Eric Christopher494109b2012-10-16 23:46:25 +0000393static bool getFileLineInfoForCompileUnit(DWARFCompileUnit *CU,
394 const DWARFLineTable *LineTable,
395 uint64_t Address,
396 bool NeedsAbsoluteFilePath,
397 std::string &FileName,
398 uint32_t &Line, uint32_t &Column) {
Alexey Samsonovc942e6b2012-09-04 08:12:33 +0000399 if (CU == 0 || LineTable == 0)
Alexey Samsonov45be7932012-08-30 07:49:50 +0000400 return false;
401 // Get the index of row we're looking for in the line table.
402 uint32_t RowIndex = LineTable->lookupAddress(Address);
403 if (RowIndex == -1U)
404 return false;
405 // Take file number and line/column from the row.
406 const DWARFDebugLine::Row &Row = LineTable->Rows[RowIndex];
407 if (!getFileNameForCompileUnit(CU, LineTable, Row.File,
408 NeedsAbsoluteFilePath, FileName))
409 return false;
410 Line = Row.Line;
411 Column = Row.Column;
412 return true;
413}
414
415DILineInfo DWARFContext::getLineInfoForAddress(uint64_t Address,
416 DILineInfoSpecifier Specifier) {
417 DWARFCompileUnit *CU = getCompileUnitForAddress(Address);
418 if (!CU)
Alexey Samsonovf4462fa2012-07-02 05:54:45 +0000419 return DILineInfo();
Alexey Samsonov45be7932012-08-30 07:49:50 +0000420 std::string FileName = "<invalid>";
421 std::string FunctionName = "<invalid>";
422 uint32_t Line = 0;
423 uint32_t Column = 0;
424 if (Specifier.needs(DILineInfoSpecifier::FunctionName)) {
Alexey Samsonovc942e6b2012-09-04 08:12:33 +0000425 // The address may correspond to instruction in some inlined function,
426 // so we have to build the chain of inlined functions and take the
427 // name of the topmost function in it.
Alexey Samsonov3211e612013-08-06 10:49:15 +0000428 const DWARFDebugInfoEntryInlinedChain &InlinedChain =
Alexey Samsonovc942e6b2012-09-04 08:12:33 +0000429 CU->getInlinedChainForAddress(Address);
Alexey Samsonov3211e612013-08-06 10:49:15 +0000430 if (InlinedChain.DIEs.size() > 0) {
431 const DWARFDebugInfoEntryMinimal &TopFunctionDIE = InlinedChain.DIEs[0];
David Blaikie07e22442013-09-23 22:44:40 +0000432 if (const char *Name = TopFunctionDIE.getSubroutineName(InlinedChain.U))
Alexey Samsonov45be7932012-08-30 07:49:50 +0000433 FunctionName = Name;
Alexey Samsonovb604ff22012-07-17 15:28:35 +0000434 }
Alexey Samsonovf4462fa2012-07-02 05:54:45 +0000435 }
Alexey Samsonov45be7932012-08-30 07:49:50 +0000436 if (Specifier.needs(DILineInfoSpecifier::FileLineInfo)) {
Eric Christopher494109b2012-10-16 23:46:25 +0000437 const DWARFLineTable *LineTable = getLineTableForCompileUnit(CU);
Alexey Samsonov45be7932012-08-30 07:49:50 +0000438 const bool NeedsAbsoluteFilePath =
439 Specifier.needs(DILineInfoSpecifier::AbsoluteFilePath);
Alexey Samsonovc942e6b2012-09-04 08:12:33 +0000440 getFileLineInfoForCompileUnit(CU, LineTable, Address,
441 NeedsAbsoluteFilePath,
Alexey Samsonov45be7932012-08-30 07:49:50 +0000442 FileName, Line, Column);
Alexey Samsonovf4462fa2012-07-02 05:54:45 +0000443 }
Alexey Samsonov45be7932012-08-30 07:49:50 +0000444 return DILineInfo(StringRef(FileName), StringRef(FunctionName),
445 Line, Column);
Benjamin Kramer2602ca62011-09-15 20:43:22 +0000446}
David Blaikiea379b1812011-12-20 02:50:00 +0000447
Andrew Kaylor9a8ff812013-01-26 00:28:05 +0000448DILineInfoTable DWARFContext::getLineInfoForAddressRange(uint64_t Address,
449 uint64_t Size,
450 DILineInfoSpecifier Specifier) {
451 DILineInfoTable Lines;
452 DWARFCompileUnit *CU = getCompileUnitForAddress(Address);
453 if (!CU)
454 return Lines;
455
456 std::string FunctionName = "<invalid>";
457 if (Specifier.needs(DILineInfoSpecifier::FunctionName)) {
458 // The address may correspond to instruction in some inlined function,
459 // so we have to build the chain of inlined functions and take the
460 // name of the topmost function in it.
Alexey Samsonov3211e612013-08-06 10:49:15 +0000461 const DWARFDebugInfoEntryInlinedChain &InlinedChain =
Andrew Kaylor9a8ff812013-01-26 00:28:05 +0000462 CU->getInlinedChainForAddress(Address);
Alexey Samsonov3211e612013-08-06 10:49:15 +0000463 if (InlinedChain.DIEs.size() > 0) {
464 const DWARFDebugInfoEntryMinimal &TopFunctionDIE = InlinedChain.DIEs[0];
David Blaikie07e22442013-09-23 22:44:40 +0000465 if (const char *Name = TopFunctionDIE.getSubroutineName(InlinedChain.U))
Andrew Kaylor9a8ff812013-01-26 00:28:05 +0000466 FunctionName = Name;
467 }
468 }
469
Andrew Kaylor9a8ff812013-01-26 00:28:05 +0000470 // If the Specifier says we don't need FileLineInfo, just
471 // return the top-most function at the starting address.
472 if (!Specifier.needs(DILineInfoSpecifier::FileLineInfo)) {
David Blaikieba860d72013-09-22 17:01:50 +0000473 Lines.push_back(
474 std::make_pair(Address, DILineInfo("<invalid>", FunctionName, 0, 0)));
Andrew Kaylor9a8ff812013-01-26 00:28:05 +0000475 return Lines;
476 }
477
478 const DWARFLineTable *LineTable = getLineTableForCompileUnit(CU);
479 const bool NeedsAbsoluteFilePath =
480 Specifier.needs(DILineInfoSpecifier::AbsoluteFilePath);
481
482 // Get the index of row we're looking for in the line table.
483 std::vector<uint32_t> RowVector;
484 if (!LineTable->lookupAddressRange(Address, Size, RowVector))
485 return Lines;
486
487 uint32_t NumRows = RowVector.size();
488 for (uint32_t i = 0; i < NumRows; ++i) {
489 uint32_t RowIndex = RowVector[i];
490 // Take file number and line/column from the row.
491 const DWARFDebugLine::Row &Row = LineTable->Rows[RowIndex];
492 std::string FileName = "<invalid>";
493 getFileNameForCompileUnit(CU, LineTable, Row.File,
494 NeedsAbsoluteFilePath, FileName);
David Blaikieba860d72013-09-22 17:01:50 +0000495 Lines.push_back(std::make_pair(
496 Row.Address, DILineInfo(FileName, FunctionName, Row.Line, Row.Column)));
Andrew Kaylor9a8ff812013-01-26 00:28:05 +0000497 }
498
499 return Lines;
500}
501
Alexey Samsonovc942e6b2012-09-04 08:12:33 +0000502DIInliningInfo DWARFContext::getInliningInfoForAddress(uint64_t Address,
503 DILineInfoSpecifier Specifier) {
504 DWARFCompileUnit *CU = getCompileUnitForAddress(Address);
505 if (!CU)
506 return DIInliningInfo();
507
Alexey Samsonov3211e612013-08-06 10:49:15 +0000508 const DWARFDebugInfoEntryInlinedChain &InlinedChain =
Alexey Samsonovc942e6b2012-09-04 08:12:33 +0000509 CU->getInlinedChainForAddress(Address);
Alexey Samsonov3211e612013-08-06 10:49:15 +0000510 if (InlinedChain.DIEs.size() == 0)
Alexey Samsonovc942e6b2012-09-04 08:12:33 +0000511 return DIInliningInfo();
512
513 DIInliningInfo InliningInfo;
514 uint32_t CallFile = 0, CallLine = 0, CallColumn = 0;
Eric Christopher494109b2012-10-16 23:46:25 +0000515 const DWARFLineTable *LineTable = 0;
Alexey Samsonov3211e612013-08-06 10:49:15 +0000516 for (uint32_t i = 0, n = InlinedChain.DIEs.size(); i != n; i++) {
517 const DWARFDebugInfoEntryMinimal &FunctionDIE = InlinedChain.DIEs[i];
Alexey Samsonovc942e6b2012-09-04 08:12:33 +0000518 std::string FileName = "<invalid>";
519 std::string FunctionName = "<invalid>";
520 uint32_t Line = 0;
521 uint32_t Column = 0;
522 // Get function name if necessary.
523 if (Specifier.needs(DILineInfoSpecifier::FunctionName)) {
David Blaikie07e22442013-09-23 22:44:40 +0000524 if (const char *Name = FunctionDIE.getSubroutineName(InlinedChain.U))
Alexey Samsonovc942e6b2012-09-04 08:12:33 +0000525 FunctionName = Name;
526 }
527 if (Specifier.needs(DILineInfoSpecifier::FileLineInfo)) {
528 const bool NeedsAbsoluteFilePath =
529 Specifier.needs(DILineInfoSpecifier::AbsoluteFilePath);
530 if (i == 0) {
531 // For the topmost frame, initialize the line table of this
532 // compile unit and fetch file/line info from it.
533 LineTable = getLineTableForCompileUnit(CU);
534 // For the topmost routine, get file/line info from line table.
535 getFileLineInfoForCompileUnit(CU, LineTable, Address,
536 NeedsAbsoluteFilePath,
537 FileName, Line, Column);
538 } else {
539 // Otherwise, use call file, call line and call column from
540 // previous DIE in inlined chain.
541 getFileNameForCompileUnit(CU, LineTable, CallFile,
542 NeedsAbsoluteFilePath, FileName);
543 Line = CallLine;
544 Column = CallColumn;
545 }
546 // Get call file/line/column of a current DIE.
547 if (i + 1 < n) {
David Blaikie07e22442013-09-23 22:44:40 +0000548 FunctionDIE.getCallerFrame(InlinedChain.U, CallFile, CallLine,
Alexey Samsonov3211e612013-08-06 10:49:15 +0000549 CallColumn);
Alexey Samsonovc942e6b2012-09-04 08:12:33 +0000550 }
551 }
552 DILineInfo Frame(StringRef(FileName), StringRef(FunctionName),
553 Line, Column);
554 InliningInfo.addFrame(Frame);
555 }
556 return InliningInfo;
557}
558
Alexey Samsonov068fc8a2013-04-23 10:17:34 +0000559static bool consumeCompressedDebugSectionHeader(StringRef &data,
560 uint64_t &OriginalSize) {
561 // Consume "ZLIB" prefix.
562 if (!data.startswith("ZLIB"))
563 return false;
564 data = data.substr(4);
565 // Consume uncompressed section size (big-endian 8 bytes).
566 DataExtractor extractor(data, false, 8);
567 uint32_t Offset = 0;
568 OriginalSize = extractor.getU64(&Offset);
569 if (Offset == 0)
570 return false;
571 data = data.substr(Offset);
572 return true;
573}
574
Eric Christopher7370b552012-11-12 21:40:38 +0000575DWARFContextInMemory::DWARFContextInMemory(object::ObjectFile *Obj) :
Eli Benderskyfd08bc12013-02-05 23:30:58 +0000576 IsLittleEndian(Obj->isLittleEndian()),
577 AddressSize(Obj->getBytesInAddress()) {
Eric Christopher7370b552012-11-12 21:40:38 +0000578 error_code ec;
579 for (object::section_iterator i = Obj->begin_sections(),
580 e = Obj->end_sections();
581 i != e; i.increment(ec)) {
582 StringRef name;
583 i->getName(name);
584 StringRef data;
585 i->getContents(data);
586
Eric Christopher7370b552012-11-12 21:40:38 +0000587 name = name.substr(name.find_first_not_of("._")); // Skip . and _ prefixes.
Alexey Samsonov3d0e3ed2013-04-17 14:27:04 +0000588
Alexey Samsonov068fc8a2013-04-23 10:17:34 +0000589 // Check if debug info section is compressed with zlib.
590 if (name.startswith("zdebug_")) {
591 uint64_t OriginalSize;
592 if (!zlib::isAvailable() ||
593 !consumeCompressedDebugSectionHeader(data, OriginalSize))
594 continue;
595 OwningPtr<MemoryBuffer> UncompressedSection;
596 if (zlib::uncompress(data, UncompressedSection, OriginalSize) !=
597 zlib::StatusOK)
598 continue;
599 // Make data point to uncompressed section contents and save its contents.
600 name = name.substr(1);
601 data = UncompressedSection->getBuffer();
602 UncompressedSections.push_back(UncompressedSection.take());
603 }
604
Eric Christopher4c7e6ba2013-09-25 23:02:41 +0000605 StringRef *Section =
606 StringSwitch<StringRef *>(name)
607 .Case("debug_info", &InfoSection.Data)
608 .Case("debug_abbrev", &AbbrevSection)
609 .Case("debug_loc", &LocSection.Data)
610 .Case("debug_line", &LineSection.Data)
611 .Case("debug_aranges", &ARangeSection)
612 .Case("debug_frame", &DebugFrameSection)
613 .Case("debug_str", &StringSection)
614 .Case("debug_ranges", &RangeSection)
615 .Case("debug_pubnames", &PubNamesSection)
616 .Case("debug_pubtypes", &PubTypesSection)
617 .Case("debug_gnu_pubnames", &GnuPubNamesSection)
618 .Case("debug_gnu_pubtypes", &GnuPubTypesSection)
619 .Case("debug_info.dwo", &InfoDWOSection.Data)
620 .Case("debug_abbrev.dwo", &AbbrevDWOSection)
621 .Case("debug_str.dwo", &StringDWOSection)
622 .Case("debug_str_offsets.dwo", &StringOffsetDWOSection)
623 .Case("debug_addr", &AddrSection)
624 // Any more debug info sections go here.
625 .Default(0);
Rafael Espindola4f60a382013-05-30 03:05:14 +0000626 if (Section) {
627 *Section = data;
628 if (name == "debug_ranges") {
629 // FIXME: Use the other dwo range section when we emit it.
630 RangeDWOSection = data;
631 }
David Blaikie03c089c2013-09-23 22:44:47 +0000632 } else if (name == "debug_types") {
David Blaikie427e4352013-09-23 23:39:55 +0000633 // Find debug_types data by section rather than name as there are
634 // multiple, comdat grouped, debug_types sections.
David Blaikie03c089c2013-09-23 22:44:47 +0000635 TypesSections[*i].Data = data;
Eric Christopherda4b2192013-01-02 23:52:13 +0000636 }
Eric Christopher7370b552012-11-12 21:40:38 +0000637
Rafael Espindola4f60a382013-05-30 03:05:14 +0000638 section_iterator RelocatedSection = i->getRelocatedSection();
639 if (RelocatedSection == Obj->end_sections())
640 continue;
641
642 StringRef RelSecName;
643 RelocatedSection->getName(RelSecName);
644 RelSecName = RelSecName.substr(
645 RelSecName.find_first_not_of("._")); // Skip . and _ prefixes.
646
Andrew Kaylord55d7012013-01-25 22:50:58 +0000647 // TODO: Add support for relocations in other sections as needed.
648 // Record relocations for the debug_info and debug_line sections.
Rafael Espindola4f60a382013-05-30 03:05:14 +0000649 RelocAddrMap *Map = StringSwitch<RelocAddrMap*>(RelSecName)
David Blaikie1b5ee5d2013-09-23 17:42:01 +0000650 .Case("debug_info", &InfoSection.Relocs)
651 .Case("debug_loc", &LocSection.Relocs)
652 .Case("debug_info.dwo", &InfoDWOSection.Relocs)
653 .Case("debug_line", &LineSection.Relocs)
Alexey Samsonov3d0e3ed2013-04-17 14:27:04 +0000654 .Default(0);
David Blaikie03c089c2013-09-23 22:44:47 +0000655 if (!Map) {
656 if (RelSecName != "debug_types")
657 continue;
David Blaikie427e4352013-09-23 23:39:55 +0000658 // Find debug_types relocs by section rather than name as there are
659 // multiple, comdat grouped, debug_types sections.
David Blaikie03c089c2013-09-23 22:44:47 +0000660 Map = &TypesSections[*RelocatedSection].Relocs;
661 }
Eric Christopher7370b552012-11-12 21:40:38 +0000662
663 if (i->begin_relocations() != i->end_relocations()) {
664 uint64_t SectionSize;
Rafael Espindola4f60a382013-05-30 03:05:14 +0000665 RelocatedSection->getSize(SectionSize);
Eric Christopher7370b552012-11-12 21:40:38 +0000666 for (object::relocation_iterator reloc_i = i->begin_relocations(),
667 reloc_e = i->end_relocations();
668 reloc_i != reloc_e; reloc_i.increment(ec)) {
669 uint64_t Address;
Rafael Espindola1e483872013-04-25 12:28:45 +0000670 reloc_i->getOffset(Address);
Eric Christopher7370b552012-11-12 21:40:38 +0000671 uint64_t Type;
672 reloc_i->getType(Type);
Andrew Kaylord55d7012013-01-25 22:50:58 +0000673 uint64_t SymAddr = 0;
674 // ELF relocations may need the symbol address
675 if (Obj->isELF()) {
Rafael Espindola806f0062013-06-05 01:33:53 +0000676 object::symbol_iterator Sym = reloc_i->getSymbol();
677 Sym->getAddress(SymAddr);
Andrew Kaylord55d7012013-01-25 22:50:58 +0000678 }
Eric Christopher7370b552012-11-12 21:40:38 +0000679
680 object::RelocVisitor V(Obj->getFileFormatName());
681 // The section address is always 0 for debug sections.
Andrew Kaylord55d7012013-01-25 22:50:58 +0000682 object::RelocToApply R(V.visit(Type, *reloc_i, 0, SymAddr));
Eric Christopher7370b552012-11-12 21:40:38 +0000683 if (V.error()) {
684 SmallString<32> Name;
685 error_code ec(reloc_i->getTypeName(Name));
686 if (ec) {
687 errs() << "Aaaaaa! Nameless relocation! Aaaaaa!\n";
688 }
689 errs() << "error: failed to compute relocation: "
690 << Name << "\n";
691 continue;
692 }
693
694 if (Address + R.Width > SectionSize) {
695 errs() << "error: " << R.Width << "-byte relocation starting "
696 << Address << " bytes into section " << name << " which is "
697 << SectionSize << " bytes long.\n";
698 continue;
699 }
700 if (R.Width > 8) {
701 errs() << "error: can't handle a relocation of more than 8 bytes at "
702 "a time.\n";
703 continue;
704 }
705 DEBUG(dbgs() << "Writing " << format("%p", R.Value)
706 << " at " << format("%p", Address)
707 << " with width " << format("%d", R.Width)
708 << "\n");
Eric Christopherda4b2192013-01-02 23:52:13 +0000709 Map->insert(std::make_pair(Address, std::make_pair(R.Width, R.Value)));
Eric Christopher7370b552012-11-12 21:40:38 +0000710 }
711 }
712 }
713}
714
Alexey Samsonov068fc8a2013-04-23 10:17:34 +0000715DWARFContextInMemory::~DWARFContextInMemory() {
716 DeleteContainerPointers(UncompressedSections);
717}
718
David Blaikiea379b1812011-12-20 02:50:00 +0000719void DWARFContextInMemory::anchor() { }