mirror of
https://github.com/Unidata/netcdf-c.git
synced 2024-11-27 07:30:33 +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.
143 lines
5.5 KiB
CMake
143 lines
5.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(abs_top_srcdir ${CMAKE_CURRENT_SOURCE_DIR})
|
|
|
|
remove_definitions(-DDLL_EXPORT)
|
|
|
|
FILE(READ ${CMAKE_CURRENT_SOURCE_DIR}/../nc_test4/tst_quantize.c QSOURCE)
|
|
FILE(WRITE ${CMAKE_CURRENT_BINARY_DIR}/test_quantize.c "#define TESTNCZARR\n")
|
|
FILE(APPEND ${CMAKE_CURRENT_BINARY_DIR}/test_quantize.c "${QSOURCE}")
|
|
|
|
FILE(READ ${CMAKE_CURRENT_SOURCE_DIR}/../nc_test4/tst_filter_avail.c ASOURCE)
|
|
STRING(PREPEND ASOURCE "#define TESTNCZARR\n")
|
|
FILE(WRITE ${CMAKE_CURRENT_BINARY_DIR}/test_filter_avail.c "${ASOURCE}")
|
|
|
|
FILE(READ ${CMAKE_CURRENT_SOURCE_DIR}/../nc_test4/tst_specific_filters.sh SPSOURCE)
|
|
STRING(PREPEND SPSOURCE "#!/bin/bash\n")
|
|
STRING(PREPEND SPSOURCE "TESTNCZARR=1\n")
|
|
FILE(WRITE ${CMAKE_CURRENT_SOURCE_DIR}/run_specific_filters.1 "${SPSOURCE}")
|
|
CONFIGURE_FILE(${CMAKE_CURRENT_SOURCE_DIR}/run_specific_filters.1 ${CMAKE_CURRENT_SOURCE_DIR}/run_specific_filters.sh @ONLY NEWLINE_STYLE LF)
|
|
FILE(COPY ${CMAKE_CURRENT_SOURCE_DIR}/run_specific_filters.sh DESTINATION ${CMAKE_CURRENT_BINARY_DIR} FILE_PERMISSIONS OWNER_WRITE OWNER_READ OWNER_EXECUTE)
|
|
FILE(REMOVE ${CMAKE_CURRENT_SOURCE_DIR}/run_specific_filters.1)
|
|
FILE(REMOVE ${CMAKE_CURRENT_SOURCE_DIR}/run_specific_filters.sh)
|
|
|
|
FILE(GLOB COPY_FILES ${CMAKE_CURRENT_SOURCE_DIR}/*.sh
|
|
${CMAKE_CURRENT_SOURCE_DIR}/ref*.cdl
|
|
${CMAKE_CURRENT_SOURCE_DIR}/ref*.txt)
|
|
|
|
FILE(COPY ${COPY_FILES} DESTINATION ${CMAKE_CURRENT_BINARY_DIR}/ FILE_PERMISSIONS OWNER_WRITE OWNER_READ OWNER_EXECUTE)
|
|
|
|
IF(ENABLE_TESTS)
|
|
|
|
SET(COMMONSRC ut_util.c ut_test.c)
|
|
IF(USE_X_GETOPT)
|
|
SET(COMMONSRC ${COMMONSRC} XGetopt.c)
|
|
ENDIF()
|
|
|
|
SET(TSTCOMMONSRC tst_utils.c)
|
|
IF(USE_X_GETOPT)
|
|
SET(TSTCOMMONSRC ${TSTCOMMONSRC} XGetopt.c)
|
|
ENDIF()
|
|
|
|
# Base tests
|
|
# The tests are set up as a combination of shell scripts and executables that
|
|
# must be run in a particular order. It is painful but will use macros to help
|
|
# keep it from being too bad.
|
|
|
|
BUILD_BIN_TEST(ut_map ${COMMONSRC})
|
|
BUILD_BIN_TEST(ut_mapapi ${COMMONSRC})
|
|
BUILD_BIN_TEST(ut_json ${COMMONSRC})
|
|
BUILD_BIN_TEST(ut_projections ${COMMONSRC})
|
|
BUILD_BIN_TEST(ut_chunking ${COMMONSRC})
|
|
BUILD_BIN_TEST(tst_zchunks ${COMMONSRC})
|
|
BUILD_BIN_TEST(tst_zchunks2 ${COMMONSRC})
|
|
BUILD_BIN_TEST(tst_zchunks3 ${COMMONSRC})
|
|
BUILD_BIN_TEST(tst_fillonlyz ${TSTCOMMONSRC})
|
|
|
|
TARGET_INCLUDE_DIRECTORIES(ut_map PUBLIC ../libnczarr)
|
|
TARGET_INCLUDE_DIRECTORIES(ut_mapapi PUBLIC ../libnczarr)
|
|
TARGET_INCLUDE_DIRECTORIES(ut_json PUBLIC ../libnczarr)
|
|
TARGET_INCLUDE_DIRECTORIES(ut_projections PUBLIC ../libnczarr)
|
|
TARGET_INCLUDE_DIRECTORIES(ut_chunking PUBLIC ../libnczarr)
|
|
TARGET_INCLUDE_DIRECTORIES(tst_zchunks PUBLIC ../libnczarr)
|
|
TARGET_INCLUDE_DIRECTORIES(tst_zchunks2 PUBLIC ../libnczarr)
|
|
TARGET_INCLUDE_DIRECTORIES(tst_zchunks3 PUBLIC ../libnczarr)
|
|
TARGET_INCLUDE_DIRECTORIES(tst_fillonlyz PUBLIC ../libnczarr)
|
|
|
|
# Helper programs for testing
|
|
BUILD_BIN_TEST(zmapio ${COMMONSRC})
|
|
TARGET_INCLUDE_DIRECTORIES(zmapio PUBLIC ../libnczarr)
|
|
BUILD_BIN_TEST(zhex)
|
|
BUILD_BIN_TEST(zisjson)
|
|
TARGET_INCLUDE_DIRECTORIES(zisjson PUBLIC ../libnczarr)
|
|
BUILD_BIN_TEST(zs3parse ${COMMONSRC})
|
|
TARGET_INCLUDE_DIRECTORIES(zs3parse PUBLIC ../libnczarr)
|
|
if(ENABLE_NCZARR_S3)
|
|
BUILD_BIN_TEST(s3util ${COMMONSRC})
|
|
TARGET_INCLUDE_DIRECTORIES(s3util PUBLIC ../libnczarr)
|
|
endif()
|
|
|
|
SET(ncdumpchunks_SOURCE ncdumpchunks.c)
|
|
IF(USE_X_GETOPT)
|
|
SET(ncdumpchunks_SOURCE ${ncdumpchunks_SOURCE} XGetopt.c)
|
|
ENDIF()
|
|
BUILD_BIN_TEST(ncdumpchunks ${ncdumpchunks_SOURCE})
|
|
TARGET_INCLUDE_DIRECTORIES(ncdumpchunks PUBLIC ../libnczarr)
|
|
|
|
IF(BUILD_UTILITIES)
|
|
add_sh_test(nczarr_test run_ut_map)
|
|
add_sh_test(nczarr_test run_ut_mapapi)
|
|
add_sh_test(nczarr_test run_ut_misc)
|
|
add_sh_test(nczarr_test run_ut_chunk)
|
|
IF(USE_HDF5)
|
|
# add_sh_test(nczarr_test run_nccopyz)
|
|
add_sh_test(nczarr_test run_fillonlyz)
|
|
ENDIF()
|
|
add_sh_test(nczarr_test run_ncgen4)
|
|
|
|
BUILD_BIN_TEST(tst_chunkcases ${TSTCOMMONSRC})
|
|
TARGET_INCLUDE_DIRECTORIES(tst_chunkcases PUBLIC ../libnczarr)
|
|
add_sh_test(nczarr_test run_chunkcases)
|
|
|
|
add_sh_test(nczarr_test run_purezarr)
|
|
add_sh_test(nczarr_test run_interop)
|
|
add_sh_test(nczarr_test run_misc)
|
|
add_sh_test(nczarr_test run_nczarr_fill)
|
|
|
|
BUILD_BIN_TEST(test_quantize ${TSTCOMMONSRC})
|
|
add_sh_test(nczarr_test run_quantize)
|
|
|
|
if(ENABLE_NCZARR_S3)
|
|
add_sh_test(nczarr_test run_s3_cleanup)
|
|
ENDIF()
|
|
|
|
IF(ENABLE_FILTER_TESTING)
|
|
build_bin_test(tst_nczfilter)
|
|
build_bin_test(testfilter)
|
|
build_bin_test(testfilter_misc)
|
|
build_bin_test(testfilter_multi)
|
|
build_bin_test(testfilter_order)
|
|
build_bin_test(testfilter_repeat)
|
|
build_bin_test(test_filter_avail)
|
|
ADD_SH_TEST(nczarr_test run_nczfilter)
|
|
ADD_SH_TEST(nczarr_test run_filter)
|
|
ADD_SH_TEST(nczarr_test run_specific_filters)
|
|
ENDIF(ENABLE_FILTER_TESTING)
|
|
if(ENABLE_NCZARR_ZIP)
|
|
add_sh_test(nczarr_test run_newformat)
|
|
endif()
|
|
|
|
ENDIF(BUILD_UTILITIES)
|
|
|
|
ENDIF(ENABLE_TESTS)
|
|
|
|
## Specify files to be distributed by 'make dist'
|
|
FILE(GLOB CUR_EXTRA_DIST RELATIVE ${CMAKE_CURRENT_SOURCE_DIR} ${CMAKE_CURRENT_SOURCE_DIR}/*.c ${CMAKE_CURRENT_SOURCE_DIR}/*.h ${CMAKE_CURRENT_SOURCE_DIR}/*.sh ${CMAKE_CURRENT_SOURCE_DIR}/*.cdl)
|
|
SET(CUR_EXTRA_DIST ${CUR_EXTRA_DIST} CMakeLists.txt Makefile.am zmapio.c zhex.c ncdumpchunks.c)
|
|
ADD_EXTRA_DIST("${CUR_EXTRA_DIST}")
|