mirror of
https://github.com/Unidata/netcdf-c.git
synced 2024-12-21 08:39:46 +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.
120 lines
4.0 KiB
CMake
120 lines
4.0 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, 2019
|
|
# University Corporation for Atmospheric Research/Unidata.
|
|
|
|
# See netcdf-c/COPYRIGHT file for more info.
|
|
|
|
# This is the cmake build file for the nc_test4 directory.
|
|
# Ward Fisher, Ed Hartnett
|
|
|
|
SET(srcdir ${CMAKE_CURRENT_SOURCE_DIR})
|
|
|
|
# Some extra tests
|
|
SET(NC4_TESTS tst_dims tst_dims2 tst_dims3 tst_files tst_files4
|
|
tst_vars tst_varms tst_unlim_vars tst_converts tst_converts2
|
|
tst_grps tst_grps2 tst_compounds tst_compounds2 tst_compounds3
|
|
tst_opaques tst_strings tst_strings2 tst_interops tst_interops4
|
|
tst_interops6 tst_interops_dims tst_enums tst_coords tst_coords2 tst_coords3 tst_vars3
|
|
tst_vars4 tst_chunks tst_chunks2 tst_utf8 tst_fills tst_fills2
|
|
tst_fillbug tst_xplatform2 tst_endian_fill tst_atts t_type
|
|
cdm_sea_soundings tst_vl tst_atts1 tst_atts2 tst_vars2 tst_files5
|
|
tst_files6 tst_sync tst_h_strbug tst_h_refs tst_h_scalar tst_rename
|
|
tst_rename2 tst_rename3 tst_h5_endians tst_atts_string_rewrite tst_put_vars_two_unlim_dim
|
|
tst_hdf5_file_compat tst_fill_attr_vanish tst_rehash tst_types tst_bug324
|
|
tst_atts3 tst_put_vars tst_elatefill tst_udf tst_bug1442 tst_quantize)
|
|
|
|
IF(HAS_PAR_FILTERS)
|
|
SET(NC4_tests $NC4_TESTS tst_alignment)
|
|
ENDIF()
|
|
|
|
# Note, renamegroup needs to be compiled before run_grp_rename
|
|
|
|
IF(BUILD_UTILITIES)
|
|
SET(NC4_TESTS ${NC4_TESTS} tst_xplatform)
|
|
build_bin_test(renamegroup)
|
|
add_sh_test(nc_test4 run_grp_rename)
|
|
build_bin_test(tst_charvlenbug)
|
|
build_bin_test(tst_vlenstr)
|
|
ADD_SH_TEST(nc_test4 tst_misc)
|
|
build_bin_test(tst_fillonly)
|
|
ADD_SH_TEST(nc_test4 test_fillonly)
|
|
IF(USE_HDF5 AND ENABLE_FILTER_TESTING)
|
|
build_bin_test(tst_filterparser)
|
|
build_bin_test(test_filter)
|
|
build_bin_test(test_filter_misc)
|
|
build_bin_test(tst_multifilter)
|
|
build_bin_test(test_filter_order)
|
|
build_bin_test(test_filter_repeat)
|
|
build_bin_test(tst_filter_avail)
|
|
build_bin_test(test_filter_vlen)
|
|
ADD_SH_TEST(nc_test4 tst_filter)
|
|
ADD_SH_TEST(nc_test4 tst_specific_filters)
|
|
IF(ENABLE_CLIENTSIDE_FILTERS)
|
|
add_bin_test(nc_test4 test_filter_reg)
|
|
ENDIF(ENABLE_CLIENTSIDE_FILTERS)
|
|
ENDIF(USE_HDF5 AND ENABLE_FILTER_TESTING)
|
|
|
|
ENDIF(BUILD_UTILITIES)
|
|
|
|
IF(${HDF5_VERSION} VERSION_GREATER "1.10.0")
|
|
SET(NC4_TESTS ${NC4_TESTS} tst_virtual_datasets)
|
|
ENDIF(${HDF5_VERSION} VERSION_GREATER "1.10.0")
|
|
|
|
##
|
|
# The shell script, run_empty_vlen_test.sh,
|
|
# depends on the 'tst_empty_vlen_unlim' binary.
|
|
##
|
|
BUILD_BIN_TEST(tst_empty_vlen_unlim)
|
|
ADD_SH_TEST(nc_test4 run_empty_vlen_test)
|
|
|
|
IF(NOT MSVC)
|
|
SET(NC4_TESTS ${NC4_TESTS} tst_interops5 tst_camrun)
|
|
ENDIF()
|
|
|
|
# If the v2 API was built, add the test program.
|
|
IF(ENABLE_V2_API)
|
|
build_bin_test(tst_v2)
|
|
ENDIF()
|
|
|
|
IF(LARGE_FILE_TESTS)
|
|
SET(NC4_TESTS ${NC4_TESTS} tst_large tst_large2)
|
|
ENDIF()
|
|
|
|
|
|
IF(HAVE_H5Z_SZIP)
|
|
BUILD_BIN_TEST(test_szip)
|
|
BUILD_BIN_TEST(h5testszip)
|
|
IF(BUILD_UTILITIES)
|
|
add_sh_test(nc_test4 tst_szip)
|
|
ENDIF()
|
|
ENDIF()
|
|
|
|
|
|
# Copy some test files from current source dir to out-of-tree build dir.
|
|
FILE(GLOB COPY_FILES ${CMAKE_CURRENT_SOURCE_DIR}/*.nc ${CMAKE_CURRENT_SOURCE_DIR}/ref_bzip2.c ${CMAKE_CURRENT_SOURCE_DIR}/*.sh ${CMAKE_CURRENT_SOURCE_DIR}/*.h5 ${CMAKE_CURRENT_SOURCE_DIR}/*.cdl)
|
|
FILE(COPY ${COPY_FILES} DESTINATION ${CMAKE_CURRENT_BINARY_DIR}/)
|
|
IF(MSVC)
|
|
FILE(COPY ${COPY_FILES} DESTINATION ${RUNTIME_OUTPUT_DIRECTORY}/)
|
|
ENDIF()
|
|
|
|
FOREACH(CTEST ${NC4_TESTS})
|
|
add_bin_test(nc_test4 ${CTEST})
|
|
SET_TESTS_PROPERTIES(nc_test4_${CTEST} PROPERTIES ENVIRONMENT srcdir=${CMAKE_CURRENT_SOURCE_DIR})
|
|
ENDFOREACH()
|
|
|
|
IF(TEST_PARALLEL4)
|
|
build_bin_test(tst_mpi_parallel)
|
|
build_bin_test(tst_parallel)
|
|
build_bin_test(tst_parallel3)
|
|
build_bin_test(tst_parallel4)
|
|
build_bin_test(tst_parallel5)
|
|
build_bin_test(tst_parallel_zlib)
|
|
build_bin_test(tst_parallel_compress)
|
|
build_bin_test(tst_nc4perf)
|
|
build_bin_test(tst_mode)
|
|
build_bin_test(tst_simplerw_coll_r)
|
|
build_bin_test(tst_quantize_par)
|
|
add_sh_test(nc_test4 run_par_test)
|
|
ENDIF()
|