Merge pull request #1199 from lukaszstolarczuk/avoid-libunwind-on-valgrind-tests

Avoid libunwind on valgrind tests

Author: lukaszstolarczuk

.github/workflows/gha.yml

@@ -34,8 +34,8 @@ jobs:
                  "TYPE=debug OS=ubuntu OS_VER=20.04 COVERAGE=1",
                  "TYPE=release OS=fedora OS_VER=32",
                  "TYPE=release OS=ubuntu OS_VER=20.04",
-                 "TYPE=valgrind OS=ubuntu OS_VER=20.04",
-                 "TYPE=memcheck_drd OS=ubuntu OS_VER=20.04",
+                 "TYPE=valgrind OS=ubuntu OS_VER=20.04 TESTS_VALGRIND_UNWIND=0",
+                 "TYPE=memcheck_drd OS=ubuntu OS_VER=20.04 TESTS_VALGRIND_UNWIND=0",
                  "TYPE=package OS=fedora OS_VER=32",
                  "TYPE=package OS=ubuntu OS_VER=20.04"]
     steps:

.github/workflows/weekly.yml

@@ -28,8 +28,8 @@ jobs:
                  "TYPE=debug OS=ubuntu OS_VER=20.04 TESTS_UBSAN=1 TESTS_PMREORDER=0",
                  "TYPE=debug OS=fedora OS_VER=rawhide TESTS_ASAN=1 TESTS_PMREORDER=0",
                  "TYPE=debug OS=fedora OS_VER=rawhide TESTS_UBSAN=1 TESTS_PMREORDER=0",
-                 "TYPE=valgrind OS=fedora OS_VER=rawhide TESTS_PMREORDER=0",
-                 "TYPE=memcheck_drd OS=fedora OS_VER=rawhide TESTS_PMREORDER=0",
+                 "TYPE=valgrind OS=fedora OS_VER=rawhide TESTS_PMREORDER=0 TESTS_VALGRIND_UNWIND=0",
+                 "TYPE=memcheck_drd OS=fedora OS_VER=rawhide TESTS_PMREORDER=0 TESTS_VALGRIND_UNWIND=0",
                  "TYPE=package OS=fedora OS_VER=34",
                  "TYPE=package OS=fedora OS_VER=rawhide TESTS_PMREORDER=0",
                  "TYPE=package OS=ubuntu OS_VER=devel"]

CMakeLists.txt

@@ -78,6 +78,7 @@ option(CHECK_CPP_STYLE "check code style of C++ sources" OFF)
 option(TRACE_TESTS "more verbose test outputs" OFF)
 option(USE_ASAN "enable AddressSanitizer (debugging)" OFF)
 option(USE_UBSAN "enable UndefinedBehaviorSanitizer (debugging)" OFF)
+option(USE_LIBUNWIND "use libunwind for more reliable stack traces from tests (if available)" ON)
 option(USE_CCACHE "use ccache if it is available in the system" ON)
 
 option(TESTS_USE_FORCED_PMEM "run tests with PMEM_IS_PMEM_FORCE=1 - it speeds up tests execution on emulated pmem" OFF)

tests/CMakeLists.txt

@@ -81,7 +81,7 @@ include(tbb)
 
 add_library(test_backtrace STATIC test_backtrace.c)
 if(LIBUNWIND_FOUND)
-	target_compile_definitions(test_backtrace PUBLIC USE_LIBUNWIND=1)
+	target_compile_definitions(test_backtrace PUBLIC LIBUNWIND_ENABLED=1)
 endif()
 
 add_library(valgrind_internal STATIC valgrind_internal.cpp)

tests/ctest_helpers.cmake

@@ -34,13 +34,17 @@ function(find_packages)
 		find_package(Curses QUIET)
 	endif()
 
-	if(PKG_CONFIG_FOUND)
-		pkg_check_modules(LIBUNWIND QUIET libunwind)
-	else()
-		find_package(LIBUNWIND QUIET)
-	endif()
-	if(NOT LIBUNWIND_FOUND)
-		message(WARNING "libunwind not found. Stack traces from tests will not be reliable")
+	if (USE_LIBUNWIND)
+		if(PKG_CONFIG_FOUND)
+			pkg_check_modules(LIBUNWIND QUIET libunwind)
+		else()
+			find_package(LIBUNWIND QUIET)
+		endif()
+		if(NOT LIBUNWIND_FOUND)
+			message(WARNING "libunwind not found. Stack traces from tests will not be reliable")
+		else()
+			message(STATUS "Found libunwind: ${LIBUNWIND_LIBDIR} (version: ${LIBUNWIND_VERSION})")
+		endif()
 	endif()
 
 	find_gdb()

tests/test_backtrace.c

@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: BSD-3-Clause
-/* Copyright 2015-2019, Intel Corporation */
+/* Copyright 2015-2021, Intel Corporation */
 
 /*
  * backtrace.c -- backtrace reporting routines
@@ -16,7 +16,7 @@
 #include <stdlib.h>
 #include <string.h>
 
-#ifdef USE_LIBUNWIND
+#ifdef LIBUNWIND_ENABLED
 
 #define UNW_LOCAL_ONLY
 #include <dlfcn.h>
@@ -90,7 +90,7 @@ test_dump_backtrace(void)
 				unw_strerror(ret), ret);
 	}
 }
-#else /* USE_LIBUNWIND */
+#else /* LIBUNWIND_ENABLED */
 
 #define BSIZE 100
 
@@ -162,7 +162,7 @@ test_dump_backtrace(void)
 
 #endif /* _WIN32 */
 
-#endif /* USE_LIBUNWIND */
+#endif /* LIBUNWIND_ENABLED */
 
 /*
  * test_sighandler -- fatal signal handler

utils/docker/build.sh

@@ -139,6 +139,7 @@ docker run --privileged=true --name=${CONTAINER_NAME} -i \
 	--env TESTS_PACKAGES=${TESTS_PACKAGES:-ON} \
 	--env TESTS_ASAN=${TESTS_ASAN:-OFF} \
 	--env TESTS_UBSAN=${TESTS_UBSAN:-OFF} \
+	--env TESTS_VALGRIND_UNWIND=${TESTS_VALGRIND_UNWIND:-OFF} \
 	--env TEST_TIMEOUT=${TEST_TIMEOUT} \
 	--env TZ='Europe/Warsaw' \
 	--shm-size=4G \

utils/docker/run-build.sh

@@ -23,6 +23,7 @@ TESTS_PACKAGES=${TESTS_PACKAGES:-ON}
 TESTS_USE_FORCED_PMEM=${TESTS_USE_FORCED_PMEM:-ON}
 TESTS_ASAN=${TESTS_ASAN:-OFF}
 TESTS_UBSAN=${TESTS_UBSAN:-OFF}
+TESTS_VALGRIND_UNWIND=${TESTS_VALGRIND_UNWIND:-OFF}
 TEST_TIMEOUT=${TEST_TIMEOUT:-600}
 
 export PMREORDER_STACKTRACE_DEPTH=20
@@ -106,6 +107,7 @@ function tests_clang_release_cpp11_no_valgrind() {
 # BUILD build_gcc_debug_cpp14 (no tests)
 ###############################################################################
 function build_gcc_debug_cpp14() {
+	VALGRIND_UNWIND=${1:-ON}
 	mkdir build
 	cd build
 
@@ -128,7 +130,8 @@ function build_gcc_debug_cpp14() {
 		-DTESTS_COMPATIBILITY=1 \
 		-DTESTS_CONCURRENT_GDB=1 \
 		-DUSE_ASAN=${TESTS_ASAN} \
-		-DUSE_UBSAN=${TESTS_UBSAN}
+		-DUSE_UBSAN=${TESTS_UBSAN} \
+		-DUSE_LIBUNWIND=${VALGRIND_UNWIND}
 
 	make -j$(nproc)
 }
@@ -152,7 +155,7 @@ function tests_gcc_debug_cpp14_no_valgrind() {
 ###############################################################################
 function tests_gcc_debug_cpp14_valgrind_memcheck_drd() {
 	printf "\n$(tput setaf 1)$(tput setab 7)BUILD ${FUNCNAME[0]} START$(tput sgr 0)\n"
-	build_gcc_debug_cpp14
+	build_gcc_debug_cpp14 ${TESTS_VALGRIND_UNWIND}
 	ctest -R "_memcheck|_drd" --timeout ${TEST_TIMEOUT} --output-on-failure
 	workspace_cleanup
 	printf "$(tput setaf 1)$(tput setab 7)BUILD ${FUNCNAME[0]} END$(tput sgr 0)\n\n"
@@ -163,7 +166,7 @@ function tests_gcc_debug_cpp14_valgrind_memcheck_drd() {
 ###############################################################################
 function tests_gcc_debug_cpp14_valgrind_other() {
 	printf "\n$(tput setaf 1)$(tput setab 7)BUILD ${FUNCNAME[0]} START$(tput sgr 0)\n"
-	build_gcc_debug_cpp14
+	build_gcc_debug_cpp14 ${TESTS_VALGRIND_UNWIND}
 	ctest -E "_none|_memcheck|_drd" --timeout ${TEST_TIMEOUT} --output-on-failure
 	ctest -R "_pmreorder" --timeout ${TEST_TIMEOUT} --output-on-failure
 	workspace_cleanup
@@ -210,7 +213,6 @@ function tests_gcc_release_cpp17_no_valgrind() {
 ###############################################################################
 # BUILD tests_clang_release_cpp20_no_valgrind llvm
 ###############################################################################
-
 function tests_clang_release_cpp20_no_valgrind() {
 	printf "\n$(tput setaf 1)$(tput setab 7)BUILD ${FUNCNAME[0]} START$(tput sgr 0)\n"