wasmi 1.0.9

use super::{ControlFlow, Executor, InstructionPtr};
use crate::{
    engine::{
        code_map::CompiledFuncRef,
        executor::stack::{CallFrame, FrameParams, ValueStack},
        utils::unreachable_unchecked,
        EngineFunc,
        FuncInOut,
        ResumableHostTrapError,
    },
    func::{FuncEntity, HostFuncEntity},
    ir::{index, Op, Slot, SlotSpan},
    store::{CallHooks, PrunedStore, StoreError, StoreInner},
    Error,
    Func,
    Instance,
    Ref,
    TrapCode,
};
use core::array;

/// Dispatches and executes the host function.
///
/// Returns the number of parameters and results of the called host function.
///
/// # Errors
///
/// Returns the error of the host function if an error occurred.
pub fn dispatch_host_func(
    store: &mut PrunedStore,
    value_stack: &mut ValueStack,
    host_func: HostFuncEntity,
    instance: Option<&Instance>,
    call_hooks: CallHooks,
) -> Result<(u16, u16), Error> {
    let len_params = host_func.len_params();
    let len_results = host_func.len_results();
    let max_inout = len_params.max(len_results);
    let values = value_stack.as_slice_mut();
    let params_results = FuncInOut::new(
        values.split_at_mut(values.len() - usize::from(max_inout)).1,
        usize::from(len_params),
        usize::from(len_results),
    );
    match store.call_host_func(&host_func, instance, params_results, call_hooks) {
        Err(StoreError::Internal(error)) => {
            panic!("`call.host`: internal interpreter error: {error}")
        }
        Err(StoreError::External(error)) => {
            // Note: We drop the values that have been temporarily added to
            //       the stack to act as parameter and result buffer for the
            //       called host function. Since the host function failed we
            //       need to clean up the temporary buffer values here.
            //       This is required for resumable calls to work properly.
            value_stack.drop(usize::from(max_inout));
            return Err(error);
        }
        _ => {}
    }
    Ok((len_params, len_results))
}

/// The kind of a function call.
#[derive(Debug, Copy, Clone)]
pub enum CallKind {
    /// A nested function call.
    Nested,
    /// A tailing function call.
    Tail,
}

trait CallContext {
    const KIND: CallKind;
    const HAS_PARAMS: bool;
}
trait ReturnCallContext: CallContext {}

mod marker {
    use super::{CallContext, CallKind, ReturnCallContext};

    pub enum ReturnCall0 {}
    impl CallContext for ReturnCall0 {
        const KIND: CallKind = CallKind::Tail;
        const HAS_PARAMS: bool = false;
    }
    impl ReturnCallContext for ReturnCall0 {}

    pub enum ReturnCall {}
    impl CallContext for ReturnCall {
        const KIND: CallKind = CallKind::Tail;
        const HAS_PARAMS: bool = true;
    }
    impl ReturnCallContext for ReturnCall {}

    pub enum NestedCall0 {}
    impl CallContext for NestedCall0 {
        const KIND: CallKind = CallKind::Nested;
        const HAS_PARAMS: bool = false;
    }

    pub enum NestedCall {}
    impl CallContext for NestedCall {
        const KIND: CallKind = CallKind::Nested;
        const HAS_PARAMS: bool = true;
    }
}

impl Executor<'_> {
    /// Updates the [`InstructionPtr`] of the caller [`CallFrame`] before dispatching a call.
    ///
    /// # Note
    ///
    /// The `offset` denotes how many [`Op`] words make up the call instruction.
    #[inline(always)]
    fn update_instr_ptr_at(&mut self, offset: usize) {
        // Note: we explicitly do not mutate `self.ip` since that would make
        // other parts of the code more fragile with respect to instruction ordering.
        self.ip.add(offset);
        let caller = self
            .stack
            .calls
            .peek_mut()
            .expect("caller call frame must be on the stack");
        caller.update_instr_ptr(self.ip);
    }

    /// Fetches the [`Op::CallIndirectParams`] parameter for a call [`Op`].
    ///
    /// # Note
    ///
    /// - This advances the [`InstructionPtr`] to the next [`Op`].
    /// - This is done by encoding an [`Op::TableGet`] instruction
    ///   word following the actual instruction where the [`index::Table`]
    ///   parameter belongs to.
    /// - This is required for some instructions that do not fit into
    ///   a single instruction word and store a [`index::Table`] value in
    ///   another instruction word.
    fn pull_call_indirect_params(&mut self) -> (u64, index::Table) {
        self.ip.add(1);
        match *self.ip.get() {
            Op::CallIndirectParams { index, table } => {
                let index: u64 = self.get_stack_slot_as(index);
                (index, table)
            }
            unexpected => {
                // Safety: Wasmi translation guarantees that correct instruction parameter follows.
                unsafe {
                    unreachable_unchecked!(
                        "expected `Op::CallIndirectParams` but found {unexpected:?}"
                    )
                }
            }
        }
    }

    /// Fetches the [`Op::CallIndirectParamsImm16`] parameter for a call [`Op`].
    ///
    /// # Note
    ///
    /// - This advances the [`InstructionPtr`] to the next [`Op`].
    /// - This is done by encoding an [`Op::TableGet`] instruction
    ///   word following the actual instruction where the [`index::Table`]
    ///   parameter belongs to.
    /// - This is required for some instructions that do not fit into
    ///   a single instruction word and store a [`index::Table`] value in
    ///   another instruction word.
    fn pull_call_indirect_params_imm16(&mut self) -> (u64, index::Table) {
        self.ip.add(1);
        match *self.ip.get() {
            Op::CallIndirectParamsImm16 { index, table } => {
                let index: u64 = index.into();
                (index, table)
            }
            unexpected => {
                // Safety: Wasmi translation guarantees that correct instruction parameter follows.
                unsafe {
                    unreachable_unchecked!(
                        "expected `Op::CallIndirectParamsImm16` but found {unexpected:?}"
                    )
                }
            }
        }
    }

    /// Creates a [`CallFrame`] for calling the [`EngineFunc`].
    #[inline(always)]
    fn dispatch_compiled_func<C: CallContext>(
        &mut self,
        results: SlotSpan,
        func: CompiledFuncRef,
    ) -> Result<CallFrame, Error> {
        // We have to reinstantiate the `self.sp` [`FrameSlots`] since we just called
        // [`ValueStack::alloc_call_frame`] which might invalidate all live [`FrameSlots`].
        let caller = self
            .stack
            .calls
            .peek()
            .expect("need to have a caller on the call stack");
        let (mut uninit_params, offsets) = self.stack.values.alloc_call_frame(func, |this| {
            // Safety: We use the base offset of a live call frame on the call stack.
            self.sp = unsafe { this.stack_ptr_at(caller.base_offset()) };
        })?;
        let instr_ptr = InstructionPtr::new(func.instrs().as_ptr());
        let frame = CallFrame::new(instr_ptr, offsets, results);
        if <C as CallContext>::HAS_PARAMS {
            self.copy_call_params(&mut uninit_params);
        }
        uninit_params.init_zeroes();
        Ok(frame)
    }

    /// Copies the parameters from caller for the callee [`CallFrame`].
    ///
    /// This will also adjust the instruction pointer to point to the
    /// last call parameter [`Op`] if any.
    fn copy_call_params(&mut self, uninit_params: &mut FrameParams) {
        self.ip.add(1);
        if let Op::SlotList { .. } = self.ip.get() {
            self.copy_call_params_list(uninit_params);
        }
        match self.ip.get() {
            Op::Slot { slot } => {
                self.copy_regs(uninit_params, array::from_ref(slot));
            }
            Op::Slot2 { slots } => {
                self.copy_regs(uninit_params, slots);
            }
            Op::Slot3 { slots } => {
                self.copy_regs(uninit_params, slots);
            }
            unexpected => {
                // Safety: Wasmi translation guarantees that register list finalizer exists.
                unsafe {
                    unreachable_unchecked!(
                        "expected register-list finalizer but found: {unexpected:?}"
                    )
                }
            }
        }
    }

    /// Copies an array of [`Slot`] to the `dst` [`Slot`] span.
    fn copy_regs<const N: usize>(&self, uninit_params: &mut FrameParams, regs: &[Slot; N]) {
        for value in regs {
            let value = self.get_stack_slot(*value);
            // Safety: The `callee.results()` always refer to a span of valid
            //         registers of the `caller` that does not overlap with the
            //         registers of the callee since they reside in different
            //         call frames. Therefore this access is safe.
            unsafe { uninit_params.init_next(value) }
        }
    }

    /// Copies a list of [`Op::SlotList`] to the `dst` [`Slot`] span.
    /// Copies the parameters from `src` for the called [`CallFrame`].
    ///
    /// This will make the [`InstructionPtr`] point to the [`Op`] following the
    /// last [`Op::SlotList`] if any.
    #[cold]
    fn copy_call_params_list(&mut self, uninit_params: &mut FrameParams) {
        while let Op::SlotList { regs } = self.ip.get() {
            self.copy_regs(uninit_params, regs);
            self.ip.add(1);
        }
    }

    /// Prepares a [`EngineFunc`] call with optional call parameters.
    #[inline(always)]
    fn prepare_compiled_func_call<C: CallContext>(
        &mut self,
        store: &mut StoreInner,
        results: SlotSpan,
        func: EngineFunc,
        mut instance: Option<Instance>,
    ) -> Result<(), Error> {
        let func = self.code_map.get(Some(store.fuel_mut()), func)?;
        let mut called = self.dispatch_compiled_func::<C>(results, func)?;
        match <C as CallContext>::KIND {
            CallKind::Nested => {
                // We need to update the instruction pointer of the caller call frame.
                self.update_instr_ptr_at(1);
            }
            CallKind::Tail => {
                // In case of a tail call we have to remove the caller call frame after
                // allocating the callee call frame. This moves all cells of the callee frame
                // and may invalidate pointers to it.
                //
                // Safety:
                //
                // We provide `merge_call_frames` properly with `frame` that has just been allocated
                // on the value stack which is what the function expects. After this operation we ensure
                // that `self.sp` is adjusted via a call to `init_call_frame` since it may have been
                // invalidated by this method.
                let caller_instance = unsafe { self.stack.merge_call_frames(&mut called) };
                if let Some(caller_instance) = caller_instance {
                    instance.get_or_insert(caller_instance);
                }
            }
        }
        self.init_call_frame(&called);
        self.stack.calls.push(called, instance)?;
        Ok(())
    }

    /// Executes an [`Op::ReturnCallInternal0`].
    #[inline(always)]
    pub fn execute_return_call_internal_0(
        &mut self,
        store: &mut StoreInner,
        func: EngineFunc,
    ) -> Result<(), Error> {
        self.execute_return_call_internal_impl::<marker::ReturnCall0>(store, func)
    }

    /// Executes an [`Op::ReturnCallInternal`].
    #[inline(always)]
    pub fn execute_return_call_internal(
        &mut self,
        store: &mut StoreInner,
        func: EngineFunc,
    ) -> Result<(), Error> {
        self.execute_return_call_internal_impl::<marker::ReturnCall>(store, func)
    }

    /// Executes an [`Op::ReturnCallInternal`] or [`Op::ReturnCallInternal0`].
    #[inline(always)]
    fn execute_return_call_internal_impl<C: CallContext>(
        &mut self,
        store: &mut StoreInner,
        func: EngineFunc,
    ) -> Result<(), Error> {
        let results = self.caller_results();
        self.prepare_compiled_func_call::<C>(store, results, func, None)
    }

    /// Returns the `results` [`SlotSpan`] of the top-most [`CallFrame`] on the [`CallStack`].
    ///
    /// # Note
    ///
    /// We refer to the top-most [`CallFrame`] as the `caller` since this method is used for
    /// tail call instructions for which the top-most [`CallFrame`] is the caller.
    ///
    /// [`CallStack`]: crate::engine::executor::stack::CallStack
    #[inline(always)]
    fn caller_results(&self) -> SlotSpan {
        self.stack
            .calls
            .peek()
            .expect("must have caller on the stack")
            .results()
    }

    /// Executes an [`Op::CallInternal0`].
    #[inline(always)]
    pub fn execute_call_internal_0(
        &mut self,
        store: &mut StoreInner,
        results: SlotSpan,
        func: EngineFunc,
    ) -> Result<(), Error> {
        self.prepare_compiled_func_call::<marker::NestedCall0>(store, results, func, None)
    }

    /// Executes an [`Op::CallInternal`].
    #[inline(always)]
    pub fn execute_call_internal(
        &mut self,
        store: &mut StoreInner,
        results: SlotSpan,
        func: EngineFunc,
    ) -> Result<(), Error> {
        self.prepare_compiled_func_call::<marker::NestedCall>(store, results, func, None)
    }

    /// Executes an [`Op::ReturnCallImported0`].
    pub fn execute_return_call_imported_0(
        &mut self,
        store: &mut PrunedStore,
        func: index::Func,
    ) -> Result<ControlFlow, Error> {
        self.execute_return_call_imported_impl::<marker::ReturnCall0>(store, func)
    }

    /// Executes an [`Op::ReturnCallImported`].
    pub fn execute_return_call_imported(
        &mut self,
        store: &mut PrunedStore,
        func: index::Func,
    ) -> Result<ControlFlow, Error> {
        self.execute_return_call_imported_impl::<marker::ReturnCall>(store, func)
    }

    /// Executes an [`Op::ReturnCallImported`] or [`Op::ReturnCallImported0`].
    fn execute_return_call_imported_impl<C: ReturnCallContext>(
        &mut self,
        store: &mut PrunedStore,
        func: index::Func,
    ) -> Result<ControlFlow, Error> {
        let func = self.get_func(func);
        self.execute_call_imported_impl::<C>(store, None, &func)
    }

    /// Executes an [`Op::CallImported0`].
    pub fn execute_call_imported_0(
        &mut self,
        store: &mut PrunedStore,
        results: SlotSpan,
        func: index::Func,
    ) -> Result<(), Error> {
        let func = self.get_func(func);
        _ = self.execute_call_imported_impl::<marker::NestedCall0>(store, Some(results), &func)?;
        Ok(())
    }

    /// Executes an [`Op::CallImported`].
    pub fn execute_call_imported(
        &mut self,
        store: &mut PrunedStore,
        results: SlotSpan,
        func: index::Func,
    ) -> Result<(), Error> {
        let func = self.get_func(func);
        _ = self.execute_call_imported_impl::<marker::NestedCall>(store, Some(results), &func)?;
        Ok(())
    }

    /// Executes an imported or indirect (tail) call instruction.
    fn execute_call_imported_impl<C: CallContext>(
        &mut self,
        store: &mut PrunedStore,
        results: Option<SlotSpan>,
        func: &Func,
    ) -> Result<ControlFlow, Error> {
        match store.inner().resolve_func(func) {
            FuncEntity::Wasm(func) => {
                let instance = *func.instance();
                let func_body = func.func_body();
                let results = results.unwrap_or_else(|| self.caller_results());
                self.prepare_compiled_func_call::<C>(
                    store.inner_mut(),
                    results,
                    func_body,
                    Some(instance),
                )?;
                self.cache.update(store.inner_mut(), &instance);
                Ok(ControlFlow::Continue(()))
            }
            FuncEntity::Host(host_func) => {
                let host_func = *host_func;
                self.execute_host_func::<C>(store, results, func, host_func)
            }
        }
    }

    /// Executes a host function.
    ///
    /// # Note
    ///
    /// This uses the value stack to store parameters and results of the host function call.
    /// Returns an [`ErrorKind::ResumableHostTrap`] variant if the host function returned an error
    /// and there are still call frames on the call stack making it possible to resume the
    /// execution at a later point in time.
    ///
    /// [`ErrorKind::ResumableHostTrap`]: crate::error::ErrorKind::ResumableHostTrap
    fn execute_host_func<C: CallContext>(
        &mut self,
        store: &mut PrunedStore,
        results: Option<SlotSpan>,
        func: &Func,
        host_func: HostFuncEntity,
    ) -> Result<ControlFlow, Error> {
        let len_params = host_func.len_params();
        let len_results = host_func.len_results();
        let max_inout = usize::from(len_params.max(len_results));
        let instance = *self.stack.calls.instance_expect();
        // We have to reinstantiate the `self.sp` [`FrameSlots`] since we just called
        // [`ValueStack::reserve`] which might invalidate all live [`FrameSlots`].
        let (caller, popped_instance) = match <C as CallContext>::KIND {
            CallKind::Nested => self.stack.calls.peek().copied().map(|frame| (frame, None)),
            CallKind::Tail => self.stack.calls.pop(),
        }
        .expect("need to have a caller on the call stack");
        let buffer = self.stack.values.extend_by(max_inout, |this| {
            // Safety: we use the base offset of a live call frame on the call stack.
            self.sp = unsafe { this.stack_ptr_at(caller.base_offset()) };
        })?;
        if <C as CallContext>::HAS_PARAMS {
            let mut uninit_params = FrameParams::new(buffer);
            self.copy_call_params(&mut uninit_params);
        }
        if matches!(<C as CallContext>::KIND, CallKind::Nested) {
            self.update_instr_ptr_at(1);
        }
        let results = results.unwrap_or_else(|| caller.results());
        self.dispatch_host_func(store, host_func, &instance)
            .map_err(|error| match self.stack.calls.is_empty() {
                true => error,
                false => ResumableHostTrapError::new(error, *func, results).into(),
            })?;
        self.cache.update(store.inner_mut(), &instance);
        let results = results.iter(len_results);
        match <C as CallContext>::KIND {
            CallKind::Nested => {
                let returned = self.stack.values.drop_return(max_inout);
                for (result, value) in results.zip(returned) {
                    // # Safety (1)
                    //
                    // We can safely acquire the stack pointer to the caller's and callee's (host)
                    // call frames because we just allocated the host call frame and can be sure that
                    // they are different.
                    // In the following we make sure to not access registers out of bounds of each
                    // call frame since we rely on Wasm validation and proper Wasm translation to
                    // provide us with valid result registers.
                    unsafe { self.sp.set(result, *value) };
                }
                Ok(ControlFlow::Continue(()))
            }
            CallKind::Tail => {
                let (mut regs, cf) = match self.stack.calls.peek() {
                    Some(frame) => {
                        // Case: return the caller's caller frame registers.
                        let sp = unsafe { self.stack.values.stack_ptr_at(frame.base_offset()) };
                        (sp, ControlFlow::Continue(()))
                    }
                    None => {
                        // Case: call stack is empty -> return the root frame registers.
                        let sp = self.stack.values.root_stack_ptr();
                        (sp, ControlFlow::Break(()))
                    }
                };
                let returned = self.stack.values.drop_return(max_inout);
                for (result, value) in results.zip(returned) {
                    // # Safety (1)
                    //
                    // We can safely acquire the stack pointer to the caller's and callee's (host)
                    // call frames because we just allocated the host call frame and can be sure that
                    // they are different.
                    // In the following we make sure to not access registers out of bounds of each
                    // call frame since we rely on Wasm validation and proper Wasm translation to
                    // provide us with valid result registers.
                    unsafe { regs.set(result, *value) };
                }
                self.stack.values.truncate(caller.frame_offset());
                let new_instance = popped_instance.and_then(|_| self.stack.calls.instance());
                if let Some(new_instance) = new_instance {
                    self.cache.update(store.inner_mut(), new_instance);
                }
                if let Some(caller) = self.stack.calls.peek() {
                    Self::init_call_frame_impl(
                        &mut self.stack.values,
                        &mut self.sp,
                        &mut self.ip,
                        caller,
                    );
                }
                Ok(cf)
            }
        }
    }

    /// Convenience forwarder to [`dispatch_host_func`].
    fn dispatch_host_func(
        &mut self,
        store: &mut PrunedStore,
        host_func: HostFuncEntity,
        instance: &Instance,
    ) -> Result<(u16, u16), Error> {
        dispatch_host_func(
            store,
            &mut self.stack.values,
            host_func,
            Some(instance),
            CallHooks::Call,
        )
    }

    /// Executes an [`Op::CallIndirect0`].
    pub fn execute_return_call_indirect_0(
        &mut self,
        store: &mut PrunedStore,
        func_type: index::FuncType,
    ) -> Result<ControlFlow, Error> {
        let (index, table) = self.pull_call_indirect_params();
        self.execute_call_indirect_impl::<marker::ReturnCall0>(store, None, func_type, index, table)
    }

    /// Executes an [`Op::CallIndirect0Imm16`].
    pub fn execute_return_call_indirect_0_imm16(
        &mut self,
        store: &mut PrunedStore,
        func_type: index::FuncType,
    ) -> Result<ControlFlow, Error> {
        let (index, table) = self.pull_call_indirect_params_imm16();
        self.execute_call_indirect_impl::<marker::ReturnCall0>(store, None, func_type, index, table)
    }

    /// Executes an [`Op::CallIndirect0`].
    pub fn execute_return_call_indirect(
        &mut self,
        store: &mut PrunedStore,
        func_type: index::FuncType,
    ) -> Result<ControlFlow, Error> {
        let (index, table) = self.pull_call_indirect_params();
        self.execute_call_indirect_impl::<marker::ReturnCall>(store, None, func_type, index, table)
    }

    /// Executes an [`Op::CallIndirect0Imm16`].
    pub fn execute_return_call_indirect_imm16(
        &mut self,
        store: &mut PrunedStore,
        func_type: index::FuncType,
    ) -> Result<ControlFlow, Error> {
        let (index, table) = self.pull_call_indirect_params_imm16();
        self.execute_call_indirect_impl::<marker::ReturnCall>(store, None, func_type, index, table)
    }

    /// Executes an [`Op::CallIndirect0`].
    pub fn execute_call_indirect_0(
        &mut self,
        store: &mut PrunedStore,
        results: SlotSpan,
        func_type: index::FuncType,
    ) -> Result<(), Error> {
        let (index, table) = self.pull_call_indirect_params();
        _ = self.execute_call_indirect_impl::<marker::NestedCall0>(
            store,
            Some(results),
            func_type,
            index,
            table,
        )?;
        Ok(())
    }

    /// Executes an [`Op::CallIndirect0Imm16`].
    pub fn execute_call_indirect_0_imm16(
        &mut self,
        store: &mut PrunedStore,
        results: SlotSpan,
        func_type: index::FuncType,
    ) -> Result<(), Error> {
        let (index, table) = self.pull_call_indirect_params_imm16();
        _ = self.execute_call_indirect_impl::<marker::NestedCall0>(
            store,
            Some(results),
            func_type,
            index,
            table,
        )?;
        Ok(())
    }

    /// Executes an [`Op::CallIndirect`].
    pub fn execute_call_indirect(
        &mut self,
        store: &mut PrunedStore,
        results: SlotSpan,
        func_type: index::FuncType,
    ) -> Result<(), Error> {
        let (index, table) = self.pull_call_indirect_params();
        _ = self.execute_call_indirect_impl::<marker::NestedCall>(
            store,
            Some(results),
            func_type,
            index,
            table,
        )?;
        Ok(())
    }

    /// Executes an [`Op::CallIndirectImm16`].
    pub fn execute_call_indirect_imm16(
        &mut self,
        store: &mut PrunedStore,
        results: SlotSpan,
        func_type: index::FuncType,
    ) -> Result<(), Error> {
        let (index, table) = self.pull_call_indirect_params_imm16();
        _ = self.execute_call_indirect_impl::<marker::NestedCall>(
            store,
            Some(results),
            func_type,
            index,
            table,
        )?;
        Ok(())
    }

    /// Executes an [`Op::CallIndirect`] and [`Op::CallIndirect0`].
    fn execute_call_indirect_impl<C: CallContext>(
        &mut self,
        store: &mut PrunedStore,
        results: Option<SlotSpan>,
        func_type: index::FuncType,
        index: u64,
        table: index::Table,
    ) -> Result<ControlFlow, Error> {
        let table = self.get_table(table);
        let funcref = store
            .inner()
            .resolve_table(&table)
            .get_untyped(index)
            .map(<Ref<Func>>::from)
            .ok_or(TrapCode::TableOutOfBounds)?;
        let func = funcref.val().ok_or(TrapCode::IndirectCallToNull)?;
        let actual_signature = store.inner().resolve_func(func).ty_dedup();
        let expected_signature = &self.get_func_type_dedup(func_type);
        if actual_signature != expected_signature {
            return Err(Error::from(TrapCode::BadSignature));
        }
        self.execute_call_imported_impl::<C>(store, results, func)
    }
}