mirror of
https://github.com/Unidata/netcdf-c.git
synced 2025-01-30 16:10:44 +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.
266 lines
6.5 KiB
C
266 lines
6.5 KiB
C
/* Copyright 2018-2018 University Corporation for Atmospheric
|
|
Research/Unidata. */
|
|
/**
|
|
* @file
|
|
* @internal Includes prototypes for libsrc4 dispatch functions.
|
|
*
|
|
* @author Dennis Heimbigner, Ed Hartnett
|
|
*/
|
|
|
|
#ifndef _NC4DISPATCH_H
|
|
#define _NC4DISPATCH_H
|
|
|
|
#include "config.h"
|
|
#include <stddef.h> /* size_t, ptrdiff_t */
|
|
#include "ncdispatch.h"
|
|
|
|
#define NCLOGLEVELENV "NETCDF_LOG_LEVEL"
|
|
|
|
#if defined(__cplusplus)
|
|
extern "C" {
|
|
#endif
|
|
|
|
EXTERNL int
|
|
NC4_create(const char *path, int cmode,
|
|
size_t initialsz, int basepe, size_t *chunksizehintp,
|
|
void* parameters, const NC_Dispatch*, int);
|
|
|
|
EXTERNL int
|
|
NC4_open(const char *path, int mode,
|
|
int basepe, size_t *chunksizehintp,
|
|
void* parameters, const NC_Dispatch*, int);
|
|
|
|
EXTERNL int
|
|
NC4_redef(int ncid);
|
|
|
|
EXTERNL int
|
|
NC4__enddef(int ncid, size_t h_minfree, size_t v_align,
|
|
size_t v_minfree, size_t r_align);
|
|
|
|
EXTERNL int
|
|
NC4_sync(int ncid);
|
|
|
|
EXTERNL int
|
|
NC4_abort(int ncid);
|
|
|
|
EXTERNL int
|
|
NC4_close(int ncid,void*);
|
|
|
|
EXTERNL int
|
|
NC4_set_fill(int ncid, int fillmode, int *old_modep);
|
|
|
|
EXTERNL int
|
|
NC4_inq_format(int ncid, int *formatp);
|
|
|
|
EXTERNL int
|
|
NC4_inq_format_extended(int ncid, int *formatp, int *modep);
|
|
|
|
EXTERNL int
|
|
NC4_inq(int ncid, int *ndimsp, int *nvarsp, int *nattsp, int *unlimdimidp);
|
|
|
|
EXTERNL int
|
|
NC4_inq_type(int, nc_type, char *, size_t *);
|
|
|
|
/* Begin _dim */
|
|
|
|
EXTERNL int
|
|
NC4_def_dim(int ncid, const char *name, size_t len, int *idp);
|
|
|
|
EXTERNL int
|
|
NC4_inq_dimid(int ncid, const char *name, int *idp);
|
|
|
|
EXTERNL int
|
|
NC4_inq_dim(int ncid, int dimid, char *name, size_t *lenp);
|
|
|
|
EXTERNL int
|
|
NC4_inq_unlimdim(int ncid, int *unlimdimidp);
|
|
|
|
EXTERNL int
|
|
NC4_rename_dim(int ncid, int dimid, const char *name);
|
|
|
|
/* End _dim */
|
|
/* Begin _att */
|
|
|
|
EXTERNL int
|
|
NC4_inq_att(int ncid, int varid, const char *name,
|
|
nc_type *xtypep, size_t *lenp);
|
|
|
|
EXTERNL int
|
|
NC4_inq_attid(int ncid, int varid, const char *name, int *idp);
|
|
|
|
EXTERNL int
|
|
NC4_inq_attname(int ncid, int varid, int attnum, char *name);
|
|
|
|
/* End _att */
|
|
/* Begin {put,get}_att */
|
|
|
|
EXTERNL int
|
|
NC4_get_att(int ncid, int varid, const char *name, void *value, nc_type);
|
|
|
|
/* End {put,get}_att */
|
|
/* Begin _var */
|
|
|
|
EXTERNL int
|
|
NC4_def_var(int ncid, const char *name,
|
|
nc_type xtype, int ndims, const int *dimidsp, int *varidp);
|
|
|
|
EXTERNL int
|
|
NC4_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);
|
|
|
|
EXTERNL int
|
|
NC4_inq_varid(int ncid, const char *name, int *varidp);
|
|
|
|
EXTERNL int
|
|
NC4_rename_var(int ncid, int varid, const char *name);
|
|
|
|
EXTERNL int
|
|
NC4_put_vara(int ncid, int varid,
|
|
const size_t *start, const size_t *count,
|
|
const void *value, nc_type);
|
|
|
|
EXTERNL int
|
|
NC4_get_vara(int ncid, int varid,
|
|
const size_t *start, const size_t *count,
|
|
void *value, nc_type);
|
|
|
|
extern int
|
|
NC4_put_vars(int ncid, int varid,
|
|
const size_t *start, const size_t *count, const ptrdiff_t* stride,
|
|
const void *value, nc_type);
|
|
|
|
extern int
|
|
NC4_get_vars(int ncid, int varid,
|
|
const size_t *start, const size_t *count, const ptrdiff_t* stride,
|
|
void *value, nc_type);
|
|
|
|
/* End _var */
|
|
|
|
/* netCDF4 API only */
|
|
EXTERNL int
|
|
NC4_var_par_access(int, int, int);
|
|
|
|
EXTERNL int
|
|
NC4_inq_ncid(int, const char *, int *);
|
|
|
|
EXTERNL int
|
|
NC4_inq_grps(int, int *, int *);
|
|
|
|
EXTERNL int
|
|
NC4_inq_grpname(int, char *);
|
|
|
|
EXTERNL int
|
|
NC4_inq_grpname_full(int, size_t *, char *);
|
|
|
|
EXTERNL int
|
|
NC4_inq_grp_parent(int, int *);
|
|
|
|
EXTERNL int
|
|
NC4_inq_grp_full_ncid(int, const char *, int *);
|
|
|
|
EXTERNL int
|
|
NC4_inq_varids(int, int * nvars, int *);
|
|
|
|
EXTERNL int
|
|
NC4_inq_dimids(int, int * ndims, int *, int);
|
|
|
|
EXTERNL int
|
|
NC4_inq_typeids(int, int * ntypes, int *);
|
|
|
|
EXTERNL int
|
|
NC4_inq_type_equal(int, nc_type, int, nc_type, int *);
|
|
|
|
EXTERNL int
|
|
NC4_def_grp(int, const char *, int *);
|
|
|
|
EXTERNL int
|
|
NC4_rename_grp(int, const char *);
|
|
|
|
EXTERNL int
|
|
NC4_inq_user_type(int, nc_type, char *, size_t *, nc_type *,
|
|
size_t *, int *);
|
|
|
|
EXTERNL int
|
|
NC4_def_compound(int, size_t, const char *, nc_type *);
|
|
|
|
EXTERNL int
|
|
NC4_insert_compound(int, nc_type, const char *, size_t, nc_type);
|
|
|
|
EXTERNL int
|
|
NC4_insert_array_compound(int, nc_type, const char *, size_t,
|
|
nc_type, int, const int *);
|
|
|
|
EXTERNL int
|
|
NC4_inq_typeid(int, const char *, nc_type *);
|
|
|
|
EXTERNL int
|
|
NC4_inq_compound_field(int, nc_type, int, char *, size_t *,
|
|
nc_type *, int *, int *);
|
|
|
|
EXTERNL int
|
|
NC4_inq_compound_fieldindex(int, nc_type, const char *, int *);
|
|
|
|
EXTERNL int
|
|
NC4_def_vlen(int, const char *, nc_type base_typeid, nc_type *);
|
|
|
|
EXTERNL int
|
|
NC4_put_vlen_element(int, int, void *, size_t, const void *);
|
|
|
|
EXTERNL int
|
|
NC4_get_vlen_element(int, int, const void *, size_t *, void *);
|
|
|
|
EXTERNL int
|
|
NC4_def_enum(int, nc_type, const char *, nc_type *);
|
|
|
|
EXTERNL int
|
|
NC4_insert_enum(int, nc_type, const char *, const void *);
|
|
|
|
EXTERNL int
|
|
NC4_inq_enum_member(int, nc_type, int, char *, void *);
|
|
|
|
EXTERNL int
|
|
NC4_inq_enum_ident(int, nc_type, long long, char *);
|
|
|
|
EXTERNL int
|
|
NC4_def_opaque(int, size_t, const char *, nc_type *);
|
|
|
|
EXTERNL int
|
|
NC4_def_var_deflate(int, int, int, int, int);
|
|
|
|
EXTERNL int
|
|
NC4_def_var_fletcher32(int, int, int);
|
|
|
|
EXTERNL int
|
|
NC4_def_var_chunking(int, int, int, const size_t *);
|
|
|
|
EXTERNL int
|
|
NC4_def_var_fill(int, int, int, const void *);
|
|
|
|
EXTERNL int
|
|
NC4_def_var_endian(int, int, int);
|
|
|
|
EXTERNL int
|
|
NC4_def_var_filter(int, int, unsigned int, size_t, const unsigned int*);
|
|
|
|
EXTERNL int
|
|
NC4_get_var_chunk_cache(int, int, size_t *, size_t *, float *);
|
|
|
|
EXTERNL int
|
|
NC4_inq_unlimdims(int, int *, int *);
|
|
|
|
EXTERNL int
|
|
NC4_show_metadata(int);
|
|
|
|
EXTERNL int
|
|
NC4_filter_actions(int, int, int, void*);
|
|
|
|
#if defined(__cplusplus)
|
|
}
|
|
#endif
|
|
|
|
#endif /*_NC4DISPATCH_H */
|