cmake: cleanups

- extend print messages,
- print warnings once per build, where possible,
- add more comments,
- fix minor todo's,
- add cache string for TBB_DIR.

Author: lukaszstolarczuk

CMakeLists.txt

@@ -2,7 +2,9 @@
 # Copyright 2018-2021, Intel Corporation
 
 cmake_minimum_required(VERSION 3.3)
+
 project(libpmemobj-cpp C CXX)
+set(LIBPMEMOBJCPP_ROOT_DIR ${CMAKE_CURRENT_SOURCE_DIR})
 
 # ----------------------------------------------------------------- #
 ## Set required and useful variables
@@ -19,27 +21,11 @@ if(VERSION_PRERELEASE)
 	set(VERSION ${VERSION}-${VERSION_PRERELEASE})
 endif()
 
-set(LIBPMEMOBJCPP_ROOT_DIR ${CMAKE_CURRENT_SOURCE_DIR})
-set(LIBPMEMOBJ_REQUIRED_VERSION 1.9)
-set(LIBPMEM_REQUIRED_VERSION 1.7)
-# Only pmreorder in ver. >= 1.9 guarantees reliable output
-set(PMREORDER_REQUIRED_VERSION 1.9)
-
-set(CMAKE_DISABLE_IN_SOURCE_BUILD ON)
+set(CXX_STANDARD 14 CACHE STRING "C++ language standard")
 
-# Treat CMAKE_CXX_STANDARD as a requirement
 set(CXX_STANDARD_REQUIRED ON)
-
-set(CXX_STANDARD 14 CACHE STRING "C++ language standard")
 set(CMAKE_CXX_STANDARD ${CXX_STANDARD})
 
-# Do not treat include directories from the interfaces
-# of consumed Imported Targets as SYSTEM by default.
-set(CMAKE_NO_SYSTEM_FROM_IMPORTED 1)
-
-set(TEST_DIR ${CMAKE_CURRENT_BINARY_DIR}/test CACHE STRING "working directory for tests")
-message(STATUS "TEST_DIR set to: \"${TEST_DIR}\"")
-
 # Specify and print the build type
 set(DEFAULT_BUILD_TYPE "RelWithDebInfo")
 set(predefined_build_types
@@ -59,7 +45,23 @@ else()
 	endif()
 endif()
 
+include(${LIBPMEMOBJCPP_ROOT_DIR}/cmake/functions.cmake)
+# set SRCVERSION, it's more accurate and "current" than VERSION
+set_source_ver(SRCVERSION)
+
 set(CMAKE_MODULE_PATH ${CMAKE_MODULE_PATH} ${LIBPMEMOBJCPP_ROOT_DIR}/cmake)
+set(CMAKE_DISABLE_IN_SOURCE_BUILD ON)
+set(LIBPMEMOBJ_REQUIRED_VERSION 1.9)
+set(LIBPMEM_REQUIRED_VERSION 1.7)
+# Only pmreorder in ver. >= 1.9 guarantees reliable output
+set(PMREORDER_REQUIRED_VERSION 1.9)
+
+set(TEST_DIR ${CMAKE_CURRENT_BINARY_DIR}/test CACHE STRING "working directory for tests")
+message(STATUS "TEST_DIR set to: \"${TEST_DIR}\"")
+
+# Do not treat include directories from the interfaces
+# of consumed Imported Targets as SYSTEM by default.
+set(CMAKE_NO_SYSTEM_FROM_IMPORTED 1)
 
 # ----------------------------------------------------------------- #
 ## CMake build options
@@ -110,9 +112,11 @@ include(CheckCXXSourceCompiles)
 include(CheckCXXCompilerFlag)
 include(GNUInstallDirs)
 
-include(${LIBPMEMOBJCPP_ROOT_DIR}/cmake/functions.cmake)
-# set SRCVERSION, it's more accurate and "current" than VERSION
-set_source_ver(SRCVERSION)
+# Configure the ccache as compiler launcher
+find_program(CCACHE_FOUND ccache)
+if(USE_CCACHE AND CCACHE_FOUND)
+	set_property(GLOBAL PROPERTY RULE_LAUNCH_COMPILE ccache)
+endif()
 
 if(WIN32)
 	# Required for MSVC to correctly define __cplusplus
@@ -123,20 +127,16 @@ if(NOT WIN32)
 	find_package(PkgConfig QUIET)
 endif()
 
-# Configure the ccache as compiler launcher
-find_program(CCACHE_FOUND ccache)
-if(USE_CCACHE AND CCACHE_FOUND)
-	set_property(GLOBAL PROPERTY RULE_LAUNCH_COMPILE ccache)
-endif()
-
-# Find Valgrind
+# Finds valgrind and checks for pmemcheck's availability
 if(PKG_CONFIG_FOUND)
 	pkg_check_modules(VALGRIND QUIET valgrind)
 else()
 	find_package(VALGRIND QUIET)
 endif()
 
 if(VALGRIND_FOUND)
+	message(STATUS "Found Valgrind in '${VALGRIND_LIBRARY_DIRS}' (version: ${VALGRIND_VERSION})")
+
 	add_flag(-DLIBPMEMOBJ_CPP_VG_MEMCHECK_ENABLED=1)
 	add_flag(-DLIBPMEMOBJ_CPP_VG_DRD_ENABLED=1)
 	add_flag(-DLIBPMEMOBJ_CPP_VG_HELGRIND_ENABLED=1)
@@ -314,7 +314,7 @@ endif()
 if(BUILD_EXAMPLES AND NO_GCC_VARIADIC_TEMPLATE_BUG)
 	add_subdirectory(examples)
 elseif(BUILD_EXAMPLES)
-	message(WARNING "Skipping building of examples because of compiler issue")
+	message(WARNING "Skipping building of examples because of gcc variadic template bug")
 endif()
 
 if(NOT "${CPACK_GENERATOR}" STREQUAL "")

cmake/functions.cmake

@@ -2,9 +2,10 @@
 # Copyright 2018-2021, Intel Corporation
 
 #
-# functions.cmake - helper functions for CMakeLists.txt
+# functions.cmake - helper functions for top-level CMakeLists.txt
 #
 
+# join all ${VALUES} into an ${OUT} string, split with custom ${SEP}arator
 function(join SEP OUT VALUES)
 	string(REPLACE ";" "${SEP}" JOIN_TMP "${VALUES}")
 	set(${OUT} "${JOIN_TMP}" PARENT_SCOPE)

cmake/packages.cmake

@@ -8,12 +8,12 @@
 string(TOUPPER "${CPACK_GENERATOR}" CPACK_GENERATOR)
 
 if(NOT ("${CPACK_GENERATOR}" STREQUAL "DEB" OR
-	"${CPACK_GENERATOR}" STREQUAL "RPM"))
+		"${CPACK_GENERATOR}" STREQUAL "RPM"))
 	message(FATAL_ERROR "Wrong CPACK_GENERATOR value, valid generators are: DEB, RPM")
 endif()
 
 set(CPACK_PACKAGING_INSTALL_PREFIX "${CMAKE_INSTALL_PREFIX}")
-set(CMAKE_INSTALL_TMPDIR /tmp CACHE PATH "Output dir for tmp")
+set(CMAKE_INSTALL_TMPDIR /tmp CACHE PATH "Output dir for temporary package")
 set(CPACK_COMPONENTS_ALL_IN_ONE)
 
 # Filter out some of directories from %dir section, which are expected

cmake/tbb.cmake

@@ -1,6 +1,7 @@
 # SPDX-License-Identifier: BSD-3-Clause
 # Copyright 2017-2021, Intel Corporation
 
+set(TBB_DIR "" CACHE PATH "dir with TBBConfig.cmake, to be set if using custom TBB installation")
 message(STATUS "Checking for module 'tbb'")
 
 # TBB was found without pkg-config:

examples/CMakeLists.txt

@@ -1,6 +1,17 @@
 # SPDX-License-Identifier: BSD-3-Clause
 # Copyright 2018-2021, Intel Corporation
 
+#
+# examples/CMakeLists.txt - CMake file for building all examples along with
+#	the current libpmemobj-cpp sources, for verification purposes.
+#	To build an example as a standalone application (with libpmemobj-cpp
+#	from the system) see a CMake file in any of the subdirectories.
+#
+add_custom_target(examples)
+
+# ----------------------------------------------------------------- #
+## Setup examples
+# ----------------------------------------------------------------- #
 if(MSVC_VERSION)
 	add_flag(-W2)
 	add_flag("-D_FORTIFY_SOURCE=2" RELEASE)
@@ -30,11 +41,10 @@ if(COVERAGE)
 	set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -coverage")
 endif()
 
-add_custom_target(examples)
-
 include_directories(${LIBPMEMOBJ_INCLUDE_DIRS} .)
 link_directories(${LIBPMEMOBJ_LIBRARY_DIRS})
 
+# Add developer checks
 add_cppstyle(examples-common ${CMAKE_CURRENT_SOURCE_DIR}/*.hpp)
 add_check_whitespace(examples-common ${CMAKE_CURRENT_SOURCE_DIR}/*.*)
 
@@ -101,14 +111,7 @@ add_check_whitespace(examples-inline_string ${CMAKE_CURRENT_SOURCE_DIR}/inline_s
 add_cppstyle(examples-radix_tree ${CMAKE_CURRENT_SOURCE_DIR}/radix_tree/*.*pp)
 add_check_whitespace(examples-radix_tree ${CMAKE_CURRENT_SOURCE_DIR}/radix_tree/*.*)
 
-function(add_example name)
-	set(srcs ${ARGN})
-	prepend(srcs ${CMAKE_CURRENT_SOURCE_DIR} ${srcs})
-	add_executable(example-${name} ${srcs})
-	target_link_libraries(example-${name} ${LIBPMEMOBJ_LIBRARIES} ${CMAKE_THREAD_LIBS_INIT})
-	add_dependencies(examples example-${name})
-endfunction()
-
+# Find required packages for examples
 if(PKG_CONFIG_FOUND)
 	pkg_check_modules(CURSES QUIET ncurses)
 else()
@@ -126,6 +129,17 @@ else()
 	set(SFML_LIBRARIES sfml-graphics sfml-window sfml-system)
 endif()
 
+function(add_example name)
+	set(srcs ${ARGN})
+	prepend(srcs ${CMAKE_CURRENT_SOURCE_DIR} ${srcs})
+	add_executable(example-${name} ${srcs})
+	target_link_libraries(example-${name} ${LIBPMEMOBJ_LIBRARIES} ${CMAKE_THREAD_LIBS_INIT})
+	add_dependencies(examples example-${name})
+endfunction()
+
+# ----------------------------------------------------------------- #
+## Add examples (some under the 'if', required for specific example)
+# ----------------------------------------------------------------- #
 if(TEST_ARRAY)
 	add_example(queue queue/queue.cpp)
 endif()

tests/CMakeLists.txt

@@ -8,9 +8,6 @@ include(ctest_helpers.cmake)
 # ----------------------------------------------------------------- #
 add_custom_target(tests)
 
-# Try to find it for some tests using TBB
-include(tbb)
-
 # Add checks when DEVELOPER_MODE is ON
 add_cppstyle(tests-common ${CMAKE_CURRENT_SOURCE_DIR}/common/*.*pp
 						  ${CMAKE_CURRENT_SOURCE_DIR}/*.c
@@ -78,9 +75,11 @@ if(COVERAGE)
 	set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -coverage")
 endif()
 
-# Prepare additional libraries/executables and finding required packages
+# Prepare additional libraries/executables and find packages required for tests
 find_packages()
-find_gdb()
+
+# Try to find it for some tests using TBB
+include(tbb)
 
 add_library(test_backtrace STATIC test_backtrace.c)
 if(LIBUNWIND_FOUND)
@@ -107,6 +106,10 @@ if(NOT GDB_FOUND)
 	message(WARNING "GDB was not found - skipping some tests. To fix, make sure `gdb` command is OS-wide accessible.")
 endif()
 
+if(NOT PMREORDER_SUPPORTED)
+	message(WARNING "Skipping pmreorder tests because of no pmreorder support")
+endif()
+
 # ----------------------------------------------------------------- #
 ## Tests
 # ----------------------------------------------------------------- #
@@ -134,7 +137,6 @@ if(BUILD_EXAMPLES AND NO_GCC_VARIADIC_TEMPLATE_BUG)
 		add_test_generic(NAME ex-pman CASE 0 TRACERS none SCRIPT ex-pman/ex-pman_0.cmake)
 	endif()
 elseif(BUILD_EXAMPLES)
-	message(WARNING "Skipping examples tests because of gcc variadic template bug")
 	skip_test("examples_tests" "SKIPPED_BECAUSE_OF_GCC_VARIADIC_TEMPLATE_BUG")
 endif()
 
@@ -345,8 +347,6 @@ if(TEST_ARRAY)
 		build_test(array_slice_pmreorder array/array_slice_pmreorder.cpp)
 		add_test_generic(NAME array_slice_pmreorder CASE 0 TRACERS none SCRIPT array/array_slice_pmreorder_0.cmake)
 		add_test_generic(NAME array_slice_pmreorder CASE 1 TRACERS none SCRIPT array/array_slice_pmreorder_1.cmake)
-	else()
-		message(WARNING "Skipping pmreorder tests because of no pmreorder support")
 	endif()
 endif()
 ################################################################################
@@ -647,8 +647,6 @@ if(TEST_CONCURRENT_HASHMAP)
 				add_test_generic(NAME ${TEST} CASE ${case} TRACERS none)
 			endforeach()
 		endif()
-	else()
-		message(WARNING "Skipping pmreorder tests because of no pmreorder support")
 	endif()
 endif()
 ################################################################################
@@ -953,11 +951,7 @@ if(TEST_CONCURRENT_MAP)
 				configure_file("${CMAKE_SCRIPT}.cmake.in" "${CMAKE_SCRIPT}_${case}.cmake" @ONLY)
 				add_test_generic(NAME ${TEST} CASE ${case} TRACERS none)
 			endforeach()
-		else()
-			message(WARNING "Skipping concurrent_map_pmreorder_break_insert test because GDB was not found")
 		endif()
-	else()
-		message(WARNING "Skipping pmreorder tests because of no pmreorder support")
 	endif()
 endif()
 ################################################################################