Merge branch 'tblass/enable-tracing-by-default' into 'master'

Enable tracing by default if LTTng is available

See merge request micro-ROS/ros_tracing/ros2_tracing!63
This commit is contained in:
Christophe Bedard 2019-07-25 09:28:25 +00:00
commit b862f92c9f
5 changed files with 54 additions and 64 deletions

View file

@ -26,15 +26,16 @@ build_enabled:
- lttng-sessiond --daemonize - lttng-sessiond --daemonize
- colcon build --symlink-install --packages-up-to $PACKAGES_LIST - colcon build --symlink-install --packages-up-to $PACKAGES_LIST
- . install/local_setup.sh - . install/local_setup.sh
- ./build/tracetools/status
- colcon test --packages-select $PACKAGES_LIST - colcon test --packages-select $PACKAGES_LIST
- colcon test-result - colcon test-result
<<: *global_artifacts <<: *global_artifacts
build: build:
script: script:
- rm colcon.meta - colcon build --symlink-install --cmake-args " -DTRACETOOLS_DISABLED=ON" --packages-up-to $PACKAGES_LIST
- colcon build --symlink-install --packages-up-to $PACKAGES_LIST
- . install/local_setup.sh - . install/local_setup.sh
- (! ./build/tracetools/status)
- colcon test --packages-select $PACKAGES_LIST - colcon test --packages-select $PACKAGES_LIST
- colcon test-result - colcon test-result
<<: *global_artifacts <<: *global_artifacts

View file

@ -4,7 +4,7 @@ Tracing tools for ROS 2.
## Building ## Building
If tracing is not enabled when building, or if LTTng is not found, then this package will not do anything. If the `TRACETOOLS_DISABLED` option is enabled during build or if LTTng is not found, then this package will not do anything.
To enable tracing: To enable tracing:
@ -16,9 +16,9 @@ To enable tracing:
$ sudo apt-get install python3-babeltrace python3-lttng $ sudo apt-get install python3-babeltrace python3-lttng
``` ```
Note: the LTTng stable 2.10 PPA is used to get newer versions of the packages. Note: the LTTng stable 2.10 PPA is used to get newer versions of the packages.
2. Build with the `WITH_LTTNG` flag: 2. Build
``` ```
$ colcon build --cmake-args " -DWITH_LTTNG=ON" $ colcon build
``` ```
3. Source and check that tracing is enabled: 3. Source and check that tracing is enabled:
``` ```

View file

@ -1,14 +0,0 @@
{
"names": {
"tracetools": {
"cmake-args": [
"-DWITH_LTTNG=ON",
],
},
"tracetools_test": {
"cmake-args": [
"-DWITH_LTTNG=ON",
],
},
},
}

View file

@ -12,21 +12,17 @@ endif()
find_package(ament_cmake_ros REQUIRED) find_package(ament_cmake_ros REQUIRED)
option(WITH_LTTNG "Include support for tracing with LTTng" OFF) option(TRACETOOLS_DISABLED "Explicitly disable support for tracing with LTTng" OFF)
if(WITH_LTTNG) if(NOT TRACETOOLS_DISABLED)
# Try to find LTTng # Set TRACING_ENABLED if we can find lttng-ust
find_package(PkgConfig REQUIRED) find_package(PkgConfig)
pkg_check_modules(LTTNG REQUIRED lttng-ust) if(PkgConfig_FOUND)
endif() pkg_check_modules(LTTNG lttng-ust)
if(LTTNG_FOUND) if(LTTNG_FOUND)
set(LTTNG_TP_FILES
include/tracetools/tp_call.h
src/tp_call.c
)
set(TRACING_ENABLED TRUE) set(TRACING_ENABLED TRUE)
message("LTTng found: tracing enabled") message("LTTng found: tracing enabled")
elseif(WITH_LTTNG) endif()
message("LTTng NOT found: tracing disabled") endif()
endif() endif()
include_directories(include) include_directories(include)
@ -54,7 +50,10 @@ set(SOURCES
src/utils.cpp src/utils.cpp
) )
if(TRACING_ENABLED) if(TRACING_ENABLED)
list(APPEND SOURCES ${LTTNG_TP_FILES}) list(APPEND SOURCES
include/tracetools/tp_call.h
src/tp_call.c
)
endif() endif()
add_library(${PROJECT_NAME} SHARED ${SOURCES}) add_library(${PROJECT_NAME} SHARED ${SOURCES})
@ -92,7 +91,7 @@ if(BUILD_TESTING)
ament_lint_auto_find_test_dependencies() ament_lint_auto_find_test_dependencies()
# Only build tracetools utils tests if LTTng is enabled and found # Only build tracetools utils tests if LTTng is enabled and found
if(TRACETOOLS_LTTNG_ENABLED) if(TRACING_ENABLED)
ament_add_gtest(test_utils test/test_utils.cpp) ament_add_gtest(test_utils test/test_utils.cpp)
if(TARGET test_utils) if(TARGET test_utils)
target_link_libraries(test_utils ${PROJECT_NAME} -rdynamic) target_link_libraries(test_utils ${PROJECT_NAME} -rdynamic)

View file

@ -12,7 +12,17 @@ endif()
find_package(ament_cmake REQUIRED) find_package(ament_cmake REQUIRED)
option(WITH_LTTNG "Include support for tracing with LTTng" OFF) option(TRACETOOLS_DISABLED "Explicitly disable support for tracing with LTTng" OFF)
if(NOT TRACETOOLS_DISABLED)
# Set TRACING_ENABLED if we can find lttng-ust
find_package(PkgConfig)
if(PkgConfig_FOUND)
pkg_check_modules(LTTNG lttng-ust)
if(LTTNG_FOUND)
set(TRACING_ENABLED TRUE)
endif()
endif()
endif()
# Tests # Tests
if(BUILD_TESTING) if(BUILD_TESTING)
@ -119,12 +129,7 @@ if(BUILD_TESTING)
ament_lint_auto_find_test_dependencies() ament_lint_auto_find_test_dependencies()
# Only build tracing tests if LTTng is enabled and found # Only build tracing tests if LTTng is enabled and found
if(WITH_LTTNG) if(TRACING_ENABLED)
find_package(PkgConfig REQUIRED)
pkg_check_modules(LTTNG REQUIRED lttng-ust)
if(LTTNG_FOUND)
message("LTTng found: tracing tests enabled")
find_package(ament_cmake_pytest REQUIRED) find_package(ament_cmake_pytest REQUIRED)
# Run each test in its own pytest invocation # Run each test in its own pytest invocation
@ -150,6 +155,5 @@ if(BUILD_TESTING)
endforeach() endforeach()
endif() endif()
endif() endif()
endif()
ament_package() ament_package()