// This file is part of Substrate. // Copyright (C) Parity Technologies (UK) Ltd. // SPDX-License-Identifier: GPL-3.0-or-later WITH Classpath-exception-2.0 // This program is free software: you can redistribute it and/or modify // it under the terms of the GNU General Public License as published by // the Free Software Foundation, either version 3 of the License, or // (at your option) any later version. // This program is distributed in the hope that it will be useful, // but WITHOUT ANY WARRANTY; without even the implied warranty of // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the // GNU General Public License for more details. // You should have received a copy of the GNU General Public License // along with this program. If not, see . use polkavm::{Caller, Reg}; use sc_executor_common::{ error::{Error, WasmError}, wasm_runtime::{AllocationStats, WasmInstance, WasmModule}, }; use sp_wasm_interface::{ Function, FunctionContext, HostFunctions, Pointer, Value, ValueType, WordSize, }; #[repr(transparent)] pub struct InstancePre(polkavm::InstancePre<()>); #[repr(transparent)] pub struct Instance(polkavm::Instance<()>); impl WasmModule for InstancePre { fn new_instance(&self) -> Result, Error> { Ok(Box::new(Instance(self.0.instantiate()?))) } } impl WasmInstance for Instance { fn call_with_allocation_stats( &mut self, name: &str, raw_data: &[u8], ) -> (Result, Error>, Option) { let Some(method_index) = self.0.module().lookup_export(name) else { return ( Err(format!("cannot call into the runtime: export not found: '{name}'").into()), None, ); }; let Ok(raw_data_length) = u32::try_from(raw_data.len()) else { return ( Err(format!("cannot call runtime method '{name}': input payload is too big").into()), None, ); }; // TODO: This will leak guest memory; find a better solution. let mut state_args = polkavm::StateArgs::new(); // Make sure the memory is cleared... state_args.reset_memory(true); // ...and allocate space for the input payload. state_args.sbrk(raw_data_length); match self.0.update_state(state_args) { Ok(()) => {}, Err(polkavm::ExecutionError::Trap(trap)) => { return (Err(format!("call into the runtime method '{name}' failed: failed to prepare the guest's memory: {trap}").into()), None); }, Err(polkavm::ExecutionError::Error(error)) => { return (Err(format!("call into the runtime method '{name}' failed: failed to prepare the guest's memory: {error}").into()), None); }, Err(polkavm::ExecutionError::OutOfGas) => unreachable!("gas metering is never enabled"), } // Grab the address of where the guest's heap starts; that's where we've just allocated // the memory for the input payload. let data_pointer = self.0.module().memory_map().heap_base(); if let Err(error) = self.0.write_memory(data_pointer, raw_data) { return (Err(format!("call into the runtime method '{name}': failed to write the input payload into guest memory: {error}").into()), None); } let mut state = (); let mut call_args = polkavm::CallArgs::new(&mut state, method_index); call_args.args_untyped(&[data_pointer, raw_data_length]); match self.0.call(Default::default(), call_args) { Ok(()) => {}, Err(polkavm::ExecutionError::Trap(trap)) => { return ( Err(format!("call into the runtime method '{name}' failed: {trap}").into()), None, ); }, Err(polkavm::ExecutionError::Error(error)) => { return ( Err(format!("call into the runtime method '{name}' failed: {error}").into()), None, ); }, Err(polkavm::ExecutionError::OutOfGas) => unreachable!("gas metering is never enabled"), } let result_pointer = self.0.get_reg(Reg::A0); let result_length = self.0.get_reg(Reg::A1); let output = match self.0.read_memory_into_vec(result_pointer, result_length) { Ok(output) => output, Err(error) => { return (Err(format!("call into the runtime method '{name}' failed: failed to read the return payload: {error}").into()), None) }, }; (Ok(output), None) } } struct Context<'r, 'a>(&'r mut polkavm::Caller<'a, ()>); impl<'r, 'a> FunctionContext for Context<'r, 'a> { fn read_memory_into( &self, address: Pointer, dest: &mut [u8], ) -> sp_wasm_interface::Result<()> { self.0 .read_memory_into_slice(u32::from(address), dest) .map_err(|error| error.to_string()) .map(|_| ()) } fn write_memory(&mut self, address: Pointer, data: &[u8]) -> sp_wasm_interface::Result<()> { self.0.write_memory(u32::from(address), data).map_err(|error| error.to_string()) } fn allocate_memory(&mut self, size: WordSize) -> sp_wasm_interface::Result> { let pointer = self.0.sbrk(0).expect("fetching the current heap pointer never fails"); // TODO: This will leak guest memory; find a better solution. self.0.sbrk(size).ok_or_else(|| String::from("allocation failed"))?; Ok(Pointer::new(pointer)) } fn deallocate_memory(&mut self, _ptr: Pointer) -> sp_wasm_interface::Result<()> { // This is only used by the allocator host function, which is unused under PolkaVM. unimplemented!("'deallocate_memory' is never used when running under PolkaVM"); } fn register_panic_error_message(&mut self, _message: &str) { unimplemented!("'register_panic_error_message' is never used when running under PolkaVM"); } } fn call_host_function( caller: &mut Caller<()>, function: &dyn Function, ) -> Result<(), polkavm::Trap> { let mut args = [Value::I64(0); Reg::ARG_REGS.len()]; let mut nth_reg = 0; for (nth_arg, kind) in function.signature().args.iter().enumerate() { match kind { ValueType::I32 => { args[nth_arg] = Value::I32(caller.get_reg(Reg::ARG_REGS[nth_reg]) as i32); nth_reg += 1; }, ValueType::F32 => { args[nth_arg] = Value::F32(caller.get_reg(Reg::ARG_REGS[nth_reg])); nth_reg += 1; }, ValueType::I64 => { let value_lo = caller.get_reg(Reg::ARG_REGS[nth_reg]); nth_reg += 1; let value_hi = caller.get_reg(Reg::ARG_REGS[nth_reg]); nth_reg += 1; args[nth_arg] = Value::I64((u64::from(value_lo) | (u64::from(value_hi) << 32)) as i64); }, ValueType::F64 => { let value_lo = caller.get_reg(Reg::ARG_REGS[nth_reg]); nth_reg += 1; let value_hi = caller.get_reg(Reg::ARG_REGS[nth_reg]); nth_reg += 1; args[nth_arg] = Value::F64(u64::from(value_lo) | (u64::from(value_hi) << 32)); }, } } log::trace!( "Calling host function: '{}', args = {:?}", function.name(), &args[..function.signature().args.len()] ); let value = match function .execute(&mut Context(caller), &mut args.into_iter().take(function.signature().args.len())) { Ok(value) => value, Err(error) => { log::warn!("Call into the host function '{}' failed: {error}", function.name()); return Err(polkavm::Trap::default()); }, }; if let Some(value) = value { match value { Value::I32(value) => { caller.set_reg(Reg::A0, value as u32); }, Value::F32(value) => { caller.set_reg(Reg::A0, value); }, Value::I64(value) => { caller.set_reg(Reg::A0, value as u32); caller.set_reg(Reg::A1, (value >> 32) as u32); }, Value::F64(value) => { caller.set_reg(Reg::A0, value as u32); caller.set_reg(Reg::A1, (value >> 32) as u32); }, } } Ok(()) } pub fn create_runtime(blob: &polkavm::ProgramBlob) -> Result, WasmError> where H: HostFunctions, { static ENGINE: std::sync::OnceLock> = std::sync::OnceLock::new(); let engine = ENGINE.get_or_init(|| { let config = polkavm::Config::from_env()?; polkavm::Engine::new(&config) }); let engine = match engine { Ok(ref engine) => engine, Err(ref error) => { return Err(WasmError::Other(error.to_string())); }, }; let module = polkavm::Module::from_blob(&engine, &polkavm::ModuleConfig::default(), blob)?; let mut linker = polkavm::Linker::new(&engine); for function in H::host_functions() { linker.func_new(function.name(), |mut caller| call_host_function(&mut caller, function))?; } let instance_pre = linker.instantiate_pre(&module)?; Ok(Box::new(InstancePre(instance_pre))) }