Merge reusable-tsan.yml and reusable-ubsan.yml

hugovk · webknjaz · commit 859256708960 · 2025-07-19T18:01:27.000+02:00
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -597,17 +597,19 @@ jobs:
         free-threading:
         - false
         - true
-    uses: ./.github/workflows/reusable-tsan.yml
+    uses: ./.github/workflows/reusable-san.yml
     with:
+      sanitizer: TSan
       config_hash: ${{ needs.build-context.outputs.config-hash }}
       free-threading: ${{ matrix.free-threading }}
 
   build-ubsan:
     name: Undefined behavior sanitizer
     needs: build-context
     if: needs.build-context.outputs.run-tests == 'true'
-    uses: ./.github/workflows/reusable-ubsan.yml
+    uses: ./.github/workflows/reusable-san.yml
     with:
+      sanitizer: UBSan
       config_hash: ${{ needs.build-context.outputs.config-hash }}
 
   cross-build-linux:
diff --git a/.github/workflows/reusable-san.yml b/.github/workflows/reusable-san.yml
@@ -1,8 +1,11 @@
-name: Reusable Thread Sanitizer
+name: Reusable Sanitizer
 
 on:
   workflow_call:
     inputs:
+      sanitizer:
+        required: true
+        type: string
       config_hash:
         required: true
         type: string
@@ -16,8 +19,8 @@ env:
   FORCE_COLOR: 1
 
 jobs:
-  build-tsan-reusable:
-    name: 'Thread sanitizer'
+  build-san-reusable:
+    name: ${{ inputs.sanitizer }}
     runs-on: ubuntu-24.04
     timeout-minutes: 60
     steps:
@@ -30,29 +33,42 @@ jobs:
       uses: actions/cache@v4
       with:
         path: config.cache
-        key: ${{ github.job }}-${{ env.IMAGE_OS_VERSION }}-${{ inputs.config_hash }}
+        key: ${{ github.job }}-${{ env.IMAGE_OS_VERSION }}-${{ inputs.sanitizer }}-${{ inputs.config_hash }}
     - name: Install dependencies
       run: |
         sudo ./.github/workflows/posix-deps-apt.sh
-        # Install clang-18
+        # Install clang
         wget https://apt.llvm.org/llvm.sh
         chmod +x llvm.sh
-        sudo ./llvm.sh 17  # gh-121946: llvm-18 package is temporarily broken
-        sudo update-alternatives --install /usr/bin/clang clang /usr/bin/clang-17 100
-        sudo update-alternatives --set clang /usr/bin/clang-17
-        sudo update-alternatives --install /usr/bin/clang++ clang++ /usr/bin/clang++-17 100
-        sudo update-alternatives --set clang++ /usr/bin/clang++-17
-        # Reduce ASLR to avoid TSAN crashing
-        sudo sysctl -w vm.mmap_rnd_bits=28
-    - name: TSAN option setup
+
+        if [ "${SANITIZER}" = "TSan" ]; then
+          sudo ./llvm.sh 17  # gh-121946: llvm-18 package is temporarily broken
+          sudo update-alternatives --install /usr/bin/clang clang /usr/bin/clang-17 100
+          sudo update-alternatives --set clang /usr/bin/clang-17
+          sudo update-alternatives --install /usr/bin/clang++ clang++ /usr/bin/clang++-17 100
+          sudo update-alternatives --set clang++ /usr/bin/clang++-17
+          # Reduce ASLR to avoid TSan crashing
+          sudo sysctl -w vm.mmap_rnd_bits=28
+        else
+          sudo ./llvm.sh 20
+        fi
+
+    - name: Sanitizer option setup
       run: |
-        echo "TSAN_OPTIONS=log_path=${GITHUB_WORKSPACE}/tsan_log suppressions=${GITHUB_WORKSPACE}/Tools/tsan/suppressions${{
-            fromJSON(inputs.free-threading)
-            && '_free_threading'
-            || ''
-          }}.txt handle_segv=0" >> "$GITHUB_ENV"
+        if [ "${SANITIZER}" = "TSan" ]; then
+          echo "TSAN_OPTIONS=${SAN_LOG_OPTION} suppressions=${GITHUB_WORKSPACE}/Tools/tsan/suppressions${{
+              fromJSON(inputs.free-threading)
+              && '_free_threading'
+              || ''
+            }}.txt handle_segv=0" >> "$GITHUB_ENV"
+        else
+          echo "UBSAN_OPTIONS=${SAN_LOG_OPTION}" >> "$GITHUB_ENV"
+        fi
         echo "CC=clang" >> "$GITHUB_ENV"
         echo "CXX=clang++" >> "$GITHUB_ENV"
+      env:
+        SANITIZER: ${{ inputs.sanitizer }}
+        SAN_LOG_OPTION: log_path=${{ github.workspace }}/san_log
     - name: Add ccache to PATH
       run: |
         echo "PATH=/usr/lib/ccache:$PATH" >> "$GITHUB_ENV"
@@ -65,30 +81,36 @@ jobs:
       run: >-
         ./configure
         --config-cache
-        --with-thread-sanitizer
+        ${{
+          inputs.sanitizer == 'TSan'
+          && '--with-thread-sanitizer'
+          || '--with-undefined-behavior-sanitizer'
+        }}
         --with-pydebug
         ${{ fromJSON(inputs.free-threading) && '--disable-gil' || '' }}
     - name: Build CPython
       run: make -j4
     - name: Display build info
       run: make pythoninfo
     - name: Tests
-      run: ./python -m test --tsan -j4
+      run: ./python -m test ${{ inputs.sanitizer == 'TSan' && '--tsan' || '' }} -j4
     - name: Parallel tests
-      if: fromJSON(inputs.free-threading)
+      if: >-
+        inputs.sanitizer == 'TSan'
+        && fromJSON(inputs.free-threading)
       run: ./python -m test --tsan-parallel --parallel-threads=4 -j4
-    - name: Display TSAN logs
+    - name: Display logs
       if: always()
-      run: find "${GITHUB_WORKSPACE}" -name 'tsan_log.*' | xargs head -n 1000
-    - name: Archive TSAN logs
+      run: find "${GITHUB_WORKSPACE}" -name 'san_log.*' | xargs head -n 1000
+    - name: Archive logs
       if: always()
       uses: actions/upload-artifact@v4
       with:
         name: >-
-          tsan-logs-${{
+          ${{ inputs.sanitizer }}-logs-${{
             fromJSON(inputs.free-threading)
             && 'free-threading'
             || 'default'
           }}
-        path: tsan_log.*
+        path: san_log.*
         if-no-files-found: ignore
diff --git a/.github/workflows/reusable-ubsan.yml b/.github/workflows/reusable-ubsan.yml
