1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151
|
//===-- ObjectFileWasm.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_WASM_OBJECTFILEWASM_H
#define LLDB_SOURCE_PLUGINS_OBJECTFILE_WASM_OBJECTFILEWASM_H
#include "lldb/Symbol/ObjectFile.h"
#include "lldb/Utility/ArchSpec.h"
namespace lldb_private {
namespace wasm {
/// Generic Wasm object file reader.
///
/// This class provides a generic wasm32 reader plugin implementing the
/// ObjectFile protocol.
class ObjectFileWasm : public ObjectFile {
public:
static void Initialize();
static void Terminate();
static ConstString GetPluginNameStatic();
static const char *GetPluginDescriptionStatic() {
return "WebAssembly object file reader.";
}
static ObjectFile *
CreateInstance(const lldb::ModuleSP &module_sp, lldb::DataBufferSP &data_sp,
lldb::offset_t data_offset, const FileSpec *file,
lldb::offset_t file_offset, lldb::offset_t length);
static ObjectFile *CreateMemoryInstance(const lldb::ModuleSP &module_sp,
lldb::DataBufferSP &data_sp,
const lldb::ProcessSP &process_sp,
lldb::addr_t header_addr);
static size_t GetModuleSpecifications(const FileSpec &file,
lldb::DataBufferSP &data_sp,
lldb::offset_t data_offset,
lldb::offset_t file_offset,
lldb::offset_t length,
ModuleSpecList &specs);
/// PluginInterface protocol.
/// \{
ConstString GetPluginName() override { return GetPluginNameStatic(); }
uint32_t GetPluginVersion() override { return 1; }
/// \}
/// 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); }
/// \}
/// ObjectFile Protocol.
/// \{
bool ParseHeader() override;
lldb::ByteOrder GetByteOrder() const override {
return m_arch.GetByteOrder();
}
bool IsExecutable() const override { return false; }
uint32_t GetAddressByteSize() const override {
return m_arch.GetAddressByteSize();
}
AddressClass GetAddressClass(lldb::addr_t file_addr) override {
return AddressClass::eInvalid;
}
Symtab *GetSymtab() override;
bool IsStripped() override { return !!GetExternalDebugInfoFileSpec(); }
void CreateSections(SectionList &unified_section_list) override;
void Dump(Stream *s) override;
ArchSpec GetArchitecture() override { return m_arch; }
UUID GetUUID() override { return m_uuid; }
uint32_t GetDependentModules(FileSpecList &files) override { return 0; }
Type CalculateType() override { return eTypeSharedLibrary; }
Strata CalculateStrata() override { return eStrataUser; }
bool SetLoadAddress(lldb_private::Target &target, lldb::addr_t value,
bool value_is_offset) override;
lldb_private::Address GetBaseAddress() override {
return IsInMemory() ? Address(m_memory_addr) : Address(0);
}
/// \}
/// A Wasm module that has external DWARF debug information should contain a
/// custom section named "external_debug_info", whose payload is an UTF-8
/// encoded string that points to a Wasm module that contains the debug
/// information for this module.
llvm::Optional<FileSpec> GetExternalDebugInfoFileSpec();
private:
ObjectFileWasm(const lldb::ModuleSP &module_sp, lldb::DataBufferSP &data_sp,
lldb::offset_t data_offset, const FileSpec *file,
lldb::offset_t offset, lldb::offset_t length);
ObjectFileWasm(const lldb::ModuleSP &module_sp,
lldb::DataBufferSP &header_data_sp,
const lldb::ProcessSP &process_sp, lldb::addr_t header_addr);
/// Wasm section decoding routines.
/// \{
bool DecodeNextSection(lldb::offset_t *offset_ptr);
bool DecodeSections();
/// \}
/// Read a range of bytes from the Wasm module.
DataExtractor ReadImageData(lldb::offset_t offset, uint32_t size);
typedef struct section_info {
lldb::offset_t offset;
uint32_t size;
uint32_t id;
ConstString name;
} section_info_t;
/// Wasm section header dump routines.
/// \{
void DumpSectionHeader(llvm::raw_ostream &ostream, const section_info_t &sh);
void DumpSectionHeaders(llvm::raw_ostream &ostream);
/// \}
std::vector<section_info_t> m_sect_infos;
ArchSpec m_arch;
UUID m_uuid;
};
} // namespace wasm
} // namespace lldb_private
#endif // LLDB_SOURCE_PLUGINS_OBJECTFILE_WASM_OBJECTFILEWASM_H
|