From 43f6fd82f4ae3e7a8b9e3c40817c473f5d5179a6 Mon Sep 17 00:00:00 2001 From: Dale Glass Date: Tue, 30 Mar 2021 16:53:56 +0200 Subject: [PATCH] Implement thread debugging with tsan This is enabled with the VIRCADIA_THREAD_DEBUGGING environment variable. It's incompatible with VIRCADIA_MEMORY_DEBUGGING, so only one of those can be enabled for a build. --- assignment-client/CMakeLists.txt | 1 + cmake/macros/LinkHifiLibraries.cmake | 1 + cmake/macros/MemoryDebugger.cmake | 4 +++ cmake/macros/SetupHifiLibrary.cmake | 1 + cmake/macros/ThreadDebugger.cmake | 36 +++++++++++++++++++ domain-server/CMakeLists.txt | 1 + ice-server/CMakeLists.txt | 1 + interface/CMakeLists.txt | 3 +- libraries/gpu-gl/CMakeLists.txt | 2 +- tests-manual/controllers/CMakeLists.txt | 1 + tests-manual/entities/CMakeLists.txt | 1 + tests-manual/gl/CMakeLists.txt | 1 + tests-manual/gpu-textures/CMakeLists.txt | 1 + tests-manual/gpu/CMakeLists.txt | 1 + tests-manual/qml/CMakeLists.txt | 1 + tests-manual/render-perf/CMakeLists.txt | 1 + .../render-texture-load/CMakeLists.txt | 1 + tests-manual/render-utils/CMakeLists.txt | 1 + tests/recording/CMakeLists.txt | 1 + tools/ac-client/CMakeLists.txt | 1 + tools/atp-client/CMakeLists.txt | 1 + tools/gpu-frame-player/CMakeLists.txt | 1 + tools/ice-client/CMakeLists.txt | 1 + tools/ktx-tool/CMakeLists.txt | 1 + tools/nitpick/CMakeLists.txt | 1 + tools/oven/CMakeLists.txt | 1 + tools/skeleton-dump/CMakeLists.txt | 1 + tools/vhacd-util/CMakeLists.txt | 1 + 28 files changed, 67 insertions(+), 2 deletions(-) create mode 100644 cmake/macros/ThreadDebugger.cmake diff --git a/assignment-client/CMakeLists.txt b/assignment-client/CMakeLists.txt index 31d8c9e5a8..285c3221f8 100644 --- a/assignment-client/CMakeLists.txt +++ b/assignment-client/CMakeLists.txt @@ -8,6 +8,7 @@ if (APPLE) endif () setup_memory_debugger() +setup_thread_debugger() # link in the shared libraries link_hifi_libraries( diff --git a/cmake/macros/LinkHifiLibraries.cmake b/cmake/macros/LinkHifiLibraries.cmake index 6a430f5b13..390bdf2326 100644 --- a/cmake/macros/LinkHifiLibraries.cmake +++ b/cmake/macros/LinkHifiLibraries.cmake @@ -26,5 +26,6 @@ function(LINK_HIFI_LIBRARIES) endforeach() setup_memory_debugger() + setup_thread_debugger() endfunction() diff --git a/cmake/macros/MemoryDebugger.cmake b/cmake/macros/MemoryDebugger.cmake index 5aa99787bf..3ec1d23d89 100644 --- a/cmake/macros/MemoryDebugger.cmake +++ b/cmake/macros/MemoryDebugger.cmake @@ -9,6 +9,10 @@ macro(SETUP_MEMORY_DEBUGGER) if ("$ENV{VIRCADIA_MEMORY_DEBUGGING}") + if (DEFINED VIRCADIA_THREAD_DEBUGGING ) + message(FATAL_ERROR "Thread debugging and memory debugging can't be enabled at the same time." ) + endif() + SET( VIRCADIA_MEMORY_DEBUGGING true ) endif () diff --git a/cmake/macros/SetupHifiLibrary.cmake b/cmake/macros/SetupHifiLibrary.cmake index 108786a651..c99ba9734e 100644 --- a/cmake/macros/SetupHifiLibrary.cmake +++ b/cmake/macros/SetupHifiLibrary.cmake @@ -53,6 +53,7 @@ macro(SETUP_HIFI_LIBRARY) endforeach() setup_memory_debugger() + setup_thread_debugger() # create a library and set the property so it can be referenced later if (${${TARGET_NAME}_SHARED}) diff --git a/cmake/macros/ThreadDebugger.cmake b/cmake/macros/ThreadDebugger.cmake new file mode 100644 index 0000000000..419755a42b --- /dev/null +++ b/cmake/macros/ThreadDebugger.cmake @@ -0,0 +1,36 @@ +# +# MemoryDebugger.cmake +# +# Copyright 2021 Vircadia Contributors +# +# Distributed under the Apache License, Version 2.0. +# See the accompanying file LICENSE or http://www.apache.org/licenses/LICENSE-2.0.html +# + +macro(SETUP_THREAD_DEBUGGER) +if ("$ENV{VIRCADIA_THREAD_DEBUGGING}") + if (DEFINED VIRCADIA_MEMORY_DEBUGGING ) + message(FATAL_ERROR "Thread debugging and memory debugging can't be enabled at the same time." ) + endif () + + SET( VIRCADIA_THREAD_DEBUGGING true ) +endif () + +if (VIRCADIA_THREAD_DEBUGGING) + if (UNIX) + if (CMAKE_CXX_COMPILER_ID MATCHES "Clang") + # for clang on Linux + SET(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -fsanitize=thread -fno-omit-frame-pointer" ) + SET(CMAKE_EXE_LINKER_FLAGS "-fsanitize=thread ${CMAKE_EXE_LINKER_FLAGS}") + SET(CMAKE_SHARED_LINKER_FLAGS "-fsanitize=thread ${CMAKE_EXE_LINKER_FLAGS}") + else () + # for gcc on Linux + SET(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -fsanitize=thread -fno-omit-frame-pointer") + SET(CMAKE_EXE_LINKER_FLAGS " -fsanitize=thread ${CMAKE_EXE_LINKER_FLAGS}") + SET(CMAKE_SHARED_LINKER_FLAGS "-fsanitize=thread ${CMAKE_EXE_LINKER_FLAGS}") + endif() + else() + message(FATAL_ERROR "Thread debugging is not supported on this platform." ) + endif (UNIX) +endif () +endmacro(SETUP_THREAD_DEBUGGER) diff --git a/domain-server/CMakeLists.txt b/domain-server/CMakeLists.txt index 693132a8f7..a3a85684b4 100644 --- a/domain-server/CMakeLists.txt +++ b/domain-server/CMakeLists.txt @@ -15,6 +15,7 @@ if (APPLE) endif () setup_memory_debugger() +setup_thread_debugger() # TODO: find a solution that will handle web file changes in resources on windows without a re-build. # Currently the resources are only copied on post-build. If one is changed but the domain-server is not, they will diff --git a/ice-server/CMakeLists.txt b/ice-server/CMakeLists.txt index 07b90b369e..9234d68faf 100644 --- a/ice-server/CMakeLists.txt +++ b/ice-server/CMakeLists.txt @@ -19,6 +19,7 @@ endif () include_directories(SYSTEM "${OPENSSL_INCLUDE_DIR}") setup_memory_debugger() +setup_thread_debugger() # append OpenSSL to our list of libraries to link target_link_libraries(${TARGET_NAME} ${OPENSSL_LIBRARIES}) diff --git a/interface/CMakeLists.txt b/interface/CMakeLists.txt index 0a0ade149d..6e4837527e 100644 --- a/interface/CMakeLists.txt +++ b/interface/CMakeLists.txt @@ -47,6 +47,7 @@ add_custom_target(resources ALL DEPENDS ${GENERATE_QRC_DEPENDS}) set(OPTIONAL_EXTERNALS "LeapMotion") setup_memory_debugger() +setup_thread_debugger() foreach(EXTERNAL ${OPTIONAL_EXTERNALS}) string(TOUPPER ${EXTERNAL} ${EXTERNAL}_UPPERCASE) @@ -299,7 +300,7 @@ target_link_libraries( ${PLATFORM_QT_LIBRARIES} ) -if (UNIX AND NOT ANDROID) +if (UNIX AND NOT ANDROID AND NOT VIRCADIA_THREAD_DEBUGGING) if (CMAKE_SYSTEM_NAME MATCHES "Linux") # Linux target_link_libraries(${TARGET_NAME} pthread atomic) diff --git a/libraries/gpu-gl/CMakeLists.txt b/libraries/gpu-gl/CMakeLists.txt index 01f097df87..3c569f7a44 100644 --- a/libraries/gpu-gl/CMakeLists.txt +++ b/libraries/gpu-gl/CMakeLists.txt @@ -1,7 +1,7 @@ set(TARGET_NAME gpu-gl) setup_hifi_library(Concurrent) link_hifi_libraries(shared gl gpu gpu-gl-common shaders) -if (UNIX) +if (UNIX AND NOT VIRCADIA_THREAD_DEBUGGING) target_link_libraries(${TARGET_NAME} pthread) endif(UNIX) GroupSources("src") diff --git a/tests-manual/controllers/CMakeLists.txt b/tests-manual/controllers/CMakeLists.txt index 03043c79f2..932826c8de 100644 --- a/tests-manual/controllers/CMakeLists.txt +++ b/tests-manual/controllers/CMakeLists.txt @@ -7,6 +7,7 @@ setup_hifi_project(Script Qml) set_target_properties(${TARGET_NAME} PROPERTIES FOLDER "Tests/manual-tests/") setup_memory_debugger() +setup_thread_debugger() # link in the shared libraries link_hifi_libraries(shared gl script-engine plugins render-utils ui-plugins input-plugins display-plugins controllers) diff --git a/tests-manual/entities/CMakeLists.txt b/tests-manual/entities/CMakeLists.txt index 6d0bf9f149..a6eed4f234 100644 --- a/tests-manual/entities/CMakeLists.txt +++ b/tests-manual/entities/CMakeLists.txt @@ -4,6 +4,7 @@ set(TARGET_NAME "entities-test") # This is not a testcase -- just set it up as a regular hifi project setup_hifi_project(Network Script) setup_memory_debugger() +setup_thread_debugger() set_target_properties(${TARGET_NAME} PROPERTIES FOLDER "Tests/manual-tests/") # link in the shared libraries diff --git a/tests-manual/gl/CMakeLists.txt b/tests-manual/gl/CMakeLists.txt index 40bb64be1c..5b738a6e39 100644 --- a/tests-manual/gl/CMakeLists.txt +++ b/tests-manual/gl/CMakeLists.txt @@ -2,6 +2,7 @@ set(TARGET_NAME gl-test) # This is not a testcase -- just set it up as a regular hifi project setup_hifi_project(Quick Gui OpenGL) setup_memory_debugger() +setup_thread_debugger() set_target_properties(${TARGET_NAME} PROPERTIES FOLDER "Tests/manual-tests/") link_hifi_libraries(shared gl) package_libraries_for_deployment() diff --git a/tests-manual/gpu-textures/CMakeLists.txt b/tests-manual/gpu-textures/CMakeLists.txt index 907690748a..d148b0cd21 100644 --- a/tests-manual/gpu-textures/CMakeLists.txt +++ b/tests-manual/gpu-textures/CMakeLists.txt @@ -2,6 +2,7 @@ set(TARGET_NAME gpu-textures-tests) # This is not a testcase -- just set it up as a regular hifi project setup_hifi_project(Quick Gui Script) setup_memory_debugger() +setup_thread_debugger() set_target_properties(${TARGET_NAME} PROPERTIES FOLDER "Tests/manual-tests/") link_hifi_libraries( shared shaders task networking gl diff --git a/tests-manual/gpu/CMakeLists.txt b/tests-manual/gpu/CMakeLists.txt index 6e3781acff..dc7bfbe75e 100644 --- a/tests-manual/gpu/CMakeLists.txt +++ b/tests-manual/gpu/CMakeLists.txt @@ -2,6 +2,7 @@ set(TARGET_NAME gpu-test) # This is not a testcase -- just set it up as a regular hifi project setup_hifi_project(Quick Gui Script) setup_memory_debugger() +setup_thread_debugger() set_target_properties(${TARGET_NAME} PROPERTIES FOLDER "Tests/manual-tests/") link_hifi_libraries( shared task networking gl diff --git a/tests-manual/qml/CMakeLists.txt b/tests-manual/qml/CMakeLists.txt index f56b8c4533..1b56927713 100644 --- a/tests-manual/qml/CMakeLists.txt +++ b/tests-manual/qml/CMakeLists.txt @@ -1,6 +1,7 @@ set(TARGET_NAME qml-test) setup_hifi_project(Quick Qml Gui OpenGL) setup_memory_debugger() +setup_thread_debugger() set_target_properties(${TARGET_NAME} PROPERTIES FOLDER "Tests/manual-tests/") link_hifi_libraries(shared networking gl qml) diff --git a/tests-manual/render-perf/CMakeLists.txt b/tests-manual/render-perf/CMakeLists.txt index 9e7d826d03..67d3ac2d86 100644 --- a/tests-manual/render-perf/CMakeLists.txt +++ b/tests-manual/render-perf/CMakeLists.txt @@ -6,6 +6,7 @@ if (WIN32) endif() setup_memory_debugger() +setup_thread_debugger() # This is not a testcase -- just set it up as a regular hifi project setup_hifi_project(Quick Gui) diff --git a/tests-manual/render-texture-load/CMakeLists.txt b/tests-manual/render-texture-load/CMakeLists.txt index 2e939e931a..77afdfa5d0 100644 --- a/tests-manual/render-texture-load/CMakeLists.txt +++ b/tests-manual/render-texture-load/CMakeLists.txt @@ -6,6 +6,7 @@ if (WIN32) endif() setup_memory_debugger() +setup_thread_debugger() # This is not a testcase -- just set it up as a regular hifi project setup_hifi_project(Quick Gui) diff --git a/tests-manual/render-utils/CMakeLists.txt b/tests-manual/render-utils/CMakeLists.txt index 9f575ee8ca..e5548de2b2 100644 --- a/tests-manual/render-utils/CMakeLists.txt +++ b/tests-manual/render-utils/CMakeLists.txt @@ -6,6 +6,7 @@ setup_hifi_project(Quick Gui) set_target_properties(${TARGET_NAME} PROPERTIES FOLDER "Tests/manual-tests/") setup_memory_debugger() +setup_thread_debugger() # link in the shared libraries link_hifi_libraries(render-utils shaders gl gpu shared ${PLATFORM_GL_BACKEND}) diff --git a/tests/recording/CMakeLists.txt b/tests/recording/CMakeLists.txt index dbb942a27a..a0925aaf6d 100644 --- a/tests/recording/CMakeLists.txt +++ b/tests/recording/CMakeLists.txt @@ -3,6 +3,7 @@ set(TARGET_NAME recording-test) setup_hifi_project(Test) set_target_properties(${TARGET_NAME} PROPERTIES FOLDER "Tests/manual-tests/") setup_memory_debugger() +setup_thread_debugger() link_hifi_libraries(shared recording) if (WIN32) target_link_libraries(${TARGET_NAME} Winmm.lib) diff --git a/tools/ac-client/CMakeLists.txt b/tools/ac-client/CMakeLists.txt index ad16187dcb..fe878b3cb4 100644 --- a/tools/ac-client/CMakeLists.txt +++ b/tools/ac-client/CMakeLists.txt @@ -1,4 +1,5 @@ set(TARGET_NAME ac-client) setup_hifi_project(Core) setup_memory_debugger() +setup_thread_debugger() link_hifi_libraries(shared networking) diff --git a/tools/atp-client/CMakeLists.txt b/tools/atp-client/CMakeLists.txt index 19c70597f7..0ed5969cb6 100644 --- a/tools/atp-client/CMakeLists.txt +++ b/tools/atp-client/CMakeLists.txt @@ -1,4 +1,5 @@ set(TARGET_NAME atp-client) setup_hifi_project(Core) setup_memory_debugger() +setup_thread_debugger() link_hifi_libraries(shared networking) diff --git a/tools/gpu-frame-player/CMakeLists.txt b/tools/gpu-frame-player/CMakeLists.txt index cb20cdde25..e3611e1068 100644 --- a/tools/gpu-frame-player/CMakeLists.txt +++ b/tools/gpu-frame-player/CMakeLists.txt @@ -2,6 +2,7 @@ set(TARGET_NAME gpu-frame-player) setup_memory_debugger() +setup_thread_debugger() if (APPLE) set(CMAKE_MACOSX_BUNDLE TRUE) diff --git a/tools/ice-client/CMakeLists.txt b/tools/ice-client/CMakeLists.txt index 64ec6b131d..ebd573ebb5 100644 --- a/tools/ice-client/CMakeLists.txt +++ b/tools/ice-client/CMakeLists.txt @@ -1,4 +1,5 @@ set(TARGET_NAME ice-client) setup_hifi_project(Core) setup_memory_debugger() +setup_thread_debugger() link_hifi_libraries(shared networking) diff --git a/tools/ktx-tool/CMakeLists.txt b/tools/ktx-tool/CMakeLists.txt index 6bb09e0a9e..0c824cc2e7 100644 --- a/tools/ktx-tool/CMakeLists.txt +++ b/tools/ktx-tool/CMakeLists.txt @@ -7,6 +7,7 @@ link_hifi_libraries(shared networking image gl shaders gpu ktx) target_gli() setup_memory_debugger() +setup_thread_debugger() if (WIN32) package_libraries_for_deployment() diff --git a/tools/nitpick/CMakeLists.txt b/tools/nitpick/CMakeLists.txt index d65505415d..811cfecd94 100644 --- a/tools/nitpick/CMakeLists.txt +++ b/tools/nitpick/CMakeLists.txt @@ -31,6 +31,7 @@ source_group("UI Files" FILES ${QT_UI_FILES}) qt5_wrap_ui(QT_UI_HEADERS "${QT_UI_FILES}") setup_memory_debugger() +setup_thread_debugger() # add them to the nitpick source files set(NITPICK_SRCS ${NITPICK_SRCS} "${QT_UI_HEADERS}" "${QT_RESOURCES}") diff --git a/tools/oven/CMakeLists.txt b/tools/oven/CMakeLists.txt index 49cf9fb6ab..9a159d8cb1 100644 --- a/tools/oven/CMakeLists.txt +++ b/tools/oven/CMakeLists.txt @@ -5,6 +5,7 @@ setup_hifi_project(Widgets Gui Concurrent) link_hifi_libraries(shared shaders image gpu ktx fbx hfm baking graphics networking procedural material-networking model-baker task) setup_memory_debugger() +setup_thread_debugger() if (WIN32) package_libraries_for_deployment() diff --git a/tools/skeleton-dump/CMakeLists.txt b/tools/skeleton-dump/CMakeLists.txt index 7d4248d171..cf95c302e8 100644 --- a/tools/skeleton-dump/CMakeLists.txt +++ b/tools/skeleton-dump/CMakeLists.txt @@ -1,6 +1,7 @@ set(TARGET_NAME skeleton-dump) setup_hifi_project(Core) setup_memory_debugger() +setup_thread_debugger() link_hifi_libraries(shared fbx hfm graphics gpu gl animation) include_hifi_library_headers(image) diff --git a/tools/vhacd-util/CMakeLists.txt b/tools/vhacd-util/CMakeLists.txt index cc8760fa2d..3c4d17122e 100644 --- a/tools/vhacd-util/CMakeLists.txt +++ b/tools/vhacd-util/CMakeLists.txt @@ -7,6 +7,7 @@ include_hifi_library_headers(image) target_vhacd() setup_memory_debugger() +setup_thread_debugger() if (WIN32) package_libraries_for_deployment()