Skip to content

Commit

Permalink
Implement JumpDest fetching from RPC.
Browse files Browse the repository at this point in the history
  • Loading branch information
einar-polygon committed Sep 2, 2024
1 parent 5faa7a1 commit e351ff9
Show file tree
Hide file tree
Showing 30 changed files with 730 additions and 50 deletions.
3 changes: 3 additions & 0 deletions Cargo.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 0 additions & 2 deletions Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,6 @@ criterion = "0.5.1"
dotenvy = "0.15.7"
either = "1.12.0"
enum-as-inner = "0.6.0"
enumn = "0.1.13"
env_logger = "0.11.3"
eth_trie = "0.4.0"
ethereum-types = "0.14.1"
Expand Down Expand Up @@ -94,7 +93,6 @@ serde = "1.0.203"
serde-big-array = "0.5.1"
serde_json = "1.0.118"
serde_path_to_error = "0.1.16"
serde_with = "3.8.1"
sha2 = "0.10.8"
static_assertions = "1.1.0"
thiserror = "1.0.61"
Expand Down
1 change: 1 addition & 0 deletions evm_arithmetization/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ homepage.workspace = true
keywords.workspace = true

[dependencies]
__compat_primitive_types = { workspace = true }
anyhow = { workspace = true }
bytes = { workspace = true }
env_logger = { workspace = true }
Expand Down
1 change: 1 addition & 0 deletions evm_arithmetization/benches/fibonacci_25m_gas.rs
Original file line number Diff line number Diff line change
Expand Up @@ -195,6 +195,7 @@ fn prepare_setup() -> anyhow::Result<GenerationInputs> {
prev_hashes: vec![H256::default(); 256],
cur_hash: H256::default(),
},
batch_jumpdest_table: None,
})
}

Expand Down
61 changes: 55 additions & 6 deletions evm_arithmetization/src/cpu/kernel/interpreter.rs
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,9 @@ use crate::cpu::columns::CpuColumnsView;
use crate::cpu::kernel::aggregator::KERNEL;
use crate::cpu::kernel::constants::global_metadata::GlobalMetadata;
use crate::generation::debug_inputs;
use crate::generation::jumpdest::{ContextJumpDests, JumpDestTableProcessed, JumpDestTableWitness};
use crate::generation::mpt::{load_linked_lists_and_txn_and_receipt_mpts, TrieRootPtrs};
use crate::generation::prover_input::{get_proofs_and_jumpdests, CodeMap};
use crate::generation::rlp::all_rlp_prover_inputs_reversed;
use crate::generation::state::{
all_ger_prover_inputs_reversed, all_withdrawals_prover_inputs_reversed, GenerationState,
Expand Down Expand Up @@ -56,6 +58,7 @@ pub(crate) struct Interpreter<F: Field> {
/// Counts the number of appearances of each opcode. For debugging purposes.
#[allow(unused)]
pub(crate) opcode_count: [usize; 0x100],
/// A table of contexts and their reached JUMPDESTs.
jumpdest_table: HashMap<usize, BTreeSet<usize>>,
/// `true` if the we are currently carrying out a jumpdest analysis.
pub(crate) is_jumpdest_analysis: bool,
Expand All @@ -71,9 +74,10 @@ pub(crate) struct Interpreter<F: Field> {
pub(crate) fn simulate_cpu_and_get_user_jumps<F: Field>(
final_label: &str,
state: &GenerationState<F>,
) -> Option<HashMap<usize, Vec<usize>>> {
// TODO(einar): remove second component of pair.
) -> (Option<JumpDestTableProcessed>, ContextJumpDests) {
match state.jumpdest_table {
Some(_) => None,
Some(_) => Default::default(),
None => {
let halt_pc = KERNEL.global_labels[final_label];
let initial_context = state.registers.context;
Expand All @@ -94,14 +98,16 @@ pub(crate) fn simulate_cpu_and_get_user_jumps<F: Field>(

interpreter
.generation_state
.set_jumpdest_analysis_inputs(interpreter.jumpdest_table);
.set_jumpdest_analysis_inputs(interpreter.jumpdest_table.clone());

log::debug!(
"Simulated CPU for jumpdest analysis halted after {:?} cycles.",
clock
);

interpreter.generation_state.jumpdest_table
(
interpreter.generation_state.jumpdest_table,
ContextJumpDests(interpreter.jumpdest_table),
)
}
}
}
Expand All @@ -114,7 +120,7 @@ pub(crate) struct ExtraSegmentData {
pub(crate) withdrawal_prover_inputs: Vec<U256>,
pub(crate) ger_prover_inputs: Vec<U256>,
pub(crate) trie_root_ptrs: TrieRootPtrs,
pub(crate) jumpdest_table: Option<HashMap<usize, Vec<usize>>>,
pub(crate) jumpdest_table: Option<JumpDestTableProcessed>,
pub(crate) next_txn_index: usize,
}

Expand Down Expand Up @@ -148,6 +154,49 @@ pub(crate) fn set_registers_and_run<F: Field>(
interpreter.run()
}

/// Computes the JUMPDEST proofs for each context.
///
/// # Arguments
///
/// - `jumpdest_table_rpc`: The raw table received from RPC.
/// - `code_db`: The corresponding database of contract code used in the trace.
pub(crate) fn set_jumpdest_analysis_inputs_rpc(
jumpdest_table_rpc: &JumpDestTableWitness,
code_map: &CodeMap,
) -> JumpDestTableProcessed {
let ctx_proofs = jumpdest_table_rpc
.0
.iter()
.flat_map(|(code_addr, ctx_jumpdests)| {
prove_context_jumpdests(&code_map.0[code_addr], ctx_jumpdests)
})
.collect();
JumpDestTableProcessed(ctx_proofs)
}

/// Orchestrates the proving of all contexts in a specific bytecode.
///
/// # Arguments
///
/// - `ctx_jumpdests`: Map from `ctx` to its list of offsets to reached
/// `JUMPDEST`s.
/// - `code`: The bytecode for the contexts. This is the same for all contexts.
fn prove_context_jumpdests(
code: &[u8],
ctx_jumpdests: &ContextJumpDests,
) -> HashMap<usize, Vec<usize>> {
ctx_jumpdests
.0
.iter()
.map(|(&ctx, jumpdests)| {
let proofs = jumpdests.last().map_or(Vec::default(), |&largest_address| {
get_proofs_and_jumpdests(code, largest_address, jumpdests.clone())
});
(ctx, proofs)
})
.collect()
}

impl<F: Field> Interpreter<F> {
/// Returns an instance of `Interpreter` given `GenerationInputs`, and
/// assuming we are initializing with the `KERNEL` code.
Expand Down
2 changes: 2 additions & 0 deletions evm_arithmetization/src/cpu/kernel/tests/add11.rs
Original file line number Diff line number Diff line change
Expand Up @@ -196,6 +196,7 @@ fn test_add11_yml() {
prev_hashes: vec![H256::default(); 256],
cur_hash: H256::default(),
},
batch_jumpdest_table: None,
};

let initial_stack = vec![];
Expand Down Expand Up @@ -378,6 +379,7 @@ fn test_add11_yml_with_exception() {
prev_hashes: vec![H256::default(); 256],
cur_hash: H256::default(),
},
batch_jumpdest_table: None,
};

let initial_stack = vec![];
Expand Down
13 changes: 10 additions & 3 deletions evm_arithmetization/src/cpu/kernel/tests/core/jumpdest_analysis.rs
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ use plonky2::field::goldilocks_field::GoldilocksField as F;
use crate::cpu::kernel::aggregator::KERNEL;
use crate::cpu::kernel::interpreter::Interpreter;
use crate::cpu::kernel::opcodes::{get_opcode, get_push_opcode};
use crate::generation::jumpdest::JumpDestTableProcessed;
use crate::witness::operation::CONTEXT_SCALING_FACTOR;

#[test]
Expand Down Expand Up @@ -67,7 +68,10 @@ fn test_jumpdest_analysis() -> Result<()> {
interpreter.generation_state.jumpdest_table,
// Context 3 has jumpdest 1, 5, 7. All have proof 0 and hence
// the list [proof_0, jumpdest_0, ... ] is [0, 1, 0, 5, 0, 7, 8, 40]
Some(HashMap::from([(3, vec![0, 1, 0, 5, 0, 7, 8, 40])]))
Some(JumpDestTableProcessed(HashMap::from([(
3,
vec![0, 1, 0, 5, 0, 7, 8, 40]
)])))
);

// Run jumpdest analysis with context = 3
Expand All @@ -89,6 +93,7 @@ fn test_jumpdest_analysis() -> Result<()> {
.jumpdest_table
.as_mut()
.unwrap()
.0
.get_mut(&CONTEXT)
.unwrap()
.pop();
Expand Down Expand Up @@ -136,7 +141,8 @@ fn test_packed_verification() -> Result<()> {
let mut interpreter: Interpreter<F> =
Interpreter::new(write_table_if_jumpdest, initial_stack.clone(), None);
interpreter.set_code(CONTEXT, code.clone());
interpreter.generation_state.jumpdest_table = Some(HashMap::from([(3, vec![1, 33])]));
interpreter.generation_state.jumpdest_table =
Some(JumpDestTableProcessed(HashMap::from([(3, vec![1, 33])])));

interpreter.run()?;

Expand All @@ -149,7 +155,8 @@ fn test_packed_verification() -> Result<()> {
let mut interpreter: Interpreter<F> =
Interpreter::new(write_table_if_jumpdest, initial_stack.clone(), None);
interpreter.set_code(CONTEXT, code.clone());
interpreter.generation_state.jumpdest_table = Some(HashMap::from([(3, vec![1, 33])]));
interpreter.generation_state.jumpdest_table =
Some(JumpDestTableProcessed(HashMap::from([(3, vec![1, 33])])));

assert!(interpreter.run().is_err());

Expand Down
1 change: 1 addition & 0 deletions evm_arithmetization/src/cpu/kernel/tests/init_exc_stop.rs
Original file line number Diff line number Diff line change
Expand Up @@ -111,6 +111,7 @@ fn test_init_exc_stop() {
cur_hash: H256::default(),
},
global_exit_roots: vec![],
batch_jumpdest_table: None,
};
let initial_stack = vec![];
let initial_offset = KERNEL.global_labels["init"];
Expand Down
67 changes: 67 additions & 0 deletions evm_arithmetization/src/generation/jumpdest.rs
Original file line number Diff line number Diff line change
@@ -0,0 +1,67 @@
use std::{
collections::{BTreeSet, HashMap},
fmt::Display,
};

use keccak_hash::H256;
use serde::{Deserialize, Serialize};

/// Each `CodeAddress` can be called one or more times, each time creating a new
/// `Context`. Each `Context` will contain one or more offsets of `JUMPDEST`.
#[derive(PartialEq, Eq, Debug, Clone, Serialize, Deserialize, Default)]
pub struct ContextJumpDests(pub HashMap<usize, BTreeSet<usize>>);

/// The result after proving a `JumpDestTableWitness`.
#[derive(PartialEq, Eq, Debug, Clone, Serialize, Deserialize, Default)]
pub(crate) struct JumpDestTableProcessed(pub HashMap<usize, Vec<usize>>);

/// Map `CodeAddress -> (Context -> [JumpDests])`
#[derive(PartialEq, Eq, Debug, Clone, Serialize, Deserialize, Default)]
pub struct JumpDestTableWitness(pub HashMap<H256, ContextJumpDests>);

impl JumpDestTableWitness {
/// Insert `offset` into `ctx` under the corrresponding `code_hash`.
/// Creates the required `ctx` keys and `code_hash`. Idempotent.
pub fn insert(&mut self, code_hash: &H256, ctx: usize, offset: usize) {
self.0.entry(*code_hash).or_default();

self.0.get_mut(code_hash).unwrap().0.entry(ctx).or_default();

self.0
.get_mut(code_hash)
.unwrap()
.0
.get_mut(&ctx)
.unwrap()
.insert(offset);

// TODO(einar) remove before publishing PR.
assert!(self.0.contains_key(code_hash));
assert!(self.0[code_hash].0.contains_key(&ctx));
assert!(self.0[code_hash].0[&ctx].contains(&offset));
}
}

impl Display for JumpDestTableWitness {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
writeln!(f, "=== JumpDest table ===")?;

for (code, ctxtbls) in &self.0 {
write!(f, "codehash: {:?}\n{}", code, ctxtbls)?;
}
Ok(())
}
}

impl Display for ContextJumpDests {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
for (ctx, offsets) in &self.0 {
write!(f, " ctx: {}, offsets: [", ctx)?;
for offset in offsets {
write!(f, "{:#10x} ", offset)?;
}
writeln!(f, "]")?;
}
Ok(())
}
}
11 changes: 11 additions & 0 deletions evm_arithmetization/src/generation/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ use std::collections::HashMap;
use anyhow::anyhow;
use ethereum_types::H160;
use ethereum_types::{Address, BigEndianHash, H256, U256};
use jumpdest::JumpDestTableWitness;
use keccak_hash::keccak;
use log::log_enabled;
use mpt_trie::partial_trie::{HashedPartialTrie, PartialTrie};
Expand Down Expand Up @@ -34,6 +35,7 @@ use crate::util::{h2u, u256_to_usize};
use crate::witness::memory::{MemoryAddress, MemoryChannel, MemoryState};
use crate::witness::state::RegistersState;

pub mod jumpdest;
pub(crate) mod linked_list;
pub mod mpt;
pub(crate) mod prover_input;
Expand Down Expand Up @@ -99,6 +101,10 @@ pub struct GenerationInputs {
/// The hash of the current block, and a list of the 256 previous block
/// hashes.
pub block_hashes: BlockHashes,

/// A table listing each JUMPDESTs reached in each call context under
/// associated code hash.
pub batch_jumpdest_table: Option<JumpDestTableWitness>,
}

/// A lighter version of [`GenerationInputs`], which have been trimmed
Expand Down Expand Up @@ -145,6 +151,10 @@ pub struct TrimmedGenerationInputs {
/// The hash of the current block, and a list of the 256 previous block
/// hashes.
pub block_hashes: BlockHashes,

/// A list of tables listing each JUMPDESTs reached in each call context
/// under associated code hash.
pub batch_jumpdest_table: Option<JumpDestTableWitness>,
}

#[derive(Clone, Debug, Deserialize, Serialize, Default)]
Expand Down Expand Up @@ -218,6 +228,7 @@ impl GenerationInputs {
burn_addr: self.burn_addr,
block_metadata: self.block_metadata.clone(),
block_hashes: self.block_hashes.clone(),
batch_jumpdest_table: self.batch_jumpdest_table.clone(),
}
}
}
Expand Down
Loading

0 comments on commit e351ff9

Please sign in to comment.