blob: 37ba43f8c139b6f73ae78137d255f660ddfad335 [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
Frederic Rissb88adbd2014-12-19 18:26:33 +000010#include "llvm/DebugInfo/DWARFContext.h"
Alexey Samsonov001ecd92014-04-25 21:30:03 +000011
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"
Frederic Rissb88adbd2014-12-19 18:26:33 +000014#include "llvm/DebugInfo/DWARFDebugArangeSet.h"
15#include "llvm/DebugInfo/DWARFAcceleratorTable.h"
Alexey Samsonov068fc8a2013-04-23 10:17:34 +000016#include "llvm/Support/Compression.h"
Benjamin Kramer6dda0322011-09-15 18:02:20 +000017#include "llvm/Support/Dwarf.h"
Benjamin Kramer07d4b1c2011-09-15 16:57:13 +000018#include "llvm/Support/Format.h"
Alexey Samsonove16e16a2012-07-19 07:03:58 +000019#include "llvm/Support/Path.h"
Benjamin Kramera6002fd2011-09-14 01:09:52 +000020#include "llvm/Support/raw_ostream.h"
Benjamin Kramer2602ca62011-09-15 20:43:22 +000021#include <algorithm>
Benjamin Krameraa2f78f2011-09-13 19:42:23 +000022using namespace llvm;
Benjamin Kramer6dda0322011-09-15 18:02:20 +000023using namespace dwarf;
Rafael Espindola4f60a382013-05-30 03:05:14 +000024using namespace object;
Benjamin Krameraa2f78f2011-09-13 19:42:23 +000025
Chandler Carruthe96dd892014-04-21 22:55:11 +000026#define DEBUG_TYPE "dwarf"
27
Eric Christopher494109b2012-10-16 23:46:25 +000028typedef DWARFDebugLine::LineTable DWARFLineTable;
Alexey Samsonovdce67342014-05-15 21:24:32 +000029typedef DILineInfoSpecifier::FileLineInfoKind FileLineInfoKind;
30typedef DILineInfoSpecifier::FunctionNameKind FunctionNameKind;
Eric Christopher494109b2012-10-16 23:46:25 +000031
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
Frederic Riss7c500472014-11-14 19:30:08 +000063static void dumpAccelSection(raw_ostream &OS, StringRef Name,
64 const DWARFSection& Section, StringRef StringSection,
65 bool LittleEndian) {
66 DataExtractor AccelSection(Section.Data, LittleEndian, 0);
Frederic Risse837ec22014-11-14 16:15:53 +000067 DataExtractor StrData(StringSection, LittleEndian, 0);
68 OS << "\n." << Name << " contents:\n";
Frederic Riss7c500472014-11-14 19:30:08 +000069 DWARFAcceleratorTable Accel(AccelSection, StrData, Section.Relocs);
Frederic Risse837ec22014-11-14 16:15:53 +000070 if (!Accel.extract())
71 return;
72 Accel.dump(OS);
73}
74
Eli Bendersky7a94daa2013-01-25 20:26:43 +000075void DWARFContext::dump(raw_ostream &OS, DIDumpType DumpType) {
76 if (DumpType == DIDT_All || DumpType == DIDT_Abbrev) {
77 OS << ".debug_abbrev contents:\n";
78 getDebugAbbrev()->dump(OS);
79 }
Benjamin Kramera6002fd2011-09-14 01:09:52 +000080
David Blaikie66865d62014-01-09 00:13:35 +000081 if (DumpType == DIDT_All || DumpType == DIDT_AbbrevDwo)
82 if (const DWARFDebugAbbrev *D = getDebugAbbrevDWO()) {
David Blaikie622dce42014-01-08 23:29:59 +000083 OS << "\n.debug_abbrev.dwo contents:\n";
David Blaikie66865d62014-01-09 00:13:35 +000084 D->dump(OS);
David Blaikie622dce42014-01-08 23:29:59 +000085 }
David Blaikie622dce42014-01-08 23:29:59 +000086
Eli Bendersky7a94daa2013-01-25 20:26:43 +000087 if (DumpType == DIDT_All || DumpType == DIDT_Info) {
88 OS << "\n.debug_info contents:\n";
Alexey Samsonov1eabf982014-03-13 07:52:54 +000089 for (const auto &CU : compile_units())
90 CU->dump(OS);
Eli Bendersky7a94daa2013-01-25 20:26:43 +000091 }
Benjamin Kramera6002fd2011-09-14 01:09:52 +000092
David Blaikie66865d62014-01-09 00:13:35 +000093 if ((DumpType == DIDT_All || DumpType == DIDT_InfoDwo) &&
94 getNumDWOCompileUnits()) {
95 OS << "\n.debug_info.dwo contents:\n";
Alexey Samsonov1eabf982014-03-13 07:52:54 +000096 for (const auto &DWOCU : dwo_compile_units())
97 DWOCU->dump(OS);
David Blaikie66865d62014-01-09 00:13:35 +000098 }
David Blaikie622dce42014-01-08 23:29:59 +000099
David Blaikie66865d62014-01-09 00:13:35 +0000100 if ((DumpType == DIDT_All || DumpType == DIDT_Types) && getNumTypeUnits()) {
David Blaikie03c089c2013-09-23 22:44:47 +0000101 OS << "\n.debug_types contents:\n";
Frederic Riss312a02e2014-09-29 13:56:39 +0000102 for (const auto &TUS : type_unit_sections())
103 for (const auto &TU : TUS)
104 TU->dump(OS);
David Blaikie03c089c2013-09-23 22:44:47 +0000105 }
106
Alexey Samsonov1eabf982014-03-13 07:52:54 +0000107 if ((DumpType == DIDT_All || DumpType == DIDT_TypesDwo) &&
108 getNumDWOTypeUnits()) {
109 OS << "\n.debug_types.dwo contents:\n";
Frederic Riss312a02e2014-09-29 13:56:39 +0000110 for (const auto &DWOTUS : dwo_type_unit_sections())
111 for (const auto &DWOTU : DWOTUS)
112 DWOTU->dump(OS);
Alexey Samsonov1eabf982014-03-13 07:52:54 +0000113 }
David Blaikie92d9d622014-01-09 05:08:24 +0000114
David Blaikie18e73502013-06-19 21:37:13 +0000115 if (DumpType == DIDT_All || DumpType == DIDT_Loc) {
David Blaikie03c089c2013-09-23 22:44:47 +0000116 OS << "\n.debug_loc contents:\n";
David Blaikie18e73502013-06-19 21:37:13 +0000117 getDebugLoc()->dump(OS);
118 }
119
David Blaikie9c550ac2014-03-25 01:44:02 +0000120 if (DumpType == DIDT_All || DumpType == DIDT_LocDwo) {
121 OS << "\n.debug_loc.dwo contents:\n";
122 getDebugLocDWO()->dump(OS);
123 }
124
Eli Benderskyfd08bc12013-02-05 23:30:58 +0000125 if (DumpType == DIDT_All || DumpType == DIDT_Frames) {
126 OS << "\n.debug_frame contents:\n";
127 getDebugFrame()->dump(OS);
128 }
129
Benjamin Kramera6002fd2011-09-14 01:09:52 +0000130 uint32_t offset = 0;
Eli Bendersky7a94daa2013-01-25 20:26:43 +0000131 if (DumpType == DIDT_All || DumpType == DIDT_Aranges) {
132 OS << "\n.debug_aranges contents:\n";
133 DataExtractor arangesData(getARangeSection(), isLittleEndian(), 0);
134 DWARFDebugArangeSet set;
135 while (set.extract(arangesData, &offset))
136 set.dump(OS);
137 }
Benjamin Kramer5acab502011-09-15 02:12:05 +0000138
Alexey Samsonov034e57a2012-08-27 07:17:47 +0000139 uint8_t savedAddressByteSize = 0;
Eli Bendersky7a94daa2013-01-25 20:26:43 +0000140 if (DumpType == DIDT_All || DumpType == DIDT_Line) {
141 OS << "\n.debug_line contents:\n";
Alexey Samsonov1eabf982014-03-13 07:52:54 +0000142 for (const auto &CU : compile_units()) {
143 savedAddressByteSize = CU->getAddressByteSize();
Eli Bendersky7a94daa2013-01-25 20:26:43 +0000144 unsigned stmtOffset =
Alexey Samsonov1eabf982014-03-13 07:52:54 +0000145 CU->getCompileUnitDIE()->getAttributeValueAsSectionOffset(
Alexey Samsonov96dc29c2014-03-13 08:19:59 +0000146 CU.get(), DW_AT_stmt_list, -1U);
Eli Bendersky7a94daa2013-01-25 20:26:43 +0000147 if (stmtOffset != -1U) {
David Blaikie1b5ee5d2013-09-23 17:42:01 +0000148 DataExtractor lineData(getLineSection().Data, isLittleEndian(),
Eli Bendersky7a94daa2013-01-25 20:26:43 +0000149 savedAddressByteSize);
Alexey Samsonov110d5952014-04-30 00:09:19 +0000150 DWARFDebugLine::LineTable LineTable;
151 LineTable.parse(lineData, &getLineSection().Relocs, &stmtOffset);
152 LineTable.dump(OS);
Eli Bendersky7a94daa2013-01-25 20:26:43 +0000153 }
Benjamin Kramer6dda0322011-09-15 18:02:20 +0000154 }
155 }
Benjamin Kramer07d4b1c2011-09-15 16:57:13 +0000156
David Blaikie1d4736e2014-02-24 23:58:54 +0000157 if (DumpType == DIDT_All || DumpType == DIDT_LineDwo) {
158 OS << "\n.debug_line.dwo contents:\n";
159 unsigned stmtOffset = 0;
160 DataExtractor lineData(getLineDWOSection().Data, isLittleEndian(),
161 savedAddressByteSize);
Alexey Samsonov110d5952014-04-30 00:09:19 +0000162 DWARFDebugLine::LineTable LineTable;
163 while (LineTable.Prologue.parse(lineData, &stmtOffset)) {
164 LineTable.dump(OS);
165 LineTable.clear();
166 }
David Blaikie1d4736e2014-02-24 23:58:54 +0000167 }
168
Eli Bendersky7a94daa2013-01-25 20:26:43 +0000169 if (DumpType == DIDT_All || DumpType == DIDT_Str) {
170 OS << "\n.debug_str contents:\n";
171 DataExtractor strData(getStringSection(), isLittleEndian(), 0);
172 offset = 0;
173 uint32_t strOffset = 0;
174 while (const char *s = strData.getCStr(&offset)) {
175 OS << format("0x%8.8x: \"%s\"\n", strOffset, s);
176 strOffset = offset;
177 }
Benjamin Kramer07d4b1c2011-09-15 16:57:13 +0000178 }
Alexey Samsonov034e57a2012-08-27 07:17:47 +0000179
David Blaikie66865d62014-01-09 00:13:35 +0000180 if ((DumpType == DIDT_All || DumpType == DIDT_StrDwo) &&
181 !getStringDWOSection().empty()) {
182 OS << "\n.debug_str.dwo contents:\n";
183 DataExtractor strDWOData(getStringDWOSection(), isLittleEndian(), 0);
184 offset = 0;
185 uint32_t strDWOOffset = 0;
186 while (const char *s = strDWOData.getCStr(&offset)) {
187 OS << format("0x%8.8x: \"%s\"\n", strDWOOffset, s);
188 strDWOOffset = offset;
David Blaikie622dce42014-01-08 23:29:59 +0000189 }
David Blaikie66865d62014-01-09 00:13:35 +0000190 }
David Blaikie622dce42014-01-08 23:29:59 +0000191
Eli Bendersky7a94daa2013-01-25 20:26:43 +0000192 if (DumpType == DIDT_All || DumpType == DIDT_Ranges) {
193 OS << "\n.debug_ranges contents:\n";
194 // In fact, different compile units may have different address byte
195 // sizes, but for simplicity we just use the address byte size of the last
196 // compile unit (there is no easy and fast way to associate address range
197 // list and the compile unit it describes).
198 DataExtractor rangesData(getRangeSection(), isLittleEndian(),
199 savedAddressByteSize);
200 offset = 0;
201 DWARFDebugRangeList rangeList;
202 while (rangeList.extract(rangesData, &offset))
203 rangeList.dump(OS);
Eric Christopherda4b2192013-01-02 23:52:13 +0000204 }
Eric Christopher962c9082013-01-15 23:56:56 +0000205
Eric Christopher0de53592013-09-25 23:02:36 +0000206 if (DumpType == DIDT_All || DumpType == DIDT_Pubnames)
207 dumpPubSection(OS, "debug_pubnames", getPubNamesSection(),
208 isLittleEndian(), false);
Krzysztof Parzyszek97438dc2013-02-12 16:20:28 +0000209
Eric Christopher4c7e6ba2013-09-25 23:02:41 +0000210 if (DumpType == DIDT_All || DumpType == DIDT_Pubtypes)
211 dumpPubSection(OS, "debug_pubtypes", getPubTypesSection(),
212 isLittleEndian(), false);
213
David Blaikieecd21ff2013-09-24 19:50:00 +0000214 if (DumpType == DIDT_All || DumpType == DIDT_GnuPubnames)
215 dumpPubSection(OS, "debug_gnu_pubnames", getGnuPubNamesSection(),
Eric Christopher0de53592013-09-25 23:02:36 +0000216 isLittleEndian(), true /* GnuStyle */);
David Blaikieecd21ff2013-09-24 19:50:00 +0000217
218 if (DumpType == DIDT_All || DumpType == DIDT_GnuPubtypes)
219 dumpPubSection(OS, "debug_gnu_pubtypes", getGnuPubTypesSection(),
Eric Christopher0de53592013-09-25 23:02:36 +0000220 isLittleEndian(), true /* GnuStyle */);
David Blaikie404d3042013-09-19 23:01:29 +0000221
David Blaikie66865d62014-01-09 00:13:35 +0000222 if ((DumpType == DIDT_All || DumpType == DIDT_StrOffsetsDwo) &&
223 !getStringOffsetDWOSection().empty()) {
224 OS << "\n.debug_str_offsets.dwo contents:\n";
225 DataExtractor strOffsetExt(getStringOffsetDWOSection(), isLittleEndian(),
226 0);
227 offset = 0;
228 uint64_t size = getStringOffsetDWOSection().size();
229 while (offset < size) {
230 OS << format("0x%8.8x: ", offset);
231 OS << format("%8.8x\n", strOffsetExt.getU32(&offset));
Eric Christopher92f3c0b2013-05-06 17:50:42 +0000232 }
David Blaikie66865d62014-01-09 00:13:35 +0000233 }
Frederic Risse837ec22014-11-14 16:15:53 +0000234
235 if (DumpType == DIDT_All || DumpType == DIDT_AppleNames)
236 dumpAccelSection(OS, "apple_names", getAppleNamesSection(),
237 getStringSection(), isLittleEndian());
238
239 if (DumpType == DIDT_All || DumpType == DIDT_AppleTypes)
240 dumpAccelSection(OS, "apple_types", getAppleTypesSection(),
241 getStringSection(), isLittleEndian());
242
243 if (DumpType == DIDT_All || DumpType == DIDT_AppleNamespaces)
244 dumpAccelSection(OS, "apple_namespaces", getAppleNamespacesSection(),
245 getStringSection(), isLittleEndian());
246
247 if (DumpType == DIDT_All || DumpType == DIDT_AppleObjC)
248 dumpAccelSection(OS, "apple_objc", getAppleObjCSection(),
249 getStringSection(), isLittleEndian());
Benjamin Krameraa2f78f2011-09-13 19:42:23 +0000250}
251
252const DWARFDebugAbbrev *DWARFContext::getDebugAbbrev() {
253 if (Abbrev)
254 return Abbrev.get();
255
256 DataExtractor abbrData(getAbbrevSection(), isLittleEndian(), 0);
257
258 Abbrev.reset(new DWARFDebugAbbrev());
Alexey Samsonov4316df52014-04-25 21:10:56 +0000259 Abbrev->extract(abbrData);
Benjamin Krameraa2f78f2011-09-13 19:42:23 +0000260 return Abbrev.get();
261}
262
Eric Christopherda4b2192013-01-02 23:52:13 +0000263const DWARFDebugAbbrev *DWARFContext::getDebugAbbrevDWO() {
264 if (AbbrevDWO)
265 return AbbrevDWO.get();
266
267 DataExtractor abbrData(getAbbrevDWOSection(), isLittleEndian(), 0);
268 AbbrevDWO.reset(new DWARFDebugAbbrev());
Alexey Samsonov4316df52014-04-25 21:10:56 +0000269 AbbrevDWO->extract(abbrData);
Eric Christopherda4b2192013-01-02 23:52:13 +0000270 return AbbrevDWO.get();
271}
272
David Blaikie18e73502013-06-19 21:37:13 +0000273const DWARFDebugLoc *DWARFContext::getDebugLoc() {
274 if (Loc)
275 return Loc.get();
276
David Blaikie1b5ee5d2013-09-23 17:42:01 +0000277 DataExtractor LocData(getLocSection().Data, isLittleEndian(), 0);
278 Loc.reset(new DWARFDebugLoc(getLocSection().Relocs));
David Blaikie18e73502013-06-19 21:37:13 +0000279 // assume all compile units have the same address byte size
280 if (getNumCompileUnits())
281 Loc->parse(LocData, getCompileUnitAtIndex(0)->getAddressByteSize());
282 return Loc.get();
283}
284
David Blaikie9c550ac2014-03-25 01:44:02 +0000285const DWARFDebugLocDWO *DWARFContext::getDebugLocDWO() {
286 if (LocDWO)
287 return LocDWO.get();
288
289 DataExtractor LocData(getLocDWOSection().Data, isLittleEndian(), 0);
290 LocDWO.reset(new DWARFDebugLocDWO());
291 LocDWO->parse(LocData);
292 return LocDWO.get();
293}
294
Benjamin Kramera6002fd2011-09-14 01:09:52 +0000295const DWARFDebugAranges *DWARFContext::getDebugAranges() {
296 if (Aranges)
297 return Aranges.get();
298
Benjamin Kramera6002fd2011-09-14 01:09:52 +0000299 Aranges.reset(new DWARFDebugAranges());
Alexey Samsonova1694c12012-11-16 08:36:25 +0000300 Aranges->generate(this);
Benjamin Kramera6002fd2011-09-14 01:09:52 +0000301 return Aranges.get();
302}
303
Eli Benderskyfd08bc12013-02-05 23:30:58 +0000304const DWARFDebugFrame *DWARFContext::getDebugFrame() {
305 if (DebugFrame)
306 return DebugFrame.get();
307
308 // There's a "bug" in the DWARFv3 standard with respect to the target address
309 // size within debug frame sections. While DWARF is supposed to be independent
310 // of its container, FDEs have fields with size being "target address size",
311 // which isn't specified in DWARF in general. It's only specified for CUs, but
312 // .eh_frame can appear without a .debug_info section. Follow the example of
313 // other tools (libdwarf) and extract this from the container (ObjectFile
314 // provides this information). This problem is fixed in DWARFv4
315 // See this dwarf-discuss discussion for more details:
316 // http://lists.dwarfstd.org/htdig.cgi/dwarf-discuss-dwarfstd.org/2011-December/001173.html
317 DataExtractor debugFrameData(getDebugFrameSection(), isLittleEndian(),
318 getAddressSize());
319 DebugFrame.reset(new DWARFDebugFrame());
320 DebugFrame->parse(debugFrameData);
321 return DebugFrame.get();
322}
323
Eric Christopher494109b2012-10-16 23:46:25 +0000324const DWARFLineTable *
Frederic Rissec8a5ba2014-09-04 06:14:40 +0000325DWARFContext::getLineTableForUnit(DWARFUnit *cu) {
Benjamin Kramer679e1752011-09-15 20:43:18 +0000326 if (!Line)
David Blaikie1b5ee5d2013-09-23 17:42:01 +0000327 Line.reset(new DWARFDebugLine(&getLineSection().Relocs));
Benjamin Kramer5acab502011-09-15 02:12:05 +0000328
Benjamin Kramer679e1752011-09-15 20:43:18 +0000329 unsigned stmtOffset =
Alexey Samsonov48cbda52013-10-28 23:01:48 +0000330 cu->getCompileUnitDIE()->getAttributeValueAsSectionOffset(
331 cu, DW_AT_stmt_list, -1U);
Benjamin Kramer679e1752011-09-15 20:43:18 +0000332 if (stmtOffset == -1U)
Craig Topper2617dcc2014-04-15 06:32:26 +0000333 return nullptr; // No line table for this compile unit.
Benjamin Kramer5acab502011-09-15 02:12:05 +0000334
Benjamin Kramer679e1752011-09-15 20:43:18 +0000335 // See if the line table is cached.
Eric Christopher494109b2012-10-16 23:46:25 +0000336 if (const DWARFLineTable *lt = Line->getLineTable(stmtOffset))
Benjamin Kramer679e1752011-09-15 20:43:18 +0000337 return lt;
338
339 // We have to parse it first.
David Blaikie1b5ee5d2013-09-23 17:42:01 +0000340 DataExtractor lineData(getLineSection().Data, isLittleEndian(),
Benjamin Kramer679e1752011-09-15 20:43:18 +0000341 cu->getAddressByteSize());
342 return Line->getOrParseLineTable(lineData, stmtOffset);
Benjamin Kramer5acab502011-09-15 02:12:05 +0000343}
344
Benjamin Krameraa2f78f2011-09-13 19:42:23 +0000345void DWARFContext::parseCompileUnits() {
Alexey Samsonov8cd4c9d2014-10-08 00:07:53 +0000346 CUs.parse(*this, getInfoSection());
Benjamin Krameraa2f78f2011-09-13 19:42:23 +0000347}
Benjamin Kramer2602ca62011-09-15 20:43:22 +0000348
David Blaikie03c089c2013-09-23 22:44:47 +0000349void DWARFContext::parseTypeUnits() {
Alexey Samsonov1eabf982014-03-13 07:52:54 +0000350 if (!TUs.empty())
351 return;
352 for (const auto &I : getTypesSections()) {
Frederic Riss312a02e2014-09-29 13:56:39 +0000353 TUs.push_back(DWARFUnitSection<DWARFTypeUnit>());
Alexey Samsonov8cd4c9d2014-10-08 00:07:53 +0000354 TUs.back().parse(*this, I.second);
David Blaikie03c089c2013-09-23 22:44:47 +0000355 }
356}
357
Eric Christopherda4b2192013-01-02 23:52:13 +0000358void DWARFContext::parseDWOCompileUnits() {
Alexey Samsonov8cd4c9d2014-10-08 00:07:53 +0000359 DWOCUs.parseDWO(*this, getInfoDWOSection());
Eric Christopherda4b2192013-01-02 23:52:13 +0000360}
361
David Blaikie92d9d622014-01-09 05:08:24 +0000362void DWARFContext::parseDWOTypeUnits() {
Alexey Samsonov1eabf982014-03-13 07:52:54 +0000363 if (!DWOTUs.empty())
364 return;
365 for (const auto &I : getTypesDWOSections()) {
Frederic Riss312a02e2014-09-29 13:56:39 +0000366 DWOTUs.push_back(DWARFUnitSection<DWARFTypeUnit>());
Alexey Samsonov8cd4c9d2014-10-08 00:07:53 +0000367 DWOTUs.back().parseDWO(*this, I.second);
David Blaikie92d9d622014-01-09 05:08:24 +0000368 }
369}
370
Alexey Samsonov45be7932012-08-30 07:49:50 +0000371DWARFCompileUnit *DWARFContext::getCompileUnitForOffset(uint32_t Offset) {
Alexey Samsonov1eabf982014-03-13 07:52:54 +0000372 parseCompileUnits();
Frederic Riss4e126a02014-09-15 07:50:27 +0000373 return CUs.getUnitForOffset(Offset);
Benjamin Kramer2602ca62011-09-15 20:43:22 +0000374}
375
Alexey Samsonov45be7932012-08-30 07:49:50 +0000376DWARFCompileUnit *DWARFContext::getCompileUnitForAddress(uint64_t Address) {
Benjamin Kramer112ec172011-09-15 21:59:13 +0000377 // First, get the offset of the compile unit.
Alexey Samsonov45be7932012-08-30 07:49:50 +0000378 uint32_t CUOffset = getDebugAranges()->findAddress(Address);
Benjamin Kramer2602ca62011-09-15 20:43:22 +0000379 // Retrieve the compile unit.
Alexey Samsonov45be7932012-08-30 07:49:50 +0000380 return getCompileUnitForOffset(CUOffset);
381}
382
Alexey Samsonovd0109992014-04-18 21:36:39 +0000383static bool getFunctionNameForAddress(DWARFCompileUnit *CU, uint64_t Address,
Alexey Samsonovdce67342014-05-15 21:24:32 +0000384 FunctionNameKind Kind,
Alexey Samsonovd0109992014-04-18 21:36:39 +0000385 std::string &FunctionName) {
Alexey Samsonovdce67342014-05-15 21:24:32 +0000386 if (Kind == FunctionNameKind::None)
387 return false;
Alexey Samsonovd0109992014-04-18 21:36:39 +0000388 // The address may correspond to instruction in some inlined function,
389 // so we have to build the chain of inlined functions and take the
390 // name of the topmost function in it.
391 const DWARFDebugInfoEntryInlinedChain &InlinedChain =
392 CU->getInlinedChainForAddress(Address);
393 if (InlinedChain.DIEs.size() == 0)
394 return false;
395 const DWARFDebugInfoEntryMinimal &TopFunctionDIE = InlinedChain.DIEs[0];
Alexey Samsonovdce67342014-05-15 21:24:32 +0000396 if (const char *Name =
397 TopFunctionDIE.getSubroutineName(InlinedChain.U, Kind)) {
Alexey Samsonovd0109992014-04-18 21:36:39 +0000398 FunctionName = Name;
399 return true;
400 }
401 return false;
402}
403
Alexey Samsonov45be7932012-08-30 07:49:50 +0000404DILineInfo DWARFContext::getLineInfoForAddress(uint64_t Address,
Alexey Samsonovdce67342014-05-15 21:24:32 +0000405 DILineInfoSpecifier Spec) {
Alexey Samsonovd0109992014-04-18 21:36:39 +0000406 DILineInfo Result;
407
Alexey Samsonov45be7932012-08-30 07:49:50 +0000408 DWARFCompileUnit *CU = getCompileUnitForAddress(Address);
409 if (!CU)
Alexey Samsonovd0109992014-04-18 21:36:39 +0000410 return Result;
Alexey Samsonovdce67342014-05-15 21:24:32 +0000411 getFunctionNameForAddress(CU, Address, Spec.FNKind, Result.FunctionName);
412 if (Spec.FLIKind != FileLineInfoKind::None) {
Frederic Riss101b5e22014-09-19 15:11:51 +0000413 if (const DWARFLineTable *LineTable = getLineTableForUnit(CU))
414 LineTable->getFileLineInfoForAddress(Address, CU->getCompilationDir(),
415 Spec.FLIKind, Result);
Alexey Samsonovf4462fa2012-07-02 05:54:45 +0000416 }
Alexey Samsonovd0109992014-04-18 21:36:39 +0000417 return Result;
Benjamin Kramer2602ca62011-09-15 20:43:22 +0000418}
David Blaikiea379b1812011-12-20 02:50:00 +0000419
Alexey Samsonovdce67342014-05-15 21:24:32 +0000420DILineInfoTable
421DWARFContext::getLineInfoForAddressRange(uint64_t Address, uint64_t Size,
422 DILineInfoSpecifier Spec) {
Andrew Kaylor9a8ff812013-01-26 00:28:05 +0000423 DILineInfoTable Lines;
424 DWARFCompileUnit *CU = getCompileUnitForAddress(Address);
425 if (!CU)
426 return Lines;
427
428 std::string FunctionName = "<invalid>";
Alexey Samsonovdce67342014-05-15 21:24:32 +0000429 getFunctionNameForAddress(CU, Address, Spec.FNKind, FunctionName);
Andrew Kaylor9a8ff812013-01-26 00:28:05 +0000430
Andrew Kaylor9a8ff812013-01-26 00:28:05 +0000431 // If the Specifier says we don't need FileLineInfo, just
432 // return the top-most function at the starting address.
Alexey Samsonovdce67342014-05-15 21:24:32 +0000433 if (Spec.FLIKind == FileLineInfoKind::None) {
Alexey Samsonovd0109992014-04-18 21:36:39 +0000434 DILineInfo Result;
435 Result.FunctionName = FunctionName;
436 Lines.push_back(std::make_pair(Address, Result));
Andrew Kaylor9a8ff812013-01-26 00:28:05 +0000437 return Lines;
438 }
439
Frederic Rissec8a5ba2014-09-04 06:14:40 +0000440 const DWARFLineTable *LineTable = getLineTableForUnit(CU);
Andrew Kaylor9a8ff812013-01-26 00:28:05 +0000441
442 // Get the index of row we're looking for in the line table.
443 std::vector<uint32_t> RowVector;
444 if (!LineTable->lookupAddressRange(Address, Size, RowVector))
445 return Lines;
446
Alexey Samsonov1eabf982014-03-13 07:52:54 +0000447 for (uint32_t RowIndex : RowVector) {
Andrew Kaylor9a8ff812013-01-26 00:28:05 +0000448 // Take file number and line/column from the row.
449 const DWARFDebugLine::Row &Row = LineTable->Rows[RowIndex];
Alexey Samsonovd0109992014-04-18 21:36:39 +0000450 DILineInfo Result;
Frederic Riss101b5e22014-09-19 15:11:51 +0000451 LineTable->getFileNameByIndex(Row.File, CU->getCompilationDir(),
452 Spec.FLIKind, Result.FileName);
Alexey Samsonovd0109992014-04-18 21:36:39 +0000453 Result.FunctionName = FunctionName;
454 Result.Line = Row.Line;
455 Result.Column = Row.Column;
456 Lines.push_back(std::make_pair(Row.Address, Result));
Andrew Kaylor9a8ff812013-01-26 00:28:05 +0000457 }
458
459 return Lines;
460}
461
Alexey Samsonovdce67342014-05-15 21:24:32 +0000462DIInliningInfo
463DWARFContext::getInliningInfoForAddress(uint64_t Address,
464 DILineInfoSpecifier Spec) {
Alexey Samsonov5c39fdf2014-04-18 22:22:44 +0000465 DIInliningInfo InliningInfo;
466
Alexey Samsonovc942e6b2012-09-04 08:12:33 +0000467 DWARFCompileUnit *CU = getCompileUnitForAddress(Address);
468 if (!CU)
Alexey Samsonov5c39fdf2014-04-18 22:22:44 +0000469 return InliningInfo;
Alexey Samsonovc942e6b2012-09-04 08:12:33 +0000470
Alexey Samsonov5c39fdf2014-04-18 22:22:44 +0000471 const DWARFLineTable *LineTable = nullptr;
Alexey Samsonov3211e612013-08-06 10:49:15 +0000472 const DWARFDebugInfoEntryInlinedChain &InlinedChain =
Alexey Samsonovc942e6b2012-09-04 08:12:33 +0000473 CU->getInlinedChainForAddress(Address);
Alexey Samsonov5c39fdf2014-04-18 22:22:44 +0000474 if (InlinedChain.DIEs.size() == 0) {
475 // If there is no DIE for address (e.g. it is in unavailable .dwo file),
476 // try to at least get file/line info from symbol table.
Alexey Samsonovdce67342014-05-15 21:24:32 +0000477 if (Spec.FLIKind != FileLineInfoKind::None) {
Alexey Samsonov5c39fdf2014-04-18 22:22:44 +0000478 DILineInfo Frame;
Frederic Rissec8a5ba2014-09-04 06:14:40 +0000479 LineTable = getLineTableForUnit(CU);
Frederic Riss101b5e22014-09-19 15:11:51 +0000480 if (LineTable &&
481 LineTable->getFileLineInfoForAddress(Address, CU->getCompilationDir(),
482 Spec.FLIKind, Frame))
Alexey Samsonov5c39fdf2014-04-18 22:22:44 +0000483 InliningInfo.addFrame(Frame);
Alexey Samsonov5c39fdf2014-04-18 22:22:44 +0000484 }
485 return InliningInfo;
486 }
Alexey Samsonovc942e6b2012-09-04 08:12:33 +0000487
Alexey Samsonovc942e6b2012-09-04 08:12:33 +0000488 uint32_t CallFile = 0, CallLine = 0, CallColumn = 0;
Alexey Samsonov3211e612013-08-06 10:49:15 +0000489 for (uint32_t i = 0, n = InlinedChain.DIEs.size(); i != n; i++) {
490 const DWARFDebugInfoEntryMinimal &FunctionDIE = InlinedChain.DIEs[i];
Alexey Samsonovd0109992014-04-18 21:36:39 +0000491 DILineInfo Frame;
Alexey Samsonovc942e6b2012-09-04 08:12:33 +0000492 // Get function name if necessary.
Alexey Samsonovdce67342014-05-15 21:24:32 +0000493 if (const char *Name =
494 FunctionDIE.getSubroutineName(InlinedChain.U, Spec.FNKind))
495 Frame.FunctionName = Name;
496 if (Spec.FLIKind != FileLineInfoKind::None) {
Alexey Samsonovc942e6b2012-09-04 08:12:33 +0000497 if (i == 0) {
498 // For the topmost frame, initialize the line table of this
499 // compile unit and fetch file/line info from it.
Frederic Rissec8a5ba2014-09-04 06:14:40 +0000500 LineTable = getLineTableForUnit(CU);
Alexey Samsonovc942e6b2012-09-04 08:12:33 +0000501 // For the topmost routine, get file/line info from line table.
Frederic Riss101b5e22014-09-19 15:11:51 +0000502 if (LineTable)
503 LineTable->getFileLineInfoForAddress(Address, CU->getCompilationDir(),
504 Spec.FLIKind, Frame);
Alexey Samsonovc942e6b2012-09-04 08:12:33 +0000505 } else {
506 // Otherwise, use call file, call line and call column from
507 // previous DIE in inlined chain.
Frederic Riss101b5e22014-09-19 15:11:51 +0000508 if (LineTable)
509 LineTable->getFileNameByIndex(CallFile, CU->getCompilationDir(),
510 Spec.FLIKind, Frame.FileName);
Alexey Samsonovd0109992014-04-18 21:36:39 +0000511 Frame.Line = CallLine;
512 Frame.Column = CallColumn;
Alexey Samsonovc942e6b2012-09-04 08:12:33 +0000513 }
514 // Get call file/line/column of a current DIE.
515 if (i + 1 < n) {
David Blaikie07e22442013-09-23 22:44:40 +0000516 FunctionDIE.getCallerFrame(InlinedChain.U, CallFile, CallLine,
Alexey Samsonov3211e612013-08-06 10:49:15 +0000517 CallColumn);
Alexey Samsonovc942e6b2012-09-04 08:12:33 +0000518 }
519 }
Alexey Samsonovc942e6b2012-09-04 08:12:33 +0000520 InliningInfo.addFrame(Frame);
521 }
522 return InliningInfo;
523}
524
Alexey Samsonov068fc8a2013-04-23 10:17:34 +0000525static bool consumeCompressedDebugSectionHeader(StringRef &data,
526 uint64_t &OriginalSize) {
527 // Consume "ZLIB" prefix.
528 if (!data.startswith("ZLIB"))
529 return false;
530 data = data.substr(4);
531 // Consume uncompressed section size (big-endian 8 bytes).
532 DataExtractor extractor(data, false, 8);
533 uint32_t Offset = 0;
534 OriginalSize = extractor.getU64(&Offset);
535 if (Offset == 0)
536 return false;
537 data = data.substr(Offset);
538 return true;
539}
540
Alexey Samsonov4a7eb382014-10-20 20:28:51 +0000541DWARFContextInMemory::DWARFContextInMemory(const object::ObjectFile &Obj)
Rafael Espindolaa04bb5b2014-07-31 20:19:36 +0000542 : IsLittleEndian(Obj.isLittleEndian()),
543 AddressSize(Obj.getBytesInAddress()) {
544 for (const SectionRef &Section : Obj.sections()) {
Eric Christopher7370b552012-11-12 21:40:38 +0000545 StringRef name;
Alexey Samsonov063eb3f2014-03-13 13:52:54 +0000546 Section.getName(name);
David Majnemerdac39852014-09-26 22:32:16 +0000547 // Skip BSS and Virtual sections, they aren't interesting.
Rafael Espindola80291272014-10-08 15:28:58 +0000548 bool IsBSS = Section.isBSS();
David Majnemerdac39852014-09-26 22:32:16 +0000549 if (IsBSS)
550 continue;
Rafael Espindola80291272014-10-08 15:28:58 +0000551 bool IsVirtual = Section.isVirtual();
David Majnemerdac39852014-09-26 22:32:16 +0000552 if (IsVirtual)
553 continue;
Eric Christopher7370b552012-11-12 21:40:38 +0000554 StringRef data;
Alexey Samsonov063eb3f2014-03-13 13:52:54 +0000555 Section.getContents(data);
Eric Christopher7370b552012-11-12 21:40:38 +0000556
Eric Christopher7370b552012-11-12 21:40:38 +0000557 name = name.substr(name.find_first_not_of("._")); // Skip . and _ prefixes.
Alexey Samsonov3d0e3ed2013-04-17 14:27:04 +0000558
Alexey Samsonov068fc8a2013-04-23 10:17:34 +0000559 // Check if debug info section is compressed with zlib.
560 if (name.startswith("zdebug_")) {
561 uint64_t OriginalSize;
562 if (!zlib::isAvailable() ||
563 !consumeCompressedDebugSectionHeader(data, OriginalSize))
564 continue;
David Blaikiea505f242014-04-05 21:26:44 +0000565 UncompressedSections.resize(UncompressedSections.size() + 1);
566 if (zlib::uncompress(data, UncompressedSections.back(), OriginalSize) !=
567 zlib::StatusOK) {
568 UncompressedSections.pop_back();
Alexey Samsonov068fc8a2013-04-23 10:17:34 +0000569 continue;
David Blaikiea505f242014-04-05 21:26:44 +0000570 }
Alexey Samsonov068fc8a2013-04-23 10:17:34 +0000571 // Make data point to uncompressed section contents and save its contents.
572 name = name.substr(1);
David Blaikiea505f242014-04-05 21:26:44 +0000573 data = UncompressedSections.back();
Alexey Samsonov068fc8a2013-04-23 10:17:34 +0000574 }
575
Alexey Samsonov063eb3f2014-03-13 13:52:54 +0000576 StringRef *SectionData =
Eric Christopher4c7e6ba2013-09-25 23:02:41 +0000577 StringSwitch<StringRef *>(name)
578 .Case("debug_info", &InfoSection.Data)
579 .Case("debug_abbrev", &AbbrevSection)
580 .Case("debug_loc", &LocSection.Data)
581 .Case("debug_line", &LineSection.Data)
582 .Case("debug_aranges", &ARangeSection)
583 .Case("debug_frame", &DebugFrameSection)
584 .Case("debug_str", &StringSection)
585 .Case("debug_ranges", &RangeSection)
586 .Case("debug_pubnames", &PubNamesSection)
587 .Case("debug_pubtypes", &PubTypesSection)
588 .Case("debug_gnu_pubnames", &GnuPubNamesSection)
589 .Case("debug_gnu_pubtypes", &GnuPubTypesSection)
590 .Case("debug_info.dwo", &InfoDWOSection.Data)
591 .Case("debug_abbrev.dwo", &AbbrevDWOSection)
David Blaikie9c550ac2014-03-25 01:44:02 +0000592 .Case("debug_loc.dwo", &LocDWOSection.Data)
David Blaikie1d4736e2014-02-24 23:58:54 +0000593 .Case("debug_line.dwo", &LineDWOSection.Data)
Eric Christopher4c7e6ba2013-09-25 23:02:41 +0000594 .Case("debug_str.dwo", &StringDWOSection)
595 .Case("debug_str_offsets.dwo", &StringOffsetDWOSection)
596 .Case("debug_addr", &AddrSection)
Frederic Riss7c500472014-11-14 19:30:08 +0000597 .Case("apple_names", &AppleNamesSection.Data)
598 .Case("apple_types", &AppleTypesSection.Data)
599 .Case("apple_namespaces", &AppleNamespacesSection.Data)
600 .Case("apple_namespac", &AppleNamespacesSection.Data)
601 .Case("apple_objc", &AppleObjCSection.Data)
Eric Christopher4c7e6ba2013-09-25 23:02:41 +0000602 // Any more debug info sections go here.
Craig Topper2617dcc2014-04-15 06:32:26 +0000603 .Default(nullptr);
Alexey Samsonov063eb3f2014-03-13 13:52:54 +0000604 if (SectionData) {
605 *SectionData = data;
Rafael Espindola4f60a382013-05-30 03:05:14 +0000606 if (name == "debug_ranges") {
607 // FIXME: Use the other dwo range section when we emit it.
608 RangeDWOSection = data;
609 }
David Blaikie03c089c2013-09-23 22:44:47 +0000610 } else if (name == "debug_types") {
David Blaikie427e4352013-09-23 23:39:55 +0000611 // Find debug_types data by section rather than name as there are
612 // multiple, comdat grouped, debug_types sections.
Alexey Samsonov063eb3f2014-03-13 13:52:54 +0000613 TypesSections[Section].Data = data;
David Blaikie92d9d622014-01-09 05:08:24 +0000614 } else if (name == "debug_types.dwo") {
Alexey Samsonov063eb3f2014-03-13 13:52:54 +0000615 TypesDWOSections[Section].Data = data;
Eric Christopherda4b2192013-01-02 23:52:13 +0000616 }
Eric Christopher7370b552012-11-12 21:40:38 +0000617
Alexey Samsonov063eb3f2014-03-13 13:52:54 +0000618 section_iterator RelocatedSection = Section.getRelocatedSection();
Rafael Espindolaa04bb5b2014-07-31 20:19:36 +0000619 if (RelocatedSection == Obj.section_end())
Rafael Espindola4f60a382013-05-30 03:05:14 +0000620 continue;
621
622 StringRef RelSecName;
623 RelocatedSection->getName(RelSecName);
624 RelSecName = RelSecName.substr(
625 RelSecName.find_first_not_of("._")); // Skip . and _ prefixes.
626
Andrew Kaylord55d7012013-01-25 22:50:58 +0000627 // TODO: Add support for relocations in other sections as needed.
628 // Record relocations for the debug_info and debug_line sections.
Rafael Espindola4f60a382013-05-30 03:05:14 +0000629 RelocAddrMap *Map = StringSwitch<RelocAddrMap*>(RelSecName)
David Blaikie1b5ee5d2013-09-23 17:42:01 +0000630 .Case("debug_info", &InfoSection.Relocs)
631 .Case("debug_loc", &LocSection.Relocs)
632 .Case("debug_info.dwo", &InfoDWOSection.Relocs)
633 .Case("debug_line", &LineSection.Relocs)
Frederic Riss7c500472014-11-14 19:30:08 +0000634 .Case("apple_names", &AppleNamesSection.Relocs)
635 .Case("apple_types", &AppleTypesSection.Relocs)
636 .Case("apple_namespaces", &AppleNamespacesSection.Relocs)
637 .Case("apple_namespac", &AppleNamespacesSection.Relocs)
638 .Case("apple_objc", &AppleObjCSection.Relocs)
Craig Topper2617dcc2014-04-15 06:32:26 +0000639 .Default(nullptr);
David Blaikie03c089c2013-09-23 22:44:47 +0000640 if (!Map) {
David Blaikie427e4352013-09-23 23:39:55 +0000641 // Find debug_types relocs by section rather than name as there are
642 // multiple, comdat grouped, debug_types sections.
David Blaikie92d9d622014-01-09 05:08:24 +0000643 if (RelSecName == "debug_types")
644 Map = &TypesSections[*RelocatedSection].Relocs;
645 else if (RelSecName == "debug_types.dwo")
646 Map = &TypesDWOSections[*RelocatedSection].Relocs;
647 else
648 continue;
David Blaikie03c089c2013-09-23 22:44:47 +0000649 }
Eric Christopher7370b552012-11-12 21:40:38 +0000650
Alexey Samsonov063eb3f2014-03-13 13:52:54 +0000651 if (Section.relocation_begin() != Section.relocation_end()) {
Rafael Espindola80291272014-10-08 15:28:58 +0000652 uint64_t SectionSize = RelocatedSection->getSize();
Alexey Samsonovaa4d2952014-03-14 14:22:49 +0000653 for (const RelocationRef &Reloc : Section.relocations()) {
Eric Christopher7370b552012-11-12 21:40:38 +0000654 uint64_t Address;
Alexey Samsonovaa4d2952014-03-14 14:22:49 +0000655 Reloc.getOffset(Address);
Eric Christopher7370b552012-11-12 21:40:38 +0000656 uint64_t Type;
Alexey Samsonovaa4d2952014-03-14 14:22:49 +0000657 Reloc.getType(Type);
Andrew Kaylord55d7012013-01-25 22:50:58 +0000658 uint64_t SymAddr = 0;
David Majnemer5fbe3242014-10-08 06:38:50 +0000659 object::symbol_iterator Sym = Reloc.getSymbol();
660 if (Sym != Obj.symbol_end())
Rafael Espindola806f0062013-06-05 01:33:53 +0000661 Sym->getAddress(SymAddr);
Eric Christopher7370b552012-11-12 21:40:38 +0000662
Eric Christopher47e079d2014-10-06 06:55:55 +0000663 object::RelocVisitor V(Obj);
David Majnemer5fbe3242014-10-08 06:38:50 +0000664 object::RelocToApply R(V.visit(Type, Reloc, SymAddr));
Eric Christopher7370b552012-11-12 21:40:38 +0000665 if (V.error()) {
666 SmallString<32> Name;
Rafael Espindoladb4ed0b2014-06-13 02:24:39 +0000667 std::error_code ec(Reloc.getTypeName(Name));
Eric Christopher7370b552012-11-12 21:40:38 +0000668 if (ec) {
669 errs() << "Aaaaaa! Nameless relocation! Aaaaaa!\n";
670 }
671 errs() << "error: failed to compute relocation: "
672 << Name << "\n";
673 continue;
674 }
675
676 if (Address + R.Width > SectionSize) {
677 errs() << "error: " << R.Width << "-byte relocation starting "
678 << Address << " bytes into section " << name << " which is "
679 << SectionSize << " bytes long.\n";
680 continue;
681 }
682 if (R.Width > 8) {
683 errs() << "error: can't handle a relocation of more than 8 bytes at "
684 "a time.\n";
685 continue;
686 }
687 DEBUG(dbgs() << "Writing " << format("%p", R.Value)
688 << " at " << format("%p", Address)
689 << " with width " << format("%d", R.Width)
690 << "\n");
Eric Christopherda4b2192013-01-02 23:52:13 +0000691 Map->insert(std::make_pair(Address, std::make_pair(R.Width, R.Value)));
Eric Christopher7370b552012-11-12 21:40:38 +0000692 }
693 }
694 }
695}
696
David Blaikiea379b1812011-12-20 02:50:00 +0000697void DWARFContextInMemory::anchor() { }