use super::invoke_wasm_and_catch_traps;
use crate::runtime::vm::{VMFuncRef, VMOpaqueContext};
use crate::store::{AutoAssertNoGc, StoreOpaque};
use crate::{
AsContext, AsContextMut, Engine, Func, FuncType, HeapType, NoFunc, RefType, StoreContextMut,
ValRaw, ValType,
};
use anyhow::{bail, Context, Result};
use core::ffi::c_void;
use core::marker;
use core::mem::{self, MaybeUninit};
use core::num::NonZeroUsize;
use core::ptr::{self};
use wasmtime_environ::VMSharedTypeIndex;
pub struct TypedFunc<Params, Results> {
_a: marker::PhantomData<fn(Params) -> Results>,
ty: FuncType,
func: Func,
}
impl<Params, Results> Clone for TypedFunc<Params, Results> {
fn clone(&self) -> TypedFunc<Params, Results> {
Self {
_a: marker::PhantomData,
ty: self.ty.clone(),
func: self.func,
}
}
}
impl<Params, Results> TypedFunc<Params, Results>
where
Params: WasmParams,
Results: WasmResults,
{
pub unsafe fn new_unchecked(store: impl AsContext, func: Func) -> TypedFunc<Params, Results> {
let store = store.as_context().0;
Self::_new_unchecked(store, func)
}
pub(crate) unsafe fn _new_unchecked(
store: &StoreOpaque,
func: Func,
) -> TypedFunc<Params, Results> {
let ty = func.load_ty(store);
TypedFunc {
_a: marker::PhantomData,
ty,
func,
}
}
pub fn func(&self) -> &Func {
&self.func
}
pub fn call(&self, mut store: impl AsContextMut, params: Params) -> Result<Results> {
let mut store = store.as_context_mut();
assert!(
!store.0.async_support(),
"must use `call_async` with async stores"
);
if Self::need_gc_before_call_raw(store.0, ¶ms) {
store.0.gc();
}
let func = self.func.vm_func_ref(store.0);
unsafe { Self::call_raw(&mut store, &self.ty, func, params) }
}
#[cfg(feature = "async")]
pub async fn call_async<T>(
&self,
mut store: impl AsContextMut<Data = T>,
params: Params,
) -> Result<Results>
where
T: Send,
{
let mut store = store.as_context_mut();
assert!(
store.0.async_support(),
"must use `call` with non-async stores"
);
if Self::need_gc_before_call_raw(store.0, ¶ms) {
store.0.gc_async().await;
}
store
.on_fiber(|store| {
let func = self.func.vm_func_ref(store.0);
unsafe { Self::call_raw(store, &self.ty, func, params) }
})
.await?
}
#[inline]
pub(crate) fn need_gc_before_call_raw(_store: &StoreOpaque, _params: &Params) -> bool {
#[cfg(feature = "gc")]
{
let num_gc_refs = _params.vmgcref_pointing_to_object_count();
if let Some(num_gc_refs) = NonZeroUsize::new(num_gc_refs) {
return _store
.unwrap_gc_store()
.gc_heap
.need_gc_before_entering_wasm(num_gc_refs);
}
}
false
}
pub(crate) unsafe fn call_raw<T>(
store: &mut StoreContextMut<'_, T>,
ty: &FuncType,
func: ptr::NonNull<VMFuncRef>,
params: Params,
) -> Result<Results> {
if cfg!(debug_assertions) {
Self::debug_typecheck(store.0, func.as_ref().type_index);
}
union Storage<T: Copy, U: Copy> {
params: MaybeUninit<T>,
results: U,
}
let mut storage = Storage::<Params::ValRawStorage, Results::ValRawStorage> {
params: MaybeUninit::uninit(),
};
{
let mut store = AutoAssertNoGc::new(store.0);
params.store(&mut store, ty, &mut storage.params)?;
}
let mut captures = (func, storage);
let result = invoke_wasm_and_catch_traps(store, |caller| {
let (func_ref, storage) = &mut captures;
let func_ref = func_ref.as_ref();
(func_ref.array_call)(
func_ref.vmctx,
VMOpaqueContext::from_vmcontext(caller),
(storage as *mut Storage<_, _>) as *mut ValRaw,
mem::size_of_val::<Storage<_, _>>(storage) / mem::size_of::<ValRaw>(),
);
});
let (_, storage) = captures;
result?;
let mut store = AutoAssertNoGc::new(store.0);
Ok(Results::load(&mut store, &storage.results))
}
fn debug_typecheck(store: &StoreOpaque, func: VMSharedTypeIndex) {
let ty = FuncType::from_shared_type_index(store.engine(), func);
Params::typecheck(store.engine(), ty.params(), TypeCheckPosition::Param)
.expect("params should match");
Results::typecheck(store.engine(), ty.results(), TypeCheckPosition::Result)
.expect("results should match");
}
}
#[doc(hidden)]
#[derive(Copy, Clone)]
pub enum TypeCheckPosition {
Param,
Result,
}
pub unsafe trait WasmTy: Send {
#[doc(hidden)]
#[inline]
fn typecheck(engine: &Engine, actual: ValType, position: TypeCheckPosition) -> Result<()> {
let expected = Self::valtype();
debug_assert!(expected.comes_from_same_engine(engine));
debug_assert!(actual.comes_from_same_engine(engine));
match position {
TypeCheckPosition::Result => actual.ensure_matches(engine, &expected),
TypeCheckPosition::Param => match (expected.as_ref(), actual.as_ref()) {
(Some(expected_ref), Some(actual_ref)) if actual_ref.heap_type().is_concrete() => {
expected_ref
.heap_type()
.top()
.ensure_matches(engine, &actual_ref.heap_type().top())
}
_ => expected.ensure_matches(engine, &actual),
},
}
}
#[doc(hidden)]
fn valtype() -> ValType;
#[doc(hidden)]
fn compatible_with_store(&self, store: &StoreOpaque) -> bool;
#[doc(hidden)]
fn dynamic_concrete_type_check(
&self,
store: &StoreOpaque,
nullable: bool,
actual: &HeapType,
) -> Result<()>;
#[doc(hidden)]
#[inline]
fn is_vmgcref_and_points_to_object(&self) -> bool {
Self::valtype().is_vmgcref_type_and_points_to_object()
}
#[doc(hidden)]
fn store(self, store: &mut AutoAssertNoGc<'_>, ptr: &mut MaybeUninit<ValRaw>) -> Result<()>;
#[doc(hidden)]
unsafe fn load(store: &mut AutoAssertNoGc<'_>, ptr: &ValRaw) -> Self;
}
macro_rules! integers {
($($primitive:ident/$get_primitive:ident => $ty:ident)*) => ($(
unsafe impl WasmTy for $primitive {
#[inline]
fn valtype() -> ValType {
ValType::$ty
}
#[inline]
fn compatible_with_store(&self, _: &StoreOpaque) -> bool {
true
}
#[inline]
fn dynamic_concrete_type_check(&self, _: &StoreOpaque, _: bool, _: &HeapType) -> Result<()> {
unreachable!()
}
#[inline]
fn store(self, _store: &mut AutoAssertNoGc<'_>, ptr: &mut MaybeUninit<ValRaw>) -> Result<()> {
ptr.write(ValRaw::$primitive(self));
Ok(())
}
#[inline]
unsafe fn load(_store: &mut AutoAssertNoGc<'_>, ptr: &ValRaw) -> Self {
ptr.$get_primitive()
}
}
)*)
}
integers! {
i32/get_i32 => I32
i64/get_i64 => I64
u32/get_u32 => I32
u64/get_u64 => I64
}
macro_rules! floats {
($($float:ident/$int:ident/$get_float:ident => $ty:ident)*) => ($(
unsafe impl WasmTy for $float {
#[inline]
fn valtype() -> ValType {
ValType::$ty
}
#[inline]
fn compatible_with_store(&self, _: &StoreOpaque) -> bool {
true
}
#[inline]
fn dynamic_concrete_type_check(&self, _: &StoreOpaque, _: bool, _: &HeapType) -> Result<()> {
unreachable!()
}
#[inline]
fn store(self, _store: &mut AutoAssertNoGc<'_>, ptr: &mut MaybeUninit<ValRaw>) -> Result<()> {
ptr.write(ValRaw::$float(self.to_bits()));
Ok(())
}
#[inline]
unsafe fn load(_store: &mut AutoAssertNoGc<'_>, ptr: &ValRaw) -> Self {
$float::from_bits(ptr.$get_float())
}
}
)*)
}
floats! {
f32/u32/get_f32 => F32
f64/u64/get_f64 => F64
}
unsafe impl WasmTy for NoFunc {
#[inline]
fn valtype() -> ValType {
ValType::Ref(RefType::new(false, HeapType::NoFunc))
}
#[inline]
fn compatible_with_store(&self, _store: &StoreOpaque) -> bool {
match self._inner {}
}
#[inline]
fn dynamic_concrete_type_check(&self, _: &StoreOpaque, _: bool, _: &HeapType) -> Result<()> {
match self._inner {}
}
#[inline]
fn is_vmgcref_and_points_to_object(&self) -> bool {
match self._inner {}
}
#[inline]
fn store(self, _store: &mut AutoAssertNoGc<'_>, _ptr: &mut MaybeUninit<ValRaw>) -> Result<()> {
match self._inner {}
}
#[inline]
unsafe fn load(_store: &mut AutoAssertNoGc<'_>, _ptr: &ValRaw) -> Self {
unreachable!("NoFunc is uninhabited")
}
}
unsafe impl WasmTy for Option<NoFunc> {
#[inline]
fn valtype() -> ValType {
ValType::Ref(RefType::new(true, HeapType::NoFunc))
}
#[inline]
fn compatible_with_store(&self, _store: &StoreOpaque) -> bool {
true
}
#[inline]
fn dynamic_concrete_type_check(
&self,
_: &StoreOpaque,
nullable: bool,
ty: &HeapType,
) -> Result<()> {
if nullable {
Ok(())
} else {
bail!("argument type mismatch: expected non-nullable (ref {ty}), found null reference")
}
}
#[inline]
fn store(self, _store: &mut AutoAssertNoGc<'_>, ptr: &mut MaybeUninit<ValRaw>) -> Result<()> {
ptr.write(ValRaw::funcref(ptr::null_mut()));
Ok(())
}
#[inline]
unsafe fn load(_store: &mut AutoAssertNoGc<'_>, _ptr: &ValRaw) -> Self {
None
}
}
unsafe impl WasmTy for Func {
#[inline]
fn valtype() -> ValType {
ValType::Ref(RefType::new(false, HeapType::Func))
}
#[inline]
fn compatible_with_store(&self, store: &StoreOpaque) -> bool {
store.store_data().contains(self.0)
}
#[inline]
fn dynamic_concrete_type_check(
&self,
store: &StoreOpaque,
_nullable: bool,
expected: &HeapType,
) -> Result<()> {
let expected = expected.unwrap_concrete_func();
self.ensure_matches_ty(store, expected)
.context("argument type mismatch for reference to concrete type")
}
#[inline]
fn store(self, store: &mut AutoAssertNoGc<'_>, ptr: &mut MaybeUninit<ValRaw>) -> Result<()> {
let abi = self.vm_func_ref(store);
ptr.write(ValRaw::funcref(abi.cast::<c_void>().as_ptr()));
Ok(())
}
#[inline]
unsafe fn load(store: &mut AutoAssertNoGc<'_>, ptr: &ValRaw) -> Self {
let p = ptr.get_funcref();
debug_assert!(!p.is_null());
Func::from_vm_func_ref(store, p.cast()).unwrap()
}
}
unsafe impl WasmTy for Option<Func> {
#[inline]
fn valtype() -> ValType {
ValType::FUNCREF
}
#[inline]
fn compatible_with_store(&self, store: &StoreOpaque) -> bool {
if let Some(f) = self {
store.store_data().contains(f.0)
} else {
true
}
}
fn dynamic_concrete_type_check(
&self,
store: &StoreOpaque,
nullable: bool,
expected: &HeapType,
) -> Result<()> {
if let Some(f) = self {
let expected = expected.unwrap_concrete_func();
f.ensure_matches_ty(store, expected)
.context("argument type mismatch for reference to concrete type")
} else if nullable {
Ok(())
} else {
bail!("argument type mismatch: expected non-nullable (ref {expected}), found null reference")
}
}
#[inline]
fn store(self, store: &mut AutoAssertNoGc<'_>, ptr: &mut MaybeUninit<ValRaw>) -> Result<()> {
let raw = if let Some(f) = self {
f.vm_func_ref(store).as_ptr()
} else {
ptr::null_mut()
};
ptr.write(ValRaw::funcref(raw.cast::<c_void>()));
Ok(())
}
#[inline]
unsafe fn load(store: &mut AutoAssertNoGc<'_>, ptr: &ValRaw) -> Self {
Func::from_vm_func_ref(store, ptr.get_funcref().cast())
}
}
pub unsafe trait WasmParams: Send {
#[doc(hidden)]
type ValRawStorage: Copy;
#[doc(hidden)]
fn typecheck(
engine: &Engine,
params: impl ExactSizeIterator<Item = crate::ValType>,
position: TypeCheckPosition,
) -> Result<()>;
#[doc(hidden)]
fn vmgcref_pointing_to_object_count(&self) -> usize;
#[doc(hidden)]
fn store(
self,
store: &mut AutoAssertNoGc<'_>,
func_ty: &FuncType,
dst: &mut MaybeUninit<Self::ValRawStorage>,
) -> Result<()>;
}
unsafe impl<T> WasmParams for T
where
T: WasmTy,
{
type ValRawStorage = <(T,) as WasmParams>::ValRawStorage;
fn typecheck(
engine: &Engine,
params: impl ExactSizeIterator<Item = crate::ValType>,
position: TypeCheckPosition,
) -> Result<()> {
<(T,) as WasmParams>::typecheck(engine, params, position)
}
#[inline]
fn vmgcref_pointing_to_object_count(&self) -> usize {
T::is_vmgcref_and_points_to_object(self) as usize
}
#[inline]
fn store(
self,
store: &mut AutoAssertNoGc<'_>,
func_ty: &FuncType,
dst: &mut MaybeUninit<Self::ValRawStorage>,
) -> Result<()> {
<(T,) as WasmParams>::store((self,), store, func_ty, dst)
}
}
macro_rules! impl_wasm_params {
($n:tt $($t:ident)*) => {
#[allow(non_snake_case)]
unsafe impl<$($t: WasmTy,)*> WasmParams for ($($t,)*) {
type ValRawStorage = [ValRaw; $n];
fn typecheck(
_engine: &Engine,
mut params: impl ExactSizeIterator<Item = crate::ValType>,
_position: TypeCheckPosition,
) -> Result<()> {
let mut _n = 0;
$(
match params.next() {
Some(t) => {
_n += 1;
$t::typecheck(_engine, t, _position)?
},
None => bail!("expected {} types, found {}", $n, params.len() + _n),
}
)*
match params.next() {
None => Ok(()),
Some(_) => {
_n += 1;
bail!("expected {} types, found {}", $n, params.len() + _n)
},
}
}
#[inline]
fn vmgcref_pointing_to_object_count(&self) -> usize {
let ($(ref $t,)*) = self;
0 $(
+ $t.is_vmgcref_and_points_to_object() as usize
)*
}
#[inline]
fn store(
self,
_store: &mut AutoAssertNoGc<'_>,
_func_ty: &FuncType,
_ptr: &mut MaybeUninit<Self::ValRawStorage>,
) -> Result<()> {
let ($($t,)*) = self;
let mut _i = 0;
$(
if !$t.compatible_with_store(_store) {
bail!("attempt to pass cross-`Store` value to Wasm as function argument");
}
if $t::valtype().is_ref() {
let param_ty = _func_ty.param(_i).unwrap();
let ref_ty = param_ty.unwrap_ref();
let heap_ty = ref_ty.heap_type();
if heap_ty.is_concrete() {
$t.dynamic_concrete_type_check(_store, ref_ty.is_nullable(), heap_ty)?;
}
}
let dst = map_maybe_uninit!(_ptr[_i]);
$t.store(_store, dst)?;
_i += 1;
)*
Ok(())
}
}
};
}
for_each_function_signature!(impl_wasm_params);
pub unsafe trait WasmResults: WasmParams {
#[doc(hidden)]
unsafe fn load(store: &mut AutoAssertNoGc<'_>, abi: &Self::ValRawStorage) -> Self;
}
unsafe impl<T: WasmTy> WasmResults for T {
unsafe fn load(store: &mut AutoAssertNoGc<'_>, abi: &Self::ValRawStorage) -> Self {
<(T,) as WasmResults>::load(store, abi).0
}
}
macro_rules! impl_wasm_results {
($n:tt $($t:ident)*) => {
#[allow(non_snake_case, unused_variables)]
unsafe impl<$($t: WasmTy,)*> WasmResults for ($($t,)*) {
unsafe fn load(store: &mut AutoAssertNoGc<'_>, abi: &Self::ValRawStorage) -> Self {
let [$($t,)*] = abi;
($($t::load(store, $t),)*)
}
}
};
}
for_each_function_signature!(impl_wasm_results);