blob: 42ab48808f9a45d6617d44af16df16ecf071cee0 [file] [log] [blame]
Eugene Zelenko28db7e62017-03-01 01:14:23 +00001//===- DWARFContext.cpp ---------------------------------------------------===//
Benjamin Krameraa2f78f2011-09-13 19:42:23 +00002//
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
Greg Claytonb8c162b2017-05-03 16:02:29 +000010#include "llvm/DebugInfo/DWARF/DWARFContext.h"
11#include "llvm/ADT/STLExtras.h"
Alexey Samsonove16e16a2012-07-19 07:03:58 +000012#include "llvm/ADT/SmallString.h"
Eugene Zelenko28db7e62017-03-01 01:14:23 +000013#include "llvm/ADT/SmallVector.h"
Eugene Zelenko28db7e62017-03-01 01:14:23 +000014#include "llvm/ADT/StringRef.h"
Greg Claytonb8c162b2017-05-03 16:02:29 +000015#include "llvm/ADT/StringSwitch.h"
Zachary Turner82af9432015-01-30 18:07:45 +000016#include "llvm/DebugInfo/DWARF/DWARFAcceleratorTable.h"
Eugene Zelenko28db7e62017-03-01 01:14:23 +000017#include "llvm/DebugInfo/DWARF/DWARFCompileUnit.h"
Eugene Zelenko28db7e62017-03-01 01:14:23 +000018#include "llvm/DebugInfo/DWARF/DWARFDebugAbbrev.h"
Zachary Turner82af9432015-01-30 18:07:45 +000019#include "llvm/DebugInfo/DWARF/DWARFDebugArangeSet.h"
Greg Claytonb8c162b2017-05-03 16:02:29 +000020#include "llvm/DebugInfo/DWARF/DWARFDebugAranges.h"
Eugene Zelenko28db7e62017-03-01 01:14:23 +000021#include "llvm/DebugInfo/DWARF/DWARFDebugFrame.h"
22#include "llvm/DebugInfo/DWARF/DWARFDebugLine.h"
23#include "llvm/DebugInfo/DWARF/DWARFDebugLoc.h"
24#include "llvm/DebugInfo/DWARF/DWARFDebugMacro.h"
George Rimare71e33f2016-12-17 09:10:32 +000025#include "llvm/DebugInfo/DWARF/DWARFDebugPubTable.h"
Eugene Zelenko28db7e62017-03-01 01:14:23 +000026#include "llvm/DebugInfo/DWARF/DWARFDebugRangeList.h"
27#include "llvm/DebugInfo/DWARF/DWARFDie.h"
28#include "llvm/DebugInfo/DWARF/DWARFFormValue.h"
29#include "llvm/DebugInfo/DWARF/DWARFGdbIndex.h"
30#include "llvm/DebugInfo/DWARF/DWARFSection.h"
David Blaikie65a8efe2015-11-11 19:28:21 +000031#include "llvm/DebugInfo/DWARF/DWARFUnitIndex.h"
Greg Claytonb8c162b2017-05-03 16:02:29 +000032#include "llvm/DebugInfo/DWARF/DWARFVerifier.h"
George Rimar4bf30832017-01-11 15:26:41 +000033#include "llvm/Object/Decompressor.h"
Reid Klecknerdafc5d72016-07-06 16:56:42 +000034#include "llvm/Object/MachO.h"
Eugene Zelenko28db7e62017-03-01 01:14:23 +000035#include "llvm/Object/ObjectFile.h"
Reid Klecknerdafc5d72016-07-06 16:56:42 +000036#include "llvm/Object/RelocVisitor.h"
Eugene Zelenko28db7e62017-03-01 01:14:23 +000037#include "llvm/Support/Casting.h"
38#include "llvm/Support/DataExtractor.h"
39#include "llvm/Support/Debug.h"
40#include "llvm/Support/Error.h"
Benjamin Kramer07d4b1c2011-09-15 16:57:13 +000041#include "llvm/Support/Format.h"
Eugene Zelenko28db7e62017-03-01 01:14:23 +000042#include "llvm/Support/MemoryBuffer.h"
Benjamin Kramera6002fd2011-09-14 01:09:52 +000043#include "llvm/Support/raw_ostream.h"
Benjamin Kramer2602ca62011-09-15 20:43:22 +000044#include <algorithm>
Eugene Zelenko28db7e62017-03-01 01:14:23 +000045#include <cstdint>
Greg Claytonc7695a82017-05-02 20:28:33 +000046#include <map>
47#include <set>
Eugene Zelenko28db7e62017-03-01 01:14:23 +000048#include <string>
49#include <utility>
50#include <vector>
51
Benjamin Krameraa2f78f2011-09-13 19:42:23 +000052using namespace llvm;
Benjamin Kramer6dda0322011-09-15 18:02:20 +000053using namespace dwarf;
Rafael Espindola4f60a382013-05-30 03:05:14 +000054using namespace object;
Benjamin Krameraa2f78f2011-09-13 19:42:23 +000055
Chandler Carruthe96dd892014-04-21 22:55:11 +000056#define DEBUG_TYPE "dwarf"
57
Eric Christopher494109b2012-10-16 23:46:25 +000058typedef DWARFDebugLine::LineTable DWARFLineTable;
Alexey Samsonovdce67342014-05-15 21:24:32 +000059typedef DILineInfoSpecifier::FileLineInfoKind FileLineInfoKind;
60typedef DILineInfoSpecifier::FunctionNameKind FunctionNameKind;
Eric Christopher494109b2012-10-16 23:46:25 +000061
George Rimarf8a96422017-04-21 09:12:18 +000062uint64_t llvm::getRelocatedValue(const DataExtractor &Data, uint32_t Size,
George Rimara25d3292017-05-27 18:10:23 +000063 uint32_t *Off, const RelocAddrMap *Relocs,
64 uint64_t *SectionIndex) {
George Rimarf8a96422017-04-21 09:12:18 +000065 if (!Relocs)
66 return Data.getUnsigned(Off, Size);
67 RelocAddrMap::const_iterator AI = Relocs->find(*Off);
68 if (AI == Relocs->end())
69 return Data.getUnsigned(Off, Size);
George Rimara25d3292017-05-27 18:10:23 +000070 if (SectionIndex)
71 *SectionIndex = AI->second.SectionIndex;
George Rimar41e65672017-05-16 14:05:45 +000072 return Data.getUnsigned(Off, Size) + AI->second.Value;
George Rimarf8a96422017-04-21 09:12:18 +000073}
74
Frederic Riss7c500472014-11-14 19:30:08 +000075static void dumpAccelSection(raw_ostream &OS, StringRef Name,
76 const DWARFSection& Section, StringRef StringSection,
77 bool LittleEndian) {
78 DataExtractor AccelSection(Section.Data, LittleEndian, 0);
Frederic Risse837ec22014-11-14 16:15:53 +000079 DataExtractor StrData(StringSection, LittleEndian, 0);
80 OS << "\n." << Name << " contents:\n";
Frederic Riss7c500472014-11-14 19:30:08 +000081 DWARFAcceleratorTable Accel(AccelSection, StrData, Section.Relocs);
Frederic Risse837ec22014-11-14 16:15:53 +000082 if (!Accel.extract())
83 return;
84 Accel.dump(OS);
85}
86
Wolfgang Pieb77d3e932017-06-06 01:22:34 +000087static void
88dumpDWARFv5StringOffsetsSection(raw_ostream &OS, StringRef SectionName,
89 const DWARFSection &StringOffsetsSection,
90 StringRef StringSection, bool LittleEndian) {
91 DataExtractor StrOffsetExt(StringOffsetsSection.Data, LittleEndian, 0);
92 uint32_t Offset = 0;
93 uint64_t SectionSize = StringOffsetsSection.Data.size();
94
95 while (Offset < SectionSize) {
96 unsigned Version = 0;
97 DwarfFormat Format = DWARF32;
98 unsigned EntrySize = 4;
99 // Perform validation and extract the segment size from the header.
100 if (!StrOffsetExt.isValidOffsetForDataOfSize(Offset, 4)) {
101 OS << "error: invalid contribution to string offsets table in section ."
102 << SectionName << ".\n";
103 return;
104 }
105 uint32_t ContributionStart = Offset;
106 uint64_t ContributionSize = StrOffsetExt.getU32(&Offset);
107 // A contribution size of 0xffffffff indicates DWARF64, with the actual size
108 // in the following 8 bytes. Otherwise, the DWARF standard mandates that
109 // the contribution size must be at most 0xfffffff0.
110 if (ContributionSize == 0xffffffff) {
111 if (!StrOffsetExt.isValidOffsetForDataOfSize(Offset, 8)) {
112 OS << "error: invalid contribution to string offsets table in section ."
113 << SectionName << ".\n";
114 return;
115 }
116 Format = DWARF64;
117 EntrySize = 8;
118 ContributionSize = StrOffsetExt.getU64(&Offset);
119 } else if (ContributionSize > 0xfffffff0) {
120 OS << "error: invalid contribution to string offsets table in section ."
121 << SectionName << ".\n";
122 return;
123 }
124
125 // We must ensure that we don't read a partial record at the end, so we
126 // validate for a multiple of EntrySize. Also, we're expecting a version
127 // number and padding, which adds an additional 4 bytes.
128 uint64_t ValidationSize =
129 4 + ((ContributionSize + EntrySize - 1) & (-(uint64_t)EntrySize));
130 if (!StrOffsetExt.isValidOffsetForDataOfSize(Offset, ValidationSize)) {
131 OS << "error: contribution to string offsets table in section ."
132 << SectionName << " has invalid length.\n";
133 return;
134 }
135
136 Version = StrOffsetExt.getU16(&Offset);
137 Offset += 2;
138 OS << format("0x%8.8x: ", ContributionStart);
139 OS << "Contribution size = " << ContributionSize
140 << ", Version = " << Version << "\n";
141
142 uint32_t ContributionBase = Offset;
143 DataExtractor StrData(StringSection, LittleEndian, 0);
144 while (Offset - ContributionBase < ContributionSize) {
145 OS << format("0x%8.8x: ", Offset);
146 // FIXME: We can only extract strings in DWARF32 format at the moment.
147 uint64_t StringOffset = getRelocatedValue(
148 StrOffsetExt, EntrySize, &Offset, &StringOffsetsSection.Relocs);
149 if (Format == DWARF32) {
150 OS << format("%8.8x ", StringOffset);
151 uint32_t StringOffset32 = (uint32_t)StringOffset;
152 const char *S = StrData.getCStr(&StringOffset32);
153 if (S)
154 OS << format("\"%s\"", S);
155 } else
156 OS << format("%16.16x ", StringOffset);
157 OS << "\n";
158 }
159 }
160}
161
162// Dump a DWARF string offsets section. This may be a DWARF v5 formatted
163// string offsets section, where each compile or type unit contributes a
164// number of entries (string offsets), with each contribution preceded by
165// a header containing size and version number. Alternatively, it may be a
166// monolithic series of string offsets, as generated by the pre-DWARF v5
167// implementation of split DWARF.
168static void dumpStringOffsetsSection(raw_ostream &OS, StringRef SectionName,
169 const DWARFSection &StringOffsetsSection,
170 StringRef StringSection, bool LittleEndian,
171 unsigned MaxVersion) {
172 if (StringOffsetsSection.Data.empty())
173 return;
174 OS << "\n." << SectionName << " contents:\n";
175 // If we have at least one (compile or type) unit with DWARF v5 or greater,
176 // we assume that the section is formatted like a DWARF v5 string offsets
177 // section.
178 if (MaxVersion >= 5)
179 dumpDWARFv5StringOffsetsSection(OS, SectionName, StringOffsetsSection,
180 StringSection, LittleEndian);
181 else {
182 DataExtractor strOffsetExt(StringOffsetsSection.Data, LittleEndian, 0);
183 uint32_t offset = 0;
184 uint64_t size = StringOffsetsSection.Data.size();
185 // Ensure that size is a multiple of the size of an entry.
186 if (size & ((uint64_t)(sizeof(uint32_t) - 1))) {
187 OS << "error: size of ." << SectionName << " is not a multiple of "
188 << sizeof(uint32_t) << ".\n";
189 size &= -(uint64_t)sizeof(uint32_t);
190 }
191 DataExtractor StrData(StringSection, LittleEndian, 0);
192 while (offset < size) {
193 OS << format("0x%8.8x: ", offset);
194 uint32_t StringOffset = strOffsetExt.getU32(&offset);
195 OS << format("%8.8x ", StringOffset);
196 const char *S = StrData.getCStr(&StringOffset);
197 if (S)
198 OS << format("\"%s\"", S);
199 OS << "\n";
200 }
201 }
202}
203
Adrian Prantlf4bc1f72017-06-01 18:18:23 +0000204void DWARFContext::dump(raw_ostream &OS, DIDumpOptions DumpOpts){
205
206 DIDumpType DumpType = DumpOpts.DumpType;
207 bool DumpEH = DumpOpts.DumpEH;
208 bool SummarizeTypes = DumpOpts.SummarizeTypes;
209
Eli Bendersky7a94daa2013-01-25 20:26:43 +0000210 if (DumpType == DIDT_All || DumpType == DIDT_Abbrev) {
211 OS << ".debug_abbrev contents:\n";
212 getDebugAbbrev()->dump(OS);
213 }
Benjamin Kramera6002fd2011-09-14 01:09:52 +0000214
David Blaikie66865d62014-01-09 00:13:35 +0000215 if (DumpType == DIDT_All || DumpType == DIDT_AbbrevDwo)
216 if (const DWARFDebugAbbrev *D = getDebugAbbrevDWO()) {
David Blaikie622dce42014-01-08 23:29:59 +0000217 OS << "\n.debug_abbrev.dwo contents:\n";
David Blaikie66865d62014-01-09 00:13:35 +0000218 D->dump(OS);
David Blaikie622dce42014-01-08 23:29:59 +0000219 }
David Blaikie622dce42014-01-08 23:29:59 +0000220
Eli Bendersky7a94daa2013-01-25 20:26:43 +0000221 if (DumpType == DIDT_All || DumpType == DIDT_Info) {
222 OS << "\n.debug_info contents:\n";
Alexey Samsonov1eabf982014-03-13 07:52:54 +0000223 for (const auto &CU : compile_units())
Adrian Prantl318d1192017-06-06 23:28:45 +0000224 CU->dump(OS, DumpOpts);
Eli Bendersky7a94daa2013-01-25 20:26:43 +0000225 }
Benjamin Kramera6002fd2011-09-14 01:09:52 +0000226
David Blaikie66865d62014-01-09 00:13:35 +0000227 if ((DumpType == DIDT_All || DumpType == DIDT_InfoDwo) &&
228 getNumDWOCompileUnits()) {
229 OS << "\n.debug_info.dwo contents:\n";
Alexey Samsonov1eabf982014-03-13 07:52:54 +0000230 for (const auto &DWOCU : dwo_compile_units())
Adrian Prantl318d1192017-06-06 23:28:45 +0000231 DWOCU->dump(OS, DumpOpts);
David Blaikie66865d62014-01-09 00:13:35 +0000232 }
David Blaikie622dce42014-01-08 23:29:59 +0000233
David Blaikie66865d62014-01-09 00:13:35 +0000234 if ((DumpType == DIDT_All || DumpType == DIDT_Types) && getNumTypeUnits()) {
David Blaikie03c089c2013-09-23 22:44:47 +0000235 OS << "\n.debug_types contents:\n";
Frederic Riss312a02e2014-09-29 13:56:39 +0000236 for (const auto &TUS : type_unit_sections())
237 for (const auto &TU : TUS)
David Blaikie50cc27e2016-10-18 21:09:48 +0000238 TU->dump(OS, SummarizeTypes);
David Blaikie03c089c2013-09-23 22:44:47 +0000239 }
240
Alexey Samsonov1eabf982014-03-13 07:52:54 +0000241 if ((DumpType == DIDT_All || DumpType == DIDT_TypesDwo) &&
242 getNumDWOTypeUnits()) {
243 OS << "\n.debug_types.dwo contents:\n";
Frederic Riss312a02e2014-09-29 13:56:39 +0000244 for (const auto &DWOTUS : dwo_type_unit_sections())
245 for (const auto &DWOTU : DWOTUS)
David Blaikie50cc27e2016-10-18 21:09:48 +0000246 DWOTU->dump(OS, SummarizeTypes);
Alexey Samsonov1eabf982014-03-13 07:52:54 +0000247 }
David Blaikie92d9d622014-01-09 05:08:24 +0000248
David Blaikie18e73502013-06-19 21:37:13 +0000249 if (DumpType == DIDT_All || DumpType == DIDT_Loc) {
David Blaikie03c089c2013-09-23 22:44:47 +0000250 OS << "\n.debug_loc contents:\n";
David Blaikie18e73502013-06-19 21:37:13 +0000251 getDebugLoc()->dump(OS);
252 }
253
David Blaikie9c550ac2014-03-25 01:44:02 +0000254 if (DumpType == DIDT_All || DumpType == DIDT_LocDwo) {
255 OS << "\n.debug_loc.dwo contents:\n";
256 getDebugLocDWO()->dump(OS);
257 }
258
Eli Benderskyfd08bc12013-02-05 23:30:58 +0000259 if (DumpType == DIDT_All || DumpType == DIDT_Frames) {
260 OS << "\n.debug_frame contents:\n";
261 getDebugFrame()->dump(OS);
Igor Laevsky03a670c2016-01-26 15:09:42 +0000262 if (DumpEH) {
263 OS << "\n.eh_frame contents:\n";
264 getEHFrame()->dump(OS);
265 }
Eli Benderskyfd08bc12013-02-05 23:30:58 +0000266 }
267
Amjad Aboude59cc3e2015-11-12 09:38:54 +0000268 if (DumpType == DIDT_All || DumpType == DIDT_Macro) {
269 OS << "\n.debug_macinfo contents:\n";
270 getDebugMacro()->dump(OS);
271 }
272
Benjamin Kramera6002fd2011-09-14 01:09:52 +0000273 uint32_t offset = 0;
Eli Bendersky7a94daa2013-01-25 20:26:43 +0000274 if (DumpType == DIDT_All || DumpType == DIDT_Aranges) {
275 OS << "\n.debug_aranges contents:\n";
276 DataExtractor arangesData(getARangeSection(), isLittleEndian(), 0);
277 DWARFDebugArangeSet set;
278 while (set.extract(arangesData, &offset))
279 set.dump(OS);
280 }
Benjamin Kramer5acab502011-09-15 02:12:05 +0000281
Alexey Samsonov034e57a2012-08-27 07:17:47 +0000282 uint8_t savedAddressByteSize = 0;
Eli Bendersky7a94daa2013-01-25 20:26:43 +0000283 if (DumpType == DIDT_All || DumpType == DIDT_Line) {
284 OS << "\n.debug_line contents:\n";
Alexey Samsonov1eabf982014-03-13 07:52:54 +0000285 for (const auto &CU : compile_units()) {
286 savedAddressByteSize = CU->getAddressByteSize();
Greg Claytonc8c10322016-12-13 18:25:19 +0000287 auto CUDIE = CU->getUnitDIE();
288 if (!CUDIE)
Alexey Samsonov7a18c062015-05-19 21:54:32 +0000289 continue;
Greg Clayton97d22182017-01-13 21:08:18 +0000290 if (auto StmtOffset = toSectionOffset(CUDIE.find(DW_AT_stmt_list))) {
David Blaikie1b5ee5d2013-09-23 17:42:01 +0000291 DataExtractor lineData(getLineSection().Data, isLittleEndian(),
Eli Bendersky7a94daa2013-01-25 20:26:43 +0000292 savedAddressByteSize);
Alexey Samsonov110d5952014-04-30 00:09:19 +0000293 DWARFDebugLine::LineTable LineTable;
Greg Clayton52fe1f62016-12-14 22:38:08 +0000294 uint32_t Offset = *StmtOffset;
295 LineTable.parse(lineData, &getLineSection().Relocs, &Offset);
Alexey Samsonov110d5952014-04-30 00:09:19 +0000296 LineTable.dump(OS);
Eli Bendersky7a94daa2013-01-25 20:26:43 +0000297 }
Benjamin Kramer6dda0322011-09-15 18:02:20 +0000298 }
299 }
Benjamin Kramer07d4b1c2011-09-15 16:57:13 +0000300
David Blaikie65a8efe2015-11-11 19:28:21 +0000301 if (DumpType == DIDT_All || DumpType == DIDT_CUIndex) {
302 OS << "\n.debug_cu_index contents:\n";
David Blaikieb073cb92015-12-02 06:21:34 +0000303 getCUIndex().dump(OS);
David Blaikie65a8efe2015-11-11 19:28:21 +0000304 }
305
David Blaikie51c40282015-11-11 19:40:49 +0000306 if (DumpType == DIDT_All || DumpType == DIDT_TUIndex) {
307 OS << "\n.debug_tu_index contents:\n";
David Blaikieb073cb92015-12-02 06:21:34 +0000308 getTUIndex().dump(OS);
David Blaikie51c40282015-11-11 19:40:49 +0000309 }
310
David Blaikie1d4736e2014-02-24 23:58:54 +0000311 if (DumpType == DIDT_All || DumpType == DIDT_LineDwo) {
312 OS << "\n.debug_line.dwo contents:\n";
313 unsigned stmtOffset = 0;
314 DataExtractor lineData(getLineDWOSection().Data, isLittleEndian(),
315 savedAddressByteSize);
Alexey Samsonov110d5952014-04-30 00:09:19 +0000316 DWARFDebugLine::LineTable LineTable;
317 while (LineTable.Prologue.parse(lineData, &stmtOffset)) {
318 LineTable.dump(OS);
319 LineTable.clear();
320 }
David Blaikie1d4736e2014-02-24 23:58:54 +0000321 }
322
Eli Bendersky7a94daa2013-01-25 20:26:43 +0000323 if (DumpType == DIDT_All || DumpType == DIDT_Str) {
324 OS << "\n.debug_str contents:\n";
325 DataExtractor strData(getStringSection(), isLittleEndian(), 0);
326 offset = 0;
327 uint32_t strOffset = 0;
328 while (const char *s = strData.getCStr(&offset)) {
329 OS << format("0x%8.8x: \"%s\"\n", strOffset, s);
330 strOffset = offset;
331 }
Benjamin Kramer07d4b1c2011-09-15 16:57:13 +0000332 }
Alexey Samsonov034e57a2012-08-27 07:17:47 +0000333
David Blaikie66865d62014-01-09 00:13:35 +0000334 if ((DumpType == DIDT_All || DumpType == DIDT_StrDwo) &&
335 !getStringDWOSection().empty()) {
336 OS << "\n.debug_str.dwo contents:\n";
337 DataExtractor strDWOData(getStringDWOSection(), isLittleEndian(), 0);
338 offset = 0;
339 uint32_t strDWOOffset = 0;
340 while (const char *s = strDWOData.getCStr(&offset)) {
341 OS << format("0x%8.8x: \"%s\"\n", strDWOOffset, s);
342 strDWOOffset = offset;
David Blaikie622dce42014-01-08 23:29:59 +0000343 }
David Blaikie66865d62014-01-09 00:13:35 +0000344 }
David Blaikie622dce42014-01-08 23:29:59 +0000345
Eli Bendersky7a94daa2013-01-25 20:26:43 +0000346 if (DumpType == DIDT_All || DumpType == DIDT_Ranges) {
347 OS << "\n.debug_ranges contents:\n";
348 // In fact, different compile units may have different address byte
349 // sizes, but for simplicity we just use the address byte size of the last
350 // compile unit (there is no easy and fast way to associate address range
351 // list and the compile unit it describes).
George Rimarca532112017-04-24 10:19:45 +0000352 DataExtractor rangesData(getRangeSection().Data, isLittleEndian(),
Eli Bendersky7a94daa2013-01-25 20:26:43 +0000353 savedAddressByteSize);
354 offset = 0;
355 DWARFDebugRangeList rangeList;
George Rimarca532112017-04-24 10:19:45 +0000356 while (rangeList.extract(rangesData, &offset, getRangeSection().Relocs))
Eli Bendersky7a94daa2013-01-25 20:26:43 +0000357 rangeList.dump(OS);
Eric Christopherda4b2192013-01-02 23:52:13 +0000358 }
Eric Christopher962c9082013-01-15 23:56:56 +0000359
Eric Christopher0de53592013-09-25 23:02:36 +0000360 if (DumpType == DIDT_All || DumpType == DIDT_Pubnames)
George Rimare71e33f2016-12-17 09:10:32 +0000361 DWARFDebugPubTable(getPubNamesSection(), isLittleEndian(), false)
362 .dump("debug_pubnames", OS);
Krzysztof Parzyszek97438dc2013-02-12 16:20:28 +0000363
Eric Christopher4c7e6ba2013-09-25 23:02:41 +0000364 if (DumpType == DIDT_All || DumpType == DIDT_Pubtypes)
George Rimare71e33f2016-12-17 09:10:32 +0000365 DWARFDebugPubTable(getPubTypesSection(), isLittleEndian(), false)
366 .dump("debug_pubtypes", OS);
Eric Christopher4c7e6ba2013-09-25 23:02:41 +0000367
David Blaikieecd21ff2013-09-24 19:50:00 +0000368 if (DumpType == DIDT_All || DumpType == DIDT_GnuPubnames)
George Rimare71e33f2016-12-17 09:10:32 +0000369 DWARFDebugPubTable(getGnuPubNamesSection(), isLittleEndian(),
370 true /* GnuStyle */)
371 .dump("debug_gnu_pubnames", OS);
David Blaikieecd21ff2013-09-24 19:50:00 +0000372
373 if (DumpType == DIDT_All || DumpType == DIDT_GnuPubtypes)
George Rimare71e33f2016-12-17 09:10:32 +0000374 DWARFDebugPubTable(getGnuPubTypesSection(), isLittleEndian(),
375 true /* GnuStyle */)
376 .dump("debug_gnu_pubtypes", OS);
David Blaikie404d3042013-09-19 23:01:29 +0000377
Wolfgang Pieb77d3e932017-06-06 01:22:34 +0000378 if (DumpType == DIDT_All || DumpType == DIDT_StrOffsets)
379 dumpStringOffsetsSection(OS, "debug_str_offsets", getStringOffsetSection(),
380 getStringSection(), isLittleEndian(),
381 getMaxVersion());
382
383 if (DumpType == DIDT_All || DumpType == DIDT_StrOffsetsDwo) {
384 dumpStringOffsetsSection(OS, "debug_str_offsets.dwo",
385 getStringOffsetDWOSection(), getStringDWOSection(),
386 isLittleEndian(), getMaxVersion());
David Blaikie66865d62014-01-09 00:13:35 +0000387 }
Frederic Risse837ec22014-11-14 16:15:53 +0000388
George Rimar4f82df52016-09-23 11:01:53 +0000389 if ((DumpType == DIDT_All || DumpType == DIDT_GdbIndex) &&
390 !getGdbIndexSection().empty()) {
391 OS << "\n.gnu_index contents:\n";
392 getGdbIndex().dump(OS);
393 }
394
Frederic Risse837ec22014-11-14 16:15:53 +0000395 if (DumpType == DIDT_All || DumpType == DIDT_AppleNames)
396 dumpAccelSection(OS, "apple_names", getAppleNamesSection(),
397 getStringSection(), isLittleEndian());
398
399 if (DumpType == DIDT_All || DumpType == DIDT_AppleTypes)
400 dumpAccelSection(OS, "apple_types", getAppleTypesSection(),
401 getStringSection(), isLittleEndian());
402
403 if (DumpType == DIDT_All || DumpType == DIDT_AppleNamespaces)
404 dumpAccelSection(OS, "apple_namespaces", getAppleNamespacesSection(),
405 getStringSection(), isLittleEndian());
406
407 if (DumpType == DIDT_All || DumpType == DIDT_AppleObjC)
408 dumpAccelSection(OS, "apple_objc", getAppleObjCSection(),
409 getStringSection(), isLittleEndian());
Benjamin Krameraa2f78f2011-09-13 19:42:23 +0000410}
411
David Blaikie15d85fc2017-05-23 06:48:53 +0000412DWARFCompileUnit *DWARFContext::getDWOCompileUnitForHash(uint64_t Hash) {
413 // FIXME: Improve this for the case where this DWO file is really a DWP file
414 // with an index - use the index for lookup instead of a linear search.
415 for (const auto &DWOCU : dwo_compile_units())
416 if (DWOCU->getDWOId() == Hash)
417 return DWOCU.get();
418 return nullptr;
419}
420
Greg Claytonc7695a82017-05-02 20:28:33 +0000421DWARFDie DWARFContext::getDIEForOffset(uint32_t Offset) {
422 parseCompileUnits();
423 if (auto *CU = CUs.getUnitForOffset(Offset))
424 return CU->getDIEForOffset(Offset);
425 return DWARFDie();
426}
427
428namespace {
429
430class Verifier {
431 raw_ostream &OS;
432 DWARFContext &DCtx;
433public:
434 Verifier(raw_ostream &S, DWARFContext &D) : OS(S), DCtx(D) {}
435
436 bool HandleDebugInfo() {
437 bool Success = true;
438 // A map that tracks all references (converted absolute references) so we
439 // can verify each reference points to a valid DIE and not an offset that
440 // lies between to valid DIEs.
441 std::map<uint64_t, std::set<uint32_t>> ReferenceToDIEOffsets;
442
Greg Clayton48432cf2017-05-01 22:07:02 +0000443 OS << "Verifying .debug_info...\n";
Greg Claytonc7695a82017-05-02 20:28:33 +0000444 for (const auto &CU : DCtx.compile_units()) {
Greg Clayton48432cf2017-05-01 22:07:02 +0000445 unsigned NumDies = CU->getNumDIEs();
446 for (unsigned I = 0; I < NumDies; ++I) {
447 auto Die = CU->getDIEAtIndex(I);
448 const auto Tag = Die.getTag();
449 if (Tag == DW_TAG_null)
450 continue;
451 for (auto AttrValue : Die.attributes()) {
452 const auto Attr = AttrValue.Attr;
453 const auto Form = AttrValue.Value.getForm();
454 switch (Attr) {
Greg Claytonc7695a82017-05-02 20:28:33 +0000455 case DW_AT_ranges:
456 // Make sure the offset in the DW_AT_ranges attribute is valid.
457 if (auto SectionOffset = AttrValue.Value.getAsSectionOffset()) {
458 if (*SectionOffset >= DCtx.getRangeSection().Data.size()) {
459 Success = false;
460 OS << "error: DW_AT_ranges offset is beyond .debug_ranges "
461 "bounds:\n";
462 Die.dump(OS, 0);
463 OS << "\n";
464 }
465 } else {
Greg Clayton48432cf2017-05-01 22:07:02 +0000466 Success = false;
Greg Claytonc7695a82017-05-02 20:28:33 +0000467 OS << "error: DIE has invalid DW_AT_ranges encoding:\n";
Greg Clayton48432cf2017-05-01 22:07:02 +0000468 Die.dump(OS, 0);
469 OS << "\n";
470 }
Greg Claytonc7695a82017-05-02 20:28:33 +0000471 break;
472 case DW_AT_stmt_list:
473 // Make sure the offset in the DW_AT_stmt_list attribute is valid.
474 if (auto SectionOffset = AttrValue.Value.getAsSectionOffset()) {
475 if (*SectionOffset >= DCtx.getLineSection().Data.size()) {
476 Success = false;
477 OS << "error: DW_AT_stmt_list offset is beyond .debug_line "
478 "bounds: "
479 << format("0x%08" PRIx32, *SectionOffset) << "\n";
480 CU->getUnitDIE().dump(OS, 0);
481 OS << "\n";
482 }
483 } else {
Greg Clayton48432cf2017-05-01 22:07:02 +0000484 Success = false;
Greg Claytonc7695a82017-05-02 20:28:33 +0000485 OS << "error: DIE has invalid DW_AT_stmt_list encoding:\n";
486 Die.dump(OS, 0);
Greg Clayton48432cf2017-05-01 22:07:02 +0000487 OS << "\n";
488 }
Greg Claytonc7695a82017-05-02 20:28:33 +0000489 break;
490
491 default:
492 break;
Greg Clayton48432cf2017-05-01 22:07:02 +0000493 }
494 switch (Form) {
Greg Claytonc7695a82017-05-02 20:28:33 +0000495 case DW_FORM_ref1:
496 case DW_FORM_ref2:
497 case DW_FORM_ref4:
498 case DW_FORM_ref8:
499 case DW_FORM_ref_udata: {
500 // Verify all CU relative references are valid CU offsets.
501 Optional<uint64_t> RefVal = AttrValue.Value.getAsReference();
502 assert(RefVal);
503 if (RefVal) {
504 auto DieCU = Die.getDwarfUnit();
505 auto CUSize = DieCU->getNextUnitOffset() - DieCU->getOffset();
506 auto CUOffset = AttrValue.Value.getRawUValue();
507 if (CUOffset >= CUSize) {
508 Success = false;
509 OS << "error: " << FormEncodingString(Form) << " CU offset "
510 << format("0x%08" PRIx32, CUOffset)
511 << " is invalid (must be less than CU size of "
512 << format("0x%08" PRIx32, CUSize) << "):\n";
513 Die.dump(OS, 0);
514 OS << "\n";
515 } else {
516 // Valid reference, but we will verify it points to an actual
517 // DIE later.
518 ReferenceToDIEOffsets[*RefVal].insert(Die.getOffset());
519 }
520 }
521 break;
522 }
523 case DW_FORM_ref_addr: {
524 // Verify all absolute DIE references have valid offsets in the
525 // .debug_info section.
526 Optional<uint64_t> RefVal = AttrValue.Value.getAsReference();
527 assert(RefVal);
528 if (RefVal) {
529 if(*RefVal >= DCtx.getInfoSection().Data.size()) {
530 Success = false;
531 OS << "error: DW_FORM_ref_addr offset beyond .debug_info "
532 "bounds:\n";
533 Die.dump(OS, 0);
534 OS << "\n";
535 } else {
536 // Valid reference, but we will verify it points to an actual
537 // DIE later.
538 ReferenceToDIEOffsets[*RefVal].insert(Die.getOffset());
539 }
540 }
541 break;
542 }
543 case DW_FORM_strp: {
544 auto SecOffset = AttrValue.Value.getAsSectionOffset();
545 assert(SecOffset); // DW_FORM_strp is a section offset.
546 if (SecOffset && *SecOffset >= DCtx.getStringSection().size()) {
Greg Clayton48432cf2017-05-01 22:07:02 +0000547 Success = false;
Greg Claytonc7695a82017-05-02 20:28:33 +0000548 OS << "error: DW_FORM_strp offset beyond .debug_str bounds:\n";
Greg Clayton48432cf2017-05-01 22:07:02 +0000549 Die.dump(OS, 0);
550 OS << "\n";
551 }
Greg Claytonc7695a82017-05-02 20:28:33 +0000552 break;
Greg Clayton48432cf2017-05-01 22:07:02 +0000553 }
Greg Claytonc7695a82017-05-02 20:28:33 +0000554 default:
555 break;
Greg Clayton48432cf2017-05-01 22:07:02 +0000556 }
557 }
558 }
559 }
Greg Claytonc7695a82017-05-02 20:28:33 +0000560
561 // Take all references and make sure they point to an actual DIE by
562 // getting the DIE by offset and emitting an error
563 OS << "Verifying .debug_info references...\n";
564 for (auto Pair: ReferenceToDIEOffsets) {
565 auto Die = DCtx.getDIEForOffset(Pair.first);
566 if (Die)
567 continue;
568 Success = false;
569 OS << "error: invalid DIE reference " << format("0x%08" PRIx64, Pair.first)
570 << ". Offset is in between DIEs:\n";
571 for (auto Offset: Pair.second) {
572 auto ReferencingDie = DCtx.getDIEForOffset(Offset);
573 ReferencingDie.dump(OS, 0);
574 OS << "\n";
575 }
576 OS << "\n";
577 }
578 return Success;
579 }
Greg Clayton67070462017-05-02 22:48:52 +0000580
581 bool HandleDebugLine() {
Greg Clayton8df55b42017-05-03 15:45:31 +0000582 std::map<uint64_t, DWARFDie> StmtListToDie;
Greg Clayton67070462017-05-02 22:48:52 +0000583 bool Success = true;
584 OS << "Verifying .debug_line...\n";
585 for (const auto &CU : DCtx.compile_units()) {
586 uint32_t LineTableOffset = 0;
Greg Clayton8df55b42017-05-03 15:45:31 +0000587 auto CUDie = CU->getUnitDIE();
588 auto StmtFormValue = CUDie.find(DW_AT_stmt_list);
Greg Clayton67070462017-05-02 22:48:52 +0000589 if (!StmtFormValue) {
590 // No line table for this compile unit.
591 continue;
592 }
593 // Get the attribute value as a section offset. No need to produce an
594 // error here if the encoding isn't correct because we validate this in
595 // the .debug_info verifier.
596 if (auto StmtSectionOffset = toSectionOffset(StmtFormValue)) {
597 LineTableOffset = *StmtSectionOffset;
598 if (LineTableOffset >= DCtx.getLineSection().Data.size()) {
599 // Make sure we don't get a valid line table back if the offset
600 // is wrong.
601 assert(DCtx.getLineTableForUnit(CU.get()) == nullptr);
602 // Skip this line table as it isn't valid. No need to create an error
603 // here because we validate this in the .debug_info verifier.
604 continue;
Greg Clayton8df55b42017-05-03 15:45:31 +0000605 } else {
606 auto Iter = StmtListToDie.find(LineTableOffset);
607 if (Iter != StmtListToDie.end()) {
608 Success = false;
609 OS << "error: two compile unit DIEs, "
610 << format("0x%08" PRIx32, Iter->second.getOffset()) << " and "
611 << format("0x%08" PRIx32, CUDie.getOffset())
612 << ", have the same DW_AT_stmt_list section offset:\n";
613 Iter->second.dump(OS, 0);
614 CUDie.dump(OS, 0);
615 OS << '\n';
616 // Already verified this line table before, no need to do it again.
617 continue;
618 }
619 StmtListToDie[LineTableOffset] = CUDie;
Greg Clayton67070462017-05-02 22:48:52 +0000620 }
621 }
622 auto LineTable = DCtx.getLineTableForUnit(CU.get());
623 if (!LineTable) {
624 Success = false;
625 OS << "error: .debug_line[" << format("0x%08" PRIx32, LineTableOffset)
626 << "] was not able to be parsed for CU:\n";
Greg Clayton8df55b42017-05-03 15:45:31 +0000627 CUDie.dump(OS, 0);
Greg Clayton67070462017-05-02 22:48:52 +0000628 OS << '\n';
629 continue;
630 }
631 uint32_t MaxFileIndex = LineTable->Prologue.FileNames.size();
632 uint64_t PrevAddress = 0;
633 uint32_t RowIndex = 0;
634 for (const auto &Row : LineTable->Rows) {
635 if (Row.Address < PrevAddress) {
636 Success = false;
637 OS << "error: .debug_line[" << format("0x%08" PRIx32, LineTableOffset)
638 << "] row[" << RowIndex
639 << "] decreases in address from previous row:\n";
640
641 DWARFDebugLine::Row::dumpTableHeader(OS);
642 if (RowIndex > 0)
643 LineTable->Rows[RowIndex - 1].dump(OS);
644 Row.dump(OS);
645 OS << '\n';
646 }
647
648 if (Row.File > MaxFileIndex) {
649 Success = false;
650 OS << "error: .debug_line[" << format("0x%08" PRIx32, LineTableOffset)
651 << "][" << RowIndex << "] has invalid file index " << Row.File
652 << " (valid values are [1," << MaxFileIndex << "]):\n";
653 DWARFDebugLine::Row::dumpTableHeader(OS);
654 Row.dump(OS);
655 OS << '\n';
656 }
657 if (Row.EndSequence)
658 PrevAddress = 0;
659 else
660 PrevAddress = Row.Address;
661 ++RowIndex;
662 }
663 }
664 return Success;
665 }
Greg Claytonc7695a82017-05-02 20:28:33 +0000666};
667
668} // anonymous namespace
669
670bool DWARFContext::verify(raw_ostream &OS, DIDumpType DumpType) {
671 bool Success = true;
Greg Claytonb8c162b2017-05-03 16:02:29 +0000672 DWARFVerifier verifier(OS, *this);
Greg Claytonc7695a82017-05-02 20:28:33 +0000673 if (DumpType == DIDT_All || DumpType == DIDT_Info) {
Greg Claytonb8c162b2017-05-03 16:02:29 +0000674 if (!verifier.handleDebugInfo())
Greg Claytonc7695a82017-05-02 20:28:33 +0000675 Success = false;
Greg Clayton48432cf2017-05-01 22:07:02 +0000676 }
Greg Clayton67070462017-05-02 22:48:52 +0000677 if (DumpType == DIDT_All || DumpType == DIDT_Line) {
Greg Claytonb8c162b2017-05-03 16:02:29 +0000678 if (!verifier.handleDebugLine())
Greg Clayton67070462017-05-02 22:48:52 +0000679 Success = false;
680 }
Greg Clayton48432cf2017-05-01 22:07:02 +0000681 return Success;
682}
David Blaikie82641be2015-11-17 00:39:55 +0000683const DWARFUnitIndex &DWARFContext::getCUIndex() {
684 if (CUIndex)
685 return *CUIndex;
686
687 DataExtractor CUIndexData(getCUIndexSection(), isLittleEndian(), 0);
688
David Blaikieb073cb92015-12-02 06:21:34 +0000689 CUIndex = llvm::make_unique<DWARFUnitIndex>(DW_SECT_INFO);
David Blaikie82641be2015-11-17 00:39:55 +0000690 CUIndex->parse(CUIndexData);
691 return *CUIndex;
692}
693
694const DWARFUnitIndex &DWARFContext::getTUIndex() {
695 if (TUIndex)
696 return *TUIndex;
697
698 DataExtractor TUIndexData(getTUIndexSection(), isLittleEndian(), 0);
699
David Blaikieb073cb92015-12-02 06:21:34 +0000700 TUIndex = llvm::make_unique<DWARFUnitIndex>(DW_SECT_TYPES);
David Blaikie82641be2015-11-17 00:39:55 +0000701 TUIndex->parse(TUIndexData);
702 return *TUIndex;
703}
704
George Rimar4f82df52016-09-23 11:01:53 +0000705DWARFGdbIndex &DWARFContext::getGdbIndex() {
706 if (GdbIndex)
707 return *GdbIndex;
708
709 DataExtractor GdbIndexData(getGdbIndexSection(), true /*LE*/, 0);
710 GdbIndex = llvm::make_unique<DWARFGdbIndex>();
711 GdbIndex->parse(GdbIndexData);
712 return *GdbIndex;
713}
714
Benjamin Krameraa2f78f2011-09-13 19:42:23 +0000715const DWARFDebugAbbrev *DWARFContext::getDebugAbbrev() {
716 if (Abbrev)
717 return Abbrev.get();
718
719 DataExtractor abbrData(getAbbrevSection(), isLittleEndian(), 0);
720
721 Abbrev.reset(new DWARFDebugAbbrev());
Alexey Samsonov4316df52014-04-25 21:10:56 +0000722 Abbrev->extract(abbrData);
Benjamin Krameraa2f78f2011-09-13 19:42:23 +0000723 return Abbrev.get();
724}
725
Eric Christopherda4b2192013-01-02 23:52:13 +0000726const DWARFDebugAbbrev *DWARFContext::getDebugAbbrevDWO() {
727 if (AbbrevDWO)
728 return AbbrevDWO.get();
729
730 DataExtractor abbrData(getAbbrevDWOSection(), isLittleEndian(), 0);
731 AbbrevDWO.reset(new DWARFDebugAbbrev());
Alexey Samsonov4316df52014-04-25 21:10:56 +0000732 AbbrevDWO->extract(abbrData);
Eric Christopherda4b2192013-01-02 23:52:13 +0000733 return AbbrevDWO.get();
734}
735
David Blaikie18e73502013-06-19 21:37:13 +0000736const DWARFDebugLoc *DWARFContext::getDebugLoc() {
737 if (Loc)
738 return Loc.get();
739
David Blaikie1b5ee5d2013-09-23 17:42:01 +0000740 DataExtractor LocData(getLocSection().Data, isLittleEndian(), 0);
741 Loc.reset(new DWARFDebugLoc(getLocSection().Relocs));
David Blaikie18e73502013-06-19 21:37:13 +0000742 // assume all compile units have the same address byte size
743 if (getNumCompileUnits())
744 Loc->parse(LocData, getCompileUnitAtIndex(0)->getAddressByteSize());
745 return Loc.get();
746}
747
David Blaikie9c550ac2014-03-25 01:44:02 +0000748const DWARFDebugLocDWO *DWARFContext::getDebugLocDWO() {
749 if (LocDWO)
750 return LocDWO.get();
751
752 DataExtractor LocData(getLocDWOSection().Data, isLittleEndian(), 0);
753 LocDWO.reset(new DWARFDebugLocDWO());
754 LocDWO->parse(LocData);
755 return LocDWO.get();
756}
757
Benjamin Kramera6002fd2011-09-14 01:09:52 +0000758const DWARFDebugAranges *DWARFContext::getDebugAranges() {
759 if (Aranges)
760 return Aranges.get();
761
Benjamin Kramera6002fd2011-09-14 01:09:52 +0000762 Aranges.reset(new DWARFDebugAranges());
Alexey Samsonova1694c12012-11-16 08:36:25 +0000763 Aranges->generate(this);
Benjamin Kramera6002fd2011-09-14 01:09:52 +0000764 return Aranges.get();
765}
766
Eli Benderskyfd08bc12013-02-05 23:30:58 +0000767const DWARFDebugFrame *DWARFContext::getDebugFrame() {
768 if (DebugFrame)
769 return DebugFrame.get();
770
771 // There's a "bug" in the DWARFv3 standard with respect to the target address
772 // size within debug frame sections. While DWARF is supposed to be independent
773 // of its container, FDEs have fields with size being "target address size",
774 // which isn't specified in DWARF in general. It's only specified for CUs, but
775 // .eh_frame can appear without a .debug_info section. Follow the example of
776 // other tools (libdwarf) and extract this from the container (ObjectFile
777 // provides this information). This problem is fixed in DWARFv4
778 // See this dwarf-discuss discussion for more details:
779 // http://lists.dwarfstd.org/htdig.cgi/dwarf-discuss-dwarfstd.org/2011-December/001173.html
780 DataExtractor debugFrameData(getDebugFrameSection(), isLittleEndian(),
781 getAddressSize());
Igor Laevsky03a670c2016-01-26 15:09:42 +0000782 DebugFrame.reset(new DWARFDebugFrame(false /* IsEH */));
783 DebugFrame->parse(debugFrameData);
784 return DebugFrame.get();
785}
786
787const DWARFDebugFrame *DWARFContext::getEHFrame() {
788 if (EHFrame)
789 return EHFrame.get();
790
791 DataExtractor debugFrameData(getEHFrameSection(), isLittleEndian(),
792 getAddressSize());
793 DebugFrame.reset(new DWARFDebugFrame(true /* IsEH */));
Eli Benderskyfd08bc12013-02-05 23:30:58 +0000794 DebugFrame->parse(debugFrameData);
795 return DebugFrame.get();
796}
797
Amjad Aboude59cc3e2015-11-12 09:38:54 +0000798const DWARFDebugMacro *DWARFContext::getDebugMacro() {
799 if (Macro)
800 return Macro.get();
801
802 DataExtractor MacinfoData(getMacinfoSection(), isLittleEndian(), 0);
803 Macro.reset(new DWARFDebugMacro());
804 Macro->parse(MacinfoData);
805 return Macro.get();
806}
807
Eric Christopher494109b2012-10-16 23:46:25 +0000808const DWARFLineTable *
Alexey Samsonov7a18c062015-05-19 21:54:32 +0000809DWARFContext::getLineTableForUnit(DWARFUnit *U) {
Benjamin Kramer679e1752011-09-15 20:43:18 +0000810 if (!Line)
David Blaikie1b5ee5d2013-09-23 17:42:01 +0000811 Line.reset(new DWARFDebugLine(&getLineSection().Relocs));
David Blaikiec4e2bed2015-11-17 21:08:05 +0000812
Greg Claytonc8c10322016-12-13 18:25:19 +0000813 auto UnitDIE = U->getUnitDIE();
814 if (!UnitDIE)
Alexey Samsonov7a18c062015-05-19 21:54:32 +0000815 return nullptr;
David Blaikiec4e2bed2015-11-17 21:08:05 +0000816
Greg Clayton97d22182017-01-13 21:08:18 +0000817 auto Offset = toSectionOffset(UnitDIE.find(DW_AT_stmt_list));
Greg Clayton52fe1f62016-12-14 22:38:08 +0000818 if (!Offset)
Craig Topper2617dcc2014-04-15 06:32:26 +0000819 return nullptr; // No line table for this compile unit.
Benjamin Kramer5acab502011-09-15 02:12:05 +0000820
Greg Clayton52fe1f62016-12-14 22:38:08 +0000821 uint32_t stmtOffset = *Offset + U->getLineTableOffset();
Benjamin Kramer679e1752011-09-15 20:43:18 +0000822 // See if the line table is cached.
Eric Christopher494109b2012-10-16 23:46:25 +0000823 if (const DWARFLineTable *lt = Line->getLineTable(stmtOffset))
Benjamin Kramer679e1752011-09-15 20:43:18 +0000824 return lt;
825
Greg Clayton48ff66a2017-05-04 18:29:44 +0000826 // Make sure the offset is good before we try to parse.
827 if (stmtOffset >= U->getLineSection().size())
828 return nullptr;
829
Benjamin Kramer679e1752011-09-15 20:43:18 +0000830 // We have to parse it first.
David Blaikiec4e2bed2015-11-17 21:08:05 +0000831 DataExtractor lineData(U->getLineSection(), isLittleEndian(),
Alexey Samsonov7a18c062015-05-19 21:54:32 +0000832 U->getAddressByteSize());
Benjamin Kramer679e1752011-09-15 20:43:18 +0000833 return Line->getOrParseLineTable(lineData, stmtOffset);
Benjamin Kramer5acab502011-09-15 02:12:05 +0000834}
835
Benjamin Krameraa2f78f2011-09-13 19:42:23 +0000836void DWARFContext::parseCompileUnits() {
Alexey Samsonov8cd4c9d2014-10-08 00:07:53 +0000837 CUs.parse(*this, getInfoSection());
Benjamin Krameraa2f78f2011-09-13 19:42:23 +0000838}
Benjamin Kramer2602ca62011-09-15 20:43:22 +0000839
David Blaikie03c089c2013-09-23 22:44:47 +0000840void DWARFContext::parseTypeUnits() {
Alexey Samsonov1eabf982014-03-13 07:52:54 +0000841 if (!TUs.empty())
842 return;
843 for (const auto &I : getTypesSections()) {
Benjamin Kramerf5e2fc42015-05-29 19:43:39 +0000844 TUs.emplace_back();
Alexey Samsonov8cd4c9d2014-10-08 00:07:53 +0000845 TUs.back().parse(*this, I.second);
David Blaikie03c089c2013-09-23 22:44:47 +0000846 }
847}
848
Eric Christopherda4b2192013-01-02 23:52:13 +0000849void DWARFContext::parseDWOCompileUnits() {
Alexey Samsonov8cd4c9d2014-10-08 00:07:53 +0000850 DWOCUs.parseDWO(*this, getInfoDWOSection());
Eric Christopherda4b2192013-01-02 23:52:13 +0000851}
852
David Blaikie92d9d622014-01-09 05:08:24 +0000853void DWARFContext::parseDWOTypeUnits() {
Alexey Samsonov1eabf982014-03-13 07:52:54 +0000854 if (!DWOTUs.empty())
855 return;
856 for (const auto &I : getTypesDWOSections()) {
Benjamin Kramerf5e2fc42015-05-29 19:43:39 +0000857 DWOTUs.emplace_back();
Alexey Samsonov8cd4c9d2014-10-08 00:07:53 +0000858 DWOTUs.back().parseDWO(*this, I.second);
David Blaikie92d9d622014-01-09 05:08:24 +0000859 }
860}
861
Alexey Samsonov45be7932012-08-30 07:49:50 +0000862DWARFCompileUnit *DWARFContext::getCompileUnitForOffset(uint32_t Offset) {
Alexey Samsonov1eabf982014-03-13 07:52:54 +0000863 parseCompileUnits();
Frederic Riss4e126a02014-09-15 07:50:27 +0000864 return CUs.getUnitForOffset(Offset);
Benjamin Kramer2602ca62011-09-15 20:43:22 +0000865}
866
Alexey Samsonov45be7932012-08-30 07:49:50 +0000867DWARFCompileUnit *DWARFContext::getCompileUnitForAddress(uint64_t Address) {
Benjamin Kramer112ec172011-09-15 21:59:13 +0000868 // First, get the offset of the compile unit.
Alexey Samsonov45be7932012-08-30 07:49:50 +0000869 uint32_t CUOffset = getDebugAranges()->findAddress(Address);
Benjamin Kramer2602ca62011-09-15 20:43:22 +0000870 // Retrieve the compile unit.
Alexey Samsonov45be7932012-08-30 07:49:50 +0000871 return getCompileUnitForOffset(CUOffset);
872}
873
David Blaikieefc4eba2017-02-06 20:19:02 +0000874static bool getFunctionNameAndStartLineForAddress(DWARFCompileUnit *CU,
875 uint64_t Address,
876 FunctionNameKind Kind,
877 std::string &FunctionName,
878 uint32_t &StartLine) {
Alexey Samsonovd0109992014-04-18 21:36:39 +0000879 // The address may correspond to instruction in some inlined function,
880 // so we have to build the chain of inlined functions and take the
David Blaikieefc4eba2017-02-06 20:19:02 +0000881 // name of the topmost function in it.
Greg Claytonc8c10322016-12-13 18:25:19 +0000882 SmallVector<DWARFDie, 4> InlinedChain;
883 CU->getInlinedChainForAddress(Address, InlinedChain);
David Blaikieefc4eba2017-02-06 20:19:02 +0000884 if (InlinedChain.empty())
Alexey Samsonovd0109992014-04-18 21:36:39 +0000885 return false;
David Blaikieefc4eba2017-02-06 20:19:02 +0000886
887 const DWARFDie &DIE = InlinedChain[0];
888 bool FoundResult = false;
889 const char *Name = nullptr;
890 if (Kind != FunctionNameKind::None && (Name = DIE.getSubroutineName(Kind))) {
Alexey Samsonovd0109992014-04-18 21:36:39 +0000891 FunctionName = Name;
David Blaikieefc4eba2017-02-06 20:19:02 +0000892 FoundResult = true;
Alexey Samsonovd0109992014-04-18 21:36:39 +0000893 }
David Blaikieefc4eba2017-02-06 20:19:02 +0000894 if (auto DeclLineResult = DIE.getDeclLine()) {
895 StartLine = DeclLineResult;
896 FoundResult = true;
897 }
898
899 return FoundResult;
Alexey Samsonovd0109992014-04-18 21:36:39 +0000900}
901
Alexey Samsonov45be7932012-08-30 07:49:50 +0000902DILineInfo DWARFContext::getLineInfoForAddress(uint64_t Address,
Alexey Samsonovdce67342014-05-15 21:24:32 +0000903 DILineInfoSpecifier Spec) {
Alexey Samsonovd0109992014-04-18 21:36:39 +0000904 DILineInfo Result;
905
Alexey Samsonov45be7932012-08-30 07:49:50 +0000906 DWARFCompileUnit *CU = getCompileUnitForAddress(Address);
907 if (!CU)
Alexey Samsonovd0109992014-04-18 21:36:39 +0000908 return Result;
David Blaikieefc4eba2017-02-06 20:19:02 +0000909 getFunctionNameAndStartLineForAddress(CU, Address, Spec.FNKind,
910 Result.FunctionName,
911 Result.StartLine);
Alexey Samsonovdce67342014-05-15 21:24:32 +0000912 if (Spec.FLIKind != FileLineInfoKind::None) {
Frederic Riss101b5e22014-09-19 15:11:51 +0000913 if (const DWARFLineTable *LineTable = getLineTableForUnit(CU))
914 LineTable->getFileLineInfoForAddress(Address, CU->getCompilationDir(),
915 Spec.FLIKind, Result);
Alexey Samsonovf4462fa2012-07-02 05:54:45 +0000916 }
Alexey Samsonovd0109992014-04-18 21:36:39 +0000917 return Result;
Benjamin Kramer2602ca62011-09-15 20:43:22 +0000918}
David Blaikiea379b1812011-12-20 02:50:00 +0000919
Alexey Samsonovdce67342014-05-15 21:24:32 +0000920DILineInfoTable
921DWARFContext::getLineInfoForAddressRange(uint64_t Address, uint64_t Size,
922 DILineInfoSpecifier Spec) {
Andrew Kaylor9a8ff812013-01-26 00:28:05 +0000923 DILineInfoTable Lines;
924 DWARFCompileUnit *CU = getCompileUnitForAddress(Address);
925 if (!CU)
926 return Lines;
927
928 std::string FunctionName = "<invalid>";
David Blaikieefc4eba2017-02-06 20:19:02 +0000929 uint32_t StartLine = 0;
930 getFunctionNameAndStartLineForAddress(CU, Address, Spec.FNKind, FunctionName,
931 StartLine);
Andrew Kaylor9a8ff812013-01-26 00:28:05 +0000932
Andrew Kaylor9a8ff812013-01-26 00:28:05 +0000933 // If the Specifier says we don't need FileLineInfo, just
934 // return the top-most function at the starting address.
Alexey Samsonovdce67342014-05-15 21:24:32 +0000935 if (Spec.FLIKind == FileLineInfoKind::None) {
Alexey Samsonovd0109992014-04-18 21:36:39 +0000936 DILineInfo Result;
937 Result.FunctionName = FunctionName;
David Blaikieefc4eba2017-02-06 20:19:02 +0000938 Result.StartLine = StartLine;
Alexey Samsonovd0109992014-04-18 21:36:39 +0000939 Lines.push_back(std::make_pair(Address, Result));
Andrew Kaylor9a8ff812013-01-26 00:28:05 +0000940 return Lines;
941 }
942
Frederic Rissec8a5ba2014-09-04 06:14:40 +0000943 const DWARFLineTable *LineTable = getLineTableForUnit(CU);
Andrew Kaylor9a8ff812013-01-26 00:28:05 +0000944
945 // Get the index of row we're looking for in the line table.
946 std::vector<uint32_t> RowVector;
947 if (!LineTable->lookupAddressRange(Address, Size, RowVector))
948 return Lines;
949
Alexey Samsonov1eabf982014-03-13 07:52:54 +0000950 for (uint32_t RowIndex : RowVector) {
Andrew Kaylor9a8ff812013-01-26 00:28:05 +0000951 // Take file number and line/column from the row.
952 const DWARFDebugLine::Row &Row = LineTable->Rows[RowIndex];
Alexey Samsonovd0109992014-04-18 21:36:39 +0000953 DILineInfo Result;
Frederic Riss101b5e22014-09-19 15:11:51 +0000954 LineTable->getFileNameByIndex(Row.File, CU->getCompilationDir(),
955 Spec.FLIKind, Result.FileName);
Alexey Samsonovd0109992014-04-18 21:36:39 +0000956 Result.FunctionName = FunctionName;
957 Result.Line = Row.Line;
958 Result.Column = Row.Column;
David Blaikieefc4eba2017-02-06 20:19:02 +0000959 Result.StartLine = StartLine;
Alexey Samsonovd0109992014-04-18 21:36:39 +0000960 Lines.push_back(std::make_pair(Row.Address, Result));
Andrew Kaylor9a8ff812013-01-26 00:28:05 +0000961 }
962
963 return Lines;
964}
965
Alexey Samsonovdce67342014-05-15 21:24:32 +0000966DIInliningInfo
967DWARFContext::getInliningInfoForAddress(uint64_t Address,
968 DILineInfoSpecifier Spec) {
Alexey Samsonov5c39fdf2014-04-18 22:22:44 +0000969 DIInliningInfo InliningInfo;
970
Alexey Samsonovc942e6b2012-09-04 08:12:33 +0000971 DWARFCompileUnit *CU = getCompileUnitForAddress(Address);
972 if (!CU)
Alexey Samsonov5c39fdf2014-04-18 22:22:44 +0000973 return InliningInfo;
Alexey Samsonovc942e6b2012-09-04 08:12:33 +0000974
Alexey Samsonov5c39fdf2014-04-18 22:22:44 +0000975 const DWARFLineTable *LineTable = nullptr;
Greg Claytonc8c10322016-12-13 18:25:19 +0000976 SmallVector<DWARFDie, 4> InlinedChain;
977 CU->getInlinedChainForAddress(Address, InlinedChain);
978 if (InlinedChain.size() == 0) {
Alexey Samsonov5c39fdf2014-04-18 22:22:44 +0000979 // If there is no DIE for address (e.g. it is in unavailable .dwo file),
980 // try to at least get file/line info from symbol table.
Alexey Samsonovdce67342014-05-15 21:24:32 +0000981 if (Spec.FLIKind != FileLineInfoKind::None) {
Alexey Samsonov5c39fdf2014-04-18 22:22:44 +0000982 DILineInfo Frame;
Frederic Rissec8a5ba2014-09-04 06:14:40 +0000983 LineTable = getLineTableForUnit(CU);
Frederic Riss101b5e22014-09-19 15:11:51 +0000984 if (LineTable &&
985 LineTable->getFileLineInfoForAddress(Address, CU->getCompilationDir(),
986 Spec.FLIKind, Frame))
Alexey Samsonov5c39fdf2014-04-18 22:22:44 +0000987 InliningInfo.addFrame(Frame);
Alexey Samsonov5c39fdf2014-04-18 22:22:44 +0000988 }
989 return InliningInfo;
990 }
Alexey Samsonovc942e6b2012-09-04 08:12:33 +0000991
Dehao Chenef700d52017-04-17 20:10:39 +0000992 uint32_t CallFile = 0, CallLine = 0, CallColumn = 0, CallDiscriminator = 0;
Greg Claytonc8c10322016-12-13 18:25:19 +0000993 for (uint32_t i = 0, n = InlinedChain.size(); i != n; i++) {
994 DWARFDie &FunctionDIE = InlinedChain[i];
Alexey Samsonovd0109992014-04-18 21:36:39 +0000995 DILineInfo Frame;
Alexey Samsonovc942e6b2012-09-04 08:12:33 +0000996 // Get function name if necessary.
Greg Claytonc8c10322016-12-13 18:25:19 +0000997 if (const char *Name = FunctionDIE.getSubroutineName(Spec.FNKind))
Alexey Samsonovdce67342014-05-15 21:24:32 +0000998 Frame.FunctionName = Name;
David Blaikieefc4eba2017-02-06 20:19:02 +0000999 if (auto DeclLineResult = FunctionDIE.getDeclLine())
1000 Frame.StartLine = DeclLineResult;
Alexey Samsonovdce67342014-05-15 21:24:32 +00001001 if (Spec.FLIKind != FileLineInfoKind::None) {
Alexey Samsonovc942e6b2012-09-04 08:12:33 +00001002 if (i == 0) {
1003 // For the topmost frame, initialize the line table of this
1004 // compile unit and fetch file/line info from it.
Frederic Rissec8a5ba2014-09-04 06:14:40 +00001005 LineTable = getLineTableForUnit(CU);
Alexey Samsonovc942e6b2012-09-04 08:12:33 +00001006 // For the topmost routine, get file/line info from line table.
Frederic Riss101b5e22014-09-19 15:11:51 +00001007 if (LineTable)
1008 LineTable->getFileLineInfoForAddress(Address, CU->getCompilationDir(),
1009 Spec.FLIKind, Frame);
Alexey Samsonovc942e6b2012-09-04 08:12:33 +00001010 } else {
1011 // Otherwise, use call file, call line and call column from
1012 // previous DIE in inlined chain.
Frederic Riss101b5e22014-09-19 15:11:51 +00001013 if (LineTable)
1014 LineTable->getFileNameByIndex(CallFile, CU->getCompilationDir(),
1015 Spec.FLIKind, Frame.FileName);
Alexey Samsonovd0109992014-04-18 21:36:39 +00001016 Frame.Line = CallLine;
1017 Frame.Column = CallColumn;
Dehao Chenef700d52017-04-17 20:10:39 +00001018 Frame.Discriminator = CallDiscriminator;
Alexey Samsonovc942e6b2012-09-04 08:12:33 +00001019 }
1020 // Get call file/line/column of a current DIE.
1021 if (i + 1 < n) {
Dehao Chenef700d52017-04-17 20:10:39 +00001022 FunctionDIE.getCallerFrame(CallFile, CallLine, CallColumn,
1023 CallDiscriminator);
Alexey Samsonovc942e6b2012-09-04 08:12:33 +00001024 }
1025 }
Alexey Samsonovc942e6b2012-09-04 08:12:33 +00001026 InliningInfo.addFrame(Frame);
1027 }
1028 return InliningInfo;
1029}
1030
David Blaikief9803fb2017-05-23 00:30:42 +00001031std::shared_ptr<DWARFContext>
1032DWARFContext::getDWOContext(StringRef AbsolutePath) {
David Blaikie15d85fc2017-05-23 06:48:53 +00001033 if (auto S = DWP.lock()) {
David Blaikief9803fb2017-05-23 00:30:42 +00001034 DWARFContext *Ctxt = S->Context.get();
1035 return std::shared_ptr<DWARFContext>(std::move(S), Ctxt);
1036 }
1037
David Blaikie15d85fc2017-05-23 06:48:53 +00001038 std::weak_ptr<DWOFile> *Entry = &DWOFiles[AbsolutePath];
1039
1040 if (auto S = Entry->lock()) {
1041 DWARFContext *Ctxt = S->Context.get();
1042 return std::shared_ptr<DWARFContext>(std::move(S), Ctxt);
1043 }
1044
1045 SmallString<128> DWPName;
1046 Expected<OwningBinary<ObjectFile>> Obj = [&] {
1047 if (!CheckedForDWP) {
1048 (getFileName() + ".dwp").toVector(DWPName);
1049 auto Obj = object::ObjectFile::createObjectFile(DWPName);
1050 if (Obj) {
1051 Entry = &DWP;
1052 return Obj;
1053 } else {
1054 CheckedForDWP = true;
1055 // TODO: Should this error be handled (maybe in a high verbosity mode)
1056 // before falling back to .dwo files?
1057 consumeError(Obj.takeError());
1058 }
1059 }
1060
1061 return object::ObjectFile::createObjectFile(AbsolutePath);
1062 }();
1063
David Blaikief9803fb2017-05-23 00:30:42 +00001064 if (!Obj) {
1065 // TODO: Actually report errors helpfully.
1066 consumeError(Obj.takeError());
1067 return nullptr;
1068 }
David Blaikie15d85fc2017-05-23 06:48:53 +00001069
1070 auto S = std::make_shared<DWOFile>();
David Blaikief9803fb2017-05-23 00:30:42 +00001071 S->File = std::move(Obj.get());
1072 S->Context = llvm::make_unique<DWARFContextInMemory>(*S->File.getBinary());
David Blaikie15d85fc2017-05-23 06:48:53 +00001073 *Entry = S;
David Blaikief9803fb2017-05-23 00:30:42 +00001074 auto *Ctxt = S->Context.get();
1075 return std::shared_ptr<DWARFContext>(std::move(S), Ctxt);
1076}
1077
George Rimar702dac62017-04-12 08:59:15 +00001078static Error createError(const Twine &Reason, llvm::Error E) {
1079 return make_error<StringError>(Reason + toString(std::move(E)),
1080 inconvertibleErrorCode());
1081}
1082
George Rimara25d3292017-05-27 18:10:23 +00001083/// SymInfo contains information about symbol: it's address
1084/// and section index which is -1LL for absolute symbols.
1085struct SymInfo {
1086 uint64_t Address;
1087 uint64_t SectionIndex;
1088};
1089
1090/// Returns the address of symbol relocation used against and a section index.
1091/// Used for futher relocations computation. Symbol's section load address is
1092static Expected<SymInfo> getSymbolInfo(const object::ObjectFile &Obj,
1093 const RelocationRef &Reloc,
1094 const LoadedObjectInfo *L,
1095 std::map<SymbolRef, SymInfo> &Cache) {
1096 SymInfo Ret = {0, (uint64_t)-1LL};
George Rimar702dac62017-04-12 08:59:15 +00001097 object::section_iterator RSec = Obj.section_end();
1098 object::symbol_iterator Sym = Reloc.getSymbol();
1099
George Rimara25d3292017-05-27 18:10:23 +00001100 std::map<SymbolRef, SymInfo>::iterator CacheIt = Cache.end();
George Rimar702dac62017-04-12 08:59:15 +00001101 // First calculate the address of the symbol or section as it appears
1102 // in the object file
1103 if (Sym != Obj.symbol_end()) {
George Rimar958b01a2017-05-15 11:45:28 +00001104 bool New;
George Rimara25d3292017-05-27 18:10:23 +00001105 std::tie(CacheIt, New) = Cache.insert({*Sym, {0, 0}});
George Rimar958b01a2017-05-15 11:45:28 +00001106 if (!New)
1107 return CacheIt->second;
1108
George Rimar702dac62017-04-12 08:59:15 +00001109 Expected<uint64_t> SymAddrOrErr = Sym->getAddress();
1110 if (!SymAddrOrErr)
1111 return createError("error: failed to compute symbol address: ",
1112 SymAddrOrErr.takeError());
1113
1114 // Also remember what section this symbol is in for later
1115 auto SectOrErr = Sym->getSection();
1116 if (!SectOrErr)
1117 return createError("error: failed to get symbol section: ",
1118 SectOrErr.takeError());
1119
1120 RSec = *SectOrErr;
George Rimara25d3292017-05-27 18:10:23 +00001121 Ret.Address = *SymAddrOrErr;
George Rimar702dac62017-04-12 08:59:15 +00001122 } else if (auto *MObj = dyn_cast<MachOObjectFile>(&Obj)) {
1123 RSec = MObj->getRelocationSection(Reloc.getRawDataRefImpl());
George Rimara25d3292017-05-27 18:10:23 +00001124 Ret.Address = RSec->getAddress();
George Rimar702dac62017-04-12 08:59:15 +00001125 }
1126
George Rimara25d3292017-05-27 18:10:23 +00001127 if (RSec != Obj.section_end())
1128 Ret.SectionIndex = RSec->getIndex();
1129
George Rimar702dac62017-04-12 08:59:15 +00001130 // If we are given load addresses for the sections, we need to adjust:
1131 // SymAddr = (Address of Symbol Or Section in File) -
1132 // (Address of Section in File) +
1133 // (Load Address of Section)
1134 // RSec is now either the section being targeted or the section
1135 // containing the symbol being targeted. In either case,
1136 // we need to perform the same computation.
1137 if (L && RSec != Obj.section_end())
1138 if (uint64_t SectionLoadAddress = L->getSectionLoadAddress(*RSec))
George Rimara25d3292017-05-27 18:10:23 +00001139 Ret.Address += SectionLoadAddress - RSec->getAddress();
George Rimar958b01a2017-05-15 11:45:28 +00001140
1141 if (CacheIt != Cache.end())
1142 CacheIt->second = Ret;
1143
George Rimar702dac62017-04-12 08:59:15 +00001144 return Ret;
1145}
1146
1147static bool isRelocScattered(const object::ObjectFile &Obj,
1148 const RelocationRef &Reloc) {
George Rimard4998b02017-04-13 09:52:50 +00001149 const MachOObjectFile *MachObj = dyn_cast<MachOObjectFile>(&Obj);
1150 if (!MachObj)
George Rimar702dac62017-04-12 08:59:15 +00001151 return false;
1152 // MachO also has relocations that point to sections and
1153 // scattered relocations.
George Rimar702dac62017-04-12 08:59:15 +00001154 auto RelocInfo = MachObj->getRelocation(Reloc.getRawDataRefImpl());
1155 return MachObj->isRelocationScattered(RelocInfo);
1156}
1157
George Rimar2122ff642017-05-05 10:52:39 +00001158Error DWARFContextInMemory::maybeDecompress(const SectionRef &Sec,
1159 StringRef Name, StringRef &Data) {
1160 if (!Decompressor::isCompressed(Sec))
1161 return Error::success();
1162
1163 Expected<Decompressor> Decompressor =
1164 Decompressor::create(Name, Data, IsLittleEndian, AddressSize == 8);
1165 if (!Decompressor)
1166 return Decompressor.takeError();
1167
1168 SmallString<32> Out;
George Rimarf98b9ac2017-05-18 08:00:01 +00001169 if (auto Err = Decompressor->resizeAndDecompress(Out))
George Rimar2122ff642017-05-05 10:52:39 +00001170 return Err;
1171
1172 UncompressedSections.emplace_back(std::move(Out));
1173 Data = UncompressedSections.back();
1174
1175 return Error::success();
1176}
1177
Keno Fischerc780e8e2015-05-21 21:24:32 +00001178DWARFContextInMemory::DWARFContextInMemory(const object::ObjectFile &Obj,
David Blaikie15d85fc2017-05-23 06:48:53 +00001179 const LoadedObjectInfo *L)
1180 : FileName(Obj.getFileName()), IsLittleEndian(Obj.isLittleEndian()),
Rafael Espindolaa04bb5b2014-07-31 20:19:36 +00001181 AddressSize(Obj.getBytesInAddress()) {
1182 for (const SectionRef &Section : Obj.sections()) {
Eric Christopher7370b552012-11-12 21:40:38 +00001183 StringRef name;
Alexey Samsonov063eb3f2014-03-13 13:52:54 +00001184 Section.getName(name);
David Majnemerdac39852014-09-26 22:32:16 +00001185 // Skip BSS and Virtual sections, they aren't interesting.
Rafael Espindola80291272014-10-08 15:28:58 +00001186 bool IsBSS = Section.isBSS();
David Majnemerdac39852014-09-26 22:32:16 +00001187 if (IsBSS)
1188 continue;
Rafael Espindola80291272014-10-08 15:28:58 +00001189 bool IsVirtual = Section.isVirtual();
David Majnemerdac39852014-09-26 22:32:16 +00001190 if (IsVirtual)
1191 continue;
Eric Christopher7370b552012-11-12 21:40:38 +00001192 StringRef data;
Keno Fischerc780e8e2015-05-21 21:24:32 +00001193
Lang Hames2e88f4f2015-07-28 17:52:11 +00001194 section_iterator RelocatedSection = Section.getRelocatedSection();
Keno Fischerc780e8e2015-05-21 21:24:32 +00001195 // Try to obtain an already relocated version of this section.
1196 // Else use the unrelocated section from the object file. We'll have to
1197 // apply relocations ourselves later.
George Rimara25d3292017-05-27 18:10:23 +00001198 if (!L || !L->getLoadedSectionContents(*RelocatedSection, data))
Keno Fischerc780e8e2015-05-21 21:24:32 +00001199 Section.getContents(data);
Eric Christopher7370b552012-11-12 21:40:38 +00001200
George Rimar2122ff642017-05-05 10:52:39 +00001201 if (auto Err = maybeDecompress(Section, name, data)) {
1202 errs() << "error: failed to decompress '" + name + "', " +
1203 toString(std::move(Err))
1204 << '\n';
1205 continue;
Alexey Samsonov068fc8a2013-04-23 10:17:34 +00001206 }
1207
George Rimar4bf30832017-01-11 15:26:41 +00001208 // Compressed sections names in GNU style starts from ".z",
1209 // at this point section is decompressed and we drop compression prefix.
1210 name = name.substr(
1211 name.find_first_not_of("._z")); // Skip ".", "z" and "_" prefixes.
1212
Chris Bieneman2e752db2017-01-20 19:03:14 +00001213 if (StringRef *SectionData = MapSectionToMember(name)) {
Alexey Samsonov063eb3f2014-03-13 13:52:54 +00001214 *SectionData = data;
Rafael Espindola4f60a382013-05-30 03:05:14 +00001215 if (name == "debug_ranges") {
1216 // FIXME: Use the other dwo range section when we emit it.
George Rimarca532112017-04-24 10:19:45 +00001217 RangeDWOSection.Data = data;
Rafael Espindola4f60a382013-05-30 03:05:14 +00001218 }
David Blaikie03c089c2013-09-23 22:44:47 +00001219 } else if (name == "debug_types") {
David Blaikie427e4352013-09-23 23:39:55 +00001220 // Find debug_types data by section rather than name as there are
1221 // multiple, comdat grouped, debug_types sections.
Alexey Samsonov063eb3f2014-03-13 13:52:54 +00001222 TypesSections[Section].Data = data;
David Blaikie92d9d622014-01-09 05:08:24 +00001223 } else if (name == "debug_types.dwo") {
Alexey Samsonov063eb3f2014-03-13 13:52:54 +00001224 TypesDWOSections[Section].Data = data;
Eric Christopherda4b2192013-01-02 23:52:13 +00001225 }
Eric Christopher7370b552012-11-12 21:40:38 +00001226
Wolfgang Pieb77d3e932017-06-06 01:22:34 +00001227 // Map platform specific debug section names to DWARF standard section
1228 // names.
1229 name = Obj.mapDebugSectionName(name);
1230
Rafael Espindolaa04bb5b2014-07-31 20:19:36 +00001231 if (RelocatedSection == Obj.section_end())
Rafael Espindola4f60a382013-05-30 03:05:14 +00001232 continue;
1233
1234 StringRef RelSecName;
Keno Fischerc780e8e2015-05-21 21:24:32 +00001235 StringRef RelSecData;
Rafael Espindola4f60a382013-05-30 03:05:14 +00001236 RelocatedSection->getName(RelSecName);
Keno Fischerc780e8e2015-05-21 21:24:32 +00001237
1238 // If the section we're relocating was relocated already by the JIT,
1239 // then we used the relocated version above, so we do not need to process
1240 // relocations for it now.
George Rimara25d3292017-05-27 18:10:23 +00001241 if (L && L->getLoadedSectionContents(*RelocatedSection, RelSecData))
Keno Fischerc780e8e2015-05-21 21:24:32 +00001242 continue;
1243
Frederic Riss7bb12262015-08-23 04:44:21 +00001244 // In Mach-o files, the relocations do not need to be applied if
1245 // there is no load offset to apply. The value read at the
1246 // relocation point already factors in the section address
1247 // (actually applying the relocations will produce wrong results
1248 // as the section address will be added twice).
Craig Topper66059c92015-11-18 07:07:59 +00001249 if (!L && isa<MachOObjectFile>(&Obj))
Frederic Riss7bb12262015-08-23 04:44:21 +00001250 continue;
1251
Rafael Espindola4f60a382013-05-30 03:05:14 +00001252 RelSecName = RelSecName.substr(
1253 RelSecName.find_first_not_of("._")); // Skip . and _ prefixes.
1254
Andrew Kaylord55d7012013-01-25 22:50:58 +00001255 // TODO: Add support for relocations in other sections as needed.
1256 // Record relocations for the debug_info and debug_line sections.
David Blaikied2f3a942017-05-22 07:02:47 +00001257 RelocAddrMap *Map =
1258 StringSwitch<RelocAddrMap *>(RelSecName)
1259 .Case("debug_info", &InfoSection.Relocs)
1260 .Case("debug_loc", &LocSection.Relocs)
1261 .Case("debug_info.dwo", &InfoDWOSection.Relocs)
1262 .Case("debug_line", &LineSection.Relocs)
Wolfgang Pieb77d3e932017-06-06 01:22:34 +00001263 .Case("debug_str_offsets", &StringOffsetSection.Relocs)
David Blaikied2f3a942017-05-22 07:02:47 +00001264 .Case("debug_ranges", &RangeSection.Relocs)
1265 .Case("debug_addr", &AddrSection.Relocs)
1266 .Case("apple_names", &AppleNamesSection.Relocs)
1267 .Case("apple_types", &AppleTypesSection.Relocs)
1268 .Case("apple_namespaces", &AppleNamespacesSection.Relocs)
1269 .Case("apple_namespac", &AppleNamespacesSection.Relocs)
1270 .Case("apple_objc", &AppleObjCSection.Relocs)
1271 .Default(nullptr);
David Blaikie03c089c2013-09-23 22:44:47 +00001272 if (!Map) {
David Blaikie427e4352013-09-23 23:39:55 +00001273 // Find debug_types relocs by section rather than name as there are
1274 // multiple, comdat grouped, debug_types sections.
David Blaikie92d9d622014-01-09 05:08:24 +00001275 if (RelSecName == "debug_types")
1276 Map = &TypesSections[*RelocatedSection].Relocs;
1277 else if (RelSecName == "debug_types.dwo")
1278 Map = &TypesDWOSections[*RelocatedSection].Relocs;
1279 else
1280 continue;
David Blaikie03c089c2013-09-23 22:44:47 +00001281 }
Eric Christopher7370b552012-11-12 21:40:38 +00001282
George Rimarfed9f092017-05-17 12:10:51 +00001283 if (Section.relocation_begin() == Section.relocation_end())
1284 continue;
1285
George Rimara25d3292017-05-27 18:10:23 +00001286 // Symbol to [address, section index] cache mapping.
1287 std::map<SymbolRef, SymInfo> AddrCache;
George Rimarfed9f092017-05-17 12:10:51 +00001288 for (const RelocationRef &Reloc : Section.relocations()) {
1289 // FIXME: it's not clear how to correctly handle scattered
1290 // relocations.
1291 if (isRelocScattered(Obj, Reloc))
1292 continue;
Keno Fischerc780e8e2015-05-21 21:24:32 +00001293
George Rimara25d3292017-05-27 18:10:23 +00001294 Expected<SymInfo> SymInfoOrErr = getSymbolInfo(Obj, Reloc, L, AddrCache);
1295 if (!SymInfoOrErr) {
1296 errs() << toString(SymInfoOrErr.takeError()) << '\n';
George Rimarfed9f092017-05-17 12:10:51 +00001297 continue;
Eric Christopher7370b552012-11-12 21:40:38 +00001298 }
George Rimarfed9f092017-05-17 12:10:51 +00001299
1300 object::RelocVisitor V(Obj);
George Rimara25d3292017-05-27 18:10:23 +00001301 uint64_t Val = V.visit(Reloc.getType(), Reloc, SymInfoOrErr->Address);
George Rimarfed9f092017-05-17 12:10:51 +00001302 if (V.error()) {
1303 SmallString<32> Name;
1304 Reloc.getTypeName(Name);
1305 errs() << "error: failed to compute relocation: " << Name << "\n";
1306 continue;
1307 }
George Rimara25d3292017-05-27 18:10:23 +00001308 llvm::RelocAddrEntry Rel = {SymInfoOrErr->SectionIndex, Val};
1309 Map->insert({Reloc.getOffset(), Rel});
Eric Christopher7370b552012-11-12 21:40:38 +00001310 }
1311 }
1312}
1313
Chris Bieneman2e752db2017-01-20 19:03:14 +00001314DWARFContextInMemory::DWARFContextInMemory(
1315 const StringMap<std::unique_ptr<MemoryBuffer>> &Sections, uint8_t AddrSize,
1316 bool isLittleEndian)
1317 : IsLittleEndian(isLittleEndian), AddressSize(AddrSize) {
1318 for (const auto &SecIt : Sections) {
1319 if (StringRef *SectionData = MapSectionToMember(SecIt.first()))
1320 *SectionData = SecIt.second->getBuffer();
1321 }
1322}
1323
1324StringRef *DWARFContextInMemory::MapSectionToMember(StringRef Name) {
1325 return StringSwitch<StringRef *>(Name)
1326 .Case("debug_info", &InfoSection.Data)
1327 .Case("debug_abbrev", &AbbrevSection)
1328 .Case("debug_loc", &LocSection.Data)
1329 .Case("debug_line", &LineSection.Data)
1330 .Case("debug_aranges", &ARangeSection)
1331 .Case("debug_frame", &DebugFrameSection)
1332 .Case("eh_frame", &EHFrameSection)
1333 .Case("debug_str", &StringSection)
Wolfgang Pieb77d3e932017-06-06 01:22:34 +00001334 .Case("debug_str_offsets", &StringOffsetSection.Data)
George Rimarca532112017-04-24 10:19:45 +00001335 .Case("debug_ranges", &RangeSection.Data)
Chris Bieneman2e752db2017-01-20 19:03:14 +00001336 .Case("debug_macinfo", &MacinfoSection)
1337 .Case("debug_pubnames", &PubNamesSection)
1338 .Case("debug_pubtypes", &PubTypesSection)
1339 .Case("debug_gnu_pubnames", &GnuPubNamesSection)
1340 .Case("debug_gnu_pubtypes", &GnuPubTypesSection)
1341 .Case("debug_info.dwo", &InfoDWOSection.Data)
1342 .Case("debug_abbrev.dwo", &AbbrevDWOSection)
1343 .Case("debug_loc.dwo", &LocDWOSection.Data)
1344 .Case("debug_line.dwo", &LineDWOSection.Data)
1345 .Case("debug_str.dwo", &StringDWOSection)
Wolfgang Pieb77d3e932017-06-06 01:22:34 +00001346 .Case("debug_str_offsets.dwo", &StringOffsetDWOSection.Data)
David Blaikied2f3a942017-05-22 07:02:47 +00001347 .Case("debug_addr", &AddrSection.Data)
Chris Bieneman2e752db2017-01-20 19:03:14 +00001348 .Case("apple_names", &AppleNamesSection.Data)
1349 .Case("apple_types", &AppleTypesSection.Data)
1350 .Case("apple_namespaces", &AppleNamespacesSection.Data)
1351 .Case("apple_namespac", &AppleNamespacesSection.Data)
1352 .Case("apple_objc", &AppleObjCSection.Data)
1353 .Case("debug_cu_index", &CUIndexSection)
1354 .Case("debug_tu_index", &TUIndexSection)
1355 .Case("gdb_index", &GdbIndexSection)
1356 // Any more debug info sections go here.
1357 .Default(nullptr);
1358}
1359
Eugene Zelenko28db7e62017-03-01 01:14:23 +00001360void DWARFContextInMemory::anchor() {}