1
//===-- DWARFFormValue.cpp ------------------------------------------------===//
3
// The LLVM Compiler Infrastructure
5
// This file is distributed under the University of Illinois Open Source
6
// License. See LICENSE.TXT for details.
8
//===----------------------------------------------------------------------===//
10
#include "SyntaxHighlighting.h"
11
#include "llvm/ADT/ArrayRef.h"
12
#include "llvm/ADT/StringRef.h"
13
#include "llvm/DebugInfo/DWARF/DWARFCompileUnit.h"
14
#include "llvm/DebugInfo/DWARF/DWARFContext.h"
15
#include "llvm/DebugInfo/DWARF/DWARFFormValue.h"
16
#include "llvm/Support/Debug.h"
17
#include "llvm/Support/Dwarf.h"
18
#include "llvm/Support/Format.h"
19
#include "llvm/Support/raw_ostream.h"
23
using namespace dwarf;
24
using namespace syntax;
27
uint8_t getRefAddrSize(uint8_t AddrSize, uint16_t Version) {
28
// FIXME: Support DWARF64.
29
return (Version == 2) ? AddrSize : 4;
32
template <uint8_t AddrSize, uint8_t RefAddrSize>
33
ArrayRef<uint8_t> makeFixedFormSizesArrayRef() {
34
static const uint8_t sizes[] = {
36
AddrSize, // 0x01 DW_FORM_addr
38
0, // 0x03 DW_FORM_block2
39
0, // 0x04 DW_FORM_block4
40
2, // 0x05 DW_FORM_data2
41
4, // 0x06 DW_FORM_data4
42
8, // 0x07 DW_FORM_data8
43
0, // 0x08 DW_FORM_string
44
0, // 0x09 DW_FORM_block
45
0, // 0x0a DW_FORM_block1
46
1, // 0x0b DW_FORM_data1
47
1, // 0x0c DW_FORM_flag
48
0, // 0x0d DW_FORM_sdata
49
4, // 0x0e DW_FORM_strp
50
0, // 0x0f DW_FORM_udata
51
RefAddrSize, // 0x10 DW_FORM_ref_addr
52
1, // 0x11 DW_FORM_ref1
53
2, // 0x12 DW_FORM_ref2
54
4, // 0x13 DW_FORM_ref4
55
8, // 0x14 DW_FORM_ref8
56
0, // 0x15 DW_FORM_ref_udata
57
0, // 0x16 DW_FORM_indirect
58
4, // 0x17 DW_FORM_sec_offset
59
0, // 0x18 DW_FORM_exprloc
60
0, // 0x19 DW_FORM_flag_present
62
return makeArrayRef(sizes);
66
ArrayRef<uint8_t> DWARFFormValue::getFixedFormSizes(uint8_t AddrSize,
68
uint8_t RefAddrSize = getRefAddrSize(AddrSize, Version);
69
if (AddrSize == 4 && RefAddrSize == 4)
70
return makeFixedFormSizesArrayRef<4, 4>();
71
if (AddrSize == 4 && RefAddrSize == 8)
72
return makeFixedFormSizesArrayRef<4, 8>();
73
if (AddrSize == 8 && RefAddrSize == 4)
74
return makeFixedFormSizesArrayRef<8, 4>();
75
if (AddrSize == 8 && RefAddrSize == 8)
76
return makeFixedFormSizesArrayRef<8, 8>();
80
static const DWARFFormValue::FormClass DWARF4FormClasses[] = {
81
DWARFFormValue::FC_Unknown, // 0x0
82
DWARFFormValue::FC_Address, // 0x01 DW_FORM_addr
83
DWARFFormValue::FC_Unknown, // 0x02 unused
84
DWARFFormValue::FC_Block, // 0x03 DW_FORM_block2
85
DWARFFormValue::FC_Block, // 0x04 DW_FORM_block4
86
DWARFFormValue::FC_Constant, // 0x05 DW_FORM_data2
87
// --- These can be FC_SectionOffset in DWARF3 and below:
88
DWARFFormValue::FC_Constant, // 0x06 DW_FORM_data4
89
DWARFFormValue::FC_Constant, // 0x07 DW_FORM_data8
91
DWARFFormValue::FC_String, // 0x08 DW_FORM_string
92
DWARFFormValue::FC_Block, // 0x09 DW_FORM_block
93
DWARFFormValue::FC_Block, // 0x0a DW_FORM_block1
94
DWARFFormValue::FC_Constant, // 0x0b DW_FORM_data1
95
DWARFFormValue::FC_Flag, // 0x0c DW_FORM_flag
96
DWARFFormValue::FC_Constant, // 0x0d DW_FORM_sdata
97
DWARFFormValue::FC_String, // 0x0e DW_FORM_strp
98
DWARFFormValue::FC_Constant, // 0x0f DW_FORM_udata
99
DWARFFormValue::FC_Reference, // 0x10 DW_FORM_ref_addr
100
DWARFFormValue::FC_Reference, // 0x11 DW_FORM_ref1
101
DWARFFormValue::FC_Reference, // 0x12 DW_FORM_ref2
102
DWARFFormValue::FC_Reference, // 0x13 DW_FORM_ref4
103
DWARFFormValue::FC_Reference, // 0x14 DW_FORM_ref8
104
DWARFFormValue::FC_Reference, // 0x15 DW_FORM_ref_udata
105
DWARFFormValue::FC_Indirect, // 0x16 DW_FORM_indirect
106
DWARFFormValue::FC_SectionOffset, // 0x17 DW_FORM_sec_offset
107
DWARFFormValue::FC_Exprloc, // 0x18 DW_FORM_exprloc
108
DWARFFormValue::FC_Flag, // 0x19 DW_FORM_flag_present
111
bool DWARFFormValue::isFormClass(DWARFFormValue::FormClass FC) const {
112
// First, check DWARF4 form classes.
113
if (Form < ArrayRef<FormClass>(DWARF4FormClasses).size() &&
114
DWARF4FormClasses[Form] == FC)
116
// Check more forms from DWARF4 and DWARF5 proposals.
118
case DW_FORM_ref_sig8:
119
case DW_FORM_GNU_ref_alt:
120
return (FC == FC_Reference);
121
case DW_FORM_GNU_addr_index:
122
return (FC == FC_Address);
123
case DW_FORM_GNU_str_index:
124
case DW_FORM_GNU_strp_alt:
125
return (FC == FC_String);
127
// In DWARF3 DW_FORM_data4 and DW_FORM_data8 served also as a section offset.
128
// Don't check for DWARF version here, as some producers may still do this
130
return (Form == DW_FORM_data4 || Form == DW_FORM_data8) &&
131
FC == FC_SectionOffset;
134
bool DWARFFormValue::extractValue(DataExtractor data, uint32_t *offset_ptr,
135
const DWARFUnit *cu) {
136
bool indirect = false;
137
bool is_block = false;
138
Value.data = nullptr;
139
// Read the value for the form into value and follow and DW_FORM_indirect
140
// instances we run into
145
case DW_FORM_ref_addr: {
149
(Form == DW_FORM_addr)
150
? cu->getAddressByteSize()
151
: getRefAddrSize(cu->getAddressByteSize(), cu->getVersion());
152
RelocAddrMap::const_iterator AI = cu->getRelocMap()->find(*offset_ptr);
153
if (AI != cu->getRelocMap()->end()) {
154
const std::pair<uint8_t, int64_t> &R = AI->second;
155
Value.uval = data.getUnsigned(offset_ptr, AddrSize) + R.second;
157
Value.uval = data.getUnsigned(offset_ptr, AddrSize);
160
case DW_FORM_exprloc:
162
Value.uval = data.getULEB128(offset_ptr);
166
Value.uval = data.getU8(offset_ptr);
170
Value.uval = data.getU16(offset_ptr);
174
Value.uval = data.getU32(offset_ptr);
180
Value.uval = data.getU8(offset_ptr);
184
Value.uval = data.getU16(offset_ptr);
188
Value.uval = data.getU32(offset_ptr);
191
RelocAddrMap::const_iterator AI = cu->getRelocMap()->find(*offset_ptr-4);
192
if (AI != cu->getRelocMap()->end())
193
Value.uval += AI->second.second;
198
Value.uval = data.getU64(offset_ptr);
201
Value.sval = data.getSLEB128(offset_ptr);
204
case DW_FORM_ref_udata:
205
Value.uval = data.getULEB128(offset_ptr);
208
Value.cstr = data.getCStr(offset_ptr);
210
case DW_FORM_indirect:
211
Form = data.getULEB128(offset_ptr);
214
case DW_FORM_sec_offset:
216
case DW_FORM_GNU_ref_alt:
217
case DW_FORM_GNU_strp_alt: {
218
// FIXME: This is 64-bit for DWARF64.
219
Value.uval = data.getU32(offset_ptr);
222
RelocAddrMap::const_iterator AI =
223
cu->getRelocMap()->find(*offset_ptr - 4);
224
if (AI != cu->getRelocMap()->end())
225
Value.uval += AI->second.second;
228
case DW_FORM_flag_present:
231
case DW_FORM_ref_sig8:
232
Value.uval = data.getU64(offset_ptr);
234
case DW_FORM_GNU_addr_index:
235
case DW_FORM_GNU_str_index:
236
Value.uval = data.getULEB128(offset_ptr);
244
StringRef str = data.getData().substr(*offset_ptr, Value.uval);
245
Value.data = nullptr;
247
Value.data = reinterpret_cast<const uint8_t *>(str.data());
248
*offset_ptr += Value.uval;
256
DWARFFormValue::skipValue(DataExtractor debug_info_data, uint32_t* offset_ptr,
257
const DWARFUnit *cu) const {
258
return DWARFFormValue::skipValue(Form, debug_info_data, offset_ptr, cu);
262
DWARFFormValue::skipValue(uint16_t form, DataExtractor debug_info_data,
263
uint32_t *offset_ptr, const DWARFUnit *cu) {
264
bool indirect = false;
267
// Blocks if inlined data that have a length field and the data bytes
268
// inlined in the .debug_info
269
case DW_FORM_exprloc:
270
case DW_FORM_block: {
271
uint64_t size = debug_info_data.getULEB128(offset_ptr);
275
case DW_FORM_block1: {
276
uint8_t size = debug_info_data.getU8(offset_ptr);
280
case DW_FORM_block2: {
281
uint16_t size = debug_info_data.getU16(offset_ptr);
285
case DW_FORM_block4: {
286
uint32_t size = debug_info_data.getU32(offset_ptr);
291
// Inlined NULL terminated C-strings
293
debug_info_data.getCStr(offset_ptr);
296
// Compile unit address sized values
298
*offset_ptr += cu->getAddressByteSize();
300
case DW_FORM_ref_addr:
301
*offset_ptr += getRefAddrSize(cu->getAddressByteSize(), cu->getVersion());
304
// 0 byte values - implied from the form.
305
case DW_FORM_flag_present:
330
case DW_FORM_ref_sig8:
334
// signed or unsigned LEB 128 values
335
// case DW_FORM_APPLE_db_str:
338
case DW_FORM_ref_udata:
339
case DW_FORM_GNU_str_index:
340
case DW_FORM_GNU_addr_index:
341
debug_info_data.getULEB128(offset_ptr);
344
case DW_FORM_indirect:
346
form = debug_info_data.getULEB128(offset_ptr);
349
// FIXME: 4 for DWARF32, 8 for DWARF64.
350
case DW_FORM_sec_offset:
352
case DW_FORM_GNU_ref_alt:
353
case DW_FORM_GNU_strp_alt:
365
DWARFFormValue::dump(raw_ostream &OS, const DWARFUnit *cu) const {
366
uint64_t uvalue = Value.uval;
367
bool cu_relative_offset = false;
370
case DW_FORM_addr: OS << format("0x%016" PRIx64, uvalue); break;
371
case DW_FORM_GNU_addr_index: {
372
OS << format(" indexed (%8.8x) address = ", (uint32_t)uvalue);
374
if (cu->getAddrOffsetSectionItem(uvalue, Address))
375
OS << format("0x%016" PRIx64, Address);
377
OS << "<no .debug_addr section>";
380
case DW_FORM_flag_present: OS << "true"; break;
382
case DW_FORM_data1: OS << format("0x%02x", (uint8_t)uvalue); break;
383
case DW_FORM_data2: OS << format("0x%04x", (uint16_t)uvalue); break;
384
case DW_FORM_data4: OS << format("0x%08x", (uint32_t)uvalue); break;
385
case DW_FORM_ref_sig8:
386
case DW_FORM_data8: OS << format("0x%016" PRIx64, uvalue); break;
389
OS.write_escaped(Value.cstr);
392
case DW_FORM_exprloc:
399
case DW_FORM_exprloc:
400
case DW_FORM_block: OS << format("<0x%" PRIx64 "> ", uvalue); break;
401
case DW_FORM_block1: OS << format("<0x%2.2x> ", (uint8_t)uvalue); break;
402
case DW_FORM_block2: OS << format("<0x%4.4x> ", (uint16_t)uvalue); break;
403
case DW_FORM_block4: OS << format("<0x%8.8x> ", (uint32_t)uvalue); break;
407
const uint8_t* data_ptr = Value.data;
409
// uvalue contains size of block
410
const uint8_t* end_data_ptr = data_ptr + uvalue;
411
while (data_ptr < end_data_ptr) {
412
OS << format("%2.2x ", *data_ptr);
421
case DW_FORM_sdata: OS << Value.sval; break;
422
case DW_FORM_udata: OS << Value.uval; break;
424
OS << format(" .debug_str[0x%8.8x] = ", (uint32_t)uvalue);
428
case DW_FORM_GNU_str_index: {
429
OS << format(" indexed (%8.8x) string = ", (uint32_t)uvalue);
433
case DW_FORM_GNU_strp_alt: {
434
OS << format("alt indirect string, offset: 0x%" PRIx64 "", uvalue);
438
case DW_FORM_ref_addr:
439
OS << format("0x%016" PRIx64, uvalue);
442
cu_relative_offset = true;
443
OS << format("cu + 0x%2.2x", (uint8_t)uvalue);
446
cu_relative_offset = true;
447
OS << format("cu + 0x%4.4x", (uint16_t)uvalue);
450
cu_relative_offset = true;
451
OS << format("cu + 0x%4.4x", (uint32_t)uvalue);
454
cu_relative_offset = true;
455
OS << format("cu + 0x%8.8" PRIx64, uvalue);
457
case DW_FORM_ref_udata:
458
cu_relative_offset = true;
459
OS << format("cu + 0x%" PRIx64, uvalue);
461
case DW_FORM_GNU_ref_alt:
462
OS << format("<alt 0x%" PRIx64 ">", uvalue);
465
// All DW_FORM_indirect attributes should be resolved prior to calling
467
case DW_FORM_indirect:
468
OS << "DW_FORM_indirect";
471
// Should be formatted to 64-bit for DWARF64.
472
case DW_FORM_sec_offset:
473
OS << format("0x%08x", (uint32_t)uvalue);
477
OS << format("DW_FORM(0x%4.4x)", Form);
481
if (cu_relative_offset) {
483
WithColor(OS, syntax::Address).get()
484
<< format("0x%8.8" PRIx64, uvalue + (cu ? cu->getOffset() : 0));
489
void DWARFFormValue::dumpString(raw_ostream &OS, const DWARFUnit *U) const {
490
Optional<const char *> DbgStr = getAsCString(U);
491
if (DbgStr.hasValue()) {
492
raw_ostream &COS = WithColor(OS, syntax::String);
494
COS.write_escaped(DbgStr.getValue());
499
Optional<const char *> DWARFFormValue::getAsCString(const DWARFUnit *U) const {
500
if (!isFormClass(FC_String))
502
if (Form == DW_FORM_string)
504
// FIXME: Add support for DW_FORM_GNU_strp_alt
505
if (Form == DW_FORM_GNU_strp_alt || U == nullptr)
507
uint32_t Offset = Value.uval;
508
if (Form == DW_FORM_GNU_str_index) {
510
if (!U->getStringOffsetSectionItem(Offset, StrOffset))
514
if (const char *Str = U->getStringExtractor().getCStr(&Offset)) {
520
Optional<uint64_t> DWARFFormValue::getAsAddress(const DWARFUnit *U) const {
521
if (!isFormClass(FC_Address))
523
if (Form == DW_FORM_GNU_addr_index) {
524
uint32_t Index = Value.uval;
526
if (!U || !U->getAddrOffsetSectionItem(Index, Result))
533
Optional<uint64_t> DWARFFormValue::getAsReference(const DWARFUnit *U) const {
534
if (!isFormClass(FC_Reference))
541
case DW_FORM_ref_udata:
544
return Value.uval + U->getOffset();
545
case DW_FORM_ref_addr:
547
// FIXME: Add proper support for DW_FORM_ref_sig8 and DW_FORM_GNU_ref_alt.
553
Optional<uint64_t> DWARFFormValue::getAsSectionOffset() const {
554
if (!isFormClass(FC_SectionOffset))
559
Optional<uint64_t> DWARFFormValue::getAsUnsignedConstant() const {
560
if ((!isFormClass(FC_Constant) && !isFormClass(FC_Flag))
561
|| Form == DW_FORM_sdata)
566
Optional<int64_t> DWARFFormValue::getAsSignedConstant() const {
567
if ((!isFormClass(FC_Constant) && !isFormClass(FC_Flag)) ||
568
(Form == DW_FORM_udata && uint64_t(LLONG_MAX) < Value.uval))
572
return int32_t(Value.uval);
574
return int16_t(Value.uval);
576
return int8_t(Value.uval);
584
Optional<ArrayRef<uint8_t>> DWARFFormValue::getAsBlock() const {
585
if (!isFormClass(FC_Block) && !isFormClass(FC_Exprloc))
587
return ArrayRef<uint8_t>(Value.data, Value.uval);