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

use super::mpc_operation::{
    CompletedMpcOperation, PendingMpcBuiltinOperation, PendingMpcOperation,
};
use crate::error::VmResult;
use crate::net::mpc_engine::AsyncMpcEngine;
use stoffel_vm_types::core_types::Value;
use stoffel_vm_types::instructions::Instruction;

#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub(crate) struct VmExecutionBudget {
    max_instructions: usize,
}

impl VmExecutionBudget {
    pub(crate) const fn max_instructions(max_instructions: usize) -> Self {
        Self { max_instructions }
    }

    pub(crate) const fn is_exhausted(self, executed_instructions: usize) -> bool {
        executed_instructions >= self.max_instructions
    }
}

#[derive(Debug)]
pub(crate) enum VmRunSlice {
    Complete(Value),
    Yield(VmEffect),
    BudgetExhausted,
}

#[derive(Debug)]
pub(crate) struct VmEffect {
    operation: PendingMpcOperation,
    after_instruction: Option<Instruction>,
    hooks_enabled: bool,
}

impl VmEffect {
    pub(super) fn new(
        operation: PendingMpcOperation,
        after_instruction: Option<Instruction>,
        hooks_enabled: bool,
    ) -> Self {
        debug_assert_eq!(after_instruction.is_some(), hooks_enabled);
        Self {
            operation,
            after_instruction,
            hooks_enabled,
        }
    }

    pub(crate) async fn execute<E: AsyncMpcEngine + ?Sized>(
        self,
        engine: &E,
    ) -> VmResult<CompletedVmEffect> {
        let completed = self.operation.execute_async(engine).await?;
        Ok(CompletedVmEffect {
            operation: completed,
            after_instruction: self.after_instruction,
            hooks_enabled: self.hooks_enabled,
        })
    }

    pub(crate) fn summary(&self) -> VmEffectSummary {
        VmEffectSummary::from_operation(&self.operation)
    }
}

#[derive(Debug)]
pub(crate) struct CompletedVmEffect {
    operation: CompletedMpcOperation,
    after_instruction: Option<Instruction>,
    hooks_enabled: bool,
}

impl CompletedVmEffect {
    pub(super) fn into_parts(self) -> (CompletedMpcOperation, Option<Instruction>, bool) {
        (self.operation, self.after_instruction, self.hooks_enabled)
    }
}

#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub(crate) enum VmEffectKind {
    Input,
    Multiply,
    BooleanBit,
    Open,
    BuiltinInput,
    BuiltinMul,
    BuiltinBatchMul,
    BuiltinOpen,
    BuiltinBatchOpen,
    BuiltinOther,
}

#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub(crate) struct VmEffectSummary {
    pub(crate) kind: VmEffectKind,
    pub(crate) items: usize,
}

impl VmEffectSummary {
    fn from_operation(operation: &PendingMpcOperation) -> Self {
        match operation {
            PendingMpcOperation::Input { .. } => Self::new(VmEffectKind::Input, 1),
            PendingMpcOperation::Multiply { .. } => Self::new(VmEffectKind::Multiply, 1),
            PendingMpcOperation::BooleanBit { .. } => Self::new(VmEffectKind::BooleanBit, 1),
            PendingMpcOperation::Open { .. } => Self::new(VmEffectKind::Open, 1),
            PendingMpcOperation::BuiltinCall(call) => match call.operation() {
                PendingMpcBuiltinOperation::InputShare { .. } => {
                    Self::new(VmEffectKind::BuiltinInput, 1)
                }
                PendingMpcBuiltinOperation::Mul { .. } => Self::new(VmEffectKind::BuiltinMul, 1),
                PendingMpcBuiltinOperation::BatchMul { left_data, .. }
                | PendingMpcBuiltinOperation::BatchMulMixed { left_data, .. } => {
                    Self::new(VmEffectKind::BuiltinBatchMul, left_data.len())
                }
                PendingMpcBuiltinOperation::Open { .. } => Self::new(VmEffectKind::BuiltinOpen, 1),
                PendingMpcBuiltinOperation::BatchOpen { share_data, .. } => {
                    Self::new(VmEffectKind::BuiltinBatchOpen, share_data.len())
                }
                _ => Self::new(VmEffectKind::BuiltinOther, 1),
            },
        }
    }

    const fn new(kind: VmEffectKind, items: usize) -> Self {
        Self { kind, items }
    }
}