Add wasmtime support and make wasmi optional.

Author: graydon

Cargo.lock

@@ -32,6 +32,13 @@ soroban-builtin-sdk-macros = { version = "=23.0.0", path = "soroban-builtin-sdk-
 # NB: this must match the wasmparser version wasmi is using
 wasmparser = "=0.116.1"
 
+[workspace.dependencies.wasmtime]
+version = "28.0"
+default-features = false
+features = ["runtime", "winch"]
+git = "https://github.com/bytecodealliance/wasmtime"
+rev = "b5627a86a7740ffc732f4c22b9f0b2c66252638b"
+
 # NB: When updating, also update the version in rs-soroban-env dev-dependencies
 [workspace.dependencies.stellar-xdr]
 version = "=22.1.0"

Cargo.toml

@@ -24,6 +24,7 @@ ethnum = "1.5.0"
 arbitrary = { version = "1.3.2", features = ["derive"], optional = true }
 num-traits = {version = "0.2.17", default-features = false}
 num-derive = "0.4.1"
+wasmtime = { workspace = true, optional = true}
 
 [target.'cfg(not(target_family = "wasm"))'.dependencies]
 tracy-client = { version = "0.17.0", features = ["enable", "timer-fallback"], default-features = false, optional = true }
@@ -36,6 +37,7 @@ num-traits = "0.2.17"
 std = ["stellar-xdr/std", "stellar-xdr/base64"]
 serde = ["dep:serde", "stellar-xdr/serde"]
 wasmi = ["dep:wasmi", "dep:wasmparser"]
+wasmtime = ["dep:wasmtime"]
 testutils = ["dep:arbitrary", "stellar-xdr/arbitrary"]
 next = ["stellar-xdr/next", "soroban-env-macros/next"]
 tracy = ["dep:tracy-client"]

soroban-env-common/Cargo.toml

@@ -283,6 +283,49 @@ impl From<wasmparser::BinaryReaderError> for Error {
     }
 }
 
+#[cfg(feature = "wasmtime")]
+impl From<wasmtime::Trap> for Error {
+    #[allow(clippy::wildcard_in_or_patterns)]
+    fn from(trap: wasmtime::Trap) -> Self {
+        let ec = match trap {
+            wasmtime::Trap::UnreachableCodeReached => ScErrorCode::InvalidAction,
+
+            wasmtime::Trap::MemoryOutOfBounds | wasmtime::Trap::TableOutOfBounds => {
+                ScErrorCode::IndexBounds
+            }
+
+            wasmtime::Trap::IndirectCallToNull => ScErrorCode::MissingValue,
+
+            wasmtime::Trap::IntegerDivisionByZero
+            | wasmtime::Trap::IntegerOverflow
+            | wasmtime::Trap::BadConversionToInteger => ScErrorCode::ArithDomain,
+
+            wasmtime::Trap::BadSignature => ScErrorCode::UnexpectedType,
+
+            wasmtime::Trap::StackOverflow
+            | wasmtime::Trap::Interrupt
+            | wasmtime::Trap::OutOfFuel => {
+                return Error::from_type_and_code(ScErrorType::Budget, ScErrorCode::ExceededLimit)
+            }
+
+            wasmtime::Trap::HeapMisaligned
+            | wasmtime::Trap::AlwaysTrapAdapter
+            | wasmtime::Trap::AtomicWaitNonSharedMemory
+            | wasmtime::Trap::NullReference
+            | wasmtime::Trap::CannotEnterComponent
+            | _ => ScErrorCode::InvalidAction,
+        };
+        Error::from_type_and_code(ScErrorType::WasmVm, ec)
+    }
+}
+
+#[cfg(feature = "wasmtime")]
+impl From<wasmtime::MemoryAccessError> for Error {
+    fn from(_: wasmtime::MemoryAccessError) -> Self {
+        Error::from_type_and_code(ScErrorType::WasmVm, ScErrorCode::IndexBounds)
+    }
+}
+
 impl Error {
     // NB: we don't provide a "get_type" to avoid casting a bad bit-pattern into
     // an ScErrorType. Instead we provide an "is_type" to check any specific

soroban-env-common/src/error.rs

@@ -113,6 +113,8 @@ pub use val::{ConversionError, Tag, Val};
 
 #[cfg(feature = "wasmi")]
 pub use val::WasmiMarshal;
+#[cfg(feature = "wasmtime")]
+pub use val::WasmtimeMarshal;
 pub use val::{AddressObject, MapObject, MuxedAddressObject, VecObject};
 pub use val::{Bool, Void};
 

soroban-env-common/src/lib.rs

@@ -469,6 +469,62 @@ impl WasmiMarshal for i64 {
     }
 }
 
+#[cfg(feature = "wasmtime")]
+pub trait WasmtimeMarshal: Sized {
+    fn try_marshal_from_wasmtime_value(v: wasmtime::Val) -> Option<Self>;
+    fn marshal_wasmtime_from_self(self) -> wasmtime::Val;
+}
+
+#[cfg(feature = "wasmtime")]
+impl WasmtimeMarshal for Val {
+    fn try_marshal_from_wasmtime_value(v: wasmtime::Val) -> Option<Self> {
+        if let wasmtime::Val::I64(i) = v {
+            let v = Val::from_payload(i as u64);
+            if v.is_good() {
+                Some(v)
+            } else {
+                None
+            }
+        } else {
+            None
+        }
+    }
+
+    fn marshal_wasmtime_from_self(self) -> wasmtime::Val {
+        wasmtime::Val::I64(self.get_payload() as i64)
+    }
+}
+
+#[cfg(feature = "wasmtime")]
+impl WasmtimeMarshal for u64 {
+    fn try_marshal_from_wasmtime_value(v: wasmtime::Val) -> Option<Self> {
+        if let wasmtime::Val::I64(i) = v {
+            Some(i as u64)
+        } else {
+            None
+        }
+    }
+
+    fn marshal_wasmtime_from_self(self) -> wasmtime::Val {
+        wasmtime::Val::I64(self as i64)
+    }
+}
+
+#[cfg(feature = "wasmtime")]
+impl WasmtimeMarshal for i64 {
+    fn try_marshal_from_wasmtime_value(v: wasmtime::Val) -> Option<Self> {
+        if let wasmtime::Val::I64(i) = v {
+            Some(i)
+        } else {
+            None
+        }
+    }
+
+    fn marshal_wasmtime_from_self(self) -> wasmtime::Val {
+        wasmtime::Val::I64(self)
+    }
+}
+
 // Manually implement all the residual pieces: ValConverts
 // and Froms.
 

soroban-env-common/src/val.rs

@@ -26,38 +26,67 @@ use core::marker::PhantomData;
 /// allows code to import and use `Env` directly (such as the native
 /// contract) to call host methods without having to write `VmCaller::none()`
 /// everywhere.
-#[cfg(feature = "wasmi")]
-pub struct VmCaller<'a, T>(pub Option<wasmi::Caller<'a, T>>);
-#[cfg(feature = "wasmi")]
+
+#[cfg(any(feature = "wasmi", feature = "wasmtime"))]
+pub enum VmCaller<'a, T> {
+    #[cfg(feature = "wasmi")]
+    WasmiCaller(wasmi::Caller<'a, T>),
+    #[cfg(feature = "wasmtime")]
+    WasmtimeCaller(wasmtime::Caller<'a, T>),
+    NoCaller,
+}
+#[cfg(any(feature = "wasmi", feature = "wasmtime"))]
 impl<'a, T> VmCaller<'a, T> {
     pub fn none() -> Self {
-        VmCaller(None)
+        VmCaller::NoCaller
     }
+    #[cfg(feature = "wasmi")]
     pub fn try_ref(&self) -> Result<&wasmi::Caller<'a, T>, Error> {
-        match &self.0 {
-            Some(caller) => Ok(caller),
-            None => Err(Error::from_type_and_code(
+        match self {
+            VmCaller::WasmiCaller(caller) => Ok(caller),
+            _ => Err(Error::from_type_and_code(
                 ScErrorType::Context,
                 ScErrorCode::InternalError,
             )),
         }
     }
+    #[cfg(feature = "wasmi")]
     pub fn try_mut(&mut self) -> Result<&mut wasmi::Caller<'a, T>, Error> {
-        match &mut self.0 {
-            Some(caller) => Ok(caller),
-            None => Err(Error::from_type_and_code(
+        match self {
+            VmCaller::WasmiCaller(caller) => Ok(caller),
+            _ => Err(Error::from_type_and_code(
+                ScErrorType::Context,
+                ScErrorCode::InternalError,
+            )),
+        }
+    }
+    #[cfg(feature = "wasmtime")]
+    pub fn try_ref_wasmtime(&self) -> Result<&wasmtime::Caller<'a, T>, Error> {
+        match self {
+            VmCaller::WasmtimeCaller(caller) => Ok(caller),
+            _ => Err(Error::from_type_and_code(
+                ScErrorType::Context,
+                ScErrorCode::InternalError,
+            )),
+        }
+    }
+    #[cfg(feature = "wasmtime")]
+    pub fn try_mut_wasmtime(&mut self) -> Result<&mut wasmtime::Caller<'a, T>, Error> {
+        match self {
+            VmCaller::WasmtimeCaller(caller) => Ok(caller),
+            _ => Err(Error::from_type_and_code(
                 ScErrorType::Context,
                 ScErrorCode::InternalError,
             )),
         }
     }
 }
 
-#[cfg(not(feature = "wasmi"))]
+#[cfg(not(any(feature = "wasmi", feature = "wasmtime")))]
 pub struct VmCaller<'a, T> {
     _nothing: PhantomData<&'a T>,
 }
-#[cfg(not(feature = "wasmi"))]
+#[cfg(not(any(feature = "wasmi", feature = "wasmtime")))]
 impl<'a, T> VmCaller<'a, T> {
     pub fn none() -> Self {
         VmCaller {

soroban-env-common/src/vmcaller_env.rs

@@ -15,8 +15,9 @@ exclude = ["observations/"]
 
 [dependencies]
 soroban-builtin-sdk-macros = { workspace = true }
-soroban-env-common = { workspace = true, features = ["std", "wasmi", "shallow-val-hash"] }
-wasmi = { workspace = true }
+soroban-env-common = { workspace = true, features = ["std", "shallow-val-hash"] }
+wasmi = { workspace = true, optional = true }
+wasmtime = { workspace = true, optional = true }
 wasmparser = { workspace = true }
 stellar-strkey = "0.0.13"
 static_assertions = "1.1.0"
@@ -90,6 +91,9 @@ default-features = false
 features = ["arbitrary"]
 
 [features]
+default = ["wasmi", "wasmtime"]
+wasmi = ["dep:wasmi", "soroban-env-common/wasmi"]
+wasmtime = ["dep:wasmtime", "soroban-env-common/wasmtime"]
 testutils = ["soroban-env-common/testutils", "recording_mode"]
 backtrace = ["dep:backtrace"]
 next = ["soroban-env-common/next", "stellar-xdr/next"]

soroban-env-host/Cargo.toml

@@ -2,13 +2,21 @@ mod dimension;
 mod limits;
 mod model;
 mod util;
+#[cfg(feature = "wasmi")]
 mod wasmi_helper;
+#[cfg(feature = "wasmtime")]
+mod wasmtime_helper;
 
 pub(crate) use limits::DepthLimiter;
 pub use limits::{DEFAULT_HOST_DEPTH_LIMIT, DEFAULT_XDR_RW_LIMITS};
 pub use model::{MeteredCostComponent, ScaledU64};
+
+#[cfg(feature = "wasmi")]
 pub(crate) use wasmi_helper::{get_wasmi_config, load_calibrated_fuel_costs};
 
+#[cfg(feature = "wasmtime")]
+pub(crate) use wasmtime_helper::get_wasmtime_config;
+
 use std::{
     cell::{RefCell, RefMut},
     fmt::{Debug, Display},

soroban-env-host/src/budget.rs

@@ -0,0 +1,15 @@
+use crate::{budget::Budget, HostError};
+
+pub(crate) fn get_wasmtime_config(_budget: &Budget) -> Result<wasmtime::Config, HostError> {
+    let mut config = wasmtime::Config::new();
+    config
+        .strategy(wasmtime::Strategy::Winch)
+        .debug_info(false)
+        .generate_address_map(false)
+        .consume_fuel(true)
+        .wasm_bulk_memory(true)
+        .wasm_multi_value(false)
+        .wasm_simd(false)
+        .wasm_tail_call(false);
+    Ok(config)
+}