Automatic thread sanitizer tests.

Add container file for tsan tests.
Tsan annotations of custom mutex.
Separate header with tsan-related definitions.
Option to exclude specific drivers and tests.

Merge branch 'feature/threadSanitizer' into develop

Author: jblueh

.gitlab-ci.yml

@@ -81,3 +81,16 @@ address-sanitizer:
     - export CXXFLAGS="-g -fsanitize=address -fno-omit-frame-pointer"
     - export OMP_NUM_THREADS=$(expr $(nproc --all) / 2)
     - make all
+
+thread-sanitizer:
+  image: $CI_REGISTRY/$CI_PROJECT_NAMESPACE/opdilib/opdi-tsan
+  script:
+    - git clone --depth 1 --branch develop https://github.com/SciCompKL/CoDiPack.git
+    - export CODI_DIR=$(pwd)/CoDiPack/include
+    - export OPDI_DIR=$(pwd)/include
+    - cd tests
+    - export CXX=g++
+    - export CXXFLAGS="$CXXFLAGS -g"
+    - export EXCLUDE_TESTS="CriticalLock CriticalName CriticalNameHint ParallelNested PreaccumulationLocal SectionsNowait"
+    - export OMP_NUM_THREADS=$(expr $(nproc --all) / 2)
+    - make all

containers/Dockerfile.opdi.tsan

@@ -0,0 +1,25 @@
+FROM ubuntu:24.04
+
+RUN DEBIAN_FRONTEND=noninteractive apt update && apt install -y build-essential binutils git curl flex
+
+RUN \
+  cd / \
+  && git clone --depth 1 --branch releases/gcc-15.2.0 git://gcc.gnu.org/git/gcc.git gcc_sources \
+  && cd gcc_sources \
+  && ./contrib/download_prerequisites \
+  && cd / \
+  && mkdir gcc_objdir \
+  && cd gcc_objdir \
+  && /gcc_sources/configure --prefix=/gcc_install --enable-languages=c,c++ --disable-linux-futex --disable-multilib \
+  && make -j $(nproc --all) \
+  && make install \
+  && cd / \
+  && rm -rf gcc_sources \
+  && rm -rf gcc_objdir
+
+ENV LD_LIBRARY_PATH=/gcc_install/lib64:$LD_LIBRARY_PATH
+ENV CXXFLAGS="-I/gcc_install/include/c++/15.2.0 -I/gcc_install/include/c++/15.2.0/x86_64-pc-linux-gnu -fsanitize=thread"
+ENV CFLAGS="-I/gcc_install/include/c++/15.2.0 -I/gcc_install/include/c++/15.2.0/x86_64-pc-linux-gnu -fsanitize=thread"
+ENV LDFLAGS="-L/gcc_install/lib64 -fsanitize=thread"
+ENV PATH=/gcc_install/bin:$PATH
+ENV TSAN_OPTIONS="history_size=7 halt_on_error=1"

include/opdi/helpers/tsanDefinitions.hpp

@@ -0,0 +1,38 @@
+/*
+ * OpDiLib, an Open Multiprocessing Differentiation Library
+ *
+ * Copyright (C) 2020-2022 Chair for Scientific Computing (SciComp), TU Kaiserslautern
+ * Copyright (C) 2023-2025 Chair for Scientific Computing (SciComp), University of Kaiserslautern-Landau
+ * Homepage: https://scicomp.rptu.de
+ * Contact:  Prof. Nicolas R. Gauger (opdi@scicomp.uni-kl.de)
+ *
+ * Lead developer: Johannes Blühdorn (SciComp, University of Kaiserslautern-Landau)
+ *
+ * This file is part of OpDiLib (https://scicomp.rptu.de/software/opdi).
+ *
+ * OpDiLib is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later
+ * version.
+ *
+ * OpDiLib is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied
+ * warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
+ * details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License along with OpDiLib. If not, see
+ * <http://www.gnu.org/licenses/>.
+ *
+ */
+
+#pragma once
+
+#ifdef __SANITIZE_THREAD__
+  #define ANNOTATE_RWLOCK_CREATE(lock) AnnotateRWLockCreate(__FILE__, __LINE__, (void*)lock)
+  #define ANNOTATE_RWLOCK_DESTROY(lock) AnnotateRWLockDestroy(__FILE__, __LINE__, (void*)lock)
+  #define ANNOTATE_RWLOCK_ACQUIRED(lock, isWrite) AnnotateRWLockAcquired(__FILE__, __LINE__, (void*)lock, isWrite)
+  #define ANNOTATE_RWLOCK_RELEASED(lock, isWrite) AnnotateRWLockReleased(__FILE__, __LINE__, (void*)lock, isWrite)
+
+  extern "C" void AnnotateRWLockCreate(const char* f, int l, void* addr);
+  extern "C" void AnnotateRWLockDestroy(const char* f, int l, void* addr);
+  extern "C" void AnnotateRWLockAcquired(const char* f, int l, void* addr, size_t isWrite);
+  extern "C" void AnnotateRWLockReleased(const char* f, int l, void* addr, size_t isWrite);
+#endif

include/opdi/logic/omp/mutexOmpLogic.cpp

@@ -25,8 +25,9 @@
 
 #include <cassert>
 
-#include "../../helpers/macros.hpp"
 #include "../../helpers/exceptions.hpp"
+#include "../../helpers/macros.hpp"
+#include "../../helpers/tsanDefinitions.hpp"
 #include "../../config.hpp"
 #include "../../tool/toolInterface.hpp"
 

tests/Makefile

@@ -71,13 +71,16 @@ else
   FLAGS += -DOPDI_USE_OMPT_BACKEND
 endif
 
+EXCLUDE_TESTS ?=
+EXCLUDE_DRIVERS ?=
+
 # list all test files and extract test names
 TEST_FILES = $(wildcard $(TEST_DIR)/Test**.hpp)
-TESTS ?= $(patsubst $(TEST_DIR)/Test%.hpp,%,$(TEST_FILES))
+TESTS ?= $(filter-out $(EXCLUDE_TESTS), $(patsubst $(TEST_DIR)/Test%.hpp,%,$(TEST_FILES)))
 
 # list all driver files and extract driver names
 DRIVER_FILES = $(wildcard $(DRIVER_DIR)/Driver**.hpp)
-DRIVERS ?= $(patsubst $(DRIVER_DIR)/Driver%.hpp,%,$(DRIVER_FILES))
+DRIVERS ?= $(filter-out $(EXCLUDE_DRIVERS), $(patsubst $(DRIVER_DIR)/Driver%.hpp,%,$(DRIVER_FILES)))
 
 # exclude specific tests on a per-driver basis
 DRIVERS_USING_ALL_TESTS = $(filter-out FirstOrderReverseNoParallel FirstOrderForward Primal, $(DRIVERS))
@@ -115,7 +118,8 @@ all:
 prepareGenerate:
 	@ mkdir -p build; \
 	rm -r -f tempmakefile; \
-	printf "# auto generated by OpDiLib\n" >> tempmakefile;
+	printf "# auto generated by OpDiLib\n" >> tempmakefile; \
+	$(CXX) --version;
 
 # process each driver with its associated tests
 $(DRIVERS):

tests/tests/TestCustomMutex.hpp

@@ -25,6 +25,8 @@
 
 #pragma once
 
+#include "opdi/helpers/tsanDefinitions.hpp"
+
 #include "testBase.hpp"
 
 template<typename _Case>
@@ -37,8 +39,27 @@ struct TestCustomMutex : public TestBase<4, 1, 3, TestCustomMutex<_Case>> {
       private:
         int status;
 
+        #ifdef __SANITIZE_THREAD__
+          int dummy;
+        #endif
+
       public:
-        CustomMutex() : status(0) {}
+        CustomMutex() : status(0)
+          #ifdef __SANITIZE_THREAD__
+                      , dummy(0)
+          #endif
+        {
+
+          #ifdef __SANITIZE_THREAD__
+            ANNOTATE_RWLOCK_CREATE(&dummy);
+          #endif
+        }
+
+        ~CustomMutex() {
+          #ifdef __SANITIZE_THREAD__
+            ANNOTATE_RWLOCK_DESTROY(&dummy);
+          #endif
+        }
 
         void lock() {
           int localStatus;
@@ -69,16 +90,26 @@ struct TestCustomMutex : public TestBase<4, 1, 3, TestCustomMutex<_Case>> {
             #endif
             --status;
           }
+
+          #ifdef __SANITIZE_THREAD__
+            ANNOTATE_RWLOCK_ACQUIRED(&dummy, true);
+          #endif
+
           #ifdef _OPENMP
             opdi::logic->onMutexAcquired(opdi::LogicInterface::MutexKind::Custom, reinterpret_cast<opdi::LogicInterface::WaitId>(&status));
           #endif
         }
 
         void unlock() {
+          #ifdef __SANITIZE_THREAD__
+            ANNOTATE_RWLOCK_RELEASED(&dummy, true);
+          #endif
+
           #ifdef _OPENMP
             #pragma omp atomic update
           #endif
           --status;
+
           #ifdef _OPENMP
             opdi::logic->onMutexReleased(opdi::LogicInterface::MutexKind::Custom, reinterpret_cast<opdi::LogicInterface::WaitId>(&status));
           #endif

tests/tests/TestTaskReset.hpp

@@ -105,7 +105,7 @@ struct TestTaskReset : public TestBase<4, 1, 3, TestTaskReset<_Case>> {
         assertAdjointAccessMode(opdi::LogicInterface::AdjointAccessMode::Atomic);
 
         // remove the inner parallel region by positional reset
-        T::getTape().resetTo(position);
+        T::getTape().resetTo(position, false);
 
         #if _OPENMP
           opdi::logic->resetImplicitTask(&position, mode);