Struct miden_processor::Process

pub struct Process<H>
where
    H: Host,
{ /* private fields */ }

A Process is the underlying execution engine for a Miden Program.

Typically, you do not need to worry about, or use Process directly, instead you should prefer to use either execute or execute_iter, which also handle setting up the process state, inputs, as well as compute the ExecutionTrace for the program.

However, for situations in which you want finer-grained control over those steps, you will need to construct an instance of Process using Process::new, invoke Process::execute, and then get the execution trace using ExecutionTrace::new using the outputs produced by execution.

Implementations

impl<H> Process<H>

where H: Host,

pub fn new( kernel: Kernel, stack_inputs: StackInputs, host: H, execution_options: ExecutionOptions, ) -> Self

Creates a new process with the provided inputs.

pub fn new_debug(kernel: Kernel, stack_inputs: StackInputs, host: H) -> Self

Creates a new process with provided inputs and debug options enabled.

pub fn execute( &mut self, program: &Program, ) -> Result<StackOutputs, ExecutionError>

Executes the provided Program in this process.

pub const fn kernel(&self) -> &Kernel

pub fn into_parts(self) -> (System, Decoder, Stack, RangeChecker, Chiplets, H)

Trait Implementations

impl<H: Host> ProcessState for Process<H>

fn clk(&self) -> RowIndex

Returns the current clock cycle of a process.

fn ctx(&self) -> ContextId

Returns the current execution context ID.

fn fmp(&self) -> u64

Returns the current value of the free memory pointer.

fn get_stack_item(&self, pos: usize) -> Felt

Returns the value located at the specified position on the stack at the current clock cycle.

fn get_stack_word(&self, word_idx: usize) -> Word

Returns a word located at the specified word index on the stack.

fn get_stack_state(&self) -> Vec<Felt>

Returns stack state at the current clock cycle. This includes the top 16 items of the stack + overflow entries.

fn get_mem_value(&self, ctx: ContextId, addr: u32) -> Option<Word>

Returns a word located at the specified context/address, or None if the address hasn’t been accessed previously.

fn get_mem_state(&self, ctx: ContextId) -> Vec<(u64, Word)>

Returns the entire memory state for the specified execution context at the current clock cycle.