build: add thread sanitizer

We have a cmake option to build Tntcxx with sanitizers. Currently, only
memory and UB sanitizers are used - let's populate the list with thread
sanitizer since we have a test for a multithreaded scenario.

Author: drewdzzz

.github/actions/build-tntcxx/action.yml

@@ -4,8 +4,11 @@ inputs:
   build-type:
     description: 'Corresponds to CMAKE_BUILD_TYPE variable of CMake'
     required: true
-  enable-sanitizers:
-    description: 'Corresponds to TNTCXX_ENABLE_SANITIZERS option of CMake'
+  enable-address-sanitizers:
+    description: 'Corresponds to TNTCXX_ENABLE_ADDRESS_SANITIZERS option of CMake'
+    default: 'false'
+  enable-thread-sanitizers:
+    description: 'Corresponds to TNTCXX_ENABLE_THREAD_SANITIZERS option of CMake'
     default: 'false'
   cxx-standard:
     description: 'Corresponds to CMAKE_CXX_STANDARD option of CMake'
@@ -26,7 +29,8 @@ runs:
         -DTNTCXX_BUILD_TESTING=ON \
         -DTNTCXX_ENABLE_SSL=ON \
         -DCMAKE_BUILD_TYPE=${{ inputs.build-type }} \
-        -DTNTCXX_ENABLE_SANITIZERS=${{ inputs.enable-sanitizers }} \
+        -DTNTCXX_ENABLE_ADDRESS_SANITIZERS=${{ inputs.enable-address-sanitizers }} \
+        -DTNTCXX_ENABLE_THREAD_SANITIZERS=${{ inputs.enable-thread-sanitizers }} \
         -DCMAKE_CXX_STANDARD=${{ inputs.cxx-standard }} \
         -DCMAKE_C_COMPILER=${{ inputs.c-compiler }} \
         -DCMAKE_CXX_COMPILER=${{ inputs.cxx-compiler }} \

.github/workflows/reusable-testing.yml

@@ -21,7 +21,10 @@ on:
       use-valgrind:
         default: false
         type: boolean
-      enable-sanitizers:
+      enable-address-sanitizers:
+        default: false
+        type: boolean
+      enable-thread-sanitizers:
         default: false
         type: boolean
       build-only:
@@ -49,7 +52,8 @@ jobs:
         uses: ./.github/actions/build-tntcxx
         with:
           build-type: ${{ inputs.build-type }}
-          enable-sanitizers: ${{ inputs.enable-sanitizers }}
+          enable-address-sanitizers: ${{ inputs.enable-address-sanitizers }}
+          enable-thread-sanitizers: ${{ inputs.enable-thread-sanitizers }}
           cxx-standard: ${{ inputs.cxx-standard }}
           c-compiler: ${{ inputs.c-compiler }}
           cxx-compiler: ${{ inputs.cxx-compiler }}

.github/workflows/testing.yml

@@ -82,7 +82,7 @@ jobs:
       build-type: ${{ matrix.build-type }}
       use-valgrind: true
 
-  sanitizers:
+  address-sanitizers:
     uses: ./.github/workflows/reusable-testing.yml
     strategy:
       fail-fast: false
@@ -100,10 +100,36 @@ jobs:
         exclude:
           - runs-on: macos-14
             compiler: {c: gcc, cxx: g++}
-    name: sanitizers (${{ matrix.runs-on }}, ${{ matrix.build-type }}, ${{ matrix.compiler.c }})
+    name: address sanitizers (${{ matrix.runs-on }}, ${{ matrix.build-type }}, ${{ matrix.compiler.c }})
     with:
       runs-on: ${{ matrix.runs-on }}
       build-type: ${{ matrix.build-type }}
       c-compiler: ${{ matrix.compiler.c }}
       cxx-compiler: ${{ matrix.compiler.cxx }}
-      enable-sanitizers: true
+      enable-address-sanitizers: true
+
+  thread-sanitizers:
+    uses: ./.github/workflows/reusable-testing.yml
+    strategy:
+      fail-fast: false
+      matrix:
+        runs-on:
+          - ubuntu-22.04
+          - macos-14
+        build-type:
+          - Debug
+          - RelWithDebInfo
+        compiler:
+          - {c: gcc, cxx: g++}
+          - {c: clang, cxx: clang++}
+        # gcc on macos is just an alias for clang
+        exclude:
+          - runs-on: macos-14
+            compiler: {c: gcc, cxx: g++}
+    name: thread sanitizers (${{ matrix.runs-on }}, ${{ matrix.build-type }}, ${{ matrix.compiler.c }})
+    with:
+      runs-on: ${{ matrix.runs-on }}
+      build-type: ${{ matrix.build-type }}
+      c-compiler: ${{ matrix.compiler.c }}
+      cxx-compiler: ${{ matrix.compiler.cxx }}
+      enable-thread-sanitizers: true

CMakeLists.txt

@@ -91,10 +91,12 @@ IF (TNTCXX_BUILD_TESTING)
 ENDIF()
 
 OPTION(TNTCXX_ENABLE_SANITIZERS
-    "If ON, tntcxx will be instrumented with sanitizers."
+    "If passed, tntcxx will be instrumented with sanitizers. Possible values: \"NONE\", \"ADDRESS\", \"THREAD\""
     OFF)
 
-IF (TNTCXX_ENABLE_SANITIZERS)
+IF (NOT TNTCXX_ENABLE_SANITIZERS)
+    # Santiizers are disabled - do nothing.
+ELSEIF (TNTCXX_ENABLE_SANITIZERS STREQUAL "ARRDESS")
     SET(SANITIZER_FLAGS "-fsanitize=address")
     # FIXME(gh-62)
     IF (NOT CMAKE_CXX_COMPILER_ID STREQUAL "AppleClang")
@@ -114,6 +116,12 @@ IF (TNTCXX_ENABLE_SANITIZERS)
     # for details).
     ADD_COMPILE_OPTIONS(${SANITIZER_FLAGS})
     ADD_LINK_OPTIONS(${SANITIZER_FLAGS})
+ELSEIF (TNTCXX_ENABLE_SANITIZERS STREQUAL "THREAD")
+    SET(SANITIZER_FLAGS "-fsanitize=thread")
+    ADD_COMPILE_OPTIONS(${SANITIZER_FLAGS})
+    ADD_LINK_OPTIONS(${SANITIZER_FLAGS})
+ELSE ()
+    MESSAGE(FATAL_ERROR "Unknown TNTCXX_ENABLED_SANITIZERS value")
 ENDIF()
 
 # Common function for building tests.