Skip to content

Rework multibyte opcode support #319

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 6 commits into from
May 24, 2025
Merged

Rework multibyte opcode support #319

Show file tree
Hide file tree
Changes from 5 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
76d0a6d
Chained Etable
sorpaas May 24, 2025
3a83a6c
Tracing Etable
sorpaas May 24, 2025
850ed6f
Decode opcode in Etable rather than in interpreter
sorpaas May 24, 2025
e76c3e8
Remove Opcode parameter and add etable::Single
sorpaas May 24, 2025
443985e
Rework MultiEtable support
sorpaas May 24, 2025
d13d463
Fix no-std build
sorpaas May 24, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 0 additions & 2 deletions interpreter/src/error/exit.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -161,8 +161,6 @@ pub enum ExitFatal {
AlreadyExited,
/// Unfinished execution.
Unfinished,
/// Unknown etable, indication of incorrect EVM config.
UnknownEtable,

/// Other fatal errors.
Other(Cow<'static, str>),
Expand Down
234 changes: 158 additions & 76 deletions interpreter/src/etable.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ use core::{
};

use crate::{
error::{CallCreateTrap, ExitFatal, ExitResult, TrapConstruct},
error::{CallCreateTrap, ExitException, ExitResult, TrapConstruct},
eval::*,
machine::Machine,
opcode::Opcode,
Expand All @@ -18,110 +18,175 @@ pub trait EtableSet {
type Handle;
type Trap;

/// Evaluate the etable.
///
/// ### Safety
///
/// The interpreter guarantee that the byte at `position` exists.
fn eval(
&self,
machine: &mut Machine<Self::State>,
handle: &mut Self::Handle,
opcode: Opcode,
position: usize,
) -> Control<Self::Trap>;
}

impl<S, H, Tr, F> EtableSet for Etable<S, H, Tr, F>
/// A chained Etable, stopping at the first if it does not return
/// `Control::NoAction`.
pub struct Chained<E1, E2>(pub E1, pub E2);

impl<S, H, Tr, E1, E2> EtableSet for Chained<E1, E2>
where
F: Fn(&mut Machine<S>, &mut H, Opcode, usize) -> Control<Tr>,
E1: EtableSet<State = S, Handle = H, Trap = Tr>,
E2: EtableSet<State = S, Handle = H, Trap = Tr>,
{
type State = S;
type Handle = H;
type Trap = Tr;

fn eval(
&self,
machine: &mut Machine<S>,
handle: &mut H,
opcode: Opcode,
position: usize,
) -> Control<Tr> {
self[opcode.as_usize()](machine, handle, opcode, position)
fn eval(&self, machine: &mut Machine<S>, handle: &mut H, position: usize) -> Control<Tr> {
let ret1 = self.0.eval(machine, handle, position);

if let Control::NoAction = ret1 {
self.1.eval(machine, handle, position)
} else {
ret1
}
}
}

impl<S, H, Tr, F1, F2> EtableSet for (Etable<S, H, Tr, F1>, Etable<S, H, Tr, F2>)
/// A tracing Etable, with pre and post actions.
pub struct Tracing<EPre, E, EPost>(pub EPre, pub E, pub EPost);

impl<S, H, Tr, EPre, E, EPost> EtableSet for Tracing<EPre, E, EPost>
where
F1: Fn(&mut Machine<S>, &mut H, Opcode, usize) -> Control<Tr>,
F2: Fn(&mut Machine<S>, &mut H, Opcode, usize) -> Control<Tr>,
EPre: EtableSet<State = S, Handle = H, Trap = Tr>,
E: EtableSet<State = S, Handle = H, Trap = Tr>,
EPost: EtableSet<State = S, Handle = H, Trap = Tr>,
{
type State = S;
type Handle = H;
type Trap = Tr;

fn eval(
&self,
machine: &mut Machine<S>,
handle: &mut H,
opcode: Opcode,
position: usize,
) -> Control<Tr> {
let mut ret = self.0[opcode.as_usize()](machine, handle, opcode, position);

if let Control::NextEtable(n) = ret {
if n == 0 {
ret = self.1[opcode.as_usize()](machine, handle, opcode, position);
} else {
ret = Control::Exit(ExitFatal::UnknownEtable.into());
}
}
fn eval(&self, machine: &mut Machine<S>, handle: &mut H, position: usize) -> Control<Tr> {
let _ = self.0.eval(machine, handle, position);
let ret = self.1.eval(machine, handle, position);
let _ = self.2.eval(machine, handle, position);

ret
}
}

impl<S, H, Tr, F1, F2, F3, const F3N: usize> EtableSet
for (
Etable<S, H, Tr, F1>,
Etable<S, H, Tr, F2>,
[Etable<S, H, Tr, F3>; F3N],
)
/// Evaluation function type.
pub type Efn<S, H, Tr> = fn(&mut Machine<S>, &mut H, usize) -> Control<Tr>;

/// Etable with only one function.
pub struct Single<S, H, Tr, F = Efn<S, H, Tr>>(F, PhantomData<(S, H, Tr)>);

unsafe impl<S, H, Tr, F: Send> Send for Single<S, H, Tr, F> {}
unsafe impl<S, H, Tr, F: Sync> Sync for Single<S, H, Tr, F> {}

impl<S, H, Tr, F> Deref for Single<S, H, Tr, F> {
type Target = F;

fn deref(&self) -> &F {
&self.0
}
}

impl<S, H, Tr, F> DerefMut for Single<S, H, Tr, F> {
fn deref_mut(&mut self) -> &mut F {
&mut self.0
}
}

impl<S, H, Tr, F> Single<S, H, Tr, F> {
/// Create a new single Etable.
pub fn new(single: F) -> Self {
Self(single, PhantomData)
}
}

impl<S, H, Tr, F> EtableSet for Single<S, H, Tr, F>
where
F1: Fn(&mut Machine<S>, &mut H, Opcode, usize) -> Control<Tr>,
F2: Fn(&mut Machine<S>, &mut H, Opcode, usize) -> Control<Tr>,
F3: Fn(&mut Machine<S>, &mut H, Opcode, usize) -> Control<Tr>,
F: Fn(&mut Machine<S>, &mut H, usize) -> Control<Tr>,
{
type State = S;
type Handle = H;
type Trap = Tr;

fn eval(
&self,
machine: &mut Machine<S>,
handle: &mut H,
opcode: Opcode,
position: usize,
) -> Control<Tr> {
let mut ret = self.0[opcode.as_usize()](machine, handle, opcode, position);

if let Control::NextEtable(n) = ret {
if n == 0 {
ret = self.1[opcode.as_usize()](machine, handle, opcode, position);
} else {
ret = Control::Exit(ExitFatal::UnknownEtable.into());
}
}
fn eval(&self, machine: &mut Machine<S>, handle: &mut H, position: usize) -> Control<Tr> {
self.0(machine, handle, position)
}
}

if let Control::NextEtable(n) = ret {
if n < self.2.len() {
ret = self.2[n][opcode.as_usize()](machine, handle, opcode, position);
} else {
ret = Control::Exit(ExitFatal::UnknownEtable.into());
}
}
/// Nested evaluation function.
pub enum MultiEfn<S, H, Tr, F = Efn<S, H, Tr>> {
/// Leaf function.
Leaf(F),
/// Node function.
Node(Box<MultiEtable<S, H, Tr, F>>),
}

ret
unsafe impl<S, H, Tr, F: Send> Send for MultiEfn<S, H, Tr, F> {}
unsafe impl<S, H, Tr, F: Sync> Sync for MultiEfn<S, H, Tr, F> {}

/// Nested evaluation table.
pub struct MultiEtable<S, H, Tr, F = Efn<S, H, Tr>>(
[MultiEfn<S, H, Tr, F>; 256],
PhantomData<(S, H, Tr)>,
);

unsafe impl<S, H, Tr, F: Send> Send for MultiEtable<S, H, Tr, F> {}
unsafe impl<S, H, Tr, F: Sync> Sync for MultiEtable<S, H, Tr, F> {}

impl<S, H, Tr, F> Deref for MultiEtable<S, H, Tr, F> {
type Target = [MultiEfn<S, H, Tr, F>; 256];

fn deref(&self) -> &[MultiEfn<S, H, Tr, F>; 256] {
&self.0
}
}

/// Evaluation function type.
pub type Efn<S, H, Tr> = fn(&mut Machine<S>, &mut H, Opcode, usize) -> Control<Tr>;
impl<S, H, Tr, F> DerefMut for MultiEtable<S, H, Tr, F> {
fn deref_mut(&mut self) -> &mut [MultiEfn<S, H, Tr, F>; 256] {
&mut self.0
}
}

impl<S, H, Tr, F> From<Etable<S, H, Tr, F>> for MultiEtable<S, H, Tr, F> {
fn from(etable: Etable<S, H, Tr, F>) -> Self {
Self(etable.0.map(|v| MultiEfn::Leaf(v)), PhantomData)
}
}

impl<S, H, Tr, F> EtableSet for MultiEtable<S, H, Tr, F>
where
F: Fn(&mut Machine<S>, &mut H, usize) -> Control<Tr>,
{
type State = S;
type Handle = H;
type Trap = Tr;

fn eval(&self, machine: &mut Machine<S>, handle: &mut H, position: usize) -> Control<Tr> {
let opcode = Opcode(machine.code()[position]);

match &self[opcode.as_usize()] {
MultiEfn::Leaf(f) => f(machine, handle, position),
MultiEfn::Node(n) => {
let nextpos = position + 1;
if nextpos >= machine.code.len() {
return Control::Exit(ExitException::PCUnderflow.into());
Copy link
Preview

Copilot AI May 24, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Throwing PCUnderflow when the next position exceeds the code length seems incorrect; out-of-bounds positions should raise a PCOverflow exception instead.

Suggested change
return Control::Exit(ExitException::PCUnderflow.into());
return Control::Exit(ExitException::PCOverflow.into());

Copilot uses AI. Check for mistakes.

}

match n.eval(machine, handle, nextpos) {
Control::Continue(c) => Control::Continue(c + 1),
ctrl => ctrl,
}
}
}
}
}

/// The evaluation table for the EVM.
pub struct Etable<S, H, Tr, F = Efn<S, H, Tr>>([F; 256], PhantomData<(S, H, Tr)>);
Expand All @@ -143,22 +208,39 @@ impl<S, H, Tr, F> DerefMut for Etable<S, H, Tr, F> {
}
}

impl<S, H, Tr, F> Etable<S, H, Tr, F>
impl<S, H, Tr, F> From<Single<S, H, Tr, F>> for Etable<S, H, Tr, F>
where
F: Fn(&mut Machine<S>, &mut H, Opcode, usize) -> Control<Tr>,
F: Copy,
{
pub const fn single(f: F) -> Self
where
F: Copy,
{
Self([f; 256], PhantomData)
fn from(single: Single<S, H, Tr, F>) -> Self {
Self([single.0; 256], PhantomData)
}
}

impl<S, H, Tr, F> EtableSet for Etable<S, H, Tr, F>
where
F: Fn(&mut Machine<S>, &mut H, usize) -> Control<Tr>,
{
type State = S;
type Handle = H;
type Trap = Tr;

fn eval(&self, machine: &mut Machine<S>, handle: &mut H, position: usize) -> Control<Tr> {
let opcode = Opcode(machine.code()[position]);

self[opcode.as_usize()](machine, handle, position)
}
}

impl<S, H, Tr, F> Etable<S, H, Tr, F>
where
F: Fn(&mut Machine<S>, &mut H, usize) -> Control<Tr>,
{
/// Wrap to create a new Etable.
pub fn wrap<FW, FR>(self, wrapper: FW) -> Etable<S, H, Tr, FR>
where
FW: Fn(F, Opcode) -> FR,
FR: Fn(&mut Machine<S>, &mut H, Opcode, usize) -> Control<Tr>,
FR: Fn(&mut Machine<S>, &mut H, usize) -> Control<Tr>,
{
let mut current_opcode = Opcode(0);
Etable(
Expand Down Expand Up @@ -382,8 +464,8 @@ where
/// Control state.
#[derive(Clone, Eq, PartialEq, Debug)]
pub enum Control<Trap> {
/// Hand off control to the next etable.
NextEtable(usize),
/// No action.
NoAction,
/// Continue the execution, increase the PC by N.
Continue(usize),
/// Exit the execution.
Expand Down
Loading
Loading