blob: 3b427007e59e839c8cfcc289322fd606d8d2aa60 [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
Zachary Turner82af9432015-01-30 18:07:45 +000010#include "llvm/DebugInfo/DWARF/DWARFContext.h"
Alexey Samsonove16e16a2012-07-19 07:03:58 +000011#include "llvm/ADT/SmallString.h"
Alexey Samsonov3d0e3ed2013-04-17 14:27:04 +000012#include "llvm/ADT/StringSwitch.h"
Zachary Turner82af9432015-01-30 18:07:45 +000013#include "llvm/DebugInfo/DWARF/DWARFAcceleratorTable.h"
14#include "llvm/DebugInfo/DWARF/DWARFDebugArangeSet.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
Frederic Riss7c500472014-11-14 19:30:08 +000062static void dumpAccelSection(raw_ostream &OS, StringRef Name,
63 const DWARFSection& Section, StringRef StringSection,
64 bool LittleEndian) {
65 DataExtractor AccelSection(Section.Data, LittleEndian, 0);
Frederic Risse837ec22014-11-14 16:15:53 +000066 DataExtractor StrData(StringSection, LittleEndian, 0);
67 OS << "\n." << Name << " contents:\n";
Frederic Riss7c500472014-11-14 19:30:08 +000068 DWARFAcceleratorTable Accel(AccelSection, StrData, Section.Relocs);
Frederic Risse837ec22014-11-14 16:15:53 +000069 if (!Accel.extract())
70 return;
71 Accel.dump(OS);
72}
73
Eli Bendersky7a94daa2013-01-25 20:26:43 +000074void DWARFContext::dump(raw_ostream &OS, DIDumpType DumpType) {
75 if (DumpType == DIDT_All || DumpType == DIDT_Abbrev) {
76 OS << ".debug_abbrev contents:\n";
77 getDebugAbbrev()->dump(OS);
78 }
Benjamin Kramera6002fd2011-09-14 01:09:52 +000079
David Blaikie66865d62014-01-09 00:13:35 +000080 if (DumpType == DIDT_All || DumpType == DIDT_AbbrevDwo)
81 if (const DWARFDebugAbbrev *D = getDebugAbbrevDWO()) {
David Blaikie622dce42014-01-08 23:29:59 +000082 OS << "\n.debug_abbrev.dwo contents:\n";
David Blaikie66865d62014-01-09 00:13:35 +000083 D->dump(OS);
David Blaikie622dce42014-01-08 23:29:59 +000084 }
David Blaikie622dce42014-01-08 23:29:59 +000085
Eli Bendersky7a94daa2013-01-25 20:26:43 +000086 if (DumpType == DIDT_All || DumpType == DIDT_Info) {
87 OS << "\n.debug_info contents:\n";
Alexey Samsonov1eabf982014-03-13 07:52:54 +000088 for (const auto &CU : compile_units())
89 CU->dump(OS);
Eli Bendersky7a94daa2013-01-25 20:26:43 +000090 }
Benjamin Kramera6002fd2011-09-14 01:09:52 +000091
David Blaikie66865d62014-01-09 00:13:35 +000092 if ((DumpType == DIDT_All || DumpType == DIDT_InfoDwo) &&
93 getNumDWOCompileUnits()) {
94 OS << "\n.debug_info.dwo contents:\n";
Alexey Samsonov1eabf982014-03-13 07:52:54 +000095 for (const auto &DWOCU : dwo_compile_units())
96 DWOCU->dump(OS);
David Blaikie66865d62014-01-09 00:13:35 +000097 }
David Blaikie622dce42014-01-08 23:29:59 +000098
David Blaikie66865d62014-01-09 00:13:35 +000099 if ((DumpType == DIDT_All || DumpType == DIDT_Types) && getNumTypeUnits()) {
David Blaikie03c089c2013-09-23 22:44:47 +0000100 OS << "\n.debug_types contents:\n";
Frederic Riss312a02e2014-09-29 13:56:39 +0000101 for (const auto &TUS : type_unit_sections())
102 for (const auto &TU : TUS)
103 TU->dump(OS);
David Blaikie03c089c2013-09-23 22:44:47 +0000104 }
105
Alexey Samsonov1eabf982014-03-13 07:52:54 +0000106 if ((DumpType == DIDT_All || DumpType == DIDT_TypesDwo) &&
107 getNumDWOTypeUnits()) {
108 OS << "\n.debug_types.dwo contents:\n";
Frederic Riss312a02e2014-09-29 13:56:39 +0000109 for (const auto &DWOTUS : dwo_type_unit_sections())
110 for (const auto &DWOTU : DWOTUS)
111 DWOTU->dump(OS);
Alexey Samsonov1eabf982014-03-13 07:52:54 +0000112 }
David Blaikie92d9d622014-01-09 05:08:24 +0000113
David Blaikie18e73502013-06-19 21:37:13 +0000114 if (DumpType == DIDT_All || DumpType == DIDT_Loc) {
David Blaikie03c089c2013-09-23 22:44:47 +0000115 OS << "\n.debug_loc contents:\n";
David Blaikie18e73502013-06-19 21:37:13 +0000116 getDebugLoc()->dump(OS);
117 }
118
David Blaikie9c550ac2014-03-25 01:44:02 +0000119 if (DumpType == DIDT_All || DumpType == DIDT_LocDwo) {
120 OS << "\n.debug_loc.dwo contents:\n";
121 getDebugLocDWO()->dump(OS);
122 }
123
Eli Benderskyfd08bc12013-02-05 23:30:58 +0000124 if (DumpType == DIDT_All || DumpType == DIDT_Frames) {
125 OS << "\n.debug_frame contents:\n";
126 getDebugFrame()->dump(OS);
127 }
128
Benjamin Kramera6002fd2011-09-14 01:09:52 +0000129 uint32_t offset = 0;
Eli Bendersky7a94daa2013-01-25 20:26:43 +0000130 if (DumpType == DIDT_All || DumpType == DIDT_Aranges) {
131 OS << "\n.debug_aranges contents:\n";
132 DataExtractor arangesData(getARangeSection(), isLittleEndian(), 0);
133 DWARFDebugArangeSet set;
134 while (set.extract(arangesData, &offset))
135 set.dump(OS);
136 }
Benjamin Kramer5acab502011-09-15 02:12:05 +0000137
Alexey Samsonov034e57a2012-08-27 07:17:47 +0000138 uint8_t savedAddressByteSize = 0;
Eli Bendersky7a94daa2013-01-25 20:26:43 +0000139 if (DumpType == DIDT_All || DumpType == DIDT_Line) {
140 OS << "\n.debug_line contents:\n";
Alexey Samsonov1eabf982014-03-13 07:52:54 +0000141 for (const auto &CU : compile_units()) {
142 savedAddressByteSize = CU->getAddressByteSize();
Eli Bendersky7a94daa2013-01-25 20:26:43 +0000143 unsigned stmtOffset =
Alexey Samsonov1eabf982014-03-13 07:52:54 +0000144 CU->getCompileUnitDIE()->getAttributeValueAsSectionOffset(
Alexey Samsonov96dc29c2014-03-13 08:19:59 +0000145 CU.get(), DW_AT_stmt_list, -1U);
Eli Bendersky7a94daa2013-01-25 20:26:43 +0000146 if (stmtOffset != -1U) {
David Blaikie1b5ee5d2013-09-23 17:42:01 +0000147 DataExtractor lineData(getLineSection().Data, isLittleEndian(),
Eli Bendersky7a94daa2013-01-25 20:26:43 +0000148 savedAddressByteSize);
Alexey Samsonov110d5952014-04-30 00:09:19 +0000149 DWARFDebugLine::LineTable LineTable;
150 LineTable.parse(lineData, &getLineSection().Relocs, &stmtOffset);
151 LineTable.dump(OS);
Eli Bendersky7a94daa2013-01-25 20:26:43 +0000152 }
Benjamin Kramer6dda0322011-09-15 18:02:20 +0000153 }
154 }
Benjamin Kramer07d4b1c2011-09-15 16:57:13 +0000155
David Blaikie1d4736e2014-02-24 23:58:54 +0000156 if (DumpType == DIDT_All || DumpType == DIDT_LineDwo) {
157 OS << "\n.debug_line.dwo contents:\n";
158 unsigned stmtOffset = 0;
159 DataExtractor lineData(getLineDWOSection().Data, isLittleEndian(),
160 savedAddressByteSize);
Alexey Samsonov110d5952014-04-30 00:09:19 +0000161 DWARFDebugLine::LineTable LineTable;
162 while (LineTable.Prologue.parse(lineData, &stmtOffset)) {
163 LineTable.dump(OS);
164 LineTable.clear();
165 }
David Blaikie1d4736e2014-02-24 23:58:54 +0000166 }
167
Eli Bendersky7a94daa2013-01-25 20:26:43 +0000168 if (DumpType == DIDT_All || DumpType == DIDT_Str) {
169 OS << "\n.debug_str contents:\n";
170 DataExtractor strData(getStringSection(), isLittleEndian(), 0);
171 offset = 0;
172 uint32_t strOffset = 0;
173 while (const char *s = strData.getCStr(&offset)) {
174 OS << format("0x%8.8x: \"%s\"\n", strOffset, s);
175 strOffset = offset;
176 }
Benjamin Kramer07d4b1c2011-09-15 16:57:13 +0000177 }
Alexey Samsonov034e57a2012-08-27 07:17:47 +0000178
David Blaikie66865d62014-01-09 00:13:35 +0000179 if ((DumpType == DIDT_All || DumpType == DIDT_StrDwo) &&
180 !getStringDWOSection().empty()) {
181 OS << "\n.debug_str.dwo contents:\n";
182 DataExtractor strDWOData(getStringDWOSection(), isLittleEndian(), 0);
183 offset = 0;
184 uint32_t strDWOOffset = 0;
185 while (const char *s = strDWOData.getCStr(&offset)) {
186 OS << format("0x%8.8x: \"%s\"\n", strDWOOffset, s);
187 strDWOOffset = offset;
David Blaikie622dce42014-01-08 23:29:59 +0000188 }
David Blaikie66865d62014-01-09 00:13:35 +0000189 }
David Blaikie622dce42014-01-08 23:29:59 +0000190
Eli Bendersky7a94daa2013-01-25 20:26:43 +0000191 if (DumpType == DIDT_All || DumpType == DIDT_Ranges) {
192 OS << "\n.debug_ranges contents:\n";
193 // In fact, different compile units may have different address byte
194 // sizes, but for simplicity we just use the address byte size of the last
195 // compile unit (there is no easy and fast way to associate address range
196 // list and the compile unit it describes).
197 DataExtractor rangesData(getRangeSection(), isLittleEndian(),
198 savedAddressByteSize);
199 offset = 0;
200 DWARFDebugRangeList rangeList;
201 while (rangeList.extract(rangesData, &offset))
202 rangeList.dump(OS);
Eric Christopherda4b2192013-01-02 23:52:13 +0000203 }
Eric Christopher962c9082013-01-15 23:56:56 +0000204
Eric Christopher0de53592013-09-25 23:02:36 +0000205 if (DumpType == DIDT_All || DumpType == DIDT_Pubnames)
206 dumpPubSection(OS, "debug_pubnames", getPubNamesSection(),
207 isLittleEndian(), false);
Krzysztof Parzyszek97438dc2013-02-12 16:20:28 +0000208
Eric Christopher4c7e6ba2013-09-25 23:02:41 +0000209 if (DumpType == DIDT_All || DumpType == DIDT_Pubtypes)
210 dumpPubSection(OS, "debug_pubtypes", getPubTypesSection(),
211 isLittleEndian(), false);
212
David Blaikieecd21ff2013-09-24 19:50:00 +0000213 if (DumpType == DIDT_All || DumpType == DIDT_GnuPubnames)
214 dumpPubSection(OS, "debug_gnu_pubnames", getGnuPubNamesSection(),
Eric Christopher0de53592013-09-25 23:02:36 +0000215 isLittleEndian(), true /* GnuStyle */);
David Blaikieecd21ff2013-09-24 19:50:00 +0000216
217 if (DumpType == DIDT_All || DumpType == DIDT_GnuPubtypes)
218 dumpPubSection(OS, "debug_gnu_pubtypes", getGnuPubTypesSection(),
Eric Christopher0de53592013-09-25 23:02:36 +0000219 isLittleEndian(), true /* GnuStyle */);
David Blaikie404d3042013-09-19 23:01:29 +0000220
David Blaikie66865d62014-01-09 00:13:35 +0000221 if ((DumpType == DIDT_All || DumpType == DIDT_StrOffsetsDwo) &&
222 !getStringOffsetDWOSection().empty()) {
223 OS << "\n.debug_str_offsets.dwo contents:\n";
224 DataExtractor strOffsetExt(getStringOffsetDWOSection(), isLittleEndian(),
225 0);
226 offset = 0;
227 uint64_t size = getStringOffsetDWOSection().size();
228 while (offset < size) {
229 OS << format("0x%8.8x: ", offset);
230 OS << format("%8.8x\n", strOffsetExt.getU32(&offset));
Eric Christopher92f3c0b2013-05-06 17:50:42 +0000231 }
David Blaikie66865d62014-01-09 00:13:35 +0000232 }
Frederic Risse837ec22014-11-14 16:15:53 +0000233
234 if (DumpType == DIDT_All || DumpType == DIDT_AppleNames)
235 dumpAccelSection(OS, "apple_names", getAppleNamesSection(),
236 getStringSection(), isLittleEndian());
237
238 if (DumpType == DIDT_All || DumpType == DIDT_AppleTypes)
239 dumpAccelSection(OS, "apple_types", getAppleTypesSection(),
240 getStringSection(), isLittleEndian());
241
242 if (DumpType == DIDT_All || DumpType == DIDT_AppleNamespaces)
243 dumpAccelSection(OS, "apple_namespaces", getAppleNamespacesSection(),
244 getStringSection(), isLittleEndian());
245
246 if (DumpType == DIDT_All || DumpType == DIDT_AppleObjC)
247 dumpAccelSection(OS, "apple_objc", getAppleObjCSection(),
248 getStringSection(), isLittleEndian());
Benjamin Krameraa2f78f2011-09-13 19:42:23 +0000249}
250
251const DWARFDebugAbbrev *DWARFContext::getDebugAbbrev() {
252 if (Abbrev)
253 return Abbrev.get();
254
255 DataExtractor abbrData(getAbbrevSection(), isLittleEndian(), 0);
256
257 Abbrev.reset(new DWARFDebugAbbrev());
Alexey Samsonov4316df52014-04-25 21:10:56 +0000258 Abbrev->extract(abbrData);
Benjamin Krameraa2f78f2011-09-13 19:42:23 +0000259 return Abbrev.get();
260}
261
Eric Christopherda4b2192013-01-02 23:52:13 +0000262const DWARFDebugAbbrev *DWARFContext::getDebugAbbrevDWO() {
263 if (AbbrevDWO)
264 return AbbrevDWO.get();
265
266 DataExtractor abbrData(getAbbrevDWOSection(), isLittleEndian(), 0);
267 AbbrevDWO.reset(new DWARFDebugAbbrev());
Alexey Samsonov4316df52014-04-25 21:10:56 +0000268 AbbrevDWO->extract(abbrData);
Eric Christopherda4b2192013-01-02 23:52:13 +0000269 return AbbrevDWO.get();
270}
271
David Blaikie18e73502013-06-19 21:37:13 +0000272const DWARFDebugLoc *DWARFContext::getDebugLoc() {
273 if (Loc)
274 return Loc.get();
275
David Blaikie1b5ee5d2013-09-23 17:42:01 +0000276 DataExtractor LocData(getLocSection().Data, isLittleEndian(), 0);
277 Loc.reset(new DWARFDebugLoc(getLocSection().Relocs));
David Blaikie18e73502013-06-19 21:37:13 +0000278 // assume all compile units have the same address byte size
279 if (getNumCompileUnits())
280 Loc->parse(LocData, getCompileUnitAtIndex(0)->getAddressByteSize());
281 return Loc.get();
282}
283
David Blaikie9c550ac2014-03-25 01:44:02 +0000284const DWARFDebugLocDWO *DWARFContext::getDebugLocDWO() {
285 if (LocDWO)
286 return LocDWO.get();
287
288 DataExtractor LocData(getLocDWOSection().Data, isLittleEndian(), 0);
289 LocDWO.reset(new DWARFDebugLocDWO());
290 LocDWO->parse(LocData);
291 return LocDWO.get();
292}
293
Benjamin Kramera6002fd2011-09-14 01:09:52 +0000294const DWARFDebugAranges *DWARFContext::getDebugAranges() {
295 if (Aranges)
296 return Aranges.get();
297
Benjamin Kramera6002fd2011-09-14 01:09:52 +0000298 Aranges.reset(new DWARFDebugAranges());
Alexey Samsonova1694c12012-11-16 08:36:25 +0000299 Aranges->generate(this);
Benjamin Kramera6002fd2011-09-14 01:09:52 +0000300 return Aranges.get();
301}
302
Eli Benderskyfd08bc12013-02-05 23:30:58 +0000303const DWARFDebugFrame *DWARFContext::getDebugFrame() {
304 if (DebugFrame)
305 return DebugFrame.get();
306
307 // There's a "bug" in the DWARFv3 standard with respect to the target address
308 // size within debug frame sections. While DWARF is supposed to be independent
309 // of its container, FDEs have fields with size being "target address size",
310 // which isn't specified in DWARF in general. It's only specified for CUs, but
311 // .eh_frame can appear without a .debug_info section. Follow the example of
312 // other tools (libdwarf) and extract this from the container (ObjectFile
313 // provides this information). This problem is fixed in DWARFv4
314 // See this dwarf-discuss discussion for more details:
315 // http://lists.dwarfstd.org/htdig.cgi/dwarf-discuss-dwarfstd.org/2011-December/001173.html
316 DataExtractor debugFrameData(getDebugFrameSection(), isLittleEndian(),
317 getAddressSize());
318 DebugFrame.reset(new DWARFDebugFrame());
319 DebugFrame->parse(debugFrameData);
320 return DebugFrame.get();
321}
322
Eric Christopher494109b2012-10-16 23:46:25 +0000323const DWARFLineTable *
Frederic Rissec8a5ba2014-09-04 06:14:40 +0000324DWARFContext::getLineTableForUnit(DWARFUnit *cu) {
Benjamin Kramer679e1752011-09-15 20:43:18 +0000325 if (!Line)
David Blaikie1b5ee5d2013-09-23 17:42:01 +0000326 Line.reset(new DWARFDebugLine(&getLineSection().Relocs));
Benjamin Kramer5acab502011-09-15 02:12:05 +0000327
Benjamin Kramer679e1752011-09-15 20:43:18 +0000328 unsigned stmtOffset =
Alexey Samsonov48cbda52013-10-28 23:01:48 +0000329 cu->getCompileUnitDIE()->getAttributeValueAsSectionOffset(
330 cu, DW_AT_stmt_list, -1U);
Benjamin Kramer679e1752011-09-15 20:43:18 +0000331 if (stmtOffset == -1U)
Craig Topper2617dcc2014-04-15 06:32:26 +0000332 return nullptr; // No line table for this compile unit.
Benjamin Kramer5acab502011-09-15 02:12:05 +0000333
Benjamin Kramer679e1752011-09-15 20:43:18 +0000334 // See if the line table is cached.
Eric Christopher494109b2012-10-16 23:46:25 +0000335 if (const DWARFLineTable *lt = Line->getLineTable(stmtOffset))
Benjamin Kramer679e1752011-09-15 20:43:18 +0000336 return lt;
337
338 // We have to parse it first.
David Blaikie1b5ee5d2013-09-23 17:42:01 +0000339 DataExtractor lineData(getLineSection().Data, isLittleEndian(),
Benjamin Kramer679e1752011-09-15 20:43:18 +0000340 cu->getAddressByteSize());
341 return Line->getOrParseLineTable(lineData, stmtOffset);
Benjamin Kramer5acab502011-09-15 02:12:05 +0000342}
343
Benjamin Krameraa2f78f2011-09-13 19:42:23 +0000344void DWARFContext::parseCompileUnits() {
Alexey Samsonov8cd4c9d2014-10-08 00:07:53 +0000345 CUs.parse(*this, getInfoSection());
Benjamin Krameraa2f78f2011-09-13 19:42:23 +0000346}
Benjamin Kramer2602ca62011-09-15 20:43:22 +0000347
David Blaikie03c089c2013-09-23 22:44:47 +0000348void DWARFContext::parseTypeUnits() {
Alexey Samsonov1eabf982014-03-13 07:52:54 +0000349 if (!TUs.empty())
350 return;
351 for (const auto &I : getTypesSections()) {
Frederic Riss312a02e2014-09-29 13:56:39 +0000352 TUs.push_back(DWARFUnitSection<DWARFTypeUnit>());
Alexey Samsonov8cd4c9d2014-10-08 00:07:53 +0000353 TUs.back().parse(*this, I.second);
David Blaikie03c089c2013-09-23 22:44:47 +0000354 }
355}
356
Eric Christopherda4b2192013-01-02 23:52:13 +0000357void DWARFContext::parseDWOCompileUnits() {
Alexey Samsonov8cd4c9d2014-10-08 00:07:53 +0000358 DWOCUs.parseDWO(*this, getInfoDWOSection());
Eric Christopherda4b2192013-01-02 23:52:13 +0000359}
360
David Blaikie92d9d622014-01-09 05:08:24 +0000361void DWARFContext::parseDWOTypeUnits() {
Alexey Samsonov1eabf982014-03-13 07:52:54 +0000362 if (!DWOTUs.empty())
363 return;
364 for (const auto &I : getTypesDWOSections()) {
Frederic Riss312a02e2014-09-29 13:56:39 +0000365 DWOTUs.push_back(DWARFUnitSection<DWARFTypeUnit>());
Alexey Samsonov8cd4c9d2014-10-08 00:07:53 +0000366 DWOTUs.back().parseDWO(*this, I.second);
David Blaikie92d9d622014-01-09 05:08:24 +0000367 }
368}
369
Alexey Samsonov45be7932012-08-30 07:49:50 +0000370DWARFCompileUnit *DWARFContext::getCompileUnitForOffset(uint32_t Offset) {
Alexey Samsonov1eabf982014-03-13 07:52:54 +0000371 parseCompileUnits();
Frederic Riss4e126a02014-09-15 07:50:27 +0000372 return CUs.getUnitForOffset(Offset);
Benjamin Kramer2602ca62011-09-15 20:43:22 +0000373}
374
Alexey Samsonov45be7932012-08-30 07:49:50 +0000375DWARFCompileUnit *DWARFContext::getCompileUnitForAddress(uint64_t Address) {
Benjamin Kramer112ec172011-09-15 21:59:13 +0000376 // First, get the offset of the compile unit.
Alexey Samsonov45be7932012-08-30 07:49:50 +0000377 uint32_t CUOffset = getDebugAranges()->findAddress(Address);
Benjamin Kramer2602ca62011-09-15 20:43:22 +0000378 // Retrieve the compile unit.
Alexey Samsonov45be7932012-08-30 07:49:50 +0000379 return getCompileUnitForOffset(CUOffset);
380}
381
Alexey Samsonovd0109992014-04-18 21:36:39 +0000382static bool getFunctionNameForAddress(DWARFCompileUnit *CU, uint64_t Address,
Alexey Samsonovdce67342014-05-15 21:24:32 +0000383 FunctionNameKind Kind,
Alexey Samsonovd0109992014-04-18 21:36:39 +0000384 std::string &FunctionName) {
Alexey Samsonovdce67342014-05-15 21:24:32 +0000385 if (Kind == FunctionNameKind::None)
386 return false;
Alexey Samsonovd0109992014-04-18 21:36:39 +0000387 // The address may correspond to instruction in some inlined function,
388 // so we have to build the chain of inlined functions and take the
389 // name of the topmost function in it.
390 const DWARFDebugInfoEntryInlinedChain &InlinedChain =
391 CU->getInlinedChainForAddress(Address);
392 if (InlinedChain.DIEs.size() == 0)
393 return false;
394 const DWARFDebugInfoEntryMinimal &TopFunctionDIE = InlinedChain.DIEs[0];
Alexey Samsonovdce67342014-05-15 21:24:32 +0000395 if (const char *Name =
396 TopFunctionDIE.getSubroutineName(InlinedChain.U, Kind)) {
Alexey Samsonovd0109992014-04-18 21:36:39 +0000397 FunctionName = Name;
398 return true;
399 }
400 return false;
401}
402
Alexey Samsonov45be7932012-08-30 07:49:50 +0000403DILineInfo DWARFContext::getLineInfoForAddress(uint64_t Address,
Alexey Samsonovdce67342014-05-15 21:24:32 +0000404 DILineInfoSpecifier Spec) {
Alexey Samsonovd0109992014-04-18 21:36:39 +0000405 DILineInfo Result;
406
Alexey Samsonov45be7932012-08-30 07:49:50 +0000407 DWARFCompileUnit *CU = getCompileUnitForAddress(Address);
408 if (!CU)
Alexey Samsonovd0109992014-04-18 21:36:39 +0000409 return Result;
Alexey Samsonovdce67342014-05-15 21:24:32 +0000410 getFunctionNameForAddress(CU, Address, Spec.FNKind, Result.FunctionName);
411 if (Spec.FLIKind != FileLineInfoKind::None) {
Frederic Riss101b5e22014-09-19 15:11:51 +0000412 if (const DWARFLineTable *LineTable = getLineTableForUnit(CU))
413 LineTable->getFileLineInfoForAddress(Address, CU->getCompilationDir(),
414 Spec.FLIKind, Result);
Alexey Samsonovf4462fa2012-07-02 05:54:45 +0000415 }
Alexey Samsonovd0109992014-04-18 21:36:39 +0000416 return Result;
Benjamin Kramer2602ca62011-09-15 20:43:22 +0000417}
David Blaikiea379b1812011-12-20 02:50:00 +0000418
Alexey Samsonovdce67342014-05-15 21:24:32 +0000419DILineInfoTable
420DWARFContext::getLineInfoForAddressRange(uint64_t Address, uint64_t Size,
421 DILineInfoSpecifier Spec) {
Andrew Kaylor9a8ff812013-01-26 00:28:05 +0000422 DILineInfoTable Lines;
423 DWARFCompileUnit *CU = getCompileUnitForAddress(Address);
424 if (!CU)
425 return Lines;
426
427 std::string FunctionName = "<invalid>";
Alexey Samsonovdce67342014-05-15 21:24:32 +0000428 getFunctionNameForAddress(CU, Address, Spec.FNKind, FunctionName);
Andrew Kaylor9a8ff812013-01-26 00:28:05 +0000429
Andrew Kaylor9a8ff812013-01-26 00:28:05 +0000430 // If the Specifier says we don't need FileLineInfo, just
431 // return the top-most function at the starting address.
Alexey Samsonovdce67342014-05-15 21:24:32 +0000432 if (Spec.FLIKind == FileLineInfoKind::None) {
Alexey Samsonovd0109992014-04-18 21:36:39 +0000433 DILineInfo Result;
434 Result.FunctionName = FunctionName;
435 Lines.push_back(std::make_pair(Address, Result));
Andrew Kaylor9a8ff812013-01-26 00:28:05 +0000436 return Lines;
437 }
438
Frederic Rissec8a5ba2014-09-04 06:14:40 +0000439 const DWARFLineTable *LineTable = getLineTableForUnit(CU);
Andrew Kaylor9a8ff812013-01-26 00:28:05 +0000440
441 // Get the index of row we're looking for in the line table.
442 std::vector<uint32_t> RowVector;
443 if (!LineTable->lookupAddressRange(Address, Size, RowVector))
444 return Lines;
445
Alexey Samsonov1eabf982014-03-13 07:52:54 +0000446 for (uint32_t RowIndex : RowVector) {
Andrew Kaylor9a8ff812013-01-26 00:28:05 +0000447 // Take file number and line/column from the row.
448 const DWARFDebugLine::Row &Row = LineTable->Rows[RowIndex];
Alexey Samsonovd0109992014-04-18 21:36:39 +0000449 DILineInfo Result;
Frederic Riss101b5e22014-09-19 15:11:51 +0000450 LineTable->getFileNameByIndex(Row.File, CU->getCompilationDir(),
451 Spec.FLIKind, Result.FileName);
Alexey Samsonovd0109992014-04-18 21:36:39 +0000452 Result.FunctionName = FunctionName;
453 Result.Line = Row.Line;
454 Result.Column = Row.Column;
455 Lines.push_back(std::make_pair(Row.Address, Result));
Andrew Kaylor9a8ff812013-01-26 00:28:05 +0000456 }
457
458 return Lines;
459}
460
Alexey Samsonovdce67342014-05-15 21:24:32 +0000461DIInliningInfo
462DWARFContext::getInliningInfoForAddress(uint64_t Address,
463 DILineInfoSpecifier Spec) {
Alexey Samsonov5c39fdf2014-04-18 22:22:44 +0000464 DIInliningInfo InliningInfo;
465
Alexey Samsonovc942e6b2012-09-04 08:12:33 +0000466 DWARFCompileUnit *CU = getCompileUnitForAddress(Address);
467 if (!CU)
Alexey Samsonov5c39fdf2014-04-18 22:22:44 +0000468 return InliningInfo;
Alexey Samsonovc942e6b2012-09-04 08:12:33 +0000469
Alexey Samsonov5c39fdf2014-04-18 22:22:44 +0000470 const DWARFLineTable *LineTable = nullptr;
Alexey Samsonov3211e612013-08-06 10:49:15 +0000471 const DWARFDebugInfoEntryInlinedChain &InlinedChain =
Alexey Samsonovc942e6b2012-09-04 08:12:33 +0000472 CU->getInlinedChainForAddress(Address);
Alexey Samsonov5c39fdf2014-04-18 22:22:44 +0000473 if (InlinedChain.DIEs.size() == 0) {
474 // If there is no DIE for address (e.g. it is in unavailable .dwo file),
475 // try to at least get file/line info from symbol table.
Alexey Samsonovdce67342014-05-15 21:24:32 +0000476 if (Spec.FLIKind != FileLineInfoKind::None) {
Alexey Samsonov5c39fdf2014-04-18 22:22:44 +0000477 DILineInfo Frame;
Frederic Rissec8a5ba2014-09-04 06:14:40 +0000478 LineTable = getLineTableForUnit(CU);
Frederic Riss101b5e22014-09-19 15:11:51 +0000479 if (LineTable &&
480 LineTable->getFileLineInfoForAddress(Address, CU->getCompilationDir(),
481 Spec.FLIKind, Frame))
Alexey Samsonov5c39fdf2014-04-18 22:22:44 +0000482 InliningInfo.addFrame(Frame);
Alexey Samsonov5c39fdf2014-04-18 22:22:44 +0000483 }
484 return InliningInfo;
485 }
Alexey Samsonovc942e6b2012-09-04 08:12:33 +0000486
Alexey Samsonovc942e6b2012-09-04 08:12:33 +0000487 uint32_t CallFile = 0, CallLine = 0, CallColumn = 0;
Alexey Samsonov3211e612013-08-06 10:49:15 +0000488 for (uint32_t i = 0, n = InlinedChain.DIEs.size(); i != n; i++) {
489 const DWARFDebugInfoEntryMinimal &FunctionDIE = InlinedChain.DIEs[i];
Alexey Samsonovd0109992014-04-18 21:36:39 +0000490 DILineInfo Frame;
Alexey Samsonovc942e6b2012-09-04 08:12:33 +0000491 // Get function name if necessary.
Alexey Samsonovdce67342014-05-15 21:24:32 +0000492 if (const char *Name =
493 FunctionDIE.getSubroutineName(InlinedChain.U, Spec.FNKind))
494 Frame.FunctionName = Name;
495 if (Spec.FLIKind != FileLineInfoKind::None) {
Alexey Samsonovc942e6b2012-09-04 08:12:33 +0000496 if (i == 0) {
497 // For the topmost frame, initialize the line table of this
498 // compile unit and fetch file/line info from it.
Frederic Rissec8a5ba2014-09-04 06:14:40 +0000499 LineTable = getLineTableForUnit(CU);
Alexey Samsonovc942e6b2012-09-04 08:12:33 +0000500 // For the topmost routine, get file/line info from line table.
Frederic Riss101b5e22014-09-19 15:11:51 +0000501 if (LineTable)
502 LineTable->getFileLineInfoForAddress(Address, CU->getCompilationDir(),
503 Spec.FLIKind, Frame);
Alexey Samsonovc942e6b2012-09-04 08:12:33 +0000504 } else {
505 // Otherwise, use call file, call line and call column from
506 // previous DIE in inlined chain.
Frederic Riss101b5e22014-09-19 15:11:51 +0000507 if (LineTable)
508 LineTable->getFileNameByIndex(CallFile, CU->getCompilationDir(),
509 Spec.FLIKind, Frame.FileName);
Alexey Samsonovd0109992014-04-18 21:36:39 +0000510 Frame.Line = CallLine;
511 Frame.Column = CallColumn;
Alexey Samsonovc942e6b2012-09-04 08:12:33 +0000512 }
513 // Get call file/line/column of a current DIE.
514 if (i + 1 < n) {
David Blaikie07e22442013-09-23 22:44:40 +0000515 FunctionDIE.getCallerFrame(InlinedChain.U, CallFile, CallLine,
Alexey Samsonov3211e612013-08-06 10:49:15 +0000516 CallColumn);
Alexey Samsonovc942e6b2012-09-04 08:12:33 +0000517 }
518 }
Alexey Samsonovc942e6b2012-09-04 08:12:33 +0000519 InliningInfo.addFrame(Frame);
520 }
521 return InliningInfo;
522}
523
Alexey Samsonov068fc8a2013-04-23 10:17:34 +0000524static bool consumeCompressedDebugSectionHeader(StringRef &data,
525 uint64_t &OriginalSize) {
526 // Consume "ZLIB" prefix.
527 if (!data.startswith("ZLIB"))
528 return false;
529 data = data.substr(4);
530 // Consume uncompressed section size (big-endian 8 bytes).
531 DataExtractor extractor(data, false, 8);
532 uint32_t Offset = 0;
533 OriginalSize = extractor.getU64(&Offset);
534 if (Offset == 0)
535 return false;
536 data = data.substr(Offset);
537 return true;
538}
539
Alexey Samsonov4a7eb382014-10-20 20:28:51 +0000540DWARFContextInMemory::DWARFContextInMemory(const object::ObjectFile &Obj)
Rafael Espindolaa04bb5b2014-07-31 20:19:36 +0000541 : IsLittleEndian(Obj.isLittleEndian()),
542 AddressSize(Obj.getBytesInAddress()) {
543 for (const SectionRef &Section : Obj.sections()) {
Eric Christopher7370b552012-11-12 21:40:38 +0000544 StringRef name;
Alexey Samsonov063eb3f2014-03-13 13:52:54 +0000545 Section.getName(name);
David Majnemerdac39852014-09-26 22:32:16 +0000546 // Skip BSS and Virtual sections, they aren't interesting.
Rafael Espindola80291272014-10-08 15:28:58 +0000547 bool IsBSS = Section.isBSS();
David Majnemerdac39852014-09-26 22:32:16 +0000548 if (IsBSS)
549 continue;
Rafael Espindola80291272014-10-08 15:28:58 +0000550 bool IsVirtual = Section.isVirtual();
David Majnemerdac39852014-09-26 22:32:16 +0000551 if (IsVirtual)
552 continue;
Eric Christopher7370b552012-11-12 21:40:38 +0000553 StringRef data;
Alexey Samsonov063eb3f2014-03-13 13:52:54 +0000554 Section.getContents(data);
Eric Christopher7370b552012-11-12 21:40:38 +0000555
Eric Christopher7370b552012-11-12 21:40:38 +0000556 name = name.substr(name.find_first_not_of("._")); // Skip . and _ prefixes.
Alexey Samsonov3d0e3ed2013-04-17 14:27:04 +0000557
Alexey Samsonov068fc8a2013-04-23 10:17:34 +0000558 // Check if debug info section is compressed with zlib.
559 if (name.startswith("zdebug_")) {
560 uint64_t OriginalSize;
561 if (!zlib::isAvailable() ||
562 !consumeCompressedDebugSectionHeader(data, OriginalSize))
563 continue;
David Blaikiea505f242014-04-05 21:26:44 +0000564 UncompressedSections.resize(UncompressedSections.size() + 1);
565 if (zlib::uncompress(data, UncompressedSections.back(), OriginalSize) !=
566 zlib::StatusOK) {
567 UncompressedSections.pop_back();
Alexey Samsonov068fc8a2013-04-23 10:17:34 +0000568 continue;
David Blaikiea505f242014-04-05 21:26:44 +0000569 }
Alexey Samsonov068fc8a2013-04-23 10:17:34 +0000570 // Make data point to uncompressed section contents and save its contents.
571 name = name.substr(1);
David Blaikiea505f242014-04-05 21:26:44 +0000572 data = UncompressedSections.back();
Alexey Samsonov068fc8a2013-04-23 10:17:34 +0000573 }
574
Alexey Samsonov063eb3f2014-03-13 13:52:54 +0000575 StringRef *SectionData =
Eric Christopher4c7e6ba2013-09-25 23:02:41 +0000576 StringSwitch<StringRef *>(name)
577 .Case("debug_info", &InfoSection.Data)
578 .Case("debug_abbrev", &AbbrevSection)
579 .Case("debug_loc", &LocSection.Data)
580 .Case("debug_line", &LineSection.Data)
581 .Case("debug_aranges", &ARangeSection)
582 .Case("debug_frame", &DebugFrameSection)
583 .Case("debug_str", &StringSection)
584 .Case("debug_ranges", &RangeSection)
585 .Case("debug_pubnames", &PubNamesSection)
586 .Case("debug_pubtypes", &PubTypesSection)
587 .Case("debug_gnu_pubnames", &GnuPubNamesSection)
588 .Case("debug_gnu_pubtypes", &GnuPubTypesSection)
589 .Case("debug_info.dwo", &InfoDWOSection.Data)
590 .Case("debug_abbrev.dwo", &AbbrevDWOSection)
David Blaikie9c550ac2014-03-25 01:44:02 +0000591 .Case("debug_loc.dwo", &LocDWOSection.Data)
David Blaikie1d4736e2014-02-24 23:58:54 +0000592 .Case("debug_line.dwo", &LineDWOSection.Data)
Eric Christopher4c7e6ba2013-09-25 23:02:41 +0000593 .Case("debug_str.dwo", &StringDWOSection)
594 .Case("debug_str_offsets.dwo", &StringOffsetDWOSection)
595 .Case("debug_addr", &AddrSection)
Frederic Riss7c500472014-11-14 19:30:08 +0000596 .Case("apple_names", &AppleNamesSection.Data)
597 .Case("apple_types", &AppleTypesSection.Data)
598 .Case("apple_namespaces", &AppleNamespacesSection.Data)
599 .Case("apple_namespac", &AppleNamespacesSection.Data)
600 .Case("apple_objc", &AppleObjCSection.Data)
Eric Christopher4c7e6ba2013-09-25 23:02:41 +0000601 // Any more debug info sections go here.
Craig Topper2617dcc2014-04-15 06:32:26 +0000602 .Default(nullptr);
Alexey Samsonov063eb3f2014-03-13 13:52:54 +0000603 if (SectionData) {
604 *SectionData = data;
Rafael Espindola4f60a382013-05-30 03:05:14 +0000605 if (name == "debug_ranges") {
606 // FIXME: Use the other dwo range section when we emit it.
607 RangeDWOSection = data;
608 }
David Blaikie03c089c2013-09-23 22:44:47 +0000609 } else if (name == "debug_types") {
David Blaikie427e4352013-09-23 23:39:55 +0000610 // Find debug_types data by section rather than name as there are
611 // multiple, comdat grouped, debug_types sections.
Alexey Samsonov063eb3f2014-03-13 13:52:54 +0000612 TypesSections[Section].Data = data;
David Blaikie92d9d622014-01-09 05:08:24 +0000613 } else if (name == "debug_types.dwo") {
Alexey Samsonov063eb3f2014-03-13 13:52:54 +0000614 TypesDWOSections[Section].Data = data;
Eric Christopherda4b2192013-01-02 23:52:13 +0000615 }
Eric Christopher7370b552012-11-12 21:40:38 +0000616
Alexey Samsonov063eb3f2014-03-13 13:52:54 +0000617 section_iterator RelocatedSection = Section.getRelocatedSection();
Rafael Espindolaa04bb5b2014-07-31 20:19:36 +0000618 if (RelocatedSection == Obj.section_end())
Rafael Espindola4f60a382013-05-30 03:05:14 +0000619 continue;
620
621 StringRef RelSecName;
622 RelocatedSection->getName(RelSecName);
623 RelSecName = RelSecName.substr(
624 RelSecName.find_first_not_of("._")); // Skip . and _ prefixes.
625
Andrew Kaylord55d7012013-01-25 22:50:58 +0000626 // TODO: Add support for relocations in other sections as needed.
627 // Record relocations for the debug_info and debug_line sections.
Rafael Espindola4f60a382013-05-30 03:05:14 +0000628 RelocAddrMap *Map = StringSwitch<RelocAddrMap*>(RelSecName)
David Blaikie1b5ee5d2013-09-23 17:42:01 +0000629 .Case("debug_info", &InfoSection.Relocs)
630 .Case("debug_loc", &LocSection.Relocs)
631 .Case("debug_info.dwo", &InfoDWOSection.Relocs)
632 .Case("debug_line", &LineSection.Relocs)
Frederic Riss7c500472014-11-14 19:30:08 +0000633 .Case("apple_names", &AppleNamesSection.Relocs)
634 .Case("apple_types", &AppleTypesSection.Relocs)
635 .Case("apple_namespaces", &AppleNamespacesSection.Relocs)
636 .Case("apple_namespac", &AppleNamespacesSection.Relocs)
637 .Case("apple_objc", &AppleObjCSection.Relocs)
Craig Topper2617dcc2014-04-15 06:32:26 +0000638 .Default(nullptr);
David Blaikie03c089c2013-09-23 22:44:47 +0000639 if (!Map) {
David Blaikie427e4352013-09-23 23:39:55 +0000640 // Find debug_types relocs by section rather than name as there are
641 // multiple, comdat grouped, debug_types sections.
David Blaikie92d9d622014-01-09 05:08:24 +0000642 if (RelSecName == "debug_types")
643 Map = &TypesSections[*RelocatedSection].Relocs;
644 else if (RelSecName == "debug_types.dwo")
645 Map = &TypesDWOSections[*RelocatedSection].Relocs;
646 else
647 continue;
David Blaikie03c089c2013-09-23 22:44:47 +0000648 }
Eric Christopher7370b552012-11-12 21:40:38 +0000649
Alexey Samsonov063eb3f2014-03-13 13:52:54 +0000650 if (Section.relocation_begin() != Section.relocation_end()) {
Rafael Espindola80291272014-10-08 15:28:58 +0000651 uint64_t SectionSize = RelocatedSection->getSize();
Alexey Samsonovaa4d2952014-03-14 14:22:49 +0000652 for (const RelocationRef &Reloc : Section.relocations()) {
Eric Christopher7370b552012-11-12 21:40:38 +0000653 uint64_t Address;
Alexey Samsonovaa4d2952014-03-14 14:22:49 +0000654 Reloc.getOffset(Address);
Eric Christopher7370b552012-11-12 21:40:38 +0000655 uint64_t Type;
Alexey Samsonovaa4d2952014-03-14 14:22:49 +0000656 Reloc.getType(Type);
Andrew Kaylord55d7012013-01-25 22:50:58 +0000657 uint64_t SymAddr = 0;
David Majnemer5fbe3242014-10-08 06:38:50 +0000658 object::symbol_iterator Sym = Reloc.getSymbol();
659 if (Sym != Obj.symbol_end())
Rafael Espindola806f0062013-06-05 01:33:53 +0000660 Sym->getAddress(SymAddr);
Eric Christopher7370b552012-11-12 21:40:38 +0000661
Eric Christopher47e079d2014-10-06 06:55:55 +0000662 object::RelocVisitor V(Obj);
David Majnemer5fbe3242014-10-08 06:38:50 +0000663 object::RelocToApply R(V.visit(Type, Reloc, SymAddr));
Eric Christopher7370b552012-11-12 21:40:38 +0000664 if (V.error()) {
665 SmallString<32> Name;
Rafael Espindoladb4ed0b2014-06-13 02:24:39 +0000666 std::error_code ec(Reloc.getTypeName(Name));
Eric Christopher7370b552012-11-12 21:40:38 +0000667 if (ec) {
668 errs() << "Aaaaaa! Nameless relocation! Aaaaaa!\n";
669 }
670 errs() << "error: failed to compute relocation: "
671 << Name << "\n";
672 continue;
673 }
674
675 if (Address + R.Width > SectionSize) {
676 errs() << "error: " << R.Width << "-byte relocation starting "
677 << Address << " bytes into section " << name << " which is "
678 << SectionSize << " bytes long.\n";
679 continue;
680 }
681 if (R.Width > 8) {
682 errs() << "error: can't handle a relocation of more than 8 bytes at "
683 "a time.\n";
684 continue;
685 }
686 DEBUG(dbgs() << "Writing " << format("%p", R.Value)
687 << " at " << format("%p", Address)
688 << " with width " << format("%d", R.Width)
689 << "\n");
Eric Christopherda4b2192013-01-02 23:52:13 +0000690 Map->insert(std::make_pair(Address, std::make_pair(R.Width, R.Value)));
Eric Christopher7370b552012-11-12 21:40:38 +0000691 }
692 }
693 }
694}
695
David Blaikiea379b1812011-12-20 02:50:00 +0000696void DWARFContextInMemory::anchor() { }