Struct ExecutorImpl

pub struct ExecutorImpl<'a> { /* private fields */ }

Available on crate feature prove and non-target_os="zkvm" only.

The proving phase uses an execution trace generated by the Executor.

Implementations

impl<'a> ExecutorImpl<'a>

pub fn new(env: ExecutorEnv<'a>, image: MemoryImage) -> Result<Self>

Construct a new ExecutorImpl from a MemoryImage and entry point.

Before a guest program is proven, the ExecutorImpl is responsible for deciding where a zkVM program should be split into Segments and what work will be done in each segment. This is the execution phase: the guest program is executed to determine how its proof should be divided into subparts.

pub fn from_elf(env: ExecutorEnv<'a>, elf: &[u8]) -> Result<Self>

Construct a new ExecutorImpl from the ELF binary of the guest program you want to run and an ExecutorEnv containing relevant environmental configuration details.

pub fn run(&mut self) -> Result<Session>

This will run the executor to get a Session which contain the results of the execution.

pub fn run_with_callback<F>(&mut self, callback: F) -> Result<Session>

where F: FnMut(Segment) -> Result<Box<dyn SegmentRef>> + Send,

Run the executor until crate::ExitCode::Halted or crate::ExitCode::Paused is reached, producing a Session as a result.

Trait Implementations

impl Syscall for ExecutorImpl<'_>

fn host_read( &self, ctx: &mut dyn CircuitSyscallContext, fd: u32, buf: &mut [u8], ) -> Result<u32>

Reads from the host.

fn host_write( &self, ctx: &mut dyn CircuitSyscallContext, _fd: u32, buf: &[u8], ) -> Result<u32>

Writes to the host.