Files
hdf5/config/HDF5Macros.cmake
Orion Poplawski 62701c4c79 Java JNI library changes (#6344)
* Allow setting HDF5_INSTALL_JNI_LIB_DIR to specify install location for the JNI shared library

* No library versioning for Java JNI
2026-04-10 06:41:43 -05:00

183 lines
7.2 KiB
CMake

#
# 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 LICENSE 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.
#
# -----------------------------------------------------------------------------
# HDF5Macros.cmake
#
# This CMake module defines macros for setting HDF5 library build options and
# managing Virtual File Driver (VFD) test configurations. It provides:
# - H5_SET_LIB_OPTIONS
# - H5_SET_VFD_LIST
# - H5_CREATE_VFD_DIR
#
# These macros help standardize and automate the configuration of HDF5 libraries
# and their test environments across different platforms and build types.
# -----------------------------------------------------------------------------
#-------------------------------------------------------------------------------
# H5_SET_LIB_OPTIONS: Macro to set library versioning, SOVERSION, and platform-
# specific install properties for HDF5 targets, including Apple and Windows
# specifics, and support for CMake frameworks.
macro (H5_SET_LIB_OPTIONS libtarget libname libtype libpackage)
set (LIB_OUT_NAME "${libname}")
# SOVERSION passed in ARGN when shared
# No versioning for Java JNI libraries
if (${libtype} MATCHES "SHARED" AND NOT ${libpackage} STREQUAL "JAVA")
set (PACKAGE_SOVERSION ${HDF5_${libpackage}_PACKAGE_SOVERSION})
set (PACKAGE_COMPATIBILITY ${H5_${libpackage}_SOVERS_INTERFACE}.0.0)
set (PACKAGE_CURRENT ${H5_${libpackage}_SOVERS_INTERFACE}.${H5_${libpackage}_SOVERS_MINOR}.0)
if (WIN32)
set (LIBHDF_VERSION ${HDF5_PACKAGE_VERSION_MAJOR})
else ()
set (LIBHDF_VERSION ${HDF5_${libpackage}_PACKAGE_SOVERSION_MAJOR})
endif ()
set_target_properties (${libtarget} PROPERTIES VERSION ${PACKAGE_SOVERSION})
if (WIN32)
set (${LIB_OUT_NAME} "${LIB_OUT_NAME}-${LIBHDF_VERSION}")
else ()
set_target_properties (${libtarget} PROPERTIES SOVERSION ${LIBHDF_VERSION})
endif ()
if (CMAKE_C_OSX_CURRENT_VERSION_FLAG)
set_property (TARGET ${libtarget} APPEND PROPERTY
LINK_FLAGS "${CMAKE_C_OSX_CURRENT_VERSION_FLAG}${PACKAGE_CURRENT} ${CMAKE_C_OSX_COMPATIBILITY_VERSION_FLAG}${PACKAGE_COMPATIBILITY}"
)
endif ()
endif ()
HDF_SET_LIB_OPTIONS (${libtarget} ${LIB_OUT_NAME} ${libtype})
#-- Apple Specific install_name for libraries
if (APPLE)
cmake_dependent_option (HDF5_BUILD_WITH_INSTALL_NAME "Build with library install_name set to the installation path" OFF APPLE OFF)
mark_as_advanced (HDF5_BUILD_WITH_INSTALL_NAME)
if (HDF5_BUILD_WITH_INSTALL_NAME)
set_target_properties (${libtarget} PROPERTIES
INSTALL_NAME_DIR "${CMAKE_INSTALL_PREFIX}/lib"
BUILD_WITH_INSTALL_RPATH ${HDF5_BUILD_WITH_INSTALL_NAME}
)
endif ()
if (HDF5_BUILD_FRAMEWORKS)
if (${libtype} MATCHES "SHARED")
# adapt target to build frameworks instead of dylibs
set_target_properties (${libtarget} PROPERTIES
XCODE_ATTRIBUTE_INSTALL_PATH "@rpath"
FRAMEWORK TRUE
FRAMEWORK_VERSION ${HDF5_PACKAGE_VERSION_MAJOR}
MACOSX_FRAMEWORK_IDENTIFIER org.hdfgroup.${libtarget}
MACOSX_FRAMEWORK_SHORT_VERSION_STRING ${HDF5_PACKAGE_VERSION_MAJOR}
MACOSX_FRAMEWORK_BUNDLE_VERSION ${HDF5_PACKAGE_VERSION_MAJOR})
endif ()
endif ()
endif ()
endmacro ()
# H5_SET_VFD_LIST: Macro to initialize the list of VFDs (Virtual File Drivers)
# to be used for testing, with logic to include/exclude VFDs based on build
# options and platform capabilities.
macro (H5_SET_VFD_LIST)
set (VFD_LIST
sec2
stdio
core
core_paged
split
multi
family
# Splitter VFD currently can't be tested with the h5_fileaccess()
# approach due to it trying to lock the same W/O file when two
# files are created/opened with the same FAPL that has the VFD
# set on it. When tested with the environment variable and a
# default FAPL, the VFD appends "_wo" to the filename when the
# W/O path isn't specified, which works for all the tests.
#splitter
# Log VFD currently has file space allocation bugs
#log
# Onion VFD not currently tested with VFD tests
#onion
)
if (H5_HAVE_DIRECT)
list (APPEND VFD_LIST direct)
endif ()
if (H5_HAVE_PARALLEL)
# MPI I/O VFD is currently incompatible with too many tests in the VFD test set
# list (APPEND VFD_LIST mpio)
endif ()
if (H5_HAVE_MIRROR_VFD)
# Mirror VFD needs network configuration, etc. and isn't easy to set
# reasonable defaults for that info.
# list (APPEND VFD_LIST mirror)
endif ()
if (H5_HAVE_ROS3_VFD)
# This would require a custom test suite
# list (APPEND VFD_LIST ros3)
endif ()
if (H5_HAVE_LIBHDFS)
# This would require a custom test suite
# list (APPEND VFD_LIST hdfs)
endif ()
if (H5_HAVE_SUBFILING_VFD)
# Subfiling has a few VFD test failures to be resolved
# list (APPEND VFD_LIST subfiling)
endif ()
if (H5_HAVE_WINDOWS)
list (APPEND VFD_LIST windows)
endif ()
endmacro ()
# H5_CREATE_VFD_DIR: Macro to initialize the list of VFDs to be used for
# testing by creating a test folder for each VFD
macro (H5_CREATE_VFD_DIR)
foreach (vfdtest ${VFD_LIST})
file (MAKE_DIRECTORY "${PROJECT_BINARY_DIR}/${vfdtest}")
endforeach ()
endmacro ()
# Given the name of a CMake target for an external VOL connector,
# populate variables with the names vol_name_out and vol_env_out with
# the connector's name and the environment string needed to load the connector,
# respectively.
macro(HDF5_GET_VOL_TGT_INFO vol_tgt vol_name_out vol_env_out)
set(${vol_env_out} "")
# HDF5_VOL_CONNECTOR
get_target_property (ext_vol_name "${vol_tgt}" HDF5_VOL_NAME)
if (${ext_vol_name} STREQUAL ext_vol_name-NOTFOUND)
message(FATAL_ERROR "VOL target ${vol_tgt} has no defined HDF5_VOL_NAME")
endif ()
list(APPEND ${vol_env_out} "HDF5_VOL_CONNECTOR=${ext_vol_name}")
# HDF5_PLUGIN_PATH
get_target_property(vol_lib_targets "${vol_tgt}" HDF5_VOL_TARGETS)
# Sanity check
string(FIND "${vol_lib_targets}" ";" semicolon_pos)
if (semicolon_pos EQUAL -1)
if ("${vol_lib_targets}" STREQUAL "vol_lib_targets-NOTFOUND")
message(FATAL_ERROR "${vol_tgt} has no corresponding targets")
endif ()
endif ()
set(vol_plugin_paths "${CMAKE_BINARY_DIR}/${HDF5_INSTALL_BIN_DIR}")
foreach (lib_target ${vol_lib_targets})
get_target_property (lib_target_output_dir "${lib_target}" LIBRARY_OUTPUT_DIRECTORY)
if (NOT "${lib_target_output_dir}" STREQUAL "lib_target_output_dir-NOTFOUND"
AND NOT "${lib_target_output_dir}" STREQUAL ""
AND NOT "${lib_target_output_dir}" STREQUAL "${CMAKE_BINARY_DIR}/${HDF5_INSTALL_BIN_DIR}")
set (vol_plugin_paths "${vol_plugin_paths}${CMAKE_SEP}${lib_target_output_dir}")
endif ()
endforeach ()
list(APPEND ${vol_env_out} "HDF5_PLUGIN_PATH=${vol_plugin_paths}")
# VOL name
string(REPLACE "HDF5_VOL_" "" ${vol_name_out} "${vol_tgt}")
endmacro()