xref: /llvm-project/llvm/lib/DebugInfo/DWARF/DWARFListTable.cpp (revision d7733f84228bde1079117e82b36fac94e9b323ed)
1439801baSWolfgang Pieb //===- DWARFListTable.cpp ---------------------------------------------===//
2439801baSWolfgang Pieb //
32946cd70SChandler Carruth // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
42946cd70SChandler Carruth // See https://llvm.org/LICENSE.txt for license information.
52946cd70SChandler Carruth // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6439801baSWolfgang Pieb //
7439801baSWolfgang Pieb //===----------------------------------------------------------------------===//
8439801baSWolfgang Pieb 
9439801baSWolfgang Pieb #include "llvm/DebugInfo/DWARF/DWARFListTable.h"
10439801baSWolfgang Pieb #include "llvm/BinaryFormat/Dwarf.h"
11*d7733f84SJack Anderson #include "llvm/DebugInfo/DWARF/DWARFContext.h"
12cba595daSVictor Leschuk #include "llvm/Support/Errc.h"
13439801baSWolfgang Pieb #include "llvm/Support/Error.h"
14439801baSWolfgang Pieb #include "llvm/Support/Format.h"
15439801baSWolfgang Pieb #include "llvm/Support/raw_ostream.h"
16439801baSWolfgang Pieb 
17439801baSWolfgang Pieb using namespace llvm;
18439801baSWolfgang Pieb 
extract(DWARFDataExtractor Data,uint64_t * OffsetPtr)19439801baSWolfgang Pieb Error DWARFListTableHeader::extract(DWARFDataExtractor Data,
20f26a70a5SIgor Kudrin                                     uint64_t *OffsetPtr) {
21439801baSWolfgang Pieb   HeaderOffset = *OffsetPtr;
22164e2c85SPavel Labath   Error Err = Error::success();
23164e2c85SPavel Labath 
24164e2c85SPavel Labath   std::tie(HeaderData.Length, Format) = Data.getInitialLength(OffsetPtr, &Err);
25164e2c85SPavel Labath   if (Err)
26164e2c85SPavel Labath     return createStringError(
27164e2c85SPavel Labath         errc::invalid_argument, "parsing %s table at offset 0x%" PRIx64 ": %s",
28164e2c85SPavel Labath         SectionName.data(), HeaderOffset, toString(std::move(Err)).c_str());
29164e2c85SPavel Labath 
30164e2c85SPavel Labath   uint8_t OffsetByteSize = Format == dwarf::DWARF64 ? 8 : 4;
31991f0fb1SIgor Kudrin   uint64_t FullLength =
32991f0fb1SIgor Kudrin       HeaderData.Length + dwarf::getUnitLengthFieldByteSize(Format);
33991f0fb1SIgor Kudrin   if (FullLength < getHeaderSize(Format))
34991f0fb1SIgor Kudrin     return createStringError(errc::invalid_argument,
35991f0fb1SIgor Kudrin                        "%s table at offset 0x%" PRIx64
36991f0fb1SIgor Kudrin                        " has too small length (0x%" PRIx64
37439801baSWolfgang Pieb                        ") to contain a complete header",
38991f0fb1SIgor Kudrin                        SectionName.data(), HeaderOffset, FullLength);
39ec9f0c7dSIgor Kudrin   assert(FullLength == length() && "Inconsistent calculation of length.");
40991f0fb1SIgor Kudrin   uint64_t End = HeaderOffset + FullLength;
41991f0fb1SIgor Kudrin   if (!Data.isValidOffsetForDataOfSize(HeaderOffset, FullLength))
42f39a9bbeSWolfgang Pieb     return createStringError(errc::invalid_argument,
43cba595daSVictor Leschuk                        "section is not large enough to contain a %s table "
44991f0fb1SIgor Kudrin                        "of length 0x%" PRIx64 " at offset 0x%" PRIx64,
45991f0fb1SIgor Kudrin                        SectionName.data(), FullLength, HeaderOffset);
46439801baSWolfgang Pieb 
47439801baSWolfgang Pieb   HeaderData.Version = Data.getU16(OffsetPtr);
48439801baSWolfgang Pieb   HeaderData.AddrSize = Data.getU8(OffsetPtr);
49439801baSWolfgang Pieb   HeaderData.SegSize = Data.getU8(OffsetPtr);
50439801baSWolfgang Pieb   HeaderData.OffsetEntryCount = Data.getU32(OffsetPtr);
51439801baSWolfgang Pieb 
52439801baSWolfgang Pieb   // Perform basic validation of the remaining header fields.
53f39a9bbeSWolfgang Pieb   if (HeaderData.Version != 5)
54cba595daSVictor Leschuk     return createStringError(errc::invalid_argument,
55cba595daSVictor Leschuk                        "unrecognised %s table version %" PRIu16
56f26a70a5SIgor Kudrin                        " in table at offset 0x%" PRIx64,
57f39a9bbeSWolfgang Pieb                        SectionName.data(), HeaderData.Version, HeaderOffset);
58*d7733f84SJack Anderson   if (Error SizeErr = DWARFContext::checkAddressSizeSupported(
59*d7733f84SJack Anderson           HeaderData.AddrSize, errc::not_supported,
60*d7733f84SJack Anderson           "%s table at offset 0x%" PRIx64, SectionName.data(), HeaderOffset))
61*d7733f84SJack Anderson     return SizeErr;
62f39a9bbeSWolfgang Pieb   if (HeaderData.SegSize != 0)
63cba595daSVictor Leschuk     return createStringError(errc::not_supported,
64f26a70a5SIgor Kudrin                        "%s table at offset 0x%" PRIx64
65439801baSWolfgang Pieb                        " has unsupported segment selector size %" PRIu8,
66439801baSWolfgang Pieb                        SectionName.data(), HeaderOffset, HeaderData.SegSize);
67991f0fb1SIgor Kudrin   if (End < HeaderOffset + getHeaderSize(Format) +
68991f0fb1SIgor Kudrin                 HeaderData.OffsetEntryCount * OffsetByteSize)
69cba595daSVictor Leschuk     return createStringError(errc::invalid_argument,
70f26a70a5SIgor Kudrin         "%s table at offset 0x%" PRIx64 " has more offset entries (%" PRIu32
71439801baSWolfgang Pieb         ") than there is space for",
72439801baSWolfgang Pieb         SectionName.data(), HeaderOffset, HeaderData.OffsetEntryCount);
73439801baSWolfgang Pieb   Data.setAddressSize(HeaderData.AddrSize);
74f7a49d2aSDavid Blaikie   *OffsetPtr += HeaderData.OffsetEntryCount * OffsetByteSize;
75439801baSWolfgang Pieb   return Error::success();
76439801baSWolfgang Pieb }
77439801baSWolfgang Pieb 
dump(DataExtractor Data,raw_ostream & OS,DIDumpOptions DumpOpts) const78f7a49d2aSDavid Blaikie void DWARFListTableHeader::dump(DataExtractor Data, raw_ostream &OS,
79f7a49d2aSDavid Blaikie                                 DIDumpOptions DumpOpts) const {
80439801baSWolfgang Pieb   if (DumpOpts.Verbose)
81f26a70a5SIgor Kudrin     OS << format("0x%8.8" PRIx64 ": ", HeaderOffset);
822094c5d2SIgor Kudrin   int OffsetDumpWidth = 2 * dwarf::getDwarfOffsetByteSize(Format);
83def67719SIgor Kudrin   OS << format("%s list header: length = 0x%0*" PRIx64, ListTypeString.data(),
84def67719SIgor Kudrin                OffsetDumpWidth, HeaderData.Length)
85def67719SIgor Kudrin      << ", format = " << dwarf::FormatString(Format)
86def67719SIgor Kudrin      << format(", version = 0x%4.4" PRIx16 ", addr_size = 0x%2.2" PRIx8
872094c5d2SIgor Kudrin                ", seg_size = 0x%2.2" PRIx8
882094c5d2SIgor Kudrin                ", offset_entry_count = 0x%8.8" PRIx32 "\n",
892094c5d2SIgor Kudrin                HeaderData.Version, HeaderData.AddrSize, HeaderData.SegSize,
902094c5d2SIgor Kudrin                HeaderData.OffsetEntryCount);
91439801baSWolfgang Pieb 
92439801baSWolfgang Pieb   if (HeaderData.OffsetEntryCount > 0) {
93439801baSWolfgang Pieb     OS << "offsets: [";
94f7a49d2aSDavid Blaikie     for (uint32_t I = 0; I < HeaderData.OffsetEntryCount; ++I) {
95f7a49d2aSDavid Blaikie       auto Off = *getOffsetEntry(Data, I);
962094c5d2SIgor Kudrin       OS << format("\n0x%0*" PRIx64, OffsetDumpWidth, Off);
97439801baSWolfgang Pieb       if (DumpOpts.Verbose)
982094c5d2SIgor Kudrin         OS << format(" => 0x%08" PRIx64,
99991f0fb1SIgor Kudrin                      Off + HeaderOffset + getHeaderSize(Format));
100439801baSWolfgang Pieb     }
101439801baSWolfgang Pieb     OS << "\n]\n";
102439801baSWolfgang Pieb   }
103439801baSWolfgang Pieb }
104439801baSWolfgang Pieb 
length() const105991f0fb1SIgor Kudrin uint64_t DWARFListTableHeader::length() const {
106439801baSWolfgang Pieb   if (HeaderData.Length == 0)
107439801baSWolfgang Pieb     return 0;
108991f0fb1SIgor Kudrin   return HeaderData.Length + dwarf::getUnitLengthFieldByteSize(Format);
109439801baSWolfgang Pieb }
110