miden-processor 0.23.0

Miden VM processor
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118

use alloc::vec::Vec;
use core::ops::ControlFlow;

use miden_core::{
    events::{EventId, SystemEvent},
    mast::{MastForest, MastNodeId},
};

use crate::{
    BaseHost, Host, SyncHost,
    advice::AdviceMutation,
    errors::{MapExecErrWithOpIdx, advice_error_with_context, event_error_with_context},
    event::EventError,
    fast::{BreakReason, FastProcessor},
};

mod sys_event_handlers;
pub use sys_event_handlers::SystemEventError;
use sys_event_handlers::handle_system_event;

impl FastProcessor {
    #[inline(always)]
    fn handle_system_event(
        &mut self,
        system_event: SystemEvent,
        current_forest: &MastForest,
        node_id: MastNodeId,
        host: &impl BaseHost,
        op_idx: usize,
    ) -> ControlFlow<BreakReason> {
        match handle_system_event(self, system_event).map_exec_err_with_op_idx(
            current_forest,
            node_id,
            host,
            op_idx,
        ) {
            Ok(()) => ControlFlow::Continue(()),
            Err(err) => ControlFlow::Break(BreakReason::Err(err)),
        }
    }

    #[inline(always)]
    fn apply_host_event_mutations(
        &mut self,
        current_forest: &MastForest,
        node_id: MastNodeId,
        host: &impl BaseHost,
        op_idx: usize,
        event_id: EventId,
        mutations: Result<Vec<AdviceMutation>, EventError>,
    ) -> ControlFlow<BreakReason> {
        let mutations = match mutations {
            Ok(mutations) => mutations,
            Err(err) => {
                let event_name = host.resolve_event(event_id).cloned();
                return ControlFlow::Break(BreakReason::Err(event_error_with_context(
                    err,
                    current_forest,
                    node_id,
                    host,
                    Some(op_idx),
                    event_id,
                    event_name,
                )));
            },
        };

        match self.advice.apply_mutations(mutations) {
            Ok(()) => ControlFlow::Continue(()),
            Err(err) => ControlFlow::Break(BreakReason::Err(advice_error_with_context(
                err,
                current_forest,
                node_id,
                host,
                Some(op_idx),
            ))),
        }
    }

    #[inline(always)]
    pub(super) fn op_emit_sync(
        &mut self,
        host: &mut impl SyncHost,
        current_forest: &MastForest,
        node_id: MastNodeId,
        op_idx: usize,
    ) -> ControlFlow<BreakReason> {
        let event_id = EventId::from_felt(self.stack_get(0));

        // If it's a system event, handle it directly. Otherwise, forward it to the host.
        if let Some(system_event) = SystemEvent::from_event_id(event_id) {
            return self.handle_system_event(system_event, current_forest, node_id, host, op_idx);
        }

        let processor_state = self.state();
        let mutations = host.on_event(&processor_state);
        self.apply_host_event_mutations(current_forest, node_id, host, op_idx, event_id, mutations)
    }

    #[inline(always)]
    pub(super) async fn op_emit(
        &mut self,
        host: &mut impl Host,
        current_forest: &MastForest,
        node_id: MastNodeId,
        op_idx: usize,
    ) -> ControlFlow<BreakReason> {
        let event_id = EventId::from_felt(self.stack_get(0));

        if let Some(system_event) = SystemEvent::from_event_id(event_id) {
            return self.handle_system_event(system_event, current_forest, node_id, host, op_idx);
        }

        let processor_state = self.state();
        let mutations = host.on_event(&processor_state).await;
        self.apply_host_event_mutations(current_forest, node_id, host, op_idx, event_id, mutations)
    }
}