sp1_core_executor/
register.rs

1//! Registers for the SP1 zkVM.
2
3/// A register stores a 32-bit value used by operations.
4#[derive(Debug, Clone, Copy, PartialEq)]
5pub enum Register {
6    /// %x0
7    X0 = 0,
8    /// %x1
9    X1 = 1,
10    /// %x2
11    X2 = 2,
12    /// %x3
13    X3 = 3,
14    /// %x4
15    X4 = 4,
16    /// %x5
17    X5 = 5,
18    /// %x6
19    X6 = 6,
20    /// %x7
21    X7 = 7,
22    /// %x8
23    X8 = 8,
24    /// %x9
25    X9 = 9,
26    /// %x10
27    X10 = 10,
28    /// %x11
29    X11 = 11,
30    /// %x12
31    X12 = 12,
32    /// %x13
33    X13 = 13,
34    /// %x14
35    X14 = 14,
36    /// %x15
37    X15 = 15,
38    /// %x16
39    X16 = 16,
40    /// %x17
41    X17 = 17,
42    /// %x18
43    X18 = 18,
44    /// %x19
45    X19 = 19,
46    /// %x20
47    X20 = 20,
48    /// %x21
49    X21 = 21,
50    /// %x22
51    X22 = 22,
52    /// %x23
53    X23 = 23,
54    /// %x24
55    X24 = 24,
56    /// %x25
57    X25 = 25,
58    /// %x26
59    X26 = 26,
60    /// %x27
61    X27 = 27,
62    /// %x28
63    X28 = 28,
64    /// %x29
65    X29 = 29,
66    /// %x30
67    X30 = 30,
68    /// %x31
69    X31 = 31,
70}
71
72impl Register {
73    /// Create a new register from a u8.
74    ///
75    /// # Panics
76    ///
77    /// This function will panic if the register is invalid.
78    #[inline]
79    #[must_use]
80    pub fn from_u8(value: u8) -> Self {
81        match value {
82            0 => Register::X0,
83            1 => Register::X1,
84            2 => Register::X2,
85            3 => Register::X3,
86            4 => Register::X4,
87            5 => Register::X5,
88            6 => Register::X6,
89            7 => Register::X7,
90            8 => Register::X8,
91            9 => Register::X9,
92            10 => Register::X10,
93            11 => Register::X11,
94            12 => Register::X12,
95            13 => Register::X13,
96            14 => Register::X14,
97            15 => Register::X15,
98            16 => Register::X16,
99            17 => Register::X17,
100            18 => Register::X18,
101            19 => Register::X19,
102            20 => Register::X20,
103            21 => Register::X21,
104            22 => Register::X22,
105            23 => Register::X23,
106            24 => Register::X24,
107            25 => Register::X25,
108            26 => Register::X26,
109            27 => Register::X27,
110            28 => Register::X28,
111            29 => Register::X29,
112            30 => Register::X30,
113            31 => Register::X31,
114            _ => panic!("invalid register {value}"),
115        }
116    }
117}