pass asan (#26)

Author: jeffreyqdd

README.md

@@ -8,16 +8,17 @@ Optimized as an execution engine for Machine Learning pipelines.
 
 ## Table of Contents
 
-- [Features](#features)  
-- [Requirements](#requirements)  
-- [Installation](#installation)  
-<!-- - [Quick Start](#quick-start)  
-- [API Reference](#api-reference)  
-  - [PyManager](#pyschedulerpymanager)  
-  - [InvokeHandler](#pyschedulerpymanagerinvokehandler)  
-- [Examples](#examples)  
-- [Configuration](#configuration)  
-- [Contributing](#contributing)  
+- [Features](#features)
+- [Requirements](#requirements)
+- [Installation](#installation)
+- [Testing with AddressSanitizer](#testing-with-addresssanitizer)
+<!-- - [Quick Start](#quick-start)
+- [API Reference](#api-reference)
+  - [PyManager](#pyschedulerpymanager)
+  - [InvokeHandler](#pyschedulerpymanagerinvokehandler)
+- [Examples](#examples)
+- [Configuration](#configuration)
+- [Contributing](#contributing)
 - [License](#license)   -->
 
 ## Features
@@ -204,3 +205,25 @@ for (int i = 0; i < 1000; i++)
 for (auto& f : rank_futures)
     std::cout << f.get() << "\n";
 ```
+
+## Testing with AddressSanitizer
+
+Build the tests with ASan enabled:
+
+```bash
+./configure.sh --tests --asan --build
+```
+
+This adds `-fsanitize=address -fno-omit-frame-pointer -g` to the compile and link flags.
+
+### LSAN suppressions
+
+CPython's embedded interpreter and extension modules (e.g. numpy) intentionally leak interned strings, type caches, and method tables at shutdown. These are not bugs in pyscheduler but will be reported by LeakSanitizer. A suppressions file (`lsan_supressions.txt`) in the project root filters them out.
+
+The build system automatically symlinks this file into the test binary directory. To use it:
+
+```bash
+LSAN_OPTIONS=suppressions=lsan_suppressions.txt PYTHONMALLOC=malloc ./build/debug/tests/pyscheduler_tests
+```
+
+`PYTHONMALLOC=malloc` is required so that Python's allocations go through the system malloc, which ASan can track. Without it, CPython uses its own arena allocator and ASan cannot see individual allocations.

configure.sh

@@ -24,7 +24,7 @@ to_preset(){ case "$1" in Debug) echo debug;; Release) echo release;; RelWithDeb
 
 command -v cmake >/dev/null 2>&1 || die "cmake not found in PATH"
 
-PRESET="debug" BUILD_EXAMPLES=OFF BUILD_TESTS=OFF
+MODE="debug" BUILD_EXAMPLES=OFF BUILD_TESTS=OFF
 ENABLE_ASAN=OFF ENABLE_TSAN=OFF ENABLE_FP=OFF
 RUN_BUILD=OFF RUN_INSTALL=OFF JOBS=""
 PYTHON_UDL_INTERFACE_PREFIX="${PYTHON_UDL_INTERFACE_PREFIX:-/usr/local}"

lsan_supressions.txt

@@ -0,0 +1,4 @@
+leak:PyUnicode_New
+leak:PyObject_Malloc
+leak:PyFloat_FromDouble
+leak:PyArrayMethod_FromSpec_int

tests/CMakeLists.txt

@@ -8,6 +8,16 @@ if(TEST_SOURCES)
 		Catch2::Catch2WithMain
 	)
 
+	# Symlink LSAN suppressions file into test binary directory
+	set(_lsan_src "${CMAKE_SOURCE_DIR}/lsan_supressions.txt")
+	set(_lsan_dst "$<TARGET_FILE_DIR:pyscheduler_tests>/lsan_suppressions.txt")
+	if(EXISTS "${_lsan_src}")
+		add_custom_command(TARGET pyscheduler_tests POST_BUILD
+			COMMAND ${CMAKE_COMMAND} -E create_symlink "${_lsan_src}" "${_lsan_dst}"
+			COMMENT "Symlinking lsan_suppressions.txt into test directory"
+		)
+	endif()
+
 	include(CTest)
 	include(Catch)
 	catch_discover_tests(pyscheduler_tests)