mirror of
https://github.com/Unidata/netcdf-c.git
synced 2024-12-27 08:49:16 +08:00
59e04ae071
cloud using a variant of the Zarr protocol and storage format. This enhancement is generically referred to as "NCZarr". The data model supported by NCZarr is netcdf-4 minus the user-defined types and the String type. In this sense it is similar to the CDF-5 data model. More detailed information about enabling and using NCZarr is described in the document NUG/nczarr.md and in a [Unidata Developer's blog entry](https://www.unidata.ucar.edu/blogs/developer/en/entry/overview-of-zarr-support-in). WARNING: this code has had limited testing, so do use this version for production work. Also, performance improvements are ongoing. Note especially the following platform matrix of successful tests: Platform | Build System | S3 support ------------------------------------ Linux+gcc | Automake | yes Linux+gcc | CMake | yes Visual Studio | CMake | no Additionally, and as a consequence of the addition of NCZarr, major changes have been made to the Filter API. NOTE: NCZarr does not yet support filters, but these changes are enablers for that support in the future. Note that it is possible (probable?) that there will be some accidental reversions if the changes here did not correctly mimic the existing filter testing. In any case, previously filter ids and parameters were of type unsigned int. In order to support the more general zarr filter model, this was all converted to char*. The old HDF5-specific, unsigned int operations are still supported but they are wrappers around the new, char* based nc_filterx_XXX functions. This entailed at least the following changes: 1. Added the files libdispatch/dfilterx.c and include/ncfilter.h 2. Some filterx utilities have been moved to libdispatch/daux.c 3. A new entry, "filter_actions" was added to the NCDispatch table and the version bumped. 4. An overly complex set of structs was created to support funnelling all of the filterx operations thru a single dispatch "filter_actions" entry. 5. Move common code to from libhdf5 to libsrc4 so that it is accessible to nczarr. Changes directly related to Zarr: 1. Modified CMakeList.txt and configure.ac to support both C and C++ -- this is in support of S3 support via the awd-sdk libraries. 2. Define a size64_t type to support nczarr. 3. More reworking of libdispatch/dinfermodel.c to support zarr and to regularize the structure of the fragments section of a URL. Changes not directly related to Zarr: 1. Make client-side filter registration be conditional, with default off. 2. Hack include/nc4internal.h to make some flags added by Ed be unique: e.g. NC_CREAT, NC_INDEF, etc. 3. cleanup include/nchttp.h and libdispatch/dhttp.c. 4. Misc. changes to support compiling under Visual Studio including: * Better testing under windows for dirent.h and opendir and closedir. 5. Misc. changes to the oc2 code to support various libcurl CURLOPT flags and to centralize error reporting. 6. By default, suppress the vlen tests that have unfixed memory leaks; add option to enable them. 7. Make part of the nc_test/test_byterange.sh test be contingent on remotetest.unidata.ucar.edu being accessible. Changes Left TO-DO: 1. fix provenance code, it is too HDF5 specific.
249 lines
12 KiB
C
249 lines
12 KiB
C
/* Copyright 2019 University Corporation for Atmospheric
|
|
Research/Unidata. */
|
|
|
|
/*
|
|
* In order to use any of the netcdf_XXX.h files, it is necessary
|
|
* to include netcdf.h followed by any netcdf_XXX.h files.
|
|
* Various things (like EXTERNL) are defined in netcdf.h
|
|
* to make them available for use by the netcdf_XXX.h files.
|
|
*/
|
|
|
|
/**
|
|
* @file
|
|
* This header contains the definition of the dispatch table. This
|
|
* table contains a pointer to every netcdf function. When a file is
|
|
* opened or created, the dispatch code in libdispatch decides which
|
|
* dispatch table to use, and all subsequent netCDF calls for that
|
|
* file will use the selected dispatch table. There are dispatch
|
|
* tables for HDF5, HDF4, pnetcdf, etc.
|
|
*
|
|
* @author Dennis Heimbigner, Ed Hartnett
|
|
*/
|
|
|
|
#ifndef NETCDF_DISPATCH_H
|
|
#define NETCDF_DISPATCH_H
|
|
|
|
/* This is the version of the dispatch table. It should be changed
|
|
* when new functions are added to the dispatch table. */
|
|
#define NC_DISPATCH_VERSION 2
|
|
|
|
/* Forward */
|
|
struct NC_Filterobject;
|
|
|
|
/* This is the dispatch table, with a pointer to each netCDF
|
|
* function. */
|
|
struct NC_Dispatch
|
|
{
|
|
int model; /* one of the NC_FORMATX #'s */
|
|
int dispatch_version;
|
|
|
|
int (*create)(const char *path, int cmode, size_t initialsz,
|
|
int basepe, size_t *chunksizehintp, void *parameters,
|
|
const struct NC_Dispatch *table, int ncid);
|
|
int (*open)(const char *path, int mode, int basepe, size_t *chunksizehintp,
|
|
void *parameters, const struct NC_Dispatch *table, int ncid);
|
|
|
|
int (*redef)(int);
|
|
int (*_enddef)(int,size_t,size_t,size_t,size_t);
|
|
int (*sync)(int);
|
|
int (*abort)(int);
|
|
int (*close)(int, void *);
|
|
int (*set_fill)(int, int, int *);
|
|
int (*inq_format)(int, int*);
|
|
int (*inq_format_extended)(int, int *, int *);
|
|
|
|
int (*inq)(int, int *, int *, int *, int *);
|
|
int (*inq_type)(int, nc_type, char *, size_t *);
|
|
|
|
int (*def_dim)(int, const char *, size_t, int *);
|
|
int (*inq_dimid)(int, const char *, int *);
|
|
int (*inq_dim)(int, int, char *, size_t *);
|
|
int (*inq_unlimdim)(int ncid, int *unlimdimidp);
|
|
int (*rename_dim)(int, int, const char *);
|
|
|
|
int (*inq_att)(int, int, const char *, nc_type *, size_t *);
|
|
int (*inq_attid)(int, int, const char *, int*);
|
|
int (*inq_attname)(int, int, int, char *);
|
|
int (*rename_att)(int, int, const char *, const char *);
|
|
int (*del_att)(int, int, const char *);
|
|
int (*get_att)(int, int, const char *, void *, nc_type);
|
|
int (*put_att)(int, int, const char *, nc_type, size_t, const void *,
|
|
nc_type);
|
|
|
|
int (*def_var)(int, const char *, nc_type, int, const int *, int *);
|
|
int (*inq_varid)(int, const char *, int *);
|
|
int (*rename_var)(int, int, const char *);
|
|
|
|
int (*get_vara)(int, int, const size_t *, const size_t *, void *, nc_type);
|
|
int (*put_vara)(int, int, const size_t *, const size_t *,
|
|
const void *, nc_type);
|
|
|
|
int (*get_vars)(int, int, const size_t *, const size_t *, const ptrdiff_t *,
|
|
void *, nc_type);
|
|
int (*put_vars)(int, int, const size_t *, const size_t *, const ptrdiff_t *,
|
|
const void *, nc_type);
|
|
|
|
int (*get_varm)(int, int, const size_t *, const size_t *, const ptrdiff_t *,
|
|
const ptrdiff_t *, void *, nc_type);
|
|
int (*put_varm)(int, int, const size_t *, const size_t *, const ptrdiff_t *,
|
|
const ptrdiff_t *, const void *, nc_type);
|
|
|
|
int (*inq_var_all)(int ncid, int varid, char *name, nc_type *xtypep,
|
|
int *ndimsp, int *dimidsp, int *nattsp,
|
|
int *shufflep, int *deflatep, int *deflate_levelp,
|
|
int *fletcher32p, int *contiguousp, size_t *chunksizesp,
|
|
int *no_fill, void *fill_valuep, int *endiannessp,
|
|
unsigned int *idp, size_t *nparamsp,
|
|
unsigned int *params);
|
|
|
|
int (*var_par_access)(int, int, int);
|
|
int (*def_var_fill)(int, int, int, const void *);
|
|
|
|
/* Note the following are specific to netcdf4, but must still be
|
|
implemented by all dispatch tables. They may still be invoked by
|
|
netcdf client code even when the file is a classic file; they
|
|
will just return an error or be ignored.
|
|
*/
|
|
|
|
int (*show_metadata)(int);
|
|
int (*inq_unlimdims)(int, int*, int*);
|
|
int (*inq_ncid)(int, const char*, int*);
|
|
int (*inq_grps)(int, int*, int*);
|
|
int (*inq_grpname)(int, char*);
|
|
int (*inq_grpname_full)(int, size_t*, char*);
|
|
int (*inq_grp_parent)(int, int*);
|
|
int (*inq_grp_full_ncid)(int, const char*, int*);
|
|
int (*inq_varids)(int, int* nvars, int*);
|
|
int (*inq_dimids)(int, int* ndims, int*, int);
|
|
int (*inq_typeids)(int, int* ntypes, int*);
|
|
int (*inq_type_equal)(int, nc_type, int, nc_type, int*);
|
|
int (*def_grp)(int, const char*, int*);
|
|
int (*rename_grp)(int, const char*);
|
|
int (*inq_user_type)(int, nc_type, char*, size_t*, nc_type*, size_t*, int*);
|
|
int (*inq_typeid)(int, const char*, nc_type*);
|
|
|
|
int (*def_compound)(int, size_t, const char *, nc_type *);
|
|
int (*insert_compound)(int, nc_type, const char *, size_t, nc_type);
|
|
int (*insert_array_compound)(int, nc_type, const char *, size_t, nc_type,
|
|
int, const int *);
|
|
int (*inq_compound_field)(int, nc_type, int, char *, size_t *, nc_type *,
|
|
int *, int *);
|
|
int (*inq_compound_fieldindex)(int, nc_type, const char *, int *);
|
|
int (*def_vlen)(int, const char *, nc_type base_typeid, nc_type *);
|
|
int (*put_vlen_element)(int, int, void *, size_t, const void *);
|
|
int (*get_vlen_element)(int, int, const void *, size_t *, void *);
|
|
int (*def_enum)(int, nc_type, const char *, nc_type *);
|
|
int (*insert_enum)(int, nc_type, const char *, const void *);
|
|
int (*inq_enum_member)(int, nc_type, int, char *, void *);
|
|
int (*inq_enum_ident)(int, nc_type, long long, char *);
|
|
int (*def_opaque)(int, size_t, const char *, nc_type*);
|
|
int (*def_var_deflate)(int, int, int, int, int);
|
|
int (*def_var_fletcher32)(int, int, int);
|
|
int (*def_var_chunking)(int, int, int, const size_t *);
|
|
int (*def_var_endian)(int, int, int);
|
|
int (*def_var_filter)(int, int, unsigned int, size_t, const unsigned int *);
|
|
int (*set_var_chunk_cache)(int, int, size_t, size_t, float);
|
|
int (*get_var_chunk_cache)(int ncid, int varid, size_t *sizep,
|
|
size_t *nelemsp, float *preemptionp);
|
|
|
|
/* Dispatch table Version 2 or later */
|
|
/* Handle all filter related actions. */
|
|
int (*filter_actions)(int ncid, int varid, int action, void*);
|
|
};
|
|
|
|
#if defined(__cplusplus)
|
|
extern "C" {
|
|
#endif
|
|
|
|
/* Read-only dispatch layers can use these functions to return
|
|
* NC_EPERM to all attempts to modify a file. */
|
|
EXTERNL int NC_RO_create(const char *path, int cmode, size_t initialsz, int basepe,
|
|
size_t *chunksizehintp, void* parameters,
|
|
const NC_Dispatch*, int);
|
|
EXTERNL int NC_RO_redef(int ncid);
|
|
EXTERNL int NC_RO__enddef(int ncid, size_t h_minfree, size_t v_align, size_t v_minfree,
|
|
size_t r_align);
|
|
EXTERNL int NC_RO_sync(int ncid);
|
|
EXTERNL int NC_RO_def_var_fill(int, int, int, const void *);
|
|
EXTERNL int NC_RO_rename_att(int ncid, int varid, const char *name,
|
|
const char *newname);
|
|
EXTERNL int NC_RO_del_att(int ncid, int varid, const char*);
|
|
EXTERNL int NC_RO_put_att(int ncid, int varid, const char *name, nc_type datatype,
|
|
size_t len, const void *value, nc_type);
|
|
EXTERNL int NC_RO_def_var(int ncid, const char *name,
|
|
nc_type xtype, int ndims, const int *dimidsp, int *varidp);
|
|
EXTERNL int NC_RO_rename_var(int ncid, int varid, const char *name);
|
|
EXTERNL int NC_RO_put_vara(int ncid, int varid,
|
|
const size_t *start, const size_t *count,
|
|
const void *value, nc_type);
|
|
EXTERNL int NC_RO_def_dim(int ncid, const char *name, size_t len, int *idp);
|
|
EXTERNL int NC_RO_rename_dim(int ncid, int dimid, const char *name);
|
|
EXTERNL int NC_RO_set_fill(int ncid, int fillmode, int *old_modep);
|
|
|
|
/* These functions are for dispatch layers that don't implement
|
|
* the enhanced model. They return NC_ENOTNC4. */
|
|
EXTERNL int NC_NOTNC4_def_var_filter(int, int, unsigned int, size_t,
|
|
const unsigned int*);
|
|
EXTERNL int NC_NOTNC4_def_grp(int, const char *, int *);
|
|
EXTERNL int NC_NOTNC4_rename_grp(int, const char *);
|
|
EXTERNL int NC_NOTNC4_def_compound(int, size_t, const char *, nc_type *);
|
|
EXTERNL int NC_NOTNC4_insert_compound(int, nc_type, const char *, size_t, nc_type);
|
|
EXTERNL int NC_NOTNC4_insert_array_compound(int, nc_type, const char *, size_t,
|
|
nc_type, int, const int *);
|
|
EXTERNL int NC_NOTNC4_inq_typeid(int, const char *, nc_type *);
|
|
EXTERNL int NC_NOTNC4_inq_compound_field(int, nc_type, int, char *, size_t *,
|
|
nc_type *, int *, int *);
|
|
EXTERNL int NC_NOTNC4_inq_compound_fieldindex(int, nc_type, const char *, int *);
|
|
EXTERNL int NC_NOTNC4_def_vlen(int, const char *, nc_type base_typeid, nc_type *);
|
|
EXTERNL int NC_NOTNC4_put_vlen_element(int, int, void *, size_t, const void *);
|
|
EXTERNL int NC_NOTNC4_get_vlen_element(int, int, const void *, size_t *, void *);
|
|
EXTERNL int NC_NOTNC4_def_enum(int, nc_type, const char *, nc_type *);
|
|
EXTERNL int NC_NOTNC4_insert_enum(int, nc_type, const char *, const void *);
|
|
EXTERNL int NC_NOTNC4_inq_enum_member(int, nc_type, int, char *, void *);
|
|
EXTERNL int NC_NOTNC4_inq_enum_ident(int, nc_type, long long, char *);
|
|
EXTERNL int NC_NOTNC4_def_opaque(int, size_t, const char *, nc_type *);
|
|
EXTERNL int NC_NOTNC4_def_var_deflate(int, int, int, int, int);
|
|
EXTERNL int NC_NOTNC4_def_var_fletcher32(int, int, int);
|
|
EXTERNL int NC_NOTNC4_def_var_chunking(int, int, int, const size_t *);
|
|
EXTERNL int NC_NOTNC4_def_var_endian(int, int, int);
|
|
EXTERNL int NC_NOTNC4_set_var_chunk_cache(int, int, size_t, size_t, float);
|
|
EXTERNL int NC_NOTNC4_get_var_chunk_cache(int, int, size_t *, size_t *, float *);
|
|
EXTERNL int NC_NOTNC4_var_par_access(int, int, int);
|
|
EXTERNL int NC_NOTNC4_inq_ncid(int, const char *, int *);
|
|
EXTERNL int NC_NOTNC4_inq_grps(int, int *, int *);
|
|
EXTERNL int NC_NOTNC4_inq_grpname(int, char *);
|
|
EXTERNL int NC_NOTNC4_inq_grpname_full(int, size_t *, char *);
|
|
EXTERNL int NC_NOTNC4_inq_grp_parent(int, int *);
|
|
EXTERNL int NC_NOTNC4_inq_grp_full_ncid(int, const char *, int *);
|
|
EXTERNL int NC_NOTNC4_inq_varids(int, int *, int *);
|
|
EXTERNL int NC_NOTNC4_inq_dimids(int, int *, int *, int);
|
|
EXTERNL int NC_NOTNC4_inq_typeids(int, int *, int *);
|
|
EXTERNL int NC_NOTNC4_inq_user_type(int, nc_type, char *, size_t *,
|
|
nc_type *, size_t *, int *);
|
|
|
|
/* These functions are for dispatch layers that don't implement
|
|
* the enhanced model, but want to succeed anyway.
|
|
* They return NC_NOERR plus properly set the out parameters.
|
|
* In some cases (filter actions), some cases may succeed and some
|
|
* will fail.
|
|
*/
|
|
EXTERNL int NC_NOOP_filter_actions(int, int, int, void*);
|
|
EXTERNL int NC_NOTNC4_filter_actions(int, int, int, void*);
|
|
|
|
/* These functions are for dispatch layers that don't want to
|
|
* implement the deprecated varm functions. They return
|
|
* NC_ENOTNC3. */
|
|
EXTERNL int NC_NOTNC3_get_varm(int ncid, int varid, const size_t *start,
|
|
const size_t *edges, const ptrdiff_t *stride,
|
|
const ptrdiff_t *imapp, void *value0, nc_type memtype);
|
|
EXTERNL int NC_NOTNC3_put_varm(int ncid, int varid, const size_t * start,
|
|
const size_t *edges, const ptrdiff_t *stride,
|
|
const ptrdiff_t *imapp, const void *value0,
|
|
nc_type memtype);
|
|
|
|
#if defined(__cplusplus)
|
|
}
|
|
#endif
|
|
|
|
#endif /* NETCDF_DISPATCH_H */
|