ci.yml

# Copyright 2021 OpenHW Group
# Licensed under the Apache License, Version 2.0, see LICENSE for details.
# SPDX-License-Identifier: Apache-2.0

# Run functional regression checks
name: ci
on: [push, pull_request]

jobs:
  build-riscv-tests:
    name: build-riscv-tests
    runs-on: ubuntu-latest
    env:
      NUM_JOBS: 8
    steps:
    - uses: actions/checkout@v4
      with:
        submodules: recursive

    - name: Get specific submodule hash
      id: core-v-submodule-hash
      run: |
        source ci/install-prereq.sh
        cd verif/core-v-verif
        echo "hash=$(git rev-parse HEAD)" >> $GITHUB_OUTPUT

    - name: Cache toolchain
      id: cache-toolchain
      uses: actions/cache@v3
      env:
          cache-name: cache-toolchain
      with:
          path: tools/riscv-toolchain/
          key: ${{ runner.os }}-build-${{ env.cache-name }}-${{ hashFiles('ci/install-toolchain.sh') }}

    - name: Cache verilator
      id: cache-verilator
      uses: actions/cache@v3
      env:
          cache-name: cache-verilator
      with:
          path: tools/verilator/
          key: ${{ runner.os }}-build-${{ env.cache-name }}-${{ hashFiles('verif/regress/install-verilator.sh') }}

    - name: Cache Spike
      id: cache-spike
      uses: actions/cache@v3
      env:
          cache-name: cache-spike
      with:
          path: tools/spike/
          key: ${{ runner.os }}-build-${{ env.cache-name }}-${{ hashFiles('verif/regress/install-spike.sh')}}-${{ steps.core-v-submodule-hash.outputs.hash }}

    - name: Prepare
      run: |
          ci/setup.sh


  execute-riscv64-tests:
    name: execute-riscv64-tests
    runs-on: ubuntu-latest
    env:
      SPIKE_TANDEM: 1
    strategy:
      matrix:
        testcase:  [ cv64a6_imafdc_tests ]
        config:    [ cv64a6_imafdc_sv39_hpdcache, cv64a6_imafdc_sv39_wb, cv64a6_imafdc_sv39 ]
        simulator: [ veri-testharness ]
        include:
          - testcase: dv-riscv-arch-test
            config: cv64a6_imafdc_sv39_hpdcache
            simulator: veri-testharness
    needs:
      build-riscv-tests
    steps:
    - uses: actions/checkout@v4
      with:
        submodules: recursive

    - name: Get specific submodule hash
      id: core-v-submodule-hash
      run: |
        cd verif/core-v-verif
        echo "hash=$(git rev-parse HEAD)" >> $GITHUB_OUTPUT

    - name: Cache toolchain
      id: cache-toolchain
      uses: actions/cache@v3
      env:
          cache-name: cache-toolchain
      with:
          path: tools/riscv-toolchain/
          key: ${{ runner.os }}-build-${{ env.cache-name }}-${{ hashFiles('ci/install-toolchain.sh') }}

    - name: Cache verilator
      id: cache-verilator
      uses: actions/cache@v3
      env:
          cache-name: cache-verilator
      with:
          path: tools/verilator/
          key: ${{ runner.os }}-build-${{ env.cache-name }}-${{ hashFiles('verif/regress/install-verilator.sh') }}

    - name: Cache Spike
      id: cache-spike
      uses: actions/cache@v3
      env:
          cache-name: cache-spike
      with:
          path: tools/spike/
          key: ${{ runner.os }}-build-${{ env.cache-name }}-${{ hashFiles('verif/regress/install-spike.sh')}}-${{ steps.core-v-submodule-hash.outputs.hash }}

    - name: Run Tests
      run: |
          set -x
          export RISCV=$(pwd)/tools/riscv-toolchain/
          source ci/install-prereq.sh
          source verif/sim/setup-env.sh
          DV_SIMULATORS=${{matrix.simulator}},spike DV_TARGET=${{matrix.config}} bash verif/regress/${{matrix.testcase}}.sh

    - name: Upload Lint Report to Github
      if: always()
      uses: actions/upload-artifact@v4
      with:
        name: ${{matrix.simulator}}.${{matrix.testcase}}.${{matrix.config}}
        path: 'verif/sim/out*'
        retention-days: 10


  execute-riscv32-tests:
    name: execute-riscv32-tests
    runs-on: ubuntu-latest
    env:
      SPIKE_TANDEM: 1
    strategy:
      matrix:
        testcase:  [ dv-riscv-arch-test, cv32a6_tests ]
        config:    [ cv32a65x ]
        simulator: [ veri-testharness ]
    needs:
      build-riscv-tests
    steps:
    - uses: actions/checkout@v4
      with:
        submodules: recursive

    - name: Get specific submodule hash
      id: core-v-submodule-hash
      run: |
        cd verif/core-v-verif
        echo "hash=$(git rev-parse HEAD)" >> $GITHUB_OUTPUT

    - name: Cache toolchain
      id: cache-toolchain
      uses: actions/cache@v3
      env:
          cache-name: cache-toolchain
      with:
          path: tools/riscv-toolchain/
          key: ${{ runner.os }}-build-${{ env.cache-name }}-${{ hashFiles('ci/install-toolchain.sh') }}

    - name: Cache verilator
      id: cache-verilator
      uses: actions/cache@v3
      env:
          cache-name: cache-verilator
      with:
          path: tools/verilator/
          key: ${{ runner.os }}-build-${{ env.cache-name }}-${{ hashFiles('verif/regress/install-verilator.sh') }}

    - name: Cache Spike
      id: cache-spike
      uses: actions/cache@v3
      env:
          cache-name: cache-spike
      with:
          path: tools/spike/
          key: ${{ runner.os }}-build-${{ env.cache-name }}-${{ hashFiles('verif/regress/install-spike.sh')}}-${{ steps.core-v-submodule-hash.outputs.hash }}

    - name: Run Tests
      run: |
          set -x
          export RISCV=$(pwd)/tools/riscv-toolchain/
          source ci/install-prereq.sh
          source verif/sim/setup-env.sh
          DV_SIMULATORS=${{matrix.simulator}},spike DV_TARGET=${{matrix.config}} bash verif/regress/${{matrix.testcase}}.sh

    - name: Upload Lint Report to Github
      uses: actions/upload-artifact@v4
      with:
        name: ${{matrix.simulator}}.${{matrix.testcase}}.${{matrix.config}}
        path: 'verif/sim/out*'
        retention-days: 10