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.
85 lines
2.6 KiB
C
85 lines
2.6 KiB
C
/* Copyright 2018-2018 University Corporation for Atmospheric
|
|
Research/Unidata. */
|
|
/**
|
|
* @file
|
|
* @internal Contains information for creating provenance
|
|
* info and/or displaying provenance info.
|
|
*
|
|
* It has come to pass that we can't guarantee that this information is
|
|
* contained only within netcdf4 files. As a result, we need
|
|
* to make printing these hidden attributes available to
|
|
* netcdf3 as well.
|
|
*
|
|
*
|
|
* For netcdf4 files, capture state information about the following:
|
|
* - Global: netcdf library version
|
|
* - Global: hdf5 library version
|
|
* - Global: any parameters specified by the --with-ncproperties option for ./configure
|
|
* - Per file: superblock version
|
|
* - Per File: was it created by netcdf-4?
|
|
* - Per file: _NCProperties attribute
|
|
*
|
|
* @author Dennis Heimbigner, Ward Fisher
|
|
*
|
|
* [This file is too hdf5 specific, need to clean so we can use with Zarr]
|
|
*/
|
|
|
|
#ifndef _NCPROVENANCE_
|
|
#define _NCPROVENANCE_
|
|
|
|
#define NCPROPS "_NCProperties"
|
|
#define NCPVERSION "version" /* Of the properties format */
|
|
#define NCPHDF5LIB1 "hdf5libversion"
|
|
#define NCPNCLIB1 "netcdflibversion"
|
|
#define NCPHDF5LIB2 "hdf5"
|
|
#define NCPNCLIB2 "netcdf"
|
|
#define NCPROPS_VERSION (2)
|
|
/* Version 2 changes this because '|' was causing bash problems */
|
|
#define NCPROPSSEP1 '|'
|
|
#define NCPROPSSEP2 ','
|
|
|
|
/* Other hidden attributes */
|
|
#define ISNETCDF4ATT "_IsNetcdf4"
|
|
#define SUPERBLOCKATT "_SuperblockVersion"
|
|
|
|
/* Forward */
|
|
struct NC_FILE_INFO;
|
|
|
|
/**************************************************/
|
|
/**
|
|
For netcdf4 files, capture state information about the following:
|
|
1. Global: netcdf library version
|
|
2. Global: hdf5 library version
|
|
3. Per file: superblock version
|
|
4. Per File: was it created by netcdf-4?
|
|
5. Per file: _NCProperties attribute
|
|
*/
|
|
|
|
typedef struct NC4_Provenance {
|
|
char* ncproperties; /* raw value of _NCProperties; NULL => does not exist */
|
|
int version;
|
|
int superblockversion;
|
|
} NC4_Provenance;
|
|
|
|
/* Provenance Management (moved from nc4internal.h) */
|
|
|
|
/* Initialize the provenance global state */
|
|
extern int NC4_provenance_init(void);
|
|
|
|
/* Finalize the provenance global state */
|
|
extern int NC4_provenance_finalize(void);
|
|
|
|
/* Read and store the provenance from an existing file */
|
|
extern int NC4_read_provenance(struct NC_FILE_INFO* file);
|
|
|
|
/* Write the provenance into a newly created file */
|
|
extern int NC4_write_provenance(struct NC_FILE_INFO* file);
|
|
|
|
/* Create the provenance for a newly created file */
|
|
extern int NC4_new_provenance(struct NC_FILE_INFO* file);
|
|
|
|
/* Clean up the provenance info in a file */
|
|
extern int NC4_clear_provenance(NC4_Provenance* prov);
|
|
|
|
#endif /* _NCPROVENANCE_ */
|