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

Make WasmtimeEngine a marker struct #782

Merged
merged 4 commits into from
Jan 3, 2025
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
90 changes: 48 additions & 42 deletions crates/containerd-shim-wasmtime/src/instance.rs
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
use std::collections::hash_map::DefaultHasher;
use std::hash::{Hash, Hasher};
use std::marker::PhantomData;
use std::sync::LazyLock;

use anyhow::{bail, Context, Result};
use containerd_shim_wasm::container::{
Expand All @@ -20,7 +20,7 @@ use wasmtime_wasi_http::{WasiHttpCtx, WasiHttpView};

use crate::http_proxy::serve_conn;

pub type WasmtimeInstance = Instance<WasmtimeEngine<DefaultConfig>>;
pub type WasmtimeInstance = Instance<WasmtimeEngine>;

/// Represents the WASI API that the component is targeting.
enum ComponentTarget<'a> {
Expand Down Expand Up @@ -53,34 +53,38 @@ impl<'a> ComponentTarget<'a> {
}
}

#[derive(Clone, Default)]
pub struct WasmtimeEngine;

static PRECOMPILER: LazyLock<wasmtime::Engine> = LazyLock::new(|| {
let mut config = wasmtime::Config::new();

// Disable Wasmtime parallel compilation for the tests
// see https://github.com/containerd/runwasi/pull/405#issuecomment-1928468714 for details
config.parallel_compilation(!cfg!(test));
config.wasm_component_model(true); // enable component linking
config.async_support(true); // must be on

wasmtime::Engine::new(&config).expect("failed to create wasmtime precompilation engine")
});

#[derive(Clone)]
pub struct WasmtimeEngine<T: WasiConfig> {
pub struct WasmtimeEngineImpl {
engine: wasmtime::Engine,
cancel: CancellationToken,
config_type: PhantomData<T>,
}

#[derive(Clone)]
pub struct DefaultConfig {}

impl WasiConfig for DefaultConfig {
fn new_config() -> Config {
impl Default for WasmtimeEngineImpl {
fn default() -> Self {
let mut config = wasmtime::Config::new();
config.wasm_component_model(true); // enable component linking
config
}
}

pub trait WasiConfig: Clone + Sync + Send + 'static {
fn new_config() -> Config;
}

impl<T: WasiConfig> Default for WasmtimeEngine<T> {
fn default() -> Self {
let mut config = T::new_config();
// Disable Wasmtime parallel compilation for the tests
// see https://github.com/containerd/runwasi/pull/405#issuecomment-1928468714 for details
config.parallel_compilation(!cfg!(test));
config.wasm_component_model(true); // enable component linking
config.async_support(true); // must be on

if use_pooling_allocator_by_default().unwrap_or_default() {
if use_pooling_allocator_by_default() {
let cfg = wasmtime::PoolingAllocationConfig::default();
config.allocation_strategy(wasmtime::InstanceAllocationStrategy::Pooling(cfg));
}
Expand All @@ -90,7 +94,6 @@ impl<T: WasiConfig> Default for WasmtimeEngine<T> {
.context("failed to create wasmtime engine")
.unwrap(),
cancel: CancellationToken::new(),
config_type: PhantomData,
}
}
}
Expand Down Expand Up @@ -132,7 +135,7 @@ impl WasiHttpView for WasiPreview2Ctx {
}
}

impl<T: WasiConfig> Engine for WasmtimeEngine<T> {
impl Engine for WasmtimeEngine {
fn name() -> &'static str {
"wasmtime"
}
Expand All @@ -147,14 +150,16 @@ impl<T: WasiConfig> Engine for WasmtimeEngine<T> {
} = ctx.entrypoint();

let wasm_bytes = &source.as_bytes()?;
self.execute(ctx, wasm_bytes, func).into_error_code()
WasmtimeEngineImpl::default()
.execute(ctx, wasm_bytes, func)
.into_error_code()
}

fn precompile(&self, layers: &[WasmLayer]) -> Result<Vec<Option<Vec<u8>>>> {
let mut compiled_layers = Vec::<Option<Vec<u8>>>::with_capacity(layers.len());

for layer in layers {
if self.engine.detect_precompiled(&layer.layer).is_some() {
if PRECOMPILER.detect_precompiled(&layer.layer).is_some() {
log::info!("Already precompiled");
compiled_layers.push(None);
continue;
Expand All @@ -163,8 +168,8 @@ impl<T: WasiConfig> Engine for WasmtimeEngine<T> {
use WasmBinaryType::*;

let compiled_layer = match WasmBinaryType::from_bytes(&layer.layer) {
Some(Module) => self.engine.precompile_module(&layer.layer)?,
Some(Component) => self.engine.precompile_component(&layer.layer)?,
Some(Module) => PRECOMPILER.precompile_module(&layer.layer)?,
Some(Component) => PRECOMPILER.precompile_component(&layer.layer)?,
None => {
log::warn!("Unknow WASM binary type");
continue;
Expand All @@ -179,17 +184,14 @@ impl<T: WasiConfig> Engine for WasmtimeEngine<T> {

fn can_precompile(&self) -> Option<String> {
let mut hasher = DefaultHasher::new();
self.engine
PRECOMPILER
.precompile_compatibility_hash()
.hash(&mut hasher);
Some(hasher.finish().to_string())
}
}

impl<T> WasmtimeEngine<T>
where
T: std::clone::Clone + Sync + WasiConfig + Send + 'static,
{
impl WasmtimeEngineImpl {
/// Execute a wasm module.
///
/// This function adds wasi_preview1 to the linker and can be utilized
Expand Down Expand Up @@ -434,16 +436,20 @@ async fn wait_for_signal() -> Result<i32> {
/// The pooling allocator is tailor made for the `wasi/http` use case. Check if we can use it.
///
/// For more details refer to: <https://github.com/bytecodealliance/wasmtime/blob/v27.0.0/src/commands/serve.rs#L641>
fn use_pooling_allocator_by_default() -> Result<bool> {
const BITS_TO_TEST: u32 = 42;
let mut config = Config::new();
config.wasm_memory64(true);
config.static_memory_maximum_size(1 << BITS_TO_TEST);
let engine = wasmtime::Engine::new(&config)?;
let mut store = Store::new(&engine, ());
let ty = wasmtime::MemoryType::new64(0, Some(1 << (BITS_TO_TEST - 16)));

Ok(wasmtime::Memory::new(&mut store, ty).is_ok())
fn use_pooling_allocator_by_default() -> bool {
static SUPPORTS_POOLING_ALLOCATOR: LazyLock<bool> = LazyLock::new(|| {
const BITS_TO_TEST: u32 = 42;
let mut config = Config::new();
config.wasm_memory64(true);
config.static_memory_maximum_size(1 << BITS_TO_TEST);
let Ok(engine) = wasmtime::Engine::new(&config) else {
return false;
};
let mut store = Store::new(&engine, ());
let ty = wasmtime::MemoryType::new64(0, Some(1 << (BITS_TO_TEST - 16)));
wasmtime::Memory::new(&mut store, ty).is_ok()
});
*SUPPORTS_POOLING_ALLOCATOR
}

pub trait IntoErrorCode {
Expand Down
19 changes: 2 additions & 17 deletions crates/containerd-shim-wasmtime/src/tests.rs
Original file line number Diff line number Diff line change
Expand Up @@ -4,28 +4,13 @@ use containerd_shim_wasm::container::Instance;
use containerd_shim_wasm::testing::modules::*;
use containerd_shim_wasm::testing::{oci_helpers, WasiTest};
use serial_test::serial;
use wasmtime::Config;
use WasmtimeTestInstance as WasiInstance;

use crate::instance::{WasiConfig, WasmtimeEngine};
use crate::instance::WasmtimeEngine;

// use test configuration to avoid dead locks when running tests
// https://github.com/containerd/runwasi/issues/357
type WasmtimeTestInstance = Instance<WasmtimeEngine<WasiTestConfig>>;

#[derive(Clone)]
struct WasiTestConfig {}

impl WasiConfig for WasiTestConfig {
fn new_config() -> Config {
let mut config = wasmtime::Config::new();
// Disable Wasmtime parallel compilation for the tests
// see https://github.com/containerd/runwasi/pull/405#issuecomment-1928468714 for details
config.parallel_compilation(false);
config.wasm_component_model(true); // enable component linking
config
}
}
type WasmtimeTestInstance = Instance<WasmtimeEngine>;

#[test]
#[serial]
Expand Down
Loading