Cleanup unused bits and pieces, add ASAN and TSAN. (Geenz#11)

* Remove Tracy profiler and ServiceLocator integration

* Add sanitizer options and improve graph thread safety

Introduces ENABLE_SANITIZERS and ENABLE_TSAN options in CMake for easier debugging with sanitizers. NodeScheduler now takes a graph mutex and uses shared locking for safe DAG access. TimerService::stop() now exits early if the contract group is destroyed, improving robustness.

* Refactor singleton implementations for thread safety

* Fix advisory lock acquisition in submitSerialized

Caught by TSAN in CI

* Refactor WorkContractGroup ownership in TimerService

Changed _workContractGroup from std::unique_ptr to raw pointer with manual reference counting. This allows WorkService to manage shared ownership and ensures proper cleanup when all references are released.

* Improve WorkContractGroup removal safety

The removal process now stops the group before acquiring the mutex, waits for in-flight executions to finish after removal, and ensures concurrency provider is cleared inside the lock. This prevents new work selection and ensures no worker is using the group before releasing its reference.

* Refactor work group selection logic in WorkService

Simplifies the worker loop by removing the intermediate snapshot of work groups and directly using a shared lock for concurrent access. The scheduling and execution flow is streamlined, improving efficiency and reducing redundant checks for stopped groups. Soft failure handling and sleep logic are also clarified for better maintainability.

* Shorten the condition variable's timeouts.

* Refactor submitSerialized for clearer locking logic

Simplifies and clarifies the locking and fallback logic in submitSerialized. The new implementation separates backend scope acquisition, error handling, and VFS advisory locking, improving readability and maintainability.

* Refactor VFS advisory lock acquisition logic

Replaces std::unique_lock with direct use of try_lock_for on the shared timed_mutex and introduces a custom RAII guard to ensure proper unlocking. This simplifies lock management and clarifies the advisory lock's usage in submitSerialized.

* One more crack at this before I move to Linux proper to more directly debug.

* Another TSAN + ASAN pass on Linux with varying settings.

* Make TSAN and ASAN + UBSAN steps non-blocking on failure, log issues instead.

* Roll back to GCC-14

* More ASAN and TSAN changes.

* Update VirtualFileSystem.cpp

Author: Geenz

.github/workflows/ci.yml

@@ -67,7 +67,7 @@ jobs:
           path: EntropyCore-Windows-x64/**
 
   build-and-test-linux:
-    name: Build and test (Linux, GCC)
+    name: Build and test (Linux, GCC 14)
     runs-on: ubuntu-24.04
     steps:
       - name: Checkout
@@ -76,7 +76,13 @@ jobs:
       - name: Install prerequisites
         run: |
           sudo apt-get update
-          sudo apt-get install -y ninja-build g++ cmake
+          sudo apt-get install -y ninja-build gcc-14 g++-14 cmake
+          sudo update-alternatives --install /usr/bin/gcc gcc /usr/bin/gcc-14 100
+          sudo update-alternatives --install /usr/bin/g++ g++ /usr/bin/g++-14 100
+          sudo update-alternatives --install /usr/bin/cc cc /usr/bin/gcc-14 100
+          sudo update-alternatives --install /usr/bin/c++ c++ /usr/bin/g++-14 100
+          gcc --version
+          g++ --version
 
       - name: Setup vcpkg
         uses: lukka/run-vcpkg@v11
@@ -270,3 +276,141 @@ jobs:
         with:
           name: EntropyCore-macOS-universal
           path: EntropyCore-macOS-universal/**
+
+  sanitizer-asan-ubsan:
+    name: Sanitizer Tests (ASAN + UBSAN, GCC 14)
+    runs-on: ubuntu-24.04
+    continue-on-error: true  # Don't fail CI, but report issues
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Install prerequisites
+        run: |
+          sudo apt-get update
+          sudo apt-get install -y ninja-build gcc-14 g++-14 cmake
+          sudo update-alternatives --install /usr/bin/gcc gcc /usr/bin/gcc-14 100
+          sudo update-alternatives --install /usr/bin/g++ g++ /usr/bin/g++-14 100
+          sudo update-alternatives --install /usr/bin/cc cc /usr/bin/gcc-14 100
+          sudo update-alternatives --install /usr/bin/c++ c++ /usr/bin/g++-14 100
+          gcc --version
+          g++ --version
+
+      - name: Setup vcpkg
+        uses: lukka/run-vcpkg@v11
+        with:
+          vcpkgGitCommitId: 'c59b04f668d20c7dd83f478835e8266a3cc51270'
+
+      - name: Configure CMake with ASAN/UBSAN
+        run: >
+          cmake -S . -B build-asan -G Ninja
+          -DCMAKE_BUILD_TYPE=Debug
+          -DENTROPY_ENABLE_TESTS=ON
+          -DENABLE_SANITIZERS=ON
+          -DCMAKE_TOOLCHAIN_FILE=${{ github.workspace }}/vcpkg/scripts/buildsystems/vcpkg.cmake
+
+      - name: Build tests with ASAN/UBSAN
+        run: cmake --build build-asan --target EntropyCoreTests
+
+      - name: Run tests with ASAN/UBSAN
+        working-directory: build-asan
+        run: ./EntropyCoreTests --gtest_brief=1 2>&1 | tee asan-ubsan-output.log
+        continue-on-error: true  # Capture failures but don't stop
+        env:
+          ASAN_OPTIONS: detect_leaks=1:check_initialization_order=1:detect_stack_use_after_return=1:strict_string_checks=1:detect_invalid_pointer_pairs=2:halt_on_error=1:abort_on_error=1
+          UBSAN_OPTIONS: halt_on_error=1:abort_on_error=1:print_stacktrace=1
+
+      - name: Check for ASAN/UBSAN issues
+        if: always()
+        working-directory: build-asan
+        run: |
+          echo "## ASAN/UBSAN Results" >> $GITHUB_STEP_SUMMARY
+          if grep -q "SUMMARY.*Sanitizer" asan-ubsan-output.log 2>/dev/null; then
+            echo "⚠️ **Issues detected!**" >> $GITHUB_STEP_SUMMARY
+            echo "" >> $GITHUB_STEP_SUMMARY
+            echo "\`\`\`" >> $GITHUB_STEP_SUMMARY
+            grep -A 5 "SUMMARY.*Sanitizer" asan-ubsan-output.log | head -20 >> $GITHUB_STEP_SUMMARY
+            echo "\`\`\`" >> $GITHUB_STEP_SUMMARY
+            echo "" >> $GITHUB_STEP_SUMMARY
+            echo "📋 See full logs in artifacts: \`sanitizer-asan-ubsan-results\`" >> $GITHUB_STEP_SUMMARY
+          else
+            echo "✅ **No issues detected**" >> $GITHUB_STEP_SUMMARY
+          fi
+
+      - name: Upload ASAN/UBSAN results
+        if: always()  # Always upload, even on success
+        uses: actions/upload-artifact@v4
+        with:
+          name: sanitizer-asan-ubsan-results
+          path: |
+            build-asan/asan-ubsan-output.log
+            build-asan/**/*.log
+
+  sanitizer-tsan:
+    name: Sanitizer Tests (TSAN, GCC 14)
+    runs-on: ubuntu-24.04
+    continue-on-error: true  # Don't fail CI, but report issues
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Install prerequisites
+        run: |
+          sudo apt-get update
+          sudo apt-get install -y ninja-build gcc-14 g++-14 cmake
+          sudo update-alternatives --install /usr/bin/gcc gcc /usr/bin/gcc-14 100
+          sudo update-alternatives --install /usr/bin/g++ g++ /usr/bin/g++-14 100
+          sudo update-alternatives --install /usr/bin/cc cc /usr/bin/gcc-14 100
+          sudo update-alternatives --install /usr/bin/c++ c++ /usr/bin/g++-14 100
+          gcc --version
+          g++ --version
+
+      - name: Setup vcpkg
+        uses: lukka/run-vcpkg@v11
+        with:
+          vcpkgGitCommitId: 'c59b04f668d20c7dd83f478835e8266a3cc51270'
+
+      - name: Configure CMake with TSAN
+        run: >
+          cmake -S . -B build-tsan -G Ninja
+          -DCMAKE_BUILD_TYPE=Debug
+          -DENTROPY_ENABLE_TESTS=ON
+          -DENABLE_SANITIZERS=ON
+          -DENABLE_TSAN=ON
+          -DCMAKE_TOOLCHAIN_FILE=${{ github.workspace }}/vcpkg/scripts/buildsystems/vcpkg.cmake
+
+      - name: Build tests with TSAN
+        run: cmake --build build-tsan --target EntropyCoreTests
+
+      - name: Run tests with TSAN
+        working-directory: build-tsan
+        run: ./EntropyCoreTests --gtest_brief=1 2>&1 | tee tsan-output.log
+        continue-on-error: true  # Capture failures but don't stop
+        env:
+          TSAN_OPTIONS: detect_deadlocks=1:second_deadlock_stack=1:history_size=7:io_sync=1:halt_on_error=1:abort_on_error=1
+
+      - name: Check for TSAN issues
+        if: always()
+        working-directory: build-tsan
+        run: |
+          echo "## TSAN Results" >> $GITHUB_STEP_SUMMARY
+          if grep -q "WARNING.*ThreadSanitizer" tsan-output.log 2>/dev/null; then
+            echo "⚠️ **Issues detected!**" >> $GITHUB_STEP_SUMMARY
+            echo "" >> $GITHUB_STEP_SUMMARY
+            echo "\`\`\`" >> $GITHUB_STEP_SUMMARY
+            grep -E "(WARNING.*ThreadSanitizer|SUMMARY.*ThreadSanitizer)" tsan-output.log | head -20 >> $GITHUB_STEP_SUMMARY
+            echo "\`\`\`" >> $GITHUB_STEP_SUMMARY
+            echo "" >> $GITHUB_STEP_SUMMARY
+            echo "📋 See full logs in artifacts: \`sanitizer-tsan-results\`" >> $GITHUB_STEP_SUMMARY
+          else
+            echo "✅ **No issues detected**" >> $GITHUB_STEP_SUMMARY
+          fi
+
+      - name: Upload TSAN results
+        if: always()  # Always upload, even on success
+        uses: actions/upload-artifact@v4
+        with:
+          name: sanitizer-tsan-results
+          path: |
+            build-tsan/tsan-output.log
+            build-tsan/**/*.log

.github/workflows/prerelease.yml

@@ -69,7 +69,6 @@ jobs:
           ### 📦 Available Builds
 
           - **Linux GCC 14**: `EntropyCore-Linux-gcc-14.tar.gz` / `.zip`
-          - **Linux Clang 18**: `EntropyCore-Linux-clang-18.tar.gz` / `.zip`
           - **macOS Universal**: `EntropyCore-macOS-universal.tar.gz` / `.zip` (Intel + Apple Silicon)
           - **Windows x64**: `EntropyCore-Windows-x64.tar.gz` / `.zip`
 

.github/workflows/release.yml

@@ -78,7 +78,6 @@ jobs:
         Download the appropriate archive for your platform:
 
         - **Linux GCC 14**: `EntropyCore-Linux-gcc-14.tar.gz` / `.zip`
-        - **Linux Clang 18**: `EntropyCore-Linux-clang-18.tar.gz` / `.zip`
         - **macOS Universal**: `EntropyCore-macOS-universal.tar.gz` / `.zip` (Intel + Apple Silicon)
         - **Windows x64**: `EntropyCore-Windows-x64.tar.gz` / `.zip`
 

CMakeLists.txt

@@ -15,6 +15,8 @@ option(ENTROPY_ENABLE_TESTS "Enable/build tests for EntropyCore" OFF)
 option(ENTROPY_BUILD_EXAMPLES "Build EntropyCore example executables" OFF)
 # Entropy does not depend on C++ RTTI. You may optionally disable RTTI for these targets if desired.
 option(ENTROPY_REQUIRE_NO_RTTI "Disable C++ RTTI for Entropy targets" OFF)
+# Enable sanitizers for debugging and testing (OFF by default - enable explicitly in CI/testing)
+option(ENABLE_SANITIZERS "Enable AddressSanitizer and UndefinedBehaviorSanitizer" OFF)
 
 # Default behavior: on single-config generators, enable tests in Debug/RelWithDebInfo
 # No build-dir heuristics; on multi-config generators we do not auto-enable by default.
@@ -31,17 +33,35 @@ set(ENTROPY_BUILD_TESTS ${ENTROPY_ENABLE_TESTS} CACHE BOOL "Build tests for Entr
 set(CMAKE_CXX_STANDARD 20)
 set(CMAKE_CXX_STANDARD_REQUIRED ON)
 set(CMAKE_CXX_EXTENSIONS OFF)
+
+# Configure sanitizers
+if(ENABLE_SANITIZERS)
+    if(CMAKE_CXX_COMPILER_ID MATCHES "Clang|GNU")
+        # ThreadSanitizer is mutually exclusive with AddressSanitizer
+        # To use TSAN instead: cmake -DENABLE_TSAN=ON
+        if(ENABLE_TSAN)
+            set(SANITIZER_FLAGS "-fsanitize=thread -fno-omit-frame-pointer -g")
+            set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} ${SANITIZER_FLAGS}")
+            set(CMAKE_EXE_LINKER_FLAGS "${CMAKE_EXE_LINKER_FLAGS} ${SANITIZER_FLAGS}")
+            message(STATUS "ThreadSanitizer (TSAN) enabled")
+        else()
+            set(SANITIZER_FLAGS "-fsanitize=address -fsanitize=undefined -fno-omit-frame-pointer -g")
+            set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} ${SANITIZER_FLAGS}")
+            set(CMAKE_EXE_LINKER_FLAGS "${CMAKE_EXE_LINKER_FLAGS} ${SANITIZER_FLAGS}")
+            message(STATUS "Sanitizers enabled: AddressSanitizer (ASAN) and UndefinedBehaviorSanitizer (UBSAN)")
+        endif()
+    else()
+        message(WARNING "Sanitizers requested but not supported by ${CMAKE_CXX_COMPILER_ID}")
+    endif()
+endif()
+
 #
 # # Configure vcpkg
 if(DEFINED CMAKE_TOOLCHAIN_FILE)
     message(STATUS "Using vcpkg toolchain: ${CMAKE_TOOLCHAIN_FILE}")
 endif()
 
 # Find packages
-option(ENTROPY_WITH_TRACY "Enable Tracy profiler integration" OFF)
-if(ENTROPY_WITH_TRACY)
-    find_package(Tracy CONFIG QUIET)
-endif()
 find_package(Boost REQUIRED COMPONENTS type_index)
 find_package(efsw CONFIG REQUIRED)
 
@@ -91,7 +111,6 @@ set(ENTROPY_CORE_HEADERS
         src/Core/EntropyInterop.h
         src/Core/entropy_c_api.h
         src/EntropyCore.h
-        src/ServiceLocator.h
         src/Core/EntropyService.h
         src/Core/EntropyServiceRegistry.h
         src/Core/EntropyApplication.h
@@ -105,7 +124,6 @@ set(ENTROPY_CORE_HEADERS
         src/Graph/AcyclicNodeHandle.h
         src/Debug/INamed.h
         src/Debug/DebugUtilities.h
-        src/Debug/Profiling.h
         src/Debug/Debug.h
         src/Logging/LogLevel.h
         src/Logging/LogEntry.h
@@ -217,13 +235,6 @@ target_link_libraries(EntropyCore
 target_compile_definitions(EntropyCore PRIVATE ENTROPYCORE_BUILDING)
 # EntropyCore is always static - no ENTROPYCORE_SHARED definition needed
 
-# Link Tracy if enabled and available
-if(ENTROPY_WITH_TRACY)
-  if(TARGET Tracy::TracyClient)
-    target_link_libraries(EntropyCore PUBLIC Tracy::TracyClient)
-  endif()
-endif()
-
 if(ENTROPY_BUILD_EXAMPLES)
   add_executable(WorkContractExample Examples/WorkContractExample.cpp)
   target_link_libraries(WorkContractExample PRIVATE EntropyCore)
@@ -307,16 +318,6 @@ if(ENTROPY_BUILD_EXAMPLES)
   # Custom AppDelegate example with main thread work pump
   add_executable(CustomAppDelegateExample Examples/CustomAppDelegateExample.cpp)
   target_link_libraries(CustomAppDelegateExample PRIVATE EntropyCore)
-
-  # Link Tracy to examples if available
-  if(ENTROPY_WITH_TRACY)
-    if(TARGET Tracy::TracyClient)
-      target_link_libraries(WorkContractExample PRIVATE Tracy::TracyClient)
-      target_link_libraries(WorkGraphYieldableExample PRIVATE Tracy::TracyClient)
-      target_link_libraries(EntropyObjectExample PRIVATE Tracy::TracyClient)
-      target_link_libraries(EntropyObjectHandleExample PRIVATE Tracy::TracyClient)
-    endif()
-  endif()
 endif()
 
 # Platform and compiler-specific settings
@@ -361,14 +362,6 @@ else()
 endif()
 
 # Define preprocessor macros
-if(ENTROPY_WITH_TRACY AND TARGET Tracy::TracyClient)
-    target_compile_definitions(EntropyCore
-        PUBLIC
-            TRACY_ENABLE
-            TRACY_ON_DEMAND
-    )
-endif()
-
 # Add EntropyDebug macro for Debug and RelWithDebInfo builds via generator expression
 target_compile_definitions(EntropyCore PUBLIC $<$<OR:$<CONFIG:Debug>,$<CONFIG:RelWithDebInfo>>:EntropyDebug>)
 

Examples/ConcurrencyAPIExample.c

@@ -107,6 +107,7 @@ void reentrant_work(void* user_data) {
             if (status == ENTROPY_OK) {
                 entropy_work_contract_schedule(left, &status);
             }
+            entropy_work_contract_handle_destroy(left);
 
             entropy_WorkContractHandle right = entropy_work_contract_group_create_contract(
                 ctx->group, reentrant_work, right_child, ENTROPY_EXEC_ANY_THREAD, &status
@@ -115,6 +116,7 @@ void reentrant_work(void* user_data) {
             if (status == ENTROPY_OK) {
                 entropy_work_contract_schedule(right, &status);
             }
+            entropy_work_contract_handle_destroy(right);
         }
     } else {
         ENTROPY_LOG_DEBUG_CAT_F("Reentrant",
@@ -264,12 +266,15 @@ int main(void) {
             entropy_work_contract_schedule(root_handle, &status);
             ENTROPY_LOG_INFO_CAT_F("Example", "Root task scheduled - it will spawn children recursively");
         }
-    }
 
-    // Wait for the recursive tree to complete
-    ENTROPY_LOG_INFO_CAT_F("Example", "Waiting for re-entrant task tree to complete...");
-    entropy_work_contract_group_wait(group, &status);
-    ENTROPY_LOG_INFO_CAT_F("Example", "Re-entrant task tree completed");
+        // Wait for the recursive tree to complete
+        ENTROPY_LOG_INFO_CAT_F("Example", "Waiting for re-entrant task tree to complete...");
+        entropy_work_contract_group_wait(group, &status);
+        ENTROPY_LOG_INFO_CAT_F("Example", "Re-entrant task tree completed");
+
+        // Destroy the root handle
+        entropy_work_contract_handle_destroy(root_handle);
+    }
 
     // 9. Print statistics
     ENTROPY_LOG_INFO_CAT_F("Example", "Step 9: Final statistics:");
@@ -287,6 +292,15 @@ int main(void) {
     entropy_work_service_stop(service, &status);
     ENTROPY_LOG_DEBUG_CAT_F("Example", "Service stopped");
 
+    // Destroy handle wrappers
+    ENTROPY_LOG_DEBUG_CAT_F("Example", "Destroying work contract handles...");
+    for (int i = 0; i < 10; i++) {
+        entropy_work_contract_handle_destroy(handles[i]);
+    }
+    for (int i = 0; i < 3; i++) {
+        entropy_work_contract_handle_destroy(main_handles[i]);
+    }
+
     entropy_work_service_destroy(service);
     ENTROPY_LOG_DEBUG_CAT_F("Example", "Service destroyed");
 

Tests/TestWorkServiceSingleton.h

@@ -50,9 +50,9 @@ class TestWorkServiceSingleton {
     TestWorkServiceSingleton& operator=(const TestWorkServiceSingleton&) = delete;
 };
 
-// Static member definitions
-std::unique_ptr<Concurrency::WorkService> TestWorkServiceSingleton::instance = nullptr;
-std::mutex TestWorkServiceSingleton::mutex;
+// Static member definitions - marked inline to avoid ODR violations in header
+inline std::unique_ptr<Concurrency::WorkService> TestWorkServiceSingleton::instance = nullptr;
+inline std::mutex TestWorkServiceSingleton::mutex;
 
 } // namespace Testing
 } // namespace Core

cmake/EntropyCoreConfig.cmake.in

@@ -6,12 +6,6 @@ include(CMakeFindDependencyMacro)
 find_dependency(Boost REQUIRED COMPONENTS type_index)
 find_dependency(efsw CONFIG REQUIRED)
 
-# Find optional dependencies based on how the package was built
-set(ENTROPY_WITH_TRACY @ENTROPY_WITH_TRACY@)
-if(ENTROPY_WITH_TRACY)
-    find_dependency(Tracy CONFIG REQUIRED)
-endif()
-
 # Include the exported targets
 include("${CMAKE_CURRENT_LIST_DIR}/EntropyCoreTargets.cmake")