Files
revive/crates/integration/contracts/ParamCondNarrow.yul
T
98d818f958 The new Yul optimizer toolkit (#519)
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>
2026-06-17 12:35:16 +02:00

60 lines
2.6 KiB
Plaintext

/// Soundness PoC: newyork parameter narrowing
/// (`type_inference.rs::narrow_function_params`) narrows a parameter to I64/I32
/// whenever its `max_width` is lowered below I256 by a use that re-validates the
/// value (a memory offset bounded by `safe_truncate_int_to_xlen`). The call
/// boundary then emits a *checked* truncation that traps on an out-of-range
/// argument (`to_llvm.rs::checked_truncate_to`).
///
/// The bug: `max_width` was lowered by ANY narrowing use, including one reached
/// only on a conditional path. `store_if(p, c)` uses `p` as a memory offset only
/// inside `if c`. EVM skips the store (and never touches `p`) when `c == 0`, so a
/// `p >= 2^64` argument is harmless. But the narrowed `i64` signature truncates
/// `p` unconditionally at every call site, trapping before `c` is even tested.
///
/// Every caller passes a `calldataload`-derived `p` (forward width I256, so the
/// caller-driven narrowing path cannot narrow it) and four distinct call sites
/// plus the body's arithmetic chain keep `store_if` out of the inliner, so the
/// narrowed parameter reaches codegen.
///
/// Called with `c == 0` and `p == 2^64`: EVM returns `4` (each `store_if`
/// returns its else-path value); the buggy narrowing traps at the first call.
object "ParamCondNarrow" {
code {
let size := datasize("ParamCondNarrow_deployed")
codecopy(0, dataoffset("ParamCondNarrow_deployed"), size)
return(0, size)
}
object "ParamCondNarrow_deployed" {
code {
let c := calldataload(0)
let acc := 0
acc := add(acc, store_if(calldataload(32), c))
acc := add(acc, store_if(calldataload(64), c))
acc := add(acc, store_if(calldataload(96), c))
acc := add(acc, store_if(calldataload(128), c))
mstore(0, acc)
return(0, 32)
function store_if(p, g) -> r {
r := 1
if g {
// `p` is used as a memory offset only on this conditional path.
mstore(p, 0x42)
r := mload(p)
}
// Live arithmetic chain on the condition keeps the body over the
// always-inline size so the narrowed parameter reaches codegen.
let a1 := add(g, 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)
r := add(r, a8)
}
}
}
}