netcdf-c/include/nc_provenance.h
Dennis Heimbigner eb3d9eb0c9 Provide a Number of fixes/improvements to NCZarr
Primary changes:
* Add an improved cache system to speed up performance.
* Fix NCZarr to properly handle scalar variables.

Misc. Related Changes:
* Added unit tests for extendible hash and for the generic cache.
* Add config parameter to set size of the NCZarr cache.
* Add initial performance tests but leave them unused.
* Add CRC64 support.
* Move location of ncdumpchunks utility from /ncgen to /ncdump.
* Refactor auth support.

Misc. Unrelated Changes:
* More cleanup of the S3 support
* Add support for S3 authentication in .rc files: HTTP.S3.ACCESSID and HTTP.S3.SECRETKEY.
* Remove the hashkey from the struct OBJHDR since it is never used.
2020-11-19 17:01:04 -07:00

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 | nczarr library versions
* - 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
*
*/
#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 | nczarr 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_ */