stoffel-vm 0.1.0

Register-based virtual machine runtime and MPC execution engine for Stoffel programs
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
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158

use super::VMState;
use crate::error::{VmError, VmResult};
use crate::reveal_destination::RevealDestination;
use crate::runtime_instruction::RuntimeRegister;
use stoffel_vm_types::activations::ActivationRecord;
use stoffel_vm_types::core_types::Value;

#[derive(Debug, Clone)]
pub(super) struct ResolvedRegister {
    value: Value,
}

impl ResolvedRegister {
    fn new(value: Value) -> Self {
        Self { value }
    }

    pub(super) fn into_value(self) -> Value {
        self.value
    }
}

#[derive(Debug, Clone)]
pub(super) struct ResolvedRegisterPair {
    left: ResolvedRegister,
    right: ResolvedRegister,
}

impl ResolvedRegisterPair {
    fn new(left: ResolvedRegister, right: ResolvedRegister) -> Self {
        Self { left, right }
    }

    pub(super) fn into_values(self) -> (Value, Value) {
        (self.left.into_value(), self.right.into_value())
    }
}

impl VMState {
    #[inline]
    pub(super) fn current_register_value(
        &self,
        register: RuntimeRegister,
    ) -> VmResult<ResolvedRegister> {
        let record = self.current_frame()?;
        let value = Self::register_value_ref(record, register)?.clone();

        Ok(ResolvedRegister::new(value))
    }

    #[inline]
    pub(super) fn resolve_register(
        &mut self,
        register: RuntimeRegister,
    ) -> VmResult<ResolvedRegister> {
        self.ensure_registers_resolved(&[register])?;
        let record = self.current_frame()?;
        let value = Self::resolved_register_value_ref(record, register)?.clone();
        Ok(ResolvedRegister::new(value))
    }

    #[inline]
    pub(super) fn resolve_register_pair(
        &mut self,
        left_register: RuntimeRegister,
        right_register: RuntimeRegister,
    ) -> VmResult<ResolvedRegisterPair> {
        self.ensure_registers_resolved(&[left_register, right_register])?;
        let record = self.current_frame()?;
        Ok(ResolvedRegisterPair::new(
            ResolvedRegister::new(
                Self::resolved_register_value_ref(record, left_register)?.clone(),
            ),
            ResolvedRegister::new(
                Self::resolved_register_value_ref(record, right_register)?.clone(),
            ),
        ))
    }

    #[inline]
    pub(super) fn with_resolved_register<T>(
        &mut self,
        register: RuntimeRegister,
        f: impl FnOnce(&Value, &Self) -> VmResult<T>,
    ) -> VmResult<T> {
        self.ensure_registers_resolved(&[register])?;
        let record = self.current_frame()?;
        let value = Self::resolved_register_value_ref(record, register)?;
        f(value, self)
    }

    #[inline]
    pub(super) fn with_resolved_register_pair<T>(
        &mut self,
        left_register: RuntimeRegister,
        right_register: RuntimeRegister,
        f: impl FnOnce(&Value, &Value, &Self) -> VmResult<T>,
    ) -> VmResult<T> {
        self.ensure_registers_resolved(&[left_register, right_register])?;
        let record = self.current_frame()?;
        let left = Self::resolved_register_value_ref(record, left_register)?;
        let right = Self::resolved_register_value_ref(record, right_register)?;
        f(left, right, self)
    }

    fn ensure_registers_resolved(&mut self, regs: &[RuntimeRegister]) -> VmResult<()> {
        let record = self.current_frame()?;
        if !self.mpc_runtime.has_any_pending_reveals() {
            for &reg in regs {
                Self::ensure_frame_contains_register(record, reg)?;
            }
            return Ok(());
        }

        let frame_depth = self.current_frame_depth()?;

        let needs_flush = regs.iter().try_fold(false, |needs_flush, &reg| {
            Self::ensure_frame_contains_register(record, reg)?;
            Ok::<bool, VmError>(
                needs_flush
                    || self
                        .mpc_runtime
                        .has_pending_reveal_destination(RevealDestination::new(frame_depth, reg)),
            )
        })?;

        if needs_flush {
            self.flush_pending_reveals()?;
        }

        Ok(())
    }

    #[inline]
    fn register_value_ref(
        record: &ActivationRecord,
        register: RuntimeRegister,
    ) -> VmResult<&Value> {
        Self::ensure_frame_contains_register(record, register)?;
        record
            .register(register.register_index())
            .ok_or(VmError::PendingRevealWithoutQueuedBatch {
                register: register.index(),
            })
    }

    #[inline]
    fn resolved_register_value_ref(
        record: &ActivationRecord,
        register: RuntimeRegister,
    ) -> VmResult<&Value> {
        record
            .register(register.register_index())
            .ok_or(VmError::PendingRevealWithoutQueuedBatch {
                register: register.index(),
            })
    }
}