Compare commits

...

26 Commits

Author SHA1 Message Date
xermicus 046455db06 release v0.5.0 (#401)
Signed-off-by: Cyrill Leutwiler <bigcyrill@hotmail.com>
2025-11-03 16:10:20 +01:00
xermicus 70037e1136 initial SELFDESTRUCT support (#400)
Note:
- The unstable interface in `v2509.0.0` of `polkadot-sdk` is required.
- The differential test fails against EVM in `v2509.0.0` of
`polkadot-sdk`.

---------

Signed-off-by: Cyrill Leutwiler <bigcyrill@hotmail.com>
2025-11-03 15:04:04 +01:00
xermicus c0cdde5a5a llvm-context: fix off-by-one in SDIV overflow semantics (#398)
- Fix the wrong predicate (the negative side in 2s complement has one
more bit)
- Increase test coverage

Signed-off-by: xermicus <cyrill@parity.io>
2025-10-31 14:07:01 +01:00
xermicus df1921ba93 runtime-api: sync syscall function signatures with pallet (#397)
This PR synchronizes the syscall function signatures in the runtime-api
with the current revive pallet API surface.

Signed-off-by: xermicus <cyrill@parity.io>
2025-10-30 14:43:55 +01:00
xermicus 84018c18ae switch to the new storage API (#396)
This PR switches to the new `get_storage_or_zero` and
`set_storage_or_clear` syscalls which are more tailored towards
Solidity.

Signed-off-by: Cyrill Leutwiler <bigcyrill@hotmail.com>
2025-10-30 14:13:37 +01:00
xermicus 42cac55be8 update cargo dependencies (#395)
Signed-off-by: Cyrill Leutwiler <bigcyrill@hotmail.com>
2025-10-29 10:01:05 +01:00
kvpanch 6549a4f825 Strip minsize attribute from functions with large div/rem (#390)
That's a workaround to avoid LLVM backend crash while selecting
instruction for 256-bit integer division.
The workaround needs to be removed after we switch to newest inkwell
that has a fix in RISC-V backend

---------

Signed-off-by: kvp <mammal_windier8j@icloud.com>
2025-10-21 10:35:40 +02:00
xermicus f46bea6a96 llvm-context: do not trap zero length OOB heap access (#389)
Fixes https://github.com/paritytech/contract-issues/issues/120

---------

Signed-off-by: xermicus <cyrill@parity.io>
2025-10-15 22:39:42 +02:00
xermicus 2090830858 release 0.4.1 (#388)
Signed-off-by: Cyrill Leutwiler <bigcyrill@hotmail.com>
2025-10-08 14:04:48 +02:00
Pavlo Khrystenko 93c6387dae Fix output selection issues for Foundry (#386)
### Description 

Fixes output selection issues for `Foundry` usage. 

- pruning to look at per file settings
- source to include `ast`


### Note 

`Selection.files` field is reintroduced because that's the way `foundry`
functions. it uses per-file output selection

---------

Co-authored-by: xermicus <cyrill@parity.io>
2025-10-08 12:48:41 +02:00
xermicus 7346d82dfa do not prune the AST output in standard JSON mode (#385)
- do not prune the AST output in standard JSON mode (required for
foundry)
- do not serialize the output format if there was not blob produced

Signed-off-by: Cyrill Leutwiler <bigcyrill@hotmail.com>
2025-10-07 15:27:44 +02:00
Alexander Samusev 39a6db7266 ci: add reusable action for release workflows (#382)
Let's check how good `claude` is.

fix https://github.com/paritytech/revive/issues/359
2025-10-06 17:08:25 +02:00
xermicus 8240163be0 release resolc 0.4.0 (#384)
Signed-off-by: Cyrill Leutwiler <bigcyrill@hotmail.com>
2025-10-06 09:12:34 +02:00
xermicus b560d72139 Prevent frontend function confusion (#383)
Function symbols can clash as we compile multiple YUL `object`
definition into the same `LLVM` module.
- Disambiguate via unique function symbols based its location (runtime
or deploy code).
- Use `LinkOnceODR` linkage for compiler builtin helpers.

---------

Signed-off-by: Cyrill Leutwiler <bigcyrill@hotmail.com>
2025-09-29 23:05:57 +02:00
xermicus 6858cb9a61 mark internal functions linker private (#381)
Prevents unused functions in the emitted ELF object. Drive-by add a
missing test case (which misses a relocation under `-Oz` when all
internal functions are marked as private).

---------

Signed-off-by: Cyrill Leutwiler <bigcyrill@hotmail.com>
2025-09-29 17:55:29 +02:00
xermicus 1cc4f967b4 vet cargo docs on CI (#380)
Signed-off-by: Cyrill Leutwiler <bigcyrill@hotmail.com>
2025-09-29 13:39:09 +02:00
xermicus 713b7e5409 Nightly release workflow fix (#378)
Signed-off-by: Cyrill Leutwiler <bigcyrill@hotmail.com>
2025-09-28 13:12:10 +02:00
dependabot[bot] ffc13697ed Bump brace-expansion (#377)
Bumps and
[brace-expansion](https://github.com/juliangruber/brace-expansion).
These dependencies needed to be updated together.
Updates `brace-expansion` from 1.1.11 to 1.1.12
<details>
<summary>Release notes</summary>
<p><em>Sourced from <a
href="https://github.com/juliangruber/brace-expansion/releases">brace-expansion's
releases</a>.</em></p>
<blockquote>
<h2>v1.1.12</h2>
<ul>
<li>pkg: publish on tag 1.x  c460dbd</li>
<li>fmt  ccb8ac6</li>
<li>Fix potential ReDoS Vulnerability or Inefficient Regular Expression
(<a
href="https://redirect.github.com/juliangruber/brace-expansion/issues/65">#65</a>)
c3c73c8</li>
</ul>
<hr />
<p><a
href="https://github.com/juliangruber/brace-expansion/compare/v1.1.11...v1.1.12">https://github.com/juliangruber/brace-expansion/compare/v1.1.11...v1.1.12</a></p>
</blockquote>
</details>
<details>
<summary>Commits</summary>
<ul>
<li><a
href="https://github.com/juliangruber/brace-expansion/commit/44f33b47c5c6a965d507421af43e86cf5971d711"><code>44f33b4</code></a>
1.1.12</li>
<li><a
href="https://github.com/juliangruber/brace-expansion/commit/c460dbd68e428d147b2080622d8ce126c7a08570"><code>c460dbd</code></a>
pkg: publish on tag 1.x</li>
<li><a
href="https://github.com/juliangruber/brace-expansion/commit/ccb8ac6d4292b7661b677fe048ba6690c877f51f"><code>ccb8ac6</code></a>
fmt</li>
<li><a
href="https://github.com/juliangruber/brace-expansion/commit/c3c73c8b088defc70851843be88ccc3af08e7217"><code>c3c73c8</code></a>
Fix potential ReDoS Vulnerability or Inefficient Regular Expression (<a
href="https://redirect.github.com/juliangruber/brace-expansion/issues/65">#65</a>)</li>
<li>See full diff in <a
href="https://github.com/juliangruber/brace-expansion/compare/1.1.11...v1.1.12">compare
view</a></li>
</ul>
</details>
<br />

Updates `brace-expansion` from 2.0.1 to 2.0.2
<details>
<summary>Release notes</summary>
<p><em>Sourced from <a
href="https://github.com/juliangruber/brace-expansion/releases">brace-expansion's
releases</a>.</em></p>
<blockquote>
<h2>v1.1.12</h2>
<ul>
<li>pkg: publish on tag 1.x  c460dbd</li>
<li>fmt  ccb8ac6</li>
<li>Fix potential ReDoS Vulnerability or Inefficient Regular Expression
(<a
href="https://redirect.github.com/juliangruber/brace-expansion/issues/65">#65</a>)
c3c73c8</li>
</ul>
<hr />
<p><a
href="https://github.com/juliangruber/brace-expansion/compare/v1.1.11...v1.1.12">https://github.com/juliangruber/brace-expansion/compare/v1.1.11...v1.1.12</a></p>
</blockquote>
</details>
<details>
<summary>Commits</summary>
<ul>
<li><a
href="https://github.com/juliangruber/brace-expansion/commit/44f33b47c5c6a965d507421af43e86cf5971d711"><code>44f33b4</code></a>
1.1.12</li>
<li><a
href="https://github.com/juliangruber/brace-expansion/commit/c460dbd68e428d147b2080622d8ce126c7a08570"><code>c460dbd</code></a>
pkg: publish on tag 1.x</li>
<li><a
href="https://github.com/juliangruber/brace-expansion/commit/ccb8ac6d4292b7661b677fe048ba6690c877f51f"><code>ccb8ac6</code></a>
fmt</li>
<li><a
href="https://github.com/juliangruber/brace-expansion/commit/c3c73c8b088defc70851843be88ccc3af08e7217"><code>c3c73c8</code></a>
Fix potential ReDoS Vulnerability or Inefficient Regular Expression (<a
href="https://redirect.github.com/juliangruber/brace-expansion/issues/65">#65</a>)</li>
<li>See full diff in <a
href="https://github.com/juliangruber/brace-expansion/compare/1.1.11...v1.1.12">compare
view</a></li>
</ul>
</details>
<br />


Dependabot will resolve any conflicts with this PR as long as you don't
alter it yourself. You can also trigger a rebase manually by commenting
`@dependabot rebase`.

[//]: # (dependabot-automerge-start)
[//]: # (dependabot-automerge-end)

---

<details>
<summary>Dependabot commands and options</summary>
<br />

You can trigger Dependabot actions by commenting on this PR:
- `@dependabot rebase` will rebase this PR
- `@dependabot recreate` will recreate this PR, overwriting any edits
that have been made to it
- `@dependabot merge` will merge this PR after your CI passes on it
- `@dependabot squash and merge` will squash and merge this PR after
your CI passes on it
- `@dependabot cancel merge` will cancel a previously requested merge
and block automerging
- `@dependabot reopen` will reopen this PR if it is closed
- `@dependabot close` will close this PR and stop Dependabot recreating
it. You can achieve the same result by closing it manually
- `@dependabot show <dependency name> ignore conditions` will show all
of the ignore conditions of the specified dependency
- `@dependabot ignore this major version` will close this PR and stop
Dependabot creating any more for this major version (unless you reopen
the PR or upgrade to it yourself)
- `@dependabot ignore this minor version` will close this PR and stop
Dependabot creating any more for this minor version (unless you reopen
the PR or upgrade to it yourself)
- `@dependabot ignore this dependency` will close this PR and stop
Dependabot creating any more for this dependency (unless you reopen the
PR or upgrade to it yourself)
You can disable automated security fix PRs for this repo from the
[Security Alerts
page](https://github.com/paritytech/revive/network/alerts).

</details>

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2025-09-28 13:06:55 +02:00
xermicus 94ec34c4d5 Separate compilation and linker phases (#376)
Separate between compilation and linker phases to allow deploy time
linking and back-porting era compiler changes to fix #91. Unlinked
contract binaries (caused by missing libraries or missing factory
dependencies in turn) are emitted as raw ELF object.

Few drive by fixes:
- #98
- A compiler panic on missing libraries definitions.
- Fixes some incosistent type forwarding in JSON output (empty string
vs. null object).
- Remove the unused fallback for size optimization setting.
- Remove the broken `--lvm-ir`  mode.
- CI workflow fixes.

---------

Signed-off-by: Cyrill Leutwiler <bigcyrill@hotmail.com>
Signed-off-by: xermicus <bigcyrill@hotmail.com>
Signed-off-by: xermicus <cyrill@parity.io>
2025-09-27 20:52:22 +02:00
xermicus 13faedf08a link to readme in the build utils llvm error message more (#373)
Signed-off-by: xermicus <cyrill@parity.io>
2025-09-02 14:21:54 +02:00
LJ 2f89c743ce Implement Rust CLI tests (#372)
# Description

Closes #365 

Ports all `resolc` CLI tests to Rust and removes the CLI TypeScript
tests.
2025-08-19 16:04:05 +02:00
LJ ea0ea711ad Update workflows to skip tests for only .md files (#371)
When updating documentation Markdown files, long-running tests still run
unnecessarily. With these changes, it will skip running test workflows
when PRs only containing changes to such files are opened.

Co-authored-by: xermicus <cyrill@parity.io>
2025-08-12 16:12:14 +02:00
LJ b31e8a0d74 Fix llvm-builder installation docs (#370)
Updated installation instructions for the llvm-builder.
2025-08-11 21:48:40 +02:00
xermicus 903cbd7159 YUL tree visitor interface (#369)
- Implement the visitor interface. This simplifies working with the AST,
for example transformations into other IRs or collecting and analyzing
various statistics.
- Switch the explorer to use the visitor interface.
- Add the reciprocal function name conversion for function names.
- Some drive-by cosmetic fixes.

---------

Signed-off-by: xermicus <bigcyrill@hotmail.com>
2025-08-10 00:08:25 +02:00
dependabot[bot] 72f9e4f66e Bump @eslint/plugin-kit from 0.3.3 to 0.3.4 (#367)
Bumps
[@eslint/plugin-kit](https://github.com/eslint/rewrite/tree/HEAD/packages/plugin-kit)
from 0.3.3 to 0.3.4.
<details>
<summary>Release notes</summary>
<p><em>Sourced from <a
href="https://github.com/eslint/rewrite/releases"><code>@​eslint/plugin-kit</code>'s
releases</a>.</em></p>
<blockquote>
<h2>plugin-kit: v0.3.4</h2>
<h2><a
href="https://github.com/eslint/rewrite/compare/plugin-kit-v0.3.3...plugin-kit-v0.3.4">0.3.4</a>
(2025-07-21)</h2>
<h3>Bug Fixes</h3>
<ul>
<li>potential quadratic runtime in regular expression (<a
href="https://redirect.github.com/eslint/rewrite/issues/240">#240</a>)
(<a
href="https://github.com/eslint/rewrite/commit/b283f64099ad6c6b5043387c091691d21b387805">b283f64</a>)</li>
</ul>
</blockquote>
</details>
<details>
<summary>Changelog</summary>
<p><em>Sourced from <a
href="https://github.com/eslint/rewrite/blob/main/packages/plugin-kit/CHANGELOG.md"><code>@​eslint/plugin-kit</code>'s
changelog</a>.</em></p>
<blockquote>
<h2><a
href="https://github.com/eslint/rewrite/compare/plugin-kit-v0.3.3...plugin-kit-v0.3.4">0.3.4</a>
(2025-07-21)</h2>
<h3>Bug Fixes</h3>
<ul>
<li>potential quadratic runtime in regular expression (<a
href="https://redirect.github.com/eslint/rewrite/issues/240">#240</a>)
(<a
href="https://github.com/eslint/rewrite/commit/b283f64099ad6c6b5043387c091691d21b387805">b283f64</a>)</li>
</ul>
</blockquote>
</details>
<details>
<summary>Commits</summary>
<ul>
<li><a
href="https://github.com/eslint/rewrite/commit/380c2248711f5277e56c2977b6b440577b210023"><code>380c224</code></a>
chore: release main (<a
href="https://github.com/eslint/rewrite/tree/HEAD/packages/plugin-kit/issues/242">#242</a>)</li>
<li><a
href="https://github.com/eslint/rewrite/commit/17276ff19cec952ecbe7a1bacfaed67bc134b20c"><code>17276ff</code></a>
docs: Update README sponsors</li>
<li><a
href="https://github.com/eslint/rewrite/commit/b283f64099ad6c6b5043387c091691d21b387805"><code>b283f64</code></a>
fix: potential quadratic runtime in regular expression (<a
href="https://github.com/eslint/rewrite/tree/HEAD/packages/plugin-kit/issues/240">#240</a>)</li>
<li><a
href="https://github.com/eslint/rewrite/commit/46cd5dab8f47b4be65a9aa9202a38603da85f186"><code>46cd5da</code></a>
docs: Update README sponsors</li>
<li><a
href="https://github.com/eslint/rewrite/commit/9677965292cd5b670ef0e4aa7b9b57028a26a0ee"><code>9677965</code></a>
docs: Update README sponsors</li>
<li><a
href="https://github.com/eslint/rewrite/commit/20799b5802db906bc43308108986e0508febe58f"><code>20799b5</code></a>
docs: Update README sponsors</li>
<li>See full diff in <a
href="https://github.com/eslint/rewrite/commits/plugin-kit-v0.3.4/packages/plugin-kit">compare
view</a></li>
</ul>
</details>
<br />


[![Dependabot compatibility
score](https://dependabot-badges.githubapp.com/badges/compatibility_score?dependency-name=@eslint/plugin-kit&package-manager=npm_and_yarn&previous-version=0.3.3&new-version=0.3.4)](https://docs.github.com/en/github/managing-security-vulnerabilities/about-dependabot-security-updates#about-compatibility-scores)

Dependabot will resolve any conflicts with this PR as long as you don't
alter it yourself. You can also trigger a rebase manually by commenting
`@dependabot rebase`.

[//]: # (dependabot-automerge-start)
[//]: # (dependabot-automerge-end)

---

<details>
<summary>Dependabot commands and options</summary>
<br />

You can trigger Dependabot actions by commenting on this PR:
- `@dependabot rebase` will rebase this PR
- `@dependabot recreate` will recreate this PR, overwriting any edits
that have been made to it
- `@dependabot merge` will merge this PR after your CI passes on it
- `@dependabot squash and merge` will squash and merge this PR after
your CI passes on it
- `@dependabot cancel merge` will cancel a previously requested merge
and block automerging
- `@dependabot reopen` will reopen this PR if it is closed
- `@dependabot close` will close this PR and stop Dependabot recreating
it. You can achieve the same result by closing it manually
- `@dependabot show <dependency name> ignore conditions` will show all
of the ignore conditions of the specified dependency
- `@dependabot ignore this major version` will close this PR and stop
Dependabot creating any more for this major version (unless you reopen
the PR or upgrade to it yourself)
- `@dependabot ignore this minor version` will close this PR and stop
Dependabot creating any more for this minor version (unless you reopen
the PR or upgrade to it yourself)
- `@dependabot ignore this dependency` will close this PR and stop
Dependabot creating any more for this dependency (unless you reopen the
PR or upgrade to it yourself)
You can disable automated security fix PRs for this repo from the
[Security Alerts
page](https://github.com/paritytech/revive/network/alerts).

</details>

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: xermicus <cyrill@parity.io>
2025-08-08 11:36:16 +02:00
xermicus a96e1a4233 fix new Rust 1.89 warnings (#368) 2025-08-08 11:14:26 +02:00
230 changed files with 11171 additions and 15326 deletions
+3
View File
@@ -15,3 +15,6 @@ rustflags = [
"-Clink-arg=-sSTACK_SIZE=128kb", "-Clink-arg=-sSTACK_SIZE=128kb",
"-Clink-arg=-sNODEJS_CATCH_EXIT=0" "-Clink-arg=-sNODEJS_CATCH_EXIT=0"
] ]
[build]
rustdocflags = ["-D", "warnings"]
+7 -231
View File
@@ -1,4 +1,5 @@
name: Nightly Release name: Nightly Release
on: on:
schedule: schedule:
# Run every day at 01:00 UTC # Run every day at 01:00 UTC
@@ -10,10 +11,8 @@ concurrency:
env: env:
CARGO_TERM_COLOR: always CARGO_TERM_COLOR: always
RUST_MUSL_CROSS_IMAGE: messense/rust-musl-cross@sha256:c0154e992adb791c3b848dd008939d19862549204f8cb26f5ca7a00f629e6067
jobs: jobs:
# check if there were commits yesterday
check_commits: check_commits:
runs-on: ubuntu-latest runs-on: ubuntu-latest
outputs: outputs:
@@ -22,7 +21,7 @@ jobs:
- name: Checkout repository - name: Checkout repository
uses: actions/checkout@v4 uses: actions/checkout@v4
with: with:
fetch-depth: 0 # Fetch full history to check previous commits fetch-depth: 0
ref: "main" ref: "main"
- name: Check for commits from yesterday - name: Check for commits from yesterday
@@ -47,229 +46,12 @@ jobs:
fi fi
build: build:
# github actions matrix jobs don't support multiple outputs
# ugly workaround from https://github.com/orgs/community/discussions/17245#discussioncomment-11222880
if: ${{ needs.check_commits.outputs.has_commits == 'true' }} if: ${{ needs.check_commits.outputs.has_commits == 'true' }}
outputs:
resolc-x86_64-unknown-linux-musl_url: ${{ steps.set-output.outputs.resolc-x86_64-unknown-linux-musl_url }}
resolc-x86_64-unknown-linux-musl_sha: ${{ steps.set-output.outputs.resolc-x86_64-unknown-linux-musl_sha }}
resolc-aarch64-apple-darwin_url: ${{ steps.set-output.outputs.resolc-aarch64-apple-darwin_url }}
resolc-aarch64-apple-darwin_sha: ${{ steps.set-output.outputs.resolc-aarch64-apple-darwin_sha }}
resolc-x86_64-apple-darwin_url: ${{ steps.set-output.outputs.resolc-x86_64-apple-darwin_url }}
resolc-x86_64-apple-darwin_sha: ${{ steps.set-output.outputs.resolc-x86_64-apple-darwin_sha }}
resolc-x86_64-pc-windows-msvc_url: ${{ steps.set-output.outputs.resolc-x86_64-pc-windows-msvc_url }}
resolc-x86_64-pc-windows-msvc_sha: ${{ steps.set-output.outputs.resolc-x86_64-pc-windows-msvc_sha }}
strategy:
matrix:
target:
[
x86_64-unknown-linux-musl,
aarch64-apple-darwin,
x86_64-apple-darwin,
x86_64-pc-windows-msvc,
]
include:
- target: x86_64-unknown-linux-musl
type: musl
runner: ubuntu-24.04
- target: aarch64-apple-darwin
type: native
runner: macos-14
- target: x86_64-apple-darwin
type: native
runner: macos-13
- target: x86_64-pc-windows-msvc
type: native
runner: windows-2022
runs-on: ${{ matrix.runner }}
needs: [check_commits] needs: [check_commits]
steps: uses: ./.github/workflows/reusable-build.yml
- uses: actions/checkout@v4
- uses: actions-rust-lang/setup-rust-toolchain@v1
with: with:
# without this it will override our rust flags is_release: false
rustflags: "" retention_days: 40
cache-key: ${{ matrix.target }}
- name: Download LLVM
uses: ./.github/actions/get-llvm
with:
target: ${{ matrix.target }}
- name: Build
if: ${{ matrix.type == 'native' }}
shell: bash
run: |
export LLVM_SYS_181_PREFIX=$PWD/llvm-${{ matrix.target }}
make install-bin
mv target/release/resolc resolc-${{ matrix.target }} || mv target/release/resolc.exe resolc-${{ matrix.target }}.exe
- name: Build
if: ${{ matrix.type == 'musl' }}
run: |
docker run -v $PWD:/opt/revive $RUST_MUSL_CROSS_IMAGE /bin/bash -c "
cd /opt/revive
chown -R root:root .
apt update && apt upgrade -y && apt install -y pkg-config
export LLVM_SYS_181_PREFIX=/opt/revive/llvm-${{ matrix.target }}
make install-bin
mv target/${{ matrix.target }}/release/resolc resolc-${{ matrix.target }}
"
sudo chown -R $(id -u):$(id -g) .
- name: Install Solc
uses: ./.github/actions/get-solc
- name: Basic Sanity Check
shell: bash
run: |
result=$(./resolc-${{ matrix.target }} --bin crates/integration/contracts/flipper.sol)
echo $result
if [[ $result == *'0x50564d'* ]]; then exit 0; else exit 1; fi
- name: Upload artifacts (nightly)
uses: actions/upload-artifact@v4
id: artifact-upload-step
with:
name: resolc-${{ matrix.target }}
path: resolc-${{ matrix.target }}*
retention-days: 40
- name: Set output variables (nightly)
id: set-output
shell: bash
run: |
echo "Artifact URL is ${{ steps.artifact-upload-step.outputs.artifact-url }}"
echo "Artifact SHA is ${{ steps.artifact-upload-step.outputs.artifact-digest }}"
echo "resolc-${{ matrix.target }}_url=${{ steps.artifact-upload-step.outputs.artifact-url }}"
echo "resolc-${{ matrix.target }}_url=${{ steps.artifact-upload-step.outputs.artifact-url }}" >> "$GITHUB_OUTPUT"
echo "resolc-${{ matrix.target }}_sha=${{ steps.artifact-upload-step.outputs.artifact-digest }}"
echo "resolc-${{ matrix.target }}_sha=${{ steps.artifact-upload-step.outputs.artifact-digest }}" >> "$GITHUB_OUTPUT"
build-wasm:
runs-on: ubuntu-24.04
needs: [check_commits]
if: ${{ needs.check_commits.outputs.has_commits == 'true' }}
outputs:
resolc-web.js_url: ${{ steps.set-output.outputs.resolc_web_js_url }}
resolc-web.js_sha: ${{ steps.set-output.outputs.resolc_web_js_sha }}
env:
RELEASE_RESOLC_WASM_URI: https://github.com/paritytech/revive/releases/download/${{ github.ref_name }}/resolc.wasm
steps:
- uses: actions/checkout@v4
- uses: actions-rust-lang/setup-rust-toolchain@v1
with:
target: wasm32-unknown-emscripten
# without this it will override our rust flags
rustflags: ""
- name: Download Host LLVM
uses: ./.github/actions/get-llvm
with:
target: x86_64-unknown-linux-gnu
- name: Download Wasm LLVM
uses: ./.github/actions/get-llvm
with:
target: wasm32-unknown-emscripten
- name: Download EMSDK
uses: ./.github/actions/get-emsdk
- name: Build
run: |
export LLVM_SYS_181_PREFIX=$PWD/llvm-x86_64-unknown-linux-gnu
export REVIVE_LLVM_TARGET_PREFIX=$PWD/llvm-wasm32-unknown-emscripten
source emsdk/emsdk_env.sh
make install-wasm
chmod -x ./target/wasm32-unknown-emscripten/release/resolc.wasm
- name: Set Up Node.js
uses: actions/setup-node@v3
with:
node-version: "20"
- name: Basic Sanity Check
run: |
mkdir -p solc
curl -sSLo solc/soljson.js https://github.com/ethereum/solidity/releases/download/v0.8.30/soljson.js
node -e "
const soljson = require('solc/soljson');
const createRevive = require('./target/wasm32-unknown-emscripten/release/resolc.js');
const compiler = createRevive();
compiler.soljson = soljson;
const standardJsonInput =
{
language: 'Solidity',
sources: {
'MyContract.sol': {
content: 'pragma solidity ^0.8.0; contract MyContract { function greet() public pure returns (string memory) { return \'Hello\'; } }',
},
},
settings: { optimizer: { enabled: false } }
};
compiler.writeToStdin(JSON.stringify(standardJsonInput));
compiler.callMain(['--standard-json']);
// Collect output
const stdout = compiler.readFromStdout();
const stderr = compiler.readFromStderr();
if (stderr) { console.error(stderr); process.exit(1); }
let out = JSON.parse(stdout);
let bytecode = out.contracts['MyContract.sol']['MyContract'].evm.bytecode.object
console.log(bytecode);
if(!bytecode.startsWith('50564d')) { process.exit(1); }
"
- name: Compress Artifact
run: |
mkdir -p resolc-wasm32-unknown-emscripten
mv ./target/wasm32-unknown-emscripten/release/resolc.js ./resolc-wasm32-unknown-emscripten/
mv ./target/wasm32-unknown-emscripten/release/resolc.wasm ./resolc-wasm32-unknown-emscripten/
mv ./target/wasm32-unknown-emscripten/release/resolc_web.js ./resolc-wasm32-unknown-emscripten/
# There is no way to upload several files as several artifacts with a single upload-artifact step
# It's needed to have resolc_web.js separately for night builds for resolc-bin repo
# https://github.com/actions/upload-artifact/issues/331
- name: Upload artifact resolc.js (nightly)
uses: actions/upload-artifact@v4
with:
name: resolc.js
path: resolc-wasm32-unknown-emscripten/resolc.js
retention-days: 40
- name: Upload artifacts resolc.wasm (nightly)
uses: actions/upload-artifact@v4
with:
name: resolc.wasm
path: resolc-wasm32-unknown-emscripten/resolc.wasm
retention-days: 40
- name: Upload artifacts resolc_web.js (nightly)
uses: actions/upload-artifact@v4
id: artifact-upload-step
with:
name: resolc_web.js
path: resolc-wasm32-unknown-emscripten/resolc_web.js
retention-days: 40
- name: Set output variables
id: set-output
env:
TARGET: resolc_web_js
run: |
echo "Artifact URL is ${{ steps.artifact-upload-step.outputs.artifact-url }}"
echo "Artifact SHA is ${{ steps.artifact-upload-step.outputs.artifact-digest }}"
echo "${TARGET}_url=${{ steps.artifact-upload-step.outputs.artifact-url }}"
echo "${TARGET}_url=${{ steps.artifact-upload-step.outputs.artifact-url }}" >> "$GITHUB_OUTPUT"
echo "${TARGET}_sha=${{ steps.artifact-upload-step.outputs.artifact-digest }}""
echo "${TARGET}_sha=${{ steps.artifact-upload-step.outputs.artifact-digest }}"" >> "$GITHUB_OUTPUT"
create-macos-fat-binary: create-macos-fat-binary:
if: ${{ needs.check_commits.outputs.has_commits == 'true' }} if: ${{ needs.check_commits.outputs.has_commits == 'true' }}
@@ -303,18 +85,14 @@ jobs:
env: env:
TARGET: resolc-universal-apple-darwin TARGET: resolc-universal-apple-darwin
run: | run: |
echo "Artifact URL is ${{ steps.artifact-upload-step.outputs.artifact-url }}"
echo "Artifact SHA is ${{ steps.artifact-upload-step.outputs.artifact-digest }}"
echo "${TARGET}_url=${{ steps.artifact-upload-step.outputs.artifact-url }}"
echo "${TARGET}_url=${{ steps.artifact-upload-step.outputs.artifact-url }}" >> "$GITHUB_OUTPUT" echo "${TARGET}_url=${{ steps.artifact-upload-step.outputs.artifact-url }}" >> "$GITHUB_OUTPUT"
echo "${TARGET}_sha=${{ steps.artifact-upload-step.outputs.artifact-digest }}"" echo "${TARGET}_sha=${{ steps.artifact-upload-step.outputs.artifact-digest }}" >> "$GITHUB_OUTPUT"
echo "${TARGET}_sha=${{ steps.artifact-upload-step.outputs.artifact-digest }}"" >> "$GITHUB_OUTPUT"
generate-nightly-json: generate-nightly-json:
runs-on: ubuntu-24.04 runs-on: ubuntu-24.04
if: ${{ needs.check_commits.outputs.has_commits == 'true' }} if: ${{ needs.check_commits.outputs.has_commits == 'true' }}
environment: tags environment: tags
needs: [build-wasm, build, create-macos-fat-binary, check_commits] needs: [build, create-macos-fat-binary, check_commits]
steps: steps:
- name: Checkout revive - name: Checkout revive
uses: actions/checkout@v4 uses: actions/checkout@v4
@@ -352,8 +130,6 @@ jobs:
echo '[' > data.json echo '[' > data.json
echo '${{ toJSON(needs.build.outputs) }}' >> data.json echo '${{ toJSON(needs.build.outputs) }}' >> data.json
echo ',' >> data.json echo ',' >> data.json
echo '${{ toJSON(needs.build-wasm.outputs) }}' >> data.json
echo ',' >> data.json
echo '${{ toJSON(needs.create-macos-fat-binary.outputs) }}' >> data.json echo '${{ toJSON(needs.create-macos-fat-binary.outputs) }}' >> data.json
echo ']' >> data.json echo ']' >> data.json
chmod +x bins/resolc-x86_64-unknown-linux-musl chmod +x bins/resolc-x86_64-unknown-linux-musl
+12 -176
View File
@@ -1,4 +1,5 @@
name: Build & Release name: Build & Release
on: on:
push: push:
branches: ["main"] branches: ["main"]
@@ -14,8 +15,6 @@ concurrency:
env: env:
CARGO_TERM_COLOR: always CARGO_TERM_COLOR: always
# if changed, dont forget to update the env var in release-nightly.yml
RUST_MUSL_CROSS_IMAGE: messense/rust-musl-cross@sha256:c0154e992adb791c3b848dd008939d19862549204f8cb26f5ca7a00f629e6067
jobs: jobs:
check-version-changed: check-version-changed:
@@ -29,33 +28,28 @@ jobs:
steps: steps:
- uses: actions/checkout@v4 - uses: actions/checkout@v4
# Check that tag and version in Cargo.toml match
- name: Check versions - name: Check versions
id: versions id: versions
run: | run: |
if [[ $CURRENT_TAG == 'main' ]]; if [[ $CURRENT_TAG == 'main' ]]; then
then echo "::notice::Tag $CURRENT_TAG is not a release tag, skipping the check in the main branch"
echo "::notice::Tag $CURRENT_TAG is not a release tag, skipping the check in the main branch";
exit 0 exit 0
fi fi
if [[ $CURRENT_TAG != "v"* ]]; if [[ $CURRENT_TAG != "v"* ]]; then
then echo "::notice::Tag $CURRENT_TAG is not a release tag, skipping the check in a PR"
echo "::notice::Tag $CURRENT_TAG is not a release tag, skipping the check in a PR";
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 crates/resolc/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"
#
if [[ $CURRENT_TAG != $PKG_VER ]]; if [[ $CURRENT_TAG != $PKG_VER ]]; then
then echo "::error::Tag $CURRENT_TAG doesn't match package version $PKG_VER in Cargo.toml, please fix"
echo "::error::Tag $CURRENT_TAG doesn't match package version $PKG_VER in Cargo.toml, please fix";
exit 1 exit 1
fi fi
# Generating release notes early, in order to avoid checkout at the last step
export RELEASE_NOTES="$(sed '/^## '${CURRENT_TAG}'/,/^## v/!d' CHANGELOG.md | sed -e '1d' -e '$d')" export RELEASE_NOTES="$(sed '/^## '${CURRENT_TAG}'/,/^## v/!d' CHANGELOG.md | sed -e '1d' -e '$d')"
echo "Release notes:" echo "Release notes:"
@@ -66,173 +60,15 @@ jobs:
echo 'EOF' >> $GITHUB_OUTPUT echo 'EOF' >> $GITHUB_OUTPUT
build: build:
strategy:
matrix:
target:
[
x86_64-unknown-linux-musl,
aarch64-apple-darwin,
x86_64-apple-darwin,
x86_64-pc-windows-msvc,
]
include:
- target: x86_64-unknown-linux-musl
type: musl
runner: ubuntu-24.04
- target: aarch64-apple-darwin
type: native
runner: macos-14
- target: x86_64-apple-darwin
type: native
runner: macos-13
- target: x86_64-pc-windows-msvc
type: native
runner: windows-2022
runs-on: ${{ matrix.runner }}
needs: [check-version-changed] needs: [check-version-changed]
steps: uses: ./.github/workflows/reusable-build.yml
- uses: actions/checkout@v4
- uses: actions-rust-lang/setup-rust-toolchain@v1
with: with:
# without this it will override our rust flags is_release: true
rustflags: "" retention_days: 1
cache-key: ${{ matrix.target }}
- name: Download LLVM
uses: ./.github/actions/get-llvm
with:
target: ${{ matrix.target }}
- name: Build
if: ${{ matrix.type == 'native' }}
shell: bash
run: |
export LLVM_SYS_181_PREFIX=$PWD/llvm-${{ matrix.target }}
make install-bin
mv target/release/resolc resolc-${{ matrix.target }} || mv target/release/resolc.exe resolc-${{ matrix.target }}.exe
- name: Build
if: ${{ matrix.type == 'musl' }}
run: |
docker run -v $PWD:/opt/revive $RUST_MUSL_CROSS_IMAGE /bin/bash -c "
cd /opt/revive
chown -R root:root .
apt update && apt upgrade -y && apt install -y pkg-config
export LLVM_SYS_181_PREFIX=/opt/revive/llvm-${{ matrix.target }}
make install-bin
mv target/${{ matrix.target }}/release/resolc resolc-${{ matrix.target }}
"
sudo chown -R $(id -u):$(id -g) .
- name: Install Solc
uses: ./.github/actions/get-solc
- name: Basic Sanity Check
shell: bash
run: |
result=$(./resolc-${{ matrix.target }} --bin crates/integration/contracts/flipper.sol)
echo $result
if [[ $result == *'0x50564d'* ]]; then exit 0; else exit 1; fi
- uses: actions/upload-artifact@v4
with:
name: resolc-${{ matrix.target }}
path: resolc-${{ matrix.target }}*
retention-days: 1
build-wasm:
runs-on: ubuntu-24.04
needs: [check-version-changed]
env:
RELEASE_RESOLC_WASM_URI: https://github.com/paritytech/revive/releases/download/${{ github.ref_name }}/resolc.wasm
steps:
- uses: actions/checkout@v4
- uses: actions-rust-lang/setup-rust-toolchain@v1
with:
target: wasm32-unknown-emscripten
# without this it will override our rust flags
rustflags: ""
- name: Download Host LLVM
uses: ./.github/actions/get-llvm
with:
target: x86_64-unknown-linux-gnu
- name: Download Wasm LLVM
uses: ./.github/actions/get-llvm
with:
target: wasm32-unknown-emscripten
- name: Download EMSDK
uses: ./.github/actions/get-emsdk
- name: Build
run: |
export LLVM_SYS_181_PREFIX=$PWD/llvm-x86_64-unknown-linux-gnu
export REVIVE_LLVM_TARGET_PREFIX=$PWD/llvm-wasm32-unknown-emscripten
source emsdk/emsdk_env.sh
make install-wasm
chmod -x ./target/wasm32-unknown-emscripten/release/resolc.wasm
- name: Set Up Node.js
uses: actions/setup-node@v3
with:
node-version: "20"
- name: Basic Sanity Check
run: |
mkdir -p solc
curl -sSLo solc/soljson.js https://github.com/ethereum/solidity/releases/download/v0.8.30/soljson.js
node -e "
const soljson = require('solc/soljson');
const createRevive = require('./target/wasm32-unknown-emscripten/release/resolc.js');
const compiler = createRevive();
compiler.soljson = soljson;
const standardJsonInput =
{
language: 'Solidity',
sources: {
'MyContract.sol': {
content: 'pragma solidity ^0.8.0; contract MyContract { function greet() public pure returns (string memory) { return \'Hello\'; } }',
},
},
settings: { optimizer: { enabled: false } }
};
compiler.writeToStdin(JSON.stringify(standardJsonInput));
compiler.callMain(['--standard-json']);
// Collect output
const stdout = compiler.readFromStdout();
const stderr = compiler.readFromStderr();
if (stderr) { console.error(stderr); process.exit(1); }
let out = JSON.parse(stdout);
let bytecode = out.contracts['MyContract.sol']['MyContract'].evm.bytecode.object
console.log(bytecode);
if(!bytecode.startsWith('50564d')) { process.exit(1); }
"
- name: Compress Artifact
run: |
mkdir -p resolc-wasm32-unknown-emscripten
mv ./target/wasm32-unknown-emscripten/release/resolc.js ./resolc-wasm32-unknown-emscripten/
mv ./target/wasm32-unknown-emscripten/release/resolc.wasm ./resolc-wasm32-unknown-emscripten/
mv ./target/wasm32-unknown-emscripten/release/resolc_web.js ./resolc-wasm32-unknown-emscripten/
- uses: actions/upload-artifact@v4
with:
name: resolc-wasm32-unknown-emscripten
path: resolc-wasm32-unknown-emscripten/*
retention-days: 1
create-release: create-release:
if: startsWith(github.ref_name, 'v') if: startsWith(github.ref_name, 'v')
needs: [check-version-changed, build-wasm] needs: [check-version-changed, build]
runs-on: macos-14 runs-on: macos-14
environment: tags environment: tags
steps: steps:
+262
View File
@@ -0,0 +1,262 @@
name: Reusable Build
on:
workflow_call:
inputs:
is_release:
description: "Whether this is a release build"
required: true
type: boolean
retention_days:
description: "Artifact retention days"
required: false
type: number
default: 1
outputs:
resolc-x86_64-unknown-linux-musl_url:
value: ${{ jobs.build.outputs.resolc-x86_64-unknown-linux-musl_url }}
resolc-x86_64-unknown-linux-musl_sha:
value: ${{ jobs.build.outputs.resolc-x86_64-unknown-linux-musl_sha }}
resolc-aarch64-apple-darwin_url:
value: ${{ jobs.build.outputs.resolc-aarch64-apple-darwin_url }}
resolc-aarch64-apple-darwin_sha:
value: ${{ jobs.build.outputs.resolc-aarch64-apple-darwin_sha }}
resolc-x86_64-apple-darwin_url:
value: ${{ jobs.build.outputs.resolc-x86_64-apple-darwin_url }}
resolc-x86_64-apple-darwin_sha:
value: ${{ jobs.build.outputs.resolc-x86_64-apple-darwin_sha }}
resolc-x86_64-pc-windows-msvc_url:
value: ${{ jobs.build.outputs.resolc-x86_64-pc-windows-msvc_url }}
resolc-x86_64-pc-windows-msvc_sha:
value: ${{ jobs.build.outputs.resolc-x86_64-pc-windows-msvc_sha }}
resolc-web_js_url:
value: ${{ jobs.build-wasm.outputs.resolc_web_js_url }}
resolc-web_js_sha:
value: ${{ jobs.build-wasm.outputs.resolc_web_js_sha }}
env:
CARGO_TERM_COLOR: always
RUST_MUSL_CROSS_IMAGE: messense/rust-musl-cross@sha256:c0154e992adb791c3b848dd008939d19862549204f8cb26f5ca7a00f629e6067
jobs:
build:
# github actions matrix jobs don't support multiple outputs
# ugly workaround from https://github.com/orgs/community/discussions/17245#discussioncomment-11222880
outputs:
resolc-x86_64-unknown-linux-musl_url: ${{ steps.set-output.outputs.resolc-x86_64-unknown-linux-musl_url }}
resolc-x86_64-unknown-linux-musl_sha: ${{ steps.set-output.outputs.resolc-x86_64-unknown-linux-musl_sha }}
resolc-aarch64-apple-darwin_url: ${{ steps.set-output.outputs.resolc-aarch64-apple-darwin_url }}
resolc-aarch64-apple-darwin_sha: ${{ steps.set-output.outputs.resolc-aarch64-apple-darwin_sha }}
resolc-x86_64-apple-darwin_url: ${{ steps.set-output.outputs.resolc-x86_64-apple-darwin_url }}
resolc-x86_64-apple-darwin_sha: ${{ steps.set-output.outputs.resolc-x86_64-apple-darwin_sha }}
resolc-x86_64-pc-windows-msvc_url: ${{ steps.set-output.outputs.resolc-x86_64-pc-windows-msvc_url }}
resolc-x86_64-pc-windows-msvc_sha: ${{ steps.set-output.outputs.resolc-x86_64-pc-windows-msvc_sha }}
strategy:
matrix:
target:
[
x86_64-unknown-linux-musl,
aarch64-apple-darwin,
x86_64-apple-darwin,
x86_64-pc-windows-msvc,
]
include:
- target: x86_64-unknown-linux-musl
type: musl
runner: ubuntu-24.04
- target: aarch64-apple-darwin
type: native
runner: macos-14
- target: x86_64-apple-darwin
type: native
runner: macos-13
- target: x86_64-pc-windows-msvc
type: native
runner: windows-2022
runs-on: ${{ matrix.runner }}
steps:
- uses: actions/checkout@v4
- uses: actions-rust-lang/setup-rust-toolchain@v1
with:
rustflags: ""
cache-key: ${{ matrix.target }}
- name: Download LLVM
uses: ./.github/actions/get-llvm
with:
target: ${{ matrix.target }}
- name: Build (Native)
if: ${{ matrix.type == 'native' }}
shell: bash
run: |
export LLVM_SYS_181_PREFIX=$PWD/llvm-${{ matrix.target }}
make install-bin
mv target/release/resolc resolc-${{ matrix.target }} || mv target/release/resolc.exe resolc-${{ matrix.target }}.exe
- name: Build (MUSL)
if: ${{ matrix.type == 'musl' }}
run: |
docker run -v $PWD:/opt/revive $RUST_MUSL_CROSS_IMAGE /bin/bash -c "
cd /opt/revive
chown -R root:root .
apt update && apt upgrade -y && apt install -y pkg-config
export LLVM_SYS_181_PREFIX=/opt/revive/llvm-${{ matrix.target }}
make install-bin
mv target/${{ matrix.target }}/release/resolc resolc-${{ matrix.target }}
"
sudo chown -R $(id -u):$(id -g) .
- name: Install Solc
uses: ./.github/actions/get-solc
- name: Basic Sanity Check
shell: bash
run: |
result=$(./resolc-${{ matrix.target }} --bin crates/integration/contracts/flipper.sol)
echo $result
if [[ $result == *'50564d'* ]]; then exit 0; else exit 1; fi
- uses: actions/upload-artifact@v4
id: artifact-upload-step
with:
name: resolc-${{ matrix.target }}
path: resolc-${{ matrix.target }}*
retention-days: ${{ inputs.retention_days }}
- name: Set output variables
if: ${{ !inputs.is_release }}
id: set-output
shell: bash
run: |
echo "resolc-${{ matrix.target }}_url=${{ steps.artifact-upload-step.outputs.artifact-url }}" >> "$GITHUB_OUTPUT"
echo "resolc-${{ matrix.target }}_sha=${{ steps.artifact-upload-step.outputs.artifact-digest }}" >> "$GITHUB_OUTPUT"
build-wasm:
runs-on: ubuntu-24.04
outputs:
resolc_web_js_url: ${{ steps.set-output.outputs.resolc_web_js_url }}
resolc_web_js_sha: ${{ steps.set-output.outputs.resolc_web_js_sha }}
env:
RELEASE_RESOLC_WASM_URI: https://github.com/paritytech/revive/releases/download/${{ github.ref_name }}/resolc.wasm
steps:
- uses: actions/checkout@v4
- uses: actions-rust-lang/setup-rust-toolchain@v1
with:
target: wasm32-unknown-emscripten
rustflags: ""
- name: Download Host LLVM
uses: ./.github/actions/get-llvm
with:
target: x86_64-unknown-linux-gnu
- name: Download Wasm LLVM
uses: ./.github/actions/get-llvm
with:
target: wasm32-unknown-emscripten
- name: Download EMSDK
uses: ./.github/actions/get-emsdk
- name: Build
run: |
export LLVM_SYS_181_PREFIX=$PWD/llvm-x86_64-unknown-linux-gnu
export REVIVE_LLVM_TARGET_PREFIX=$PWD/llvm-wasm32-unknown-emscripten
source emsdk/emsdk_env.sh
make install-wasm
chmod -x ./target/wasm32-unknown-emscripten/release/resolc.wasm
- name: Set Up Node.js
uses: actions/setup-node@v3
with:
node-version: "20"
- name: Basic Sanity Check
run: |
mkdir -p solc
curl -sSLo solc/soljson.js https://github.com/ethereum/solidity/releases/download/v0.8.30/soljson.js
node -e "
const soljson = require('solc/soljson');
const createRevive = require('./target/wasm32-unknown-emscripten/release/resolc.js');
const compiler = createRevive();
compiler.soljson = soljson;
const standardJsonInput =
{
language: 'Solidity',
sources: {
'MyContract.sol': {
content: 'pragma solidity ^0.8.0; contract MyContract { function greet() public pure returns (string memory) { return \'Hello\'; } }',
},
},
settings: { optimizer: { enabled: false } }
};
compiler.writeToStdin(JSON.stringify(standardJsonInput));
compiler.callMain(['--standard-json']);
const stdout = compiler.readFromStdout();
const stderr = compiler.readFromStderr();
if (stderr) { console.error(stderr); process.exit(1); }
let out = JSON.parse(stdout);
let bytecode = out.contracts['MyContract.sol']['MyContract'].evm.bytecode.object
console.log(bytecode);
if(!bytecode.startsWith('50564d')) { process.exit(1); }
"
- name: Compress Artifact
run: |
mkdir -p resolc-wasm32-unknown-emscripten
mv ./target/wasm32-unknown-emscripten/release/resolc.js ./resolc-wasm32-unknown-emscripten/
mv ./target/wasm32-unknown-emscripten/release/resolc.wasm ./resolc-wasm32-unknown-emscripten/
mv ./target/wasm32-unknown-emscripten/release/resolc_web.js ./resolc-wasm32-unknown-emscripten/
- name: Upload artifacts (Release)
if: ${{ inputs.is_release }}
uses: actions/upload-artifact@v4
with:
name: resolc-wasm32-unknown-emscripten
path: resolc-wasm32-unknown-emscripten/*
retention-days: ${{ inputs.retention_days }}
# There is no way to upload several files as several artifacts with a single upload-artifact step
# It's needed to have resolc_web.js separately for night builds for resolc-bin repo
# https://github.com/actions/upload-artifact/issues/331
- name: Upload artifact resolc.js (Nightly)
if: ${{ !inputs.is_release }}
uses: actions/upload-artifact@v4
with:
name: resolc.js
path: resolc-wasm32-unknown-emscripten/resolc.js
retention-days: ${{ inputs.retention_days }}
- name: Upload artifacts resolc.wasm (Nightly)
if: ${{ !inputs.is_release }}
uses: actions/upload-artifact@v4
with:
name: resolc.wasm
path: resolc-wasm32-unknown-emscripten/resolc.wasm
retention-days: ${{ inputs.retention_days }}
- name: Upload artifacts resolc_web.js (Nightly)
if: ${{ !inputs.is_release }}
uses: actions/upload-artifact@v4
id: artifact-upload-step
with:
name: resolc_web.js
path: resolc-wasm32-unknown-emscripten/resolc_web.js
retention-days: ${{ inputs.retention_days }}
- name: Set output variables
if: ${{ !inputs.is_release }}
id: set-output
env:
TARGET: resolc_web_js
run: |
echo "${TARGET}_url=${{ steps.artifact-upload-step.outputs.artifact-url }}" >> "$GITHUB_OUTPUT"
echo "${TARGET}_sha=${{ steps.artifact-upload-step.outputs.artifact-digest }}" >> "$GITHUB_OUTPUT"
+2
View File
@@ -7,6 +7,8 @@ on:
- 'LLVM.lock' - 'LLVM.lock'
- 'crates/llvm-builder/**' - 'crates/llvm-builder/**'
- '.github/workflows/test-llvm-builder.yml' - '.github/workflows/test-llvm-builder.yml'
paths-ignore:
- "**.md"
concurrency: concurrency:
group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }} group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
+4
View File
@@ -2,9 +2,13 @@ name: Test Wasm Version
on: on:
push: push:
branches: ["main"] branches: ["main"]
paths-ignore:
- "**.md"
pull_request: pull_request:
branches: ["main"] branches: ["main"]
types: [opened, synchronize] types: [opened, synchronize]
paths-ignore:
- "**.md"
concurrency: concurrency:
group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }} group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
+7 -2
View File
@@ -2,9 +2,13 @@ name: Test
on: on:
push: push:
branches: ["main"] branches: ["main"]
paths-ignore:
- "**.md"
pull_request: pull_request:
branches: ["main"] branches: ["main"]
types: [opened, synchronize] types: [opened, synchronize]
paths-ignore:
- "**.md"
concurrency: concurrency:
group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }} group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
@@ -22,6 +26,7 @@ jobs:
with: with:
# without this it will override our rust flags # without this it will override our rust flags
rustflags: "" rustflags: ""
components: rustfmt, clippy
- name: Install Solc - name: Install Solc
uses: ./.github/actions/get-solc uses: ./.github/actions/get-solc
@@ -53,5 +58,5 @@ jobs:
- name: Test cargo workspace - name: Test cargo workspace
run: make test-workspace run: make test-workspace
- name: Test CLI - name: Test docs
run: make test-cli run: make doc
+37
View File
@@ -4,22 +4,59 @@
This is a development pre-release. This is a development pre-release.
Supported `polkadot-sdk` rev: `2509.0.0`
## v0.5.0
This is a development pre-release.
Supported `polkadot-sdk` rev: `2509.0.0`
### Added
- Support for `SELFDESTRUCT`.
### Changed
- Emulated EVM heap memory accesses of zero length are never out of bounds.
- Switched to newer and cheaper storage syscalls (omits reads and writes of `0` values).
### Fixed
- Introduced a workaround avoiding compiler crashes caused by a bug in LLVM affecting `SDIV`.
- An off-by-one bug affecting `SDIV` overflow semantics.
## v0.4.1
This is a development pre-release.
Supported `polkadot-sdk` rev: `2503.0.1` Supported `polkadot-sdk` rev: `2503.0.1`
### Changed
- The `ast` output is no longer pruned in standard JSON mode (required for foundry).
- Support `standard_json.output_selection` to also look at per file settings.
## v0.4.0 ## v0.4.0
This is a development pre-release. This is a development pre-release.
Supported `polkadot-sdk` rev: `2503.0.1` Supported `polkadot-sdk` rev: `2503.0.1`
### Changed
- Remove the broken `--llvm-ir` mode.
- Remove the unused fallback for size optimization setting.
- Unlinked contract binaries are emitted as raw ELF objects.
### Added ### Added
- Line debug information per YUL builtin and for `if` statements. - Line debug information per YUL builtin and for `if` statements.
- Column numbers in debug information. - Column numbers in debug information.
- Support for the YUL optimizer details in the standard json input definition. - Support for the YUL optimizer details in the standard json input definition.
- The `revive-explorer` compiler utility. - The `revive-explorer` compiler utility.
- `revive-yul`: The AST visitor interface.
- The `--link` deploy time linking mode.
### Fixed ### Fixed
- The debug info source file matches the YUL path in `--debug-output-dir`, allowing tools to display the source line. - The debug info source file matches the YUL path in `--debug-output-dir`, allowing tools to display the source line.
- Incosistent type forwarding in JSON output (empty string vs. null object).
- The solc automatic import resolution.
- Compiler panic on missing libraries definition.
## v0.3.0 ## v0.3.0
Generated
+2886 -1966
View File
File diff suppressed because it is too large Load Diff
+26 -25
View File
@@ -14,22 +14,22 @@ repository = "https://github.com/paritytech/revive"
rust-version = "1.85.0" rust-version = "1.85.0"
[workspace.dependencies] [workspace.dependencies]
resolc = { version = "0.3.0", path = "crates/resolc" }
revive-benchmarks = { version = "0.1.0", path = "crates/benchmarks" }
revive-builtins = { version = "0.1.0", path = "crates/builtins" }
revive-common = { version = "0.1.0", path = "crates/common" }
revive-differential = { version = "0.1.0", path = "crates/differential" }
revive-explorer = { version = "0.1.0", path = "crates/explore" }
revive-integration = { version = "0.1.1", path = "crates/integration" }
revive-linker = { version = "0.1.0", path = "crates/linker" }
lld-sys = { version = "0.1.0", path = "crates/lld-sys" } lld-sys = { version = "0.1.0", path = "crates/lld-sys" }
revive-llvm-context = { version = "0.3.0", path = "crates/llvm-context" } resolc = { version = "0.5.0", path = "crates/resolc", default-features = false }
revive-runtime-api = { version = "0.2.0", path = "crates/runtime-api" } revive-benchmarks = { version = "0.1.0", path = "crates/benchmarks" }
revive-runner = { version = "0.1.0", path = "crates/runner" } revive-build-utils = { version = "0.2.0", path = "crates/build-utils" }
revive-solc-json-interface = { version = "0.2.0", path = "crates/solc-json-interface" } revive-builtins = { version = "0.1.0", path = "crates/builtins" }
revive-stdlib = { version = "0.1.1", path = "crates/stdlib" } revive-common = { version = "0.2.1", path = "crates/common" }
revive-build-utils = { version = "0.1.0", path = "crates/build-utils" } revive-differential = { version = "0.2.0", path = "crates/differential" }
revive-yul = { version = "0.2.1", path = "crates/yul" } revive-explorer = { version = "0.1.0", path = "crates/explore" }
revive-integration = { version = "0.3.0", path = "crates/integration" }
revive-linker = { version = "0.2.0", path = "crates/linker" }
revive-llvm-context = { version = "0.5.0", path = "crates/llvm-context" }
revive-runner = { version = "0.3.0", path = "crates/runner" }
revive-runtime-api = { version = "0.4.0", path = "crates/runtime-api" }
revive-solc-json-interface = { version = "0.4.0", path = "crates/solc-json-interface", default-features = false }
revive-stdlib = { version = "0.2.0", path = "crates/stdlib" }
revive-yul = { version = "0.4.0", path = "crates/yul" }
hex = "0.4.3" hex = "0.4.3"
cc = "1.2" cc = "1.2"
@@ -46,21 +46,21 @@ 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 = "8.0"
path-slash = "0.2" path-slash = "0.2"
rayon = "1.10" rayon = "1.10"
clap = { version = "4", default-features = false, features = ["derive"] } clap = { version = "4", default-features = false, features = ["derive"] }
polkavm-common = "0.24.0" polkavm-common = "0.29.0"
polkavm-linker = "0.24.0" polkavm-linker = "0.29.0"
polkavm-disassembler = "0.24.0" polkavm-disassembler = "0.29.0"
polkavm = "0.24.0" polkavm = "0.29.0"
alloy-primitives = { version = "1.1", features = ["serde"] } alloy-primitives = { version = "1.1", features = ["serde"] }
alloy-sol-types = "1.1" alloy-sol-types = "1.1"
alloy-genesis = "1.0" alloy-genesis = "1.0.41"
alloy-serde = "1.0" alloy-serde = "1.0"
env_logger = { version = "0.11.8", default-features = false } env_logger = { version = "0.11.8", default-features = false }
serde_stacker = "0.1.12" serde_stacker = "0.1.12"
criterion = { version = "0.6", features = ["html_reports"] } criterion = { version = "0.7", features = ["html_reports"] }
log = { version = "0.4.27" } log = { version = "0.4.27" }
git2 = { version = "0.20.2", default-features = false } git2 = { version = "0.20.2", default-features = false }
downloader = "0.2.8" downloader = "0.2.8"
@@ -68,14 +68,15 @@ flate2 = "1.1"
fs_extra = "1.3" fs_extra = "1.3"
num_cpus = "1" num_cpus = "1"
tar = "0.4" tar = "0.4"
toml = "0.8" toml = "0.9"
assert_cmd = "2.0" assert_cmd = "2"
assert_fs = "1.1" assert_fs = "1.1"
normpath = "1.3"
# polkadot-sdk and friends # polkadot-sdk and friends
codec = { version = "3.7.5", default-features = false, package = "parity-scale-codec" } codec = { version = "3.7.5", 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 = { version = "2509.0.0" }
# llvm # llvm
[workspace.dependencies.inkwell] [workspace.dependencies.inkwell]
+6 -6
View File
@@ -9,12 +9,12 @@
install-revive-explorer \ install-revive-explorer \
format \ format \
clippy \ clippy \
doc \
machete \ machete \
test \ test \
test-integration \ test-integration \
test-resolc \ test-resolc \
test-workspace \ test-workspace \
test-cli \
test-wasm \ test-wasm \
test-llvm-builder test-llvm-builder
bench \ bench \
@@ -53,11 +53,14 @@ format:
clippy: clippy:
cargo clippy --all-features --workspace --tests --benches -- --deny warnings cargo clippy --all-features --workspace --tests --benches -- --deny warnings
doc:
cargo doc --all-features --workspace --document-private-items --no-deps
machete: machete:
cargo install cargo-machete cargo install cargo-machete
cargo machete cargo machete
test: format clippy machete test-cli test-workspace install-revive-runner install-revive-explorer test: format clippy machete test-workspace install-revive-runner install-revive-explorer doc
test-integration: install-bin test-integration: install-bin
cargo test --package revive-integration cargo test --package revive-integration
@@ -68,9 +71,6 @@ test-resolc: install
test-workspace: install test-workspace: install
cargo test --workspace --exclude revive-llvm-builder cargo test --workspace --exclude revive-llvm-builder
test-cli: install
npm run test:cli
test-wasm: install-wasm test-wasm: install-wasm
npm run test:wasm npm run test:wasm
@@ -94,6 +94,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/resolc/src/tests/cli/artifacts ; \
cargo uninstall resolc ; \ cargo uninstall resolc ; \
cargo uninstall revive-llvm-builder ; cargo uninstall revive-llvm-builder ;
+1 -3
View File
@@ -76,9 +76,7 @@ export LLVM_SYS_181_PREFIX=</path/to/the/extracted/archive>/target-llvm/gnu/targ
<details> <details>
<summary>Building from source</summary> <summary>Building from source</summary>
Use the provided [revive-llvm](crates/llvm-builder/README.md) utility to compile a compatible LLVM build locally and point `$LLVM_SYS_181_PREFIX` to the installation afterwards. The `Makefile` provides a shortcut target to obtain a compatible LLVM build, using the provided [revive-llvm](crates/llvm-builder/README.md) utility. Once installed, point `$LLVM_SYS_181_PREFIX` to the installation afterwards:
The `Makefile` provides a shortcut target to obtain a compatible LLVM build:
```sh ```sh
make install-llvm make install-llvm
+1
View File
@@ -0,0 +1 @@
large-error-threshold = 192
+1 -1
View File
@@ -1,6 +1,6 @@
[package] [package]
name = "revive-build-utils" name = "revive-build-utils"
version.workspace = true version = "0.2.0"
license.workspace = true license.workspace = true
edition.workspace = true edition.workspace = true
repository.workspace = true repository.workspace = true
+5 -3
View File
@@ -6,6 +6,10 @@ pub const REVIVE_LLVM_HOST_PREFIX: &str = "LLVM_SYS_181_PREFIX";
/// The revive LLVM target dependency directory prefix environment variable. /// The revive LLVM target dependency directory prefix environment variable.
pub const REVIVE_LLVM_TARGET_PREFIX: &str = "REVIVE_LLVM_TARGET_PREFIX"; pub const REVIVE_LLVM_TARGET_PREFIX: &str = "REVIVE_LLVM_TARGET_PREFIX";
/// The revive LLVM host tool help link.
pub const REVIVE_LLVM_BUILDER_HELP_LINK: &str =
"https://github.com/paritytech/revive?tab=readme-ov-file#building-from-source";
/// Constructs a path to the LLVM tool `name`. /// Constructs a path to the LLVM tool `name`.
/// ///
/// Respects the [`REVIVE_LLVM_HOST_PREFIX`] environment variable. /// Respects the [`REVIVE_LLVM_HOST_PREFIX`] environment variable.
@@ -13,9 +17,7 @@ pub fn llvm_host_tool(name: &str) -> std::path::PathBuf {
std::env::var_os(REVIVE_LLVM_HOST_PREFIX) std::env::var_os(REVIVE_LLVM_HOST_PREFIX)
.map(Into::<std::path::PathBuf>::into) .map(Into::<std::path::PathBuf>::into)
.unwrap_or_else(|| { .unwrap_or_else(|| {
panic!( panic!("install LLVM using the revive-llvm builder and export '{REVIVE_LLVM_HOST_PREFIX}'; see also: {REVIVE_LLVM_BUILDER_HELP_LINK}")
"install LLVM using the revive-llvm builder and export {REVIVE_LLVM_HOST_PREFIX}",
)
}) })
.join("bin") .join("bin")
.join(name) .join(name)
+3 -1
View File
@@ -1,6 +1,6 @@
[package] [package]
name = "revive-common" name = "revive-common"
version.workspace = true version = "0.2.1"
license.workspace = true license.workspace = true
edition.workspace = true edition.workspace = true
repository.workspace = true repository.workspace = true
@@ -15,6 +15,8 @@ doctest = false
[dependencies] [dependencies]
anyhow = { workspace = true } anyhow = { workspace = true }
hex = { workspace = true }
sha3 = { workspace = true }
serde = { workspace = true, features = ["derive"] } serde = { workspace = true, features = ["derive"] }
serde_json = { workspace = true, features = [ "arbitrary_precision", "unbounded_depth" ] } serde_json = { workspace = true, features = [ "arbitrary_precision", "unbounded_depth" ] }
serde_stacker = { workspace = true } serde_stacker = { workspace = true }
+33
View File
@@ -0,0 +1,33 @@
//! The contract identifier helper library.
use serde::{Deserialize, Serialize};
/// This structure simplifies passing the contract identifiers through the compilation pipeline.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct ContractIdentifier {
/// The absolute file path.
pub path: String,
/// The contract name.
/// Is set for Solidity contracts only. Otherwise it would be equal to the file name.
pub name: Option<String>,
/// The full contract identifier.
/// For Solidity, The format is `<absolute file path>:<contract name>`.
/// For other languages, `<absolute file path>`.
pub full_path: String,
}
impl ContractIdentifier {
/// A shortcut constructor.
pub fn new(path: String, name: Option<String>) -> Self {
let full_path = match name {
Some(ref name) => format!("{path}:{name}"),
None => path.clone(),
};
Self {
path,
name,
full_path,
}
}
}
+1 -1
View File
@@ -37,4 +37,4 @@ pub static EXTENSION_POLKAVM_ASSEMBLY: &str = "pvmasm";
pub static EXTENSION_POLKAVM_BINARY: &str = "pvm"; pub static EXTENSION_POLKAVM_BINARY: &str = "pvm";
/// The ELF shared object file extension. /// The ELF shared object file extension.
pub static EXTENSION_SHARED_OBJECT: &str = "so"; pub static EXTENSION_OBJECT: &str = "o";
+68
View File
@@ -0,0 +1,68 @@
//! Keccak-256 hash utilities.
use serde::{Deserialize, Serialize};
use sha3::digest::FixedOutput;
use sha3::Digest;
pub const DIGEST_BYTES: usize = 32;
/// Keccak-256 hash utilities.
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
pub struct Keccak256 {
/// Binary representation.
bytes: [u8; DIGEST_BYTES],
/// Hexadecimal string representation.
string: String,
}
impl Keccak256 {
/// Computes the `keccak256` hash for `preimage`.
pub fn from_slice(preimage: &[u8]) -> Self {
let bytes = sha3::Keccak256::digest(preimage).into();
let string = format!("0x{}", hex::encode(bytes));
Self { bytes, string }
}
/// Computes the `keccak256` hash for an array of `preimages`.
pub fn from_slices<R: AsRef<[u8]>>(preimages: &[R]) -> Self {
let mut hasher = sha3::Keccak256::new();
for preimage in preimages.iter() {
hasher.update(preimage);
}
let bytes: [u8; DIGEST_BYTES] = hasher.finalize_fixed().into();
let string = format!("0x{}", hex::encode(bytes));
Self { bytes, string }
}
/// Returns a reference to the 32-byte SHA-3 hash.
pub fn as_bytes(&self) -> &[u8] {
self.bytes.as_slice()
}
/// Returns a reference to the hexadecimal string representation.
pub fn as_str(&self) -> &str {
self.string.as_str()
}
/// Extracts the binary representation.
pub fn to_vec(&self) -> Vec<u8> {
self.bytes.to_vec()
}
}
impl std::fmt::Display for Keccak256 {
fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
write!(f, "{}", self.as_str())
}
}
#[cfg(test)]
mod tests {
#[test]
fn hash_and_stringify_works() {
assert_eq!(
super::Keccak256::from_slices(&["foo".as_bytes(), "bar".as_bytes(),]).as_str(),
"0x38d18acb67d25c8bb9942764b62f18e17054f66a817bd4295423adf9ed98873e"
);
}
}
+8
View File
@@ -3,9 +3,13 @@
pub(crate) mod base; pub(crate) mod base;
pub(crate) mod bit_length; pub(crate) mod bit_length;
pub(crate) mod byte_length; pub(crate) mod byte_length;
pub(crate) mod contract_identifier;
pub(crate) mod evm_version; pub(crate) mod evm_version;
pub(crate) mod exit_code; pub(crate) mod exit_code;
pub(crate) mod extension; pub(crate) mod extension;
pub(crate) mod keccak256;
pub(crate) mod metadata;
pub(crate) mod object;
pub(crate) mod utils; pub(crate) mod utils;
pub use self::base::*; pub use self::base::*;
@@ -14,4 +18,8 @@ pub use self::byte_length::*;
pub use self::evm_version::EVMVersion; pub use self::evm_version::EVMVersion;
pub use self::exit_code::*; pub use self::exit_code::*;
pub use self::extension::*; pub use self::extension::*;
pub use self::keccak256::*;
pub use self::metadata::*;
pub use self::object::*;
pub use self::utils::*; pub use self::utils::*;
pub use contract_identifier::*;
+42
View File
@@ -0,0 +1,42 @@
//! The metadata hash type.
use std::str::FromStr;
use serde::{Deserialize, Serialize};
/// The metadata hash type.
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash, Serialize, Deserialize)]
pub enum MetadataHash {
/// Do not include bytecode hash.
#[serde(rename = "none")]
None,
/// Include the `ipfs` hash.
#[serde(rename = "ipfs")]
IPFS,
/// Include the `keccak256`` hash.
#[serde(rename = "keccak256")]
Keccak256,
}
impl FromStr for MetadataHash {
type Err = anyhow::Error;
fn from_str(string: &str) -> Result<Self, Self::Err> {
match string {
"none" => Ok(Self::None),
"ipfs" => Ok(Self::IPFS),
"keccak256" => Ok(Self::Keccak256),
string => anyhow::bail!("unknown bytecode hash mode: `{string}`"),
}
}
}
impl std::fmt::Display for MetadataHash {
fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
match self {
Self::None => write!(f, "none"),
Self::IPFS => write!(f, "ipfs"),
Self::Keccak256 => write!(f, "keccak256"),
}
}
}
+61
View File
@@ -0,0 +1,61 @@
//! The revive binary object helper module.
use std::str::FromStr;
use serde::{Deserialize, Serialize};
/// The binary object format.
///
/// Unlinked contracts are stored in a different object format
/// than final (linked) contract blobs.
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash, Serialize, Deserialize)]
pub enum ObjectFormat {
/// The unlinked ELF object format.
ELF,
/// The fully linked PVM format.
PVM,
}
impl ObjectFormat {
pub const PVM_MAGIC: [u8; 4] = [b'P', b'V', b'M', b'\0'];
pub const ELF_MAGIC: [u8; 4] = [0x7f, b'E', b'L', b'F'];
}
impl FromStr for ObjectFormat {
type Err = anyhow::Error;
fn from_str(value: &str) -> Result<Self, Self::Err> {
match value {
"ELF" => Ok(Self::ELF),
"PVM" => Ok(Self::PVM),
_ => anyhow::bail!(
"Unknown object format: {value}. Supported formats: {}, {}",
Self::ELF,
Self::PVM,
),
}
}
}
impl TryFrom<&[u8]> for ObjectFormat {
type Error = &'static str;
fn try_from(value: &[u8]) -> Result<Self, Self::Error> {
if value.starts_with(&Self::PVM_MAGIC) {
return Ok(Self::PVM);
}
if value.starts_with(&Self::ELF_MAGIC) {
return Ok(Self::ELF);
}
Err("expected a contract object")
}
}
impl std::fmt::Display for ObjectFormat {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
match self {
Self::ELF => write!(f, "ELF"),
Self::PVM => write!(f, "PVM"),
}
}
}
+26 -6
View File
@@ -1,25 +1,45 @@
//! The compiler common utils. //! The compiler common utils.
/// Deserializes a `serde_json` object from slice with the recursion limit disabled. /// Deserializes a `serde_json` object from slice with the recursion limit disabled.
///
/// Must be used for all JSON I/O to avoid crashes due to the aforementioned limit. /// Must be used for all JSON I/O to avoid crashes due to the aforementioned limit.
pub fn deserialize_from_slice<O>(input: &[u8]) -> anyhow::Result<O> pub fn deserialize_from_slice<O>(input: &[u8]) -> anyhow::Result<O>
where where
O: serde::de::DeserializeOwned, O: serde::de::DeserializeOwned,
{ {
let mut deserializer = serde_json::Deserializer::from_slice(input); let deserializer = serde_json::Deserializer::from_slice(input);
deserializer.disable_recursion_limit(); deserialize(deserializer)
let deserializer = serde_stacker::Deserializer::new(&mut deserializer);
let result = O::deserialize(deserializer)?;
Ok(result)
} }
/// Deserializes a `serde_json` object from string with the recursion limit disabled. /// Deserializes a `serde_json` object from string with the recursion limit disabled.
///
/// Must be used for all JSON I/O to avoid crashes due to the aforementioned limit. /// Must be used for all JSON I/O to avoid crashes due to the aforementioned limit.
pub fn deserialize_from_str<O>(input: &str) -> anyhow::Result<O> pub fn deserialize_from_str<O>(input: &str) -> anyhow::Result<O>
where where
O: serde::de::DeserializeOwned, O: serde::de::DeserializeOwned,
{ {
let mut deserializer = serde_json::Deserializer::from_str(input); let deserializer = serde_json::Deserializer::from_str(input);
deserialize(deserializer)
}
/// Deserializes a `serde_json` object from reader with the recursion limit disabled.
///
/// Must be used for all JSON I/O to avoid crashes due to the aforementioned limit.
pub fn deserialize_from_reader<R, O>(reader: R) -> anyhow::Result<O>
where
R: std::io::Read,
O: serde::de::DeserializeOwned,
{
let deserializer = serde_json::Deserializer::from_reader(reader);
deserialize(deserializer)
}
/// Runs the generic deserializer.
pub fn deserialize<'de, R, O>(mut deserializer: serde_json::Deserializer<R>) -> anyhow::Result<O>
where
R: serde_json::de::Read<'de>,
O: serde::de::DeserializeOwned,
{
deserializer.disable_recursion_limit(); deserializer.disable_recursion_limit();
let deserializer = serde_stacker::Deserializer::new(&mut deserializer); let deserializer = serde_stacker::Deserializer::new(&mut deserializer);
let result = O::deserialize(deserializer)?; let result = O::deserialize(deserializer)?;
+1 -1
View File
@@ -1,7 +1,7 @@
[package] [package]
name = "revive-differential" name = "revive-differential"
description = "utilities for differential testing the revive compiler against EVM" description = "utilities for differential testing the revive compiler against EVM"
version.workspace = true version = "0.2.0"
license.workspace = true license.workspace = true
edition.workspace = true edition.workspace = true
authors.workspace = true authors.workspace = true
+2 -2
View File
@@ -3,8 +3,8 @@ use std::time::Duration;
/// Parse a go formatted duration. /// Parse a go formatted duration.
/// ///
/// Sources: /// Sources:
/// - https://crates.io/crates/go-parse-duration (fixed an utf8 bug) /// - <https://crates.io/crates/go-parse-duration> (fixed an utf8 bug)
/// - https://github.com/golang/go/blob/master/src/time/format.go /// - <https://github.com/golang/go/blob/master/src/time/format.go>
pub fn parse_go_duration(value: &str) -> Result<Duration, String> { pub fn parse_go_duration(value: &str) -> Result<Duration, String> {
parse_duration(value).map(|ns| Duration::from_nanos(ns.unsigned_abs())) parse_duration(value).map(|ns| Duration::from_nanos(ns.unsigned_abs()))
} }
+1 -1
View File
@@ -1,6 +1,6 @@
[package] [package]
name = "revive-explorer" name = "revive-explorer"
version.workspace = true version = "0.1.0"
license.workspace = true license.workspace = true
edition.workspace = true edition.workspace = true
repository.workspace = true repository.workspace = true
+10 -1
View File
@@ -29,7 +29,16 @@ pub fn source_file(
dwarfdump_executable: &Option<PathBuf>, dwarfdump_executable: &Option<PathBuf>,
) -> anyhow::Result<PathBuf> { ) -> anyhow::Result<PathBuf> {
let output = dwarfdump(shared_object, dwarfdump_executable, &SOURCE_FILE_ARGUMENTS)?; let output = dwarfdump(shared_object, dwarfdump_executable, &SOURCE_FILE_ARGUMENTS)?;
Ok(output.trim().into()) let output = output.trim();
if output.is_empty() {
anyhow::bail!(
"the shared object at path `{}` doesn't contain the source file name. Hint: compile with debug information (-g)?",
shared_object.display()
);
}
Ok(output.into())
} }
/// The internal `llvm-dwarfdump` helper function. /// The internal `llvm-dwarfdump` helper function.
+6 -34
View File
@@ -7,34 +7,7 @@ use std::{
use revive_yul::lexer::token::location::Location; use revive_yul::lexer::token::location::Location;
use crate::location_mapper::{self, map_locations, LocationMap}; use crate::location_mapper::{self, LocationMapper};
/// Unknwon code.
pub const OTHER: &str = "other";
/// Compiler internal code.
pub const INTERNAL: &str = "internal";
/// YUL block code.
pub const BLOCK: &str = "block";
/// YUL function call code.
pub const FUNCTION_CALL: &str = "function_call";
/// YUL conditional code.
pub const IF: &str = "if";
/// YUL loop code.
pub const FOR: &str = "for";
/// YUL loop continue code.
pub const CONTINUE: &str = "continue";
/// YUL loop break code.
pub const BREAK: &str = "break";
/// YUL switch code.
pub const SWITCH: &str = "switch";
/// YUL variable declaration code.
pub const DECLARATION: &str = "let";
/// YUL variable assignment code.
pub const ASSIGNMENT: &str = "assignment";
/// YUL function definition code.
pub const FUNCTION_DEFINITION: &str = "function_definition";
/// YUL function leave code.
pub const LEAVE: &str = "leave";
/// The dwarf dump analyzer. /// The dwarf dump analyzer.
/// ///
@@ -48,7 +21,7 @@ pub struct DwarfdumpAnalyzer {
source: PathBuf, source: PathBuf,
/// The YUL location to statements map. /// The YUL location to statements map.
location_map: LocationMap, location_map: HashMap<Location, String>,
/// The `llvm-dwarfdump --debug-lines` output. /// The `llvm-dwarfdump --debug-lines` output.
debug_lines: String, debug_lines: String,
@@ -81,7 +54,7 @@ impl DwarfdumpAnalyzer {
/// Populate the maps so that we can always unwrap later. /// Populate the maps so that we can always unwrap later.
fn map_locations(&mut self) -> anyhow::Result<()> { fn map_locations(&mut self) -> anyhow::Result<()> {
self.location_map = map_locations(&self.source)?; self.location_map = LocationMapper::map_locations(&self.source)?;
self.statements_count = HashMap::with_capacity(self.location_map.len()); self.statements_count = HashMap::with_capacity(self.location_map.len());
self.statements_size = HashMap::with_capacity(self.location_map.len()); self.statements_size = HashMap::with_capacity(self.location_map.len());
@@ -176,13 +149,12 @@ impl DwarfdumpAnalyzer {
location_mapper::BLOCK => "--block-cost", location_mapper::BLOCK => "--block-cost",
location_mapper::FUNCTION_CALL => "--function-call-cost", location_mapper::FUNCTION_CALL => "--function-call-cost",
location_mapper::IF => "--if-cost", location_mapper::IF => "--if-cost",
location_mapper::CONTINUE => "--continue-cost",
location_mapper::BREAK => "--break-cost",
location_mapper::LEAVE => "--leave-cost",
location_mapper::SWITCH => "--switch-cost", location_mapper::SWITCH => "--switch-cost",
location_mapper::DECLARATION => "--variable-declaration-cost", location_mapper::DECLARATION => "--variable-declaration-cost",
location_mapper::ASSIGNMENT => "--assignment-cost", location_mapper::ASSIGNMENT => "--assignment-cost",
location_mapper::FUNCTION_DEFINITION => "--function-definition-cost", location_mapper::FUNCTION_DEFINITION => "--function-definition-cost",
location_mapper::IDENTIFIER => "--identifier-cost",
location_mapper::LITERAL => "--literal-cost",
_ => "--expression-statement-cost", _ => "--expression-statement-cost",
}; };
@@ -216,7 +188,7 @@ impl DwarfdumpAnalyzer {
} }
} }
/// Given a slice of u64 values, returns a Vec<u64> where each element /// Given a slice of u64 values, returns a `Vec<u64>` where each element
/// is linearly scaled into the closed interval [1, 10]. /// is linearly scaled into the closed interval [1, 10].
fn scale_to(data: &[u64], scale_max: u64) -> Vec<u64> { fn scale_to(data: &[u64], scale_max: u64) -> Vec<u64> {
if data.is_empty() { if data.is_empty() {
+86 -121
View File
@@ -1,158 +1,123 @@
//! The location mapper utility maps YUL source locations to AST statements. //! The location mapper utility maps YUL source locations to AST statements.
//!
//! TODO: Refactor when the AST visitor is implemented.
use std::{collections::HashMap, path::Path}; use std::{collections::HashMap, path::Path};
use revive_yul::{ use revive_yul::{
lexer::{token::location::Location, Lexer}, lexer::{token::location::Location, Lexer},
parser::statement::{ parser::{
identifier::Identifier,
statement::{
assignment::Assignment,
block::Block, block::Block,
expression::{function_call::name::Name, Expression}, expression::{function_call::FunctionCall, literal::Literal},
for_loop::ForLoop,
function_definition::FunctionDefinition,
if_conditional::IfConditional,
object::Object, object::Object,
Statement, switch::Switch,
variable_declaration::VariableDeclaration,
}, },
},
visitor::{AstNode, AstVisitor},
}; };
/// Code attributed to an unknown location. /// Code attributed to an unknown location.
pub const OTHER: &str = "other"; pub const OTHER: &str = "other";
/// Code attributed to a compiler internal location. /// Code attributed to a compiler internal location.
pub const INTERNAL: &str = "internal"; pub const INTERNAL: &str = "internal";
/// Code attributed to a /// Code attributed to a block.
pub const BLOCK: &str = "block"; pub const BLOCK: &str = "block";
/// Code attributed to a function call.
pub const FUNCTION_CALL: &str = "function_call"; pub const FUNCTION_CALL: &str = "function_call";
/// Code attributed to a for loop.
pub const FOR: &str = "for"; pub const FOR: &str = "for";
/// Code attributed to an if statement.
pub const IF: &str = "if"; pub const IF: &str = "if";
pub const CONTINUE: &str = "continue"; /// Code attributed to a switch statement.
pub const BREAK: &str = "break";
pub const LEAVE: &str = "leave";
pub const SWITCH: &str = "switch"; pub const SWITCH: &str = "switch";
/// Code attributed to a variable declaration.
pub const DECLARATION: &str = "let"; pub const DECLARATION: &str = "let";
/// Code attributed to a variable assignement.
pub const ASSIGNMENT: &str = "assignment"; pub const ASSIGNMENT: &str = "assignment";
/// Code attributed to a function definition.
pub const FUNCTION_DEFINITION: &str = "function_definition"; pub const FUNCTION_DEFINITION: &str = "function_definition";
/// Code attributed to an identifier.
pub const IDENTIFIER: &str = "identifier";
/// Code attributed to a literal.
pub const LITERAL: &str = "literal";
/// The location to statements map type alias. /// The location to statements mapper.
pub type LocationMap = HashMap<Location, String>; pub struct LocationMapper(HashMap<Location, String>);
/// Construct a [LocationMap] from the given YUL `source` file. impl LocationMapper {
pub fn map_locations(source: &Path) -> anyhow::Result<LocationMap> { /// Construct a node location map from the given YUL `source` file.
pub fn map_locations(source: &Path) -> anyhow::Result<HashMap<Location, String>> {
let mut lexer = Lexer::new(std::fs::read_to_string(source)?); let mut lexer = Lexer::new(std::fs::read_to_string(source)?);
let ast = Object::parse(&mut lexer, None).map_err(|error| { let ast = Object::parse(&mut lexer, None).map_err(|error| {
anyhow::anyhow!("Contract `{}` parsing error: {:?}", source.display(), error) anyhow::anyhow!("Contract `{}` parsing error: {:?}", source.display(), error)
})?; })?;
let mut location_map = HashMap::with_capacity(1024); let mut location_map = Self(Default::default());
crate::location_mapper::object_mapper(&mut location_map, &ast); ast.accept(&mut location_map);
location_map.insert(Location::new(0, 0), OTHER.to_string()); location_map.0.insert(Location::new(0, 0), OTHER.into());
location_map.insert(Location::new(1, 0), INTERNAL.to_string()); location_map.0.insert(Location::new(1, 0), INTERNAL.into());
Ok(location_map) Ok(location_map.0)
}
/// Map the [Block].
fn block_mapper(map: &mut LocationMap, block: &Block) {
map.insert(block.location, BLOCK.to_string());
for statement in &block.statements {
statement_mapper(map, statement);
} }
} }
/// Map the [Expression]. impl AstVisitor for LocationMapper {
fn expression_mapper(map: &mut LocationMap, expression: &Expression) { fn visit(&mut self, node: &impl AstNode) {
if let Expression::FunctionCall(call) = expression { node.visit_children(self);
let id = match call.name {
Name::UserDefined(_) => FUNCTION_CALL.to_string(),
_ => format!("{:?}", call.name),
};
map.insert(expression.location(), id);
for expression in &call.arguments {
expression_mapper(map, expression);
} }
}
} fn visit_block(&mut self, node: &Block) {
node.visit_children(self);
/// Map the [Statement]. self.0.insert(node.location, BLOCK.into());
fn statement_mapper(map: &mut LocationMap, statement: &Statement) { }
match statement {
Statement::Object(object) => object_mapper(map, object), fn visit_assignment(&mut self, node: &Assignment) {
node.visit_children(self);
Statement::Code(code) => block_mapper(map, &code.block), self.0.insert(node.location, ASSIGNMENT.into());
}
Statement::Block(block) => block_mapper(map, block),
fn visit_if_conditional(&mut self, node: &IfConditional) {
Statement::ForLoop(for_loop) => { node.visit_children(self);
map.insert(for_loop.location, FOR.to_string()); self.0.insert(node.location, IF.into());
}
expression_mapper(map, &for_loop.condition);
block_mapper(map, &for_loop.body); fn visit_variable_declaration(&mut self, node: &VariableDeclaration) {
block_mapper(map, &for_loop.initializer); node.visit_children(self);
block_mapper(map, &for_loop.finalizer); self.0.insert(node.location, DECLARATION.into());
} }
Statement::IfConditional(if_conditional) => { fn visit_function_call(&mut self, node: &FunctionCall) {
map.insert(if_conditional.location, IF.to_string()); node.visit_children(self);
self.0.insert(node.location, node.name.to_string());
expression_mapper(map, &if_conditional.condition); }
block_mapper(map, &if_conditional.block);
} fn visit_function_definition(&mut self, node: &FunctionDefinition) {
node.visit_children(self);
Statement::Expression(expression) => expression_mapper(map, expression), self.0.insert(node.location, FUNCTION_DEFINITION.into());
}
Statement::Continue(location) => {
map.insert(*location, CONTINUE.to_string()); fn visit_identifier(&mut self, node: &Identifier) {
} node.visit_children(self);
self.0.insert(node.location, IDENTIFIER.into());
Statement::Leave(location) => { }
map.insert(*location, LEAVE.to_string());
} fn visit_literal(&mut self, node: &Literal) {
node.visit_children(self);
Statement::Break(location) => { self.0.insert(node.location, LITERAL.into());
map.insert(*location, BREAK.to_string()); }
}
fn visit_for_loop(&mut self, node: &ForLoop) {
Statement::Switch(switch) => { node.visit_children(self);
map.insert(switch.expression.location(), SWITCH.to_string()); self.0.insert(node.location, FOR.into());
}
expression_mapper(map, &switch.expression);
for case in &switch.cases { fn visit_switch(&mut self, node: &Switch) {
block_mapper(map, &case.block); node.visit_children(self);
} self.0.insert(node.location, SWITCH.into());
if let Some(block) = switch.default.as_ref() {
block_mapper(map, block);
}
}
Statement::Assignment(assignment) => {
map.insert(assignment.location, ASSIGNMENT.to_string());
expression_mapper(map, &assignment.initializer);
}
Statement::VariableDeclaration(declaration) => {
map.insert(declaration.location, DECLARATION.to_string());
if let Some(expression) = declaration.expression.as_ref() {
expression_mapper(map, expression);
}
}
Statement::FunctionDefinition(definition) => {
map.insert(definition.location, FUNCTION_DEFINITION.to_string());
block_mapper(map, &definition.body);
}
}
}
/// Map the [Object].
fn object_mapper(map: &mut LocationMap, object: &Object) {
map.insert(object.location, object.identifier.clone());
block_mapper(map, &object.code.block);
if let Some(object) = object.inner_object.as_ref() {
object_mapper(map, object);
} }
} }
+3
View File
@@ -10,6 +10,8 @@ use revive_explorer::{dwarfdump, dwarfdump_analyzer::DwarfdumpAnalyzer, yul_phas
/// - The count of each YUL statement translated. /// - The count of each YUL statement translated.
/// - A per YUL statement break-down of bytecode size contributed per. /// - A per YUL statement break-down of bytecode size contributed per.
/// - Estimated `yul-phaser` cost parameters. /// - Estimated `yul-phaser` cost parameters.
///
/// Note: This tool might not be fully accurate, especially when the code was optimized.
#[derive(Parser, Debug)] #[derive(Parser, Debug)]
#[command(version, about, long_about = None)] #[command(version, about, long_about = None)]
struct Args { struct Args {
@@ -26,6 +28,7 @@ struct Args {
yul_phaser: Option<PathBuf>, yul_phaser: Option<PathBuf>,
/// Path of the shared object to analyze. /// Path of the shared object to analyze.
/// It must have been compiled with debug info (-g).
file: PathBuf, file: PathBuf,
} }
+1 -1
View File
@@ -1,6 +1,6 @@
[package] [package]
name = "revive-integration" name = "revive-integration"
version = "0.1.1" version = "0.3.0"
license.workspace = true license.workspace = true
edition.workspace = true edition.workspace = true
repository.workspace = true repository.workspace = true
+8 -8
View File
@@ -1,10 +1,10 @@
{ {
"Baseline": 960, "Baseline": 914,
"Computation": 2367, "Computation": 2295,
"DivisionArithmetics": 9108, "DivisionArithmetics": 14496,
"ERC20": 17655, "ERC20": 17482,
"Events": 1680, "Events": 1674,
"FibonacciIterative": 1536, "FibonacciIterative": 1490,
"Flipper": 2137, "Flipper": 2086,
"SHA1": 8299 "SHA1": 8158
} }
@@ -0,0 +1,81 @@
// SPDX-License-Identifier: GPL-3.0
pragma solidity ^0.8;
/* runner.json
{
"differential": true,
"actions": [
{
"Upload": {
"code": {
"Solidity": {
"contract": "AddModMulMod"
}
}
}
},
{
"Instantiate": {
"value": 123123,
"code": {
"Solidity": {
"contract": "AddModMulModTester"
}
}
}
},
{
"VerifyCall": {
"success": true
}
}
]
}
*/
contract AddModMulMod {
function test() public returns (uint256) {
// Note that this only works because computation on literals is done using
// unbounded integers.
if ((2**255 + 2**255) % 7 != addmod(2**255, 2**255, 7)) return 1;
if ((2**255 + 2**255) % 7 != addmod(2**255, 2**255, 7)) return 2;
return 0;
}
function f(uint256 d) public pure returns (uint256) {
addmod(1, 2, d);
return 2;
}
function g(uint256 d) public pure returns (uint256) {
mulmod(1, 2, d);
return 2;
}
function h() public pure returns (uint256) {
mulmod(0, 1, 2);
mulmod(1, 0, 2);
addmod(0, 1, 2);
addmod(1, 0, 2);
return 2;
}
}
contract AddModMulModTester {
constructor() payable {
AddModMulMod c = new AddModMulMod();
assert(c.test() == 0);
try c.f(0) returns (uint m) { revert(); } catch Panic(uint errorCode) {
assert(errorCode == 0x12);
}
try c.g(0) returns (uint m) { revert(); } catch Panic(uint errorCode) {
assert(errorCode == 0x12);
}
assert(c.h() == 2);
}
}
@@ -0,0 +1,36 @@
// SPDX-License-Identifier: MIT
pragma solidity ^0.8.24;
/* runner.json
{
"differential": true,
"actions": [
{
"Instantiate": {
"code": {
"Solidity": {
"contract": "MemoryBounds"
}
}
}
},
{
"Call": {
"dest": {
"Instantiated": 0
}
}
}
]
}
*/
contract MemoryBounds {
fallback() external {
assembly {
// Accessing OOB offsets should always work when the length is 0.
return(100000, 0)
}
}
}
@@ -0,0 +1,66 @@
// SPDX-License-Identifier: MIT
pragma solidity ^0.8;
// TODO: This currently fails the differential test.
// The pallet doesn't send the correct balance back.
/* runner.json
{
"differential": false,
"actions": [
{
"Upload": {
"code": {
"Solidity": {
"contract": "SelfdestructTester"
}
}
}
},
{
"Instantiate": {
"code": {
"Solidity": {
"contract": "Selfdestruct"
}
},
"value": 123456789
}
},
{
"Call": {
"dest": {
"Instantiated": 0
}
}
}
]
}
*/
contract Selfdestruct {
address tester;
uint value;
constructor() payable {
require(msg.value > 0, "the test should have value");
value = msg.value;
SelfdestructTester s = new SelfdestructTester{value: msg.value}();
tester = address(s);
}
fallback() external {
(bool success, ) = tester.call(hex"");
require(success, "the call to the self destructing contract should succeed");
}
}
contract SelfdestructTester {
constructor() payable {}
fallback() external {
selfdestruct(payable(msg.sender));
}
}
+20 -20
View File
@@ -12,6 +12,26 @@ pub struct Contract {
pub calldata: Vec<u8>, pub calldata: Vec<u8>,
} }
impl Contract {
pub fn build(calldata: Vec<u8>, name: &'static str, code: &str) -> Self {
Self {
name,
evm_runtime: compile_evm_bin_runtime(name, code),
pvm_runtime: compile_blob(name, code),
calldata,
}
}
pub fn build_size_opt(calldata: Vec<u8>, name: &'static str, code: &str) -> Self {
Self {
name,
evm_runtime: compile_evm_bin_runtime(name, code),
pvm_runtime: compile_blob_with_options(name, code, true, OptimizerSettings::size()),
calldata,
}
}
}
macro_rules! case { macro_rules! case {
// Arguments: // Arguments:
// 1. The file name, expect to live under "../contracts/" // 1. The file name, expect to live under "../contracts/"
@@ -261,26 +281,6 @@ sol!(
case!("AddressPredictor.sol", Predicted, constructorCall, predicted_constructor, salt: U256); case!("AddressPredictor.sol", Predicted, constructorCall, predicted_constructor, salt: U256);
case!("AddressPredictor.sol", AddressPredictor, constructorCall, address_predictor_constructor, salt: U256, bytecode: Bytes); case!("AddressPredictor.sol", AddressPredictor, constructorCall, address_predictor_constructor, salt: U256, bytecode: Bytes);
impl Contract {
pub fn build(calldata: Vec<u8>, name: &'static str, code: &str) -> Self {
Self {
name,
evm_runtime: compile_evm_bin_runtime(name, code),
pvm_runtime: compile_blob(name, code),
calldata,
}
}
pub fn build_size_opt(calldata: Vec<u8>, name: &'static str, code: &str) -> Self {
Self {
name,
evm_runtime: compile_evm_bin_runtime(name, code),
pvm_runtime: compile_blob_with_options(name, code, true, OptimizerSettings::size()),
calldata,
}
}
}
#[cfg(test)] #[cfg(test)]
mod tests { mod tests {
use rayon::iter::{IntoParallelIterator, ParallelIterator}; use rayon::iter::{IntoParallelIterator, ParallelIterator};
+5
View File
@@ -61,6 +61,9 @@ 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"); test_spec!(shift_arithmetic_right, "SAR", "SAR.sol");
test_spec!(add_mod_mul_mod, "AddModMulModTester", "AddModMulMod.sol");
test_spec!(memory_bounds, "MemoryBounds", "MemoryBounds.sol");
test_spec!(selfdestruct, "Selfdestruct", "Selfdestruct.sol");
fn instantiate(path: &str, contract: &str) -> Vec<SpecsAction> { fn instantiate(path: &str, contract: &str) -> Vec<SpecsAction> {
vec![Instantiate { vec![Instantiate {
@@ -167,6 +170,8 @@ fn signed_division() {
(minus_five, two), (minus_five, two),
(I256::MINUS_ONE, I256::MIN), (I256::MINUS_ONE, I256::MIN),
(one, I256::ZERO), (one, I256::ZERO),
(I256::MIN, I256::MINUS_ONE),
(I256::MIN + I256::ONE, I256::MINUS_ONE),
] { ] {
actions.push(Call { actions.push(Call {
origin: TestAddress::Alice, origin: TestAddress::Alice,
+5 -5
View File
@@ -1,6 +1,6 @@
[package] [package]
name = "revive-linker" name = "revive-linker"
version.workspace = true version = "0.2.0"
license.workspace = true license.workspace = true
edition.workspace = true edition.workspace = true
repository.workspace = true repository.workspace = true
@@ -8,10 +8,10 @@ authors.workspace = true
description = "revive compiler linker utils" description = "revive compiler linker utils"
[dependencies] [dependencies]
tempfile = { workspace = true }
polkavm-linker = { workspace = true }
libc = { workspace = true }
anyhow = { workspace = true } anyhow = { workspace = true }
libc = { workspace = true }
polkavm-linker = { workspace = true }
tempfile = { workspace = true }
revive-builtins = { workspace = true }
lld-sys = { workspace = true } lld-sys = { workspace = true }
revive-builtins = { workspace = true }
+114
View File
@@ -0,0 +1,114 @@
//! The revive ELF object linker library.
use std::{ffi::CString, fs, path::PathBuf, sync::Mutex};
use lld_sys::LLDELFLink;
use tempfile::TempDir;
use revive_builtins::COMPILER_RT;
static GUARD: Mutex<()> = Mutex::new(());
/// The revive ELF object linker.
pub struct ElfLinker {
temporary_directory: TempDir,
output_path: PathBuf,
object_path: PathBuf,
symbols_path: PathBuf,
linker_script_path: PathBuf,
}
impl ElfLinker {
const LINKER_SCRIPT: &str = r#"
SECTIONS {
.text : { KEEP(*(.text.polkavm_export)) *(.text .text.*) }
}"#;
const BUILTINS_ARCHIVE_FILE: &str = "libclang_rt.builtins-riscv64.a";
const BUILTINS_LIB_NAME: &str = "clang_rt.builtins-riscv64";
/// The setup routine prepares a temporary working directory.
pub fn setup() -> anyhow::Result<Self> {
let temporary_directory = TempDir::new()?;
let object_path = temporary_directory.path().join("obj.o");
let output_path = temporary_directory.path().join("out.o");
let symbols_path = temporary_directory.path().join("sym.o");
let linker_script_path = temporary_directory.path().join("linker.ld");
fs::write(&linker_script_path, Self::LINKER_SCRIPT)
.map_err(|message| anyhow::anyhow!("{message} {linker_script_path:?}",))?;
let compiler_rt_path = temporary_directory.path().join(Self::BUILTINS_ARCHIVE_FILE);
fs::write(&compiler_rt_path, COMPILER_RT)
.map_err(|message| anyhow::anyhow!("{message} {compiler_rt_path:?}"))?;
Ok(Self {
temporary_directory,
output_path,
object_path,
symbols_path,
linker_script_path,
})
}
/// Link `input` with `symbols` and the `compiler_rt` via `LLD`.
pub fn link<T: AsRef<[u8]>>(self, input: T, symbols: T) -> anyhow::Result<Vec<u8>> {
fs::write(&self.object_path, input)
.map_err(|message| anyhow::anyhow!("{message} {:?}", self.object_path))?;
fs::write(&self.symbols_path, symbols)
.map_err(|message| anyhow::anyhow!("{message} {:?}", self.symbols_path))?;
if lld(self
.create_arguments()
.into_iter()
.map(|v| v.to_string())
.collect())
{
return Err(anyhow::anyhow!("ld.lld failed"));
}
Ok(fs::read(&self.output_path)?)
}
/// The argument creation helper function.
fn create_arguments(&self) -> Vec<String> {
[
"ld.lld",
"--error-limit=0",
"--relocatable",
"--emit-relocs",
"--no-relax",
"--unique",
"--gc-sections",
self.linker_script_path.to_str().expect("should be utf8"),
"-o",
self.output_path.to_str().expect("should be utf8"),
self.object_path.to_str().expect("should be utf8"),
self.symbols_path.to_str().expect("should be utf8"),
"--library-path",
self.temporary_directory
.path()
.to_str()
.expect("should be utf8"),
"--library",
Self::BUILTINS_LIB_NAME,
]
.iter()
.map(ToString::to_string)
.collect()
}
}
/// The thread-safe LLD helper function.
fn lld(arguments: Vec<String>) -> bool {
let c_strings = arguments
.into_iter()
.map(|arg| CString::new(arg).expect("ld.lld args should not contain null bytes"))
.collect::<Vec<_>>();
let args: Vec<*const libc::c_char> = c_strings.iter().map(|arg| arg.as_ptr()).collect();
let _lock = GUARD.lock().expect("ICE: linker mutex should not poison");
unsafe { LLDELFLink(args.as_ptr(), args.len()) == 0 }
}
+3 -75
View File
@@ -1,76 +1,4 @@
use std::{env, ffi::CString, fs}; //! The revive ELF object to PVM blob linker library.
use lld_sys::LLDELFLink; pub mod elf;
use revive_builtins::COMPILER_RT; pub mod pvm;
const LINKER_SCRIPT: &str = r#"
SECTIONS {
.text : { KEEP(*(.text.polkavm_export)) *(.text .text.*) }
}"#;
const BUILTINS_ARCHIVE_FILE: &str = "libclang_rt.builtins-riscv64.a";
const BUILTINS_LIB_NAME: &str = "clang_rt.builtins-riscv64";
fn invoke_lld(cmd_args: &[&str]) -> bool {
let c_strings = cmd_args
.iter()
.map(|arg| CString::new(*arg).expect("ld.lld args should not contain null bytes"))
.collect::<Vec<_>>();
let args: Vec<*const libc::c_char> = c_strings.iter().map(|arg| arg.as_ptr()).collect();
unsafe { LLDELFLink(args.as_ptr(), args.len()) == 0 }
}
pub fn polkavm_linker<T: AsRef<[u8]>>(code: T, strip_binary: bool) -> anyhow::Result<Vec<u8>> {
let mut config = polkavm_linker::Config::default();
config.set_strip(strip_binary);
config.set_optimize(true);
polkavm_linker::program_from_elf(config, code.as_ref())
.map_err(|reason| anyhow::anyhow!("polkavm linker failed: {}", reason))
}
pub fn link<T: AsRef<[u8]>>(input: T) -> anyhow::Result<Vec<u8>> {
let dir = tempfile::tempdir().expect("failed to create temp directory for linking");
let output_path = dir.path().join("out.so");
let object_path = dir.path().join("out.o");
let linker_script_path = dir.path().join("linker.ld");
let compiler_rt_path = dir.path().join(BUILTINS_ARCHIVE_FILE);
fs::write(&object_path, input).map_err(|msg| anyhow::anyhow!("{msg} {object_path:?}"))?;
if env::var("PVM_LINKER_DUMP_OBJ").is_ok() {
fs::copy(&object_path, "/tmp/out.o")?;
}
fs::write(&linker_script_path, LINKER_SCRIPT)
.map_err(|msg| anyhow::anyhow!("{msg} {linker_script_path:?}"))?;
fs::write(&compiler_rt_path, COMPILER_RT)
.map_err(|msg| anyhow::anyhow!("{msg} {compiler_rt_path:?}"))?;
let ld_args = [
"ld.lld",
"--error-limit=0",
"--relocatable",
"--emit-relocs",
"--no-relax",
"--unique",
"--gc-sections",
"--library-path",
dir.path().to_str().expect("should be utf8"),
"--library",
BUILTINS_LIB_NAME,
linker_script_path.to_str().expect("should be utf8"),
object_path.to_str().expect("should be utf8"),
"-o",
output_path.to_str().expect("should be utf8"),
];
if invoke_lld(&ld_args) {
return Err(anyhow::anyhow!("ld.lld failed"));
}
Ok(fs::read(&output_path)?)
}
+10
View File
@@ -0,0 +1,10 @@
//! The revive PVM blob linker library.
pub fn polkavm_linker<T: AsRef<[u8]>>(code: T, strip_binary: bool) -> anyhow::Result<Vec<u8>> {
let mut config = polkavm_linker::Config::default();
config.set_strip(strip_binary);
config.set_optimize(true);
polkavm_linker::program_from_elf(config, code.as_ref())
.map_err(|reason| anyhow::anyhow!("polkavm linker failed: {}", reason))
}
+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 = "0.4.0"
license.workspace = true license.workspace = true
edition.workspace = true edition.workspace = true
repository.workspace = true repository.workspace = true
+7 -2
View File
@@ -59,7 +59,7 @@ Obtain a compatible build for your host platform from the release section of thi
* Install the builder using `cargo`: * Install the builder using `cargo`:
```shell ```shell
cargo install --git https://github.com/paritytech/revive-llvm-builder --force --locked cargo install --force --locked --path crates/llvm-builder
``` ```
> The builder is not the LLVM framework itself, but a tool that clones its repository and runs a sequence of build commands. By default it is installed in `~/.cargo/bin/`, which is recommended to be added to your `$PATH`. > The builder is not the LLVM framework itself, but a tool that clones its repository and runs a sequence of build commands. By default it is installed in `~/.cargo/bin/`, which is recommended to be added to your `$PATH`.
@@ -88,7 +88,12 @@ Obtain a compatible build for your host platform from the release section of thi
Build artifacts end up in the `./target-llvm/gnu/target-final/` directory by default. Build artifacts end up in the `./target-llvm/gnu/target-final/` directory by default.
The `gnu` directory depends on the supported archticture and will either be `gnu`, `musl` or `emscripten`. The `gnu` directory depends on the supported archticture and will either be `gnu`, `musl` or `emscripten`.
You now need to export the final target directory `$LLVM_SYS_181_PREFIX`: `export LLVM_SYS_181_PREFIX=${PWD}/target-llvm/gnu/target-final` You now need to export the final target directory `$LLVM_SYS_181_PREFIX`:
```shell
export LLVM_SYS_181_PREFIX=${PWD}/target-llvm/gnu/target-final
```
If built with the `--enable-tests` option, test tools will be in the `./target-llvm/gnu/build-final/` directory, along with copies of the build artifacts. For all supported build options, run `revive-llvm build --help`. If built with the `--enable-tests` option, test tools will be in the `./target-llvm/gnu/build-final/` directory, along with copies of the build artifacts. For all supported build options, run `revive-llvm build --help`.
</details> </details>
+17 -17
View File
@@ -2,20 +2,20 @@ pub mod common;
use std::process::Command; use std::process::Command;
use assert_cmd::prelude::*; use assert_cmd::{cargo, prelude::*};
/// This test verifies that the LLVM repository can be successfully cloned, built, and cleaned. /// This test verifies that the LLVM repository can be successfully cloned, built, and cleaned.
#[test] #[test]
fn clone_build_and_clean() -> anyhow::Result<()> { fn clone_build_and_clean() -> anyhow::Result<()> {
let test_dir = common::TestDir::with_lockfile(None)?; let test_dir = common::TestDir::with_lockfile(None)?;
Command::cargo_bin(common::REVIVE_LLVM)? Command::new(cargo::cargo_bin!("revive-llvm"))
.current_dir(test_dir.path()) .current_dir(test_dir.path())
.arg("clone") .arg("clone")
.assert() .assert()
.success(); .success();
Command::cargo_bin(common::REVIVE_LLVM)? Command::new(cargo::cargo_bin!("revive-llvm"))
.current_dir(test_dir.path()) .current_dir(test_dir.path())
.arg("build") .arg("build")
.arg("--llvm-projects") .arg("--llvm-projects")
@@ -25,13 +25,13 @@ fn clone_build_and_clean() -> anyhow::Result<()> {
.assert() .assert()
.success(); .success();
Command::cargo_bin(common::REVIVE_LLVM)? Command::new(cargo::cargo_bin!("revive-llvm"))
.current_dir(test_dir.path()) .current_dir(test_dir.path())
.arg("builtins") .arg("builtins")
.assert() .assert()
.success(); .success();
Command::cargo_bin(common::REVIVE_LLVM)? Command::new(cargo::cargo_bin!("revive-llvm"))
.current_dir(test_dir.path()) .current_dir(test_dir.path())
.arg("clean") .arg("clean")
.assert() .assert()
@@ -47,13 +47,13 @@ fn clone_build_and_clean() -> anyhow::Result<()> {
fn clone_build_and_clean_musl() -> anyhow::Result<()> { fn clone_build_and_clean_musl() -> anyhow::Result<()> {
let test_dir = common::TestDir::with_lockfile(None)?; let test_dir = common::TestDir::with_lockfile(None)?;
Command::cargo_bin(common::REVIVE_LLVM)? Command::new(cargo::cargo_bin!("revive-llvm"))
.arg("clone") .arg("clone")
.current_dir(test_dir.path()) .current_dir(test_dir.path())
.assert() .assert()
.success(); .success();
Command::cargo_bin(common::REVIVE_LLVM)? Command::new(cargo::cargo_bin!("revive-llvm"))
.current_dir(test_dir.path()) .current_dir(test_dir.path())
.arg("build") .arg("build")
.arg("--llvm-projects") .arg("--llvm-projects")
@@ -63,7 +63,7 @@ fn clone_build_and_clean_musl() -> anyhow::Result<()> {
.assert() .assert()
.success(); .success();
Command::cargo_bin(common::REVIVE_LLVM)? Command::new(cargo::cargo_bin!("revive-llvm"))
.arg("--target-env") .arg("--target-env")
.arg("musl") .arg("musl")
.arg("build") .arg("build")
@@ -75,7 +75,7 @@ fn clone_build_and_clean_musl() -> anyhow::Result<()> {
.assert() .assert()
.success(); .success();
Command::cargo_bin(common::REVIVE_LLVM)? Command::new(cargo::cargo_bin!("revive-llvm"))
.current_dir(test_dir.path()) .current_dir(test_dir.path())
.arg("clean") .arg("clean")
.assert() .assert()
@@ -91,13 +91,13 @@ fn clone_build_and_clean_musl() -> anyhow::Result<()> {
fn debug_build_with_tests_coverage() -> anyhow::Result<()> { fn debug_build_with_tests_coverage() -> anyhow::Result<()> {
let test_dir = common::TestDir::with_lockfile(None)?; let test_dir = common::TestDir::with_lockfile(None)?;
Command::cargo_bin(common::REVIVE_LLVM)? Command::new(cargo::cargo_bin!("revive-llvm"))
.current_dir(test_dir.path()) .current_dir(test_dir.path())
.arg("clone") .arg("clone")
.assert() .assert()
.success(); .success();
Command::cargo_bin(common::REVIVE_LLVM)? Command::new(cargo::cargo_bin!("revive-llvm"))
.current_dir(test_dir.path()) .current_dir(test_dir.path())
.arg("build") .arg("build")
.arg("--enable-coverage") .arg("--enable-coverage")
@@ -120,13 +120,13 @@ fn debug_build_with_tests_coverage() -> anyhow::Result<()> {
fn build_with_sanitizers() -> anyhow::Result<()> { fn build_with_sanitizers() -> anyhow::Result<()> {
let test_dir = common::TestDir::with_lockfile(None)?; let test_dir = common::TestDir::with_lockfile(None)?;
Command::cargo_bin(common::REVIVE_LLVM)? Command::new(cargo::cargo_bin!("revive-llvm"))
.current_dir(test_dir.path()) .current_dir(test_dir.path())
.arg("clone") .arg("clone")
.assert() .assert()
.success(); .success();
Command::cargo_bin(common::REVIVE_LLVM)? Command::new(cargo::cargo_bin!("revive-llvm"))
.current_dir(test_dir.path()) .current_dir(test_dir.path())
.arg("build") .arg("build")
.arg("--sanitizer") .arg("--sanitizer")
@@ -146,16 +146,16 @@ fn build_with_sanitizers() -> anyhow::Result<()> {
#[cfg(target_os = "linux")] #[cfg(target_os = "linux")]
fn clone_build_and_clean_emscripten() -> anyhow::Result<()> { fn clone_build_and_clean_emscripten() -> anyhow::Result<()> {
let test_dir = common::TestDir::with_lockfile(None)?; let test_dir = common::TestDir::with_lockfile(None)?;
let command = Command::cargo_bin(common::REVIVE_LLVM)?; let command = Command::new(cargo::cargo_bin!("revive-llvm"));
let program = command.get_program().to_string_lossy(); let program = command.get_program().to_string_lossy();
Command::cargo_bin(common::REVIVE_LLVM)? Command::new(cargo::cargo_bin!("revive-llvm"))
.current_dir(test_dir.path()) .current_dir(test_dir.path())
.arg("clone") .arg("clone")
.assert() .assert()
.success(); .success();
Command::cargo_bin(common::REVIVE_LLVM)? Command::new(cargo::cargo_bin!("revive-llvm"))
.current_dir(test_dir.path()) .current_dir(test_dir.path())
.arg("build") .arg("build")
.arg("--llvm-projects") .arg("--llvm-projects")
@@ -183,7 +183,7 @@ fn clone_build_and_clean_emscripten() -> anyhow::Result<()> {
.assert() .assert()
.success(); .success();
Command::cargo_bin(common::REVIVE_LLVM)? Command::new(cargo::cargo_bin!("revive-llvm"))
.arg("clean") .arg("clean")
.current_dir(test_dir.path()) .current_dir(test_dir.path())
.assert() .assert()
+5 -5
View File
@@ -2,7 +2,7 @@ pub mod common;
use std::process::Command; use std::process::Command;
use assert_cmd::prelude::*; use assert_cmd::{cargo, prelude::*};
/// This test verifies that after cloning the LLVM repository, checking out a specific branch /// This test verifies that after cloning the LLVM repository, checking out a specific branch
/// or reference works as expected. /// or reference works as expected.
@@ -10,13 +10,13 @@ use assert_cmd::prelude::*;
fn checkout_after_clone() -> anyhow::Result<()> { fn checkout_after_clone() -> anyhow::Result<()> {
let test_dir = common::TestDir::with_lockfile(None)?; let test_dir = common::TestDir::with_lockfile(None)?;
Command::cargo_bin(common::REVIVE_LLVM)? Command::new(cargo::cargo_bin!("revive-llvm"))
.current_dir(test_dir.path()) .current_dir(test_dir.path())
.arg("clone") .arg("clone")
.assert() .assert()
.success(); .success();
Command::cargo_bin(common::REVIVE_LLVM)? Command::new(cargo::cargo_bin!("revive-llvm"))
.current_dir(test_dir.path()) .current_dir(test_dir.path())
.arg("checkout") .arg("checkout")
.assert() .assert()
@@ -31,13 +31,13 @@ fn checkout_after_clone() -> anyhow::Result<()> {
fn force_checkout() -> anyhow::Result<()> { fn force_checkout() -> anyhow::Result<()> {
let test_dir = common::TestDir::with_lockfile(None)?; let test_dir = common::TestDir::with_lockfile(None)?;
Command::cargo_bin(common::REVIVE_LLVM)? Command::new(cargo::cargo_bin!("revive-llvm"))
.current_dir(test_dir.path()) .current_dir(test_dir.path())
.arg("clone") .arg("clone")
.assert() .assert()
.success(); .success();
Command::cargo_bin(common::REVIVE_LLVM)? Command::new(cargo::cargo_bin!("revive-llvm"))
.current_dir(test_dir.path()) .current_dir(test_dir.path())
.arg("checkout") .arg("checkout")
.arg("--force") .arg("--force")
+3 -3
View File
@@ -2,7 +2,7 @@ pub mod common;
use std::process::Command; use std::process::Command;
use assert_cmd::prelude::*; use assert_cmd::{cargo, prelude::*};
/// This test verifies that the LLVM repository can be successfully cloned using a specific branch /// This test verifies that the LLVM repository can be successfully cloned using a specific branch
/// and reference. /// and reference.
@@ -10,7 +10,7 @@ use assert_cmd::prelude::*;
fn clone() -> anyhow::Result<()> { fn clone() -> anyhow::Result<()> {
let test_dir = common::TestDir::with_lockfile(None)?; let test_dir = common::TestDir::with_lockfile(None)?;
Command::cargo_bin(common::REVIVE_LLVM)? Command::new(cargo::cargo_bin!("revive-llvm"))
.current_dir(test_dir.path()) .current_dir(test_dir.path())
.arg("clone") .arg("clone")
.assert() .assert()
@@ -25,7 +25,7 @@ fn clone() -> anyhow::Result<()> {
fn clone_deep() -> anyhow::Result<()> { fn clone_deep() -> anyhow::Result<()> {
let test_dir = common::TestDir::with_lockfile(None)?; let test_dir = common::TestDir::with_lockfile(None)?;
Command::cargo_bin(common::REVIVE_LLVM)? Command::new(cargo::cargo_bin!("revive-llvm"))
.current_dir(test_dir.path()) .current_dir(test_dir.path())
.arg("clone") .arg("clone")
.arg("--deep") .arg("--deep")
+1 -2
View File
@@ -1,6 +1,6 @@
[package] [package]
name = "revive-llvm-context" name = "revive-llvm-context"
version = "0.3.0" version = "0.5.0"
license.workspace = true license.workspace = true
edition.workspace = true edition.workspace = true
repository.workspace = true repository.workspace = true
@@ -20,7 +20,6 @@ itertools = { workspace = true }
serde = { workspace = true, features = ["derive"] } serde = { workspace = true, features = ["derive"] }
num = { workspace = true } num = { workspace = true }
hex = { workspace = true } hex = { workspace = true }
sha3 = { workspace = true }
inkwell = { workspace = true } inkwell = { workspace = true }
libc = { workspace = true } libc = { workspace = true }
polkavm-disassembler = { workspace = true } polkavm-disassembler = { workspace = true }
@@ -1,5 +1,9 @@
//! The debug IR type. //! The debug IR type.
use revive_common::{
EXTENSION_LLVM_SOURCE, EXTENSION_OBJECT, EXTENSION_POLKAVM_ASSEMBLY, EXTENSION_YUL,
};
/// The debug IR type. /// The debug IR type.
#[allow(clippy::upper_case_acronyms)] #[allow(clippy::upper_case_acronyms)]
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)] #[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
@@ -11,22 +15,17 @@ pub enum IRType {
/// Whether to dump the assembly code. /// Whether to dump the assembly code.
Assembly, Assembly,
/// Whether to dump the ELF shared object /// Whether to dump the ELF shared object
SO, Object,
/// Whether to jump JSON
#[cfg(debug_assertions)]
JSON,
} }
impl IRType { impl IRType {
/// Returns the file extension for the specified IR. /// Returns the file extension for the specified IR.
pub fn file_extension(&self) -> &'static str { pub fn file_extension(&self) -> &'static str {
match self { match self {
Self::Yul => revive_common::EXTENSION_YUL, Self::Yul => EXTENSION_YUL,
Self::LLVM => revive_common::EXTENSION_LLVM_SOURCE, Self::LLVM => EXTENSION_LLVM_SOURCE,
Self::Assembly => revive_common::EXTENSION_POLKAVM_ASSEMBLY, Self::Assembly => EXTENSION_POLKAVM_ASSEMBLY,
#[cfg(debug_assertions)] Self::Object => EXTENSION_OBJECT,
Self::JSON => revive_common::EXTENSION_JSON,
Self::SO => revive_common::EXTENSION_SHARED_OBJECT,
} }
} }
} }
+3 -42
View File
@@ -1,8 +1,5 @@
//! The debug configuration. //! The debug configuration.
pub mod ir_type;
use std::path::Path;
use std::path::PathBuf; use std::path::PathBuf;
use serde::Deserialize; use serde::Deserialize;
@@ -10,6 +7,8 @@ use serde::Serialize;
use self::ir_type::IRType; use self::ir_type::IRType;
pub mod ir_type;
/// The debug configuration. /// The debug configuration.
#[derive(Debug, Default, Serialize, Deserialize, Clone)] #[derive(Debug, Default, Serialize, Deserialize, Clone)]
pub struct DebugConfig { pub struct DebugConfig {
@@ -18,13 +17,7 @@ pub struct DebugConfig {
/// Whether debug info should be emitted. /// Whether debug info should be emitted.
pub emit_debug_info: bool, pub emit_debug_info: bool,
/// The YUL debug output file path. /// The YUL debug output file path.
///
/// Is expected to be configured when running in YUL mode.
pub contract_path: Option<PathBuf>, pub contract_path: Option<PathBuf>,
/// The YUL input file path.
///
/// Is expected to be configured when not running in YUL mode.
pub yul_path: Option<PathBuf>,
} }
impl DebugConfig { impl DebugConfig {
@@ -34,29 +27,15 @@ impl DebugConfig {
output_directory, output_directory,
emit_debug_info, emit_debug_info,
contract_path: None, contract_path: None,
yul_path: None,
} }
} }
/// Set the current YUL path.
pub fn set_yul_path(&mut self, yul_path: &Path) {
self.yul_path = yul_path.to_path_buf().into();
}
/// Set the current contract path. /// Set the current contract path.
pub fn set_contract_path(&mut self, contract_path: &str) { pub fn set_contract_path(&mut self, contract_path: &str) {
self.contract_path = self.yul_source_path(contract_path); self.contract_path = self.yul_source_path(contract_path);
} }
/// Returns with the following precedence:
/// 1. The YUL source path if it was configured.
/// 2. The source YUL path from the debug output dir if it was configured.
/// 3. `None` if there is no debug output directory.
pub fn yul_source_path(&self, contract_path: &str) -> Option<PathBuf> { pub fn yul_source_path(&self, contract_path: &str) -> Option<PathBuf> {
if let Some(path) = self.yul_path.as_ref() {
return Some(path.clone());
}
self.output_directory.as_ref().map(|output_directory| { self.output_directory.as_ref().map(|output_directory| {
let mut file_path = output_directory.to_owned(); let mut file_path = output_directory.to_owned();
let full_file_name = Self::full_file_name(contract_path, None, IRType::Yul); let full_file_name = Self::full_file_name(contract_path, None, IRType::Yul);
@@ -128,7 +107,7 @@ impl DebugConfig {
pub fn dump_object(&self, contract_path: &str, code: &[u8]) -> anyhow::Result<()> { pub fn dump_object(&self, contract_path: &str, code: &[u8]) -> anyhow::Result<()> {
if let Some(output_directory) = self.output_directory.as_ref() { if let Some(output_directory) = self.output_directory.as_ref() {
let mut file_path = output_directory.to_owned(); let mut file_path = output_directory.to_owned();
let full_file_name = Self::full_file_name(contract_path, None, IRType::SO); let full_file_name = Self::full_file_name(contract_path, None, IRType::Object);
file_path.push(full_file_name); file_path.push(full_file_name);
std::fs::write(file_path, code)?; std::fs::write(file_path, code)?;
} }
@@ -136,24 +115,6 @@ impl DebugConfig {
Ok(()) Ok(())
} }
/// Dumps the stage output as a json file suitable for use with --recursive-process
#[cfg(debug_assertions)]
pub fn dump_stage_output(
&self,
contract_path: &str,
contract_suffix: Option<&str>,
stage_json: &Vec<u8>,
) -> anyhow::Result<()> {
if let Some(output_directory) = self.output_directory.as_ref() {
let mut file_path = output_directory.to_owned();
let full_file_name = Self::full_file_name(contract_path, contract_suffix, IRType::JSON);
file_path.push(full_file_name);
std::fs::write(file_path, stage_json)?;
}
Ok(())
}
/// Creates a full file name, given the contract full path, suffix, and extension. /// Creates a full file name, given the contract full path, suffix, and extension.
fn full_file_name(contract_path: &str, suffix: Option<&str>, ir_type: IRType) -> String { fn full_file_name(contract_path: &str, suffix: Option<&str>, ir_type: IRType) -> String {
let mut full_file_name = contract_path.replace('/', "_").replace(':', "."); let mut full_file_name = contract_path.replace('/', "_").replace(':', ".");
+10 -7
View File
@@ -1,5 +1,7 @@
//! The LLVM context library. //! The LLVM context library.
#![allow(clippy::too_many_arguments)]
use std::ffi::CString; use std::ffi::CString;
use std::sync::OnceLock; use std::sync::OnceLock;
@@ -8,7 +10,7 @@ pub use self::debug_config::DebugConfig;
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;
pub use self::polkavm::build_assembly_text as polkavm_build_assembly_text; pub use self::polkavm::build as polkavm_build;
pub use self::polkavm::context::address_space::AddressSpace as PolkaVMAddressSpace; pub use self::polkavm::context::address_space::AddressSpace as PolkaVMAddressSpace;
pub use self::polkavm::context::argument::Argument as PolkaVMArgument; pub use self::polkavm::context::argument::Argument as PolkaVMArgument;
pub use self::polkavm::context::attribute::Attribute as PolkaVMAttribute; pub use self::polkavm::context::attribute::Attribute as PolkaVMAttribute;
@@ -46,6 +48,7 @@ pub use self::polkavm::context::r#loop::Loop as PolkaVMLoop;
pub use self::polkavm::context::solidity_data::SolidityData as PolkaVMContextSolidityData; pub use self::polkavm::context::solidity_data::SolidityData as PolkaVMContextSolidityData;
pub use self::polkavm::context::yul_data::YulData as PolkaVMContextYulData; pub use self::polkavm::context::yul_data::YulData as PolkaVMContextYulData;
pub use self::polkavm::context::Context as PolkaVMContext; pub use self::polkavm::context::Context as PolkaVMContext;
pub use self::polkavm::disassemble as polkavm_disassemble;
pub use self::polkavm::evm::arithmetic as polkavm_evm_arithmetic; pub use self::polkavm::evm::arithmetic as polkavm_evm_arithmetic;
pub use self::polkavm::evm::bitwise as polkavm_evm_bitwise; pub use self::polkavm::evm::bitwise as polkavm_evm_bitwise;
pub use self::polkavm::evm::call as polkavm_evm_call; pub use self::polkavm::evm::call as polkavm_evm_call;
@@ -66,13 +69,13 @@ pub use self::polkavm::evm::memory as polkavm_evm_memory;
pub use self::polkavm::evm::r#return as polkavm_evm_return; pub use self::polkavm::evm::r#return as polkavm_evm_return;
pub use self::polkavm::evm::return_data as polkavm_evm_return_data; pub use self::polkavm::evm::return_data as polkavm_evm_return_data;
pub use self::polkavm::evm::storage as polkavm_evm_storage; pub use self::polkavm::evm::storage as polkavm_evm_storage;
pub use self::polkavm::hash as polkavm_hash;
pub use self::polkavm::link as polkavm_link;
pub use self::polkavm::r#const as polkavm_const; pub use self::polkavm::r#const as polkavm_const;
pub use self::polkavm::Dependency as PolkaVMDependency;
pub use self::polkavm::DummyDependency as PolkaVMDummyDependency;
pub use self::polkavm::DummyLLVMWritable as PolkaVMDummyLLVMWritable; pub use self::polkavm::DummyLLVMWritable as PolkaVMDummyLLVMWritable;
pub use self::polkavm::WriteLLVM as PolkaVMWriteLLVM; pub use self::polkavm::WriteLLVM as PolkaVMWriteLLVM;
pub use self::target_machine::target::Target; pub use self::target_machine::target::Target as PolkaVMTarget;
pub use self::target_machine::TargetMachine; pub use self::target_machine::TargetMachine as PolkaVMTargetMachine;
pub(crate) mod debug_config; pub(crate) mod debug_config;
pub(crate) mod optimizer; pub(crate) mod optimizer;
@@ -86,7 +89,7 @@ static DID_INITIALIZE: OnceLock<()> = OnceLock::new();
/// This is a no-op if called subsequentially. /// This is a no-op if called subsequentially.
/// ///
/// `llvm_arguments` are passed as-is to the LLVM CL options parser. /// `llvm_arguments` are passed as-is to the LLVM CL options parser.
pub fn initialize_llvm(target: Target, name: &str, llvm_arguments: &[String]) { pub fn initialize_llvm(target: PolkaVMTarget, name: &str, llvm_arguments: &[String]) {
let Ok(_) = DID_INITIALIZE.set(()) else { let Ok(_) = DID_INITIALIZE.set(()) else {
return; // Tests don't go through a recursive process return; // Tests don't go through a recursive process
}; };
@@ -109,6 +112,6 @@ pub fn initialize_llvm(target: Target, name: &str, llvm_arguments: &[String]) {
inkwell::support::enable_llvm_pretty_stack_trace(); inkwell::support::enable_llvm_pretty_stack_trace();
match target { match target {
Target::PVM => inkwell::targets::Target::initialize_riscv(&Default::default()), PolkaVMTarget::PVM => inkwell::targets::Target::initialize_riscv(&Default::default()),
} }
} }
+2 -2
View File
@@ -1,7 +1,5 @@
//! The LLVM optimizing tools. //! The LLVM optimizing tools.
pub mod settings;
use serde::Deserialize; use serde::Deserialize;
use serde::Serialize; use serde::Serialize;
@@ -9,6 +7,8 @@ use crate::target_machine::TargetMachine;
use self::settings::Settings; use self::settings::Settings;
pub mod settings;
/// The LLVM optimizing tools. /// The LLVM optimizing tools.
#[derive(Debug, Serialize, Deserialize)] #[derive(Debug, Serialize, Deserialize)]
pub struct Optimizer { pub struct Optimizer {
@@ -1,8 +1,5 @@
//! The LLVM optimizer settings. //! The LLVM optimizer settings.
pub mod size_level;
use revive_solc_json_interface::SolcStandardJsonInputSettingsOptimizer;
use serde::Deserialize; use serde::Deserialize;
use serde::Serialize; use serde::Serialize;
@@ -10,6 +7,8 @@ use itertools::Itertools;
use self::size_level::SizeLevel; use self::size_level::SizeLevel;
pub mod size_level;
/// The LLVM optimizer and code-gen settings. /// The LLVM optimizer and code-gen settings.
#[derive(Debug, Serialize, Deserialize, Clone, Eq)] #[derive(Debug, Serialize, Deserialize, Clone, Eq)]
pub struct Settings { pub struct Settings {
@@ -20,9 +19,6 @@ pub struct Settings {
/// The back-end optimization level. /// The back-end optimization level.
pub level_back_end: inkwell::OptimizationLevel, pub level_back_end: inkwell::OptimizationLevel,
/// Fallback to optimizing for size if the bytecode is too large.
pub is_fallback_to_size_enabled: bool,
/// Whether the LLVM `verify each` option is enabled. /// Whether the LLVM `verify each` option is enabled.
pub is_verify_each_enabled: bool, pub is_verify_each_enabled: bool,
/// Whether the LLVM `debug logging` option is enabled. /// Whether the LLVM `debug logging` option is enabled.
@@ -41,8 +37,6 @@ impl Settings {
level_middle_end_size, level_middle_end_size,
level_back_end, level_back_end,
is_fallback_to_size_enabled: false,
is_verify_each_enabled: false, is_verify_each_enabled: false,
is_debug_logging_enabled: false, is_debug_logging_enabled: false,
} }
@@ -62,8 +56,6 @@ impl Settings {
level_middle_end_size, level_middle_end_size,
level_back_end, level_back_end,
is_fallback_to_size_enabled: false,
is_verify_each_enabled, is_verify_each_enabled,
is_debug_logging_enabled, is_debug_logging_enabled,
} }
@@ -197,16 +189,6 @@ impl Settings {
combinations combinations
} }
/// Sets the fallback to optimizing for size if the bytecode is too large.
pub fn enable_fallback_to_size(&mut self) {
self.is_fallback_to_size_enabled = true;
}
/// Whether the fallback to optimizing for size is enabled.
pub fn is_fallback_to_size_enabled(&self) -> bool {
self.is_fallback_to_size_enabled
}
} }
impl PartialEq for Settings { impl PartialEq for Settings {
@@ -227,18 +209,3 @@ impl std::fmt::Display for Settings {
) )
} }
} }
impl TryFrom<&SolcStandardJsonInputSettingsOptimizer> for Settings {
type Error = anyhow::Error;
fn try_from(value: &SolcStandardJsonInputSettingsOptimizer) -> Result<Self, Self::Error> {
let mut result = match value.mode {
Some(mode) => Self::try_from_cli(mode)?,
None => Self::size(),
};
if value.fallback_to_optimizing_for_size.unwrap_or_default() {
result.enable_fallback_to_size();
}
Ok(result)
}
}
+4 -2
View File
@@ -1,10 +1,12 @@
//! The LLVM context constants. //! The LLVM context constants.
use revive_common::{BIT_LENGTH_X32, BYTE_LENGTH_WORD};
/// The LLVM framework version. /// The LLVM framework version.
pub const LLVM_VERSION: semver::Version = semver::Version::new(18, 1, 4); pub const LLVM_VERSION: semver::Version = semver::Version::new(18, 1, 4);
/// The pointer width sized type. /// The pointer width sized type.
pub static XLEN: usize = revive_common::BIT_LENGTH_X32; pub static XLEN: usize = BIT_LENGTH_X32;
/// The calldata size global variable name. /// The calldata size global variable name.
pub static GLOBAL_CALLDATA_SIZE: &str = "calldatasize"; pub static GLOBAL_CALLDATA_SIZE: &str = "calldatasize";
@@ -20,4 +22,4 @@ pub static GLOBAL_ADDRESS_SPILL_BUFFER: &str = "address_spill_buffer";
/// The deployer call header size that consists of: /// The deployer call header size that consists of:
/// - bytecode hash (32 bytes) /// - bytecode hash (32 bytes)
pub const DEPLOYER_CALL_HEADER_SIZE: usize = revive_common::BYTE_LENGTH_WORD; pub const DEPLOYER_CALL_HEADER_SIZE: usize = BYTE_LENGTH_WORD;
@@ -66,9 +66,9 @@ impl<'ctx> Argument<'ctx> {
/// Access the underlying value. /// Access the underlying value.
/// ///
/// Will emit a stack load if `self` is a pointer argument. /// Will emit a stack load if `self` is a pointer argument.
pub fn access<D: crate::polkavm::Dependency + Clone>( pub fn access(
&self, &self,
context: &crate::polkavm::context::Context<'ctx, D>, context: &crate::polkavm::context::Context<'ctx>,
) -> anyhow::Result<inkwell::values::BasicValueEnum<'ctx>> { ) -> anyhow::Result<inkwell::values::BasicValueEnum<'ctx>> {
match &self.value { match &self.value {
Value::Register(value) => Ok(*value), Value::Register(value) => Ok(*value),
@@ -79,9 +79,9 @@ impl<'ctx> Argument<'ctx> {
/// Access the underlying value. /// Access the underlying value.
/// ///
/// Will emit a stack load if `self` is a pointer argument. /// Will emit a stack load if `self` is a pointer argument.
pub fn as_pointer<D: crate::polkavm::Dependency + Clone>( pub fn as_pointer(
&self, &self,
context: &crate::polkavm::context::Context<'ctx, D>, context: &crate::polkavm::context::Context<'ctx>,
) -> anyhow::Result<crate::polkavm::context::Pointer<'ctx>> { ) -> anyhow::Result<crate::polkavm::context::Pointer<'ctx>> {
match &self.value { match &self.value {
Value::Register(value) => { Value::Register(value) => {
@@ -1,7 +1,6 @@
//! The LLVM module build. //! The LLVM module build.
use std::collections::BTreeMap; use revive_common::BYTE_LENGTH_WORD;
use serde::Deserialize; use serde::Deserialize;
use serde::Serialize; use serde::Serialize;
@@ -9,31 +8,23 @@ use serde::Serialize;
#[derive(Debug, Serialize, Deserialize)] #[derive(Debug, Serialize, Deserialize)]
pub struct Build { pub struct Build {
/// The PolkaVM text assembly. /// The PolkaVM text assembly.
pub assembly_text: String, pub assembly_text: Option<String>,
/// The metadata hash. /// The metadata hash.
pub metadata_hash: Option<[u8; revive_common::BYTE_LENGTH_WORD]>, pub metadata_hash: Option<[u8; BYTE_LENGTH_WORD]>,
/// The PolkaVM binary bytecode. /// The PolkaVM binary bytecode.
pub bytecode: Vec<u8>, pub bytecode: Vec<u8>,
/// The PolkaVM bytecode hash. /// The PolkaVM bytecode hash. Unlinked builds don't have a hash yet.
pub bytecode_hash: String, pub bytecode_hash: Option<[u8; BYTE_LENGTH_WORD]>,
/// The hash-to-full-path mapping of the contract factory dependencies.
pub factory_dependencies: BTreeMap<String, String>,
} }
impl Build { impl Build {
/// A shortcut constructor. /// A shortcut constructor.
pub fn new( pub fn new(metadata_hash: Option<[u8; BYTE_LENGTH_WORD]>, bytecode: Vec<u8>) -> Self {
assembly_text: String,
metadata_hash: Option<[u8; revive_common::BYTE_LENGTH_WORD]>,
bytecode: Vec<u8>,
bytecode_hash: String,
) -> Self {
Self { Self {
assembly_text, assembly_text: None,
metadata_hash, metadata_hash,
bytecode, bytecode,
bytecode_hash, bytecode_hash: None,
factory_dependencies: BTreeMap::new(),
} }
} }
} }
@@ -2,6 +2,8 @@
use std::cell::RefCell; use std::cell::RefCell;
use revive_common::BIT_LENGTH_WORD;
use inkwell::debug_info::AsDIScope; use inkwell::debug_info::AsDIScope;
use inkwell::debug_info::DIScope; use inkwell::debug_info::DIScope;
@@ -164,7 +166,7 @@ impl<'ctx> DebugInfo<'ctx> {
&self, &self,
flags: Option<inkwell::debug_info::DIFlags>, flags: Option<inkwell::debug_info::DIFlags>,
) -> anyhow::Result<inkwell::debug_info::DIBasicType<'ctx>> { ) -> anyhow::Result<inkwell::debug_info::DIBasicType<'ctx>> {
self.create_primitive_type(revive_common::BIT_LENGTH_WORD, flags) self.create_primitive_type(BIT_LENGTH_WORD, flags)
} }
/// Return the DIBuilder. /// Return the DIBuilder.
@@ -64,24 +64,13 @@ impl<'ctx> LLVMRuntime<'ctx> {
} }
} }
/// Declares an LLVM runtime function in the `module`,
pub fn declare(
module: &inkwell::module::Module<'ctx>,
name: &str,
r#type: inkwell::types::FunctionType<'ctx>,
linkage: Option<inkwell::module::Linkage>,
) -> FunctionDeclaration<'ctx> {
let value = module.add_function(name, r#type, linkage);
FunctionDeclaration::new(r#type, value)
}
/// Create the function definition from an existing symbol. /// Create the function definition from an existing symbol.
pub fn define( pub fn define(
module: &inkwell::module::Module<'ctx>, module: &inkwell::module::Module<'ctx>,
name: &str, name: &str,
) -> Option<FunctionDeclaration<'ctx>> { ) -> Option<FunctionDeclaration<'ctx>> {
let value = module.get_function(name)?; let value = module.get_function(name)?;
value.set_linkage(inkwell::module::Linkage::External); value.set_linkage(inkwell::module::Linkage::Private);
FunctionDeclaration::new(value.get_type(), value).into() FunctionDeclaration::new(value.get_type(), value).into()
} }
} }
@@ -1,12 +1,5 @@
//! The LLVM IR generator function. //! The LLVM IR generator function.
pub mod declaration;
pub mod intrinsics;
pub mod llvm_runtime;
pub mod r#return;
pub mod runtime;
pub mod yul_data;
use std::collections::HashMap; use std::collections::HashMap;
use inkwell::debug_info::AsDIScope; use inkwell::debug_info::AsDIScope;
@@ -20,6 +13,13 @@ use self::declaration::Declaration;
use self::r#return::Return; use self::r#return::Return;
use self::yul_data::YulData; use self::yul_data::YulData;
pub mod declaration;
pub mod intrinsics;
pub mod llvm_runtime;
pub mod r#return;
pub mod runtime;
pub mod yul_data;
/// The LLVM IR generator function. /// The LLVM IR generator function.
#[derive(Debug)] #[derive(Debug)]
pub struct Function<'ctx> { pub struct Function<'ctx> {
@@ -75,15 +75,6 @@ impl<'ctx> Function<'ctx> {
self.name.as_str() self.name.as_str()
} }
/// Checks whether the function is defined outside of the front-end.
pub fn is_name_external(name: &str) -> bool {
name.starts_with("llvm.")
|| (name.starts_with("__")
&& name != self::runtime::FUNCTION_ENTRY
&& name != self::runtime::FUNCTION_DEPLOY_CODE
&& name != self::runtime::FUNCTION_RUNTIME_CODE)
}
/// Returns the LLVM function declaration. /// Returns the LLVM function declaration.
pub fn declaration(&self) -> Declaration<'ctx> { pub fn declaration(&self) -> Declaration<'ctx> {
self.declaration self.declaration
@@ -223,30 +214,11 @@ impl<'ctx> Function<'ctx> {
self.stack.get(name).copied() self.stack.get(name).copied()
} }
/// Removes the pointer to a stack variable.
pub fn remove_stack_pointer(&mut self, name: &str) {
self.stack.remove(name);
}
/// Returns the return entity representation. /// Returns the return entity representation.
pub fn r#return(&self) -> Return<'ctx> { pub fn r#return(&self) -> Return<'ctx> {
self.r#return self.r#return
} }
/// Returns the pointer to the function return value.
/// # Panics
/// If the pointer has not been set yet.
pub fn return_pointer(&self) -> Option<Pointer<'ctx>> {
self.r#return.return_pointer()
}
/// Returns the return data size in bytes, based on the default stack alignment.
/// # Panics
/// If the pointer has not been set yet.
pub fn return_data_size(&self) -> usize {
self.r#return.return_data_size()
}
/// Returns the function entry block. /// Returns the function entry block.
pub fn entry_block(&self) -> inkwell::basic_block::BasicBlock<'ctx> { pub fn entry_block(&self) -> inkwell::basic_block::BasicBlock<'ctx> {
self.entry_block self.entry_block
@@ -1,22 +1,19 @@
//! Translates the arithmetic operations. //! Translates the arithmetic operations.
use inkwell::values::BasicValue; use inkwell::values::BasicValue;
use revive_common::BIT_LENGTH_WORD;
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::WriteLLVM; use crate::polkavm::WriteLLVM;
/// Implements the division operator according to the EVM specification. /// Implements the division operator according to the EVM specification.
pub struct Division; pub struct Division;
impl<D> RuntimeFunction<D> for Division impl RuntimeFunction for Division {
where
D: Dependency + Clone,
{
const NAME: &'static str = "__revive_division"; const NAME: &'static str = "__revive_division";
fn r#type<'ctx>(context: &Context<'ctx, D>) -> inkwell::types::FunctionType<'ctx> { fn r#type<'ctx>(context: &Context<'ctx>) -> inkwell::types::FunctionType<'ctx> {
context.word_type().fn_type( context.word_type().fn_type(
&[context.word_type().into(), context.word_type().into()], &[context.word_type().into(), context.word_type().into()],
false, false,
@@ -25,7 +22,7 @@ where
fn emit_body<'ctx>( fn emit_body<'ctx>(
&self, &self,
context: &mut Context<'ctx, D>, context: &mut Context<'ctx>,
) -> anyhow::Result<Option<inkwell::values::BasicValueEnum<'ctx>>> { ) -> anyhow::Result<Option<inkwell::values::BasicValueEnum<'ctx>>> {
let operand_1 = Self::paramater(context, 0).into_int_value(); let operand_1 = Self::paramater(context, 0).into_int_value();
let operand_2 = Self::paramater(context, 1).into_int_value(); let operand_2 = Self::paramater(context, 1).into_int_value();
@@ -39,29 +36,23 @@ where
} }
} }
impl<D> WriteLLVM<D> for Division impl WriteLLVM for Division {
where fn declare(&mut self, context: &mut Context) -> anyhow::Result<()> {
D: Dependency + Clone, <Self as RuntimeFunction>::declare(self, context)
{
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<()> { fn into_llvm(self, context: &mut Context) -> anyhow::Result<()> {
<Self as RuntimeFunction<_>>::emit(&self, context) <Self as RuntimeFunction>::emit(&self, context)
} }
} }
/// Implements the signed division operator according to the EVM specification. /// Implements the signed division operator according to the EVM specification.
pub struct SignedDivision; pub struct SignedDivision;
impl<D> RuntimeFunction<D> for SignedDivision impl RuntimeFunction for SignedDivision {
where
D: Dependency + Clone,
{
const NAME: &'static str = "__revive_signed_division"; const NAME: &'static str = "__revive_signed_division";
fn r#type<'ctx>(context: &Context<'ctx, D>) -> inkwell::types::FunctionType<'ctx> { fn r#type<'ctx>(context: &Context<'ctx>) -> inkwell::types::FunctionType<'ctx> {
context.word_type().fn_type( context.word_type().fn_type(
&[context.word_type().into(), context.word_type().into()], &[context.word_type().into(), context.word_type().into()],
false, false,
@@ -70,7 +61,7 @@ where
fn emit_body<'ctx>( fn emit_body<'ctx>(
&self, &self,
context: &mut Context<'ctx, D>, context: &mut Context<'ctx>,
) -> anyhow::Result<Option<inkwell::values::BasicValueEnum<'ctx>>> { ) -> anyhow::Result<Option<inkwell::values::BasicValueEnum<'ctx>>> {
let operand_1 = Self::paramater(context, 0).into_int_value(); let operand_1 = Self::paramater(context, 0).into_int_value();
let operand_2 = Self::paramater(context, 1).into_int_value(); let operand_2 = Self::paramater(context, 1).into_int_value();
@@ -96,14 +87,12 @@ where
context.set_basic_block(block_overflow); context.set_basic_block(block_overflow);
let max_uint = context.builder().build_int_z_extend( let max_uint = context.builder().build_int_z_extend(
context context.integer_type(BIT_LENGTH_WORD - 1).const_all_ones(),
.integer_type(revive_common::BIT_LENGTH_WORD - 1)
.const_all_ones(),
context.word_type(), context.word_type(),
"max_uint", "max_uint",
)?; )?;
let is_operand_1_overflow = context.builder().build_int_compare( let is_operand_1_overflow = context.builder().build_int_compare(
inkwell::IntPredicate::EQ, inkwell::IntPredicate::SLT,
operand_1, operand_1,
context.builder().build_int_neg(max_uint, "min_uint")?, context.builder().build_int_neg(max_uint, "min_uint")?,
"is_operand_1_overflow", "is_operand_1_overflow",
@@ -121,29 +110,23 @@ where
} }
} }
impl<D> WriteLLVM<D> for SignedDivision impl WriteLLVM for SignedDivision {
where fn declare(&mut self, context: &mut Context) -> anyhow::Result<()> {
D: Dependency + Clone, <Self as RuntimeFunction>::declare(self, context)
{
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<()> { fn into_llvm(self, context: &mut Context) -> anyhow::Result<()> {
<Self as RuntimeFunction<_>>::emit(&self, context) <Self as RuntimeFunction>::emit(&self, context)
} }
} }
/// Implements the remainder operator according to the EVM specification. /// Implements the remainder operator according to the EVM specification.
pub struct Remainder; pub struct Remainder;
impl<D> RuntimeFunction<D> for Remainder impl RuntimeFunction for Remainder {
where
D: Dependency + Clone,
{
const NAME: &'static str = "__revive_remainder"; const NAME: &'static str = "__revive_remainder";
fn r#type<'ctx>(context: &Context<'ctx, D>) -> inkwell::types::FunctionType<'ctx> { fn r#type<'ctx>(context: &Context<'ctx>) -> inkwell::types::FunctionType<'ctx> {
context.word_type().fn_type( context.word_type().fn_type(
&[context.word_type().into(), context.word_type().into()], &[context.word_type().into(), context.word_type().into()],
false, false,
@@ -152,7 +135,7 @@ where
fn emit_body<'ctx>( fn emit_body<'ctx>(
&self, &self,
context: &mut Context<'ctx, D>, context: &mut Context<'ctx>,
) -> anyhow::Result<Option<inkwell::values::BasicValueEnum<'ctx>>> { ) -> anyhow::Result<Option<inkwell::values::BasicValueEnum<'ctx>>> {
let operand_1 = Self::paramater(context, 0).into_int_value(); let operand_1 = Self::paramater(context, 0).into_int_value();
let operand_2 = Self::paramater(context, 1).into_int_value(); let operand_2 = Self::paramater(context, 1).into_int_value();
@@ -166,29 +149,23 @@ where
} }
} }
impl<D> WriteLLVM<D> for Remainder impl WriteLLVM for Remainder {
where fn declare(&mut self, context: &mut Context) -> anyhow::Result<()> {
D: Dependency + Clone, <Self as RuntimeFunction>::declare(self, context)
{
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<()> { fn into_llvm(self, context: &mut Context) -> anyhow::Result<()> {
<Self as RuntimeFunction<_>>::emit(&self, context) <Self as RuntimeFunction>::emit(&self, context)
} }
} }
/// Implements the signed remainder operator according to the EVM specification. /// Implements the signed remainder operator according to the EVM specification.
pub struct SignedRemainder; pub struct SignedRemainder;
impl<D> RuntimeFunction<D> for SignedRemainder impl RuntimeFunction for SignedRemainder {
where
D: Dependency + Clone,
{
const NAME: &'static str = "__revive_signed_remainder"; const NAME: &'static str = "__revive_signed_remainder";
fn r#type<'ctx>(context: &Context<'ctx, D>) -> inkwell::types::FunctionType<'ctx> { fn r#type<'ctx>(context: &Context<'ctx>) -> inkwell::types::FunctionType<'ctx> {
context.word_type().fn_type( context.word_type().fn_type(
&[context.word_type().into(), context.word_type().into()], &[context.word_type().into(), context.word_type().into()],
false, false,
@@ -197,7 +174,7 @@ where
fn emit_body<'ctx>( fn emit_body<'ctx>(
&self, &self,
context: &mut Context<'ctx, D>, context: &mut Context<'ctx>,
) -> anyhow::Result<Option<inkwell::values::BasicValueEnum<'ctx>>> { ) -> anyhow::Result<Option<inkwell::values::BasicValueEnum<'ctx>>> {
let operand_1 = Self::paramater(context, 0).into_int_value(); let operand_1 = Self::paramater(context, 0).into_int_value();
let operand_2 = Self::paramater(context, 1).into_int_value(); let operand_2 = Self::paramater(context, 1).into_int_value();
@@ -211,16 +188,13 @@ where
} }
} }
impl<D> WriteLLVM<D> for SignedRemainder impl WriteLLVM for SignedRemainder {
where fn declare(&mut self, context: &mut Context) -> anyhow::Result<()> {
D: Dependency + Clone, <Self as RuntimeFunction>::declare(self, context)
{
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<()> { fn into_llvm(self, context: &mut Context) -> anyhow::Result<()> {
<Self as RuntimeFunction<_>>::emit(&self, context) <Self as RuntimeFunction>::emit(&self, context)
} }
} }
@@ -231,13 +205,12 @@ where
/// ///
/// The result is either the calculated quotient or zero, /// The result is either the calculated quotient or zero,
/// selected at runtime. /// selected at runtime.
fn wrapped_division<'ctx, D, F, T>( fn wrapped_division<'ctx, F, T>(
context: &Context<'ctx, D>, context: &Context<'ctx>,
denominator: inkwell::values::IntValue<'ctx>, denominator: inkwell::values::IntValue<'ctx>,
f: F, f: F,
) -> anyhow::Result<inkwell::values::BasicValueEnum<'ctx>> ) -> anyhow::Result<inkwell::values::BasicValueEnum<'ctx>>
where where
D: Dependency + Clone,
F: FnOnce() -> anyhow::Result<T>, F: FnOnce() -> anyhow::Result<T>,
T: inkwell::values::IntMathValue<'ctx>, T: inkwell::values::IntMathValue<'ctx>,
{ {
@@ -1,64 +1,52 @@
//! The deploy code function. //! The deploy code function.
use std::marker::PhantomData;
use crate::polkavm::context::code_type::CodeType;
use crate::polkavm::context::function::runtime; use crate::polkavm::context::function::runtime;
use crate::polkavm::context::Context; use crate::polkavm::context::Context;
use crate::polkavm::Dependency;
use crate::polkavm::WriteLLVM; use crate::polkavm::WriteLLVM;
/// The deploy code function. /// The deploy code function.
/// Is a special function that is only used by the front-end generated code. /// Is a special function that is only used by the front-end generated code.
#[derive(Debug)] #[derive(Debug)]
pub struct DeployCode<B, D> pub struct DeployCode<B>
where where
B: WriteLLVM<D>, B: WriteLLVM,
D: Dependency + Clone,
{ {
/// The deploy code AST representation. /// The deploy code AST representation.
inner: B, inner: B,
/// The `D` phantom data.
_pd: PhantomData<D>,
} }
impl<B, D> DeployCode<B, D> impl<B> DeployCode<B>
where where
B: WriteLLVM<D>, B: WriteLLVM,
D: Dependency + Clone,
{ {
/// A shortcut constructor. /// A shortcut constructor.
pub fn new(inner: B) -> Self { pub fn new(inner: B) -> Self {
Self { Self { inner }
inner,
_pd: PhantomData,
}
} }
} }
impl<B, D> WriteLLVM<D> for DeployCode<B, D> impl<B> WriteLLVM for DeployCode<B>
where where
B: WriteLLVM<D>, B: WriteLLVM,
D: Dependency + Clone,
{ {
fn declare(&mut self, context: &mut Context<D>) -> anyhow::Result<()> { fn declare(&mut self, context: &mut Context) -> anyhow::Result<()> {
let function_type = context.function_type::<inkwell::types::BasicTypeEnum>(vec![], 0); let function_type = context.function_type::<inkwell::types::BasicTypeEnum>(vec![], 0);
context.add_function( context.add_function(
runtime::FUNCTION_DEPLOY_CODE, runtime::FUNCTION_DEPLOY_CODE,
function_type, function_type,
0, 0,
Some(inkwell::module::Linkage::External), Some(inkwell::module::Linkage::Private),
None, None,
false,
)?; )?;
self.inner.declare(context) self.inner.declare(context)
} }
fn into_llvm(self, context: &mut Context<D>) -> anyhow::Result<()> { fn into_llvm(self, context: &mut Context) -> anyhow::Result<()> {
context.set_current_function(runtime::FUNCTION_DEPLOY_CODE, None)?; context.set_current_function(runtime::FUNCTION_DEPLOY_CODE, None, false)?;
context.set_basic_block(context.current_function().borrow().entry_block()); context.set_basic_block(context.current_function().borrow().entry_block());
context.set_code_type(CodeType::Deploy);
self.inner.into_llvm(context)?; self.inner.into_llvm(context)?;
context.set_debug_location(0, 0, None)?; context.set_debug_location(0, 0, None)?;
@@ -1,12 +1,16 @@
//! The entry function. //! The entry function.
use inkwell::types::BasicType; use inkwell::types::BasicType;
use revive_common::BIT_LENGTH_ETH_ADDRESS;
use revive_runtime_api::immutable_data::{
GLOBAL_IMMUTABLE_DATA_POINTER, GLOBAL_IMMUTABLE_DATA_SIZE,
};
use revive_runtime_api::polkavm_imports::CALL_DATA_SIZE;
use revive_solc_json_interface::PolkaVMDefaultHeapMemorySize; 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;
use crate::polkavm::context::Context; use crate::polkavm::context::Context;
use crate::polkavm::Dependency;
use crate::polkavm::WriteLLVM; use crate::polkavm::WriteLLVM;
/// The entry function. /// The entry function.
@@ -21,10 +25,7 @@ impl Entry {
/// Initializes the global variables. /// Initializes the global variables.
/// The pointers are not initialized, because it's not possible to create a null pointer. /// The pointers are not initialized, because it's not possible to create a null pointer.
pub fn initialize_globals<D>(context: &mut Context<D>) -> anyhow::Result<()> pub fn initialize_globals(context: &mut Context) -> anyhow::Result<()> {
where
D: Dependency + Clone,
{
context.set_global( context.set_global(
crate::polkavm::GLOBAL_CALLDATA_SIZE, crate::polkavm::GLOBAL_CALLDATA_SIZE,
context.xlen_type(), context.xlen_type(),
@@ -52,7 +53,7 @@ impl Entry {
heap_memory_type.const_zero(), heap_memory_type.const_zero(),
); );
let address_type = context.integer_type(revive_common::BIT_LENGTH_ETH_ADDRESS); let address_type = context.integer_type(BIT_LENGTH_ETH_ADDRESS);
context.set_global( context.set_global(
crate::polkavm::GLOBAL_ADDRESS_SPILL_BUFFER, crate::polkavm::GLOBAL_ADDRESS_SPILL_BUFFER,
address_type, address_type,
@@ -64,16 +65,13 @@ impl Entry {
} }
/// Populate the calldata size global value. /// Populate the calldata size global value.
pub fn load_calldata_size<D>(context: &mut Context<D>) -> anyhow::Result<()> pub fn load_calldata_size(context: &mut Context) -> anyhow::Result<()> {
where
D: Dependency + Clone,
{
let call_data_size_pointer = context let call_data_size_pointer = context
.get_global(crate::polkavm::GLOBAL_CALLDATA_SIZE)? .get_global(crate::polkavm::GLOBAL_CALLDATA_SIZE)?
.value .value
.as_pointer_value(); .as_pointer_value();
let call_data_size_value = context let call_data_size_value = context
.build_runtime_call(revive_runtime_api::polkavm_imports::CALL_DATA_SIZE, &[]) .build_runtime_call(CALL_DATA_SIZE, &[])
.expect("the call_data_size syscall method should return a value") .expect("the call_data_size syscall method should return a value")
.into_int_value(); .into_int_value();
let call_data_size_value = context.builder().build_int_truncate( let call_data_size_value = context.builder().build_int_truncate(
@@ -90,10 +88,7 @@ impl Entry {
/// Calls the deploy code if the first function argument was `1`. /// Calls the deploy code if the first function argument was `1`.
/// Calls the runtime code otherwise. /// Calls the runtime code otherwise.
pub fn leave_entry<D>(context: &mut Context<D>) -> anyhow::Result<()> pub fn leave_entry(context: &mut Context) -> anyhow::Result<()> {
where
D: Dependency + Clone,
{
context.set_debug_location(0, 0, None)?; context.set_debug_location(0, 0, None)?;
let is_deploy = context let is_deploy = context
@@ -133,11 +128,8 @@ impl Entry {
} }
} }
impl<D> WriteLLVM<D> for Entry impl WriteLLVM for Entry {
where fn declare(&mut self, context: &mut Context) -> anyhow::Result<()> {
D: Dependency + Clone,
{
fn declare(&mut self, context: &mut Context<D>) -> anyhow::Result<()> {
let entry_arguments = vec![context.bool_type().as_basic_type_enum()]; let entry_arguments = vec![context.bool_type().as_basic_type_enum()];
let entry_function_type = context.function_type(entry_arguments, 0); let entry_function_type = context.function_type(entry_arguments, 0);
context.add_function( context.add_function(
@@ -146,16 +138,17 @@ where
0, 0,
Some(inkwell::module::Linkage::External), Some(inkwell::module::Linkage::External),
None, None,
false,
)?; )?;
context.declare_global( context.declare_global(
revive_runtime_api::immutable_data::GLOBAL_IMMUTABLE_DATA_POINTER, GLOBAL_IMMUTABLE_DATA_POINTER,
context.word_type().array_type(0), context.word_type().array_type(0),
AddressSpace::Stack, AddressSpace::Stack,
); );
context.declare_global( context.declare_global(
revive_runtime_api::immutable_data::GLOBAL_IMMUTABLE_DATA_SIZE, GLOBAL_IMMUTABLE_DATA_SIZE,
context.xlen_type(), context.xlen_type(),
AddressSpace::Stack, AddressSpace::Stack,
); );
@@ -166,9 +159,9 @@ where
/// Instead of a single entrypoint, the runtime expects two exports: `call ` and `deploy`. /// Instead of a single entrypoint, the runtime expects two exports: `call ` and `deploy`.
/// `call` and `deploy` directly call `entry`, signaling a deploy if the first arg is `1`. /// `call` and `deploy` directly call `entry`, signaling a deploy if the first arg is `1`.
/// The `entry` function loads calldata, sets globals and calls the runtime or deploy code. /// The `entry` function loads calldata, sets globals and calls the runtime or deploy code.
fn into_llvm(self, context: &mut Context<D>) -> anyhow::Result<()> { fn into_llvm(self, context: &mut Context) -> anyhow::Result<()> {
let entry = context let entry = context
.get_function(runtime::FUNCTION_ENTRY) .get_function(runtime::FUNCTION_ENTRY, false)
.expect("the entry function should already be declared") .expect("the entry function should already be declared")
.borrow() .borrow()
.declaration; .declaration;
@@ -179,7 +172,7 @@ where
true, true,
); );
context.set_current_function(runtime::FUNCTION_ENTRY, None)?; context.set_current_function(runtime::FUNCTION_ENTRY, None, false)?;
context.set_basic_block(context.current_function().borrow().entry_block()); context.set_basic_block(context.current_function().borrow().entry_block());
Self::initialize_globals(context)?; Self::initialize_globals(context)?;
@@ -5,7 +5,6 @@ use inkwell::values::BasicValue;
use crate::polkavm::context::function::Attribute; use crate::polkavm::context::function::Attribute;
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::WriteLLVM; use crate::polkavm::WriteLLVM;
/// Pointers are represented as opaque 256 bit integer values in EVM. /// Pointers are represented as opaque 256 bit integer values in EVM.
@@ -15,10 +14,7 @@ use crate::polkavm::WriteLLVM;
/// (but wrong) pointers when truncated. /// (but wrong) pointers when truncated.
pub struct WordToPointer; pub struct WordToPointer;
impl<D> RuntimeFunction<D> for WordToPointer impl RuntimeFunction for WordToPointer {
where
D: Dependency + Clone,
{
const NAME: &'static str = "__revive_int_truncate"; const NAME: &'static str = "__revive_int_truncate";
const ATTRIBUTES: &'static [Attribute] = &[ const ATTRIBUTES: &'static [Attribute] = &[
@@ -27,7 +23,7 @@ where
Attribute::AlwaysInline, Attribute::AlwaysInline,
]; ];
fn r#type<'ctx>(context: &Context<'ctx, D>) -> inkwell::types::FunctionType<'ctx> { fn r#type<'ctx>(context: &Context<'ctx>) -> inkwell::types::FunctionType<'ctx> {
context context
.xlen_type() .xlen_type()
.fn_type(&[context.word_type().into()], false) .fn_type(&[context.word_type().into()], false)
@@ -35,7 +31,7 @@ where
fn emit_body<'ctx>( fn emit_body<'ctx>(
&self, &self,
context: &mut Context<'ctx, D>, context: &mut Context<'ctx>,
) -> anyhow::Result<Option<inkwell::values::BasicValueEnum<'ctx>>> { ) -> anyhow::Result<Option<inkwell::values::BasicValueEnum<'ctx>>> {
let value = Self::paramater(context, 0).into_int_value(); let value = Self::paramater(context, 0).into_int_value();
let truncated = let truncated =
@@ -67,26 +63,20 @@ where
} }
} }
impl<D> WriteLLVM<D> for WordToPointer impl WriteLLVM for WordToPointer {
where fn declare(&mut self, context: &mut Context) -> anyhow::Result<()> {
D: Dependency + Clone, <Self as RuntimeFunction>::declare(self, context)
{
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<()> { fn into_llvm(self, context: &mut Context) -> anyhow::Result<()> {
<Self as RuntimeFunction<_>>::emit(&self, context) <Self as RuntimeFunction>::emit(&self, context)
} }
} }
/// The revive runtime exit function. /// The revive runtime exit function.
pub struct Exit; pub struct Exit;
impl<D> RuntimeFunction<D> for Exit impl RuntimeFunction for Exit {
where
D: Dependency + Clone,
{
const NAME: &'static str = "__revive_exit"; const NAME: &'static str = "__revive_exit";
const ATTRIBUTES: &'static [Attribute] = &[ const ATTRIBUTES: &'static [Attribute] = &[
@@ -95,7 +85,7 @@ where
Attribute::AlwaysInline, Attribute::AlwaysInline,
]; ];
fn r#type<'ctx>(context: &Context<'ctx, D>) -> inkwell::types::FunctionType<'ctx> { fn r#type<'ctx>(context: &Context<'ctx>) -> inkwell::types::FunctionType<'ctx> {
context.void_type().fn_type( context.void_type().fn_type(
&[ &[
context.xlen_type().into(), context.xlen_type().into(),
@@ -108,7 +98,7 @@ where
fn emit_body<'ctx>( fn emit_body<'ctx>(
&self, &self,
context: &mut Context<'ctx, D>, context: &mut Context<'ctx>,
) -> anyhow::Result<Option<inkwell::values::BasicValueEnum<'ctx>>> { ) -> anyhow::Result<Option<inkwell::values::BasicValueEnum<'ctx>>> {
let flags = Self::paramater(context, 0).into_int_value(); let flags = Self::paramater(context, 0).into_int_value();
let offset = Self::paramater(context, 1).into_int_value(); let offset = Self::paramater(context, 1).into_int_value();
@@ -133,15 +123,12 @@ where
} }
} }
impl<D> WriteLLVM<D> for Exit impl WriteLLVM for Exit {
where fn declare(&mut self, context: &mut Context) -> anyhow::Result<()> {
D: Dependency + Clone, <Self as RuntimeFunction>::declare(self, context)
{
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<()> { fn into_llvm(self, context: &mut Context) -> anyhow::Result<()> {
<Self as RuntimeFunction<_>>::emit(&self, context) <Self as RuntimeFunction>::emit(&self, context)
} }
} }
@@ -1,64 +1,52 @@
//! The runtime code function. //! The runtime code function.
use std::marker::PhantomData;
use crate::polkavm::context::code_type::CodeType;
use crate::polkavm::context::function::runtime; use crate::polkavm::context::function::runtime;
use crate::polkavm::context::Context; use crate::polkavm::context::Context;
use crate::polkavm::Dependency;
use crate::polkavm::WriteLLVM; use crate::polkavm::WriteLLVM;
/// The runtime code function. /// The runtime code function.
/// Is a special function that is only used by the front-end generated code. /// Is a special function that is only used by the front-end generated code.
#[derive(Debug)] #[derive(Debug)]
pub struct RuntimeCode<B, D> pub struct RuntimeCode<B>
where where
B: WriteLLVM<D>, B: WriteLLVM,
D: Dependency + Clone,
{ {
/// The runtime code AST representation. /// The runtime code AST representation.
inner: B, inner: B,
/// The `D` phantom data.
_pd: PhantomData<D>,
} }
impl<B, D> RuntimeCode<B, D> impl<B> RuntimeCode<B>
where where
B: WriteLLVM<D>, B: WriteLLVM,
D: Dependency + Clone,
{ {
/// A shortcut constructor. /// A shortcut constructor.
pub fn new(inner: B) -> Self { pub fn new(inner: B) -> Self {
Self { Self { inner }
inner,
_pd: PhantomData,
}
} }
} }
impl<B, D> WriteLLVM<D> for RuntimeCode<B, D> impl<B> WriteLLVM for RuntimeCode<B>
where where
B: WriteLLVM<D>, B: WriteLLVM,
D: Dependency + Clone,
{ {
fn declare(&mut self, context: &mut Context<D>) -> anyhow::Result<()> { fn declare(&mut self, context: &mut Context) -> anyhow::Result<()> {
let function_type = context.function_type::<inkwell::types::BasicTypeEnum>(vec![], 0); let function_type = context.function_type::<inkwell::types::BasicTypeEnum>(vec![], 0);
context.add_function( context.add_function(
runtime::FUNCTION_RUNTIME_CODE, runtime::FUNCTION_RUNTIME_CODE,
function_type, function_type,
0, 0,
Some(inkwell::module::Linkage::External), Some(inkwell::module::Linkage::Private),
None, None,
false,
)?; )?;
self.inner.declare(context) self.inner.declare(context)
} }
fn into_llvm(self, context: &mut Context<D>) -> anyhow::Result<()> { fn into_llvm(self, context: &mut Context) -> anyhow::Result<()> {
context.set_current_function(runtime::FUNCTION_RUNTIME_CODE, None)?; context.set_current_function(runtime::FUNCTION_RUNTIME_CODE, None, false)?;
context.set_basic_block(context.current_function().borrow().entry_block()); context.set_basic_block(context.current_function().borrow().entry_block());
context.set_code_type(CodeType::Runtime);
self.inner.into_llvm(context)?; self.inner.into_llvm(context)?;
context.set_debug_location(0, 0, None)?; context.set_debug_location(0, 0, None)?;
@@ -1,11 +1,11 @@
//! Emulates the linear EVM heap memory via a simulated `sbrk` system call. //! Emulates the linear EVM heap memory via a simulated `sbrk` system call.
use inkwell::values::BasicValue; use inkwell::values::BasicValue;
use revive_common::BYTE_LENGTH_WORD;
use crate::polkavm::context::attribute::Attribute; use crate::polkavm::context::attribute::Attribute;
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::WriteLLVM; use crate::polkavm::WriteLLVM;
/// Simulates the `sbrk` system call, reproducing the semantics of the EVM heap memory. /// Simulates the `sbrk` system call, reproducing the semantics of the EVM heap memory.
@@ -24,10 +24,7 @@ use crate::polkavm::WriteLLVM;
/// - Maintains the total memory size (`msize`) in global heap size value. /// - Maintains the total memory size (`msize`) in global heap size value.
pub struct Sbrk; pub struct Sbrk;
impl<D> RuntimeFunction<D> for Sbrk impl RuntimeFunction for Sbrk {
where
D: Dependency + Clone,
{
const NAME: &'static str = "__sbrk_internal"; const NAME: &'static str = "__sbrk_internal";
const ATTRIBUTES: &'static [Attribute] = &[ const ATTRIBUTES: &'static [Attribute] = &[
@@ -36,7 +33,7 @@ where
Attribute::WillReturn, Attribute::WillReturn,
]; ];
fn r#type<'ctx>(context: &Context<'ctx, D>) -> inkwell::types::FunctionType<'ctx> { fn r#type<'ctx>(context: &Context<'ctx>) -> inkwell::types::FunctionType<'ctx> {
context.llvm().ptr_type(Default::default()).fn_type( context.llvm().ptr_type(Default::default()).fn_type(
&[context.xlen_type().into(), context.xlen_type().into()], &[context.xlen_type().into(), context.xlen_type().into()],
false, false,
@@ -45,11 +42,22 @@ where
fn emit_body<'ctx>( fn emit_body<'ctx>(
&self, &self,
context: &mut Context<'ctx, D>, context: &mut Context<'ctx>,
) -> anyhow::Result<Option<inkwell::values::BasicValueEnum<'ctx>>> { ) -> anyhow::Result<Option<inkwell::values::BasicValueEnum<'ctx>>> {
let offset = Self::paramater(context, 0).into_int_value(); let offset = Self::paramater(context, 0).into_int_value();
let size = Self::paramater(context, 1).into_int_value(); let size = Self::paramater(context, 1).into_int_value();
let return_block = context.append_basic_block("return_pointer");
let body_block = context.append_basic_block("body");
let is_size_zero = context.builder().build_int_compare(
inkwell::IntPredicate::EQ,
size,
context.xlen_type().const_zero(),
"is_size_zero",
)?;
context.build_conditional_branch(is_size_zero, return_block, body_block)?;
context.set_basic_block(body_block);
let trap_block = context.append_basic_block("trap"); let trap_block = context.append_basic_block("trap");
let offset_in_bounds_block = context.append_basic_block("offset_in_bounds"); let offset_in_bounds_block = context.append_basic_block("offset_in_bounds");
let is_offset_out_of_bounds = context.builder().build_int_compare( let is_offset_out_of_bounds = context.builder().build_int_compare(
@@ -71,7 +79,7 @@ where
context.set_basic_block(offset_in_bounds_block); context.set_basic_block(offset_in_bounds_block);
let mask = context let mask = context
.xlen_type() .xlen_type()
.const_int(revive_common::BYTE_LENGTH_WORD as u64 - 1, false); .const_int(BYTE_LENGTH_WORD as u64 - 1, false);
let total_size = context let total_size = context
.builder() .builder()
.build_int_add(offset, size, "total_size")?; .build_int_add(offset, size, "total_size")?;
@@ -94,7 +102,6 @@ where
)?; )?;
context.set_basic_block(size_in_bounds_block); context.set_basic_block(size_in_bounds_block);
let return_block = context.append_basic_block("return_pointer");
let new_size_block = context.append_basic_block("new_size"); let new_size_block = context.append_basic_block("new_size");
let is_new_size = context.builder().build_int_compare( let is_new_size = context.builder().build_int_compare(
inkwell::IntPredicate::UGT, inkwell::IntPredicate::UGT,
@@ -130,15 +137,12 @@ where
} }
} }
impl<D> WriteLLVM<D> for Sbrk impl WriteLLVM for Sbrk {
where fn declare(&mut self, context: &mut Context) -> anyhow::Result<()> {
D: Dependency + Clone, <Self as RuntimeFunction>::declare(self, context)
{
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<()> { fn into_llvm(self, context: &mut Context) -> anyhow::Result<()> {
<Self as RuntimeFunction<_>>::emit(&self, context) <Self as RuntimeFunction>::emit(&self, context)
} }
} }
@@ -5,7 +5,6 @@ use inkwell::values::BasicValue;
use crate::polkavm::context::address_space::AddressSpace; use crate::polkavm::context::address_space::AddressSpace;
use crate::polkavm::context::Context; use crate::polkavm::context::Context;
use crate::PolkaVMDependency;
/// The LLVM global value. /// The LLVM global value.
#[derive(Debug, Clone, Copy)] #[derive(Debug, Clone, Copy)]
@@ -18,15 +17,14 @@ pub struct Global<'ctx> {
impl<'ctx> Global<'ctx> { impl<'ctx> Global<'ctx> {
/// A shortcut constructor. /// A shortcut constructor.
pub fn new<D, T, V>( pub fn new<T, V>(
context: &mut Context<'ctx, D>, context: &mut Context<'ctx>,
r#type: T, r#type: T,
address_space: AddressSpace, address_space: AddressSpace,
initializer: V, initializer: V,
name: &str, name: &str,
) -> Self ) -> Self
where where
D: PolkaVMDependency + Clone,
T: BasicType<'ctx>, T: BasicType<'ctx>,
V: BasicValue<'ctx>, V: BasicValue<'ctx>,
{ {
@@ -53,14 +51,13 @@ impl<'ctx> Global<'ctx> {
} }
/// Construct an external global. /// Construct an external global.
pub fn declare<D, T>( pub fn declare<T>(
context: &mut Context<'ctx, D>, context: &mut Context<'ctx>,
r#type: T, r#type: T,
address_space: AddressSpace, address_space: AddressSpace,
name: &str, name: &str,
) -> Self ) -> Self
where where
D: PolkaVMDependency + Clone,
T: BasicType<'ctx>, T: BasicType<'ctx>,
{ {
let r#type = r#type.as_basic_type_enum(); let r#type = r#type.as_basic_type_enum();
+121 -152
View File
@@ -1,22 +1,5 @@
//! The LLVM IR generator context. //! The LLVM IR generator context.
pub mod address_space;
pub mod argument;
pub mod attribute;
pub mod build;
pub mod code_type;
pub mod debug_info;
pub mod function;
pub mod global;
pub mod r#loop;
pub mod pointer;
pub mod runtime;
pub mod solidity_data;
pub mod yul_data;
#[cfg(test)]
mod tests;
use std::cell::RefCell; use std::cell::RefCell;
use std::collections::HashMap; use std::collections::HashMap;
use std::rc::Rc; use std::rc::Rc;
@@ -25,6 +8,7 @@ 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 inkwell::values::InstructionOpcode;
use revive_solc_json_interface::PolkaVMDefaultHeapMemorySize; use revive_solc_json_interface::PolkaVMDefaultHeapMemorySize;
use revive_solc_json_interface::PolkaVMDefaultStackMemorySize; use revive_solc_json_interface::PolkaVMDefaultStackMemorySize;
use revive_solc_json_interface::SolcStandardJsonInputSettingsPolkaVMMemory; use revive_solc_json_interface::SolcStandardJsonInputSettingsPolkaVMMemory;
@@ -32,7 +16,6 @@ use revive_solc_json_interface::SolcStandardJsonInputSettingsPolkaVMMemory;
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;
use crate::polkavm::Dependency;
use crate::target_machine::target::Target; use crate::target_machine::target::Target;
use crate::target_machine::TargetMachine; use crate::target_machine::TargetMachine;
use crate::PolkaVMLoadHeapWordFunction; use crate::PolkaVMLoadHeapWordFunction;
@@ -58,13 +41,27 @@ use self::runtime::RuntimeFunction;
use self::solidity_data::SolidityData; use self::solidity_data::SolidityData;
use self::yul_data::YulData; use self::yul_data::YulData;
pub mod address_space;
pub mod argument;
pub mod attribute;
pub mod build;
pub mod code_type;
pub mod debug_info;
pub mod function;
pub mod global;
pub mod r#loop;
pub mod pointer;
pub mod runtime;
pub mod solidity_data;
pub mod yul_data;
#[cfg(test)]
mod tests;
/// The LLVM IR generator context. /// The LLVM IR generator context.
/// It is a not-so-big god-like object glueing all the compilers' complexity and act as an adapter /// It is a not-so-big god-like object glueing all the compilers' complexity and act as an adapter
/// and a superstructure over the inner `inkwell` LLVM context. /// and a superstructure over the inner `inkwell` LLVM context.
pub struct Context<'ctx, D> pub struct Context<'ctx> {
where
D: Dependency + Clone,
{
/// The inner LLVM context. /// The inner LLVM context.
llvm: &'ctx inkwell::context::Context, llvm: &'ctx inkwell::context::Context,
/// The inner LLVM context builder. /// The inner LLVM context builder.
@@ -87,17 +84,9 @@ where
current_function: Option<Rc<RefCell<Function<'ctx>>>>, current_function: Option<Rc<RefCell<Function<'ctx>>>>,
/// The loop context stack. /// The loop context stack.
loop_stack: Vec<Loop<'ctx>>, loop_stack: Vec<Loop<'ctx>>,
/// The extra LLVM arguments that were used during target initialization.
llvm_arguments: &'ctx [String],
/// The PVM memory configuration. /// The PVM memory configuration.
memory_config: SolcStandardJsonInputSettingsPolkaVMMemory, memory_config: SolcStandardJsonInputSettingsPolkaVMMemory,
/// 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 multi-threaded compilation process.
dependency_manager: Option<D>,
/// Whether to append the metadata hash at the end of bytecode.
include_metadata_hash: bool,
/// The debug info of the current module. /// The debug info of the current module.
debug_info: Option<DebugInfo<'ctx>>, debug_info: Option<DebugInfo<'ctx>>,
/// The debug configuration telling whether to dump the needed IRs. /// The debug configuration telling whether to dump the needed IRs.
@@ -109,10 +98,7 @@ where
yul_data: Option<YulData>, yul_data: Option<YulData>,
} }
impl<'ctx, D> Context<'ctx, D> impl<'ctx> Context<'ctx> {
where
D: Dependency + Clone,
{
/// The functions hashmap default capacity. /// The functions hashmap default capacity.
const FUNCTIONS_HASHMAP_INITIAL_CAPACITY: usize = 64; const FUNCTIONS_HASHMAP_INITIAL_CAPACITY: usize = 64;
@@ -221,15 +207,11 @@ where
} }
/// Initializes a new LLVM context. /// Initializes a new LLVM context.
#[allow(clippy::too_many_arguments)]
pub fn new( pub fn new(
llvm: &'ctx inkwell::context::Context, llvm: &'ctx inkwell::context::Context,
module: inkwell::module::Module<'ctx>, module: inkwell::module::Module<'ctx>,
optimizer: Optimizer, optimizer: Optimizer,
dependency_manager: Option<D>,
include_metadata_hash: bool,
debug_config: DebugConfig, debug_config: DebugConfig,
llvm_arguments: &'ctx [String],
memory_config: SolcStandardJsonInputSettingsPolkaVMMemory, memory_config: SolcStandardJsonInputSettingsPolkaVMMemory,
) -> Self { ) -> Self {
Self::set_data_layout(llvm, &module); Self::set_data_layout(llvm, &module);
@@ -264,12 +246,8 @@ where
functions: HashMap::with_capacity(Self::FUNCTIONS_HASHMAP_INITIAL_CAPACITY), functions: HashMap::with_capacity(Self::FUNCTIONS_HASHMAP_INITIAL_CAPACITY),
current_function: None, current_function: None,
loop_stack: Vec::with_capacity(Self::LOOP_STACK_INITIAL_CAPACITY), loop_stack: Vec::with_capacity(Self::LOOP_STACK_INITIAL_CAPACITY),
llvm_arguments,
memory_config, memory_config,
dependency_manager,
include_metadata_hash,
debug_info, debug_info,
debug_config, debug_config,
@@ -280,12 +258,10 @@ where
/// Builds the LLVM IR module, returning the build artifacts. /// Builds the LLVM IR module, returning the build artifacts.
pub fn build( pub fn build(
mut self, self,
contract_path: &str, contract_path: &str,
metadata_hash: Option<[u8; revive_common::BYTE_LENGTH_WORD]>, metadata_hash: Option<revive_common::Keccak256>,
) -> anyhow::Result<Build> { ) -> anyhow::Result<Build> {
let module_clone = self.module.clone();
self.link_polkavm_exports(contract_path)?; self.link_polkavm_exports(contract_path)?;
self.link_immutable_data(contract_path)?; self.link_immutable_data(contract_path)?;
@@ -313,6 +289,17 @@ where
) )
})?; })?;
// Remove MinSize on functions that perform large integer div/rem to
// avoid compiler crash that happens when large integer div/rem by
// power-of-2 are not being expanded by ExpandLargeIntDivRem pass as
// it expects peephole from DAGCombine, which doesn't happen due to the
// MinSize attribute being set on the function.
// NOTE: As soon as it strips attribute from a function where large
// integer div/rem is used, it's crucial to call it after inlining.
// TODO: Remove this once LLVM fix is backported to LLVM 21 and we
// switch to corresponding inkwell version.
self.strip_minsize_for_divrem();
self.debug_config self.debug_config
.dump_llvm_ir_optimized(contract_path, self.module())?; .dump_llvm_ir_optimized(contract_path, self.module())?;
@@ -334,33 +321,16 @@ where
) )
})?; })?;
let shared_object = revive_linker::link(buffer.as_slice())?; let object = buffer.as_slice().to_vec();
self.debug_config self.debug_config.dump_object(contract_path, &object)?;
.dump_object(contract_path, &shared_object)?;
let polkavm_bytecode = crate::polkavm::build(
revive_linker::polkavm_linker(shared_object, !self.debug_config().emit_debug_info)?; &object,
metadata_hash
let build = match crate::polkavm::build_assembly_text( .as_ref()
contract_path, .map(|hash| hash.as_bytes().try_into().unwrap()),
&polkavm_bytecode, )
metadata_hash,
self.debug_config(),
) {
Ok(build) => build,
Err(_error)
if self.optimizer.settings() != &OptimizerSettings::size()
&& self.optimizer.settings().is_fallback_to_size_enabled() =>
{
self.optimizer = Optimizer::new(OptimizerSettings::size());
self.module = module_clone;
self.build(contract_path, metadata_hash)?
}
Err(error) => Err(error)?,
};
Ok(build)
} }
/// Verifies the current LLVM IR module. /// Verifies the current LLVM IR module.
@@ -437,11 +407,15 @@ where
} }
} }
/// Declare an external global. /// Declare an external global. This is an idempotent method.
pub fn declare_global<T>(&mut self, name: &str, r#type: T, address_space: AddressSpace) pub fn declare_global<T>(&mut self, name: &str, r#type: T, address_space: AddressSpace)
where where
T: BasicType<'ctx> + Clone + Copy, T: BasicType<'ctx> + Clone + Copy,
{ {
if self.globals.contains_key(name) {
return;
}
let global = Global::declare(self, r#type, address_space, name); let global = Global::declare(self, r#type, address_space, name);
self.globals.insert(name.to_owned(), global); self.globals.insert(name.to_owned(), global);
} }
@@ -464,8 +438,15 @@ where
return_values_length: usize, return_values_length: usize,
linkage: Option<inkwell::module::Linkage>, linkage: Option<inkwell::module::Linkage>,
location: Option<(u32, u32)>, location: Option<(u32, u32)>,
is_frontend: bool,
) -> anyhow::Result<Rc<RefCell<Function<'ctx>>>> { ) -> anyhow::Result<Rc<RefCell<Function<'ctx>>>> {
let value = self.module().add_function(name, r#type, linkage); assert!(
self.get_function(name, is_frontend).is_none(),
"ICE: function '{name}' declared subsequentally"
);
let name = self.internal_function_name(name, is_frontend);
let value = self.module().add_function(&name, r#type, linkage);
if self.debug_info().is_some() { if self.debug_info().is_some() {
self.builder().unset_current_debug_location(); self.builder().unset_current_debug_location();
@@ -506,7 +487,7 @@ where
}; };
let function = Function::new( let function = Function::new(
name.to_owned(), name.clone(),
FunctionDeclaration::new(r#type, value), FunctionDeclaration::new(r#type, value),
r#return, r#return,
entry_block, entry_block,
@@ -514,7 +495,7 @@ where
); );
Function::set_default_attributes(self.llvm, function.declaration(), &self.optimizer); Function::set_default_attributes(self.llvm, function.declaration(), &self.optimizer);
let function = Rc::new(RefCell::new(function)); let function = Rc::new(RefCell::new(function));
self.functions.insert(name.to_string(), function.clone()); self.functions.insert(name, function.clone());
self.pop_debug_scope(); self.pop_debug_scope();
@@ -522,8 +503,14 @@ where
} }
/// Returns a shared reference to the specified function. /// Returns a shared reference to the specified function.
pub fn get_function(&self, name: &str) -> Option<Rc<RefCell<Function<'ctx>>>> { pub fn get_function(
self.functions.get(name).cloned() &self,
name: &str,
is_frontend: bool,
) -> Option<Rc<RefCell<Function<'ctx>>>> {
self.functions
.get(&self.internal_function_name(name, is_frontend))
.cloned()
} }
/// Returns a shared reference to the current active function. /// Returns a shared reference to the current active function.
@@ -539,8 +526,9 @@ where
&mut self, &mut self,
name: &str, name: &str,
location: Option<(u32, u32)>, location: Option<(u32, u32)>,
frontend: bool,
) -> anyhow::Result<()> { ) -> anyhow::Result<()> {
let function = self.functions.get(name).cloned().ok_or_else(|| { let function = self.get_function(name, frontend).ok_or_else(|| {
anyhow::anyhow!("Failed to activate an undeclared function `{}`", name) anyhow::anyhow!("Failed to activate an undeclared function `{}`", name)
})?; })?;
self.current_function = Some(function); self.current_function = Some(function);
@@ -650,54 +638,6 @@ where
.expect("The current context is not in a loop") .expect("The current context is not in a loop")
} }
/// Compiles a contract dependency, if the dependency manager is set.
pub fn compile_dependency(&mut self, name: &str) -> anyhow::Result<String> {
self.dependency_manager
.to_owned()
.ok_or_else(|| anyhow::anyhow!("The dependency manager is unset"))
.and_then(|manager| {
Dependency::compile(
manager,
name,
self.optimizer.settings().to_owned(),
self.include_metadata_hash,
self.debug_config.clone(),
self.llvm_arguments,
self.memory_config,
)
})
}
/// Gets a full contract_path from the dependency manager.
pub fn resolve_path(&self, identifier: &str) -> anyhow::Result<String> {
self.dependency_manager
.to_owned()
.ok_or_else(|| anyhow::anyhow!("The dependency manager is unset"))
.and_then(|manager| {
let full_path = manager.resolve_path(identifier)?;
Ok(full_path)
})
}
/// Gets a deployed library address from the dependency manager.
pub fn resolve_library(&self, path: &str) -> anyhow::Result<inkwell::values::IntValue<'ctx>> {
self.dependency_manager
.to_owned()
.ok_or_else(|| anyhow::anyhow!("The dependency manager is unset"))
.and_then(|manager| {
let address = manager.resolve_library(path)?;
let address = self.word_const_str_hex(address.as_str());
Ok(address)
})
}
/// Extracts the dependency manager.
pub fn take_dependency_manager(&mut self) -> D {
self.dependency_manager
.take()
.expect("The dependency manager is unset")
}
/// Returns the debug info. /// Returns the debug info.
pub fn debug_info(&self) -> Option<&DebugInfo<'ctx>> { pub fn debug_info(&self) -> Option<&DebugInfo<'ctx>> {
self.debug_info.as_ref() self.debug_info.as_ref()
@@ -750,7 +690,7 @@ where
} }
/// Builds an aligned stack allocation at the current position. /// Builds an aligned stack allocation at the current position.
/// Use this if [`build_alloca_at_entry`] might change program semantics. /// Use this if [`Self::build_alloca_at_entry`] might change program semantics.
/// Otherwise, alloca should always be built at the function prelude! /// Otherwise, alloca should always be built at the function prelude!
pub fn build_alloca<T: BasicType<'ctx> + Clone + Copy>( pub fn build_alloca<T: BasicType<'ctx> + Clone + Copy>(
&self, &self,
@@ -808,9 +748,9 @@ where
) -> anyhow::Result<inkwell::values::BasicValueEnum<'ctx>> { ) -> anyhow::Result<inkwell::values::BasicValueEnum<'ctx>> {
match pointer.address_space { match pointer.address_space {
AddressSpace::Heap => { AddressSpace::Heap => {
let name = <PolkaVMLoadHeapWordFunction as RuntimeFunction<D>>::NAME; let name = <PolkaVMLoadHeapWordFunction as RuntimeFunction>::NAME;
let declaration = let declaration =
<PolkaVMLoadHeapWordFunction as RuntimeFunction<D>>::declaration(self); <PolkaVMLoadHeapWordFunction as RuntimeFunction>::declaration(self);
let arguments = [self let arguments = [self
.builder() .builder()
.build_ptr_to_int(pointer.value, self.xlen_type(), "offset_ptrtoint")? .build_ptr_to_int(pointer.value, self.xlen_type(), "offset_ptrtoint")?
@@ -846,7 +786,7 @@ where
match pointer.address_space { match pointer.address_space {
AddressSpace::Heap => { AddressSpace::Heap => {
let declaration = let declaration =
<PolkaVMStoreHeapWordFunction as RuntimeFunction<D>>::declaration(self); <PolkaVMStoreHeapWordFunction as RuntimeFunction>::declaration(self);
let arguments = [ let arguments = [
pointer.to_int(self).as_basic_value_enum(), pointer.to_int(self).as_basic_value_enum(),
value.as_basic_value_enum(), value.as_basic_value_enum(),
@@ -966,10 +906,7 @@ where
pub fn build_runtime_call_to_getter( pub fn build_runtime_call_to_getter(
&self, &self,
import: &'static str, import: &'static str,
) -> anyhow::Result<inkwell::values::BasicValueEnum<'ctx>> ) -> anyhow::Result<inkwell::values::BasicValueEnum<'ctx>> {
where
D: Dependency + Clone,
{
let pointer = self.build_alloca_at_entry(self.word_type(), &format!("{import}_output")); let pointer = self.build_alloca_at_entry(self.word_type(), &format!("{import}_output"));
self.build_runtime_call(import, &[pointer.to_int(self).into()]); self.build_runtime_call(import, &[pointer.to_int(self).into()]);
self.build_load(pointer, import) self.build_load(pointer, import)
@@ -1064,7 +1001,7 @@ where
length: inkwell::values::IntValue<'ctx>, length: inkwell::values::IntValue<'ctx>,
) -> anyhow::Result<()> { ) -> anyhow::Result<()> {
self.build_call( self.build_call(
<Exit as RuntimeFunction<D>>::declaration(self), <Exit as RuntimeFunction>::declaration(self),
&[flags.into(), offset.into(), length.into()], &[flags.into(), offset.into(), length.into()],
"exit", "exit",
); );
@@ -1088,14 +1025,14 @@ where
Ok(self Ok(self
.build_call( .build_call(
<WordToPointer as RuntimeFunction<D>>::declaration(self), <WordToPointer as RuntimeFunction>::declaration(self),
&[value.into()], &[value.into()],
"word_to_pointer", "word_to_pointer",
) )
.unwrap_or_else(|| { .unwrap_or_else(|| {
panic!( panic!(
"revive runtime function {} should return a value", "revive runtime function {} should return a value",
<WordToPointer as RuntimeFunction<D>>::NAME, <WordToPointer as RuntimeFunction>::NAME,
) )
}) })
.into_int_value()) .into_int_value())
@@ -1111,7 +1048,7 @@ where
size: inkwell::values::IntValue<'ctx>, size: inkwell::values::IntValue<'ctx>,
) -> anyhow::Result<inkwell::values::PointerValue<'ctx>> { ) -> anyhow::Result<inkwell::values::PointerValue<'ctx>> {
let call_site_value = self.builder().build_call( let call_site_value = self.builder().build_call(
<PolkaVMSbrkFunction as RuntimeFunction<D>>::declaration(self).function_value(), <PolkaVMSbrkFunction as RuntimeFunction>::declaration(self).function_value(),
&[offset.into(), size.into()], &[offset.into(), size.into()],
"alloc_start", "alloc_start",
)?; )?;
@@ -1133,7 +1070,7 @@ where
.unwrap_or_else(|| { .unwrap_or_else(|| {
panic!( panic!(
"revive runtime function {} should return a value", "revive runtime function {} should return a value",
<PolkaVMSbrkFunction as RuntimeFunction<D>>::NAME, <PolkaVMSbrkFunction as RuntimeFunction>::NAME,
) )
}) })
.into_pointer_value()) .into_pointer_value())
@@ -1433,19 +1370,8 @@ where
/// Returns the Yul data reference. /// Returns the Yul data reference.
/// # Panics /// # Panics
/// If the Yul data has not been initialized. /// If the Yul data has not been initialized.
pub fn yul(&self) -> &YulData { pub fn yul(&self) -> Option<&YulData> {
self.yul_data self.yul_data.as_ref()
.as_ref()
.expect("The Yul data must have been initialized")
}
/// Returns the Yul data mutable reference.
/// # Panics
/// If the Yul data has not been initialized.
pub fn yul_mut(&mut self) -> &mut YulData {
self.yul_data
.as_mut()
.expect("The Yul data must have been initialized")
} }
/// Returns the current number of immutables values in the contract. /// Returns the current number of immutables values in the contract.
@@ -1471,4 +1397,47 @@ where
false, false,
) )
} }
/// Returns the internal function name.
fn internal_function_name(&self, name: &str, is_frontend: bool) -> String {
if is_frontend {
format!("{name}_{}", self.code_type().unwrap())
} else {
name.to_string()
}
}
/// Scans all functions in the module and removes the `MinSize` attribute
/// if the function contains any large sdiv, udiv, srem, urem instructions with either unknown
/// NOTE: The check here could be relaxed by checking denominator: if the denominator is
/// unknown or is a power-of-2 constant, then need to strip the `minsize` attribute; otherwise
/// instruction can be ignored as backend will expand it correctly.
fn strip_minsize_for_divrem(&self) {
self.module().get_functions().for_each(|func| {
let has_divrem = func.get_basic_block_iter().any(|b| {
b.get_instructions().any(|inst| match inst.get_opcode() {
InstructionOpcode::SDiv
| InstructionOpcode::UDiv
| InstructionOpcode::SRem
| InstructionOpcode::URem => {
inst.get_type().into_int_type().get_bit_width() >= 256
}
_ => false,
})
});
if has_divrem
&& func
.get_enum_attribute(
inkwell::attributes::AttributeLoc::Function,
Attribute::MinSize as u32,
)
.is_some()
{
func.remove_enum_attribute(
inkwell::attributes::AttributeLoc::Function,
Attribute::MinSize as u32,
);
}
});
}
} }
@@ -2,21 +2,20 @@
use inkwell::values::BasicValueEnum; use inkwell::values::BasicValueEnum;
use revive_common::BYTE_LENGTH_BYTE;
use revive_common::BYTE_LENGTH_WORD;
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::WriteLLVM; use crate::polkavm::WriteLLVM;
/// Load a word size value from a heap pointer. /// Load a word size value from a heap pointer.
pub struct LoadWord; pub struct LoadWord;
impl<D> RuntimeFunction<D> for LoadWord impl RuntimeFunction for LoadWord {
where
D: Dependency + Clone,
{
const NAME: &'static str = "__revive_load_heap_word"; const NAME: &'static str = "__revive_load_heap_word";
fn r#type<'ctx>(context: &Context<'ctx, D>) -> inkwell::types::FunctionType<'ctx> { fn r#type<'ctx>(context: &Context<'ctx>) -> inkwell::types::FunctionType<'ctx> {
context context
.word_type() .word_type()
.fn_type(&[context.xlen_type().into()], false) .fn_type(&[context.xlen_type().into()], false)
@@ -24,12 +23,12 @@ where
fn emit_body<'ctx>( fn emit_body<'ctx>(
&self, &self,
context: &mut Context<'ctx, D>, context: &mut Context<'ctx>,
) -> anyhow::Result<Option<BasicValueEnum<'ctx>>> { ) -> anyhow::Result<Option<BasicValueEnum<'ctx>>> {
let offset = Self::paramater(context, 0).into_int_value(); let offset = Self::paramater(context, 0).into_int_value();
let length = context let length = context
.xlen_type() .xlen_type()
.const_int(revive_common::BYTE_LENGTH_WORD as u64, false); .const_int(BYTE_LENGTH_WORD as u64, false);
let pointer = context.build_heap_gep(offset, length)?; let pointer = context.build_heap_gep(offset, length)?;
let value = context let value = context
.builder() .builder()
@@ -38,7 +37,7 @@ where
.basic_block() .basic_block()
.get_last_instruction() .get_last_instruction()
.expect("Always exists") .expect("Always exists")
.set_alignment(revive_common::BYTE_LENGTH_BYTE as u32) .set_alignment(BYTE_LENGTH_BYTE as u32)
.expect("Alignment is valid"); .expect("Alignment is valid");
let swapped_value = context.build_byte_swap(value)?; let swapped_value = context.build_byte_swap(value)?;
@@ -46,29 +45,23 @@ where
} }
} }
impl<D> WriteLLVM<D> for LoadWord impl WriteLLVM for LoadWord {
where fn declare(&mut self, context: &mut Context) -> anyhow::Result<()> {
D: Dependency + Clone, <Self as RuntimeFunction>::declare(self, context)
{
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<()> { fn into_llvm(self, context: &mut Context) -> anyhow::Result<()> {
<Self as RuntimeFunction<_>>::emit(&self, context) <Self as RuntimeFunction>::emit(&self, context)
} }
} }
/// Store a word size value through a heap pointer. /// Store a word size value through a heap pointer.
pub struct StoreWord; pub struct StoreWord;
impl<D> RuntimeFunction<D> for StoreWord impl RuntimeFunction for StoreWord {
where
D: Dependency + Clone,
{
const NAME: &'static str = "__revive_store_heap_word"; const NAME: &'static str = "__revive_store_heap_word";
fn r#type<'ctx>(context: &Context<'ctx, D>) -> inkwell::types::FunctionType<'ctx> { fn r#type<'ctx>(context: &Context<'ctx>) -> inkwell::types::FunctionType<'ctx> {
context.void_type().fn_type( context.void_type().fn_type(
&[context.xlen_type().into(), context.word_type().into()], &[context.xlen_type().into(), context.word_type().into()],
false, false,
@@ -77,12 +70,12 @@ where
fn emit_body<'ctx>( fn emit_body<'ctx>(
&self, &self,
context: &mut Context<'ctx, D>, context: &mut Context<'ctx>,
) -> anyhow::Result<Option<BasicValueEnum<'ctx>>> { ) -> anyhow::Result<Option<BasicValueEnum<'ctx>>> {
let offset = Self::paramater(context, 0).into_int_value(); let offset = Self::paramater(context, 0).into_int_value();
let length = context let length = context
.xlen_type() .xlen_type()
.const_int(revive_common::BYTE_LENGTH_WORD as u64, false); .const_int(BYTE_LENGTH_WORD as u64, false);
let pointer = context.build_heap_gep(offset, length)?; let pointer = context.build_heap_gep(offset, length)?;
let value = context.build_byte_swap(Self::paramater(context, 1))?; let value = context.build_byte_swap(Self::paramater(context, 1))?;
@@ -90,21 +83,18 @@ where
context context
.builder() .builder()
.build_store(pointer.value, value)? .build_store(pointer.value, value)?
.set_alignment(revive_common::BYTE_LENGTH_BYTE as u32) .set_alignment(BYTE_LENGTH_BYTE as u32)
.expect("Alignment is valid"); .expect("Alignment is valid");
Ok(None) Ok(None)
} }
} }
impl<D> WriteLLVM<D> for StoreWord impl WriteLLVM for StoreWord {
where fn declare(&mut self, context: &mut Context) -> anyhow::Result<()> {
D: Dependency + Clone, <Self as RuntimeFunction>::declare(self, context)
{
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<()> { fn into_llvm(self, context: &mut Context) -> anyhow::Result<()> {
<Self as RuntimeFunction<_>>::emit(&self, context) <Self as RuntimeFunction>::emit(&self, context)
} }
} }
@@ -5,7 +5,6 @@ use inkwell::types::BasicType;
use crate::polkavm::context::address_space::AddressSpace; use crate::polkavm::context::address_space::AddressSpace;
use crate::polkavm::context::global::Global; use crate::polkavm::context::global::Global;
use crate::polkavm::context::Context; use crate::polkavm::context::Context;
use crate::polkavm::Dependency;
pub mod heap; pub mod heap;
pub mod storage; pub mod storage;
@@ -39,13 +38,10 @@ impl<'ctx> Pointer<'ctx> {
} }
/// Wraps a 256-bit primitive type pointer. /// Wraps a 256-bit primitive type pointer.
pub fn new_stack_field<D>( pub fn new_stack_field(
context: &Context<'ctx, D>, context: &Context<'ctx>,
value: inkwell::values::PointerValue<'ctx>, value: inkwell::values::PointerValue<'ctx>,
) -> Self ) -> Self {
where
D: Dependency + Clone,
{
Self { Self {
r#type: context.word_type().as_basic_type_enum(), r#type: context.word_type().as_basic_type_enum(),
address_space: AddressSpace::Stack, address_space: AddressSpace::Stack,
@@ -54,15 +50,14 @@ impl<'ctx> Pointer<'ctx> {
} }
/// Creates a new pointer with the specified `offset`. /// Creates a new pointer with the specified `offset`.
pub fn new_with_offset<D, T>( pub fn new_with_offset<T>(
context: &Context<'ctx, D>, context: &Context<'ctx>,
address_space: AddressSpace, address_space: AddressSpace,
r#type: T, r#type: T,
offset: inkwell::values::IntValue<'ctx>, offset: inkwell::values::IntValue<'ctx>,
name: &str, name: &str,
) -> Self ) -> Self
where where
D: Dependency + Clone,
T: BasicType<'ctx>, T: BasicType<'ctx>,
{ {
assert_ne!( assert_ne!(
@@ -92,25 +87,19 @@ impl<'ctx> Pointer<'ctx> {
} }
/// Cast this pointer to a register sized integer value. /// Cast this pointer to a register sized integer value.
pub fn to_int<D>(&self, context: &Context<'ctx, D>) -> inkwell::values::IntValue<'ctx> pub fn to_int(&self, context: &Context<'ctx>) -> inkwell::values::IntValue<'ctx> {
where
D: Dependency + Clone,
{
context context
.builder() .builder()
.build_ptr_to_int(self.value, context.xlen_type(), "ptr_to_xlen") .build_ptr_to_int(self.value, context.xlen_type(), "ptr_to_xlen")
.expect("we should be positioned") .expect("we should be positioned")
} }
pub fn address_space_cast<D>( pub fn address_space_cast(
self, self,
context: &Context<'ctx, D>, context: &Context<'ctx>,
address_space: AddressSpace, address_space: AddressSpace,
name: &str, name: &str,
) -> anyhow::Result<Self> ) -> anyhow::Result<Self> {
where
D: Dependency + Clone,
{
let value = context.builder().build_address_space_cast( let value = context.builder().build_address_space_cast(
self.value, self.value,
context.llvm().ptr_type(address_space.into()), context.llvm().ptr_type(address_space.into()),
@@ -4,19 +4,15 @@ use inkwell::values::BasicValueEnum;
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::WriteLLVM; use crate::polkavm::WriteLLVM;
/// Load a word size value from a storage pointer. /// Load a word size value from a storage pointer.
pub struct LoadWord; pub struct LoadWord;
impl<D> RuntimeFunction<D> for LoadWord impl RuntimeFunction for LoadWord {
where
D: Dependency + Clone,
{
const NAME: &'static str = "__revive_load_storage_word"; const NAME: &'static str = "__revive_load_storage_word";
fn r#type<'ctx>(context: &Context<'ctx, D>) -> inkwell::types::FunctionType<'ctx> { fn r#type<'ctx>(context: &Context<'ctx>) -> inkwell::types::FunctionType<'ctx> {
context context
.word_type() .word_type()
.fn_type(&[context.llvm().ptr_type(Default::default()).into()], false) .fn_type(&[context.llvm().ptr_type(Default::default()).into()], false)
@@ -24,7 +20,7 @@ where
fn emit_body<'ctx>( fn emit_body<'ctx>(
&self, &self,
context: &mut Context<'ctx, D>, context: &mut Context<'ctx>,
) -> anyhow::Result<Option<BasicValueEnum<'ctx>>> { ) -> anyhow::Result<Option<BasicValueEnum<'ctx>>> {
Ok(Some(emit_load( Ok(Some(emit_load(
context, context,
@@ -34,29 +30,23 @@ where
} }
} }
impl<D> WriteLLVM<D> for LoadWord impl WriteLLVM for LoadWord {
where fn declare(&mut self, context: &mut Context) -> anyhow::Result<()> {
D: Dependency + Clone, <Self as RuntimeFunction>::declare(self, context)
{
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<()> { fn into_llvm(self, context: &mut Context) -> anyhow::Result<()> {
<Self as RuntimeFunction<_>>::emit(&self, context) <Self as RuntimeFunction>::emit(&self, context)
} }
} }
/// Load a word size value from a transient storage pointer. /// Load a word size value from a transient storage pointer.
pub struct LoadTransientWord; pub struct LoadTransientWord;
impl<D> RuntimeFunction<D> for LoadTransientWord impl RuntimeFunction for LoadTransientWord {
where
D: Dependency + Clone,
{
const NAME: &'static str = "__revive_load_transient_storage_word"; const NAME: &'static str = "__revive_load_transient_storage_word";
fn r#type<'ctx>(context: &Context<'ctx, D>) -> inkwell::types::FunctionType<'ctx> { fn r#type<'ctx>(context: &Context<'ctx>) -> inkwell::types::FunctionType<'ctx> {
context context
.word_type() .word_type()
.fn_type(&[context.llvm().ptr_type(Default::default()).into()], false) .fn_type(&[context.llvm().ptr_type(Default::default()).into()], false)
@@ -64,35 +54,29 @@ where
fn emit_body<'ctx>( fn emit_body<'ctx>(
&self, &self,
context: &mut Context<'ctx, D>, context: &mut Context<'ctx>,
) -> anyhow::Result<Option<BasicValueEnum<'ctx>>> { ) -> anyhow::Result<Option<BasicValueEnum<'ctx>>> {
Ok(Some(emit_load(context, Self::paramater(context, 0), true)?)) Ok(Some(emit_load(context, Self::paramater(context, 0), true)?))
} }
} }
impl<D> WriteLLVM<D> for LoadTransientWord impl WriteLLVM for LoadTransientWord {
where fn declare(&mut self, context: &mut Context) -> anyhow::Result<()> {
D: Dependency + Clone, <Self as RuntimeFunction>::declare(self, context)
{
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<()> { fn into_llvm(self, context: &mut Context) -> anyhow::Result<()> {
<Self as RuntimeFunction<_>>::emit(&self, context) <Self as RuntimeFunction>::emit(&self, context)
} }
} }
/// Store a word size value through a storage pointer. /// Store a word size value through a storage pointer.
pub struct StoreWord; pub struct StoreWord;
impl<D> RuntimeFunction<D> for StoreWord impl RuntimeFunction for StoreWord {
where
D: Dependency + Clone,
{
const NAME: &'static str = "__revive_store_storage_word"; const NAME: &'static str = "__revive_store_storage_word";
fn r#type<'ctx>(context: &Context<'ctx, D>) -> inkwell::types::FunctionType<'ctx> { fn r#type<'ctx>(context: &Context<'ctx>) -> inkwell::types::FunctionType<'ctx> {
context.void_type().fn_type( context.void_type().fn_type(
&[ &[
context.llvm().ptr_type(Default::default()).into(), context.llvm().ptr_type(Default::default()).into(),
@@ -104,7 +88,7 @@ where
fn emit_body<'ctx>( fn emit_body<'ctx>(
&self, &self,
context: &mut Context<'ctx, D>, context: &mut Context<'ctx>,
) -> anyhow::Result<Option<BasicValueEnum<'ctx>>> { ) -> anyhow::Result<Option<BasicValueEnum<'ctx>>> {
emit_store( emit_store(
context, context,
@@ -117,29 +101,23 @@ where
} }
} }
impl<D> WriteLLVM<D> for StoreWord impl WriteLLVM for StoreWord {
where fn declare(&mut self, context: &mut Context) -> anyhow::Result<()> {
D: Dependency + Clone, <Self as RuntimeFunction>::declare(self, context)
{
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<()> { fn into_llvm(self, context: &mut Context) -> anyhow::Result<()> {
<Self as RuntimeFunction<_>>::emit(&self, context) <Self as RuntimeFunction>::emit(&self, context)
} }
} }
/// Store a word size value through a transient storage pointer. /// Store a word size value through a transient storage pointer.
pub struct StoreTransientWord; pub struct StoreTransientWord;
impl<D> RuntimeFunction<D> for StoreTransientWord impl RuntimeFunction for StoreTransientWord {
where
D: Dependency + Clone,
{
const NAME: &'static str = "__revive_store_transient_storage_word"; const NAME: &'static str = "__revive_store_transient_storage_word";
fn r#type<'ctx>(context: &Context<'ctx, D>) -> inkwell::types::FunctionType<'ctx> { fn r#type<'ctx>(context: &Context<'ctx>) -> inkwell::types::FunctionType<'ctx> {
context.void_type().fn_type( context.void_type().fn_type(
&[ &[
context.llvm().ptr_type(Default::default()).into(), context.llvm().ptr_type(Default::default()).into(),
@@ -151,7 +129,7 @@ where
fn emit_body<'ctx>( fn emit_body<'ctx>(
&self, &self,
context: &mut Context<'ctx, D>, context: &mut Context<'ctx>,
) -> anyhow::Result<Option<BasicValueEnum<'ctx>>> { ) -> anyhow::Result<Option<BasicValueEnum<'ctx>>> {
emit_store( emit_store(
context, context,
@@ -164,24 +142,25 @@ where
} }
} }
impl<D> WriteLLVM<D> for StoreTransientWord impl WriteLLVM for StoreTransientWord {
where fn declare(&mut self, context: &mut Context) -> anyhow::Result<()> {
D: Dependency + Clone, <Self as RuntimeFunction>::declare(self, context)
{
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<()> { fn into_llvm(self, context: &mut Context) -> anyhow::Result<()> {
<Self as RuntimeFunction<_>>::emit(&self, context) <Self as RuntimeFunction>::emit(&self, context)
} }
} }
fn emit_load<'ctx, D: Dependency + Clone>( fn emit_load<'ctx>(
context: &mut Context<'ctx, D>, context: &mut Context<'ctx>,
key: BasicValueEnum<'ctx>, key: BasicValueEnum<'ctx>,
transient: bool, transient: bool,
) -> anyhow::Result<BasicValueEnum<'ctx>> { ) -> anyhow::Result<BasicValueEnum<'ctx>> {
let is_transient = context.xlen_type().const_int(transient as u64, false);
let key_pointer = context.build_alloca_at_entry(context.word_type(), "key_pointer");
let value_pointer = context.build_alloca_at_entry(context.word_type(), "value_pointer");
let mut key = context.build_load( let mut key = context.build_load(
super::Pointer::new( super::Pointer::new(
context.word_type(), context.word_type(),
@@ -193,33 +172,17 @@ fn emit_load<'ctx, D: Dependency + Clone>(
if !transient { if !transient {
key = context.build_byte_swap(key)?; key = context.build_byte_swap(key)?;
} }
let key_pointer = context.build_alloca_at_entry(context.word_type(), "key_pointer");
let value_pointer = context.build_alloca_at_entry(context.word_type(), "value_pointer");
let length_pointer = context.build_alloca_at_entry(context.xlen_type(), "length_pointer");
context.builder().build_store(key_pointer.value, key)?; context.builder().build_store(key_pointer.value, key)?;
context.build_store(value_pointer, context.word_const(0))?;
context.build_store(
length_pointer,
context
.xlen_type()
.const_int(revive_common::BYTE_LENGTH_WORD as u64, false),
)?;
let is_transient = context.xlen_type().const_int(transient as u64, false);
let arguments = [ let arguments = [
is_transient.into(), is_transient.into(),
key_pointer.to_int(context).into(), key_pointer.to_int(context).into(),
context.xlen_type().const_all_ones().into(),
value_pointer.to_int(context).into(), value_pointer.to_int(context).into(),
length_pointer.to_int(context).into(),
]; ];
context.build_runtime_call(revive_runtime_api::polkavm_imports::GET_STORAGE, &arguments); context.build_runtime_call(revive_runtime_api::polkavm_imports::GET_STORAGE, &arguments);
// We do not to check the return value: Solidity assumes infallible loads. // We do not to check the return value: Solidity assumes infallible loads.
// If a key doesn't exist the "zero" value is returned (ensured by above write). // If a key doesn't exist the syscall returns zero.
let value = context.build_load(value_pointer, "storage_value")?; let value = context.build_load(value_pointer, "storage_value")?;
Ok(if transient { Ok(if transient {
@@ -229,12 +192,16 @@ fn emit_load<'ctx, D: Dependency + Clone>(
}) })
} }
fn emit_store<'ctx, D: Dependency + Clone>( fn emit_store<'ctx>(
context: &mut Context<'ctx, D>, context: &mut Context<'ctx>,
key: BasicValueEnum<'ctx>, key: BasicValueEnum<'ctx>,
value: BasicValueEnum<'ctx>, value: BasicValueEnum<'ctx>,
transient: bool, transient: bool,
) -> anyhow::Result<()> { ) -> anyhow::Result<()> {
let is_transient = context.xlen_type().const_int(transient as u64, false);
let key_pointer = context.build_alloca_at_entry(context.word_type(), "key_pointer");
let value_pointer = context.build_alloca_at_entry(context.word_type(), "value_pointer");
let mut key = context.build_load( let mut key = context.build_load(
super::Pointer::new( super::Pointer::new(
context.word_type(), context.word_type(),
@@ -249,27 +216,20 @@ fn emit_store<'ctx, D: Dependency + Clone>(
Default::default(), Default::default(),
value.into_pointer_value(), value.into_pointer_value(),
), ),
"key", "value",
)?; )?;
if !transient { if !transient {
key = context.build_byte_swap(key)?; key = context.build_byte_swap(key)?;
value = context.build_byte_swap(value)?; value = context.build_byte_swap(value)?;
} }
let key_pointer = context.build_alloca_at_entry(context.word_type(), "key_pointer");
let value_pointer = context.build_alloca_at_entry(context.word_type(), "value_pointer");
context.build_store(key_pointer, key)?; context.build_store(key_pointer, key)?;
context.build_store(value_pointer, value)?; context.build_store(value_pointer, value)?;
let is_transient = context.xlen_type().const_int(transient as u64, false);
let arguments = [ let arguments = [
is_transient.into(), is_transient.into(),
key_pointer.to_int(context).into(), key_pointer.to_int(context).into(),
context.xlen_type().const_all_ones().into(),
value_pointer.to_int(context).into(), value_pointer.to_int(context).into(),
context.integer_const(crate::polkavm::XLEN, 32).into(),
]; ];
context.build_runtime_call(revive_runtime_api::polkavm_imports::SET_STORAGE, &arguments); context.build_runtime_call(revive_runtime_api::polkavm_imports::SET_STORAGE, &arguments);
@@ -8,14 +8,10 @@ use crate::polkavm::context::function::declaration::Declaration;
use crate::polkavm::context::function::Function; use crate::polkavm::context::function::Function;
use crate::polkavm::context::Attribute; use crate::polkavm::context::Attribute;
use crate::polkavm::context::Context; use crate::polkavm::context::Context;
use crate::polkavm::Dependency;
/// The revive runtime function interface simplifies declaring runtime functions /// The revive runtime function interface simplifies declaring runtime functions
/// and code emitting by providing helpful default implementations. /// and code emitting by providing helpful default implementations.
pub trait RuntimeFunction<D> pub trait RuntimeFunction {
where
D: Dependency + Clone,
{
/// The function name. /// The function name.
const NAME: &'static str; const NAME: &'static str;
@@ -26,16 +22,17 @@ where
]; ];
/// The function type. /// The function type.
fn r#type<'ctx>(context: &Context<'ctx, D>) -> inkwell::types::FunctionType<'ctx>; fn r#type<'ctx>(context: &Context<'ctx>) -> inkwell::types::FunctionType<'ctx>;
/// Declare the function. /// Declare the function.
fn declare(&self, context: &mut Context<D>) -> anyhow::Result<()> { fn declare(&self, context: &mut Context) -> anyhow::Result<()> {
let function = context.add_function( let function = context.add_function(
Self::NAME, Self::NAME,
Self::r#type(context), Self::r#type(context),
0, 0,
Some(inkwell::module::Linkage::External), Some(inkwell::module::Linkage::LinkOnceODR),
None, None,
false,
)?; )?;
let mut attributes = Self::ATTRIBUTES.to_vec(); let mut attributes = Self::ATTRIBUTES.to_vec();
@@ -49,22 +46,28 @@ where
&attributes, &attributes,
true, true,
); );
let function = function.borrow().declaration().function_value();
let comdat = context
.module()
.get_or_insert_comdat(&format!("{}_comdat", Self::NAME));
comdat.set_selection_kind(inkwell::comdat::ComdatSelectionKind::NoDuplicates);
function.as_global_value().set_comdat(comdat);
Ok(()) Ok(())
} }
/// Get the function declaration. /// Get the function declaration.
fn declaration<'ctx>(context: &Context<'ctx, D>) -> Declaration<'ctx> { fn declaration<'ctx>(context: &Context<'ctx>) -> Declaration<'ctx> {
context context
.get_function(Self::NAME) .get_function(Self::NAME, false)
.unwrap_or_else(|| panic!("runtime function {} should be declared", Self::NAME)) .unwrap_or_else(|| panic!("runtime function {} should be declared", Self::NAME))
.borrow() .borrow()
.declaration() .declaration()
} }
/// Emit the function. /// Emit the function.
fn emit(&self, context: &mut Context<D>) -> anyhow::Result<()> { fn emit(&self, context: &mut Context) -> anyhow::Result<()> {
context.set_current_function(Self::NAME, None)?; context.set_current_function(Self::NAME, None, false)?;
context.set_basic_block(context.current_function().borrow().entry_block()); context.set_basic_block(context.current_function().borrow().entry_block());
let return_value = self.emit_body(context)?; let return_value = self.emit_body(context)?;
@@ -78,13 +81,13 @@ where
/// Emit the function body. /// Emit the function body.
fn emit_body<'ctx>( fn emit_body<'ctx>(
&self, &self,
context: &mut Context<'ctx, D>, context: &mut Context<'ctx>,
) -> anyhow::Result<Option<inkwell::values::BasicValueEnum<'ctx>>>; ) -> anyhow::Result<Option<inkwell::values::BasicValueEnum<'ctx>>>;
/// Emit the function return instructions. /// Emit the function return instructions.
fn emit_epilogue<'ctx>( fn emit_epilogue<'ctx>(
&self, &self,
context: &mut Context<'ctx, D>, context: &mut Context<'ctx>,
return_value: Option<inkwell::values::BasicValueEnum<'ctx>>, return_value: Option<inkwell::values::BasicValueEnum<'ctx>>,
) { ) {
let return_block = context.current_function().borrow().return_block(); let return_block = context.current_function().borrow().return_block();
@@ -98,12 +101,12 @@ where
/// Get the nth function paramater. /// Get the nth function paramater.
fn paramater<'ctx>( fn paramater<'ctx>(
context: &Context<'ctx, D>, context: &Context<'ctx>,
index: usize, index: usize,
) -> inkwell::values::BasicValueEnum<'ctx> { ) -> inkwell::values::BasicValueEnum<'ctx> {
let name = Self::NAME; let name = Self::NAME;
context context
.get_function(name) .get_function(name, false)
.unwrap_or_else(|| panic!("runtime function {name} should be declared")) .unwrap_or_else(|| panic!("runtime function {name} should be declared"))
.borrow() .borrow()
.declaration() .declaration()
@@ -2,6 +2,8 @@
use std::collections::BTreeMap; use std::collections::BTreeMap;
use revive_common::BYTE_LENGTH_WORD;
/// The LLVM IR generator Solidity data. /// The LLVM IR generator Solidity data.
/// Describes some data that is only relevant to Solidity. /// Describes some data that is only relevant to Solidity.
#[derive(Debug, Default)] #[derive(Debug, Default)]
@@ -19,14 +21,14 @@ impl SolidityData {
/// Returns the current size of immutable values in the contract. /// Returns the current size of immutable values in the contract.
pub fn immutables_size(&self) -> usize { pub fn immutables_size(&self) -> usize {
self.immutables.len() * revive_common::BYTE_LENGTH_WORD self.immutables.len() * BYTE_LENGTH_WORD
} }
/// Allocates memory for an immutable value in the auxiliary heap. /// Allocates memory for an immutable value in the auxiliary heap.
/// If the identifier is already known, just returns its offset. /// If the identifier is already known, just returns its offset.
pub fn allocate_immutable(&mut self, identifier: &str) -> usize { pub fn allocate_immutable(&mut self, identifier: &str) -> usize {
let number_of_elements = self.immutables.len(); let number_of_elements = self.immutables.len();
let new_offset = number_of_elements * revive_common::BYTE_LENGTH_WORD; let new_offset = number_of_elements * BYTE_LENGTH_WORD;
*self *self
.immutables .immutables
.entry(identifier.to_owned()) .entry(identifier.to_owned())
@@ -4,24 +4,21 @@ use crate::optimizer::settings::Settings as OptimizerSettings;
use crate::optimizer::Optimizer; use crate::optimizer::Optimizer;
use crate::polkavm::context::attribute::Attribute; use crate::polkavm::context::attribute::Attribute;
use crate::polkavm::context::Context; use crate::polkavm::context::Context;
use crate::polkavm::DummyDependency; use crate::PolkaVMTarget;
pub fn create_context( pub fn create_context(
llvm: &inkwell::context::Context, llvm: &inkwell::context::Context,
optimizer_settings: OptimizerSettings, optimizer_settings: OptimizerSettings,
) -> Context<DummyDependency> { ) -> Context<'_> {
crate::initialize_llvm(crate::Target::PVM, "resolc", Default::default()); crate::initialize_llvm(PolkaVMTarget::PVM, "resolc", Default::default());
let module = llvm.create_module("test"); let module = llvm.create_module("test");
let optimizer = Optimizer::new(optimizer_settings); let optimizer = Optimizer::new(optimizer_settings);
Context::<DummyDependency>::new( Context::new(
llvm, llvm,
module, module,
optimizer, optimizer,
None,
true,
Default::default(),
Default::default(), Default::default(),
Default::default(), Default::default(),
) )
@@ -41,6 +38,7 @@ pub fn check_attribute_null_pointer_is_invalid() {
1, 1,
Some(inkwell::module::Linkage::External), Some(inkwell::module::Linkage::External),
None, None,
false,
) )
.expect("Failed to add function"); .expect("Failed to add function");
assert!(!function assert!(!function
@@ -65,6 +63,7 @@ pub fn check_attribute_optimize_for_size_mode_3() {
1, 1,
Some(inkwell::module::Linkage::External), Some(inkwell::module::Linkage::External),
None, None,
false,
) )
.expect("Failed to add function"); .expect("Failed to add function");
assert!(!function assert!(!function
@@ -89,6 +88,7 @@ pub fn check_attribute_optimize_for_size_mode_z() {
1, 1,
Some(inkwell::module::Linkage::External), Some(inkwell::module::Linkage::External),
None, None,
false,
) )
.expect("Failed to add function"); .expect("Failed to add function");
assert!(function assert!(function
@@ -113,6 +113,7 @@ pub fn check_attribute_min_size_mode_3() {
1, 1,
Some(inkwell::module::Linkage::External), Some(inkwell::module::Linkage::External),
None, None,
false,
) )
.expect("Failed to add function"); .expect("Failed to add function");
assert!(!function assert!(!function
@@ -137,6 +138,7 @@ pub fn check_attribute_min_size_mode_z() {
1, 1,
Some(inkwell::module::Linkage::External), Some(inkwell::module::Linkage::External),
None, None,
false,
) )
.expect("Failed to add function"); .expect("Failed to add function");
assert!(function assert!(function
@@ -2,60 +2,25 @@
use std::collections::BTreeMap; use std::collections::BTreeMap;
use num::Zero;
/// The LLVM IR generator Yul data. /// The LLVM IR generator Yul data.
/// Describes some data that is only relevant to Yul. ///
/// Contains data that is only relevant to Yul.
#[derive(Debug, Default)] #[derive(Debug, Default)]
pub struct YulData { pub struct YulData {
/// The list of constant arrays in the code section. /// Mapping from Yul object identifiers to full contract paths.
/// It is a temporary storage used until the finalization method is called. identifier_paths: BTreeMap<String, String>,
const_arrays: BTreeMap<u8, Vec<num::BigUint>>,
} }
impl YulData { impl YulData {
/// Declares a temporary constant array representation. /// A shorthand constructor.
pub fn const_array_declare(&mut self, index: u8, size: u16) -> anyhow::Result<()> { pub fn new(identifier_paths: BTreeMap<String, String>) -> Self {
if self.const_arrays.contains_key(&index) { Self { identifier_paths }
anyhow::bail!(
"The constant array with index {} is already declared",
index
);
} }
self.const_arrays /// Resolves the full contract path by the Yul object identifier.
.insert(index, vec![num::BigUint::zero(); size as usize]); pub fn resolve_path(&self, identifier: &str) -> Option<&str> {
self.identifier_paths
Ok(()) .get(identifier)
} .map(|path| path.as_str())
/// Sets a value in the constant array representation.
pub fn const_array_set(
&mut self,
index: u8,
offset: u16,
value: num::BigUint,
) -> anyhow::Result<()> {
let array = self.const_arrays.get_mut(&index).ok_or_else(|| {
anyhow::anyhow!("The constant array with index {} is not declared", index)
})?;
if offset >= array.len() as u16 {
anyhow::bail!(
"The constant array with index {} has size {} but the offset is {}",
index,
array.len(),
offset,
);
}
array[offset as usize] = value;
Ok(())
}
/// Finalizes the constant array declaration.
pub fn const_array_take(&mut self, index: u8) -> anyhow::Result<Vec<num::BigUint>> {
self.const_arrays.remove(&index).ok_or_else(|| {
anyhow::anyhow!("The constant array with index {} is not declared", index)
})
} }
} }
@@ -4,21 +4,17 @@ 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::PolkaVMDivisionFunction; use crate::PolkaVMDivisionFunction;
use crate::PolkaVMRemainderFunction; use crate::PolkaVMRemainderFunction;
use crate::PolkaVMSignedDivisionFunction; use crate::PolkaVMSignedDivisionFunction;
use crate::PolkaVMSignedRemainderFunction; use crate::PolkaVMSignedRemainderFunction;
/// Translates the arithmetic addition. /// Translates the arithmetic addition.
pub fn addition<'ctx, D>( pub fn addition<'ctx>(
context: &mut Context<'ctx, D>, context: &mut Context<'ctx>,
operand_1: inkwell::values::IntValue<'ctx>, operand_1: inkwell::values::IntValue<'ctx>,
operand_2: inkwell::values::IntValue<'ctx>, operand_2: inkwell::values::IntValue<'ctx>,
) -> anyhow::Result<inkwell::values::BasicValueEnum<'ctx>> ) -> anyhow::Result<inkwell::values::BasicValueEnum<'ctx>> {
where
D: Dependency + Clone,
{
Ok(context Ok(context
.builder() .builder()
.build_int_add(operand_1, operand_2, "addition_result")? .build_int_add(operand_1, operand_2, "addition_result")?
@@ -26,14 +22,11 @@ where
} }
/// Translates the arithmetic subtraction. /// Translates the arithmetic subtraction.
pub fn subtraction<'ctx, D>( pub fn subtraction<'ctx>(
context: &mut Context<'ctx, D>, context: &mut Context<'ctx>,
operand_1: inkwell::values::IntValue<'ctx>, operand_1: inkwell::values::IntValue<'ctx>,
operand_2: inkwell::values::IntValue<'ctx>, operand_2: inkwell::values::IntValue<'ctx>,
) -> anyhow::Result<inkwell::values::BasicValueEnum<'ctx>> ) -> anyhow::Result<inkwell::values::BasicValueEnum<'ctx>> {
where
D: Dependency + Clone,
{
Ok(context Ok(context
.builder() .builder()
.build_int_sub(operand_1, operand_2, "subtraction_result")? .build_int_sub(operand_1, operand_2, "subtraction_result")?
@@ -41,14 +34,11 @@ where
} }
/// Translates the arithmetic multiplication. /// Translates the arithmetic multiplication.
pub fn multiplication<'ctx, D>( pub fn multiplication<'ctx>(
context: &mut Context<'ctx, D>, context: &mut Context<'ctx>,
operand_1: inkwell::values::IntValue<'ctx>, operand_1: inkwell::values::IntValue<'ctx>,
operand_2: inkwell::values::IntValue<'ctx>, operand_2: inkwell::values::IntValue<'ctx>,
) -> anyhow::Result<inkwell::values::BasicValueEnum<'ctx>> ) -> anyhow::Result<inkwell::values::BasicValueEnum<'ctx>> {
where
D: Dependency + Clone,
{
Ok(context Ok(context
.builder() .builder()
.build_int_mul(operand_1, operand_2, "multiplication_result")? .build_int_mul(operand_1, operand_2, "multiplication_result")?
@@ -56,32 +46,26 @@ where
} }
/// Translates the arithmetic division. /// Translates the arithmetic division.
pub fn division<'ctx, D>( pub fn division<'ctx>(
context: &mut Context<'ctx, D>, context: &mut Context<'ctx>,
operand_1: inkwell::values::IntValue<'ctx>, operand_1: inkwell::values::IntValue<'ctx>,
operand_2: inkwell::values::IntValue<'ctx>, operand_2: inkwell::values::IntValue<'ctx>,
) -> anyhow::Result<inkwell::values::BasicValueEnum<'ctx>> ) -> anyhow::Result<inkwell::values::BasicValueEnum<'ctx>> {
where let name = <PolkaVMDivisionFunction as RuntimeFunction>::NAME;
D: Dependency + Clone, let declaration = <PolkaVMDivisionFunction as RuntimeFunction>::declaration(context);
{
let name = <PolkaVMDivisionFunction as RuntimeFunction<D>>::NAME;
let declaration = <PolkaVMDivisionFunction as RuntimeFunction<D>>::declaration(context);
Ok(context Ok(context
.build_call(declaration, &[operand_1.into(), operand_2.into()], "div") .build_call(declaration, &[operand_1.into(), operand_2.into()], "div")
.unwrap_or_else(|| panic!("revive runtime function {name} should return a value",))) .unwrap_or_else(|| panic!("revive runtime function {name} should return a value",)))
} }
/// Translates the arithmetic remainder. /// Translates the arithmetic remainder.
pub fn remainder<'ctx, D>( pub fn remainder<'ctx>(
context: &mut Context<'ctx, D>, context: &mut Context<'ctx>,
operand_1: inkwell::values::IntValue<'ctx>, operand_1: inkwell::values::IntValue<'ctx>,
operand_2: inkwell::values::IntValue<'ctx>, operand_2: inkwell::values::IntValue<'ctx>,
) -> anyhow::Result<inkwell::values::BasicValueEnum<'ctx>> ) -> anyhow::Result<inkwell::values::BasicValueEnum<'ctx>> {
where let name = <PolkaVMRemainderFunction as RuntimeFunction>::NAME;
D: Dependency + Clone, let declaration = <PolkaVMRemainderFunction as RuntimeFunction>::declaration(context);
{
let name = <PolkaVMRemainderFunction as RuntimeFunction<D>>::NAME;
let declaration = <PolkaVMRemainderFunction as RuntimeFunction<D>>::declaration(context);
Ok(context Ok(context
.build_call(declaration, &[operand_1.into(), operand_2.into()], "rem") .build_call(declaration, &[operand_1.into(), operand_2.into()], "rem")
.unwrap_or_else(|| panic!("revive runtime function {name} should return a value",))) .unwrap_or_else(|| panic!("revive runtime function {name} should return a value",)))
@@ -91,32 +75,26 @@ where
/// Two differences between the EVM and LLVM IR: /// Two differences between the EVM and LLVM IR:
/// 1. In case of division by zero, 0 is returned. /// 1. In case of division by zero, 0 is returned.
/// 2. In case of overflow, the first argument is returned. /// 2. In case of overflow, the first argument is returned.
pub fn division_signed<'ctx, D>( pub fn division_signed<'ctx>(
context: &mut Context<'ctx, D>, context: &mut Context<'ctx>,
operand_1: inkwell::values::IntValue<'ctx>, operand_1: inkwell::values::IntValue<'ctx>,
operand_2: inkwell::values::IntValue<'ctx>, operand_2: inkwell::values::IntValue<'ctx>,
) -> anyhow::Result<inkwell::values::BasicValueEnum<'ctx>> ) -> anyhow::Result<inkwell::values::BasicValueEnum<'ctx>> {
where let name = <PolkaVMSignedDivisionFunction as RuntimeFunction>::NAME;
D: Dependency + Clone, let declaration = <PolkaVMSignedDivisionFunction as RuntimeFunction>::declaration(context);
{
let name = <PolkaVMSignedDivisionFunction as RuntimeFunction<D>>::NAME;
let declaration = <PolkaVMSignedDivisionFunction as RuntimeFunction<D>>::declaration(context);
Ok(context Ok(context
.build_call(declaration, &[operand_1.into(), operand_2.into()], "sdiv") .build_call(declaration, &[operand_1.into(), operand_2.into()], "sdiv")
.unwrap_or_else(|| panic!("revive runtime function {name} should return a value",))) .unwrap_or_else(|| panic!("revive runtime function {name} should return a value",)))
} }
/// Translates the signed arithmetic remainder. /// Translates the signed arithmetic remainder.
pub fn remainder_signed<'ctx, D>( pub fn remainder_signed<'ctx>(
context: &mut Context<'ctx, D>, context: &mut Context<'ctx>,
operand_1: inkwell::values::IntValue<'ctx>, operand_1: inkwell::values::IntValue<'ctx>,
operand_2: inkwell::values::IntValue<'ctx>, operand_2: inkwell::values::IntValue<'ctx>,
) -> anyhow::Result<inkwell::values::BasicValueEnum<'ctx>> ) -> anyhow::Result<inkwell::values::BasicValueEnum<'ctx>> {
where let name = <PolkaVMSignedRemainderFunction as RuntimeFunction>::NAME;
D: Dependency + Clone, let declaration = <PolkaVMSignedRemainderFunction as RuntimeFunction>::declaration(context);
{
let name = <PolkaVMSignedRemainderFunction as RuntimeFunction<D>>::NAME;
let declaration = <PolkaVMSignedRemainderFunction as RuntimeFunction<D>>::declaration(context);
Ok(context Ok(context
.build_call(declaration, &[operand_1.into(), operand_2.into()], "srem") .build_call(declaration, &[operand_1.into(), operand_2.into()], "srem")
.unwrap_or_else(|| panic!("revive runtime function {name} should return a value",))) .unwrap_or_else(|| panic!("revive runtime function {name} should return a value",)))
+32 -54
View File
@@ -2,18 +2,17 @@
use inkwell::values::BasicValue; use inkwell::values::BasicValue;
use revive_common::BIT_LENGTH_BYTE;
use revive_common::BIT_LENGTH_WORD;
use crate::polkavm::context::Context; use crate::polkavm::context::Context;
use crate::polkavm::Dependency;
/// Translates the bitwise OR. /// Translates the bitwise OR.
pub fn or<'ctx, D>( pub fn or<'ctx>(
context: &mut Context<'ctx, D>, context: &mut Context<'ctx>,
operand_1: inkwell::values::IntValue<'ctx>, operand_1: inkwell::values::IntValue<'ctx>,
operand_2: inkwell::values::IntValue<'ctx>, operand_2: inkwell::values::IntValue<'ctx>,
) -> anyhow::Result<inkwell::values::BasicValueEnum<'ctx>> ) -> anyhow::Result<inkwell::values::BasicValueEnum<'ctx>> {
where
D: Dependency + Clone,
{
Ok(context Ok(context
.builder() .builder()
.build_or(operand_1, operand_2, "or_result")? .build_or(operand_1, operand_2, "or_result")?
@@ -21,14 +20,11 @@ where
} }
/// Translates the bitwise XOR. /// Translates the bitwise XOR.
pub fn xor<'ctx, D>( pub fn xor<'ctx>(
context: &mut Context<'ctx, D>, context: &mut Context<'ctx>,
operand_1: inkwell::values::IntValue<'ctx>, operand_1: inkwell::values::IntValue<'ctx>,
operand_2: inkwell::values::IntValue<'ctx>, operand_2: inkwell::values::IntValue<'ctx>,
) -> anyhow::Result<inkwell::values::BasicValueEnum<'ctx>> ) -> anyhow::Result<inkwell::values::BasicValueEnum<'ctx>> {
where
D: Dependency + Clone,
{
Ok(context Ok(context
.builder() .builder()
.build_xor(operand_1, operand_2, "xor_result")? .build_xor(operand_1, operand_2, "xor_result")?
@@ -36,14 +32,11 @@ where
} }
/// Translates the bitwise AND. /// Translates the bitwise AND.
pub fn and<'ctx, D>( pub fn and<'ctx>(
context: &mut Context<'ctx, D>, context: &mut Context<'ctx>,
operand_1: inkwell::values::IntValue<'ctx>, operand_1: inkwell::values::IntValue<'ctx>,
operand_2: inkwell::values::IntValue<'ctx>, operand_2: inkwell::values::IntValue<'ctx>,
) -> anyhow::Result<inkwell::values::BasicValueEnum<'ctx>> ) -> anyhow::Result<inkwell::values::BasicValueEnum<'ctx>> {
where
D: Dependency + Clone,
{
Ok(context Ok(context
.builder() .builder()
.build_and(operand_1, operand_2, "and_result")? .build_and(operand_1, operand_2, "and_result")?
@@ -51,14 +44,11 @@ where
} }
/// Translates the bitwise shift left. /// Translates the bitwise shift left.
pub fn shift_left<'ctx, D>( pub fn shift_left<'ctx>(
context: &mut Context<'ctx, D>, context: &mut Context<'ctx>,
shift: inkwell::values::IntValue<'ctx>, shift: inkwell::values::IntValue<'ctx>,
value: inkwell::values::IntValue<'ctx>, value: inkwell::values::IntValue<'ctx>,
) -> anyhow::Result<inkwell::values::BasicValueEnum<'ctx>> ) -> anyhow::Result<inkwell::values::BasicValueEnum<'ctx>> {
where
D: Dependency + Clone,
{
let overflow_block = context.append_basic_block("shift_left_overflow"); let overflow_block = context.append_basic_block("shift_left_overflow");
let non_overflow_block = context.append_basic_block("shift_left_non_overflow"); let non_overflow_block = context.append_basic_block("shift_left_non_overflow");
let join_block = context.append_basic_block("shift_left_join"); let join_block = context.append_basic_block("shift_left_join");
@@ -66,7 +56,7 @@ where
let condition_is_overflow = context.builder().build_int_compare( let condition_is_overflow = context.builder().build_int_compare(
inkwell::IntPredicate::UGT, inkwell::IntPredicate::UGT,
shift, shift,
context.word_const((revive_common::BIT_LENGTH_WORD - 1) as u64), context.word_const((BIT_LENGTH_WORD - 1) as u64),
"shift_left_is_overflow", "shift_left_is_overflow",
)?; )?;
context.build_conditional_branch(condition_is_overflow, overflow_block, non_overflow_block)?; context.build_conditional_branch(condition_is_overflow, overflow_block, non_overflow_block)?;
@@ -93,14 +83,11 @@ where
} }
/// Translates the bitwise shift right. /// Translates the bitwise shift right.
pub fn shift_right<'ctx, D>( pub fn shift_right<'ctx>(
context: &mut Context<'ctx, D>, context: &mut Context<'ctx>,
shift: inkwell::values::IntValue<'ctx>, shift: inkwell::values::IntValue<'ctx>,
value: inkwell::values::IntValue<'ctx>, value: inkwell::values::IntValue<'ctx>,
) -> anyhow::Result<inkwell::values::BasicValueEnum<'ctx>> ) -> anyhow::Result<inkwell::values::BasicValueEnum<'ctx>> {
where
D: Dependency + Clone,
{
let overflow_block = context.append_basic_block("shift_right_overflow"); let overflow_block = context.append_basic_block("shift_right_overflow");
let non_overflow_block = context.append_basic_block("shift_right_non_overflow"); let non_overflow_block = context.append_basic_block("shift_right_non_overflow");
let join_block = context.append_basic_block("shift_right_join"); let join_block = context.append_basic_block("shift_right_join");
@@ -108,7 +95,7 @@ where
let condition_is_overflow = context.builder().build_int_compare( let condition_is_overflow = context.builder().build_int_compare(
inkwell::IntPredicate::UGT, inkwell::IntPredicate::UGT,
shift, shift,
context.word_const((revive_common::BIT_LENGTH_WORD - 1) as u64), context.word_const((BIT_LENGTH_WORD - 1) as u64),
"shift_right_is_overflow", "shift_right_is_overflow",
)?; )?;
context.build_conditional_branch(condition_is_overflow, overflow_block, non_overflow_block)?; context.build_conditional_branch(condition_is_overflow, overflow_block, non_overflow_block)?;
@@ -137,14 +124,11 @@ where
} }
/// Translates the arithmetic bitwise shift right. /// Translates the arithmetic bitwise shift right.
pub fn shift_right_arithmetic<'ctx, D>( pub fn shift_right_arithmetic<'ctx>(
context: &mut Context<'ctx, D>, context: &mut Context<'ctx>,
shift: inkwell::values::IntValue<'ctx>, shift: inkwell::values::IntValue<'ctx>,
value: inkwell::values::IntValue<'ctx>, value: inkwell::values::IntValue<'ctx>,
) -> anyhow::Result<inkwell::values::BasicValueEnum<'ctx>> ) -> anyhow::Result<inkwell::values::BasicValueEnum<'ctx>> {
where
D: Dependency + Clone,
{
let overflow_block = context.append_basic_block("shift_right_arithmetic_overflow"); let overflow_block = context.append_basic_block("shift_right_arithmetic_overflow");
let overflow_positive_block = let overflow_positive_block =
context.append_basic_block("shift_right_arithmetic_overflow_positive"); context.append_basic_block("shift_right_arithmetic_overflow_positive");
@@ -156,7 +140,7 @@ where
let condition_is_overflow = context.builder().build_int_compare( let condition_is_overflow = context.builder().build_int_compare(
inkwell::IntPredicate::UGT, inkwell::IntPredicate::UGT,
shift, shift,
context.word_const((revive_common::BIT_LENGTH_WORD - 1) as u64), context.word_const((BIT_LENGTH_WORD - 1) as u64),
"shift_right_arithmetic_is_overflow", "shift_right_arithmetic_is_overflow",
)?; )?;
context.build_conditional_branch(condition_is_overflow, overflow_block, non_overflow_block)?; context.build_conditional_branch(condition_is_overflow, overflow_block, non_overflow_block)?;
@@ -164,7 +148,7 @@ where
context.set_basic_block(overflow_block); context.set_basic_block(overflow_block);
let sign_bit = context.builder().build_right_shift( let sign_bit = context.builder().build_right_shift(
value, value,
context.word_const((revive_common::BIT_LENGTH_WORD - 1) as u64), context.word_const((BIT_LENGTH_WORD - 1) as u64),
false, false,
"shift_right_arithmetic_sign_bit", "shift_right_arithmetic_sign_bit",
)?; )?;
@@ -217,14 +201,11 @@ where
/// Because this opcode returns zero on overflows, the index `operand_1` /// Because this opcode returns zero on overflows, the index `operand_1`
/// is checked for overflow. On overflow, the mask will be all zeros, /// is checked for overflow. On overflow, the mask will be all zeros,
/// resulting in a branchless implementation. /// resulting in a branchless implementation.
pub fn byte<'ctx, D>( pub fn byte<'ctx>(
context: &mut Context<'ctx, D>, context: &mut Context<'ctx>,
operand_1: inkwell::values::IntValue<'ctx>, operand_1: inkwell::values::IntValue<'ctx>,
operand_2: inkwell::values::IntValue<'ctx>, operand_2: inkwell::values::IntValue<'ctx>,
) -> anyhow::Result<inkwell::values::BasicValueEnum<'ctx>> ) -> anyhow::Result<inkwell::values::BasicValueEnum<'ctx>> {
where
D: Dependency + Clone,
{
const MAX_INDEX_BYTES: u64 = 31; const MAX_INDEX_BYTES: u64 = 31;
let is_overflow_bit = context.builder().build_int_compare( let is_overflow_bit = context.builder().build_int_compare(
@@ -254,16 +235,13 @@ where
.build_int_truncate(operand_1, context.byte_type(), "index_truncated")?; .build_int_truncate(operand_1, context.byte_type(), "index_truncated")?;
let index_in_bits = context.builder().build_int_mul( let index_in_bits = context.builder().build_int_mul(
index_truncated, index_truncated,
context context.byte_type().const_int(BIT_LENGTH_BYTE as u64, false),
.byte_type()
.const_int(revive_common::BIT_LENGTH_BYTE as u64, false),
"index_in_bits", "index_in_bits",
)?; )?;
let index_from_most_significant_bit = context.builder().build_int_sub( let index_from_most_significant_bit = context.builder().build_int_sub(
context.byte_type().const_int( context
MAX_INDEX_BYTES * revive_common::BIT_LENGTH_BYTE as u64, .byte_type()
false, .const_int(MAX_INDEX_BYTES * BIT_LENGTH_BYTE as u64, false),
),
index_in_bits, index_in_bits,
"index_from_msb", "index_from_msb",
)?; )?;
+21 -39
View File
@@ -2,18 +2,15 @@
use inkwell::values::BasicValue; use inkwell::values::BasicValue;
use crate::polkavm::context::argument::Argument;
use crate::polkavm::context::Context; use crate::polkavm::context::Context;
use crate::polkavm::Dependency;
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; const SOLIDITY_TRANSFER_GAS_STIPEND_THRESHOLD: u64 = 2300;
/// Translates a contract call. /// Translates a contract call.
#[allow(clippy::too_many_arguments)] pub fn call<'ctx>(
pub fn call<'ctx, D>( context: &mut Context<'ctx>,
context: &mut Context<'ctx, D>,
gas: inkwell::values::IntValue<'ctx>, gas: inkwell::values::IntValue<'ctx>,
address: inkwell::values::IntValue<'ctx>, address: inkwell::values::IntValue<'ctx>,
value: Option<inkwell::values::IntValue<'ctx>>, value: Option<inkwell::values::IntValue<'ctx>>,
@@ -23,10 +20,7 @@ pub fn call<'ctx, D>(
output_length: inkwell::values::IntValue<'ctx>, output_length: inkwell::values::IntValue<'ctx>,
_constants: Vec<Option<num::BigUint>>, _constants: Vec<Option<num::BigUint>>,
static_call: bool, static_call: bool,
) -> anyhow::Result<inkwell::values::BasicValueEnum<'ctx>> ) -> anyhow::Result<inkwell::values::BasicValueEnum<'ctx>> {
where
D: Dependency + Clone,
{
let address_pointer = context.build_address_argument_store(address)?; let address_pointer = context.build_address_argument_store(address)?;
let value = value.unwrap_or_else(|| context.word_const(0)); let value = value.unwrap_or_else(|| context.word_const(0));
@@ -105,7 +99,7 @@ where
let is_success = context.builder().build_int_compare( let is_success = context.builder().build_int_compare(
inkwell::IntPredicate::EQ, inkwell::IntPredicate::EQ,
success, success,
context.integer_const(revive_common::BIT_LENGTH_X64, 0), context.integer_const(revive_common::BIT_LENGTH_X32, 0),
"is_success", "is_success",
)?; )?;
@@ -115,9 +109,8 @@ where
.as_basic_value_enum()) .as_basic_value_enum())
} }
#[allow(clippy::too_many_arguments)] pub fn delegate_call<'ctx>(
pub fn delegate_call<'ctx, D>( context: &mut Context<'ctx>,
context: &mut Context<'ctx, D>,
_gas: inkwell::values::IntValue<'ctx>, _gas: inkwell::values::IntValue<'ctx>,
address: inkwell::values::IntValue<'ctx>, address: inkwell::values::IntValue<'ctx>,
input_offset: inkwell::values::IntValue<'ctx>, input_offset: inkwell::values::IntValue<'ctx>,
@@ -125,10 +118,7 @@ pub fn delegate_call<'ctx, D>(
output_offset: inkwell::values::IntValue<'ctx>, output_offset: inkwell::values::IntValue<'ctx>,
output_length: inkwell::values::IntValue<'ctx>, output_length: inkwell::values::IntValue<'ctx>,
_constants: Vec<Option<num::BigUint>>, _constants: Vec<Option<num::BigUint>>,
) -> anyhow::Result<inkwell::values::BasicValueEnum<'ctx>> ) -> anyhow::Result<inkwell::values::BasicValueEnum<'ctx>> {
where
D: Dependency + Clone,
{
let address_pointer = context.build_address_argument_store(address)?; let address_pointer = context.build_address_argument_store(address)?;
let input_offset = context.safe_truncate_int_to_xlen(input_offset)?; let input_offset = context.safe_truncate_int_to_xlen(input_offset)?;
@@ -188,7 +178,7 @@ where
let is_success = context.builder().build_int_compare( let is_success = context.builder().build_int_compare(
inkwell::IntPredicate::EQ, inkwell::IntPredicate::EQ,
success, success,
context.integer_const(revive_common::BIT_LENGTH_X64, 0), context.integer_const(revive_common::BIT_LENGTH_X32, 0),
"is_success", "is_success",
)?; )?;
@@ -199,21 +189,16 @@ where
} }
/// Translates the Yul `linkersymbol` instruction. /// Translates the Yul `linkersymbol` instruction.
pub fn linker_symbol<'ctx, D>( pub fn linker_symbol<'ctx>(
context: &mut Context<'ctx, D>, context: &mut Context<'ctx>,
mut arguments: [Argument<'ctx>; 1], path: &str,
) -> anyhow::Result<inkwell::values::BasicValueEnum<'ctx>> ) -> anyhow::Result<inkwell::values::BasicValueEnum<'ctx>> {
where context.declare_global(
D: Dependency + Clone, path,
{ context.integer_type(revive_common::BIT_LENGTH_ETH_ADDRESS),
let path = arguments[0] Default::default(),
.original );
.take() context.build_load_address(context.get_global(path)?.into())
.ok_or_else(|| anyhow::anyhow!("Linker symbol literal is missing"))?;
Ok(context
.resolve_library(path.as_str())?
.as_basic_value_enum())
} }
/// The Solidity `address.transfer` and `address.send` call detection heuristic. /// The Solidity `address.transfer` and `address.send` call detection heuristic.
@@ -236,18 +221,15 @@ where
/// ///
/// # Returns /// # Returns
/// The call flags xlen `IntValue` and the deposit limit word `IntValue`. /// The call flags xlen `IntValue` and the deposit limit word `IntValue`.
fn call_reentrancy_heuristic<'ctx, D>( fn call_reentrancy_heuristic<'ctx>(
context: &mut Context<'ctx, D>, context: &mut Context<'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<( ) -> anyhow::Result<(
inkwell::values::IntValue<'ctx>, inkwell::values::IntValue<'ctx>,
inkwell::values::IntValue<'ctx>, inkwell::values::IntValue<'ctx>,
)> )> {
where
D: Dependency + Clone,
{
// Branch-free SSA implementation: First derive the heuristic boolean (int1) value. // Branch-free SSA implementation: First derive the heuristic boolean (int1) value.
let input_length_or_output_length = let input_length_or_output_length =
context context
@@ -1,16 +1,12 @@
//! Translates the calldata instructions. //! Translates the calldata instructions.
use crate::polkavm::context::Context; use crate::polkavm::context::Context;
use crate::polkavm::Dependency;
/// Translates the calldata load. /// Translates the calldata load.
pub fn load<'ctx, D>( pub fn load<'ctx>(
context: &mut Context<'ctx, D>, context: &mut Context<'ctx>,
offset: inkwell::values::IntValue<'ctx>, offset: inkwell::values::IntValue<'ctx>,
) -> anyhow::Result<inkwell::values::BasicValueEnum<'ctx>> ) -> anyhow::Result<inkwell::values::BasicValueEnum<'ctx>> {
where
D: Dependency + Clone,
{
let output_pointer = context.build_alloca_at_entry(context.word_type(), "call_data_output"); let output_pointer = context.build_alloca_at_entry(context.word_type(), "call_data_output");
let offset = context.safe_truncate_int_to_xlen(offset)?; let offset = context.safe_truncate_int_to_xlen(offset)?;
@@ -23,12 +19,9 @@ where
} }
/// Translates the calldata size. /// Translates the calldata size.
pub fn size<'ctx, D>( pub fn size<'ctx>(
context: &mut Context<'ctx, D>, context: &mut Context<'ctx>,
) -> anyhow::Result<inkwell::values::BasicValueEnum<'ctx>> ) -> anyhow::Result<inkwell::values::BasicValueEnum<'ctx>> {
where
D: Dependency + Clone,
{
let value = context.get_global_value(crate::polkavm::GLOBAL_CALLDATA_SIZE)?; let value = context.get_global_value(crate::polkavm::GLOBAL_CALLDATA_SIZE)?;
Ok(context Ok(context
.builder() .builder()
@@ -41,15 +34,12 @@ where
} }
/// Translates the calldata copy. /// Translates the calldata copy.
pub fn copy<'ctx, D>( pub fn copy<'ctx>(
context: &mut Context<'ctx, D>, context: &mut Context<'ctx>,
destination_offset: inkwell::values::IntValue<'ctx>, destination_offset: inkwell::values::IntValue<'ctx>,
source_offset: inkwell::values::IntValue<'ctx>, source_offset: inkwell::values::IntValue<'ctx>,
size: inkwell::values::IntValue<'ctx>, size: inkwell::values::IntValue<'ctx>,
) -> anyhow::Result<()> ) -> anyhow::Result<()> {
where
D: Dependency + Clone,
{
let source_offset = context.safe_truncate_int_to_xlen(source_offset)?; let source_offset = context.safe_truncate_int_to_xlen(source_offset)?;
let size = context.safe_truncate_int_to_xlen(size)?; let size = context.safe_truncate_int_to_xlen(size)?;
let destination_offset = context.safe_truncate_int_to_xlen(destination_offset)?; let destination_offset = context.safe_truncate_int_to_xlen(destination_offset)?;
@@ -3,19 +3,15 @@
use inkwell::values::BasicValue; use inkwell::values::BasicValue;
use crate::polkavm::context::Context; use crate::polkavm::context::Context;
use crate::polkavm::Dependency;
/// Translates the comparison operations. /// Translates the comparison operations.
/// There is not difference between the EVM and LLVM IR behaviors. /// There is not difference between the EVM and LLVM IR behaviors.
pub fn compare<'ctx, D>( pub fn compare<'ctx>(
context: &mut Context<'ctx, D>, context: &mut Context<'ctx>,
operand_1: inkwell::values::IntValue<'ctx>, operand_1: inkwell::values::IntValue<'ctx>,
operand_2: inkwell::values::IntValue<'ctx>, operand_2: inkwell::values::IntValue<'ctx>,
operation: inkwell::IntPredicate, operation: inkwell::IntPredicate,
) -> anyhow::Result<inkwell::values::BasicValueEnum<'ctx>> ) -> anyhow::Result<inkwell::values::BasicValueEnum<'ctx>> {
where
D: Dependency + Clone,
{
let result = context.builder().build_int_compare( let result = context.builder().build_int_compare(
operation, operation,
operand_1, operand_1,
+39 -74
View File
@@ -2,17 +2,15 @@
use inkwell::values::BasicValue; use inkwell::values::BasicValue;
use revive_common::BIT_LENGTH_ETH_ADDRESS;
use crate::polkavm::context::pointer::Pointer; use crate::polkavm::context::pointer::Pointer;
use crate::polkavm::context::Context; use crate::polkavm::context::Context;
use crate::polkavm::Dependency;
/// Translates the `gas_limit` instruction. /// Translates the `gas_limit` instruction.
pub fn gas_limit<'ctx, D>( pub fn gas_limit<'ctx>(
context: &mut Context<'ctx, D>, context: &mut Context<'ctx>,
) -> anyhow::Result<inkwell::values::BasicValueEnum<'ctx>> ) -> anyhow::Result<inkwell::values::BasicValueEnum<'ctx>> {
where
D: Dependency + Clone,
{
let gas_limit_value = context let gas_limit_value = context
.build_runtime_call(revive_runtime_api::polkavm_imports::GAS_LIMIT, &[]) .build_runtime_call(revive_runtime_api::polkavm_imports::GAS_LIMIT, &[])
.expect("the gas_limit syscall method should return a value") .expect("the gas_limit syscall method should return a value")
@@ -25,12 +23,9 @@ where
} }
/// Translates the `gas_price` instruction. /// Translates the `gas_price` instruction.
pub fn gas_price<'ctx, D>( pub fn gas_price<'ctx>(
context: &mut Context<'ctx, D>, context: &mut Context<'ctx>,
) -> anyhow::Result<inkwell::values::BasicValueEnum<'ctx>> ) -> anyhow::Result<inkwell::values::BasicValueEnum<'ctx>> {
where
D: Dependency + Clone,
{
let gas_price_value = context let gas_price_value = context
.build_runtime_call(revive_runtime_api::polkavm_imports::GAS_PRICE, &[]) .build_runtime_call(revive_runtime_api::polkavm_imports::GAS_PRICE, &[])
.expect("the gas_price syscall method should return a value") .expect("the gas_price syscall method should return a value")
@@ -43,13 +38,10 @@ where
} }
/// Translates the `tx.origin` instruction. /// Translates the `tx.origin` instruction.
pub fn origin<'ctx, D>( pub fn origin<'ctx>(
context: &mut Context<'ctx, D>, context: &mut Context<'ctx>,
) -> anyhow::Result<inkwell::values::BasicValueEnum<'ctx>> ) -> anyhow::Result<inkwell::values::BasicValueEnum<'ctx>> {
where let address_type = context.integer_type(BIT_LENGTH_ETH_ADDRESS);
D: Dependency + Clone,
{
let address_type = context.integer_type(revive_common::BIT_LENGTH_ETH_ADDRESS);
let address_pointer: Pointer<'_> = context let address_pointer: Pointer<'_> = context
.get_global(crate::polkavm::GLOBAL_ADDRESS_SPILL_BUFFER)? .get_global(crate::polkavm::GLOBAL_ADDRESS_SPILL_BUFFER)?
.into(); .into();
@@ -62,43 +54,31 @@ where
} }
/// Translates the `chain_id` instruction. /// Translates the `chain_id` instruction.
pub fn chain_id<'ctx, D>( pub fn chain_id<'ctx>(
context: &mut Context<'ctx, D>, context: &mut Context<'ctx>,
) -> anyhow::Result<inkwell::values::BasicValueEnum<'ctx>> ) -> anyhow::Result<inkwell::values::BasicValueEnum<'ctx>> {
where
D: Dependency + Clone,
{
context.build_runtime_call_to_getter(revive_runtime_api::polkavm_imports::CHAIN_ID) context.build_runtime_call_to_getter(revive_runtime_api::polkavm_imports::CHAIN_ID)
} }
/// Translates the `block_number` instruction. /// Translates the `block_number` instruction.
pub fn block_number<'ctx, D>( pub fn block_number<'ctx>(
context: &mut Context<'ctx, D>, context: &mut Context<'ctx>,
) -> anyhow::Result<inkwell::values::BasicValueEnum<'ctx>> ) -> anyhow::Result<inkwell::values::BasicValueEnum<'ctx>> {
where
D: Dependency + Clone,
{
context.build_runtime_call_to_getter(revive_runtime_api::polkavm_imports::BLOCK_NUMBER) context.build_runtime_call_to_getter(revive_runtime_api::polkavm_imports::BLOCK_NUMBER)
} }
/// Translates the `block_timestamp` instruction. /// Translates the `block_timestamp` instruction.
pub fn block_timestamp<'ctx, D>( pub fn block_timestamp<'ctx>(
context: &mut Context<'ctx, D>, context: &mut Context<'ctx>,
) -> anyhow::Result<inkwell::values::BasicValueEnum<'ctx>> ) -> anyhow::Result<inkwell::values::BasicValueEnum<'ctx>> {
where
D: Dependency + Clone,
{
context.build_runtime_call_to_getter(revive_runtime_api::polkavm_imports::NOW) context.build_runtime_call_to_getter(revive_runtime_api::polkavm_imports::NOW)
} }
/// Translates the `block_hash` instruction. /// Translates the `block_hash` instruction.
pub fn block_hash<'ctx, D>( pub fn block_hash<'ctx>(
context: &mut Context<'ctx, D>, context: &mut Context<'ctx>,
index: inkwell::values::IntValue<'ctx>, index: inkwell::values::IntValue<'ctx>,
) -> anyhow::Result<inkwell::values::BasicValueEnum<'ctx>> ) -> anyhow::Result<inkwell::values::BasicValueEnum<'ctx>> {
where
D: Dependency + Clone,
{
let output_pointer = context.build_alloca_at_entry(context.word_type(), "blockhash_out_ptr"); let output_pointer = context.build_alloca_at_entry(context.word_type(), "blockhash_out_ptr");
let index_pointer = context.build_alloca_at_entry(context.word_type(), "blockhash_index_ptr"); let index_pointer = context.build_alloca_at_entry(context.word_type(), "blockhash_index_ptr");
context.build_store(index_pointer, index)?; context.build_store(index_pointer, index)?;
@@ -114,22 +94,16 @@ where
} }
/// Translates the `difficulty` instruction. /// Translates the `difficulty` instruction.
pub fn difficulty<'ctx, D>( pub fn difficulty<'ctx>(
context: &mut Context<'ctx, D>, context: &mut Context<'ctx>,
) -> anyhow::Result<inkwell::values::BasicValueEnum<'ctx>> ) -> anyhow::Result<inkwell::values::BasicValueEnum<'ctx>> {
where
D: Dependency + Clone,
{
Ok(context.word_const(2500000000000000).as_basic_value_enum()) Ok(context.word_const(2500000000000000).as_basic_value_enum())
} }
/// Translates the `coinbase` instruction. /// Translates the `coinbase` instruction.
pub fn coinbase<'ctx, D>( pub fn coinbase<'ctx>(
context: &mut Context<'ctx, D>, context: &mut Context<'ctx>,
) -> anyhow::Result<inkwell::values::BasicValueEnum<'ctx>> ) -> anyhow::Result<inkwell::values::BasicValueEnum<'ctx>> {
where
D: Dependency + Clone,
{
let pointer: Pointer<'_> = context let pointer: Pointer<'_> = context
.get_global(crate::polkavm::GLOBAL_ADDRESS_SPILL_BUFFER)? .get_global(crate::polkavm::GLOBAL_ADDRESS_SPILL_BUFFER)?
.into(); .into();
@@ -141,22 +115,16 @@ where
} }
/// Translates the `basefee` instruction. /// Translates the `basefee` instruction.
pub fn basefee<'ctx, D>( pub fn basefee<'ctx>(
context: &mut Context<'ctx, D>, context: &mut Context<'ctx>,
) -> anyhow::Result<inkwell::values::BasicValueEnum<'ctx>> ) -> anyhow::Result<inkwell::values::BasicValueEnum<'ctx>> {
where
D: Dependency + Clone,
{
context.build_runtime_call_to_getter(revive_runtime_api::polkavm_imports::BASE_FEE) context.build_runtime_call_to_getter(revive_runtime_api::polkavm_imports::BASE_FEE)
} }
/// Translates the `address` instruction. /// Translates the `address` instruction.
pub fn address<'ctx, D>( pub fn address<'ctx>(
context: &mut Context<'ctx, D>, context: &mut Context<'ctx>,
) -> anyhow::Result<inkwell::values::BasicValueEnum<'ctx>> ) -> anyhow::Result<inkwell::values::BasicValueEnum<'ctx>> {
where
D: Dependency + Clone,
{
let pointer: Pointer<'_> = context let pointer: Pointer<'_> = context
.get_global(crate::polkavm::GLOBAL_ADDRESS_SPILL_BUFFER)? .get_global(crate::polkavm::GLOBAL_ADDRESS_SPILL_BUFFER)?
.into(); .into();
@@ -168,12 +136,9 @@ where
} }
/// Translates the `caller` instruction. /// Translates the `caller` instruction.
pub fn caller<'ctx, D>( pub fn caller<'ctx>(
context: &mut Context<'ctx, D>, context: &mut Context<'ctx>,
) -> anyhow::Result<inkwell::values::BasicValueEnum<'ctx>> ) -> anyhow::Result<inkwell::values::BasicValueEnum<'ctx>> {
where
D: Dependency + Clone,
{
let pointer: Pointer<'_> = context let pointer: Pointer<'_> = context
.get_global(crate::polkavm::GLOBAL_ADDRESS_SPILL_BUFFER)? .get_global(crate::polkavm::GLOBAL_ADDRESS_SPILL_BUFFER)?
.into(); .into();
+54 -50
View File
@@ -3,24 +3,22 @@
use inkwell::values::BasicValue; use inkwell::values::BasicValue;
use num::Zero; use num::Zero;
use revive_common::BIT_LENGTH_ETH_ADDRESS;
use crate::polkavm::context::argument::Argument; use crate::polkavm::context::argument::Argument;
use crate::polkavm::context::code_type::CodeType; use crate::polkavm::context::code_type::CodeType;
use crate::polkavm::context::Context; use crate::polkavm::context::Context;
use crate::polkavm::Dependency;
/// Translates the contract `create` and `create2` instruction. /// Translates the contract `create` and `create2` instruction.
/// ///
/// A `salt` value of `None` is equivalent to `create1`. /// A `salt` value of `None` is equivalent to `create1`.
pub fn create<'ctx, D>( pub fn create<'ctx>(
context: &mut Context<'ctx, D>, context: &mut Context<'ctx>,
value: inkwell::values::IntValue<'ctx>, value: inkwell::values::IntValue<'ctx>,
input_offset: inkwell::values::IntValue<'ctx>, input_offset: inkwell::values::IntValue<'ctx>,
input_length: inkwell::values::IntValue<'ctx>, input_length: inkwell::values::IntValue<'ctx>,
salt: Option<inkwell::values::IntValue<'ctx>>, salt: Option<inkwell::values::IntValue<'ctx>>,
) -> anyhow::Result<inkwell::values::BasicValueEnum<'ctx>> ) -> anyhow::Result<inkwell::values::BasicValueEnum<'ctx>> {
where
D: Dependency + Clone,
{
let input_offset = context.safe_truncate_int_to_xlen(input_offset)?; let input_offset = context.safe_truncate_int_to_xlen(input_offset)?;
let input_length = context.safe_truncate_int_to_xlen(input_length)?; let input_length = context.safe_truncate_int_to_xlen(input_length)?;
@@ -40,7 +38,7 @@ where
}; };
let address_pointer = context.build_alloca_at_entry( let address_pointer = context.build_alloca_at_entry(
context.integer_type(revive_common::BIT_LENGTH_ETH_ADDRESS), context.integer_type(BIT_LENGTH_ETH_ADDRESS),
"address_pointer", "address_pointer",
); );
context.build_store(address_pointer, context.word_const(0))?; context.build_store(address_pointer, context.word_const(0))?;
@@ -96,77 +94,83 @@ where
/// Translates the contract hash instruction, which is actually used to set the hash of the contract /// Translates the contract hash instruction, which is actually used to set the hash of the contract
/// being created, or other related auxiliary data. /// being created, or other related auxiliary data.
/// Represents `dataoffset` in Yul and `PUSH [$]` in the EVM legacy assembly. /// Represents `dataoffset` in Yul and `PUSH [$]` in the EVM legacy assembly.
pub fn contract_hash<'ctx, D>( pub fn contract_hash<'ctx>(
context: &mut Context<'ctx, D>, context: &mut Context<'ctx>,
identifier: String, identifier: String,
) -> anyhow::Result<Argument<'ctx>> ) -> anyhow::Result<Argument<'ctx>> {
where
D: Dependency + Clone,
{
let code_type = context let code_type = context
.code_type() .code_type()
.ok_or_else(|| anyhow::anyhow!("The contract code part type is undefined"))?; .ok_or_else(|| anyhow::anyhow!("The contract code part type is undefined"))?;
let parent = context.module().get_name().to_str().expect("Always valid"); let parent = context.module().get_name().to_str().expect("Always valid");
let contract_path = let full_path = match context.yul() {
context Some(yul_data) => yul_data
.resolve_path(identifier.as_str()) .resolve_path(
.map_err(|error| match code_type { identifier
CodeType::Runtime if identifier.ends_with("_deployed") => { .strip_suffix("_deployed")
anyhow::anyhow!("type({}).runtimeCode is not supported", identifier) .unwrap_or(identifier.as_str()),
} )
_ => error, .expect("Always exists")
})?; .to_owned(),
if contract_path.as_str() == parent { None => identifier.clone(),
};
match code_type {
CodeType::Deploy if full_path == parent => {
return Ok(Argument::value(context.word_const(0).as_basic_value_enum()) return Ok(Argument::value(context.word_const(0).as_basic_value_enum())
.with_constant(num::BigUint::zero())); .with_constant(num::BigUint::zero()));
} else if identifier.ends_with("_deployed") && code_type == CodeType::Runtime { }
anyhow::bail!("type({}).runtimeCode is not supported", identifier); CodeType::Runtime if context.yul().is_some() && identifier.ends_with("_deployed") => {
anyhow::bail!("type({identifier}).runtimeCode is not supported");
}
_ => {}
} }
let hash_string = context.compile_dependency(identifier.as_str())?; context.declare_global(&full_path, context.word_type(), Default::default());
let hash_value = context context
.word_const_str_hex(hash_string.as_str()) .build_load(context.get_global(&full_path)?.into(), &full_path)
.as_basic_value_enum(); .map(Argument::value)
Ok(Argument::value(hash_value).with_original(hash_string))
} }
/// Translates the deploy call header size instruction. the header consists of /// Translates the deploy call header size instruction. the header consists of
/// the hash of the bytecode of the contract whose instance is being created. /// the hash of the bytecode of the contract whose instance is being created.
/// Represents `datasize` in Yul and `PUSH #[$]` in the EVM legacy assembly. /// Represents `datasize` in Yul and `PUSH #[$]` in the EVM legacy assembly.
pub fn header_size<'ctx, D>( pub fn header_size<'ctx>(
context: &mut Context<'ctx, D>, context: &mut Context<'ctx>,
identifier: String, identifier: String,
) -> anyhow::Result<Argument<'ctx>> ) -> anyhow::Result<Argument<'ctx>> {
where
D: Dependency + Clone,
{
let code_type = context let code_type = context
.code_type() .code_type()
.ok_or_else(|| anyhow::anyhow!("The contract code part type is undefined"))?; .ok_or_else(|| anyhow::anyhow!("The contract code part type is undefined"))?;
let parent = context.module().get_name().to_str().expect("Always valid"); let parent = context.module().get_name().to_str().expect("Always valid");
let contract_path = let full_path = match context.yul() {
context Some(yul_data) => yul_data
.resolve_path(identifier.as_str()) .resolve_path(
.map_err(|error| match code_type { identifier
CodeType::Runtime if identifier.ends_with("_deployed") => { .strip_suffix("_deployed")
anyhow::anyhow!("type({}).runtimeCode is not supported", identifier) .unwrap_or(identifier.as_str()),
} )
_ => error, .unwrap_or_else(|| panic!("ICE: {identifier} not found {yul_data:?}")),
})?; None => identifier.as_str(),
if contract_path.as_str() == parent { };
match code_type {
CodeType::Deploy if full_path == parent => {
return Ok(Argument::value(context.word_const(0).as_basic_value_enum()) return Ok(Argument::value(context.word_const(0).as_basic_value_enum())
.with_constant(num::BigUint::zero())); .with_constant(num::BigUint::zero()));
} else if identifier.ends_with("_deployed") && code_type == CodeType::Runtime { }
anyhow::bail!("type({}).runtimeCode is not supported", identifier); CodeType::Runtime if context.yul().is_some() && identifier.ends_with("_deployed") => {
anyhow::bail!("type({identifier}).runtimeCode is not supported");
}
_ => {}
} }
let size_bigint = num::BigUint::from(crate::polkavm::DEPLOYER_CALL_HEADER_SIZE);
let size_value = context let size_value = context
.word_const(crate::polkavm::DEPLOYER_CALL_HEADER_SIZE as u64) .word_const(crate::polkavm::DEPLOYER_CALL_HEADER_SIZE as u64)
.as_basic_value_enum(); .as_basic_value_enum();
let size_bigint = num::BigUint::from(crate::polkavm::DEPLOYER_CALL_HEADER_SIZE);
Ok(Argument::value(size_value).with_constant(size_bigint)) Ok(Argument::value(size_value).with_constant(size_bigint))
} }
@@ -1,17 +1,13 @@
//! Translates the cryptographic operations. //! Translates the cryptographic operations.
use crate::polkavm::context::Context; use crate::polkavm::context::Context;
use crate::polkavm::Dependency;
/// Translates the `sha3` instruction. /// Translates the `sha3` instruction.
pub fn sha3<'ctx, D>( pub fn sha3<'ctx>(
context: &mut Context<'ctx, D>, context: &mut Context<'ctx>,
offset: inkwell::values::IntValue<'ctx>, offset: inkwell::values::IntValue<'ctx>,
length: inkwell::values::IntValue<'ctx>, length: inkwell::values::IntValue<'ctx>,
) -> anyhow::Result<inkwell::values::BasicValueEnum<'ctx>> ) -> anyhow::Result<inkwell::values::BasicValueEnum<'ctx>> {
where
D: Dependency + Clone,
{
let offset_casted = context.safe_truncate_int_to_xlen(offset)?; let offset_casted = context.safe_truncate_int_to_xlen(offset)?;
let length_casted = context.safe_truncate_int_to_xlen(length)?; let length_casted = context.safe_truncate_int_to_xlen(length)?;
let input_pointer = context.build_heap_gep(offset_casted, length_casted)?; let input_pointer = context.build_heap_gep(offset_casted, length_casted)?;
@@ -1,15 +1,11 @@
//! Translates the value and balance operations. //! Translates the value and balance operations.
use crate::polkavm::context::Context; use crate::polkavm::context::Context;
use crate::polkavm::Dependency;
/// Translates the `gas` instruction. /// Translates the `gas` instruction.
pub fn gas<'ctx, D>( pub fn gas<'ctx>(
context: &mut Context<'ctx, D>, context: &mut Context<'ctx>,
) -> anyhow::Result<inkwell::values::BasicValueEnum<'ctx>> ) -> anyhow::Result<inkwell::values::BasicValueEnum<'ctx>> {
where
D: Dependency + Clone,
{
let ref_time_left_value = context let ref_time_left_value = context
.build_runtime_call(revive_runtime_api::polkavm_imports::REF_TIME_LEFT, &[]) .build_runtime_call(revive_runtime_api::polkavm_imports::REF_TIME_LEFT, &[])
.expect("the ref_time_left syscall method should return a value") .expect("the ref_time_left syscall method should return a value")
@@ -22,12 +18,9 @@ where
} }
/// Translates the `value` instruction. /// Translates the `value` instruction.
pub fn value<'ctx, D>( pub fn value<'ctx>(
context: &mut Context<'ctx, D>, context: &mut Context<'ctx>,
) -> anyhow::Result<inkwell::values::BasicValueEnum<'ctx>> ) -> anyhow::Result<inkwell::values::BasicValueEnum<'ctx>> {
where
D: Dependency + Clone,
{
let output_pointer = context.build_alloca_at_entry(context.value_type(), "value_transferred"); let output_pointer = context.build_alloca_at_entry(context.value_type(), "value_transferred");
context.build_store(output_pointer, context.word_const(0))?; context.build_store(output_pointer, context.word_const(0))?;
context.build_runtime_call( context.build_runtime_call(
@@ -38,13 +31,10 @@ where
} }
/// Translates the `balance` instructions. /// Translates the `balance` instructions.
pub fn balance<'ctx, D>( pub fn balance<'ctx>(
context: &mut Context<'ctx, D>, context: &mut Context<'ctx>,
address: inkwell::values::IntValue<'ctx>, address: inkwell::values::IntValue<'ctx>,
) -> anyhow::Result<inkwell::values::BasicValueEnum<'ctx>> ) -> anyhow::Result<inkwell::values::BasicValueEnum<'ctx>> {
where
D: Dependency + Clone,
{
let address_pointer = context.build_address_argument_store(address)?; let address_pointer = context.build_address_argument_store(address)?;
let balance_pointer = context.build_alloca_at_entry(context.word_type(), "balance_pointer"); let balance_pointer = context.build_alloca_at_entry(context.word_type(), "balance_pointer");
let balance = context.builder().build_ptr_to_int( let balance = context.builder().build_ptr_to_int(
@@ -62,12 +52,9 @@ where
} }
/// Translates the `selfbalance` instructions. /// Translates the `selfbalance` instructions.
pub fn self_balance<'ctx, D>( pub fn self_balance<'ctx>(
context: &mut Context<'ctx, D>, context: &mut Context<'ctx>,
) -> anyhow::Result<inkwell::values::BasicValueEnum<'ctx>> ) -> anyhow::Result<inkwell::values::BasicValueEnum<'ctx>> {
where
D: Dependency + Clone,
{
let balance_pointer = context.build_alloca_at_entry(context.word_type(), "balance_pointer"); let balance_pointer = context.build_alloca_at_entry(context.word_type(), "balance_pointer");
let balance = context.builder().build_ptr_to_int( let balance = context.builder().build_ptr_to_int(
balance_pointer.value, balance_pointer.value,
+35 -56
View File
@@ -1,19 +1,16 @@
//! Translates a log or event call. //! Translates a log or event call.
use inkwell::values::BasicValue; use inkwell::values::BasicValue;
use revive_common::BYTE_LENGTH_WORD;
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::WriteLLVM; use crate::polkavm::WriteLLVM;
/// A function for emitting EVM event logs from contract code. /// A function for emitting EVM event logs from contract code.
pub struct EventLog<const N: usize>; pub struct EventLog<const N: usize>;
impl<D, const N: usize> RuntimeFunction<D> for EventLog<N> impl<const N: usize> RuntimeFunction for EventLog<N> {
where
D: Dependency + Clone,
{
const NAME: &'static str = match N { const NAME: &'static str = match N {
0 => "__revive_log_0", 0 => "__revive_log_0",
1 => "__revive_log_1", 1 => "__revive_log_1",
@@ -23,7 +20,7 @@ where
_ => unreachable!(), _ => unreachable!(),
}; };
fn r#type<'ctx>(context: &Context<'ctx, D>) -> inkwell::types::FunctionType<'ctx> { fn r#type<'ctx>(context: &Context<'ctx>) -> inkwell::types::FunctionType<'ctx> {
let mut parameter_types = vec![context.xlen_type().into(), context.xlen_type().into()]; let mut parameter_types = vec![context.xlen_type().into(), context.xlen_type().into()];
parameter_types.extend_from_slice(&[context.word_type().into(); N]); parameter_types.extend_from_slice(&[context.word_type().into(); N]);
context.void_type().fn_type(&parameter_types, false) context.void_type().fn_type(&parameter_types, false)
@@ -31,7 +28,7 @@ where
fn emit_body<'ctx>( fn emit_body<'ctx>(
&self, &self,
context: &mut Context<'ctx, D>, context: &mut Context<'ctx>,
) -> anyhow::Result<Option<inkwell::values::BasicValueEnum<'ctx>>> { ) -> anyhow::Result<Option<inkwell::values::BasicValueEnum<'ctx>>> {
let input_offset = Self::paramater(context, 0).into_int_value(); let input_offset = Self::paramater(context, 0).into_int_value();
let input_length = Self::paramater(context, 1).into_int_value(); let input_length = Self::paramater(context, 1).into_int_value();
@@ -49,7 +46,7 @@ where
input_length.as_basic_value_enum(), input_length.as_basic_value_enum(),
] ]
} else { } else {
let topics_buffer_size = N * revive_common::BYTE_LENGTH_WORD; let topics_buffer_size = N * BYTE_LENGTH_WORD;
let topics_buffer_pointer = context.build_alloca_at_entry( let topics_buffer_pointer = context.build_alloca_at_entry(
context.byte_type().array_type(topics_buffer_size as u32), context.byte_type().array_type(topics_buffer_size as u32),
"topics_buffer", "topics_buffer",
@@ -59,7 +56,7 @@ where
let topic = Self::paramater(context, n + 2); let topic = Self::paramater(context, n + 2);
let topic_buffer_offset = context let topic_buffer_offset = context
.xlen_type() .xlen_type()
.const_int((n * revive_common::BYTE_LENGTH_WORD) as u64, false); .const_int((n * BYTE_LENGTH_WORD) as u64, false);
context.build_store( context.build_store(
context.build_gep( context.build_gep(
topics_buffer_pointer, topics_buffer_pointer,
@@ -98,82 +95,64 @@ where
} }
} }
impl<D> WriteLLVM<D> for EventLog<0> impl WriteLLVM for EventLog<0> {
where fn declare(&mut self, context: &mut Context) -> anyhow::Result<()> {
D: Dependency + Clone, <Self as RuntimeFunction>::declare(self, context)
{
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<()> { fn into_llvm(self, context: &mut Context) -> anyhow::Result<()> {
<Self as RuntimeFunction<_>>::emit(&self, context) <Self as RuntimeFunction>::emit(&self, context)
} }
} }
impl<D> WriteLLVM<D> for EventLog<1> impl WriteLLVM for EventLog<1> {
where fn declare(&mut self, context: &mut Context) -> anyhow::Result<()> {
D: Dependency + Clone, <Self as RuntimeFunction>::declare(self, context)
{
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<()> { fn into_llvm(self, context: &mut Context) -> anyhow::Result<()> {
<Self as RuntimeFunction<_>>::emit(&self, context) <Self as RuntimeFunction>::emit(&self, context)
} }
} }
impl<D> WriteLLVM<D> for EventLog<2> impl WriteLLVM for EventLog<2> {
where fn declare(&mut self, context: &mut Context) -> anyhow::Result<()> {
D: Dependency + Clone, <Self as RuntimeFunction>::declare(self, context)
{
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<()> { fn into_llvm(self, context: &mut Context) -> anyhow::Result<()> {
<Self as RuntimeFunction<_>>::emit(&self, context) <Self as RuntimeFunction>::emit(&self, context)
} }
} }
impl<D> WriteLLVM<D> for EventLog<3> impl WriteLLVM for EventLog<3> {
where fn declare(&mut self, context: &mut Context) -> anyhow::Result<()> {
D: Dependency + Clone, <Self as RuntimeFunction>::declare(self, context)
{
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<()> { fn into_llvm(self, context: &mut Context) -> anyhow::Result<()> {
<Self as RuntimeFunction<_>>::emit(&self, context) <Self as RuntimeFunction>::emit(&self, context)
} }
} }
impl<D> WriteLLVM<D> for EventLog<4> impl WriteLLVM for EventLog<4> {
where fn declare(&mut self, context: &mut Context) -> anyhow::Result<()> {
D: Dependency + Clone, <Self as RuntimeFunction>::declare(self, context)
{
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<()> { fn into_llvm(self, context: &mut Context) -> anyhow::Result<()> {
<Self as RuntimeFunction<_>>::emit(&self, context) <Self as RuntimeFunction>::emit(&self, context)
} }
} }
/// Translates a log or event call. /// Translates a log or event call.
pub fn log<'ctx, D, const N: usize>( pub fn log<'ctx, const N: usize>(
context: &mut Context<'ctx, D>, context: &mut Context<'ctx>,
input_offset: inkwell::values::IntValue<'ctx>, input_offset: inkwell::values::IntValue<'ctx>,
input_length: inkwell::values::IntValue<'ctx>, input_length: inkwell::values::IntValue<'ctx>,
topics: [inkwell::values::BasicValueEnum<'ctx>; N], topics: [inkwell::values::BasicValueEnum<'ctx>; N],
) -> anyhow::Result<()> ) -> anyhow::Result<()> {
where let declaration = <EventLog<N> as RuntimeFunction>::declaration(context);
D: Dependency + Clone,
{
let declaration = <EventLog<N> as RuntimeFunction<D>>::declaration(context);
let mut arguments = vec![ let mut arguments = vec![
context.safe_truncate_int_to_xlen(input_offset)?.into(), context.safe_truncate_int_to_xlen(input_offset)?.into(),
context.safe_truncate_int_to_xlen(input_length)?.into(), context.safe_truncate_int_to_xlen(input_length)?.into(),
@@ -1,17 +1,15 @@
//! Translates the external code operations. //! Translates the external code operations.
use revive_common::BIT_LENGTH_ETH_ADDRESS;
use crate::polkavm::context::Context; use crate::polkavm::context::Context;
use crate::polkavm::Dependency;
/// Translates the `extcodesize` instruction if `address` is `Some`. /// Translates the `extcodesize` instruction if `address` is `Some`.
/// Otherwise, translates the `codesize` instruction. /// Otherwise, translates the `codesize` instruction.
pub fn size<'ctx, D>( pub fn size<'ctx>(
context: &mut Context<'ctx, D>, context: &mut Context<'ctx>,
address: Option<inkwell::values::IntValue<'ctx>>, address: Option<inkwell::values::IntValue<'ctx>>,
) -> anyhow::Result<inkwell::values::BasicValueEnum<'ctx>> ) -> anyhow::Result<inkwell::values::BasicValueEnum<'ctx>> {
where
D: Dependency + Clone,
{
let address = match address { let address = match address {
Some(address) => address, Some(address) => address,
None => super::context::address(context)?.into_int_value(), None => super::context::address(context)?.into_int_value(),
@@ -33,14 +31,11 @@ where
} }
/// Translates the `extcodehash` instruction. /// Translates the `extcodehash` instruction.
pub fn hash<'ctx, D>( pub fn hash<'ctx>(
context: &mut Context<'ctx, D>, context: &mut Context<'ctx>,
address: inkwell::values::IntValue<'ctx>, address: inkwell::values::IntValue<'ctx>,
) -> anyhow::Result<inkwell::values::BasicValueEnum<'ctx>> ) -> anyhow::Result<inkwell::values::BasicValueEnum<'ctx>> {
where let address_type = context.integer_type(BIT_LENGTH_ETH_ADDRESS);
D: Dependency + Clone,
{
let address_type = context.integer_type(revive_common::BIT_LENGTH_ETH_ADDRESS);
let address_pointer = context.build_alloca_at_entry(address_type, "address_pointer"); let address_pointer = context.build_alloca_at_entry(address_type, "address_pointer");
let address_truncated = let address_truncated =
context context
@@ -7,7 +7,6 @@ use crate::polkavm::context::code_type::CodeType;
use crate::polkavm::context::pointer::Pointer; use crate::polkavm::context::pointer::Pointer;
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::WriteLLVM; use crate::polkavm::WriteLLVM;
/// A function for requesting the immutable data from the runtime. /// A function for requesting the immutable data from the runtime.
@@ -20,19 +19,16 @@ use crate::polkavm::WriteLLVM;
/// However, this is a one time assertion, hence worth it. /// However, this is a one time assertion, hence worth it.
pub struct Load; pub struct Load;
impl<D> RuntimeFunction<D> for Load impl RuntimeFunction for Load {
where
D: Dependency + Clone,
{
const NAME: &'static str = "__revive_load_immutable_data"; const NAME: &'static str = "__revive_load_immutable_data";
fn r#type<'ctx>(context: &Context<'ctx, D>) -> inkwell::types::FunctionType<'ctx> { fn r#type<'ctx>(context: &Context<'ctx>) -> inkwell::types::FunctionType<'ctx> {
context.void_type().fn_type(Default::default(), false) context.void_type().fn_type(Default::default(), false)
} }
fn emit_body<'ctx>( fn emit_body<'ctx>(
&self, &self,
context: &mut Context<'ctx, D>, context: &mut Context<'ctx>,
) -> anyhow::Result<Option<inkwell::values::BasicValueEnum<'ctx>>> { ) -> anyhow::Result<Option<inkwell::values::BasicValueEnum<'ctx>>> {
let immutable_data_size_pointer = context let immutable_data_size_pointer = context
.get_global(revive_runtime_api::immutable_data::GLOBAL_IMMUTABLE_DATA_SIZE)? .get_global(revive_runtime_api::immutable_data::GLOBAL_IMMUTABLE_DATA_SIZE)?
@@ -109,35 +105,29 @@ where
} }
} }
impl<D> WriteLLVM<D> for Load impl WriteLLVM for Load {
where fn declare(&mut self, context: &mut Context) -> anyhow::Result<()> {
D: Dependency + Clone, <Self as RuntimeFunction>::declare(self, context)
{
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<()> { fn into_llvm(self, context: &mut Context) -> anyhow::Result<()> {
<Self as RuntimeFunction<_>>::emit(&self, context) <Self as RuntimeFunction>::emit(&self, context)
} }
} }
/// Store the immutable data from the constructor code. /// Store the immutable data from the constructor code.
pub struct Store; pub struct Store;
impl<D> RuntimeFunction<D> for Store impl RuntimeFunction for Store {
where
D: Dependency + Clone,
{
const NAME: &'static str = "__revive_store_immutable_data"; const NAME: &'static str = "__revive_store_immutable_data";
fn r#type<'ctx>(context: &Context<'ctx, D>) -> inkwell::types::FunctionType<'ctx> { fn r#type<'ctx>(context: &Context<'ctx>) -> inkwell::types::FunctionType<'ctx> {
context.void_type().fn_type(Default::default(), false) context.void_type().fn_type(Default::default(), false)
} }
fn emit_body<'ctx>( fn emit_body<'ctx>(
&self, &self,
context: &mut Context<'ctx, D>, context: &mut Context<'ctx>,
) -> anyhow::Result<Option<inkwell::values::BasicValueEnum<'ctx>>> { ) -> anyhow::Result<Option<inkwell::values::BasicValueEnum<'ctx>>> {
let immutable_data_size_pointer = context let immutable_data_size_pointer = context
.get_global(revive_runtime_api::immutable_data::GLOBAL_IMMUTABLE_DATA_SIZE)? .get_global(revive_runtime_api::immutable_data::GLOBAL_IMMUTABLE_DATA_SIZE)?
@@ -192,16 +182,13 @@ where
} }
} }
impl<D> WriteLLVM<D> for Store impl WriteLLVM for Store {
where fn declare(&mut self, context: &mut Context) -> anyhow::Result<()> {
D: Dependency + Clone, <Self as RuntimeFunction>::declare(self, context)
{
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<()> { fn into_llvm(self, context: &mut Context) -> anyhow::Result<()> {
<Self as RuntimeFunction<_>>::emit(&self, context) <Self as RuntimeFunction>::emit(&self, context)
} }
} }
@@ -210,23 +197,20 @@ where
/// In deploy code the values are read from the stack. /// In deploy code the values are read from the stack.
/// ///
/// In runtime code they are loaded lazily with the `get_immutable_data` syscall. /// In runtime code they are loaded lazily with the `get_immutable_data` syscall.
pub fn load<'ctx, D>( pub fn load<'ctx>(
context: &mut Context<'ctx, D>, context: &mut Context<'ctx>,
index: inkwell::values::IntValue<'ctx>, index: inkwell::values::IntValue<'ctx>,
) -> anyhow::Result<inkwell::values::BasicValueEnum<'ctx>> ) -> anyhow::Result<inkwell::values::BasicValueEnum<'ctx>> {
where
D: Dependency + Clone,
{
match context.code_type() { match context.code_type() {
None => { None => {
anyhow::bail!("Immutables are not available if the contract part is undefined"); anyhow::bail!("Immutables are not available if the contract part is undefined");
} }
Some(CodeType::Deploy) => load_from_memory(context, index), Some(CodeType::Deploy) => load_from_memory(context, index),
Some(CodeType::Runtime) => { Some(CodeType::Runtime) => {
let name = <Load as RuntimeFunction<D>>::NAME; let name = <Load as RuntimeFunction>::NAME;
context.build_call( context.build_call(
context context
.get_function(name) .get_function(name, false)
.expect("is always declared for runtime code") .expect("is always declared for runtime code")
.borrow() .borrow()
.declaration(), .declaration(),
@@ -244,14 +228,11 @@ where
/// being prepared for storing them using the `set_immutable_data` syscall. /// being prepared for storing them using the `set_immutable_data` syscall.
/// ///
/// Ignored in the runtime code. /// Ignored in the runtime code.
pub fn store<'ctx, D>( pub fn store<'ctx>(
context: &mut Context<'ctx, D>, context: &mut Context<'ctx>,
index: inkwell::values::IntValue<'ctx>, index: inkwell::values::IntValue<'ctx>,
value: inkwell::values::IntValue<'ctx>, value: inkwell::values::IntValue<'ctx>,
) -> anyhow::Result<()> ) -> anyhow::Result<()> {
where
D: Dependency + Clone,
{
match context.code_type() { match context.code_type() {
None => { None => {
anyhow::bail!("Immutables are not available if the contract part is undefined"); anyhow::bail!("Immutables are not available if the contract part is undefined");
@@ -279,13 +260,10 @@ where
} }
} }
pub fn load_from_memory<'ctx, D>( pub fn load_from_memory<'ctx>(
context: &mut Context<'ctx, D>, context: &mut Context<'ctx>,
index: inkwell::values::IntValue<'ctx>, index: inkwell::values::IntValue<'ctx>,
) -> anyhow::Result<inkwell::values::BasicValueEnum<'ctx>> ) -> anyhow::Result<inkwell::values::BasicValueEnum<'ctx>> {
where
D: Dependency + Clone,
{
let immutable_data_pointer = context let immutable_data_pointer = context
.get_global(revive_runtime_api::immutable_data::GLOBAL_IMMUTABLE_DATA_POINTER)? .get_global(revive_runtime_api::immutable_data::GLOBAL_IMMUTABLE_DATA_POINTER)?
.value .value
+12 -25
View File
@@ -3,18 +3,14 @@
use inkwell::values::BasicValue; use inkwell::values::BasicValue;
use crate::polkavm::context::Context; use crate::polkavm::context::Context;
use crate::polkavm::Dependency;
/// Translates the `addmod` instruction. /// Translates the `addmod` instruction.
pub fn add_mod<'ctx, D>( pub fn add_mod<'ctx>(
context: &mut Context<'ctx, D>, context: &mut Context<'ctx>,
operand_1: inkwell::values::IntValue<'ctx>, operand_1: inkwell::values::IntValue<'ctx>,
operand_2: inkwell::values::IntValue<'ctx>, operand_2: inkwell::values::IntValue<'ctx>,
modulo: inkwell::values::IntValue<'ctx>, modulo: inkwell::values::IntValue<'ctx>,
) -> anyhow::Result<inkwell::values::BasicValueEnum<'ctx>> ) -> anyhow::Result<inkwell::values::BasicValueEnum<'ctx>> {
where
D: Dependency + Clone,
{
Ok(context Ok(context
.build_call( .build_call(
context.llvm_runtime().add_mod, context.llvm_runtime().add_mod,
@@ -29,15 +25,12 @@ where
} }
/// Translates the `mulmod` instruction. /// Translates the `mulmod` instruction.
pub fn mul_mod<'ctx, D>( pub fn mul_mod<'ctx>(
context: &mut Context<'ctx, D>, context: &mut Context<'ctx>,
operand_1: inkwell::values::IntValue<'ctx>, operand_1: inkwell::values::IntValue<'ctx>,
operand_2: inkwell::values::IntValue<'ctx>, operand_2: inkwell::values::IntValue<'ctx>,
modulo: inkwell::values::IntValue<'ctx>, modulo: inkwell::values::IntValue<'ctx>,
) -> anyhow::Result<inkwell::values::BasicValueEnum<'ctx>> ) -> anyhow::Result<inkwell::values::BasicValueEnum<'ctx>> {
where
D: Dependency + Clone,
{
Ok(context Ok(context
.build_call( .build_call(
context.llvm_runtime().mul_mod, context.llvm_runtime().mul_mod,
@@ -52,14 +45,11 @@ where
} }
/// Translates the `exp` instruction. /// Translates the `exp` instruction.
pub fn exponent<'ctx, D>( pub fn exponent<'ctx>(
context: &mut Context<'ctx, D>, context: &mut Context<'ctx>,
value: inkwell::values::IntValue<'ctx>, value: inkwell::values::IntValue<'ctx>,
exponent: inkwell::values::IntValue<'ctx>, exponent: inkwell::values::IntValue<'ctx>,
) -> anyhow::Result<inkwell::values::BasicValueEnum<'ctx>> ) -> anyhow::Result<inkwell::values::BasicValueEnum<'ctx>> {
where
D: Dependency + Clone,
{
Ok(context Ok(context
.build_call( .build_call(
context.llvm_runtime().exp, context.llvm_runtime().exp,
@@ -70,14 +60,11 @@ where
} }
/// Translates the `signextend` instruction. /// Translates the `signextend` instruction.
pub fn sign_extend<'ctx, D>( pub fn sign_extend<'ctx>(
context: &mut Context<'ctx, D>, context: &mut Context<'ctx>,
bytes: inkwell::values::IntValue<'ctx>, bytes: inkwell::values::IntValue<'ctx>,
value: inkwell::values::IntValue<'ctx>, value: inkwell::values::IntValue<'ctx>,
) -> anyhow::Result<inkwell::values::BasicValueEnum<'ctx>> ) -> anyhow::Result<inkwell::values::BasicValueEnum<'ctx>> {
where
D: Dependency + Clone,
{
Ok(context Ok(context
.build_call( .build_call(
context.llvm_runtime().sign_extend, context.llvm_runtime().sign_extend,
+14 -26
View File
@@ -1,19 +1,16 @@
//! Translates the heap memory operations. //! Translates the heap memory operations.
use inkwell::values::BasicValue; use inkwell::values::BasicValue;
use revive_common::BYTE_LENGTH_BYTE;
use crate::polkavm::context::address_space::AddressSpace; use crate::polkavm::context::address_space::AddressSpace;
use crate::polkavm::context::pointer::Pointer; use crate::polkavm::context::pointer::Pointer;
use crate::polkavm::context::Context; use crate::polkavm::context::Context;
use crate::polkavm::Dependency;
/// Translates the `msize` instruction. /// Translates the `msize` instruction.
pub fn msize<'ctx, D>( pub fn msize<'ctx>(
context: &mut Context<'ctx, D>, context: &mut Context<'ctx>,
) -> anyhow::Result<inkwell::values::BasicValueEnum<'ctx>> ) -> anyhow::Result<inkwell::values::BasicValueEnum<'ctx>> {
where
D: Dependency + Clone,
{
Ok(context Ok(context
.builder() .builder()
.build_int_z_extend( .build_int_z_extend(
@@ -26,13 +23,10 @@ where
/// Translates the `mload` instruction. /// Translates the `mload` instruction.
/// Uses the main heap. /// Uses the main heap.
pub fn load<'ctx, D>( pub fn load<'ctx>(
context: &mut Context<'ctx, D>, context: &mut Context<'ctx>,
offset: inkwell::values::IntValue<'ctx>, offset: inkwell::values::IntValue<'ctx>,
) -> anyhow::Result<inkwell::values::BasicValueEnum<'ctx>> ) -> anyhow::Result<inkwell::values::BasicValueEnum<'ctx>> {
where
D: Dependency + Clone,
{
let pointer = Pointer::new_with_offset( let pointer = Pointer::new_with_offset(
context, context,
AddressSpace::Heap, AddressSpace::Heap,
@@ -45,14 +39,11 @@ where
/// Translates the `mstore` instruction. /// Translates the `mstore` instruction.
/// Uses the main heap. /// Uses the main heap.
pub fn store<'ctx, D>( pub fn store<'ctx>(
context: &mut Context<'ctx, D>, context: &mut Context<'ctx>,
offset: inkwell::values::IntValue<'ctx>, offset: inkwell::values::IntValue<'ctx>,
value: inkwell::values::IntValue<'ctx>, value: inkwell::values::IntValue<'ctx>,
) -> anyhow::Result<()> ) -> anyhow::Result<()> {
where
D: Dependency + Clone,
{
let pointer = Pointer::new_with_offset( let pointer = Pointer::new_with_offset(
context, context,
AddressSpace::Heap, AddressSpace::Heap,
@@ -66,14 +57,11 @@ where
/// Translates the `mstore8` instruction. /// Translates the `mstore8` instruction.
/// Uses the main heap. /// Uses the main heap.
pub fn store_byte<'ctx, D>( pub fn store_byte<'ctx>(
context: &mut Context<'ctx, D>, context: &mut Context<'ctx>,
offset: inkwell::values::IntValue<'ctx>, offset: inkwell::values::IntValue<'ctx>,
value: inkwell::values::IntValue<'ctx>, value: inkwell::values::IntValue<'ctx>,
) -> anyhow::Result<()> ) -> anyhow::Result<()> {
where
D: Dependency + Clone,
{
let byte_type = context.byte_type(); let byte_type = context.byte_type();
let value = context let value = context
.builder() .builder()
@@ -92,7 +80,7 @@ where
context context
.builder() .builder()
.build_store(pointer, value)? .build_store(pointer, value)?
.set_alignment(revive_common::BYTE_LENGTH_BYTE as u32) .set_alignment(BYTE_LENGTH_BYTE as u32)
.expect("Alignment is valid"); .expect("Alignment is valid");
Ok(()) Ok(())
} }
+22 -22
View File
@@ -4,22 +4,18 @@ use crate::polkavm::context::code_type::CodeType;
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::evm::immutable::Store; use crate::polkavm::evm::immutable::Store;
use crate::polkavm::Dependency;
/// Translates the `return` instruction. /// Translates the `return` instruction.
pub fn r#return<'ctx, D>( pub fn r#return<'ctx>(
context: &mut Context<'ctx, D>, context: &mut Context<'ctx>,
offset: inkwell::values::IntValue<'ctx>, offset: inkwell::values::IntValue<'ctx>,
length: inkwell::values::IntValue<'ctx>, length: inkwell::values::IntValue<'ctx>,
) -> anyhow::Result<()> ) -> anyhow::Result<()> {
where
D: Dependency + Clone,
{
match context.code_type() { match context.code_type() {
None => anyhow::bail!("Return is not available if the contract part is undefined"), None => anyhow::bail!("Return is not available if the contract part is undefined"),
Some(CodeType::Deploy) => { Some(CodeType::Deploy) => {
context.build_call( context.build_call(
<Store as RuntimeFunction<D>>::declaration(context), <Store as RuntimeFunction>::declaration(context),
Default::default(), Default::default(),
"store_immutable_data", "store_immutable_data",
); );
@@ -35,14 +31,11 @@ where
} }
/// Translates the `revert` instruction. /// Translates the `revert` instruction.
pub fn revert<'ctx, D>( pub fn revert<'ctx>(
context: &mut Context<'ctx, D>, context: &mut Context<'ctx>,
offset: inkwell::values::IntValue<'ctx>, offset: inkwell::values::IntValue<'ctx>,
length: inkwell::values::IntValue<'ctx>, length: inkwell::values::IntValue<'ctx>,
) -> anyhow::Result<()> ) -> anyhow::Result<()> {
where
D: Dependency + Clone,
{
context.build_exit( context.build_exit(
context.integer_const(crate::polkavm::XLEN, 1), context.integer_const(crate::polkavm::XLEN, 1),
offset, offset,
@@ -52,19 +45,13 @@ where
/// Translates the `stop` instruction. /// Translates the `stop` instruction.
/// Is the same as `return(0, 0)`. /// Is the same as `return(0, 0)`.
pub fn stop<D>(context: &mut Context<D>) -> anyhow::Result<()> pub fn stop(context: &mut Context) -> anyhow::Result<()> {
where
D: Dependency + Clone,
{
r#return(context, context.word_const(0), context.word_const(0)) r#return(context, context.word_const(0), context.word_const(0))
} }
/// Translates the `invalid` instruction. /// Translates the `invalid` instruction.
/// Burns all gas using an out-of-bounds memory store, causing a panic. /// Burns all gas using an out-of-bounds memory store, causing a panic.
pub fn invalid<D>(context: &mut Context<D>) -> anyhow::Result<()> pub fn invalid(context: &mut Context) -> anyhow::Result<()> {
where
D: Dependency + Clone,
{
crate::polkavm::evm::memory::store( crate::polkavm::evm::memory::store(
context, context,
context.word_type().const_all_ones(), context.word_type().const_all_ones(),
@@ -73,3 +60,16 @@ where
context.build_call(context.intrinsics().trap, &[], "invalid_trap"); context.build_call(context.intrinsics().trap, &[], "invalid_trap");
Ok(()) Ok(())
} }
/// Translates the `selfdestruct` instruction.
pub fn selfdestruct<'ctx>(
context: &mut Context<'ctx>,
address: inkwell::values::IntValue<'ctx>,
) -> anyhow::Result<()> {
let address_pointer = context.build_address_argument_store(address)?;
context.build_runtime_call(
revive_runtime_api::polkavm_imports::TERMINATE,
&[address_pointer.to_int(context).into()],
);
Ok(())
}
@@ -1,15 +1,11 @@
//! Translates the return data instructions. //! Translates the return data instructions.
use crate::polkavm::context::Context; use crate::polkavm::context::Context;
use crate::polkavm::Dependency;
/// Translates the return data size. /// Translates the return data size.
pub fn size<'ctx, D>( pub fn size<'ctx>(
context: &mut Context<'ctx, D>, context: &mut Context<'ctx>,
) -> anyhow::Result<inkwell::values::BasicValueEnum<'ctx>> ) -> anyhow::Result<inkwell::values::BasicValueEnum<'ctx>> {
where
D: Dependency + Clone,
{
let return_data_size_value = context let return_data_size_value = context
.build_runtime_call(revive_runtime_api::polkavm_imports::RETURNDATASIZE, &[]) .build_runtime_call(revive_runtime_api::polkavm_imports::RETURNDATASIZE, &[])
.expect("the return_data_size syscall method should return a value") .expect("the return_data_size syscall method should return a value")
@@ -29,15 +25,12 @@ where
/// - Destination, offset or size exceed the VM register size (XLEN) /// - Destination, offset or size exceed the VM register size (XLEN)
/// - `source_offset + size` overflows (in XLEN) /// - `source_offset + size` overflows (in XLEN)
/// - `source_offset + size` is beyond `RETURNDATASIZE` /// - `source_offset + size` is beyond `RETURNDATASIZE`
pub fn copy<'ctx, D>( pub fn copy<'ctx>(
context: &mut Context<'ctx, D>, context: &mut Context<'ctx>,
destination_offset: inkwell::values::IntValue<'ctx>, destination_offset: inkwell::values::IntValue<'ctx>,
source_offset: inkwell::values::IntValue<'ctx>, source_offset: inkwell::values::IntValue<'ctx>,
size: inkwell::values::IntValue<'ctx>, size: inkwell::values::IntValue<'ctx>,
) -> anyhow::Result<()> ) -> anyhow::Result<()> {
where
D: Dependency + Clone,
{
let source_offset = context.safe_truncate_int_to_xlen(source_offset)?; let source_offset = context.safe_truncate_int_to_xlen(source_offset)?;
let destination_offset = context.safe_truncate_int_to_xlen(destination_offset)?; let destination_offset = context.safe_truncate_int_to_xlen(destination_offset)?;
let size = context.safe_truncate_int_to_xlen(size)?; let size = context.safe_truncate_int_to_xlen(size)?;
+18 -31
View File
@@ -2,7 +2,6 @@
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::PolkaVMArgument; use crate::PolkaVMArgument;
use crate::PolkaVMLoadStorageWordFunction; use crate::PolkaVMLoadStorageWordFunction;
use crate::PolkaVMLoadTransientStorageWordFunction; use crate::PolkaVMLoadTransientStorageWordFunction;
@@ -10,15 +9,12 @@ use crate::PolkaVMStoreStorageWordFunction;
use crate::PolkaVMStoreTransientStorageWordFunction; use crate::PolkaVMStoreTransientStorageWordFunction;
/// Translates the storage load. /// Translates the storage load.
pub fn load<'ctx, D>( pub fn load<'ctx>(
context: &mut Context<'ctx, D>, context: &mut Context<'ctx>,
position: &PolkaVMArgument<'ctx>, position: &PolkaVMArgument<'ctx>,
) -> anyhow::Result<inkwell::values::BasicValueEnum<'ctx>> ) -> anyhow::Result<inkwell::values::BasicValueEnum<'ctx>> {
where let name = <PolkaVMLoadStorageWordFunction as RuntimeFunction>::NAME;
D: Dependency + Clone, let declaration = <PolkaVMLoadStorageWordFunction as RuntimeFunction>::declaration(context);
{
let name = <PolkaVMLoadStorageWordFunction as RuntimeFunction<D>>::NAME;
let declaration = <PolkaVMLoadStorageWordFunction as RuntimeFunction<D>>::declaration(context);
let arguments = [position.as_pointer(context)?.value.into()]; let arguments = [position.as_pointer(context)?.value.into()];
Ok(context Ok(context
.build_call(declaration, &arguments, "storage_load") .build_call(declaration, &arguments, "storage_load")
@@ -26,15 +22,12 @@ where
} }
/// Translates the storage store. /// Translates the storage store.
pub fn store<'ctx, D>( pub fn store<'ctx>(
context: &mut Context<'ctx, D>, context: &mut Context<'ctx>,
position: &PolkaVMArgument<'ctx>, position: &PolkaVMArgument<'ctx>,
value: &PolkaVMArgument<'ctx>, value: &PolkaVMArgument<'ctx>,
) -> anyhow::Result<()> ) -> anyhow::Result<()> {
where let declaration = <PolkaVMStoreStorageWordFunction as RuntimeFunction>::declaration(context);
D: Dependency + Clone,
{
let declaration = <PolkaVMStoreStorageWordFunction as RuntimeFunction<D>>::declaration(context);
let arguments = [ let arguments = [
position.as_pointer(context)?.value.into(), position.as_pointer(context)?.value.into(),
value.as_pointer(context)?.value.into(), value.as_pointer(context)?.value.into(),
@@ -44,33 +37,27 @@ where
} }
/// Translates the transient storage load. /// Translates the transient storage load.
pub fn transient_load<'ctx, D>( pub fn transient_load<'ctx>(
context: &mut Context<'ctx, D>, context: &mut Context<'ctx>,
position: &PolkaVMArgument<'ctx>, position: &PolkaVMArgument<'ctx>,
) -> anyhow::Result<inkwell::values::BasicValueEnum<'ctx>> ) -> anyhow::Result<inkwell::values::BasicValueEnum<'ctx>> {
where let name = <PolkaVMLoadTransientStorageWordFunction as RuntimeFunction>::NAME;
D: Dependency + Clone,
{
let name = <PolkaVMLoadTransientStorageWordFunction as RuntimeFunction<D>>::NAME;
let arguments = [position.as_pointer(context)?.value.into()]; let arguments = [position.as_pointer(context)?.value.into()];
let declaration = let declaration =
<PolkaVMLoadTransientStorageWordFunction as RuntimeFunction<D>>::declaration(context); <PolkaVMLoadTransientStorageWordFunction as RuntimeFunction>::declaration(context);
Ok(context Ok(context
.build_call(declaration, &arguments, "transient_storage_load") .build_call(declaration, &arguments, "transient_storage_load")
.unwrap_or_else(|| panic!("runtime function {name} should return a value"))) .unwrap_or_else(|| panic!("runtime function {name} should return a value")))
} }
/// Translates the transient storage store. /// Translates the transient storage store.
pub fn transient_store<'ctx, D>( pub fn transient_store<'ctx>(
context: &mut Context<'ctx, D>, context: &mut Context<'ctx>,
position: &PolkaVMArgument<'ctx>, position: &PolkaVMArgument<'ctx>,
value: &PolkaVMArgument<'ctx>, value: &PolkaVMArgument<'ctx>,
) -> anyhow::Result<()> ) -> anyhow::Result<()> {
where
D: Dependency + Clone,
{
let declaration = let declaration =
<PolkaVMStoreTransientStorageWordFunction as RuntimeFunction<D>>::declaration(context); <PolkaVMStoreTransientStorageWordFunction as RuntimeFunction>::declaration(context);
let arguments = [ let arguments = [
position.as_pointer(context)?.value.into(), position.as_pointer(context)?.value.into(),
value.as_pointer(context)?.value.into(), value.as_pointer(context)?.value.into(),
+118 -82
View File
@@ -1,30 +1,43 @@
//! The LLVM context library. //! The LLVM context library.
use std::collections::BTreeMap;
use crate::debug_config::DebugConfig;
use crate::optimizer::settings::Settings as OptimizerSettings;
use crate::{PolkaVMTarget, PolkaVMTargetMachine};
use anyhow::Context as AnyhowContext;
use polkavm_common::program::ProgramBlob;
use polkavm_disassembler::{Disassembler, DisassemblyFormat};
use revive_common::{
Keccak256, ObjectFormat, BIT_LENGTH_ETH_ADDRESS, BIT_LENGTH_WORD, BYTE_LENGTH_ETH_ADDRESS,
BYTE_LENGTH_WORD,
};
use revive_linker::elf::ElfLinker;
use revive_linker::pvm::polkavm_linker;
use self::context::build::Build;
use self::context::Context;
pub use self::r#const::*;
pub mod r#const; pub mod r#const;
pub mod context; pub mod context;
pub mod evm; pub mod evm;
pub use self::r#const::*; /// Get a [Build] from contract bytecode and its auxilliary data.
pub fn build(
bytecode: &[u8],
metadata_hash: Option<[u8; BYTE_LENGTH_WORD]>,
) -> anyhow::Result<Build> {
Ok(Build::new(metadata_hash, bytecode.to_owned()))
}
use crate::debug_config::DebugConfig; /// Disassembles the PolkaVM blob into assembly text representation.
use crate::optimizer::settings::Settings as OptimizerSettings; pub fn disassemble(
use anyhow::Context as AnyhowContext;
use polkavm_common::program::ProgramBlob;
use polkavm_disassembler::{Disassembler, DisassemblyFormat};
use revive_solc_json_interface::SolcStandardJsonInputSettingsPolkaVMMemory;
use sha3::Digest;
use self::context::build::Build;
use self::context::Context;
/// Builds PolkaVM assembly text.
pub fn build_assembly_text(
contract_path: &str, contract_path: &str,
bytecode: &[u8], bytecode: &[u8],
metadata_hash: Option<[u8; revive_common::BYTE_LENGTH_WORD]>,
debug_config: &DebugConfig, debug_config: &DebugConfig,
) -> anyhow::Result<Build> { ) -> anyhow::Result<String> {
let program_blob = ProgramBlob::parse(bytecode.into()) let program_blob = ProgramBlob::parse(bytecode.into())
.map_err(anyhow::Error::msg) .map_err(anyhow::Error::msg)
.with_context(|| format!("Failed to parse program blob for contract: {contract_path}"))?; .with_context(|| format!("Failed to parse program blob for contract: {contract_path}"))?;
@@ -45,86 +58,109 @@ pub fn build_assembly_text(
debug_config.dump_assembly(contract_path, &assembly_text)?; debug_config.dump_assembly(contract_path, &assembly_text)?;
Ok(Build::new( Ok(assembly_text)
assembly_text.to_owned(),
metadata_hash,
bytecode.to_owned(),
hex::encode(sha3::Keccak256::digest(bytecode)),
))
} }
/// Computes the PVM bytecode hash.
pub fn hash(bytecode_buffer: &[u8]) -> [u8; BYTE_LENGTH_WORD] {
Keccak256::from_slice(bytecode_buffer)
.as_bytes()
.try_into()
.expect("the bytecode hash should be word sized")
}
/// Links the `bytecode` with `linker_symbols` and `factory_dependencies`.
pub fn link(
bytecode: &[u8],
linker_symbols: &BTreeMap<String, [u8; BYTE_LENGTH_ETH_ADDRESS]>,
factory_dependencies: &BTreeMap<String, [u8; BYTE_LENGTH_WORD]>,
strip_binary: bool,
) -> anyhow::Result<(Vec<u8>, ObjectFormat)> {
Ok(match ObjectFormat::try_from(bytecode) {
Ok(format @ ObjectFormat::PVM) => (bytecode.to_vec(), format),
Ok(ObjectFormat::ELF) => {
let symbols = build_symbols(linker_symbols, factory_dependencies)?;
let bytecode_linked = ElfLinker::setup()?.link(bytecode, symbols.as_slice())?;
polkavm_linker(&bytecode_linked, strip_binary)
.map(|pvm| (pvm, ObjectFormat::PVM))
.unwrap_or_else(|error| {
if !error
.to_string()
.lines()
.map(|line| line.trim())
.filter(|line| !line.is_empty())
.all(|line| line.contains("found undefined symbol"))
{
panic!("ICE: linker: {error}");
}
(bytecode.to_vec(), ObjectFormat::ELF)
})
}
Err(error) => panic!("ICE: linker: {error}"),
})
}
/// The returned module defines given `linker_symbols` and `factory_dependencies` global values.
pub fn build_symbols(
linker_symbols: &BTreeMap<String, [u8; BYTE_LENGTH_ETH_ADDRESS]>,
factory_dependencies: &BTreeMap<String, [u8; BYTE_LENGTH_WORD]>,
) -> anyhow::Result<inkwell::memory_buffer::MemoryBuffer> {
let context = inkwell::context::Context::create();
let module = context.create_module("symbols");
let word_type = context.custom_width_int_type(BIT_LENGTH_WORD as u32);
let address_type = context.custom_width_int_type(BIT_LENGTH_ETH_ADDRESS as u32);
for (name, value) in linker_symbols {
let global_value = module.add_global(address_type, Default::default(), name);
global_value.set_linkage(inkwell::module::Linkage::External);
global_value.set_initializer(
&address_type
.const_int_from_string(
hex::encode(value).as_str(),
inkwell::types::StringRadix::Hexadecimal,
)
.expect("should be valid"),
);
}
for (name, value) in factory_dependencies {
let global_value = module.add_global(word_type, Default::default(), name);
global_value.set_linkage(inkwell::module::Linkage::External);
global_value.set_initializer(
&word_type
.const_int_from_string(
hex::encode(value).as_str(),
inkwell::types::StringRadix::Hexadecimal,
)
.expect("should be valid"),
);
}
Ok(
PolkaVMTargetMachine::new(PolkaVMTarget::PVM, &OptimizerSettings::none())?
.write_to_memory_buffer(&module)
.expect("ICE: the symbols module should be valid"),
)
}
/// Implemented by items which are translated into LLVM IR. /// Implemented by items which are translated into LLVM IR.
pub trait WriteLLVM<D> pub trait WriteLLVM {
where
D: Dependency + Clone,
{
/// Declares the entity in the LLVM IR. /// Declares the entity in the LLVM IR.
/// Is usually performed in order to use the item before defining it. /// Is usually performed in order to use the item before defining it.
fn declare(&mut self, _context: &mut Context<D>) -> anyhow::Result<()> { fn declare(&mut self, _context: &mut Context) -> anyhow::Result<()> {
Ok(()) Ok(())
} }
/// Translates the entity into LLVM IR. /// Translates the entity into LLVM IR.
fn into_llvm(self, context: &mut Context<D>) -> anyhow::Result<()>; fn into_llvm(self, context: &mut Context) -> anyhow::Result<()>;
} }
/// The dummy LLVM writable entity. /// The dummy LLVM writable entity.
#[derive(Debug, Default, Clone)] #[derive(Debug, Default, Clone)]
pub struct DummyLLVMWritable {} pub struct DummyLLVMWritable {}
impl<D> WriteLLVM<D> for DummyLLVMWritable impl WriteLLVM for DummyLLVMWritable {
where fn into_llvm(self, _context: &mut Context) -> anyhow::Result<()> {
D: Dependency + Clone,
{
fn into_llvm(self, _context: &mut Context<D>) -> anyhow::Result<()> {
Ok(()) Ok(())
} }
} }
/// Implemented by items managing project dependencies.
pub trait Dependency {
/// Compiles a project dependency.
fn compile(
dependency: Self,
path: &str,
optimizer_settings: OptimizerSettings,
include_metadata_hash: bool,
debug_config: DebugConfig,
llvm_arguments: &[String],
memory_config: SolcStandardJsonInputSettingsPolkaVMMemory,
) -> anyhow::Result<String>;
/// Resolves a full contract path.
fn resolve_path(&self, identifier: &str) -> anyhow::Result<String>;
/// Resolves a library address.
fn resolve_library(&self, path: &str) -> anyhow::Result<String>;
}
/// The dummy dependency entity.
#[derive(Debug, Default, Clone)]
pub struct DummyDependency {}
impl Dependency for DummyDependency {
fn compile(
_dependency: Self,
_path: &str,
_optimizer_settings: OptimizerSettings,
_include_metadata_hash: bool,
_debug_config: DebugConfig,
_llvm_arguments: &[String],
_memory_config: SolcStandardJsonInputSettingsPolkaVMMemory,
) -> anyhow::Result<String> {
Ok(String::new())
}
/// Resolves a full contract path.
fn resolve_path(&self, _identifier: &str) -> anyhow::Result<String> {
Ok(String::new())
}
/// Resolves a library address.
fn resolve_library(&self, _path: &str) -> anyhow::Result<String> {
Ok(String::new())
}
}
@@ -1,12 +1,12 @@
//! The LLVM target machine. //! The LLVM target machine.
pub mod target;
use crate::optimizer::settings::size_level::SizeLevel as OptimizerSettingsSizeLevel; use crate::optimizer::settings::size_level::SizeLevel as OptimizerSettingsSizeLevel;
use crate::optimizer::settings::Settings as OptimizerSettings; use crate::optimizer::settings::Settings as OptimizerSettings;
use self::target::Target; use self::target::Target;
pub mod target;
/// The LLVM target machine. /// The LLVM target machine.
#[derive(Debug)] #[derive(Debug)]
pub struct TargetMachine { pub struct TargetMachine {
+7 -3
View File
@@ -1,6 +1,6 @@
[package] [package]
name = "resolc" name = "resolc"
version = "0.3.0" version = "0.5.0"
license.workspace = true license.workspace = true
edition.workspace = true edition.workspace = true
repository.workspace = true repository.workspace = true
@@ -28,8 +28,8 @@ 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 }
sha3 = { workspace = true }
which = { workspace = true } which = { workspace = true }
normpath = { workspace = true }
revive-common = { workspace = true } revive-common = { workspace = true }
revive-llvm-context = { workspace = true } revive-llvm-context = { workspace = true }
@@ -46,6 +46,10 @@ inkwell = { workspace = true, features = ["target-riscv", "llvm18-1-no-llvm-link
[build-dependencies] [build-dependencies]
git2 = { workspace = true, default-features = false } git2 = { workspace = true, default-features = false }
[dev-dependencies]
tempfile = { workspace = true }
[features] [features]
parallel = ["rayon"] parallel = ["rayon", "revive-solc-json-interface/parallel"]
default = ["parallel"] default = ["parallel"]
+135 -60
View File
@@ -1,10 +1,19 @@
//! The Solidity contract build. //! The Solidity contract build.
use std::collections::HashSet; use std::collections::BTreeMap;
use std::collections::BTreeSet;
use std::fs::File; use std::fs::File;
use std::io::Write; use std::io::Write;
use std::path::Path; use std::path::Path;
use std::path::PathBuf;
use revive_common::ContractIdentifier;
use revive_common::ObjectFormat;
use revive_common::BYTE_LENGTH_WORD;
use revive_common::EXTENSION_JSON;
use revive_common::EXTENSION_POLKAVM_ASSEMBLY;
use revive_common::EXTENSION_POLKAVM_BINARY;
use revive_llvm_context::PolkaVMBuild;
use revive_solc_json_interface::CombinedJsonContract; use revive_solc_json_interface::CombinedJsonContract;
use revive_solc_json_interface::SolcStandardJsonOutputContract; use revive_solc_json_interface::SolcStandardJsonOutputContract;
use serde::Deserialize; use serde::Deserialize;
@@ -13,92 +22,137 @@ use serde::Serialize;
/// The Solidity contract build. /// The Solidity contract build.
#[derive(Debug, Serialize, Deserialize)] #[derive(Debug, Serialize, Deserialize)]
pub struct Contract { pub struct Contract {
/// The contract path. /// The contract identifier.
pub path: String, pub identifier: ContractIdentifier,
/// The auxiliary identifier. Used to identify Yul objects.
pub identifier: String,
/// The LLVM module build. /// The LLVM module build.
pub build: revive_llvm_context::PolkaVMBuild, pub build: PolkaVMBuild,
/// The metadata JSON. /// The metadata JSON.
pub metadata_json: serde_json::Value, pub metadata_json: serde_json::Value,
/// The factory dependencies. /// The unlinked missing libraries.
pub factory_dependencies: HashSet<String>, pub missing_libraries: BTreeSet<String>,
/// The unresolved factory dependencies.
pub factory_dependencies: BTreeSet<String>,
/// The resolved factory dependencies.
pub factory_dependencies_resolved: BTreeMap<[u8; BYTE_LENGTH_WORD], String>,
/// The binary object format.
pub object_format: ObjectFormat,
} }
impl Contract { impl Contract {
/// A shortcut constructor. /// A shortcut constructor.
pub fn new( pub fn new(
path: String, identifier: ContractIdentifier,
identifier: String, build: PolkaVMBuild,
build: revive_llvm_context::PolkaVMBuild,
metadata_json: serde_json::Value, metadata_json: serde_json::Value,
factory_dependencies: HashSet<String>, missing_libraries: BTreeSet<String>,
factory_dependencies: BTreeSet<String>,
object_format: ObjectFormat,
) -> Self { ) -> Self {
Self { Self {
path,
identifier, identifier,
build, build,
metadata_json, metadata_json,
missing_libraries,
factory_dependencies, factory_dependencies,
factory_dependencies_resolved: BTreeMap::new(),
object_format,
} }
} }
/// Writes the contract text assembly and bytecode to terminal.
pub fn write_to_terminal(
self,
path: String,
output_metadata: bool,
output_assembly: bool,
output_binary: bool,
) -> anyhow::Result<()> {
writeln!(std::io::stdout(), "\n======= {path} =======")?;
if output_assembly {
writeln!(
std::io::stdout(),
"Assembly:\n{}",
self.build.assembly_text.unwrap_or_default(),
)?;
}
if output_metadata {
writeln!(std::io::stdout(), "Metadata:\n{}", self.metadata_json)?;
}
if output_binary {
writeln!(
std::io::stdout(),
"Binary:\n{}",
hex::encode(self.build.bytecode)
)?;
}
Ok(())
}
/// Writes the contract text assembly and bytecode to files. /// Writes the contract text assembly and bytecode to files.
pub fn write_to_directory( pub fn write_to_directory(
self, self,
path: &Path, path: &Path,
output_metadata: bool,
output_assembly: bool, output_assembly: bool,
output_binary: bool, output_binary: bool,
overwrite: bool, overwrite: bool,
) -> anyhow::Result<()> { ) -> anyhow::Result<()> {
let file_name = Self::short_path(self.path.as_str()); let file_path = PathBuf::from(self.identifier.path);
let file_name = file_path
if output_assembly { .file_name()
let file_name = format!( .expect("Always exists")
"{}.{}", .to_str()
file_name, .expect("Always valid");
revive_common::EXTENSION_POLKAVM_ASSEMBLY let output_path = path.to_owned();
); std::fs::create_dir_all(output_path.as_path())?;
let mut file_path = path.to_owned();
file_path.push(file_name);
if output_metadata {
let file_path = output_path.join(format!(
"{file_name}:{}.{EXTENSION_JSON}",
self.identifier.name.as_deref().unwrap_or(file_name),
));
if file_path.exists() && !overwrite { if file_path.exists() && !overwrite {
anyhow::bail!( anyhow::bail!(
"Refusing to overwrite an existing file {file_path:?} (use --overwrite to force)." "Refusing to overwrite an existing file {file_path:?} (use --overwrite to force)."
); );
} else {
let assembly_text = self.build.assembly_text;
File::create(&file_path)
.map_err(|error| {
anyhow::anyhow!("File {:?} creating error: {}", file_path, error)
})?
.write_all(assembly_text.as_bytes())
.map_err(|error| {
anyhow::anyhow!("File {:?} writing error: {}", file_path, error)
})?;
} }
std::fs::write(
file_path.as_path(),
self.metadata_json.to_string().as_bytes(),
)
.map_err(|error| anyhow::anyhow!("File {file_path:?} writing: {error}"))?;
}
if output_assembly {
let file_path = output_path.join(format!(
"{file_name}:{}.{EXTENSION_POLKAVM_ASSEMBLY}",
self.identifier.name.as_deref().unwrap_or(file_name),
));
if file_path.exists() && !overwrite {
anyhow::bail!(
"Refusing to overwrite an existing file {file_path:?} (use --overwrite to force)."
);
}
File::create(&file_path)
.map_err(|error| anyhow::anyhow!("File {file_path:?} creating error: {error}"))?
.write_all(self.build.assembly_text.unwrap_or_default().as_bytes())
.map_err(|error| anyhow::anyhow!("File {file_path:?} writing error: {error}"))?;
} }
if output_binary { if output_binary {
let file_name = format!("{}.{}", file_name, revive_common::EXTENSION_POLKAVM_BINARY); let file_path = output_path.join(format!(
let mut file_path = path.to_owned(); "{file_name}:{}.{EXTENSION_POLKAVM_BINARY}",
file_path.push(file_name); self.identifier.name.as_deref().unwrap_or(file_name),
));
if file_path.exists() && !overwrite { if file_path.exists() && !overwrite {
anyhow::bail!( anyhow::bail!(
"Refusing to overwrite an existing file {file_path:?} (use --overwrite to force)." "Refusing to overwrite an existing file {file_path:?} (use --overwrite to force)."
); );
} else {
File::create(&file_path)
.map_err(|error| {
anyhow::anyhow!("File {:?} creating error: {}", file_path, error)
})?
.write_all(self.build.bytecode.as_slice())
.map_err(|error| {
anyhow::anyhow!("File {:?} writing error: {}", file_path, error)
})?;
} }
File::create(&file_path)
.map_err(|error| anyhow::anyhow!("File {file_path:?} creating error: {error}"))?
.write_all(self.build.bytecode.as_slice())
.map_err(|error| anyhow::anyhow!("File {file_path:?} writing error: {error}"))?;
} }
Ok(()) Ok(())
@@ -109,20 +163,30 @@ impl Contract {
self, self,
combined_json_contract: &mut CombinedJsonContract, combined_json_contract: &mut CombinedJsonContract,
) -> anyhow::Result<()> { ) -> anyhow::Result<()> {
let hexadecimal_bytecode = hex::encode(self.build.bytecode);
if let Some(metadata) = combined_json_contract.metadata.as_mut() { if let Some(metadata) = combined_json_contract.metadata.as_mut() {
*metadata = self.metadata_json.to_string(); *metadata = self.metadata_json.to_string();
} }
if let Some(asm) = combined_json_contract.asm.as_mut() { combined_json_contract.assembly = self.build.assembly_text;
*asm = serde_json::Value::String(self.build.assembly_text);
}
let hexadecimal_bytecode = hex::encode(self.build.bytecode);
combined_json_contract.bin = Some(hexadecimal_bytecode); combined_json_contract.bin = Some(hexadecimal_bytecode);
combined_json_contract combined_json_contract
.bin_runtime .bin_runtime
.clone_from(&combined_json_contract.bin); .clone_from(&combined_json_contract.bin);
combined_json_contract.factory_deps = Some(self.build.factory_dependencies); combined_json_contract
.missing_libraries
.extend(self.missing_libraries);
combined_json_contract
.factory_deps_unlinked
.extend(self.factory_dependencies);
combined_json_contract.factory_deps.extend(
self.factory_dependencies_resolved
.into_iter()
.map(|(hash, path)| (hex::encode(hash), path)),
);
combined_json_contract.object_format = Some(self.object_format);
Ok(()) Ok(())
} }
@@ -132,16 +196,27 @@ impl Contract {
self, self,
standard_json_contract: &mut SolcStandardJsonOutputContract, standard_json_contract: &mut SolcStandardJsonOutputContract,
) -> anyhow::Result<()> { ) -> anyhow::Result<()> {
standard_json_contract.metadata = Some(self.metadata_json);
let assembly_text = self.build.assembly_text;
let bytecode = hex::encode(self.build.bytecode.as_slice()); let bytecode = hex::encode(self.build.bytecode.as_slice());
if let Some(evm) = standard_json_contract.evm.as_mut() { let assembly_text = self.build.assembly_text.unwrap_or_default();
evm.modify(assembly_text, bytecode);
}
standard_json_contract.factory_dependencies = Some(self.build.factory_dependencies); standard_json_contract.metadata = self.metadata_json;
standard_json_contract.hash = Some(self.build.bytecode_hash); standard_json_contract
.evm
.get_or_insert_with(Default::default)
.modify(assembly_text, bytecode);
standard_json_contract.hash = self.build.bytecode_hash.map(hex::encode);
standard_json_contract
.missing_libraries
.extend(self.missing_libraries);
standard_json_contract
.factory_dependencies_unlinked
.extend(self.factory_dependencies);
standard_json_contract.factory_dependencies.extend(
self.factory_dependencies_resolved
.into_iter()
.map(|(hash, path)| (hex::encode(hash), path)),
);
standard_json_contract.object_format = Some(self.object_format);
Ok(()) Ok(())
} }
+300 -42
View File
@@ -1,94 +1,352 @@
//! The Solidity project build. //! The Solidity project build.
use std::collections::BTreeMap;
use std::io::Write;
use std::path::Path;
use std::path::PathBuf;
use normpath::PathExt;
use revive_common::ObjectFormat;
use revive_common::BYTE_LENGTH_ETH_ADDRESS;
use revive_llvm_context::polkavm_disassemble;
use revive_llvm_context::polkavm_hash;
use revive_llvm_context::polkavm_link;
use revive_llvm_context::DebugConfig;
use revive_solc_json_interface::combined_json::CombinedJson;
use revive_solc_json_interface::CombinedJsonContract;
use revive_solc_json_interface::SolcStandardJsonOutput;
use revive_solc_json_interface::SolcStandardJsonOutputContract;
use revive_solc_json_interface::SolcStandardJsonOutputError;
use revive_solc_json_interface::SolcStandardJsonOutputErrorHandler;
use crate::build::contract::Contract;
use crate::solc::version::Version as SolcVersion;
pub mod contract; pub mod contract;
use std::collections::BTreeMap; /// The Solidity project PVM build.
use std::path::Path;
use revive_solc_json_interface::combined_json::CombinedJson;
use revive_solc_json_interface::SolcStandardJsonOutput;
use crate::solc::version::Version as SolcVersion;
use crate::ResolcVersion;
use self::contract::Contract;
/// The Solidity project build.
#[derive(Debug, Default)] #[derive(Debug, Default)]
pub struct Build { pub struct Build {
/// The contract data, /// The contract data,
pub contracts: BTreeMap<String, Contract>, pub results: BTreeMap<String, Result<Contract, SolcStandardJsonOutputError>>,
/// The additional message to output (added by the revive compiler).
pub messages: Vec<SolcStandardJsonOutputError>,
} }
impl Build { impl Build {
/// Writes all contracts to the specified directory. /// A shorthand constructor.
pub fn write_to_directory( ///
self, /// Note: Takes the supplied `messages`, leaving an empty vec.
output_directory: &Path, pub fn new(
results: BTreeMap<String, Result<Contract, SolcStandardJsonOutputError>>,
messages: &mut Vec<SolcStandardJsonOutputError>,
) -> Self {
Self {
results,
messages: std::mem::take(messages),
}
}
/// Links the PVM build.
pub fn link(
mut self,
linker_symbols: BTreeMap<String, [u8; BYTE_LENGTH_ETH_ADDRESS]>,
debug_config: &DebugConfig,
) -> Self {
let mut contracts: BTreeMap<String, Contract> = self
.results
.into_iter()
.map(|(path, result)| (path, result.expect("Cannot link a project with errors")))
.collect();
loop {
let mut linkage_data = BTreeMap::new();
for (path, contract) in contracts
.iter()
.filter(|(_path, contract)| contract.object_format == ObjectFormat::ELF)
{
match polkavm_link(
&contract.build.bytecode,
&linker_symbols,
&contract
.factory_dependencies
.iter()
.filter_map(|dependency| {
let bytecode_hash = contracts
.get(dependency)
.as_ref()?
.build
.bytecode_hash
.as_ref()?
.to_owned();
Some((dependency.to_owned(), bytecode_hash))
})
.collect(),
!debug_config.emit_debug_info,
) {
Ok((memory_buffer_linked, ObjectFormat::PVM)) => {
let bytecode_hash = polkavm_hash(&memory_buffer_linked);
let assembly_text =
polkavm_disassemble(path, &memory_buffer_linked, debug_config)
.unwrap_or_else(|error| {
panic!("ICE: The PVM disassembler failed: {error}")
});
linkage_data.insert(
path.to_owned(),
(memory_buffer_linked, bytecode_hash, assembly_text),
);
}
Ok((_memory_buffer_linked, ObjectFormat::ELF)) => {}
Err(error) => self
.messages
.push(SolcStandardJsonOutputError::new_error(error, None, None)),
}
}
if linkage_data.is_empty() {
break;
}
for (path, (memory_buffer_linked, bytecode_hash, assembly_text)) in
linkage_data.into_iter()
{
let contract = contracts.get(path.as_str()).expect("Always exists");
let factory_dependencies_resolved = contract
.factory_dependencies
.iter()
.filter_map(|dependency| {
Some((
contracts
.get(dependency)
.as_ref()?
.build
.bytecode_hash
.as_ref()?
.to_owned(),
dependency.to_owned(),
))
})
.collect();
let contract = contracts.get_mut(path.as_str()).expect("Always exists");
contract.build.bytecode = memory_buffer_linked.as_slice().to_vec();
contract.build.bytecode_hash = Some(bytecode_hash);
contract.build.assembly_text = Some(assembly_text);
contract.factory_dependencies_resolved = factory_dependencies_resolved;
contract.object_format = ObjectFormat::PVM;
}
}
let results = contracts
.into_iter()
.map(|(path, contract)| {
if contract.object_format == ObjectFormat::ELF {
self.messages.push(SolcStandardJsonOutputError::new_warning(
format!("{path} is unlinked. Consider providing missing libraries."),
None,
None,
));
}
(path, Ok(contract))
})
.collect();
Self::new(results, &mut self.messages)
}
/// Writes all contracts to the terminal.
pub fn write_to_terminal(
mut self,
output_metadata: bool,
output_assembly: bool, output_assembly: bool,
output_binary: bool, output_binary: bool,
overwrite: bool,
) -> anyhow::Result<()> { ) -> anyhow::Result<()> {
for (_path, contract) in self.contracts.into_iter() { self.take_and_write_warnings();
contract.write_to_directory( self.exit_on_error();
output_directory,
if !output_metadata && !output_assembly && !output_binary {
writeln!(
std::io::stderr(),
"Compiler run successful. No output requested. Use flags --metadata, --asm, --bin."
)?;
return Ok(());
}
for (path, build) in self.results.into_iter() {
build.expect("Always valid").write_to_terminal(
path,
output_metadata,
output_assembly, output_assembly,
output_binary, output_binary,
overwrite,
)?; )?;
} }
Ok(()) Ok(())
} }
/// Writes all contracts to the specified directory.
pub fn write_to_directory(
mut self,
output_directory: &Path,
output_metadata: bool,
output_assembly: bool,
output_binary: bool,
overwrite: bool,
) -> anyhow::Result<()> {
self.take_and_write_warnings();
self.exit_on_error();
std::fs::create_dir_all(output_directory)?;
for build in self.results.into_values() {
build.expect("Always valid").write_to_directory(
output_directory,
output_metadata,
output_assembly,
output_binary,
overwrite,
)?;
}
writeln!(
std::io::stderr(),
"Compiler run successful. Artifact(s) can be found in directory {output_directory:?}."
)?;
Ok(())
}
/// Writes all contracts assembly and bytecode to the combined JSON. /// Writes all contracts assembly and bytecode to the combined JSON.
pub fn write_to_combined_json(self, combined_json: &mut CombinedJson) -> anyhow::Result<()> { pub fn write_to_combined_json(
for (path, contract) in self.contracts.into_iter() { mut self,
let combined_json_contract = combined_json combined_json: &mut CombinedJson,
) -> anyhow::Result<()> {
self.take_and_write_warnings();
self.exit_on_error();
for result in self.results.into_values() {
let build = result.expect("Exits on an error above");
let identifier = build.identifier.clone();
let combined_json_contract =
match combined_json
.contracts .contracts
.iter_mut() .iter_mut()
.find_map(|(json_path, contract)| { .find_map(|(json_path, contract)| {
if path.ends_with(json_path) { if Self::normalize_full_path(identifier.full_path.as_str())
.ends_with(Self::normalize_full_path(json_path).as_str())
{
Some(contract) Some(contract)
} else { } else {
None None
} }
}) }) {
.ok_or_else(|| anyhow::anyhow!("Contract `{}` not found in the project", path))?; Some(contract) => contract,
None => {
contract.write_to_combined_json(combined_json_contract)?; combined_json.contracts.insert(
identifier.full_path.clone(),
CombinedJsonContract::default(),
);
combined_json
.contracts
.get_mut(identifier.full_path.as_str())
.expect("Always exists")
} }
};
combined_json.revive_version = Some(ResolcVersion::default().long); build.write_to_combined_json(combined_json_contract)?;
}
Ok(()) Ok(())
} }
/// Writes all contracts assembly and bytecode to the standard JSON. /// Writes all contracts assembly and bytecode to the standard JSON.
pub fn write_to_standard_json( pub fn write_to_standard_json(
mut self, self,
standard_json: &mut SolcStandardJsonOutput, standard_json: &mut SolcStandardJsonOutput,
solc_version: &SolcVersion, solc_version: &SolcVersion,
) -> anyhow::Result<()> { ) -> anyhow::Result<()> {
let contracts = match standard_json.contracts.as_mut() { let mut errors = Vec::with_capacity(self.results.len());
Some(contracts) => contracts, for result in self.results.into_values() {
None => return Ok(()), let build = match result {
Ok(build) => build,
Err(error) => {
errors.push(error);
continue;
}
}; };
let identifier = build.identifier.clone();
for (path, contracts) in contracts.iter_mut() { match standard_json
for (name, contract) in contracts.iter_mut() { .contracts
let full_name = format!("{path}:{name}"); .get_mut(identifier.path.as_str())
.and_then(|contracts| {
if let Some(contract_data) = self.contracts.remove(full_name.as_str()) { contracts.get_mut(
contract_data.write_to_standard_json(contract)?; identifier
.name
.as_deref()
.unwrap_or(identifier.path.as_str()),
)
}) {
Some(contract) => {
build.write_to_standard_json(contract)?;
}
None => {
let contracts = standard_json
.contracts
.entry(identifier.path.clone())
.or_default();
let mut contract = SolcStandardJsonOutputContract::default();
build.write_to_standard_json(&mut contract)?;
contracts.insert(identifier.name.unwrap_or(identifier.path), contract);
} }
} }
} }
standard_json.errors.extend(errors);
standard_json.version = Some(solc_version.default.to_string()); standard_json.version = Some(solc_version.default.to_string());
standard_json.long_version = Some(solc_version.long.to_owned()); standard_json.long_version = Some(solc_version.long.to_owned());
standard_json.revive_version = Some(ResolcVersion::default().long);
Ok(()) Ok(())
} }
/// Normalizes the full contract path.
///
/// # Panics
/// If the path does not contain a colon.
fn normalize_full_path(path: &str) -> String {
let mut iterator = path.split(':');
let path = iterator.next().expect("Always exists");
let name = iterator.next().expect("Always exists");
let mut full_path = PathBuf::from(path)
.normalize()
.expect("Path normalization error")
.as_os_str()
.to_string_lossy()
.into_owned();
full_path.push(':');
full_path.push_str(name);
full_path
}
}
impl SolcStandardJsonOutputErrorHandler for Build {
fn errors(&self) -> Vec<&SolcStandardJsonOutputError> {
let mut errors: Vec<&SolcStandardJsonOutputError> = self
.results
.values()
.filter_map(|build| build.as_ref().err())
.collect();
errors.extend(self.messages.iter().filter(|message| message.is_error()));
errors
}
fn take_warnings(&mut self) -> Vec<SolcStandardJsonOutputError> {
let warnings = self
.messages
.iter()
.filter(|message| message.is_warning())
.cloned()
.collect();
self.messages.retain(|message| !message.is_warning());
warnings
}
} }
+5 -3
View File
@@ -1,5 +1,7 @@
//! Solidity to PolkaVM compiler constants. //! Solidity to PolkaVM compiler constants.
use revive_common::BYTE_LENGTH_WORD;
/// The default executable name. /// The default executable name.
pub static DEFAULT_EXECUTABLE_NAME: &str = "resolc"; pub static DEFAULT_EXECUTABLE_NAME: &str = "resolc";
@@ -7,10 +9,10 @@ pub static DEFAULT_EXECUTABLE_NAME: &str = "resolc";
pub const OFFSET_SCRATCH_SPACE: usize = 0; pub const OFFSET_SCRATCH_SPACE: usize = 0;
/// The memory pointer offset. /// The memory pointer offset.
pub const OFFSET_MEMORY_POINTER: usize = 2 * revive_common::BYTE_LENGTH_WORD; pub const OFFSET_MEMORY_POINTER: usize = 2 * BYTE_LENGTH_WORD;
/// The empty slot offset. /// The empty slot offset.
pub const OFFSET_EMPTY_SLOT: usize = 3 * revive_common::BYTE_LENGTH_WORD; pub const OFFSET_EMPTY_SLOT: usize = 3 * BYTE_LENGTH_WORD;
/// The non-reserved memory offset. /// The non-reserved memory offset.
pub const OFFSET_NON_RESERVED: usize = 4 * revive_common::BYTE_LENGTH_WORD; pub const OFFSET_NON_RESERVED: usize = 4 * BYTE_LENGTH_WORD;
+268 -205
View File
@@ -1,12 +1,35 @@
//! Solidity to PolkaVM compiler library. //! Solidity to PolkaVM compiler library.
pub(crate) mod build; #![allow(clippy::too_many_arguments)]
pub(crate) mod r#const;
pub(crate) mod missing_libraries; use std::collections::BTreeMap;
pub(crate) mod process; use std::collections::BTreeSet;
pub(crate) mod project; use std::collections::HashSet;
pub(crate) mod solc; use std::io::Write;
pub(crate) mod version; use std::path::PathBuf;
#[cfg(feature = "parallel")]
use rayon::iter::IntoParallelIterator;
#[cfg(feature = "parallel")]
use rayon::iter::ParallelIterator;
use revive_common::EVMVersion;
use revive_common::MetadataHash;
use revive_common::EXIT_CODE_SUCCESS;
use revive_llvm_context::DebugConfig;
use revive_llvm_context::OptimizerSettings;
use revive_solc_json_interface::CombinedJsonSelector;
use revive_solc_json_interface::ResolcWarning;
use revive_solc_json_interface::SolcStandardJsonInput;
use revive_solc_json_interface::SolcStandardJsonInputLanguage;
use revive_solc_json_interface::SolcStandardJsonInputSettingsLibraries;
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::SolcStandardJsonOutputError;
use revive_solc_json_interface::SolcStandardJsonOutputErrorHandler;
use crate::linker::Output;
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;
@@ -31,118 +54,76 @@ pub use self::solc::FIRST_SUPPORTED_VERSION as SolcFirstSupportedVersion;
pub use self::solc::LAST_SUPPORTED_VERSION as SolcLastSupportedVersion; pub use self::solc::LAST_SUPPORTED_VERSION as SolcLastSupportedVersion;
pub use self::version::Version as ResolcVersion; pub use self::version::Version as ResolcVersion;
pub(crate) mod build;
pub(crate) mod r#const;
pub(crate) mod linker;
pub(crate) mod missing_libraries;
pub(crate) mod process;
pub(crate) mod project;
pub(crate) mod solc;
#[cfg(not(target_os = "emscripten"))] #[cfg(not(target_os = "emscripten"))]
pub mod test_utils; pub mod test_utils;
pub mod tests; pub mod tests;
pub(crate) mod version;
use std::collections::BTreeSet; /// The rayon worker stack size.
use std::io::Write; pub const RAYON_WORKER_STACK_SIZE: usize = 64 * 1024 * 1024;
use std::path::PathBuf;
use revive_solc_json_interface::standard_json::input::settings::metadata_hash::MetadataHash;
use revive_solc_json_interface::ResolcWarning;
use revive_solc_json_interface::SolcStandardJsonInput;
use revive_solc_json_interface::SolcStandardJsonInputLanguage;
use revive_solc_json_interface::SolcStandardJsonInputSettingsOptimizer;
use revive_solc_json_interface::SolcStandardJsonInputSettingsPolkaVM;
use revive_solc_json_interface::SolcStandardJsonInputSettingsPolkaVMMemory;
use revive_solc_json_interface::SolcStandardJsonInputSettingsSelection;
/// Runs the Yul mode. /// Runs the Yul mode.
pub fn yul<T: Compiler>( pub fn yul<T: Compiler>(
solc: &T,
input_files: &[PathBuf], input_files: &[PathBuf],
solc: &mut T, libraries: &[String],
optimizer_settings: revive_llvm_context::OptimizerSettings, metadata_hash: MetadataHash,
include_metadata_hash: bool, messages: &mut Vec<SolcStandardJsonOutputError>,
mut debug_config: revive_llvm_context::DebugConfig, optimizer_settings: OptimizerSettings,
debug_config: DebugConfig,
llvm_arguments: &[String], llvm_arguments: &[String],
memory_config: SolcStandardJsonInputSettingsPolkaVMMemory, memory_config: SolcStandardJsonInputSettingsPolkaVMMemory,
) -> anyhow::Result<Build> { ) -> anyhow::Result<Build> {
let path = match input_files.len() { let libraries = SolcStandardJsonInputSettingsLibraries::try_from(libraries)?;
1 => input_files.first().expect("Always exists"), solc.validate_yul_paths(input_files, libraries.clone(), messages)?;
0 => anyhow::bail!("The input file is missing"),
length => anyhow::bail!(
"Only one input file is allowed in the Yul mode, but found {}",
length,
),
};
if solc.version()?.default != solc::LAST_SUPPORTED_VERSION { let linker_symbols = libraries.as_linker_symbols()?;
anyhow::bail!( let project = Project::try_from_yul_paths(input_files, None, libraries, &debug_config)?;
"The Yul mode is only supported with the most recent version of the Solidity compiler: {}", let mut build = project.compile(
solc::LAST_SUPPORTED_VERSION, messages,
);
}
let solc_validator = Some(&*solc);
let project = Project::try_from_yul_path(path, solc_validator)?;
debug_config.set_yul_path(path);
let build = project.compile(
optimizer_settings, optimizer_settings,
include_metadata_hash, metadata_hash,
debug_config, &debug_config,
llvm_arguments,
memory_config,
)?;
Ok(build)
}
/// Runs the LLVM IR mode.
pub fn llvm_ir(
input_files: &[PathBuf],
optimizer_settings: revive_llvm_context::OptimizerSettings,
include_metadata_hash: bool,
debug_config: revive_llvm_context::DebugConfig,
llvm_arguments: &[String],
memory_config: SolcStandardJsonInputSettingsPolkaVMMemory,
) -> anyhow::Result<Build> {
let path = match input_files.len() {
1 => input_files.first().expect("Always exists"),
0 => anyhow::bail!("The input file is missing"),
length => anyhow::bail!(
"Only one input file is allowed in the LLVM IR mode, but found {}",
length,
),
};
let project = Project::try_from_llvm_ir_path(path)?;
let build = project.compile(
optimizer_settings,
include_metadata_hash,
debug_config,
llvm_arguments, llvm_arguments,
memory_config, memory_config,
)?; )?;
build.take_and_write_warnings();
build.check_errors()?;
let mut build = build.link(linker_symbols, &debug_config);
build.take_and_write_warnings();
build.check_errors()?;
Ok(build) Ok(build)
} }
/// Runs the standard output mode. /// Runs the standard output mode.
#[allow(clippy::too_many_arguments)]
pub fn standard_output<T: Compiler>( pub fn standard_output<T: Compiler>(
solc: &T,
input_files: &[PathBuf], input_files: &[PathBuf],
libraries: Vec<String>, libraries: &[String],
solc: &mut T, metadata_hash: MetadataHash,
evm_version: Option<revive_common::EVMVersion>, messages: &mut Vec<SolcStandardJsonOutputError>,
evm_version: Option<EVMVersion>,
solc_optimizer_enabled: bool, solc_optimizer_enabled: bool,
optimizer_settings: revive_llvm_context::OptimizerSettings, optimizer_settings: OptimizerSettings,
include_metadata_hash: bool,
base_path: Option<String>, base_path: Option<String>,
include_paths: Vec<String>, include_paths: Vec<String>,
allow_paths: Option<String>, allow_paths: Option<String>,
remappings: Option<BTreeSet<String>>, remappings: BTreeSet<String>,
suppressed_warnings: Option<Vec<ResolcWarning>>, suppressed_warnings: Vec<ResolcWarning>,
debug_config: revive_llvm_context::DebugConfig, debug_config: DebugConfig,
llvm_arguments: &[String], llvm_arguments: Vec<String>,
memory_config: SolcStandardJsonInputSettingsPolkaVMMemory, memory_config: SolcStandardJsonInputSettingsPolkaVMMemory,
) -> anyhow::Result<Build> { ) -> anyhow::Result<Build> {
let solc_version = solc.version()?; let solc_version = solc.version()?;
let mut solc_input = SolcStandardJsonInput::try_from_solidity_paths(
let solc_input = SolcStandardJsonInput::try_from_paths(
SolcStandardJsonInputLanguage::Solidity,
evm_version, evm_version,
input_files, input_files,
libraries, libraries,
@@ -150,162 +131,211 @@ pub fn standard_output<T: Compiler>(
SolcStandardJsonInputSettingsSelection::new_required(), SolcStandardJsonInputSettingsSelection::new_required(),
SolcStandardJsonInputSettingsOptimizer::new( SolcStandardJsonInputSettingsOptimizer::new(
solc_optimizer_enabled, solc_optimizer_enabled,
None, SolcStandardJsonInputSettingsOptimizer::default_mode(),
&solc_version.default, Default::default(),
optimizer_settings.is_fallback_to_size_enabled(),
), ),
None, Default::default(),
suppressed_warnings, suppressed_warnings,
Some(SolcStandardJsonInputSettingsPolkaVM::new( SolcStandardJsonInputSettingsPolkaVM::new(
Some(memory_config), Some(memory_config),
debug_config.emit_debug_info, debug_config.emit_debug_info,
)), ),
llvm_arguments,
false,
)?; )?;
let mut solc_output = solc.standard_json(
&mut solc_input,
messages,
base_path,
include_paths,
allow_paths,
)?;
solc_output.take_and_write_warnings();
solc_output.check_errors()?;
let source_code_files = solc_input let linker_symbols = solc_input.settings.libraries.as_linker_symbols()?;
.sources
.iter()
.map(|(path, source)| (path.to_owned(), source.content.to_owned()))
.collect();
let libraries = solc_input.settings.libraries.clone().unwrap_or_default();
let solc_output = solc.standard_json(solc_input, base_path, include_paths, allow_paths)?;
if let Some(errors) = solc_output.errors.as_deref() {
let mut has_errors = false;
for error in errors.iter() {
if error.severity.as_str() == "error" {
has_errors = true;
}
writeln!(std::io::stderr(), "{error}")?;
}
if has_errors {
anyhow::bail!("Error(s) found. Compilation aborted");
}
}
let project = Project::try_from_standard_json_output( let project = Project::try_from_standard_json_output(
&solc_output, &mut solc_output,
source_code_files, solc_input.settings.libraries,
libraries,
&solc_version, &solc_version,
&debug_config, &debug_config,
)?; )?;
solc_output.take_and_write_warnings();
solc_output.check_errors()?;
let build = project.compile( let mut build = project.compile(
messages,
optimizer_settings, optimizer_settings,
include_metadata_hash, metadata_hash,
debug_config, &debug_config,
llvm_arguments, &solc_input.settings.llvm_arguments,
memory_config, memory_config,
)?; )?;
build.take_and_write_warnings();
build.check_errors()?;
let mut build = build.link(linker_symbols, &debug_config);
build.take_and_write_warnings();
build.check_errors()?;
Ok(build) Ok(build)
} }
/// Runs the standard JSON mode. /// Runs the standard JSON mode.
#[allow(clippy::too_many_arguments)]
pub fn standard_json<T: Compiler>( pub fn standard_json<T: Compiler>(
solc: &mut T, solc: &T,
detect_missing_libraries: bool, metadata_hash: MetadataHash,
messages: &mut Vec<SolcStandardJsonOutputError>,
json_path: Option<PathBuf>,
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, mut debug_config: DebugConfig,
llvm_arguments: &[String], detect_missing_libraries: bool,
) -> anyhow::Result<()> { ) -> anyhow::Result<()> {
let solc_version = solc.version()?; let solc_version = solc.version()?;
let mut solc_input = SolcStandardJsonInput::try_from(json_path.as_deref())?;
let language = solc_input.language;
let prune_output = solc_input.settings.selection_to_prune();
let deployed_libraries = solc_input.settings.libraries.as_paths();
let linker_symbols = solc_input.settings.libraries.as_linker_symbols()?;
let optimizer_settings = OptimizerSettings::try_from_cli(solc_input.settings.optimizer.mode)?;
let detect_missing_libraries =
solc_input.settings.detect_missing_libraries || detect_missing_libraries;
debug_config.emit_debug_info = solc_input
.settings
.polkavm
.debug_information
.unwrap_or(false);
solc_input.extend_selection(SolcStandardJsonInputSettingsSelection::new_required());
let mut solc_output = solc.standard_json(
&mut solc_input,
messages,
base_path,
include_paths,
allow_paths,
)?;
let solc_input = SolcStandardJsonInput::try_from_stdin()?; let (mut solc_output, project) = match language {
let source_code_files = solc_input SolcStandardJsonInputLanguage::Solidity => {
.sources
.iter()
.map(|(path, source)| (path.to_owned(), source.content.to_owned()))
.collect();
let optimizer_settings =
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 {
Some(ref metadata) => metadata.bytecode_hash != Some(MetadataHash::None),
None => true,
};
let libraries = solc_input.settings.libraries.clone().unwrap_or_default();
let mut solc_output = solc.standard_json(solc_input, base_path, include_paths, allow_paths)?;
if let Some(errors) = solc_output.errors.as_deref() {
for error in errors.iter() {
if error.severity.as_str() == "error" {
serde_json::to_writer(std::io::stdout(), &solc_output)?;
std::process::exit(0);
}
}
}
let project = Project::try_from_standard_json_output( let project = Project::try_from_standard_json_output(
&solc_output, &mut solc_output,
source_code_files, solc_input.settings.libraries,
libraries,
&solc_version, &solc_version,
&debug_config, &debug_config,
)?; )?;
(solc_output, project)
}
SolcStandardJsonInputLanguage::Yul => {
let mut solc_output = solc.validate_yul_standard_json(&mut solc_input, messages)?;
if solc_output.has_errors() {
solc_output.write_and_exit(prune_output);
}
let project = Project::try_from_yul_sources(
solc_input.sources,
solc_input.settings.libraries,
Some(&mut solc_output),
&debug_config,
)?;
(solc_output, project)
}
};
if solc_output.has_errors() {
solc_output.write_and_exit(prune_output);
}
if detect_missing_libraries { if detect_missing_libraries {
let missing_libraries = project.get_missing_libraries(); let missing_libraries = project.get_missing_libraries(&deployed_libraries);
missing_libraries.write_to_standard_json(&mut solc_output, &solc_version)?; missing_libraries.write_to_standard_json(&mut solc_output, &solc_version);
} else { solc_output.write_and_exit(prune_output);
let build = project.compile(
optimizer_settings,
include_metadata_hash,
debug_config,
llvm_arguments,
polkavm_settings
.memory_config
.unwrap_or_else(SolcStandardJsonInputSettingsPolkaVMMemory::default),
)?;
build.write_to_standard_json(&mut solc_output, &solc_version)?;
} }
serde_json::to_writer(std::io::stdout(), &solc_output)?;
std::process::exit(0); let build = project.compile(
messages,
optimizer_settings,
metadata_hash,
&debug_config,
&solc_input.settings.llvm_arguments,
solc_input
.settings
.polkavm
.memory_config
.unwrap_or_default(),
)?;
if build.has_errors() {
build.write_to_standard_json(&mut solc_output, &solc_version)?;
solc_output.write_and_exit(prune_output);
}
let build = build.link(linker_symbols, &debug_config);
build.write_to_standard_json(&mut solc_output, &solc_version)?;
solc_output.write_and_exit(prune_output);
} }
/// Runs the combined JSON mode. /// Runs the combined JSON mode.
#[allow(clippy::too_many_arguments)]
pub fn combined_json<T: Compiler>( pub fn combined_json<T: Compiler>(
solc: &T,
paths: &[PathBuf],
libraries: &[String],
metadata_hash: MetadataHash,
messages: &mut Vec<SolcStandardJsonOutputError>,
evm_version: Option<EVMVersion>,
format: String, format: String,
input_files: &[PathBuf],
libraries: Vec<String>,
solc: &mut T,
evm_version: Option<revive_common::EVMVersion>,
solc_optimizer_enabled: bool, solc_optimizer_enabled: bool,
optimizer_settings: revive_llvm_context::OptimizerSettings, optimizer_settings: OptimizerSettings,
include_metadata_hash: bool,
base_path: Option<String>, base_path: Option<String>,
include_paths: Vec<String>, include_paths: Vec<String>,
allow_paths: Option<String>, allow_paths: Option<String>,
remappings: Option<BTreeSet<String>>, remappings: BTreeSet<String>,
suppressed_warnings: Option<Vec<ResolcWarning>>, suppressed_warnings: Vec<ResolcWarning>,
debug_config: revive_llvm_context::DebugConfig, debug_config: DebugConfig,
output_directory: Option<PathBuf>, output_directory: Option<PathBuf>,
overwrite: bool, overwrite: bool,
llvm_arguments: &[String], llvm_arguments: Vec<String>,
memory_config: SolcStandardJsonInputSettingsPolkaVMMemory, memory_config: SolcStandardJsonInputSettingsPolkaVMMemory,
) -> anyhow::Result<()> { ) -> anyhow::Result<()> {
let build = standard_output( let selectors = CombinedJsonSelector::from_cli(format.as_str())
input_files, .into_iter()
libraries, .filter_map(|result| match result {
Ok(selector) => Some(selector),
Err(error) => {
messages.push(SolcStandardJsonOutputError::new_error(
error.to_string(),
None,
None,
));
None
}
})
.collect::<HashSet<_>>();
if !selectors.contains(&CombinedJsonSelector::Bytecode) {
messages.push(SolcStandardJsonOutputError::new_warning(
"Bytecode is always emitted even if the selector is not provided.".to_string(),
None,
None,
));
}
if selectors.contains(&CombinedJsonSelector::BytecodeRuntime) {
messages.push(SolcStandardJsonOutputError::new_warning(
format!("The `{}` selector does not make sense for the PVM target, since there is only one bytecode segment.", CombinedJsonSelector::BytecodeRuntime),
None,
None,
));
}
let mut combined_json = solc.combined_json(paths, selectors)?;
standard_output(
solc, solc,
paths,
libraries,
metadata_hash,
messages,
evm_version, evm_version,
solc_optimizer_enabled, solc_optimizer_enabled,
optimizer_settings, optimizer_settings,
include_metadata_hash,
base_path, base_path,
include_paths, include_paths,
allow_paths, allow_paths,
@@ -314,24 +344,57 @@ pub fn combined_json<T: Compiler>(
debug_config, debug_config,
llvm_arguments, llvm_arguments,
memory_config, memory_config,
)?; )?
.write_to_combined_json(&mut combined_json)?;
let mut combined_json = solc.combined_json(input_files, format.as_str())?;
build.write_to_combined_json(&mut combined_json)?;
match output_directory { match output_directory {
Some(output_directory) => { Some(output_directory) => {
std::fs::create_dir_all(output_directory.as_path())?; std::fs::create_dir_all(output_directory.as_path())?;
combined_json.write_to_directory(output_directory.as_path(), overwrite)?; combined_json.write_to_directory(output_directory.as_path(), overwrite)?;
}
None => {
writeln!( writeln!(
std::io::stdout(), std::io::stderr(),
"{}", "Compiler run successful. Artifact(s) can be found in directory {output_directory:?}."
serde_json::to_string(&combined_json).expect("Always valid")
)?; )?;
} }
None => {
serde_json::to_writer(std::io::stdout(), &combined_json)?;
} }
std::process::exit(0); }
std::process::exit(EXIT_CODE_SUCCESS);
}
/// Links unlinked bytecode files.
pub fn link(paths: Vec<String>, libraries: Vec<String>) -> anyhow::Result<()> {
#[cfg(feature = "parallel")]
let iter = paths.into_par_iter();
#[cfg(not(feature = "parallel"))]
let iter = paths.into_iter();
let bytecodes = iter
.map(|path| {
let bytecode = std::fs::read(path.as_str())?;
Ok((path, bytecode))
})
.collect::<anyhow::Result<BTreeMap<String, Vec<u8>>>>()?;
let output = Output::try_from(&bytecodes, &libraries)?;
#[cfg(feature = "parallel")]
let iter = output.linked.into_par_iter();
#[cfg(not(feature = "parallel"))]
let iter = output.linked.into_iter();
iter.map(|(path, bytecode)| {
std::fs::write(path, bytecode)?;
Ok(())
})
.collect::<anyhow::Result<()>>()?;
for (path, _) in output.unlinked {
println!("Warning: file '{path}' still unresolved");
}
println!("Linking completed");
std::process::exit(EXIT_CODE_SUCCESS);
} }
+96
View File
@@ -0,0 +1,96 @@
//! The Solidity to PolkaVM compiler deploy time linking library.
//!
//! # Deploy time linking
//!
//! At compile time, factory dependencies and library addresses
//! are declared but not necessarily defined.
//!
//! `resolc` will emit raw ELF objects for any contract requiring
//! deploy time linking using the `--link` flag.
//!
//! # Internals
//!
//! After all contracts have been built successfully, the compiler
//! tries to link the resulting raw ELF object files into PVM blobs.
//! This fails if any library address symbols are unknown at compile
//! time (which is better known in Solidity as the so called "deploy
//! time linking" feature). Since factory dependency symbols can be
//! resolved only after the the final PVM blob linking step, missing
//! libraries may further lead to unresolved factory dependencies.
use std::collections::BTreeMap;
use revive_common::{ObjectFormat, EXTENSION_POLKAVM_BINARY};
use revive_llvm_context::{polkavm_hash, polkavm_link};
use revive_solc_json_interface::SolcStandardJsonInputSettingsLibraries;
/// The Solidity to PolkaVM compiler deploy time linking outputs.
pub struct Output {
/// The linked objects.
pub linked: BTreeMap<String, Vec<u8>>,
/// The unlinked objects.
pub unlinked: Vec<(String, Vec<u8>)>,
}
impl Output {
/// Try linking given `libraries` into given `bytecodes`.
///
/// Bytecodes failing to fully resolve end up in [Output::unlinked].
pub fn try_from(
bytecodes: &BTreeMap<String, Vec<u8>>,
libraries: &[String],
) -> anyhow::Result<Self> {
let linker_symbols =
SolcStandardJsonInputSettingsLibraries::try_from(libraries)?.as_linker_symbols()?;
let mut linked = BTreeMap::default();
let mut unlinked = Vec::default();
let mut factory_dependencies = BTreeMap::default();
for (path, bytecode) in bytecodes {
match ObjectFormat::try_from(bytecode.as_slice()) {
Ok(ObjectFormat::ELF) => unlinked.push((path.clone(), bytecode.clone())),
Ok(ObjectFormat::PVM) => {
factory_dependencies
.insert(factory_dependency_symbol(path), polkavm_hash(bytecode));
}
Err(error) => anyhow::bail!("{path}: {error}"),
}
}
loop {
let mut linked_counter = 0;
let mut remaining_objects = Vec::new();
for (path, bytecode_buffer) in unlinked.drain(..) {
let (linked_bytecode, object_format) = polkavm_link(
&bytecode_buffer,
&linker_symbols,
&factory_dependencies,
true,
)?;
match object_format {
ObjectFormat::ELF => remaining_objects.push((path, linked_bytecode)),
ObjectFormat::PVM => {
factory_dependencies.insert(
factory_dependency_symbol(&path),
polkavm_hash(&linked_bytecode),
);
linked.insert(path, linked_bytecode);
linked_counter += 1;
}
}
}
unlinked = remaining_objects;
if linked_counter == 0 {
break;
}
}
Ok(Self { linked, unlinked })
}
}
fn factory_dependency_symbol(path: &str) -> String {
path.trim_end_matches(&format!(".{EXTENSION_POLKAVM_BINARY}"))
.to_string()
}
+7 -16
View File
@@ -1,22 +1,21 @@
//! The missing Solidity libraries. //! The missing Solidity libraries.
use std::collections::BTreeMap; use std::collections::BTreeMap;
use std::collections::HashSet; use std::collections::BTreeSet;
use revive_solc_json_interface::SolcStandardJsonOutput; use revive_solc_json_interface::SolcStandardJsonOutput;
use crate::solc::version::Version as SolcVersion; use crate::solc::version::Version as SolcVersion;
use crate::ResolcVersion;
/// The missing Solidity libraries. /// The missing Solidity libraries.
pub struct MissingLibraries { pub struct MissingLibraries {
/// The missing libraries. /// The missing libraries.
pub contract_libraries: BTreeMap<String, HashSet<String>>, pub contract_libraries: BTreeMap<String, BTreeSet<String>>,
} }
impl MissingLibraries { impl MissingLibraries {
/// A shortcut constructor. /// A shortcut constructor.
pub fn new(contract_libraries: BTreeMap<String, HashSet<String>>) -> Self { pub fn new(contract_libraries: BTreeMap<String, BTreeSet<String>>) -> Self {
Self { contract_libraries } Self { contract_libraries }
} }
@@ -25,27 +24,19 @@ impl MissingLibraries {
mut self, mut self,
standard_json: &mut SolcStandardJsonOutput, standard_json: &mut SolcStandardJsonOutput,
solc_version: &SolcVersion, solc_version: &SolcVersion,
) -> anyhow::Result<()> { ) {
let contracts = match standard_json.contracts.as_mut() { for (path, file) in standard_json.contracts.iter_mut() {
Some(contracts) => contracts, for (name, contract) in file.iter_mut() {
None => return Ok(()),
};
for (path, contracts) in contracts.iter_mut() {
for (name, contract) in contracts.iter_mut() {
let full_name = format!("{path}:{name}"); let full_name = format!("{path}:{name}");
let missing_libraries = self.contract_libraries.remove(full_name.as_str()); let missing_libraries = self.contract_libraries.remove(full_name.as_str());
if let Some(missing_libraries) = missing_libraries { if let Some(missing_libraries) = missing_libraries {
contract.missing_libraries = Some(missing_libraries); contract.missing_libraries = missing_libraries;
} }
} }
} }
standard_json.version = Some(solc_version.default.to_string()); standard_json.version = Some(solc_version.default.to_string());
standard_json.long_version = Some(solc_version.long.to_owned()); standard_json.long_version = Some(solc_version.long.to_owned());
standard_json.revive_version = Some(ResolcVersion::default().long);
Ok(())
} }
} }
+30 -12
View File
@@ -1,51 +1,69 @@
//! Process for compiling a single compilation unit. //! Process for compiling a single compilation unit.
//! The input data. //! The input data.
use std::collections::BTreeMap;
use std::collections::BTreeSet;
use revive_common::MetadataHash;
use revive_llvm_context::DebugConfig;
use revive_llvm_context::OptimizerSettings;
use revive_solc_json_interface::SolcStandardJsonInputSettingsPolkaVMMemory; use revive_solc_json_interface::SolcStandardJsonInputSettingsPolkaVMMemory;
use serde::Deserialize; use serde::Deserialize;
use serde::Serialize; use serde::Serialize;
use crate::project::contract::Contract; use crate::project::contract::Contract;
use crate::project::Project; use crate::SolcVersion;
/// The input data. /// The input data.
#[derive(Debug, Serialize, Deserialize)] #[derive(Debug, Serialize, Deserialize)]
pub struct Input { pub struct Input {
/// The contract representation. /// The contract representation.
pub contract: Contract, pub contract: Contract,
/// The project representation. /// The `solc` compiler version.
pub project: Project, pub solc_version: Option<SolcVersion>,
/// Whether to append the metadata hash. /// Whether to append the metadata hash.
pub include_metadata_hash: bool, pub metadata_hash: MetadataHash,
/// The optimizer settings. /// The optimizer settings.
pub optimizer_settings: revive_llvm_context::OptimizerSettings, pub optimizer_settings: OptimizerSettings,
/// The debug output config. /// The debug output config.
pub debug_config: revive_llvm_context::DebugConfig, pub debug_config: DebugConfig,
/// 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: SolcStandardJsonInputSettingsPolkaVMMemory,
/// Missing unlinked libraries.
pub missing_libraries: BTreeSet<String>,
/// Factory dependencies.
pub factory_dependencies: BTreeSet<String>,
/// The mapping of auxiliary identifiers, e.g. Yul object names, to full contract paths.
pub identifier_paths: BTreeMap<String, String>,
} }
impl Input { impl Input {
/// A shortcut constructor. /// A shortcut constructor.
pub fn new( pub fn new(
contract: Contract, contract: Contract,
project: Project, solc_version: Option<SolcVersion>,
include_metadata_hash: bool, metadata_hash: MetadataHash,
optimizer_settings: revive_llvm_context::OptimizerSettings, optimizer_settings: OptimizerSettings,
debug_config: revive_llvm_context::DebugConfig, debug_config: DebugConfig,
llvm_arguments: Vec<String>, llvm_arguments: Vec<String>,
memory_config: SolcStandardJsonInputSettingsPolkaVMMemory, memory_config: SolcStandardJsonInputSettingsPolkaVMMemory,
missing_libraries: BTreeSet<String>,
factory_dependencies: BTreeSet<String>,
identifier_paths: BTreeMap<String, String>,
) -> Self { ) -> Self {
Self { Self {
contract, contract,
project, solc_version,
include_metadata_hash, metadata_hash,
optimizer_settings, optimizer_settings,
debug_config, debug_config,
llvm_arguments, llvm_arguments,
memory_config, memory_config,
missing_libraries,
factory_dependencies,
identifier_paths,
} }
} }
} }

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