TSAN triggers false positives because TSAN does not mark EOWNERDEAD returning timed_lock as locked. Annotations can't help here, so a try-based alternative is tested when TSAN is active

Author: igaztanaga

.github/workflows/ci.yml

@@ -699,7 +699,8 @@ jobs:
             #TSAN options
             if [ -n "${{matrix.tsan}}" ]
             then
-                export TSAN_OPTIONS="verbosity=1:print_stacktrace=1"
+                #print_stacktrace is not a ThreadSanitizer option
+                export TSAN_OPTIONS="verbosity=1"
                 B2_ARGS+=("thread-sanitizer=norecover" "define=TSAN=1")
             fi
             #Common UBSAN / ASAN / TSAN options
@@ -939,7 +940,8 @@ jobs:
             #TSAN options
             if [ -n "${{matrix.tsan}}" ]
             then
-                export TSAN_OPTIONS="verbosity=1:print_stacktrace=1"
+                #print_stacktrace is not a ThreadSanitizer option
+                export TSAN_OPTIONS="verbosity=1"
                 B2_ARGS+=("thread-sanitizer=norecover" "define=TSAN=1")
             fi
             #Common UBSAN / ASAN / TSAN options
@@ -1136,7 +1138,8 @@ jobs:
             #TSAN options
             if [ -n "${{matrix.tsan}}" ]
             then
-                export TSAN_OPTIONS="verbosity=1:print_stacktrace=1"
+                #print_stacktrace is not a ThreadSanitizer option
+                export TSAN_OPTIONS="verbosity=1"
                 B2_ARGS+=("thread-sanitizer=norecover" "define=TSAN=1")
             fi
             #Common UBSAN / ASAN / TSAN options

include/boost/interprocess/detail/workaround.hpp

@@ -188,6 +188,33 @@
 #  define BOOST_INTERPROCESS_MAPPED_FILES
 #endif
 
+//////////////////////////////////////////////////////
+//    BOOST_INTERPROCESS_THREAD_SANITIZER
+//////////////////////////////////////////////////////
+#if defined(__has_feature)
+   #if __has_feature(thread_sanitizer)
+      #define BOOST_INTERPROCESS_THREAD_SANITIZER
+   #endif
+#endif
+#if !defined(BOOST_INTERPROCESS_THREAD_SANITIZER) && defined(__SANITIZE_THREAD__)
+   #define BOOST_INTERPROCESS_THREAD_SANITIZER
+#endif
+
+//////////////////////////////////////////////////////
+//    BOOST_INTERPROCESS_TSAN_ROBUST_TIMEDLOCK_WORKAROUND
+//////////////////////////////////////////////////////
+//ThreadSanitizer's pthread_mutex_lock and pthread_mutex_trylock interceptors
+//know that an EOWNERDEAD return from a robust mutex means the mutex *was*
+//acquired, but its pthread_mutex_timedlock interceptor does not. The mutex is
+//not registered as owned by the caller and the mandatory unlock that marks it
+//as unrecoverable is then reported as "unlock of an unlocked mutex". Emulate
+//the timed lock with try_lock while that limitation lasts.
+#if defined(BOOST_INTERPROCESS_THREAD_SANITIZER)
+   #if defined(BOOST_INTERPROCESS_POSIX_TIMEOUTS) && defined(BOOST_INTERPROCESS_POSIX_ROBUST_MUTEXES)
+      #define BOOST_INTERPROCESS_TSAN_ROBUST_TIMEDLOCK_WORKAROUND
+   #endif
+#endif
+
 //Now declare some Boost.Interprocess features depending on the implementation
 #if defined(BOOST_INTERPROCESS_POSIX_NAMED_SEMAPHORES) && !defined(BOOST_INTERPROCESS_POSIX_SEMAPHORES_NO_UNLINK)
    #define BOOST_INTERPROCESS_NAMED_MUTEX_USES_POSIX_SEMAPHORES

include/boost/interprocess/sync/posix/mutex.hpp

@@ -47,7 +47,7 @@
 #include <boost/interprocess/timed_utils.hpp>
 
 
-#ifndef BOOST_INTERPROCESS_POSIX_TIMEOUTS
+#if !defined(BOOST_INTERPROCESS_POSIX_TIMEOUTS) || defined(BOOST_INTERPROCESS_TSAN_ROBUST_TIMEDLOCK_WORKAROUND)
 #  include <boost/interprocess/detail/os_thread_functions.hpp>
 #  include <boost/interprocess/sync/detail/common_algorithms.hpp>
 #endif
@@ -141,7 +141,7 @@ inline bool posix_mutex::try_lock()
 template<class TimePoint>
 inline bool posix_mutex::timed_lock(const TimePoint &abs_time)
 {
-   #ifdef BOOST_INTERPROCESS_POSIX_TIMEOUTS
+   #if defined(BOOST_INTERPROCESS_POSIX_TIMEOUTS) && !defined(BOOST_INTERPROCESS_TSAN_ROBUST_TIMEDLOCK_WORKAROUND)
    //Posix does not support infinity absolute time so handle it here
    if(ipcdetail::is_pos_infinity(abs_time)){
       this->lock();

include/boost/interprocess/sync/posix/recursive_mutex.hpp

@@ -44,7 +44,7 @@
 #include <boost/interprocess/sync/posix/timepoint_to_timespec.hpp>
 #include <boost/interprocess/timed_utils.hpp>
 #include <boost/interprocess/exceptions.hpp>
-#ifndef BOOST_INTERPROCESS_POSIX_TIMEOUTS
+#if !defined(BOOST_INTERPROCESS_POSIX_TIMEOUTS) || defined(BOOST_INTERPROCESS_TSAN_ROBUST_TIMEDLOCK_WORKAROUND)
 #  include <boost/interprocess/detail/os_thread_functions.hpp>
 #  include <boost/interprocess/sync/detail/common_algorithms.hpp>
 #endif
@@ -127,7 +127,7 @@ inline bool posix_recursive_mutex::try_lock()
 template<class TimePoint>
 inline bool posix_recursive_mutex::timed_lock(const TimePoint &abs_time)
 {
-   #ifdef BOOST_INTERPROCESS_POSIX_TIMEOUTS
+   #if defined(BOOST_INTERPROCESS_POSIX_TIMEOUTS) && !defined(BOOST_INTERPROCESS_TSAN_ROBUST_TIMEDLOCK_WORKAROUND)
    //Posix does not support infinity absolute time so handle it here
    if(ipcdetail::is_pos_infinity(abs_time)){
       this->lock();