1//===- DWARFListTable.cpp ---------------------------------------------===//
2//
3// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4// See https://llvm.org/LICENSE.txt for license information.
5// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6//
7//===----------------------------------------------------------------------===//
8
9#include "llvm/DebugInfo/DWARF/DWARFListTable.h"
10#include "llvm/BinaryFormat/Dwarf.h"
11#include "llvm/DebugInfo/DWARF/DWARFContext.h"
12#include "llvm/Support/Errc.h"
13#include "llvm/Support/Error.h"
14#include "llvm/Support/FormatAdapters.h"
15#include "llvm/Support/FormatVariadic.h"
16#include "llvm/Support/raw_ostream.h"
17
18using namespace llvm;
19
20Error DWARFListTableHeader::extract(DWARFDataExtractor Data,
21 uint64_t *OffsetPtr) {
22 HeaderOffset = *OffsetPtr;
23 Error Err = Error::success();
24
25 std::tie(args&: HeaderData.Length, args&: Format) = Data.getInitialLength(Off: OffsetPtr, Err: &Err);
26 if (Err)
27 return createStringError(
28 EC: errc::invalid_argument, Fmt: "parsing %s table at offset 0x%" PRIx64 ": %s",
29 Vals: SectionName.data(), Vals: HeaderOffset, Vals: toString(E: std::move(Err)).c_str());
30
31 uint8_t OffsetByteSize = Format == dwarf::DWARF64 ? 8 : 4;
32 uint64_t FullLength =
33 HeaderData.Length + dwarf::getUnitLengthFieldByteSize(Format);
34 if (FullLength < getHeaderSize(Format))
35 return createStringError(EC: errc::invalid_argument,
36 Fmt: "%s table at offset 0x%" PRIx64
37 " has too small length (0x%" PRIx64
38 ") to contain a complete header",
39 Vals: SectionName.data(), Vals: HeaderOffset, Vals: FullLength);
40 assert(FullLength == length() && "Inconsistent calculation of length.");
41 uint64_t End = HeaderOffset + FullLength;
42 if (!Data.isValidOffsetForDataOfSize(offset: HeaderOffset, length: FullLength))
43 return createStringError(EC: errc::invalid_argument,
44 Fmt: "section is not large enough to contain a %s table "
45 "of length 0x%" PRIx64 " at offset 0x%" PRIx64,
46 Vals: SectionName.data(), Vals: FullLength, Vals: HeaderOffset);
47
48 HeaderData.Version = Data.getU16(offset_ptr: OffsetPtr);
49 HeaderData.AddrSize = Data.getU8(offset_ptr: OffsetPtr);
50 HeaderData.SegSize = Data.getU8(offset_ptr: OffsetPtr);
51 HeaderData.OffsetEntryCount = Data.getU32(offset_ptr: OffsetPtr);
52
53 // Perform basic validation of the remaining header fields.
54 if (HeaderData.Version < 5 || HeaderData.Version > 6)
55 return createStringError(EC: errc::invalid_argument,
56 Fmt: "unrecognised %s table version %" PRIu16
57 " in table at offset 0x%" PRIx64,
58 Vals: SectionName.data(), Vals: HeaderData.Version, Vals: HeaderOffset);
59 if (Error SizeErr = DWARFContext::checkAddressSizeSupported(
60 AddressSize: HeaderData.AddrSize, EC: errc::not_supported,
61 Fmt: "%s table at offset 0x%" PRIx64, Vals: SectionName.data(), Vals: HeaderOffset))
62 return SizeErr;
63 if (HeaderData.SegSize != 0)
64 return createStringError(EC: errc::not_supported,
65 Fmt: "%s table at offset 0x%" PRIx64
66 " has unsupported segment selector size %" PRIu8,
67 Vals: SectionName.data(), Vals: HeaderOffset, Vals: HeaderData.SegSize);
68 if (End < HeaderOffset + getHeaderSize(Format) +
69 HeaderData.OffsetEntryCount * OffsetByteSize)
70 return createStringError(EC: errc::invalid_argument,
71 Fmt: "%s table at offset 0x%" PRIx64 " has more offset entries (%" PRIu32
72 ") than there is space for",
73 Vals: SectionName.data(), Vals: HeaderOffset, Vals: HeaderData.OffsetEntryCount);
74 Data.setAddressSize(HeaderData.AddrSize);
75 *OffsetPtr += HeaderData.OffsetEntryCount * OffsetByteSize;
76 return Error::success();
77}
78
79void DWARFListTableHeader::dump(DataExtractor Data, raw_ostream &OS,
80 DIDumpOptions DumpOpts) const {
81 if (DumpOpts.Verbose)
82 OS << formatv(Fmt: "{0:x8}: ", Vals: HeaderOffset);
83 int OffsetDumpWidth = 2 * dwarf::getDwarfOffsetByteSize(Format);
84 OS << formatv(Fmt: "{0} list header: length = 0x{1:x-}", Vals: ListTypeString.data(),
85 Vals: fmt_align(Item: HeaderData.Length, Where: AlignStyle::Right, Amount: OffsetDumpWidth,
86 Fill: '0'))
87 << ", format = " << dwarf::FormatString(Format)
88 << formatv(Fmt: ", version = {0:x4}, addr_size = {1:x2}"
89 ", seg_size = {2:x2}"
90 ", offset_entry_count = {3:x8}\n",
91 Vals: HeaderData.Version, Vals: HeaderData.AddrSize, Vals: HeaderData.SegSize,
92 Vals: HeaderData.OffsetEntryCount);
93
94 if (HeaderData.OffsetEntryCount > 0) {
95 OS << "offsets: [";
96 for (uint32_t I = 0; I < HeaderData.OffsetEntryCount; ++I) {
97 auto Off = *getOffsetEntry(Data, Index: I);
98 OS << formatv(Fmt: "\n0x{0:x-}",
99 Vals: fmt_align(Item&: Off, Where: AlignStyle::Right, Amount: OffsetDumpWidth, Fill: '0'));
100 if (DumpOpts.Verbose)
101 OS << formatv(Fmt: " => {0:x8}", Vals: Off + HeaderOffset + getHeaderSize(Format));
102 }
103 OS << "\n]\n";
104 }
105}
106
107uint64_t DWARFListTableHeader::length() const {
108 if (HeaderData.Length == 0)
109 return 0;
110 return HeaderData.Length + dwarf::getUnitLengthFieldByteSize(Format);
111}
112