Merge pull request scipy#23936 from FFY00/add-asan

BLD/CI: Add ASAN suppressions and CI job

Author: FFY00

.github/workflows/macos.yml

@@ -138,3 +138,75 @@ jobs:
           spin build --with-accelerate
           pip install -r requirements/test.txt
           spin test
+
+
+  clang_ASAN:
+    name: Test under AddressSanitizer
+    runs-on: macos-15
+    needs: get_commit_message
+    if: >
+      needs.get_commit_message.outputs.message == 1
+      && (github.repository == 'scipy/scipy' || github.repository == '')
+    steps:
+    - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
+      with:
+        submodules: recursive
+        fetch-tags: true
+        persist-credentials: false
+
+    - name: Set up pyenv
+      run: |
+        git clone https://github.com/pyenv/pyenv.git "$HOME/.pyenv"
+        PYENV_ROOT="$HOME/.pyenv"
+        PYENV_BIN="$PYENV_ROOT/bin"
+        PYENV_SHIMS="$PYENV_ROOT/shims"
+        echo "$PYENV_BIN" >> $GITHUB_PATH
+        echo "$PYENV_SHIMS" >> $GITHUB_PATH
+        echo "PYENV_ROOT=$PYENV_ROOT" >> $GITHUB_ENV
+
+    - name: Set up LLVM
+      run: |
+        brew install llvm@19
+        LLVM_PREFIX=$(brew --prefix llvm@19)
+        echo CC="$LLVM_PREFIX/bin/clang" >> $GITHUB_ENV
+        echo CXX="$LLVM_PREFIX/bin/clang++" >> $GITHUB_ENV
+        echo LDFLAGS="-L$LLVM_PREFIX/lib" >> $GITHUB_ENV
+        echo CPPFLAGS="-I$LLVM_PREFIX/include" >> $GITHUB_ENV
+
+    - name: Build Python with AddressSanitizer
+      run: |
+        CONFIGURE_OPTS="--with-address-sanitizer" pyenv install 3.14t
+        pyenv global 3.14t
+
+    - name: Install NumPy dependencies from PyPI
+      run: |
+        pip install meson-python ninja cython
+
+    - name: Build NumPy with ASan
+      run:
+        pip install numpy --no-binary numpy --no-build-isolation -Csetup-args="-Db_sanitize=address" -v
+
+    - name: Install SciPy dependencies from PyPI
+      run: |
+        pip install pybind11 pythran spin pooch hypothesis pytest pytest-timeout
+
+    - name: Make gfortran-13 on runner image usable
+      run: |
+        # Ensure we use gfortran-13 and that its runtime is on the library search path
+        FC=$(which gfortran-13)
+        GFORTRAN_LIB=$(dirname `$FC --print-file-name libgfortran.dylib`)
+        echo DYLD_LIBRARY_PATH=$GFORTRAN_LIB >> "$GITHUB_ENV"
+        echo FC=$FC >> "$GITHUB_ENV"
+
+    - name: Build SciPy with ASan
+      run: |
+        # Can't use Meson's `-Db_sanitize=address` because gfortran-13 will choke on it
+        export CFLAGS="-fsanitize=address -fno-omit-frame-pointer -fsanitize-ignorelist=$(pwd)/tools/asan-ignore.txt -Wno-deprecated-declarations"
+        export CXXFLAGS="-fsanitize=address -fno-omit-frame-pointer -fsanitize-ignorelist=$(pwd)/tools/asan-ignore.txt -Wno-deprecated-declarations"
+        spin build -S-Dblas=accelerate
+
+    - name: Test
+      run: |
+        # pass -s to pytest to see ASAN errors and warnings, otherwise pytest captures them
+        ASAN_OPTIONS=detect_leaks=0:symbolize=1:strict_init_order=true:allocator_may_return_null=1:use_sigaltstack=0 \
+        spin test -- -v -s --timeout=600 --durations=10 -m 'not fail_asan'

meson.build

@@ -122,6 +122,13 @@ if host_machine.system() == 'darwin'
   endif
 endif
 
+if get_option('b_sanitize') != 'none'
+  if cc.get_id() == 'clang'
+    ignore_file = meson.current_source_dir() / 'tools' / 'asan-ignore.txt'
+    add_global_arguments('-fsanitize-ignorelist=' + ignore_file, language: ['c', 'cpp'])
+  endif
+endif
+
 # Intel compilers default to fast-math, so disable it if we detect Intel
 # compilers. A word of warning: this may not work with the conda-forge
 # compilers, because those have the annoying habit of including lots of flags

pytest.ini

@@ -43,3 +43,4 @@ markers =
     parallel_threads_limit(n): run the given test function in parallel
     thread_unsafe: mark the test function as single-threaded
     iterations(n): run the given test function `n` times in each thread
+    fail_asan: mark test as triggering the address sanitizer (and not covered by the suppressions file)

scipy/signal/tests/test_bsplines.py

@@ -337,6 +337,7 @@ def test_sepfir2d_strided_2(self, xp):
 
     @skip_xp_backends(np_only=True, reason="TODO: convert this test")
     @pytest.mark.xfail(reason="XXX: flaky. pointers OOB on some platforms")
+    @pytest.mark.fail_asan
     @pytest.mark.parametrize('dtyp',
         [np.uint8, int, np.float32, float, np.complex64, complex]
     )

tools/asan-ignore.txt

@@ -0,0 +1,13 @@
+[address]
+
+# from scipy.optimize._minpack._lmdif
+fun:enorm
+
+# from scipy.interpolate._dierckx.qr_reduce_periodic
+fun:_ZN7fitpack18qr_reduce_periodic*
+
+# from scipy.ndimage._rank_filter_1d.rank_filter
+fun:_Z12_rank_filterIfEiPT_iiiS1_iS0_i
+
+# from scipy.signal._spline.sepfir2d
+fun:*_fir_mirror_symmetric*