tycho-vm 0.3.6

TON-compatible VM for the Tycho node.
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

use tycho_types::error::Error;

use crate::stack::StackValueType;

/// Result of VM-related stuff.
pub type VmResult<T> = Result<T, Box<VmError>>;

/// VM execution error.
#[derive(Debug, thiserror::Error)]
pub enum VmError {
    #[error("stack underflow at depth {0}")]
    StackUnderflow(usize),
    #[error("too many arguments copied into a closure continuation: {0}")]
    TooManyArguments(usize),
    #[error("expected integer in range {min}..={max}, found {actual}")]
    IntegerOutOfRange {
        min: isize,
        max: isize,
        actual: String,
    },
    #[error("control register index out of range: {0}")]
    ControlRegisterOutOfRange(usize),
    #[error("control register redefined")]
    ControlRegisterRedefined,
    #[error("integer overflow")]
    IntegerOverflow,
    #[error("invalid opcode")]
    InvalidOpcode,
    #[error(
        "expected type {}, found {}",
        StackValueType::display_raw(*expected),
        StackValueType::display_raw(*actual),
    )]
    InvalidType { expected: u8, actual: u8 },
    #[error("out of gas")]
    OutOfGas,
    #[error(transparent)]
    CellError(#[from] Error),
    #[error("dict error")]
    DictError,
    #[error("unknown error. {0}")]
    Unknown(String),
}

impl VmError {
    pub fn is_out_of_gas(&self) -> bool {
        matches!(self, Self::OutOfGas | Self::CellError(Error::Cancelled))
    }

    pub fn as_exception(&self) -> VmException {
        match self {
            Self::StackUnderflow(_) => VmException::StackUnderflow,
            Self::TooManyArguments(_) => VmException::StackOverflow,
            Self::IntegerOutOfRange { .. } => VmException::RangeCheck,
            Self::ControlRegisterOutOfRange(_) => VmException::RangeCheck,
            Self::ControlRegisterRedefined => VmException::TypeCheck,
            Self::IntegerOverflow => VmException::IntOverflow,
            Self::InvalidOpcode => VmException::InvalidOpcode,
            Self::InvalidType { .. } => VmException::TypeCheck,
            Self::OutOfGas => VmException::OutOfGas,
            Self::Unknown(_) => VmException::Unknown,
            Self::CellError(e) => match e {
                Error::CellUnderflow => VmException::CellUnderflow,
                Error::CellOverflow => VmException::CellOverflow,
                Error::UnexpectedExoticCell | Error::UnexpectedOrdinaryCell => {
                    VmException::VirtError
                }
                Error::Cancelled => VmException::OutOfGas, // ?
                Error::IntOverflow => VmException::IntOverflow,
                Error::InvalidCell => VmException::CellOverflow,
                _ => VmException::Fatal, // ?
            },
            Self::DictError => VmException::DictError,
        }
    }
}

impl From<Error> for Box<VmError> {
    #[inline]
    fn from(e: Error) -> Self {
        Box::new(VmError::CellError(e))
    }
}

/// Opcode dump result.
#[cfg(feature = "dump")]
pub type DumpResult = Result<(), DumpError>;

/// Opcode dump error.
#[cfg(feature = "dump")]
#[derive(thiserror::Error, Debug)]
pub enum DumpError {
    #[error(transparent)]
    InvalidCode(#[from] tycho_types::error::Error),
    #[error("invalid opcode")]
    InvalidOpcode,
    #[error("unexpected cell")]
    CellMismatch,
    #[error(transparent)]
    WriterError(#[from] std::fmt::Error),
}

/// A code for an execution error.
#[derive(Debug, Clone, Copy, Eq, PartialEq, Ord, PartialOrd)]
#[repr(u8)]
pub enum VmException {
    Ok = 0,
    Alternative = 1,
    StackUnderflow = 2,
    StackOverflow = 3,
    IntOverflow = 4,
    RangeCheck = 5,
    InvalidOpcode = 6,
    TypeCheck = 7,
    CellOverflow = 8,
    CellUnderflow = 9,
    DictError = 10,
    Unknown = 11,
    Fatal = 12,
    OutOfGas = 13,
    VirtError = 14,
}

impl VmException {
    pub const fn as_exit_code(&self) -> i32 {
        !(*self as i32)
    }
}

impl std::fmt::Display for VmException {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        f.write_str(match self {
            Self::Ok => "normal termination",
            Self::Alternative => "alternative termination",
            Self::StackUnderflow => "stack underflow",
            Self::StackOverflow => "stack overflow",
            Self::IntOverflow => "integer overflow",
            Self::RangeCheck => "integer out of range",
            Self::InvalidOpcode => "invalid opcode",
            Self::TypeCheck => "type check error",
            Self::CellOverflow => "cell overflow",
            Self::CellUnderflow => "cell underflow",
            Self::DictError => "dictionary error",
            Self::Unknown => "unknown error",
            Self::Fatal => "fatal error",
            Self::OutOfGas => "out of gas",
            Self::VirtError => "virtualization error",
        })
    }
}