Increment Sail version, and consolidate version usage in CI. (#1963)

Make the `sail-setup` action use the Sail version in
`cmake/sail_required_version.txt` by default.

---------

Signed-off-by: Prashanth Mundkur <prashanth@riscv.org>

Author: pmundkur

.github/actions/sail-setup/action.yml

@@ -8,12 +8,12 @@ inputs:
   sail-version:
     description: 'Sail version to install (use "latest" to build from source)'
     required: false
-    default: "0.20.2"
   install-clang:
     description: "Install latest Clang"
     required: false
     default: "false"
 
+# The 'default' Sail version below is the one specified in `cmake/sail_required_version.txt`.
 # This is the current CI Platform/Target support matrix:
 #
 #                          | RISC-V Model                 |sail-riscv-tests|first-party-tests|   Rocq    |    Lean        | Linux boot
@@ -93,33 +93,43 @@ runs:
           cmake_suffix="universal"
         fi
         curl --location https://github.com/Kitware/CMake/releases/download/v${{ inputs.cmake-version }}/cmake-${{ inputs.cmake-version }}-${{ runner.os }}-$cmake_suffix.tar.gz | sudo tar xvz --directory=/usr/local --strip-components=1
+
+    - name: Set Sail version
+      shell: bash
+      run: |
+        if [ -n ${{ inputs.sail-version }} ]; then
+          echo "SAIL_VERSION=$(cat cmake/sail_required_version.txt)" >> $GITHUB_ENV
+        else
+          echo "SAIL_VERSION=${{ inputs.sail-version }}" >>  $GITHUB_ENV
+        fi
+
     - name: Restore cached opam (macOS or latest Sail)
-      if: runner.os == 'macOS' || inputs.sail-version == 'latest'
+      if: runner.os == 'macOS' || env.SAIL_VERSION == 'latest'
       id: cache-opam-restore
       uses: actions/cache/restore@v4
       with:
         path: ~/.opam
-        key: ${{ runner.os }}-${{ runner.arch }}-cmake-${{ inputs.cmake-version }}-sail-${{ inputs.sail-version }}-opam
+        key: ${{ runner.os }}-${{ runner.arch }}-cmake-${{ inputs.cmake-version }}-sail-${{ env.SAIL_VERSION }}-opam
 
     - name: Install Sail (Linux binary)
-      if: runner.os == 'Linux' && inputs.sail-version != 'latest'
+      if: runner.os == 'Linux' && env.SAIL_VERSION != 'latest'
       shell: bash
       run: |
         sudo mkdir -p /usr/local
-        curl --location https://github.com/rems-project/sail/releases/download/${{ inputs.sail-version }}-binary/sail-$(uname)-$(arch).tar.gz | sudo tar xvz --directory=/usr/local --strip-components=1
+        curl --location https://github.com/rems-project/sail/releases/download/${{ env.SAIL_VERSION }}-binary/sail-$(uname)-$(arch).tar.gz | sudo tar xvz --directory=/usr/local --strip-components=1
 
     - name: Install Sail (macOS opam)
-      if: runner.os == 'macOS' && steps.cache-opam-restore.outputs.cache-hit != 'true' && inputs.sail-version != 'latest'
+      if: runner.os == 'macOS' && steps.cache-opam-restore.outputs.cache-hit != 'true' && env.SAIL_VERSION != 'latest'
       shell: bash
       run: |
         opam init --auto-setup --bare
         opam switch create default 5.3.0
         eval $(opam env)
         opam update
-        opam install -y sail.${{ inputs.sail-version }}
+        opam install -y sail.${{ env.SAIL_VERSION }}
 
     - name: Install opam (latest Sail)
-      if: inputs.sail-version == 'latest'
+      if: env.SAIL_VERSION == 'latest'
       shell: bash
       run: |
         if [ "${{ runner.os }}" = "Linux" ]; then
@@ -129,14 +139,14 @@ runs:
         fi
 
     - name: Setup opam (latest Sail)
-      if: inputs.sail-version == 'latest' && steps.cache-opam-restore.outputs.cache-hit != 'true'
+      if: env.SAIL_VERSION == 'latest' && steps.cache-opam-restore.outputs.cache-hit != 'true'
       shell: bash
       run: |
         opam init --yes --no-setup --shell=sh --compiler=5.3.0
         opam install dune
 
     - name: Install Sail (latest Sail)
-      if: inputs.sail-version == 'latest'
+      if: env.SAIL_VERSION == 'latest'
       shell: bash
       run: |
         git clone https://github.com/rems-project/sail.git
@@ -146,7 +156,7 @@ runs:
 
     - name: Save cached opam (macOS or latest Sail)
       # Update cache only on the master branch
-      if: (runner.os == 'macOS' || inputs.sail-version == 'latest') && github.ref == 'refs/heads/master'
+      if: (runner.os == 'macOS' || env.SAIL_VERSION == 'latest') && github.ref == 'refs/heads/master'
       id: cache-opam-save
       uses: actions/cache/save@v4
       with:

.github/workflows/ci.yml

@@ -58,8 +58,7 @@ jobs:
 
       - name: Get tests version
         run: |
-          SAIL_RISCV_TESTS_VERSION=$(cat test/sail_riscv_tests_version.txt)
-          echo "SAIL_RISCV_TESTS_VERSION=$SAIL_RISCV_TESTS_VERSION" >> $GITHUB_ENV
+          echo "SAIL_RISCV_TESTS_VERSION=$(cat test/sail_riscv_tests_version.txt)" >> $GITHUB_ENV
 
       - name: Restore cached tests
         uses: actions/cache/restore@v6

.github/workflows/release.yml

@@ -51,7 +51,6 @@ jobs:
     container: ${{ matrix.container }}
 
     env:
-      SAIL_VERSION: "0.20.2"
       # This helps with reproducible builds by not embedding variable timestamps in files.
       # This is needed in particular for the Debian package's compressed changelog.
       # See the comments in `cmake/packaging.cmake`.

.github/workflows/run-full-tests.yml

@@ -32,20 +32,24 @@ jobs:
             RISCV_VECTOR_TESTS_V256_E64,
             RISCV_VECTOR_TESTS_V512_E64,
           ]
+
     steps:
       - name: Check out repository code
         uses: actions/checkout@v7
         with:
           # Git history is needed for `git describe` in the build to work.
           fetch-depth: 0
+
       - name: Common setup
         uses: ./.github/actions/sail-setup
         with:
           install-clang: "true"
+
       - name: Build simulator
         run: |
           cmake -S . -B build -GNinja -DCMAKE_BUILD_TYPE=RelWithDebInfo -DENABLE_${{ matrix.TEST_SUITE }}=TRUE -DENABLE_LTO=TRUE
           ninja -C build all
+
       - name: Run tests
         run: |
           ctest --test-dir build --output-on-failure

README.md

@@ -83,8 +83,6 @@ $ ./build_simulator.sh
 
 will build the simulator at `build/c_emulator/sail_riscv_sim`.
 
-If you get an error message saying `sail: unknown option '--require-version'.` it's because your Sail compiler is too old. You need version 0.20.2 or later.
-
 By default [`build_simulator.sh`](./build_simulator.sh) will download and build [libgmp](https://gmplib.org).
 To use a system installation of libgmp, run `env DOWNLOAD_GMP=FALSE ./build_simulator.sh` instead.
 

cmake/sail_required_version.txt

@@ -1 +1 @@
-0.20.2
+0.20.3

doc/ChangeLog.md

@@ -8,6 +8,9 @@
   - Whether the `mcountinhibit` CSR is supported, and if so, which
     bits are writable, can now be specified; see `base.mcountinhibit`.
 
+- Other notes:
+  - The model now requires the Sail 0.20.3 compiler version.
+
 # Release notes for version 0.14.1
 
 This is primarily a bug-fix release with fixes for the issues listed