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
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
#![allow(clippy::unusual_byte_groupings)]

use crate::{BaseElement, FieldElement};
use core::fmt;

// FLOW CONTROL OPERATIONS
// ================================================================================================
#[repr(u8)]
#[derive(Copy, Clone, Debug, PartialEq)]
pub enum FlowOps {
    Hacc = 0b000,
    Begin = 0b001,
    Tend = 0b010,
    Fend = 0b011,
    Loop = 0b100,
    Wrap = 0b101,
    Break = 0b110,
    Void = 0b111,
}

impl FlowOps {
    pub fn op_index(&self) -> usize {
        (*self as usize) & 0b111
    }
}

impl fmt::Display for FlowOps {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        match self {
            FlowOps::Hacc => write!(f, "hacc"),

            FlowOps::Begin => write!(f, "begin"),
            FlowOps::Tend => write!(f, "tend"),
            FlowOps::Fend => write!(f, "fend"),

            FlowOps::Loop => write!(f, "loop"),
            FlowOps::Wrap => write!(f, "wrap"),
            FlowOps::Break => write!(f, "break"),

            FlowOps::Void => write!(f, "void"),
        }
    }
}

// USER OPERATIONS
// ================================================================================================
#[repr(u8)]
#[derive(Copy, Clone, Debug, PartialEq)]
pub enum UserOps {
    // low-degree operations
    Assert = 0b0_11_00000,   // left shift: 1
    AssertEq = 0b0_11_00001, // left shift: 2
    Eq = 0b0_11_00010,       // left shift: 2
    Drop = 0b0_11_00011,     // left shift: 1
    Drop4 = 0b0_11_00100,    // left shift: 4
    Choose = 0b0_11_00101,   // left shift: 2
    Choose2 = 0b0_11_00110,  // left shift: 4
    CSwap2 = 0b0_11_00111,   // left shift: 2

    Add = 0b0_11_01000, // left shift: 1
    Mul = 0b0_11_01001, // left shift: 1
    And = 0b0_11_01010, // left shift: 1
    Or = 0b0_11_01011,  // left shift: 1
    Inv = 0b0_11_01100, // no shift
    Neg = 0b0_11_01101, // no shift
    Not = 0b0_11_01110, // no shift
    //??? = 0b0_11_01111,
    Read = 0b0_11_10000,  // right shift: 1
    Read2 = 0b0_11_10001, // right shift: 2
    Dup = 0b0_11_10010,   // right shift: 1
    Dup2 = 0b0_11_10011,  // right shift: 2
    Dup4 = 0b0_11_10100,  // right shift: 4
    Pad2 = 0b0_11_10101,  // right shift: 2
    //??? = 0b0_11_10110,
    //??? = 0b0_11_10111,
    Swap = 0b0_11_11000,   // no shift
    Swap2 = 0b0_11_11001,  // no shift
    Swap4 = 0b0_11_11010,  // no shift
    Roll4 = 0b0_11_11011,  // no shift
    Roll8 = 0b0_11_11100,  // no shift
    BinAcc = 0b0_11_11101, // no shift
    //??? = 0b0_11_11110,

    // high-degree operations
    Push = 0b0_00_11111,  // right shift: 1
    Cmp = 0b0_01_11111,   // no shift
    RescR = 0b0_10_11111, // no shift

    // composite operations
    Begin = 0b0_00_00000, // no shift
    Noop = 0b0_11_11111,  // no shift
}

impl UserOps {
    pub fn ld_index(&self) -> usize {
        match self {
            UserOps::Push | UserOps::Cmp | UserOps::RescR => {
                panic!("{} is not a low-degree operation", self);
            }
            _ => (*self as usize) & 0b11111,
        }
    }

    pub fn hd_index(&self) -> usize {
        match self {
            UserOps::Push | UserOps::Cmp | UserOps::RescR | UserOps::Noop | UserOps::Begin => {
                ((*self as usize) >> 5) & 0b11
            }
            _ => {
                panic!("{} is not a high-degree operation", self);
            }
        }
    }
}

impl fmt::Display for UserOps {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        match self {
            UserOps::Begin => write!(f, "begin"),
            UserOps::Noop => write!(f, "noop"),

            UserOps::Assert => write!(f, "assert"),
            UserOps::AssertEq => write!(f, "asserteq"),

            UserOps::Push => write!(f, "push"),
            UserOps::Read => write!(f, "read"),
            UserOps::Read2 => write!(f, "read2"),

            UserOps::Dup => write!(f, "dup"),
            UserOps::Dup2 => write!(f, "dup2"),
            UserOps::Dup4 => write!(f, "dup4"),
            UserOps::Pad2 => write!(f, "pad2"),

            UserOps::Drop => write!(f, "drop"),
            UserOps::Drop4 => write!(f, "drop4"),

            UserOps::Swap => write!(f, "swap"),
            UserOps::Swap2 => write!(f, "swap2"),
            UserOps::Swap4 => write!(f, "swap4"),

            UserOps::Roll4 => write!(f, "roll4"),
            UserOps::Roll8 => write!(f, "roll8"),

            UserOps::Choose => write!(f, "choose"),
            UserOps::Choose2 => write!(f, "choose2"),
            UserOps::CSwap2 => write!(f, "cswap2"),

            UserOps::Add => write!(f, "add"),
            UserOps::Mul => write!(f, "mul"),
            UserOps::Inv => write!(f, "inv"),
            UserOps::Neg => write!(f, "neg"),
            UserOps::Not => write!(f, "not"),
            UserOps::And => write!(f, "and"),
            UserOps::Or => write!(f, "or"),

            UserOps::Eq => write!(f, "eq"),
            UserOps::Cmp => write!(f, "cmp"),
            UserOps::BinAcc => write!(f, "binacc"),

            UserOps::RescR => write!(f, "rescr"),
        }
    }
}

// OPERATION HINTS
// ================================================================================================
#[derive(Copy, Clone, Debug)]
pub enum OpHint {
    EqStart,
    RcStart(u32),
    CmpStart(u32),
    PmpathStart(u32),
    PushValue(BaseElement),
    None,
}

impl OpHint {
    pub fn value(&self) -> BaseElement {
        match self {
            OpHint::PushValue(value) => *value,
            _ => BaseElement::ZERO,
        }
    }
}

impl fmt::Display for OpHint {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        match self {
            OpHint::EqStart => write!(f, "::eq"),
            OpHint::RcStart(value) => write!(f, ".{}", value),
            OpHint::CmpStart(value) => write!(f, ".{}", value),
            OpHint::PmpathStart(value) => write!(f, ".{}", value),
            OpHint::PushValue(value) => write!(f, "({})", value),
            OpHint::None => Ok(()),
        }
    }
}