Compare commits

..

3 Commits

Author SHA1 Message Date
pgherveou 963d167fb2 Fix Set version to remove leading v 2025-05-08 12:35:31 +02:00
pgherveou df963d2795 add optimizer options: 2025-05-08 12:23:51 +02:00
pgherveou 8b1a36eddf Run lint:fix 2025-05-08 12:20:38 +02:00
162 changed files with 3475 additions and 5752 deletions
+1 -1
View File
@@ -3,7 +3,7 @@ inputs:
version: version:
description: "" description: ""
required: false required: false
default: "4.0.9" default: "3.1.64"
runs: runs:
+1 -1
View File
@@ -19,7 +19,7 @@ runs:
shell: bash shell: bash
run: | run: |
mkdir -p solc mkdir -p solc
curl -sSL --output solc/solc https://github.com/ethereum/solidity/releases/download/v0.8.30/${SOLC_NAME} curl -sSL --output solc/solc https://github.com/ethereum/solidity/releases/download/v0.8.29/${SOLC_NAME}
- name: Make Solc Executable - name: Make Solc Executable
if: ${{ runner.os == 'Windows' }} if: ${{ runner.os == 'Windows' }}
+1 -1
View File
@@ -94,7 +94,7 @@ jobs:
- name: Install LLVM Builder - name: Install LLVM Builder
run: | run: |
cargo install --locked --force --path crates/llvm-builder cargo install --path crates/llvm-builder
- name: Clone LLVM - name: Clone LLVM
run: | run: |
+10 -4
View File
@@ -14,7 +14,7 @@ concurrency:
env: env:
CARGO_TERM_COLOR: always CARGO_TERM_COLOR: always
RUST_MUSL_CROSS_IMAGE: messense/rust-musl-cross@sha256:c0154e992adb791c3b848dd008939d19862549204f8cb26f5ca7a00f629e6067 RUST_MUSL_CROSS_IMAGE: messense/rust-musl-cross@sha256:68b86bc7cb2867259e6b233415a665ff4469c28b57763e78c3bfea1c68091561
jobs: jobs:
check-version-changed: check-version-changed:
@@ -44,7 +44,7 @@ jobs:
exit 0 exit 0
fi fi
export PKG_VER=v$(cat crates/resolc/Cargo.toml | grep -A 5 package] | grep version | cut -d '=' -f 2 | tr -d '"' | tr -d " ") export PKG_VER=v$(cat Cargo.toml | grep -A 5 package] | grep version | cut -d '=' -f 2 | tr -d '"' | tr -d " ")
echo "Current tag $CURRENT_TAG" echo "Current tag $CURRENT_TAG"
echo "Package version $PKG_VER" echo "Package version $PKG_VER"
# #
@@ -143,7 +143,7 @@ jobs:
runs-on: ubuntu-24.04 runs-on: ubuntu-24.04
needs: [check-version-changed] needs: [check-version-changed]
env: env:
RELEASE_RESOLC_WASM_URI: https://github.com/paritytech/revive/releases/download/${{ github.ref_name }}/resolc.wasm RELEASE_RESOLC_WASM_URI: https://github.com/paritytech/revive-workflow-test/releases/download/${{ github.ref_name }}/resolc.wasm
steps: steps:
- uses: actions/checkout@v4 - uses: actions/checkout@v4
- uses: actions-rust-lang/setup-rust-toolchain@v1 - uses: actions-rust-lang/setup-rust-toolchain@v1
@@ -181,7 +181,7 @@ jobs:
- name: Basic Sanity Check - name: Basic Sanity Check
run: | run: |
mkdir -p solc mkdir -p solc
curl -sSLo solc/soljson.js https://github.com/ethereum/solidity/releases/download/v0.8.30/soljson.js curl -sSLo solc/soljson.js https://github.com/ethereum/solidity/releases/download/v0.8.29/soljson.js
node -e " node -e "
const soljson = require('solc/soljson'); const soljson = require('solc/soljson');
const createRevive = require('./target/wasm32-unknown-emscripten/release/resolc.js'); const createRevive = require('./target/wasm32-unknown-emscripten/release/resolc.js');
@@ -311,6 +311,12 @@ jobs:
cp -f resolc.{wasm,js} js/resolc/src/resolc cp -f resolc.{wasm,js} js/resolc/src/resolc
npm -w js/resolc run build npm -w js/resolc run build
- name: Set version
run: |
VERSION="${{ github.event.release.tag_name }}"
STRIPPED_VERSION="${VERSION#v}"
npm -w js/resolc version --no-git-tag-version "$STRIPPED_VERSION"
- name: npm pack - name: npm pack
run: npm -w js/resolc pack run: npm -w js/resolc pack
+4 -83
View File
@@ -4,74 +4,21 @@
This is a development pre-release. This is a development pre-release.
Supported `polkadot-sdk` rev: `2503.0.1` Supported `polkadot-sdk` rev:`c29e72a8628835e34deb6aa7db9a78a2e4eabcee`
## v0.3.0
This is a development pre-release.
Supported `polkadot-sdk` rev: `2503.0.1`
### Fixed
- llvm-context: Bugfix the SAR YUL builtin translation.
- runtime-api: Add the missing `memset` builtin.
- npm package: Bugfix the exports field defined in the `package.json`.
## v0.2.0
This is a development pre-release.
Supported `polkadot-sdk` rev: `2503.0.1`
### Changed
- Removed the license printer from the `resolc` binary.
- EVM bytecode is no longer requested from solc (except in test utils) leading to less compilation work in the pipeline.
### Fixed
- solc-json-interface: Serializing of any custom key in the JSON input is only skipped if not provided.
- npm package resolution no longer fails with an 'ERR_PACKAGE_PATH_NOT_EXPORTED' error for packages defining exports fields in the `package.json`.
## v0.1.0 ## v0.1.0
This is a development pre-release. This is a development pre-release.
Supported `polkadot-sdk` rev: `2503.0.1`
### Added
- Add the PolkaVM heap size, stack size and debug info CLI compiler options to the standard JSON settings. This makes the standard JSON input succint for reproducible builds.
### Changed
- Supported `polkadot-sdk` version is now `2503.0.1`
- The `emsdk` version is now `4.0.9`
### Fixed
## v0.1.0-dev.16
This is a development pre-release.
Supported `polkadot-sdk` rev:`c29e72a8628835e34deb6aa7db9a78a2e4eabcee` Supported `polkadot-sdk` rev:`c29e72a8628835e34deb6aa7db9a78a2e4eabcee`
### Added ### Added
- Move the npm package from paritytech/js-revive, into this repo. The package `@parity/resolc` will be deployed to npm for each release.
- Support for solc v0.8.30
### Changed ### Changed
- By default, heavy size optimizations are applied. - By default, heavy size optimizations are applied.
### Fixed ### Fixed
- @parity/resolc: The solc dependency package is constrained to the latest supported version, preventing breaking the package ever time a new solc package was released.
- The resolc npm package no longer ignores the optimizer settings
## v0.1.0-dev.14 ## v0.1.0-dev.14
This is a development pre-release. This is a development pre-release.
@@ -79,16 +26,13 @@ This is a development pre-release.
Supported `polkadot-sdk` rev:`c29e72a8628835e34deb6aa7db9a78a2e4eabcee` Supported `polkadot-sdk` rev:`c29e72a8628835e34deb6aa7db9a78a2e4eabcee`
### Added ### Added
- The `revive-runner` helper utility binary which helps to run contracts locally without a blockchain node.
- The `revive-runner` helper utility binary which helps to run contracts locally without a blockchain node.
- Allow configuration of the EVM heap memory size and stack size via CLI flags and JSON input settings. - Allow configuration of the EVM heap memory size and stack size via CLI flags and JSON input settings.
### Changed ### Changed
- The default PVM stack memory size was increased from 16kb to 32kb. - The default PVM stack memory size was increased from 16kb to 32kb.
### Fixed ### Fixed
- Constructors avoid storing zero sized immutable data on exit. - Constructors avoid storing zero sized immutable data on exit.
## v0.1.0-dev.13 ## v0.1.0-dev.13
@@ -98,19 +42,16 @@ This is a development pre-release.
Supported `polkadot-sdk` rev:`c29e72a8628835e34deb6aa7db9a78a2e4eabcee` Supported `polkadot-sdk` rev:`c29e72a8628835e34deb6aa7db9a78a2e4eabcee`
### Added ### Added
- Support for solc v0.8.29 - Support for solc v0.8.29
- Decouples the solc JSON-input-output type definitions from the Solidity fronted and expose them via a dedicated crate. - Decouples the solc JSON-input-output type definitions from the Solidity fronted and expose them via a dedicated crate.
- `--supported-solc-versions` for `resolc` binary to return a `semver` range of supported `solc` versions. - `--supported-solc-versions` for `resolc` binary to return a `semver` range of supported `solc` versions.
- Support for passing LLVM command line options via the prcoess input or providing one or more `--llvm-arg='..'` resolc CLI flag. This allows more fine-grained control over the LLVM backend configuration. - Support for passing LLVM command line options via the prcoess input or providing one or more `--llvm-arg='..'` resolc CLI flag. This allows more fine-grained control over the LLVM backend configuration.
### Changed ### Changed
- Storage keys and values are big endian. This was a pre-mature optimization because for the contract itself it this is a no-op and thus not observable. However we should consider the storage layout as part of the contract ABI. The endianness of transient storage values are still kept as-is. - Storage keys and values are big endian. This was a pre-mature optimization because for the contract itself it this is a no-op and thus not observable. However we should consider the storage layout as part of the contract ABI. The endianness of transient storage values are still kept as-is.
- Running `resolc` using webkit is no longer supported. - Running `resolc` using webkit is no longer supported.
### Fixed ### Fixed
- A missing byte swap for the create2 salt value. - A missing byte swap for the create2 salt value.
## v0.1.0-dev.12 ## v0.1.0-dev.12
@@ -120,12 +61,10 @@ This is a development pre-release.
Supported `polkadot-sdk` rev: `21f6f0705e53c15aa2b8a5706b208200447774a9` Supported `polkadot-sdk` rev: `21f6f0705e53c15aa2b8a5706b208200447774a9`
### Added ### Added
- Per file output selection for `--standard-json` mode. - Per file output selection for `--standard-json` mode.
- The `ir` output selection option for `--standard-json` mode. - The `ir` output selection option for `--standard-json` mode.
### Changed ### Changed
- Improved code size: Large contracts compile to smaller code blobs when enabling aggressive size optimizations (`-Oz`). - Improved code size: Large contracts compile to smaller code blobs when enabling aggressive size optimizations (`-Oz`).
### Fixed ### Fixed
@@ -141,7 +80,6 @@ Supported `polkadot-sdk` rev: `274a781e8ca1a9432c7ec87593bd93214abbff50`
### Changed ### Changed
### Fixed ### Fixed
- A bug causing incorrect loads from the emulated EVM linear memory. - A bug causing incorrect loads from the emulated EVM linear memory.
- A missing integer truncate after switching to 64bit. - A missing integer truncate after switching to 64bit.
@@ -152,12 +90,10 @@ This is a development pre-release.
Supported `polkadot-sdk` rev: `274a781e8ca1a9432c7ec87593bd93214abbff50` Supported `polkadot-sdk` rev: `274a781e8ca1a9432c7ec87593bd93214abbff50`
### Added ### Added
- Support for the `coinbase` opcode. - Support for the `coinbase` opcode.
- The resolc web JS version. - The resolc web JS version.
### Changed ### Changed
- Missing the `--overwrite` flag emits an error instead of a warning. - Missing the `--overwrite` flag emits an error instead of a warning.
- The `resolc` executable prints the help by default. - The `resolc` executable prints the help by default.
- Removed support for legacy EVM assembly (EVMLA) translation. - Removed support for legacy EVM assembly (EVMLA) translation.
@@ -167,7 +103,6 @@ Supported `polkadot-sdk` rev: `274a781e8ca1a9432c7ec87593bd93214abbff50`
If detected, the re-entrant call flag is not set and 0 deposit limit is endowed. If detected, the re-entrant call flag is not set and 0 deposit limit is endowed.
### Fixed ### Fixed
- Solidity: Add the solc `--libraries` files to sources. - Solidity: Add the solc `--libraries` files to sources.
- A data race in tests. - A data race in tests.
- Fix `broken pipe` errors. - Fix `broken pipe` errors.
@@ -181,11 +116,9 @@ This is a development pre-release.
### Added ### Added
### Changed ### Changed
- Syscalls with more than 6 arguments now pack them into registers. - Syscalls with more than 6 arguments now pack them into registers.
### Fixed ### Fixed
- Remove reloading of the resolc.js file (fix issue with relative path in web worker) - Remove reloading of the resolc.js file (fix issue with relative path in web worker)
## v0.1.0-dev.8 ## v0.1.0-dev.8
@@ -193,18 +126,15 @@ This is a development pre-release.
This is a development pre-release. This is a development pre-release.
### Added ### Added
- The `revive-llvm-builder` crate with the `revive-llvm` helper utility for streamlined management of the LLVM framework dependency. - The `revive-llvm-builder` crate with the `revive-llvm` helper utility for streamlined management of the LLVM framework dependency.
- Initial support for running `resolc` in the browser. - Initial support for running `resolc` in the browser.
### Changed ### Changed
- Suported contracts runtime is polkadot-sdk git version `d62a90c8c729acd98c7e9a5cab9803b8b211ffc5`. - Suported contracts runtime is polkadot-sdk git version `d62a90c8c729acd98c7e9a5cab9803b8b211ffc5`.
- The minimum supported Rust version is `1.81.0`. - The minimum supported Rust version is `1.81.0`.
- Error out early instead of invoking `solc` with invalid base or include path flags. - Error out early instead of invoking `solc` with invalid base or include path flags.
### Fixed ### Fixed
- Decouple the LLVM target dependency from the LLVM host dependency. - Decouple the LLVM target dependency from the LLVM host dependency.
- Do not error out if no files and no errors were produced. This aligns resolc closer to solc. - Do not error out if no files and no errors were produced. This aligns resolc closer to solc.
- Fixes input normalization in the Wasm version. - Fixes input normalization in the Wasm version.
@@ -214,20 +144,17 @@ This is a development pre-release.
This is a development pre-release. This is a development pre-release.
### Added ### Added
- Implement the `GASPRICE` opcode. - Implement the `GASPRICE` opcode.
- Implement the `BASEFEE` opcode. - Implement the `BASEFEE` opcode.
- Implement the `GASLIMIT` opcode. - Implement the `GASLIMIT` opcode.
### Changed ### Changed
- The `GAS` opcode now returns the remaining `ref_time`. - The `GAS` opcode now returns the remaining `ref_time`.
- Contracts can now be supplied call data input of arbitrary size. - Contracts can now be supplied call data input of arbitrary size.
- Some syscalls now return the value in a register, slightly improving emitted contract code. - Some syscalls now return the value in a register, slightly improving emitted contract code.
- Calls forward maximum weight limits instead of 0, anticipating a change in polkadot-sdk where weight limits of 0 no longer interprets as uncapped limit. - Calls forward maximum weight limits instead of 0, anticipating a change in polkadot-sdk where weight limits of 0 no longer interprets as uncapped limit.
### Fixed ### Fixed
- A linker bug which was preventing certain contracts from linking with the PVM linker. - A linker bug which was preventing certain contracts from linking with the PVM linker.
- JS: Fix encoding conversion from JS string (UTF-16) to UTF-8. - JS: Fix encoding conversion from JS string (UTF-16) to UTF-8.
- The git commit hash slug is always displayed in the version string. - The git commit hash slug is always displayed in the version string.
@@ -237,7 +164,6 @@ This is a development pre-release.
This is a development pre-release. This is a development pre-release.
# Added # Added
- Implement the `BLOCKHASH` opcode. - Implement the `BLOCKHASH` opcode.
- Implement delegate calls. - Implement delegate calls.
- Implement the `GASPRICE` opcode. Currently hard-coded to return `1`. - Implement the `GASPRICE` opcode. Currently hard-coded to return `1`.
@@ -245,24 +171,21 @@ This is a development pre-release.
- Initial support for emitting debug info (opt in via the `-g` flag) - Initial support for emitting debug info (opt in via the `-g` flag)
# Changed # Changed
- resolc now emits 64bit PolkaVM blobs, reducing contract code size and execution time. - resolc now emits 64bit PolkaVM blobs, reducing contract code size and execution time.
- The RISC-V bit-manipulation target feature (`zbb`) is enabled. - The RISC-V bit-manipulation target feature (`zbb`) is enabled.
# Fixed # Fixed
- Compilation to Wasm (for usage in node and web browsers) - Compilation to Wasm (for usage in node and web browsers)
## v0.1.0-dev.5 ## v0.1.0-dev.5
This is development pre-release. This is development pre-release.
# Added # Added
- Implement the `CODESIZE` and `EXTCODESIZE` opcodes. - Implement the `CODESIZE` and `EXTCODESIZE` opcodes.
# Changed # Changed
- Include the full revive version in the contract metadata. - Include the full revive version in the contract metadata.
# Fixed # Fixed
@@ -272,11 +195,9 @@ This is development pre-release.
This is development pre-release. This is development pre-release.
# Added # Added
- Support the `ORIGIN` opcode. - Support the `ORIGIN` opcode.
# Changed # Changed
- Update polkavm to `v0.14.0`. - Update polkavm to `v0.14.0`.
- Enable the `a`, `fast-unaligned-access` and `xtheadcondmov` LLVM target features, decreasing the code size for some contracts. - Enable the `a`, `fast-unaligned-access` and `xtheadcondmov` LLVM target features, decreasing the code size for some contracts.
Generated
+2225 -2067
View File
File diff suppressed because it is too large Load Diff
+41 -41
View File
@@ -3,7 +3,7 @@ resolver = "2"
members = ["crates/*"] members = ["crates/*"]
[workspace.package] [workspace.package]
version = "0.1.0" version = "0.1.0-dev.14"
authors = [ authors = [
"Cyrill Leutwiler <cyrill@parity.io>", "Cyrill Leutwiler <cyrill@parity.io>",
"Parity Technologies <admin@parity.io>", "Parity Technologies <admin@parity.io>",
@@ -11,60 +11,59 @@ authors = [
license = "MIT/Apache-2.0" license = "MIT/Apache-2.0"
edition = "2021" edition = "2021"
repository = "https://github.com/paritytech/revive" repository = "https://github.com/paritytech/revive"
rust-version = "1.85.0" rust-version = "1.81.0"
[workspace.dependencies] [workspace.dependencies]
resolc = { version = "0.3.0", path = "crates/resolc" } revive-benchmarks = { version = "0.1.0-dev.14", path = "crates/benchmarks" }
revive-benchmarks = { version = "0.1.0", path = "crates/benchmarks" } revive-builtins = { version = "0.1.0-dev.14", path = "crates/builtins" }
revive-builtins = { version = "0.1.0", path = "crates/builtins" } revive-common = { version = "0.1.0-dev.14", path = "crates/common" }
revive-common = { version = "0.1.0", path = "crates/common" } revive-differential = { version = "0.1.0-dev.14", path = "crates/differential" }
revive-differential = { version = "0.1.0", path = "crates/differential" } revive-integration = { version = "0.1.0-dev.14", path = "crates/integration" }
revive-integration = { version = "0.1.1", path = "crates/integration" } revive-linker = { version = "0.1.0-dev.14", path = "crates/linker" }
revive-linker = { version = "0.1.0", path = "crates/linker" } lld-sys = { version = "0.1.0-dev.14", path = "crates/lld-sys" }
lld-sys = { version = "0.1.0", path = "crates/lld-sys" } revive-llvm-context = { version = "0.1.0-dev.14", path = "crates/llvm-context" }
revive-llvm-context = { version = "0.3.0", path = "crates/llvm-context" } revive-runtime-api = { version = "0.1.0-dev.14", path = "crates/runtime-api" }
revive-runtime-api = { version = "0.2.0", path = "crates/runtime-api" } revive-runner = { version = "0.1.0-dev.14", path = "crates/runner" }
revive-runner = { version = "0.1.0", path = "crates/runner" } revive-solc-json-interface = { version = "0.1.0-dev.14", path = "crates/solc-json-interface" }
revive-solc-json-interface = { version = "0.2.0", path = "crates/solc-json-interface" } revive-solidity = { version = "0.1.0-dev.14", path = "crates/solidity" }
revive-stdlib = { version = "0.1.1", path = "crates/stdlib" } revive-stdlib = { version = "0.1.0-dev.14", path = "crates/stdlib" }
revive-build-utils = { version = "0.1.0", path = "crates/build-utils" } revive-build-utils = { version = "0.1.0-dev.14", path = "crates/build-utils" }
revive-yul = { version = "0.2.1", path = "crates/yul" }
hex = "0.4.3" hex = "0.4.3"
cc = "1.2" cc = "1.2"
libc = "0.2.172" libc = "0.2.169"
tempfile = "3.20" tempfile = "3.17"
anyhow = "1.0" anyhow = "1.0"
semver = { version = "1.0", features = ["serde"] } semver = { version = "1.0", features = ["serde"] }
itertools = "0.14" itertools = "0.14"
serde = { version = "1.0", features = ["derive"] } serde = { version = "1.0", features = ["derive"] }
serde_json = { version = "1.0", features = ["arbitrary_precision"] } serde_json = { version = "1.0", features = ["arbitrary_precision"] }
regex = "1.11" regex = "1.10"
once_cell = "1.21" once_cell = "1.20"
num = "0.4.3" num = "0.4.3"
sha1 = "0.10" sha1 = "0.10"
sha3 = "0.10" sha3 = "0.10"
thiserror = "2.0" thiserror = "2.0"
which = "7.0" which = "7.0"
path-slash = "0.2" path-slash = "0.2"
rayon = "1.10" rayon = "1.8"
clap = { version = "4", default-features = false, features = ["derive"] } clap = { version = "4", default-features = false, features = ["derive"] }
polkavm-common = "0.24.0" polkavm-common = "0.21.0"
polkavm-linker = "0.24.0" polkavm-linker = "0.21.0"
polkavm-disassembler = "0.24.0" polkavm-disassembler = "0.21.0"
polkavm = "0.24.0" polkavm = "0.21.0"
alloy-primitives = { version = "1.1", features = ["serde"] } alloy-primitives = { version = "0.8.21", features = ["serde"] }
alloy-sol-types = "1.1" alloy-sol-types = "0.8.21"
alloy-genesis = "1.0" alloy-genesis = "0.11.1"
alloy-serde = "1.0" alloy-serde = "0.11.1"
env_logger = { version = "0.11.8", default-features = false } env_logger = { version = "0.11.6", default-features = false }
serde_stacker = "0.1.12" serde_stacker = "0.1.11"
criterion = { version = "0.6", features = ["html_reports"] } criterion = { version = "0.5.1", features = ["html_reports"] }
log = { version = "0.4.27" } log = { version = "0.4.25" }
git2 = { version = "0.20.2", default-features = false } git2 = { version = "0.20.0", default-features = false }
downloader = "0.2.8" downloader = "0.2.8"
flate2 = "1.1" flate2 = "1.0.35"
fs_extra = "1.3" fs_extra = "1.3.0"
num_cpus = "1" num_cpus = "1"
tar = "0.4" tar = "0.4"
toml = "0.8" toml = "0.8"
@@ -72,15 +71,16 @@ assert_cmd = "2.0"
assert_fs = "1.1" assert_fs = "1.1"
# polkadot-sdk and friends # polkadot-sdk and friends
codec = { version = "3.7.5", default-features = false, package = "parity-scale-codec" } codec = { version = "3.6.12", default-features = false, package = "parity-scale-codec" }
scale-info = { version = "2.11.6", default-features = false } scale-info = { version = "2.11.6", default-features = false }
polkadot-sdk = { version = "2503.0.1" } polkadot-sdk = { git = "https://github.com/paritytech/polkadot-sdk", rev = "c29e72a8628835e34deb6aa7db9a78a2e4eabcee" }
# llvm # llvm
[workspace.dependencies.inkwell] [workspace.dependencies.inkwell]
version = "0.6.0" git = "https://github.com/TheDan64/inkwell.git"
rev = "7b410298b6a93450adaa90b1841d5805a3038f12"
default-features = false default-features = false
features = ["serde", "llvm18-1", "no-libffi-linking", "target-riscv"] features = ["serde", "llvm18-0", "no-libffi-linking", "target-riscv"]
[profile.bench] [profile.bench]
inherits = "release" inherits = "release"
+2 -2
View File
@@ -1,4 +1,4 @@
FROM rust:1.85.0 AS llvm-builder FROM rust:1.84.0 AS llvm-builder
WORKDIR /opt/revive WORKDIR /opt/revive
RUN apt update && \ RUN apt update && \
@@ -11,7 +11,7 @@ RUN make install-llvm-builder
RUN revive-llvm --target-env musl clone RUN revive-llvm --target-env musl clone
RUN revive-llvm --target-env musl build --llvm-projects lld --llvm-projects clang RUN revive-llvm --target-env musl build --llvm-projects lld --llvm-projects clang
FROM messense/rust-musl-cross@sha256:c0154e992adb791c3b848dd008939d19862549204f8cb26f5ca7a00f629e6067 AS resolc-builder FROM messense/rust-musl-cross@sha256:68b86bc7cb2867259e6b233415a665ff4469c28b57763e78c3bfea1c68091561 AS resolc-builder
WORKDIR /opt/revive WORKDIR /opt/revive
RUN apt update && \ RUN apt update && \
+9 -9
View File
@@ -11,7 +11,7 @@
machete \ machete \
test \ test \
test-integration \ test-integration \
test-resolc \ test-solidity \
test-workspace \ test-workspace \
test-cli \ test-cli \
test-wasm \ test-wasm \
@@ -24,24 +24,24 @@
install: install-bin install-npm install: install-bin install-npm
install-bin: install-bin:
cargo install --force --locked --path crates/resolc cargo install --locked --path crates/solidity
install-npm: install-npm:
npm install && npm fund npm install && npm fund
install-wasm: install-npm install-wasm: install-npm
cargo build --target wasm32-unknown-emscripten -p resolc --release --no-default-features cargo build --target wasm32-unknown-emscripten -p revive-solidity --release --no-default-features
npm run build:package npm run build:package
install-llvm-builder: install-llvm-builder:
cargo install --force --locked --path crates/llvm-builder cargo install --path crates/llvm-builder
install-llvm: install-llvm-builder install-llvm: install-llvm-builder
revive-llvm clone revive-llvm clone
revive-llvm build --llvm-projects lld --llvm-projects clang revive-llvm build --llvm-projects lld --llvm-projects clang
install-revive-runner: install-revive-runner:
cargo install --locked --force --path crates/runner --no-default-features cargo install --path crates/runner --no-default-features --locked
format: format:
cargo fmt --all --check cargo fmt --all --check
@@ -58,8 +58,8 @@ test: format clippy machete test-cli test-workspace install-revive-runner
test-integration: install-bin test-integration: install-bin
cargo test --package revive-integration cargo test --package revive-integration
test-resolc: install test-solidity: install
cargo test --package resolc cargo test --package revive-solidity
test-workspace: install test-workspace: install
cargo test --workspace --exclude revive-llvm-builder cargo test --workspace --exclude revive-llvm-builder
@@ -90,6 +90,6 @@ clean:
cargo clean ; \ cargo clean ; \
revive-llvm clean ; \ revive-llvm clean ; \
rm -rf node_modules ; \ rm -rf node_modules ; \
rm -rf crates/resolc/src/tests/cli-tests/artifacts ; \ rm -rf crates/solidity/src/tests/cli-tests/artifacts ; \
cargo uninstall resolc ; \ cargo uninstall revive-solidity ; \
cargo uninstall revive-llvm-builder ; cargo uninstall revive-llvm-builder ;
+3 -38
View File
@@ -14,39 +14,7 @@ This is experimental software in active development and not ready just yet for p
Discussion around the development is hosted on the [Polkadot Forum](https://forum.polkadot.network/t/contracts-update-solidity-on-polkavm/6949#a-new-solidity-compiler-1). Discussion around the development is hosted on the [Polkadot Forum](https://forum.polkadot.network/t/contracts-update-solidity-on-polkavm/6949#a-new-solidity-compiler-1).
## Installation ## Installation
Building Solidity contracts for PolkaVM requires installing the following two compilers: Please consult [the documentation](https://contracts.polkadot.io/revive_compiler/installation) for installation instructions.
- `resolc`: The revive Solidity compiler YUL frontend and PolkaVM code generator (provided by this repository).
- `solc`: The [Ethereum Solidity reference compiler](https://github.com/ethereum/solidity/) implemenation.`resolc` uses `solc` during the compilation process, please refer to the [Ethereum Solidity documentation](https://docs.soliditylang.org/en/latest/installing-solidity.html) for installation instructions.
### `resolc` binary releases
`resolc` is distributed as a standalone binary (with `solc` as the only external dependency). Please download one of our [binary releases](https://github.com/paritytech/revive/releases) for your target platform and mind the platform specific instructions below.
<details>
<summary>MacOS users</summary>
> **MacOS** users need to clear the `downloaded` attribute from the binary and set the executable flag.
> ```sh
> xattr -rc resolc-universal-apple-darwin
> chmod +x resolc-universal-apple-darwin
> ```
</details>
<details>
<summary>Linux users</summary>
> **Linux** users need to set the executable flag.
> ```sh
> chmod +x resolc-x86_64-unknown-linux-musl
> ```
</details>
### `resolc` NPM package
We distribute the revive compiler as [node.js module](https://www.npmjs.com/package/@parity/resolc) and [hardhat plugin](https://www.npmjs.com/package/@parity/hardhat-polkadot-resolc).
Note: The `solc` dependency is bundled via NPM packaging and defaults to the latest supported version.
## Building from source ## Building from source
@@ -131,6 +99,8 @@ Ensure that your branch passes `make test` locally when submitting a pull reques
### Design overview ### Design overview
See the [relevant section in our documentation](https://contracts.polkadot.io/revive_compiler/architecture) to learn more about how the compiler works. See the [relevant section in our documentation](https://contracts.polkadot.io/revive_compiler/architecture) to learn more about how the compiler works.
[Frontend](https://github.com/matter-labs/era-compiler-solidity) and [code generator](https://github.com/matter-labs/era-compiler-llvm-context) are based of ZKSync `zksolc` (the project started as a fork of the era compiler).
### Tests ### Tests
Before running the tests, ensure that Geth (Go Ethereum) is installed on your system. Follow the installation guide here: [Installing Geth](https://geth.ethereum.org/docs/getting-started/installing-geth). Before running the tests, ensure that Geth (Go Ethereum) is installed on your system. Follow the installation guide here: [Installing Geth](https://geth.ethereum.org/docs/getting-started/installing-geth).
@@ -139,8 +109,3 @@ Once Geth is installed, you can run the tests using the following command:
```sh ```sh
make test make test
``` ```
# Acknowledgements
The revive compiler project, after some early experiments with EVM bytecode translations, decided to fork the `era-compiler` framework.
[Frontend](https://github.com/matter-labs/era-compiler-solidity), [code generator](https://github.com/matter-labs/era-compiler-llvm-context) and some supporting libraries are based of ZKSync `zksolc`. I'd like to express my gratitude and thank the original authors for providing a useable code base under a generous license.
+3 -11
View File
@@ -4,23 +4,15 @@ Prior to the first stable release we neither have formal release processes nor d
To create a new pre-release: To create a new pre-release:
1. Create a release PR which, if necessary: 1. Create a release PR which updates the `-dev.X` versions in the workspace `Cargo.toml` and updates the `CHANGELOG.md` accordingly.
- Updates the versions in the workspace `Cargo.toml`
- Updates the version in each crate `Cargo.toml`
- Updates the version of the NPM package in `js/resolc/package.json`
- Updates the `CHANGELOG.md` to reflect all observable changes
2. If the CI passes, merge the release PR. 2. If the CI passes, merge the release PR.
3. Push a `vX.Y.Z` tag that has the same version as in `Cargo.toml` 3. Push a tag that has the same `-dev.X` version as in `Cargo.toml`
4. The release workflow will attempt to build and publish a new pre-release if the latest tag does match the cargo package version. 4. The release workflow will attempt to build and publish a new pre-release if the latest tag does match the cargo package version.
5. Wait for the `Release` workflow to finish. It should create the pre-release with the same name. 5. Wait for the `Release` workflow to finish. It should create the pre-release with the same `-dev.X` name.
6. Check that pre-release was created on the [Releases page](https://github.com/paritytech/revive/releases) with all artifacts. 6. Check that pre-release was created on the [Releases page](https://github.com/paritytech/revive/releases) with all artifacts.
7. After the release is published, another workflow should start automatically and update json files in https://github.com/paritytech/resolc-bin. Check the changes. 7. After the release is published, another workflow should start automatically and update json files in https://github.com/paritytech/resolc-bin. Check the changes.
8. Update the [contract-docs](https://github.com/paritytech/contract-docs/) accordingly 8. Update the [contract-docs](https://github.com/paritytech/contract-docs/) accordingly
# `resolc` NPM package release
Will happen automatically.
# LLVM release # LLVM release
To create a new LLVM release, run "Release LLVM" workflow. Use current LLVM version as parameter, e.g. `18.1.8`. To create a new LLVM release, run "Release LLVM" workflow. Use current LLVM version as parameter, e.g. `18.1.8`.
+30
View File
@@ -0,0 +1,30 @@
# Known issues
The following is known and we are either working on it or it is a hard limitation. Please do not open a new issue.
## Release
`0.1.0-dev-2`
## Missing features
- [Libraries with public functions are not supported](https://github.com/paritytech/revive/issues/91)
- [Automatic import resolution is not supported](https://github.com/paritytech/revive/issues/98)
- The emulated EVM linear contract memory is limited to 64kb in size. Will be fixed with support for metered dynamic memory.
- [The contract calldata is currently limited to 1kb in size](https://github.com/paritytech/revive/issues/57)
- [EIP-4844 opcodes are not supported](https://github.com/paritytech/revive/issues/64)
- [Delegate calls are not supported](https://github.com/paritytech/revive/issues/67)
- [The `blockhash` opcode is not supported](https://github.com/paritytech/revive/issues/61)
- [The `extcodesize` opcode is not supported](https://github.com/paritytech/revive/issues/58)
- [The `origin` opcode is not supported](https://github.com/paritytech/revive/issues/59)
- [Gas limits for contract calls are ignored](https://github.com/paritytech/revive/issues/60)
- [Gas related opcodes are not supported](https://github.com/paritytech/revive/issues/60)
- IPFS metadata hashes are not supported
- [Compiled contract artifacts can exceed the pallet static memory limit and fail to deploy](https://github.com/paritytech/revive/issues/96).
- [Transfers to inexistant accounts will fail if the transferred value lies below the ED.](https://github.com/paritytech/revive/issues/83) Will be fixed in the pallet to make the ED completely transparent for contracts.
## Wontfix
Please consult our documentation to learn more about Solidity and EVM features likely to remain unsupported (and why they will not be supported).
TODO: Insert link to the relevant documentation section.
+1 -2
View File
@@ -1,6 +1,5 @@
[package] [package]
name = "revive-differential" name = "revive-differential"
description = "utilities for differential testing the revive compiler against EVM"
version.workspace = true version.workspace = true
license.workspace = true license.workspace = true
edition.workspace = true edition.workspace = true
@@ -14,4 +13,4 @@ serde = { workspace = true }
serde_json = { workspace = true } serde_json = { workspace = true }
alloy-primitives = { workspace = true, features = ["serde"] } alloy-primitives = { workspace = true, features = ["serde"] }
alloy-genesis = { workspace = true } alloy-genesis = { workspace = true }
alloy-serde = { workspace = true } alloy-serde = { workspace = true }
+2 -2
View File
@@ -1,6 +1,6 @@
[package] [package]
name = "revive-integration" name = "revive-integration"
version = "0.1.1" version.workspace = true
license.workspace = true license.workspace = true
edition.workspace = true edition.workspace = true
repository.workspace = true repository.workspace = true
@@ -13,7 +13,7 @@ alloy-sol-types = { workspace = true }
hex = { workspace = true } hex = { workspace = true }
serde_json = { workspace = true } serde_json = { workspace = true }
resolc = { workspace = true } revive-solidity = { workspace = true }
revive-runner = { workspace = true } revive-runner = { workspace = true }
revive-llvm-context = { workspace = true } revive-llvm-context = { workspace = true }
-49
View File
@@ -1,49 +0,0 @@
// SPDX-License-Identifier: MIT
pragma solidity ^0.8;
/* runner.json
{
"differential": true,
"actions": [
{
"Instantiate": {
"code": {
"Solidity": {
"contract": "SAR"
}
}
}
}
]
}
*/
contract SAR {
constructor() payable {
assert(sar(0x03, 0x01) == 0x01);
assert(
sar(
0xffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff,
0x01
) == 0xffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff
);
assert(
sar(
0xffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff,
0xff
) == 0xffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff
);
assert(
sar(
0xffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff,
0x100
) == 0xffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff
);
}
function sar(uint256 a, uint256 b) public pure returns (uint256 c) {
assembly {
c := sar(b, a)
}
}
}
+1 -1
View File
@@ -1,8 +1,8 @@
use alloy_primitives::{Address, Bytes, I256, U256}; use alloy_primitives::{Address, Bytes, I256, U256};
use alloy_sol_types::{sol, SolCall, SolConstructor}; use alloy_sol_types::{sol, SolCall, SolConstructor};
use resolc::test_utils::*;
use revive_llvm_context::OptimizerSettings; use revive_llvm_context::OptimizerSettings;
use revive_solidity::test_utils::*;
#[derive(Clone)] #[derive(Clone)]
pub struct Contract { pub struct Contract {
-1
View File
@@ -60,7 +60,6 @@ test_spec!(mload, "MLoad", "MLoad.sol");
test_spec!(delegate_no_contract, "DelegateCaller", "DelegateCaller.sol"); test_spec!(delegate_no_contract, "DelegateCaller", "DelegateCaller.sol");
test_spec!(function_type, "FunctionType", "FunctionType.sol"); test_spec!(function_type, "FunctionType", "FunctionType.sol");
test_spec!(layout_at, "LayoutAt", "LayoutAt.sol"); test_spec!(layout_at, "LayoutAt", "LayoutAt.sol");
test_spec!(shift_arithmetic_right, "SAR", "SAR.sol");
fn instantiate(path: &str, contract: &str) -> Vec<SpecsAction> { fn instantiate(path: &str, contract: &str) -> Vec<SpecsAction> {
vec![Instantiate { vec![Instantiate {
+1 -1
View File
@@ -6,7 +6,7 @@ authors = [
"Anton Baliasnikov <aba@matterlabs.dev>", "Anton Baliasnikov <aba@matterlabs.dev>",
"Cyrill Leutwiler <cyrill@parity.io>", "Cyrill Leutwiler <cyrill@parity.io>",
] ]
version = "0.2.0" version.workspace = true
license.workspace = true license.workspace = true
edition.workspace = true edition.workspace = true
repository.workspace = true repository.workspace = true
+1 -1
View File
@@ -22,7 +22,7 @@ impl std::str::FromStr for BuildType {
"Release" => Ok(Self::Release), "Release" => Ok(Self::Release),
"RelWithDebInfo" => Ok(Self::RelWithDebInfo), "RelWithDebInfo" => Ok(Self::RelWithDebInfo),
"MinSizeRel" => Ok(Self::MinSizeRel), "MinSizeRel" => Ok(Self::MinSizeRel),
value => Err(format!("Unsupported build type: `{value}`")), value => Err(format!("Unsupported build type: `{}`", value)),
} }
} }
} }
+1 -1
View File
@@ -16,7 +16,7 @@ impl std::str::FromStr for CcacheVariant {
match value { match value {
"ccache" => Ok(Self::Ccache), "ccache" => Ok(Self::Ccache),
"sccache" => Ok(Self::Sccache), "sccache" => Ok(Self::Sccache),
value => Err(format!("Unsupported ccache variant: `{value}`")), value => Err(format!("Unsupported ccache variant: `{}`", value)),
} }
} }
} }
+14 -13
View File
@@ -127,22 +127,23 @@ pub fn build(
sanitizer: Option<sanitizer::Sanitizer>, sanitizer: Option<sanitizer::Sanitizer>,
enable_valgrind: bool, enable_valgrind: bool,
) -> anyhow::Result<()> { ) -> anyhow::Result<()> {
log::trace!("build type: {build_type:?}"); log::trace!("build type: {:?}", build_type);
log::trace!("target env: {target_env:?}"); log::trace!("target env: {:?}", target_env);
log::trace!("targets: {targets:?}"); log::trace!("targets: {:?}", targets);
log::trace!("llvm projects: {llvm_projects:?}"); log::trace!("llvm projects: {:?}", llvm_projects);
log::trace!("enable rtti: {enable_rtti:?}"); log::trace!("enable rtti: {:?}", enable_rtti);
log::trace!("default target: {default_target:?}"); log::trace!("default target: {:?}", default_target);
log::trace!("eneable tests: {enable_tests:?}"); log::trace!("eneable tests: {:?}", enable_tests);
log::trace!("enable_coverage: {enable_coverage:?}"); log::trace!("enable_coverage: {:?}", enable_coverage);
log::trace!("extra args: {extra_args:?}"); log::trace!("extra args: {:?}", extra_args);
log::trace!("sanitzer: {sanitizer:?}"); log::trace!("sanitzer: {:?}", sanitizer);
log::trace!("enable valgrind: {enable_valgrind:?}"); log::trace!("enable valgrind: {:?}", enable_valgrind);
if !PathBuf::from(LLVMPath::DIRECTORY_LLVM_SOURCE).exists() { if !PathBuf::from(LLVMPath::DIRECTORY_LLVM_SOURCE).exists() {
log::error!( log::error!(
"LLVM project source directory {} does not exist (run `revive-llvm --target-env {target_env} clone`)", "LLVM project source directory {} does not exist (run `revive-llvm --target-env {} clone`)",
LLVMPath::DIRECTORY_LLVM_SOURCE LLVMPath::DIRECTORY_LLVM_SOURCE,
target_env
) )
} }
+1 -1
View File
@@ -22,7 +22,7 @@ impl std::str::FromStr for LLVMProject {
"lld" => Ok(Self::LLD), "lld" => Ok(Self::LLD),
"lldb" => Ok(Self::LLDB), "lldb" => Ok(Self::LLDB),
"mlir" => Ok(Self::MLIR), "mlir" => Ok(Self::MLIR),
value => Err(format!("Unsupported LLVM project to enable: `{value}`")), value => Err(format!("Unsupported LLVM project to enable: `{}`", value)),
} }
} }
} }
+1 -1
View File
@@ -30,7 +30,7 @@ impl TryFrom<&PathBuf> for Lock {
fn try_from(path: &PathBuf) -> Result<Self, Self::Error> { fn try_from(path: &PathBuf) -> Result<Self, Self::Error> {
let mut config_str = String::new(); let mut config_str = String::new();
let mut config_file = let mut config_file =
File::open(path).with_context(|| format!("Error opening {path:?} file"))?; File::open(path).with_context(|| format!("Error opening {:?} file", path))?;
config_file.read_to_string(&mut config_str)?; config_file.read_to_string(&mut config_str)?;
Ok(toml::from_str(&config_str)?) Ok(toml::from_str(&config_str)?)
} }
+1 -1
View File
@@ -29,7 +29,7 @@ impl FromStr for Platform {
fn from_str(value: &str) -> Result<Self, Self::Err> { fn from_str(value: &str) -> Result<Self, Self::Err> {
match value { match value {
"PolkaVM" => Ok(Self::PolkaVM), "PolkaVM" => Ok(Self::PolkaVM),
value => Err(format!("Unsupported platform: `{value}`")), value => Err(format!("Unsupported platform: `{}`", value)),
} }
} }
} }
+2 -2
View File
@@ -69,8 +69,8 @@ fn main_inner() -> anyhow::Result<()> {
}) })
.collect(); .collect();
log::debug!("extra_args: {extra_args:#?}"); log::debug!("extra_args: {:#?}", extra_args);
log::debug!("extra_args_unescaped: {extra_args_unescaped:#?}"); log::debug!("extra_args_unescaped: {:#?}", extra_args_unescaped);
if let Some(ccache_variant) = ccache_variant { if let Some(ccache_variant) = ccache_variant {
revive_llvm_builder::utils::check_presence(ccache_variant.to_string().as_str())?; revive_llvm_builder::utils::check_presence(ccache_variant.to_string().as_str())?;
+1 -1
View File
@@ -30,7 +30,7 @@ impl std::str::FromStr for Sanitizer {
"thread" => Ok(Self::Thread), "thread" => Ok(Self::Thread),
"dataflow" => Ok(Self::DataFlow), "dataflow" => Ok(Self::DataFlow),
"address;undefined" => Ok(Self::AddressUndefined), "address;undefined" => Ok(Self::AddressUndefined),
value => Err(format!("Unsupported sanitizer: `{value}`")), value => Err(format!("Unsupported sanitizer: `{}`", value)),
} }
} }
} }
+1 -1
View File
@@ -20,7 +20,7 @@ impl std::str::FromStr for TargetEnv {
"gnu" => Ok(Self::GNU), "gnu" => Ok(Self::GNU),
"musl" => Ok(Self::MUSL), "musl" => Ok(Self::MUSL),
"emscripten" => Ok(Self::Emscripten), "emscripten" => Ok(Self::Emscripten),
value => Err(format!("Unsupported target environment: `{value}`")), value => Err(format!("Unsupported target environment: `{}`", value)),
} }
} }
} }
+1 -1
View File
@@ -15,7 +15,7 @@ impl std::str::FromStr for TargetTriple {
fn from_str(value: &str) -> Result<Self, Self::Err> { fn from_str(value: &str) -> Result<Self, Self::Err> {
match value { match value {
"polkavm" => Ok(Self::PolkaVM), "polkavm" => Ok(Self::PolkaVM),
value => Err(format!("Unsupported target triple: `{value}`")), value => Err(format!("Unsupported target triple: `{}`", value)),
} }
} }
} }
+3 -3
View File
@@ -38,7 +38,7 @@ pub const MUSL_SNAPSHOTS_URL: &str = "https://git.musl-libc.org/cgit/musl/snapsh
pub const EMSDK_SOURCE_URL: &str = "https://github.com/emscripten-core/emsdk.git"; pub const EMSDK_SOURCE_URL: &str = "https://github.com/emscripten-core/emsdk.git";
/// The emscripten SDK version. /// The emscripten SDK version.
pub const EMSDK_VERSION: &str = "4.0.9"; pub const EMSDK_VERSION: &str = "3.1.64";
/// The subprocess runner. /// The subprocess runner.
/// ///
@@ -92,7 +92,7 @@ pub fn unpack_tar(filename: PathBuf, path: &str) -> anyhow::Result<()> {
pub fn download_musl(name: &str) -> anyhow::Result<()> { pub fn download_musl(name: &str) -> anyhow::Result<()> {
log::info!("downloading musl {name}"); log::info!("downloading musl {name}");
let tar_file_name = format!("{name}.tar.gz"); let tar_file_name = format!("{name}.tar.gz");
let url = format!("{MUSL_SNAPSHOTS_URL}/{tar_file_name}"); let url = format!("{}/{tar_file_name}", MUSL_SNAPSHOTS_URL);
let target_path = crate::llvm_path::DIRECTORY_LLVM_TARGET let target_path = crate::llvm_path::DIRECTORY_LLVM_TARGET
.get() .get()
.unwrap() .unwrap()
@@ -223,6 +223,6 @@ pub fn install_emsdk() -> anyhow::Result<()> {
/// The LLVM target directory default path. /// The LLVM target directory default path.
pub fn directory_target_llvm(target_env: crate::target_env::TargetEnv) -> PathBuf { pub fn directory_target_llvm(target_env: crate::target_env::TargetEnv) -> PathBuf {
crate::llvm_path::DIRECTORY_LLVM_TARGET crate::llvm_path::DIRECTORY_LLVM_TARGET
.get_or_init(|| PathBuf::from(format!("./target-llvm/{target_env}/"))) .get_or_init(|| PathBuf::from(format!("./target-llvm/{}/", target_env)))
.clone() .clone()
} }
+1 -1
View File
@@ -1,6 +1,6 @@
[package] [package]
name = "revive-llvm-context" name = "revive-llvm-context"
version = "0.3.0" version.workspace = true
license.workspace = true license.workspace = true
edition.workspace = true edition.workspace = true
repository.workspace = true repository.workspace = true
+2 -12
View File
@@ -5,6 +5,7 @@ use std::sync::OnceLock;
pub use self::debug_config::ir_type::IRType as DebugConfigIR; pub use self::debug_config::ir_type::IRType as DebugConfigIR;
pub use self::debug_config::DebugConfig; pub use self::debug_config::DebugConfig;
pub use self::memory::MemoryConfig;
pub use self::optimizer::settings::size_level::SizeLevel as OptimizerSettingsSizeLevel; pub use self::optimizer::settings::size_level::SizeLevel as OptimizerSettingsSizeLevel;
pub use self::optimizer::settings::Settings as OptimizerSettings; pub use self::optimizer::settings::Settings as OptimizerSettings;
pub use self::optimizer::Optimizer; pub use self::optimizer::Optimizer;
@@ -19,22 +20,10 @@ pub use self::polkavm::context::function::declaration::Declaration as PolkaVMFun
pub use self::polkavm::context::function::intrinsics::Intrinsics as PolkaVMIntrinsicFunction; pub use self::polkavm::context::function::intrinsics::Intrinsics as PolkaVMIntrinsicFunction;
pub use self::polkavm::context::function::llvm_runtime::LLVMRuntime as PolkaVMLLVMRuntime; pub use self::polkavm::context::function::llvm_runtime::LLVMRuntime as PolkaVMLLVMRuntime;
pub use self::polkavm::context::function::r#return::Return as PolkaVMFunctionReturn; pub use self::polkavm::context::function::r#return::Return as PolkaVMFunctionReturn;
pub use self::polkavm::context::function::runtime::arithmetics::Addition as PolkaVMAdditionFunction;
pub use self::polkavm::context::function::runtime::arithmetics::Division as PolkaVMDivisionFunction; pub use self::polkavm::context::function::runtime::arithmetics::Division as PolkaVMDivisionFunction;
pub use self::polkavm::context::function::runtime::arithmetics::Multiplication as PolkaVMMultiplicationFunction;
pub use self::polkavm::context::function::runtime::arithmetics::Remainder as PolkaVMRemainderFunction; pub use self::polkavm::context::function::runtime::arithmetics::Remainder as PolkaVMRemainderFunction;
pub use self::polkavm::context::function::runtime::arithmetics::SignedDivision as PolkaVMSignedDivisionFunction; pub use self::polkavm::context::function::runtime::arithmetics::SignedDivision as PolkaVMSignedDivisionFunction;
pub use self::polkavm::context::function::runtime::arithmetics::SignedRemainder as PolkaVMSignedRemainderFunction; pub use self::polkavm::context::function::runtime::arithmetics::SignedRemainder as PolkaVMSignedRemainderFunction;
pub use self::polkavm::context::function::runtime::arithmetics::Subtraction as PolkaVMSubstractionFunction;
pub use self::polkavm::context::function::runtime::bitwise::And as PolkaVMAndFunction;
pub use self::polkavm::context::function::runtime::bitwise::Byte as PolkaVMByteFunction;
pub use self::polkavm::context::function::runtime::bitwise::Or as PolkaVMOrFunction;
pub use self::polkavm::context::function::runtime::bitwise::Sar as PolkaVMSarFunction;
pub use self::polkavm::context::function::runtime::bitwise::Shl as PolkaVMShlFunction;
pub use self::polkavm::context::function::runtime::bitwise::Shr as PolkaVMShrFunction;
pub use self::polkavm::context::function::runtime::bitwise::Xor as PolkaVMXorFunction;
pub use self::polkavm::context::function::runtime::call::Call as PolkaVMCall;
pub use self::polkavm::context::function::runtime::call::CallReentrancyProtector as PolkaVMCallReentrancyProtector;
pub use self::polkavm::context::function::runtime::deploy_code::DeployCode as PolkaVMDeployCodeFunction; pub use self::polkavm::context::function::runtime::deploy_code::DeployCode as PolkaVMDeployCodeFunction;
pub use self::polkavm::context::function::runtime::entry::Entry as PolkaVMEntryFunction; pub use self::polkavm::context::function::runtime::entry::Entry as PolkaVMEntryFunction;
pub use self::polkavm::context::function::runtime::revive::Exit as PolkaVMExitFunction; pub use self::polkavm::context::function::runtime::revive::Exit as PolkaVMExitFunction;
@@ -87,6 +76,7 @@ pub use self::target_machine::target::Target;
pub use self::target_machine::TargetMachine; pub use self::target_machine::TargetMachine;
pub(crate) mod debug_config; pub(crate) mod debug_config;
pub(crate) mod memory;
pub(crate) mod optimizer; pub(crate) mod optimizer;
pub(crate) mod polkavm; pub(crate) mod polkavm;
pub(crate) mod target_machine; pub(crate) mod target_machine;
+21
View File
@@ -0,0 +1,21 @@
//! The compile time PolkaVM memory configuration settings.
use serde::{Deserialize, Serialize};
/// The PolkaVM memory configuration.
#[derive(Clone, Copy, Debug, Deserialize, Serialize)]
pub struct MemoryConfig {
/// The emulated EVM linear heap memory size in bytes.
pub heap_size: u32,
/// The PVM stack size in bytes.
pub stack_size: u32,
}
impl Default for MemoryConfig {
fn default() -> Self {
Self {
heap_size: 64 * 1024,
stack_size: 32 * 1024,
}
}
}
@@ -7,141 +7,6 @@ use crate::polkavm::context::Context;
use crate::polkavm::Dependency; use crate::polkavm::Dependency;
use crate::polkavm::WriteLLVM; use crate::polkavm::WriteLLVM;
/// Implements the ADD operator according to the EVM specification.
pub struct Addition;
impl<D> RuntimeFunction<D> for Addition
where
D: Dependency + Clone,
{
const NAME: &'static str = "__revive_addition";
fn r#type<'ctx>(context: &Context<'ctx, D>) -> inkwell::types::FunctionType<'ctx> {
context.word_type().fn_type(
&[context.word_type().into(), context.word_type().into()],
false,
)
}
fn emit_body<'ctx>(
&self,
context: &mut Context<'ctx, D>,
) -> anyhow::Result<Option<inkwell::values::BasicValueEnum<'ctx>>> {
let operand_1 = Self::paramater(context, 0).into_int_value();
let operand_2 = Self::paramater(context, 1).into_int_value();
Ok(Some(
context
.builder()
.build_int_add(operand_1, operand_2, "ADD")
.map(Into::into)?,
))
}
}
impl<D> WriteLLVM<D> for Addition
where
D: Dependency + Clone,
{
fn declare(&mut self, context: &mut Context<D>) -> anyhow::Result<()> {
<Self as RuntimeFunction<_>>::declare(self, context)
}
fn into_llvm(self, context: &mut Context<D>) -> anyhow::Result<()> {
<Self as RuntimeFunction<_>>::emit(&self, context)
}
}
/// Implements the SUB operator according to the EVM specification.
pub struct Subtraction;
impl<D> RuntimeFunction<D> for Subtraction
where
D: Dependency + Clone,
{
const NAME: &'static str = "__revive_subtraction";
fn r#type<'ctx>(context: &Context<'ctx, D>) -> inkwell::types::FunctionType<'ctx> {
context.word_type().fn_type(
&[context.word_type().into(), context.word_type().into()],
false,
)
}
fn emit_body<'ctx>(
&self,
context: &mut Context<'ctx, D>,
) -> anyhow::Result<Option<inkwell::values::BasicValueEnum<'ctx>>> {
let operand_1 = Self::paramater(context, 0).into_int_value();
let operand_2 = Self::paramater(context, 1).into_int_value();
Ok(Some(
context
.builder()
.build_int_sub(operand_1, operand_2, "SUB")
.map(Into::into)?,
))
}
}
impl<D> WriteLLVM<D> for Subtraction
where
D: Dependency + Clone,
{
fn declare(&mut self, context: &mut Context<D>) -> anyhow::Result<()> {
<Self as RuntimeFunction<_>>::declare(self, context)
}
fn into_llvm(self, context: &mut Context<D>) -> anyhow::Result<()> {
<Self as RuntimeFunction<_>>::emit(&self, context)
}
}
/// Implements the MUL operator according to the EVM specification.
pub struct Multiplication;
impl<D> RuntimeFunction<D> for Multiplication
where
D: Dependency + Clone,
{
const NAME: &'static str = "__revive_multiplication";
fn r#type<'ctx>(context: &Context<'ctx, D>) -> inkwell::types::FunctionType<'ctx> {
context.word_type().fn_type(
&[context.word_type().into(), context.word_type().into()],
false,
)
}
fn emit_body<'ctx>(
&self,
context: &mut Context<'ctx, D>,
) -> anyhow::Result<Option<inkwell::values::BasicValueEnum<'ctx>>> {
let operand_1 = Self::paramater(context, 0).into_int_value();
let operand_2 = Self::paramater(context, 1).into_int_value();
Ok(Some(
context
.builder()
.build_int_mul(operand_1, operand_2, "MUL")
.map(Into::into)?,
))
}
}
impl<D> WriteLLVM<D> for Multiplication
where
D: Dependency + Clone,
{
fn declare(&mut self, context: &mut Context<D>) -> anyhow::Result<()> {
<Self as RuntimeFunction<_>>::declare(self, context)
}
fn into_llvm(self, context: &mut Context<D>) -> anyhow::Result<()> {
<Self as RuntimeFunction<_>>::emit(&self, context)
}
}
/// Implements the division operator according to the EVM specification. /// Implements the division operator according to the EVM specification.
pub struct Division; pub struct Division;
@@ -1,494 +0,0 @@
//! Translates the arithmetic operations.
use inkwell::values::BasicValue;
use crate::polkavm::context::runtime::RuntimeFunction;
use crate::polkavm::context::Context;
use crate::polkavm::Dependency;
use crate::polkavm::WriteLLVM;
/// Implements the OR operator according to the EVM specification.
pub struct Or;
impl<D> RuntimeFunction<D> for Or
where
D: Dependency + Clone,
{
const NAME: &'static str = "__revive_or";
fn r#type<'ctx>(context: &Context<'ctx, D>) -> inkwell::types::FunctionType<'ctx> {
context.word_type().fn_type(
&[context.word_type().into(), context.word_type().into()],
false,
)
}
fn emit_body<'ctx>(
&self,
context: &mut Context<'ctx, D>,
) -> anyhow::Result<Option<inkwell::values::BasicValueEnum<'ctx>>> {
let operand_1 = Self::paramater(context, 0).into_int_value();
let operand_2 = Self::paramater(context, 1).into_int_value();
Ok(Some(
context
.builder()
.build_or(operand_1, operand_2, "OR")
.map(Into::into)?,
))
}
}
impl<D> WriteLLVM<D> for Or
where
D: Dependency + Clone,
{
fn declare(&mut self, context: &mut Context<D>) -> anyhow::Result<()> {
<Self as RuntimeFunction<_>>::declare(self, context)
}
fn into_llvm(self, context: &mut Context<D>) -> anyhow::Result<()> {
<Self as RuntimeFunction<_>>::emit(&self, context)
}
}
/// Implements the XOR operator according to the EVM specification.
pub struct Xor;
impl<D> RuntimeFunction<D> for Xor
where
D: Dependency + Clone,
{
const NAME: &'static str = "__revive_xor";
fn r#type<'ctx>(context: &Context<'ctx, D>) -> inkwell::types::FunctionType<'ctx> {
context.word_type().fn_type(
&[context.word_type().into(), context.word_type().into()],
false,
)
}
fn emit_body<'ctx>(
&self,
context: &mut Context<'ctx, D>,
) -> anyhow::Result<Option<inkwell::values::BasicValueEnum<'ctx>>> {
let operand_1 = Self::paramater(context, 0).into_int_value();
let operand_2 = Self::paramater(context, 1).into_int_value();
Ok(Some(
context
.builder()
.build_xor(operand_1, operand_2, "XOR")
.map(Into::into)?,
))
}
}
impl<D> WriteLLVM<D> for Xor
where
D: Dependency + Clone,
{
fn declare(&mut self, context: &mut Context<D>) -> anyhow::Result<()> {
<Self as RuntimeFunction<_>>::declare(self, context)
}
fn into_llvm(self, context: &mut Context<D>) -> anyhow::Result<()> {
<Self as RuntimeFunction<_>>::emit(&self, context)
}
}
/// Implements the AND operator according to the EVM specification.
pub struct And;
impl<D> RuntimeFunction<D> for And
where
D: Dependency + Clone,
{
const NAME: &'static str = "__revive_and";
fn r#type<'ctx>(context: &Context<'ctx, D>) -> inkwell::types::FunctionType<'ctx> {
context.word_type().fn_type(
&[context.word_type().into(), context.word_type().into()],
false,
)
}
fn emit_body<'ctx>(
&self,
context: &mut Context<'ctx, D>,
) -> anyhow::Result<Option<inkwell::values::BasicValueEnum<'ctx>>> {
let operand_1 = Self::paramater(context, 0).into_int_value();
let operand_2 = Self::paramater(context, 1).into_int_value();
Ok(Some(
context
.builder()
.build_and(operand_1, operand_2, "AND")
.map(Into::into)?,
))
}
}
impl<D> WriteLLVM<D> for And
where
D: Dependency + Clone,
{
fn declare(&mut self, context: &mut Context<D>) -> anyhow::Result<()> {
<Self as RuntimeFunction<_>>::declare(self, context)
}
fn into_llvm(self, context: &mut Context<D>) -> anyhow::Result<()> {
<Self as RuntimeFunction<_>>::emit(&self, context)
}
}
/// Implements the SHL operator according to the EVM specification.
pub struct Shl;
impl<D> RuntimeFunction<D> for Shl
where
D: Dependency + Clone,
{
const NAME: &'static str = "__revive_shl";
fn r#type<'ctx>(context: &Context<'ctx, D>) -> inkwell::types::FunctionType<'ctx> {
context.word_type().fn_type(
&[context.word_type().into(), context.word_type().into()],
false,
)
}
fn emit_body<'ctx>(
&self,
context: &mut Context<'ctx, D>,
) -> anyhow::Result<Option<inkwell::values::BasicValueEnum<'ctx>>> {
let shift = Self::paramater(context, 0).into_int_value();
let value = Self::paramater(context, 1).into_int_value();
let overflow_block = context.append_basic_block("shift_left_overflow");
let non_overflow_block = context.append_basic_block("shift_left_non_overflow");
let join_block = context.append_basic_block("shift_left_join");
let condition_is_overflow = context.builder().build_int_compare(
inkwell::IntPredicate::UGT,
shift,
context.word_const((revive_common::BIT_LENGTH_WORD - 1) as u64),
"shift_left_is_overflow",
)?;
context.build_conditional_branch(
condition_is_overflow,
overflow_block,
non_overflow_block,
)?;
context.set_basic_block(overflow_block);
context.build_unconditional_branch(join_block);
context.set_basic_block(non_overflow_block);
let value =
context
.builder()
.build_left_shift(value, shift, "shift_left_non_overflow_result")?;
context.build_unconditional_branch(join_block);
context.set_basic_block(join_block);
let result = context
.builder()
.build_phi(context.word_type(), "shift_left_value")?;
result.add_incoming(&[
(&value, non_overflow_block),
(&context.word_const(0), overflow_block),
]);
Ok(Some(result.as_basic_value()))
}
}
impl<D> WriteLLVM<D> for Shl
where
D: Dependency + Clone,
{
fn declare(&mut self, context: &mut Context<D>) -> anyhow::Result<()> {
<Self as RuntimeFunction<_>>::declare(self, context)
}
fn into_llvm(self, context: &mut Context<D>) -> anyhow::Result<()> {
<Self as RuntimeFunction<_>>::emit(&self, context)
}
}
/// Implements the SHR operator according to the EVM specification.
pub struct Shr;
impl<D> RuntimeFunction<D> for Shr
where
D: Dependency + Clone,
{
const NAME: &'static str = "__revive_shr";
fn r#type<'ctx>(context: &Context<'ctx, D>) -> inkwell::types::FunctionType<'ctx> {
context.word_type().fn_type(
&[context.word_type().into(), context.word_type().into()],
false,
)
}
fn emit_body<'ctx>(
&self,
context: &mut Context<'ctx, D>,
) -> anyhow::Result<Option<inkwell::values::BasicValueEnum<'ctx>>> {
let shift = Self::paramater(context, 0).into_int_value();
let value = Self::paramater(context, 1).into_int_value();
let overflow_block = context.append_basic_block("shift_right_overflow");
let non_overflow_block = context.append_basic_block("shift_right_non_overflow");
let join_block = context.append_basic_block("shift_right_join");
let condition_is_overflow = context.builder().build_int_compare(
inkwell::IntPredicate::UGT,
shift,
context.word_const((revive_common::BIT_LENGTH_WORD - 1) as u64),
"shift_right_is_overflow",
)?;
context.build_conditional_branch(
condition_is_overflow,
overflow_block,
non_overflow_block,
)?;
context.set_basic_block(overflow_block);
context.build_unconditional_branch(join_block);
context.set_basic_block(non_overflow_block);
let value = context.builder().build_right_shift(
value,
shift,
false,
"shift_right_non_overflow_result",
)?;
context.build_unconditional_branch(join_block);
context.set_basic_block(join_block);
let result = context
.builder()
.build_phi(context.word_type(), "shift_right_value")?;
result.add_incoming(&[
(&value, non_overflow_block),
(&context.word_const(0), overflow_block),
]);
Ok(Some(result.as_basic_value()))
}
}
impl<D> WriteLLVM<D> for Shr
where
D: Dependency + Clone,
{
fn declare(&mut self, context: &mut Context<D>) -> anyhow::Result<()> {
<Self as RuntimeFunction<_>>::declare(self, context)
}
fn into_llvm(self, context: &mut Context<D>) -> anyhow::Result<()> {
<Self as RuntimeFunction<_>>::emit(&self, context)
}
}
/// Implements the SAR operator according to the EVM specification.
pub struct Sar;
impl<D> RuntimeFunction<D> for Sar
where
D: Dependency + Clone,
{
const NAME: &'static str = "__revive_sar";
fn r#type<'ctx>(context: &Context<'ctx, D>) -> inkwell::types::FunctionType<'ctx> {
context.word_type().fn_type(
&[context.word_type().into(), context.word_type().into()],
false,
)
}
fn emit_body<'ctx>(
&self,
context: &mut Context<'ctx, D>,
) -> anyhow::Result<Option<inkwell::values::BasicValueEnum<'ctx>>> {
let shift = Self::paramater(context, 0).into_int_value();
let value = Self::paramater(context, 1).into_int_value();
let overflow_block = context.append_basic_block("shift_right_arithmetic_overflow");
let overflow_positive_block =
context.append_basic_block("shift_right_arithmetic_overflow_positive");
let overflow_negative_block =
context.append_basic_block("shift_right_arithmetic_overflow_negative");
let non_overflow_block = context.append_basic_block("shift_right_arithmetic_non_overflow");
let join_block = context.append_basic_block("shift_right_arithmetic_join");
let condition_is_overflow = context.builder().build_int_compare(
inkwell::IntPredicate::UGT,
shift,
context.word_const((revive_common::BIT_LENGTH_WORD - 1) as u64),
"shift_right_arithmetic_is_overflow",
)?;
context.build_conditional_branch(
condition_is_overflow,
overflow_block,
non_overflow_block,
)?;
context.set_basic_block(overflow_block);
let sign_bit = context.builder().build_right_shift(
value,
context.word_const((revive_common::BIT_LENGTH_WORD - 1) as u64),
false,
"shift_right_arithmetic_sign_bit",
)?;
let condition_is_negative = context.builder().build_int_truncate_or_bit_cast(
sign_bit,
context.bool_type(),
"shift_right_arithmetic_sign_bit_truncated",
)?;
context.build_conditional_branch(
condition_is_negative,
overflow_negative_block,
overflow_positive_block,
)?;
context.set_basic_block(overflow_positive_block);
context.build_unconditional_branch(join_block);
context.set_basic_block(overflow_negative_block);
context.build_unconditional_branch(join_block);
context.set_basic_block(non_overflow_block);
let value = context.builder().build_right_shift(
value,
shift,
true,
"shift_right_arithmetic_non_overflow_result",
)?;
context.build_unconditional_branch(join_block);
context.set_basic_block(join_block);
let result = context
.builder()
.build_phi(context.word_type(), "shift_arithmetic_right_value")?;
result.add_incoming(&[
(&value, non_overflow_block),
(
&context.word_type().const_all_ones(),
overflow_negative_block,
),
(&context.word_const(0), overflow_positive_block),
]);
Ok(Some(result.as_basic_value()))
}
}
impl<D> WriteLLVM<D> for Sar
where
D: Dependency + Clone,
{
fn declare(&mut self, context: &mut Context<D>) -> anyhow::Result<()> {
<Self as RuntimeFunction<_>>::declare(self, context)
}
fn into_llvm(self, context: &mut Context<D>) -> anyhow::Result<()> {
<Self as RuntimeFunction<_>>::emit(&self, context)
}
}
/// Implements the BYTE operator according to the EVM specification.
pub struct Byte;
impl<D> RuntimeFunction<D> for Byte
where
D: Dependency + Clone,
{
const NAME: &'static str = "__revive_byte";
fn r#type<'ctx>(context: &Context<'ctx, D>) -> inkwell::types::FunctionType<'ctx> {
context.word_type().fn_type(
&[context.word_type().into(), context.word_type().into()],
false,
)
}
fn emit_body<'ctx>(
&self,
context: &mut Context<'ctx, D>,
) -> anyhow::Result<Option<inkwell::values::BasicValueEnum<'ctx>>> {
let operand_1 = Self::paramater(context, 0).into_int_value();
let operand_2 = Self::paramater(context, 1).into_int_value();
const MAX_INDEX_BYTES: u64 = 31;
let is_overflow_bit = context.builder().build_int_compare(
inkwell::IntPredicate::ULE,
operand_1,
context.word_const(MAX_INDEX_BYTES),
"is_overflow_bit",
)?;
let is_overflow_byte = context.builder().build_int_z_extend(
is_overflow_bit,
context.byte_type(),
"is_overflow_byte",
)?;
let mask_byte = context.builder().build_int_mul(
context.byte_type().const_all_ones(),
is_overflow_byte,
"mask_byte",
)?;
let mask_byte_word = context.builder().build_int_z_extend(
mask_byte,
context.word_type(),
"mask_byte_word",
)?;
let index_truncated = context.builder().build_int_truncate(
operand_1,
context.byte_type(),
"index_truncated",
)?;
let index_in_bits = context.builder().build_int_mul(
index_truncated,
context
.byte_type()
.const_int(revive_common::BIT_LENGTH_BYTE as u64, false),
"index_in_bits",
)?;
let index_from_most_significant_bit = context.builder().build_int_sub(
context.byte_type().const_int(
MAX_INDEX_BYTES * revive_common::BIT_LENGTH_BYTE as u64,
false,
),
index_in_bits,
"index_from_msb",
)?;
let index_extended = context.builder().build_int_z_extend(
index_from_most_significant_bit,
context.word_type(),
"index",
)?;
let mask = context
.builder()
.build_left_shift(mask_byte_word, index_extended, "mask")?;
let masked_value = context.builder().build_and(operand_2, mask, "masked")?;
let byte =
context
.builder()
.build_right_shift(masked_value, index_extended, false, "byte")?;
Ok(Some(byte.as_basic_value_enum()))
}
}
impl<D> WriteLLVM<D> for Byte
where
D: Dependency + Clone,
{
fn declare(&mut self, context: &mut Context<D>) -> anyhow::Result<()> {
<Self as RuntimeFunction<_>>::declare(self, context)
}
fn into_llvm(self, context: &mut Context<D>) -> anyhow::Result<()> {
<Self as RuntimeFunction<_>>::emit(&self, context)
}
}
@@ -1,257 +0,0 @@
//! Translates the arithmetic operations.
use inkwell::values::BasicValue;
use crate::polkavm::context::runtime::RuntimeFunction;
use crate::polkavm::context::Context;
use crate::polkavm::context::Pointer;
use crate::polkavm::Dependency;
use crate::polkavm::WriteLLVM;
const SOLIDITY_TRANSFER_GAS_STIPEND_THRESHOLD: u64 = 2300;
/// The Solidity `address.transfer` and `address.send` call detection heuristic.
///
/// # Why
/// This heuristic is an additional security feature to guard against re-entrancy attacks
/// in case contract authors violate Solidity best practices and use `address.transfer` or
/// `address.send`.
/// While contract authors are supposed to never use `address.transfer` or `address.send`,
/// for a small cost we can be extra defensive about it.
///
/// # How
/// The gas stipend emitted by solc for `transfer` and `send` is not static, thus:
/// - Dynamically allow re-entrancy only for calls considered not transfer or send.
/// - Detected balance transfers will supply 0 deposit limit instead of `u256::MAX`.
///
/// Calls are considered transfer or send if:
/// - (Input length | Output lenght) == 0;
/// - Gas <= 2300;
///
/// # Arguments:
/// - The deposit value pointer.
/// - The gas value.
/// - `input_length | output_length`.
///
///
/// # Returns:
/// The call flags xlen `IntValue`
pub struct CallReentrancyProtector;
impl<D> RuntimeFunction<D> for CallReentrancyProtector
where
D: Dependency + Clone,
{
const NAME: &'static str = "__revive_call_reentrancy_protector";
fn r#type<'ctx>(context: &Context<'ctx, D>) -> inkwell::types::FunctionType<'ctx> {
context.xlen_type().fn_type(
&[
context.llvm().ptr_type(Default::default()).into(),
context.word_type().into(),
context.xlen_type().into(),
],
false,
)
}
fn emit_body<'ctx>(
&self,
context: &mut Context<'ctx, D>,
) -> anyhow::Result<Option<inkwell::values::BasicValueEnum<'ctx>>> {
let deposit_pointer = Self::paramater(context, 0).into_pointer_value();
let gas = Self::paramater(context, 1).into_int_value();
let input_length_or_output_length = Self::paramater(context, 2).into_int_value();
// Branch-free SSA implementation: First derive the heuristic boolean (int1) value.
let is_no_input_no_output = context.builder().build_int_compare(
inkwell::IntPredicate::EQ,
context.xlen_type().const_zero(),
input_length_or_output_length,
"is_no_input_no_output",
)?;
let gas_stipend = context
.word_type()
.const_int(SOLIDITY_TRANSFER_GAS_STIPEND_THRESHOLD, false);
let is_gas_stipend_for_transfer_or_send = context.builder().build_int_compare(
inkwell::IntPredicate::ULE,
gas,
gas_stipend,
"is_gas_stipend_for_transfer_or_send",
)?;
let is_balance_transfer = context.builder().build_and(
is_no_input_no_output,
is_gas_stipend_for_transfer_or_send,
"is_balance_transfer",
)?;
let is_regular_call = context
.builder()
.build_not(is_balance_transfer, "is_balance_transfer_inverted")?;
// Call flag: Left shift the heuristic boolean value.
let is_regular_call_xlen = context.builder().build_int_z_extend(
is_regular_call,
context.xlen_type(),
"is_balance_transfer_xlen",
)?;
let call_flags = context.builder().build_left_shift(
is_regular_call_xlen,
context.xlen_type().const_int(3, false),
"flags",
)?;
// Deposit limit value: Sign-extended the heuristic boolean value.
let deposit_limit_value = context.builder().build_int_s_extend(
is_regular_call,
context.word_type(),
"deposit_limit_value",
)?;
context
.builder()
.build_store(deposit_pointer, deposit_limit_value)?;
Ok(Some(call_flags.into()))
}
}
impl<D> WriteLLVM<D> for CallReentrancyProtector
where
D: Dependency + Clone,
{
fn declare(&mut self, context: &mut Context<D>) -> anyhow::Result<()> {
<Self as RuntimeFunction<_>>::declare(self, context)
}
fn into_llvm(self, context: &mut Context<D>) -> anyhow::Result<()> {
<Self as RuntimeFunction<_>>::emit(&self, context)
}
}
/// Implements the CALL operator according to the EVM specification.
///
/// # Arguments:
/// - The address value.
/// - The value value.
/// - The input offset.
/// - The input length.
/// - The output offset.
/// - The output length.
/// - The deposit limit pointer.
/// - The call flags.
///
/// # Returns:
/// - The success value (as xlen)
pub struct Call;
impl<D> RuntimeFunction<D> for Call
where
D: Dependency + Clone,
{
const NAME: &'static str = "__revive_call";
fn r#type<'ctx>(context: &Context<'ctx, D>) -> inkwell::types::FunctionType<'ctx> {
context.register_type().fn_type(
&[
context.word_type().into(),
context.word_type().into(),
context.xlen_type().into(),
context.xlen_type().into(),
context.xlen_type().into(),
context.xlen_type().into(),
context.llvm().ptr_type(Default::default()).into(),
context.xlen_type().into(),
],
false,
)
}
fn emit_body<'ctx>(
&self,
context: &mut Context<'ctx, D>,
) -> anyhow::Result<Option<inkwell::values::BasicValueEnum<'ctx>>> {
let address = Self::paramater(context, 0).into_int_value();
let value = Self::paramater(context, 1).into_int_value();
let input_offset = Self::paramater(context, 2).into_int_value();
let input_length = Self::paramater(context, 3).into_int_value();
let output_offset = Self::paramater(context, 4).into_int_value();
let output_length = Self::paramater(context, 5).into_int_value();
let depsit_limit_pointer = Self::paramater(context, 6).into_pointer_value();
let flags = Self::paramater(context, 7).into_int_value();
let address_pointer = context.build_address_argument_store(address)?;
let value_pointer = context.build_alloca_at_entry(context.word_type(), "value_pointer");
context.build_store(value_pointer, value)?;
let input_pointer = context.build_heap_gep(input_offset, input_length)?;
let output_pointer = context.build_heap_gep(output_offset, output_length)?;
let output_length_pointer =
context.build_alloca_at_entry(context.xlen_type(), "output_length");
context.build_store(output_length_pointer, output_length)?;
let flags_and_callee = revive_runtime_api::calling_convention::pack_hi_lo_reg(
context.builder(),
context.llvm(),
flags,
address_pointer.to_int(context),
"address_and_callee",
)?;
let deposit_limit_pointer = Pointer::new(
context.word_type(),
Default::default(),
depsit_limit_pointer,
);
let deposit_and_value = revive_runtime_api::calling_convention::pack_hi_lo_reg(
context.builder(),
context.llvm(),
deposit_limit_pointer.to_int(context),
value_pointer.to_int(context),
"deposit_and_value",
)?;
let input_data = revive_runtime_api::calling_convention::pack_hi_lo_reg(
context.builder(),
context.llvm(),
input_length,
input_pointer.to_int(context),
"input_data",
)?;
let output_data = revive_runtime_api::calling_convention::pack_hi_lo_reg(
context.builder(),
context.llvm(),
output_length_pointer.to_int(context),
output_pointer.to_int(context),
"output_data",
)?;
let name = revive_runtime_api::polkavm_imports::CALL;
let success = context
.build_runtime_call(
name,
&[
flags_and_callee.into(),
context.register_type().const_all_ones().into(),
context.register_type().const_all_ones().into(),
deposit_and_value.into(),
input_data.into(),
output_data.into(),
],
)
.unwrap_or_else(|| panic!("{name} should return a value"))
.into_int_value();
Ok(Some(success.into()))
}
}
impl<D> WriteLLVM<D> for Call
where
D: Dependency + Clone,
{
fn declare(&mut self, context: &mut Context<D>) -> anyhow::Result<()> {
<Self as RuntimeFunction<_>>::declare(self, context)
}
fn into_llvm(self, context: &mut Context<D>) -> anyhow::Result<()> {
<Self as RuntimeFunction<_>>::emit(&self, context)
}
}
@@ -1,7 +1,6 @@
//! The entry function. //! The entry function.
use inkwell::types::BasicType; use inkwell::types::BasicType;
use revive_solc_json_interface::PolkaVMDefaultHeapMemorySize;
use crate::polkavm::context::address_space::AddressSpace; use crate::polkavm::context::address_space::AddressSpace;
use crate::polkavm::context::function::runtime; use crate::polkavm::context::function::runtime;
@@ -39,12 +38,9 @@ impl Entry {
context.xlen_type().const_zero(), context.xlen_type().const_zero(),
); );
let heap_memory_type = context.byte_type().array_type( let heap_memory_type = context
context .byte_type()
.memory_config .array_type(context.memory_config.heap_size);
.heap_size
.unwrap_or(PolkaVMDefaultHeapMemorySize),
);
context.set_global( context.set_global(
crate::polkavm::GLOBAL_HEAP_MEMORY, crate::polkavm::GLOBAL_HEAP_MEMORY,
heap_memory_type, heap_memory_type,
@@ -1,8 +1,6 @@
//! The front-end runtime functions. //! The front-end runtime functions.
pub mod arithmetics; pub mod arithmetics;
pub mod bitwise;
pub mod call;
pub mod deploy_code; pub mod deploy_code;
pub mod entry; pub mod entry;
pub mod revive; pub mod revive;
+6 -18
View File
@@ -25,10 +25,8 @@ use inkwell::debug_info::AsDIScope;
use inkwell::debug_info::DIScope; use inkwell::debug_info::DIScope;
use inkwell::types::BasicType; use inkwell::types::BasicType;
use inkwell::values::BasicValue; use inkwell::values::BasicValue;
use revive_solc_json_interface::PolkaVMDefaultHeapMemorySize;
use revive_solc_json_interface::PolkaVMDefaultStackMemorySize;
use revive_solc_json_interface::SolcStandardJsonInputSettingsPolkaVMMemory;
use crate::memory::MemoryConfig;
use crate::optimizer::settings::Settings as OptimizerSettings; use crate::optimizer::settings::Settings as OptimizerSettings;
use crate::optimizer::Optimizer; use crate::optimizer::Optimizer;
use crate::polkavm::DebugConfig; use crate::polkavm::DebugConfig;
@@ -90,7 +88,7 @@ where
/// The extra LLVM arguments that were used during target initialization. /// The extra LLVM arguments that were used during target initialization.
llvm_arguments: &'ctx [String], llvm_arguments: &'ctx [String],
/// The PVM memory configuration. /// The PVM memory configuration.
memory_config: SolcStandardJsonInputSettingsPolkaVMMemory, memory_config: MemoryConfig,
/// The project dependency manager. It can be any entity implementing the trait. /// The project dependency manager. It can be any entity implementing the trait.
/// The manager is used to get information about contracts and their dependencies during /// The manager is used to get information about contracts and their dependencies during
@@ -230,18 +228,12 @@ where
include_metadata_hash: bool, include_metadata_hash: bool,
debug_config: DebugConfig, debug_config: DebugConfig,
llvm_arguments: &'ctx [String], llvm_arguments: &'ctx [String],
memory_config: SolcStandardJsonInputSettingsPolkaVMMemory, memory_config: MemoryConfig,
) -> Self { ) -> Self {
Self::set_data_layout(llvm, &module); Self::set_data_layout(llvm, &module);
Self::link_stdlib_module(llvm, &module); Self::link_stdlib_module(llvm, &module);
Self::link_polkavm_imports(llvm, &module); Self::link_polkavm_imports(llvm, &module);
Self::set_polkavm_stack_size( Self::set_polkavm_stack_size(llvm, &module, memory_config.stack_size);
llvm,
&module,
memory_config
.stack_size
.unwrap_or(PolkaVMDefaultStackMemorySize),
);
Self::set_module_flags(llvm, &module); Self::set_module_flags(llvm, &module);
let intrinsics = Intrinsics::new(llvm, &module); let intrinsics = Intrinsics::new(llvm, &module);
@@ -1451,11 +1443,7 @@ where
} }
pub fn heap_size(&self) -> inkwell::values::IntValue<'ctx> { pub fn heap_size(&self) -> inkwell::values::IntValue<'ctx> {
self.xlen_type().const_int( self.xlen_type()
self.memory_config .const_int(self.memory_config.heap_size as u64, false)
.heap_size
.unwrap_or(PolkaVMDefaultHeapMemorySize) as u64,
false,
)
} }
} }
@@ -1,15 +1,14 @@
//! Translates the arithmetic operations. //! Translates the arithmetic operations.
use inkwell::values::BasicValue;
use crate::polkavm::context::runtime::RuntimeFunction; use crate::polkavm::context::runtime::RuntimeFunction;
use crate::polkavm::context::Context; use crate::polkavm::context::Context;
use crate::polkavm::Dependency; use crate::polkavm::Dependency;
use crate::PolkaVMAdditionFunction;
use crate::PolkaVMDivisionFunction; use crate::PolkaVMDivisionFunction;
use crate::PolkaVMMultiplicationFunction;
use crate::PolkaVMRemainderFunction; use crate::PolkaVMRemainderFunction;
use crate::PolkaVMSignedDivisionFunction; use crate::PolkaVMSignedDivisionFunction;
use crate::PolkaVMSignedRemainderFunction; use crate::PolkaVMSignedRemainderFunction;
use crate::PolkaVMSubstractionFunction;
/// Translates the arithmetic addition. /// Translates the arithmetic addition.
pub fn addition<'ctx, D>( pub fn addition<'ctx, D>(
@@ -20,11 +19,10 @@ pub fn addition<'ctx, D>(
where where
D: Dependency + Clone, D: Dependency + Clone,
{ {
let name = <PolkaVMAdditionFunction as RuntimeFunction<D>>::NAME;
let declaration = <PolkaVMAdditionFunction as RuntimeFunction<D>>::declaration(context);
Ok(context Ok(context
.build_call(declaration, &[operand_1.into(), operand_2.into()], "SUB") .builder()
.unwrap_or_else(|| panic!("revive runtime function {name} should return a value"))) .build_int_add(operand_1, operand_2, "addition_result")?
.as_basic_value_enum())
} }
/// Translates the arithmetic subtraction. /// Translates the arithmetic subtraction.
@@ -36,11 +34,10 @@ pub fn subtraction<'ctx, D>(
where where
D: Dependency + Clone, D: Dependency + Clone,
{ {
let name = <PolkaVMSubstractionFunction as RuntimeFunction<D>>::NAME;
let declaration = <PolkaVMSubstractionFunction as RuntimeFunction<D>>::declaration(context);
Ok(context Ok(context
.build_call(declaration, &[operand_1.into(), operand_2.into()], "SUB") .builder()
.unwrap_or_else(|| panic!("revive runtime function {name} should return a value"))) .build_int_sub(operand_1, operand_2, "subtraction_result")?
.as_basic_value_enum())
} }
/// Translates the arithmetic multiplication. /// Translates the arithmetic multiplication.
@@ -52,11 +49,10 @@ pub fn multiplication<'ctx, D>(
where where
D: Dependency + Clone, D: Dependency + Clone,
{ {
let name = <PolkaVMMultiplicationFunction as RuntimeFunction<D>>::NAME;
let declaration = <PolkaVMMultiplicationFunction as RuntimeFunction<D>>::declaration(context);
Ok(context Ok(context
.build_call(declaration, &[operand_1.into(), operand_2.into()], "MUL") .builder()
.unwrap_or_else(|| panic!("revive runtime function {name} should return a value"))) .build_int_mul(operand_1, operand_2, "multiplication_result")?
.as_basic_value_enum())
} }
/// Translates the arithmetic division. /// Translates the arithmetic division.
+194 -37
View File
@@ -1,12 +1,9 @@
//! Translates the bitwise operations. //! Translates the bitwise operations.
use crate::polkavm::context::runtime::RuntimeFunction; use inkwell::values::BasicValue;
use crate::polkavm::context::Context; use crate::polkavm::context::Context;
use crate::polkavm::Dependency; use crate::polkavm::Dependency;
use crate::{
PolkaVMAndFunction, PolkaVMByteFunction, PolkaVMOrFunction, PolkaVMSarFunction,
PolkaVMShlFunction, PolkaVMShrFunction, PolkaVMXorFunction,
};
/// Translates the bitwise OR. /// Translates the bitwise OR.
pub fn or<'ctx, D>( pub fn or<'ctx, D>(
@@ -17,11 +14,10 @@ pub fn or<'ctx, D>(
where where
D: Dependency + Clone, D: Dependency + Clone,
{ {
let name = <PolkaVMOrFunction as RuntimeFunction<D>>::NAME;
let declaration = <PolkaVMOrFunction as RuntimeFunction<D>>::declaration(context);
Ok(context Ok(context
.build_call(declaration, &[operand_1.into(), operand_2.into()], "OR") .builder()
.unwrap_or_else(|| panic!("revive runtime function {name} should return a value"))) .build_or(operand_1, operand_2, "or_result")?
.as_basic_value_enum())
} }
/// Translates the bitwise XOR. /// Translates the bitwise XOR.
@@ -33,11 +29,10 @@ pub fn xor<'ctx, D>(
where where
D: Dependency + Clone, D: Dependency + Clone,
{ {
let name = <PolkaVMXorFunction as RuntimeFunction<D>>::NAME;
let declaration = <PolkaVMXorFunction as RuntimeFunction<D>>::declaration(context);
Ok(context Ok(context
.build_call(declaration, &[operand_1.into(), operand_2.into()], "XOR") .builder()
.unwrap_or_else(|| panic!("revive runtime function {name} should return a value"))) .build_xor(operand_1, operand_2, "xor_result")?
.as_basic_value_enum())
} }
/// Translates the bitwise AND. /// Translates the bitwise AND.
@@ -49,11 +44,10 @@ pub fn and<'ctx, D>(
where where
D: Dependency + Clone, D: Dependency + Clone,
{ {
let name = <PolkaVMAndFunction as RuntimeFunction<D>>::NAME;
let declaration = <PolkaVMAndFunction as RuntimeFunction<D>>::declaration(context);
Ok(context Ok(context
.build_call(declaration, &[operand_1.into(), operand_2.into()], "AND") .builder()
.unwrap_or_else(|| panic!("revive runtime function {name} should return a value"))) .build_and(operand_1, operand_2, "and_result")?
.as_basic_value_enum())
} }
/// Translates the bitwise shift left. /// Translates the bitwise shift left.
@@ -65,11 +59,37 @@ pub fn shift_left<'ctx, D>(
where where
D: Dependency + Clone, D: Dependency + Clone,
{ {
let name = <PolkaVMShlFunction as RuntimeFunction<D>>::NAME; let overflow_block = context.append_basic_block("shift_left_overflow");
let declaration = <PolkaVMShlFunction as RuntimeFunction<D>>::declaration(context); let non_overflow_block = context.append_basic_block("shift_left_non_overflow");
Ok(context let join_block = context.append_basic_block("shift_left_join");
.build_call(declaration, &[shift.into(), value.into()], "SHL")
.unwrap_or_else(|| panic!("revive runtime function {name} should return a value"))) let condition_is_overflow = context.builder().build_int_compare(
inkwell::IntPredicate::UGT,
shift,
context.word_const((revive_common::BIT_LENGTH_WORD - 1) as u64),
"shift_left_is_overflow",
)?;
context.build_conditional_branch(condition_is_overflow, overflow_block, non_overflow_block)?;
context.set_basic_block(overflow_block);
context.build_unconditional_branch(join_block);
context.set_basic_block(non_overflow_block);
let value =
context
.builder()
.build_left_shift(value, shift, "shift_left_non_overflow_result")?;
context.build_unconditional_branch(join_block);
context.set_basic_block(join_block);
let result = context
.builder()
.build_phi(context.word_type(), "shift_left_value")?;
result.add_incoming(&[
(&value, non_overflow_block),
(&context.word_const(0), overflow_block),
]);
Ok(result.as_basic_value())
} }
/// Translates the bitwise shift right. /// Translates the bitwise shift right.
@@ -81,11 +101,39 @@ pub fn shift_right<'ctx, D>(
where where
D: Dependency + Clone, D: Dependency + Clone,
{ {
let name = <PolkaVMShrFunction as RuntimeFunction<D>>::NAME; let overflow_block = context.append_basic_block("shift_right_overflow");
let declaration = <PolkaVMShrFunction as RuntimeFunction<D>>::declaration(context); let non_overflow_block = context.append_basic_block("shift_right_non_overflow");
Ok(context let join_block = context.append_basic_block("shift_right_join");
.build_call(declaration, &[shift.into(), value.into()], "SHR")
.unwrap_or_else(|| panic!("revive runtime function {name} should return a value"))) let condition_is_overflow = context.builder().build_int_compare(
inkwell::IntPredicate::UGT,
shift,
context.word_const((revive_common::BIT_LENGTH_WORD - 1) as u64),
"shift_right_is_overflow",
)?;
context.build_conditional_branch(condition_is_overflow, overflow_block, non_overflow_block)?;
context.set_basic_block(overflow_block);
context.build_unconditional_branch(join_block);
context.set_basic_block(non_overflow_block);
let value = context.builder().build_right_shift(
value,
shift,
false,
"shift_right_non_overflow_result",
)?;
context.build_unconditional_branch(join_block);
context.set_basic_block(join_block);
let result = context
.builder()
.build_phi(context.word_type(), "shift_right_value")?;
result.add_incoming(&[
(&value, non_overflow_block),
(&context.word_const(0), overflow_block),
]);
Ok(result.as_basic_value())
} }
/// Translates the arithmetic bitwise shift right. /// Translates the arithmetic bitwise shift right.
@@ -97,11 +145,68 @@ pub fn shift_right_arithmetic<'ctx, D>(
where where
D: Dependency + Clone, D: Dependency + Clone,
{ {
let name = <PolkaVMSarFunction as RuntimeFunction<D>>::NAME; let overflow_block = context.append_basic_block("shift_right_arithmetic_overflow");
let declaration = <PolkaVMSarFunction as RuntimeFunction<D>>::declaration(context); let overflow_positive_block =
Ok(context context.append_basic_block("shift_right_arithmetic_overflow_positive");
.build_call(declaration, &[shift.into(), value.into()], "SHR") let overflow_negative_block =
.unwrap_or_else(|| panic!("revive runtime function {name} should return a value"))) context.append_basic_block("shift_right_arithmetic_overflow_negative");
let non_overflow_block = context.append_basic_block("shift_right_arithmetic_non_overflow");
let join_block = context.append_basic_block("shift_right_arithmetic_join");
let condition_is_overflow = context.builder().build_int_compare(
inkwell::IntPredicate::UGT,
shift,
context.word_const((revive_common::BIT_LENGTH_WORD - 1) as u64),
"shift_right_arithmetic_is_overflow",
)?;
context.build_conditional_branch(condition_is_overflow, overflow_block, non_overflow_block)?;
context.set_basic_block(overflow_block);
let sign_bit = context.builder().build_right_shift(
value,
context.word_const((revive_common::BIT_LENGTH_WORD - 1) as u64),
false,
"shift_right_arithmetic_sign_bit",
)?;
let condition_is_negative = context.builder().build_int_truncate_or_bit_cast(
sign_bit,
context.bool_type(),
"shift_right_arithmetic_sign_bit_truncated",
)?;
context.build_conditional_branch(
condition_is_negative,
overflow_negative_block,
overflow_positive_block,
)?;
context.set_basic_block(overflow_positive_block);
context.build_unconditional_branch(join_block);
context.set_basic_block(overflow_negative_block);
context.build_unconditional_branch(join_block);
context.set_basic_block(non_overflow_block);
let value = context.builder().build_right_shift(
value,
shift,
true,
"shift_right_arithmetic_non_overflow_result",
)?;
context.build_unconditional_branch(join_block);
context.set_basic_block(join_block);
let result = context
.builder()
.build_phi(context.word_type(), "shift_arithmetic_right_value")?;
result.add_incoming(&[
(&value, non_overflow_block),
(
&context.word_type().const_all_ones(),
overflow_negative_block,
),
(&context.word_const(0), overflow_block),
]);
Ok(result.as_basic_value())
} }
/// Translates the `byte` instruction, extracting the byte of `operand_2` /// Translates the `byte` instruction, extracting the byte of `operand_2`
@@ -120,9 +225,61 @@ pub fn byte<'ctx, D>(
where where
D: Dependency + Clone, D: Dependency + Clone,
{ {
let name = <PolkaVMByteFunction as RuntimeFunction<D>>::NAME; const MAX_INDEX_BYTES: u64 = 31;
let declaration = <PolkaVMByteFunction as RuntimeFunction<D>>::declaration(context);
Ok(context let is_overflow_bit = context.builder().build_int_compare(
.build_call(declaration, &[operand_1.into(), operand_2.into()], "BYTE") inkwell::IntPredicate::ULE,
.unwrap_or_else(|| panic!("revive runtime function {name} should return a value"))) operand_1,
context.word_const(MAX_INDEX_BYTES),
"is_overflow_bit",
)?;
let is_overflow_byte = context.builder().build_int_z_extend(
is_overflow_bit,
context.byte_type(),
"is_overflow_byte",
)?;
let mask_byte = context.builder().build_int_mul(
context.byte_type().const_all_ones(),
is_overflow_byte,
"mask_byte",
)?;
let mask_byte_word =
context
.builder()
.build_int_z_extend(mask_byte, context.word_type(), "mask_byte_word")?;
let index_truncated =
context
.builder()
.build_int_truncate(operand_1, context.byte_type(), "index_truncated")?;
let index_in_bits = context.builder().build_int_mul(
index_truncated,
context
.byte_type()
.const_int(revive_common::BIT_LENGTH_BYTE as u64, false),
"index_in_bits",
)?;
let index_from_most_significant_bit = context.builder().build_int_sub(
context.byte_type().const_int(
MAX_INDEX_BYTES * revive_common::BIT_LENGTH_BYTE as u64,
false,
),
index_in_bits,
"index_from_msb",
)?;
let index_extended = context.builder().build_int_z_extend(
index_from_most_significant_bit,
context.word_type(),
"index",
)?;
let mask = context
.builder()
.build_left_shift(mask_byte_word, index_extended, "mask")?;
let masked_value = context.builder().build_and(operand_2, mask, "masked")?;
let byte = context
.builder()
.build_right_shift(masked_value, index_extended, false, "byte")?;
Ok(byte.as_basic_value_enum())
} }
+141 -51
View File
@@ -3,13 +3,12 @@
use inkwell::values::BasicValue; use inkwell::values::BasicValue;
use crate::polkavm::context::argument::Argument; use crate::polkavm::context::argument::Argument;
use crate::polkavm::context::runtime::RuntimeFunction;
use crate::polkavm::context::Context; use crate::polkavm::context::Context;
use crate::polkavm::Dependency; use crate::polkavm::Dependency;
use crate::{PolkaVMCall, PolkaVMCallReentrancyProtector};
const STATIC_CALL_FLAG: u32 = 0b0001_0000; const STATIC_CALL_FLAG: u32 = 0b0001_0000;
const REENTRANT_CALL_FLAG: u32 = 0b0000_1000; const REENTRANT_CALL_FLAG: u32 = 0b0000_1000;
const SOLIDITY_TRANSFER_GAS_STIPEND_THRESHOLD: u64 = 2300;
/// Translates a contract call. /// Translates a contract call.
#[allow(clippy::too_many_arguments)] #[allow(clippy::too_many_arguments)]
@@ -28,45 +27,79 @@ pub fn call<'ctx, D>(
where where
D: Dependency + Clone, D: Dependency + Clone,
{ {
let input_offset = context.safe_truncate_int_to_xlen(input_offset)?; let address_pointer = context.build_address_argument_store(address)?;
let output_offset = context.safe_truncate_int_to_xlen(output_offset)?;
let input_length = context.safe_truncate_int_to_xlen(input_length)?;
let output_length = context.safe_truncate_int_to_xlen(output_length)?;
let deposit_limit_pointer =
context.build_alloca_at_entry(context.word_type(), "deposit_pointer");
let flags = if static_call {
let flags = REENTRANT_CALL_FLAG | STATIC_CALL_FLAG;
context.build_store(deposit_limit_pointer, context.word_type().const_zero())?;
context.xlen_type().const_int(flags as u64, false)
} else {
call_reentrancy_heuristic(
context,
deposit_limit_pointer.value,
gas,
input_length,
output_length,
)?
};
let value = value.unwrap_or_else(|| context.word_const(0)); let value = value.unwrap_or_else(|| context.word_const(0));
let value_pointer = context.build_alloca_at_entry(context.word_type(), "value_pointer");
context.build_store(value_pointer, value)?;
let name = <PolkaVMCall as RuntimeFunction<D>>::NAME; let input_offset = context.safe_truncate_int_to_xlen(input_offset)?;
let declaration = <PolkaVMCall as RuntimeFunction<D>>::declaration(context); let input_length = context.safe_truncate_int_to_xlen(input_length)?;
let arguments = &[ let output_offset = context.safe_truncate_int_to_xlen(output_offset)?;
address.into(), let output_length = context.safe_truncate_int_to_xlen(output_length)?;
value.into(),
input_offset.into(), let input_pointer = context.build_heap_gep(input_offset, input_length)?;
input_length.into(), let output_pointer = context.build_heap_gep(output_offset, output_length)?;
output_offset.into(),
output_length.into(), let output_length_pointer = context.build_alloca_at_entry(context.xlen_type(), "output_length");
deposit_limit_pointer.value.into(), context.build_store(output_length_pointer, output_length)?;
flags.into(),
]; let (flags, deposit_limit_value) = if static_call {
let flags = REENTRANT_CALL_FLAG | STATIC_CALL_FLAG;
(
context.xlen_type().const_int(flags as u64, false),
context.word_type().const_zero(),
)
} else {
call_reentrancy_heuristic(context, gas, input_length, output_length)?
};
let deposit_pointer = context.build_alloca_at_entry(context.word_type(), "deposit_pointer");
context.build_store(deposit_pointer, deposit_limit_value)?;
let flags_and_callee = revive_runtime_api::calling_convention::pack_hi_lo_reg(
context.builder(),
context.llvm(),
flags,
address_pointer.to_int(context),
"address_and_callee",
)?;
let deposit_and_value = revive_runtime_api::calling_convention::pack_hi_lo_reg(
context.builder(),
context.llvm(),
deposit_pointer.to_int(context),
value_pointer.to_int(context),
"deposit_and_value",
)?;
let input_data = revive_runtime_api::calling_convention::pack_hi_lo_reg(
context.builder(),
context.llvm(),
input_length,
input_pointer.to_int(context),
"input_data",
)?;
let output_data = revive_runtime_api::calling_convention::pack_hi_lo_reg(
context.builder(),
context.llvm(),
output_length_pointer.to_int(context),
output_pointer.to_int(context),
"output_data",
)?;
let name = revive_runtime_api::polkavm_imports::CALL;
let success = context let success = context
.build_call(declaration, arguments, "call") .build_runtime_call(
.unwrap_or_else(|| panic!("revive runtime function {name} should return a value")) name,
&[
flags_and_callee.into(),
context.register_type().const_all_ones().into(),
context.register_type().const_all_ones().into(),
deposit_and_value.into(),
input_data.into(),
output_data.into(),
],
)
.unwrap_or_else(|| panic!("{name} should return a value"))
.into_int_value(); .into_int_value();
let is_success = context.builder().build_int_compare( let is_success = context.builder().build_int_compare(
@@ -183,28 +216,85 @@ where
.as_basic_value_enum()) .as_basic_value_enum())
} }
/// The Solidity `address.transfer` and `address.send` call detection heuristic.
///
/// # Why
/// This heuristic is an additional security feature to guard against re-entrancy attacks
/// in case contract authors violate Solidity best practices and use `address.transfer` or
/// `address.send`.
/// While contract authors are supposed to never use `address.transfer` or `address.send`,
/// for a small cost we can be extra defensive about it.
///
/// # How
/// The gas stipend emitted by solc for `transfer` and `send` is not static, thus:
/// - Dynamically allow re-entrancy only for calls considered not transfer or send.
/// - Detected balance transfers will supply 0 deposit limit instead of `u256::MAX`.
///
/// Calls are considered transfer or send if:
/// - (Input length | Output lenght) == 0;
/// - Gas <= 2300;
///
/// # Returns
/// The call flags xlen `IntValue` and the deposit limit word `IntValue`.
fn call_reentrancy_heuristic<'ctx, D>( fn call_reentrancy_heuristic<'ctx, D>(
context: &mut Context<'ctx, D>, context: &mut Context<'ctx, D>,
deposit_limit_pointer: inkwell::values::PointerValue<'ctx>,
gas: inkwell::values::IntValue<'ctx>, gas: inkwell::values::IntValue<'ctx>,
input_length: inkwell::values::IntValue<'ctx>, input_length: inkwell::values::IntValue<'ctx>,
output_length: inkwell::values::IntValue<'ctx>, output_length: inkwell::values::IntValue<'ctx>,
) -> anyhow::Result<inkwell::values::IntValue<'ctx>> ) -> anyhow::Result<(
inkwell::values::IntValue<'ctx>,
inkwell::values::IntValue<'ctx>,
)>
where where
D: Dependency + Clone, D: Dependency + Clone,
{ {
let name = <PolkaVMCallReentrancyProtector as RuntimeFunction<D>>::NAME; // Branch-free SSA implementation: First derive the heuristic boolean (int1) value.
let declaration = <PolkaVMCallReentrancyProtector as RuntimeFunction<D>>::declaration(context); let input_length_or_output_length =
let arguments = &[
deposit_limit_pointer.into(),
gas.into(),
context context
.builder() .builder()
.build_or(input_length, output_length, "input_length_or_output_length")? .build_or(input_length, output_length, "input_length_or_output_length")?;
.into(), let is_no_input_no_output = context.builder().build_int_compare(
]; inkwell::IntPredicate::EQ,
Ok(context context.xlen_type().const_zero(),
.build_call(declaration, arguments, "call_flags") input_length_or_output_length,
.unwrap_or_else(|| panic!("revive runtime function {name} should return a value")) "is_no_input_no_output",
.into_int_value()) )?;
let gas_stipend = context
.word_type()
.const_int(SOLIDITY_TRANSFER_GAS_STIPEND_THRESHOLD, false);
let is_gas_stipend_for_transfer_or_send = context.builder().build_int_compare(
inkwell::IntPredicate::ULE,
gas,
gas_stipend,
"is_gas_stipend_for_transfer_or_send",
)?;
let is_balance_transfer = context.builder().build_and(
is_no_input_no_output,
is_gas_stipend_for_transfer_or_send,
"is_balance_transfer",
)?;
let is_regular_call = context
.builder()
.build_not(is_balance_transfer, "is_balance_transfer_inverted")?;
// Call flag: Left shift the heuristic boolean value.
let is_regular_call_xlen = context.builder().build_int_z_extend(
is_regular_call,
context.xlen_type(),
"is_balance_transfer_xlen",
)?;
let call_flags = context.builder().build_left_shift(
is_regular_call_xlen,
context.xlen_type().const_int(3, false),
"flags",
)?;
// Deposit limit value: Sign-extended the heuristic boolean value.
let deposit_limit_value = context.builder().build_int_s_extend(
is_regular_call,
context.word_type(),
"deposit_limit_value",
)?;
Ok((call_flags, deposit_limit_value))
} }
+4 -4
View File
@@ -7,12 +7,12 @@ pub mod evm;
pub use self::r#const::*; pub use self::r#const::*;
use crate::debug_config::DebugConfig; use crate::debug_config::DebugConfig;
use crate::memory::MemoryConfig;
use crate::optimizer::settings::Settings as OptimizerSettings; use crate::optimizer::settings::Settings as OptimizerSettings;
use anyhow::Context as AnyhowContext; use anyhow::Context as AnyhowContext;
use polkavm_common::program::ProgramBlob; use polkavm_common::program::ProgramBlob;
use polkavm_disassembler::{Disassembler, DisassemblyFormat}; use polkavm_disassembler::{Disassembler, DisassemblyFormat};
use revive_solc_json_interface::SolcStandardJsonInputSettingsPolkaVMMemory;
use sha3::Digest; use sha3::Digest;
use self::context::build::Build; use self::context::build::Build;
@@ -37,7 +37,7 @@ pub fn build_assembly_text(
let mut disassembled_code = Vec::new(); let mut disassembled_code = Vec::new();
disassembler disassembler
.disassemble_into(&mut disassembled_code) .disassemble_into(&mut disassembled_code)
.with_context(|| format!("Failed to disassemble contract: {contract_path}"))?; .with_context(|| format!("Failed to disassemble contract: {}", contract_path))?;
let assembly_text = String::from_utf8(disassembled_code).with_context(|| { let assembly_text = String::from_utf8(disassembled_code).with_context(|| {
format!("Failed to convert disassembled code to string for contract: {contract_path}") format!("Failed to convert disassembled code to string for contract: {contract_path}")
@@ -91,7 +91,7 @@ pub trait Dependency {
include_metadata_hash: bool, include_metadata_hash: bool,
debug_config: DebugConfig, debug_config: DebugConfig,
llvm_arguments: &[String], llvm_arguments: &[String],
memory_config: SolcStandardJsonInputSettingsPolkaVMMemory, memory_config: MemoryConfig,
) -> anyhow::Result<String>; ) -> anyhow::Result<String>;
/// Resolves a full contract path. /// Resolves a full contract path.
@@ -113,7 +113,7 @@ impl Dependency for DummyDependency {
_include_metadata_hash: bool, _include_metadata_hash: bool,
_debug_config: DebugConfig, _debug_config: DebugConfig,
_llvm_arguments: &[String], _llvm_arguments: &[String],
_memory_config: SolcStandardJsonInputSettingsPolkaVMMemory, _memory_config: MemoryConfig,
) -> anyhow::Result<String> { ) -> anyhow::Result<String> {
Ok(String::new()) Ok(String::new())
} }
-11
View File
@@ -1,11 +0,0 @@
fn main() {
match git2::Repository::open("../..") {
Ok(repo) => {
let head = repo.head().expect("should have head");
let commit = head.peel_to_commit().expect("should have commit");
let id = &commit.id().to_string()[..7];
println!("cargo:rustc-env=GIT_COMMIT_HASH={id}");
}
Err(_) => println!("cargo:rustc-env=GIT_COMMIT_HASH=unknown"),
};
}
@@ -1,22 +0,0 @@
object "Test" {
code {
function allocate(size) -> ptr {
ptr := mload(0x40)
if iszero(ptr) { ptr := 0x60 }
mstore(0x40, add(ptr, size))
}
let size := datasize("Test_deployed")
let offset := allocate(size)
datacopy(offset, dataoffset("Test_deployed"), size)
return(offset, size)
}
object "Test_deployed" {
code {
{
let test:=0x5
mstore(2,signextend(0x8,0x0))
mstore(8,lt(0xc,test))
}
return(0, 65536)
}}}
@@ -1,18 +0,0 @@
import { executeCommand } from '../src/helper'
import { paths } from '../src/entities'
describe('tests for the memset builtin to be present', () => {
// -O3 is required to reproduce.
const command = `resolc ${paths.pathToMemsetYulContract} --yul -O3`
const result = executeCommand(command)
it('Valid command exit code = 0', () => {
expect(result.exitCode).toBe(0)
})
it('--yul output is presented', () => {
expect(result.output).toMatch(/(Compiler run successful)/i)
expect(result.output).toMatch(/(No output requested)/i)
})
})
+2 -2
View File
@@ -17,7 +17,7 @@ path = "src/main.rs"
[features] [features]
std = ["polkadot-sdk/std"] std = ["polkadot-sdk/std"]
default = ["solidity"] default = ["solidity"]
solidity = ["resolc", "revive-differential", "revive-llvm-context"] solidity = ["revive-solidity", "revive-differential", "revive-llvm-context"]
[dependencies] [dependencies]
env_logger = { workspace = true } env_logger = { workspace = true }
@@ -39,6 +39,6 @@ polkadot-sdk.features = [
"pallet-timestamp" "pallet-timestamp"
] ]
resolc = { workspace = true, optional = true } revive-solidity = { workspace = true, optional = true }
revive-differential = { workspace = true, optional = true } revive-differential = { workspace = true, optional = true }
revive-llvm-context = { workspace = true, optional = true } revive-llvm-context = { workspace = true, optional = true }
+3 -3
View File
@@ -44,7 +44,7 @@ pub use crate::specs::*;
mod runtime; mod runtime;
mod specs; mod specs;
#[cfg(not(feature = "resolc"))] #[cfg(not(feature = "revive-solidity"))]
pub(crate) const NO_SOLIDITY_FRONTEND: &str = pub(crate) const NO_SOLIDITY_FRONTEND: &str =
"revive-runner was built without the solidity frontend; please enable the 'solidity' feature!"; "revive-runner was built without the solidity frontend; please enable the 'solidity' feature!";
@@ -234,7 +234,7 @@ impl CallResult {
#[derive(Clone, Debug, Serialize, Deserialize)] #[derive(Clone, Debug, Serialize, Deserialize)]
pub enum Code { pub enum Code {
#[cfg(feature = "resolc")] #[cfg(feature = "revive-solidity")]
/// Compile a single solidity source and use the blob of `contract` /// Compile a single solidity source and use the blob of `contract`
Solidity { Solidity {
path: Option<std::path::PathBuf>, path: Option<std::path::PathBuf>,
@@ -270,7 +270,7 @@ impl From<Code> for pallet_revive::Code {
let Ok(source_code) = std::fs::read_to_string(&path) else { let Ok(source_code) = std::fs::read_to_string(&path) else {
panic!("Failed to reead source code from {}", path.display()); panic!("Failed to reead source code from {}", path.display());
}; };
pallet_revive::Code::Upload(resolc::test_utils::compile_blob_with_options( pallet_revive::Code::Upload(revive_solidity::test_utils::compile_blob_with_options(
&contract, &contract,
&source_code, &source_code,
solc_optimizer.unwrap_or(true), solc_optimizer.unwrap_or(true),
+1 -7
View File
@@ -94,12 +94,6 @@ impl FindAuthor<<Runtime as frame_system::Config>::AccountId> for Runtime {
where where
I: 'a + IntoIterator<Item = (frame_support::ConsensusEngineId, &'a [u8])>, I: 'a + IntoIterator<Item = (frame_support::ConsensusEngineId, &'a [u8])>,
{ {
Some( Some([0xff; 32].into())
[[0xff; 20].as_slice(), [0xee; 12].as_slice()]
.concat()
.as_slice()
.try_into()
.unwrap(),
)
} }
} }
+7 -7
View File
@@ -4,12 +4,12 @@ use serde::{Deserialize, Serialize};
use crate::*; use crate::*;
use alloy_primitives::keccak256; use alloy_primitives::keccak256;
#[cfg(feature = "resolc")] #[cfg(feature = "revive-solidity")]
use alloy_primitives::Address; use alloy_primitives::Address;
#[cfg(feature = "resolc")] #[cfg(feature = "revive-solidity")]
use resolc::test_utils::*;
#[cfg(feature = "resolc")]
use revive_differential::{Evm, EvmLog}; use revive_differential::{Evm, EvmLog};
#[cfg(feature = "revive-solidity")]
use revive_solidity::test_utils::*;
const SPEC_MARKER_BEGIN: &str = "/* runner.json"; const SPEC_MARKER_BEGIN: &str = "/* runner.json";
const SPEC_MARKER_END: &str = "*/"; const SPEC_MARKER_END: &str = "*/";
@@ -256,7 +256,7 @@ impl Specs {
}; };
match code { match code {
#[cfg(feature = "resolc")] #[cfg(feature = "revive-solidity")]
Code::Bytes(bytes) if bytes.is_empty() => { Code::Bytes(bytes) if bytes.is_empty() => {
let contract_source = match std::fs::read_to_string(contract_path) { let contract_source = match std::fs::read_to_string(contract_path) {
Err(err) => panic!("unable to read {contract_path}: {err}"), Err(err) => panic!("unable to read {contract_path}: {err}"),
@@ -264,9 +264,9 @@ impl Specs {
}; };
*bytes = compile_blob(contract_name, &contract_source) *bytes = compile_blob(contract_name, &contract_source)
} }
#[cfg(not(feature = "resolc"))] #[cfg(not(feature = "revive-solidity"))]
Code::Bytes(_) => panic!("{NO_SOLIDITY_FRONTEND}"), Code::Bytes(_) => panic!("{NO_SOLIDITY_FRONTEND}"),
#[cfg(feature = "resolc")] #[cfg(feature = "revive-solidity")]
Code::Solidity { path, .. } if path.is_none() => *path = Some(contract_path.into()), Code::Solidity { path, .. } if path.is_none() => *path = Some(contract_path.into()),
_ => continue, _ => continue,
} }
+2 -2
View File
@@ -1,6 +1,6 @@
[package] [package]
name = "revive-runtime-api" name = "revive-runtime-api"
version = "0.2.0" version.workspace = true
license.workspace = true license.workspace = true
edition.workspace = true edition.workspace = true
repository.workspace = true repository.workspace = true
@@ -9,7 +9,7 @@ description = "Implements the low level runtime API bindings with pallet contrac
[dependencies] [dependencies]
anyhow = { workspace = true } anyhow = { workspace = true }
inkwell = { workspace = true, features = ["target-riscv", "no-libffi-linking", "llvm18-1"] } inkwell = { workspace = true, features = ["target-riscv", "no-libffi-linking", "llvm18-0"] }
revive-common = { workspace = true } revive-common = { workspace = true }
+3 -2
View File
@@ -37,11 +37,12 @@ fn compile(source_path: &str, bitcode_path: &str) {
source_path, source_path,
]) ])
.output() .output()
.unwrap_or_else(|error| panic!("failed to execute clang: {error}")); .unwrap_or_else(|error| panic!("failed to execute clang: {}", error));
assert!( assert!(
output.status.success(), output.status.success(),
"failed to compile the PolkaVM C API: {output:?}" "failed to compile the PolkaVM C API: {:?}",
output
); );
} }
-7
View File
@@ -30,13 +30,6 @@ void * memmove(void *dst, const void *src, size_t n) {
return dst; return dst;
} }
void * memset(void *b, int c, size_t len) {
uint8_t *dest = b;
uint8_t val = (uint8_t)c;
while (len-- > 0) *dest++ = val;
return b;
}
// Imports // Imports
POLKAVM_IMPORT(void, address, uint32_t) POLKAVM_IMPORT(void, address, uint32_t)
+2 -2
View File
@@ -1,6 +1,6 @@
[package] [package]
name = "revive-solc-json-interface" name = "revive-solc-json-interface"
version = "0.2.0" version.workspace = true
authors.workspace = true authors.workspace = true
license.workspace = true license.workspace = true
edition.workspace = true edition.workspace = true
@@ -20,4 +20,4 @@ anyhow = { workspace = true }
rayon = { workspace = true, optional = true } rayon = { workspace = true, optional = true }
semver = { workspace = true } semver = { workspace = true }
serde = { workspace = true } serde = { workspace = true }
serde_json = { workspace = true } serde_json = { workspace = true }
-4
View File
@@ -8,10 +8,6 @@ pub use self::standard_json::input::language::Language as SolcStandardJsonInputL
pub use self::standard_json::input::settings::metadata::Metadata as SolcStandardJsonInputSettingsMetadata; pub use self::standard_json::input::settings::metadata::Metadata as SolcStandardJsonInputSettingsMetadata;
pub use self::standard_json::input::settings::metadata_hash::MetadataHash as SolcStandardJsonInputSettingsMetadataHash; pub use self::standard_json::input::settings::metadata_hash::MetadataHash as SolcStandardJsonInputSettingsMetadataHash;
pub use self::standard_json::input::settings::optimizer::Optimizer as SolcStandardJsonInputSettingsOptimizer; pub use self::standard_json::input::settings::optimizer::Optimizer as SolcStandardJsonInputSettingsOptimizer;
pub use self::standard_json::input::settings::polkavm::memory::MemoryConfig as SolcStandardJsonInputSettingsPolkaVMMemory;
pub use self::standard_json::input::settings::polkavm::memory::DEFAULT_HEAP_SIZE as PolkaVMDefaultHeapMemorySize;
pub use self::standard_json::input::settings::polkavm::memory::DEFAULT_STACK_SIZE as PolkaVMDefaultStackMemorySize;
pub use self::standard_json::input::settings::polkavm::PolkaVM as SolcStandardJsonInputSettingsPolkaVM;
pub use self::standard_json::input::settings::selection::file::flag::Flag as SolcStandardJsonInputSettingsSelectionFileFlag; pub use self::standard_json::input::settings::selection::file::flag::Flag as SolcStandardJsonInputSettingsSelectionFileFlag;
pub use self::standard_json::input::settings::selection::file::File as SolcStandardJsonInputSettingsSelectionFile; pub use self::standard_json::input::settings::selection::file::File as SolcStandardJsonInputSettingsSelectionFile;
pub use self::standard_json::input::settings::selection::Selection as SolcStandardJsonInputSettingsSelection; pub use self::standard_json::input::settings::selection::Selection as SolcStandardJsonInputSettingsSelection;
@@ -18,14 +18,13 @@ use crate::standard_json::input::settings::optimizer::Optimizer as SolcStandardJ
use crate::standard_json::input::settings::selection::Selection as SolcStandardJsonInputSettingsSelection; use crate::standard_json::input::settings::selection::Selection as SolcStandardJsonInputSettingsSelection;
#[cfg(feature = "resolc")] #[cfg(feature = "resolc")]
use crate::warning::Warning; use crate::warning::Warning;
use crate::SolcStandardJsonInputSettingsPolkaVM;
use self::language::Language; use self::language::Language;
use self::settings::Settings; use self::settings::Settings;
use self::source::Source; use self::source::Source;
/// The `solc --standard-json` input. /// The `solc --standard-json` input.
#[derive(Clone, Debug, Serialize, Deserialize)] #[derive(Debug, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")] #[serde(rename_all = "camelCase")]
pub struct Input { pub struct Input {
/// The input language. /// The input language.
@@ -64,7 +63,6 @@ impl Input {
optimizer: SolcStandardJsonInputSettingsOptimizer, optimizer: SolcStandardJsonInputSettingsOptimizer,
metadata: Option<SolcStandardJsonInputSettingsMetadata>, metadata: Option<SolcStandardJsonInputSettingsMetadata>,
#[cfg(feature = "resolc")] suppressed_warnings: Option<Vec<Warning>>, #[cfg(feature = "resolc")] suppressed_warnings: Option<Vec<Warning>>,
polkavm: Option<SolcStandardJsonInputSettingsPolkaVM>,
) -> anyhow::Result<Self> { ) -> anyhow::Result<Self> {
let mut paths: BTreeSet<PathBuf> = paths.iter().cloned().collect(); let mut paths: BTreeSet<PathBuf> = paths.iter().cloned().collect();
let libraries = Settings::parse_libraries(library_map)?; let libraries = Settings::parse_libraries(library_map)?;
@@ -92,7 +90,6 @@ impl Input {
output_selection, output_selection,
optimizer, optimizer,
metadata, metadata,
polkavm,
), ),
#[cfg(feature = "resolc")] #[cfg(feature = "resolc")]
suppressed_warnings, suppressed_warnings,
@@ -112,7 +109,6 @@ impl Input {
optimizer: SolcStandardJsonInputSettingsOptimizer, optimizer: SolcStandardJsonInputSettingsOptimizer,
metadata: Option<SolcStandardJsonInputSettingsMetadata>, metadata: Option<SolcStandardJsonInputSettingsMetadata>,
suppressed_warnings: Option<Vec<Warning>>, suppressed_warnings: Option<Vec<Warning>>,
polkavm: Option<SolcStandardJsonInputSettingsPolkaVM>,
) -> anyhow::Result<Self> { ) -> anyhow::Result<Self> {
#[cfg(feature = "parallel")] #[cfg(feature = "parallel")]
let iter = sources.into_par_iter(); // Parallel iterator let iter = sources.into_par_iter(); // Parallel iterator
@@ -133,7 +129,6 @@ impl Input {
output_selection, output_selection,
optimizer, optimizer,
metadata, metadata,
polkavm,
), ),
suppressed_warnings, suppressed_warnings,
}) })
@@ -6,7 +6,7 @@ use serde::Serialize;
use crate::standard_json::input::settings::metadata_hash::MetadataHash; use crate::standard_json::input::settings::metadata_hash::MetadataHash;
/// The `solc --standard-json` input settings metadata. /// The `solc --standard-json` input settings metadata.
#[derive(Clone, Debug, Default, Serialize, Deserialize)] #[derive(Debug, Default, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")] #[serde(rename_all = "camelCase")]
pub struct Metadata { pub struct Metadata {
/// The bytecode hash mode. /// The bytecode hash mode.
@@ -3,7 +3,6 @@
pub mod metadata; pub mod metadata;
pub mod metadata_hash; pub mod metadata_hash;
pub mod optimizer; pub mod optimizer;
pub mod polkavm;
pub mod selection; pub mod selection;
use std::collections::BTreeMap; use std::collections::BTreeMap;
@@ -14,11 +13,10 @@ use serde::Serialize;
use self::metadata::Metadata; use self::metadata::Metadata;
use self::optimizer::Optimizer; use self::optimizer::Optimizer;
use self::polkavm::PolkaVM;
use self::selection::Selection; use self::selection::Selection;
/// The `solc --standard-json` input settings. /// The `solc --standard-json` input settings.
#[derive(Clone, Debug, Serialize, Deserialize)] #[derive(Debug, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")] #[serde(rename_all = "camelCase")]
pub struct Settings { pub struct Settings {
/// The target EVM version. /// The target EVM version.
@@ -45,9 +43,6 @@ pub struct Settings {
/// The metadata settings. /// The metadata settings.
#[serde(skip_serializing_if = "Option::is_none")] #[serde(skip_serializing_if = "Option::is_none")]
pub metadata: Option<Metadata>, pub metadata: Option<Metadata>,
/// The resolc custom PolkaVM settings.
#[serde(skip_serializing_if = "Option::is_none")]
pub polkavm: Option<PolkaVM>,
} }
impl Settings { impl Settings {
@@ -59,7 +54,6 @@ impl Settings {
output_selection: Selection, output_selection: Selection,
optimizer: Optimizer, optimizer: Optimizer,
metadata: Option<Metadata>, metadata: Option<Metadata>,
polkavm: Option<PolkaVM>,
) -> Self { ) -> Self {
Self { Self {
evm_version, evm_version,
@@ -69,13 +63,11 @@ impl Settings {
optimizer, optimizer,
metadata, metadata,
via_ir: Some(true), via_ir: Some(true),
polkavm,
} }
} }
/// Sets the necessary defaults. /// Sets the necessary defaults.
pub fn normalize(&mut self, version: &semver::Version) { pub fn normalize(&mut self, version: &semver::Version) {
self.polkavm = None;
self.optimizer.normalize(version); self.optimizer.normalize(version);
} }
@@ -4,7 +4,7 @@ use serde::Deserialize;
use serde::Serialize; use serde::Serialize;
/// The `solc --standard-json` input settings optimizer details. /// The `solc --standard-json` input settings optimizer details.
#[derive(Clone, Debug, Serialize, Deserialize)] #[derive(Debug, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")] #[serde(rename_all = "camelCase")]
pub struct Details { pub struct Details {
/// Whether the pass is enabled. /// Whether the pass is enabled.
@@ -8,19 +8,19 @@ use serde::Serialize;
use self::details::Details; use self::details::Details;
/// The `solc --standard-json` input settings optimizer. /// The `solc --standard-json` input settings optimizer.
#[derive(Clone, Debug, Serialize, Deserialize)] #[derive(Debug, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")] #[serde(rename_all = "camelCase")]
pub struct Optimizer { pub struct Optimizer {
/// Whether the optimizer is enabled. /// Whether the optimizer is enabled.
pub enabled: bool, pub enabled: bool,
/// The optimization mode string. /// The optimization mode string.
#[serde(skip_serializing_if = "Option::is_none")] #[serde(skip_serializing)]
pub mode: Option<char>, pub mode: Option<char>,
/// The `solc` optimizer details. /// The `solc` optimizer details.
#[serde(skip_serializing_if = "Option::is_none")] #[serde(skip_serializing_if = "Option::is_none")]
pub details: Option<Details>, pub details: Option<Details>,
/// Whether to try to recompile with -Oz if the bytecode is too large. /// Whether to try to recompile with -Oz if the bytecode is too large.
#[serde(skip_serializing_if = "Option::is_none")] #[serde(skip_serializing)]
pub fallback_to_optimizing_for_size: Option<bool>, pub fallback_to_optimizing_for_size: Option<bool>,
} }
@@ -42,8 +42,6 @@ impl Optimizer {
/// Sets the necessary defaults. /// Sets the necessary defaults.
pub fn normalize(&mut self, version: &semver::Version) { pub fn normalize(&mut self, version: &semver::Version) {
self.mode = None;
self.fallback_to_optimizing_for_size = None;
self.details = if version >= &semver::Version::new(0, 5, 5) { self.details = if version >= &semver::Version::new(0, 5, 5) {
Some(Details::disabled(version)) Some(Details::disabled(version))
} else { } else {
@@ -1,36 +0,0 @@
//! The compile time PolkaVM memory configuration settings.
use serde::{Deserialize, Serialize};
pub const DEFAULT_HEAP_SIZE: u32 = 64 * 1024;
pub const DEFAULT_STACK_SIZE: u32 = 32 * 1024;
/// The PolkaVM memory configuration.
#[derive(Clone, Copy, Debug, Deserialize, Serialize)]
pub struct MemoryConfig {
/// The emulated EVM linear heap memory size in bytes.
#[serde(skip_serializing_if = "Option::is_none")]
pub heap_size: Option<u32>,
/// The PVM stack size in bytes.
#[serde(skip_serializing_if = "Option::is_none")]
pub stack_size: Option<u32>,
}
impl MemoryConfig {
/// A shorthand constructor.
pub fn new(heap_size: Option<u32>, stack_size: Option<u32>) -> Self {
Self {
heap_size,
stack_size,
}
}
}
impl Default for MemoryConfig {
fn default() -> Self {
Self {
heap_size: Some(DEFAULT_HEAP_SIZE),
stack_size: Some(DEFAULT_STACK_SIZE),
}
}
}
@@ -1,28 +0,0 @@
//! The `resolc --standard-json` polkavm settings.
//!
//! Used for options specific to PolkaVM which therefor don't exist in solc.
use memory::MemoryConfig;
use serde::{Deserialize, Serialize};
pub mod memory;
/// PVM specific compiler settings.
#[derive(Clone, Copy, Default, Debug, Serialize, Deserialize)]
pub struct PolkaVM {
/// The PolkaVM target machine memory configuration settings.
#[serde(skip_serializing_if = "Option::is_none")]
pub memory_config: Option<MemoryConfig>,
/// Instruct LLVM to emit debug information.
#[serde(skip_serializing_if = "Option::is_none")]
pub debug_information: Option<bool>,
}
impl PolkaVM {
pub fn new(memory_config: Option<MemoryConfig>, debug_information: bool) -> Self {
Self {
memory_config,
debug_information: Some(debug_information),
}
}
}
@@ -10,7 +10,7 @@ use serde::Serialize;
use self::flag::Flag as SelectionFlag; use self::flag::Flag as SelectionFlag;
/// The `solc --standard-json` output file selection. /// The `solc --standard-json` output file selection.
#[derive(Clone, Debug, Default, Serialize, Deserialize, PartialEq)] #[derive(Debug, Default, Serialize, Deserialize, PartialEq)]
pub struct File { pub struct File {
/// The per-file output selections. /// The per-file output selections.
#[serde(rename = "", skip_serializing_if = "Option::is_none")] #[serde(rename = "", skip_serializing_if = "Option::is_none")]
@@ -21,20 +21,8 @@ pub struct File {
} }
impl File { impl File {
/// Creates the selection required for production compilation (excludes EVM bytecode). /// Creates the selection required by our compilation process.
pub fn new_required() -> Self { pub fn new_required() -> Self {
Self {
per_file: Some(HashSet::from_iter([SelectionFlag::AST])),
per_contract: Some(HashSet::from_iter([
SelectionFlag::MethodIdentifiers,
SelectionFlag::Metadata,
SelectionFlag::Yul,
])),
}
}
/// Creates the selection required for test compilation (includes EVM bytecode).
pub fn new_required_for_tests() -> Self {
Self { Self {
per_file: Some(HashSet::from_iter([SelectionFlag::AST])), per_file: Some(HashSet::from_iter([SelectionFlag::AST])),
per_contract: Some(HashSet::from_iter([ per_contract: Some(HashSet::from_iter([
@@ -61,38 +49,3 @@ impl File {
self self
} }
} }
#[cfg(test)]
mod tests {
use super::*;
#[test]
fn production_excludes_evm_bytecode() {
let selection = File::new_required();
let per_contract = selection.per_contract.unwrap();
// Production should NOT include EVM bytecode flags
assert!(!per_contract.contains(&SelectionFlag::EVMBC));
assert!(!per_contract.contains(&SelectionFlag::EVMDBC));
// But should include other required flags
assert!(per_contract.contains(&SelectionFlag::MethodIdentifiers));
assert!(per_contract.contains(&SelectionFlag::Metadata));
assert!(per_contract.contains(&SelectionFlag::Yul));
}
#[test]
fn tests_include_evm_bytecode() {
let selection = File::new_required_for_tests();
let per_contract = selection.per_contract.unwrap();
// Tests should include EVM bytecode flags
assert!(per_contract.contains(&SelectionFlag::EVMBC));
assert!(per_contract.contains(&SelectionFlag::EVMDBC));
// And should also include other required flags
assert!(per_contract.contains(&SelectionFlag::MethodIdentifiers));
assert!(per_contract.contains(&SelectionFlag::Metadata));
assert!(per_contract.contains(&SelectionFlag::Yul));
}
}
@@ -10,7 +10,7 @@ use serde::Serialize;
use self::file::File as FileSelection; use self::file::File as FileSelection;
/// The `solc --standard-json` output selection. /// The `solc --standard-json` output selection.
#[derive(Clone, Debug, Serialize, Deserialize, Default, PartialEq)] #[derive(Debug, Serialize, Deserialize, Default, PartialEq)]
pub struct Selection { pub struct Selection {
/// Only the 'all' wildcard is available for robustness reasons. /// Only the 'all' wildcard is available for robustness reasons.
#[serde(rename = "*", skip_serializing_if = "Option::is_none")] #[serde(rename = "*", skip_serializing_if = "Option::is_none")]
@@ -29,14 +29,6 @@ impl Selection {
} }
} }
/// Creates the selection required for test compilation (includes EVM bytecode).
pub fn new_required_for_tests() -> Self {
Self {
all: Some(FileSelection::new_required_for_tests()),
files: BTreeMap::new(),
}
}
/// Extends the user's output selection with flag required by our compilation process. /// Extends the user's output selection with flag required by our compilation process.
pub fn extend_with_required(&mut self) -> &mut Self { pub fn extend_with_required(&mut self) -> &mut Self {
self.all self.all
@@ -7,7 +7,7 @@ use serde::Deserialize;
use serde::Serialize; use serde::Serialize;
/// The `solc --standard-json` input source. /// The `solc --standard-json` input source.
#[derive(Clone, Debug, Serialize, Deserialize)] #[derive(Debug, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")] #[serde(rename_all = "camelCase")]
pub struct Source { pub struct Source {
/// The source code file content. /// The source code file content.
@@ -1,6 +1,6 @@
[package] [package]
name = "resolc" name = "revive-solidity"
version = "0.3.0" version.workspace = true
license.workspace = true license.workspace = true
edition.workspace = true edition.workspace = true
repository.workspace = true repository.workspace = true
@@ -18,30 +18,33 @@ path = "src/resolc/main.rs"
doctest = false doctest = false
[dependencies] [dependencies]
anyhow = { workspace = true }
clap = { workspace = true } clap = { workspace = true }
hex = { workspace = true } thiserror = { workspace = true }
inkwell = { workspace = true } anyhow = { workspace = true }
once_cell = { workspace = true } which = { workspace = true }
path-slash = { workspace = true } path-slash = { workspace = true }
rayon = { workspace = true, optional = true } rayon = { workspace = true, optional = true }
semver = { workspace = true }
serde = { workspace = true } serde = { workspace = true }
serde_json = { workspace = true } serde_json = { workspace = true }
semver = { workspace = true }
once_cell = { workspace = true }
regex = { workspace = true }
hex = { workspace = true }
num = { workspace = true }
sha3 = { workspace = true } sha3 = { workspace = true }
which = { workspace = true } inkwell = { workspace = true }
revive-common = { workspace = true } revive-common = { workspace = true }
revive-llvm-context = { workspace = true } revive-llvm-context = { workspace = true }
revive-solc-json-interface = { workspace = true, features = ["resolc"] } revive-solc-json-interface = { workspace = true, features = ["resolc"] }
revive-yul = { workspace = true }
[target.'cfg(target_env = "musl")'.dependencies] [target.'cfg(target_env = "musl")'.dependencies]
mimalloc = { version = "0.1.46", default-features = false } mimalloc = { version = "*", default-features = false }
[target.'cfg(target_os = "emscripten")'.dependencies] [target.'cfg(target_os = "emscripten")'.dependencies]
libc = { workspace = true } libc = { workspace = true }
inkwell = { workspace = true, features = ["target-riscv", "llvm18-1-no-llvm-linking"]} inkwell = { workspace = true, features = ["target-riscv", "llvm18-0-no-llvm-linking"]}
[build-dependencies] [build-dependencies]
git2 = { workspace = true, default-features = false } git2 = { workspace = true, default-features = false }
+7
View File
@@ -0,0 +1,7 @@
fn main() {
let repo = git2::Repository::open("../..").expect("should be a repository");
let head = repo.head().expect("should have head");
let commit = head.peel_to_commit().expect("should have commit");
let id = &commit.id().to_string()[..7];
println!("cargo:rustc-env=GIT_COMMIT_HASH={id}");
}
@@ -7,6 +7,7 @@ pub(crate) mod process;
pub(crate) mod project; pub(crate) mod project;
pub(crate) mod solc; pub(crate) mod solc;
pub(crate) mod version; pub(crate) mod version;
pub(crate) mod yul;
pub use self::build::contract::Contract as ContractBuild; pub use self::build::contract::Contract as ContractBuild;
pub use self::build::Build; pub use self::build::Build;
@@ -44,8 +45,6 @@ use revive_solc_json_interface::ResolcWarning;
use revive_solc_json_interface::SolcStandardJsonInput; use revive_solc_json_interface::SolcStandardJsonInput;
use revive_solc_json_interface::SolcStandardJsonInputLanguage; use revive_solc_json_interface::SolcStandardJsonInputLanguage;
use revive_solc_json_interface::SolcStandardJsonInputSettingsOptimizer; use revive_solc_json_interface::SolcStandardJsonInputSettingsOptimizer;
use revive_solc_json_interface::SolcStandardJsonInputSettingsPolkaVM;
use revive_solc_json_interface::SolcStandardJsonInputSettingsPolkaVMMemory;
use revive_solc_json_interface::SolcStandardJsonInputSettingsSelection; use revive_solc_json_interface::SolcStandardJsonInputSettingsSelection;
/// Runs the Yul mode. /// Runs the Yul mode.
@@ -56,7 +55,7 @@ pub fn yul<T: Compiler>(
include_metadata_hash: bool, include_metadata_hash: bool,
debug_config: revive_llvm_context::DebugConfig, debug_config: revive_llvm_context::DebugConfig,
llvm_arguments: &[String], llvm_arguments: &[String],
memory_config: SolcStandardJsonInputSettingsPolkaVMMemory, memory_config: revive_llvm_context::MemoryConfig,
) -> anyhow::Result<Build> { ) -> anyhow::Result<Build> {
let path = match input_files.len() { let path = match input_files.len() {
1 => input_files.first().expect("Always exists"), 1 => input_files.first().expect("Always exists"),
@@ -95,7 +94,7 @@ pub fn llvm_ir(
include_metadata_hash: bool, include_metadata_hash: bool,
debug_config: revive_llvm_context::DebugConfig, debug_config: revive_llvm_context::DebugConfig,
llvm_arguments: &[String], llvm_arguments: &[String],
memory_config: SolcStandardJsonInputSettingsPolkaVMMemory, memory_config: revive_llvm_context::MemoryConfig,
) -> anyhow::Result<Build> { ) -> anyhow::Result<Build> {
let path = match input_files.len() { let path = match input_files.len() {
1 => input_files.first().expect("Always exists"), 1 => input_files.first().expect("Always exists"),
@@ -136,7 +135,7 @@ pub fn standard_output<T: Compiler>(
suppressed_warnings: Option<Vec<ResolcWarning>>, suppressed_warnings: Option<Vec<ResolcWarning>>,
debug_config: revive_llvm_context::DebugConfig, debug_config: revive_llvm_context::DebugConfig,
llvm_arguments: &[String], llvm_arguments: &[String],
memory_config: SolcStandardJsonInputSettingsPolkaVMMemory, memory_config: revive_llvm_context::MemoryConfig,
) -> anyhow::Result<Build> { ) -> anyhow::Result<Build> {
let solc_version = solc.version()?; let solc_version = solc.version()?;
@@ -155,10 +154,6 @@ pub fn standard_output<T: Compiler>(
), ),
None, None,
suppressed_warnings, suppressed_warnings,
Some(SolcStandardJsonInputSettingsPolkaVM::new(
Some(memory_config),
debug_config.emit_debug_info,
)),
)?; )?;
let source_code_files = solc_input let source_code_files = solc_input
@@ -213,8 +208,9 @@ pub fn standard_json<T: Compiler>(
base_path: Option<String>, base_path: Option<String>,
include_paths: Vec<String>, include_paths: Vec<String>,
allow_paths: Option<String>, allow_paths: Option<String>,
mut debug_config: revive_llvm_context::DebugConfig, debug_config: revive_llvm_context::DebugConfig,
llvm_arguments: &[String], llvm_arguments: &[String],
memory_config: revive_llvm_context::MemoryConfig,
) -> anyhow::Result<()> { ) -> anyhow::Result<()> {
let solc_version = solc.version()?; let solc_version = solc.version()?;
@@ -228,9 +224,6 @@ pub fn standard_json<T: Compiler>(
let optimizer_settings = let optimizer_settings =
revive_llvm_context::OptimizerSettings::try_from(&solc_input.settings.optimizer)?; revive_llvm_context::OptimizerSettings::try_from(&solc_input.settings.optimizer)?;
let polkavm_settings = solc_input.settings.polkavm.unwrap_or_default();
debug_config.emit_debug_info = polkavm_settings.debug_information.unwrap_or_default();
let include_metadata_hash = match solc_input.settings.metadata { let include_metadata_hash = match solc_input.settings.metadata {
Some(ref metadata) => metadata.bytecode_hash != Some(MetadataHash::None), Some(ref metadata) => metadata.bytecode_hash != Some(MetadataHash::None),
None => true, None => true,
@@ -265,9 +258,7 @@ pub fn standard_json<T: Compiler>(
include_metadata_hash, include_metadata_hash,
debug_config, debug_config,
llvm_arguments, llvm_arguments,
polkavm_settings memory_config,
.memory_config
.unwrap_or_else(SolcStandardJsonInputSettingsPolkaVMMemory::default),
)?; )?;
build.write_to_standard_json(&mut solc_output, &solc_version)?; build.write_to_standard_json(&mut solc_output, &solc_version)?;
} }
@@ -295,7 +286,7 @@ pub fn combined_json<T: Compiler>(
output_directory: Option<PathBuf>, output_directory: Option<PathBuf>,
overwrite: bool, overwrite: bool,
llvm_arguments: &[String], llvm_arguments: &[String],
memory_config: SolcStandardJsonInputSettingsPolkaVMMemory, memory_config: revive_llvm_context::MemoryConfig,
) -> anyhow::Result<()> { ) -> anyhow::Result<()> {
let build = standard_output( let build = standard_output(
input_files, input_files,
@@ -1,7 +1,6 @@
//! Process for compiling a single compilation unit. //! Process for compiling a single compilation unit.
//! The input data. //! The input data.
use revive_solc_json_interface::SolcStandardJsonInputSettingsPolkaVMMemory;
use serde::Deserialize; use serde::Deserialize;
use serde::Serialize; use serde::Serialize;
@@ -24,7 +23,7 @@ pub struct Input {
/// The extra LLVM arguments give used for manual control. /// The extra LLVM arguments give used for manual control.
pub llvm_arguments: Vec<String>, pub llvm_arguments: Vec<String>,
/// The PVM memory configuration. /// The PVM memory configuration.
pub memory_config: SolcStandardJsonInputSettingsPolkaVMMemory, pub memory_config: revive_llvm_context::MemoryConfig,
} }
impl Input { impl Input {
@@ -36,7 +35,7 @@ impl Input {
optimizer_settings: revive_llvm_context::OptimizerSettings, optimizer_settings: revive_llvm_context::OptimizerSettings,
debug_config: revive_llvm_context::DebugConfig, debug_config: revive_llvm_context::DebugConfig,
llvm_arguments: Vec<String>, llvm_arguments: Vec<String>,
memory_config: SolcStandardJsonInputSettingsPolkaVMMemory, memory_config: revive_llvm_context::MemoryConfig,
) -> Self { ) -> Self {
Self { Self {
contract, contract,
@@ -8,7 +8,7 @@ use std::collections::HashSet;
use serde::Deserialize; use serde::Deserialize;
use serde::Serialize; use serde::Serialize;
use revive_yul::parser::statement::object::Object; use crate::yul::parser::statement::object::Object;
use self::llvm_ir::LLVMIR; use self::llvm_ir::LLVMIR;
use self::yul::Yul; use self::yul::Yul;
@@ -5,7 +5,7 @@ use std::collections::HashSet;
use serde::Deserialize; use serde::Deserialize;
use serde::Serialize; use serde::Serialize;
use revive_yul::parser::statement::object::Object; use crate::yul::parser::statement::object::Object;
/// The contract Yul source code. /// The contract Yul source code.
#[derive(Debug, Serialize, Deserialize, Clone)] #[derive(Debug, Serialize, Deserialize, Clone)]
@@ -5,7 +5,6 @@ pub mod metadata;
use std::collections::HashSet; use std::collections::HashSet;
use revive_solc_json_interface::SolcStandardJsonInputSettingsPolkaVMMemory;
use serde::Deserialize; use serde::Deserialize;
use serde::Serialize; use serde::Serialize;
use sha3::Digest; use sha3::Digest;
@@ -79,7 +78,7 @@ impl Contract {
include_metadata_hash: bool, include_metadata_hash: bool,
debug_config: revive_llvm_context::DebugConfig, debug_config: revive_llvm_context::DebugConfig,
llvm_arguments: &[String], llvm_arguments: &[String],
memory_config: SolcStandardJsonInputSettingsPolkaVMMemory, memory_config: revive_llvm_context::MemoryConfig,
) -> anyhow::Result<ContractBuild> { ) -> anyhow::Result<ContractBuild> {
let llvm = inkwell::context::Context::create(); let llvm = inkwell::context::Context::create();
let optimizer = revive_llvm_context::Optimizer::new(optimizer_settings); let optimizer = revive_llvm_context::Optimizer::new(optimizer_settings);
@@ -9,14 +9,11 @@ use std::path::Path;
#[cfg(feature = "parallel")] #[cfg(feature = "parallel")]
use rayon::iter::{IntoParallelIterator, ParallelIterator}; use rayon::iter::{IntoParallelIterator, ParallelIterator};
use revive_solc_json_interface::SolcStandardJsonOutput;
use serde::Deserialize; use serde::Deserialize;
use serde::Serialize; use serde::Serialize;
use sha3::Digest; use sha3::Digest;
use revive_solc_json_interface::SolcStandardJsonOutput;
use revive_yul::lexer::Lexer;
use revive_yul::parser::statement::object::Object;
use crate::build::contract::Contract as ContractBuild; use crate::build::contract::Contract as ContractBuild;
use crate::build::Build; use crate::build::Build;
use crate::missing_libraries::MissingLibraries; use crate::missing_libraries::MissingLibraries;
@@ -25,6 +22,8 @@ use crate::process::Process;
use crate::project::contract::ir::IR; use crate::project::contract::ir::IR;
use crate::solc::version::Version as SolcVersion; use crate::solc::version::Version as SolcVersion;
use crate::solc::Compiler; use crate::solc::Compiler;
use crate::yul::lexer::Lexer;
use crate::yul::parser::statement::object::Object;
use self::contract::Contract; use self::contract::Contract;
@@ -68,7 +67,7 @@ impl Project {
include_metadata_hash: bool, include_metadata_hash: bool,
debug_config: revive_llvm_context::DebugConfig, debug_config: revive_llvm_context::DebugConfig,
llvm_arguments: &[String], llvm_arguments: &[String],
memory_config: revive_solc_json_interface::SolcStandardJsonInputSettingsPolkaVMMemory, memory_config: revive_llvm_context::MemoryConfig,
) -> anyhow::Result<Build> { ) -> anyhow::Result<Build> {
let project = self.clone(); let project = self.clone();
#[cfg(feature = "parallel")] #[cfg(feature = "parallel")]
@@ -155,8 +154,8 @@ impl Project {
.iter() .iter()
.flat_map(|(file, names)| { .flat_map(|(file, names)| {
names names
.keys() .iter()
.map(|name| format!("{file}:{name}")) .map(|(name, _address)| format!("{file}:{name}"))
.collect::<HashSet<String>>() .collect::<HashSet<String>>()
}) })
.collect::<HashSet<String>>(); .collect::<HashSet<String>>();
@@ -322,7 +321,7 @@ impl revive_llvm_context::PolkaVMDependency for Project {
include_metadata_hash: bool, include_metadata_hash: bool,
debug_config: revive_llvm_context::DebugConfig, debug_config: revive_llvm_context::DebugConfig,
llvm_arguments: &[String], llvm_arguments: &[String],
memory_config: revive_solc_json_interface::SolcStandardJsonInputSettingsPolkaVMMemory, memory_config: revive_llvm_context::MemoryConfig,
) -> anyhow::Result<String> { ) -> anyhow::Result<String> {
let contract_path = project.resolve_path(identifier)?; let contract_path = project.resolve_path(identifier)?;
let contract = project let contract = project
@@ -23,6 +23,10 @@ pub struct Arguments {
#[arg(long = "supported-solc-versions")] #[arg(long = "supported-solc-versions")]
pub supported_solc_versions: bool, pub supported_solc_versions: bool,
/// Print the licence and exit.
#[arg(long = "license")]
pub license: bool,
/// Specify the input paths and remappings. /// Specify the input paths and remappings.
/// If an argument contains a '=', it is considered a remapping. /// If an argument contains a '=', it is considered a remapping.
/// Multiple Solidity files can be passed in the default Solidity mode. /// Multiple Solidity files can be passed in the default Solidity mode.
@@ -181,8 +185,8 @@ pub struct Arguments {
/// 1.Increasing the heap size will increase startup costs. /// 1.Increasing the heap size will increase startup costs.
/// 2.The heap size contributes to the total memory size a contract can use, /// 2.The heap size contributes to the total memory size a contract can use,
/// which includes the contracts code size /// which includes the contracts code size
#[arg(long = "heap-size")] #[arg(long = "heap-size", default_value = "65536")]
pub heap_size: Option<u32>, pub heap_size: u32,
/// The contracts total stack size in bytes. /// The contracts total stack size in bytes.
/// ///
@@ -196,8 +200,8 @@ pub struct Arguments {
/// 1.Increasing the heap size will increase startup costs. /// 1.Increasing the heap size will increase startup costs.
/// 2.The stack size contributes to the total memory size a contract can use, /// 2.The stack size contributes to the total memory size a contract can use,
/// which includes the contracts code size /// which includes the contracts code size
#[arg(long = "stack-size")] #[arg(long = "stack-size", default_value = "32768")]
pub stack_size: Option<u32>, pub stack_size: u32,
} }
impl Arguments { impl Arguments {
@@ -326,22 +330,6 @@ impl Arguments {
if self.metadata_hash.is_some() { if self.metadata_hash.is_some() {
anyhow::bail!("Metadata hash mode must specified in standard JSON input settings."); anyhow::bail!("Metadata hash mode must specified in standard JSON input settings.");
} }
if self.heap_size.is_some() {
anyhow::bail!(
"Heap size must be specified in standard JSON input polkavm memory settings."
);
}
if self.stack_size.is_some() {
anyhow::bail!(
"Stack size must be specified in standard JSON input polkavm memory settings."
);
}
if self.emit_source_debug_info {
anyhow::bail!(
"Debug info must be requested in standard JSON input polkavm settings."
);
}
} }
Ok(()) Ok(())
@@ -5,7 +5,7 @@ pub mod arguments;
use std::io::Write; use std::io::Write;
use std::str::FromStr; use std::str::FromStr;
use resolc::Process; use revive_solidity::Process;
use self::arguments::Arguments; use self::arguments::Arguments;
@@ -36,7 +36,7 @@ fn main_inner() -> anyhow::Result<()> {
std::io::stdout(), std::io::stdout(),
"{} version {}", "{} version {}",
env!("CARGO_PKG_DESCRIPTION"), env!("CARGO_PKG_DESCRIPTION"),
resolc::ResolcVersion::default().long revive_solidity::ResolcVersion::default().long
)?; )?;
return Ok(()); return Ok(());
} }
@@ -45,12 +45,20 @@ fn main_inner() -> anyhow::Result<()> {
writeln!( writeln!(
std::io::stdout(), std::io::stdout(),
">={},<={}", ">={},<={}",
resolc::SolcFirstSupportedVersion, revive_solidity::SolcFirstSupportedVersion,
resolc::SolcLastSupportedVersion, revive_solidity::SolcLastSupportedVersion,
)?; )?;
return Ok(()); return Ok(());
} }
if arguments.license {
let license_mit = include_str!("../../../../LICENSE-MIT");
let license_apache = include_str!("../../../../LICENSE-APACHE");
writeln!(std::io::stdout(), "{}\n{}\n", license_mit, license_apache)?;
return Ok(());
}
#[cfg(feature = "parallel")] #[cfg(feature = "parallel")]
rayon::ThreadPoolBuilder::new() rayon::ThreadPoolBuilder::new()
.stack_size(RAYON_WORKER_STACK_SIZE) .stack_size(RAYON_WORKER_STACK_SIZE)
@@ -63,20 +71,20 @@ fn main_inner() -> anyhow::Result<()> {
let mut infile = std::fs::File::open(fname)?; let mut infile = std::fs::File::open(fname)?;
#[cfg(target_os = "emscripten")] #[cfg(target_os = "emscripten")]
{ {
return resolc::WorkerProcess::run(Some(&mut infile)); return revive_solidity::WorkerProcess::run(Some(&mut infile));
} }
#[cfg(not(target_os = "emscripten"))] #[cfg(not(target_os = "emscripten"))]
{ {
return resolc::NativeProcess::run(Some(&mut infile)); return revive_solidity::NativeProcess::run(Some(&mut infile));
} }
} }
#[cfg(target_os = "emscripten")] #[cfg(target_os = "emscripten")]
{ {
return resolc::WorkerProcess::run(None); return revive_solidity::WorkerProcess::run(None);
} }
#[cfg(not(target_os = "emscripten"))] #[cfg(not(target_os = "emscripten"))]
{ {
return resolc::NativeProcess::run(None); return revive_solidity::NativeProcess::run(None);
} }
} }
@@ -103,16 +111,14 @@ fn main_inner() -> anyhow::Result<()> {
let mut solc = { let mut solc = {
#[cfg(target_os = "emscripten")] #[cfg(target_os = "emscripten")]
{ {
resolc::SoljsonCompiler revive_solidity::SoljsonCompiler
} }
#[cfg(not(target_os = "emscripten"))] #[cfg(not(target_os = "emscripten"))]
{ {
resolc::SolcCompiler::new( revive_solidity::SolcCompiler::new(arguments.solc.unwrap_or_else(|| {
arguments revive_solidity::SolcCompiler::DEFAULT_EXECUTABLE_NAME.to_owned()
.solc }))?
.unwrap_or_else(|| resolc::SolcCompiler::DEFAULT_EXECUTABLE_NAME.to_owned()),
)?
} }
}; };
@@ -142,13 +148,13 @@ fn main_inner() -> anyhow::Result<()> {
None => true, None => true,
}; };
let memory_config = revive_solc_json_interface::SolcStandardJsonInputSettingsPolkaVMMemory::new( let memory_config = revive_llvm_context::MemoryConfig {
arguments.heap_size, heap_size: arguments.heap_size,
arguments.stack_size, stack_size: arguments.stack_size,
); };
let build = if arguments.yul { let build = if arguments.yul {
resolc::yul( revive_solidity::yul(
input_files.as_slice(), input_files.as_slice(),
&mut solc, &mut solc,
optimizer_settings, optimizer_settings,
@@ -158,7 +164,7 @@ fn main_inner() -> anyhow::Result<()> {
memory_config, memory_config,
) )
} else if arguments.llvm_ir { } else if arguments.llvm_ir {
resolc::llvm_ir( revive_solidity::llvm_ir(
input_files.as_slice(), input_files.as_slice(),
optimizer_settings, optimizer_settings,
include_metadata_hash, include_metadata_hash,
@@ -167,7 +173,7 @@ fn main_inner() -> anyhow::Result<()> {
memory_config, memory_config,
) )
} else if arguments.standard_json { } else if arguments.standard_json {
resolc::standard_json( revive_solidity::standard_json(
&mut solc, &mut solc,
arguments.detect_missing_libraries, arguments.detect_missing_libraries,
arguments.base_path, arguments.base_path,
@@ -175,10 +181,11 @@ fn main_inner() -> anyhow::Result<()> {
arguments.allow_paths, arguments.allow_paths,
debug_config, debug_config,
&arguments.llvm_arguments, &arguments.llvm_arguments,
memory_config,
)?; )?;
return Ok(()); return Ok(());
} else if let Some(format) = arguments.combined_json { } else if let Some(format) = arguments.combined_json {
resolc::combined_json( revive_solidity::combined_json(
format, format,
input_files.as_slice(), input_files.as_slice(),
arguments.libraries, arguments.libraries,
@@ -200,7 +207,7 @@ fn main_inner() -> anyhow::Result<()> {
)?; )?;
return Ok(()); return Ok(());
} else { } else {
resolc::standard_output( revive_solidity::standard_output(
input_files.as_slice(), input_files.as_slice(),
arguments.libraries, arguments.libraries,
&mut solc, &mut solc,
@@ -240,7 +247,9 @@ fn main_inner() -> anyhow::Result<()> {
writeln!( writeln!(
std::io::stdout(), std::io::stdout(),
"Contract `{path}` assembly:\n\n{assembly_text}" "Contract `{}` assembly:\n\n{}",
path,
assembly_text
)?; )?;
} }
if arguments.output_binary { if arguments.output_binary {
@@ -19,7 +19,7 @@ use self::version::Version;
pub const FIRST_SUPPORTED_VERSION: semver::Version = semver::Version::new(0, 8, 0); pub const FIRST_SUPPORTED_VERSION: semver::Version = semver::Version::new(0, 8, 0);
/// The last supported version of `solc`. /// The last supported version of `solc`.
pub const LAST_SUPPORTED_VERSION: semver::Version = semver::Version::new(0, 8, 30); pub const LAST_SUPPORTED_VERSION: semver::Version = semver::Version::new(0, 8, 29);
/// `--include-path` was introduced in solc `0.8.8` <https://github.com/ethereum/solidity/releases/tag/v0.8.8> /// `--include-path` was introduced in solc `0.8.8` <https://github.com/ethereum/solidity/releases/tag/v0.8.8>
pub const FIRST_INCLUDE_PATH_VERSION: semver::Version = semver::Version::new(0, 8, 8); pub const FIRST_INCLUDE_PATH_VERSION: semver::Version = semver::Version::new(0, 8, 8);
@@ -89,7 +89,7 @@ pub fn build_solidity_with_options(
sources.clone(), sources.clone(),
libraries.clone(), libraries.clone(),
remappings, remappings,
SolcStandardJsonInputSettingsSelection::new_required_for_tests(), SolcStandardJsonInputSettingsSelection::new_required(),
SolcStandardJsonInputSettingsOptimizer::new( SolcStandardJsonInputSettingsOptimizer::new(
solc_optimizer_enabled, solc_optimizer_enabled,
optimizer_settings.middle_end_as_string().chars().last(), optimizer_settings.middle_end_as_string().chars().last(),
@@ -98,7 +98,6 @@ pub fn build_solidity_with_options(
), ),
None, None,
None, None,
None,
)?; )?;
let mut output = solc.standard_json(input, None, vec![], None)?; let mut output = solc.standard_json(input, None, vec![], None)?;
@@ -154,7 +153,7 @@ pub fn build_solidity_with_options_evm(
sources.clone(), sources.clone(),
libraries.clone(), libraries.clone(),
remappings, remappings,
SolcStandardJsonInputSettingsSelection::new_required_for_tests(), SolcStandardJsonInputSettingsSelection::new_required(),
SolcStandardJsonInputSettingsOptimizer::new( SolcStandardJsonInputSettingsOptimizer::new(
solc_optimizer_enabled, solc_optimizer_enabled,
None, None,
@@ -163,7 +162,6 @@ pub fn build_solidity_with_options_evm(
), ),
None, None,
None, None,
None,
)?; )?;
let mut output = solc.standard_json(input, None, vec![], None)?; let mut output = solc.standard_json(input, None, vec![], None)?;
@@ -211,11 +209,10 @@ pub fn build_solidity_and_detect_missing_libraries(
sources.clone(), sources.clone(),
libraries.clone(), libraries.clone(),
None, None,
SolcStandardJsonInputSettingsSelection::new_required_for_tests(), SolcStandardJsonInputSettingsSelection::new_required(),
SolcStandardJsonInputSettingsOptimizer::new(true, None, &solc_version.default, false), SolcStandardJsonInputSettingsOptimizer::new(true, None, &solc_version.default, false),
None, None,
None, None,
None,
)?; )?;
let mut output = solc.standard_json(input, None, vec![], None)?; let mut output = solc.standard_json(input, None, vec![], None)?;
@@ -285,11 +282,10 @@ pub fn check_solidity_warning(
sources.clone(), sources.clone(),
libraries, libraries,
None, None,
SolcStandardJsonInputSettingsSelection::new_required_for_tests(), SolcStandardJsonInputSettingsSelection::new_required(),
SolcStandardJsonInputSettingsOptimizer::new(true, None, &solc_version.default, false), SolcStandardJsonInputSettingsOptimizer::new(true, None, &solc_version.default, false),
None, None,
suppressed_warnings, suppressed_warnings,
None,
)?; )?;
let output = solc.standard_json(input, None, vec![], None)?; let output = solc.standard_json(input, None, vec![], None)?;
@@ -361,7 +357,7 @@ fn compile_evm(
.expect("source should compile"); .expect("source should compile");
let object = &contracts let object = &contracts
.get(contract_name) .get(contract_name)
.unwrap_or_else(|| panic!("contract '{contract_name}' didn't produce bin-runtime")); .unwrap_or_else(|| panic!("contract '{}' didn't produce bin-runtime", contract_name));
let code = if runtime { let code = if runtime {
object.1.object.as_str() object.1.object.as_str()
} else { } else {
@@ -15,11 +15,6 @@ const pathToBasicYulContract = path.join(
'yul', 'yul',
contractYulFilename contractYulFilename
) )
const pathToMemsetYulContract = path.join(
pathToContracts,
'yul',
'memset.yul'
)
const pathToBasicSolContract = path.join( const pathToBasicSolContract = path.join(
pathToContracts, pathToContracts,
'solidity', 'solidity',
@@ -47,7 +42,6 @@ export const paths = {
pathToContracts: pathToContracts, pathToContracts: pathToContracts,
pathToBasicSolContract: pathToBasicSolContract, pathToBasicSolContract: pathToBasicSolContract,
pathToBasicYulContract: pathToBasicYulContract, pathToBasicYulContract: pathToBasicYulContract,
pathToMemsetYulContract: pathToMemsetYulContract,
pathToSolBinOutputFile: pathToSolBinOutputFile, pathToSolBinOutputFile: pathToSolBinOutputFile,
pathToSolAsmOutputFile: pathToSolAsmOutputFile, pathToSolAsmOutputFile: pathToSolAsmOutputFile,
} }

Some files were not shown because too many files have changed in this diff Show More