netcdf-c/libdispatch/dnotnc4.c
Dennis Heimbigner 3ffe7be446 Enhance/Fix filter support
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.
2022-03-14 12:39:37 -06:00

688 lines
15 KiB
C

/* Copyright 2018, UCAR/Unidata See netcdf/COPYRIGHT file for copying
* and redistribution conditions.*/
/**
* @file
* @internal This file contains functions that
* can be used in dispatch tables to handle
* such things as unimplemented functions.
* As a rule, these functions will return NC_ENOTNC4.
* In some cases, the function may succeed and set
* appropriate output parameter values. These are indicated
* by the NC_NOOP prefix to the function name.
*
* @author Ed Hartnett, Dennis Heimbigner
*/
#include "netcdf.h"
#include "netcdf_filter.h"
#include "netcdf_aux.h"
#include "ncdispatch.h"
#include "nc4internal.h"
/**
* @internal Not implemented in some dispatch tables
*
* @param ncid Ignored.
* @param varid Ignored.
* @param quantize_mode Ignored.
* @param nsd Ignored.
*
* @return ::NC_ENOTNC4 Not implemented for a dispatch table
* @author Ed Hartnett
*/
int
NC_NOTNC4_def_var_quantize(int ncid, int varid, int quantize_mode, int nsd)
{
return NC_ENOTNC4;
}
/**
* @internal Not implemented in some dispatch tables
*
* @param ncid Ignored.
* @param varid Ignored.
* @param quantize_modep Ignored.
* @param nsdp Ignored.
*
* @return ::NC_ENOTNC4 Not implemented for a dispatch table
* @author Ed Hartnett
*/
int
NC_NOTNC4_inq_var_quantize(int ncid, int varid, int *quantize_modep,
int *nsdp)
{
return NC_ENOTNC4;
}
/**
* @internal Not implemented in some dispatch tables
*
* @param ncid Ignored.
* @param varid Ignored.
* @param id Ignored.
* @param nparams Ignored.
* @param parms Ignored.
*
* @return ::NC_ENOTNC4 Not implemented for a dispatch table
* @author Ed Hartnett
*/
int
NC_NOTNC4_def_var_filter(int ncid, int varid, unsigned int id, size_t nparams, const unsigned int* parms)
{
return NC_ENOTNC4;
}
int
NC_NOTNC4_inq_var_filter_ids(int ncid, int varid, size_t* nfilters, unsigned int* filterids)
{
return NC_ENOTNC4;
}
int
NC_NOTNC4_inq_var_filter_info(int ncid, int varid, unsigned int id, size_t* nparams, unsigned int* params)
{
return NC_ENOTNC4;
}
int
NC_NOOP_inq_var_filter_ids(int ncid, int varid, size_t* nfilters, unsigned int* filterids)
{
if(nfilters) *nfilters = 0;
return NC_NOERR;
}
int
NC_NOOP_inq_var_filter_info(int ncid, int varid, unsigned int id, size_t* nparams, unsigned int* params)
{
return NC_ENOFILTER;
}
int
NC_NOOP_inq_filter_avail(int ncid, unsigned id)
{
NC_UNUSED(ncid);
return NC_ENOFILTER;
}
/**
* @internal Not allowed for classic model.
*
* @param parent_ncid Ignored.
* @param name Ignored.
* @param new_ncid Ignored.
*
* @return ::NC_ENOTNC4 Not implemented for a dispatch table.
* @author Ed Hartnett
*/
int
NC_NOTNC4_def_grp(int parent_ncid, const char *name, int *new_ncid)
{
return NC_ENOTNC4;
}
/**
* @internal Not implemented for a dispatch table.
*
* @param grpid Ignored.
* @param name Ignored.
*
* @return ::NC_ENOTNC4 Not implemented for a dispatch table.
* @author Ed Hartnett
*/
int
NC_NOTNC4_rename_grp(int grpid, const char *name)
{
return NC_ENOTNC4;
}
/**
* @internal Not implemented for a dispatch table.
*
* @param ncid Ignored.
* @param size Ignored.
* @param name Ignored.
* @param typeidp Ignored.
*
* @return ::NC_ENOTNC4 Not implemented for a dispatch table.
* @author Ed Hartnett
*/
int
NC_NOTNC4_def_compound(int ncid, size_t size, const char *name, nc_type *typeidp)
{
return NC_ENOTNC4;
}
/**
* @internal Not implemented for a dispatch table.
*
* @param ncid Ignored.
* @param typeid1 Ignored.
* @param name Ignored.
* @param offset Ignored.
* @param field Ignored.
*
* @return ::NC_ENOTNC4 Not implemented for a dispatch table.
* @author Ed Hartnett
*/
int
NC_NOTNC4_insert_compound(int ncid, nc_type typeid1, const char *name, size_t offset,
nc_type field_typeid)
{
return NC_ENOTNC4;
}
/**
* @internal Not implemented for a dispatch table.
*
* @param ncid Ignored.
* @param typeid1 Ignored.
* @param name Ignored.
* @param offset Ignored.
* @param field Ignored.
* @param ndims Ignored.
* @param dim Ignored.
*
* @return ::NC_ENOTNC4 Not implemented for a dispatch table.
* @author Ed Hartnett
*/
extern int
NC_NOTNC4_insert_array_compound(int ncid, int typeid1, const char *name,
size_t offset, nc_type field_typeid,
int ndims, const int *dim_sizesp)
{
return NC_ENOTNC4;
}
/**
* @internal Not implemented for a dispatch table.
*
* @param ncid Ignored.
* @param typeid1 Ignored.
* @param fieldid Ignored.
* @param name Ignored.
* @param offsetp Ignored.
* @param field Ignored.
* @param ndimsp Ignored.
* @param dim Ignored.
*
* @return ::NC_ENOTNC4 Not implemented for a dispatch table.
* @author Ed Hartnett
*/
int
NC_NOTNC4_inq_compound_field(int ncid, nc_type typeid1, int fieldid, char *name,
size_t *offsetp, nc_type *field_typeidp, int *ndimsp,
int *dim_sizesp)
{
return NC_ENOTNC4;
}
/**
* @internal Not implemented for a dispatch table.
*
* @param ncid Ignored.
* @param typeid1 Ignored.
* @param name Ignored.
* @param fieldidp Ignored.
*
* @return ::NC_ENOTNC4 Not implemented for a dispatch table.
* @author Ed Hartnett
*/
int
NC_NOTNC4_inq_compound_fieldindex(int ncid, nc_type typeid1, const char *name, int *fieldidp)
{
return NC_ENOTNC4;
}
/* Opaque type. */
/**
* @internal Not implemented for a dispatch table.
*
* @param ncid Ignored.
* @param datum Ignored.
* @param name Ignored.
* @param typeidp Ignored.
*
* @return ::NC_ENOTNC4 Not implemented for a dispatch table.
* @author Ed Hartnett
*/
int
NC_NOTNC4_def_opaque(int ncid, size_t datum_size, const char *name,
nc_type *typeidp)
{
return NC_ENOTNC4;
}
/**
* @internal Not implemented for a dispatch table.
*
* @param ncid Ignored.
* @param name Ignored.
* @param base_typeid Ignored.
* @param typeidp Ignored.
*
* @return ::NC_ENOTNC4 Not implemented for a dispatch table.
* @author Ed Hartnett
*/
int
NC_NOTNC4_def_vlen(int ncid, const char *name, nc_type base_typeid,
nc_type *typeidp)
{
return NC_ENOTNC4;
}
/**
* @internal Not implemented for a dispatch table.
*
* @param ncid Ignored.
* @param base_typeid Ignored.
* @param name Ignored.
* @param typeidp Ignored.
*
* @return ::NC_ENOTNC4 Not implemented for a dispatch table.
* @author Ed Hartnett
*/
int
NC_NOTNC4_def_enum(int ncid, nc_type base_typeid, const char *name,
nc_type *typeidp)
{
return NC_ENOTNC4;
}
/**
* @internal Not implemented for a dispatch table.
*
* @param ncid Ignored.
* @param xtype Ignored.
* @param value Ignored.
* @param identifier Ignored.
*
* @return ::NC_ENOTNC4 Not implemented for a dispatch table.
* @author Ed Hartnett
*/
int
NC_NOTNC4_inq_enum_ident(int ncid, nc_type xtype, long long value, char *identifier)
{
return NC_ENOTNC4;
}
/**
* @internal Not implemented for a dispatch table.
*
* @param ncid Ignored.
* @param typeid1 Ignored.
* @param idx Ignored.
* @param identifier Ignored.
* @param value Ignored.
*
* @return ::NC_ENOTNC4 Not implemented for a dispatch table.
* @author Ed Hartnett
*/
int
NC_NOTNC4_inq_enum_member(int ncid, nc_type typeid1, int idx, char *identifier,
void *value)
{
return NC_ENOTNC4;
}
/**
* @internal Not implemented for a dispatch table.
*
* @param ncid Ignored.
* @param typeid1 Ignored.
* @param identifier Ignored.
* @param value Ignored.
*
* @return ::NC_ENOTNC4 Not implemented for a dispatch table.
* @author Ed Hartnett
*/
int
NC_NOTNC4_insert_enum(int ncid, nc_type typeid1, const char *identifier,
const void *value)
{
return NC_ENOTNC4;
}
/**
* @internal Not implemented for a dispatch table.
*
* @param ncid Ignored.
* @param typeid1 Ignored.
* @param vlen_element Ignored.
* @param len Ignored.
* @param data Ignored.
*
* @return ::NC_NOERR No error.
* @author Ed Hartnett
*/
int
NC_NOTNC4_put_vlen_element(int ncid, int typeid1, void *vlen_element,
size_t len, const void *data)
{
return NC_ENOTNC4;
}
/**
* @internal Not implemented for a dispatch table.
*
* @param ncid Ignored.
* @param typeid1 Ignored.
* @param vlen_element Ignored.
* @param len Ignored.
* @param data Ignored.
*
* @return ::NC_ENOTNC4 Not implemented for a dispatch table.
* @author Ed Hartnett
*/
int
NC_NOTNC4_get_vlen_element(int ncid, int typeid1, const void *vlen_element,
size_t *len, void *data)
{
return NC_ENOTNC4;
}
/**
* @internal Not implemented for a dispatch table.
*
* @param ncid Ignored.
* @param varid Ignored.
* @param size Ignored.
* @param nelems Ignored.
* @param preemption Ignored.
*
* @return ::NC_ENOTNC4 Not implemented for a dispatch table.
* @author Ed Hartnett
*/
int
NC_NOTNC4_set_var_chunk_cache(int ncid, int varid, size_t size, size_t nelems,
float preemption)
{
return NC_ENOTNC4;
}
/**
* @internal Not implemented for a dispatch table.
*
* @param ncid Ignored.
* @param varid Ignored.
* @param sizep Ignored.
* @param nelemsp Ignored.
* @param preemptionp Ignored.
*
* @return ::NC_ENOTNC4 Not implemented for a dispatch table.
* @author Ed Hartnett
*/
int
NC_NOTNC4_get_var_chunk_cache(int ncid, int varid, size_t *sizep,
size_t *nelemsp, float *preemptionp)
{
return NC_ENOTNC4;
}
/**
* @internal Not implemented for a dispatch table.
*
* @param ncid Ignored.
* @param varid Ignored.
* @param shuffle Ignored.
* @param deflate Ignored.
* @param deflate_level Ignored.
*
* @return ::NC_ENOTNC4 Not implemented for a dispatch table.
* @author Ed Hartnett, Dennis Heimbigner
*/
int
NC_NOTNC4_def_var_deflate(int ncid, int varid, int shuffle, int deflate,
int deflate_level)
{
return NC_ENOTNC4;
}
/**
* @internal Not implemented for a dispatch table.
*
* @param ncid Ignored.
* @param varid Ignored.
* @param fletcher32 Ignored.
*
* @return ::NC_ENOTNC4 Not implemented for a dispatch table.
* @author Ed Hartnett, Dennis Heimbigner
*/
int
NC_NOTNC4_def_var_fletcher32(int ncid, int varid, int fletcher32)
{
return NC_ENOTNC4;
}
/**
* @internal Not implemented for a dispatch table.
*
* @param ncid Ignored.
* @param varid Ignored.
* @param contiguous Ignored.
* @param chunksizesp Ignored.
*
* @return ::NC_ENOTNC4 Not implemented for a dispatch table.
* @author Ed Hartnett, Dennis Heimbigner
*/
int
NC_NOTNC4_def_var_chunking(int ncid, int varid, int contiguous, const size_t *chunksizesp)
{
return NC_EPERM;
}
/**
* @internal Not implemented for a dispatch table.
*
* @param ncid Ignored.
* @param varid Ignored.
* @param endianness Ignored.
*
* @return ::NC_ENOTNC4 Not implemented for a dispatch table.
* @author Ed Hartnett
*/
int
NC_NOTNC4_def_var_endian(int ncid, int varid, int endianness)
{
return NC_ENOTNC4;
}
/**
* @internal Not implemented for a dispatch table.
*
* @param ncid Ignored.
* @param varid Ignored.
* @param par_access Ignored.
*
* @return ::NC_ENOTNC4 Not implemented for a dispatch table.
* @author Ed Hartnett, Dennis Heimbigner
*/
int
NC_NOTNC4_var_par_access(int ncid, int varid, int par_access)
{
return NC_ENOTNC4;
}
/**
* @internal Not implemented for a dispatch table.
*
* @param ncid Ignored.
* @param name Ignored.
* @param grp_ncid Ignored.
*
* @return ::NC_ENOTNC4 Not implemented for a dispatch table.
* @author Ed Hartnett
*/
int
NC_NOTNC4_inq_ncid(int ncid, const char *name, int *grp_ncid)
{
return NC_ENOTNC4;
}
/**
* @internal Not implemented for a dispatch table.
*
* @param ncid Ignored.
* @param numgrps Ignored.
* @param ncids Ignored.
*
* @return ::NC_ENOTNC4 Not implemented for a dispatch table.
* @author Ed Hartnett
*/
int
NC_NOTNC4_inq_grps(int ncid, int *numgrps, int *ncids)
{
return NC_ENOTNC4;
}
/**
* @internal Not implemented for a dispatch table.
*
* @param ncid Ignored.
* @param name Ignored.
* @return ::NC_ENOTNC4 Not implemented for a dispatch table.
* @author Ed Hartnett
*/
int
NC_NOTNC4_inq_grpname(int ncid, char *name)
{
return NC_ENOTNC4;
}
/**
* @internal Not implemented for a dispatch table.
*
* @param ncid Ignored.
* @param lenp Ignored.
* @param full_name Ignored.
*
* @return ::NC_ENOTNC4 Not implemented for a dispatch table.
* @author Ed Hartnett
*/
int
NC_NOTNC4_inq_grpname_full(int ncid, size_t *lenp, char *full_name)
{
return NC_ENOTNC4;
}
/**
* @internal Not implemented for a dispatch table.
*
* @param ncid Ignored.
* @param parent_ncid Ignored.
*
* @return ::NC_ENOTNC4 Not implemented for a dispatch table.
* @author Ed Hartnett
*/
int
NC_NOTNC4_inq_grp_parent(int ncid, int *parent_ncid)
{
return NC_ENOTNC4;
}
/**
* @internal Not implemented for a dispatch table.
*
* @param ncid Ignored.
* @param full_name Ignored.
* @param grp_ncid Ignored.
*
* @return ::NC_ENOTNC4 Not implemented for a dispatch table.
* @author Ed Hartnett
*/
int
NC_NOTNC4_inq_grp_full_ncid(int ncid, const char *full_name, int *grp_ncid)
{
return NC_ENOTNC4;
}
/**
* @internal Not implemented for a dispatch table.
*
* @param ncid Ignored.
* @param nvars Ignored.
* @param varids Ignored.
*
* @return ::NC_ENOTNC4 Not implemented for a dispatch table.
* @author Ed Hartnett
*/
int
NC_NOTNC4_inq_varids(int ncid, int *nvars, int *varids)
{
return NC_ENOTNC4;
}
/**
* @internal Not implemented for a dispatch table.
*
* @param ncid Ignored.
* @param ndims Ignored.
* @param dimids Ignored.
* @param include_parents Ignored.
*
* @return ::NC_ENOTNC4 Not implemented for a dispatch table.
* @author Ed Hartnett
*/
int
NC_NOTNC4_inq_dimids(int ncid, int *ndims, int *dimids, int include_parents)
{
return NC_ENOTNC4;
}
/**
* @internal Not implemented for a dispatch table.
*
* @param ncid Ignored.
* @param ntypes Ignored.
* @param typeids Ignored.
*
* @return ::NC_ENOTNC4 Not implemented for a dispatch table.
* @author Ed Hartnett
*/
int
NC_NOTNC4_inq_typeids(int ncid, int *ntypes, int *typeids)
{
return NC_ENOTNC4;
}
/**
* @internal Not implemented for a dispatch table.
*
* @param ncid Ignored.
* @param typeid1 Ignored.
* @param name Ignored.
* @param size Ignored.
* @param base_nc_typep Ignored.
* @param nfieldsp Ignored.
* @param classp Ignored.
*
* @return ::NC_ENOTNC4 Not implemented for a dispatch table.
* @author Ed Hartnett
*/
int
NC_NOTNC4_inq_user_type(int ncid, nc_type typeid1, char *name, size_t *size,
nc_type *base_nc_typep, size_t *nfieldsp, int *classp)
{
return NC_ENOTNC4;
}
/**
* @internal Get the id of a type from the name.
*
* @param ncid Ignored.
* @param name Ignored.
* @param typeidp Ignored.
*
* @return ::NC_ENOTNC4 Not implemented for a dispatch table.
* @author Ed Hartnett
*/
int
NC_NOTNC4_inq_typeid(int ncid, const char *name, nc_type *typeidp)
{
/* Note that this should actually work for atomic types */
return NC_ENOTNC4;
}