Skip to content
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.

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

Additional EVM optimizations #850

Merged
merged 19 commits into from
Oct 15, 2024
Merged
Show file tree
Hide file tree
Changes from 18 commits
Commits
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
12 changes: 11 additions & 1 deletion src/kontrol/cli.py
Original file line number Diff line number Diff line change
Expand Up @@ -575,7 +575,17 @@ def parse(s: str) -> list[T]:
help=(
'Optimize performance for proof execution. Takes the number of parallel threads to be used.'
"Will overwrite other settings of 'assume-defined', 'log-success-rewrites', 'max-frontier-parallel',"
"'maintenance-rate', 'smt-timeout', 'smt-retry-limit', 'max-depth', and 'max-iterations'."
"'maintenance-rate', 'smt-timeout', 'smt-retry-limit', 'max-depth', 'max-iterations', and 'no-stack-checks'."
),
)
prove_args.add_argument(
'--no-stack-checks',
dest='no_stack_checks',
default=None,
action='store_true',
help=(
'Optimize KEVM execution by removing stack overflow/underflow checks.'
'Assumes running Solidity-compiled bytecode cannot result in a stack overflow/underflow.'
),
)

Expand Down
8 changes: 4 additions & 4 deletions src/kontrol/kdist/cheatcodes.md
Original file line number Diff line number Diff line change
Expand Up @@ -470,7 +470,7 @@ WThe `#checkRevert` will be used to compare the status code of the execution and
<expectedDepth> CD </expectedDepth>
...
</expectedRevert>
[priority(38)]
[priority(32)]

rule [foundry.set.expectrevert.2]:
<k> #next [ _OP:CallSixOp ] ~> (.K => #checkRevert ~> #updateRevertOutput RETSTART RETWIDTH) ~> #execute ... </k>
Expand All @@ -481,7 +481,7 @@ WThe `#checkRevert` will be used to compare the status code of the execution and
<expectedDepth> CD </expectedDepth>
...
</expectedRevert>
[priority(38)]
[priority(32)]

rule [foundry.set.expectrevert.3]:
<k> #next [ OP:OpCode ] ~> (.K => #checkRevert) ~> #execute ... </k>
Expand All @@ -492,7 +492,7 @@ WThe `#checkRevert` will be used to compare the status code of the execution and
...
</expectedRevert>
requires (OP ==K CREATE orBool OP ==K CREATE2)
[priority(38)]
[priority(32)]
```

If the `expectRevert()` selector is matched, call the `#setExpectRevert` production to initialize the `<expectedRevert>` subconfiguration.
Expand Down Expand Up @@ -656,7 +656,7 @@ The last point is required in order to prevent overwriting the caller for subcal
requires ACCT =/=K NCL
andBool ACCTTO =/=K #address(FoundryCheat)
andBool (OP ==K CALL orBool OP ==K CALLCODE orBool OP ==K STATICCALL orBool OP ==K CREATE orBool OP ==K CREATE2)
[priority(40)]
[priority(34)]
```

#### `startPrank` - Sets `msg.sender` and `tx.origin` for all subsequent calls until `stopPrank` is called.
Expand Down
1 change: 1 addition & 0 deletions src/kontrol/kdist/foundry.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@ module FOUNDRY
configuration
<foundry>
<kevm/>
<stackChecks> true </stackChecks>
<cheatcodes/>
<KEVMTracing/>
</foundry>
Expand Down
12 changes: 0 additions & 12 deletions src/kontrol/kdist/kontrol_lemmas.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,18 +14,6 @@ module KONTROL-AUX-LEMMAS
imports MAP-SYMBOLIC
imports SET-SYMBOLIC

syntax StepSort ::= Int
| Bool
| Bytes
| Map
| Set
// -------------------------

syntax KItem ::= runLemma ( StepSort )
| doneLemma( StepSort )
// --------------------------------------
rule <k> runLemma(T) => doneLemma(T) ... </k>

syntax Int ::= "ethMaxWidth" [macro]
syntax Int ::= "ethUpperBound" [macro]
// --------------------------------------
Expand Down
145 changes: 145 additions & 0 deletions src/kontrol/kdist/no_stack_checks.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,145 @@
Optimized EVM rules
===================

The provided rules speed up execution by not performing stack overflow/underflow checks
and rely on the hypothesis that EVM bytecode that comes compiled from Solidity will not
result in a stack overflow/underflow.

```k
requires "foundry.md"

module NO-STACK-CHECKS
imports EVM
imports FOUNDRY

rule [super.optimized.pushzero]:
<k> ( #next[ PUSHZERO ] => .K ) ... </k>
<useGas> false </useGas>
<stackChecks> false </stackChecks>
<wordStack> WS => 0 : WS </wordStack>
<pc> PCOUNT => PCOUNT +Int 1 </pc>
[priority(30)]

rule [super.optimized.push]:
<k> ( #next[ PUSH(N) ] => .K ) ... </k>
<useGas> false </useGas>
<stackChecks> false </stackChecks>
<program> PGM </program>
<wordStack> WS => #asWord( #range(PGM, PCOUNT +Int 1, N) ) : WS </wordStack>
<pc> PCOUNT => PCOUNT +Int N +Int 1 </pc>
[priority(30)]

rule [super.optimized.dup]:
<k> ( #next[ DUP(N) ] => .K ) ... </k>
<useGas> false </useGas>
<stackChecks> false </stackChecks>
<wordStack> WS => WS [ ( N +Int -1 ) ] : WS </wordStack>
<pc> PCOUNT => PCOUNT +Int 1 </pc>
[priority(30)]

rule [super.optimized.swap]:
<k> ( #next[ SWAP(N) ] => .K ) ... </k>
<useGas> false </useGas>
<stackChecks> false </stackChecks>
<wordStack> W0 : WS => WS [ ( N +Int -1 ) ] : ( WS [ ( N +Int -1 ) := W0 ] ) </wordStack>
<pc> PCOUNT => PCOUNT +Int 1 </pc>
[priority(30)]

rule [super.optimized.add]:
<k> ( #next[ ADD ] => .K ) ... </k>
<useGas> false </useGas>
<stackChecks> false </stackChecks>
<wordStack> W0 : W1 : WS => chop ( W0 +Int W1 ) : WS </wordStack>
<pc> PCOUNT => PCOUNT +Int 1 </pc>
[priority(30)]

rule [super.optimized.sub]:
<k> ( #next[ SUB ] => .K ) ... </k>
<useGas> false </useGas>
<stackChecks> false </stackChecks>
<wordStack> W0 : W1 : WS => chop ( W0 -Int W1 ) : WS </wordStack>
<pc> PCOUNT => PCOUNT +Int 1 </pc>
[priority(30)]

rule [super.optimized.mul]:
<k> ( #next[ MUL ] => .K ) ... </k>
<useGas> false </useGas>
<stackChecks> false </stackChecks>
<wordStack> W0 : W1 : WS => chop ( W0 *Int W1 ) : WS </wordStack>
<pc> PCOUNT => PCOUNT +Int 1 </pc>
[priority(30)]

rule [super.optimized.and]:
<k> ( #next[ AND ] => .K ) ... </k>
<useGas> false </useGas>
<stackChecks> false </stackChecks>
<wordStack> W0 : W1 : WS => W0 &Int W1 : WS </wordStack>
<pc> PCOUNT => PCOUNT +Int 1 </pc>
[priority(30)]

rule [super.optimized.or]:
<k> ( #next[ EVMOR ] => .K ) ... </k>
<useGas> false </useGas>
<stackChecks> false </stackChecks>
<wordStack> W0 : W1 : WS => W0 |Int W1 : WS </wordStack>
<pc> PCOUNT => PCOUNT +Int 1 </pc>
[priority(30)]

rule [super.optimized.xor]:
<k> ( #next[ XOR ] => .K ) ... </k>
<useGas> false </useGas>
<stackChecks> false </stackChecks>
<wordStack> W0 : W1 : WS => W0 xorInt W1 : WS </wordStack>
<pc> PCOUNT => PCOUNT +Int 1 </pc>
[priority(30)]

rule [super.optimized.iszero]:
<k> ( #next[ ISZERO ] => .K ) ... </k>
<useGas> false </useGas>
<stackChecks> false </stackChecks>
<wordStack> W0 : WS => bool2Word ( W0 ==Int 0 ) : WS </wordStack>
<pc> PCOUNT => PCOUNT +Int 1 </pc>
[priority(30)]

rule [super.optimized.lt]:
<k> ( #next[ LT ] => .K ) ... </k>
<useGas> false </useGas>
<stackChecks> false </stackChecks>
<wordStack> W0 : W1 : WS => bool2Word ( W0 <Int W1 ) : WS </wordStack>
<pc> PCOUNT => PCOUNT +Int 1 </pc>
[priority(30)]

rule [super.optimized.gt]:
<k> ( #next[ GT ] => .K ) ... </k>
<useGas> false </useGas>
<stackChecks> false </stackChecks>
<wordStack> W0 : W1 : WS => bool2Word ( W1 <Int W0 ) : WS </wordStack>
<pc> PCOUNT => PCOUNT +Int 1 </pc>
[priority(30)]

rule [super.optimized.eq]:
<k> ( #next[ EQ ] => .K ) ... </k>
<useGas> false </useGas>
<stackChecks> false </stackChecks>
<wordStack> W0 : W1 : WS => bool2Word ( W0 ==Int W1 ) : WS </wordStack>
<pc> PCOUNT => PCOUNT +Int 1 </pc>
[priority(30)]

rule [super.optimized.next.succ]:
<k> ( #next [ OP:OpCode ] => #addr [ OP ] ~> #exec [ OP ] ~> #pc[ OP ] ) ... </k>
<stackChecks> false </stackChecks>
<wordStack> WS </wordStack>
<static> STATIC:Bool </static>
requires notBool ( STATIC andBool #changesState(OP, WS) )
[priority(36)]

rule [super.optimized.next.smv]:
<k> ( #next [ OP ] => #end EVMC_STATIC_MODE_VIOLATION ) ... </k>
<stackChecks> false </stackChecks>
<wordStack> WS </wordStack>
<static> STATIC:Bool </static>
requires STATIC andBool #changesState(OP, WS)
[priority(38)]

endmodule
```
2 changes: 2 additions & 0 deletions src/kontrol/kompile.py
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,7 @@ def foundry_kompile(
options.requires
+ ([KSRC_DIR / 'keccak.md'] if options.keccak_lemmas else [])
+ ([KSRC_DIR / 'kontrol_lemmas.md'] if options.auxiliary_lemmas else [])
+ ([KSRC_DIR / 'no_stack_checks.md'])
)
for r in tuple(requires):
req = Path(r)
Expand Down Expand Up @@ -227,6 +228,7 @@ def _foundry_to_main_def(
[KImport(mname) for mname in (_m.name for _m in modules)]
+ ([KImport('KECCAK-LEMMAS')] if keccak_lemmas else [])
+ ([KImport('KONTROL-AUX-LEMMAS')] if auxiliary_lemmas else [])
+ ([KImport('NO-STACK-CHECKS')])
),
)

Expand Down
5 changes: 4 additions & 1 deletion src/kontrol/options.py
Original file line number Diff line number Diff line change
Expand Up @@ -378,6 +378,7 @@ class ProveOptions(
hide_status_bar: bool
remove_old_proofs: bool
optimize_performance: int | None
no_stack_checks: bool

def __init__(self, args: dict[str, Any]) -> None:
super().__init__(args)
Expand Down Expand Up @@ -406,6 +407,7 @@ def default() -> dict[str, Any]:
'hide_status_bar': False,
'remove_old_proofs': False,
'optimize_performance': None,
'no_stack_checks': False,
}

@staticmethod
Expand Down Expand Up @@ -464,11 +466,12 @@ def apply_optimizations(self) -> None:
self.assume_defined = True
self.log_succ_rewrites = False
self.max_frontier_parallel = self.optimize_performance
self.maintenance_rate = 2 * self.optimize_performance
self.maintenance_rate = 64
self.smt_timeout = 120000
self.smt_retry_limit = 0
self.max_depth = 100000
self.max_iterations = 10000
self.no_stack_checks = True

def __str__(self) -> str:
"""
Expand Down
9 changes: 9 additions & 0 deletions src/kontrol/prove.py
Original file line number Diff line number Diff line change
Expand Up @@ -425,6 +425,7 @@ def create_kcfg_explore() -> KCFGExplore:
'usegas': options.usegas,
}
),
no_stack_checks=options.no_stack_checks,
trace_options=TraceOptions(
{
'active_tracing': options.active_tracing,
Expand Down Expand Up @@ -567,6 +568,7 @@ def method_to_apr_proof(
kcfg_explore: KCFGExplore,
config_type: ConfigType,
evm_chain_options: EVMChainOptions,
no_stack_checks: bool,
bmc_depth: int | None = None,
run_constructor: bool = False,
recorded_state_entries: Iterable[StateDiffEntry] | Iterable[StateDumpEntry] | None = None,
Expand Down Expand Up @@ -594,6 +596,7 @@ def method_to_apr_proof(
setup_proof=setup_proof,
graft_setup_proof=((setup_proof is not None) and not setup_proof_is_constructor),
evm_chain_options=evm_chain_options,
no_stack_checks=no_stack_checks,
recorded_state_entries=recorded_state_entries,
active_symbolik=active_symbolik,
hevm=hevm,
Expand Down Expand Up @@ -637,6 +640,7 @@ def _method_to_initialized_cfg(
kcfg_explore: KCFGExplore,
config_type: ConfigType,
evm_chain_options: EVMChainOptions,
no_stack_checks: bool,
*,
setup_proof: APRProof | None = None,
graft_setup_proof: bool = False,
Expand All @@ -659,6 +663,7 @@ def _method_to_initialized_cfg(
recorded_state_entries,
active_symbolik,
config_type=config_type,
no_stack_checks=no_stack_checks,
hevm=hevm,
trace_options=trace_options,
)
Expand Down Expand Up @@ -692,6 +697,7 @@ def _method_to_cfg(
recorded_state_entries: Iterable[StateDiffEntry] | Iterable[StateDumpEntry] | None,
active_symbolik: bool,
config_type: ConfigType,
no_stack_checks: bool,
hevm: bool = False,
trace_options: TraceOptions | None = None,
) -> tuple[KCFG, list[int], int, int, Iterable[int]]:
Expand Down Expand Up @@ -729,6 +735,7 @@ def _method_to_cfg(
trace_options=trace_options,
config_type=config_type,
additional_accounts=external_libs,
no_stack_checks=no_stack_checks,
)
new_node_ids = []
bounded_node_ids = []
Expand Down Expand Up @@ -983,6 +990,7 @@ def _init_cterm(
active_symbolik: bool,
evm_chain_options: EVMChainOptions,
additional_accounts: list[KInner],
no_stack_checks: bool,
*,
calldata: KInner | None = None,
callvalue: KInner | None = None,
Expand All @@ -999,6 +1007,7 @@ def _init_cterm(
init_subst = {
'MODE_CELL': KApply(evm_chain_options.mode),
'USEGAS_CELL': boolToken(evm_chain_options.usegas),
'STACKCHECKS_CELL': boolToken(not no_stack_checks),
'SCHEDULE_CELL': schedule,
'CHAINID_CELL': intToken(evm_chain_options.chainid),
'STATUSCODE_CELL': KVariable('STATUSCODE'),
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -217,6 +217,9 @@ module SUMMARY-TEST%ACCOUNTPARAMSTEST.TESTDEALCONCRETE():0
</ethereum>
...
</kevm>
<stackChecks>
true
</stackChecks>
<cheatcodes>
<prank>
<active>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -175,6 +175,9 @@ module SUMMARY-SRC%CSE%ADDCONST.APPLYOP(UINT256):0
</ethereum>
...
</kevm>
<stackChecks>
true
</stackChecks>
<cheatcodes>
<expectedOpcode>
<isOpcodeExpected>
Expand Down Expand Up @@ -351,6 +354,9 @@ module SUMMARY-SRC%CSE%ADDCONST.APPLYOP(UINT256):0
</ethereum>
...
</kevm>
<stackChecks>
true
</stackChecks>
<cheatcodes>
<expectedOpcode>
<isOpcodeExpected>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -177,6 +177,9 @@ module SUMMARY-TEST%ADDRTEST.TEST-ADDR-TRUE():0
</ethereum>
...
</kevm>
<stackChecks>
true
</stackChecks>
<cheatcodes>
<prank>
<active>
Expand Down
Loading
Loading