Run TSAN in CI (#144)

Author: crusaderky

.github/workflows/sanitizers.yml

@@ -0,0 +1,56 @@
+name: Sanitizers
+
+on:
+  push:
+    branches: [main]
+    paths-ignore:
+      - "*.md"
+  pull_request:
+    branches: ["*"]
+    paths-ignore:
+      - "*.md"
+  workflow_dispatch: # allows you to trigger manually
+
+# When this workflow is queued, automatically cancel any previous running
+# or pending jobs from the same branch
+concurrency:
+  group: tsan-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  TSAN:
+    runs-on: ubuntu-latest
+    container:
+        image: ghcr.io/nascheme/numpy-tsan:3.14t
+
+    steps:
+      - name: Check out repo
+        uses: actions/checkout@v6
+
+      - name: Install build dependencies
+        run: python -m pip install -U build pip setuptools wheel cython
+
+      - name: Build wheel
+        run: | 
+          # See setup.py for special handling in flame-blis modules
+          export CFLAGS="$CFLAGS -fsanitize=thread"
+          # Build without isolation to use TSAN-enabled NumPy from the container
+          python -m build --wheel --no-isolation
+
+      - name: Install wheel
+        run: python -m pip install dist/*.whl
+
+      - name: Delete source directory
+        run: rm -rf blis
+
+      - name: Test import
+        run: python -c "import blis" -Werror
+
+      - name: Install test requirements
+        run: python -m pip install -r requirements.txt
+
+      - name: Run pytest-run-parallel
+        env:
+          # Reference: https://github.com/google/sanitizers/wiki/ThreadSanitizerFlags
+          TSAN_OPTIONS: "halt_on_error=0 suppressions=tsan_suppressions.txt"
+        run: pytest -s --parallel-threads 4

README.md

@@ -7,6 +7,7 @@ This repository provides the
 self-contained Python C-extension.
 
 [![tests](https://github.com/explosion/cython-blis/actions/workflows/tests.yml/badge.svg)](https://github.com/explosion/cython-blis/actions/workflows/tests.yml)
+[![sanitizers](https://github.com/explosion/cython-blis/actions/workflows/sanitizers.yml/badge.svg)](https://github.com/explosion/cython-blis/actions/workflows/sanitizers.yml)
 [![pypi Version](https://img.shields.io/pypi/v/blis.svg?style=flat-square&logo=pypi&logoColor=white)](https://pypi.python.org/pypi/blis)
 [![conda](https://img.shields.io/conda/vn/conda-forge/cython-blis.svg?style=flat-square&logo=conda-forge&logoColor=white)](https://anaconda.org/conda-forge/cython-blis)
 [![Python wheels](https://img.shields.io/badge/wheels-%E2%9C%93-4c1.svg?longCache=true&style=flat-square&logo=python&logoColor=white)](https://github.com/explosion/wheelwright/releases)

setup.py

@@ -254,6 +254,13 @@ def compile_objects(self, platform, py_arch, obj_dir):
                 # spec["flags"].append(
                 #    "-D__cpuid=__cpuid_function"
                 # )
+                if "-fsanitize=thread" in os.environ.get("CFLAGS", "").split():
+                    # Enable TSAN compilation flag for flame-blis modules.
+                    # Ignore other environmental CFLAGS; for everything else
+                    # use the jsonl specs instead.
+                    # Cython modules use CFLAGS directly instead.
+                    spec["flags"].append("-fsanitize=thread")
+
                 objects.append(self.build_object(env=env, **spec))
         return objects
 

tsan_suppressions.txt

@@ -0,0 +1,8 @@
+# This file contains suppressions for the TSAN tool
+# Reference: https://github.com/google/sanitizers/wiki/ThreadSanitizerSuppressions
+
+# https://github.com/numpy/numpy/issues/30085
+race:mt19937
+race:mtrand
+# https://github.com/cython/cython/issues/7383
+race:__Pyx__CyFunction_SetClassObj