[WIP] Inline farcall

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,138 @@
+# Code Review Checklist
+
+
+
+## Purpose
+
+
+## Ticket Number
+
+
+## Requirements
+- [ ] Have the requirements been met?
+- [ ] Have stakeholder(s) approved the change?
+
+## Implementation
+- [ ] Does this code change accomplish what it is supposed to do?
+- [ ] Can this solution be simplified?
+- [ ] Does this change add unwanted compile-time or run-time dependencies?
+- [ ] Could an additional framework, API, library, or service improve the solution?
+- [ ] Could we reuse part of LLVM instead of implementing the patch or a part of it?
+- [ ] Is the code at the right abstraction level?
+- [ ] Is the code modular enough?
+- [ ] Can a better solution be found in terms of maintainability, readability, performance, or security?
+- [ ] Does similar functionality already exist in the codebase? If yes, why isn’t it reused?
+- [ ] Are there any best practices, design patterns or language-specific patterns that could substantially improve this code? 
+
+## Logic Errors and Bugs
+- [ ] Can you think of any use case in which the
+code does not behave as intended?
+- [ ] Can you think of any inputs or external events
+that could break the code?
+
+## Error Handling and Logging
+- [ ] Is error handling done the correct way?
+- [ ] Should any logging or debugging information
+be added or removed?
+- [ ] Are error messages user-friendly?
+- [ ] Are there enough log events and are they
+written in a way that allows for easy
+debugging?
+
+## Maintainability
+- [ ] Is the code easy to read?
+- [ ] Is the code not repeated (DRY Principle)?
+- [ ] Is the code method/class not too long?
+
+## Dependencies
+- [ ] Were updates to documentation, configuration, or readme files made as required by this change?
+- [ ] Are there any potential impacts on other parts of the system or backward compatibility?
+
+## Security
+- [ ] Does the code introduce any security vulnerabilities?
+
+## Performance
+- [ ] Do you think this code change decreases
+system performance?
+- [ ] Do you see any potential to improve the
+performance of the code significantly?
+
+## Testing and Testability
+- [ ] Is the code testable?
+- [ ] Have automated tests been added, or have related ones been updated to cover the change?
+	- [ ] For changes to mutable state
+- [ ] Do tests reasonably cover the code change (unit/integration/system tests)? 
+	- [ ] Line Coverage
+	- [ ] Region Coverage
+	- [ ] Branch Coverage
+- [ ] Are there some test cases, input or edge cases
+that should be tested in addition?
+
+## Readability
+- [ ] Is the code easy to understand?
+- [ ] Which parts were confusing to you and why?
+- [ ] Can the readability of the code be improved by
+smaller methods?
+- [ ] Can the readability of the code be improved by
+different function, method or variable names?
+- [ ] Is the code located in the right
+file/folder/package?
+- [ ] Do you think certain methods should be
+restructured to have a more intuitive control
+flow?
+- [ ] Is the data flow understandable?
+- [ ] Are there redundant or outdated comments?
+- [ ] Could some comments convey the message
+better?
+- [ ] Would more comments make the code more
+understandable?
+- [ ] Could some comments be removed by making the code itself more readable?
+- [ ] Is there any commented-out code?
+- [ ] Have you run a spelling and grammar checker?
+
+## Documentation
+- [ ] Is there sufficient documentation?
+- [ ] Is the ReadMe.md file up to date?
+
+## Best Practices
+- [ ] Follow Single Responsibility principle?
+- [ ] Are different errors handled correctly?
+- [ ] Are errors and warnings logged?
+- [ ] Magic values avoided?
+- [ ] No unnecessary comments?
+- [ ] Minimal nesting used?
+
+## Experts' Opinion
+- [ ] Do you think a specific expert, like a security
+expert or a usability expert, should look over
+the code before it can be accepted?
+- [ ] Will this code change impact different teams, and should they review the change as well?
+
+<!-- 
+MIT License
+
+Copyright (c) 2020 Michaela Greiler
+from https://github.com/mgreiler/code-review-checklist/
+Modified 2023– by Matter Labs,
+some extracts from https://www.codereviewchecklist.com added,
+Copyright (c) 2020 Lee Englestone
+also MIT License.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+ -->

.github/workflows/benchmarks-integration-tests.yml

@@ -0,0 +1,144 @@
+name: Integration tests and benchmarks
+
+on:
+  pull_request:
+  workflow_dispatch:
+    inputs:
+      llvm_build_type:
+        description: "LLVM build type: debug | release"
+        required: true
+        default: "release"
+      compiler_tester_reference_rev:
+        description: "compiler-tester revision to use as a benchmark reference"
+        required: true
+        default: "main"
+      compiler_tester_candidate_rev:
+        description: "compiler-tester revision to use as a benchmark candidate. Defaults to `main` branch if the `era-compiler-llvm-test` tag doesn't exist"
+        required: true
+        default: "era-compiler-llvm-test"
+      compiler_llvm_reference_branch:
+        description: "compiler-llvm branch to use as a benchmark reference"
+        required: true
+        default: "main"
+      compiler_llvm_candidate_branch:
+        description: "compiler-llvm branch to use as a benchmark candidate"
+        required: true
+        default: "main"
+      compiler_llvm_benchmark_mode:
+        description: "Mode filter for compiler-llvm benchmarks"
+        required: false
+        default: "^M^B3"
+      compiler_llvm_benchmark_path:
+        description: "Path filter for compiler-llvm benchmarks"
+        required: false
+        default: ""
+
+concurrency:
+  group: ${{ github.repository_id }}-${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
+  cancel-in-progress: true
+
+jobs:
+
+  # Check for secrets leak in the repository
+  secrets-scanner:
+    uses: matter-labs/era-compiler-ci/.github/workflows/secrets-scanner.yaml@v1
+    secrets: inherit
+
+  compiler-tester-ref:
+    runs-on: ubuntu-latest
+    outputs:
+      reference-ref: ${{ steps.compiler_tester_ref.outputs.reference-ref }}
+      candidate-ref: ${{ steps.compiler_tester_ref.outputs.candidate-ref }}
+    env:
+      ERA_COMPILER_LLVM_TEST_TAG: era-compiler-llvm-test
+      ERA_COMPILER_LLVM_REF_DEFAULT: main
+    steps:
+
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          repository: matter-labs/era-compiler-tester
+
+      - name: Define compiler tester ref
+        id: compiler_tester_ref
+        shell: bash
+        run: |
+          REFERENCE_REF=${{ inputs.compiler_tester_reference_rev || env.ERA_COMPILER_LLVM_REF_DEFAULT }}
+          if [ -n "$(git ls-remote --tags --heads --refs origin ${REFERENCE_REF})" ]; then
+            echo "reference-ref=${REFERENCE_REF}" | tee -a "${GITHUB_OUTPUT}"
+          else
+            echo "reference-ref=${{ env.ERA_COMPILER_LLVM_REF_DEFAULT }}" | tee -a "${GITHUB_OUTPUT}"
+          fi
+          CANDIDATE_REF=${{ inputs.compiler_tester_candidate_rev || env.ERA_COMPILER_LLVM_TEST_TAG }}
+          if [ -n "$(git ls-remote --tags --heads --refs origin ${CANDIDATE_REF})" ]; then
+            echo "candidate-ref=${CANDIDATE_REF}" | tee -a "${GITHUB_OUTPUT}"
+          else
+            echo "candidate-ref=${{ env.ERA_COMPILER_LLVM_REF_DEFAULT }}" | tee -a "${GITHUB_OUTPUT}"
+          fi
+
+  target-machine:
+    runs-on: ubuntu-latest
+    outputs:
+      evm: ${{ steps.evm.outputs.machine }}
+      eravm: ${{ steps.eravm.outputs.machine }}
+      default: ${{ steps.default.outputs.machine }}
+    steps:
+
+      - name: Check for EraVM target
+        id: eravm
+        if: contains(github.event.pull_request.title, '[EraVM]')
+        run: echo "machine=EraVM" | tee -a "${GITHUB_OUTPUT}"
+
+      - name: Check for EVM target
+        id: evm
+        if: contains(github.event.pull_request.title, '[EVM]')
+        run: echo "machine=EVM" | tee -a "${GITHUB_OUTPUT}"
+
+      - name: Check for default target
+        id: default
+        shell: bash -ex {0}
+        run: |
+          if [[ "${{ join(steps.*.outputs.*) }}" == "" ]]; then
+            echo "machine=default" | tee -a "${GITHUB_OUTPUT}"
+          fi
+
+  # Benchmarks workflow call from the era-compiler-ci repository
+  # This is a common part of the benchmarks workflow for all repositories
+  # If you would like to make a change to the benchmarks workflow, please do it in the era-compiler-ci repository
+  benchmarks:
+    needs: [compiler-tester-ref, target-machine]
+    uses: matter-labs/era-compiler-ci/.github/workflows/benchmarks.yml@v1
+    secrets: inherit
+    strategy:
+      fail-fast: false
+      matrix:
+        target: ${{ needs.target-machine.outputs.* }}
+    with:
+      llvm_build_type: ${{ github.event.inputs.llvm_build_type }}
+      compiler_tester_reference_branch: ${{ needs.compiler-tester-ref.outputs.reference-ref }}
+      compiler_tester_candidate_branch: ${{ needs.compiler-tester-ref.outputs.candidate-ref }}
+      compiler_llvm_reference_branch: ${{ github.event.inputs.compiler_llvm_reference_branch || github.event.repository.default_branch }}
+      compiler_llvm_candidate_branch: ${{ github.event.inputs.compiler_llvm_candidate_branch || github.head_ref }}
+      compiler_llvm_benchmark_mode: ${{ github.event.inputs.compiler_llvm_benchmark_mode || '^M^B3' }}
+      compiler_llvm_benchmark_path: ${{ github.event.inputs.compiler_llvm_benchmark_path || '' }}
+      ccache-key-type: 'static' # rotate ccache key every month
+      compiler-llvm-repo: ${{ github.event.pull_request.head.repo.full_name }} # required to properly test forks
+      target-machine: ${{ matrix.target }}
+
+  # Integration tests workflow call from the era-compiler-ci repository
+  # This is a common part of the integration tests workflow for all repositories
+  # If you would like to make a change to the integration tests workflow, please do it in the era-compiler-ci repository
+  integration-tests:
+    needs: [compiler-tester-ref, target-machine]
+    uses: matter-labs/era-compiler-ci/.github/workflows/integration-tests.yaml@v1
+    secrets: inherit
+    strategy:
+      fail-fast: false
+      matrix:
+        target: ${{ needs.target-machine.outputs.* }}
+    with:
+      compiler-tester-ref: ${{ needs.compiler-tester-ref.outputs.candidate-ref }}
+      llvm-ref: ${{ github.event.inputs.compiler_llvm_candidate_branch || github.head_ref || github.event.repository.default_branch }}
+      ccache-key-type: 'static' # rotate ccache key every month
+      compiler-llvm-repo: ${{ github.event.pull_request.head.repo.full_name }} # required to properly test forks
+      target-machine: ${{ matrix.target }}

.github/workflows/build-binaries.yml

@@ -0,0 +1,103 @@
+name: Build LLVM binaries
+
+on:
+  schedule:
+    - cron: '0 0 1 * *' # every month to regenerate ccache
+  workflow_dispatch:
+    inputs:
+      ref:
+        description: "Git REF to use for the build"
+        required: false
+        type: string
+      build_macos_amd64:
+        description: "Build for MacOS amd64?"
+        required: false
+        type: boolean
+        default: true
+      build_macos_arm64:
+        description: "Build for MacOS arm64?"
+        required: false
+        type: boolean
+        default: true
+      build_linux_amd64:
+        description: "Build for Linux amd64?"
+        required: false
+        type: boolean
+        default: true
+      build_linux_arm64:
+        description: "Build for Linux arm64?"
+        required: false
+        type: boolean
+        default: true
+      build_windows_amd64:
+        description: "Build for Windows amd64?"
+        required: false
+        type: boolean
+        default: true
+
+
+jobs:
+
+  prepare-matrix:
+    runs-on: ubuntu-latest
+    outputs:
+      matrix: ${{ steps.prepare-matrix.outputs.matrix }}
+    steps:
+      - name: Prepare matrix
+        id: prepare-matrix
+        run: |
+          # Define general matrix parameters
+          WINDOWS='{"name":"Windows","runner":"windows-2022-github-hosted-64core"}'
+          MACOS_AMD64='{"name":"MacOS-x86","runner":"macos-12-large"}'
+          MACOS_ARM64='{"name":"MacOS-arm64","runner":["self-hosted","macOS","ARM64"]}'
+          LINUX_AMD64='{"name":"Linux-AMD64","runner":"matterlabs-ci-runner","image":"ghcr.io/matter-labs/zksync-llvm-runner:latest"}'
+          LINUX_ARM64='{"name":"Linux-ARM64","runner":"matterlabs-ci-runner-arm","image":"ghcr.io/matter-labs/zksync-llvm-runner:latest"}'
+          # Disable platforms for non-tag builds if user requested
+          if [ ${GITHUB_EVENT_NAME} = workflow_dispatch ]; then
+            [ ${{ github.event.inputs.build_windows_amd64 }} != true ] && WINDOWS=
+            [ ${{ github.event.inputs.build_macos_amd64 }} != true ] && MACOS_AMD64=
+            [ ${{ github.event.inputs.build_macos_arm64 }} != true ] && MACOS_ARM64=
+            [ ${{ github.event.inputs.build_linux_amd64 }} != true ] && LINUX_AMD64=
+            [ ${{ github.event.inputs.build_linux_arm64 }} != true ] && LINUX_ARM64=
+          fi
+          PLATFORMS=(${WINDOWS} ${MACOS_AMD64} ${MACOS_ARM64} ${LINUX_AMD64} ${LINUX_ARM64})
+          echo "matrix={ \"include\": [ $(IFS=, ; echo "${PLATFORMS[*]}") ] }" | tee -a "${GITHUB_OUTPUT}"
+
+  build:
+    needs: prepare-matrix
+    strategy:
+      fail-fast: false
+      matrix: ${{ fromJson(needs.prepare-matrix.outputs.matrix) }}
+    runs-on: ${{ matrix.runner }}
+    container:
+      image: ${{ matrix.image || '' }} # Special workaround to allow matrix builds with optional container
+    name: ${{ matrix.name }}
+    steps:
+      - name: Checkout source
+        uses: actions/checkout@v4
+        with:
+          ref: ${{ inputs.ref }}
+          path: "llvm"
+
+      - name: Prepare Windows env
+        if: runner.os == 'Windows'
+        uses: matter-labs/era-compiler-ci/.github/actions/prepare-msys@v1
+
+      - name: Build LLVM
+        uses: matter-labs/era-compiler-ci/.github/actions/build-llvm@v1
+        with:
+          enable-tests: true
+          enable-assertions: true
+          clone-llvm: false
+          ccache-key-type: 'static'
+          save-ccache: ${{ matrix.name == 'Linux x86' }}
+
+      # Required to keep executable permissions for binaries
+      - name: Prepare tarball
+        run: tar -czf ${{ runner.os }}-${{ runner.arch }}-target-final.tar.gz ./target-llvm/target-final
+
+      - name: Upload LLVM binaries
+        uses: actions/upload-artifact@v4
+        with:
+          name: llvm-bins-${{ runner.os }}-${{ runner.arch }}
+          path: ./${{ runner.os }}-${{ runner.arch }}-target-final.tar.gz