Struct sp1_core::runtime::Runtime

pub struct Runtime<'a> {

    pub program: Arc<Program>,
    pub state: ExecutionState,
    pub record: ExecutionRecord,
    pub records: Vec<ExecutionRecord>,
    pub memory_accesses: MemoryAccessRecord,
    pub shard_size: u32,
    pub shard_batch_size: u32,
    pub cycle_tracker: HashMap<String, (u64, u32)>,
    pub io_buf: HashMap<u32, String>,
    pub trace_buf: Option<BufWriter<File>>,
    pub unconstrained: bool,
    pub syscall_map: HashMap<SyscallCode, Arc<dyn Syscall>>,
    pub max_syscall_cycles: u32,
    pub emit_events: bool,
    pub report: ExecutionReport,
    pub print_report: bool,
    pub subproof_verifier: Arc<dyn SubproofVerifier + 'a>,
    pub hook_registry: HookRegistry<'a>,
    pub opts: SP1CoreOpts,
    pub max_cycles: Option<u64>,
    /* private fields */
}

An implementation of a runtime for the SP1 RISC-V zkVM.

The runtime is responsible for executing a user program and tracing important events which occur during execution (i.e., memory reads, alu operations, etc).

For more information on the RV32IM instruction set, see the following: https://www.cs.sfu.ca/~ashriram/Courses/CS295/assets/notebooks/RISCV/RISCV_CARD.pdf

Fields

program: Arc<Program>

The program.

state: ExecutionState

The state of the execution.

record: ExecutionRecord

The current trace of the execution that is being collected.

records: Vec<ExecutionRecord>

The collected records, split by cpu cycles.

memory_accesses: MemoryAccessRecord

The memory accesses for the current cycle.

shard_size: u32

The maximum size of each shard.

shard_batch_size: u32

cycle_tracker: HashMap<String, (u64, u32)>

A counter for the number of cycles that have been executed in certain functions.

io_buf: HashMap<u32, String>

A buffer for stdout and stderr IO.

trace_buf: Option<BufWriter<File>>

A buffer for writing trace events to a file.

unconstrained: bool

Whether the runtime is in constrained mode or not.

In unconstrained mode, any events, clock, register, or memory changes are reset after leaving the unconstrained block. The only thing preserved is writes to the input stream.

syscall_map: HashMap<SyscallCode, Arc<dyn Syscall>>

The mapping between syscall codes and their implementations.

max_syscall_cycles: u32

The maximum number of cycles for a syscall.

emit_events: bool

Whether to emit events during execution.

report: ExecutionReport

Report of the program execution.

print_report: bool

Whether we should write to the report.

subproof_verifier: Arc<dyn SubproofVerifier + 'a>

Verifier used to sanity check verify_sp1_proof during runtime.

hook_registry: HookRegistry<'a>

Registry of hooks, to be invoked by writing to certain file descriptors.

opts: SP1CoreOpts

max_cycles: Option<u64>

The maximum number of cpu cycles to use for execution.

Implementations

impl<'a> Runtime<'a>

pub fn write_stdin<T: Serialize>(&mut self, input: &T)

pub fn write_stdin_slice(&mut self, input: &[u8])

pub fn write_vecs(&mut self, inputs: &[Vec<u8>])

pub fn write_proof( &mut self, proof: ShardProof<BabyBearPoseidon2>, vk: StarkVerifyingKey<BabyBearPoseidon2>, )

pub fn read_public_values<T: DeserializeOwned>(&mut self) -> T

pub fn read_public_values_slice(&mut self, buf: &mut [u8])

impl<'a> Runtime<'a>

pub fn log(&mut self, instruction: &Instruction)

impl<'a> Runtime<'a>

pub fn new(program: Program, opts: SP1CoreOpts) -> Self

pub fn with_context( program: Program, opts: SP1CoreOpts, context: SP1Context<'a>, ) -> Self

Create a new runtime from a program, options, and a context.

pub fn hook(&self, fd: u32, buf: &[u8]) -> Vec<Vec<u8>>

Invokes the hook corresponding to the given file descriptor fd with the data buf, returning the resulting data.

pub fn hook_env<'b>(&'b self) -> HookEnv<'b, 'a>

Prepare a HookEnv for use by hooks.

pub fn recover( program: Program, state: ExecutionState, opts: SP1CoreOpts, ) -> Self

Recover runtime state from a program and existing execution state.

pub fn registers(&self) -> [u32; 32]

Get the current values of the registers.

pub fn register(&self, register: Register) -> u32

Get the current value of a register.

pub fn word(&self, addr: u32) -> u32

Get the current value of a word.

pub fn byte(&self, addr: u32) -> u8

Get the current value of a byte.

pub const fn timestamp(&self, position: &MemoryAccessPosition) -> u32

Get the current timestamp for a given memory access position.

pub fn shard(&self) -> u32

Get the current shard.

pub fn channel(&self) -> u32

pub fn mr(&mut self, addr: u32, shard: u32, timestamp: u32) -> MemoryReadRecord

Read a word from memory and create an access record.

pub fn mw( &mut self, addr: u32, value: u32, shard: u32, timestamp: u32, ) -> MemoryWriteRecord

Write a word to memory and create an access record.

pub fn mr_cpu(&mut self, addr: u32, position: MemoryAccessPosition) -> u32

Read from memory, assuming that all addresses are aligned.

pub fn mw_cpu(&mut self, addr: u32, value: u32, position: MemoryAccessPosition)

Write to memory.

pub fn rr(&mut self, register: Register, position: MemoryAccessPosition) -> u32

Read from a register.

pub fn rw(&mut self, register: Register, value: u32)

Write to a register.

pub fn bump_record(&mut self)

pub fn execute_record( &mut self, ) -> Result<(Vec<ExecutionRecord>, bool), ExecutionError>

Execute up to self.shard_batch_size cycles, returning the events emitted and whether the program ended.

pub fn execute_state( &mut self, ) -> Result<(ExecutionState, bool), ExecutionError>

Execute up to self.shard_batch_size cycles, returning a copy of the prestate and whether the program ended.

pub fn run_untraced(&mut self) -> Result<(), ExecutionError>

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

pub fn dry_run(&mut self)

Trait Implementations

impl<'a> Read for Runtime<'a>

fn read(&mut self, buf: &mut [u8]) -> Result<usize>

Pull some bytes from this source into the specified buffer, returning how many bytes were read.

fn read_vectored(&mut self, bufs: &mut [IoSliceMut<'_>]) -> Result<usize, Error>

Like read, except that it reads into a slice of buffers.

fn is_read_vectored(&self) -> bool

🔬This is a nightly-only experimental API. (can_vector)

Determines if this Reader has an efficient read_vectored implementation.

fn read_to_end(&mut self, buf: &mut Vec<u8>) -> Result<usize, Error>

Read all bytes until EOF in this source, placing them into buf.

fn read_to_string(&mut self, buf: &mut String) -> Result<usize, Error>

Read all bytes until EOF in this source, appending them to buf.

fn read_exact(&mut self, buf: &mut [u8]) -> Result<(), Error>

Read the exact number of bytes required to fill buf.

fn read_buf(&mut self, buf: BorrowedCursor<'_>) -> Result<(), Error>

🔬This is a nightly-only experimental API. (read_buf)

Pull some bytes from this source into the specified buffer.

fn read_buf_exact(&mut self, cursor: BorrowedCursor<'_>) -> Result<(), Error>

🔬This is a nightly-only experimental API. (read_buf)

Read the exact number of bytes required to fill cursor.

fn by_ref(&mut self) -> &mut Self

where Self: Sized,

Creates a “by reference” adaptor for this instance of Read.

fn bytes(self) -> Bytes<Self>

where Self: Sized,

Transforms this Read instance to an Iterator over its bytes.

fn chain<R>(self, next: R) -> Chain<Self, R>

where R: Read, Self: Sized,

Creates an adapter which will chain this stream with another.

fn take(self, limit: u64) -> Take<Self>

where Self: Sized,

Creates an adapter which will read at most limit bytes from it.