Fix: add llvm- prefix to llvm version tag (#225)

Needed both for differentiating them from regular releases and for
filtering the tags in automation

.github/workflows/release-llvm.yml

@@ -0,0 +1,167 @@
+name: Release LLVM
+
+on:
+  workflow_dispatch:
+    inputs:
+      llvm_version:
+        type: string
+        required: true
+        description: llvm version in "x.x.x" format, e.g. "18.1.8"
+
+env:
+  CARGO_TERM_COLOR: always
+
+jobs:
+  create-release:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+    outputs:
+      version: ${{ steps.resolve-version.outputs.version }}
+    steps:
+      - id: resolve-version
+        run: |
+          echo "version=llvm-${{ inputs.llvm_version }}-revive.${GITHUB_SHA:0:7}" >> $GITHUB_OUTPUT
+
+      - name: create release
+        uses: softprops/action-gh-release@v2
+        with:
+          name: "LLVM binaries release: ${{ steps.resolve-version.outputs.version }}"
+          body: "This release includes binaries of LLVM, used to compile revive itself"
+          make_latest: "false"
+          tag_name: ${{ steps.resolve-version.outputs.version }}
+
+  build-macos:
+    strategy:
+      matrix:
+        os: [macos-14, macos-13]
+        include:
+          - os: macos-13
+            arch: x64
+          - os: macos-14
+            arch: arm64
+    needs: create-release
+    runs-on: ${{ matrix.os }}
+    name: "build-macos-${{ matrix.arch }}"
+    env:
+      RUST_LOG: trace
+    permissions:
+      contents: write # for uploading assets to release
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: install macos deps
+        run: |
+          brew install ninja
+
+      - name: versions
+        run: |
+          rustup show
+          cargo --version
+          cmake --version
+          echo "bash:" && bash --version
+          echo "ninja:" && ninja --version
+          echo "clang:" && clang --version
+
+      - name: Build LLVM
+        run: |
+          make install-llvm
+
+      - name: clean
+        # check removed files
+        run: |
+          cd target-llvm/gnu/target-final/bin/
+          rm diagtool llvm-libtool-darwin llvm-lipo llvm-pdbutil llvm-dwarfdump llvm-nm llvm-readobj llvm-cfi-verify \
+             sancov llvm-debuginfo-analyzer llvm-objdump llvm-profgen llvm-extract llvm-jitlink llvm-c-test llvm-gsymutil llvm-dwp \
+             dsymutil llvm-dwarfutil llvm-exegesis lli clang-rename bugpoint clang-extdef-mapping clang-refactor c-index-test \
+             llvm-reduce llvm-lto clang-linker-wrapper llc llvm-lto2
+
+      - name: package artifacts
+        run: |
+          tar -czf "${{ needs.create-release.outputs.version }}-macos-${{ matrix.arch }}.tar.gz" target-llvm/gnu/target-final
+
+      - name: upload archive to release
+        uses: softprops/action-gh-release@v2
+        with:
+          make_latest: "false"
+          tag_name: ${{ needs.create-release.outputs.version }}
+          files: |
+            ${{ needs.create-release.outputs.version }}-macos-${{ matrix.arch }}.tar.gz
+
+
+  build-linux-all:
+    needs: create-release
+    runs-on: parity-large
+    env:
+      RUST_LOG: trace
+    permissions:
+      contents: write # for uploading assets to release
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: install linux deps
+        run: |
+          sudo apt-get update && sudo apt-get install -y cmake ninja-build curl git libssl-dev pkg-config clang lld musl
+
+      - uses: actions-rust-lang/setup-rust-toolchain@v1
+        with:
+          toolchain: stable
+          components: rust-src
+          target: wasm32-unknown-emscripten
+          rustflags: ""
+
+      - name: versions
+        run: |
+          rustup show
+          cargo --version
+          cmake --version
+          echo "bash:" && bash --version
+          echo "ninja:" && ninja --version
+          echo "clang:" && clang --version
+
+      - name: Build host LLVM
+        run: |
+          make install-llvm
+
+      - name: Build gnu LLVM
+        run: |
+          revive-llvm clone
+          revive-llvm build --llvm-projects lld --llvm-projects clang
+
+      - name: Build musl LLVM
+        run: |
+          revive-llvm --target-env musl build --llvm-projects lld --llvm-projects clang
+
+      - name: Build emscripten LLVM
+        run: |
+          revive-llvm --target-env emscripten clone
+          source emsdk/emsdk_env.sh
+          revive-llvm --target-env emscripten build --llvm-projects lld
+
+      - name: clean
+        # check removed files
+        run: |
+          for target in gnu emscripten musl; do
+            cd target-llvm/${target}/target-final/bin/
+            rm -rf diagtool llvm-libtool-darwin llvm-lipo llvm-pdbutil llvm-dwarfdump llvm-nm llvm-readobj llvm-cfi-verify \
+               sancov llvm-debuginfo-analyzer llvm-objdump llvm-profgen llvm-extract llvm-jitlink llvm-c-test llvm-gsymutil llvm-dwp \
+               dsymutil llvm-dwarfutil llvm-exegesis lli clang-rename bugpoint clang-extdef-mapping clang-refactor c-index-test \
+               llvm-reduce llvm-lto clang-linker-wrapper llc llvm-lto2 llvm-otool llvm-readelf
+            cd -
+          done
+
+      - name: package artifacts
+        run: |
+          tar -czf "${{ needs.create-release.outputs.version }}-x86_64-linux-gnu-linux.tar.gz" target-llvm/gnu/target-final
+          tar -czf "${{ needs.create-release.outputs.version }}-x86_64-linux-musl.tar.gz" target-llvm/musl/target-final
+          tar -czf "${{ needs.create-release.outputs.version }}-wasm32-unknown-emscripten.tar.gz" target-llvm/emscripten/target-final
+
+      - name: upload archive to release
+        uses: softprops/action-gh-release@v2
+        with:
+          make_latest: "false"
+          tag_name: ${{ needs.create-release.outputs.version }}
+          files: |
+            ${{ needs.create-release.outputs.version }}-x86_64-linux-gnu-linux.tar.gz
+            ${{ needs.create-release.outputs.version }}-x86_64-linux-musl.tar.gz
+            ${{ needs.create-release.outputs.version }}-wasm32-unknown-emscripten.tar.gz

README.md

@@ -1,5 +1,5 @@
 ![CI](https://github.com/paritytech/revive/actions/workflows/rust.yml/badge.svg)
-[![Docs](https://img.shields.io/badge/Docs-contracts.polkadot.io-brightgreen.svg)](https://contracts.polkadot.io)
+[![Docs](https://img.shields.io/badge/Docs-contracts.polkadot.io-brightgreen.svg)](https://contracts.polkadot.io/revive_compiler/)
 
 # revive
 
@@ -14,10 +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
-
-`resolc` depends on the [solc](https://github.com/ethereum/solidity) binary installed on your system.
-
-Download and install the `resolc` frontend executable for your platform from our [releases](https://github.com/paritytech/revive/releases).
+Please consult [the documentation](https://contracts.polkadot.io/revive_compiler/installation) for installation instructions.
 
 ## Building from source
 
@@ -25,22 +22,46 @@ Building revive requires a [stable Rust installation](https://rustup.rs/) and a
 
 ### LLVM
 
-`revive` depends on a custom build of LLVM `v18.1.8` with the RISC-V _embedded_ target, including the `compiler-rt` builtins. 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.
+`revive` depends on a custom build of LLVM `v18.1.8` with the RISC-V _embedded_ target, including the `compiler-rt` builtins. You can either download a build from our releases (recommended for older hardware) or build it from source.
+
+<details>
+  <summary>Download from our LLVM releases</summary>
+
+Download the [latest LLVM build](https://github.com/paritytech/revive/releases?q=LLVM+binaries+release&expanded=true) from our releases.
+
+> **MacOS** users need to clear the `downloaded` attribute from all binaries after extracting the archive:
+> ```sh
+> xattr -rc </path/to/the/extracted/archive>/target-llvm/gnu/target-final/bin/*
+> ```
+
+After extracting the archive, point `$LLVM_SYS_181_PREFIX` to it:
+```sh
+export LLVM_SYS_181_PREFIX=</path/to/the/extracted/archive>/target-llvm/gnu/target-final
+```
+
+</details>
+
+<details>
+  <summary>Building from source</summary>
+
+ Use the provided [revive-llvm](crates/llvm-builder/README.md) utility to compile a compatible LLVM build locally and point `$LLVM_SYS_181_PREFIX` to the installation afterwards.
 
 The `Makefile` provides a shortcut target to obtain a compatible LLVM build:
 
-```bash
+```sh
 make install-llvm
 export LLVM_SYS_181_PREFIX=${PWD}/target-llvm/gnu/target-final
 ```
 
+</details>
+
 ### The `resolc` Solidity frontend
 
-To build the `resolc` Solidity frontend executable, make sure you have obtained a compatible LLVM build using [revive-llvm](crates/llvm-builder/README.md) and did export the `LLVM_SYS_181_PREFIX` environment variable pointing to it (see [above](#LLVM)).
+To build the `resolc` Solidity frontend executable, make sure you have obtained a compatible LLVM build and did export the `LLVM_SYS_181_PREFIX` environment variable pointing to it (see [above](#LLVM)).
 
 To install the `resolc` Solidity frontend executable:
 
-```bash
+```sh
 make install-bin
 resolc --version
 ```
@@ -49,7 +70,10 @@ resolc --version
 
 Cross-compile the `resolc.js` frontend executable to Wasm for running it in a Node.js or browser environment. The `REVIVE_LLVM_TARGET_PREFIX` environment variable is used to control the target environment LLVM dependency.
 
-```bash
+<details>
+  <summary>Instructions for cross-compilation to wasm32-unknown-emscripten</summary>
+
+```sh
 # Build the host LLVM dependency with PolkaVM target support
 make install-llvm
 export LLVM_SYS_181_PREFIX=${PWD}/target-llvm/gnu/target-final
@@ -65,21 +89,23 @@ make install-wasm
 make test-wasm
 ```
 
-### Development
+</details>
+
+## Development
 
 Please consult the [Makefile](Makefile) targets to learn how to run tests and benchmarks. 
 Ensure that your branch passes `make test` locally when submitting a pull request.
 
-## Design overview
+### Design overview
+See the [relevant section in our documentation](https://contracts.polkadot.io/revive_compiler/architecture) to learn more about how the compiler works. 
 
-`revive` uses [solc](https://github.com/ethereum/solidity/), the Ethereum Solidity compiler, as the [Solidity frontend](crates/solidity/src/lib.rs) to process smart contracts written in Solidity. The YUL IR code (or legacy EVM assembly as a fallback for older `solc` versions) emitted by `solc` is then translated to LLVM IR, targetting [Polkadots `revive` pallet](https://docs.rs/pallet-revive/latest/pallet_revive/trait.SyscallDoc.html).
-[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`.
+[Frontend](https://github.com/matter-labs/era-compiler-solidity) and [code generator](https://github.com/matter-labs/era-compiler-llvm-context) are based of ZKSync `zksolc` (the project started as a fork of the era compiler).
 
-## Tests
+### Tests
 
 Before running the tests, ensure that Geth (Go Ethereum) is installed on your system. Follow the installation guide here: [Installing Geth](https://geth.ethereum.org/docs/getting-started/installing-geth).
 Once Geth is installed, you can run the tests using the following command:
 
-```bash
+```sh
 make test
 ```

RELEASE.md

@@ -7,4 +7,11 @@ To create a new pre-release:
 1. Merge a release PR which updates the `-dev.X` versions in the workspace `Cargo.toml` and updates the `CHANGELOG.md` accordingly. The release workflow will attempt to build and publish a new release whenever the latest git tag does not match the cargo package version.
 2. Wait for the `Release` workflow to finish. If the workflow fails after the `build-linux-all` step, check if a tag has been created and delete it before restarting or pushing updates. Note: It's more convenient to debug the release workflow in a fork (the fork has to be under the `paritytech` org to access `parity-large` runners).
 3. Check draft release on [Releases page](https://github.com/paritytech/revive/releases) and publish (should contain `resolc.js`, `resolc.wasm`, `resolc-web.js`, and `resolc-static-linux` release assets)
-4. Update the [contract-docs](https://github.com/paritytech/contract-docs/) accordingly
+4. Update the [contract-docs](https://github.com/paritytech/contract-docs/) accordingly
+
+# LLVM release
+
+To create a new LLVM release, run "Release LLVM" workflow. Use current LLVM version as parameter, e.g. `18.1.8`.
+Version suffix will be resolved automatically.  
+The workflows will create new GitHub release, and upload LLVM binaries.
+Next release of resolc will use newly created binaries.  

crates/llvm-context/src/polkavm/context/function/mod.rs

@@ -212,22 +212,6 @@ impl<'ctx> Function<'ctx> {
         }
     }
 
-    /// Sets the exception handler attributes.
-    pub fn set_exception_handler_attributes(
-        llvm: &'ctx inkwell::context::Context,
-        declaration: Declaration<'ctx>,
-    ) {
-        Self::set_attributes(llvm, declaration, vec![Attribute::NoInline], false);
-    }
-
-    /// Sets the CXA-throw attributes.
-    pub fn set_cxa_throw_attributes(
-        llvm: &'ctx inkwell::context::Context,
-        declaration: Declaration<'ctx>,
-    ) {
-        Self::set_attributes(llvm, declaration, vec![Attribute::NoProfile], false);
-    }
-
     /// Sets the pure function attributes.
     pub fn set_pure_function_attributes(
         llvm: &'ctx inkwell::context::Context,

crates/solidity/src/yul/parser/statement/expression/function_call/mod.rs

@@ -943,7 +943,7 @@ impl FunctionCall {
             Name::BlobHash => {
                 let _arguments = self.pop_arguments_llvm::<D, 1>(context)?;
                 anyhow::bail!(
-                    "{} The `BLOBHASH` instruction is not supported until zkVM v1.5.0",
+                    "{} The `BLOBHASH` instruction is not supported in revive",
                     location
                 );
             }
@@ -958,7 +958,7 @@ impl FunctionCall {
             }
             Name::BlobBaseFee => {
                 anyhow::bail!(
-                    "{} The `BLOBBASEFEE` instruction is not supported until zkVM v1.5.0",
+                    "{} The `BLOBBASEFEE` instruction is not supported in revive",
                     location
                 );
             }