[ci] refactor workflows into multiple runs

chipsalliance · Jul 30, 2024 · 3f432db · 3f432db
1 parent 238fc5c
commit 3f432db
Show file tree

Hide file tree

Showing 5 changed files with 174 additions and 113 deletions.
diff --git a/.github/workflows/pd.yml b/.github/workflows/pd.yml
@@ -0,0 +1,87 @@
+name: Trigger Physical Design Workflow
+on:
+  pull_request:
+    types:
+      - opened
+      - synchronize
+      - reopened
+      - ready_for_review
+      - labeled
+env:
+  USER: runner
+
+# Cancel the current workflow when new commit pushed
+concurrency:
+  group: ${{ github.workflow }}-${{ github.event.pull_request.number }}
+  cancel-in-progress: true
+
+jobs:
+  test-emit:
+    if: '! github.event.pull_request.draft'
+    name: "Test elaborate"
+    runs-on: [self-hosted, linux, nixos]
+    strategy:
+      fail-fast: false
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          ref: ${{ github.event.pull_request.head.sha }}
+      - name: "Test elaborate"
+        run: |
+          configArray=( $(ls configgen/generated | sed 's/\.json$//') )
+          for cfg in "${configArray[@]}"; do
+            echo "Building .#t1.${cfg}.ip.rtl"
+            if ! nix build ".#t1.${cfg}.ip.rtl" -L; then
+              failed_rtl_configs+=("${cfg}.ip")
+            fi
+            if ! nix run ".#ci-helper" -- runOMTests --config ${cfg}; then
+              failed_om+=("${cfg}")
+            fi
+          done
+          if [ -n "${failed_rtl_configs[*]}"  ]; then
+            echo -e "## Failed RTL\n" >> "$GITHUB_STEP_SUMMARY"
+            for cfg in "${failed_rtl_configs[@]}"; do
+              echo "* ${cfg}" >> $GITHUB_STEP_SUMMARY
+            done
+            echo -e "## Failed RTL\n" >> "$GITHUB_STEP_SUMMARY"
+            for cfg in "${failed_om[@]}"; do
+              echo "* ${cfg}" >> $GITHUB_STEP_SUMMARY
+            done
+            printf "\n" >> $GITHUB_STEP_SUMMARY
+          fi
+
+  physical-design-report:
+    name: "Request physical design report"
+    if: ${{ success() && (contains(github.event.pull_request.labels.*.name, 'PD-Lane') || contains(github.event.pull_request.labels.*.name, 'PD-Lane-DBG'))}}
+    runs-on: ubuntu-latest
+    needs: [test-emit]
+    steps:
+      - name: "Request report"
+        env:
+          # Use env key can help us inspect the data
+          JSON_CTX: ${{ toJson(github.event.pull_request.labels.*.name) }}
+        run: |
+          # GitHub `toJson` will pretty print JSON and causing multiple line escape issue
+          # So we have to redirect it to file here
+          printf "$JSON_CTX" > _ctx.json
+          pdType=$(jq -r 'map(select(. | test("^PD-Lane.*"))) | .[0]' _ctx.json)
+          if [[ -z "$pdType" ]] || [[ "$pdType" == "null" ]]; then
+            echo "Unable to filter Physical Design type"
+            exit 1
+          fi
+
+          commitSha="${{ github.event.pull_request.head.sha }}"
+          prId="${{ github.event.pull_request.number }}"
+          jq -n \
+            --arg commit_sha "$commitSha" \
+            --arg pr_id "$prId" \
+            --arg pd_type "$pdType" \
+            '{"event_type":"ci_success","client_payload":{"commit_sha": $commit_sha,"pr_id": $pr_id, "pd_type": $pd_type }}' \
+            > payload.json
+          curl -L \
+            -X POST \
+            -H "Accept: application/vnd.github+json" \
+            -H "Authorization: Bearer ${{ secrets.T1_INHOUSE_PAT }}" \
+            -H "X-GitHub-Api-Version: 2022-11-28" \
+            "${{ secrets.T1_INHOUSE_URL }}" \
+            -d '@payload.json'
diff --git a/.github/workflows/trace.yml b/.github/workflows/trace.yml
@@ -0,0 +1,60 @@
+name: Compile Wave Trace
+on:
+  pull_request:
+    types:
+      - opened
+      - synchronize
+      - reopened
+      - ready_for_review
+      - labeled
+env:
+  USER: runner
+
+# Cancel the current workflow when new commit pushed
+concurrency:
+  group: ${{ github.workflow }}-${{ github.event.pull_request.number }}
+  cancel-in-progress: true
+
+jobs:
+  gen-test-plan:
+    if: '! github.event.pull_request.draft'
+    name: "Generate test plan"
+    runs-on: [self-hosted, linux, nixos]
+    outputs:
+      testplan: ${{ steps.get-all-configs.outputs.out }}
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          ref: ${{ github.event.pull_request.head.sha }}
+      - id: "get-all-configs"
+        run: echo "out=$(nix run .#ci-helper generateTestPlan)" > $GITHUB_OUTPUT
+
+  build-vcs-emulators:
+    name: "Build VCS trace emulators"
+    needs: [gen-test-plan]
+    runs-on: [self-hosted, linux, nixos, BIGRAM]
+    strategy:
+      fail-fast: false
+      matrix: ${{ fromJSON(needs.gen-test-plan.outputs.testplan) }}
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          ref: ${{ github.event.pull_request.head.sha }}
+      - name: "Build vcs emulator"
+        run: |
+          nix build '.#t1.${{ matrix.config }}.ip.vcs-emu-trace' --impure --no-link --cores 64
+
+  # In the future, we may choose Verdi for trace, and left verilator trace only for performance evaluation
+  build-verilator-trace-emulators:
+    name: "Build verilator trace emulators"
+    needs: [gen-test-plan]
+    runs-on: [self-hosted, linux, nixos, BIGRAM]
+    strategy:
+      fail-fast: false
+      matrix: ${{ fromJSON(needs.gen-test-plan.outputs.testplan) }}
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          ref: ${{ github.event.pull_request.head.sha }}
+      - name: "Build verilator emulator with trace"
+        run: nix build '.#t1.${{ matrix.config }}.ip.verilator-emu-trace' -L --no-link --cores 64
diff --git a/.github/workflows/vcs.yml b/.github/workflows/vcs.yml
@@ -1,4 +1,4 @@
-name: VCS
+name: VCS Test
 on:
   pull_request:
     types:

diff --git a/.github/workflows/pr.yml → .github/workflows/verilator.yml b/.github/workflows/pr.yml → .github/workflows/verilator.yml
@@ -1,4 +1,4 @@
-name: PR
+name: Verilator Test
 on:
   pull_request:
     types:
@@ -69,87 +69,6 @@ jobs:
           echo -n matrix= >> "$GITHUB_OUTPUT"
           nix run ".#ci-helper" -- generateCiMatrix --runnersAmount "$RUNNERS" >> "$GITHUB_OUTPUT"
 
-  build-trace-emulators:
-    name: "Build trace emulator"
-    needs: [gen-test-plan]
-    runs-on: [self-hosted, linux, nixos]
-    strategy:
-      fail-fast: false
-      matrix: ${{ fromJSON(needs.gen-test-plan.outputs.testplan) }}
-    steps:
-      - uses: actions/checkout@v4
-        with:
-          ref: ${{ github.event.pull_request.head.sha }}
-      - name: "Build verilator emulator with trace"
-        run: nix build '.#t1.${{ matrix.config }}.ip.verilator-emu-trace' -L --no-link --cores 64
-
-  test-emit:
-    if: '! github.event.pull_request.draft'
-    name: "Test elaborate"
-    runs-on: [self-hosted, linux, nixos]
-    strategy:
-      fail-fast: false
-    steps:
-      - uses: actions/checkout@v4
-        with:
-          ref: ${{ github.event.pull_request.head.sha }}
-      - name: "Test elaborate"
-        run: |
-          configArray=( $(ls configgen/generated | sed 's/\.json$//') )
-          for cfg in "${configArray[@]}"; do
-            echo "Building .#t1.${cfg}.ip.rtl"
-            if ! nix build ".#t1.${cfg}.ip.rtl" -L; then
-              failed_rtl_configs+=("${cfg}.ip")
-            fi
-            echo "Building .#t1.${cfg}.subsystem.rtl"
-            if ! nix build ".#t1.${cfg}.subsystem.rtl" -L; then
-              failed_rtl_configs+=("${cfg}.subsystem")
-            fi
-          done
-          if [ -n "${failed_rtl_configs[*]}"  ]; then
-            echo -e "## Failed RTL\n" >> "$GITHUB_STEP_SUMMARY"
-            for cfg in "${failed_rtl_configs[@]}"; do
-              echo "* ${cfg}" >> $GITHUB_STEP_SUMMARY
-            done
-            printf "\n" >> $GITHUB_STEP_SUMMARY
-          fi
-
-  physical-design-report:
-    name: "Request physical design report"
-    if: ${{ success() && (contains(github.event.pull_request.labels.*.name, 'PD-Lane') || contains(github.event.pull_request.labels.*.name, 'PD-Lane-DBG'))}}
-    runs-on: ubuntu-latest
-    needs: [test-emit]
-    steps:
-      - name: "Request report"
-        env:
-          # Use env key can help us inspect the data
-          JSON_CTX: ${{ toJson(github.event.pull_request.labels.*.name) }}
-        run: |
-          # GitHub `toJson` will pretty print JSON and causing multiple line escape issue
-          # So we have to redirect it to file here
-          printf "$JSON_CTX" > _ctx.json
-          pdType=$(jq -r 'map(select(. | test("^PD-Lane.*"))) | .[0]' _ctx.json)
-          if [[ -z "$pdType" ]] || [[ "$pdType" == "null" ]]; then
-            echo "Unable to filter Physical Design type"
-            exit 1
-          fi
-
-          commitSha="${{ github.event.pull_request.head.sha }}"
-          prId="${{ github.event.pull_request.number }}"
-          jq -n \
-            --arg commit_sha "$commitSha" \
-            --arg pr_id "$prId" \
-            --arg pd_type "$pdType" \
-            '{"event_type":"ci_success","client_payload":{"commit_sha": $commit_sha,"pr_id": $pr_id, "pd_type": $pd_type }}' \
-            > payload.json
-          curl -L \
-            -X POST \
-            -H "Accept: application/vnd.github+json" \
-            -H "Authorization: Bearer ${{ secrets.T1_INHOUSE_PAT }}" \
-            -H "X-GitHub-Api-Version: 2022-11-28" \
-            "${{ secrets.T1_INHOUSE_URL }}" \
-            -d '@payload.json'
-
   run-testcases:
     name: "Run testcases"
     needs: [gen-matrix]
@@ -164,9 +83,6 @@ jobs:
       - name: "Run testcases"
         run: |
           nix run ".#ci-helper" -- runTests --jobs "${{ matrix.jobs }}"
-      - name: "Run OM tests"
-        run: |
-          nix run ".#ci-helper" -- runOMTests --jobs "${{ matrix.jobs }}"
 
   report:
     name: "Report CI result"

diff --git a/script/ci/src/Main.scala b/script/ci/src/Main.scala
@@ -200,35 +200,33 @@ object Main:
 
   @main
   def runOMTests(
-      jobs: String
+      config: String
   ): Unit =
-    val configs = jobs.split(";").map(_.split(",")(0))
-    configs.distinct.foreach: config =>
-      Seq("omreader", "emu-omreader").foreach: target =>
-        val command = Seq(
-          "nix",
-          "run",
-          s".#t1.$config.ip.$target",
-          "--",
-          "run",
-          "--dump-methods"
-        )
-        println("\n")
-        Logger.info(
-          s"Running OM test with command $BOLD'${command.mkString(" ")}'$RESET"
-        )
-        val outputs = os.proc(command).call().out.trim()
-        Logger.trace(s"Outputs:\n${outputs}")
+    Seq("omreader", "verilator-emu-omreader", "vcs-emu-omreader").foreach: target =>
+      val command = Seq(
+        "nix",
+        "run",
+        s".#t1.$config.ip.$target",
+        "--",
+        "run",
+        "--dump-methods"
+      )
+      println("\n")
+      Logger.info(
+        s"Running OM test with command $BOLD'${command.mkString(" ")}'$RESET"
+      )
+      val outputs = os.proc(command).call().out.trim()
+      Logger.trace(s"Outputs:\n${outputs}")
 
-        Seq("vlen =", "dlen =").foreach: keyword =>
-          if outputs.contains(keyword) then
-            Logger.info(
-              s"Keyword $BOLD'$keyword'$RESET found - ${GREEN}Pass!$RESET"
-            )
-          else
-            Logger.fatal(
-              s"Keyword $BOLD'$keyword'$RESET not found - ${RED}Fail!$RESET"
-            )
+      Seq("vlen =", "dlen =").foreach: keyword =>
+        if outputs.contains(keyword) then
+          Logger.info(
+            s"Keyword $BOLD'$keyword'$RESET found - ${GREEN}Pass!$RESET"
+          )
+        else
+          Logger.fatal(
+            s"Keyword $BOLD'$keyword'$RESET not found - ${RED}Fail!$RESET"
+          )
   end runOMTests
 
   // PostCI do the below four things: