This repository has been archived by the owner on Jul 5, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 858
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Browse files
Browse the repository at this point in the history
…1567) ### Description This PR was pulled from Scroll team (scroll-tech#351) and 1. moved CREATE case to a sparated gadget, see #1562. 2. supported uint64 overflow 3. updated the rlc part to fit our word lo/hi design. ### Issue Link closed #1519 ### Type of change - [ ] Bug fix (non-breaking change which fixes an issue) - [x] New feature (non-breaking change which adds functionality) - [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected) - [ ] This change requires a documentation update --------- Co-authored-by: Akase Cho <lightsing@users.noreply.github.com>
- Loading branch information
Showing
6 changed files
with
269 additions
and
38 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
221 changes: 221 additions & 0 deletions
221
zkevm-circuits/src/evm_circuit/execution/error_oog_dynamic_memory.rs
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,221 @@ | ||
| use crate::{ | ||
| evm_circuit::{ | ||
| execution::ExecutionGadget, | ||
| param::{N_BYTES_GAS, N_BYTES_MEMORY_ADDRESS}, | ||
| step::ExecutionState, | ||
| util::{ | ||
| common_gadget::CommonErrorGadget, | ||
| constraint_builder::{ConstrainBuilderCommon, EVMConstraintBuilder}, | ||
| math_gadget::LtGadget, | ||
| memory_gadget::{ | ||
| CommonMemoryAddressGadget, MemoryExpandedAddressGadget, MemoryExpansionGadget, | ||
| }, | ||
| CachedRegion, Cell, | ||
| }, | ||
| }, | ||
| witness::{Block, Call, ExecStep, Transaction}, | ||
| }; | ||
| use eth_types::{evm_types::OpcodeId, Field}; | ||
| use gadgets::util::{or, Expr}; | ||
| use halo2_proofs::{circuit::Value, plonk::Error}; | ||
|
|
||
| #[derive(Clone, Debug)] | ||
| pub(crate) struct ErrorOOGDynamicMemoryGadget<F> { | ||
| opcode: Cell<F>, | ||
|
|
||
| memory_expansion: MemoryExpansionGadget<F, 1, N_BYTES_MEMORY_ADDRESS>, | ||
| memory_address: MemoryExpandedAddressGadget<F>, | ||
| insufficient_gas: LtGadget<F, N_BYTES_GAS>, | ||
| common_error_gadget: CommonErrorGadget<F>, | ||
| } | ||
|
|
||
| impl<F: Field> ExecutionGadget<F> for ErrorOOGDynamicMemoryGadget<F> { | ||
| const NAME: &'static str = "ErrorOutOfGasDynamicMemoryExpansion"; | ||
| const EXECUTION_STATE: ExecutionState = ExecutionState::ErrorOutOfGasDynamicMemoryExpansion; | ||
|
|
||
| // Support other OOG due to pure memory including RETURN and REVERT | ||
| fn configure(cb: &mut EVMConstraintBuilder<F>) -> Self { | ||
| let opcode = cb.query_cell(); | ||
|
|
||
| cb.require_in_set( | ||
| "ErrorOutOfGasDynamicMemoryExpansion opcode must be RETURN or REVERT", | ||
| opcode.expr(), | ||
| vec![OpcodeId::RETURN.expr(), OpcodeId::REVERT.expr()], | ||
| ); | ||
|
|
||
| let memory_address = MemoryExpandedAddressGadget::construct_self(cb); | ||
| cb.stack_pop(memory_address.offset_word()); | ||
| cb.stack_pop(memory_address.length_word()); | ||
| let memory_expansion = MemoryExpansionGadget::construct(cb, [memory_address.address()]); | ||
|
|
||
| // constant gas of RETURN and REVERT is zero. | ||
| let insufficient_gas = LtGadget::construct( | ||
| cb, | ||
| cb.curr.state.gas_left.expr(), | ||
| memory_expansion.gas_cost(), | ||
| ); | ||
| cb.require_equal( | ||
| "Memory address is overflow or gas left is less than required", | ||
| or::expr([memory_address.overflow(), insufficient_gas.expr()]), | ||
| 1.expr(), | ||
| ); | ||
|
|
||
| let common_error_gadget = | ||
| CommonErrorGadget::construct(cb, opcode.expr(), cb.rw_counter_offset()); | ||
|
|
||
| Self { | ||
| opcode, | ||
| memory_address, | ||
| memory_expansion, | ||
| insufficient_gas, | ||
| common_error_gadget, | ||
| } | ||
| } | ||
|
|
||
| fn assign_exec_step( | ||
| &self, | ||
| region: &mut CachedRegion<'_, '_, F>, | ||
| offset: usize, | ||
| block: &Block<F>, | ||
| _: &Transaction, | ||
| call: &Call, | ||
| step: &ExecStep, | ||
| ) -> Result<(), Error> { | ||
| let opcode = step.opcode().unwrap(); | ||
| self.opcode | ||
| .assign(region, offset, Value::known(F::from(opcode.as_u64())))?; | ||
|
|
||
| let [memory_offset, length] = [0, 1].map(|idx| block.get_rws(step, idx).stack_value()); | ||
|
|
||
| let expanded_address = self | ||
| .memory_address | ||
| .assign(region, offset, memory_offset, length)?; | ||
|
|
||
| let (_, memory_expansion_cost) = self.memory_expansion.assign( | ||
| region, | ||
| offset, | ||
| step.memory_word_size(), | ||
| [expanded_address], | ||
| )?; | ||
|
|
||
| // constant gas of RETURN and REVERT is zero | ||
| self.insufficient_gas.assign( | ||
| region, | ||
| offset, | ||
| F::from(step.gas_left), | ||
| F::from(memory_expansion_cost), | ||
| )?; | ||
|
|
||
| self.common_error_gadget | ||
| .assign(region, offset, block, call, step, 4)?; | ||
| Ok(()) | ||
| } | ||
| } | ||
|
|
||
| #[cfg(test)] | ||
| mod tests { | ||
| use crate::test_util::CircuitTestBuilder; | ||
| use eth_types::{bytecode, word, Bytecode, ToWord, U256}; | ||
| use mock::{ | ||
| eth, test_ctx::helpers::account_0_code_account_1_no_code, TestContext, MOCK_ACCOUNTS, | ||
| }; | ||
|
|
||
| #[test] | ||
| fn test_oog_dynamic_memory_simple() { | ||
| for code in testing_bytecodes(0x40_u64.into(), 0x14.into()).iter() { | ||
| test_root(code); | ||
| test_internal(code); | ||
| } | ||
| } | ||
|
|
||
| #[test] | ||
| fn test_oog_dynamic_memory_max_expanded_address() { | ||
| // 0xffffffff1 + 0xffffffff0 = 0x1fffffffe1 | ||
| // > MAX_EXPANDED_MEMORY_ADDRESS (0x1fffffffe0) | ||
| for code in testing_bytecodes(0xffffffff1_u64.into(), 0xffffffff0_u64.into()).iter() { | ||
| test_root(code); | ||
| test_internal(code); | ||
| } | ||
| } | ||
|
|
||
| #[test] | ||
| fn test_oog_dynamic_memory_max_u64_address() { | ||
| for code in testing_bytecodes(u64::MAX.into(), u64::MAX.into()).iter() { | ||
| test_root(code); | ||
| test_internal(code); | ||
| } | ||
| } | ||
|
|
||
| #[test] | ||
| fn test_oog_dynamic_memory_max_word_address() { | ||
| for code in testing_bytecodes(U256::MAX, U256::MAX).iter() { | ||
| test_root(code); | ||
| test_internal(code); | ||
| } | ||
| } | ||
|
|
||
| fn test_root(code: &Bytecode) { | ||
| let ctx = TestContext::<2, 1>::new( | ||
| None, | ||
| account_0_code_account_1_no_code(code.clone()), | ||
| |mut txs, accs| { | ||
| txs[0] | ||
| .from(accs[1].address) | ||
| .to(accs[0].address) | ||
| .gas(word!("0x5FFF")); | ||
| }, | ||
| |block, _tx| block, | ||
| ) | ||
| .unwrap(); | ||
|
|
||
| CircuitTestBuilder::new_from_test_ctx(ctx).run(); | ||
| } | ||
|
|
||
| fn test_internal(code: &Bytecode) { | ||
| let code_a = bytecode! { | ||
| PUSH1(0x00) // retLength | ||
| PUSH1(0x00) // retOffset | ||
| PUSH32(0x00) // argsLength | ||
| PUSH32(0x00) // argsOffset | ||
| PUSH1(0x00) // value | ||
| PUSH32(MOCK_ACCOUNTS[1].to_word()) // addr | ||
| PUSH32(0xFFFF) // gas | ||
| CALL | ||
| STOP | ||
| }; | ||
|
|
||
| let ctx = TestContext::<3, 1>::new( | ||
| None, | ||
| |accs| { | ||
| accs[0].address(MOCK_ACCOUNTS[0]).code(code_a); | ||
| accs[1].address(MOCK_ACCOUNTS[1]).code(code.clone()); | ||
| accs[2].address(MOCK_ACCOUNTS[2]).balance(eth(1)); | ||
| }, | ||
| |mut txs, accs| { | ||
| txs[0] | ||
| .from(accs[2].address) | ||
| .to(accs[0].address) | ||
| .gas(word!("0xFFFFF")); | ||
| }, | ||
| |block, _tx| block, | ||
| ) | ||
| .unwrap(); | ||
|
|
||
| CircuitTestBuilder::new_from_test_ctx(ctx).run(); | ||
| } | ||
|
|
||
| fn testing_bytecodes(offset: U256, size: U256) -> Vec<Bytecode> { | ||
| vec![ | ||
| bytecode! { | ||
| PUSH32(size) | ||
| PUSH32(offset) | ||
| RETURN | ||
| }, | ||
| bytecode! { | ||
| PUSH32(size) | ||
| PUSH32(offset) | ||
| REVERT | ||
| }, | ||
| ] | ||
| } | ||
| } |