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