Merge pull request #905 from lukaszstolarczuk/cleanup-cmake

cleanups in CMake files

Author: igchor

CMakeLists.txt

@@ -4,16 +4,17 @@
 cmake_minimum_required(VERSION 3.3)
 project(libpmemobj-cpp C CXX)
 
+## Set required and useful variables
 set(VERSION_MAJOR 1)
 set(VERSION_MINOR 11)
 set(VERSION_PATCH 0)
 #set(VERSION_PRERELEASE rc3)
 
 set(VERSION ${VERSION_MAJOR}.${VERSION_MINOR})
-if (VERSION_PATCH GREATER 0)
+if(VERSION_PATCH GREATER 0)
 	set(VERSION ${VERSION}.${VERSION_PATCH})
 endif()
-if (VERSION_PRERELEASE)
+if(VERSION_PRERELEASE)
 	set(VERSION ${VERSION}-${VERSION_PRERELEASE})
 endif()
 
@@ -30,15 +31,37 @@ set(CXX_STANDARD_REQUIRED ON)
 set(CXX_STANDARD 14 CACHE STRING "C++ language standard")
 set(CMAKE_CXX_STANDARD ${CXX_STANDARD})
 
-include(FindPerl)
-include(FindThreads)
-include(CMakeDependentOption)
-include(CMakePackageConfigHelpers)
-include(CheckCXXSourceCompiles)
-include(CheckCXXCompilerFlag)
-include(GNUInstallDirs)
-include(${CMAKE_SOURCE_DIR}/cmake/functions.cmake)
+# 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")
+
+if(NOT CMAKE_BUILD_TYPE)
+	set(CMAKE_BUILD_TYPE "Debug")
+endif()
 
+set(CMAKE_MODULE_PATH ${CMAKE_MODULE_PATH} ${CMAKE_SOURCE_DIR}/cmake)
+
+# XXX: use it in version.hpp and in Doxygen.in
+# Set ${SRCVERSION}
+if(EXISTS "${CMAKE_SOURCE_DIR}/.git")
+	execute_process(COMMAND git describe
+			OUTPUT_VARIABLE SRCVERSION
+			WORKING_DIRECTORY ${CMAKE_SOURCE_DIR}
+			OUTPUT_STRIP_TRAILING_WHITESPACE
+			ERROR_QUIET)
+	if(NOT SRCVERSION)
+		execute_process(COMMAND git log -1 --format=%h
+				OUTPUT_VARIABLE SRCVERSION
+				WORKING_DIRECTORY ${CMAKE_SOURCE_DIR}
+				OUTPUT_STRIP_TRAILING_WHITESPACE)
+	endif()
+else()
+	file(STRINGS ${CMAKE_SOURCE_DIR}/.version SRCVERSION)
+endif()
+
+## CMake build options
 option(BUILD_EXAMPLES "build examples" ON)
 option(BUILD_TESTS "build tests" ON)
 option(BUILD_DOC "build documentation" ON)
@@ -52,11 +75,11 @@ option(USE_ASAN "enable AddressSanitizer (debugging)" OFF)
 option(USE_UBSAN "enable UndefinedBehaviorSanitizer (debugging)" OFF)
 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" OFF)
+option(TESTS_USE_FORCED_PMEM "run tests with PMEM_IS_PMEM_FORCE=1 - it speeds up tests execution on emulated pmem" OFF)
 option(TESTS_USE_VALGRIND "enable tests with valgrind (if found)" ON)
 option(TESTS_PMREORDER "enable tests with pmreorder (if pmreorder found; it requires PMDK ver. >= 1.9)" OFF)
-option(TESTS_CONCURRENT_HASH_MAP_DRD_HELGRIND "enable concurrent_hash_map tests with drd and helgrind (can only be run on PMEM)." OFF)
-option(TESTS_CONCURRENT_GDB "enable concurrent gdb tests - require 'set scheduler-locking on' support (OS dependent) " OFF)
+option(TESTS_CONCURRENT_HASH_MAP_DRD_HELGRIND "enable concurrent_hash_map tests with drd and helgrind (can only be run on PMEM)" OFF)
+option(TESTS_CONCURRENT_GDB "enable concurrent gdb tests - require 'set scheduler-locking on' support (OS dependent)" OFF)
 option(TESTS_LONG "enable long running tests" OFF)
 option(TESTS_TBB "enable tests which require TBB" OFF)
 option(TESTS_COMPATIBILITY "enable compatibility tests (requires internet connection)" OFF)
@@ -68,7 +91,7 @@ option(TEST_CONCURRENT_HASHMAP "enable testing of pmem::obj::concurrent_hash_map
 option(TEST_SEGMENT_VECTOR_ARRAY_EXPSIZE "enable testing of pmem::obj::segment_vector with array as segment_vector_type and exponential_size_policy" ON)
 option(TEST_SEGMENT_VECTOR_VECTOR_EXPSIZE "enable testing of pmem::obj::segment_vector with vector as segment_vector_type and exponential_size_policy" ON)
 option(TEST_SEGMENT_VECTOR_VECTOR_FIXEDSIZE "enable testing of pmem::obj::segment_vector with vector as segment_vector_type and fixed_size_policy" ON)
-option(TEST_ENUMERABLE_THREAD_SPECIFIC "enable testing of pmem::obj::experimental::enumerable_thread_specific" ON)
+option(TEST_ENUMERABLE_THREAD_SPECIFIC "enable testing of pmem::obj::enumerable_thread_specific" ON)
 option(TEST_CONCURRENT_MAP "enable testing of pmem::obj::experimental::concurrent_map (depends on TEST_STRING)" ON)
 option(TEST_SELF_RELATIVE_POINTER "enable testing of pmem::obj::experimental::self_relative_ptr" ON)
 option(TEST_RADIX_TREE "enable testing of pmem::obj::experimental::radix_tree" ON)
@@ -80,60 +103,52 @@ option(INSTALL_CONCURRENT_HASHMAP "enable installation of pmem::obj::concurrent_
 option(INSTALL_SEGMENT_VECTOR "enable installation of pmem::obj::segment_vector" ON)
 option(INSTALL_CONCURRENT_MAP "enable installation of pmem::obj::experimental::concurrent_map (depends on INSTALL_STRING)" ON)
 option(INSTALL_SELF_RELATIVE_POINTER "enable installation of pmem::obj::experimental::self_relative_ptr" ON)
-option(INSTALL_RADIX_TREE "enable testing of pmem::obj::experimental::radix_tree" ON)
-
-# 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()
+option(INSTALL_RADIX_TREE "enable installation of pmem::obj::experimental::radix_tree" ON)
 
-# Do not treat include directories from the interfaces
-# of consumed Imported Targets as SYSTEM by default.
-set(CMAKE_NO_SYSTEM_FROM_IMPORTED 1)
+## Setup environment, find packages, set compiler's flags, add additional custom targets
+include(FindPerl)
+include(FindThreads)
+include(CMakeDependentOption)
+include(CMakePackageConfigHelpers)
+include(CheckCXXSourceCompiles)
+include(CheckCXXCompilerFlag)
+include(GNUInstallDirs)
+include(${CMAKE_SOURCE_DIR}/cmake/functions.cmake)
 
 # Required for MSVC to correctly define __cplusplus
 add_flag("/Zc:__cplusplus")
 
-set(TEST_DIR ${CMAKE_CURRENT_BINARY_DIR}/test
-	CACHE STRING "working directory for tests")
+if(NOT WIN32)
+	find_package(PkgConfig QUIET)
+endif()
 
-if(NOT CMAKE_BUILD_TYPE)
-	set(CMAKE_BUILD_TYPE "Debug")
-endif (NOT CMAKE_BUILD_TYPE)
+# 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(EXISTS "${CMAKE_SOURCE_DIR}/.git")
-	execute_process(COMMAND git describe
-			OUTPUT_VARIABLE SRCVERSION
-			WORKING_DIRECTORY ${CMAKE_SOURCE_DIR}
-			OUTPUT_STRIP_TRAILING_WHITESPACE
-			ERROR_QUIET)
-	if(NOT SRCVERSION)
-		execute_process(COMMAND git log -1 --format=%h
-				OUTPUT_VARIABLE SRCVERSION
-				WORKING_DIRECTORY ${CMAKE_SOURCE_DIR}
-				OUTPUT_STRIP_TRAILING_WHITESPACE)
-	endif()
+# Find Valgrind
+if(PKG_CONFIG_FOUND)
+	pkg_check_modules(VALGRIND QUIET valgrind)
 else()
-	execute_process(COMMAND cat .version
-			OUTPUT_VARIABLE SRCVERSION
-			WORKING_DIRECTORY ${CMAKE_SOURCE_DIR}
-			OUTPUT_STRIP_TRAILING_WHITESPACE)
+	find_package(VALGRIND QUIET)
 endif()
 
-if(NOT WIN32)
-	find_package(PkgConfig QUIET)
-endif()
+if(VALGRIND_FOUND)
+	add_flag(-DLIBPMEMOBJ_CPP_VG_MEMCHECK_ENABLED=1)
+	add_flag(-DLIBPMEMOBJ_CPP_VG_DRD_ENABLED=1)
+	add_flag(-DLIBPMEMOBJ_CPP_VG_HELGRIND_ENABLED=1)
 
-set(CMAKE_MODULE_PATH ${CMAKE_MODULE_PATH} ${CMAKE_SOURCE_DIR}/cmake)
+	include_directories(${VALGRIND_INCLUDE_DIRS})
+	find_pmemcheck()
 
-if(NOT PERL_FOUND)
-	message(FATAL_ERROR "Perl not found")
-endif()
-if (PERL_VERSION_STRING VERSION_LESS 5.16)
-	message(FATAL_ERROR "Too old Perl (<5.16)")
+	if(VALGRIND_PMEMCHECK_FOUND)
+		add_flag(-DLIBPMEMOBJ_CPP_VG_PMEMCHECK_ENABLED=1)
+	endif()
 endif()
 
+# XXX: move under if(BUILD_TESTS)
 # Some tests and examples require clang >= 8.0
 # because of the following bug:
 # https://bugs.llvm.org/show_bug.cgi?id=28280
@@ -159,27 +174,7 @@ if(BUILD_TESTS OR BUILD_EXAMPLES OR BUILD_BENCHMARKS)
 		find_package(LIBPMEM REQUIRED ${LIBPMEM_REQUIRED_VERSION})
 	endif()
 
-	if (LIBPMEMOBJ_VERSION AND LIBPMEMOBJ_VERSION MATCHES "[0-9]+[.][0-9]+.*")
-		string(REGEX REPLACE "\\+git.*" "" LIBPMEMOBJ_VERSION_SHORT ${LIBPMEMOBJ_VERSION})
-		string(REGEX REPLACE "-rc.*" "" LIBPMEMOBJ_VERSION_SHORT ${LIBPMEMOBJ_VERSION_SHORT})
-		string(REPLACE "." ";" VERSION_LIST ${LIBPMEMOBJ_VERSION_SHORT})
-		list(GET VERSION_LIST 0 LIBPMEMOBJ_VERSION_MAJOR)
-		list(GET VERSION_LIST 1 LIBPMEMOBJ_VERSION_MINOR)
-		list(LENGTH VERSION_LIST OBJ_VER_COMPS)
-		if (${OBJ_VER_COMPS} LESS 3)
-			list(APPEND VERSION_LIST "0")
-		endif()
-		list(GET VERSION_LIST 2 LIBPMEMOBJ_VERSION_PATCH)
-	else()
-		message(WARNING "cannot detect libpmemobj version, some tests will be skipped")
-		# assume 0.0.0
-		set(LIBPMEMOBJ_VERSION_MAJOR 0)
-		set(LIBPMEMOBJ_VERSION_MINOR 0)
-		set(LIBPMEMOBJ_VERSION_PATCH 0)
-	endif()
-
-	math(EXPR LIBPMEMOBJ_VERSION_NUM "${LIBPMEMOBJ_VERSION_PATCH} + ${LIBPMEMOBJ_VERSION_MINOR} * 100 + ${LIBPMEMOBJ_VERSION_MAJOR} * 10000")
-
+	# XXX: required by tests only?
 	include(tbb)
 endif()
 
@@ -189,18 +184,8 @@ add_custom_target(cppformat)
 add_custom_target(check-whitespace)
 add_custom_target(check-license
 	COMMAND ${CMAKE_SOURCE_DIR}/utils/check_license/check-headers.sh
-		${CMAKE_SOURCE_DIR}
-		BSD-3-Clause)
-
-add_custom_target(check-whitespace-main
-		COMMAND ${PERL_EXECUTABLE}
-			${CMAKE_SOURCE_DIR}/utils/check_whitespace
-			${CMAKE_SOURCE_DIR}/utils/check_license/*.sh
-			${CMAKE_SOURCE_DIR}/README.md)
-
-add_dependencies(check-whitespace check-whitespace-main)
-
-add_custom_target(tests)
+			${CMAKE_SOURCE_DIR}
+			BSD-3-Clause)
 
 if(CHECK_CPP_STYLE)
 	find_program(CLANG_FORMAT NAMES clang-format clang-format-9 clang-format-9.0)
@@ -214,31 +199,44 @@ if(CHECK_CPP_STYLE)
 	else()
 		message(FATAL_ERROR "CHECK_CPP_STYLE=ON, but clang-format not found (required version: ${CLANG_FORMAT_REQUIRED})")
 	endif()
+
+	add_dependencies(checkers cppstyle)
 endif()
 
 if(DEVELOPER_MODE)
+	# treat compiler warnings as errors
 	if(WIN32)
 		add_flag(-WX)
 	else()
 		add_flag(-Werror)
+
+		# check for required programs for whitespace and license checks and add dependencies to ALL
+		if(NOT PERL_FOUND)
+			message(FATAL_ERROR "Perl not found")
+		endif()
+		if(PERL_VERSION_STRING VERSION_LESS 5.16)
+			message(FATAL_ERROR "Too old Perl (<5.16)")
+		endif()
 		execute_process(COMMAND ${PERL_EXECUTABLE} -MText::Diff -e ""
-				ERROR_QUIET
-				RESULT_VARIABLE PERL_TEXT_DIFF_STATUS)
-		if (PERL_TEXT_DIFF_STATUS)
+						ERROR_QUIET
+						RESULT_VARIABLE PERL_TEXT_DIFF_STATUS)
+		if(PERL_TEXT_DIFF_STATUS)
 			message(FATAL_ERROR "Text::Diff Perl module not found (install libtext-diff-perl or perl-Text-Diff)")
 		endif()
 
-		add_dependencies(checkers cppstyle)
 		add_dependencies(checkers check-whitespace)
 		add_dependencies(checkers check-license)
 	endif()
-endif(DEVELOPER_MODE)
+endif()
 
 add_cppstyle(include ${CMAKE_CURRENT_SOURCE_DIR}/include/libpmemobj++/*.hpp)
 add_cppstyle(include-container ${CMAKE_CURRENT_SOURCE_DIR}/include/libpmemobj++/container/*.hpp)
 add_cppstyle(include-container-detail ${CMAKE_CURRENT_SOURCE_DIR}/include/libpmemobj++/container/detail/*.hpp)
 add_cppstyle(include-detail ${CMAKE_CURRENT_SOURCE_DIR}/include/libpmemobj++/detail/*.hpp)
 add_cppstyle(include-experimental ${CMAKE_CURRENT_SOURCE_DIR}/include/libpmemobj++/experimental/*.hpp)
+
+add_check_whitespace(main ${CMAKE_SOURCE_DIR}/utils/check_license/*.sh
+						${CMAKE_SOURCE_DIR}/README.md)
 add_check_whitespace(include ${CMAKE_CURRENT_SOURCE_DIR}/include/libpmemobj++/*.hpp)
 add_check_whitespace(include-container ${CMAKE_CURRENT_SOURCE_DIR}/include/libpmemobj++/container/*.hpp)
 add_check_whitespace(include-container-detail ${CMAKE_CURRENT_SOURCE_DIR}/include/libpmemobj++/container/detail/*.hpp)
@@ -247,6 +245,7 @@ add_check_whitespace(include-experimental ${CMAKE_CURRENT_SOURCE_DIR}/include/li
 add_check_whitespace(cmake-main ${CMAKE_CURRENT_SOURCE_DIR}/CMakeLists.txt)
 add_check_whitespace(cmake-helpers ${CMAKE_CURRENT_SOURCE_DIR}/cmake/*.cmake)
 
+## Configure make install/uninstall and packages
 configure_file(${CMAKE_SOURCE_DIR}/cmake/version.hpp.in
 		${CMAKE_SOURCE_DIR}/include/libpmemobj++/version.hpp @ONLY)
 
@@ -316,7 +315,6 @@ if(INSTALL_RADIX_TREE)
 	install(DIRECTORY include/ DESTINATION ${CMAKE_INSTALL_INCLUDEDIR} FILES_MATCHING PATTERN "radix_tree.hpp")
 endif()
 
-
 install(DIRECTORY examples/ DESTINATION ${CMAKE_INSTALL_DOCDIR}/examples
 	FILES_MATCHING PATTERN "*.*pp")
 
@@ -346,29 +344,17 @@ write_basic_package_version_file(libpmemobj++-config-version.cmake
 install(FILES ${CMAKE_CURRENT_BINARY_DIR}/libpmemobj++-config.cmake ${CMAKE_CURRENT_BINARY_DIR}/libpmemobj++-config-version.cmake
 	DESTINATION ${CMAKE_INSTALL_LIBDIR}/libpmemobj++/cmake)
 
+
+# set up project's include dir (our source 'include' dir)
 include_directories(include)
 
+# Run checks for known issues, it's required to enable/disable some tests and examples.
+# It has to be executed (included) here, when environment is fully set up,
+# all packages are found and all paths/variables are set.
 include(${CMAKE_SOURCE_DIR}/cmake/check_compiling_issues.cmake)
 
-if(PKG_CONFIG_FOUND)
-	pkg_check_modules(VALGRIND QUIET valgrind)
-else()
-	find_package(VALGRIND QUIET)
-endif()
-
-if(VALGRIND_FOUND)
-	add_flag(-DLIBPMEMOBJ_CPP_VG_MEMCHECK_ENABLED=1)
-	add_flag(-DLIBPMEMOBJ_CPP_VG_DRD_ENABLED=1)
-	add_flag(-DLIBPMEMOBJ_CPP_VG_HELGRIND_ENABLED=1)
-
-	include_directories(${VALGRIND_INCLUDE_DIRS})
-	find_pmemcheck()
-
-	if(VALGRIND_PMEMCHECK_FOUND)
-		add_flag(-DLIBPMEMOBJ_CPP_VG_PMEMCHECK_ENABLED=1)
-	endif()
-endif()
 
+## Add/include sub-directories if build options enabled them
 if(BUILD_TESTS)
 	if(TEST_DIR)
 		enable_testing()
@@ -383,14 +369,14 @@ if(BUILD_DOC)
 	add_subdirectory(doc)
 endif()
 
-if (BUILD_BENCHMARKS)
+if(BUILD_BENCHMARKS)
 	add_subdirectory(benchmarks)
 endif()
 
 if(BUILD_EXAMPLES AND NO_GCC_VARIADIC_TEMPLATE_BUG)
 	add_subdirectory(examples)
 elseif(BUILD_EXAMPLES)
-	message(WARNING "Skipping build of examples because of compiler issue")
+	message(WARNING "Skipping building of examples because of compiler issue")
 endif()
 
 if(NOT "${CPACK_GENERATOR}" STREQUAL "")