Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Clean-up: move test related methods into tests module #1232

Merged
merged 2 commits into from
Oct 7, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
102 changes: 0 additions & 102 deletions crates/wasmi/src/engine/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -15,11 +15,6 @@ mod utils;
#[cfg(test)]
mod tests;

#[cfg(test)]
use self::code_map::CompiledFuncRef;
#[cfg(test)]
use crate::{core::UntypedVal, ir::Instruction, ir::RegSpan};

pub(crate) use self::{
block_type::BlockType,
config::FuelCosts,
Expand Down Expand Up @@ -274,54 +269,6 @@ impl Engine {
.init_lazy_func(func_idx, func, bytes, module, func_to_validate)
}

/// Resolves the [`EngineFunc`] to the underlying Wasmi bytecode instructions.
///
/// # Note
///
/// - This is a variant of [`Engine::resolve_instr`] that returns register
/// machine based bytecode instructions.
/// - This API is mainly intended for unit testing purposes and shall not be used
/// outside of this context. The function bodies are intended to be data private
/// to the Wasmi interpreter.
///
/// # Errors
///
/// If the `func` fails Wasm to Wasmi bytecode translation after it was lazily initialized.
///
/// # Panics
///
/// - If the [`EngineFunc`] is invalid for the [`Engine`].
/// - If register machine bytecode translation is disabled.
#[cfg(test)]
pub(crate) fn resolve_instr(
&self,
func: EngineFunc,
index: usize,
) -> Result<Option<Instruction>, Error> {
self.inner.resolve_instr(func, index)
}

/// Resolves the function local constant of [`EngineFunc`] at `index` if any.
///
/// # Note
///
/// This API is intended for unit testing purposes and shall not be used
/// outside of this context. The function bodies are intended to be data
/// private to the Wasmi interpreter.
///
/// # Errors
///
/// If the `func` fails Wasm to Wasmi bytecode translation after it was lazily initialized.
///
/// # Panics
///
/// - If the [`EngineFunc`] is invalid for the [`Engine`].
/// - If register machine bytecode translation is disabled.
#[cfg(test)]
fn get_func_const(&self, func: EngineFunc, index: usize) -> Result<Option<UntypedVal>, Error> {
self.inner.get_func_const(func, index)
}

/// Executes the given [`Func`] with parameters `params`.
///
/// Stores the execution result into `results` upon a successful execution.
Expand Down Expand Up @@ -739,55 +686,6 @@ impl EngineInner {
.init_func_as_uncompiled(func, func_idx, bytes, module, func_to_validate)
}

/// Resolves the [`InternalFuncEntity`] for [`EngineFunc`] and applies `f` to it.
///
/// # Panics
///
/// If [`EngineFunc`] is invalid for [`Engine`].
#[cfg(test)]
fn resolve_func<'a, F, R>(&'a self, func: EngineFunc, f: F) -> Result<R, Error>
where
F: FnOnce(CompiledFuncRef<'a>) -> R,
{
// Note: We use `None` so this test-only function will never charge for compilation fuel.
Ok(f(self.code_map.get(None, func)?))
}

/// Returns the [`Instruction`] of `func` at `index`.
///
/// Returns `None` if the function has no instruction at `index`.
///
/// # Errors
///
/// If the `func` fails Wasm to Wasmi bytecode translation after it was lazily initialized.
///
/// # Pancis
///
/// If `func` cannot be resolved to a function for the [`EngineInner`].
#[cfg(test)]
fn resolve_instr(&self, func: EngineFunc, index: usize) -> Result<Option<Instruction>, Error> {
self.resolve_func(func, |func| func.instrs().get(index).copied())
}

/// Returns the function local constant value of `func` at `index`.
///
/// Returns `None` if the function has no function local constant at `index`.
///
/// # Errors
///
/// If the `func` fails Wasm to Wasmi bytecode translation after it was lazily initialized.
///
/// # Pancis
///
/// If `func` cannot be resolved to a function for the [`EngineInner`].
#[cfg(test)]
fn get_func_const(&self, func: EngineFunc, index: usize) -> Result<Option<UntypedVal>, Error> {
// Function local constants are stored in reverse order of their indices since
// they are allocated in reverse order to their absolute indices during function
// translation. That is why we need to access them in reverse order.
self.resolve_func(func, |func| func.consts().iter().rev().nth(index).copied())
}

/// Recycles the given [`Stack`].
fn recycle_stack(&self, stack: Stack) {
self.stacks.lock().recycle(stack)
Expand Down
114 changes: 114 additions & 0 deletions crates/wasmi/src/engine/tests/mod.rs
Original file line number Diff line number Diff line change
@@ -1,2 +1,116 @@
mod host_calls;
mod many_inout;

use super::{
code_map::{CompiledFuncRef, EngineFunc},
EngineInner,
};
use crate::{core::UntypedVal, ir::Instruction, Engine, Error};

impl Engine {
/// Resolves the [`EngineFunc`] to the underlying Wasmi bytecode instructions.
///
/// # Note
///
/// - This is a variant of [`Engine::resolve_instr`] that returns register
/// machine based bytecode instructions.
/// - This API is mainly intended for unit testing purposes and shall not be used
/// outside of this context. The function bodies are intended to be data private
/// to the Wasmi interpreter.
///
/// # Errors
///
/// If the `func` fails Wasm to Wasmi bytecode translation after it was lazily initialized.
///
/// # Panics
///
/// - If the [`EngineFunc`] is invalid for the [`Engine`].
/// - If register machine bytecode translation is disabled.
pub(crate) fn resolve_instr(
&self,
func: EngineFunc,
index: usize,
) -> Result<Option<Instruction>, Error> {
self.inner.resolve_instr(func, index)
}

/// Resolves the function local constant of [`EngineFunc`] at `index` if any.
///
/// # Note
///
/// This API is intended for unit testing purposes and shall not be used
/// outside of this context. The function bodies are intended to be data
/// private to the Wasmi interpreter.
///
/// # Errors
///
/// If the `func` fails Wasm to Wasmi bytecode translation after it was lazily initialized.
///
/// # Panics
///
/// - If the [`EngineFunc`] is invalid for the [`Engine`].
/// - If register machine bytecode translation is disabled.
pub(crate) fn get_func_const(
&self,
func: EngineFunc,
index: usize,
) -> Result<Option<UntypedVal>, Error> {
self.inner.get_func_const(func, index)
}
}

impl EngineInner {
/// Resolves the [`InternalFuncEntity`] for [`EngineFunc`] and applies `f` to it.
///
/// # Panics
///
/// If [`EngineFunc`] is invalid for [`Engine`].
pub(crate) fn resolve_func<'a, F, R>(&'a self, func: EngineFunc, f: F) -> Result<R, Error>
where
F: FnOnce(CompiledFuncRef<'a>) -> R,
{
// Note: We use `None` so this test-only function will never charge for compilation fuel.
Ok(f(self.code_map.get(None, func)?))
}

/// Returns the [`Instruction`] of `func` at `index`.
///
/// Returns `None` if the function has no instruction at `index`.
///
/// # Errors
///
/// If the `func` fails Wasm to Wasmi bytecode translation after it was lazily initialized.
///
/// # Pancis
///
/// If `func` cannot be resolved to a function for the [`EngineInner`].
pub(crate) fn resolve_instr(
&self,
func: EngineFunc,
index: usize,
) -> Result<Option<Instruction>, Error> {
self.resolve_func(func, |func| func.instrs().get(index).copied())
}

/// Returns the function local constant value of `func` at `index`.
///
/// Returns `None` if the function has no function local constant at `index`.
///
/// # Errors
///
/// If the `func` fails Wasm to Wasmi bytecode translation after it was lazily initialized.
///
/// # Pancis
///
/// If `func` cannot be resolved to a function for the [`EngineInner`].
pub(crate) fn get_func_const(
&self,
func: EngineFunc,
index: usize,
) -> Result<Option<UntypedVal>, Error> {
// Function local constants are stored in reverse order of their indices since
// they are allocated in reverse order to their absolute indices during function
// translation. That is why we need to access them in reverse order.
self.resolve_func(func, |func| func.consts().iter().rev().nth(index).copied())
}
}
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
use super::*;
use crate::engine::{EngineFunc, RegSpan};
use crate::{engine::EngineFunc, ir::RegSpan};

#[test]
#[cfg_attr(miri, ignore)]
Expand Down
Loading