diff options
Diffstat (limited to 'CMakeVOL.cmake')
| -rw-r--r-- | CMakeVOL.cmake | 180 |
1 files changed, 180 insertions, 0 deletions
diff --git a/CMakeVOL.cmake b/CMakeVOL.cmake new file mode 100644 index 0000000..a5f499e --- /dev/null +++ b/CMakeVOL.cmake @@ -0,0 +1,180 @@ +# +# Copyright by The HDF Group. +# All rights reserved. +# +# This file is part of HDF5. The full HDF5 copyright notice, including +# terms governing use, modification, and redistribution, is contained in +# the COPYING file, which can be found at the root of the source code +# distribution tree, or in https://www.hdfgroup.org/licenses. +# If you do not have access to either file, you may request a copy from +# help@hdfgroup.org. +# + +include (FetchContent) + +# Function to retrieve all of the CMake targets generated +# in a directory and all its subdirectories +function (get_generated_cmake_targets out_var dir) + get_directory_property (dir_targets DIRECTORY "${dir}" BUILDSYSTEM_TARGETS) + get_directory_property (dir_subdirs DIRECTORY "${dir}" SUBDIRECTORIES) + + foreach (subdir ${dir_subdirs}) + get_generated_cmake_targets(subdir_targets "${subdir}") + list (APPEND dir_targets "${subdir_targets}") + endforeach() + + set (${out_var} "${dir_targets}" PARENT_SCOPE) +endfunction () + +# For now, only support building of external VOL connectors with FetchContent +option (HDF5_VOL_ALLOW_EXTERNAL "Allow building of external HDF5 VOL connectors with FetchContent" OFF) +mark_as_advanced (HDF5_VOL_ALLOW_EXTERNAL) +if (HDF5_VOL_ALLOW_EXTERNAL) + if (HDF5_ALLOW_EXTERNAL_SUPPORT MATCHES "NO" OR NOT HDF5_ALLOW_EXTERNAL_SUPPORT MATCHES "GIT") + message (FATAL_ERROR "HDF5_ALLOW_EXTERNAL_SUPPORT must be set to 'GIT' to allow building of external HDF5 VOL connectors") + endif () + + # For compatibility, set some variables that projects would + # typically look for after calling find_package(HDF5) + set (HDF5_FOUND 1) + set (HDF5_LIBRARIES "${HDF5_LIBSH_TARGET};${LINK_LIBS};${LINK_COMP_LIBS};$<$<BOOL:${HDF5_ENABLE_PARALLEL}>:MPI::MPI_C>") + set (HDF5_INCLUDE_DIRS "${HDF5_SRC_INCLUDE_DIRS};${HDF5_SRC_BINARY_DIR};$<$<BOOL:${HDF5_ENABLE_PARALLEL}>:${MPI_C_INCLUDE_DIRS}>") + + set (HDF5_MAX_EXTERNAL_VOLS 10) + set (HDF5_EXTERNAL_VOL_TARGETS "") + + foreach (vol_idx RANGE 1 ${HDF5_MAX_EXTERNAL_VOLS}) + # Generate fixed-width index number prepended with 0s + # so URLs come in order from 1 - HDF5_MAX_EXTERNAL_VOLS + set (vol_idx_num_digits 2) # Based on HDF5_MAX_EXTERNAL_VOLS + set (vol_idx_fixed "${vol_idx}") + string (LENGTH "${vol_idx_fixed}" vol_idx_len) + while (vol_idx_len LESS vol_idx_num_digits) + string (PREPEND vol_idx_fixed "0") + math (EXPR vol_idx_len "${vol_idx_len}+1") + endwhile () + + set (HDF5_VOL_URL${vol_idx_fixed} "" CACHE STRING "Git repository URL of an external HDF5 VOL connector to build") + mark_as_advanced (HDF5_VOL_URL${vol_idx_fixed}) + + if (NOT "${HDF5_VOL_URL${vol_idx_fixed}}" STREQUAL "") + # Extract the name of the VOL connector + string (FIND "${HDF5_VOL_URL${vol_idx_fixed}}" "/" hdf5_vol_name_pos REVERSE) + if (hdf5_vol_name_pos EQUAL -1) + message (SEND_ERROR "Invalid URL '${HDF5_VOL_URL${vol_idx_fixed}}' specified for HDF5_VOL_URL${vol_idx_fixed}") + endif () + + math (EXPR hdf5_vol_name_pos "${hdf5_vol_name_pos}+1") + + string (SUBSTRING "${HDF5_VOL_URL${vol_idx_fixed}}" ${hdf5_vol_name_pos} -1 hdf5_vol_name) + string (REPLACE ".git" "" hdf5_vol_name "${hdf5_vol_name}") + string (STRIP "${hdf5_vol_name}" hdf5_vol_name) + string (TOUPPER "${hdf5_vol_name}" hdf5_vol_name_upper) + string (TOLOWER "${hdf5_vol_name}" hdf5_vol_name_lower) + + message (VERBOSE "Building VOL connector '${hdf5_vol_name}' with FetchContent") + + # Set some cache variables that can be set by users when building + set ("HDF5_VOL_${hdf5_vol_name_upper}_NAME" "" CACHE STRING "Name of VOL connector to set for the HDF5_VOL_CONNECTOR environment variable") + set ("HDF5_VOL_${hdf5_vol_name_upper}_BRANCH" "main" CACHE STRING "Git branch (or tag) to use when building VOL connector '${hdf5_vol_name}'") + option ("HDF5_VOL_${hdf5_vol_name_upper}_TEST_PARALLEL" "Whether to test VOL connector '${hdf5_vol_name}' against the parallel API tests" OFF) + + mark_as_advanced ("HDF5_VOL_${hdf5_vol_name_upper}_NAME") + mark_as_advanced ("HDF5_VOL_${hdf5_vol_name_upper}_BRANCH") + mark_as_advanced ("HDF5_VOL_${hdf5_vol_name_upper}_TEST_PARALLEL") + + if (HDF5_TEST_API) + if ("${HDF5_VOL_${hdf5_vol_name_upper}_NAME}" STREQUAL "") + message (SEND_ERROR "HDF5_VOL_${hdf5_vol_name_upper}_NAME must be set to a valid connector name to use VOL connector '${hdf5_vol_name}' for testing") + endif () + endif () + + if ("${HDF5_VOL_${hdf5_vol_name_upper}_BRANCH}" STREQUAL "") + message (SEND_ERROR "HDF5_VOL_${hdf5_vol_name_upper}_BRANCH must be set to a valid git branch name (or git tag) to build VOL connector '${hdf5_vol_name}'") + endif () + + FetchContent_Declare (HDF5_VOL_${hdf5_vol_name_lower} + GIT_REPOSITORY "${HDF5_VOL_URL${vol_idx_fixed}}" + GIT_TAG "${HDF5_VOL_${hdf5_vol_name_upper}_BRANCH}" + ) + + FetchContent_GetProperties(HDF5_VOL_${hdf5_vol_name_lower}) + if (NOT hdf5_vol_${hdf5_vol_name_lower}_POPULATED) + FetchContent_Populate(HDF5_VOL_${hdf5_vol_name_lower}) + + if (NOT EXISTS "${hdf5_vol_${hdf5_vol_name_lower}_SOURCE_DIR}/CMakeLists.txt") + message (SEND_ERROR "The git repository branch '${HDF5_VOL_${hdf5_vol_name_upper}_BRANCH}' for VOL connector '${hdf5_vol_name}' does not appear to contain a CMakeLists.txt file") + endif () + + # If there are any calls to find_package(HDF5) in the connector's + # CMakeLists.txt files, remove those since any found HDF5 targets + # will conflict with targets being generated by this build of HDF5 + if (EXISTS "${hdf5_vol_${hdf5_vol_name_lower}_SOURCE_DIR}/CMakeLists.txt") + file (READ "${hdf5_vol_${hdf5_vol_name_lower}_SOURCE_DIR}/CMakeLists.txt" vol_cmake_contents) + string (REGEX REPLACE "[ \t]*find_package[ \t]*\\([ \t]*HDF5[^\r\n\\)]*\\)[ \t]*[\r\n]+" "" vol_cmake_contents "${vol_cmake_contents}") + file (WRITE "${hdf5_vol_${hdf5_vol_name_lower}_SOURCE_DIR}/CMakeLists.txt" "${vol_cmake_contents}") + endif () + if (EXISTS "${hdf5_vol_${hdf5_vol_name_lower}_SOURCE_DIR}/src/CMakeLists.txt") + file (READ "${hdf5_vol_${hdf5_vol_name_lower}_SOURCE_DIR}/src/CMakeLists.txt" vol_cmake_contents) + string (REGEX REPLACE "[ \t]*find_package[ \t]*\\([ \t]*HDF5[^\r\n\\)]*\\)[ \t]*[\r\n]+" "" vol_cmake_contents "${vol_cmake_contents}") + file (WRITE "${hdf5_vol_${hdf5_vol_name_lower}_SOURCE_DIR}/src/CMakeLists.txt" "${vol_cmake_contents}") + endif () + + add_subdirectory (${hdf5_vol_${hdf5_vol_name_lower}_SOURCE_DIR} ${hdf5_vol_${hdf5_vol_name_lower}_BINARY_DIR}) + + # Get list of targets generated by build of connector + get_generated_cmake_targets (connector_targets ${hdf5_vol_${hdf5_vol_name_lower}_SOURCE_DIR}) + + # Create a custom target for the connector to encompass all its + # targets and other custom properties set by us for later use + add_custom_target ("HDF5_VOL_${hdf5_vol_name_lower}") + + # Define and set a custom property on the VOL connector target to + # capture all of the connector's generated targets + define_property ( + TARGET + PROPERTY HDF5_VOL_TARGETS + ) + + set_target_properties ( + "HDF5_VOL_${hdf5_vol_name_lower}" + PROPERTIES + HDF5_VOL_TARGETS "${connector_targets}" + ) + + # Define and set a custom property on the VOL connector target to + # capture the connector's name to set for the HDF5_VOL_CONNECTOR + # environment variable for testing + define_property ( + TARGET + PROPERTY HDF5_VOL_NAME + BRIEF_DOCS "VOL connector name to use for the HDF5_VOL_CONNECTOR environment variable when testing" + ) + + set_target_properties ( + "HDF5_VOL_${hdf5_vol_name_lower}" + PROPERTIES + HDF5_VOL_NAME "${HDF5_VOL_${hdf5_vol_name_upper}_NAME}" + ) + + # Define and set a custom property on the VOL connector target to + # capture whether the connector should be tested with the parallel + # API tests + define_property ( + TARGET + PROPERTY HDF5_VOL_TEST_PARALLEL + BRIEF_DOCS "Whether the VOL connector should be tested with the parallel API tests" + ) + + set_target_properties ( + "HDF5_VOL_${hdf5_vol_name_lower}" + PROPERTIES + HDF5_VOL_TEST_PARALLEL ${HDF5_VOL_${hdf5_vol_name_upper}_TEST_PARALLEL} + ) + + # Add this connector's target to the list of external connector targets + list (APPEND HDF5_EXTERNAL_VOL_TARGETS "HDF5_VOL_${hdf5_vol_name_lower}") + endif () + endif () + endforeach () +endif () |