mirror of
https://github.com/Unidata/netcdf-c.git
synced 2024-12-27 08:49:16 +08:00
3ffe7be446
re: Discussion https://github.com/Unidata/netcdf-c/discussions/2214 The primary change is to support so-called "standard filters". A standard filter is one that is defined by the following netcdf-c API: ```` int nc_def_var_XXX(int ncid, int varid, size_t nparams, unsigned* params); int nc_inq_var_XXXX(int ncid, int varid, int* usefilterp, unsigned* params); ```` So for example, zstandard would be a standard filter by defining the functions *nc_def_var_zstandard* and *nc_inq_var_zstandard*. In order to define these functions, we need a new dispatch function: ```` int nc_inq_filter_avail(int ncid, unsigned filterid); ```` This function, combined with the existing filter API can be used to implement arbitrary standard filters using a simple code pattern. Note that I would have preferred that this function return a list of all available filters, but HDF5 does not support that functionality. So this PR implements the dispatch function and implements the following standard functions: + bzip2 + zstandard + blosc Specific test cases are also provided for HDF5 and NCZarr. Over time, other specific standard filters will be defined. ## Primary Changes * Add nc_inq_filter_avail() to netcdf-c API. * Add standard filter implementations to test use of *nc_inq_filter_avail*. * Bump the dispatch table version number and add to all the relevant dispatch tables (libsrc, libsrcp, etc). * Create a program to invoke nc_inq_filter_avail so that it is accessible to shell scripts. * Cleanup szip support to properly support szip when HDF5 is disabled. This involves detecting libsz separately from testing if HDF5 supports szip. * Integrate shuffle and fletcher32 into the existing filter API. This means that, for example, nc_def_var_fletcher32 is now a wrapper around nc_def_var_filter. * Extend the Codec defaulting to allow multiple default shared libraries. ## Misc. Changes * Modify configure.ac/CMakeLists.txt to look for the relevant libraries implementing standard filters. * Modify libnetcdf.settings to list available standard filters (including deflate and szip). * Add CMake test modules to locate libbz2 and libzstd. * Cleanup the HDF5 memory manager function use in the plugins. * remove unused file include//ncfilter.h * remove tests for the HDF5 memory operations e.g. H5allocate_memory. * Add flag to ncdump to force use of _Filter instead of _Deflate or _Shuffle or _Fletcher32. Used for testing.
100 lines
3.5 KiB
CMake
100 lines
3.5 KiB
CMake
# Copyright 1993, 1994, 1995, 1996, 1997, 1998, 1999, 2000, 2001, 2002,
|
|
# 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011, 2012, 2013, 2014,
|
|
# 2015, 2016, 2017, 2018
|
|
# University Corporation for Atmospheric Research/Unidata.
|
|
|
|
# See netcdf-c/COPYRIGHT file for more info.
|
|
SET(CMAKE_BUILD_TYPE "")
|
|
|
|
FILE(READ H5Znoop.c NOOP_SOURCE)
|
|
FILE(WRITE ${CMAKE_CURRENT_BINARY_DIR}/H5Znoop1.c "#define NOOP_INSTANCE 1\n")
|
|
FILE(APPEND ${CMAKE_CURRENT_BINARY_DIR}/H5Znoop1.c "${NOOP_SOURCE}")
|
|
|
|
SET(h5bzip2_SOURCES H5Zbzip2.c)
|
|
|
|
IF(NOT HAVE_BZIP2)
|
|
SET(h5bzip2_SOURCES ${h5bzip2_SOURCES} blocksort.c huffman.c crctable.c randtable.c compress.c decompress.c bzlib.c)
|
|
ENDIF()
|
|
|
|
SET(h5misc_SOURCES H5Zmisc.c H5Zutil.c h5misc.h)
|
|
|
|
SET(h5noop_SOURCES H5Znoop.c H5Zutil.c h5noop.h)
|
|
SET_SOURCE_FILES_PROPERTIES(H5Znoop.c PROPERTIES COMPILE_OPTIONS -DNOOP_INSTANCE=0)
|
|
|
|
SET(h5noop1_SOURCES ${CMAKE_CURRENT_BINARY_DIR}/H5Znoop1.c H5Zutil.c h5noop.h)
|
|
SET_SOURCE_FILES_PROPERTIES(${CMAKE_CURRENT_BINARY_DIR}/H5Znoop1.c PROPERTIES COMPILE_OPTIONS -DNOOP_INSTANCE=1)
|
|
|
|
SET(h5shuffle_SOURCES H5Zshuffle.c)
|
|
SET(h5fletcher32_SOURCES H5Zfletcher32.c H5checksum.c)
|
|
SET(h5deflate_SOURCES H5Zdeflate.c)
|
|
|
|
SET(nczmisc_SOURCES NCZmisc.c)
|
|
SET(nczdefaults_SOURCES NCZdefaults.c)
|
|
|
|
IF(ENABLE_FILTER_TESTING)
|
|
IF(BUILD_UTILITIES)
|
|
|
|
# LDFLAGS = -module -avoid-version -shared -export-dynamic -no-undefined
|
|
|
|
SET(CMAKE_LIBRARY_OUTPUT_DIRECTORY "${CMAKE_CURRENT_BINARY_DIR}")
|
|
SET(CMAKE_LIBRARY_OUTPUT_DIRECTORY_DEBUG "${CMAKE_CURRENT_BINARY_DIR}")
|
|
SET(CMAKE_LIBRARY_OUTPUT_DIRECTORY_RELEASE "${CMAKE_CURRENT_BINARY_DIR}")
|
|
|
|
MACRO(buildplugin TARGET TARGETLIB)
|
|
ADD_LIBRARY(${TARGET} MODULE ${${TARGET}_SOURCES})
|
|
SET_TARGET_PROPERTIES(${TARGET} PROPERTIES LIBRARY_OUTPUT_NAME ${TARGETLIB})
|
|
SET_TARGET_PROPERTIES(${TARGET} PROPERTIES ARCHIVE_OUTPUT_NAME ${TARGETLIB})
|
|
SET_TARGET_PROPERTIES(${TARGET} PROPERTIES RUNTIME_OUTPUT_NAME ${TARGETLIB})
|
|
TARGET_LINK_LIBRARIES(${TARGET} ${ALL_TLL_LIBS};${ARGN})
|
|
IF(MSVC)
|
|
target_compile_options(${TARGET} PRIVATE /Zi)
|
|
# Tell linker to include symbol data
|
|
set_target_properties(${TARGET} PROPERTIES LINK_FLAGS "/INCREMENTAL:NO /DEBUG /OPT:REF /OPT:ICF")
|
|
# Set file name & location
|
|
set_target_properties(${TARGET} PROPERTIES COMPILE_PDB_NAME ${TARGET} COMPILE_PDB_OUTPUT_DIR ${CMAKE_BINARY_DIR})
|
|
ENDIF()
|
|
ENDMACRO()
|
|
|
|
buildplugin(h5misc "h5misc")
|
|
buildplugin(h5noop "h5noop")
|
|
buildplugin(h5noop1 "h5noop1")
|
|
|
|
buildplugin(h5shuffle "h5shuffle")
|
|
buildplugin(h5fletcher32 "h5fletcher32")
|
|
buildplugin(h5deflate "h5deflate")
|
|
|
|
buildplugin(nczmisc "nczmisc")
|
|
buildplugin(nczdefaults "nczdefaults" netcdf)
|
|
|
|
IF(ENABLE_BLOSC)
|
|
SET(h5blosc_SOURCES H5Zblosc.c)
|
|
buildplugin(h5blosc "h5blosc" netcdf;${Blosc_LIBRARIES})
|
|
ENDIF()
|
|
|
|
IF(ENABLE_ZSTD)
|
|
SET(h5zstd_SOURCES H5Zzstd.c H5Zzstd.h)
|
|
buildplugin(h5zstd "h5zstd" netcdf;${Zstd_LIBRARIES})
|
|
ENDIF()
|
|
|
|
# Need our version of szip if libsz available and we are not using HDF5
|
|
IF(HAVE_SZ)
|
|
SET(h5szip_SOURCES H5Zszip.c H5Zszip.h)
|
|
buildplugin(h5szip "h5szip" ${Szip_LIBRARIES})
|
|
SET(nczszip_SOURCES NCZszip.c)
|
|
buildplugin(nczszip "nczszip" netcdf)
|
|
ENDIF()
|
|
|
|
buildplugin(h5bzip2 "h5bzip2" ${Bzip2_LIBRARIES})
|
|
# Note we use name h5bzip2 instead of bzip2 to avoid logical
|
|
# target name clash with examples/C/hdf5plugins
|
|
SET_TARGET_PROPERTIES(h5bzip2 PROPERTIES OUTPUT_NAME "bzip2")
|
|
|
|
ENDIF(BUILD_UTILITIES)
|
|
ENDIF(ENABLE_FILTER_TESTING)
|
|
|
|
# Copy some test files from current source dir to out-of-tree build dir.
|
|
FILE(COPY ${COPY_FILES} DESTINATION ${CMAKE_CURRENT_BINARY_DIR}/)
|
|
IF(MSVC)
|
|
FILE(COPY ${COPY_FILES} DESTINATION ${RUNTIME_OUTPUT_DIRECTORY}/)
|
|
ENDIF()
|