cmake: add USE_LIBUNWIND option to allow switching off that library

Author: lukaszstolarczuk

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