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.
323 lines
7.0 KiB
C
323 lines
7.0 KiB
C
/* Copyright 2005-2018 University Corporation for Atmospheric
|
|
Research/Unidata. */
|
|
|
|
/**
|
|
* @file
|
|
* @internal This header file contains prototypes and initialization
|
|
* for the ZARR dispatch layer.
|
|
*
|
|
* @author Dennis Heimbigner, Ed Hartnett
|
|
*/
|
|
|
|
#include "zincludes.h"
|
|
|
|
/* Forward */
|
|
static int NCZ_var_par_access(int ncid, int varid, int par_access);
|
|
static int NCZ_show_metadata(int ncid);
|
|
|
|
static const NC_Dispatch NCZ_dispatcher = {
|
|
|
|
NC_FORMATX_NCZARR,
|
|
NC_DISPATCH_VERSION,
|
|
|
|
NCZ_create,
|
|
NCZ_open,
|
|
|
|
NCZ_redef,
|
|
NCZ__enddef,
|
|
NCZ_sync,
|
|
NCZ_abort,
|
|
NCZ_close,
|
|
NCZ_set_fill,
|
|
NCZ_inq_format,
|
|
NCZ_inq_format_extended,
|
|
|
|
NCZ_inq,
|
|
NCZ_inq_type,
|
|
|
|
NCZ_def_dim,
|
|
NCZ_inq_dimid,
|
|
NCZ_inq_dim,
|
|
NCZ_inq_unlimdim,
|
|
NCZ_rename_dim,
|
|
|
|
NCZ_inq_att,
|
|
NCZ_inq_attid,
|
|
NCZ_inq_attname,
|
|
NCZ_rename_att,
|
|
NCZ_del_att,
|
|
NCZ_get_att,
|
|
NCZ_put_att,
|
|
|
|
NCZ_def_var,
|
|
NCZ_inq_varid,
|
|
NCZ_rename_var,
|
|
NCZ_get_vara,
|
|
NCZ_put_vara,
|
|
NCZ_get_vars,
|
|
NCZ_put_vars,
|
|
NCDEFAULT_get_varm,
|
|
NCDEFAULT_put_varm,
|
|
|
|
NCZ_inq_var_all,
|
|
|
|
NCZ_var_par_access,
|
|
NCZ_def_var_fill,
|
|
|
|
NCZ_show_metadata,
|
|
NCZ_inq_unlimdims,
|
|
|
|
NCZ_inq_ncid,
|
|
NCZ_inq_grps,
|
|
NCZ_inq_grpname,
|
|
NCZ_inq_grpname_full,
|
|
NCZ_inq_grp_parent,
|
|
NCZ_inq_grp_full_ncid,
|
|
NCZ_inq_varids,
|
|
NCZ_inq_dimids,
|
|
NCZ_inq_typeids,
|
|
NCZ_inq_type_equal,
|
|
NCZ_def_grp,
|
|
NCZ_rename_grp,
|
|
NCZ_inq_user_type,
|
|
NCZ_inq_typeid,
|
|
|
|
NC_NOTNC4_def_compound,
|
|
NC_NOTNC4_insert_compound,
|
|
NC_NOTNC4_insert_array_compound,
|
|
NC_NOTNC4_inq_compound_field,
|
|
NC_NOTNC4_inq_compound_fieldindex,
|
|
NC_NOTNC4_def_vlen,
|
|
NC_NOTNC4_put_vlen_element,
|
|
NC_NOTNC4_get_vlen_element,
|
|
NC_NOTNC4_def_enum,
|
|
NC_NOTNC4_insert_enum,
|
|
NC_NOTNC4_inq_enum_member,
|
|
NC_NOTNC4_inq_enum_ident,
|
|
NC_NOTNC4_def_opaque,
|
|
NCZ_def_var_deflate,
|
|
NCZ_def_var_fletcher32,
|
|
NCZ_def_var_chunking,
|
|
NCZ_def_var_endian,
|
|
NCZ_def_var_filter,
|
|
NCZ_set_var_chunk_cache,
|
|
NC4_get_var_chunk_cache,
|
|
NCZ_inq_var_filter_ids,
|
|
NCZ_inq_var_filter_info,
|
|
NCZ_def_var_quantize,
|
|
NCZ_inq_var_quantize,
|
|
NCZ_inq_filter_avail,
|
|
};
|
|
|
|
const NC_Dispatch* NCZ_dispatch_table = NULL; /* moved here from ddispatch.c */
|
|
|
|
/**
|
|
* @internal Initialize the ZARR dispatch layer.
|
|
*
|
|
* @return ::NC_NOERR No error.
|
|
* @author Dennis Heimbigner, Ed Hartnett
|
|
*/
|
|
int ncz_initialized = 0; /**< True if initialization has happened. */
|
|
|
|
int
|
|
NCZ_initialize(void)
|
|
{
|
|
int stat;
|
|
NCZ_dispatch_table = &NCZ_dispatcher;
|
|
if (!ncz_initialized)
|
|
NCZ_initialize_internal();
|
|
stat = NCZ_provenance_init();
|
|
if(stat) ncz_initialized = 1;
|
|
return stat;
|
|
}
|
|
|
|
/**
|
|
* @internal Finalize the ZARR dispatch layer.
|
|
*
|
|
* @return ::NC_NOERR No error.
|
|
* @author Dennis Heimbigner
|
|
*/
|
|
int
|
|
NCZ_finalize(void)
|
|
{
|
|
NCZ_finalize_internal();
|
|
NCZ_provenance_finalize();
|
|
return NC_NOERR;
|
|
}
|
|
|
|
static int
|
|
NCZ_var_par_access(int ncid, int varid, int par_access)
|
|
{
|
|
return NC_NOERR; /* no-op */
|
|
}
|
|
|
|
static int
|
|
NCZ_show_metadata(int ncid)
|
|
{
|
|
return NC_NOERR;
|
|
}
|
|
|
|
#ifndef ENABLE_NCZARR_FILTERS
|
|
int
|
|
NCZ_def_var_filter(int ncid, int varid, unsigned int id , size_t n , const unsigned int *params)
|
|
{
|
|
NC_UNUSED(ncid);
|
|
NC_UNUSED(varid);
|
|
NC_UNUSED(id);
|
|
NC_UNUSED(n);
|
|
NC_UNUSED(params);
|
|
return REPORT(NC_NOERR,"def_var_filter");
|
|
}
|
|
|
|
int
|
|
NCZ_inq_var_filter_ids(int ncid, int varid, size_t* nfilters, unsigned int* filterids)
|
|
{
|
|
NC_UNUSED(ncid);
|
|
NC_UNUSED(varid);
|
|
NC_UNUSED(filterids);
|
|
if(nfilters) *nfilters = 0;
|
|
return REPORT(NC_NOERR,"inq_var_filter_ids");
|
|
}
|
|
|
|
int
|
|
NCZ_inq_var_filter_info(int ncid, int varid, unsigned int id, size_t* nparams, unsigned int* params)
|
|
{
|
|
NC_UNUSED(ncid);
|
|
NC_UNUSED(varid);
|
|
NC_UNUSED(id);
|
|
NC_UNUSED(nparams);
|
|
NC_UNUSED(params);
|
|
return REPORT(NC_ENOFILTER,"inq_var_filter_info");
|
|
}
|
|
|
|
int
|
|
NCZ_inq_filter_avail(int ncid, unsigned id)
|
|
{
|
|
NC_UNUSED(ncid);
|
|
NC_UNUSED(id);
|
|
return REPORT(NC_ENOFILTER,"inq_filter_avail");
|
|
}
|
|
|
|
|
|
#endif /*ENABLE_NCZARR_FILTERS*/
|
|
|
|
/**************************************************/
|
|
/* Following functions call into libsrc4 */
|
|
|
|
int
|
|
NCZ_inq_type(int ncid, nc_type xtype, char *name, size_t *size)
|
|
{
|
|
int stat = NC_NOERR;
|
|
ZTRACE(0,"NC4_inq_type(ncid,xtype,name,size)");
|
|
stat = NC4_inq_type(ncid,xtype,name,size);
|
|
return ZUNTRACE(stat);
|
|
}
|
|
|
|
int
|
|
NCZ_inq_dimid(int ncid, const char *name, int *idp)
|
|
{
|
|
int stat = NC_NOERR;
|
|
ZTRACE(0,"NC4_inq_dimid(ncid,name,idp)");
|
|
stat = NC4_inq_dimid(ncid,name,idp);
|
|
return ZUNTRACE(stat);
|
|
}
|
|
|
|
int
|
|
NCZ_inq_unlimdim(int ncid, int *unlimdimidp)
|
|
{
|
|
int stat = NC_NOERR;
|
|
ZTRACE(0,"NC4_inq_unlimdim(ncid,unlimdimidp)");
|
|
stat = NC4_inq_unlimdim(ncid,unlimdimidp);
|
|
return ZUNTRACE(stat);
|
|
}
|
|
|
|
int
|
|
NCZ_inq_varid(int ncid, const char* name, int *varidp)
|
|
{
|
|
int stat = NC_NOERR;
|
|
ZTRACE(0,"NC4_inq_varid(ncid,name,varidp)");
|
|
stat = NC4_inq_varid(ncid,name,varidp);
|
|
return ZUNTRACE(stat);
|
|
}
|
|
|
|
int
|
|
NCZ_inq_ncid(int ncid, const char* name, int* grpidp)
|
|
{
|
|
int stat = NC_NOERR;
|
|
ZTRACE(0,"NC4_inq_ncid(ncid,name,grpidp)");
|
|
stat = NC4_inq_ncid(ncid,name,grpidp);
|
|
return ZUNTRACE(stat);
|
|
}
|
|
|
|
int
|
|
NCZ_inq_grps(int ncid, int* n, int* ncids)
|
|
{
|
|
int stat = NC_NOERR;
|
|
ZTRACE(0,"NC4_inq_grps(ncid,n,ncids)");
|
|
stat = NC4_inq_grps(ncid,n,ncids);
|
|
return ZUNTRACE(stat);
|
|
}
|
|
|
|
int
|
|
NCZ_inq_grpname(int ncid, char* name)
|
|
{
|
|
int stat = NC_NOERR;
|
|
ZTRACE(0,"NC4_inq_grpname(ncid,name)");
|
|
stat = NC4_inq_grpname(ncid,name);
|
|
return ZUNTRACE(stat);
|
|
}
|
|
|
|
int
|
|
NCZ_inq_grpname_full(int ncid, size_t* lenp, char* fullname)
|
|
{
|
|
int stat = NC_NOERR;
|
|
ZTRACE(0,"NC4_inq_grpname_full(ncid,lenp,fullname)");
|
|
stat = NC4_inq_grpname_full(ncid,lenp,fullname);
|
|
return ZUNTRACE(stat);
|
|
}
|
|
|
|
int
|
|
NCZ_inq_grp_parent(int ncid, int* parentidp)
|
|
{
|
|
int stat = NC_NOERR;
|
|
ZTRACE(0,"NC4_inq_grp_parent(ncid,parentidp)");
|
|
stat = NC4_inq_grp_parent(ncid,parentidp);
|
|
return ZUNTRACE(stat);
|
|
}
|
|
|
|
int
|
|
NCZ_inq_grp_full_ncid(int ncid, const char* fullname, int* grpidp)
|
|
{
|
|
int stat = NC_NOERR;
|
|
ZTRACE(0,"NC4_inq_grp_full_ncid(ncid,fullname,grpidp)");
|
|
stat = NC4_inq_grp_full_ncid(ncid,fullname,grpidp);
|
|
return ZUNTRACE(stat);
|
|
}
|
|
|
|
int
|
|
NCZ_inq_varids(int ncid, int* nvars, int* varids)
|
|
{
|
|
int stat = NC_NOERR;
|
|
ZTRACE(0,"NC4_inq_varids(ncid,nvars,varids)");
|
|
stat = NC4_inq_varids(ncid,nvars,varids);
|
|
return ZUNTRACE(stat);
|
|
}
|
|
|
|
int
|
|
NCZ_inq_dimids(int ncid, int* ndims, int* dimids, int inclparents)
|
|
{
|
|
int stat = NC_NOERR;
|
|
ZTRACE(0,"NC4_inq_dimids(ncid,ndims,dimids,inclparents)");
|
|
stat = NC4_inq_dimids(ncid,ndims,dimids,inclparents);
|
|
return ZUNTRACE(stat);
|
|
}
|
|
|
|
int
|
|
NCZ_inq_user_type(int ncid, nc_type xtype, char* name, size_t* size, nc_type* basetid, size_t* nfields, int* classp)
|
|
{
|
|
int stat = NC_NOERR;
|
|
ZTRACE(0,"NC4_inq_user_type(ncid,xtype,name,size,basetid,nfields,classp)");
|
|
stat = NC4_inq_user_type(ncid,xtype,name,size,basetid,nfields,classp);
|
|
return ZUNTRACE(stat);
|
|
}
|