Skip to content

Commit 6332990

Browse files
igorkudrinigorkudrin
committed
[DWARF] Support DWARF64 in DWARFDebugArangeSet.
This allows parsing Address Range Tables in the 64-bit DWARF format. Differential Revision: https://reviews.llvm.org/D71876
1 parent a0f367f commit 6332990

File tree

4 files changed

+95
-22
lines changed

4 files changed

+95
-22
lines changed

‎llvm/include/llvm/DebugInfo/DWARF/DWARFDebugArangeSet.h

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -24,10 +24,10 @@ class DWARFDebugArangeSet {
2424
struct Header {
2525
/// The total length of the entries for that set, not including the length
2626
/// field itself.
27-
uint32_t Length;
27+
uint64_t Length;
2828
/// The offset from the beginning of the .debug_info section of the
2929
/// compilation unit entry referenced by the table.
30-
uint32_t CuOffset;
30+
uint64_t CuOffset;
3131
/// The DWARF version number.
3232
uint16_t Version;
3333
/// The size in bytes of an address on the target architecture. For segmented
@@ -61,7 +61,7 @@ class DWARFDebugArangeSet {
6161
Error extract(DataExtractor data, uint64_t *offset_ptr);
6262
void dump(raw_ostream &OS) const;
6363

64-
uint32_t getCompileUnitDIEOffset() const { return HeaderData.CuOffset; }
64+
uint64_t getCompileUnitDIEOffset() const { return HeaderData.CuOffset; }
6565

6666
const Header &getHeader() const { return HeaderData; }
6767

‎llvm/lib/DebugInfo/DWARF/DWARFDebugArangeSet.cpp

Lines changed: 45 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@
77
//===----------------------------------------------------------------------===//
88

99
#include "llvm/DebugInfo/DWARF/DWARFDebugArangeSet.h"
10+
#include "llvm/BinaryFormat/Dwarf.h"
1011
#include "llvm/Support/Errc.h"
1112
#include "llvm/Support/Format.h"
1213
#include "llvm/Support/raw_ostream.h"
@@ -35,28 +36,51 @@ Error DWARFDebugArangeSet::extract(DataExtractor data, uint64_t *offset_ptr) {
3536
ArangeDescriptors.clear();
3637
Offset = *offset_ptr;
3738

38-
// 7.20 Address Range Table
39-
//
39+
// 7.21 Address Range Table (extract)
4040
// Each set of entries in the table of address ranges contained in
41-
// the .debug_aranges section begins with a header consisting of: a
42-
// 4-byte length containing the length of the set of entries for this
43-
// compilation unit, not including the length field itself; a 2-byte
44-
// version identifier containing the value 2 for DWARF Version 2; a
45-
// 4-byte offset into the.debug_infosection; a 1-byte unsigned integer
46-
// containing the size in bytes of an address (or the offset portion of
47-
// an address for segmented addressing) on the target system; and a
48-
// 1-byte unsigned integer containing the size in bytes of a segment
49-
// descriptor on the target system. This header is followed by a series
50-
// of tuples. Each tuple consists of an address and a length, each in
51-
// the size appropriate for an address on the target architecture.
41+
// the .debug_aranges section begins with a header containing:
42+
// 1. unit_length (initial length)
43+
// A 4-byte (32-bit DWARF) or 12-byte (64-bit DWARF) length containing
44+
// the length of the set of entries for this compilation unit,
45+
// not including the length field itself.
46+
// 2. version (uhalf)
47+
// The value in this field is 2.
48+
// 3. debug_info_offset (section offset)
49+
// A 4-byte (32-bit DWARF) or 8-byte (64-bit DWARF) offset into the
50+
// .debug_info section of the compilation unit header.
51+
// 4. address_size (ubyte)
52+
// 5. segment_selector_size (ubyte)
53+
// This header is followed by a series of tuples. Each tuple consists of
54+
// a segment, an address and a length. The segment selector size is given by
55+
// the segment_selector_size field of the header; the address and length
56+
// size are each given by the address_size field of the header. Each set of
57+
// tuples is terminated by a 0 for the segment, a 0 for the address and 0
58+
// for the length. If the segment_selector_size field in the header is zero,
59+
// the segment selectors are omitted from all tuples, including
60+
// the terminating tuple.
61+
62+
dwarf::DwarfFormat format = dwarf::DWARF32;
5263
HeaderData.Length = data.getU32(offset_ptr);
64+
if (HeaderData.Length == dwarf::DW_LENGTH_DWARF64) {
65+
HeaderData.Length = data.getU64(offset_ptr);
66+
format = dwarf::DWARF64;
67+
} else if (HeaderData.Length >= dwarf::DW_LENGTH_lo_reserved) {
68+
return createStringError(
69+
errc::invalid_argument,
70+
"address range table at offset 0x%" PRIx64
71+
" has unsupported reserved unit length of value 0x%8.8" PRIx64,
72+
Offset, HeaderData.Length);
73+
}
5374
HeaderData.Version = data.getU16(offset_ptr);
54-
HeaderData.CuOffset = data.getU32(offset_ptr);
75+
HeaderData.CuOffset =
76+
data.getUnsigned(offset_ptr, dwarf::getDwarfOffsetByteSize(format));
5577
HeaderData.AddrSize = data.getU8(offset_ptr);
5678
HeaderData.SegSize = data.getU8(offset_ptr);
5779

5880
// Perform basic validation of the header fields.
59-
if (!data.isValidOffsetForDataOfSize(Offset, HeaderData.Length + 4))
81+
uint64_t full_length =
82+
dwarf::getUnitLengthFieldByteSize(format) + HeaderData.Length;
83+
if (!data.isValidOffsetForDataOfSize(Offset, full_length))
6084
return createStringError(errc::invalid_argument,
6185
"the length of address range table at offset "
6286
"0x%" PRIx64 " exceeds section size",
@@ -105,10 +129,12 @@ Error DWARFDebugArangeSet::extract(DataExtractor data, uint64_t *offset_ptr) {
105129
}
106130

107131
void DWARFDebugArangeSet::dump(raw_ostream &OS) const {
108-
OS << format("Address Range Header: length = 0x%8.8x, version = 0x%4.4x, ",
109-
HeaderData.Length, HeaderData.Version)
110-
<< format("cu_offset = 0x%8.8x, addr_size = 0x%2.2x, seg_size = 0x%2.2x\n",
111-
HeaderData.CuOffset, HeaderData.AddrSize, HeaderData.SegSize);
132+
OS << "Address Range Header: "
133+
<< format("length = 0x%8.8" PRIx64 ", ", HeaderData.Length)
134+
<< format("version = 0x%4.4x, ", HeaderData.Version)
135+
<< format("cu_offset = 0x%8.8" PRIx64 ", ", HeaderData.CuOffset)
136+
<< format("addr_size = 0x%2.2x, ", HeaderData.AddrSize)
137+
<< format("seg_size = 0x%2.2x\n", HeaderData.SegSize);
112138

113139
for (const auto &Desc : ArangeDescriptors) {
114140
Desc.dump(OS, HeaderData.AddrSize);

‎llvm/test/DebugInfo/X86/dwarfdump-debug-aranges.s

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -63,3 +63,24 @@
6363
.quad 0, 0 # Termination tuple
6464
# CHECK-NOT: [0x
6565
.L3end:
66+
67+
## Case 4: Check that 64-bit DWARF format is supported.
68+
.long 0xffffffff # DWARF64 mark
69+
.quad .L4end - .L4version # Length
70+
# CHECK: Address Range Header: length = 0x0000001c,
71+
.L4version:
72+
.short 2 # Version
73+
.quad 0x1234567899aabbcc # Debug Info Offset
74+
.byte 4 # Address Size
75+
.byte 0 # Segment Selector Size
76+
# CHECK-SAME: version = 0x0002,
77+
# CHECK-SAME: cu_offset = 0x1234567899aabbcc,
78+
# CHECK-SAME: addr_size = 0x04,
79+
# CHECK-SAME: seg_size = 0x00
80+
# No padding
81+
.L4tuples:
82+
.long 0, 1 # Address and length
83+
# CHECK-NEXT: [0x00000000, 0x00000001)
84+
.long 0, 0 # Termination tuple
85+
# CHECK-NOT: [0x
86+
.L4end:

‎llvm/unittests/DebugInfo/DWARF/DWARFDebugArangeSetTest.cpp

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,23 @@ TEST(DWARFDebugArangeSet, LengthExceedsSectionSize) {
4141
"the length of address range table at offset 0x0 exceeds section size");
4242
}
4343

44+
TEST(DWARFDebugArangeSet, LengthExceedsSectionSizeDWARF64) {
45+
static const char DebugArangesSecRaw[] =
46+
"\xff\xff\xff\xff" // DWARF64 mark
47+
"\x15\x00\x00\x00\x00\x00\x00\x00" // The length exceeds the section
48+
// boundaries
49+
"\x02\x00" // Version
50+
"\x00\x00\x00\x00\x00\x00\x00\x00" // Debug Info Offset
51+
"\x04" // Address Size
52+
"\x00" // Segment Selector Size
53+
// No padding
54+
"\x00\x00\x00\x00" // Termination tuple
55+
"\x00\x00\x00\x00";
56+
ExpectExtractError(
57+
DebugArangesSecRaw,
58+
"the length of address range table at offset 0x0 exceeds section size");
59+
}
60+
4461
TEST(DWARFDebugArangeSet, UnsupportedAddressSize) {
4562
static const char DebugArangesSecRaw[] =
4663
"\x0c\x00\x00\x00" // Length
@@ -72,4 +89,13 @@ TEST(DWARFDebugArangeSet, NoTerminationEntry) {
7289
"address range table at offset 0x0 is not terminated by null entry");
7390
}
7491

92+
TEST(DWARFDebugArangeSet, ReservedUnitLength) {
93+
static const char DebugArangesSecRaw[] =
94+
"\xf0\xff\xff\xff"; // Reserved unit length value
95+
ExpectExtractError(
96+
DebugArangesSecRaw,
97+
"address range table at offset 0x0 has unsupported reserved unit length "
98+
"of value 0xfffffff0");
99+
}
100+
75101
} // end anonymous namespace

0 commit comments

Comments
 (0)