wasmi 1.0.9

use super::{typeid, CallHooks, FuncInOut, HostFuncEntity, StoreInner};
use crate::{
    core::{hint, UntypedVal},
    errors::{MemoryError, TableError},
    store::error::{InternalStoreError, StoreError},
    CallHook,
    Error,
    Instance,
    Memory,
    Store,
    Table,
};
use core::{
    fmt::{self, Debug},
    mem,
};

#[cfg(test)]
use crate::Engine;

/// A wrapper used to restore a [`PrunedStore`].
///
/// This wrapper exists to provide a `Debug` impl so that `#[derive(Debug)]`
/// works for [`Store`].
#[allow(clippy::type_complexity)]
#[derive(Copy, Clone)]
pub struct PrunedStoreVTable {
    /// Calls the given [`HostFuncEntity`] with the `params` and `results` on `instance`.
    ///
    /// # Errors
    ///
    /// If the called host function returned an error.
    call_host_func: fn(
        store: &mut PrunedStore,
        func: &HostFuncEntity,
        instance: Option<&Instance>,
        params_results: FuncInOut,
        call_hooks: CallHooks,
    ) -> Result<(), StoreError<Error>>,
    /// Grows `memory` by `delta` pages.
    grow_memory:
        fn(&mut PrunedStore, memory: &Memory, delta: u64) -> Result<u64, StoreError<MemoryError>>,
    /// Grows `table` by `delta` items filling with `init`.
    grow_table: fn(
        &mut PrunedStore,
        table: &Table,
        delta: u64,
        init: UntypedVal,
    ) -> Result<u64, StoreError<TableError>>,
}
impl PrunedStoreVTable {
    pub fn new<T>() -> Self {
        Self {
            call_host_func: |pruned: &mut PrunedStore,
                             func: &HostFuncEntity,
                             instance: Option<&Instance>,
                             params_results: FuncInOut,
                             call_hooks: CallHooks|
             -> Result<(), StoreError<Error>> {
                let store: &mut Store<T> = pruned.restore()?;
                if matches!(call_hooks, CallHooks::Call) {
                    store
                        .invoke_call_hook(CallHook::CallingHost)
                        .map_err(StoreError::external)?;
                }
                store.call_host_func(func, instance, params_results)?;
                if matches!(call_hooks, CallHooks::Call) {
                    store
                        .invoke_call_hook(CallHook::ReturningFromHost)
                        .map_err(StoreError::external)?;
                }
                Ok(())
            },
            grow_memory: |pruned: &mut PrunedStore,
                          memory: &Memory,
                          delta: u64|
             -> Result<u64, StoreError<MemoryError>> {
                let store: &mut Store<T> = pruned.restore()?;
                let (store, mut resource_limiter) = store.store_inner_and_resource_limiter_ref();
                let (memory, fuel) = store.try_resolve_memory_and_fuel_mut(memory)?;
                memory
                    .grow(delta, Some(fuel), &mut resource_limiter)
                    .map_err(StoreError::external)
            },
            grow_table: |pruned: &mut PrunedStore,
                         table: &Table,
                         delta: u64,
                         init: UntypedVal|
             -> Result<u64, StoreError<TableError>> {
                let store: &mut Store<T> = pruned.restore()?;
                let (store, mut resource_limiter) = store.store_inner_and_resource_limiter_ref();
                let (table, fuel) = store.try_resolve_table_and_fuel_mut(table)?;
                table
                    .grow_untyped(delta, init, Some(fuel), &mut resource_limiter)
                    .map_err(StoreError::external)
            },
        }
    }
}
impl PrunedStoreVTable {
    #[inline]
    fn call_host_func(
        &self,
        pruned: &mut PrunedStore,
        func: &HostFuncEntity,
        instance: Option<&Instance>,
        params_results: FuncInOut,
        call_hooks: CallHooks,
    ) -> Result<(), StoreError<Error>> {
        (self.call_host_func)(pruned, func, instance, params_results, call_hooks)
    }

    #[inline]
    fn grow_memory(
        &self,
        pruned: &mut PrunedStore,
        memory: &Memory,
        delta: u64,
    ) -> Result<u64, StoreError<MemoryError>> {
        (self.grow_memory)(pruned, memory, delta)
    }

    #[inline]
    fn grow_table(
        &self,
        pruned: &mut PrunedStore,
        table: &Table,
        delta: u64,
        init: UntypedVal,
    ) -> Result<u64, StoreError<TableError>> {
        (self.grow_table)(pruned, table, delta, init)
    }
}
impl Debug for PrunedStoreVTable {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        write!(f, "RestorePrunedWrapper")
    }
}

/// A [`Store`] with a pruned `T`.
#[derive(Debug)]
#[repr(transparent)]
pub struct PrunedStore {
    /// The underlying [`Store`] with pruned type signature.
    pruned: Store<Pruned>,
}

/// Placeholder type of `T` for a pruned `Store<T>`.
#[derive(Debug)]
pub struct Pruned;

impl<'a, T> From<&'a mut Store<T>> for &'a mut PrunedStore {
    #[inline]
    fn from(store: &'a mut Store<T>) -> Self {
        // Safety: the generic `Store<T>` has its `T` pruned here.
        //
        // - This is safe because we are operating on a `&mut Store<T>` thus it is just
        //   a reference and since `Store<T>` and `Store<Pruned>` have the same size and API.
        // - We make sure in `PrunedStore` to never access the typed parts of the original
        //   `Store<T>` and check in the restoration process the type-ID of the target `T`.
        // - `Store<T>` has the same size and alignment for all `T`.
        unsafe { mem::transmute::<&'a mut Store<T>, &'a mut PrunedStore>(store) }
    }
}

impl<T> Store<T> {
    /// Prune the [`Store`] from `T` returning a [`PrunedStore`].
    #[inline]
    pub(crate) fn prune(&mut self) -> &mut PrunedStore {
        self.into()
    }
}

impl PrunedStore {
    /// Returns a shared reference to the underlying [`StoreInner`].
    #[inline]
    pub fn inner(&self) -> &StoreInner {
        &self.pruned.inner
    }

    /// Returns an exclusive reference to the underlying [`StoreInner`].
    #[inline]
    pub fn inner_mut(&mut self) -> &mut StoreInner {
        &mut self.pruned.inner
    }

    /// Calls a host `func` at `instance` with `params_results` buffer.
    ///
    /// # Errors
    ///
    /// If the host function returns an error.
    #[inline]
    pub fn call_host_func(
        &mut self,
        func: &HostFuncEntity,
        instance: Option<&Instance>,
        params_results: FuncInOut,
        call_hooks: CallHooks,
    ) -> Result<(), StoreError<Error>> {
        self.pruned.restore_pruned.clone().call_host_func(
            self,
            func,
            instance,
            params_results,
            call_hooks,
        )
    }

    /// Grows the [`Memory`] by `delta` pages and returns the result.
    #[inline]
    pub fn grow_memory(
        &mut self,
        memory: &Memory,
        delta: u64,
    ) -> Result<u64, StoreError<MemoryError>> {
        self.pruned
            .restore_pruned
            .clone()
            .grow_memory(self, memory, delta)
    }

    /// Grows the [`Table`] by `delta` items and returns the result.
    #[inline]
    pub fn grow_table(
        &mut self,
        table: &Table,
        delta: u64,
        init: UntypedVal,
    ) -> Result<u64, StoreError<TableError>> {
        self.pruned
            .restore_pruned
            .clone()
            .grow_table(self, table, delta, init)
    }

    /// Restores `self` to a proper [`Store<T>`] if possible.
    ///
    /// # Errors
    ///
    /// If the `T` of the resulting [`Store<T>`] does not match the given `T`.
    #[inline]
    fn restore<T>(&mut self) -> Result<&mut Store<T>, InternalStoreError> {
        if hint::unlikely(typeid::of::<T>() != self.pruned.id) {
            return Err(InternalStoreError::restore_type_mismatch::<T>());
        }
        let store = {
            // Safety: we restore the original `Store<T>` from the pruned `Store<Pruned>`.
            //
            // This is safe because we have already checked above that the `TypedId` of `T`
            // matches the `id` of the original `Store<T>` and thus the `T`'s are identical.
            //
            // Furthermore, we are only operating on `&mut` pointers and not values.
            // Finally, `Store<T>` has the same size and alignment for all `T`.
            unsafe { mem::transmute::<&mut PrunedStore, &mut Store<T>>(self) }
        };
        Ok(store)
    }
}

#[test]
fn pruning_works() {
    let engine = Engine::default();
    let mut store = Store::new(&engine, ());
    let pruned = store.prune();
    assert!(pruned.restore::<()>().is_ok());
}

#[test]
fn pruning_errors() {
    let engine = Engine::default();
    let mut store = Store::new(&engine, ());
    let pruned = store.prune();
    assert!(pruned.restore::<i32>().is_err());
}

#[test]
fn pruned_store_deref() {
    let mut config = crate::Config::default();
    config.consume_fuel(true);
    let engine = Engine::new(&config);
    let mut store = Store::new(&engine, ());
    let fuel_amount = 100;
    store.set_fuel(fuel_amount).unwrap();
    let pruned = store.prune();
    assert_eq!(
        PrunedStore::inner(pruned).fuel.get_fuel().unwrap(),
        fuel_amount
    );
    PrunedStore::inner_mut(pruned)
        .fuel
        .set_fuel(fuel_amount * 2)
        .unwrap();
    assert_eq!(
        PrunedStore::inner(pruned).fuel.get_fuel().unwrap(),
        fuel_amount * 2
    );
}

#[test]
fn equal_size() {
    use super::TypedStoreInner;
    type SmallType = ();
    type BigType = [i64; 16];
    // Note: `TypedStore<T>` must be of the same size for all `T` so that
    //       `PrunedStore` works and is a safe abstraction.
    use core::mem::size_of;
    assert_eq!(size_of::<Store<SmallType>>(), size_of::<Store<BigType>>(),);
    assert_eq!(
        size_of::<TypedStoreInner<SmallType>>(),
        size_of::<TypedStoreInner<BigType>>(),
    );
}