Struct midenc_debug::DebuggerHost

pub struct DebuggerHost { /* private fields */ }

This is an implementation of Host which is essentially miden_processor::DefaultHost, but extended with additional functionality for debugging, in particular it manages trace events that record the entry or exit of a procedure call frame.

Implementations

impl DebuggerHost

pub fn new(adv_provider: MemAdviceProvider) -> Self

Construct a new instance of DebuggerHost with the given advice provider.

pub fn register_trace_handler<F>(&mut self, event: TraceEvent, callback: F)

where F: FnMut(RowIndex, TraceEvent) + 'static,

Register a trace handler for event

pub fn register_assert_failed_tracer<F>(&mut self, callback: F)

where F: FnMut(RowIndex, TraceEvent) + 'static,

Register a handler to be called when an assertion in the VM fails

pub fn load_mast_forest(&mut self, forest: MastForest)

Load forest into the MAST store for this host

Trait Implementations

impl Default for DebuggerHost

fn default() -> DebuggerHost

Returns the “default value” for a type.

impl Host for DebuggerHost

fn get_advice<P: ProcessState>( &mut self, process: &P, extractor: AdviceExtractor, ) -> Result<HostResponse, ExecutionError>

Returns the requested advice, specified by AdviceExtractor, from the host to the VM.

fn set_advice<P: ProcessState>( &mut self, process: &P, injector: AdviceInjector, ) -> Result<HostResponse, ExecutionError>

Sets the requested advice, specified by AdviceInjector, on the host.

fn get_mast_forest(&self, node_digest: &RpoDigest) -> Option<Arc<MastForest>>

Returns MAST forest corresponding to the specified digest, or None if the MAST forest for this digest could not be found in this Host.

fn on_trace<S: ProcessState>( &mut self, process: &S, trace_id: u32, ) -> Result<HostResponse, ExecutionError>

Handles the trace emitted from the VM.

fn on_assert_failed<S: ProcessState>( &mut self, process: &S, err_code: u32, ) -> ExecutionError

Handles the failure of the assertion instruction.

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

Creates a “by reference” host for this instance.

fn on_event<S>( &mut self, _process: &S, _event_id: u32, ) -> Result<HostResponse, ExecutionError>

where S: ProcessState,

Handles the event emitted from the VM.

fn on_debug<S>( &mut self, _process: &S, _options: &DebugOptions, ) -> Result<HostResponse, ExecutionError>

where S: ProcessState,

Handles the debug request from the VM.

fn pop_adv_stack<S>( &mut self, process: &S, ) -> Result<BaseElement, ExecutionError>

where S: ProcessState,

Pops an element from the advice stack and returns it.

fn pop_adv_stack_word<S>( &mut self, process: &S, ) -> Result<[BaseElement; 4], ExecutionError>

where S: ProcessState,

Pops a word (4 elements) from the advice stack and returns it.

fn pop_adv_stack_dword<S>( &mut self, process: &S, ) -> Result<[[BaseElement; 4]; 2], ExecutionError>

where S: ProcessState,

Pops a double word (8 elements) from the advice stack and returns them.

fn get_adv_merkle_path<S>( &mut self, process: &S, ) -> Result<MerklePath, ExecutionError>

where S: ProcessState,

Returns a path to a node at the specified depth and index in a Merkle tree with the specified root.