1.14 Add fetchcontent for compression libs and fix cmake config #2487 (…

…#2492) * Add fetchcontent for compression libs and fix cmake config #2487 * Update cmake doc for FetchContent * Add CI test for FetchContent * Use LINK_COMP_LIBS instead of STATIC_LIBRARY for depends
HDFGroup · Mar 1, 2023 · 197966e · 197966e
1 parent d8fd9c2
commit 197966e
Show file tree

Hide file tree

Showing 21 changed files with 2,149 additions and 153 deletions.
diff --git a/.github/workflows/codespell.yml b/.github/workflows/codespell.yml
@@ -12,4 +12,4 @@ jobs:
       - uses: codespell-project/actions-codespell@master
         with:
           skip: ./bin/trace,./hl/tools/h5watch/h5watch.c,./tools/test/h5jam/tellub.c,./config/sanitizer/LICENSE,./tools/test/h5repack/testfiles/*.dat
-          ignore_words_list: isnt,inout,nd,parms,parm,ba,offsetP,ser,ois,had,fiter,fo,clude,refere,minnum,offsetp,creat,ans:,eiter,lastr,ans,isn't,ifset,sur,trun,dne,tthe,hda,filname,te,htmp,minnum,ake,gord,numer,ro,oce
+          ignore_words_list: isnt,inout,nd,parms,parm,ba,offsetP,ser,ois,had,fiter,fo,clude,refere,minnum,offsetp,creat,ans:,eiter,lastr,ans,isn't,ifset,sur,trun,dne,tthe,hda,filname,te,htmp,minnum,ake,gord,numer,ro,oce,msdos
diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml
@@ -73,6 +73,8 @@ jobs:
             cpp: ON
             fortran: OFF
             java: ON
+            libaecfc: ON
+            zlibfc: ON
             parallel: OFF
             mirror_vfd: OFF
             direct_vfd: OFF
@@ -88,6 +90,8 @@ jobs:
             cpp: ON
             fortran: ON
             java: ON
+            libaecfc: ON
+            zlibfc: ON
             parallel: OFF
             mirror_vfd: ON
             direct_vfd: ON
@@ -143,6 +147,8 @@ jobs:
             cpp: ON
             fortran: OFF
             java: ON
+            libaecfc: ON
+            zlibfc: ON
             parallel: OFF
             mirror_vfd: ON
             direct_vfd: OFF
@@ -405,7 +411,7 @@ jobs:
         run: |
           mkdir "${{ runner.workspace }}/build"
           cd "${{ runner.workspace }}/build"
-          cmake ${{ matrix.generator }} -DCMAKE_BUILD_TYPE=${{ matrix.build_mode.cmake }} -DCMAKE_TOOLCHAIN_FILE=${{ matrix.toolchain }} -DBUILD_SHARED_LIBS=ON -DHDF5_ENABLE_ALL_WARNINGS=ON -DHDF5_ENABLE_PARALLEL:BOOL=${{ matrix.parallel }} -DHDF5_BUILD_CPP_LIB:BOOL=${{ matrix.cpp }} -DHDF5_BUILD_FORTRAN=${{ matrix.fortran }} -DHDF5_BUILD_JAVA=${{ matrix.java }} -DHDF5_ENABLE_MIRROR_VFD:BOOL=${{ matrix.mirror_vfd }} -DHDF5_ENABLE_DIRECT_VFD:BOOL=${{ matrix.direct_vfd }} $GITHUB_WORKSPACE
+          cmake ${{ matrix.generator }} -DCMAKE_BUILD_TYPE=${{ matrix.build_mode.cmake }} -DCMAKE_TOOLCHAIN_FILE=${{ matrix.toolchain }} -DBUILD_SHARED_LIBS=ON -DHDF5_ENABLE_ALL_WARNINGS=ON -DHDF5_ENABLE_PARALLEL:BOOL=${{ matrix.parallel }} -DHDF5_BUILD_CPP_LIB:BOOL=${{ matrix.cpp }} -DHDF5_BUILD_FORTRAN=${{ matrix.fortran }} -DHDF5_BUILD_JAVA=${{ matrix.java }} -DBUILD_SZIP_WITH_FETCHCONTENT=${{ matrix.libaecfc }} -DBUILD_ZLIB_WITH_FETCHCONTENT=${{ matrix.zlibfc }} -DHDF5_ENABLE_MIRROR_VFD:BOOL=${{ matrix.mirror_vfd }} -DHDF5_ENABLE_DIRECT_VFD:BOOL=${{ matrix.direct_vfd }} $GITHUB_WORKSPACE
         shell: bash
         if: (matrix.generator != 'autogen') && (! matrix.thread_safe.enabled)
 

diff --git a/CMakeFilters.cmake b/CMakeFilters.cmake
@@ -11,16 +11,44 @@
 #
 option (USE_LIBAEC "Use AEC library as SZip Filter" OFF)
 option (USE_LIBAEC_STATIC "Use static AEC library " OFF)
+option (ZLIB_USE_EXTERNAL "Use External Library Building for ZLIB" 0)
+option (SZIP_USE_EXTERNAL "Use External Library Building for SZIP" 0)
 
-include (ExternalProject)
-include (FetchContent)
+option (BUILD_ZLIB_WITH_FETCHCONTENT "Use FetchContent to use original source files" OFF)
+if (BUILD_ZLIB_WITH_FETCHCONTENT)
+  set (ZLIB_USE_EXTERNAL "Use External Library Building for ZLIB" 1)
+  if (NOT ZLIB_USE_LOCALCONTENT)
+    set (ZLIB_URL ${ZLIB_TGZ_ORIGPATH}/${ZLIB_TGZ_ORIGNAME})
+  else ()
+    set (ZLIB_URL ${TGZPATH}/${ZLIB_TGZ_ORIGNAME})
+  endif ()
+  if (CMAKE_VERSION VERSION_GREATER_EQUAL "3.15.0")
+    message (VERBOSE "Filter ZLIB file is ${ZLIB_URL}")
+  endif ()
+endif ()
+
+option (BUILD_SZIP_WITH_FETCHCONTENT "Use FetchContent to use original source files" OFF)
+if (BUILD_SZIP_WITH_FETCHCONTENT)
+  # Only libaec library is usable
+  set (USE_LIBAEC ON CACHE BOOL "Use libaec szip replacement" FORCE)
+  set (SZIP_USE_EXTERNAL "Use External Library Building for SZIP" 1)
+  if (NOT LIBAEC_USE_LOCALCONTENT)
+    set (SZIP_URL ${LIBAEC_TGZ_ORIGPATH}/${LIBAEC_TGZ_ORIGNAME})
+  else ()
+    set (SZIP_URL ${TGZPATH}/${LIBAEC_TGZ_ORIGNAME})
+  endif ()
+  if (CMAKE_VERSION VERSION_GREATER_EQUAL "3.15.0")
+    message (VERBOSE "Filter SZIP file is ${SZIP_URL}")
+  endif ()
+endif ()
 
+include (ExternalProject)
 #option (HDF5_ALLOW_EXTERNAL_SUPPORT "Allow External Library Building (NO GIT TGZ)" "NO")
 set (HDF5_ALLOW_EXTERNAL_SUPPORT "NO" CACHE STRING "Allow External Library Building (NO GIT TGZ)")
 set_property (CACHE HDF5_ALLOW_EXTERNAL_SUPPORT PROPERTY STRINGS NO GIT TGZ)
 if (HDF5_ALLOW_EXTERNAL_SUPPORT MATCHES "GIT" OR HDF5_ALLOW_EXTERNAL_SUPPORT MATCHES "TGZ")
-  option (ZLIB_USE_EXTERNAL "Use External Library Building for HDF5_ZLIB" 1)
-  option (SZIP_USE_EXTERNAL "Use External Library Building for SZIP" 1)
+  set (ZLIB_USE_EXTERNAL "Use External Library Building for ZLIB" 1)
+  set (SZIP_USE_EXTERNAL "Use External Library Building for SZIP" 1)
   if (HDF5_ALLOW_EXTERNAL_SUPPORT MATCHES "GIT")
     set (ZLIB_URL ${ZLIB_GIT_URL} CACHE STRING "Path to zlib git repository")
     set (ZLIB_BRANCH ${ZLIB_GIT_BRANCH})
@@ -30,14 +58,18 @@ if (HDF5_ALLOW_EXTERNAL_SUPPORT MATCHES "GIT" OR HDF5_ALLOW_EXTERNAL_SUPPORT MAT
     if (NOT TGZPATH)
       set (TGZPATH ${HDF5_SOURCE_DIR})
     endif ()
-    set (ZLIB_URL ${TGZPATH}/${ZLIB_TGZ_NAME})
+    if (NOT BUILD_ZLIB_WITH_FETCHCONTENT)
+      set (ZLIB_URL ${TGZPATH}/${ZLIB_TGZ_NAME})
+    endif ()
     if (NOT EXISTS "${ZLIB_URL}")
       set (HDF5_ENABLE_Z_LIB_SUPPORT OFF CACHE BOOL "" FORCE)
       message (VERBOSE "Filter ZLIB file ${ZLIB_URL} not found")
     endif ()
-    set (SZIP_URL ${TGZPATH}/${SZIP_TGZ_NAME})
-    if (USE_LIBAEC)
-      set (SZIP_URL ${TGZPATH}/${SZAEC_TGZ_NAME})
+    if (NOT BUILD_SZIP_WITH_FETCHCONTENT)
+      set (SZIP_URL ${TGZPATH}/${SZIP_TGZ_NAME})
+      if (USE_LIBAEC)
+        set (SZIP_URL ${TGZPATH}/${SZAEC_TGZ_NAME})
+      endif ()
     endif ()
     if (NOT EXISTS "${SZIP_URL}")
       set (HDF5_ENABLE_SZIP_SUPPORT OFF CACHE BOOL "" FORCE)
@@ -59,25 +91,32 @@ if (HDF5_ENABLE_Z_LIB_SUPPORT)
       find_package (ZLIB NAMES ${ZLIB_PACKAGE_NAME}${HDF_PACKAGE_EXT} COMPONENTS static shared)
       if (NOT ZLIB_FOUND)
         find_package (ZLIB) # Legacy find
-        if (ZLIB_FOUND)
-          set (LINK_COMP_LIBS ${LINK_COMP_LIBS} ${ZLIB_LIBRARIES})
-        endif ()
       endif ()
-    endif ()
-    if (ZLIB_FOUND)
-      set (H5_HAVE_FILTER_DEFLATE 1)
-      set (H5_HAVE_ZLIB_H 1)
-      set (H5_HAVE_LIBZ 1)
-      set (H5_ZLIB_HEADER "zlib.h")
-      set (ZLIB_INCLUDE_DIR_GEN ${ZLIB_INCLUDE_DIR})
-      set (ZLIB_INCLUDE_DIRS ${ZLIB_INCLUDE_DIRS} ${ZLIB_INCLUDE_DIR})
+      if (ZLIB_FOUND)
+        set (H5_HAVE_FILTER_DEFLATE 1)
+        set (H5_HAVE_ZLIB_H 1)
+        set (H5_HAVE_LIBZ 1)
+        set (H5_ZLIB_HEADER "zlib.h")
+        set (ZLIB_INCLUDE_DIR_GEN ${ZLIB_INCLUDE_DIR})
+        set (ZLIB_INCLUDE_DIRS ${ZLIB_INCLUDE_DIRS} ${ZLIB_INCLUDE_DIR})
+        set (LINK_COMP_LIBS ${LINK_COMP_LIBS} ${ZLIB_LIBRARIES})
+      endif ()
     else ()
-      if (HDF5_ALLOW_EXTERNAL_SUPPORT MATCHES "GIT" OR HDF5_ALLOW_EXTERNAL_SUPPORT MATCHES "TGZ")
+      if (BUILD_ZLIB_WITH_FETCHCONTENT)
+        # Only tgz files available
+        ORIGINAL_ZLIB_LIBRARY ("TGZ")
+        set (H5_HAVE_FILTER_DEFLATE 1)
+        set (H5_HAVE_ZLIB_H 1)
+        set (H5_HAVE_LIBZ 1)
+        message (VERBOSE "HDF5_ZLIB is built from fetch content")
+        set (LINK_COMP_LIBS ${LINK_COMP_LIBS} ${ZLIB_STATIC_LIBRARY})
+      elseif (HDF5_ALLOW_EXTERNAL_SUPPORT MATCHES "GIT" OR HDF5_ALLOW_EXTERNAL_SUPPORT MATCHES "TGZ")
         EXTERNAL_ZLIB_LIBRARY (${HDF5_ALLOW_EXTERNAL_SUPPORT})
         set (H5_HAVE_FILTER_DEFLATE 1)
         set (H5_HAVE_ZLIB_H 1)
         set (H5_HAVE_LIBZ 1)
         message (VERBOSE "Filter HDF5_ZLIB is built")
+        set (LINK_COMP_LIBS ${LINK_COMP_LIBS} ${ZLIB_STATIC_LIBRARY})
       else ()
         message (FATAL_ERROR " ZLib is Required for ZLib support in HDF5")
       endif ()
@@ -91,7 +130,6 @@ if (HDF5_ENABLE_Z_LIB_SUPPORT)
   if (H5_HAVE_FILTER_DEFLATE)
     set (EXTERNAL_FILTERS "${EXTERNAL_FILTERS} DEFLATE")
   endif ()
-  set (LINK_COMP_LIBS ${LINK_COMP_LIBS} ${ZLIB_STATIC_LIBRARY})
   INCLUDE_DIRECTORIES (${ZLIB_INCLUDE_DIRS})
   message (VERBOSE "Filter HDF5_ZLIB is ON")
 endif ()
@@ -111,25 +149,36 @@ if (HDF5_ENABLE_SZIP_SUPPORT)
         set (LINK_COMP_LIBS ${LINK_COMP_LIBS} ${SZIP_LIBRARIES})
       endif ()
     endif ()
-
     if (NOT SZIP_FOUND)
       find_package (SZIP NAMES ${SZIP_PACKAGE_NAME}${HDF_PACKAGE_EXT} COMPONENTS static shared)
       if (NOT SZIP_FOUND)
         find_package (SZIP) # Legacy find
-        if (SZIP_FOUND)
-          set (LINK_COMP_LIBS ${LINK_COMP_LIBS} ${SZIP_LIBRARIES})
-        endif ()
+      endif ()
+      if (SZIP_FOUND)
+        set (H5_HAVE_FILTER_SZIP 1)
+        set (H5_HAVE_SZLIB_H 1)
+        set (H5_HAVE_LIBSZ 1)
+        set (SZIP_INCLUDE_DIR_GEN ${SZIP_INCLUDE_DIR})
+        set (SZIP_INCLUDE_DIRS ${SZIP_INCLUDE_DIRS} ${SZIP_INCLUDE_DIR})
+        set (LINK_COMP_LIBS ${LINK_COMP_LIBS} ${SZIP_LIBRARIES})
       endif ()
     endif ()
-  endif ()
-  if (SZIP_FOUND)
-    set (H5_HAVE_FILTER_SZIP 1)
-    set (H5_HAVE_SZLIB_H 1)
-    set (H5_HAVE_LIBSZ 1)
-    set (SZIP_INCLUDE_DIR_GEN ${SZIP_INCLUDE_DIR})
-    set (SZIP_INCLUDE_DIRS ${SZIP_INCLUDE_DIRS} ${SZIP_INCLUDE_DIR})
   else ()
-    if (HDF5_ALLOW_EXTERNAL_SUPPORT MATCHES "GIT" OR HDF5_ALLOW_EXTERNAL_SUPPORT MATCHES "TGZ")
+    if (BUILD_SZIP_WITH_FETCHCONTENT)
+      # Only tgz files available
+      ORIGINAL_SZIP_LIBRARY ("TGZ" ${HDF5_ENABLE_SZIP_ENCODING})
+      set (H5_HAVE_FILTER_SZIP 1)
+      set (H5_HAVE_SZLIB_H 1)
+      set (H5_HAVE_LIBSZ 1)
+      message (VERBOSE "SZIP is built from fetch content")
+      if (USE_LIBAEC)
+        message (VERBOSE "... with library AEC")
+        set (SZIP_PACKAGE_NAME ${LIBAEC_PACKAGE_NAME})
+      else ()
+        set (SZIP_PACKAGE_NAME ${SZIP_PACKAGE_NAME})
+      endif ()
+      set (LINK_COMP_LIBS ${LINK_COMP_LIBS} ${SZIP_STATIC_LIBRARY})
+    elseif (HDF5_ALLOW_EXTERNAL_SUPPORT MATCHES "GIT" OR HDF5_ALLOW_EXTERNAL_SUPPORT MATCHES "TGZ")
       EXTERNAL_SZIP_LIBRARY (${HDF5_ALLOW_EXTERNAL_SUPPORT} ${HDF5_ENABLE_SZIP_ENCODING})
       set (H5_HAVE_FILTER_SZIP 1)
       set (H5_HAVE_SZLIB_H 1)
@@ -141,11 +190,11 @@ if (HDF5_ENABLE_SZIP_SUPPORT)
       else ()
         set (SZIP_PACKAGE_NAME ${SZIP_PACKAGE_NAME})
       endif ()
+      set (LINK_COMP_LIBS ${LINK_COMP_LIBS} ${SZIP_STATIC_LIBRARY})
     else ()
       message (FATAL_ERROR "SZIP is Required for SZIP support in HDF5")
     endif ()
   endif ()
-  set (LINK_COMP_LIBS ${LINK_COMP_LIBS} ${SZIP_STATIC_LIBRARY})
   INCLUDE_DIRECTORIES (${SZIP_INCLUDE_DIRS})
   message (VERBOSE "Filter SZIP is ON")
   if (H5_HAVE_FILTER_SZIP)

diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -829,11 +829,11 @@ option (HDF5_PACKAGE_EXTLIBS "CPACK - include external libraries" OFF)
 if (NOT HDF5_EXTERNALLY_CONFIGURED)
   if (HDF5_PACKAGE_EXTLIBS)
     set (HDF5_NO_PACKAGES OFF CACHE BOOL "CPACK - Disable packaging" FORCE)
-    if (HDF5_ENABLE_Z_LIB_SUPPORT AND ZLIB_FOUND)
+    if (HDF5_ENABLE_Z_LIB_SUPPORT AND ZLIB_FOUND AND NOT BUILD_ZLIB_WITH_FETCHCONTENT)
       PACKAGE_ZLIB_LIBRARY (${HDF5_ALLOW_EXTERNAL_SUPPORT})
     endif ()
 
-    if (HDF5_ENABLE_SZIP_SUPPORT AND SZIP_FOUND)
+    if (HDF5_ENABLE_SZIP_SUPPORT AND SZIP_FOUND AND NOT BUILD_SZIP_WITH_FETCHCONTENT)
       PACKAGE_SZIP_LIBRARY (${HDF5_ALLOW_EXTERNAL_SUPPORT})
     endif ()
   endif ()
@@ -899,20 +899,12 @@ endif ()
 add_subdirectory (src)
 
 if (HDF5_ALLOW_EXTERNAL_SUPPORT MATCHES "GIT" OR HDF5_ALLOW_EXTERNAL_SUPPORT MATCHES "TGZ")
-  if (ZLIB_FOUND AND ZLIB_USE_EXTERNAL)
+  if ((ZLIB_FOUND AND ZLIB_USE_EXTERNAL) OR (SZIP_FOUND AND SZIP_USE_EXTERNAL))
     if (NOT ONLY_SHARED_LIBS)
-      add_dependencies (${HDF5_LIB_TARGET} HDF5_ZLIB)
+      add_dependencies (${HDF5_LIB_TARGET} ${LINK_COMP_LIBS})
     endif ()
     if (BUILD_SHARED_LIBS)
-      add_dependencies (${HDF5_LIBSH_TARGET} HDF5_ZLIB)
-    endif ()
-  endif ()
-  if (SZIP_FOUND AND SZIP_USE_EXTERNAL)
-    if (NOT ONLY_SHARED_LIBS)
-      add_dependencies (${HDF5_LIB_TARGET} SZIP)
-    endif ()
-    if (BUILD_SHARED_LIBS)
-      add_dependencies (${HDF5_LIBSH_TARGET} SZIP)
+      add_dependencies (${HDF5_LIBSH_TARGET} ${LINK_COMP_LIBS})
     endif ()
   endif ()
 endif ()