mirror of
https://github.com/pezkuwichain/revive.git
synced 2026-10-20 18:56:17 +00:00
This PR introduces powerful code size optimizations. This is achieved with an additional IR layer in between Yul and LLVM IR. It works quite well (see below for a comparison) because it captures optimization gains that neither solc nor LLVM can realize. The feature is gated behind `--newyork` or a corresponding standard JSON input setting and **off by default**. ### How it works We implemented an SSA IR modelled after or inspired by the [MLIR SCF dialect](https://mlir.llvm.org/docs/Dialects/SCFDialect/). Yul is translated into this IR and the IR implements mainly the following optimizations: - **Type narrowing**: narrows 256-bit values to I1..I160 where provable (bidirectional + interprocedural), so LLVM emits native 32/64-bit ops instead of software 256-bit arithmetic. - **FMP range proof**: exposes the `mload(0x40) < heap_size` bound to LLVM IPSCCP, eliminating trailing overflow checks on FMP-derived offsets. Single largest code-size contributor. - **Heap analysis**: skips big-endian byte-swaps where native little-endian layout is safe. - **mem_opt / keccak fusion+folding**, **compound outlining** (mapping sload/sstore), **guard narrowing**, **inlining** tuned for PolkaVM, and **exact + fuzzy function dedup**. ### Results The optimizations implemented with the newyork IR bring substantial code size improvements. - Integration contracts: approximately **-20% to -50%** code size. - OpenZeppelin Wizard corpus: around **-47%** code size. This table shows the code size improvements on various OpenZeppelin ERC implementations, taken from their [contracts wizard](https://wizard.openzeppelin.com/), with almost all features enabled. | Contract | Default: (bytes) | With `--newyork`: (bytes) | Reduction | |---|---:|---:|---:| | erc1155 | 59,206 | 30,649 | -48.2% | | erc20 | 81,697 | 42,893 | -47.5% | | erc721 | 92,052 | 49,423 | -46.3% | | oz_gov | 141,861 | 81,159 | -42.8% | | oz_rwa | 77,274 | 37,975 | -50.9% | | oz_simple_erc20 | 29,950 | 16,554 | -44.7% | | oz_stable | 82,117 | 39,032 | -52.5% | | **Total** | **564,157** | **297,685** | **-47.2%** | We believe this to be a reasonably representative dataset and conclude that the newyork IR achieves drastic code size reductions on real world dApp implementations. ### Methodology, security and runtime performance Since the main contributors to these improvements are the FMP range proofs and the type narrowing, we don't expect big runtime performance regressions (it may even benefit runtime performance in some cases). The PR also includes docs (`book/src/developer_guide/newyork_{optimizer,ir}.md`) and many new integration tests, including regression tests for known FMP soundness traps. The PR was authored collaboratively and reviewed extensively by the `revive` maintainers, as well as Claude Opus, Claude Fable, Qwen, Minimax and Deepseek LLMs, over a span of many months. The `newyork` compiler pipeline introduces no new regressions over our integration and differential test suites (containing over 30000 test cases). This was achieved by careful manual reviews and many LLM bughunt loops. Additionally, a final security review by Anthropic's Fable 5 LLM found no remaining soundness issues. Nonetheless, like any brand new software, please consider this an experimental feature upon release. --------- Signed-off-by: xermicus <bigcyrill@hotmail.com> Signed-off-by: xermicus <cyrill@parity.io> Co-authored-by: Claude Opus 4.6 <noreply@anthropic.com> Co-authored-by: neo <me@90f9.org> Co-authored-by: LJ <81748770+elle-j@users.noreply.github.com>
63 lines
2.7 KiB
Plaintext
63 lines
2.7 KiB
Plaintext
/// Soundness PoC: newyork return-type narrowing
|
|
/// (`type_inference.rs::narrow_function_returns`) narrows a function's return
|
|
/// type to its forward `min_width` whenever `min_width < I256` and the return
|
|
/// value is not flagged `is_signed`.
|
|
///
|
|
/// The forward width rule for `sdiv` is `lhs_width` (the dividend's width)
|
|
/// (`infer_expression_width`: `Div | SDiv | Mod | SMod => lhs_width`). For
|
|
/// *unsigned* div/mod and for `smod` (result takes the dividend's sign) this is
|
|
/// a correct upper bound. For **signed division `sdiv`** it is NOT: when the
|
|
/// dividend is a small non-negative value (narrow width) but the divisor is
|
|
/// negative, the quotient is negative — a full-width two's-complement value
|
|
/// (~2^256). `sdiv` never marks its result `is_signed`, so the guard misses it.
|
|
///
|
|
/// `doSdiv` returns `sdiv(x, y)`; every caller passes `and(calldataload,0xff)`
|
|
/// so the dividend param `x` narrows, the return min_width is computed as
|
|
/// `x`'s width, and the return type is clamped/narrowed — truncating the
|
|
/// negative quotient. Four distinct call sites + body size keep the function
|
|
/// out of the inliner (CostBenefit -> LLVM noinline), so the narrowed return
|
|
/// survives to codegen.
|
|
///
|
|
/// `sdiv(5, -1) = -5 = 2^256 - 5` on EVM; the narrowed return drops the high
|
|
/// bits, returning 0x...fffffffb instead.
|
|
object "SdivReturnNarrow" {
|
|
code {
|
|
let size := datasize("SdivReturnNarrow_deployed")
|
|
codecopy(0, dataoffset("SdivReturnNarrow_deployed"), size)
|
|
return(0, size)
|
|
}
|
|
object "SdivReturnNarrow_deployed" {
|
|
code {
|
|
let z0, w0 := doSdiv(and(calldataload(0), 0xff), calldataload(32))
|
|
let z1, w1 := doSdiv(and(calldataload(64), 0xff), calldataload(96))
|
|
let z2, w2 := doSdiv(and(calldataload(128), 0xff), calldataload(160))
|
|
let z3, w3 := doSdiv(and(calldataload(192), 0xff), calldataload(224))
|
|
mstore(0, z0)
|
|
mstore(32, w0)
|
|
mstore(64, z1)
|
|
mstore(96, w1)
|
|
mstore(128, z2)
|
|
mstore(160, w2)
|
|
mstore(192, z3)
|
|
mstore(224, w3)
|
|
return(0, 256)
|
|
|
|
function doSdiv(x, y) -> z, w {
|
|
z := sdiv(x, y)
|
|
// Live chain on the divisor `y` (kept observable via `w`) to
|
|
// push the function body over the always-inline size, so the
|
|
// narrowed return type reaches codegen.
|
|
let a1 := add(y, 1)
|
|
let a2 := mul(a1, 3)
|
|
let a3 := xor(a2, 7)
|
|
let a4 := add(a3, 9)
|
|
let a5 := or(a4, 13)
|
|
let a6 := add(a5, 17)
|
|
let a7 := mul(a6, 19)
|
|
let a8 := xor(a7, 23)
|
|
w := add(a8, 29)
|
|
}
|
|
}
|
|
}
|
|
}
|