Struct DebuggerHost 

pub struct DebuggerHost<S: SourceManager + ?Sized> { /* 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<S> DebuggerHost<S>

where S: SourceManager + ?Sized,

pub fn new(source_manager: Arc<S>) -> Self

Construct a new instance of DebuggerHost with the given source manager.

pub fn set_event_replay(&mut self, events: VecDeque<Vec<AdviceMutation>>)

Set the event replay queue.

When non-empty, on_event() will pop mutations from this queue instead of returning empty results. This is used for transaction debugging where events were recorded during a prior execution.

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 handle_assert_failed( &mut self, clk: RowIndex, err_code: Option<NonZeroU32>, )

Invoke the assert-failed handler, if registered.

This is called externally when step() returns an assertion error, since on_assert_failed no longer exists on the Host trait in 0.21.

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

Load forest into the MAST store for this host

pub fn register_event_handler( &mut self, event: EventName, handler: Arc<dyn EventHandler>, ) -> Result<(), ExecutionError>

Registers an event handler for use during program execution.

Trait Implementations

impl<S> Host for DebuggerHost<S>

where S: SourceManager + ?Sized,

fn get_label_and_source_file( &self, location: &Location, ) -> (SourceSpan, Option<Arc<SourceFile>>)

Returns the SourceSpan and optional SourceFile for the provided location.

fn get_mast_forest( &self, node_digest: &Word, ) -> impl FutureMaybeSend<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_event( &mut self, process: &ProcessorState<'_>, ) -> impl FutureMaybeSend<Result<Vec<AdviceMutation>, EventError>>

Handles the event emitted from the VM and provides advice mutations to be applied to the advice provider.

fn on_trace( &mut self, process: &ProcessorState<'_>, trace_id: u32, ) -> Result<(), TraceError>

Handles the trace emitted from the VM.

fn resolve_event(&self, event_id: EventId) -> Option<&EventName>

Returns the EventName registered for the provided EventId, if any.

fn on_debug( &mut self, process: &ProcessorState<'_>, options: &DebugOptions, ) -> Result<(), Box<dyn Error + Send + Sync>>

Handles the debug request from the VM.