mirror of
https://github.com/pezkuwichain/revive.git
synced 2026-10-20 18:56:17 +00:00
98d818f958
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>
124 lines
3.1 KiB
Makefile
124 lines
3.1 KiB
Makefile
.PHONY: \
|
|
install \
|
|
install-bin \
|
|
install-npm \
|
|
install-wasm \
|
|
install-llvm-builder \
|
|
install-llvm \
|
|
install-revive-runner \
|
|
format \
|
|
clippy \
|
|
doc \
|
|
book \
|
|
machete \
|
|
test \
|
|
test-integration \
|
|
test-resolc \
|
|
test-yul \
|
|
test-workspace \
|
|
test-wasm \
|
|
test-llvm-builder \
|
|
test-book \
|
|
bench \
|
|
bench-pvm \
|
|
bench-evm \
|
|
bench-resolc \
|
|
bench-yul \
|
|
clean
|
|
|
|
install: install-bin install-npm
|
|
|
|
install-bin:
|
|
cargo install --force --locked --path crates/resolc
|
|
|
|
install-npm:
|
|
npm install && npm fund
|
|
|
|
install-wasm: install-npm
|
|
cargo build --target wasm32-unknown-emscripten -p resolc --release --no-default-features
|
|
npm run build:package
|
|
|
|
install-llvm-builder:
|
|
cargo install --force --locked --path crates/llvm-builder
|
|
|
|
install-llvm: install-llvm-builder
|
|
git submodule update --init --recursive --depth 1
|
|
revive-llvm build --llvm-projects lld --llvm-projects clang
|
|
|
|
install-revive-runner:
|
|
cargo install --locked --force --path crates/runner --no-default-features
|
|
|
|
format:
|
|
cargo fmt --all --check
|
|
|
|
clippy:
|
|
cargo clippy --all-features --workspace --tests --benches -- --deny warnings
|
|
|
|
doc:
|
|
cargo doc --all-features --workspace --document-private-items --no-deps
|
|
|
|
book: test-book
|
|
mdbook serve book --open
|
|
|
|
machete:
|
|
cargo install cargo-machete
|
|
cargo machete
|
|
|
|
test: format clippy machete test-workspace install-revive-runner doc test-book
|
|
|
|
test-integration: install-bin
|
|
cargo test --package revive-integration
|
|
cargo test --package revive-integration --features newyork
|
|
|
|
test-resolc: install
|
|
cargo test --package resolc --all-targets
|
|
|
|
test-yul:
|
|
cargo test --package revive-yul --all-targets
|
|
|
|
test-workspace: install
|
|
cargo test --workspace --all-targets --exclude revive-llvm-builder
|
|
cargo test --package revive-integration --features newyork
|
|
|
|
test-wasm: install-wasm
|
|
npm run test:wasm
|
|
|
|
test-llvm-builder:
|
|
@echo "warning: the llvm-builder tests will take many hours"
|
|
cargo test --package revive-llvm-builder -- --test-threads=1
|
|
|
|
test-book:
|
|
cargo install mdbook --version 0.5.1 --locked
|
|
mdbook test book
|
|
|
|
bench: install-bin
|
|
cargo criterion --all --all-features --message-format=json \
|
|
| criterion-table > crates/benchmarks/BENCHMARKS.md
|
|
|
|
bench-pvm: install-bin
|
|
cargo criterion --bench execute --features bench-pvm-interpreter --message-format=json \
|
|
| criterion-table > crates/benchmarks/PVM.md
|
|
|
|
bench-evm: install-bin
|
|
cargo criterion --bench execute --features bench-evm --message-format=json \
|
|
| criterion-table > crates/benchmarks/EVM.md
|
|
|
|
bench-resolc: test-resolc
|
|
cargo criterion --package resolc --bench compile --message-format=json \
|
|
| criterion-table > crates/resolc/BENCHMARKS_M4PRO.md
|
|
|
|
bench-yul: test-yul
|
|
cargo criterion --package revive-benchmarks --bench parse --message-format=json \
|
|
| criterion-table > crates/benchmarks/BENCHMARKS_PARSE_M4PRO.md
|
|
cargo criterion --package revive-benchmarks --bench lower --message-format=json \
|
|
| criterion-table > crates/benchmarks/BENCHMARKS_LOWER_M4PRO.md
|
|
|
|
clean:
|
|
cargo clean ; \
|
|
revive-llvm clean ; \
|
|
rm -rf node_modules ; \
|
|
rm -rf crates/resolc/src/tests/cli/artifacts ; \
|
|
cargo uninstall resolc ; \
|
|
cargo uninstall revive-llvm-builder ;
|
|
mdbook clean book
|