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.
85 lines
3.0 KiB
C
85 lines
3.0 KiB
C
/*********************************************************************
|
|
* Copyright 2018, UCAR/Unidata
|
|
* See netcdf/COPYRIGHT file for copying and redistribution conditions.
|
|
*********************************************************************/
|
|
#ifndef ZDEBUG_H
|
|
#define ZDEBUG_H
|
|
|
|
#undef ZDEBUG /* general debug */
|
|
#undef ZDEBUG1 /* detailed debug */
|
|
|
|
#undef ZCATCH /* Warning: significant performance impact */
|
|
#undef ZTRACING /* Warning: significant performance impact */
|
|
|
|
#include "ncexternl.h"
|
|
#include "nclog.h"
|
|
|
|
#ifdef LOGGING
|
|
#define ZLOG(tag,...) nclog(tag,__VA_ARGS__)
|
|
#else
|
|
#define ZLOG(tag,...)
|
|
#endif
|
|
|
|
#ifdef ZCATCH
|
|
/* Place breakpoint on zbreakpoint to catch errors close to where they occur*/
|
|
#define THROW(e) zthrow((e),__FILE__, __func__, __LINE__)
|
|
#define REPORT(e,msg) zreport((e),(msg),__FILE__, __func__, __LINE__)
|
|
#define ZCHECK(e) if((e)) {THROW(stat); goto done;} else {}
|
|
EXTERNL int zbreakpoint(int err);
|
|
EXTERNL int zthrow(int err, const char* fname, const char* fcn, int line);
|
|
EXTERNL int zreport(int err, const char* msg, const char* fname, const char* fcn, int line);
|
|
#else
|
|
#define ZCHECK(e) {if((e)) {goto done;}}
|
|
#define THROW(e) (e)
|
|
#define REPORT(e,msg) (e)
|
|
#endif
|
|
|
|
#ifdef ZTRACING
|
|
#define ZTRACE(level,fmt,...) nctrace((level),__func__,fmt,##__VA_ARGS__)
|
|
#define ZTRACEMORE(level,fmt,...) nctracemore((level),fmt,##__VA_ARGS__)
|
|
#define ZUNTRACE(e) ncuntrace(__func__,THROW(e),NULL)
|
|
#define ZUNTRACEX(e,fmt,...) ncuntrace(__func__,THROW(e),fmt,##__VA_ARGS__)
|
|
#else
|
|
#define ZTRACE(level,fmt,...)
|
|
#define ZTRACEMORE(level,fmt,...)
|
|
#define ZUNTRACE(e) (e)
|
|
#define ZUNTRACEX(e,fmt,...) (e)
|
|
#endif
|
|
|
|
/* printers */
|
|
EXTERNL void nczprint_reclaim(void);
|
|
EXTERNL char* nczprint_slice(NCZSlice);
|
|
EXTERNL char* nczprint_slices(int rank, const NCZSlice*);
|
|
EXTERNL char* nczprint_slab(int rank, const NCZSlice*);
|
|
EXTERNL char* nczprint_odom(const NCZOdometer*);
|
|
EXTERNL char* nczprint_chunkrange(const NCZChunkRange);
|
|
EXTERNL char* nczprint_projection(const NCZProjection);
|
|
EXTERNL char* nczprint_sliceprojections(const NCZSliceProjections);
|
|
EXTERNL char* nczprint_allsliceprojections(int r, const NCZSliceProjections* slp);
|
|
EXTERNL char* nczprint_slicex(const NCZSlice slice, int raw);
|
|
EXTERNL char* nczprint_slicesx(int rank, const NCZSlice* slices, int raw);
|
|
EXTERNL char* nczprint_projectionx(const NCZProjection proj, int raw);
|
|
EXTERNL char* nczprint_sliceprojectionsx(const NCZSliceProjections slp, int raw);
|
|
EXTERNL char* nczprint_vector(size_t,const size64_t*);
|
|
EXTERNL char* nczprint_idvector(size_t,const int*);
|
|
EXTERNL char* nczprint_paramvector(size_t,const unsigned*);
|
|
EXTERNL char* nczprint_sizevector(size_t,const size_t*);
|
|
EXTERNL char* nczprint_envv(const char** envv);
|
|
|
|
EXTERNL void zdumpcommon(const struct Common*);
|
|
|
|
/* Define the possible unit tests (powers of 2) */
|
|
#define UTEST_RANGE 1
|
|
#define UTEST_WALK 2
|
|
#define UTEST_TRANSFER 4
|
|
#define UTEST_WHOLECHUNK 8
|
|
|
|
struct ZUTEST {
|
|
int tests;
|
|
void (*print)(int sort,...);
|
|
};
|
|
EXTERNL struct ZUTEST* zutest;
|
|
|
|
#endif /*ZDEBUG_H*/
|
|
|