mirror of
https://github.com/pezkuwichain/revive.git
synced 2026-06-14 14:31:05 +00:00
Compare commits
1 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
 Cyrill Leutwiler
|
9c83352fdb |
@@ -1,13 +1,3 @@
|
||||
#!/usr/bin/env python3
|
||||
"""
|
||||
This script generates JSON files for different platforms based on GitHub release data.
|
||||
It fetches release information from a specified GitHub repository and tag,
|
||||
parses the release assets, and generates JSON files for each platform with relevant metadata.
|
||||
It also handles checksum files and updates a list.json file for each platform.
|
||||
It requires the GITHUB_TOKEN environment variable to be set for authentication.
|
||||
Usage:
|
||||
python json_generator.py <repo> <tag>
|
||||
"""
|
||||
import os
|
||||
import sys
|
||||
import json
|
||||
|
||||
@@ -1,155 +0,0 @@
|
||||
#!/usr/bin/env python3
|
||||
"""
|
||||
This script generates JSON files for different platforms based on GitHub data.
|
||||
Requires the GITHUB_SHA, FIRST_SOLC_VERSION, LAST_SOLC_VERSION, TAG and FILEPATH environment variables to be set.
|
||||
Usage:
|
||||
python json_generator_nightly.py
|
||||
"""
|
||||
import os
|
||||
import sys
|
||||
import json
|
||||
from datetime import datetime
|
||||
|
||||
def validate_env_variables():
|
||||
"""Validate that environment variables are set."""
|
||||
if "GITHUB_SHA" not in os.environ:
|
||||
print("Error: GITHUB_SHA environment variable is not set.")
|
||||
sys.exit(1)
|
||||
if "FIRST_SOLC_VERSION" not in os.environ:
|
||||
print("Error: FIRST_SOLC_VERSION environment variable is not set.")
|
||||
sys.exit(1)
|
||||
if "LAST_SOLC_VERSION" not in os.environ:
|
||||
print("Error: LAST_SOLC_VERSION environment variable is not set.")
|
||||
sys.exit(1)
|
||||
if "TAG" not in os.environ:
|
||||
print("Error: TAG environment variable is not set.")
|
||||
sys.exit(1)
|
||||
if "FILEPATH" not in os.environ:
|
||||
print("Error: FILEPATH environment variable is not set.")
|
||||
sys.exit(1)
|
||||
|
||||
|
||||
def fetch_data_file():
|
||||
"""
|
||||
Fetch the data.json file with artifacts urls and sha256 checksums
|
||||
and parse it into a single dictionary mapping artifact names to their URLs and SHAs.
|
||||
"""
|
||||
# read data.json file
|
||||
artifacts_data = {}
|
||||
data_file_path = os.environ["FILEPATH"]
|
||||
if not os.path.exists(data_file_path):
|
||||
print("Error: data.json file not found.")
|
||||
sys.exit(1)
|
||||
with open(data_file_path, 'r') as f:
|
||||
try:
|
||||
artifacts_data = json.load(f)
|
||||
except json.JSONDecodeError:
|
||||
print("Error: data.json file is not a valid JSON.")
|
||||
sys.exit(1)
|
||||
|
||||
result = {}
|
||||
|
||||
for item in artifacts_data:
|
||||
for key, value in item.items():
|
||||
if key.endswith('_url'):
|
||||
base_key = key.rsplit('_url', 1)[0]
|
||||
if base_key not in result:
|
||||
result[base_key] = {}
|
||||
result[base_key]['url'] = value
|
||||
elif key.endswith('_sha'):
|
||||
base_key = key.rsplit('_sha', 1)[0]
|
||||
if base_key not in result:
|
||||
result[base_key] = {}
|
||||
result[base_key]['sha'] = value
|
||||
|
||||
return result
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
def extract_build_hash():
|
||||
"""Extract the first 8 characters of the commit hash."""
|
||||
sha = os.environ.get("GITHUB_SHA")
|
||||
return f"commit.{sha[:8]}"
|
||||
|
||||
def generate_asset_json_nightly(name, url, checksum):
|
||||
"""Generate JSON for a specific asset."""
|
||||
# Date in format YYYY-MM-DD
|
||||
date = datetime.now().strftime("%Y.%-m.%-d")
|
||||
last_version = os.environ.get("TAG").replace('v','')
|
||||
version = f"{last_version}-nightly.{date}"
|
||||
SHA = os.environ.get("GITHUB_SHA", "")[:8]
|
||||
build = f"commit.{SHA}"
|
||||
long_version = f"{version}+{build}"
|
||||
|
||||
return {
|
||||
"name": name,
|
||||
"version": version,
|
||||
"build": build,
|
||||
"longVersion": long_version,
|
||||
"url": url,
|
||||
"sha256": checksum,
|
||||
"firstSolcVersion": os.environ.get("FIRST_SOLC_VERSION"),
|
||||
"lastSolcVersion": os.environ.get("LAST_SOLC_VERSION")
|
||||
}
|
||||
|
||||
def save_platform_json(platform_folder, asset_json):
|
||||
"""Save asset JSON and update list.json for a specific platform."""
|
||||
# Create platform folder if it doesn't exist
|
||||
os.makedirs(platform_folder, exist_ok=True)
|
||||
|
||||
# Update or create list.json
|
||||
list_file_path = os.path.join(platform_folder, "list.json")
|
||||
|
||||
if os.path.exists(list_file_path):
|
||||
with open(list_file_path, 'r') as f:
|
||||
try:
|
||||
list_data = json.load(f)
|
||||
except json.JSONDecodeError:
|
||||
list_data = {"builds": [], "releases": {}, "latestRelease": ""}
|
||||
else:
|
||||
list_data = {"builds": [], "releases": {}, "latestRelease": ""}
|
||||
|
||||
# Remove any existing entry with the same path
|
||||
list_data['builds'] = [
|
||||
build for build in list_data['builds']
|
||||
if build['version'] != asset_json['version']
|
||||
]
|
||||
# Add the new build
|
||||
list_data['builds'].append(asset_json)
|
||||
|
||||
# Update releases
|
||||
version = asset_json['version']
|
||||
list_data['releases'][version] = f"{asset_json['name']}+{asset_json['longVersion']}"
|
||||
|
||||
# Update latest release
|
||||
list_data['latestRelease'] = version
|
||||
|
||||
with open(list_file_path, 'w') as f:
|
||||
json.dump(list_data, f, indent=4)
|
||||
|
||||
def main():
|
||||
|
||||
validate_env_variables()
|
||||
data = fetch_data_file()
|
||||
|
||||
# Mapping of asset names to platform folders
|
||||
platform_mapping = {
|
||||
'resolc-x86_64-unknown-linux-musl': 'linux',
|
||||
'resolc-universal-apple-darwin': 'macos',
|
||||
'resolc-x86_64-pc-windows-msvc': 'windows',
|
||||
'resolc-web.js': 'wasm'
|
||||
}
|
||||
|
||||
# Process each asset
|
||||
for asset in data.keys():
|
||||
platform_name = platform_mapping.get(asset)
|
||||
if platform_name:
|
||||
platform_folder = os.path.join(platform_name)
|
||||
asset_json = generate_asset_json_nightly(asset, data[asset]['url'], data[asset]['sha'])
|
||||
save_platform_json(platform_folder, asset_json)
|
||||
print(f"Processed {asset} for {platform_name}")
|
||||
|
||||
if __name__ == "__main__":
|
||||
main()
|
||||
@@ -94,7 +94,7 @@ jobs:
|
||||
|
||||
- name: Install LLVM Builder
|
||||
run: |
|
||||
cargo install --locked --force --path crates/llvm-builder
|
||||
cargo install --path crates/llvm-builder
|
||||
|
||||
- name: Clone LLVM
|
||||
run: |
|
||||
|
||||
@@ -1,385 +0,0 @@
|
||||
name: Nightly Release
|
||||
on:
|
||||
schedule:
|
||||
# Run every day at 01:00 UTC
|
||||
- cron: "0 1 * * *"
|
||||
|
||||
concurrency:
|
||||
group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
|
||||
cancel-in-progress: true
|
||||
|
||||
env:
|
||||
CARGO_TERM_COLOR: always
|
||||
RUST_MUSL_CROSS_IMAGE: messense/rust-musl-cross@sha256:c0154e992adb791c3b848dd008939d19862549204f8cb26f5ca7a00f629e6067
|
||||
|
||||
jobs:
|
||||
# check if there were commits yesterday
|
||||
check_commits:
|
||||
runs-on: ubuntu-latest
|
||||
outputs:
|
||||
has_commits: ${{ steps.check_commits.outputs.has_commits }}
|
||||
steps:
|
||||
- name: Checkout repository
|
||||
uses: actions/checkout@v4
|
||||
with:
|
||||
fetch-depth: 0 # Fetch full history to check previous commits
|
||||
ref: "main"
|
||||
|
||||
- name: Check for commits from yesterday
|
||||
id: check_commits
|
||||
run: |
|
||||
# Get yesterday's date in YYYY-MM-DD format
|
||||
YESTERDAY=$(date -d "yesterday" +%Y-%m-%d)
|
||||
echo "Checking for commits from: $YESTERDAY"
|
||||
|
||||
# Check if there were any commits yesterday
|
||||
COMMIT_COUNT=$(git log --oneline --since="$YESTERDAY 00:00:00" --until="$YESTERDAY 23:59:59" | wc -l)
|
||||
|
||||
echo "Found $COMMIT_COUNT commits from yesterday"
|
||||
|
||||
if [ $COMMIT_COUNT -gt 0 ]; then
|
||||
echo "has_commits=true" >> $GITHUB_OUTPUT
|
||||
echo "✅ Found $COMMIT_COUNT commits from yesterday - continuing workflow"
|
||||
else
|
||||
echo "has_commits=false" >> $GITHUB_OUTPUT
|
||||
echo "❌ No commits found from yesterday - skipping remaining steps"
|
||||
echo "::notice::❌ No commits found from yesterday - skipping remaining steps"
|
||||
fi
|
||||
|
||||
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' }}
|
||||
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]
|
||||
steps:
|
||||
- uses: actions/checkout@v4
|
||||
- uses: actions-rust-lang/setup-rust-toolchain@v1
|
||||
with:
|
||||
# without this it will override our rust flags
|
||||
rustflags: ""
|
||||
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:
|
||||
if: ${{ needs.check_commits.outputs.has_commits == 'true' }}
|
||||
needs: [build]
|
||||
outputs:
|
||||
resolc-universal-apple-darwin_url: ${{ steps.set-output.outputs.resolc-universal-apple-darwin_url }}
|
||||
resolc-universal-apple-darwin_sha: ${{ steps.set-output.outputs.resolc-universal-apple-darwin_sha }}
|
||||
runs-on: macos-14
|
||||
steps:
|
||||
- uses: actions/download-artifact@v4
|
||||
with:
|
||||
merge-multiple: true
|
||||
|
||||
- name: Create macOS Fat Binary
|
||||
run: |
|
||||
lipo resolc-aarch64-apple-darwin resolc-x86_64-apple-darwin -create -output resolc-universal-apple-darwin
|
||||
|
||||
- name: Make Executable
|
||||
run: |
|
||||
chmod +x resolc-universal-apple-darwin
|
||||
|
||||
- uses: actions/upload-artifact@v4
|
||||
id: artifact-upload-step
|
||||
with:
|
||||
name: resolc-universal-apple-darwin
|
||||
path: resolc-universal-apple-darwin
|
||||
retention-days: 40
|
||||
|
||||
- name: Set output variables
|
||||
id: set-output
|
||||
env:
|
||||
TARGET: resolc-universal-apple-darwin
|
||||
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"
|
||||
|
||||
generate-nightly-json:
|
||||
runs-on: ubuntu-24.04
|
||||
if: ${{ needs.check_commits.outputs.has_commits == 'true' }}
|
||||
environment: tags
|
||||
needs: [build-wasm, build, create-macos-fat-binary, check_commits]
|
||||
steps:
|
||||
- name: Checkout revive
|
||||
uses: actions/checkout@v4
|
||||
with:
|
||||
path: revive
|
||||
|
||||
- name: Checkout resolc-bin
|
||||
uses: actions/checkout@v4
|
||||
with:
|
||||
repository: paritytech/resolc-bin
|
||||
path: resolc-bin
|
||||
|
||||
- name: Download Artifacts
|
||||
uses: actions/download-artifact@v4
|
||||
with:
|
||||
merge-multiple: true
|
||||
path: bins
|
||||
|
||||
- uses: actions/create-github-app-token@v1
|
||||
id: app-token
|
||||
with:
|
||||
app-id: ${{ secrets.REVIVE_JSON_APP_ID }}
|
||||
private-key: ${{ secrets.REVIVE_JSON_APP_KEY }}
|
||||
owner: paritytech
|
||||
repositories: resolc-bin
|
||||
|
||||
- name: Generate JSON
|
||||
env:
|
||||
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||
TOKEN: ${{ steps.app-token.outputs.token }}
|
||||
APP_NAME: "paritytech-revive-json"
|
||||
Green: "\e[32m"
|
||||
NC: "\e[0m"
|
||||
run: |
|
||||
echo '[' > data.json
|
||||
echo '${{ toJSON(needs.build.outputs) }}' >> 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 ']' >> data.json
|
||||
chmod +x bins/resolc-x86_64-unknown-linux-musl
|
||||
export FIRST_SOLC_VERSION=$(./bins/resolc-x86_64-unknown-linux-musl --supported-solc-versions | cut -f 1 -d "," | tr -d ">=")
|
||||
export LAST_SOLC_VERSION=$(./bins/resolc-x86_64-unknown-linux-musl --supported-solc-versions | cut -f 2 -d "," | tr -d "<=")
|
||||
export FILEPATH=$(readlink -f data.json)
|
||||
export TAG=$(cd revive;gh release list --json name,isLatest --jq '.[] | select(.isLatest)|.name')
|
||||
cd resolc-bin
|
||||
mkdir -p nightly
|
||||
cd nightly
|
||||
python3 ../../revive/.github/scripts/json_generator_nightly.py
|
||||
cd ..
|
||||
git status
|
||||
|
||||
echo "${Green}Add new remote with gh app token${NC}"
|
||||
git remote set-url origin $(git config remote.origin.url | sed "s/github.com/${APP_NAME}:${TOKEN}@github.com/g")
|
||||
|
||||
echo "${Green}Remove http section that causes issues with gh app auth token${NC}"
|
||||
sed -i.bak '/\[http/d' ./.git/config
|
||||
sed -i.bak '/extraheader/d' ./.git/config
|
||||
|
||||
git config user.email "ci@parity.io"
|
||||
git config user.name "${APP_NAME}"
|
||||
|
||||
git add nightly/
|
||||
git commit -m "Update nightly json"
|
||||
git push origin main
|
||||
|
||||
echo "::notice::nightly info.list files were successfully published to https://github.com/paritytech/resolc-bin"
|
||||
@@ -14,7 +14,6 @@ concurrency:
|
||||
|
||||
env:
|
||||
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:
|
||||
@@ -45,7 +44,7 @@ jobs:
|
||||
exit 0
|
||||
fi
|
||||
|
||||
export PKG_VER=v$(cat crates/resolc/Cargo.toml | grep -A 5 package] | grep version | cut -d '=' -f 2 | tr -d '"' | tr -d " ")
|
||||
export PKG_VER=v$(cat Cargo.toml | grep -A 5 package] | grep version | cut -d '=' -f 2 | tr -d '"' | tr -d " ")
|
||||
echo "Current tag $CURRENT_TAG"
|
||||
echo "Package version $PKG_VER"
|
||||
#
|
||||
@@ -144,7 +143,7 @@ jobs:
|
||||
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
|
||||
RELEASE_RESOLC_WASM_URI: https://github.com/paritytech/revive-workflow-test/releases/download/${{ github.ref_name }}/resolc.wasm
|
||||
steps:
|
||||
- uses: actions/checkout@v4
|
||||
- uses: actions-rust-lang/setup-rust-toolchain@v1
|
||||
|
||||
@@ -7,8 +7,6 @@ on:
|
||||
- 'LLVM.lock'
|
||||
- 'crates/llvm-builder/**'
|
||||
- '.github/workflows/test-llvm-builder.yml'
|
||||
paths-ignore:
|
||||
- "**.md"
|
||||
|
||||
concurrency:
|
||||
group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
|
||||
|
||||
@@ -2,13 +2,9 @@ name: Test Wasm Version
|
||||
on:
|
||||
push:
|
||||
branches: ["main"]
|
||||
paths-ignore:
|
||||
- "**.md"
|
||||
pull_request:
|
||||
branches: ["main"]
|
||||
types: [opened, synchronize]
|
||||
paths-ignore:
|
||||
- "**.md"
|
||||
|
||||
concurrency:
|
||||
group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
|
||||
|
||||
@@ -2,13 +2,9 @@ name: Test
|
||||
on:
|
||||
push:
|
||||
branches: ["main"]
|
||||
paths-ignore:
|
||||
- "**.md"
|
||||
pull_request:
|
||||
branches: ["main"]
|
||||
types: [opened, synchronize]
|
||||
paths-ignore:
|
||||
- "**.md"
|
||||
|
||||
concurrency:
|
||||
group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
|
||||
@@ -56,3 +52,6 @@ jobs:
|
||||
|
||||
- name: Test cargo workspace
|
||||
run: make test-workspace
|
||||
|
||||
- name: Test CLI
|
||||
run: make test-cli
|
||||
|
||||
@@ -6,51 +6,6 @@ This is a development pre-release.
|
||||
|
||||
Supported `polkadot-sdk` rev: `2503.0.1`
|
||||
|
||||
## v0.4.0
|
||||
|
||||
This is a development pre-release.
|
||||
|
||||
Supported `polkadot-sdk` rev: `2503.0.1`
|
||||
|
||||
### Added
|
||||
- Line debug information per YUL builtin and for `if` statements.
|
||||
- Column numbers in debug information.
|
||||
- Support for the YUL optimizer details in the standard json input definition.
|
||||
- The `revive-explorer` compiler utility.
|
||||
- `revive-yul`: The AST visitor interface.
|
||||
|
||||
### Fixed
|
||||
- The debug info source file matches the YUL path in `--debug-output-dir`, allowing tools to display the source line.
|
||||
|
||||
## v0.3.0
|
||||
|
||||
This is a development pre-release.
|
||||
|
||||
Supported `polkadot-sdk` rev: `2503.0.1`
|
||||
|
||||
### Fixed
|
||||
|
||||
- llvm-context: Bugfix the SAR YUL builtin translation.
|
||||
- runtime-api: Add the missing `memset` builtin.
|
||||
- npm package: Bugfix the exports field defined in the `package.json`.
|
||||
|
||||
|
||||
## v0.2.0
|
||||
|
||||
This is a development pre-release.
|
||||
|
||||
Supported `polkadot-sdk` rev: `2503.0.1`
|
||||
|
||||
### Changed
|
||||
|
||||
- Removed the license printer from the `resolc` binary.
|
||||
- EVM bytecode is no longer requested from solc (except in test utils) leading to less compilation work in the pipeline.
|
||||
|
||||
### Fixed
|
||||
|
||||
- solc-json-interface: Serializing of any custom key in the JSON input is only skipped if not provided.
|
||||
- npm package resolution no longer fails with an 'ERR_PACKAGE_PATH_NOT_EXPORTED' error for packages defining exports fields in the `package.json`.
|
||||
|
||||
## v0.1.0
|
||||
|
||||
This is a development pre-release.
|
||||
|
||||
Generated
+334
-570
File diff suppressed because it is too large
Load Diff
+35
-39
@@ -3,7 +3,7 @@ resolver = "2"
|
||||
members = ["crates/*"]
|
||||
|
||||
[workspace.package]
|
||||
version = "0.1.0"
|
||||
version = "0.1.0-dev.16"
|
||||
authors = [
|
||||
"Cyrill Leutwiler <cyrill@parity.io>",
|
||||
"Parity Technologies <admin@parity.io>",
|
||||
@@ -14,68 +14,64 @@ repository = "https://github.com/paritytech/revive"
|
||||
rust-version = "1.85.0"
|
||||
|
||||
[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" }
|
||||
revive-llvm-context = { version = "0.3.0", path = "crates/llvm-context" }
|
||||
revive-runtime-api = { version = "0.2.0", path = "crates/runtime-api" }
|
||||
revive-runner = { version = "0.1.0", path = "crates/runner" }
|
||||
revive-solc-json-interface = { version = "0.2.0", path = "crates/solc-json-interface" }
|
||||
revive-stdlib = { version = "0.1.1", path = "crates/stdlib" }
|
||||
revive-build-utils = { version = "0.1.0", path = "crates/build-utils" }
|
||||
revive-yul = { version = "0.2.1", path = "crates/yul" }
|
||||
revive-benchmarks = { version = "0.1.0-dev.16", path = "crates/benchmarks" }
|
||||
revive-builtins = { version = "0.1.0-dev.16", path = "crates/builtins" }
|
||||
revive-common = { version = "0.1.0-dev.16", path = "crates/common" }
|
||||
revive-differential = { version = "0.1.0-dev.16", path = "crates/differential" }
|
||||
revive-integration = { version = "0.1.0-dev.16", path = "crates/integration" }
|
||||
revive-linker = { version = "0.1.0-dev.16", path = "crates/linker" }
|
||||
lld-sys = { version = "0.1.0-dev.16", path = "crates/lld-sys" }
|
||||
revive-llvm-context = { version = "0.1.0-dev.16", path = "crates/llvm-context" }
|
||||
revive-runtime-api = { version = "0.1.0-dev.16", path = "crates/runtime-api" }
|
||||
revive-runner = { version = "0.1.0-dev.16", path = "crates/runner" }
|
||||
revive-solc-json-interface = { version = "0.1.0-dev.16", path = "crates/solc-json-interface" }
|
||||
revive-solidity = { version = "0.1.0-dev.16", path = "crates/solidity" }
|
||||
revive-stdlib = { version = "0.1.0-dev.16", path = "crates/stdlib" }
|
||||
revive-build-utils = { version = "0.1.0-dev.16", path = "crates/build-utils" }
|
||||
|
||||
hex = "0.4.3"
|
||||
cc = "1.2"
|
||||
libc = "0.2.172"
|
||||
tempfile = "3.20"
|
||||
tempfile = "3.17"
|
||||
anyhow = "1.0"
|
||||
semver = { version = "1.0", features = ["serde"] }
|
||||
itertools = "0.14"
|
||||
serde = { version = "1.0", features = ["derive"] }
|
||||
serde_json = { version = "1.0", features = ["arbitrary_precision"] }
|
||||
regex = "1.11"
|
||||
once_cell = "1.21"
|
||||
regex = "1.10"
|
||||
once_cell = "1.20"
|
||||
num = "0.4.3"
|
||||
sha1 = "0.10"
|
||||
sha3 = "0.10"
|
||||
thiserror = "2.0"
|
||||
which = "7.0"
|
||||
path-slash = "0.2"
|
||||
rayon = "1.10"
|
||||
rayon = "1.8"
|
||||
clap = { version = "4", default-features = false, features = ["derive"] }
|
||||
polkavm-common = "0.24.0"
|
||||
polkavm-linker = "0.24.0"
|
||||
polkavm-disassembler = "0.24.0"
|
||||
polkavm = "0.24.0"
|
||||
alloy-primitives = { version = "1.1", features = ["serde"] }
|
||||
alloy-sol-types = "1.1"
|
||||
alloy-genesis = "1.0"
|
||||
alloy-serde = "1.0"
|
||||
alloy-core = "1.3"
|
||||
env_logger = { version = "0.11.8", default-features = false }
|
||||
serde_stacker = "0.1.12"
|
||||
criterion = { version = "0.6", features = ["html_reports"] }
|
||||
log = { version = "0.4.27" }
|
||||
git2 = { version = "0.20.2", default-features = false }
|
||||
polkavm-common = "0.21.0"
|
||||
polkavm-linker = "0.21.0"
|
||||
polkavm-disassembler = "0.21.0"
|
||||
polkavm = "0.21.0"
|
||||
alloy-primitives = { version = "0.8.21", features = ["serde"] }
|
||||
alloy-sol-types = "0.8.21"
|
||||
alloy-genesis = "0.11.1"
|
||||
alloy-serde = "0.11.1"
|
||||
env_logger = { version = "0.11.6", default-features = false }
|
||||
serde_stacker = "0.1.11"
|
||||
criterion = { version = "0.5.1", features = ["html_reports"] }
|
||||
log = { version = "0.4.25" }
|
||||
git2 = { version = "0.20.0", default-features = false }
|
||||
downloader = "0.2.8"
|
||||
flate2 = "1.1"
|
||||
fs_extra = "1.3"
|
||||
flate2 = "1.0.35"
|
||||
fs_extra = "1.3.0"
|
||||
num_cpus = "1"
|
||||
tar = "0.4"
|
||||
toml = "0.8"
|
||||
assert_cmd = "2.0"
|
||||
assert_fs = "1.1"
|
||||
pallet-revive-uapi = "0.7.0"
|
||||
|
||||
# polkadot-sdk and friends
|
||||
codec = { version = "3.7.5", default-features = false, package = "parity-scale-codec" }
|
||||
codec = { version = "3.6.12", default-features = false, package = "parity-scale-codec" }
|
||||
scale-info = { version = "2.11.6", default-features = false }
|
||||
polkadot-sdk = { version = "2503.0.1" }
|
||||
|
||||
|
||||
@@ -6,14 +6,14 @@
|
||||
install-llvm-builder \
|
||||
install-llvm \
|
||||
install-revive-runner \
|
||||
install-revive-explorer \
|
||||
format \
|
||||
clippy \
|
||||
machete \
|
||||
test \
|
||||
test-integration \
|
||||
test-resolc \
|
||||
test-solidity \
|
||||
test-workspace \
|
||||
test-cli \
|
||||
test-wasm \
|
||||
test-llvm-builder
|
||||
bench \
|
||||
@@ -24,27 +24,24 @@
|
||||
install: install-bin install-npm
|
||||
|
||||
install-bin:
|
||||
cargo install --force --locked --path crates/resolc
|
||||
cargo install --locked --path crates/solidity
|
||||
|
||||
install-npm:
|
||||
npm install && npm fund
|
||||
|
||||
install-wasm: install-npm
|
||||
cargo build --target wasm32-unknown-emscripten -p resolc --release --no-default-features
|
||||
cargo build --target wasm32-unknown-emscripten -p revive-solidity --release --no-default-features
|
||||
npm run build:package
|
||||
|
||||
install-llvm-builder:
|
||||
cargo install --force --locked --path crates/llvm-builder
|
||||
cargo install --path crates/llvm-builder
|
||||
|
||||
install-llvm: install-llvm-builder
|
||||
revive-llvm clone
|
||||
revive-llvm build --llvm-projects lld --llvm-projects clang
|
||||
|
||||
install-revive-runner:
|
||||
cargo install --locked --force --path crates/runner --no-default-features
|
||||
|
||||
install-revive-explorer:
|
||||
cargo install --locked --force --path crates/explorer --no-default-features
|
||||
cargo install --path crates/runner --no-default-features --locked
|
||||
|
||||
format:
|
||||
cargo fmt --all --check
|
||||
@@ -56,17 +53,20 @@ machete:
|
||||
cargo install cargo-machete
|
||||
cargo machete
|
||||
|
||||
test: format clippy machete test-workspace install-revive-runner install-revive-explorer
|
||||
test: format clippy machete test-cli test-workspace install-revive-runner
|
||||
|
||||
test-integration: install-bin
|
||||
cargo test --package revive-integration
|
||||
|
||||
test-resolc: install
|
||||
cargo test --package resolc
|
||||
test-solidity: install
|
||||
cargo test --package revive-solidity
|
||||
|
||||
test-workspace: install
|
||||
cargo test --workspace --exclude revive-llvm-builder
|
||||
|
||||
test-cli: install
|
||||
npm run test:cli
|
||||
|
||||
test-wasm: install-wasm
|
||||
npm run test:wasm
|
||||
|
||||
@@ -90,6 +90,6 @@ clean:
|
||||
cargo clean ; \
|
||||
revive-llvm clean ; \
|
||||
rm -rf node_modules ; \
|
||||
rm -rf crates/resolc/src/tests/cli/artifacts ; \
|
||||
cargo uninstall resolc ; \
|
||||
rm -rf crates/solidity/src/tests/cli-tests/artifacts ; \
|
||||
cargo uninstall revive-solidity ; \
|
||||
cargo uninstall revive-llvm-builder ;
|
||||
|
||||
@@ -14,39 +14,7 @@ This is experimental software in active development and not ready just yet for p
|
||||
Discussion around the development is hosted on the [Polkadot Forum](https://forum.polkadot.network/t/contracts-update-solidity-on-polkavm/6949#a-new-solidity-compiler-1).
|
||||
|
||||
## Installation
|
||||
Building Solidity contracts for PolkaVM requires installing the following two compilers:
|
||||
- `resolc`: The revive Solidity compiler YUL frontend and PolkaVM code generator (provided by this repository).
|
||||
- `solc`: The [Ethereum Solidity reference compiler](https://github.com/ethereum/solidity/) implemenation.`resolc` uses `solc` during the compilation process, please refer to the [Ethereum Solidity documentation](https://docs.soliditylang.org/en/latest/installing-solidity.html) for installation instructions.
|
||||
|
||||
### `resolc` binary releases
|
||||
`resolc` is distributed as a standalone binary (with `solc` as the only external dependency). Please download one of our [binary releases](https://github.com/paritytech/revive/releases) for your target platform and mind the platform specific instructions below.
|
||||
|
||||
<details>
|
||||
<summary>MacOS users</summary>
|
||||
|
||||
> **MacOS** users need to clear the `downloaded` attribute from the binary and set the executable flag.
|
||||
> ```sh
|
||||
> xattr -rc resolc-universal-apple-darwin
|
||||
> chmod +x resolc-universal-apple-darwin
|
||||
> ```
|
||||
|
||||
</details>
|
||||
|
||||
<details>
|
||||
<summary>Linux users</summary>
|
||||
|
||||
> **Linux** users need to set the executable flag.
|
||||
> ```sh
|
||||
> chmod +x resolc-x86_64-unknown-linux-musl
|
||||
> ```
|
||||
|
||||
</details>
|
||||
|
||||
|
||||
### `resolc` NPM package
|
||||
We distribute the revive compiler as [node.js module](https://www.npmjs.com/package/@parity/resolc) and [hardhat plugin](https://www.npmjs.com/package/@parity/hardhat-polkadot-resolc).
|
||||
|
||||
Note: The `solc` dependency is bundled via NPM packaging and defaults to the latest supported version.
|
||||
Please consult [the documentation](https://contracts.polkadot.io/revive_compiler/installation) for installation instructions.
|
||||
|
||||
## Building from source
|
||||
|
||||
@@ -76,7 +44,9 @@ export LLVM_SYS_181_PREFIX=</path/to/the/extracted/archive>/target-llvm/gnu/targ
|
||||
<details>
|
||||
<summary>Building from source</summary>
|
||||
|
||||
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:
|
||||
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:
|
||||
|
||||
```sh
|
||||
make install-llvm
|
||||
@@ -129,6 +99,8 @@ Ensure that your branch passes `make test` locally when submitting a pull reques
|
||||
### Design overview
|
||||
See the [relevant section in our documentation](https://contracts.polkadot.io/revive_compiler/architecture) to learn more about how the compiler works.
|
||||
|
||||
[Frontend](https://github.com/matter-labs/era-compiler-solidity) and [code generator](https://github.com/matter-labs/era-compiler-llvm-context) are based of ZKSync `zksolc` (the project started as a fork of the era compiler).
|
||||
|
||||
### Tests
|
||||
|
||||
Before running the tests, ensure that Geth (Go Ethereum) is installed on your system. Follow the installation guide here: [Installing Geth](https://geth.ethereum.org/docs/getting-started/installing-geth).
|
||||
@@ -137,8 +109,3 @@ Once Geth is installed, you can run the tests using the following command:
|
||||
```sh
|
||||
make test
|
||||
```
|
||||
# Acknowledgements
|
||||
|
||||
The revive compiler project, after some early experiments with EVM bytecode translations, decided to fork the `era-compiler` framework.
|
||||
[Frontend](https://github.com/matter-labs/era-compiler-solidity), [code generator](https://github.com/matter-labs/era-compiler-llvm-context) and some supporting libraries are based of ZKSync `zksolc`. I'd like to express my gratitude and thank the original authors for providing a useable code base under a generous license.
|
||||
|
||||
|
||||
+3
-7
@@ -4,15 +4,11 @@ Prior to the first stable release we neither have formal release processes nor d
|
||||
|
||||
To create a new pre-release:
|
||||
|
||||
1. Create a release PR which, if necessary:
|
||||
- Updates the versions in the workspace `Cargo.toml`
|
||||
- Updates the version in each crate `Cargo.toml`
|
||||
- Updates the version of the NPM package in `js/resolc/package.json`
|
||||
- Updates the `CHANGELOG.md` to reflect all observable changes
|
||||
1. Create a release PR which updates the `-dev.X` versions in the workspace `Cargo.toml` and updates the `CHANGELOG.md` accordingly.
|
||||
2. If the CI passes, merge the release PR.
|
||||
3. Push a `vX.Y.Z` tag that has the same version as in `Cargo.toml`
|
||||
3. Push a tag that has the same `-dev.X` version as in `Cargo.toml`
|
||||
4. The release workflow will attempt to build and publish a new pre-release if the latest tag does match the cargo package version.
|
||||
5. Wait for the `Release` workflow to finish. It should create the pre-release with the same name.
|
||||
5. Wait for the `Release` workflow to finish. It should create the pre-release with the same `-dev.X` name.
|
||||
6. Check that pre-release was created on the [Releases page](https://github.com/paritytech/revive/releases) with all artifacts.
|
||||
7. After the release is published, another workflow should start automatically and update json files in https://github.com/paritytech/resolc-bin. Check the changes.
|
||||
8. Update the [contract-docs](https://github.com/paritytech/contract-docs/) accordingly
|
||||
|
||||
@@ -1,6 +1,5 @@
|
||||
[package]
|
||||
name = "revive-differential"
|
||||
description = "utilities for differential testing the revive compiler against EVM"
|
||||
version.workspace = true
|
||||
license.workspace = true
|
||||
edition.workspace = true
|
||||
@@ -14,4 +13,4 @@ serde = { workspace = true }
|
||||
serde_json = { workspace = true }
|
||||
alloy-primitives = { workspace = true, features = ["serde"] }
|
||||
alloy-genesis = { workspace = true }
|
||||
alloy-serde = { workspace = true }
|
||||
alloy-serde = { workspace = true }
|
||||
@@ -1,20 +0,0 @@
|
||||
[package]
|
||||
name = "revive-explorer"
|
||||
version.workspace = true
|
||||
license.workspace = true
|
||||
edition.workspace = true
|
||||
repository.workspace = true
|
||||
authors.workspace = true
|
||||
description = "Helper utility to inspect debug builds"
|
||||
|
||||
[[bin]]
|
||||
name = "revive-explorer"
|
||||
path = "src/main.rs"
|
||||
|
||||
[dependencies]
|
||||
anyhow = { workspace = true }
|
||||
clap = { workspace = true, features = ["help", "std", "derive"] }
|
||||
num_cpus = { workspace = true }
|
||||
|
||||
revive-yul = { workspace = true }
|
||||
|
||||
@@ -1,49 +0,0 @@
|
||||
# revive-explorer
|
||||
|
||||
The `revive-explorer` is a helper utility for exploring the compilers YUL lowering unit.
|
||||
|
||||
It analyzes a given shared objects from the debug dump and outputs:
|
||||
- The count of each YUL statement translated.
|
||||
- A per YUL statement break-down of bytecode size contributed per.
|
||||
- Estimated `yul-phaser` cost parameters.
|
||||
|
||||
Example:
|
||||
|
||||
```
|
||||
statements count:
|
||||
block 532
|
||||
Caller 20
|
||||
Not 73
|
||||
Gas 24
|
||||
Shr 2
|
||||
...
|
||||
Shl 259
|
||||
SetImmutable 2
|
||||
CodeSize 1
|
||||
CallDataLoad 87
|
||||
Return 56
|
||||
bytes per statement:
|
||||
Or 756
|
||||
CodeCopy 158
|
||||
Log3 620
|
||||
Return 1562
|
||||
MStore 36128
|
||||
...
|
||||
ReturnDataCopy 2854
|
||||
DataOffset 28
|
||||
assignment 1194
|
||||
Number 540
|
||||
CallValue 4258
|
||||
yul-phaser parameters:
|
||||
--break-cost 1
|
||||
--variable-declaration-cost 3
|
||||
--function-call-cost 8
|
||||
--if-cost 4
|
||||
--expression-statement-cost 6
|
||||
--function-definition-cost 11
|
||||
--switch-cost 3
|
||||
--block-cost 1
|
||||
--leave-cost 1
|
||||
--assignment-cost 1
|
||||
```
|
||||
|
||||
@@ -1,68 +0,0 @@
|
||||
//! The `llvm-dwarfdump` utility helper library.
|
||||
|
||||
use std::{
|
||||
path::{Path, PathBuf},
|
||||
process::{Command, Stdio},
|
||||
};
|
||||
|
||||
pub static EXECUTABLE: &str = "llvm-dwarfdump";
|
||||
pub static DEBUG_LINES_ARGUMENTS: [&str; 1] = ["--debug-line"];
|
||||
pub static SOURCE_FILE_ARGUMENTS: [&str; 1] = ["--show-sources"];
|
||||
|
||||
/// Calls the `llvm-dwarfdump` tool to extract debug line information
|
||||
/// from the shared object at `path`. Returns the output.
|
||||
///
|
||||
/// Provide `Some(dwarfdump_exectuable)` to override the default executable.
|
||||
pub fn debug_lines(
|
||||
shared_object: &Path,
|
||||
dwarfdump_executable: &Option<PathBuf>,
|
||||
) -> anyhow::Result<String> {
|
||||
dwarfdump(shared_object, dwarfdump_executable, &DEBUG_LINES_ARGUMENTS)
|
||||
}
|
||||
|
||||
/// Calls the `llvm-dwarfdump` tool to extract the source file name.
|
||||
/// Returns the source file path.
|
||||
///
|
||||
/// Provide `Some(dwarfdump_exectuable)` to override the default executable.
|
||||
pub fn source_file(
|
||||
shared_object: &Path,
|
||||
dwarfdump_executable: &Option<PathBuf>,
|
||||
) -> anyhow::Result<PathBuf> {
|
||||
let output = dwarfdump(shared_object, dwarfdump_executable, &SOURCE_FILE_ARGUMENTS)?;
|
||||
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.
|
||||
fn dwarfdump(
|
||||
shared_object: &Path,
|
||||
dwarfdump_executable: &Option<PathBuf>,
|
||||
arguments: &[&str],
|
||||
) -> anyhow::Result<String> {
|
||||
let executable = dwarfdump_executable
|
||||
.to_owned()
|
||||
.unwrap_or_else(|| PathBuf::from(EXECUTABLE));
|
||||
|
||||
let output = Command::new(executable)
|
||||
.args(arguments)
|
||||
.arg(shared_object)
|
||||
.stdin(Stdio::null())
|
||||
.stdout(Stdio::piped())
|
||||
.stderr(Stdio::piped())
|
||||
.spawn()?
|
||||
.wait_with_output()?;
|
||||
|
||||
if !output.status.success() {
|
||||
anyhow::bail!(String::from_utf8_lossy(&output.stderr).to_string());
|
||||
}
|
||||
|
||||
Ok(String::from_utf8_lossy(&output.stdout).to_string())
|
||||
}
|
||||
@@ -1,222 +0,0 @@
|
||||
//! The core dwarf dump analyzer library.
|
||||
|
||||
use std::{
|
||||
collections::HashMap,
|
||||
path::{Path, PathBuf},
|
||||
};
|
||||
|
||||
use revive_yul::lexer::token::location::Location;
|
||||
|
||||
use crate::location_mapper::{self, LocationMapper};
|
||||
|
||||
/// The dwarf dump analyzer.
|
||||
///
|
||||
/// Loads debug information from `llvm-dwarfdump` and calculates statistics
|
||||
/// about the compiled YUL statements:
|
||||
/// - Statements count
|
||||
/// - Per-statement
|
||||
#[derive(Debug, Default)]
|
||||
pub struct DwarfdumpAnalyzer {
|
||||
/// The YUL source file path.
|
||||
source: PathBuf,
|
||||
|
||||
/// The YUL location to statements map.
|
||||
location_map: HashMap<Location, String>,
|
||||
|
||||
/// The `llvm-dwarfdump --debug-lines` output.
|
||||
debug_lines: String,
|
||||
|
||||
/// The observed statements.
|
||||
statements_count: HashMap<String, usize>,
|
||||
/// The observed statement to instructions size.
|
||||
statements_size: HashMap<String, u64>,
|
||||
}
|
||||
|
||||
impl DwarfdumpAnalyzer {
|
||||
/// The debug info analyzer constructor.
|
||||
///
|
||||
/// `source` is the path to the YUL source file.
|
||||
/// `debug_lines` is the `llvm-dwarfdump --debug-lines` output.
|
||||
pub fn new(source: &Path, debug_lines: String) -> Self {
|
||||
Self {
|
||||
source: source.to_path_buf(),
|
||||
debug_lines,
|
||||
..Default::default()
|
||||
}
|
||||
}
|
||||
|
||||
/// Run the analysis.
|
||||
pub fn analyze(&mut self) -> anyhow::Result<()> {
|
||||
self.map_locations()?;
|
||||
self.analyze_statements()?;
|
||||
Ok(())
|
||||
}
|
||||
|
||||
/// Populate the maps so that we can always unwrap later.
|
||||
fn map_locations(&mut self) -> anyhow::Result<()> {
|
||||
self.location_map = LocationMapper::map_locations(&self.source)?;
|
||||
|
||||
self.statements_count = HashMap::with_capacity(self.location_map.len());
|
||||
self.statements_size = HashMap::with_capacity(self.location_map.len());
|
||||
|
||||
for statement in self.location_map.values() {
|
||||
if !self.statements_size.contains_key(statement) {
|
||||
self.statements_size.insert(statement.clone(), 0);
|
||||
}
|
||||
|
||||
*self.statements_count.entry(statement.clone()).or_insert(0) += 1;
|
||||
}
|
||||
|
||||
Ok(())
|
||||
}
|
||||
|
||||
/// Analyze how much bytes of insturctions each statement contributes.
|
||||
fn analyze_statements(&mut self) -> anyhow::Result<()> {
|
||||
let mut previous_offset = 0;
|
||||
let mut previous_location = Location::new(0, 0);
|
||||
|
||||
for line in self
|
||||
.debug_lines
|
||||
.lines()
|
||||
.skip_while(|line| !line.starts_with("Address"))
|
||||
.skip(2)
|
||||
{
|
||||
let mut parts = line.split_whitespace();
|
||||
let (Some(offset), Some(line), Some(column)) =
|
||||
(parts.next(), parts.next(), parts.next())
|
||||
else {
|
||||
continue;
|
||||
};
|
||||
|
||||
let current_offset = u64::from_str_radix(offset.trim_start_matches("0x"), 16)?;
|
||||
let mut current_location = Location::new(line.parse()?, column.parse()?);
|
||||
|
||||
// TODO: A bug? Needs further investigation.
|
||||
if current_location.line == 0 && current_location.column != 0 {
|
||||
current_location.line = previous_location.line;
|
||||
}
|
||||
|
||||
if let Some(statement) = self.location_map.get(&previous_location) {
|
||||
let contribution = current_offset - previous_offset;
|
||||
*self.statements_size.get_mut(statement).unwrap() += contribution;
|
||||
}
|
||||
|
||||
previous_offset = current_offset;
|
||||
previous_location = current_location;
|
||||
}
|
||||
|
||||
Ok(())
|
||||
}
|
||||
|
||||
/// Print the per-statement count break-down.
|
||||
pub fn display_statement_count(&self) {
|
||||
println!("statements count:");
|
||||
for (statement, count) in self.statements_count.iter() {
|
||||
println!("\t{statement} {count}");
|
||||
}
|
||||
}
|
||||
|
||||
/// Print the per-statement byte size contribution break-down.
|
||||
pub fn display_statement_size(&self) {
|
||||
println!("bytes per statement:");
|
||||
for (statement, size) in self.statements_size.iter() {
|
||||
println!("\t{statement} {size}");
|
||||
}
|
||||
}
|
||||
|
||||
/// Print the estimated `yul-phaser` cost parameters.
|
||||
pub fn display_phaser_costs(&self, yul_phaser_scale: u64) {
|
||||
println!("yul-phaser parameters:");
|
||||
for (parameter, cost) in self.phaser_costs(yul_phaser_scale) {
|
||||
println!("\t{parameter} {cost}");
|
||||
}
|
||||
}
|
||||
|
||||
/// Estimate the `yul-phaser` costs using the simplified weight function:
|
||||
/// `Total size / toal count = cost`
|
||||
pub fn phaser_costs(&self, yul_phaser_scale: u64) -> Vec<(String, u64)> {
|
||||
let mut costs: HashMap<String, (usize, u64)> = HashMap::with_capacity(16);
|
||||
for (statement, count) in self
|
||||
.statements_count
|
||||
.iter()
|
||||
.filter(|(_, count)| **count > 0)
|
||||
{
|
||||
let size = self.statements_size.get(statement).unwrap();
|
||||
let cost = match statement.as_str() {
|
||||
location_mapper::FOR => "--for-loop-cost",
|
||||
location_mapper::OTHER => continue,
|
||||
location_mapper::INTERNAL => continue,
|
||||
location_mapper::BLOCK => "--block-cost",
|
||||
location_mapper::FUNCTION_CALL => "--function-call-cost",
|
||||
location_mapper::IF => "--if-cost",
|
||||
location_mapper::SWITCH => "--switch-cost",
|
||||
location_mapper::DECLARATION => "--variable-declaration-cost",
|
||||
location_mapper::ASSIGNMENT => "--assignment-cost",
|
||||
location_mapper::FUNCTION_DEFINITION => "--function-definition-cost",
|
||||
location_mapper::IDENTIFIER => "--identifier-cost",
|
||||
location_mapper::LITERAL => "--literal-cost",
|
||||
_ => "--expression-statement-cost",
|
||||
};
|
||||
|
||||
let entry = costs.entry(cost.to_string()).or_default();
|
||||
entry.0 += count;
|
||||
entry.1 += size;
|
||||
}
|
||||
|
||||
let costs = costs
|
||||
.iter()
|
||||
.map(|(cost, (count, size))| {
|
||||
let ratio = *size / *count as u64;
|
||||
(cost.to_string(), ratio.min(100))
|
||||
})
|
||||
.collect::<Vec<_>>();
|
||||
|
||||
let scaled_costs = scale_to(
|
||||
costs
|
||||
.iter()
|
||||
.map(|(_, ratio)| *ratio)
|
||||
.collect::<Vec<_>>()
|
||||
.as_slice(),
|
||||
yul_phaser_scale,
|
||||
);
|
||||
|
||||
costs
|
||||
.iter()
|
||||
.zip(scaled_costs)
|
||||
.map(|((cost, _), scaled_ratio)| (cost.to_string(), scaled_ratio))
|
||||
.collect()
|
||||
}
|
||||
}
|
||||
|
||||
/// Given a slice of u64 values, returns a Vec<u64> where each element
|
||||
/// is linearly scaled into the closed interval [1, 10].
|
||||
fn scale_to(data: &[u64], scale_max: u64) -> Vec<u64> {
|
||||
if data.is_empty() {
|
||||
return Vec::new();
|
||||
}
|
||||
|
||||
let mut min = data[0];
|
||||
let mut max = data[0];
|
||||
for &x in &data[1..] {
|
||||
if x < min {
|
||||
min = x;
|
||||
}
|
||||
if x > max {
|
||||
max = x;
|
||||
}
|
||||
}
|
||||
if max < scale_max {
|
||||
return data.to_vec();
|
||||
}
|
||||
|
||||
let range = max - min;
|
||||
data.iter()
|
||||
.map(|&x| {
|
||||
if range == 0 {
|
||||
1
|
||||
} else {
|
||||
1 + (x - min) * scale_max / range
|
||||
}
|
||||
})
|
||||
.collect()
|
||||
}
|
||||
@@ -1,6 +0,0 @@
|
||||
//! The revive explorer leverages debug info to get insights into emitted code.
|
||||
|
||||
pub mod dwarfdump;
|
||||
pub mod dwarfdump_analyzer;
|
||||
pub mod location_mapper;
|
||||
pub mod yul_phaser;
|
||||
@@ -1,123 +0,0 @@
|
||||
//! The location mapper utility maps YUL source locations to AST statements.
|
||||
|
||||
use std::{collections::HashMap, path::Path};
|
||||
|
||||
use revive_yul::{
|
||||
lexer::{token::location::Location, Lexer},
|
||||
parser::{
|
||||
identifier::Identifier,
|
||||
statement::{
|
||||
assignment::Assignment,
|
||||
block::Block,
|
||||
expression::{function_call::FunctionCall, literal::Literal},
|
||||
for_loop::ForLoop,
|
||||
function_definition::FunctionDefinition,
|
||||
if_conditional::IfConditional,
|
||||
object::Object,
|
||||
switch::Switch,
|
||||
variable_declaration::VariableDeclaration,
|
||||
},
|
||||
},
|
||||
visitor::{AstNode, AstVisitor},
|
||||
};
|
||||
|
||||
/// Code attributed to an unknown location.
|
||||
pub const OTHER: &str = "other";
|
||||
/// Code attributed to a compiler internal location.
|
||||
pub const INTERNAL: &str = "internal";
|
||||
/// Code attributed to a block.
|
||||
pub const BLOCK: &str = "block";
|
||||
/// Code attributed to a function call.
|
||||
pub const FUNCTION_CALL: &str = "function_call";
|
||||
/// Code attributed to a for loop.
|
||||
pub const FOR: &str = "for";
|
||||
/// Code attributed to an if statement.
|
||||
pub const IF: &str = "if";
|
||||
/// Code attributed to a switch statement.
|
||||
pub const SWITCH: &str = "switch";
|
||||
/// Code attributed to a variable declaration.
|
||||
pub const DECLARATION: &str = "let";
|
||||
/// Code attributed to a variable assignement.
|
||||
pub const ASSIGNMENT: &str = "assignment";
|
||||
/// Code attributed to a 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 mapper.
|
||||
pub struct LocationMapper(HashMap<Location, String>);
|
||||
|
||||
impl LocationMapper {
|
||||
/// 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 ast = Object::parse(&mut lexer, None).map_err(|error| {
|
||||
anyhow::anyhow!("Contract `{}` parsing error: {:?}", source.display(), error)
|
||||
})?;
|
||||
|
||||
let mut location_map = Self(Default::default());
|
||||
ast.accept(&mut location_map);
|
||||
location_map.0.insert(Location::new(0, 0), OTHER.into());
|
||||
location_map.0.insert(Location::new(1, 0), INTERNAL.into());
|
||||
|
||||
Ok(location_map.0)
|
||||
}
|
||||
}
|
||||
|
||||
impl AstVisitor for LocationMapper {
|
||||
fn visit(&mut self, node: &impl AstNode) {
|
||||
node.visit_children(self);
|
||||
}
|
||||
|
||||
fn visit_block(&mut self, node: &Block) {
|
||||
node.visit_children(self);
|
||||
self.0.insert(node.location, BLOCK.into());
|
||||
}
|
||||
|
||||
fn visit_assignment(&mut self, node: &Assignment) {
|
||||
node.visit_children(self);
|
||||
self.0.insert(node.location, ASSIGNMENT.into());
|
||||
}
|
||||
|
||||
fn visit_if_conditional(&mut self, node: &IfConditional) {
|
||||
node.visit_children(self);
|
||||
self.0.insert(node.location, IF.into());
|
||||
}
|
||||
|
||||
fn visit_variable_declaration(&mut self, node: &VariableDeclaration) {
|
||||
node.visit_children(self);
|
||||
self.0.insert(node.location, DECLARATION.into());
|
||||
}
|
||||
|
||||
fn visit_function_call(&mut self, node: &FunctionCall) {
|
||||
node.visit_children(self);
|
||||
self.0.insert(node.location, node.name.to_string());
|
||||
}
|
||||
|
||||
fn visit_function_definition(&mut self, node: &FunctionDefinition) {
|
||||
node.visit_children(self);
|
||||
self.0.insert(node.location, FUNCTION_DEFINITION.into());
|
||||
}
|
||||
|
||||
fn visit_identifier(&mut self, node: &Identifier) {
|
||||
node.visit_children(self);
|
||||
self.0.insert(node.location, IDENTIFIER.into());
|
||||
}
|
||||
|
||||
fn visit_literal(&mut self, node: &Literal) {
|
||||
node.visit_children(self);
|
||||
self.0.insert(node.location, LITERAL.into());
|
||||
}
|
||||
|
||||
fn visit_for_loop(&mut self, node: &ForLoop) {
|
||||
node.visit_children(self);
|
||||
self.0.insert(node.location, FOR.into());
|
||||
}
|
||||
|
||||
fn visit_switch(&mut self, node: &Switch) {
|
||||
node.visit_children(self);
|
||||
self.0.insert(node.location, SWITCH.into());
|
||||
}
|
||||
}
|
||||
@@ -1,59 +0,0 @@
|
||||
use std::path::PathBuf;
|
||||
|
||||
use clap::Parser;
|
||||
|
||||
use revive_explorer::{dwarfdump, dwarfdump_analyzer::DwarfdumpAnalyzer, yul_phaser};
|
||||
|
||||
/// The `revive-explorer` is a helper utility for exploring the compilers YUL lowering unit.
|
||||
///
|
||||
/// It analyzes a given shared objects from the debug dump and outputs:
|
||||
/// - The count of each YUL statement translated.
|
||||
/// - A per YUL statement break-down of bytecode size contributed per.
|
||||
/// - Estimated `yul-phaser` cost parameters.
|
||||
///
|
||||
/// Note: This tool might not be fully accurate, especially when the code was optimized.
|
||||
#[derive(Parser, Debug)]
|
||||
#[command(version, about, long_about = None)]
|
||||
struct Args {
|
||||
/// Path of the dwarfdump executable.
|
||||
#[arg(short, long)]
|
||||
dwarfdump: Option<PathBuf>,
|
||||
|
||||
/// The YUL phaser cost scale maximum value.
|
||||
#[arg(short, long, default_value_t = 10)]
|
||||
cost_scale: u64,
|
||||
|
||||
/// Run the provided yul-phaser executable using the estimated costs.
|
||||
#[arg(short, long)]
|
||||
yul_phaser: Option<PathBuf>,
|
||||
|
||||
/// Path of the shared object to analyze.
|
||||
/// It must have been compiled with debug info (-g).
|
||||
file: PathBuf,
|
||||
}
|
||||
|
||||
fn main() -> anyhow::Result<()> {
|
||||
let args = Args::parse();
|
||||
|
||||
let source_file = dwarfdump::source_file(&args.file, &args.dwarfdump)?;
|
||||
let debug_lines = dwarfdump::debug_lines(&args.file, &args.dwarfdump)?;
|
||||
let mut analyzer = DwarfdumpAnalyzer::new(source_file.as_path(), debug_lines);
|
||||
|
||||
analyzer.analyze()?;
|
||||
|
||||
if let Some(path) = args.yul_phaser.as_ref() {
|
||||
yul_phaser::run(
|
||||
path,
|
||||
source_file.as_path(),
|
||||
analyzer.phaser_costs(args.cost_scale).as_slice(),
|
||||
num_cpus::get() / 2, // TODO: should be configurable.
|
||||
)?;
|
||||
return Ok(());
|
||||
}
|
||||
|
||||
analyzer.display_statement_count();
|
||||
analyzer.display_statement_size();
|
||||
analyzer.display_phaser_costs(args.cost_scale);
|
||||
|
||||
Ok(())
|
||||
}
|
||||
@@ -1,79 +0,0 @@
|
||||
//! The revive explorer YUL phaser utility library.
|
||||
//!
|
||||
//! This can be used to invoke the `yul-phaser` utility,
|
||||
//! used to find better YUL optimizer sequences.
|
||||
|
||||
use std::{
|
||||
path::{Path, PathBuf},
|
||||
process::{Command, Stdio},
|
||||
thread,
|
||||
time::{SystemTime, UNIX_EPOCH},
|
||||
};
|
||||
|
||||
/// The `yul-phaser` sane default arguments:
|
||||
/// - Less verbose output.
|
||||
/// - Sufficient rounds.
|
||||
/// - Sufficient random population start.
|
||||
const ARGUMENTS: [&str; 6] = [
|
||||
"--hide-round",
|
||||
"--rounds",
|
||||
"1000",
|
||||
"--random-population",
|
||||
"100",
|
||||
"--show-only-top-chromosome",
|
||||
];
|
||||
|
||||
/// Run multiple YUL phaser executables in parallel.
|
||||
pub fn run(
|
||||
executable: &Path,
|
||||
source: &Path,
|
||||
costs: &[(String, u64)],
|
||||
n_threads: usize,
|
||||
) -> anyhow::Result<()> {
|
||||
let mut handles = Vec::with_capacity(n_threads);
|
||||
|
||||
for n in 0..n_threads {
|
||||
let executable = executable.to_path_buf();
|
||||
let source = source.to_path_buf();
|
||||
let costs = costs.to_vec();
|
||||
|
||||
handles.push(thread::spawn(move || {
|
||||
spawn_process(executable, source, costs, n)
|
||||
}));
|
||||
}
|
||||
|
||||
for handle in handles {
|
||||
let _ = handle.join();
|
||||
}
|
||||
|
||||
Ok(())
|
||||
}
|
||||
|
||||
/// The `yul-phaser` process spawning helper function.
|
||||
fn spawn_process(
|
||||
executable: PathBuf,
|
||||
source: PathBuf,
|
||||
costs: Vec<(String, u64)>,
|
||||
seed: usize,
|
||||
) -> anyhow::Result<()> {
|
||||
let cost_parameters = costs
|
||||
.iter()
|
||||
.flat_map(|(parameter, cost)| vec![parameter.clone(), cost.to_string()]);
|
||||
|
||||
let secs = SystemTime::now()
|
||||
.duration_since(UNIX_EPOCH)
|
||||
.expect("Time went backwards")
|
||||
.as_secs();
|
||||
|
||||
Command::new(executable)
|
||||
.args(cost_parameters)
|
||||
.args(ARGUMENTS)
|
||||
.arg("--seed")
|
||||
.arg((seed + secs as usize).to_string())
|
||||
.arg(source)
|
||||
.stdin(Stdio::null())
|
||||
.spawn()?
|
||||
.wait()?;
|
||||
|
||||
Ok(())
|
||||
}
|
||||
@@ -1,6 +1,6 @@
|
||||
[package]
|
||||
name = "revive-integration"
|
||||
version = "0.1.1"
|
||||
version.workspace = true
|
||||
license.workspace = true
|
||||
edition.workspace = true
|
||||
repository.workspace = true
|
||||
@@ -13,7 +13,7 @@ alloy-sol-types = { workspace = true }
|
||||
hex = { workspace = true }
|
||||
serde_json = { workspace = true }
|
||||
|
||||
resolc = { workspace = true }
|
||||
revive-solidity = { workspace = true }
|
||||
revive-runner = { workspace = true }
|
||||
revive-llvm-context = { workspace = true }
|
||||
|
||||
|
||||
@@ -1,10 +1,10 @@
|
||||
{
|
||||
"Baseline": 960,
|
||||
"Computation": 2367,
|
||||
"DivisionArithmetics": 9108,
|
||||
"ERC20": 17655,
|
||||
"Events": 1680,
|
||||
"FibonacciIterative": 1536,
|
||||
"Flipper": 2137,
|
||||
"SHA1": 8299
|
||||
"Baseline": 939,
|
||||
"Computation": 2282,
|
||||
"DivisionArithmetics": 8849,
|
||||
"ERC20": 18308,
|
||||
"Events": 1640,
|
||||
"FibonacciIterative": 1497,
|
||||
"Flipper": 2099,
|
||||
"SHA1": 8243
|
||||
}
|
||||
@@ -1,49 +0,0 @@
|
||||
// SPDX-License-Identifier: MIT
|
||||
pragma solidity ^0.8;
|
||||
|
||||
/* runner.json
|
||||
{
|
||||
"differential": true,
|
||||
"actions": [
|
||||
{
|
||||
"Instantiate": {
|
||||
"code": {
|
||||
"Solidity": {
|
||||
"contract": "SAR"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
]
|
||||
}
|
||||
*/
|
||||
|
||||
contract SAR {
|
||||
constructor() payable {
|
||||
assert(sar(0x03, 0x01) == 0x01);
|
||||
assert(
|
||||
sar(
|
||||
0xffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff,
|
||||
0x01
|
||||
) == 0xffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff
|
||||
);
|
||||
assert(
|
||||
sar(
|
||||
0xffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff,
|
||||
0xff
|
||||
) == 0xffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff
|
||||
);
|
||||
assert(
|
||||
sar(
|
||||
0xffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff,
|
||||
0x100
|
||||
) == 0xffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff
|
||||
);
|
||||
}
|
||||
|
||||
function sar(uint256 a, uint256 b) public pure returns (uint256 c) {
|
||||
assembly {
|
||||
c := sar(b, a)
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -1,8 +1,8 @@
|
||||
use alloy_primitives::{Address, Bytes, I256, U256};
|
||||
use alloy_sol_types::{sol, SolCall, SolConstructor};
|
||||
|
||||
use resolc::test_utils::*;
|
||||
use revive_llvm_context::OptimizerSettings;
|
||||
use revive_solidity::test_utils::*;
|
||||
|
||||
#[derive(Clone)]
|
||||
pub struct Contract {
|
||||
|
||||
@@ -60,7 +60,6 @@ test_spec!(mload, "MLoad", "MLoad.sol");
|
||||
test_spec!(delegate_no_contract, "DelegateCaller", "DelegateCaller.sol");
|
||||
test_spec!(function_type, "FunctionType", "FunctionType.sol");
|
||||
test_spec!(layout_at, "LayoutAt", "LayoutAt.sol");
|
||||
test_spec!(shift_arithmetic_right, "SAR", "SAR.sol");
|
||||
|
||||
fn instantiate(path: &str, contract: &str) -> Vec<SpecsAction> {
|
||||
vec![Instantiate {
|
||||
|
||||
@@ -6,7 +6,7 @@ authors = [
|
||||
"Anton Baliasnikov <aba@matterlabs.dev>",
|
||||
"Cyrill Leutwiler <cyrill@parity.io>",
|
||||
]
|
||||
version = "0.2.0"
|
||||
version.workspace = true
|
||||
license.workspace = true
|
||||
edition.workspace = true
|
||||
repository.workspace = true
|
||||
|
||||
@@ -59,7 +59,7 @@ Obtain a compatible build for your host platform from the release section of thi
|
||||
|
||||
* Install the builder using `cargo`:
|
||||
```shell
|
||||
cargo install --force --locked --path crates/llvm-builder
|
||||
cargo install --git https://github.com/paritytech/revive-llvm-builder --force --locked
|
||||
```
|
||||
|
||||
> 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,12 +88,7 @@ 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.
|
||||
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`:
|
||||
|
||||
```shell
|
||||
export LLVM_SYS_181_PREFIX=${PWD}/target-llvm/gnu/target-final
|
||||
```
|
||||
|
||||
You now need to export the final target directory `$LLVM_SYS_181_PREFIX`: `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`.
|
||||
|
||||
</details>
|
||||
|
||||
@@ -22,7 +22,7 @@ impl std::str::FromStr for BuildType {
|
||||
"Release" => Ok(Self::Release),
|
||||
"RelWithDebInfo" => Ok(Self::RelWithDebInfo),
|
||||
"MinSizeRel" => Ok(Self::MinSizeRel),
|
||||
value => Err(format!("Unsupported build type: `{value}`")),
|
||||
value => Err(format!("Unsupported build type: `{}`", value)),
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@@ -16,7 +16,7 @@ impl std::str::FromStr for CcacheVariant {
|
||||
match value {
|
||||
"ccache" => Ok(Self::Ccache),
|
||||
"sccache" => Ok(Self::Sccache),
|
||||
value => Err(format!("Unsupported ccache variant: `{value}`")),
|
||||
value => Err(format!("Unsupported ccache variant: `{}`", value)),
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@@ -127,22 +127,23 @@ pub fn build(
|
||||
sanitizer: Option<sanitizer::Sanitizer>,
|
||||
enable_valgrind: bool,
|
||||
) -> anyhow::Result<()> {
|
||||
log::trace!("build type: {build_type:?}");
|
||||
log::trace!("target env: {target_env:?}");
|
||||
log::trace!("targets: {targets:?}");
|
||||
log::trace!("llvm projects: {llvm_projects:?}");
|
||||
log::trace!("enable rtti: {enable_rtti:?}");
|
||||
log::trace!("default target: {default_target:?}");
|
||||
log::trace!("eneable tests: {enable_tests:?}");
|
||||
log::trace!("enable_coverage: {enable_coverage:?}");
|
||||
log::trace!("extra args: {extra_args:?}");
|
||||
log::trace!("sanitzer: {sanitizer:?}");
|
||||
log::trace!("enable valgrind: {enable_valgrind:?}");
|
||||
log::trace!("build type: {:?}", build_type);
|
||||
log::trace!("target env: {:?}", target_env);
|
||||
log::trace!("targets: {:?}", targets);
|
||||
log::trace!("llvm projects: {:?}", llvm_projects);
|
||||
log::trace!("enable rtti: {:?}", enable_rtti);
|
||||
log::trace!("default target: {:?}", default_target);
|
||||
log::trace!("eneable tests: {:?}", enable_tests);
|
||||
log::trace!("enable_coverage: {:?}", enable_coverage);
|
||||
log::trace!("extra args: {:?}", extra_args);
|
||||
log::trace!("sanitzer: {:?}", sanitizer);
|
||||
log::trace!("enable valgrind: {:?}", enable_valgrind);
|
||||
|
||||
if !PathBuf::from(LLVMPath::DIRECTORY_LLVM_SOURCE).exists() {
|
||||
log::error!(
|
||||
"LLVM project source directory {} does not exist (run `revive-llvm --target-env {target_env} clone`)",
|
||||
LLVMPath::DIRECTORY_LLVM_SOURCE
|
||||
"LLVM project source directory {} does not exist (run `revive-llvm --target-env {} clone`)",
|
||||
LLVMPath::DIRECTORY_LLVM_SOURCE,
|
||||
target_env
|
||||
)
|
||||
}
|
||||
|
||||
|
||||
@@ -22,7 +22,7 @@ impl std::str::FromStr for LLVMProject {
|
||||
"lld" => Ok(Self::LLD),
|
||||
"lldb" => Ok(Self::LLDB),
|
||||
"mlir" => Ok(Self::MLIR),
|
||||
value => Err(format!("Unsupported LLVM project to enable: `{value}`")),
|
||||
value => Err(format!("Unsupported LLVM project to enable: `{}`", value)),
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@@ -30,7 +30,7 @@ impl TryFrom<&PathBuf> for Lock {
|
||||
fn try_from(path: &PathBuf) -> Result<Self, Self::Error> {
|
||||
let mut config_str = String::new();
|
||||
let mut config_file =
|
||||
File::open(path).with_context(|| format!("Error opening {path:?} file"))?;
|
||||
File::open(path).with_context(|| format!("Error opening {:?} file", path))?;
|
||||
config_file.read_to_string(&mut config_str)?;
|
||||
Ok(toml::from_str(&config_str)?)
|
||||
}
|
||||
|
||||
@@ -29,7 +29,7 @@ impl FromStr for Platform {
|
||||
fn from_str(value: &str) -> Result<Self, Self::Err> {
|
||||
match value {
|
||||
"PolkaVM" => Ok(Self::PolkaVM),
|
||||
value => Err(format!("Unsupported platform: `{value}`")),
|
||||
value => Err(format!("Unsupported platform: `{}`", value)),
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@@ -69,8 +69,8 @@ fn main_inner() -> anyhow::Result<()> {
|
||||
})
|
||||
.collect();
|
||||
|
||||
log::debug!("extra_args: {extra_args:#?}");
|
||||
log::debug!("extra_args_unescaped: {extra_args_unescaped:#?}");
|
||||
log::debug!("extra_args: {:#?}", extra_args);
|
||||
log::debug!("extra_args_unescaped: {:#?}", extra_args_unescaped);
|
||||
|
||||
if let Some(ccache_variant) = ccache_variant {
|
||||
revive_llvm_builder::utils::check_presence(ccache_variant.to_string().as_str())?;
|
||||
|
||||
@@ -30,7 +30,7 @@ impl std::str::FromStr for Sanitizer {
|
||||
"thread" => Ok(Self::Thread),
|
||||
"dataflow" => Ok(Self::DataFlow),
|
||||
"address;undefined" => Ok(Self::AddressUndefined),
|
||||
value => Err(format!("Unsupported sanitizer: `{value}`")),
|
||||
value => Err(format!("Unsupported sanitizer: `{}`", value)),
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@@ -20,7 +20,7 @@ impl std::str::FromStr for TargetEnv {
|
||||
"gnu" => Ok(Self::GNU),
|
||||
"musl" => Ok(Self::MUSL),
|
||||
"emscripten" => Ok(Self::Emscripten),
|
||||
value => Err(format!("Unsupported target environment: `{value}`")),
|
||||
value => Err(format!("Unsupported target environment: `{}`", value)),
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@@ -15,7 +15,7 @@ impl std::str::FromStr for TargetTriple {
|
||||
fn from_str(value: &str) -> Result<Self, Self::Err> {
|
||||
match value {
|
||||
"polkavm" => Ok(Self::PolkaVM),
|
||||
value => Err(format!("Unsupported target triple: `{value}`")),
|
||||
value => Err(format!("Unsupported target triple: `{}`", value)),
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@@ -92,7 +92,7 @@ pub fn unpack_tar(filename: PathBuf, path: &str) -> anyhow::Result<()> {
|
||||
pub fn download_musl(name: &str) -> anyhow::Result<()> {
|
||||
log::info!("downloading musl {name}");
|
||||
let tar_file_name = format!("{name}.tar.gz");
|
||||
let url = format!("{MUSL_SNAPSHOTS_URL}/{tar_file_name}");
|
||||
let url = format!("{}/{tar_file_name}", MUSL_SNAPSHOTS_URL);
|
||||
let target_path = crate::llvm_path::DIRECTORY_LLVM_TARGET
|
||||
.get()
|
||||
.unwrap()
|
||||
@@ -223,6 +223,6 @@ pub fn install_emsdk() -> anyhow::Result<()> {
|
||||
/// The LLVM target directory default path.
|
||||
pub fn directory_target_llvm(target_env: crate::target_env::TargetEnv) -> PathBuf {
|
||||
crate::llvm_path::DIRECTORY_LLVM_TARGET
|
||||
.get_or_init(|| PathBuf::from(format!("./target-llvm/{target_env}/")))
|
||||
.get_or_init(|| PathBuf::from(format!("./target-llvm/{}/", target_env)))
|
||||
.clone()
|
||||
}
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
[package]
|
||||
name = "revive-llvm-context"
|
||||
version = "0.3.0"
|
||||
version.workspace = true
|
||||
license.workspace = true
|
||||
edition.workspace = true
|
||||
repository.workspace = true
|
||||
|
||||
@@ -2,7 +2,6 @@
|
||||
|
||||
pub mod ir_type;
|
||||
|
||||
use std::path::Path;
|
||||
use std::path::PathBuf;
|
||||
|
||||
use serde::Deserialize;
|
||||
@@ -17,14 +16,6 @@ pub struct DebugConfig {
|
||||
pub output_directory: Option<PathBuf>,
|
||||
/// Whether debug info should be emitted.
|
||||
pub emit_debug_info: bool,
|
||||
/// The YUL debug output file path.
|
||||
///
|
||||
/// Is expected to be configured when running in YUL mode.
|
||||
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 {
|
||||
@@ -33,41 +24,15 @@ impl DebugConfig {
|
||||
Self {
|
||||
output_directory,
|
||||
emit_debug_info,
|
||||
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.
|
||||
pub fn set_contract_path(&mut self, contract_path: &str) {
|
||||
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> {
|
||||
if let Some(path) = self.yul_path.as_ref() {
|
||||
return Some(path.clone());
|
||||
}
|
||||
|
||||
self.output_directory.as_ref().map(|output_directory| {
|
||||
let mut file_path = output_directory.to_owned();
|
||||
let full_file_name = Self::full_file_name(contract_path, None, IRType::Yul);
|
||||
file_path.push(full_file_name);
|
||||
file_path
|
||||
})
|
||||
}
|
||||
|
||||
/// Dumps the Yul IR.
|
||||
pub fn dump_yul(&self, contract_path: &str, code: &str) -> anyhow::Result<()> {
|
||||
if let Some(file_path) = self.yul_source_path(contract_path) {
|
||||
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, None, IRType::Yul);
|
||||
file_path.push(full_file_name);
|
||||
std::fs::write(file_path, code)?;
|
||||
}
|
||||
|
||||
|
||||
@@ -51,20 +51,11 @@ pub struct DebugInfo<'ctx> {
|
||||
|
||||
impl<'ctx> DebugInfo<'ctx> {
|
||||
/// A shortcut constructor.
|
||||
pub fn new(
|
||||
module: &inkwell::module::Module<'ctx>,
|
||||
debug_config: &crate::debug_config::DebugConfig,
|
||||
) -> Self {
|
||||
let module_name = module.get_name().to_string_lossy();
|
||||
let yul_name = debug_config
|
||||
.contract_path
|
||||
.as_ref()
|
||||
.map(|path| path.display().to_string());
|
||||
|
||||
pub fn new(module: &inkwell::module::Module<'ctx>) -> Self {
|
||||
let (builder, compile_unit) = module.create_debug_info_builder(
|
||||
true,
|
||||
inkwell::debug_info::DWARFSourceLanguage::C,
|
||||
yul_name.as_deref().unwrap_or_else(|| module_name.as_ref()),
|
||||
module.get_name().to_string_lossy().as_ref(),
|
||||
"",
|
||||
"",
|
||||
false,
|
||||
|
||||
@@ -48,7 +48,6 @@ where
|
||||
function_type,
|
||||
0,
|
||||
Some(inkwell::module::Linkage::External),
|
||||
None,
|
||||
)?;
|
||||
|
||||
self.inner.declare(context)
|
||||
@@ -75,6 +74,7 @@ where
|
||||
}
|
||||
|
||||
context.set_basic_block(context.current_function().borrow().return_block());
|
||||
context.set_debug_location(0, 0, None)?;
|
||||
context.build_return(None);
|
||||
|
||||
context.pop_debug_scope();
|
||||
|
||||
@@ -1,7 +1,6 @@
|
||||
//! The entry function.
|
||||
|
||||
use inkwell::types::BasicType;
|
||||
use revive_solc_json_interface::PolkaVMDefaultHeapMemorySize;
|
||||
|
||||
use crate::polkavm::context::address_space::AddressSpace;
|
||||
use crate::polkavm::context::function::runtime;
|
||||
@@ -39,12 +38,9 @@ impl Entry {
|
||||
context.xlen_type().const_zero(),
|
||||
);
|
||||
|
||||
let heap_memory_type = context.byte_type().array_type(
|
||||
context
|
||||
.memory_config
|
||||
.heap_size
|
||||
.unwrap_or(PolkaVMDefaultHeapMemorySize),
|
||||
);
|
||||
let heap_memory_type = context
|
||||
.byte_type()
|
||||
.array_type(context.memory_config.heap_size);
|
||||
context.set_global(
|
||||
crate::polkavm::GLOBAL_HEAP_MEMORY,
|
||||
heap_memory_type,
|
||||
@@ -145,7 +141,6 @@ where
|
||||
entry_function_type,
|
||||
0,
|
||||
Some(inkwell::module::Linkage::External),
|
||||
None,
|
||||
)?;
|
||||
|
||||
context.declare_global(
|
||||
|
||||
@@ -48,7 +48,6 @@ where
|
||||
function_type,
|
||||
0,
|
||||
Some(inkwell::module::Linkage::External),
|
||||
None,
|
||||
)?;
|
||||
|
||||
self.inner.declare(context)
|
||||
|
||||
@@ -25,8 +25,6 @@ use inkwell::debug_info::AsDIScope;
|
||||
use inkwell::debug_info::DIScope;
|
||||
use inkwell::types::BasicType;
|
||||
use inkwell::values::BasicValue;
|
||||
use revive_solc_json_interface::PolkaVMDefaultHeapMemorySize;
|
||||
use revive_solc_json_interface::PolkaVMDefaultStackMemorySize;
|
||||
use revive_solc_json_interface::SolcStandardJsonInputSettingsPolkaVMMemory;
|
||||
|
||||
use crate::optimizer::settings::Settings as OptimizerSettings;
|
||||
@@ -235,19 +233,13 @@ where
|
||||
Self::set_data_layout(llvm, &module);
|
||||
Self::link_stdlib_module(llvm, &module);
|
||||
Self::link_polkavm_imports(llvm, &module);
|
||||
Self::set_polkavm_stack_size(
|
||||
llvm,
|
||||
&module,
|
||||
memory_config
|
||||
.stack_size
|
||||
.unwrap_or(PolkaVMDefaultStackMemorySize),
|
||||
);
|
||||
Self::set_polkavm_stack_size(llvm, &module, memory_config.stack_size);
|
||||
Self::set_module_flags(llvm, &module);
|
||||
|
||||
let intrinsics = Intrinsics::new(llvm, &module);
|
||||
let llvm_runtime = LLVMRuntime::new(llvm, &module, &optimizer);
|
||||
let debug_info = debug_config.emit_debug_info.then(|| {
|
||||
let debug_info = DebugInfo::new(&module, &debug_config);
|
||||
let debug_info = DebugInfo::new(&module);
|
||||
debug_info.initialize_module(llvm, &module);
|
||||
debug_info
|
||||
});
|
||||
@@ -463,7 +455,6 @@ where
|
||||
r#type: inkwell::types::FunctionType<'ctx>,
|
||||
return_values_length: usize,
|
||||
linkage: Option<inkwell::module::Linkage>,
|
||||
location: Option<(u32, u32)>,
|
||||
) -> anyhow::Result<Rc<RefCell<Function<'ctx>>>> {
|
||||
let value = self.module().add_function(name, r#type, linkage);
|
||||
|
||||
@@ -479,8 +470,7 @@ where
|
||||
Some(scp) => scp,
|
||||
};
|
||||
self.push_debug_scope(func_scope.as_debug_info_scope());
|
||||
let (line, column) = location.unwrap_or((0, 0));
|
||||
self.set_debug_location(line, column, Some(func_scope.as_debug_info_scope()))?;
|
||||
self.set_debug_location(0, 0, Some(func_scope.as_debug_info_scope()))?;
|
||||
}
|
||||
|
||||
let entry_block = self.llvm.append_basic_block(value, "entry");
|
||||
@@ -535,11 +525,7 @@ where
|
||||
|
||||
/// Sets the current active function. If debug-info generation is enabled,
|
||||
/// constructs a debug-scope and pushes in on the scope-stack.
|
||||
pub fn set_current_function(
|
||||
&mut self,
|
||||
name: &str,
|
||||
location: Option<(u32, u32)>,
|
||||
) -> anyhow::Result<()> {
|
||||
pub fn set_current_function(&mut self, name: &str, line: Option<u32>) -> anyhow::Result<()> {
|
||||
let function = self.functions.get(name).cloned().ok_or_else(|| {
|
||||
anyhow::anyhow!("Failed to activate an undeclared function `{}`", name)
|
||||
})?;
|
||||
@@ -548,8 +534,7 @@ where
|
||||
if let Some(scope) = self.current_function().borrow().get_debug_scope() {
|
||||
self.push_debug_scope(scope);
|
||||
}
|
||||
let (line, column) = location.unwrap_or_default();
|
||||
self.set_debug_location(line, column, None)?;
|
||||
self.set_debug_location(line.unwrap_or_default(), 0, None)?;
|
||||
|
||||
Ok(())
|
||||
}
|
||||
@@ -730,23 +715,17 @@ where
|
||||
r#type: T,
|
||||
name: &str,
|
||||
) -> Pointer<'ctx> {
|
||||
// TODO: Revisit. While at entry should be preferred in theory:
|
||||
// - It has negligible code size impact on real word contracts.
|
||||
// - Sometimes has negative impact on code size.
|
||||
// - Messes up debug information used to analyze code size issues.
|
||||
self.build_alloca(r#type, name)
|
||||
let current_block = self.basic_block();
|
||||
let entry_block = self.current_function().borrow().entry_block();
|
||||
|
||||
// let current_block = self.basic_block();
|
||||
// let entry_block = self.current_function().borrow().entry_block();
|
||||
match entry_block.get_first_instruction() {
|
||||
Some(instruction) => self.builder().position_before(&instruction),
|
||||
None => self.builder().position_at_end(entry_block),
|
||||
}
|
||||
|
||||
// match entry_block.get_first_instruction() {
|
||||
// Some(instruction) => self.builder().position_before(&instruction),
|
||||
// None => self.builder().position_at_end(entry_block),
|
||||
// }
|
||||
|
||||
// let pointer = self.build_alloca(r#type, name);
|
||||
// self.set_basic_block(current_block);
|
||||
// pointer
|
||||
let pointer = self.build_alloca(r#type, name);
|
||||
self.set_basic_block(current_block);
|
||||
pointer
|
||||
}
|
||||
|
||||
/// Builds an aligned stack allocation at the current position.
|
||||
@@ -1464,11 +1443,7 @@ where
|
||||
}
|
||||
|
||||
pub fn heap_size(&self) -> inkwell::values::IntValue<'ctx> {
|
||||
self.xlen_type().const_int(
|
||||
self.memory_config
|
||||
.heap_size
|
||||
.unwrap_or(PolkaVMDefaultHeapMemorySize) as u64,
|
||||
false,
|
||||
)
|
||||
self.xlen_type()
|
||||
.const_int(self.memory_config.heap_size as u64, false)
|
||||
}
|
||||
}
|
||||
|
||||
@@ -35,7 +35,6 @@ where
|
||||
Self::r#type(context),
|
||||
0,
|
||||
Some(inkwell::module::Linkage::External),
|
||||
None,
|
||||
)?;
|
||||
|
||||
let mut attributes = Self::ATTRIBUTES.to_vec();
|
||||
|
||||
@@ -9,7 +9,7 @@ use crate::polkavm::DummyDependency;
|
||||
pub fn create_context(
|
||||
llvm: &inkwell::context::Context,
|
||||
optimizer_settings: OptimizerSettings,
|
||||
) -> Context<'_, DummyDependency> {
|
||||
) -> Context<DummyDependency> {
|
||||
crate::initialize_llvm(crate::Target::PVM, "resolc", Default::default());
|
||||
|
||||
let module = llvm.create_module("test");
|
||||
@@ -40,7 +40,6 @@ pub fn check_attribute_null_pointer_is_invalid() {
|
||||
.fn_type(&[context.word_type().into()], false),
|
||||
1,
|
||||
Some(inkwell::module::Linkage::External),
|
||||
None,
|
||||
)
|
||||
.expect("Failed to add function");
|
||||
assert!(!function
|
||||
@@ -64,7 +63,6 @@ pub fn check_attribute_optimize_for_size_mode_3() {
|
||||
.fn_type(&[context.word_type().into()], false),
|
||||
1,
|
||||
Some(inkwell::module::Linkage::External),
|
||||
None,
|
||||
)
|
||||
.expect("Failed to add function");
|
||||
assert!(!function
|
||||
@@ -88,7 +86,6 @@ pub fn check_attribute_optimize_for_size_mode_z() {
|
||||
.fn_type(&[context.word_type().into()], false),
|
||||
1,
|
||||
Some(inkwell::module::Linkage::External),
|
||||
None,
|
||||
)
|
||||
.expect("Failed to add function");
|
||||
assert!(function
|
||||
@@ -112,7 +109,6 @@ pub fn check_attribute_min_size_mode_3() {
|
||||
.fn_type(&[context.word_type().into()], false),
|
||||
1,
|
||||
Some(inkwell::module::Linkage::External),
|
||||
None,
|
||||
)
|
||||
.expect("Failed to add function");
|
||||
assert!(!function
|
||||
@@ -136,7 +132,6 @@ pub fn check_attribute_min_size_mode_z() {
|
||||
.fn_type(&[context.word_type().into()], false),
|
||||
1,
|
||||
Some(inkwell::module::Linkage::External),
|
||||
None,
|
||||
)
|
||||
.expect("Failed to add function");
|
||||
assert!(function
|
||||
|
||||
@@ -204,7 +204,7 @@ where
|
||||
&context.word_type().const_all_ones(),
|
||||
overflow_negative_block,
|
||||
),
|
||||
(&context.word_const(0), overflow_positive_block),
|
||||
(&context.word_const(0), overflow_block),
|
||||
]);
|
||||
Ok(result.as_basic_value())
|
||||
}
|
||||
|
||||
@@ -37,7 +37,7 @@ pub fn build_assembly_text(
|
||||
let mut disassembled_code = Vec::new();
|
||||
disassembler
|
||||
.disassemble_into(&mut disassembled_code)
|
||||
.with_context(|| format!("Failed to disassemble contract: {contract_path}"))?;
|
||||
.with_context(|| format!("Failed to disassemble contract: {}", contract_path))?;
|
||||
|
||||
let assembly_text = String::from_utf8(disassembled_code).with_context(|| {
|
||||
format!("Failed to convert disassembled code to string for contract: {contract_path}")
|
||||
|
||||
@@ -1,11 +0,0 @@
|
||||
fn main() {
|
||||
match git2::Repository::open("../..") {
|
||||
Ok(repo) => {
|
||||
let head = repo.head().expect("should have head");
|
||||
let commit = head.peel_to_commit().expect("should have commit");
|
||||
let id = &commit.id().to_string()[..7];
|
||||
println!("cargo:rustc-env=GIT_COMMIT_HASH={id}");
|
||||
}
|
||||
Err(_) => println!("cargo:rustc-env=GIT_COMMIT_HASH=unknown"),
|
||||
};
|
||||
}
|
||||
@@ -1,40 +0,0 @@
|
||||
//! The tests for running resolc with asm option.
|
||||
|
||||
#![cfg(test)]
|
||||
|
||||
use crate::tests::cli::utils;
|
||||
|
||||
const ASM_OPTION: &str = "--asm";
|
||||
|
||||
#[test]
|
||||
fn runs_with_valid_input_file() {
|
||||
let arguments = &[utils::SOLIDITY_CONTRACT_PATH, ASM_OPTION];
|
||||
let resolc_result = utils::execute_resolc(arguments);
|
||||
utils::assert_command_success(&resolc_result, "Providing a valid input file");
|
||||
|
||||
for pattern in &["deploy", "call", "seal_return"] {
|
||||
assert!(
|
||||
resolc_result.stdout.contains(pattern),
|
||||
"Expected the output to contain `{pattern}`."
|
||||
);
|
||||
}
|
||||
|
||||
let solc_result = utils::execute_solc(arguments);
|
||||
utils::assert_equal_exit_codes(&solc_result, &resolc_result);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn fails_without_input_file() {
|
||||
let arguments = &[ASM_OPTION];
|
||||
let resolc_result = utils::execute_resolc(arguments);
|
||||
utils::assert_command_failure(&resolc_result, "Omitting an input file");
|
||||
|
||||
let output = resolc_result.stderr.to_lowercase();
|
||||
assert!(
|
||||
output.contains("no input sources specified") || output.contains("compilation aborted"),
|
||||
"Expected the output to contain a specific error message."
|
||||
);
|
||||
|
||||
let solc_result = utils::execute_solc(arguments);
|
||||
utils::assert_equal_exit_codes(&solc_result, &resolc_result);
|
||||
}
|
||||
@@ -1,137 +0,0 @@
|
||||
//! The tests for running resolc with combined JSON option.
|
||||
|
||||
#![cfg(test)]
|
||||
|
||||
use revive_common;
|
||||
|
||||
use crate::tests::cli::utils;
|
||||
|
||||
const JSON_OPTION: &str = "--combined-json";
|
||||
const JSON_ARGUMENTS: &[&str] = &[
|
||||
"abi",
|
||||
"hashes",
|
||||
"metadata",
|
||||
"devdoc",
|
||||
"userdoc",
|
||||
"storage-layout",
|
||||
"ast",
|
||||
"asm",
|
||||
"bin",
|
||||
"bin-runtime",
|
||||
];
|
||||
|
||||
#[test]
|
||||
fn runs_with_valid_json_argument() {
|
||||
for json_argument in JSON_ARGUMENTS {
|
||||
let arguments = &[utils::SOLIDITY_CONTRACT_PATH, JSON_OPTION, json_argument];
|
||||
let resolc_result = utils::execute_resolc(arguments);
|
||||
assert!(
|
||||
resolc_result.success,
|
||||
"Providing the `{json_argument}` argument should succeed with exit code {}, got {}.\nDetails: {}",
|
||||
revive_common::EXIT_CODE_SUCCESS,
|
||||
resolc_result.code,
|
||||
resolc_result.stderr
|
||||
);
|
||||
|
||||
assert!(
|
||||
resolc_result.stdout.contains("contracts"),
|
||||
"Expected the output to contain a `contracts` field when using the `{json_argument}` argument."
|
||||
);
|
||||
|
||||
let solc_result = utils::execute_solc(arguments);
|
||||
utils::assert_equal_exit_codes(&solc_result, &resolc_result);
|
||||
}
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn fails_with_invalid_json_argument() {
|
||||
let arguments = &[
|
||||
utils::SOLIDITY_CONTRACT_PATH,
|
||||
JSON_OPTION,
|
||||
"invalid-argument",
|
||||
];
|
||||
let resolc_result = utils::execute_resolc(arguments);
|
||||
utils::assert_command_failure(&resolc_result, "Providing an invalid json argument");
|
||||
|
||||
assert!(
|
||||
resolc_result.stdout.contains("Invalid option"),
|
||||
"Expected the output to contain a specific error message."
|
||||
);
|
||||
|
||||
let solc_result = utils::execute_solc(arguments);
|
||||
utils::assert_equal_exit_codes(&solc_result, &resolc_result);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn fails_with_multiple_json_arguments() {
|
||||
let arguments = &[
|
||||
utils::SOLIDITY_CONTRACT_PATH,
|
||||
JSON_OPTION,
|
||||
JSON_ARGUMENTS[0],
|
||||
JSON_ARGUMENTS[1],
|
||||
];
|
||||
let resolc_result = utils::execute_resolc(arguments);
|
||||
utils::assert_command_failure(&resolc_result, "Providing multiple json arguments");
|
||||
|
||||
assert!(
|
||||
resolc_result
|
||||
.stderr
|
||||
.contains("reading error: No such file or directory"),
|
||||
"Expected the output to contain a specific error message."
|
||||
);
|
||||
|
||||
// FIX: Resolc exit code == 101
|
||||
// let solc_result = utils::execute_solc(arguments);
|
||||
// utils::assert_equal_exit_codes(&solc_result, &resolc_result);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn fails_without_json_argument() {
|
||||
let arguments = &[utils::SOLIDITY_CONTRACT_PATH, JSON_OPTION];
|
||||
let resolc_result = utils::execute_resolc(arguments);
|
||||
utils::assert_command_failure(&resolc_result, "Omitting a JSON argument");
|
||||
|
||||
assert!(
|
||||
resolc_result.stderr.contains(
|
||||
"a value is required for '--combined-json <COMBINED_JSON>' but none was supplied"
|
||||
),
|
||||
"Expected the output to contain a specific error message."
|
||||
);
|
||||
|
||||
let solc_result = utils::execute_solc(arguments);
|
||||
utils::assert_equal_exit_codes(&solc_result, &resolc_result);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn fails_without_solidity_input_file() {
|
||||
let arguments = &[JSON_OPTION, JSON_ARGUMENTS[0]];
|
||||
let resolc_result = utils::execute_resolc(arguments);
|
||||
utils::assert_command_failure(&resolc_result, "Omitting a Solidity input file");
|
||||
|
||||
assert!(
|
||||
resolc_result.stderr.contains("No input sources specified"),
|
||||
"Expected the output to contain a specific error message."
|
||||
);
|
||||
|
||||
let solc_result = utils::execute_solc(arguments);
|
||||
utils::assert_equal_exit_codes(&solc_result, &resolc_result);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn fails_with_yul_input_file() {
|
||||
for json_argument in JSON_ARGUMENTS {
|
||||
let arguments = &[utils::YUL_CONTRACT_PATH, JSON_OPTION, json_argument];
|
||||
let resolc_result = utils::execute_resolc(arguments);
|
||||
utils::assert_command_failure(&resolc_result, "Providing a Yul input file");
|
||||
|
||||
assert!(
|
||||
resolc_result
|
||||
.stderr
|
||||
.contains("ParserError: Expected identifier"),
|
||||
"Expected the output to contain a specific error message."
|
||||
);
|
||||
|
||||
let solc_result = utils::execute_solc(arguments);
|
||||
utils::assert_equal_exit_codes(&solc_result, &resolc_result);
|
||||
}
|
||||
}
|
||||
@@ -1,22 +0,0 @@
|
||||
object "Test" {
|
||||
code {
|
||||
function allocate(size) -> ptr {
|
||||
ptr := mload(0x40)
|
||||
if iszero(ptr) { ptr := 0x60 }
|
||||
mstore(0x40, add(ptr, size))
|
||||
}
|
||||
let size := datasize("Test_deployed")
|
||||
let offset := allocate(size)
|
||||
datacopy(offset, dataoffset("Test_deployed"), size)
|
||||
return(offset, size)
|
||||
}
|
||||
object "Test_deployed" {
|
||||
code {
|
||||
{
|
||||
let test:=0x5
|
||||
mstore(2,signextend(0x8,0x0))
|
||||
mstore(8,lt(0xc,test))
|
||||
}
|
||||
|
||||
return(0, 65536)
|
||||
}}}
|
||||
@@ -1,12 +0,0 @@
|
||||
//! The CLI tests.
|
||||
|
||||
#![cfg(test)]
|
||||
|
||||
mod asm;
|
||||
mod combined_json;
|
||||
mod optimization;
|
||||
mod output_dir;
|
||||
mod standard_json;
|
||||
mod usage;
|
||||
mod utils;
|
||||
mod yul;
|
||||
@@ -1,53 +0,0 @@
|
||||
//! The tests for running resolc with explicit optimization.
|
||||
|
||||
#![cfg(test)]
|
||||
|
||||
use revive_common;
|
||||
|
||||
use crate::tests::cli::{utils, yul};
|
||||
|
||||
const LEVELS: &[char] = &['0', '1', '2', '3', 's', 'z'];
|
||||
|
||||
#[test]
|
||||
fn runs_with_valid_level() {
|
||||
for level in LEVELS {
|
||||
let optimization_argument = format!("-O{level}");
|
||||
let arguments = &[
|
||||
utils::YUL_MEMSET_CONTRACT_PATH,
|
||||
yul::YUL_OPTION,
|
||||
&optimization_argument,
|
||||
];
|
||||
let resolc_result = utils::execute_resolc(arguments);
|
||||
assert!(
|
||||
resolc_result.success,
|
||||
"Providing the level `{optimization_argument}` should succeed with exit code {}, got {}.\nDetails: {}",
|
||||
revive_common::EXIT_CODE_SUCCESS,
|
||||
resolc_result.code,
|
||||
resolc_result.stderr
|
||||
);
|
||||
|
||||
assert!(
|
||||
resolc_result
|
||||
.stderr
|
||||
.contains("Compiler run successful. No output requested"),
|
||||
"Expected the output to contain a success message when providing the level `{optimization_argument}`."
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn fails_with_invalid_level() {
|
||||
let arguments = &[utils::YUL_MEMSET_CONTRACT_PATH, yul::YUL_OPTION, "-O9"];
|
||||
let resolc_result = utils::execute_resolc(arguments);
|
||||
utils::assert_command_failure(&resolc_result, "Providing an invalid optimization level");
|
||||
|
||||
assert!(
|
||||
resolc_result
|
||||
.stderr
|
||||
.contains("Unexpected optimization option"),
|
||||
"Expected the output to contain a specific error message."
|
||||
);
|
||||
|
||||
let solc_result = utils::execute_solc(arguments);
|
||||
utils::assert_equal_exit_codes(&solc_result, &resolc_result);
|
||||
}
|
||||
@@ -1,122 +0,0 @@
|
||||
//! The tests for running resolc with output directory option.
|
||||
|
||||
#![cfg(test)]
|
||||
|
||||
use std::path::Path;
|
||||
|
||||
use crate::tests::cli::utils;
|
||||
|
||||
const OUTPUT_DIRECTORY: &str = "src/tests/cli/artifacts";
|
||||
const OUTPUT_BIN_FILE_PATH: &str = "src/tests/cli/artifacts/contract.sol:C.pvm";
|
||||
const OUTPUT_ASM_FILE_PATH: &str = "src/tests/cli/artifacts/contract.sol:C.pvmasm";
|
||||
const OUTPUT_LLVM_OPTIMIZED_FILE_PATH: &str =
|
||||
"src/tests/cli/artifacts/src_tests_cli_contracts_solidity_contract.sol.C.optimized.ll";
|
||||
const OUTPUT_LLVM_UNOPTIMIZED_FILE_PATH: &str =
|
||||
"src/tests/cli/artifacts/src_tests_cli_contracts_solidity_contract.sol.C.unoptimized.ll";
|
||||
|
||||
fn file_exists(path: &str) -> bool {
|
||||
Path::new(path).try_exists().unwrap()
|
||||
}
|
||||
|
||||
fn file_is_empty(path: &str) -> bool {
|
||||
Path::new(path).metadata().unwrap().len() == 0
|
||||
}
|
||||
|
||||
fn assert_valid_output_file(
|
||||
result: &utils::CommandResult,
|
||||
output_file_type: &str,
|
||||
output_file_path: &str,
|
||||
) {
|
||||
utils::assert_command_success(result, "Providing an output directory");
|
||||
|
||||
assert!(
|
||||
result.stderr.contains("Compiler run successful"),
|
||||
"Expected the compiler output to contain a success message.",
|
||||
);
|
||||
|
||||
assert!(
|
||||
file_exists(output_file_path),
|
||||
"Expected the {output_file_type} output file `{output_file_path}` to exist."
|
||||
);
|
||||
|
||||
assert!(
|
||||
!file_is_empty(output_file_path),
|
||||
"Expected the {output_file_type} output file `{output_file_path}` to not be empty."
|
||||
);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn writes_to_file() {
|
||||
let arguments = &[
|
||||
utils::SOLIDITY_CONTRACT_PATH,
|
||||
"--overwrite",
|
||||
"-O3",
|
||||
"--bin",
|
||||
"--asm",
|
||||
"--output-dir",
|
||||
OUTPUT_DIRECTORY,
|
||||
];
|
||||
let result = utils::execute_resolc(arguments);
|
||||
assert_valid_output_file(&result, "--bin", OUTPUT_BIN_FILE_PATH);
|
||||
assert_valid_output_file(&result, "--asm", OUTPUT_ASM_FILE_PATH);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn writes_debug_info_to_file_unoptimized() {
|
||||
let arguments = &[
|
||||
utils::SOLIDITY_CONTRACT_PATH,
|
||||
"-g",
|
||||
"--disable-solc-optimizer",
|
||||
"--overwrite",
|
||||
"--bin",
|
||||
"--asm",
|
||||
"--output-dir",
|
||||
OUTPUT_DIRECTORY,
|
||||
];
|
||||
let result = utils::execute_resolc(arguments);
|
||||
assert_valid_output_file(&result, "--bin", OUTPUT_BIN_FILE_PATH);
|
||||
assert_valid_output_file(&result, "--asm", OUTPUT_ASM_FILE_PATH);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn writes_debug_info_to_file_optimized() {
|
||||
let arguments = &[
|
||||
utils::SOLIDITY_CONTRACT_PATH,
|
||||
"-g",
|
||||
"--overwrite",
|
||||
"--bin",
|
||||
"--asm",
|
||||
"--output-dir",
|
||||
OUTPUT_DIRECTORY,
|
||||
];
|
||||
let result = utils::execute_resolc(arguments);
|
||||
assert_valid_output_file(&result, "--bin", OUTPUT_BIN_FILE_PATH);
|
||||
assert_valid_output_file(&result, "--asm", OUTPUT_ASM_FILE_PATH);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn writes_llvm_debug_info_to_file_unoptimized() {
|
||||
let arguments = &[
|
||||
utils::SOLIDITY_CONTRACT_PATH,
|
||||
"-g",
|
||||
"--disable-solc-optimizer",
|
||||
"--overwrite",
|
||||
"--debug-output-dir",
|
||||
OUTPUT_DIRECTORY,
|
||||
];
|
||||
let result = utils::execute_resolc(arguments);
|
||||
assert_valid_output_file(&result, "llvm", OUTPUT_LLVM_UNOPTIMIZED_FILE_PATH);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn writes_llvm_debug_info_to_file_optimized() {
|
||||
let arguments = &[
|
||||
utils::SOLIDITY_CONTRACT_PATH,
|
||||
"-g",
|
||||
"--overwrite",
|
||||
"--debug-output-dir",
|
||||
OUTPUT_DIRECTORY,
|
||||
];
|
||||
let result = utils::execute_resolc(arguments);
|
||||
assert_valid_output_file(&result, "llvm", OUTPUT_LLVM_OPTIMIZED_FILE_PATH);
|
||||
}
|
||||
@@ -1,24 +0,0 @@
|
||||
//! The tests for running resolc with standard JSON option.
|
||||
|
||||
#![cfg(test)]
|
||||
|
||||
use crate::tests::cli::utils;
|
||||
|
||||
const JSON_OPTION: &str = "--standard-json";
|
||||
|
||||
#[test]
|
||||
fn runs_with_valid_input_file() {
|
||||
let arguments = &[JSON_OPTION];
|
||||
let resolc_result =
|
||||
utils::execute_resolc_with_stdin_input(arguments, utils::STANDARD_JSON_CONTRACTS_PATH);
|
||||
utils::assert_command_success(&resolc_result, "Providing a valid input file to stdin");
|
||||
|
||||
assert!(
|
||||
resolc_result.stdout.contains("contracts"),
|
||||
"Expected the output to contain a `contracts` field."
|
||||
);
|
||||
|
||||
let solc_result =
|
||||
utils::execute_solc_with_stdin_input(arguments, utils::STANDARD_JSON_CONTRACTS_PATH);
|
||||
utils::assert_equal_exit_codes(&solc_result, &resolc_result);
|
||||
}
|
||||
@@ -1,35 +0,0 @@
|
||||
//! The tests for running resolc when expecting usage output.
|
||||
|
||||
#![cfg(test)]
|
||||
|
||||
use crate::tests::cli::utils;
|
||||
|
||||
#[test]
|
||||
#[ignore = "Fix: 'resolc --help' should exit with success exit code"]
|
||||
fn shows_usage_with_help() {
|
||||
let arguments = &["--help"];
|
||||
let resolc_result = utils::execute_resolc(arguments);
|
||||
utils::assert_command_success(&resolc_result, "Providing the `--help` option");
|
||||
|
||||
assert!(
|
||||
resolc_result.stdout.contains("Usage: resolc"),
|
||||
"Expected the output to contain usage information."
|
||||
);
|
||||
|
||||
let solc_result = utils::execute_solc(arguments);
|
||||
utils::assert_equal_exit_codes(&solc_result, &resolc_result);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn fails_without_options() {
|
||||
let resolc_result = utils::execute_resolc(&[]);
|
||||
utils::assert_command_failure(&resolc_result, "Omitting options");
|
||||
|
||||
assert!(
|
||||
resolc_result.stderr.contains("Usage: resolc"),
|
||||
"Expected the output to contain usage information."
|
||||
);
|
||||
|
||||
let solc_result = utils::execute_solc(&[]);
|
||||
utils::assert_equal_exit_codes(&solc_result, &resolc_result);
|
||||
}
|
||||
@@ -1,99 +0,0 @@
|
||||
//! Common utilities used for CLI tests.
|
||||
|
||||
use std::{
|
||||
fs::File,
|
||||
process::{Command, Stdio},
|
||||
};
|
||||
|
||||
use revive_common;
|
||||
|
||||
use crate::SolcCompiler;
|
||||
|
||||
pub const SOLIDITY_CONTRACT_PATH: &str = "src/tests/cli/contracts/solidity/contract.sol";
|
||||
pub const YUL_CONTRACT_PATH: &str = "src/tests/cli/contracts/yul/contract.yul";
|
||||
pub const YUL_MEMSET_CONTRACT_PATH: &str = "src/tests/cli/contracts/yul/memset.yul";
|
||||
pub const STANDARD_JSON_CONTRACTS_PATH: &str =
|
||||
"src/tests/cli/contracts/standard_json/solidity_contracts.json";
|
||||
|
||||
/// The result of executing a command.
|
||||
pub struct CommandResult {
|
||||
/// The data written to `stdout`.
|
||||
pub stdout: String,
|
||||
/// The data written to `stderr`.
|
||||
pub stderr: String,
|
||||
/// Whether termination was successful.
|
||||
pub success: bool,
|
||||
/// The exit code of the process.
|
||||
pub code: i32,
|
||||
}
|
||||
|
||||
pub fn execute_resolc(arguments: &[&str]) -> CommandResult {
|
||||
execute_command("resolc", arguments, None)
|
||||
}
|
||||
|
||||
pub fn execute_resolc_with_stdin_input(arguments: &[&str], stdin_file_path: &str) -> CommandResult {
|
||||
execute_command("resolc", arguments, Some(stdin_file_path))
|
||||
}
|
||||
|
||||
pub fn execute_solc(arguments: &[&str]) -> CommandResult {
|
||||
execute_command(SolcCompiler::DEFAULT_EXECUTABLE_NAME, arguments, None)
|
||||
}
|
||||
|
||||
pub fn execute_solc_with_stdin_input(arguments: &[&str], stdin_file_path: &str) -> CommandResult {
|
||||
execute_command(
|
||||
SolcCompiler::DEFAULT_EXECUTABLE_NAME,
|
||||
arguments,
|
||||
Some(stdin_file_path),
|
||||
)
|
||||
}
|
||||
|
||||
fn execute_command(
|
||||
command: &str,
|
||||
arguments: &[&str],
|
||||
stdin_file_path: Option<&str>,
|
||||
) -> CommandResult {
|
||||
let stdin_config = match stdin_file_path {
|
||||
Some(path) => Stdio::from(File::open(path).unwrap()),
|
||||
None => Stdio::null(),
|
||||
};
|
||||
let result = Command::new(command)
|
||||
.args(arguments)
|
||||
.stdin(stdin_config)
|
||||
.stdout(Stdio::piped())
|
||||
.stderr(Stdio::piped())
|
||||
.output()
|
||||
.unwrap();
|
||||
|
||||
CommandResult {
|
||||
stdout: String::from_utf8_lossy(&result.stdout).to_string(),
|
||||
stderr: String::from_utf8_lossy(&result.stderr).to_string(),
|
||||
success: result.status.success(),
|
||||
code: result.status.code().unwrap(),
|
||||
}
|
||||
}
|
||||
|
||||
pub fn assert_equal_exit_codes(solc_result: &CommandResult, resolc_result: &CommandResult) {
|
||||
assert_eq!(
|
||||
solc_result.code, resolc_result.code,
|
||||
"Expected solc and resolc to have the same exit code."
|
||||
);
|
||||
}
|
||||
|
||||
pub fn assert_command_success(result: &CommandResult, error_message_prefix: &str) {
|
||||
assert!(
|
||||
result.success,
|
||||
"{error_message_prefix} should succeed with exit code {}, got {}.\nDetails: {}",
|
||||
revive_common::EXIT_CODE_SUCCESS,
|
||||
result.code,
|
||||
result.stderr
|
||||
);
|
||||
}
|
||||
|
||||
pub fn assert_command_failure(result: &CommandResult, error_message_prefix: &str) {
|
||||
assert!(
|
||||
!result.success,
|
||||
"{error_message_prefix} should fail with exit code {}, got {}.",
|
||||
revive_common::EXIT_CODE_FAILURE,
|
||||
result.code
|
||||
);
|
||||
}
|
||||
@@ -1,44 +0,0 @@
|
||||
//! The tests for running resolc with yul option.
|
||||
|
||||
#![cfg(test)]
|
||||
|
||||
use crate::tests::cli::utils;
|
||||
|
||||
pub const YUL_OPTION: &str = "--yul";
|
||||
/// The `--yul` option was deprecated in Solidity 0.8.27 in favor of `--strict-assembly`.
|
||||
/// See section `--strict-assembly vs. --yul` in https://soliditylang.org/blog/2024/09/04/solidity-0.8.27-release-announcement/
|
||||
const SOLC_YUL_OPTION: &str = "--strict-assembly";
|
||||
|
||||
#[test]
|
||||
fn runs_with_valid_input_file() {
|
||||
let arguments = &[utils::YUL_CONTRACT_PATH, YUL_OPTION];
|
||||
let resolc_result = utils::execute_resolc(arguments);
|
||||
utils::assert_command_success(&resolc_result, "Providing a valid input file");
|
||||
|
||||
assert!(
|
||||
resolc_result
|
||||
.stderr
|
||||
.contains("Compiler run successful. No output requested"),
|
||||
"Expected the output to contain a success message."
|
||||
);
|
||||
|
||||
let solc_arguments = &[utils::YUL_CONTRACT_PATH, SOLC_YUL_OPTION];
|
||||
let solc_result = utils::execute_solc(solc_arguments);
|
||||
utils::assert_equal_exit_codes(&solc_result, &resolc_result);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn fails_without_input_file() {
|
||||
let arguments = &[YUL_OPTION];
|
||||
let resolc_result = utils::execute_resolc(arguments);
|
||||
utils::assert_command_failure(&resolc_result, "Omitting an input file");
|
||||
|
||||
assert!(
|
||||
resolc_result.stderr.contains("The input file is missing"),
|
||||
"Expected the output to contain a specific error message."
|
||||
);
|
||||
|
||||
let solc_arguments = &[SOLC_YUL_OPTION];
|
||||
let solc_result = utils::execute_solc(solc_arguments);
|
||||
utils::assert_equal_exit_codes(&solc_result, &resolc_result);
|
||||
}
|
||||
@@ -1,11 +0,0 @@
|
||||
[package]
|
||||
name = "revive-rul-runtime-library"
|
||||
version.workspace = true
|
||||
license.workspace = true
|
||||
edition.workspace = true
|
||||
repository.workspace = true
|
||||
authors.workspace = true
|
||||
description = "revive compiler rust backend runtime library"
|
||||
|
||||
[dependencies]
|
||||
alloy-core = { workspace = true, default-features = false }
|
||||
@@ -1,4 +0,0 @@
|
||||
//! The revive Rust backend contract runtime library configuration.
|
||||
|
||||
/// The Ethereum Virtual Machine word size in bytes.
|
||||
pub const EVM_WORD_SIZE_BYTES: usize = 32;
|
||||
@@ -1,6 +0,0 @@
|
||||
//! The revive Rust backend contract runtime library.
|
||||
|
||||
#![no_std]
|
||||
|
||||
pub mod configuration;
|
||||
pub mod memory;
|
||||
@@ -1,13 +0,0 @@
|
||||
//! The revive Rust backend contract runtime emulated linear EVM heap memory.
|
||||
|
||||
/// The emulated linear EVM heap memory size.
|
||||
pub const MEMORY_SIZE: usize = 1024 * 64;
|
||||
|
||||
/// The emulated linear EVM heap memory size.
|
||||
pub const MEMORY: [u8; MEMORY_SIZE] = [0; MEMORY_SIZE];
|
||||
|
||||
pub struct Function<const VARIABLES: usize> {
|
||||
pub variables: [u8; VARIABLES],
|
||||
}
|
||||
|
||||
impl<const VARIABLES: usize> Function<VARIABLES> {}
|
||||
@@ -1,14 +0,0 @@
|
||||
[package]
|
||||
name = "revive-rul"
|
||||
version.workspace = true
|
||||
license.workspace = true
|
||||
edition.workspace = true
|
||||
repository.workspace = true
|
||||
authors.workspace = true
|
||||
description = "revive compiler rust backend"
|
||||
|
||||
[dependencies]
|
||||
anyhow = { workspace = true }
|
||||
pallet-revive-uapi = { workspace = true }
|
||||
polkavm-linker = { workspace = true }
|
||||
|
||||
@@ -1,79 +0,0 @@
|
||||
//! The revive rust backend builder module.
|
||||
|
||||
const CARGO_TOML: &str = r#"
|
||||
[package]
|
||||
name = "contracts"
|
||||
publish = false
|
||||
version = "1.0.0"
|
||||
edition = "2021"
|
||||
|
||||
# Make sure this is not included into the workspace
|
||||
[workspace]
|
||||
|
||||
# Binary targets are injected dynamically by the build script.
|
||||
[[bin]]
|
||||
|
||||
# All paths are injected dynamically by the build script.
|
||||
[dependencies]
|
||||
uapi = { version = "0.7.0", package = 'pallet-revive-uapi', features = ["unstable-hostfn"], default-features = false }
|
||||
hex-literal = { version = "0.4.1", default-features = false }
|
||||
polkavm-derive = { version = "0.27.0" }
|
||||
|
||||
[profile.release]
|
||||
opt-level = z
|
||||
lto = true
|
||||
codegen-units = 1
|
||||
"#;
|
||||
|
||||
const HEADER: &str = r#"
|
||||
#![no_std]
|
||||
#![no_main]
|
||||
include!("../panic_handler.rs");
|
||||
|
||||
use uapi::{HostFn, HostFnImpl as api, ReturnFlags};
|
||||
|
||||
#[panic_handler]
|
||||
fn panic(_info: &core::panic::PanicInfo) -> ! {
|
||||
// SAFETY: The unimp instruction is guaranteed to trap
|
||||
unsafe {
|
||||
core::arch::asm!("unimp");
|
||||
core::hint::unreachable_unchecked();
|
||||
}
|
||||
}
|
||||
|
||||
/// The emulated linear EVM heap memory size.
|
||||
pub const MEMORY_SIZE: usize = 1024 * 64;
|
||||
|
||||
/// The emulated linear EVM heap memory size.
|
||||
pub const MEMORY: [u8; MEMORY_SIZE] = [0; MEMORY_SIZE];
|
||||
"#;
|
||||
|
||||
const EXPORT_FUNCTION: &str = r#"
|
||||
#[no_mangle]
|
||||
#[polkavm_derive::polkavm_export]
|
||||
pub extern "C" fn "#;
|
||||
|
||||
fn emit(constructor_code: &str, runtime_code: &str) -> String {
|
||||
let mut buffer = String::from(HEADER);
|
||||
buffer.reserve(
|
||||
constructor_code.len() + runtime_code.len() + HEADER.len() + EXPORT_FUNCTION.len() * 2,
|
||||
);
|
||||
|
||||
buffer.push_str(EXPORT_FUNCTION);
|
||||
buffer.push_str("deploy() {");
|
||||
buffer.push_str(constructor_code);
|
||||
buffer.push_str("\n}");
|
||||
|
||||
buffer.push_str(EXPORT_FUNCTION);
|
||||
buffer.push_str("call() {");
|
||||
buffer.push_str(runtime_code);
|
||||
buffer.push_str("\n}");
|
||||
|
||||
buffer
|
||||
}
|
||||
|
||||
/// Build a PVM blob.
|
||||
pub fn build(constructor_code: &str, runtime_code: &str) -> Vec<u8> {
|
||||
let code = emit(constructor_code, runtime_code);
|
||||
todo!();
|
||||
}
|
||||
@@ -1,5 +0,0 @@
|
||||
//! The revive rust backend library.
|
||||
|
||||
pub mod builder;
|
||||
pub mod yul_library;
|
||||
|
||||
@@ -1 +0,0 @@
|
||||
//! The revive rust backend YUL auxilliary library functions module.
|
||||
@@ -17,7 +17,7 @@ path = "src/main.rs"
|
||||
[features]
|
||||
std = ["polkadot-sdk/std"]
|
||||
default = ["solidity"]
|
||||
solidity = ["resolc", "revive-differential", "revive-llvm-context"]
|
||||
solidity = ["revive-solidity", "revive-differential", "revive-llvm-context"]
|
||||
|
||||
[dependencies]
|
||||
env_logger = { workspace = true }
|
||||
@@ -39,6 +39,6 @@ polkadot-sdk.features = [
|
||||
"pallet-timestamp"
|
||||
]
|
||||
|
||||
resolc = { workspace = true, optional = true }
|
||||
revive-solidity = { workspace = true, optional = true }
|
||||
revive-differential = { workspace = true, optional = true }
|
||||
revive-llvm-context = { workspace = true, optional = true }
|
||||
|
||||
@@ -44,7 +44,7 @@ pub use crate::specs::*;
|
||||
mod runtime;
|
||||
mod specs;
|
||||
|
||||
#[cfg(not(feature = "resolc"))]
|
||||
#[cfg(not(feature = "revive-solidity"))]
|
||||
pub(crate) const NO_SOLIDITY_FRONTEND: &str =
|
||||
"revive-runner was built without the solidity frontend; please enable the 'solidity' feature!";
|
||||
|
||||
@@ -234,7 +234,7 @@ impl CallResult {
|
||||
|
||||
#[derive(Clone, Debug, Serialize, Deserialize)]
|
||||
pub enum Code {
|
||||
#[cfg(feature = "resolc")]
|
||||
#[cfg(feature = "revive-solidity")]
|
||||
/// Compile a single solidity source and use the blob of `contract`
|
||||
Solidity {
|
||||
path: Option<std::path::PathBuf>,
|
||||
@@ -270,7 +270,7 @@ impl From<Code> for pallet_revive::Code {
|
||||
let Ok(source_code) = std::fs::read_to_string(&path) else {
|
||||
panic!("Failed to reead source code from {}", path.display());
|
||||
};
|
||||
pallet_revive::Code::Upload(resolc::test_utils::compile_blob_with_options(
|
||||
pallet_revive::Code::Upload(revive_solidity::test_utils::compile_blob_with_options(
|
||||
&contract,
|
||||
&source_code,
|
||||
solc_optimizer.unwrap_or(true),
|
||||
|
||||
@@ -4,12 +4,12 @@ use serde::{Deserialize, Serialize};
|
||||
|
||||
use crate::*;
|
||||
use alloy_primitives::keccak256;
|
||||
#[cfg(feature = "resolc")]
|
||||
#[cfg(feature = "revive-solidity")]
|
||||
use alloy_primitives::Address;
|
||||
#[cfg(feature = "resolc")]
|
||||
use resolc::test_utils::*;
|
||||
#[cfg(feature = "resolc")]
|
||||
#[cfg(feature = "revive-solidity")]
|
||||
use revive_differential::{Evm, EvmLog};
|
||||
#[cfg(feature = "revive-solidity")]
|
||||
use revive_solidity::test_utils::*;
|
||||
|
||||
const SPEC_MARKER_BEGIN: &str = "/* runner.json";
|
||||
const SPEC_MARKER_END: &str = "*/";
|
||||
@@ -256,7 +256,7 @@ impl Specs {
|
||||
};
|
||||
|
||||
match code {
|
||||
#[cfg(feature = "resolc")]
|
||||
#[cfg(feature = "revive-solidity")]
|
||||
Code::Bytes(bytes) if bytes.is_empty() => {
|
||||
let contract_source = match std::fs::read_to_string(contract_path) {
|
||||
Err(err) => panic!("unable to read {contract_path}: {err}"),
|
||||
@@ -264,9 +264,9 @@ impl Specs {
|
||||
};
|
||||
*bytes = compile_blob(contract_name, &contract_source)
|
||||
}
|
||||
#[cfg(not(feature = "resolc"))]
|
||||
#[cfg(not(feature = "revive-solidity"))]
|
||||
Code::Bytes(_) => panic!("{NO_SOLIDITY_FRONTEND}"),
|
||||
#[cfg(feature = "resolc")]
|
||||
#[cfg(feature = "revive-solidity")]
|
||||
Code::Solidity { path, .. } if path.is_none() => *path = Some(contract_path.into()),
|
||||
_ => continue,
|
||||
}
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
[package]
|
||||
name = "revive-runtime-api"
|
||||
version = "0.2.0"
|
||||
version.workspace = true
|
||||
license.workspace = true
|
||||
edition.workspace = true
|
||||
repository.workspace = true
|
||||
|
||||
@@ -37,11 +37,12 @@ fn compile(source_path: &str, bitcode_path: &str) {
|
||||
source_path,
|
||||
])
|
||||
.output()
|
||||
.unwrap_or_else(|error| panic!("failed to execute clang: {error}"));
|
||||
.unwrap_or_else(|error| panic!("failed to execute clang: {}", error));
|
||||
|
||||
assert!(
|
||||
output.status.success(),
|
||||
"failed to compile the PolkaVM C API: {output:?}"
|
||||
"failed to compile the PolkaVM C API: {:?}",
|
||||
output
|
||||
);
|
||||
}
|
||||
|
||||
|
||||
@@ -26,19 +26,19 @@ pub static GLOBAL_IMMUTABLE_DATA_SIZE: &str = "__immutable_data_size";
|
||||
pub static IMMUTABLE_DATA_MAX_SIZE: u32 = 4 * 1024;
|
||||
|
||||
/// Returns the immutable data global type.
|
||||
pub fn data_type(context: &inkwell::context::Context, size: u32) -> inkwell::types::ArrayType<'_> {
|
||||
pub fn data_type(context: &inkwell::context::Context, size: u32) -> inkwell::types::ArrayType {
|
||||
context
|
||||
.custom_width_int_type(revive_common::BIT_LENGTH_WORD as u32)
|
||||
.array_type(size)
|
||||
}
|
||||
|
||||
/// Returns the immutable data size global type.
|
||||
pub fn size_type(context: &inkwell::context::Context) -> inkwell::types::IntType<'_> {
|
||||
pub fn size_type(context: &inkwell::context::Context) -> inkwell::types::IntType {
|
||||
context.custom_width_int_type(revive_common::BIT_LENGTH_X32 as u32)
|
||||
}
|
||||
|
||||
/// Creates a LLVM module with the immutable data and its `size` in bytes.
|
||||
pub fn module(context: &inkwell::context::Context, size: u32) -> inkwell::module::Module<'_> {
|
||||
pub fn module(context: &inkwell::context::Context, size: u32) -> inkwell::module::Module {
|
||||
let module = context.create_module(MODULE_NAME);
|
||||
let length = size / revive_common::BYTE_LENGTH_WORD as u32;
|
||||
|
||||
|
||||
@@ -30,13 +30,6 @@ void * memmove(void *dst, const void *src, size_t n) {
|
||||
return dst;
|
||||
}
|
||||
|
||||
void * memset(void *b, int c, size_t len) {
|
||||
uint8_t *dest = b;
|
||||
uint8_t val = (uint8_t)c;
|
||||
while (len-- > 0) *dest++ = val;
|
||||
return b;
|
||||
}
|
||||
|
||||
// Imports
|
||||
|
||||
POLKAVM_IMPORT(void, address, uint32_t)
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
[package]
|
||||
name = "revive-solc-json-interface"
|
||||
version = "0.2.0"
|
||||
version.workspace = true
|
||||
authors.workspace = true
|
||||
license.workspace = true
|
||||
edition.workspace = true
|
||||
@@ -20,4 +20,4 @@ anyhow = { workspace = true }
|
||||
rayon = { workspace = true, optional = true }
|
||||
semver = { workspace = true }
|
||||
serde = { workspace = true }
|
||||
serde_json = { workspace = true }
|
||||
serde_json = { workspace = true }
|
||||
@@ -7,11 +7,8 @@ pub use self::combined_json::contract::Contract as CombinedJsonContract;
|
||||
pub use self::standard_json::input::language::Language as SolcStandardJsonInputLanguage;
|
||||
pub use self::standard_json::input::settings::metadata::Metadata as SolcStandardJsonInputSettingsMetadata;
|
||||
pub use self::standard_json::input::settings::metadata_hash::MetadataHash as SolcStandardJsonInputSettingsMetadataHash;
|
||||
pub use self::standard_json::input::settings::optimizer::yul_details::YulDetails as SolcStandardJsonInputSettingsYulOptimizerDetails;
|
||||
pub use self::standard_json::input::settings::optimizer::Optimizer as SolcStandardJsonInputSettingsOptimizer;
|
||||
pub use self::standard_json::input::settings::polkavm::memory::MemoryConfig as SolcStandardJsonInputSettingsPolkaVMMemory;
|
||||
pub use self::standard_json::input::settings::polkavm::memory::DEFAULT_HEAP_SIZE as PolkaVMDefaultHeapMemorySize;
|
||||
pub use self::standard_json::input::settings::polkavm::memory::DEFAULT_STACK_SIZE as PolkaVMDefaultStackMemorySize;
|
||||
pub use self::standard_json::input::settings::polkavm::PolkaVM as SolcStandardJsonInputSettingsPolkaVM;
|
||||
pub use self::standard_json::input::settings::selection::file::flag::Flag as SolcStandardJsonInputSettingsSelectionFileFlag;
|
||||
pub use self::standard_json::input::settings::selection::file::File as SolcStandardJsonInputSettingsSelectionFile;
|
||||
|
||||
@@ -25,7 +25,7 @@ use self::settings::Settings;
|
||||
use self::source::Source;
|
||||
|
||||
/// The `solc --standard-json` input.
|
||||
#[derive(Clone, Debug, Serialize, Deserialize)]
|
||||
#[derive(Debug, Serialize, Deserialize)]
|
||||
#[serde(rename_all = "camelCase")]
|
||||
pub struct Input {
|
||||
/// The input language.
|
||||
@@ -140,7 +140,7 @@ impl Input {
|
||||
}
|
||||
|
||||
/// Sets the necessary defaults.
|
||||
pub fn normalize(&mut self) {
|
||||
self.settings.normalize();
|
||||
pub fn normalize(&mut self, version: &semver::Version) {
|
||||
self.settings.normalize(version);
|
||||
}
|
||||
}
|
||||
|
||||
@@ -6,7 +6,7 @@ use serde::Serialize;
|
||||
use crate::standard_json::input::settings::metadata_hash::MetadataHash;
|
||||
|
||||
/// The `solc --standard-json` input settings metadata.
|
||||
#[derive(Clone, Debug, Default, Serialize, Deserialize)]
|
||||
#[derive(Debug, Default, Serialize, Deserialize)]
|
||||
#[serde(rename_all = "camelCase")]
|
||||
pub struct Metadata {
|
||||
/// The bytecode hash mode.
|
||||
|
||||
@@ -18,7 +18,7 @@ use self::polkavm::PolkaVM;
|
||||
use self::selection::Selection;
|
||||
|
||||
/// The `solc --standard-json` input settings.
|
||||
#[derive(Clone, Debug, Serialize, Deserialize)]
|
||||
#[derive(Debug, Serialize, Deserialize)]
|
||||
#[serde(rename_all = "camelCase")]
|
||||
pub struct Settings {
|
||||
/// The target EVM version.
|
||||
@@ -46,7 +46,7 @@ pub struct Settings {
|
||||
#[serde(skip_serializing_if = "Option::is_none")]
|
||||
pub metadata: Option<Metadata>,
|
||||
/// The resolc custom PolkaVM settings.
|
||||
#[serde(skip_serializing_if = "Option::is_none")]
|
||||
#[serde(skip_serializing)]
|
||||
pub polkavm: Option<PolkaVM>,
|
||||
}
|
||||
|
||||
@@ -74,9 +74,8 @@ impl Settings {
|
||||
}
|
||||
|
||||
/// Sets the necessary defaults.
|
||||
pub fn normalize(&mut self) {
|
||||
self.polkavm = None;
|
||||
self.optimizer.normalize();
|
||||
pub fn normalize(&mut self, version: &semver::Version) {
|
||||
self.optimizer.normalize(version);
|
||||
}
|
||||
|
||||
/// Parses the library list and returns their double hashmap with path and name as keys.
|
||||
|
||||
@@ -3,54 +3,37 @@
|
||||
use serde::Deserialize;
|
||||
use serde::Serialize;
|
||||
|
||||
use crate::standard_json::input::settings::optimizer::yul_details::YulDetails;
|
||||
|
||||
/// The `solc --standard-json` input settings optimizer details.
|
||||
#[derive(Clone, Debug, Serialize, Deserialize)]
|
||||
#[derive(Debug, Serialize, Deserialize)]
|
||||
#[serde(rename_all = "camelCase")]
|
||||
pub struct Details {
|
||||
/// Whether the pass is enabled.
|
||||
#[serde(skip_serializing_if = "Option::is_none")]
|
||||
pub peephole: Option<bool>,
|
||||
pub peephole: bool,
|
||||
/// Whether the pass is enabled.
|
||||
#[serde(skip_serializing_if = "Option::is_none")]
|
||||
pub inliner: Option<bool>,
|
||||
/// Whether the pass is enabled.
|
||||
#[serde(skip_serializing_if = "Option::is_none")]
|
||||
pub jumpdest_remover: Option<bool>,
|
||||
pub jumpdest_remover: bool,
|
||||
/// Whether the pass is enabled.
|
||||
#[serde(skip_serializing_if = "Option::is_none")]
|
||||
pub order_literals: Option<bool>,
|
||||
pub order_literals: bool,
|
||||
/// Whether the pass is enabled.
|
||||
#[serde(skip_serializing_if = "Option::is_none")]
|
||||
pub deduplicate: Option<bool>,
|
||||
pub deduplicate: bool,
|
||||
/// Whether the pass is enabled.
|
||||
#[serde(skip_serializing_if = "Option::is_none")]
|
||||
pub cse: Option<bool>,
|
||||
pub cse: bool,
|
||||
/// Whether the pass is enabled.
|
||||
#[serde(skip_serializing_if = "Option::is_none")]
|
||||
pub constant_optimizer: Option<bool>,
|
||||
/// Whether the YUL optimizer is enabled.
|
||||
#[serde(skip_serializing_if = "Option::is_none")]
|
||||
pub yul: Option<bool>,
|
||||
/// The YUL optimizer configuration.
|
||||
#[serde(skip_serializing_if = "Option::is_none")]
|
||||
pub yul_details: Option<YulDetails>,
|
||||
pub constant_optimizer: bool,
|
||||
}
|
||||
|
||||
impl Details {
|
||||
/// A shortcut constructor.
|
||||
#[allow(clippy::too_many_arguments)]
|
||||
pub fn new(
|
||||
peephole: Option<bool>,
|
||||
peephole: bool,
|
||||
inliner: Option<bool>,
|
||||
jumpdest_remover: Option<bool>,
|
||||
order_literals: Option<bool>,
|
||||
deduplicate: Option<bool>,
|
||||
cse: Option<bool>,
|
||||
constant_optimizer: Option<bool>,
|
||||
yul: Option<bool>,
|
||||
yul_details: Option<YulDetails>,
|
||||
jumpdest_remover: bool,
|
||||
order_literals: bool,
|
||||
deduplicate: bool,
|
||||
cse: bool,
|
||||
constant_optimizer: bool,
|
||||
) -> Self {
|
||||
Self {
|
||||
peephole,
|
||||
@@ -60,11 +43,10 @@ impl Details {
|
||||
deduplicate,
|
||||
cse,
|
||||
constant_optimizer,
|
||||
yul,
|
||||
yul_details,
|
||||
}
|
||||
}
|
||||
|
||||
/// Creates a set of disabled optimizations.
|
||||
pub fn disabled(version: &semver::Version) -> Self {
|
||||
let inliner = if version >= &semver::Version::new(0, 8, 5) {
|
||||
Some(false)
|
||||
@@ -72,16 +54,6 @@ impl Details {
|
||||
None
|
||||
};
|
||||
|
||||
Self::new(
|
||||
Some(false),
|
||||
inliner,
|
||||
Some(false),
|
||||
Some(false),
|
||||
Some(false),
|
||||
Some(false),
|
||||
Some(false),
|
||||
None,
|
||||
None,
|
||||
)
|
||||
Self::new(false, inliner, false, false, false, false, false)
|
||||
}
|
||||
}
|
||||
|
||||
@@ -1,7 +1,6 @@
|
||||
//! The `solc --standard-json` input settings optimizer.
|
||||
|
||||
pub mod details;
|
||||
pub mod yul_details;
|
||||
|
||||
use serde::Deserialize;
|
||||
use serde::Serialize;
|
||||
@@ -9,19 +8,19 @@ use serde::Serialize;
|
||||
use self::details::Details;
|
||||
|
||||
/// The `solc --standard-json` input settings optimizer.
|
||||
#[derive(Clone, Debug, Serialize, Deserialize)]
|
||||
#[derive(Debug, Serialize, Deserialize)]
|
||||
#[serde(rename_all = "camelCase")]
|
||||
pub struct Optimizer {
|
||||
/// Whether the optimizer is enabled.
|
||||
pub enabled: bool,
|
||||
/// The optimization mode string.
|
||||
#[serde(skip_serializing_if = "Option::is_none")]
|
||||
#[serde(skip_serializing)]
|
||||
pub mode: Option<char>,
|
||||
/// The `solc` optimizer details.
|
||||
#[serde(skip_serializing_if = "Option::is_none")]
|
||||
pub details: Option<Details>,
|
||||
/// Whether to try to recompile with -Oz if the bytecode is too large.
|
||||
#[serde(skip_serializing_if = "Option::is_none")]
|
||||
#[serde(skip_serializing)]
|
||||
pub fallback_to_optimizing_for_size: Option<bool>,
|
||||
}
|
||||
|
||||
@@ -42,8 +41,11 @@ impl Optimizer {
|
||||
}
|
||||
|
||||
/// Sets the necessary defaults.
|
||||
pub fn normalize(&mut self) {
|
||||
self.mode = None;
|
||||
self.fallback_to_optimizing_for_size = None;
|
||||
pub fn normalize(&mut self, version: &semver::Version) {
|
||||
self.details = if version >= &semver::Version::new(0, 5, 5) {
|
||||
Some(Details::disabled(version))
|
||||
} else {
|
||||
None
|
||||
};
|
||||
}
|
||||
}
|
||||
|
||||
@@ -1,26 +0,0 @@
|
||||
//! The `solc --standard-json` input settings YUL optimizer details.
|
||||
|
||||
use serde::Deserialize;
|
||||
use serde::Serialize;
|
||||
|
||||
/// The `solc --standard-json` input settings optimizer YUL details.
|
||||
#[derive(Clone, Debug, Serialize, Deserialize)]
|
||||
#[serde(rename_all = "camelCase")]
|
||||
pub struct YulDetails {
|
||||
/// Whether the stack allocation pass is enabled.
|
||||
#[serde(skip_serializing_if = "Option::is_none")]
|
||||
pub stack_allocation: Option<bool>,
|
||||
/// The optimization step sequence string.
|
||||
#[serde(skip_serializing_if = "Option::is_none")]
|
||||
pub optimizer_steps: Option<String>,
|
||||
}
|
||||
|
||||
impl YulDetails {
|
||||
/// A shortcut constructor.
|
||||
pub fn new(stack_allocation: Option<bool>, optimizer_steps: Option<String>) -> Self {
|
||||
Self {
|
||||
stack_allocation,
|
||||
optimizer_steps,
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -2,35 +2,20 @@
|
||||
|
||||
use serde::{Deserialize, Serialize};
|
||||
|
||||
pub const DEFAULT_HEAP_SIZE: u32 = 64 * 1024;
|
||||
pub const DEFAULT_STACK_SIZE: u32 = 32 * 1024;
|
||||
|
||||
/// The PolkaVM memory configuration.
|
||||
#[derive(Clone, Copy, Debug, Deserialize, Serialize)]
|
||||
pub struct MemoryConfig {
|
||||
/// The emulated EVM linear heap memory size in bytes.
|
||||
#[serde(skip_serializing_if = "Option::is_none")]
|
||||
pub heap_size: Option<u32>,
|
||||
pub heap_size: u32,
|
||||
/// The PVM stack size in bytes.
|
||||
#[serde(skip_serializing_if = "Option::is_none")]
|
||||
pub stack_size: Option<u32>,
|
||||
}
|
||||
|
||||
impl MemoryConfig {
|
||||
/// A shorthand constructor.
|
||||
pub fn new(heap_size: Option<u32>, stack_size: Option<u32>) -> Self {
|
||||
Self {
|
||||
heap_size,
|
||||
stack_size,
|
||||
}
|
||||
}
|
||||
pub stack_size: u32,
|
||||
}
|
||||
|
||||
impl Default for MemoryConfig {
|
||||
fn default() -> Self {
|
||||
Self {
|
||||
heap_size: Some(DEFAULT_HEAP_SIZE),
|
||||
stack_size: Some(DEFAULT_STACK_SIZE),
|
||||
heap_size: 64 * 1024,
|
||||
stack_size: 32 * 1024,
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@@ -11,18 +11,16 @@ pub mod memory;
|
||||
#[derive(Clone, Copy, Default, Debug, Serialize, Deserialize)]
|
||||
pub struct PolkaVM {
|
||||
/// The PolkaVM target machine memory configuration settings.
|
||||
#[serde(skip_serializing_if = "Option::is_none")]
|
||||
pub memory_config: Option<MemoryConfig>,
|
||||
pub memory_config: MemoryConfig,
|
||||
/// Instruct LLVM to emit debug information.
|
||||
#[serde(skip_serializing_if = "Option::is_none")]
|
||||
pub debug_information: Option<bool>,
|
||||
pub debug_information: bool,
|
||||
}
|
||||
|
||||
impl PolkaVM {
|
||||
pub fn new(memory_config: Option<MemoryConfig>, debug_information: bool) -> Self {
|
||||
Self {
|
||||
memory_config,
|
||||
debug_information: Some(debug_information),
|
||||
memory_config: memory_config.unwrap_or_default(),
|
||||
debug_information,
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@@ -10,7 +10,7 @@ use serde::Serialize;
|
||||
use self::flag::Flag as SelectionFlag;
|
||||
|
||||
/// The `solc --standard-json` output file selection.
|
||||
#[derive(Clone, Debug, Default, Serialize, Deserialize, PartialEq)]
|
||||
#[derive(Debug, Default, Serialize, Deserialize, PartialEq)]
|
||||
pub struct File {
|
||||
/// The per-file output selections.
|
||||
#[serde(rename = "", skip_serializing_if = "Option::is_none")]
|
||||
@@ -21,20 +21,8 @@ pub struct File {
|
||||
}
|
||||
|
||||
impl File {
|
||||
/// Creates the selection required for production compilation (excludes EVM bytecode).
|
||||
/// Creates the selection required by our compilation process.
|
||||
pub fn new_required() -> Self {
|
||||
Self {
|
||||
per_file: Some(HashSet::from_iter([SelectionFlag::AST])),
|
||||
per_contract: Some(HashSet::from_iter([
|
||||
SelectionFlag::MethodIdentifiers,
|
||||
SelectionFlag::Metadata,
|
||||
SelectionFlag::Yul,
|
||||
])),
|
||||
}
|
||||
}
|
||||
|
||||
/// Creates the selection required for test compilation (includes EVM bytecode).
|
||||
pub fn new_required_for_tests() -> Self {
|
||||
Self {
|
||||
per_file: Some(HashSet::from_iter([SelectionFlag::AST])),
|
||||
per_contract: Some(HashSet::from_iter([
|
||||
@@ -61,38 +49,3 @@ impl File {
|
||||
self
|
||||
}
|
||||
}
|
||||
|
||||
#[cfg(test)]
|
||||
mod tests {
|
||||
use super::*;
|
||||
|
||||
#[test]
|
||||
fn production_excludes_evm_bytecode() {
|
||||
let selection = File::new_required();
|
||||
let per_contract = selection.per_contract.unwrap();
|
||||
|
||||
// Production should NOT include EVM bytecode flags
|
||||
assert!(!per_contract.contains(&SelectionFlag::EVMBC));
|
||||
assert!(!per_contract.contains(&SelectionFlag::EVMDBC));
|
||||
|
||||
// But should include other required flags
|
||||
assert!(per_contract.contains(&SelectionFlag::MethodIdentifiers));
|
||||
assert!(per_contract.contains(&SelectionFlag::Metadata));
|
||||
assert!(per_contract.contains(&SelectionFlag::Yul));
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn tests_include_evm_bytecode() {
|
||||
let selection = File::new_required_for_tests();
|
||||
let per_contract = selection.per_contract.unwrap();
|
||||
|
||||
// Tests should include EVM bytecode flags
|
||||
assert!(per_contract.contains(&SelectionFlag::EVMBC));
|
||||
assert!(per_contract.contains(&SelectionFlag::EVMDBC));
|
||||
|
||||
// And should also include other required flags
|
||||
assert!(per_contract.contains(&SelectionFlag::MethodIdentifiers));
|
||||
assert!(per_contract.contains(&SelectionFlag::Metadata));
|
||||
assert!(per_contract.contains(&SelectionFlag::Yul));
|
||||
}
|
||||
}
|
||||
|
||||
@@ -10,7 +10,7 @@ use serde::Serialize;
|
||||
use self::file::File as FileSelection;
|
||||
|
||||
/// The `solc --standard-json` output selection.
|
||||
#[derive(Clone, Debug, Serialize, Deserialize, Default, PartialEq)]
|
||||
#[derive(Debug, Serialize, Deserialize, Default, PartialEq)]
|
||||
pub struct Selection {
|
||||
/// Only the 'all' wildcard is available for robustness reasons.
|
||||
#[serde(rename = "*", skip_serializing_if = "Option::is_none")]
|
||||
@@ -29,14 +29,6 @@ impl Selection {
|
||||
}
|
||||
}
|
||||
|
||||
/// Creates the selection required for test compilation (includes EVM bytecode).
|
||||
pub fn new_required_for_tests() -> Self {
|
||||
Self {
|
||||
all: Some(FileSelection::new_required_for_tests()),
|
||||
files: BTreeMap::new(),
|
||||
}
|
||||
}
|
||||
|
||||
/// Extends the user's output selection with flag required by our compilation process.
|
||||
pub fn extend_with_required(&mut self) -> &mut Self {
|
||||
self.all
|
||||
|
||||
@@ -7,7 +7,7 @@ use serde::Deserialize;
|
||||
use serde::Serialize;
|
||||
|
||||
/// The `solc --standard-json` input source.
|
||||
#[derive(Clone, Debug, Serialize, Deserialize)]
|
||||
#[derive(Debug, Serialize, Deserialize)]
|
||||
#[serde(rename_all = "camelCase")]
|
||||
pub struct Source {
|
||||
/// The source code file content.
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
[package]
|
||||
name = "resolc"
|
||||
version = "0.3.0"
|
||||
name = "revive-solidity"
|
||||
version.workspace = true
|
||||
license.workspace = true
|
||||
edition.workspace = true
|
||||
repository.workspace = true
|
||||
@@ -18,26 +18,29 @@ path = "src/resolc/main.rs"
|
||||
doctest = false
|
||||
|
||||
[dependencies]
|
||||
anyhow = { workspace = true }
|
||||
clap = { workspace = true }
|
||||
hex = { workspace = true }
|
||||
inkwell = { workspace = true }
|
||||
once_cell = { workspace = true }
|
||||
thiserror = { workspace = true }
|
||||
anyhow = { workspace = true }
|
||||
which = { workspace = true }
|
||||
path-slash = { workspace = true }
|
||||
rayon = { workspace = true, optional = true }
|
||||
semver = { workspace = true }
|
||||
|
||||
serde = { workspace = true }
|
||||
serde_json = { workspace = true }
|
||||
semver = { workspace = true }
|
||||
once_cell = { workspace = true }
|
||||
regex = { workspace = true }
|
||||
hex = { workspace = true }
|
||||
num = { workspace = true }
|
||||
sha3 = { workspace = true }
|
||||
which = { workspace = true }
|
||||
inkwell = { workspace = true }
|
||||
|
||||
revive-common = { workspace = true }
|
||||
revive-llvm-context = { workspace = true }
|
||||
revive-solc-json-interface = { workspace = true, features = ["resolc"] }
|
||||
revive-yul = { workspace = true }
|
||||
|
||||
[target.'cfg(target_env = "musl")'.dependencies]
|
||||
mimalloc = { version = "0.1.46", default-features = false }
|
||||
mimalloc = { version = "*", default-features = false }
|
||||
|
||||
[target.'cfg(target_os = "emscripten")'.dependencies]
|
||||
libc = { workspace = true }
|
||||
@@ -0,0 +1,7 @@
|
||||
fn main() {
|
||||
let repo = git2::Repository::open("../..").expect("should be a repository");
|
||||
let head = repo.head().expect("should have head");
|
||||
let commit = head.peel_to_commit().expect("should have commit");
|
||||
let id = &commit.id().to_string()[..7];
|
||||
println!("cargo:rustc-env=GIT_COMMIT_HASH={id}");
|
||||
}
|
||||
@@ -7,6 +7,7 @@ pub(crate) mod process;
|
||||
pub(crate) mod project;
|
||||
pub(crate) mod solc;
|
||||
pub(crate) mod version;
|
||||
pub(crate) mod yul;
|
||||
|
||||
pub use self::build::contract::Contract as ContractBuild;
|
||||
pub use self::build::Build;
|
||||
@@ -54,7 +55,7 @@ pub fn yul<T: Compiler>(
|
||||
solc: &mut T,
|
||||
optimizer_settings: revive_llvm_context::OptimizerSettings,
|
||||
include_metadata_hash: bool,
|
||||
mut debug_config: revive_llvm_context::DebugConfig,
|
||||
debug_config: revive_llvm_context::DebugConfig,
|
||||
llvm_arguments: &[String],
|
||||
memory_config: SolcStandardJsonInputSettingsPolkaVMMemory,
|
||||
) -> anyhow::Result<Build> {
|
||||
@@ -77,7 +78,6 @@ pub fn yul<T: Compiler>(
|
||||
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,
|
||||
include_metadata_hash,
|
||||
@@ -230,7 +230,7 @@ pub fn standard_json<T: Compiler>(
|
||||
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();
|
||||
debug_config.emit_debug_info = polkavm_settings.debug_information;
|
||||
|
||||
let include_metadata_hash = match solc_input.settings.metadata {
|
||||
Some(ref metadata) => metadata.bytecode_hash != Some(MetadataHash::None),
|
||||
@@ -266,9 +266,7 @@ pub fn standard_json<T: Compiler>(
|
||||
include_metadata_hash,
|
||||
debug_config,
|
||||
llvm_arguments,
|
||||
polkavm_settings
|
||||
.memory_config
|
||||
.unwrap_or_else(SolcStandardJsonInputSettingsPolkaVMMemory::default),
|
||||
polkavm_settings.memory_config,
|
||||
)?;
|
||||
build.write_to_standard_json(&mut solc_output, &solc_version)?;
|
||||
}
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user