/* Copyright 2018-2018 University Corporation for Atmospheric Research/Unidata. */ /** * @file This header file contains macros, types, and prototypes for * the HDF5 code in libhdf5. This header should not be included in * code outside libhdf5. * * @author Ed Hartnett */ #ifndef _HDF5INTERNAL_ #define _HDF5INTERNAL_ #include "config.h" #include #include #include "nc4internal.h" #include "ncdimscale.h" #include "nc4dispatch.h" #include "hdf5dispatch.h" #include "netcdf_filter.h" #define NC_MAX_HDF5_NAME (NC_MAX_NAME + 10) /* These have to do with creating chunked datasets in HDF5. */ #define NC_HDF5_UNLIMITED_DIMSIZE (0) #define NC_HDF5_CHUNKSIZE_FACTOR (10) #define NC_HDF5_MIN_CHUNK_SIZE (2) #define NC_EMPTY_SCALE "NC_EMPTY_SCALE" /* This is an attribute I had to add to handle multidimensional * coordinate variables. */ #define COORDINATES "_Netcdf4Coordinates" #define COORDINATES_LEN (NC_MAX_NAME * 5) /* This is used when the user defines a non-coordinate variable with * same name as a dimension. */ #define NON_COORD_PREPEND "_nc4_non_coord_" /* An attribute in the HDF5 root group of this name means that the * file must follow strict netCDF classic format rules. */ #define NC3_STRICT_ATT_NAME "_nc3_strict" /* If this attribute is present on a dimscale variable, use the value * as the netCDF dimid. */ #define NC_DIMID_ATT_NAME "_Netcdf4Dimid" /** This is the name of the class HDF5 dimension scale attribute. */ #define HDF5_DIMSCALE_CLASS_ATT_NAME "CLASS" /** This is the name of the name HDF5 dimension scale attribute. */ #define HDF5_DIMSCALE_NAME_ATT_NAME "NAME" /** Define Filter API Operations */ #define FILTER_REG 1 #define FILTER_UNREG 2 #define FILTER_INQ 3 /** Struct to hold HDF5-specific info for the file. */ typedef struct NC_HDF5_FILE_INFO { hid_t hdfid; #ifdef ENABLE_BYTERANGE struct HTTP { NCURI* uri; /* Parse of the incoming path, if url */ int iosp; /* We are using the S3 rawvirtual file driver */ } http; #endif } NC_HDF5_FILE_INFO_T; /* This is a struct to handle the dim metadata. */ typedef struct NC_HDF5_DIM_INFO { hid_t hdf_dimscaleid; /* Non-zero if a DIM_WITHOUT_VARIABLE dataset is in use (no coord var). */ HDF5_OBJID_T hdf5_objid; } NC_HDF5_DIM_INFO_T; /** Strut to hold HDF5-specific info for attributes. */ typedef struct NC_HDF5_ATT_INFO { hid_t native_hdf_typeid; /* Native HDF5 datatype for attribute's data */ } NC_HDF5_ATT_INFO_T; /* Struct to hold HDF5-specific info for a group. */ typedef struct NC_HDF5_GRP_INFO { hid_t hdf_grpid; } NC_HDF5_GRP_INFO_T; /* Struct to hold HDF5-specific info for a variable. */ typedef struct NC_HDF5_VAR_INFO { hid_t hdf_datasetid; HDF5_OBJID_T *dimscale_hdf5_objids; } NC_HDF5_VAR_INFO_T; /* Struct to hold HDF5-specific info for a field. */ typedef struct NC_HDF5_FIELD_INFO { hid_t hdf_typeid; hid_t native_hdf_typeid; } NC_HDF5_FIELD_INFO_T; /* Struct to hold HDF5-specific info for a type. */ typedef struct NC_HDF5_TYPE_INFO { hid_t hdf_typeid; hid_t native_hdf_typeid; } NC_HDF5_TYPE_INFO_T; /* Forward */ struct NC_FILTER_OBJ_HDF5; /* Logging and debugging. */ void reportopenobjects(int log, hid_t); int hdf5_set_log_level(); /* These functions deal with HDF5 dimension scales. */ int rec_detach_scales(NC_GRP_INFO_T *grp, int dimid, hid_t dimscaleid); int rec_reattach_scales(NC_GRP_INFO_T *grp, int dimid, hid_t dimscaleid); int delete_dimscale_dataset(NC_GRP_INFO_T *grp, int dimid, NC_DIM_INFO_T *dim); /* Write metadata. */ int nc4_rec_write_metadata(NC_GRP_INFO_T *grp, nc_bool_t bad_coord_order); int nc4_rec_write_groups_types(NC_GRP_INFO_T *grp); /* Adjust the cache. */ int nc4_adjust_var_cache(NC_GRP_INFO_T *grp, NC_VAR_INFO_T * var); /* Open a HDF5 dataset. */ int nc4_open_var_grp2(NC_GRP_INFO_T *grp, int varid, hid_t *dataset); /* Find types. */ NC_TYPE_INFO_T *nc4_rec_find_hdf_type(NC_FILE_INFO_T* h5, hid_t target_hdf_typeid); int nc4_get_hdf_typeid(NC_FILE_INFO_T *h5, nc_type xtype, hid_t *hdf_typeid, int endianness); /* Enddef and closing files. */ int nc4_close_hdf5_file(NC_FILE_INFO_T *h5, int abort, NC_memio *memio); int nc4_rec_grp_HDF5_del(NC_GRP_INFO_T *grp); int nc4_enddef_netcdf4_file(NC_FILE_INFO_T *h5); /* Break & reform coordinate variables */ int nc4_break_coord_var(NC_GRP_INFO_T *grp, NC_VAR_INFO_T *coord_var, NC_DIM_INFO_T *dim); int nc4_reform_coord_var(NC_GRP_INFO_T *grp, NC_VAR_INFO_T *coord_var, NC_DIM_INFO_T *dim); /* In-memory functions */ extern hid_t NC4_image_init(NC_FILE_INFO_T* h5); extern void NC4_image_finalize(void*); /* Create HDF5 dataset for dim without a coord var. */ extern int nc4_create_dim_wo_var(NC_DIM_INFO_T *dim); /* Give a var a secret HDF5 name, for use when there is a dim of this * name, but the var is not a coord var of that dim. */ extern int nc4_give_var_secret_name(NC_VAR_INFO_T *var); /* Get the fill value for a var. */ int nc4_get_fill_value(NC_FILE_INFO_T *h5, NC_VAR_INFO_T *var, void **fillp); /* Find file, group, var, and att info, doing lazy reads if needed. */ int nc4_hdf5_find_grp_var_att(int ncid, int varid, const char *name, int attnum, int use_name, char *norm_name, NC_FILE_INFO_T **h5, NC_GRP_INFO_T **grp, NC_VAR_INFO_T **var, NC_ATT_INFO_T **att); /* Find var, doing lazy var metadata read if needed. */ int nc4_hdf5_find_grp_h5_var(int ncid, int varid, NC_FILE_INFO_T **h5, NC_GRP_INFO_T **grp, NC_VAR_INFO_T **var); /* Perform lazy read of the rest of the metadata for a var. */ int nc4_get_var_meta(NC_VAR_INFO_T *var); /* Define Filter API Function */ int nc4_global_filter_action(int action, unsigned int id, struct NC_FILTER_OBJ_HDF5* infop); int NC4_hdf5_addfilter(NC_VAR_INFO_T* var, int active, unsigned int id, size_t nparams, unsigned int* params); int NC4_hdf5_remove_filter(NC_VAR_INFO_T* var, unsigned int filterid); /* Support functions for provenance info (defined in nc4hdf.c) */ extern int NC4_hdf5get_libversion(unsigned*,unsigned*,unsigned*);/*libsrc4/nc4hdf.c*/ extern int NC4_hdf5get_superblock(struct NC_FILE_INFO*, int*);/*libsrc4/nc4hdf.c*/ extern int NC4_isnetcdf4(struct NC_FILE_INFO*); /*libsrc4/nc4hdf.c*/ extern int nc4_find_default_chunksizes2(NC_GRP_INFO_T *grp, NC_VAR_INFO_T *var); #endif /* _HDF5INTERNAL_ */