pub struct SystemRuntime { /* private fields */ }Expand description
A system runtime instance.
System runtimes are trusted programs executed through Wasmtime and reused across calls. This wrapper owns:
- a cached, compiled+instantiated Wasmtime runtime (
CompiledRuntime), - the per-call
RuntimeContext(ctx) which is swapped into the cached store on execution, - an optional resumable interruption state used when system runtimes request an interruption.
- a flag indicating whether Wasmtime fuel metering is enabled (
consume_fuel).
The runtime is keyed by code_hash so that we can cache compiled artifacts and instances.
Implementations§
Source§impl SystemRuntime
impl SystemRuntime
Sourcepub fn reset_cached_runtimes()
pub fn reset_cached_runtimes()
Clears the per-thread cache of instantiated runtimes.
Useful in tests or when a process needs to drop cached instances (e.g. after an upgrade).
Sourcepub fn new(
rwasm_module: RwasmModule,
import_linker: Arc<ImportLinker>,
code_hash: B256,
ctx: RuntimeContext,
consume_fuel: bool,
) -> Self
pub fn new( rwasm_module: RwasmModule, import_linker: Arc<ImportLinker>, code_hash: B256, ctx: RuntimeContext, consume_fuel: bool, ) -> Self
Creates a new SystemRuntime.
If a compiled runtime for code_hash is present in the thread-local cache, it will be reused.
Otherwise, this function compiles/loads the module and instantiates it with imports wired via
import_linker.
§Fuel metering
The consume_fuel parameter determines whether Wasmtime fuel metering is enabled:
true: Engine automatically meters fuel (for NITRO, OAUTH2, WASM_RUNTIME, WEBAUTHN)false: Contract self-meters via_charge_fuelsyscall (for EVM_RUNTIME, etc.)
Sourcepub fn execute(&mut self) -> Result<(), TrapCode>
pub fn execute(&mut self) -> Result<(), TrapCode>
Executes the system runtime entrypoint and updates self.ctx.execution_result.
Execution uses the cached store/instance. Before calling into Wasmtime, we swap
self.ctx into the store to ensure syscalls and state access refer to the correct context.
§Fuel metering
If consume_fuel=true, the fuel limit is set in the store before execution. Wasmtime
will automatically decrement fuel as instructions execute.
§Error handling model
- If Wasmtime traps unexpectedly, we do not propagate the trap outward as fatal.
Instead, we mark
UnexpectedFatalExecutionFailureinexecution_resultand returnOk(())so the outer executor can treat it as a partially controlled failure. - Normal completion is signaled by output where the first 4 bytes are LE
exit_code. - Interruption is requested by returning
ExitCode::InterruptionCalledin that header.
Sourcepub fn resume(
&mut self,
_exit_code: i32,
_fuel_consumed: u64,
) -> Result<(), TrapCode>
pub fn resume( &mut self, _exit_code: i32, _fuel_consumed: u64, ) -> Result<(), TrapCode>
Resumes execution after an interruption.
System runtimes do not support “native” resumable interruptions internally in the same way
as contract runtimes. Therefore, resume currently re-enters execute() after clearing any
stale output.
Note: exit_code and fuel_consumed are intentionally ignored here because fuel metering
is handled by RuntimeContext, and exit codes are encoded in returned output.
Sourcepub fn memory_write(
&mut self,
offset: usize,
data: &[u8],
) -> Result<(), TrapCode>
pub fn memory_write( &mut self, offset: usize, data: &[u8], ) -> Result<(), TrapCode>
Writes bytes into the system runtime’s linear memory.
Bounds violations are mapped into TrapCode::MemoryOutOfBounds.
Sourcepub fn memory_read(
&mut self,
offset: usize,
buffer: &mut [u8],
) -> Result<(), TrapCode>
pub fn memory_read( &mut self, offset: usize, buffer: &mut [u8], ) -> Result<(), TrapCode>
Reads bytes from the system runtime’s linear memory.
Bounds violations are mapped into TrapCode::MemoryOutOfBounds.
Sourcepub fn remaining_fuel(&self) -> Option<u64>
pub fn remaining_fuel(&self) -> Option<u64>
Returns remaining fuel if fuel metering is enabled.
For engine-metered precompiles (consume_fuel=true), returns the actual remaining fuel
from the Wasmtime store.
For self-metering runtimes (consume_fuel=false), returns None because fuel is
tracked in RuntimeContext via _charge_fuel syscall, not in the Wasmtime store.
Sourcepub fn context_mut(&mut self) -> &mut RuntimeContext
pub fn context_mut(&mut self) -> &mut RuntimeContext
Provides mutable access to the per-call runtime context.
Sourcepub fn context(&self) -> &RuntimeContext
pub fn context(&self) -> &RuntimeContext
Provides immutable access to the per-call runtime context.
Auto Trait Implementations§
impl !Freeze for SystemRuntime
impl !RefUnwindSafe for SystemRuntime
impl !Send for SystemRuntime
impl !Sync for SystemRuntime
impl Unpin for SystemRuntime
impl UnsafeUnpin for SystemRuntime
impl !UnwindSafe for SystemRuntime
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> Downcast for Twhere
T: Any,
impl<T> Downcast for Twhere
T: Any,
Source§fn into_any(self: Box<T>) -> Box<dyn Any>
fn into_any(self: Box<T>) -> Box<dyn Any>
Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>, which can then be
downcast into Box<dyn ConcreteType> where ConcreteType implements Trait.Source§fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
Rc<Trait> (where Trait: Downcast) to Rc<Any>, which can then be further
downcast into Rc<ConcreteType> where ConcreteType implements Trait.Source§fn as_any(&self) -> &(dyn Any + 'static)
fn as_any(&self) -> &(dyn Any + 'static)
&Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot
generate &Any’s vtable from &Trait’s.Source§fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
&mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot
generate &mut Any’s vtable from &mut Trait’s.Source§impl<T> FmtForward for T
impl<T> FmtForward for T
Source§fn fmt_binary(self) -> FmtBinary<Self>where
Self: Binary,
fn fmt_binary(self) -> FmtBinary<Self>where
Self: Binary,
self to use its Binary implementation when Debug-formatted.Source§fn fmt_display(self) -> FmtDisplay<Self>where
Self: Display,
fn fmt_display(self) -> FmtDisplay<Self>where
Self: Display,
self to use its Display implementation when
Debug-formatted.Source§fn fmt_lower_exp(self) -> FmtLowerExp<Self>where
Self: LowerExp,
fn fmt_lower_exp(self) -> FmtLowerExp<Self>where
Self: LowerExp,
self to use its LowerExp implementation when
Debug-formatted.Source§fn fmt_lower_hex(self) -> FmtLowerHex<Self>where
Self: LowerHex,
fn fmt_lower_hex(self) -> FmtLowerHex<Self>where
Self: LowerHex,
self to use its LowerHex implementation when
Debug-formatted.Source§fn fmt_octal(self) -> FmtOctal<Self>where
Self: Octal,
fn fmt_octal(self) -> FmtOctal<Self>where
Self: Octal,
self to use its Octal implementation when Debug-formatted.Source§fn fmt_pointer(self) -> FmtPointer<Self>where
Self: Pointer,
fn fmt_pointer(self) -> FmtPointer<Self>where
Self: Pointer,
self to use its Pointer implementation when
Debug-formatted.Source§fn fmt_upper_exp(self) -> FmtUpperExp<Self>where
Self: UpperExp,
fn fmt_upper_exp(self) -> FmtUpperExp<Self>where
Self: UpperExp,
self to use its UpperExp implementation when
Debug-formatted.Source§fn fmt_upper_hex(self) -> FmtUpperHex<Self>where
Self: UpperHex,
fn fmt_upper_hex(self) -> FmtUpperHex<Self>where
Self: UpperHex,
self to use its UpperHex implementation when
Debug-formatted.Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> Pipe for Twhere
T: ?Sized,
impl<T> Pipe for Twhere
T: ?Sized,
Source§fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
Source§fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
R: 'a,
fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
R: 'a,
self and passes that borrow into the pipe function. Read moreSource§fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
R: 'a,
fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
R: 'a,
self and passes that borrow into the pipe function. Read moreSource§fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
Source§fn pipe_borrow_mut<'a, B, R>(
&'a mut self,
func: impl FnOnce(&'a mut B) -> R,
) -> R
fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R, ) -> R
Source§fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
self, then passes self.as_ref() into the pipe function.Source§fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
self, then passes self.as_mut() into the pipe
function.Source§fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
self, then passes self.deref() into the pipe function.Source§impl<T> Pointable for T
impl<T> Pointable for T
Source§impl<T> Tap for T
impl<T> Tap for T
Source§fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
Borrow<B> of a value. Read moreSource§fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
BorrowMut<B> of a value. Read moreSource§fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
AsRef<R> view of a value. Read moreSource§fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
AsMut<R> view of a value. Read moreSource§fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
Deref::Target of a value. Read moreSource§fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
Deref::Target of a value. Read moreSource§fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
.tap() only in debug builds, and is erased in release builds.Source§fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
.tap_mut() only in debug builds, and is erased in release
builds.Source§fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
.tap_borrow() only in debug builds, and is erased in release
builds.Source§fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
.tap_borrow_mut() only in debug builds, and is erased in release
builds.Source§fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
.tap_ref() only in debug builds, and is erased in release
builds.Source§fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
.tap_ref_mut() only in debug builds, and is erased in release
builds.Source§fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
.tap_deref() only in debug builds, and is erased in release
builds.