From 0fe755fc8504c047f540df1188d055288319efc3 Mon Sep 17 00:00:00 2001 From: Lukas Berbuer Date: Sun, 1 Aug 2021 10:40:50 +0200 Subject: [PATCH 1/2] Add options to CMakeLists.txt Major parts taken from https://github.com/Manu343726/tracy/blob/master/CMakeLists.txt --- CMakeLists.txt | 66 +++++++++++++++++++++++++++++++++++++++++++++++--- 1 file changed, 63 insertions(+), 3 deletions(-) diff --git a/CMakeLists.txt b/CMakeLists.txt index 2189e11d..0c9b40b2 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -1,4 +1,64 @@ cmake_minimum_required(VERSION 3.10) -project(TracyClient LANGUAGES CXX) -add_library(TracyClient INTERFACE) -target_include_directories(TracyClient INTERFACE ${CMAKE_CURRENT_SOURCE_DIR}) + +project(Tracy LANGUAGES CXX) + +find_package(Threads REQUIRED) + +option(TRACY_ENABLE "Enable profiling" ON) +option(TRACY_ON_DEMAND "On-demand profiling" OFF) +option(TRACY_CALLSTACK "Collect call stacks" OFF) +option(TRACY_ONLY_LOCALHOST "Only listen on the localhost interface" OFF) +option(TRACY_NO_BROADCAST "Disable client discovery by broadcast to local network" OFF) +option(TRACY_NO_CODE_TRANSFER "Disable collection of source code" OFF) +option(TRACY_NO_CONTEXT_SWITCH "Disable capture of context switches" OFF) +option(TRACY_NO_EXIT "Client executable does not exit until all profile data is sent to server" OFF) +option(TRACY_NO_FRAME_IMAGE "Disable capture of frame images" OFF) +option(TRACE_NO_SAMPLING "Disable call stack sampling" OFF) +option(TRACY_NO_VERIFY "Disable zone validation for C API" OFF) +option(TRACY_NO_VSYNC_CAPTURE "Disable capture of hardware Vsync events" OFF) + +add_library(TracyClient TracyClient.cpp) +target_compile_features(TracyClient PUBLIC cxx_std_11) +target_include_directories(TracyClient PUBLIC ${CMAKE_CURRENT_SOURCE_DIR}) +target_link_libraries( + TracyClient + PUBLIC + Threads::Threads + ${CMAKE_DL_LIBS} +) + +if(CMAKE_SYSTEM_NAME MATCHES "FreeBSD") + find_library(EXECINFO_LIBRARY NAMES execinfo REQUIRED) + target_link_libraries(TracyClient PUBLIC ${EXECINFO_LIBRARY}) +endif() + +add_library(Tracy::TracyClient ALIAS TracyClient) + +macro(set_option OPTION) + if(${OPTION}) + message(STATUS "${OPTION}: ON") + target_compile_definitions(TracyClient PUBLIC ${OPTION}) + else() + message(STATUS "${OPTION}: OFF") + endif() +endmacro() + +set_option(TRACY_ENABLE) +set_option(TRACY_ON_DEMAND) +set_option(TRACY_CALLSTACK) +set_option(TRACY_ONLY_LOCALHOST) +set_option(TRACY_NO_BROADCAST) +set_option(TRACY_NO_CODE_TRANSFER) +set_option(TRACY_NO_CONTEXT_SWITCH) +set_option(TRACY_NO_EXIT) +set_option(TRACY_NO_FRAME_IMAGE) +set_option(TRACE_NO_SAMPLING) +set_option(TRACY_NO_VERIFY) +set_option(TRACY_NO_VSYNC_CAPTURE) + +if(NOT TRACY_PORT) + set(TRACY_PORT 8086) +endif() + +message(STATUS "TRACY_PORT: ${TRACY_PORT}") +target_compile_definitions(TracyClient PUBLIC TRACY_PORT=${TRACY_PORT}) From 958386709f108837e33473b4c5a96bb839635d1a Mon Sep 17 00:00:00 2001 From: Lukas Berbuer Date: Sun, 1 Aug 2021 12:46:29 +0200 Subject: [PATCH 2/2] Add documentation for CMake integration --- CMakeLists.txt | 7 ------- manual/tracy.tex | 23 ++++++++++++++++++++++- 2 files changed, 22 insertions(+), 8 deletions(-) diff --git a/CMakeLists.txt b/CMakeLists.txt index 0c9b40b2..30cd3965 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -55,10 +55,3 @@ set_option(TRACY_NO_FRAME_IMAGE) set_option(TRACE_NO_SAMPLING) set_option(TRACY_NO_VERIFY) set_option(TRACY_NO_VSYNC_CAPTURE) - -if(NOT TRACY_PORT) - set(TRACY_PORT 8086) -endif() - -message(STATUS "TRACY_PORT: ${TRACY_PORT}") -target_compile_definitions(TracyClient PUBLIC TRACY_PORT=${TRACY_PORT}) diff --git a/manual/tracy.tex b/manual/tracy.tex index 635ca7cb..4bec38c1 100644 --- a/manual/tracy.tex +++ b/manual/tracy.tex @@ -425,6 +425,27 @@ The application you want to profile should be compiled with all the usual optimi Finally, on Unix make sure that the application is linked with libraries \texttt{libpthread} and \texttt{libdl}. BSD systems will also need to be linked with \texttt{libexecinfo}. +\begin{bclogo}[ +noborder=true, +couleur=black!5, +logo=\bclampe +]{CMake integration} +You can integrate Tracy easily with CMake by adding the git submodule folder as a subdirectory. + +\begin{lstlisting} +# set options before add_subdirectory +# available options: TRACY_ENABLE, TRACY_ON_DEMAND, TRACY_NO_BROADCAST, TRACY_NO_CODE_TRANSFER, ... +option(TRACY_ENABLE "" ON) +option(TRACY_ON_DEMAND "" ON) +add_subdirectory(3rdparty/tracy) # target: TracyClient or alias Tracy::TracyClient +\end{lstlisting} + +Link \texttt{Tracy::TracyClient} to any target where you use Tracy for profiling: + +\begin{lstlisting} +target_link_libraries( PUBLIC Tracy::TracyClient) +\end{lstlisting} +\end{bclogo} \begin{bclogo}[ noborder=true, @@ -448,7 +469,7 @@ FetchContent_MakeAvailable(tracy) Then add this to any target where you use tracy for profiling: \begin{lstlisting} -target_link_libraries(${_target} PUBLIC TracyClient) +target_link_libraries( PUBLIC TracyClient) \end{lstlisting} \end{bclogo}