pub struct InterpretedInstance<'a, F, Ctx> { /* private fields */ }Expand description
VM pure executor(E1/E2 executor) which doesn’t consider trace generation. Note: This executor doesn’t hold any VM state and can be used for multiple execution.
The generic Ctx and constructor determine whether this supported pure execution or metered
execution.
Implementations§
Source§impl<'a, F, Ctx> InterpretedInstance<'a, F, Ctx>where
F: PrimeField32,
Ctx: ExecutionCtxTrait,
impl<'a, F, Ctx> InterpretedInstance<'a, F, Ctx>where
F: PrimeField32,
Ctx: ExecutionCtxTrait,
Sourcepub fn new<E>(
inventory: &'a ExecutorInventory<E>,
exe: &VmExe<F>,
) -> Result<Self, StaticProgramError>where
E: Executor<F>,
pub fn new<E>(
inventory: &'a ExecutorInventory<E>,
exe: &VmExe<F>,
) -> Result<Self, StaticProgramError>where
E: Executor<F>,
Creates a new interpreter instance for pure execution.
pub fn create_initial_vm_state( &self, inputs: impl Into<Streams<F>>, ) -> VmState<F>
Source§impl<'a, F, Ctx> InterpretedInstance<'a, F, Ctx>where
F: PrimeField32,
Ctx: MeteredExecutionCtxTrait,
impl<'a, F, Ctx> InterpretedInstance<'a, F, Ctx>where
F: PrimeField32,
Ctx: MeteredExecutionCtxTrait,
Sourcepub fn new_metered<E>(
inventory: &'a ExecutorInventory<E>,
exe: &VmExe<F>,
executor_idx_to_air_idx: &[usize],
) -> Result<Self, StaticProgramError>where
E: MeteredExecutor<F>,
pub fn new_metered<E>(
inventory: &'a ExecutorInventory<E>,
exe: &VmExe<F>,
executor_idx_to_air_idx: &[usize],
) -> Result<Self, StaticProgramError>where
E: MeteredExecutor<F>,
Creates a new interpreter instance for pure execution.
Source§impl<F> InterpretedInstance<'_, F, ExecutionCtx>where
F: PrimeField32,
impl<F> InterpretedInstance<'_, F, ExecutionCtx>where
F: PrimeField32,
Sourcepub fn execute(
&self,
inputs: impl Into<Streams<F>>,
num_insns: Option<u64>,
) -> Result<VmState<F, GuestMemory>, ExecutionError>
pub fn execute( &self, inputs: impl Into<Streams<F>>, num_insns: Option<u64>, ) -> Result<VmState<F, GuestMemory>, ExecutionError>
Pure execution, without metering, for the given inputs. Execution begins from the initial
state specified by the VmExe. This function executes the program until either termination
if num_insns is None or for exactly num_insns instructions if num_insns is Some.
Returns the final VM state when execution stops.
Sourcepub fn execute_from_state(
&self,
from_state: VmState<F, GuestMemory>,
num_insns: Option<u64>,
) -> Result<VmState<F, GuestMemory>, ExecutionError>
pub fn execute_from_state( &self, from_state: VmState<F, GuestMemory>, num_insns: Option<u64>, ) -> Result<VmState<F, GuestMemory>, ExecutionError>
Pure execution, without metering, from the given VmState. This function executes the
program until either termination if num_insns is None or for exactly num_insns
instructions if num_insns is Some.
Returns the final VM state when execution stops.
Source§impl<F> InterpretedInstance<'_, F, MeteredCtx>where
F: PrimeField32,
impl<F> InterpretedInstance<'_, F, MeteredCtx>where
F: PrimeField32,
Sourcepub fn execute_metered(
&self,
inputs: impl Into<Streams<F>>,
ctx: MeteredCtx,
) -> Result<(Vec<Segment>, VmState<F, GuestMemory>), ExecutionError>
pub fn execute_metered( &self, inputs: impl Into<Streams<F>>, ctx: MeteredCtx, ) -> Result<(Vec<Segment>, VmState<F, GuestMemory>), ExecutionError>
Metered execution for the given inputs. Execution begins from the initial
state specified by the VmExe. This function executes the program until termination.
Returns the segmentation boundary data and the final VM state when execution stops.
Sourcepub fn execute_metered_from_state(
&self,
from_state: VmState<F, GuestMemory>,
ctx: MeteredCtx,
) -> Result<(Vec<Segment>, VmState<F, GuestMemory>), ExecutionError>
pub fn execute_metered_from_state( &self, from_state: VmState<F, GuestMemory>, ctx: MeteredCtx, ) -> Result<(Vec<Segment>, VmState<F, GuestMemory>), ExecutionError>
Metered execution for the given VmState. This function executes the program until
termination.
Returns the segmentation boundary data and the final VM state when execution stops.
The MeteredCtx can be constructed using either VmExecutor::build_metered_ctx or VirtualMachine::build_metered_ctx.
Sourcepub fn execute_metered_until_suspend(
&self,
exec_state: VmExecState<F, GuestMemory, MeteredCtx>,
) -> Result<VmExecState<F, GuestMemory, MeteredCtx>, ExecutionError>
pub fn execute_metered_until_suspend( &self, exec_state: VmExecState<F, GuestMemory, MeteredCtx>, ) -> Result<VmExecState<F, GuestMemory, MeteredCtx>, ExecutionError>
Executes a metered virtual machine operation starting from a given execution state until suspension.
This function resumes and continues execution of a guest virtual machine until either it:
- Hits a suspension trigger (e.g. out of gas or a specific halt condition). ATTENTION: when a suspension is triggered, the VM state is not at the boundary of the last segment. Instead, the VM state is slightly after the segment boundary.
- Completes its run based on the instructions or context provided.
§Parameters
self: The reference to the current executor or VM context.exec_state: A mutableVmExecState<F, GuestMemory, MeteredCtx>which represents the execution state of the virtual machine, including its program counter (pc), instruction retirement (instret), and execution context (MeteredCtx).
§Returns
Ok(VmExecState<F, GuestMemory, MeteredCtx>): The execution state after suspension or normal completion.Err(ExecutionError): If there is an error during execution, such as an invalid state or run-time error.
Source§impl<F> InterpretedInstance<'_, F, MeteredCostCtx>where
F: PrimeField32,
impl<F> InterpretedInstance<'_, F, MeteredCostCtx>where
F: PrimeField32,
Sourcepub fn execute_metered_cost(
&self,
inputs: impl Into<Streams<F>>,
ctx: MeteredCostCtx,
) -> Result<(u64, VmState<F, GuestMemory>), ExecutionError>
pub fn execute_metered_cost( &self, inputs: impl Into<Streams<F>>, ctx: MeteredCostCtx, ) -> Result<(u64, VmState<F, GuestMemory>), ExecutionError>
Metered cost execution for the given inputs. Execution begins from the initial
state specified by the VmExe. This function executes the program until termination.
Returns the trace cost and final VM state when execution stops.
Sourcepub fn execute_metered_cost_from_state(
&self,
from_state: VmState<F, GuestMemory>,
ctx: MeteredCostCtx,
) -> Result<(u64, VmState<F, GuestMemory>), ExecutionError>
pub fn execute_metered_cost_from_state( &self, from_state: VmState<F, GuestMemory>, ctx: MeteredCostCtx, ) -> Result<(u64, VmState<F, GuestMemory>), ExecutionError>
Metered cost execution for the given VmState. This function executes the program until
termination.
Returns the trace cost and final VM state when execution stops.
Auto Trait Implementations§
impl<'a, F, Ctx> Freeze for InterpretedInstance<'a, F, Ctx>
impl<'a, F, Ctx> RefUnwindSafe for InterpretedInstance<'a, F, Ctx>
impl<'a, F, Ctx> !Send for InterpretedInstance<'a, F, Ctx>
impl<'a, F, Ctx> !Sync for InterpretedInstance<'a, F, Ctx>
impl<'a, F, Ctx> Unpin for InterpretedInstance<'a, F, Ctx>
impl<'a, F, Ctx> UnwindSafe for InterpretedInstance<'a, F, Ctx>
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> 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.