Skip to content
This repository has been archived by the owner on Nov 15, 2023. It is now read-only.

Statically register host WASM functions #10394

Merged
Show file tree
Hide file tree
Changes from 12 commits
Commits
Show all changes
23 commits
Select commit Hold shift + click to select a range
a6b9624
Statically register host WASM functions
koute Nov 30, 2021
1d8649f
Fix `substrate-test-client` compilation
koute Nov 30, 2021
2a4658f
Move `ExtendedHostFunctions` to `sp-wasm-interface`
koute Dec 2, 2021
878d512
Fix `sp-runtime-interface` tests' compilation
koute Dec 2, 2021
7efc4f5
Fix `sc-executor-wasmtime` tests' compilation
koute Dec 2, 2021
570788d
Use `runtime_interface` macro in `test-runner`
koute Dec 2, 2021
7610cde
Fix `sc-executor` tests' compilation
koute Dec 6, 2021
0c51a64
Reformatting/`rustfmt`
koute Dec 6, 2021
963f9e7
Add an extra comment regarding the `H` generic arg in `create_runtime`
koute Dec 6, 2021
76e8c96
Even more `rustfmt`
koute Dec 6, 2021
e853225
Depend on `wasmtime` without default features in `sp-wasm-interface`
koute Dec 6, 2021
df38788
Merge branch 'master' into master_statically_register_wasmtime_ffi
koute Dec 6, 2021
3699f6d
Merge branch 'master' into master_statically_register_wasmtime_ffi
koute Dec 9, 2021
cd14ed1
Merge branch 'master' into master_statically_register_wasmtime_ffi
koute Dec 10, 2021
f825113
Bump version of `sp-wasm-interface` to 4.0.1
koute Dec 10, 2021
8ffb42d
Bump `sp-wasm-interface` in `Cargo.lock` too
koute Dec 10, 2021
0f7ccf8
Bump all of the `sp-wasm-interface` requirements to 4.0.1
koute Dec 10, 2021
e429bb9
Revert "Bump all of the `sp-wasm-interface` requirements to 4.0.1"
koute Dec 10, 2021
9ce2fb7
Make `cargo-unleash` happy (maybe)
koute Dec 10, 2021
f9019cd
Use `cargo-unleash` to bump the crates' versions
koute Dec 13, 2021
acc2835
Merge branch 'master' into master_statically_register_wasmtime_ffi
koute Dec 13, 2021
61ce0b2
Align to review comments
koute Dec 13, 2021
bdd38da
Merge branch 'master' into master_statically_register_wasmtime_ffi
koute Dec 14, 2021
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions Cargo.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

8 changes: 8 additions & 0 deletions client/executor/runtime-test/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -332,6 +332,14 @@ sp_core::wasm_export_functions! {
fn test_panic_in_spawned() {
sp_tasks::spawn(tasks::panicker, vec![]).join();
}

fn test_return_i8() -> i8 {
-66
}

fn test_take_i8(value: i8) {
assert_eq!(value, -66);
}
}

#[cfg(not(feature = "std"))]
Expand Down
40 changes: 24 additions & 16 deletions client/executor/src/integration_tests/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,6 @@ use sp_core::{
use sp_runtime::traits::BlakeTwo256;
use sp_state_machine::TestExternalities as CoreTestExternalities;
use sp_trie::{trie_types::Layout, TrieConfiguration};
use sp_wasm_interface::HostFunctions as _;
use std::sync::Arc;
use tracing_subscriber::layer::SubscriberExt;

Expand Down Expand Up @@ -124,13 +123,7 @@ fn call_in_wasm<E: Externalities>(
execution_method: WasmExecutionMethod,
ext: &mut E,
) -> Result<Vec<u8>, String> {
let executor = crate::WasmExecutor::new(
execution_method,
Some(1024),
HostFunctions::host_functions(),
8,
None,
);
let executor = crate::WasmExecutor::<HostFunctions>::new(execution_method, Some(1024), 8, None);
executor.uncached_call(
RuntimeBlob::uncompress_if_needed(&wasm_binary_unwrap()[..]).unwrap(),
ext,
Expand Down Expand Up @@ -474,10 +467,9 @@ test_wasm_execution!(should_trap_when_heap_exhausted);
fn should_trap_when_heap_exhausted(wasm_method: WasmExecutionMethod) {
let mut ext = TestExternalities::default();

let executor = crate::WasmExecutor::new(
let executor = crate::WasmExecutor::<HostFunctions>::new(
wasm_method,
Some(17), // `17` is the initial number of pages compiled into the binary.
HostFunctions::host_functions(),
8,
None,
);
Expand All @@ -499,11 +491,10 @@ fn mk_test_runtime(wasm_method: WasmExecutionMethod, pages: u64) -> Arc<dyn Wasm
let blob = RuntimeBlob::uncompress_if_needed(&wasm_binary_unwrap()[..])
.expect("failed to create a runtime blob out of test runtime");

crate::wasm_runtime::create_wasm_runtime_with_code(
crate::wasm_runtime::create_wasm_runtime_with_code::<HostFunctions>(
wasm_method,
pages,
blob,
HostFunctions::host_functions(),
true,
None,
)
Expand Down Expand Up @@ -587,10 +578,9 @@ fn heap_is_reset_between_calls(wasm_method: WasmExecutionMethod) {

test_wasm_execution!(parallel_execution);
fn parallel_execution(wasm_method: WasmExecutionMethod) {
let executor = std::sync::Arc::new(crate::WasmExecutor::new(
let executor = std::sync::Arc::new(crate::WasmExecutor::<HostFunctions>::new(
wasm_method,
Some(1024),
HostFunctions::host_functions(),
8,
None,
));
Expand Down Expand Up @@ -760,11 +750,10 @@ fn memory_is_cleared_between_invocations(wasm_method: WasmExecutionMethod) {
)
)"#).unwrap();

let runtime = crate::wasm_runtime::create_wasm_runtime_with_code(
let runtime = crate::wasm_runtime::create_wasm_runtime_with_code::<HostFunctions>(
wasm_method,
1024,
RuntimeBlob::uncompress_if_needed(&binary[..]).unwrap(),
HostFunctions::host_functions(),
true,
None,
)
Expand All @@ -777,3 +766,22 @@ fn memory_is_cleared_between_invocations(wasm_method: WasmExecutionMethod) {
let res = instance.call_export("returns_no_bss_mutable_static", &[0]).unwrap();
assert_eq!(1, u64::decode(&mut &res[..]).unwrap());
}

test_wasm_execution!(return_i8);
fn return_i8(wasm_method: WasmExecutionMethod) {
let mut ext = TestExternalities::default();
let mut ext = ext.ext();

assert_eq!(
call_in_wasm("test_return_i8", &[], wasm_method, &mut ext).unwrap(),
(-66_i8).encode()
);
}

test_wasm_execution!(take_i8);
fn take_i8(wasm_method: WasmExecutionMethod) {
let mut ext = TestExternalities::default();
let mut ext = ext.ext();

call_in_wasm("test_take_i8", &(-66_i8).encode(), wasm_method, &mut ext).unwrap();
}
4 changes: 1 addition & 3 deletions client/executor/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -67,17 +67,15 @@ mod tests {
use sc_executor_common::runtime_blob::RuntimeBlob;
use sc_runtime_test::wasm_binary_unwrap;
use sp_io::TestExternalities;
use sp_wasm_interface::HostFunctions;

#[test]
fn call_in_interpreted_wasm_works() {
let mut ext = TestExternalities::default();
let mut ext = ext.ext();

let executor = WasmExecutor::new(
let executor = WasmExecutor::<sp_io::SubstrateHostFunctions>::new(
WasmExecutionMethod::Interpreted,
Some(8),
sp_io::SubstrateHostFunctions::host_functions(),
8,
None,
);
Expand Down
103 changes: 64 additions & 39 deletions client/executor/src/native_executor.rs
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ use crate::{

use std::{
collections::HashMap,
marker::PhantomData,
panic::{AssertUnwindSafe, UnwindSafe},
path::PathBuf,
result,
Expand All @@ -46,7 +47,7 @@ use sp_core::{
use sp_externalities::ExternalitiesExt as _;
use sp_tasks::new_async_externalities;
use sp_version::{GetNativeVersion, NativeVersion, RuntimeVersion};
use sp_wasm_interface::{Function, HostFunctions};
use sp_wasm_interface::{ExtendedHostFunctions, HostFunctions};

/// Default num of pages for the heap
const DEFAULT_HEAP_PAGES: u64 = 2048;
Expand Down Expand Up @@ -91,22 +92,42 @@ pub trait NativeExecutionDispatch: Send + Sync {

/// An abstraction over Wasm code executor. Supports selecting execution backend and
/// manages runtime cache.
#[derive(Clone)]
pub struct WasmExecutor {
pub struct WasmExecutor<H>
where
H: HostFunctions,
koute marked this conversation as resolved.
Show resolved Hide resolved
{
/// Method used to execute fallback Wasm code.
method: WasmExecutionMethod,
/// The number of 64KB pages to allocate for Wasm execution.
default_heap_pages: u64,
/// The host functions registered with this instance.
host_functions: Arc<Vec<&'static dyn Function>>,
/// WASM runtime cache.
cache: Arc<RuntimeCache>,
/// The path to a directory which the executor can leverage for a file cache, e.g. put there
/// compiled artifacts.
cache_path: Option<PathBuf>,

phantom: PhantomData<H>,
}

impl<H> Clone for WasmExecutor<H>
where
H: HostFunctions,
koute marked this conversation as resolved.
Show resolved Hide resolved
{
fn clone(&self) -> Self {
Self {
method: self.method,
default_heap_pages: self.default_heap_pages,
cache: self.cache.clone(),
cache_path: self.cache_path.clone(),
phantom: self.phantom,
}
}
}

impl WasmExecutor {
impl<H> WasmExecutor<H>
where
H: HostFunctions,
{
/// Create new instance.
///
/// # Parameters
Expand All @@ -127,16 +148,15 @@ impl WasmExecutor {
pub fn new(
method: WasmExecutionMethod,
default_heap_pages: Option<u64>,
host_functions: Vec<&'static dyn Function>,
max_runtime_instances: usize,
cache_path: Option<PathBuf>,
) -> Self {
WasmExecutor {
method,
default_heap_pages: default_heap_pages.unwrap_or(DEFAULT_HEAP_PAGES),
host_functions: Arc::new(host_functions),
cache: Arc::new(RuntimeCache::new(max_runtime_instances, cache_path.clone())),
cache_path,
phantom: PhantomData,
}
}

Expand Down Expand Up @@ -168,12 +188,11 @@ impl WasmExecutor {
AssertUnwindSafe<&mut dyn Externalities>,
) -> Result<Result<R>>,
{
match self.cache.with_instance(
match self.cache.with_instance::<H, _, _>(
runtime_code,
ext,
self.method,
self.default_heap_pages,
&*self.host_functions,
allow_missing_host_functions,
|module, instance, version, ext| {
let module = AssertUnwindSafe(module);
Expand Down Expand Up @@ -203,11 +222,10 @@ impl WasmExecutor {
export_name: &str,
call_data: &[u8],
) -> std::result::Result<Vec<u8>, String> {
let module = crate::wasm_runtime::create_wasm_runtime_with_code(
let module = crate::wasm_runtime::create_wasm_runtime_with_code::<H>(
self.method,
self.default_heap_pages,
runtime_blob,
self.host_functions.to_vec(),
allow_missing_host_functions,
self.cache_path.as_deref(),
)
Expand All @@ -230,7 +248,10 @@ impl WasmExecutor {
}
}

impl sp_core::traits::ReadRuntimeVersion for WasmExecutor {
impl<H> sp_core::traits::ReadRuntimeVersion for WasmExecutor<H>
where
H: HostFunctions,
{
fn read_runtime_version(
&self,
wasm_code: &[u8],
Expand Down Expand Up @@ -264,7 +285,10 @@ impl sp_core::traits::ReadRuntimeVersion for WasmExecutor {
}
}

impl CodeExecutor for WasmExecutor {
impl<H> CodeExecutor for WasmExecutor<H>
where
H: HostFunctions,
{
type Error = Error;

fn call<
Expand Down Expand Up @@ -294,7 +318,10 @@ impl CodeExecutor for WasmExecutor {
}
}

impl RuntimeVersionOf for WasmExecutor {
impl<H> RuntimeVersionOf for WasmExecutor<H>
where
H: HostFunctions,
{
fn runtime_version(
&self,
ext: &mut dyn Externalities,
Expand All @@ -308,13 +335,17 @@ impl RuntimeVersionOf for WasmExecutor {

/// A generic `CodeExecutor` implementation that uses a delegate to determine wasm code equivalence
/// and dispatch to native code when possible, falling back on `WasmExecutor` when not.
pub struct NativeElseWasmExecutor<D> {
pub struct NativeElseWasmExecutor<D>
where
D: NativeExecutionDispatch,
{
/// Dummy field to avoid the compiler complaining about us not using `D`.
_dummy: std::marker::PhantomData<D>,
/// Native runtime version info.
native_version: NativeVersion,
/// Fallback wasm executor.
wasm: WasmExecutor,
wasm:
WasmExecutor<ExtendedHostFunctions<sp_io::SubstrateHostFunctions, D::ExtendHostFunctions>>,
}

impl<D: NativeExecutionDispatch> NativeElseWasmExecutor<D> {
Expand All @@ -331,27 +362,8 @@ impl<D: NativeExecutionDispatch> NativeElseWasmExecutor<D> {
default_heap_pages: Option<u64>,
max_runtime_instances: usize,
) -> Self {
let extended = D::ExtendHostFunctions::host_functions();
let mut host_functions = sp_io::SubstrateHostFunctions::host_functions()
.into_iter()
// filter out any host function overrides provided.
.filter(|host_fn| {
extended
.iter()
.find(|ext_host_fn| host_fn.name() == ext_host_fn.name())
.is_none()
})
.collect::<Vec<_>>();

// Add the custom host functions provided by the user.
host_functions.extend(extended);
let wasm_executor = WasmExecutor::new(
fallback_method,
default_heap_pages,
host_functions,
max_runtime_instances,
None,
);
let wasm_executor =
WasmExecutor::new(fallback_method, default_heap_pages, max_runtime_instances, None);

NativeElseWasmExecutor {
_dummy: Default::default(),
Expand Down Expand Up @@ -637,8 +649,21 @@ mod tests {
None,
8,
);

fn extract_host_functions<H>(
_: &WasmExecutor<H>,
) -> Vec<&'static dyn sp_wasm_interface::Function>
where
H: HostFunctions,
{
H::host_functions()
}

my_interface::HostFunctions::host_functions().iter().for_each(|function| {
assert_eq!(executor.wasm.host_functions.iter().filter(|f| f == &function).count(), 2);
assert_eq!(
extract_host_functions(&executor.wasm).iter().filter(|f| f == &function).count(),
2
);
});

my_interface::say_hello_world("hey");
Expand Down
Loading