coreblocks 0.2026.7.3__tar.gz

coreblocks-0.2026.7.3/.gitattributes

@@ -0,0 +1,8 @@
+* text=auto
+*.sh text eol=lf
+*.bat text eol=crlf
+*.ps1 text eol=crlf
+
+*.jpg binary
+*.png binary
+*.svg binary

coreblocks-0.2026.7.3/.github/workflows/benchmark.yml

@@ -0,0 +1,287 @@
+name: Core Benchmarks
+
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+    types: [ synchronize, labeled ]
+    branches:
+      - master
+  workflow_dispatch:
+
+jobs:
+  synthesis:
+    strategy:
+      matrix:
+        config: [basic, full]
+    name: Run synthesis benchmarks
+    if: >
+      github.ref == 'refs/heads/master' ||
+      (
+        github.event_name == 'pull_request' &&
+        (
+          (github.event.action == 'synchronize' && contains(github.event.pull_request.labels.*.name, 'benchmark')) ||
+          (github.event.action == 'labeled' && github.event.label.name == 'benchmark')
+        )
+      )
+    runs-on: ubuntu-24.04
+    timeout-minutes: 45
+    container: ghcr.io/kuznia-rdzeni/amaranth-synth:ecp5-2025.01.31
+    steps:
+      - uses: actions/checkout@v6
+
+      - name: Set ownership (Github Actions workaround)
+        run: |
+          # https://github.com/actions/runner/issues/2033
+          chown -R $(id -u):$(id -g) $PWD
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.13'
+
+      - name: Install dependencies
+        run: |
+          python3 -m venv venv
+          . venv/bin/activate
+          python3 -m pip install --upgrade pip
+          python3 -m pip install ".[dev]"
+
+      - name: Synthesize
+        run: |
+          . venv/bin/activate
+          PYTHONHASHSEED=0 ./scripts/synthesize.py --verbose --strip-debug --config ${{ matrix.config }}
+
+      - name: Print synthesis information
+        run: cat ./build/top.tim
+
+      - name: Collect Benchmark information
+        run: |
+          . venv/bin/activate
+          ./scripts/parse_benchmark_info.py -o synth-benchmark-${{ matrix.config }}.json
+          cat ./synth-benchmark-${{ matrix.config }}.json
+
+      - uses: actions/upload-artifact@v7
+        with:
+          name: synth_benchmark_results-${{ matrix.config }}
+          path: synth-benchmark-${{ matrix.config }}.json
+
+
+  build-perf-benchmarks:
+    name: Build performance benchmarks
+    runs-on: ubuntu-latest
+    if: >
+      github.ref == 'refs/heads/master' ||
+      (
+        github.event_name == 'pull_request' &&
+        (
+          (github.event.action == 'synchronize' && contains(github.event.pull_request.labels.*.name, 'benchmark')) ||
+          (github.event.action == 'labeled' && github.event.label.name == 'benchmark')
+        )
+      )
+    container: ghcr.io/kuznia-rdzeni/riscv-toolchain:2024.12.07
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v6
+        with:
+          submodules: recursive
+
+      - name: Build embench
+        run: cd test/external/embench && make
+
+      - uses: actions/upload-artifact@v7
+        with:
+          name: "embench"
+          path: |
+            test/external/embench/build
+
+  run-perf-benchmarks:
+    name: Run performance benchmarks
+    runs-on: ubuntu-22.04  # older version for compatibility with Docker image
+    timeout-minutes: 60
+    container: ghcr.io/kuznia-rdzeni/verilator:v5.032-2026.04.15
+    needs: build-perf-benchmarks
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v6
+
+      - name: Set ownership (Github Actions workaround)
+        run: |
+          # https://github.com/actions/runner/issues/2033
+          chown -R $(id -u):$(id -g) $PWD
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.13'
+
+      - name: Install dependencies
+        run: |
+          python3 -m venv venv
+          . venv/bin/activate
+          python3 -m pip install --upgrade pip
+          python3 -m pip install ".[dev]"
+
+      - name: Generate Verilog
+        run: |
+          . venv/bin/activate
+          PYTHONHASHSEED=0 TRANSACTRON_VERBOSE=1 python3 -m coreblocks.gen_verilog --verbose --config full
+
+      - uses: actions/download-artifact@v8
+        with:
+          name: "embench"
+          path: test/external/embench/build
+
+      - name: Run benchmarks
+        run: |
+          . venv/bin/activate
+          scripts/run_benchmarks.py -o perf_benchmark.json --summary perf.md
+          cat perf.md >> $GITHUB_STEP_SUMMARY
+
+      - uses: actions/upload-artifact@v7
+        with:
+          name: perf_benchmark_results
+          path: perf_benchmark.json
+
+  pr-summary:
+    name: Create benchmark summary for a pull request
+    if: ${{ github.event_name == 'pull_request' }}
+    runs-on: ubuntu-latest
+    timeout-minutes: 5
+    needs: [run-perf-benchmarks, synthesis]
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v6
+
+      - name: Set ownership (Github Actions workaround)
+        run: |
+          # https://github.com/actions/runner/issues/2033
+          chown -R $(id -u):$(id -g) $PWD
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.13'
+
+      - name: Install dependencies
+        run: |
+          python3 -m venv venv
+          . venv/bin/activate
+          python3 -m pip install --upgrade pip
+          python3 -m pip install ".[dev]"
+
+      - name: Get baseline benchmarks results
+        uses: actions/cache@v4
+        env:
+          cache-name: benchmark-results
+        with:
+          key: ${{ env.cache-name }}-${{ runner.os }}-${{ github.event.pull_request.base.sha }}
+          path: |
+            perf_benchmark.json
+            synth-benchmark-basic.json
+            synth-benchmark-full.json
+
+      - uses: actions/download-artifact@v8
+        with:
+          name: perf_benchmark_results
+          path: artifacts
+      - uses: actions/download-artifact@v8
+        with:
+          name: synth_benchmark_results-basic
+          path: artifacts
+      - uses: actions/download-artifact@v8
+        with:
+          name: synth_benchmark_results-full
+          path: artifacts
+
+      - name: Save PR number
+        run: |
+          mkdir -p ./summary
+          echo ${{ github.event.number }} > ./summary/pr_number
+
+      - name: Create comment
+        id: createComment
+        run: |
+          . venv/bin/activate
+          {
+            echo "## Benchmarks summary"
+            echo "### Performance benchmarks"
+            ci/print_benchmark_summary.py --precision 3 artifacts/perf_benchmark.json perf_benchmark.json
+            echo
+            echo "You can view all the metrics [here](${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }})."
+            echo "### Synthesis benchmarks (basic)"
+            ci/print_benchmark_summary.py --precision 0 artifacts/synth-benchmark-basic.json synth-benchmark-basic.json
+            echo
+            echo "### Synthesis benchmarks (full)"
+            ci/print_benchmark_summary.py --precision 0 artifacts/synth-benchmark-full.json synth-benchmark-full.json
+            echo
+          } >> summary/comment.md
+
+      - uses: actions/upload-artifact@v4
+        with:
+          name: benchmark-summary
+          path: summary
+
+  publish-benchmarks:
+    name: Publish benchmarks
+    if: github.ref == 'refs/heads/master'
+    runs-on: ubuntu-latest
+    timeout-minutes: 5
+    needs: [run-perf-benchmarks, synthesis]
+    steps:
+      - uses: actions/checkout@v6
+
+      - uses: actions/download-artifact@v8
+        with:
+          name: perf_benchmark_results
+          path: .
+      - uses: actions/download-artifact@v8
+        with:
+          name: synth_benchmark_results-basic
+          path: .
+      - uses: actions/download-artifact@v8
+        with:
+          name: synth_benchmark_results-full
+          path: .
+
+      - name: Put results in a cache
+        uses: actions/cache@v4
+        env:
+          cache-name: benchmark-results
+        with:
+          key: ${{ env.cache-name }}-${{ runner.os }}-${{ github.sha }}
+          path: |
+            perf_benchmark.json
+            synth-benchmark-basic.json
+            synth-benchmark-full.json
+
+      - name: Store benchmark result (IPC)
+        uses: benchmark-action/github-action-benchmark@v1
+        with:
+          name: Performance (IPC)
+          tool: 'customBiggerIsBetter'
+          output-file-path: './perf_benchmark.json'
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+          auto-push: true
+          benchmark-data-dir-path: "dev/benchmark"
+
+      - name: Store synthesis benchmark result (basic)
+        uses: benchmark-action/github-action-benchmark@v1
+        with:
+          name: Fmax and LCs (basic)
+          tool: 'customBiggerIsBetter'
+          output-file-path: './synth-benchmark-basic.json'
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+          auto-push: true
+          benchmark-data-dir-path: "dev/benchmark"
+
+      - name: Store synthesis benchmark result (full)
+        uses: benchmark-action/github-action-benchmark@v1
+        with:
+          name: Fmax and LCs (full)
+          tool: 'customBiggerIsBetter'
+          output-file-path: './synth-benchmark-full.json'
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+          auto-push: true
+          benchmark-data-dir-path: "dev/benchmark"

coreblocks-0.2026.7.3/.github/workflows/deploy_gh_pages.yml

@@ -0,0 +1,48 @@
+name: Build docs and trigger gh-pages
+
+on:
+  push:
+    branches:
+      - "master"
+  pull_request:
+    branches:
+      - "master"
+  workflow_dispatch:
+
+jobs:
+  push_gh-pages:
+    runs-on: ubuntu-latest
+    timeout-minutes: 5
+    env:
+      GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+      GH_MAIL: ${{github.event.pusher.email}}
+      GH_NAME: ${{github.event.pusher.name}}
+      DOCS_DIR: "docs"
+      BUILD_DIR: "build"
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v6
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.13"
+
+      - name: Install dependencies
+        run: |
+          python3 -m venv venv
+          . venv/bin/activate
+          python -m pip install --upgrade pip
+          python -m pip install ".[dev]"
+
+      - name: Build documentation
+        run: |
+          . venv/bin/activate
+          ./ci/build_docs.sh
+
+      - name: Push documentation
+        # Deploy documentation only when on master
+        if: github.ref == 'refs/heads/master'
+        run: |
+          . venv/bin/activate
+          ./ci/push_gh_pages.sh

coreblocks-0.2026.7.3/.github/workflows/main.yml

@@ -0,0 +1,327 @@
+name: CI
+
+on:
+  push:
+    branches:
+      - master
+      - 'feature/**'
+  pull_request:
+    branches:
+      - master
+      - 'feature/**'
+  workflow_dispatch:
+
+jobs:
+  build-core:
+    name: Synthesize full core
+    runs-on: ubuntu-latest
+    timeout-minutes: 5
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v6
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+            python-version: '3.13'
+
+      - name: Install Coreblocks dependencies
+        run: |
+          python3 -m venv venv
+          . venv/bin/activate
+          python3 -m pip install --upgrade pip
+          python3 -m pip install .
+
+      - name: Generate Verilog
+        run: |
+          . venv/bin/activate
+          PYTHONHASHSEED=0 TRANSACTRON_VERBOSE=1 python3 -m coreblocks.gen_verilog --verbose --config full
+
+      - uses: actions/upload-artifact@v7
+        with:
+          name: "verilog-full-core"
+          path: |
+            core.v
+            core.v.json
+
+  build-regression-tests:
+    name: Build regression tests (riscv-tests)
+    runs-on: ubuntu-latest
+    container: ghcr.io/kuznia-rdzeni/riscv-toolchain:2024.12.07
+    timeout-minutes: 10
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v6
+
+      - name: Get submodules HEAD hash
+        run: |
+          git config --global --add safe.directory /__w/coreblocks/coreblocks
+          git submodule > .gitmodules-hash
+
+      - name: Cache regression-tests
+        id: cache-regression
+        uses: actions/cache@v4
+        env:
+          cache-name: cache-regression-tests
+        with:
+          path: test/external/riscv-tests/test-*
+          key: ${{ env.cache-name }}-${{ runner.os }}-${{ hashFiles(
+              '**/test/external/riscv-tests/environment/custom/**',
+              '**/test/external/riscv-tests/Makefile',
+              '**/.gitmodules-hash',
+              '**/docker/riscv-toolchain.Dockerfile',
+              '**/.github/workflows/main.yml'
+            ) }}
+          lookup-only: true
+
+      - if: ${{ steps.cache-regression.outputs.cache-hit != 'true' }}
+        name: Checkout with submodules
+        uses: actions/checkout@v6
+        with:
+          submodules: recursive
+
+      - if: ${{ steps.cache-regression.outputs.cache-hit != 'true' }}
+        run: cd test/external/riscv-tests && make
+
+      - if: ${{ steps.cache-regression.outputs.cache-hit != 'true' }}
+        name: Upload riscv-tests
+        uses: actions/upload-artifact@v7
+        with:
+          path: test/external/riscv-tests
+
+  run-regression-tests:
+    name: Run regression tests (riscv-tests)
+    runs-on: ubuntu-22.04  # older version for compatibility with Docker image
+    timeout-minutes: 60
+    container: ghcr.io/kuznia-rdzeni/verilator:v5.008-2023.11.19_v
+    needs: [ build-regression-tests, build-core ]
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v6
+
+      - name: Get submodules HEAD hash
+        run: |
+          git config --global --add safe.directory /__w/coreblocks/coreblocks
+          git submodule > .gitmodules-hash
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.13'
+
+      - name: Install dependencies
+        run: |
+          python3 -m venv venv
+          . venv/bin/activate
+          python3 -m pip install --upgrade pip
+          python3 -m pip install ".[dev]"
+
+      - uses: actions/download-artifact@v8
+        name: Download full verilog core
+        with:
+          name: "verilog-full-core"
+          path: .
+
+      - uses: actions/cache@v4
+        name: Download tests from cache
+        env:
+          cache-name: cache-regression-tests
+        with:
+          path: test/external/riscv-tests/test-*
+          key: ${{ env.cache-name }}-${{ runner.os }}-${{ hashFiles(
+              '**/test/external/riscv-tests/environment/custom/**',
+              '**/test/external/riscv-tests/Makefile',
+              '**/.gitmodules-hash',
+              '**/docker/riscv-toolchain.Dockerfile',
+              '**/.github/workflows/main.yml'
+            ) }}
+          fail-on-cache-miss: true
+
+      - name: Run tests
+        run: |
+          . venv/bin/activate
+          scripts/run_tests.py -a regression -v
+
+      - name: Check regression with pysim
+        run: |
+          . venv/bin/activate
+          ./scripts/run_tests.py -c 1 -a -b pysim regression
+
+  build-arch-regression-tests:
+    name: Build arch regression tests (riscv-arch-test)
+    runs-on: ubuntu-latest
+    container:
+      image: ghcr.io/riscv/act4-build:sha-cb452225bcac086030f4bf6f3565298abe45401c
+      options: --user root
+    timeout-minutes: 20
+    steps:
+      - name: Add required tools for github CI
+        run: |
+          apt-get update
+          apt-get install -y git tar gzip curl ca-certificates build-essential libgmp-dev
+
+      - name: Checkout
+        uses: actions/checkout@v6
+
+      - name: Get submodules HEAD hash
+        working-directory: .
+        run: |
+          git config --global --add safe.directory /__w/coreblocks/coreblocks
+          git submodule > .gitmodules-hash
+
+      - name: Cache arch regression tests
+        id: cache-arch-regression-tests
+        uses: actions/cache@v4
+        env:
+          cache-name: cache-arch-regression-tests
+        with:
+          path: |
+            test/external/riscv-arch-test/elfs/**/*.elf
+          key: ${{ env.cache-name }}-${{ runner.os }}-${{ hashFiles(
+              '**/test/external/riscv-arch-test/Makefile',
+              '**/test/external/riscv-arch-test/coreblocks/**',
+              '**/.gitmodules-hash',
+              '**/.github/workflows/main.yml'
+            ) }}
+
+      - if: ${{ steps.cache-arch-regression-tests.outputs.cache-hit != 'true' }}
+        name: Checkout with submodules
+        uses: actions/checkout@v6
+        with:
+          submodules: recursive
+
+      - if: ${{ steps.cache-arch-regression-tests.outputs.cache-hit != 'true' }}
+        name: Trust riscv-arch-test with mise
+        run: mise trust test/external/riscv-arch-test/.mise.toml
+
+      - if: ${{ steps.cache-arch-regression-tests.outputs.cache-hit != 'true' }}
+        name: Build arch regression tests
+        run: make -C test/external/riscv-arch-test -j $(nproc)
+
+      - name: Upload riscv-arch-test tests
+        uses: actions/upload-artifact@v7
+        with:
+          name: "riscv-arch-test-elfs"
+          path: test/external/riscv-arch-test/elfs
+
+  run-arch-regression-tests:
+    strategy:
+      fail-fast: false
+      matrix:
+        config: [cocotb, pysim]
+    name: Run arch regression tests (riscv-arch-test)
+    runs-on: ubuntu-22.04  # older version for compatibility with Docker image
+    container: ghcr.io/kuznia-rdzeni/verilator:v5.008-2023.11.19_v
+    timeout-minutes: 180
+    needs: [ build-arch-regression-tests ]
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v6
+
+      - name: Get submodules HEAD hash
+        working-directory: .
+        run: |
+          git config --global --add safe.directory /__w/coreblocks/coreblocks
+          git submodule > .gitmodules-hash
+
+      - name: Restore arch regression tests cache
+        uses: actions/cache@v4
+        env:
+          cache-name: cache-arch-regression-tests
+        with:
+          path: |
+            test/external/riscv-arch-test/elfs/**/*.elf
+          key: ${{ env.cache-name }}-${{ runner.os }}-${{ hashFiles(
+              '**/test/external/riscv-arch-test/Makefile',
+              '**/test/external/riscv-arch-test/coreblocks/**',
+              '**/.gitmodules-hash',
+              '**/.github/workflows/main.yml'
+            ) }}
+          fail-on-cache-miss: true
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.13'
+
+      - name: Install dependencies
+        run: |
+          python3 -m venv venv
+          . venv/bin/activate
+          python3 -m pip install --upgrade pip
+          python3 -m pip install ".[dev]"
+
+      - name: Run arch regression tests
+        run: |
+          . venv/bin/activate
+          if [ "${{ matrix.config }}" = "cocotb" ]; then
+            ./scripts/run_tests.py --arch-tests -v -b cocotb regression
+          else
+            ./scripts/run_tests.py --arch-tests -v -b pysim -c 1 -j 0 'regression.*not'
+          fi
+
+  unit-test:
+    name: Run unit tests
+    runs-on: ubuntu-latest
+    timeout-minutes: 150
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v6
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.13'
+          cache: 'pip'
+          cache-dependency-path: |
+            pyproject.toml
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip3 install ".[dev]"
+          sudo apt-get install -y binutils-riscv64-unknown-elf
+
+      - name: Run tests
+        run: ./scripts/run_tests.py -v
+
+      - name: Check traces and profiles
+        run: ./scripts/run_tests.py -t -p -c 1 TestCore
+
+      - name: Check listing tests
+        run: ./scripts/run_tests.py -l
+
+  lint:
+    name: Check code formatting and typing
+    runs-on: ubuntu-latest
+    timeout-minutes: 5
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v6
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.13'
+          cache: 'pip'
+          cache-dependency-path: |
+            pyproject.toml
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip3 install ".[dev]"
+
+      - name: Check format
+        run: ./scripts/lint.sh check_format
+
+      - name: Check types
+        run: ./scripts/lint.sh check_types
+
+      - name: Check line endings
+        run: |
+          git add --renormalize .
+          git diff --cached --exit-code
+
+      - name: Check pre-commit hooks
+        run: pre-commit run --all-files --show-diff-on-failure