Skip to content

Integrate Clang ThreadSanitizer in tests #1986

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
3manifold wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Integrate Clang ThreadSanitizer in tests #1986

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e8d2622
Integrate Clang ThreadSanitizer in tests
3manifold Feb 4, 2026
57c877b
Remove unnecessary debug flag from TSAN_FLAGS
3manifold Feb 5, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
53 changes: 52 additions & 1 deletion .github/workflows/ci.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -122,7 +122,58 @@ jobs:
CT2_USE_MKL: 1
run: |
ASAN_OPTIONS=detect_leaks=1:print_stats=1 tests/ctranslate2_test tests/data


build-and-test-cpp-x86_64-thread_sanitizer:
runs-on: ubuntu-22.04
env:
CT2_VERBOSE: 1

steps:
- uses: actions/checkout@v4
with:
submodules: recursive

- name: Install Intel oneAPI
run: |
wget https://apt.repos.intel.com/intel-gpg-keys/GPG-PUB-KEY-INTEL-SW-PRODUCTS.PUB
sudo apt-key add *.PUB
sudo sh -c 'echo "deb https://apt.repos.intel.com/oneapi all main" > /etc/apt/sources.list.d/oneAPI.list'
sudo apt update

- name: Install MKL
env:
CT2_USE_MKL: 1
MKL_VERSION: 2023.0.0
run: |
sudo apt install -y intel-oneapi-mkl-devel-$MKL_VERSION

- name: Install Clang
run: |
sudo apt install -y clang

- name: Configure with MKL and Clang
env:
CT2_USE_MKL: 1
run: |
cmake -DCMAKE_INSTALL_PREFIX=$PWD/install -DBUILD_TESTS=ON -DCMAKE_C_COMPILER=/usr/bin/clang -DCMAKE_CXX_COMPILER=/usr/bin/clang++ -DENABLE_THREAD_SANITIZER=ON -DCMAKE_BUILD_TYPE=Debug .

- name: Build
run: |
make -j $(nproc) install

- name: Download test data
working-directory: tests/data/models
run: |
wget https://opennmt-models.s3.amazonaws.com/pi_lm_step_5000.pt
wget https://opennmt-models.s3.amazonaws.com/transliteration-aren-all.tar.gz
tar xf transliteration-aren-all.tar.gz

- name: Test ThreadSanitizer
env:
CT2_USE_MKL: 1
run: |
TSAN_OPTIONS="ignore_noninstrumented_modules=1:halt_on_error=1" tests/ctranslate2_test tests/data
Copy link
Contributor Author

@3manifold 3manifold Feb 4, 2026 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ignore_noninstrumented_modules flag which makes ThreadSanitizer ignore all interceptors called from the given set of (non-instrumented) libraries

https://github.com/google/sanitizers/wiki/ThreadSanitizerCppManual#non-instrumented-code

This avoids false positives coming mostly from OpenMP.


build-and-test-cpp-arm64:
runs-on: ${{ matrix.os }}
env:
Expand Down
12 changes: 10 additions & 2 deletions CMakeLists.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ option(BUILD_SHARED_LIBS "Build shared libraries" ON)
option(WITH_TENSOR_PARALLEL "Compile with NCCL and MPI backend" OFF)
option(WITH_FLASH_ATTN "Compile with Flash Attention 2" OFF)
option(ENABLE_ADDRESS_SANITIZER "ASAN" OFF)
option(ENABLE_THREAD_SANITIZER "TSAN" OFF)

MESSAGE(STATUS "Compiler Id: ${CMAKE_CXX_COMPILER_ID}")
MESSAGE(STATUS "Compiler Version: ${CMAKE_CXX_COMPILER_VERSION}")
Expand Down Expand Up @@ -481,13 +482,20 @@ if (WITH_RUY)
list(APPEND LIBRARIES ruy)
endif()

# sanitizers
IF (ENABLE_ADDRESS_SANITIZER AND (CMAKE_BUILD_TYPE STREQUAL "Debug" OR CMAKE_BUILD_TYPE STREQUAL "DEBUG"))
MESSAGE (STATUS "ENABLE_ADDRESS_SANITIZER: ENABLED")
MESSAGE (STATUS "ENABLE_ADDRESS_SANITIZER: TRUE")
set(ASAN_FLAGS " -fsanitize=address -fno-omit-frame-pointer -fno-optimize-sibling-calls -fno-common")
string(APPEND CMAKE_C_FLAGS ${ASAN_FLAGS})
string(APPEND CMAKE_CXX_FLAGS ${ASAN_FLAGS})
add_link_options(-fsanitize=address)
ELSEIF (ENABLE_ADDRESS_SANITIZER)
ELSEIF (ENABLE_THREAD_SANITIZER AND (CMAKE_BUILD_TYPE STREQUAL "Debug" OR CMAKE_BUILD_TYPE STREQUAL "DEBUG"))
MESSAGE (STATUS "ENABLE_THREAD_SANITIZER: TRUE")
set(TSAN_FLAGS " -fsanitize=thread")
string(APPEND CMAKE_C_FLAGS ${TSAN_FLAGS})
string(APPEND CMAKE_CXX_FLAGS ${TSAN_FLAGS})
add_link_options(-fsanitize=thread)
ELSEIF (ENABLE_ADDRESS_SANITIZER OR ENABLE_THREAD_SANITIZER)
MESSAGE(FATAL_ERROR "SANITIZER requires Debug build type")
ENDIF ()

Expand Down