revm_bytecode/
opcode.rs

1//! EVM opcode definitions and utilities. It contains opcode information and utilities to work with opcodes.
2
3#[cfg(feature = "parse")]
4pub mod parse;
5
6use core::{fmt, ptr::NonNull};
7
8/// An EVM opcode
9///
10/// This is always a valid opcode, as declared in the [`opcode`][self] module or the
11/// [`OPCODE_INFO`] constant.
12#[derive(Clone, Copy, Debug, Default, PartialEq, Eq, PartialOrd, Ord, Hash)]
13#[repr(transparent)]
14pub struct OpCode(u8);
15
16impl fmt::Display for OpCode {
17    /// Formats the opcode as a string
18    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
19        let n = self.get();
20        if let Some(val) = OPCODE_INFO[n as usize] {
21            f.write_str(val.name())
22        } else {
23            write!(f, "UNKNOWN(0x{n:02X})")
24        }
25    }
26}
27
28impl OpCode {
29    /// Instantiates a new opcode from a u8.
30    ///
31    /// Returns None if the opcode is not valid.
32    #[inline]
33    pub const fn new(opcode: u8) -> Option<Self> {
34        match OPCODE_INFO[opcode as usize] {
35            Some(_) => Some(Self(opcode)),
36            None => None,
37        }
38    }
39
40    /// Returns true if the opcode is a jump destination.
41    #[inline]
42    pub const fn is_jumpdest(&self) -> bool {
43        self.0 == JUMPDEST
44    }
45
46    /// Takes a u8 and returns true if it is a jump destination.
47    #[inline]
48    pub const fn is_jumpdest_by_op(opcode: u8) -> bool {
49        if let Some(opcode) = Self::new(opcode) {
50            opcode.is_jumpdest()
51        } else {
52            false
53        }
54    }
55
56    /// Returns true if the opcode is a legacy jump instruction.
57    #[inline]
58    pub const fn is_jump(self) -> bool {
59        self.0 == JUMP
60    }
61
62    /// Takes a u8 and returns true if it is a jump instruction.
63    #[inline]
64    pub const fn is_jump_by_op(opcode: u8) -> bool {
65        if let Some(opcode) = Self::new(opcode) {
66            opcode.is_jump()
67        } else {
68            false
69        }
70    }
71
72    /// Returns true if the opcode is a `PUSH` instruction.
73    #[inline]
74    pub const fn is_push(self) -> bool {
75        self.0 >= PUSH1 && self.0 <= PUSH32
76    }
77
78    /// Takes a u8 and returns true if it is a push instruction.
79    #[inline]
80    pub fn is_push_by_op(opcode: u8) -> bool {
81        if let Some(opcode) = Self::new(opcode) {
82            opcode.is_push()
83        } else {
84            false
85        }
86    }
87
88    /// Instantiates a new opcode from a u8 without checking if it is valid.
89    ///
90    /// # Safety
91    ///
92    /// All code using `Opcode` values assume that they are valid opcodes, so providing an invalid
93    /// opcode may cause undefined behavior.
94    #[inline]
95    pub unsafe fn new_unchecked(opcode: u8) -> Self {
96        Self(opcode)
97    }
98
99    /// Returns the opcode as a string. This is the inverse of [`parse`](Self::parse).
100    #[doc(alias = "name")]
101    #[inline]
102    pub const fn as_str(self) -> &'static str {
103        self.info().name()
104    }
105
106    /// Returns the opcode name.
107    #[inline]
108    pub const fn name_by_op(opcode: u8) -> &'static str {
109        if let Some(opcode) = Self::new(opcode) {
110            opcode.as_str()
111        } else {
112            "Unknown"
113        }
114    }
115
116    /// Returns the number of input stack elements.
117    #[inline]
118    pub const fn inputs(&self) -> u8 {
119        self.info().inputs()
120    }
121
122    /// Returns the number of output stack elements.
123    #[inline]
124    pub const fn outputs(&self) -> u8 {
125        self.info().outputs()
126    }
127
128    /// Calculates the difference between the number of input and output stack elements.
129    #[inline]
130    pub const fn io_diff(&self) -> i16 {
131        self.info().io_diff()
132    }
133
134    /// Returns the opcode information for the given opcode.
135    /// Check [OpCodeInfo] for more information.
136    #[inline]
137    pub const fn info_by_op(opcode: u8) -> Option<OpCodeInfo> {
138        if let Some(opcode) = Self::new(opcode) {
139            Some(opcode.info())
140        } else {
141            None
142        }
143    }
144
145    /// Returns the opcode as a usize.
146    #[inline]
147    pub const fn as_usize(&self) -> usize {
148        self.0 as usize
149    }
150
151    /// Returns the opcode information.
152    #[inline]
153    pub const fn info(&self) -> OpCodeInfo {
154        if let Some(t) = OPCODE_INFO[self.0 as usize] {
155            t
156        } else {
157            panic!("opcode not found")
158        }
159    }
160
161    /// Returns the number of both input and output stack elements.
162    ///
163    /// Can be slightly faster than calling `inputs` and `outputs` separately.
164    pub const fn input_output(&self) -> (u8, u8) {
165        let info = self.info();
166        (info.inputs, info.outputs)
167    }
168
169    /// Returns the opcode as a u8.
170    #[inline]
171    pub const fn get(self) -> u8 {
172        self.0
173    }
174
175    /// Returns true if the opcode modifies memory.
176    ///
177    /// <https://docs.rs/revm-interpreter/latest/revm_interpreter/instructions/index.html>
178    ///
179    /// <https://github.com/crytic/evm-opcodes>
180    #[inline]
181    pub const fn modifies_memory(&self) -> bool {
182        matches!(
183            *self,
184            OpCode::EXTCODECOPY
185                | OpCode::MLOAD
186                | OpCode::MSTORE
187                | OpCode::MSTORE8
188                | OpCode::MCOPY
189                | OpCode::KECCAK256
190                | OpCode::CODECOPY
191                | OpCode::CALLDATACOPY
192                | OpCode::RETURNDATACOPY
193                | OpCode::CALL
194                | OpCode::CALLCODE
195                | OpCode::DELEGATECALL
196                | OpCode::STATICCALL
197        )
198    }
199
200    /// Returns true if the opcode is valid
201    #[inline]
202    pub const fn is_valid(&self) -> bool {
203        OPCODE_INFO[self.0 as usize].is_some()
204    }
205}
206
207impl PartialEq<u8> for OpCode {
208    fn eq(&self, other: &u8) -> bool {
209        self.get().eq(other)
210    }
211}
212
213/// Information about opcode, such as name, and stack inputs and outputs
214#[derive(Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash)]
215pub struct OpCodeInfo {
216    /// Invariant: `(name_ptr, name_len)` is a [`&'static str`][str].
217    ///
218    /// It is a shorted variant of [`str`] as
219    /// the name length is always less than 256 characters.
220    name_ptr: NonNull<u8>,
221    name_len: u8,
222    /// Stack inputs
223    inputs: u8,
224    /// Stack outputs
225    outputs: u8,
226    /// Number of intermediate bytes
227    immediate_size: u8,
228    /// If the opcode stops execution. aka STOP, RETURN, ..
229    terminating: bool,
230}
231
232// SAFETY: The `NonNull` is just a `&'static str`.
233unsafe impl Send for OpCodeInfo {}
234unsafe impl Sync for OpCodeInfo {}
235
236impl fmt::Debug for OpCodeInfo {
237    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
238        f.debug_struct("OpCodeInfo")
239            .field("name", &self.name())
240            .field("inputs", &self.inputs())
241            .field("outputs", &self.outputs())
242            .field("terminating", &self.is_terminating())
243            .field("immediate_size", &self.immediate_size())
244            .finish()
245    }
246}
247
248impl OpCodeInfo {
249    /// Creates a new opcode info with the given name and default values.
250    pub const fn new(name: &'static str) -> Self {
251        assert!(name.len() < 256, "opcode name is too long");
252        Self {
253            name_ptr: unsafe { NonNull::new_unchecked(name.as_ptr().cast_mut()) },
254            name_len: name.len() as u8,
255            inputs: 0,
256            outputs: 0,
257            terminating: false,
258            immediate_size: 0,
259        }
260    }
261
262    /// Returns the opcode name.
263    #[inline]
264    pub const fn name(&self) -> &'static str {
265        // SAFETY: `self.name_*` can only be initialized with a valid `&'static str`.
266        unsafe {
267            let slice = std::slice::from_raw_parts(self.name_ptr.as_ptr(), self.name_len as usize);
268            core::str::from_utf8_unchecked(slice)
269        }
270    }
271
272    /// Calculates the difference between the number of input and output stack elements.
273    #[inline]
274    pub const fn io_diff(&self) -> i16 {
275        self.outputs as i16 - self.inputs as i16
276    }
277
278    /// Returns the number of input stack elements.
279    #[inline]
280    pub const fn inputs(&self) -> u8 {
281        self.inputs
282    }
283
284    /// Returns the number of output stack elements.
285    #[inline]
286    pub const fn outputs(&self) -> u8 {
287        self.outputs
288    }
289
290    /// Returns whether this opcode terminates execution, e.g. `STOP`, `RETURN`, etc.
291    #[inline]
292    pub const fn is_terminating(&self) -> bool {
293        self.terminating
294    }
295
296    /// Returns the size of the immediate value in bytes.
297    #[inline]
298    pub const fn immediate_size(&self) -> u8 {
299        self.immediate_size
300    }
301}
302
303/// Used for [`OPCODE_INFO`] to set the immediate bytes number in the [`OpCodeInfo`].
304#[inline]
305pub const fn immediate_size(mut op: OpCodeInfo, n: u8) -> OpCodeInfo {
306    op.immediate_size = n;
307    op
308}
309
310/// Used for [`OPCODE_INFO`] to set the terminating flag to true in the [`OpCodeInfo`].
311#[inline]
312pub const fn terminating(mut op: OpCodeInfo) -> OpCodeInfo {
313    op.terminating = true;
314    op
315}
316
317/// Use for [`OPCODE_INFO`] to sets the number of stack inputs and outputs in the [`OpCodeInfo`].
318#[inline]
319pub const fn stack_io(mut op: OpCodeInfo, inputs: u8, outputs: u8) -> OpCodeInfo {
320    op.inputs = inputs;
321    op.outputs = outputs;
322    op
323}
324
325/// Alias for the [`JUMPDEST`] opcode
326pub const NOP: u8 = JUMPDEST;
327
328/// Created all opcodes constants and two maps:
329///  * `OPCODE_INFO` maps opcode number to the opcode info
330///  * `NAME_TO_OPCODE` that maps opcode name to the opcode number.
331macro_rules! opcodes {
332    ($($val:literal => $name:ident => $($modifier:ident $(( $($modifier_arg:expr),* ))?),*);* $(;)?) => {
333        // Constants for each opcode. This also takes care of duplicate names.
334        $(
335            #[doc = concat!("The `", stringify!($val), "` (\"", stringify!($name),"\") opcode.")]
336            pub const $name: u8 = $val;
337        )*
338        impl OpCode {$(
339            #[doc = concat!("The `", stringify!($val), "` (\"", stringify!($name),"\") opcode.")]
340            pub const $name: Self = Self($val);
341        )*}
342
343        /// Maps each opcode to its info.
344        pub static OPCODE_INFO: [Option<OpCodeInfo>; 256] = {
345            let mut map = [None; 256];
346            let mut prev: u8 = 0;
347            $(
348                let val: u8 = $val;
349                assert!(val == 0 || val > prev, "opcodes must be sorted in ascending order");
350                prev = val;
351                let info = OpCodeInfo::new(stringify!($name));
352                $(
353                let info = $modifier(info, $($($modifier_arg),*)?);
354                )*
355                map[$val] = Some(info);
356            )*
357            let _ = prev;
358            map
359        };
360
361
362        /// Maps each name to its opcode.
363        #[cfg(feature = "parse")]
364        pub(crate) static NAME_TO_OPCODE: phf::Map<&'static str, OpCode> = stringify_with_cb! { phf_map_cb; $($name)* };
365    };
366}
367
368/// Callback for creating a [`phf`] map with `stringify_with_cb`.
369#[cfg(feature = "parse")]
370macro_rules! phf_map_cb {
371    ($(#[doc = $s:literal] $id:ident)*) => {
372        phf::phf_map! {
373            $($s => OpCode::$id),*
374        }
375    };
376}
377
378/// Stringifies identifiers with `paste` so that they are available as literals.
379///
380/// This doesn't work with [`stringify!`] because it cannot be expanded inside of another macro.
381#[cfg(feature = "parse")]
382macro_rules! stringify_with_cb {
383    ($callback:ident; $($id:ident)*) => { paste::paste! {
384        $callback! { $(#[doc = "" $id ""] $id)* }
385    }};
386}
387
388// When adding new opcodes:
389// 1. add the opcode to the list below; make sure it's sorted by opcode value
390// 2. implement the opcode in the corresponding module;
391//    the function signature must be the exact same as the others
392opcodes! {
393    0x00 => STOP     => stack_io(0, 0), terminating;
394    0x01 => ADD      => stack_io(2, 1);
395    0x02 => MUL      => stack_io(2, 1);
396    0x03 => SUB      => stack_io(2, 1);
397    0x04 => DIV      => stack_io(2, 1);
398    0x05 => SDIV     => stack_io(2, 1);
399    0x06 => MOD      => stack_io(2, 1);
400    0x07 => SMOD     => stack_io(2, 1);
401    0x08 => ADDMOD   => stack_io(3, 1);
402    0x09 => MULMOD   => stack_io(3, 1);
403    0x0A => EXP      => stack_io(2, 1);
404    0x0B => SIGNEXTEND => stack_io(2, 1);
405    // 0x0C
406    // 0x0D
407    // 0x0E
408    // 0x0F
409    0x10 => LT   => stack_io(2, 1);
410    0x11 => GT   => stack_io(2, 1);
411    0x12 => SLT  => stack_io(2, 1);
412    0x13 => SGT  => stack_io(2, 1);
413    0x14 => EQ   => stack_io(2, 1);
414    0x15 => ISZERO => stack_io(1, 1);
415    0x16 => AND  => stack_io(2, 1);
416    0x17 => OR   => stack_io(2, 1);
417    0x18 => XOR  => stack_io(2, 1);
418    0x19 => NOT  => stack_io(1, 1);
419    0x1A => BYTE => stack_io(2, 1);
420    0x1B => SHL  => stack_io(2, 1);
421    0x1C => SHR  => stack_io(2, 1);
422    0x1D => SAR  => stack_io(2, 1);
423    0x1E => CLZ => stack_io(1, 1);
424    // 0x1F
425    0x20 => KECCAK256 => stack_io(2, 1);
426    // 0x21
427    // 0x22
428    // 0x23
429    // 0x24
430    // 0x25
431    // 0x26
432    // 0x27
433    // 0x28
434    // 0x29
435    // 0x2A
436    // 0x2B
437    // 0x2C
438    // 0x2D
439    // 0x2E
440    // 0x2F
441    0x30 => ADDRESS    => stack_io(0, 1);
442    0x31 => BALANCE    => stack_io(1, 1);
443    0x32 => ORIGIN     => stack_io(0, 1);
444    0x33 => CALLER     => stack_io(0, 1);
445    0x34 => CALLVALUE  => stack_io(0, 1);
446    0x35 => CALLDATALOAD => stack_io(1, 1);
447    0x36 => CALLDATASIZE => stack_io(0, 1);
448    0x37 => CALLDATACOPY => stack_io(3, 0);
449    0x38 => CODESIZE   => stack_io(0, 1);
450    0x39 => CODECOPY   => stack_io(3, 0);
451
452    0x3A => GASPRICE     => stack_io(0, 1);
453    0x3B => EXTCODESIZE  => stack_io(1, 1);
454    0x3C => EXTCODECOPY  => stack_io(4, 0);
455    0x3D => RETURNDATASIZE => stack_io(0, 1);
456    0x3E => RETURNDATACOPY => stack_io(3, 0);
457    0x3F => EXTCODEHASH  => stack_io(1, 1);
458    0x40 => BLOCKHASH    => stack_io(1, 1);
459    0x41 => COINBASE     => stack_io(0, 1);
460    0x42 => TIMESTAMP    => stack_io(0, 1);
461    0x43 => NUMBER       => stack_io(0, 1);
462    0x44 => DIFFICULTY   => stack_io(0, 1);
463    0x45 => GASLIMIT     => stack_io(0, 1);
464    0x46 => CHAINID      => stack_io(0, 1);
465    0x47 => SELFBALANCE  => stack_io(0, 1);
466    0x48 => BASEFEE      => stack_io(0, 1);
467    0x49 => BLOBHASH     => stack_io(1, 1);
468    0x4A => BLOBBASEFEE  => stack_io(0, 1);
469    // 0x4B
470    // 0x4C
471    // 0x4D
472    // 0x4E
473    // 0x4F
474    0x50 => POP      => stack_io(1, 0);
475    0x51 => MLOAD    => stack_io(1, 1);
476    0x52 => MSTORE   => stack_io(2, 0);
477    0x53 => MSTORE8  => stack_io(2, 0);
478    0x54 => SLOAD    => stack_io(1, 1);
479    0x55 => SSTORE   => stack_io(2, 0);
480    0x56 => JUMP     => stack_io(1, 0);
481    0x57 => JUMPI    => stack_io(2, 0);
482    0x58 => PC       => stack_io(0, 1);
483    0x59 => MSIZE    => stack_io(0, 1);
484    0x5A => GAS      => stack_io(0, 1);
485    0x5B => JUMPDEST => stack_io(0, 0);
486    0x5C => TLOAD    => stack_io(1, 1);
487    0x5D => TSTORE   => stack_io(2, 0);
488    0x5E => MCOPY    => stack_io(3, 0);
489
490    0x5F => PUSH0  => stack_io(0, 1);
491    0x60 => PUSH1  => stack_io(0, 1), immediate_size(1);
492    0x61 => PUSH2  => stack_io(0, 1), immediate_size(2);
493    0x62 => PUSH3  => stack_io(0, 1), immediate_size(3);
494    0x63 => PUSH4  => stack_io(0, 1), immediate_size(4);
495    0x64 => PUSH5  => stack_io(0, 1), immediate_size(5);
496    0x65 => PUSH6  => stack_io(0, 1), immediate_size(6);
497    0x66 => PUSH7  => stack_io(0, 1), immediate_size(7);
498    0x67 => PUSH8  => stack_io(0, 1), immediate_size(8);
499    0x68 => PUSH9  => stack_io(0, 1), immediate_size(9);
500    0x69 => PUSH10 => stack_io(0, 1), immediate_size(10);
501    0x6A => PUSH11 => stack_io(0, 1), immediate_size(11);
502    0x6B => PUSH12 => stack_io(0, 1), immediate_size(12);
503    0x6C => PUSH13 => stack_io(0, 1), immediate_size(13);
504    0x6D => PUSH14 => stack_io(0, 1), immediate_size(14);
505    0x6E => PUSH15 => stack_io(0, 1), immediate_size(15);
506    0x6F => PUSH16 => stack_io(0, 1), immediate_size(16);
507    0x70 => PUSH17 => stack_io(0, 1), immediate_size(17);
508    0x71 => PUSH18 => stack_io(0, 1), immediate_size(18);
509    0x72 => PUSH19 => stack_io(0, 1), immediate_size(19);
510    0x73 => PUSH20 => stack_io(0, 1), immediate_size(20);
511    0x74 => PUSH21 => stack_io(0, 1), immediate_size(21);
512    0x75 => PUSH22 => stack_io(0, 1), immediate_size(22);
513    0x76 => PUSH23 => stack_io(0, 1), immediate_size(23);
514    0x77 => PUSH24 => stack_io(0, 1), immediate_size(24);
515    0x78 => PUSH25 => stack_io(0, 1), immediate_size(25);
516    0x79 => PUSH26 => stack_io(0, 1), immediate_size(26);
517    0x7A => PUSH27 => stack_io(0, 1), immediate_size(27);
518    0x7B => PUSH28 => stack_io(0, 1), immediate_size(28);
519    0x7C => PUSH29 => stack_io(0, 1), immediate_size(29);
520    0x7D => PUSH30 => stack_io(0, 1), immediate_size(30);
521    0x7E => PUSH31 => stack_io(0, 1), immediate_size(31);
522    0x7F => PUSH32 => stack_io(0, 1), immediate_size(32);
523
524    0x80 => DUP1  => stack_io(1, 2);
525    0x81 => DUP2  => stack_io(2, 3);
526    0x82 => DUP3  => stack_io(3, 4);
527    0x83 => DUP4  => stack_io(4, 5);
528    0x84 => DUP5  => stack_io(5, 6);
529    0x85 => DUP6  => stack_io(6, 7);
530    0x86 => DUP7  => stack_io(7, 8);
531    0x87 => DUP8  => stack_io(8, 9);
532    0x88 => DUP9  => stack_io(9, 10);
533    0x89 => DUP10 => stack_io(10, 11);
534    0x8A => DUP11 => stack_io(11, 12);
535    0x8B => DUP12 => stack_io(12, 13);
536    0x8C => DUP13 => stack_io(13, 14);
537    0x8D => DUP14 => stack_io(14, 15);
538    0x8E => DUP15 => stack_io(15, 16);
539    0x8F => DUP16 => stack_io(16, 17);
540
541    0x90 => SWAP1  => stack_io(2, 2);
542    0x91 => SWAP2  => stack_io(3, 3);
543    0x92 => SWAP3  => stack_io(4, 4);
544    0x93 => SWAP4  => stack_io(5, 5);
545    0x94 => SWAP5  => stack_io(6, 6);
546    0x95 => SWAP6  => stack_io(7, 7);
547    0x96 => SWAP7  => stack_io(8, 8);
548    0x97 => SWAP8  => stack_io(9, 9);
549    0x98 => SWAP9  => stack_io(10, 10);
550    0x99 => SWAP10 => stack_io(11, 11);
551    0x9A => SWAP11 => stack_io(12, 12);
552    0x9B => SWAP12 => stack_io(13, 13);
553    0x9C => SWAP13 => stack_io(14, 14);
554    0x9D => SWAP14 => stack_io(15, 15);
555    0x9E => SWAP15 => stack_io(16, 16);
556    0x9F => SWAP16 => stack_io(17, 17);
557
558    0xA0 => LOG0 => stack_io(2, 0);
559    0xA1 => LOG1 => stack_io(3, 0);
560    0xA2 => LOG2 => stack_io(4, 0);
561    0xA3 => LOG3 => stack_io(5, 0);
562    0xA4 => LOG4 => stack_io(6, 0);
563    // 0xA5
564    // 0xA6
565    // 0xA7
566    // 0xA8
567    // 0xA9
568    // 0xAA
569    // 0xAB
570    // 0xAC
571    // 0xAD
572    // 0xAE
573    // 0xAF
574    // 0xB0
575    // 0xB1
576    // 0xB2
577    // 0xB3
578    // 0xB4
579    // 0xB5
580    // 0xB6
581    // 0xB7
582    // 0xB8
583    // 0xB9
584    // 0xBA
585    // 0xBB
586    // 0xBC
587    // 0xBD
588    // 0xBE
589    // 0xBF
590    // 0xC0
591    // 0xC1
592    // 0xC2
593    // 0xC3
594    // 0xC4
595    // 0xC5
596    // 0xC6
597    // 0xC7
598    // 0xC8
599    // 0xC9
600    // 0xCA
601    // 0xCB
602    // 0xCC
603    // 0xCD
604    // 0xCE
605    // 0xCF
606    // 0xD0
607    // 0xD1
608    // 0xD2
609    // 0xD3
610    // 0xD4
611    // 0xD5
612    // 0xD6
613    // 0xD7
614    // 0xD8
615    // 0xD9
616    // 0xDA
617    // 0xDB
618    // 0xDC
619    // 0xDD
620    // 0xDE
621    // 0xDF
622    // 0xE0
623    // 0xE1
624    // 0xE2
625    // 0xE3
626    // 0xE4
627    // 0xE5
628    // 0xE6
629    // 0xE7
630    // 0xE8
631    // 0xE9
632    // 0xEA
633    // 0xEB
634    // 0xEC
635    // 0xED
636    // 0xEE
637    // 0xEF
638    0xF0 => CREATE       => stack_io(3, 1);
639    0xF1 => CALL         => stack_io(7, 1);
640    0xF2 => CALLCODE     => stack_io(7, 1);
641    0xF3 => RETURN       => stack_io(2, 0), terminating;
642    0xF4 => DELEGATECALL => stack_io(6, 1);
643    0xF5 => CREATE2      => stack_io(4, 1);
644    // 0xF6
645    // 0xF7
646    // 0xF8
647    // 0xF9
648    0xFA => STATICCALL      => stack_io(6, 1);
649    // 0xFB
650    // 0xFC
651    0xFD => REVERT       => stack_io(2, 0), terminating;
652    0xFE => INVALID      => stack_io(0, 0), terminating;
653    0xFF => SELFDESTRUCT => stack_io(1, 0), terminating;
654}
655
656#[cfg(test)]
657mod tests {
658    use super::*;
659
660    #[test]
661    fn test_opcode() {
662        let opcode = OpCode::new(0x00).unwrap();
663        assert!(!opcode.is_jumpdest());
664        assert!(!opcode.is_jump());
665        assert!(!opcode.is_push());
666        assert_eq!(opcode.as_str(), "STOP");
667        assert_eq!(opcode.get(), 0x00);
668    }
669
670    #[test]
671    fn test_immediate_size() {
672        let mut expected = [0u8; 256];
673        // PUSH opcodes
674        for push in PUSH1..=PUSH32 {
675            expected[push as usize] = push - PUSH1 + 1;
676        }
677
678        for (i, opcode) in OPCODE_INFO.iter().enumerate() {
679            if let Some(opcode) = opcode {
680                assert_eq!(
681                    opcode.immediate_size(),
682                    expected[i],
683                    "immediate_size check failed for {opcode:#?}",
684                );
685            }
686        }
687    }
688
689    #[test]
690    fn test_enabled_opcodes() {
691        // List obtained from https://eips.ethereum.org/EIPS/eip-3670
692        let opcodes = [
693            0x10..=0x1d,
694            0x20..=0x20,
695            0x30..=0x3f,
696            0x40..=0x48,
697            0x50..=0x5b,
698            0x54..=0x5f,
699            0x60..=0x6f,
700            0x70..=0x7f,
701            0x80..=0x8f,
702            0x90..=0x9f,
703            0xa0..=0xa4,
704            0xf0..=0xf5,
705            0xfa..=0xfa,
706            0xfd..=0xfd,
707            //0xfe,
708            0xff..=0xff,
709        ];
710        for i in opcodes {
711            for opcode in i {
712                OpCode::new(opcode).expect("Opcode should be valid and enabled");
713            }
714        }
715    }
716
717    #[test]
718    fn count_opcodes() {
719        let mut opcode_num = 0;
720        for _ in OPCODE_INFO.into_iter().flatten() {
721            opcode_num += 1;
722        }
723        assert_eq!(opcode_num, 150);
724    }
725
726    #[test]
727    fn test_terminating_opcodes() {
728        let terminating = [REVERT, RETURN, INVALID, SELFDESTRUCT, STOP];
729        let mut opcodes = [false; 256];
730        for terminating in terminating.iter() {
731            opcodes[*terminating as usize] = true;
732        }
733
734        for (i, opcode) in OPCODE_INFO.into_iter().enumerate() {
735            assert_eq!(
736                opcode.map(|opcode| opcode.terminating).unwrap_or_default(),
737                opcodes[i],
738                "Opcode {opcode:?} terminating check failed."
739            );
740        }
741    }
742
743    #[test]
744    #[cfg(feature = "parse")]
745    fn test_parsing() {
746        for i in 0..=u8::MAX {
747            if let Some(op) = OpCode::new(i) {
748                assert_eq!(OpCode::parse(op.as_str()), Some(op));
749            }
750        }
751    }
752
753    #[test]
754    #[should_panic(expected = "opcode not found")]
755    fn test_new_unchecked_invalid() {
756        let op = unsafe { OpCode::new_unchecked(0x0C) };
757        op.info();
758    }
759
760    #[test]
761    fn test_op_code_valid() {
762        let op1 = OpCode::new(ADD).unwrap();
763        let op2 = OpCode::new(MUL).unwrap();
764        assert!(op1.is_valid());
765        assert!(op2.is_valid());
766
767        let op3 = unsafe { OpCode::new_unchecked(0x0C) };
768        assert!(!op3.is_valid());
769    }
770
771    #[test]
772    fn test_modifies_memory() {
773        assert!(OpCode::new(MLOAD).unwrap().modifies_memory());
774        assert!(OpCode::new(MSTORE).unwrap().modifies_memory());
775        assert!(OpCode::new(KECCAK256).unwrap().modifies_memory());
776        assert!(!OpCode::new(ADD).unwrap().modifies_memory());
777    }
778}
revm_bytecode/opcode.rs

revm_bytecode/
opcode.rs
