Jacek Caban 48feef277a [lldb] Treat ARM64X images as ARM64.
With D149091, ARM64X binaries are no longer reported as ARM64. This broke
lldb tests as Windows 11 system DLLs are mostly ARM64X binaries and lldb
doesn't know how to handle them. Ideally lldb would understand a bit more
about ARM64X and handle them as AMD64 in x64 processes, but this is
enough to preserve previous behavior and fix tests.

Reviewed By: mstorsjo
Differential Revision: https://reviews.llvm.org/D156268
2023-07-26 14:45:48 +02:00

292 lines
10 KiB
C++

//===-- ObjectFilePECOFF.h --------------------------------------*- C++ -*-===//
//
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
// See https://llvm.org/LICENSE.txt for license information.
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
//
//===----------------------------------------------------------------------===//
#ifndef LLDB_SOURCE_PLUGINS_OBJECTFILE_PECOFF_OBJECTFILEPECOFF_H
#define LLDB_SOURCE_PLUGINS_OBJECTFILE_PECOFF_OBJECTFILEPECOFF_H
#include <optional>
#include <vector>
#include "lldb/Symbol/ObjectFile.h"
#include "llvm/Object/COFF.h"
class ObjectFilePECOFF : public lldb_private::ObjectFile {
public:
enum MachineType {
MachineUnknown = 0x0,
MachineAm33 = 0x1d3,
MachineAmd64 = 0x8664,
MachineArm = 0x1c0,
MachineArmNt = 0x1c4,
MachineArm64 = 0xaa64,
MachineArm64X = 0xa64e,
MachineEbc = 0xebc,
MachineX86 = 0x14c,
MachineIA64 = 0x200,
MachineM32R = 0x9041,
MachineMips16 = 0x266,
MachineMipsFpu = 0x366,
MachineMipsFpu16 = 0x466,
MachinePowerPc = 0x1f0,
MachinePowerPcfp = 0x1f1,
MachineR4000 = 0x166,
MachineSh3 = 0x1a2,
MachineSh3dsp = 0x1a3,
MachineSh4 = 0x1a6,
MachineSh5 = 0x1a8,
MachineThumb = 0x1c2,
MachineWcemIpsv2 = 0x169
};
ObjectFilePECOFF(const lldb::ModuleSP &module_sp, lldb::DataBufferSP data_sp,
lldb::offset_t data_offset,
const lldb_private::FileSpec *file,
lldb::offset_t file_offset, lldb::offset_t length);
ObjectFilePECOFF(const lldb::ModuleSP &module_sp,
lldb::WritableDataBufferSP header_data_sp,
const lldb::ProcessSP &process_sp, lldb::addr_t header_addr);
~ObjectFilePECOFF() override;
// Static Functions
static void Initialize();
static void DebuggerInitialize(lldb_private::Debugger &debugger);
static void Terminate();
static llvm::StringRef GetPluginNameStatic() { return "pe-coff"; }
static llvm::StringRef GetPluginDescriptionStatic();
static ObjectFile *
CreateInstance(const lldb::ModuleSP &module_sp, lldb::DataBufferSP data_sp,
lldb::offset_t data_offset, const lldb_private::FileSpec *file,
lldb::offset_t offset, lldb::offset_t length);
static lldb_private::ObjectFile *CreateMemoryInstance(
const lldb::ModuleSP &module_sp, lldb::WritableDataBufferSP data_sp,
const lldb::ProcessSP &process_sp, lldb::addr_t header_addr);
static size_t GetModuleSpecifications(const lldb_private::FileSpec &file,
lldb::DataBufferSP &data_sp,
lldb::offset_t data_offset,
lldb::offset_t file_offset,
lldb::offset_t length,
lldb_private::ModuleSpecList &specs);
static bool SaveCore(const lldb::ProcessSP &process_sp,
const lldb_private::FileSpec &outfile,
lldb::SaveCoreStyle &core_style,
lldb_private::Status &error);
static bool MagicBytesMatch(lldb::DataBufferSP data_sp);
static lldb::SymbolType MapSymbolType(uint16_t coff_symbol_type);
// LLVM RTTI support
static char ID;
bool isA(const void *ClassID) const override {
return ClassID == &ID || ObjectFile::isA(ClassID);
}
static bool classof(const ObjectFile *obj) { return obj->isA(&ID); }
bool ParseHeader() override;
bool SetLoadAddress(lldb_private::Target &target, lldb::addr_t value,
bool value_is_offset) override;
lldb::ByteOrder GetByteOrder() const override;
bool IsExecutable() const override;
uint32_t GetAddressByteSize() const override;
// virtual lldb_private::AddressClass
// GetAddressClass (lldb::addr_t file_addr);
void ParseSymtab(lldb_private::Symtab &symtab) override;
bool IsStripped() override;
void CreateSections(lldb_private::SectionList &unified_section_list) override;
void Dump(lldb_private::Stream *s) override;
lldb_private::ArchSpec GetArchitecture() override;
lldb_private::UUID GetUUID() override;
/// Return the contents of the .gnu_debuglink section, if the object file
/// contains it.
std::optional<lldb_private::FileSpec> GetDebugLink();
uint32_t GetDependentModules(lldb_private::FileSpecList &files) override;
lldb_private::Address GetEntryPointAddress() override;
lldb_private::Address GetBaseAddress() override;
ObjectFile::Type CalculateType() override;
ObjectFile::Strata CalculateStrata() override;
// PluginInterface protocol
llvm::StringRef GetPluginName() override { return GetPluginNameStatic(); }
bool IsWindowsSubsystem();
uint32_t GetRVA(const lldb_private::Address &addr) const;
lldb_private::Address GetAddress(uint32_t rva);
lldb::addr_t GetFileAddress(uint32_t rva) const;
lldb_private::DataExtractor ReadImageData(uint32_t offset, size_t size);
lldb_private::DataExtractor ReadImageDataByRVA(uint32_t rva, size_t size);
std::unique_ptr<lldb_private::CallFrameInfo> CreateCallFrameInfo() override;
protected:
bool NeedsEndianSwap() const;
typedef struct dos_header { // DOS .EXE header
uint16_t e_magic = 0; // Magic number
uint16_t e_cblp = 0; // Bytes on last page of file
uint16_t e_cp = 0; // Pages in file
uint16_t e_crlc = 0; // Relocations
uint16_t e_cparhdr = 0; // Size of header in paragraphs
uint16_t e_minalloc = 0; // Minimum extra paragraphs needed
uint16_t e_maxalloc = 0; // Maximum extra paragraphs needed
uint16_t e_ss = 0; // Initial (relative) SS value
uint16_t e_sp = 0; // Initial SP value
uint16_t e_csum = 0; // Checksum
uint16_t e_ip = 0; // Initial IP value
uint16_t e_cs = 0; // Initial (relative) CS value
uint16_t e_lfarlc = 0; // File address of relocation table
uint16_t e_ovno = 0; // Overlay number
uint16_t e_res[4]; // Reserved words
uint16_t e_oemid = 0; // OEM identifier (for e_oeminfo)
uint16_t e_oeminfo = 0; // OEM information; e_oemid specific
uint16_t e_res2[10] = {}; // Reserved words
uint32_t e_lfanew = 0; // File address of new exe header
} dos_header_t;
typedef struct coff_header {
uint16_t machine = 0;
uint16_t nsects = 0;
uint32_t modtime = 0;
uint32_t symoff = 0;
uint32_t nsyms = 0;
uint16_t hdrsize = 0;
uint16_t flags = 0;
} coff_header_t;
typedef struct data_directory {
uint32_t vmaddr = 0;
uint32_t vmsize = 0;
} data_directory_t;
typedef struct coff_opt_header {
uint16_t magic = 0;
uint8_t major_linker_version = 0;
uint8_t minor_linker_version = 0;
uint32_t code_size = 0;
uint32_t data_size = 0;
uint32_t bss_size = 0;
uint32_t entry = 0;
uint32_t code_offset = 0;
uint32_t data_offset = 0;
uint64_t image_base = 0;
uint32_t sect_alignment = 0;
uint32_t file_alignment = 0;
uint16_t major_os_system_version = 0;
uint16_t minor_os_system_version = 0;
uint16_t major_image_version = 0;
uint16_t minor_image_version = 0;
uint16_t major_subsystem_version = 0;
uint16_t minor_subsystem_version = 0;
uint32_t reserved1 = 0;
uint32_t image_size = 0;
uint32_t header_size = 0;
uint32_t checksum = 0;
uint16_t subsystem = 0;
uint16_t dll_flags = 0;
uint64_t stack_reserve_size = 0;
uint64_t stack_commit_size = 0;
uint64_t heap_reserve_size = 0;
uint64_t heap_commit_size = 0;
uint32_t loader_flags = 0;
// uint32_t num_data_dir_entries;
std::vector<data_directory>
data_dirs; // will contain num_data_dir_entries entries
} coff_opt_header_t;
typedef struct section_header {
char name[8] = {};
uint32_t vmsize = 0; // Virtual Size
uint32_t vmaddr = 0; // Virtual Addr
uint32_t size = 0; // File size
uint32_t offset = 0; // File offset
uint32_t reloff = 0; // Offset to relocations
uint32_t lineoff = 0; // Offset to line table entries
uint16_t nreloc = 0; // Number of relocation entries
uint16_t nline = 0; // Number of line table entries
uint32_t flags = 0;
} section_header_t;
static bool ParseDOSHeader(lldb_private::DataExtractor &data,
dos_header_t &dos_header);
static bool ParseCOFFHeader(lldb_private::DataExtractor &data,
lldb::offset_t *offset_ptr,
coff_header_t &coff_header);
bool ParseCOFFOptionalHeader(lldb::offset_t *offset_ptr);
bool ParseSectionHeaders(uint32_t offset);
uint32_t ParseDependentModules();
static void DumpDOSHeader(lldb_private::Stream *s,
const dos_header_t &header);
static void DumpCOFFHeader(lldb_private::Stream *s,
const coff_header_t &header);
static void DumpOptCOFFHeader(lldb_private::Stream *s,
const coff_opt_header_t &header);
void DumpSectionHeaders(lldb_private::Stream *s);
void DumpSectionHeader(lldb_private::Stream *s, const section_header_t &sh);
void DumpDependentModules(lldb_private::Stream *s);
llvm::StringRef GetSectionName(const section_header_t &sect);
static lldb::SectionType GetSectionType(llvm::StringRef sect_name,
const section_header_t &sect);
typedef std::vector<section_header_t> SectionHeaderColl;
typedef SectionHeaderColl::iterator SectionHeaderCollIter;
typedef SectionHeaderColl::const_iterator SectionHeaderCollConstIter;
private:
bool CreateBinary();
typedef std::vector<std::pair<uint32_t, uint32_t>> rva_symbol_list_t;
void AppendFromCOFFSymbolTable(lldb_private::SectionList *sect_list,
lldb_private::Symtab &symtab,
const rva_symbol_list_t &sorted_exports);
rva_symbol_list_t AppendFromExportTable(lldb_private::SectionList *sect_list,
lldb_private::Symtab &symtab);
dos_header_t m_dos_header;
coff_header_t m_coff_header;
coff_opt_header_t m_coff_header_opt;
SectionHeaderColl m_sect_headers;
lldb::addr_t m_image_base;
lldb_private::Address m_entry_point_address;
std::optional<lldb_private::FileSpecList> m_deps_filespec;
std::unique_ptr<llvm::object::COFFObjectFile> m_binary;
lldb_private::UUID m_uuid;
};
#endif // LLDB_SOURCE_PLUGINS_OBJECTFILE_PECOFF_OBJECTFILEPECOFF_H