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

revm_bytecode/
opcode.rs
