pull: PR on stable-23 and hammersim23 rebase

.git-blame-ignore-revs

@@ -29,3 +29,9 @@ c3bd8eb1214cbebbc92c7958b80aa06913bce3ba
 
 # A commit which ran flynt all Python files.
 e73655d038cdfa68964109044e33c9a6e7d85ac9
+
+# A commit which ran pre-commit on ext/testlib
+9e1afdecefaf910fa6e266f29dc480a32b0fa83e
+
+# Updated black from 22.6.0 to 23.9.1
+ddf6cb88e48df4ac7de4a9e4b612daf2e7e635c8

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,56 @@
+---
+name: Bug report
+about: Create a report to help us find and fix the bug
+title: ''
+labels: bug
+assignees: ''
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**Affects version**
+State which version of gem5 this bug was found in. If on the develop branch state the Commit revision ID you are working.
+
+**gem5 Modifications**
+If you have modified gem5 in some way please state, to the best of your ability, how it has been modified.
+
+**To Reproduce**
+Steps to reproduce the behavior. Please assume starting from a clean repository:
+
+1. Compile gem5 with command ...
+2. Execute the simulation with...
+
+If writing code, or a terminal command, use code blocks. Either an inline code block, `scons build/ALL/gem5.opt` (enclosed in two '`') or a multi-line codeblock:
+
+
+```python
+int x=2
+int y=3
+print(x+y)
+```
+
+If possible, please include the Python configuration script used and state clearly any parameters passed.
+
+**Terminal Output**
+If applicable, add the terminal output here. If long, only include the relevant lines.
+Please put the terminal output in code blocks. I.e.:
+
+```shell
+#Terminal output here#
+```
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Host Operating System**
+Ubuntu 22.04, Mac OS X, etc.
+
+**Host ISA**
+ARM, X86, RISC-V, etc.
+
+**Compiler used**
+State which compiler was used to compile gem5. Please include the compiler version.
+
+**Additional information**
+Add any other information which does not fit in the previous sections but may be of use in fixing this bug.

.github/workflows/ci-tests.yaml

@@ -1,103 +1,195 @@
+---
 # This workflow runs after a pull-request has been approved by a reviewer.
 
 name: CI Tests
 
 on:
-  pull_request:
-    types: [opened, edited, synchronize, ready_for_review]
+    pull_request:
+        types: [opened, edited, synchronize, ready_for_review]
 
+concurrency:
+    group: ${{ github.workflow }}-${{ github.ref || github.run_id }}
+    cancel-in-progress: true
 
 jobs:
-  pre-commit:
+    pre-commit:
     # runs on github hosted runner
-    runs-on: ubuntu-22.04
-    steps:
-    - uses: actions/checkout@v3
-    - uses: actions/setup-python@v3
-    - uses: pre-commit/action@v3.0.0
+        runs-on: ubuntu-22.04
+        if: github.event.pull_request.draft == false
+        steps:
+            - uses: actions/checkout@v3
+            - uses: actions/setup-python@v3
+            - uses: pre-commit/action@v3.0.0
 
   # ensures we have a change-id in every commit, needed for gerrit
-  check-for-change-id:
-    # runs on github hosted runner
-    runs-on: ubuntu-latest
-    container: gcr.io/gem5-test/ubuntu-22.04_all-dependencies:latest
-    steps:
-      - uses: actions/github-script@v6
-        env:
-          token: "Change-Id"
-          pattern: ".*"
-        with:
-          script: |
-            const commits = ${{ toJSON(github.event.commits) }}
-            for (const commit of commits) {
-              const id = "Change-Id: "
-              const message = commit.message;
-              if (!message.includes(id)) {
-                core.setFailed('One or more of the commits in this pull request is missing a Change-ID, which we require for any changes made to gem5. ' +
-                'To automatically insert one, run the following:\n f=`git rev-parse --git-dir`/hooks/commit-msg ; mkdir -p $(dirname $f) ; ' +
-                'curl -Lo $f https://gerrit-review.googlesource.com/tools/hooks/commit-msg ; chmod +x $f\n Then amend the commit with git commit --amend --no-edit, and update your pull request.')
-              }
-            }
-
-  build-gem5:
-    runs-on: [self-hosted, linux, x64, build]
-    container: gcr.io/gem5-test/ubuntu-22.04_all-dependencies:latest
-    needs: [pre-commit, check-for-change-id] # only runs if pre-commit and change-id passes
-    outputs:
-      artifactname: ${{ steps.name.outputs.test }}
-    steps:
-      - uses: actions/checkout@v3
-      - id: name
-        run: echo "test=$(date +"%Y-%m-%d_%H.%M.%S")-artifact" >> $GITHUB_OUTPUT
-
-      - name: Build gem5
-        run: |
-          scons build/ALL/gem5.opt -j $(nproc)
-      - uses: actions/upload-artifact@v3
-        with:
-          name: ${{ steps.name.outputs.test }}
-          path: build/ALL/gem5.opt
-      - run: echo "This job's status is ${{ job.status }}."
-
-  unittests-all-opt:
-    runs-on: [self-hosted, linux, x64, run]
-    container: gcr.io/gem5-test/ubuntu-22.04_all-dependencies:latest
-    needs: [pre-commit, check-for-change-id] # only runs if pre-commit and change-id passes
-    timeout-minutes: 60
-    steps:
-      - uses: actions/checkout@v3
-      - name: CI Unittests
-        working-directory: ${{ github.workspace }}
-        run: scons build/ALL/unittests.opt -j $(nproc)
-      - run: echo "This job's status is ${{ job.status }}."
-
-  testlib-quick:
-    runs-on: [self-hosted, linux, x64, run]
-    container: gcr.io/gem5-test/ubuntu-22.04_all-dependencies:latest
-    needs: [pre-commit, check-for-change-id, build-gem5]
-    timeout-minutes: 360     # 6 hours
-    steps:
-      - uses: actions/checkout@v3
-      - uses: actions/download-artifact@v3
-        with:
-          name: ${{needs.build-gem5.outputs.artifactname}}
-          path: build/ALL
-      - run: chmod u+x build/ALL/gem5.opt
-      - name: The TestLib CI Tests
-        working-directory: ${{ github.workspace }}/tests
-        run: ./main.py run --skip-build -vv
-      - name: create zip of results
-        if: success() || failure()
-        run: |
-          apt-get -y install zip
-          zip -r output.zip tests/testing-results
-      - name: upload zip
-        if: success() || failure()
-        uses: actions/upload-artifact@v3
-        env:
-          MY_STEP_VAR: ${{github.job}}_COMMIT.${{github.sha}}_RUN.${{github.run_id}}_ATTEMPT.${{github.run_attempt}}
-        with:
-          name: ${{ env.MY_STEP_VAR }}
-          path: output.zip
-          retention-days: 7
-      - run: echo "This job's status is ${{ job.status }}."
+    check-for-change-id:
+        # runs on github hosted runner
+        runs-on: ubuntu-22.04
+        if: github.event.pull_request.draft == false
+        steps:
+            - uses: actions/checkout@v3
+              with:
+                  fetch-depth: 0
+            - name: Check for Change-Id
+              run: |
+                  # loop through all the commits in the pull request
+                  for commit in $(git rev-list ${{ github.event.pull_request.base.sha }}..${{ github.event.pull_request.head.sha }}); do
+                      git checkout $commit
+                      if (git log -1 --pretty=format:"%B" | grep -q "Change-Id: ")
+                      then
+                        # passes as long as at least one change-id exists in the pull request
+                        exit 0
+                      fi
+                  done
+                  # if we reach this part, none of the commits had a change-id
+                  echo "None of the commits in this pull request contains a Change-ID, which we require for any changes made to gem5. "\
+                    "To automatically insert one, run the following:\n f=`git rev-parse --git-dir`/hooks/commit-msg ; mkdir -p $(dirname $f) ; "\
+                    "curl -Lo $f https://gerrit-review.googlesource.com/tools/hooks/commit-msg ; chmod +x $f\n Then amend the commit with git commit --amend --no-edit, and update your pull request."
+                  exit 1
+
+    unittests-all-opt:
+        runs-on: [self-hosted, linux, x64]
+        if: github.event.pull_request.draft == false
+        container: ghcr.io/gem5/ubuntu-22.04_all-dependencies:latest
+        needs: [pre-commit, check-for-change-id] # only runs if pre-commit and change-id passes
+        timeout-minutes: 60
+        steps:
+            - uses: actions/checkout@v3
+            - name: CI Unittests
+              working-directory: ${{ github.workspace }}
+              run: scons build/ALL/unittests.opt -j $(nproc)
+            - run: echo "This job's status is ${{ job.status }}."
+
+    testlib-quick-matrix:
+        runs-on: [self-hosted, linux, x64]
+        if: github.event.pull_request.draft == false
+    # In order to make sure the environment is exactly the same, we run in
+    # the same container we use to build gem5 and run the testlib tests. This
+        container: ghcr.io/gem5/ubuntu-22.04_all-dependencies:latest
+        needs: [pre-commit, check-for-change-id]
+        steps:
+            - uses: actions/checkout@v3
+
+      # Unfortunately the 'ubunutu-latest' image doesn't have jq installed.
+      # We therefore need to install it as a step here.
+            - name: Install jq
+              run: apt install -y jq
+
+            - name: Get directories for testlib-quick
+              working-directory: ${{ github.workspace }}/tests
+              id: dir-matrix
+              run: echo "test-dirs-matrix=$(find gem5/* -type d -maxdepth 0 | jq -ncR '[inputs]')" >>$GITHUB_OUTPUT
+
+            - name: Get the build targets for testlib-quick-gem5-builds
+              working-directory: ${{ github.workspace }}/tests
+              id: build-matrix
+              run: echo "build-matrix=$(./main.py list --build-targets -q | jq -ncR '[inputs]')" >>$GITHUB_OUTPUT
+
+        outputs:
+            build-matrix: ${{ steps.build-matrix.outputs.build-matrix }}
+            test-dirs-matrix: ${{ steps.dir-matrix.outputs.test-dirs-matrix }}
+
+    clang-fast-compilation:
+        # gem5 binaries built in `quick-gem5-builds` always use GCC.
+        # Clang is more strict than GCC. This job checks that gem5 compiles
+        # with Clang. It compiles build/ALL/gem5.fast to maximize the change
+        # for compilation error to be exposed.
+        runs-on: [self-hosted, linux, x64]
+        if: github.event.pull_request.draft == false
+        container: ghcr.io/gem5/clang-version-16:latest
+        needs: [pre-commit, check-for-change-id]
+        timeout-minutes: 90
+        steps:
+            - uses: actions/checkout@v3
+            - name: Clang Compilation
+              working-directory: ${{ github.workspace }}
+              run: scons build/ALL/gem5.fast -j $(nproc)
+
+    testlib-quick-gem5-builds:
+        runs-on: [self-hosted, linux, x64]
+        if: github.event.pull_request.draft == false
+        container: ghcr.io/gem5/ubuntu-22.04_all-dependencies:latest
+        needs: [pre-commit, check-for-change-id, testlib-quick-matrix]
+        strategy:
+            matrix:
+                build-target: ${{ fromJson(needs.testlib-quick-matrix.outputs.build-matrix) }}
+        steps:
+            - uses: actions/checkout@v3
+            - name: Build gem5
+              run: scons ${{ matrix.build-target }} -j $(nproc)
+
+        # Upload the gem5 binary as an artifact.
+        # Note: the "achor.txt" file is a hack to make sure the paths are
+        # preserverd in the artifact. The upload-artifact action finds the
+        # closest common directory and uploads everything relative to that.
+        # E.g., if we upload "build/ARM/gem5.opt" and "build/RISCV/gem5.opt"
+        # Then upload-artifact will upload "ARM/gem5.opt" and "RISCV/gem5.opt",
+        # stripping the "build" directory. By adding the "anchor.txt" file, we
+        # ensure the "build" directory is preserved.
+            - run: echo "anchor" > anchor.txt
+            - uses: actions/upload-artifact@v3
+              with:
+                  name: ci-tests-${{ github.run_number }}-testlib-quick-all-gem5-builds
+                  path: |
+                      build/*/gem5.*
+                      anchor.txt
+                  retention-days: 7
+
+    testlib-quick-execution:
+        runs-on: [self-hosted, linux, x64]
+        if: github.event.pull_request.draft == false
+        container: ghcr.io/gem5/ubuntu-22.04_all-dependencies:latest
+        needs: [pre-commit, check-for-change-id, testlib-quick-matrix, testlib-quick-gem5-builds]
+        timeout-minutes: 360 # 6 hours
+        strategy:
+            fail-fast: false
+            matrix:
+                test-dir: ${{ fromJson(needs.testlib-quick-matrix.outputs.test-dirs-matrix) }}
+        steps:
+            - name: Clean runner
+              run: rm -rf ./* || true rm -rf ./.??* || true rm -rf ~/.cache || true
+
+        # Checkout the repository then download the gem5.opt artifact.
+            - uses: actions/checkout@v3
+            - uses: actions/download-artifact@v3
+              with:
+                  name: ci-tests-${{ github.run_number }}-testlib-quick-all-gem5-builds
+
+        # Check that the gem5.opt artifact exists and is executable.
+            - name: Chmod gem5.{opt,debug,fast} to be executable
+              run: |
+                  find . -name "gem5.opt" -exec chmod u+x {} \;
+                  find . -name "gem5.debug" -exec chmod u+x {} \;
+                  find . -name "gem5.fast" -exec chmod u+x {} \;
+
+        # Run the testlib quick tests in the given directory.
+            - name: Run "tests/${{ matrix.test-dir }}" TestLib quick tests
+              id: run-tests
+              working-directory: ${{ github.workspace }}/tests
+              run: ./main.py run --skip-build -vv -j$(nproc) ${{ matrix.test-dir }}
+
+        # Get the basename of the matrix.test-dir path (to name the artifact).
+            - name: Sanatize test-dir for artifact name
+              id: sanitize-test-dir
+              if: success() || failure()
+              run: echo "sanatized-test-dir=$(echo '${{ matrix.test-dir }}' | sed 's/\//-/g')" >> $GITHUB_OUTPUT
+
+        # Upload the tests/testing-results directory as an artifact.
+            - name: Upload test results
+              if: success() || failure()
+              uses: actions/upload-artifact@v3
+              with:
+                  name: ci-tests-run-${{ github.run_number }}-attempt-${{ github.run_attempt }}-testlib-quick-${{ steps.sanitize-test-dir.outputs.sanatized-test-dir
+                      }}-status-${{ steps.run-tests.outcome }}-output
+                  path: tests/testing-results
+                  retention-days: 30
+
+    testlib-quick:
+    # It is 'testlib-quick' which needs to pass for the pull request to be
+    # merged. The 'testlib-quick-execution' is a matrix job which runs all the
+    # the testlib quick tests. This job is therefore a stub which will pass if
+    # all the testlib-quick-execution jobs pass.
+        runs-on: ubuntu-22.04
+        needs: testlib-quick-execution
+        steps:
+            - run: echo "This job's status is ${{ job.status }}."