110 lines · cpp
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-exception6//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/Format.h"15#include "llvm/Support/raw_ostream.h"16 17using namespace llvm;18 19Error DWARFListTableHeader::extract(DWARFDataExtractor Data,20 uint64_t *OffsetPtr) {21 HeaderOffset = *OffsetPtr;22 Error Err = Error::success();23 24 std::tie(HeaderData.Length, Format) = Data.getInitialLength(OffsetPtr, &Err);25 if (Err)26 return createStringError(27 errc::invalid_argument, "parsing %s table at offset 0x%" PRIx64 ": %s",28 SectionName.data(), HeaderOffset, toString(std::move(Err)).c_str());29 30 uint8_t OffsetByteSize = Format == dwarf::DWARF64 ? 8 : 4;31 uint64_t FullLength =32 HeaderData.Length + dwarf::getUnitLengthFieldByteSize(Format);33 if (FullLength < getHeaderSize(Format))34 return createStringError(errc::invalid_argument,35 "%s table at offset 0x%" PRIx6436 " has too small length (0x%" PRIx6437 ") to contain a complete header",38 SectionName.data(), HeaderOffset, FullLength);39 assert(FullLength == length() && "Inconsistent calculation of length.");40 uint64_t End = HeaderOffset + FullLength;41 if (!Data.isValidOffsetForDataOfSize(HeaderOffset, FullLength))42 return createStringError(errc::invalid_argument,43 "section is not large enough to contain a %s table "44 "of length 0x%" PRIx64 " at offset 0x%" PRIx64,45 SectionName.data(), FullLength, HeaderOffset);46 47 HeaderData.Version = Data.getU16(OffsetPtr);48 HeaderData.AddrSize = Data.getU8(OffsetPtr);49 HeaderData.SegSize = Data.getU8(OffsetPtr);50 HeaderData.OffsetEntryCount = Data.getU32(OffsetPtr);51 52 // Perform basic validation of the remaining header fields.53 if (HeaderData.Version != 5)54 return createStringError(errc::invalid_argument,55 "unrecognised %s table version %" PRIu1656 " in table at offset 0x%" PRIx64,57 SectionName.data(), HeaderData.Version, HeaderOffset);58 if (Error SizeErr = DWARFContext::checkAddressSizeSupported(59 HeaderData.AddrSize, errc::not_supported,60 "%s table at offset 0x%" PRIx64, SectionName.data(), HeaderOffset))61 return SizeErr;62 if (HeaderData.SegSize != 0)63 return createStringError(errc::not_supported,64 "%s table at offset 0x%" PRIx6465 " has unsupported segment selector size %" PRIu8,66 SectionName.data(), HeaderOffset, HeaderData.SegSize);67 if (End < HeaderOffset + getHeaderSize(Format) +68 HeaderData.OffsetEntryCount * OffsetByteSize)69 return createStringError(errc::invalid_argument,70 "%s table at offset 0x%" PRIx64 " has more offset entries (%" PRIu3271 ") than there is space for",72 SectionName.data(), HeaderOffset, HeaderData.OffsetEntryCount);73 Data.setAddressSize(HeaderData.AddrSize);74 *OffsetPtr += HeaderData.OffsetEntryCount * OffsetByteSize;75 return Error::success();76}77 78void DWARFListTableHeader::dump(DataExtractor Data, raw_ostream &OS,79 DIDumpOptions DumpOpts) const {80 if (DumpOpts.Verbose)81 OS << format("0x%8.8" PRIx64 ": ", HeaderOffset);82 int OffsetDumpWidth = 2 * dwarf::getDwarfOffsetByteSize(Format);83 OS << format("%s list header: length = 0x%0*" PRIx64, ListTypeString.data(),84 OffsetDumpWidth, HeaderData.Length)85 << ", format = " << dwarf::FormatString(Format)86 << format(", version = 0x%4.4" PRIx16 ", addr_size = 0x%2.2" PRIx887 ", seg_size = 0x%2.2" PRIx888 ", offset_entry_count = 0x%8.8" PRIx32 "\n",89 HeaderData.Version, HeaderData.AddrSize, HeaderData.SegSize,90 HeaderData.OffsetEntryCount);91 92 if (HeaderData.OffsetEntryCount > 0) {93 OS << "offsets: [";94 for (uint32_t I = 0; I < HeaderData.OffsetEntryCount; ++I) {95 auto Off = *getOffsetEntry(Data, I);96 OS << format("\n0x%0*" PRIx64, OffsetDumpWidth, Off);97 if (DumpOpts.Verbose)98 OS << format(" => 0x%08" PRIx64,99 Off + HeaderOffset + getHeaderSize(Format));100 }101 OS << "\n]\n";102 }103}104 105uint64_t DWARFListTableHeader::length() const {106 if (HeaderData.Length == 0)107 return 0;108 return HeaderData.Length + dwarf::getUnitLengthFieldByteSize(Format);109}110