2018-07-17 22:29:47 +08:00
|
|
|
/* Copyright 2003-2018, University Corporation for Atmospheric
|
|
|
|
* Research. See COPYRIGHT file for copying and redistribution
|
|
|
|
* conditions. */
|
|
|
|
/**
|
|
|
|
* @file
|
|
|
|
* @internal This file contains functions that are used in file
|
|
|
|
* opens, both fast and slow.
|
|
|
|
*
|
|
|
|
* @author Ed Hartnett
|
|
|
|
*/
|
|
|
|
|
|
|
|
#include "config.h"
|
|
|
|
#include "hdf5internal.h"
|
|
|
|
|
|
|
|
#define NUM_TYPES 12 /**< Number of netCDF atomic types. */
|
|
|
|
#define CD_NELEMS_ZLIB 1 /**< Number of parameters needed for ZLIB filter. */
|
|
|
|
|
|
|
|
/** @internal Native HDF5 constants for atomic types. For performance,
|
|
|
|
* fill this array only the first time, and keep it in global memory
|
|
|
|
* for each further use. */
|
|
|
|
static hid_t h5_native_type_constant_g[NUM_TYPES];
|
|
|
|
|
|
|
|
/** @internal NetCDF atomic type names. */
|
|
|
|
static const char nc_type_name_g[NUM_TYPES][NC_MAX_NAME + 1] = {"char", "byte", "short",
|
|
|
|
"int", "float", "double", "ubyte",
|
|
|
|
"ushort", "uint", "int64",
|
|
|
|
"uint64", "string"};
|
|
|
|
|
|
|
|
/** @internal NetCDF atomic types. */
|
|
|
|
static const nc_type nc_type_constant_g[NUM_TYPES] = {NC_CHAR, NC_BYTE, NC_SHORT,
|
|
|
|
NC_INT, NC_FLOAT, NC_DOUBLE, NC_UBYTE,
|
|
|
|
NC_USHORT, NC_UINT, NC_INT64,
|
|
|
|
NC_UINT64, NC_STRING};
|
|
|
|
|
|
|
|
/** @internal NetCDF atomic type sizes. */
|
|
|
|
static const int nc_type_size_g[NUM_TYPES] = {sizeof(char), sizeof(char), sizeof(short),
|
|
|
|
sizeof(int), sizeof(float), sizeof(double), sizeof(unsigned char),
|
|
|
|
sizeof(unsigned short), sizeof(unsigned int), sizeof(long long),
|
|
|
|
sizeof(unsigned long long), sizeof(char *)};
|
|
|
|
|
|
|
|
/** @internal These flags may not be set for open mode. */
|
|
|
|
static const int ILLEGAL_OPEN_FLAGS = (NC_MMAP|NC_64BIT_OFFSET);
|
|
|
|
|
|
|
|
/* From hdf5file.c. */
|
|
|
|
extern size_t nc4_chunk_cache_size;
|
|
|
|
extern size_t nc4_chunk_cache_nelems;
|
|
|
|
extern float nc4_chunk_cache_preemption;
|
|
|
|
|
|
|
|
/* From nc4mem.c */
|
|
|
|
extern int NC4_open_image_file(NC_FILE_INFO_T* h5);
|
|
|
|
|
|
|
|
/* Defined later in this file. */
|
|
|
|
static int nc4_rec_read_metadata(NC_GRP_INFO_T *grp);
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @internal Struct to track information about objects in a group, for
|
|
|
|
* nc4_rec_read_metadata()
|
|
|
|
*/
|
|
|
|
typedef struct NC4_rec_read_metadata_obj_info
|
|
|
|
{
|
|
|
|
hid_t oid; /* HDF5 object ID */
|
|
|
|
char oname[NC_MAX_NAME + 1]; /* Name of object */
|
|
|
|
H5G_stat_t statbuf; /* Information about the object */
|
2018-07-17 23:03:19 +08:00
|
|
|
struct NC4_rec_read_metadata_obj_info *next; /* Pointer to next node in list */
|
2018-07-17 22:29:47 +08:00
|
|
|
} NC4_rec_read_metadata_obj_info_t;
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @internal User data struct for call to H5Literate() in
|
|
|
|
* nc4_rec_read_metadata(). Tracks the groups, named datatypes and
|
|
|
|
* datasets in the group, for later use.
|
|
|
|
*/
|
|
|
|
typedef struct NC4_rec_read_metadata_ud
|
|
|
|
{
|
|
|
|
NClist* grps; /* NClist<NC4_rec_read_metadata_obj_info_t*> */
|
|
|
|
NC_GRP_INFO_T *grp; /* Pointer to parent group */
|
|
|
|
} NC4_rec_read_metadata_ud_t;
|
|
|
|
|
|
|
|
/* Custom iteration callback data */
|
|
|
|
typedef struct {
|
|
|
|
NC_GRP_INFO_T *grp;
|
|
|
|
NC_VAR_INFO_T *var;
|
|
|
|
} att_iter_info;
|
|
|
|
|
|
|
|
/**
|
2018-07-17 23:03:19 +08:00
|
|
|
* @internal Given an HDF5 type, set a pointer to netcdf type_info
|
|
|
|
* struct, either an existing one (for user-defined types) or a newly
|
|
|
|
* created one.
|
2018-07-17 22:29:47 +08:00
|
|
|
*
|
|
|
|
* @param h5 Pointer to HDF5 file info struct.
|
|
|
|
* @param datasetid HDF5 dataset ID.
|
|
|
|
* @param type_info Pointer to pointer that gets type info struct.
|
|
|
|
*
|
|
|
|
* @return ::NC_NOERR No error.
|
|
|
|
* @return ::NC_EBADID Bad ncid.
|
|
|
|
* @return ::NC_EHDFERR HDF5 returned error.
|
|
|
|
* @return ::NC_EBADTYPID Type not found.
|
|
|
|
* @author Ed Hartnett
|
|
|
|
*/
|
|
|
|
static int
|
|
|
|
get_type_info2(NC_FILE_INFO_T *h5, hid_t datasetid,
|
|
|
|
NC_TYPE_INFO_T **type_info)
|
|
|
|
{
|
|
|
|
htri_t is_str, equal = 0;
|
|
|
|
H5T_class_t class;
|
|
|
|
hid_t native_typeid, hdf_typeid;
|
|
|
|
H5T_order_t order;
|
|
|
|
int t;
|
|
|
|
|
|
|
|
assert(h5 && type_info);
|
|
|
|
|
|
|
|
/* Because these N5T_NATIVE_* constants are actually function calls
|
|
|
|
* (!) in H5Tpublic.h, I can't initialize this array in the usual
|
|
|
|
* way, because at least some C compilers (like Irix) complain
|
|
|
|
* about calling functions when defining constants. So I have to do
|
|
|
|
* it like this. Note that there's no native types for char or
|
|
|
|
* string. Those are handled later. */
|
|
|
|
if (!h5_native_type_constant_g[1])
|
|
|
|
{
|
|
|
|
h5_native_type_constant_g[1] = H5T_NATIVE_SCHAR;
|
|
|
|
h5_native_type_constant_g[2] = H5T_NATIVE_SHORT;
|
|
|
|
h5_native_type_constant_g[3] = H5T_NATIVE_INT;
|
|
|
|
h5_native_type_constant_g[4] = H5T_NATIVE_FLOAT;
|
|
|
|
h5_native_type_constant_g[5] = H5T_NATIVE_DOUBLE;
|
|
|
|
h5_native_type_constant_g[6] = H5T_NATIVE_UCHAR;
|
|
|
|
h5_native_type_constant_g[7] = H5T_NATIVE_USHORT;
|
|
|
|
h5_native_type_constant_g[8] = H5T_NATIVE_UINT;
|
|
|
|
h5_native_type_constant_g[9] = H5T_NATIVE_LLONG;
|
|
|
|
h5_native_type_constant_g[10] = H5T_NATIVE_ULLONG;
|
|
|
|
}
|
|
|
|
|
|
|
|
/* Get the HDF5 typeid - we'll need it later. */
|
|
|
|
if ((hdf_typeid = H5Dget_type(datasetid)) < 0)
|
|
|
|
return NC_EHDFERR;
|
|
|
|
|
|
|
|
/* Get the native typeid. Will be equivalent to hdf_typeid when
|
|
|
|
* creating but not necessarily when reading, a variable. */
|
|
|
|
if ((native_typeid = H5Tget_native_type(hdf_typeid, H5T_DIR_DEFAULT)) < 0)
|
|
|
|
return NC_EHDFERR;
|
|
|
|
|
|
|
|
/* Is this type an integer, string, compound, or what? */
|
|
|
|
if ((class = H5Tget_class(native_typeid)) < 0)
|
|
|
|
return NC_EHDFERR;
|
|
|
|
|
|
|
|
/* Is this an atomic type? */
|
|
|
|
if (class == H5T_STRING || class == H5T_INTEGER || class == H5T_FLOAT)
|
|
|
|
{
|
|
|
|
/* Allocate a phony NC_TYPE_INFO_T struct to hold type info. */
|
|
|
|
if (!(*type_info = calloc(1, sizeof(NC_TYPE_INFO_T))))
|
|
|
|
return NC_ENOMEM;
|
|
|
|
|
|
|
|
/* H5Tequal doesn't work with H5T_C_S1 for some reason. But
|
|
|
|
* H5Tget_class will return H5T_STRING if this is a string. */
|
|
|
|
if (class == H5T_STRING)
|
|
|
|
{
|
|
|
|
if ((is_str = H5Tis_variable_str(native_typeid)) < 0)
|
|
|
|
return NC_EHDFERR;
|
2018-07-17 23:03:19 +08:00
|
|
|
/* Make sure fixed-len strings will work like variable-len
|
|
|
|
* strings */
|
2018-07-17 22:29:47 +08:00
|
|
|
if (is_str || H5Tget_size(hdf_typeid) > 1)
|
|
|
|
{
|
|
|
|
/* Set a class for the type */
|
|
|
|
t = NUM_TYPES - 1;
|
|
|
|
(*type_info)->nc_type_class = NC_STRING;
|
|
|
|
}
|
|
|
|
else
|
|
|
|
{
|
|
|
|
/* Set a class for the type */
|
|
|
|
t = 0;
|
|
|
|
(*type_info)->nc_type_class = NC_CHAR;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
else
|
|
|
|
{
|
|
|
|
for (t = 1; t < NUM_TYPES - 1; t++)
|
|
|
|
{
|
2018-07-17 23:03:19 +08:00
|
|
|
if ((equal = H5Tequal(native_typeid,
|
|
|
|
h5_native_type_constant_g[t])) < 0)
|
2018-07-17 22:29:47 +08:00
|
|
|
return NC_EHDFERR;
|
|
|
|
if (equal)
|
|
|
|
break;
|
|
|
|
}
|
|
|
|
|
2018-07-17 23:03:19 +08:00
|
|
|
/* Find out about endianness. As of HDF 1.8.6, this works
|
|
|
|
* with all data types Not just H5T_INTEGER. See
|
|
|
|
* https://www.hdfgroup.org/HDF5/doc/RM/RM_H5T.html#Datatype-GetOrder */
|
2018-07-17 22:29:47 +08:00
|
|
|
if((order = H5Tget_order(hdf_typeid)) < 0)
|
|
|
|
return NC_EHDFERR;
|
|
|
|
|
|
|
|
if(order == H5T_ORDER_LE)
|
|
|
|
(*type_info)->endianness = NC_ENDIAN_LITTLE;
|
|
|
|
else if(order == H5T_ORDER_BE)
|
|
|
|
(*type_info)->endianness = NC_ENDIAN_BIG;
|
|
|
|
else
|
|
|
|
return NC_EBADTYPE;
|
|
|
|
|
|
|
|
if(class == H5T_INTEGER)
|
|
|
|
(*type_info)->nc_type_class = NC_INT;
|
|
|
|
else
|
|
|
|
(*type_info)->nc_type_class = NC_FLOAT;
|
|
|
|
}
|
|
|
|
(*type_info)->hdr.id = nc_type_constant_g[t];
|
|
|
|
(*type_info)->size = nc_type_size_g[t];
|
|
|
|
if (!((*type_info)->hdr.name = strdup(nc_type_name_g[t])))
|
|
|
|
return NC_ENOMEM;
|
|
|
|
(*type_info)->hdf_typeid = hdf_typeid;
|
|
|
|
(*type_info)->native_hdf_typeid = native_typeid;
|
|
|
|
return NC_NOERR;
|
|
|
|
}
|
|
|
|
else
|
|
|
|
{
|
|
|
|
NC_TYPE_INFO_T *type;
|
|
|
|
|
|
|
|
/* This is a user-defined type. */
|
|
|
|
if((type = nc4_rec_find_hdf_type(h5, native_typeid)))
|
|
|
|
*type_info = type;
|
|
|
|
|
|
|
|
/* The type entry in the array of user-defined types already has
|
|
|
|
* an open data typeid (and native typeid), so close the ones we
|
|
|
|
* opened above. */
|
|
|
|
if (H5Tclose(native_typeid) < 0)
|
|
|
|
return NC_EHDFERR;
|
|
|
|
if (H5Tclose(hdf_typeid) < 0)
|
|
|
|
return NC_EHDFERR;
|
|
|
|
|
|
|
|
if (type)
|
|
|
|
return NC_NOERR;
|
|
|
|
}
|
|
|
|
|
|
|
|
return NC_EBADTYPID;
|
|
|
|
}
|
|
|
|
/**
|
|
|
|
* @internal This function reads the hacked in coordinates attribute I
|
|
|
|
* use for multi-dimensional coordinates.
|
|
|
|
*
|
|
|
|
* @param grp Group info pointer.
|
|
|
|
* @param var Var info pointer.
|
|
|
|
*
|
|
|
|
* @return NC_NOERR No error.
|
|
|
|
* @author Ed Hartnett
|
|
|
|
*/
|
|
|
|
static int
|
|
|
|
read_coord_dimids(NC_GRP_INFO_T *grp, NC_VAR_INFO_T *var)
|
|
|
|
{
|
|
|
|
hid_t coord_att_typeid = -1, coord_attid = -1, spaceid = -1;
|
|
|
|
hssize_t npoints;
|
|
|
|
int ret = 0;
|
|
|
|
int d;
|
|
|
|
|
|
|
|
/* There is a hidden attribute telling us the ids of the
|
|
|
|
* dimensions that apply to this multi-dimensional coordinate
|
|
|
|
* variable. Read it. */
|
|
|
|
if ((coord_attid = H5Aopen_name(var->hdf_datasetid, COORDINATES)) < 0) ret++;
|
|
|
|
if (!ret && (coord_att_typeid = H5Aget_type(coord_attid)) < 0) ret++;
|
|
|
|
|
|
|
|
/* How many dimensions are there? */
|
|
|
|
if (!ret && (spaceid = H5Aget_space(coord_attid)) < 0) ret++;
|
|
|
|
if (!ret && (npoints = H5Sget_simple_extent_npoints(spaceid)) < 0) ret++;
|
|
|
|
|
|
|
|
/* Check that the number of points is the same as the number of dimensions
|
|
|
|
* for the variable */
|
|
|
|
if (!ret && npoints != var->ndims) ret++;
|
|
|
|
|
|
|
|
if (!ret && H5Aread(coord_attid, coord_att_typeid, var->dimids) < 0) ret++;
|
|
|
|
LOG((4, "dimscale %s is multidimensional and has coords", var->hdr.name));
|
|
|
|
|
|
|
|
/* Update var->dim field based on the var->dimids */
|
|
|
|
for (d = 0; d < var->ndims; d++) {
|
|
|
|
/* Ok if does not find a dim at this time, but if found set it */
|
|
|
|
nc4_find_dim(grp, var->dimids[d], &var->dim[d], NULL);
|
|
|
|
}
|
|
|
|
|
|
|
|
/* Set my HDF5 IDs free! */
|
|
|
|
if (spaceid >= 0 && H5Sclose(spaceid) < 0) ret++;
|
|
|
|
if (coord_att_typeid >= 0 && H5Tclose(coord_att_typeid) < 0) ret++;
|
|
|
|
if (coord_attid >= 0 && H5Aclose(coord_attid) < 0) ret++;
|
|
|
|
return ret ? NC_EATTMETA : NC_NOERR;
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @internal This function is called when reading a file's metadata
|
|
|
|
* for each dimension scale attached to a variable.
|
|
|
|
*
|
|
|
|
* @param did HDF5 ID for dimscale.
|
|
|
|
* @param dim
|
|
|
|
* @param dsid
|
|
|
|
* @param dimscale_hdf5_objids
|
|
|
|
*
|
|
|
|
* @return 0 for success, -1 for error.
|
|
|
|
* @author Ed Hartnett
|
|
|
|
*/
|
|
|
|
static herr_t
|
|
|
|
dimscale_visitor(hid_t did, unsigned dim, hid_t dsid,
|
|
|
|
void *dimscale_hdf5_objids)
|
|
|
|
{
|
|
|
|
H5G_stat_t statbuf;
|
|
|
|
|
|
|
|
/* Get more info on the dimscale object.*/
|
|
|
|
if (H5Gget_objinfo(dsid, ".", 1, &statbuf) < 0)
|
|
|
|
return -1;
|
|
|
|
|
|
|
|
/* Pass this information back to caller. */
|
|
|
|
(*(HDF5_OBJID_T *)dimscale_hdf5_objids).fileno[0] = statbuf.fileno[0];
|
|
|
|
(*(HDF5_OBJID_T *)dimscale_hdf5_objids).fileno[1] = statbuf.fileno[1];
|
|
|
|
(*(HDF5_OBJID_T *)dimscale_hdf5_objids).objno[0] = statbuf.objno[0];
|
|
|
|
(*(HDF5_OBJID_T *)dimscale_hdf5_objids).objno[1] = statbuf.objno[1];
|
|
|
|
return 0;
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @internal Check for the attribute that indicates that netcdf
|
|
|
|
* classic model is in use.
|
|
|
|
*
|
|
|
|
* @param root_grp pointer to the group info for the root group of the
|
|
|
|
* @param is_classic store 1 if this is a classic file.
|
|
|
|
* file.
|
|
|
|
*
|
|
|
|
* @return NC_NOERR No error.
|
|
|
|
* @author Ed Hartnett
|
|
|
|
*/
|
|
|
|
static int
|
|
|
|
check_for_classic_model(NC_GRP_INFO_T *root_grp, int *is_classic)
|
|
|
|
{
|
|
|
|
htri_t attr_exists = -1;
|
|
|
|
|
|
|
|
/* Check inputs. */
|
|
|
|
assert(!root_grp->parent && is_classic);
|
|
|
|
|
|
|
|
/* If this attribute exists in the root group, then classic model
|
|
|
|
* is in effect. */
|
|
|
|
if ((attr_exists = H5Aexists(root_grp->hdf_grpid, NC3_STRICT_ATT_NAME)) < 0)
|
|
|
|
return NC_EHDFERR;
|
|
|
|
*is_classic = attr_exists ? 1 : 0;
|
|
|
|
|
|
|
|
return NC_NOERR;
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @internal Open a netcdf-4 file. Things have already been kicked off
|
|
|
|
* in ncfunc.c in nc_open, but here the netCDF-4 part of opening a
|
|
|
|
* file is handled.
|
|
|
|
*
|
|
|
|
* @param path The file name of the new file.
|
|
|
|
* @param mode The open mode flag.
|
|
|
|
* @param parameters File parameters.
|
|
|
|
* @param nc Pointer to NC file info.
|
|
|
|
*
|
|
|
|
* @return ::NC_NOERR No error.
|
|
|
|
* @author Ed Hartnett, Dennis Heimbigner
|
|
|
|
*/
|
|
|
|
static int
|
|
|
|
nc4_open_file(const char *path, int mode, void* parameters, NC *nc)
|
|
|
|
{
|
|
|
|
hid_t fapl_id = H5P_DEFAULT;
|
|
|
|
int retval;
|
|
|
|
unsigned flags;
|
|
|
|
NC_FILE_INFO_T *nc4_info = NULL;
|
|
|
|
int is_classic;
|
|
|
|
|
|
|
|
#ifdef USE_PARALLEL4
|
|
|
|
NC_MPI_INFO* mpiinfo = NULL;
|
|
|
|
int comm_duped = 0; /* Whether the MPI Communicator was duplicated */
|
|
|
|
int info_duped = 0; /* Whether the MPI Info object was duplicated */
|
|
|
|
#endif
|
|
|
|
|
|
|
|
LOG((3, "%s: path %s mode %d", __func__, path, mode));
|
|
|
|
assert(path && nc);
|
|
|
|
|
|
|
|
flags = (mode & NC_WRITE) ? H5F_ACC_RDWR : H5F_ACC_RDONLY;
|
|
|
|
|
|
|
|
/* Add necessary structs to hold netcdf-4 file data. */
|
|
|
|
if ((retval = nc4_nc4f_list_add(nc, path, mode)))
|
|
|
|
BAIL(retval);
|
|
|
|
nc4_info = NC4_DATA(nc);
|
|
|
|
assert(nc4_info && nc4_info->root_grp);
|
|
|
|
|
2018-07-20 02:32:06 +08:00
|
|
|
/* Add struct to hold HDF5-specific file metadata. */
|
|
|
|
if (!(nc4_info->format_file_info = calloc(1, sizeof(NC_HDF5_FILE_INFO_T))))
|
|
|
|
BAIL(NC_ENOMEM);
|
|
|
|
|
2018-07-17 22:29:47 +08:00
|
|
|
nc4_info->mem.inmemory = ((mode & NC_INMEMORY) == NC_INMEMORY);
|
|
|
|
nc4_info->mem.diskless = ((mode & NC_DISKLESS) == NC_DISKLESS);
|
|
|
|
if(nc4_info->mem.inmemory) {
|
|
|
|
NC_memio* memparams = NULL;
|
|
|
|
if(parameters == NULL)
|
|
|
|
BAIL(NC_EINMEMORY);
|
|
|
|
memparams = (NC_memio*)parameters;
|
|
|
|
nc4_info->mem.memio = *memparams; /* keep local copy */
|
|
|
|
/* As a safeguard, if !locked and NC_WRITE is set,
|
|
|
|
then we must take control of the incoming memory */
|
|
|
|
nc4_info->mem.locked = (nc4_info->mem.memio.flags & NC_MEMIO_LOCKED) == NC_MEMIO_LOCKED;
|
|
|
|
if(!nc4_info->mem.locked && ((mode & NC_WRITE) == NC_WRITE)) {
|
|
|
|
memparams->memory = NULL;
|
|
|
|
}
|
|
|
|
#ifdef USE_PARALLEL4
|
|
|
|
} else {
|
|
|
|
mpiinfo = (NC_MPI_INFO*)parameters;
|
|
|
|
#endif /* !USE_PARALLEL4 */
|
|
|
|
}
|
|
|
|
|
|
|
|
/* Need this access plist to control how HDF5 handles open objects
|
|
|
|
* on file close. (Setting H5F_CLOSE_SEMI will cause H5Fclose to
|
|
|
|
* fail if there are any open objects in the file. */
|
|
|
|
if ((fapl_id = H5Pcreate(H5P_FILE_ACCESS)) < 0)
|
|
|
|
BAIL(NC_EHDFERR);
|
|
|
|
|
|
|
|
if (H5Pset_fclose_degree(fapl_id, H5F_CLOSE_SEMI))
|
|
|
|
BAIL(NC_EHDFERR);
|
|
|
|
|
|
|
|
#ifdef USE_PARALLEL4
|
|
|
|
/* If this is a parallel file create, set up the file creation
|
|
|
|
property list. */
|
|
|
|
if (mode & NC_MPIIO || mode & NC_MPIPOSIX)
|
|
|
|
{
|
|
|
|
nc4_info->parallel = NC_TRUE;
|
|
|
|
if (mode & NC_MPIIO) /* MPI/IO */
|
|
|
|
{
|
|
|
|
LOG((4, "opening parallel file with MPI/IO"));
|
|
|
|
if (H5Pset_fapl_mpio(fapl_id, mpiinfo->comm, mpiinfo->info) < 0)
|
|
|
|
BAIL(NC_EPARINIT);
|
|
|
|
}
|
|
|
|
#ifdef USE_PARALLEL_POSIX
|
|
|
|
else /* MPI/POSIX */
|
|
|
|
{
|
|
|
|
LOG((4, "opening parallel file with MPI/posix"));
|
|
|
|
if (H5Pset_fapl_mpiposix(fapl_id, mpiinfo->comm, 0) < 0)
|
|
|
|
BAIL(NC_EPARINIT);
|
|
|
|
}
|
|
|
|
#else /* USE_PARALLEL_POSIX */
|
|
|
|
/* Should not happen! Code in NC4_create/NC4_open should alias the
|
|
|
|
* NC_MPIPOSIX flag to NC_MPIIO, if the MPI-POSIX VFD is not
|
|
|
|
* available in HDF5. -QAK
|
|
|
|
*/
|
|
|
|
else /* MPI/POSIX */
|
|
|
|
BAIL(NC_EPARINIT);
|
|
|
|
#endif /* USE_PARALLEL_POSIX */
|
|
|
|
|
|
|
|
/* Keep copies of the MPI Comm & Info objects */
|
|
|
|
if (MPI_SUCCESS != MPI_Comm_dup(mpiinfo->comm, &nc4_info->comm))
|
|
|
|
BAIL(NC_EMPI);
|
|
|
|
comm_duped++;
|
|
|
|
if (MPI_INFO_NULL != mpiinfo->info)
|
|
|
|
{
|
|
|
|
if (MPI_SUCCESS != MPI_Info_dup(mpiinfo->info, &nc4_info->info))
|
|
|
|
BAIL(NC_EMPI);
|
|
|
|
info_duped++;
|
|
|
|
}
|
|
|
|
else
|
|
|
|
{
|
|
|
|
/* No dup, just copy it. */
|
|
|
|
nc4_info->info = mpiinfo->info;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
#else /* only set cache for non-parallel. */
|
|
|
|
if (H5Pset_cache(fapl_id, 0, nc4_chunk_cache_nelems, nc4_chunk_cache_size,
|
|
|
|
nc4_chunk_cache_preemption) < 0)
|
|
|
|
BAIL(NC_EHDFERR);
|
|
|
|
LOG((4, "%s: set HDF raw chunk cache to size %d nelems %d preemption %f",
|
2018-07-17 23:03:19 +08:00
|
|
|
__func__, nc4_chunk_cache_size, nc4_chunk_cache_nelems,
|
|
|
|
nc4_chunk_cache_preemption));
|
2018-07-17 22:29:47 +08:00
|
|
|
#endif /* USE_PARALLEL4 */
|
|
|
|
|
|
|
|
/* The NetCDF-3.x prototype contains an mode option NC_SHARE for
|
|
|
|
multiple processes accessing the dataset concurrently. As there
|
|
|
|
is no HDF5 equivalent, NC_SHARE is treated as NC_NOWRITE. */
|
|
|
|
#ifdef HDF5_HAS_COLL_METADATA_OPS
|
|
|
|
H5Pset_all_coll_metadata_ops(fapl_id, 1 );
|
|
|
|
#endif
|
|
|
|
|
|
|
|
/* Does the mode specify that this file is read-only? */
|
|
|
|
if ((mode & NC_WRITE) == 0)
|
|
|
|
nc4_info->no_write = NC_TRUE;
|
|
|
|
|
|
|
|
if(nc4_info->mem.inmemory) {
|
|
|
|
/* validate */
|
|
|
|
if(nc4_info->mem.memio.size == 0 || nc4_info->mem.memio.memory == NULL)
|
|
|
|
BAIL(NC_INMEMORY);
|
|
|
|
retval = NC4_open_image_file(nc4_info);
|
|
|
|
if(retval)
|
|
|
|
BAIL(NC_EHDFERR);
|
2018-07-20 02:32:06 +08:00
|
|
|
}
|
|
|
|
else
|
|
|
|
{
|
2018-07-20 02:39:49 +08:00
|
|
|
NC_HDF5_FILE_INFO_T *hdf5_info;
|
|
|
|
hdf5_info = (NC_HDF5_FILE_INFO_T *)nc4_info->format_file_info;
|
|
|
|
|
2018-07-20 02:32:06 +08:00
|
|
|
/* Open the HDF5 file. */
|
2018-07-20 02:39:49 +08:00
|
|
|
if ((hdf5_info->hdfid = H5Fopen(path, flags, fapl_id)) < 0)
|
2018-07-20 02:32:06 +08:00
|
|
|
BAIL(NC_EHDFERR);
|
|
|
|
}
|
2018-07-17 22:29:47 +08:00
|
|
|
|
|
|
|
/* Now read in all the metadata. Some types and dimscale
|
|
|
|
* information may be difficult to resolve here, if, for example, a
|
|
|
|
* dataset of user-defined type is encountered before the
|
|
|
|
* definition of that type. */
|
|
|
|
if ((retval = nc4_rec_read_metadata(nc4_info->root_grp)))
|
|
|
|
BAIL(retval);
|
|
|
|
|
|
|
|
/* Check for classic model attribute. */
|
|
|
|
if ((retval = check_for_classic_model(nc4_info->root_grp, &is_classic)))
|
|
|
|
BAIL(retval);
|
|
|
|
if (is_classic)
|
|
|
|
nc4_info->cmode |= NC_CLASSIC_MODEL;
|
|
|
|
|
|
|
|
/* Now figure out which netCDF dims are indicated by the dimscale
|
|
|
|
* information. */
|
|
|
|
if ((retval = nc4_rec_match_dimscales(nc4_info->root_grp)))
|
|
|
|
BAIL(retval);
|
|
|
|
|
|
|
|
#ifdef LOGGING
|
|
|
|
/* This will print out the names, types, lens, etc of the vars and
|
|
|
|
atts in the file, if the logging level is 2 or greater. */
|
|
|
|
log_metadata_nc(nc);
|
|
|
|
#endif
|
|
|
|
|
|
|
|
/* Close the property list. */
|
|
|
|
if (H5Pclose(fapl_id) < 0)
|
|
|
|
BAIL(NC_EHDFERR);
|
|
|
|
|
|
|
|
/* Get the HDF5 superblock and read and parse the special
|
|
|
|
* _NCProperties attribute. */
|
|
|
|
if ((retval = NC4_get_fileinfo(nc4_info, NULL)))
|
|
|
|
BAIL(retval);
|
|
|
|
|
|
|
|
return NC_NOERR;
|
|
|
|
|
|
|
|
exit:
|
|
|
|
#ifdef USE_PARALLEL4
|
|
|
|
if (comm_duped) MPI_Comm_free(&nc4_info->comm);
|
|
|
|
if (info_duped) MPI_Info_free(&nc4_info->info);
|
|
|
|
#endif
|
|
|
|
if (fapl_id != H5P_DEFAULT) H5Pclose(fapl_id);
|
|
|
|
if (!nc4_info) return retval;
|
|
|
|
nc4_close_netcdf4_file(nc4_info,1,0); /* treat like abort*/
|
|
|
|
return retval;
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @internal Open a netCDF-4 file.
|
|
|
|
*
|
|
|
|
* @param path The file name of the new file.
|
|
|
|
* @param mode The open mode flag.
|
|
|
|
* @param basepe Ignored by this function.
|
|
|
|
* @param chunksizehintp Ignored by this function.
|
|
|
|
* @param use_parallel 0 for sequential, non-zero for parallel I/O.
|
|
|
|
* @param parameters pointer to struct holding extra data (e.g. for parallel I/O)
|
|
|
|
* layer. Ignored if NULL.
|
|
|
|
* @param dispatch Pointer to the dispatch table for this file.
|
|
|
|
* @param nc_file Pointer to an instance of NC.
|
|
|
|
*
|
|
|
|
* @return ::NC_NOERR No error.
|
|
|
|
* @return ::NC_EINVAL Invalid inputs.
|
|
|
|
* @author Ed Hartnett
|
|
|
|
*/
|
|
|
|
int
|
|
|
|
NC4_open(const char *path, int mode, int basepe, size_t *chunksizehintp,
|
|
|
|
int use_parallel, void *parameters, NC_Dispatch *dispatch, NC *nc_file)
|
|
|
|
{
|
|
|
|
assert(nc_file && path && dispatch && nc_file &&
|
|
|
|
nc_file->model == NC_FORMATX_NC4);
|
|
|
|
|
|
|
|
LOG((1, "%s: path %s mode %d params %x",
|
|
|
|
__func__, path, mode, parameters));
|
|
|
|
|
|
|
|
#ifdef USE_PARALLEL4
|
|
|
|
/* User must provide MPI communicator for parallel I/O. */
|
|
|
|
if (use_parallel && !parameters)
|
|
|
|
return NC_EINVAL;
|
|
|
|
|
|
|
|
#ifndef USE_PARALLEL_POSIX
|
|
|
|
/* If the HDF5 library has been compiled without the MPI-POSIX VFD,
|
|
|
|
* alias the NC_MPIPOSIX flag to NC_MPIIO. -QAK */
|
|
|
|
if (mode & NC_MPIPOSIX)
|
|
|
|
{
|
|
|
|
mode &= ~NC_MPIPOSIX;
|
|
|
|
mode |= NC_MPIIO;
|
|
|
|
}
|
|
|
|
#endif /* USE_PARALLEL_POSIX */
|
|
|
|
#endif /* USE_PARALLEL4 */
|
|
|
|
|
|
|
|
/* Check the mode for validity */
|
|
|
|
if (mode & ILLEGAL_OPEN_FLAGS)
|
|
|
|
return NC_EINVAL;
|
|
|
|
|
|
|
|
/* If this is our first file, initialize HDF5. */
|
|
|
|
if (!nc4_hdf5_initialized)
|
|
|
|
nc4_hdf5_initialize();
|
|
|
|
|
|
|
|
nc_file->int_ncid = nc_file->ext_ncid;
|
|
|
|
|
|
|
|
/* Open the file. */
|
|
|
|
return nc4_open_file(path, mode, parameters, nc_file);
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @internal This function is called by read_dataset(), (which is called
|
|
|
|
* by nc4_rec_read_metadata()) when a netCDF variable is found in the
|
|
|
|
* file. This function reads in all the metadata about the var,
|
|
|
|
* including the attributes.
|
|
|
|
*
|
|
|
|
* @param grp Pointer to group info struct.
|
|
|
|
* @param datasetid HDF5 dataset ID.
|
|
|
|
* @param obj_name Name of the HDF5 object to read.
|
|
|
|
* @param ndims Number of dimensions.
|
|
|
|
* @param dim
|
|
|
|
*
|
|
|
|
* @return ::NC_NOERR No error.
|
|
|
|
* @return ::NC_EBADID Bad ncid.
|
|
|
|
* @return ::NC_EHDFERR HDF5 returned error.
|
|
|
|
* @author Ed Hartnett
|
|
|
|
*/
|
|
|
|
static int
|
|
|
|
read_var(NC_GRP_INFO_T *grp, hid_t datasetid, const char *obj_name,
|
|
|
|
size_t ndims, NC_DIM_INFO_T *dim)
|
|
|
|
{
|
|
|
|
NC_VAR_INFO_T *var = NULL;
|
|
|
|
hid_t access_pid = 0;
|
2018-07-17 23:03:19 +08:00
|
|
|
int incr_id_rc = 0; /* Whether dataset ID's ref count has been incremented */
|
2018-07-17 22:29:47 +08:00
|
|
|
int d;
|
|
|
|
H5Z_filter_t filter;
|
|
|
|
int num_filters;
|
|
|
|
unsigned int cd_values_zip[CD_NELEMS_ZLIB];
|
|
|
|
size_t cd_nelems = CD_NELEMS_ZLIB;
|
|
|
|
hid_t propid = 0;
|
|
|
|
H5D_fill_value_t fill_status;
|
|
|
|
H5D_layout_t layout;
|
|
|
|
hsize_t chunksize[NC_MAX_VAR_DIMS] = {0};
|
|
|
|
int retval = NC_NOERR;
|
|
|
|
double rdcc_w0;
|
|
|
|
int f;
|
|
|
|
char* finalname = NULL;
|
|
|
|
|
|
|
|
assert(obj_name && grp);
|
|
|
|
LOG((4, "%s: obj_name %s", __func__, obj_name));
|
|
|
|
|
|
|
|
/* Check for a weird case: a non-coordinate variable that has the
|
|
|
|
* same name as a dimension. It's legal in netcdf, and requires
|
|
|
|
* that the HDF5 dataset name be changed. */
|
|
|
|
if (strlen(obj_name) > strlen(NON_COORD_PREPEND) &&
|
|
|
|
!strncmp(obj_name, NON_COORD_PREPEND, strlen(NON_COORD_PREPEND)))
|
|
|
|
{
|
|
|
|
/* Allocate space for the name. */
|
|
|
|
if(finalname) {free(finalname); finalname = NULL;}
|
2018-07-17 23:03:19 +08:00
|
|
|
if (!(finalname = malloc(((strlen(obj_name) -
|
|
|
|
strlen(NON_COORD_PREPEND))+ 1) * sizeof(char))))
|
2018-07-17 22:29:47 +08:00
|
|
|
BAIL(NC_ENOMEM);
|
|
|
|
strcpy(finalname, &obj_name[strlen(NON_COORD_PREPEND)]);
|
|
|
|
} else
|
|
|
|
finalname = strdup(obj_name);
|
|
|
|
|
|
|
|
/* Add a variable to the end of the group's var list. */
|
|
|
|
if ((retval = nc4_var_list_add(grp,finalname,ndims,&var)))
|
|
|
|
BAIL(retval);
|
|
|
|
|
|
|
|
/* Fill in what we already know. */
|
|
|
|
var->hdf_datasetid = datasetid;
|
2018-07-17 23:03:19 +08:00
|
|
|
H5Iinc_ref(var->hdf_datasetid); /* Increment number of objects using ID */
|
|
|
|
incr_id_rc++; /* Indicate that we've incremented the ref. count (for errors) */
|
2018-07-17 22:29:47 +08:00
|
|
|
var->created = NC_TRUE;
|
|
|
|
|
|
|
|
/* Get the current chunk cache settings. */
|
|
|
|
if ((access_pid = H5Dget_access_plist(datasetid)) < 0)
|
|
|
|
BAIL(NC_EVARMETA);
|
|
|
|
|
|
|
|
/* Learn about current chunk cache settings. */
|
|
|
|
if ((H5Pget_chunk_cache(access_pid, &(var->chunk_cache_nelems),
|
|
|
|
&(var->chunk_cache_size), &rdcc_w0)) < 0)
|
|
|
|
BAIL(NC_EHDFERR);
|
|
|
|
var->chunk_cache_preemption = rdcc_w0;
|
|
|
|
|
|
|
|
/* Find out what filters are applied to this HDF5 dataset,
|
|
|
|
* fletcher32, deflate, and/or shuffle. All other filters are
|
|
|
|
* just dumped */
|
|
|
|
if ((propid = H5Dget_create_plist(datasetid)) < 0)
|
|
|
|
BAIL(NC_EHDFERR);
|
|
|
|
|
|
|
|
/* Get the chunking info for non-scalar vars. */
|
|
|
|
if ((layout = H5Pget_layout(propid)) < -1)
|
|
|
|
BAIL(NC_EHDFERR);
|
|
|
|
if (layout == H5D_CHUNKED)
|
|
|
|
{
|
|
|
|
if (H5Pget_chunk(propid, NC_MAX_VAR_DIMS, chunksize) < 0)
|
|
|
|
BAIL(NC_EHDFERR);
|
|
|
|
if (!(var->chunksizes = malloc(var->ndims * sizeof(size_t))))
|
|
|
|
BAIL(NC_ENOMEM);
|
|
|
|
for (d = 0; d < var->ndims; d++)
|
|
|
|
var->chunksizes[d] = chunksize[d];
|
|
|
|
}
|
|
|
|
else if (layout == H5D_CONTIGUOUS || layout == H5D_COMPACT)
|
|
|
|
var->contiguous = NC_TRUE;
|
|
|
|
|
|
|
|
/* The possible values of filter (which is just an int) can be
|
|
|
|
* found in H5Zpublic.h. */
|
|
|
|
if ((num_filters = H5Pget_nfilters(propid)) < 0)
|
|
|
|
BAIL(NC_EHDFERR);
|
|
|
|
for (f = 0; f < num_filters; f++)
|
|
|
|
{
|
|
|
|
if ((filter = H5Pget_filter2(propid, f, NULL, &cd_nelems,
|
|
|
|
cd_values_zip, 0, NULL, NULL)) < 0)
|
|
|
|
BAIL(NC_EHDFERR);
|
|
|
|
switch (filter)
|
|
|
|
{
|
|
|
|
case H5Z_FILTER_SHUFFLE:
|
|
|
|
var->shuffle = NC_TRUE;
|
|
|
|
break;
|
|
|
|
|
|
|
|
case H5Z_FILTER_FLETCHER32:
|
|
|
|
var->fletcher32 = NC_TRUE;
|
|
|
|
break;
|
|
|
|
|
|
|
|
case H5Z_FILTER_DEFLATE:
|
|
|
|
var->deflate = NC_TRUE;
|
2018-07-17 23:03:19 +08:00
|
|
|
if (cd_nelems != CD_NELEMS_ZLIB ||
|
|
|
|
cd_values_zip[0] > NC_MAX_DEFLATE_LEVEL)
|
2018-07-17 22:29:47 +08:00
|
|
|
BAIL(NC_EHDFERR);
|
|
|
|
var->deflate_level = cd_values_zip[0];
|
|
|
|
break;
|
|
|
|
|
|
|
|
default:
|
|
|
|
var->filterid = filter;
|
|
|
|
var->nparams = cd_nelems;
|
|
|
|
if(cd_nelems == 0)
|
|
|
|
var->params = NULL;
|
|
|
|
else {
|
|
|
|
/* We have to re-read the parameters based on actual nparams */
|
|
|
|
var->params = (unsigned int*)calloc(1,sizeof(unsigned int)*var->nparams);
|
|
|
|
if(var->params == NULL)
|
|
|
|
BAIL(NC_ENOMEM);
|
|
|
|
if((filter = H5Pget_filter2(propid, f, NULL, &cd_nelems,
|
|
|
|
var->params, 0, NULL, NULL)) < 0)
|
|
|
|
BAIL(NC_EHDFERR);
|
|
|
|
}
|
|
|
|
break;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
/* Learn all about the type of this variable. */
|
|
|
|
if ((retval = get_type_info2(grp->nc4_info, datasetid,
|
|
|
|
&var->type_info)))
|
|
|
|
BAIL(retval);
|
|
|
|
|
|
|
|
/* Indicate that the variable has a pointer to the type */
|
|
|
|
var->type_info->rc++;
|
|
|
|
|
|
|
|
/* Is there a fill value associated with this dataset? */
|
|
|
|
if (H5Pfill_value_defined(propid, &fill_status) < 0)
|
|
|
|
BAIL(NC_EHDFERR);
|
|
|
|
|
|
|
|
/* Get the fill value, if there is one defined. */
|
|
|
|
if (fill_status == H5D_FILL_VALUE_USER_DEFINED)
|
|
|
|
{
|
|
|
|
/* Allocate space to hold the fill value. */
|
|
|
|
if (!var->fill_value)
|
|
|
|
{
|
|
|
|
if (var->type_info->nc_type_class == NC_VLEN)
|
|
|
|
{
|
|
|
|
if (!(var->fill_value = malloc(sizeof(nc_vlen_t))))
|
|
|
|
BAIL(NC_ENOMEM);
|
|
|
|
}
|
|
|
|
else if (var->type_info->nc_type_class == NC_STRING)
|
|
|
|
{
|
|
|
|
if (!(var->fill_value = malloc(sizeof(char *))))
|
|
|
|
BAIL(NC_ENOMEM);
|
|
|
|
}
|
|
|
|
else
|
|
|
|
{
|
|
|
|
assert(var->type_info->size);
|
|
|
|
if (!(var->fill_value = malloc(var->type_info->size)))
|
|
|
|
BAIL(NC_ENOMEM);
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
/* Get the fill value from the HDF5 property lust. */
|
|
|
|
if (H5Pget_fill_value(propid, var->type_info->native_hdf_typeid,
|
|
|
|
var->fill_value) < 0)
|
|
|
|
BAIL(NC_EHDFERR);
|
|
|
|
}
|
|
|
|
else
|
|
|
|
var->no_fill = NC_TRUE;
|
|
|
|
|
|
|
|
/* If it's a scale, mark it as such. */
|
|
|
|
if (dim)
|
|
|
|
{
|
|
|
|
assert(ndims);
|
|
|
|
var->dimscale = NC_TRUE;
|
|
|
|
if (var->ndims > 1)
|
|
|
|
{
|
|
|
|
if ((retval = read_coord_dimids(grp, var)))
|
|
|
|
BAIL(retval);
|
|
|
|
}
|
|
|
|
else
|
|
|
|
{
|
|
|
|
/* sanity check */
|
|
|
|
assert(0 == strcmp(var->hdr.name, dim->hdr.name));
|
|
|
|
|
|
|
|
var->dimids[0] = dim->hdr.id;
|
|
|
|
var->dim[0] = dim;
|
|
|
|
}
|
|
|
|
dim->coord_var = var;
|
|
|
|
}
|
|
|
|
/* If this is not a scale, but has scales, iterate
|
|
|
|
* through them. (i.e. this is a variable that is not a
|
|
|
|
* coordinate variable) */
|
|
|
|
else
|
|
|
|
{
|
|
|
|
int num_scales = 0;
|
|
|
|
|
|
|
|
/* Find out how many scales are attached to this
|
|
|
|
* dataset. H5DSget_num_scales returns an error if there are no
|
|
|
|
* scales, so convert a negative return value to zero. */
|
|
|
|
num_scales = H5DSget_num_scales(datasetid, 0);
|
|
|
|
if (num_scales < 0)
|
|
|
|
num_scales = 0;
|
|
|
|
|
|
|
|
if (num_scales && ndims)
|
|
|
|
{
|
2018-07-17 23:03:19 +08:00
|
|
|
/* Allocate space to remember whether the dimscale has been
|
|
|
|
* attached for each dimension. */
|
|
|
|
if (!(var->dimscale_attached = calloc(ndims, sizeof(nc_bool_t))))
|
2018-07-17 22:29:47 +08:00
|
|
|
BAIL(NC_ENOMEM);
|
|
|
|
|
|
|
|
/* Store id information allowing us to match hdf5
|
|
|
|
* dimscales to netcdf dimensions. */
|
2018-07-17 23:03:19 +08:00
|
|
|
if (!(var->dimscale_hdf5_objids = malloc(ndims *
|
|
|
|
sizeof(struct hdf5_objid))))
|
2018-07-17 22:29:47 +08:00
|
|
|
BAIL(NC_ENOMEM);
|
|
|
|
for (d = 0; d < var->ndims; d++)
|
|
|
|
{
|
|
|
|
if (H5DSiterate_scales(var->hdf_datasetid, d, NULL, dimscale_visitor,
|
|
|
|
&(var->dimscale_hdf5_objids[d])) < 0)
|
|
|
|
BAIL(NC_EHDFERR);
|
|
|
|
var->dimscale_attached[d] = NC_TRUE;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
/* Read variable attributes. */
|
|
|
|
var->atts_not_read = 1;
|
|
|
|
|
|
|
|
/* Is this a deflated variable with a chunksize greater than the
|
|
|
|
* current cache size? */
|
|
|
|
if ((retval = nc4_adjust_var_cache(grp, var)))
|
|
|
|
BAIL(retval);
|
|
|
|
|
|
|
|
exit:
|
|
|
|
if(finalname) free(finalname);
|
|
|
|
if (retval)
|
|
|
|
{
|
|
|
|
if (incr_id_rc && H5Idec_ref(datasetid) < 0)
|
|
|
|
BAIL2(NC_EHDFERR);
|
|
|
|
if (var != NULL) {
|
|
|
|
nc4_var_list_del(grp,var);
|
|
|
|
}
|
|
|
|
}
|
|
|
|
if (access_pid && H5Pclose(access_pid) < 0)
|
|
|
|
BAIL2(NC_EHDFERR);
|
|
|
|
if (propid > 0 && H5Pclose(propid) < 0)
|
|
|
|
BAIL2(NC_EHDFERR);
|
|
|
|
return retval;
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @internal Given an HDF5 type, set a pointer to netcdf type.
|
|
|
|
*
|
|
|
|
* @param h5 Pointer to HDF5 file info struct.
|
|
|
|
* @param native_typeid HDF5 type ID.
|
|
|
|
* @param xtype Pointer that gets netCDF type.
|
|
|
|
*
|
|
|
|
* @return ::NC_NOERR No error.
|
|
|
|
* @return ::NC_EBADID Bad ncid.
|
|
|
|
* @return ::NC_EHDFERR HDF5 returned error.
|
|
|
|
* @return ::NC_EBADTYPID Type not found.
|
|
|
|
* @author Ed Hartnett
|
|
|
|
*/
|
|
|
|
static int
|
|
|
|
get_netcdf_type(NC_FILE_INFO_T *h5, hid_t native_typeid,
|
|
|
|
nc_type *xtype)
|
|
|
|
{
|
|
|
|
NC_TYPE_INFO_T *type;
|
|
|
|
H5T_class_t class;
|
|
|
|
htri_t is_str, equal = 0;
|
|
|
|
|
|
|
|
assert(h5 && xtype);
|
|
|
|
|
|
|
|
if ((class = H5Tget_class(native_typeid)) < 0)
|
|
|
|
return NC_EHDFERR;
|
|
|
|
|
|
|
|
/* H5Tequal doesn't work with H5T_C_S1 for some reason. But
|
|
|
|
* H5Tget_class will return H5T_STRING if this is a string. */
|
|
|
|
if (class == H5T_STRING)
|
|
|
|
{
|
|
|
|
if ((is_str = H5Tis_variable_str(native_typeid)) < 0)
|
|
|
|
return NC_EHDFERR;
|
|
|
|
if (is_str)
|
|
|
|
*xtype = NC_STRING;
|
|
|
|
else
|
|
|
|
*xtype = NC_CHAR;
|
|
|
|
return NC_NOERR;
|
|
|
|
}
|
|
|
|
else if (class == H5T_INTEGER || class == H5T_FLOAT)
|
|
|
|
{
|
|
|
|
/* For integers and floats, we don't have to worry about
|
|
|
|
* endianness if we compare native types. */
|
|
|
|
if ((equal = H5Tequal(native_typeid, H5T_NATIVE_SCHAR)) < 0)
|
|
|
|
return NC_EHDFERR;
|
|
|
|
if (equal)
|
|
|
|
{
|
|
|
|
*xtype = NC_BYTE;
|
|
|
|
return NC_NOERR;
|
|
|
|
}
|
|
|
|
if ((equal = H5Tequal(native_typeid, H5T_NATIVE_SHORT)) < 0)
|
|
|
|
return NC_EHDFERR;
|
|
|
|
if (equal)
|
|
|
|
{
|
|
|
|
*xtype = NC_SHORT;
|
|
|
|
return NC_NOERR;
|
|
|
|
}
|
|
|
|
if ((equal = H5Tequal(native_typeid, H5T_NATIVE_INT)) < 0)
|
|
|
|
return NC_EHDFERR;
|
|
|
|
if (equal)
|
|
|
|
{
|
|
|
|
*xtype = NC_INT;
|
|
|
|
return NC_NOERR;
|
|
|
|
}
|
|
|
|
if ((equal = H5Tequal(native_typeid, H5T_NATIVE_FLOAT)) < 0)
|
|
|
|
return NC_EHDFERR;
|
|
|
|
if (equal)
|
|
|
|
{
|
|
|
|
*xtype = NC_FLOAT;
|
|
|
|
return NC_NOERR;
|
|
|
|
}
|
|
|
|
if ((equal = H5Tequal(native_typeid, H5T_NATIVE_DOUBLE)) < 0)
|
|
|
|
return NC_EHDFERR;
|
|
|
|
if (equal)
|
|
|
|
{
|
|
|
|
*xtype = NC_DOUBLE;
|
|
|
|
return NC_NOERR;
|
|
|
|
}
|
|
|
|
if ((equal = H5Tequal(native_typeid, H5T_NATIVE_UCHAR)) < 0)
|
|
|
|
return NC_EHDFERR;
|
|
|
|
if (equal)
|
|
|
|
{
|
|
|
|
*xtype = NC_UBYTE;
|
|
|
|
return NC_NOERR;
|
|
|
|
}
|
|
|
|
if ((equal = H5Tequal(native_typeid, H5T_NATIVE_USHORT)) < 0)
|
|
|
|
return NC_EHDFERR;
|
|
|
|
if (equal)
|
|
|
|
{
|
|
|
|
*xtype = NC_USHORT;
|
|
|
|
return NC_NOERR;
|
|
|
|
}
|
|
|
|
if ((equal = H5Tequal(native_typeid, H5T_NATIVE_UINT)) < 0)
|
|
|
|
return NC_EHDFERR;
|
|
|
|
if (equal)
|
|
|
|
{
|
|
|
|
*xtype = NC_UINT;
|
|
|
|
return NC_NOERR;
|
|
|
|
}
|
|
|
|
if ((equal = H5Tequal(native_typeid, H5T_NATIVE_LLONG)) < 0)
|
|
|
|
return NC_EHDFERR;
|
|
|
|
if (equal)
|
|
|
|
{
|
|
|
|
*xtype = NC_INT64;
|
|
|
|
return NC_NOERR;
|
|
|
|
}
|
|
|
|
if ((equal = H5Tequal(native_typeid, H5T_NATIVE_ULLONG)) < 0)
|
|
|
|
return NC_EHDFERR;
|
|
|
|
if (equal)
|
|
|
|
{
|
|
|
|
*xtype = NC_UINT64;
|
|
|
|
return NC_NOERR;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
/* Maybe we already know about this type. */
|
|
|
|
if (!equal)
|
|
|
|
if((type = nc4_rec_find_hdf_type(h5, native_typeid)))
|
|
|
|
{
|
|
|
|
*xtype = type->hdr.id;
|
|
|
|
return NC_NOERR;
|
|
|
|
}
|
|
|
|
|
|
|
|
*xtype = NC_NAT;
|
|
|
|
return NC_EBADTYPID;
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @internal Read an attribute. This is called by att_read_var_callbk().
|
|
|
|
*
|
|
|
|
* @param grp Pointer to group info struct.
|
|
|
|
* @param attid Attribute ID.
|
|
|
|
* @param att Pointer that gets att info struct.
|
|
|
|
*
|
|
|
|
* @return ::NC_NOERR No error.
|
|
|
|
* @return ::NC_EHDFERR HDF5 returned error.
|
|
|
|
* @author Ed Hartnett
|
|
|
|
*/
|
|
|
|
static int
|
|
|
|
read_hdf5_att(NC_GRP_INFO_T *grp, hid_t attid, NC_ATT_INFO_T *att)
|
|
|
|
{
|
|
|
|
hid_t spaceid = 0, file_typeid = 0;
|
|
|
|
hsize_t dims[1] = {0}; /* netcdf attributes always 1-D. */
|
|
|
|
int retval = NC_NOERR;
|
|
|
|
size_t type_size;
|
|
|
|
int att_ndims;
|
|
|
|
hssize_t att_npoints;
|
|
|
|
H5T_class_t att_class;
|
|
|
|
int fixed_len_string = 0;
|
|
|
|
size_t fixed_size = 0;
|
|
|
|
|
|
|
|
assert(att->hdr.name);
|
|
|
|
LOG((5, "%s: att->hdr.id %d att->hdr.name %s att->nc_typeid %d att->len %d",
|
|
|
|
__func__, att->hdr.id, att->hdr.name, (int)att->nc_typeid, att->len));
|
|
|
|
|
|
|
|
/* Get type of attribute in file. */
|
|
|
|
if ((file_typeid = H5Aget_type(attid)) < 0)
|
|
|
|
return NC_EATTMETA;
|
2018-07-17 23:03:19 +08:00
|
|
|
if ((att->native_hdf_typeid = H5Tget_native_type(file_typeid,
|
|
|
|
H5T_DIR_DEFAULT)) < 0)
|
2018-07-17 22:29:47 +08:00
|
|
|
BAIL(NC_EHDFERR);
|
|
|
|
if ((att_class = H5Tget_class(att->native_hdf_typeid)) < 0)
|
|
|
|
BAIL(NC_EATTMETA);
|
2018-07-17 23:03:19 +08:00
|
|
|
if (att_class == H5T_STRING &&
|
|
|
|
!H5Tis_variable_str(att->native_hdf_typeid))
|
2018-07-17 22:29:47 +08:00
|
|
|
{
|
|
|
|
fixed_len_string++;
|
|
|
|
if (!(fixed_size = H5Tget_size(att->native_hdf_typeid)))
|
|
|
|
BAIL(NC_EATTMETA);
|
|
|
|
}
|
|
|
|
if ((retval = get_netcdf_type(grp->nc4_info, att->native_hdf_typeid,
|
|
|
|
&(att->nc_typeid))))
|
|
|
|
BAIL(retval);
|
|
|
|
|
|
|
|
|
|
|
|
/* Get len. */
|
|
|
|
if ((spaceid = H5Aget_space(attid)) < 0)
|
|
|
|
BAIL(NC_EATTMETA);
|
|
|
|
if ((att_ndims = H5Sget_simple_extent_ndims(spaceid)) < 0)
|
|
|
|
BAIL(NC_EATTMETA);
|
|
|
|
if ((att_npoints = H5Sget_simple_extent_npoints(spaceid)) < 0)
|
|
|
|
BAIL(NC_EATTMETA);
|
|
|
|
|
|
|
|
/* If both att_ndims and att_npoints are zero, then this is a
|
|
|
|
* zero length att. */
|
|
|
|
if (att_ndims == 0 && att_npoints == 0)
|
|
|
|
dims[0] = 0;
|
|
|
|
else if (att->nc_typeid == NC_STRING)
|
|
|
|
dims[0] = att_npoints;
|
|
|
|
else if (att->nc_typeid == NC_CHAR)
|
|
|
|
{
|
|
|
|
/* NC_CHAR attributes are written as a scalar in HDF5, of type
|
|
|
|
* H5T_C_S1, of variable length. */
|
|
|
|
if (att_ndims == 0)
|
|
|
|
{
|
|
|
|
if (!(dims[0] = H5Tget_size(file_typeid)))
|
|
|
|
BAIL(NC_EATTMETA);
|
|
|
|
}
|
|
|
|
else
|
|
|
|
{
|
|
|
|
/* This is really a string type! */
|
|
|
|
att->nc_typeid = NC_STRING;
|
|
|
|
dims[0] = att_npoints;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
else
|
|
|
|
{
|
|
|
|
H5S_class_t space_class;
|
|
|
|
|
|
|
|
/* All netcdf attributes are scalar or 1-D only. */
|
|
|
|
if (att_ndims > 1)
|
|
|
|
BAIL(NC_EATTMETA);
|
|
|
|
|
|
|
|
/* Check class of HDF5 dataspace */
|
|
|
|
if ((space_class = H5Sget_simple_extent_type(spaceid)) < 0)
|
|
|
|
BAIL(NC_EATTMETA);
|
|
|
|
|
2018-07-17 23:03:19 +08:00
|
|
|
/* Check for NULL HDF5 dataspace class (should be weeded out
|
|
|
|
* earlier) */
|
2018-07-17 22:29:47 +08:00
|
|
|
if (H5S_NULL == space_class)
|
|
|
|
BAIL(NC_EATTMETA);
|
|
|
|
|
|
|
|
/* check for SCALAR HDF5 dataspace class */
|
|
|
|
if (H5S_SCALAR == space_class)
|
|
|
|
dims[0] = 1;
|
|
|
|
else /* Must be "simple" dataspace */
|
|
|
|
{
|
|
|
|
/* Read the size of this attribute. */
|
|
|
|
if (H5Sget_simple_extent_dims(spaceid, dims, NULL) < 0)
|
|
|
|
BAIL(NC_EATTMETA);
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
/* Tell the user what the length if this attribute is. */
|
|
|
|
att->len = dims[0];
|
|
|
|
|
|
|
|
/* Allocate some memory if the len is not zero, and read the
|
|
|
|
attribute. */
|
|
|
|
if (dims[0])
|
|
|
|
{
|
2018-07-17 23:03:19 +08:00
|
|
|
if ((retval = nc4_get_typelen_mem(grp->nc4_info, att->nc_typeid,
|
|
|
|
&type_size)))
|
2018-07-17 22:29:47 +08:00
|
|
|
return retval;
|
|
|
|
if (att_class == H5T_VLEN)
|
|
|
|
{
|
|
|
|
if (!(att->vldata = malloc((unsigned int)(att->len * sizeof(hvl_t)))))
|
|
|
|
BAIL(NC_ENOMEM);
|
|
|
|
if (H5Aread(attid, att->native_hdf_typeid, att->vldata) < 0)
|
|
|
|
BAIL(NC_EATTMETA);
|
|
|
|
}
|
|
|
|
else if (att->nc_typeid == NC_STRING)
|
|
|
|
{
|
|
|
|
if (!(att->stdata = calloc(att->len, sizeof(char *))))
|
|
|
|
BAIL(NC_ENOMEM);
|
|
|
|
/* For a fixed length HDF5 string, the read requires
|
|
|
|
* contiguous memory. Meanwhile, the netCDF API requires that
|
|
|
|
* nc_free_string be called on string arrays, which would not
|
|
|
|
* work if one contiguous memory block were used. So here I
|
|
|
|
* convert the contiguous block of strings into an array of
|
|
|
|
* malloced strings (each string with its own malloc). Then I
|
|
|
|
* copy the data and free the contiguous memory. This
|
|
|
|
* involves copying the data, which is bad, but this only
|
|
|
|
* occurs for fixed length string attributes, and presumably
|
|
|
|
* these are small. (And netCDF-4 does not create them - it
|
|
|
|
* always uses variable length strings. */
|
|
|
|
if (fixed_len_string)
|
|
|
|
{
|
|
|
|
int i;
|
|
|
|
char *contig_buf, *cur;
|
|
|
|
|
|
|
|
/* Alloc space for the contiguous memory read. */
|
|
|
|
if (!(contig_buf = malloc(att->len * fixed_size * sizeof(char))))
|
|
|
|
BAIL(NC_ENOMEM);
|
|
|
|
|
|
|
|
/* Read the fixed-len strings as one big block. */
|
|
|
|
if (H5Aread(attid, att->native_hdf_typeid, contig_buf) < 0) {
|
|
|
|
free(contig_buf);
|
|
|
|
BAIL(NC_EATTMETA);
|
|
|
|
}
|
|
|
|
|
|
|
|
/* Copy strings, one at a time, into their new home. Alloc
|
|
|
|
space for each string. The user will later free this
|
|
|
|
space with nc_free_string. */
|
|
|
|
cur = contig_buf;
|
|
|
|
for (i = 0; i < att->len; i++)
|
|
|
|
{
|
|
|
|
if (!(att->stdata[i] = malloc(fixed_size))) {
|
|
|
|
free(contig_buf);
|
|
|
|
BAIL(NC_ENOMEM);
|
|
|
|
}
|
|
|
|
strncpy(att->stdata[i], cur, fixed_size);
|
|
|
|
cur += fixed_size;
|
|
|
|
}
|
|
|
|
|
|
|
|
/* Free contiguous memory buffer. */
|
|
|
|
free(contig_buf);
|
|
|
|
}
|
|
|
|
else
|
|
|
|
{
|
|
|
|
/* Read variable-length string atts. */
|
|
|
|
if (H5Aread(attid, att->native_hdf_typeid, att->stdata) < 0)
|
|
|
|
BAIL(NC_EATTMETA);
|
|
|
|
}
|
|
|
|
}
|
|
|
|
else
|
|
|
|
{
|
|
|
|
if (!(att->data = malloc((unsigned int)(att->len * type_size))))
|
|
|
|
BAIL(NC_ENOMEM);
|
|
|
|
if (H5Aread(attid, att->native_hdf_typeid, att->data) < 0)
|
|
|
|
BAIL(NC_EATTMETA);
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
if (H5Tclose(file_typeid) < 0)
|
|
|
|
BAIL(NC_EHDFERR);
|
|
|
|
if (H5Sclose(spaceid) < 0)
|
|
|
|
return NC_EHDFERR;
|
|
|
|
|
|
|
|
return NC_NOERR;
|
|
|
|
|
|
|
|
exit:
|
|
|
|
if (H5Tclose(file_typeid) < 0)
|
|
|
|
BAIL2(NC_EHDFERR);
|
|
|
|
if (spaceid > 0 && H5Sclose(spaceid) < 0)
|
|
|
|
BAIL2(NC_EHDFERR);
|
|
|
|
return retval;
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @internal Wrap HDF5 allocated memory free operations
|
|
|
|
*
|
|
|
|
* @param memory Pointer to memory to be freed.
|
|
|
|
*
|
|
|
|
* @return ::NC_NOERR No error.
|
|
|
|
* @author Dennis Heimbigner
|
|
|
|
*/
|
|
|
|
static void
|
|
|
|
hdf5free(void* memory)
|
|
|
|
{
|
|
|
|
#ifndef JNA
|
|
|
|
/* On Windows using the microsoft runtime, it is an error
|
|
|
|
for one library to free memory allocated by a different library.*/
|
|
|
|
#ifdef HDF5_HAS_H5FREE
|
|
|
|
if(memory != NULL) H5free_memory(memory);
|
|
|
|
#else
|
|
|
|
#ifndef _MSC_VER
|
|
|
|
if(memory != NULL) free(memory);
|
|
|
|
#endif
|
|
|
|
#endif
|
|
|
|
#endif
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @internal Read information about a user defined type from the HDF5
|
|
|
|
* file, and stash it in the group's list of types.
|
|
|
|
*
|
|
|
|
* @param grp Pointer to group info struct.
|
|
|
|
* @param hdf_typeid HDF5 type ID.
|
|
|
|
* @param type_name Pointer that gets the type name.
|
|
|
|
*
|
|
|
|
* @return ::NC_NOERR No error.
|
|
|
|
* @return ::NC_EBADID Bad ncid.
|
|
|
|
* @return ::NC_EHDFERR HDF5 returned error.
|
|
|
|
* @return ::NC_EBADTYPID Type not found.
|
|
|
|
* @author Ed Hartnett
|
|
|
|
*/
|
|
|
|
static int
|
|
|
|
read_type(NC_GRP_INFO_T *grp, hid_t hdf_typeid, char *type_name)
|
|
|
|
{
|
|
|
|
NC_TYPE_INFO_T *type;
|
|
|
|
H5T_class_t class;
|
|
|
|
hid_t native_typeid;
|
|
|
|
size_t type_size;
|
|
|
|
int retval = NC_NOERR;
|
|
|
|
int nmembers;
|
|
|
|
|
|
|
|
assert(grp && type_name);
|
|
|
|
|
2018-07-17 23:03:19 +08:00
|
|
|
LOG((4, "%s: type_name %s grp->hdr.name %s", __func__, type_name,
|
|
|
|
grp->hdr.name));
|
2018-07-17 22:29:47 +08:00
|
|
|
|
|
|
|
/* What is the native type for this platform? */
|
|
|
|
if ((native_typeid = H5Tget_native_type(hdf_typeid, H5T_DIR_DEFAULT)) < 0)
|
|
|
|
return NC_EHDFERR;
|
|
|
|
|
|
|
|
/* What is the size of this type on this platform. */
|
|
|
|
if (!(type_size = H5Tget_size(native_typeid)))
|
|
|
|
return NC_EHDFERR;
|
|
|
|
LOG((5, "type_size %d", type_size));
|
|
|
|
|
|
|
|
/* Add to the list for this new type, and get a local pointer to it. */
|
|
|
|
if ((retval = nc4_type_list_add(grp, type_size, type_name, &type)))
|
|
|
|
return retval;
|
|
|
|
|
|
|
|
/* Remember common info about this type. */
|
|
|
|
type->committed = NC_TRUE;
|
|
|
|
type->hdf_typeid = hdf_typeid;
|
2018-07-17 23:03:19 +08:00
|
|
|
H5Iinc_ref(type->hdf_typeid); /* Increment number of objects using ID */
|
2018-07-17 22:29:47 +08:00
|
|
|
type->native_hdf_typeid = native_typeid;
|
|
|
|
|
|
|
|
/* What is the class of this type, compound, vlen, etc. */
|
|
|
|
if ((class = H5Tget_class(hdf_typeid)) < 0)
|
|
|
|
return NC_EHDFERR;
|
|
|
|
switch (class)
|
|
|
|
{
|
|
|
|
case H5T_STRING:
|
|
|
|
type->nc_type_class = NC_STRING;
|
|
|
|
break;
|
|
|
|
|
|
|
|
case H5T_COMPOUND:
|
|
|
|
{
|
|
|
|
int nmembers;
|
|
|
|
unsigned int m;
|
|
|
|
char* member_name = NULL;
|
|
|
|
#ifdef JNA
|
|
|
|
char jna[1001];
|
|
|
|
#endif
|
|
|
|
|
|
|
|
type->nc_type_class = NC_COMPOUND;
|
|
|
|
|
|
|
|
if ((nmembers = H5Tget_nmembers(hdf_typeid)) < 0)
|
|
|
|
return NC_EHDFERR;
|
|
|
|
LOG((5, "compound type has %d members", nmembers));
|
|
|
|
type->u.c.field = nclistnew();
|
|
|
|
nclistsetalloc(type->u.c.field,nmembers);
|
|
|
|
|
|
|
|
for (m = 0; m < nmembers; m++)
|
|
|
|
{
|
|
|
|
hid_t member_hdf_typeid;
|
|
|
|
hid_t member_native_typeid;
|
|
|
|
size_t member_offset;
|
|
|
|
H5T_class_t mem_class;
|
|
|
|
nc_type member_xtype;
|
|
|
|
|
|
|
|
/* Get the typeid and native typeid of this member of the
|
|
|
|
* compound type. */
|
|
|
|
if ((member_hdf_typeid = H5Tget_member_type(type->native_hdf_typeid, m)) < 0)
|
|
|
|
return NC_EHDFERR;
|
|
|
|
|
2018-07-17 23:03:19 +08:00
|
|
|
if ((member_native_typeid = H5Tget_native_type(member_hdf_typeid,
|
|
|
|
H5T_DIR_DEFAULT)) < 0)
|
2018-07-17 22:29:47 +08:00
|
|
|
return NC_EHDFERR;
|
|
|
|
|
|
|
|
/* Get the name of the member.*/
|
|
|
|
member_name = H5Tget_member_name(type->native_hdf_typeid, m);
|
|
|
|
if (!member_name || strlen(member_name) > NC_MAX_NAME) {
|
|
|
|
retval = NC_EBADNAME;
|
|
|
|
break;
|
|
|
|
}
|
|
|
|
#ifdef JNA
|
|
|
|
else {
|
|
|
|
strncpy(jna,member_name,1000);
|
|
|
|
member_name = jna;
|
|
|
|
}
|
|
|
|
#endif
|
|
|
|
|
|
|
|
/* Offset in bytes on *this* platform. */
|
|
|
|
member_offset = H5Tget_member_offset(type->native_hdf_typeid, m);
|
|
|
|
|
|
|
|
/* Get dimensional data if this member is an array of something. */
|
|
|
|
if ((mem_class = H5Tget_class(member_hdf_typeid)) < 0)
|
|
|
|
return NC_EHDFERR;
|
|
|
|
if (mem_class == H5T_ARRAY)
|
|
|
|
{
|
|
|
|
int ndims, dim_size[NC_MAX_VAR_DIMS];
|
|
|
|
hsize_t dims[NC_MAX_VAR_DIMS];
|
|
|
|
int d;
|
|
|
|
|
|
|
|
if ((ndims = H5Tget_array_ndims(member_hdf_typeid)) < 0) {
|
|
|
|
retval = NC_EHDFERR;
|
|
|
|
break;
|
|
|
|
}
|
|
|
|
if (H5Tget_array_dims(member_hdf_typeid, dims, NULL) != ndims) {
|
|
|
|
retval = NC_EHDFERR;
|
|
|
|
break;
|
|
|
|
}
|
|
|
|
for (d = 0; d < ndims; d++)
|
|
|
|
dim_size[d] = dims[d];
|
|
|
|
|
|
|
|
/* What is the netCDF typeid of this member? */
|
|
|
|
if ((retval = get_netcdf_type(grp->nc4_info, H5Tget_super(member_hdf_typeid),
|
|
|
|
&member_xtype)))
|
|
|
|
break;
|
|
|
|
|
|
|
|
/* Add this member to our list of fields in this compound type. */
|
|
|
|
if ((retval = nc4_field_list_add(type, member_name,
|
|
|
|
member_offset, H5Tget_super(member_hdf_typeid),
|
|
|
|
H5Tget_super(member_native_typeid),
|
|
|
|
member_xtype, ndims, dim_size)))
|
|
|
|
break;
|
|
|
|
}
|
|
|
|
else
|
|
|
|
{
|
|
|
|
/* What is the netCDF typeid of this member? */
|
|
|
|
if ((retval = get_netcdf_type(grp->nc4_info, member_native_typeid,
|
|
|
|
&member_xtype)))
|
|
|
|
break;
|
|
|
|
|
|
|
|
/* Add this member to our list of fields in this compound type. */
|
|
|
|
if ((retval = nc4_field_list_add(type, member_name,
|
|
|
|
member_offset, member_hdf_typeid, member_native_typeid,
|
|
|
|
member_xtype, 0, NULL)))
|
|
|
|
break;
|
|
|
|
}
|
|
|
|
|
|
|
|
hdf5free(member_name);
|
|
|
|
member_name = NULL;
|
|
|
|
}
|
|
|
|
hdf5free(member_name);
|
|
|
|
member_name = NULL;
|
|
|
|
if(retval) /* error exit from loop */
|
|
|
|
return retval;
|
|
|
|
}
|
|
|
|
break;
|
|
|
|
|
|
|
|
case H5T_VLEN:
|
|
|
|
{
|
|
|
|
htri_t ret;
|
|
|
|
|
|
|
|
/* For conveninence we allow user to pass vlens of strings
|
|
|
|
* with null terminated strings. This means strings are
|
|
|
|
* treated slightly differently by the API, although they are
|
|
|
|
* really just VLENs of characters. */
|
|
|
|
if ((ret = H5Tis_variable_str(hdf_typeid)) < 0)
|
|
|
|
return NC_EHDFERR;
|
|
|
|
if (ret)
|
|
|
|
type->nc_type_class = NC_STRING;
|
|
|
|
else
|
|
|
|
{
|
|
|
|
hid_t base_hdf_typeid;
|
|
|
|
nc_type base_nc_type = NC_NAT;
|
|
|
|
|
|
|
|
type->nc_type_class = NC_VLEN;
|
|
|
|
|
|
|
|
/* Find the base type of this vlen (i.e. what is this a
|
|
|
|
* vlen of?) */
|
|
|
|
if (!(base_hdf_typeid = H5Tget_super(native_typeid)))
|
|
|
|
return NC_EHDFERR;
|
|
|
|
|
|
|
|
/* What size is this type? */
|
|
|
|
if (!(type_size = H5Tget_size(base_hdf_typeid)))
|
|
|
|
return NC_EHDFERR;
|
|
|
|
|
|
|
|
/* What is the netcdf corresponding type. */
|
|
|
|
if ((retval = get_netcdf_type(grp->nc4_info, base_hdf_typeid,
|
|
|
|
&base_nc_type)))
|
|
|
|
return retval;
|
|
|
|
LOG((5, "base_hdf_typeid 0x%x type_size %d base_nc_type %d",
|
|
|
|
base_hdf_typeid, type_size, base_nc_type));
|
|
|
|
|
|
|
|
/* Remember the base types for this vlen */
|
|
|
|
type->u.v.base_nc_typeid = base_nc_type;
|
|
|
|
type->u.v.base_hdf_typeid = base_hdf_typeid;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
break;
|
|
|
|
|
|
|
|
case H5T_OPAQUE:
|
|
|
|
type->nc_type_class = NC_OPAQUE;
|
|
|
|
break;
|
|
|
|
|
|
|
|
case H5T_ENUM:
|
|
|
|
{
|
|
|
|
hid_t base_hdf_typeid;
|
|
|
|
nc_type base_nc_type = NC_NAT;
|
|
|
|
void *value;
|
|
|
|
int i;
|
|
|
|
char *member_name = NULL;
|
|
|
|
#ifdef JNA
|
|
|
|
char jna[1001];
|
|
|
|
#endif
|
|
|
|
|
|
|
|
type->nc_type_class = NC_ENUM;
|
|
|
|
|
|
|
|
/* Find the base type of this enum (i.e. what is this a
|
|
|
|
* enum of?) */
|
|
|
|
if (!(base_hdf_typeid = H5Tget_super(hdf_typeid)))
|
|
|
|
return NC_EHDFERR;
|
|
|
|
/* What size is this type? */
|
|
|
|
if (!(type_size = H5Tget_size(base_hdf_typeid)))
|
|
|
|
return NC_EHDFERR;
|
|
|
|
/* What is the netcdf corresponding type. */
|
|
|
|
if ((retval = get_netcdf_type(grp->nc4_info, base_hdf_typeid,
|
|
|
|
&base_nc_type)))
|
|
|
|
return retval;
|
|
|
|
LOG((5, "base_hdf_typeid 0x%x type_size %d base_nc_type %d",
|
|
|
|
base_hdf_typeid, type_size, base_nc_type));
|
|
|
|
|
|
|
|
/* Remember the base types for this enum */
|
|
|
|
type->u.e.base_nc_typeid = base_nc_type;
|
|
|
|
type->u.e.base_hdf_typeid = base_hdf_typeid;
|
|
|
|
|
|
|
|
/* Find out how many member are in the enum. */
|
|
|
|
if ((nmembers = H5Tget_nmembers(hdf_typeid)) < 0)
|
|
|
|
return NC_EHDFERR;
|
|
|
|
type->u.e.enum_member = nclistnew();
|
|
|
|
nclistsetalloc(type->u.e.enum_member,nmembers);
|
|
|
|
|
|
|
|
/* Allocate space for one value. */
|
|
|
|
if (!(value = calloc(1, type_size)))
|
|
|
|
return NC_ENOMEM;
|
|
|
|
|
|
|
|
/* Read each name and value defined in the enum. */
|
|
|
|
for (i = 0; i < nmembers; i++)
|
|
|
|
{
|
|
|
|
/* Get the name and value from HDF5. */
|
|
|
|
if (!(member_name = H5Tget_member_name(hdf_typeid, i)))
|
|
|
|
{
|
|
|
|
retval = NC_EHDFERR;
|
|
|
|
break;
|
|
|
|
}
|
|
|
|
#ifdef JNA
|
|
|
|
strncpy(jna,member_name,1000);
|
|
|
|
member_name = jna;
|
|
|
|
#endif
|
|
|
|
|
|
|
|
if (strlen(member_name) > NC_MAX_NAME)
|
|
|
|
{
|
|
|
|
retval = NC_EBADNAME;
|
|
|
|
break;
|
|
|
|
}
|
|
|
|
if (H5Tget_member_value(hdf_typeid, i, value) < 0)
|
|
|
|
{
|
|
|
|
retval = NC_EHDFERR;
|
|
|
|
break;
|
|
|
|
}
|
|
|
|
|
|
|
|
/* Insert new field into this type's list of fields. */
|
|
|
|
if ((retval = nc4_enum_member_add(type, type->size,
|
|
|
|
member_name, value)))
|
|
|
|
{
|
|
|
|
break;
|
|
|
|
}
|
|
|
|
|
|
|
|
hdf5free(member_name);
|
|
|
|
member_name = NULL;
|
|
|
|
}
|
|
|
|
hdf5free(member_name);
|
|
|
|
member_name = NULL;
|
|
|
|
if(value) free(value);
|
|
|
|
if(retval) /* error exit from loop */
|
|
|
|
return retval;
|
|
|
|
}
|
|
|
|
break;
|
|
|
|
|
|
|
|
default:
|
|
|
|
LOG((0, "unknown class"));
|
|
|
|
return NC_EBADCLASS;
|
|
|
|
}
|
|
|
|
return retval;
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
2018-07-17 23:03:19 +08:00
|
|
|
* @internal Callback function for reading attributes. This is used by
|
|
|
|
* read_var().
|
2018-07-17 22:29:47 +08:00
|
|
|
*
|
|
|
|
* @param loc_id HDF5 attribute ID.
|
|
|
|
* @param att_name Name of the attrigute.
|
|
|
|
* @param ainfo HDF5 info struct for attribute.
|
|
|
|
* @param att_data The attribute data.
|
|
|
|
*
|
|
|
|
* @return ::NC_NOERR No error.
|
|
|
|
* @return ::NC_EHDFERR HDF5 returned error.
|
|
|
|
* @return ::NC_ENOMEM Out of memory.
|
|
|
|
* @return ::NC_EATTMETA HDF5 can't open attribute.
|
|
|
|
* @return ::NC_EBADTYPID Can't read attribute type.
|
|
|
|
*/
|
|
|
|
static herr_t
|
2018-07-17 23:03:19 +08:00
|
|
|
att_read_var_callbk(hid_t loc_id, const char *att_name,
|
|
|
|
const H5A_info_t *ainfo, void *att_data)
|
2018-07-17 22:29:47 +08:00
|
|
|
{
|
|
|
|
|
|
|
|
hid_t attid = 0;
|
|
|
|
int retval = NC_NOERR;
|
|
|
|
NC_ATT_INFO_T *att;
|
|
|
|
att_iter_info *att_info = (att_iter_info *)att_data;
|
|
|
|
|
|
|
|
/* Should we ignore this attribute? */
|
2018-07-21 02:39:02 +08:00
|
|
|
if (NC_findreserved(att_name))
|
|
|
|
return NC_NOERR;
|
2018-07-17 22:29:47 +08:00
|
|
|
|
|
|
|
/* Add to the end of the list of atts for this var. */
|
|
|
|
if ((retval = nc4_att_list_add(att_info->var->att, att_name, &att)))
|
|
|
|
BAIL(retval);
|
|
|
|
|
|
|
|
/* Open the att by name. */
|
|
|
|
if ((attid = H5Aopen(loc_id, att_name, H5P_DEFAULT)) < 0)
|
|
|
|
BAIL(NC_EATTMETA);
|
|
|
|
LOG((4, "%s:: att_name %s", __func__, att_name));
|
|
|
|
|
|
|
|
/* Read the rest of the info about the att,
|
|
|
|
* including its values. */
|
|
|
|
if ((retval = read_hdf5_att(att_info->grp, attid, att)))
|
|
|
|
BAIL(retval);
|
|
|
|
|
|
|
|
if (att)
|
|
|
|
att->created = NC_TRUE;
|
|
|
|
|
|
|
|
exit:
|
2018-07-21 02:39:02 +08:00
|
|
|
if (retval == NC_EBADTYPID)
|
|
|
|
{
|
|
|
|
/* NC_EBADTYPID will be normally converted to NC_NOERR so that
|
|
|
|
the parent iterator does not fail. */
|
|
|
|
retval = nc4_att_list_del(att_info->var->att,att);
|
|
|
|
att = NULL;
|
2018-07-17 22:29:47 +08:00
|
|
|
}
|
|
|
|
if (attid > 0 && H5Aclose(attid) < 0)
|
|
|
|
retval = NC_EHDFERR;
|
|
|
|
return retval;
|
|
|
|
}
|
|
|
|
|
2018-07-21 20:46:29 +08:00
|
|
|
/**
|
|
|
|
* @internal Callback function for reading attributes. This is used by
|
|
|
|
* read_var().
|
|
|
|
*
|
|
|
|
* @param loc_id HDF5 attribute ID.
|
|
|
|
* @param att_name Name of the attrigute.
|
|
|
|
* @param ainfo HDF5 info struct for attribute.
|
|
|
|
* @param att_data The attribute data.
|
|
|
|
*
|
|
|
|
* @return ::NC_NOERR No error.
|
|
|
|
* @return ::NC_EHDFERR HDF5 returned error.
|
|
|
|
* @return ::NC_ENOMEM Out of memory.
|
|
|
|
* @return ::NC_EATTMETA HDF5 can't open attribute.
|
|
|
|
* @return ::NC_EBADTYPID Can't read attribute type.
|
|
|
|
*/
|
|
|
|
static herr_t
|
|
|
|
att_read_grp_callbk(hid_t loc_id, const char *att_name,
|
|
|
|
const H5A_info_t *ainfo, void *att_data)
|
|
|
|
{
|
|
|
|
|
|
|
|
hid_t attid = 0;
|
|
|
|
int retval = NC_NOERR;
|
|
|
|
NC_ATT_INFO_T *att;
|
|
|
|
att_iter_info *att_info = (att_iter_info *)att_data;
|
|
|
|
|
|
|
|
/* This may be an attribute telling us that strict netcdf-3 rules
|
|
|
|
* are in effect. If so, we will make note of the fact, but not add
|
|
|
|
* this attribute to the metadata. It's not a user attribute, but
|
|
|
|
* an internal netcdf-4 one. */
|
|
|
|
if (!strcmp(att_name, NC3_STRICT_ATT_NAME))
|
|
|
|
{
|
|
|
|
att_info->grp->nc4_info->cmode |= NC_CLASSIC_MODEL;
|
|
|
|
return NC_NOERR;
|
|
|
|
}
|
|
|
|
|
|
|
|
/* Should we ignore this attribute? */
|
|
|
|
if (NC_findreserved(att_name))
|
|
|
|
return NC_NOERR;
|
|
|
|
|
|
|
|
/* Add to the end of the list of atts for this var. */
|
|
|
|
if ((retval = nc4_att_list_add(att_info->grp->att, att_name, &att)))
|
|
|
|
BAIL(retval);
|
|
|
|
|
|
|
|
/* Open the att by name. */
|
|
|
|
if ((attid = H5Aopen(loc_id, att_name, H5P_DEFAULT)) < 0)
|
|
|
|
BAIL(NC_EATTMETA);
|
|
|
|
LOG((4, "%s:: att_name %s", __func__, att_name));
|
|
|
|
|
|
|
|
/* Read the rest of the info about the att,
|
|
|
|
* including its values. */
|
|
|
|
if ((retval = read_hdf5_att(att_info->grp, attid, att)))
|
|
|
|
BAIL(retval);
|
|
|
|
|
|
|
|
if (att)
|
|
|
|
att->created = NC_TRUE;
|
|
|
|
|
|
|
|
exit:
|
|
|
|
if (retval == NC_EBADTYPID)
|
|
|
|
{
|
|
|
|
/* NC_EBADTYPID will be normally converted to NC_NOERR so that
|
|
|
|
the parent iterator does not fail. */
|
|
|
|
retval = nc4_att_list_del(att_info->grp->att,att);
|
|
|
|
att = NULL;
|
|
|
|
}
|
|
|
|
if (attid > 0 && H5Aclose(attid) < 0)
|
|
|
|
retval = NC_EHDFERR;
|
|
|
|
return retval;
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @internal This function reads all the group level attributes (the
|
|
|
|
* NC_GLOBAL atts for this group).
|
|
|
|
*
|
|
|
|
* @param grp Pointer to group info struct.
|
|
|
|
*
|
|
|
|
* @return ::NC_NOERR No error.
|
|
|
|
* @return ::NC_EHDFERR HDF5 returned error.
|
|
|
|
* @author Ed Hartnett
|
|
|
|
*/
|
|
|
|
int
|
|
|
|
nc4_read_grp_atts2(NC_GRP_INFO_T *grp)
|
|
|
|
{
|
|
|
|
att_iter_info att_info; /* Custom iteration information */
|
|
|
|
|
|
|
|
/* Check inputs. */
|
|
|
|
assert(grp);
|
|
|
|
|
|
|
|
/* Assign var and grp in struct. */
|
|
|
|
att_info.var = NULL;
|
|
|
|
att_info.grp = grp;
|
|
|
|
|
|
|
|
/* Now read all the attributes of this variable, ignoring the
|
|
|
|
ones that hold HDF5 dimension scale information. */
|
|
|
|
if ((H5Aiterate2(grp->hdf_grpid, H5_INDEX_CRT_ORDER, H5_ITER_INC, NULL,
|
|
|
|
att_read_grp_callbk, &att_info)) < 0)
|
|
|
|
return NC_EATTMETA;
|
|
|
|
|
|
|
|
/* Remember that we have read the atts for this var. */
|
|
|
|
grp->atts_not_read = 0;
|
|
|
|
|
|
|
|
return NC_NOERR;
|
|
|
|
}
|
|
|
|
|
2018-07-17 22:29:47 +08:00
|
|
|
/**
|
|
|
|
* @internal This function reads all the attributes of a variable.
|
|
|
|
*
|
|
|
|
* @param grp Pointer to the group info.
|
|
|
|
* @param var Pointer to the var info.
|
|
|
|
*
|
|
|
|
* @return NC_NOERR No error.
|
|
|
|
* @author Ed Hartnett
|
|
|
|
*/
|
|
|
|
int
|
|
|
|
nc4_read_var_atts(NC_GRP_INFO_T *grp, NC_VAR_INFO_T *var)
|
|
|
|
{
|
|
|
|
att_iter_info att_info; /* Custom iteration information */
|
|
|
|
|
|
|
|
/* Check inputs. */
|
|
|
|
assert(grp && var);
|
|
|
|
|
|
|
|
/* Assign var and grp in struct. */
|
|
|
|
att_info.var = var;
|
|
|
|
att_info.grp = grp;
|
|
|
|
|
|
|
|
/* Now read all the attributes of this variable, ignoring the
|
|
|
|
ones that hold HDF5 dimension scale information. */
|
|
|
|
if ((H5Aiterate2(var->hdf_datasetid, H5_INDEX_CRT_ORDER, H5_ITER_INC, NULL,
|
|
|
|
att_read_var_callbk, &att_info)) < 0)
|
|
|
|
return NC_EATTMETA;
|
|
|
|
|
|
|
|
/* Remember that we have read the atts for this var. */
|
|
|
|
var->atts_not_read = 0;
|
|
|
|
|
|
|
|
return NC_NOERR;
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @internal This function is called by read_dataset when a dimension
|
|
|
|
* scale dataset is encountered. It reads in the dimension data
|
|
|
|
* (creating a new NC_DIM_INFO_T object), and also checks to see if
|
|
|
|
* this is a dimension without a variable - that is, a coordinate
|
|
|
|
* dimension which does not have any coordinate data.
|
|
|
|
*
|
|
|
|
* @param grp Pointer to group info struct.
|
|
|
|
* @param datasetid The HDF5 dataset ID.
|
|
|
|
* @param obj_name
|
|
|
|
* @param statbuf
|
|
|
|
* @param scale_size Size of dimension scale.
|
|
|
|
* @param max_scale_size Maximum size of dim scale.
|
|
|
|
* @param dim Pointer to pointer that gets new dim info struct.
|
|
|
|
*
|
|
|
|
* @returns ::NC_NOERR No error.
|
|
|
|
* @return ::NC_EHDFERR HDF5 returned error.
|
|
|
|
* @author Ed Hartnett
|
|
|
|
*/
|
|
|
|
static int
|
|
|
|
read_scale(NC_GRP_INFO_T *grp, hid_t datasetid, const char *obj_name,
|
|
|
|
const H5G_stat_t *statbuf, hsize_t scale_size, hsize_t max_scale_size,
|
|
|
|
NC_DIM_INFO_T **dim)
|
|
|
|
{
|
2018-07-17 23:03:19 +08:00
|
|
|
NC_DIM_INFO_T *new_dim; /* Dimension added to group */
|
2018-07-17 22:29:47 +08:00
|
|
|
char dimscale_name_att[NC_MAX_NAME + 1] = ""; /* Dimscale name, for checking if dim without var */
|
2018-07-17 23:03:19 +08:00
|
|
|
htri_t attr_exists = -1; /* Flag indicating hidden attribute exists */
|
|
|
|
hid_t attid = -1; /* ID of hidden attribute (to store dim ID) */
|
|
|
|
int dimscale_created = 0; /* Remember if a dimension was created (for error recovery) */
|
2018-07-17 22:29:47 +08:00
|
|
|
short initial_next_dimid = grp->nc4_info->next_dimid;/* Retain for error recovery */
|
|
|
|
int retval;
|
|
|
|
size_t len = 0;
|
|
|
|
int too_long = NC_FALSE;
|
|
|
|
int assigned_id = -1;
|
|
|
|
|
|
|
|
/* Does this dataset have a hidden attribute that tells us its
|
|
|
|
* dimid? If so, read it. */
|
|
|
|
if ((attr_exists = H5Aexists(datasetid, NC_DIMID_ATT_NAME)) < 0)
|
|
|
|
BAIL(NC_EHDFERR);
|
|
|
|
if (attr_exists)
|
|
|
|
{
|
|
|
|
if ((attid = H5Aopen_name(datasetid, NC_DIMID_ATT_NAME)) < 0)
|
|
|
|
BAIL(NC_EHDFERR);
|
|
|
|
|
|
|
|
if (H5Aread(attid, H5T_NATIVE_INT, &assigned_id) < 0)
|
|
|
|
BAIL(NC_EHDFERR);
|
|
|
|
|
|
|
|
/* Check if scale's dimid should impact the group's next dimid */
|
|
|
|
if (assigned_id >= grp->nc4_info->next_dimid)
|
|
|
|
grp->nc4_info->next_dimid = assigned_id + 1;
|
|
|
|
}
|
|
|
|
|
|
|
|
if (SIZEOF_SIZE_T < 8 && scale_size > NC_MAX_UINT)
|
|
|
|
{
|
|
|
|
len = NC_MAX_UINT;
|
|
|
|
too_long = NC_TRUE;
|
|
|
|
}
|
|
|
|
else
|
|
|
|
len = scale_size;
|
|
|
|
|
|
|
|
/* Create the dimension for this scale. */
|
|
|
|
if ((retval = nc4_dim_list_add(grp, obj_name, len, assigned_id, &new_dim)))
|
|
|
|
BAIL(retval);
|
|
|
|
|
|
|
|
new_dim->too_long = too_long;
|
|
|
|
|
|
|
|
dimscale_created++;
|
|
|
|
|
|
|
|
new_dim->hdf5_objid.fileno[0] = statbuf->fileno[0];
|
|
|
|
new_dim->hdf5_objid.fileno[1] = statbuf->fileno[1];
|
|
|
|
new_dim->hdf5_objid.objno[0] = statbuf->objno[0];
|
|
|
|
new_dim->hdf5_objid.objno[1] = statbuf->objno[1];
|
|
|
|
|
|
|
|
/* If the dimscale has an unlimited dimension, then this dimension
|
|
|
|
* is unlimited. */
|
|
|
|
if (max_scale_size == H5S_UNLIMITED)
|
|
|
|
new_dim->unlimited = NC_TRUE;
|
|
|
|
|
|
|
|
/* If the scale name is set to DIM_WITHOUT_VARIABLE, then this is a
|
|
|
|
* dimension, but not a variable. (If get_scale_name returns an
|
|
|
|
* error, just move on, there's no NAME.) */
|
|
|
|
if (H5DSget_scale_name(datasetid, dimscale_name_att, NC_MAX_NAME) >= 0)
|
|
|
|
{
|
|
|
|
if (!strncmp(dimscale_name_att, DIM_WITHOUT_VARIABLE,
|
|
|
|
strlen(DIM_WITHOUT_VARIABLE)))
|
|
|
|
{
|
|
|
|
if (new_dim->unlimited)
|
|
|
|
{
|
|
|
|
size_t len = 0, *lenp = &len;
|
|
|
|
|
|
|
|
if ((retval = nc4_find_dim_len(grp, new_dim->hdr.id, &lenp)))
|
|
|
|
BAIL(retval);
|
|
|
|
new_dim->len = *lenp;
|
|
|
|
}
|
|
|
|
|
2018-07-17 23:03:19 +08:00
|
|
|
/* Hold open the dataset, since the dimension doesn't have a
|
|
|
|
* coordinate variable */
|
2018-07-17 22:29:47 +08:00
|
|
|
new_dim->hdf_dimscaleid = datasetid;
|
|
|
|
H5Iinc_ref(new_dim->hdf_dimscaleid); /* Increment number of objects using ID */
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
/* Set the dimension created */
|
|
|
|
*dim = new_dim;
|
|
|
|
|
|
|
|
exit:
|
2018-07-17 23:03:19 +08:00
|
|
|
/* Close the hidden attribute, if it was opened (error, or no
|
|
|
|
* error) */
|
2018-07-17 22:29:47 +08:00
|
|
|
if (attid > 0 && H5Aclose(attid) < 0)
|
|
|
|
BAIL2(NC_EHDFERR);
|
|
|
|
|
|
|
|
/* On error, undo any dimscale creation */
|
|
|
|
if (retval < 0 && dimscale_created)
|
|
|
|
{
|
|
|
|
/* free the dimension */
|
|
|
|
if ((retval = nc4_dim_list_del(grp, new_dim)))
|
|
|
|
BAIL2(retval);
|
|
|
|
|
|
|
|
/* Reset the group's information */
|
|
|
|
grp->nc4_info->next_dimid = initial_next_dimid;
|
|
|
|
}
|
|
|
|
|
|
|
|
return retval;
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @internal This function is called when nc4_rec_read_metadata
|
|
|
|
* encounters an HDF5 dataset when reading a file.
|
|
|
|
*
|
|
|
|
* @param grp Pointer to group info struct.
|
|
|
|
* @param datasetid HDF5 dataset ID.
|
|
|
|
* @param obj_name Object name.
|
|
|
|
* @param statbuf HDF5 status buffer.
|
|
|
|
*
|
|
|
|
* @return ::NC_NOERR No error.
|
|
|
|
* @return ::NC_EBADID Bad ncid.
|
|
|
|
* @return ::NC_EHDFERR HDF5 returned error.
|
|
|
|
* @author Ed Hartnett
|
|
|
|
*/
|
|
|
|
static int
|
|
|
|
read_dataset(NC_GRP_INFO_T *grp, hid_t datasetid, const char *obj_name,
|
|
|
|
const H5G_stat_t *statbuf)
|
|
|
|
{
|
|
|
|
NC_DIM_INFO_T *dim = NULL; /* Dimension created for scales */
|
|
|
|
hid_t spaceid = 0;
|
|
|
|
int ndims;
|
|
|
|
htri_t is_scale;
|
|
|
|
int retval = NC_NOERR;
|
|
|
|
|
|
|
|
/* Get the dimension information for this dataset. */
|
|
|
|
if ((spaceid = H5Dget_space(datasetid)) < 0)
|
|
|
|
BAIL(NC_EHDFERR);
|
|
|
|
if ((ndims = H5Sget_simple_extent_ndims(spaceid)) < 0)
|
|
|
|
BAIL(NC_EHDFERR);
|
|
|
|
|
|
|
|
/* Is this a dimscale? */
|
|
|
|
if ((is_scale = H5DSis_scale(datasetid)) < 0)
|
|
|
|
BAIL(NC_EHDFERR);
|
|
|
|
if (is_scale)
|
|
|
|
{
|
|
|
|
hsize_t dims[H5S_MAX_RANK];
|
|
|
|
hsize_t max_dims[H5S_MAX_RANK];
|
|
|
|
|
|
|
|
/* Query the scale's size & max. size */
|
|
|
|
if (H5Sget_simple_extent_dims(spaceid, dims, max_dims) < 0)
|
|
|
|
BAIL(NC_EHDFERR);
|
|
|
|
|
|
|
|
/* Read the scale information. */
|
|
|
|
if ((retval = read_scale(grp, datasetid, obj_name, statbuf, dims[0],
|
|
|
|
max_dims[0], &dim)))
|
|
|
|
BAIL(retval);
|
|
|
|
}
|
|
|
|
|
|
|
|
/* Add a var to the linked list, and get its metadata,
|
|
|
|
* unless this is one of those funny dimscales that are a
|
|
|
|
* dimension in netCDF but not a variable. (Spooky!) */
|
|
|
|
if (NULL == dim || (dim && !dim->hdf_dimscaleid))
|
|
|
|
if ((retval = read_var(grp, datasetid, obj_name, ndims, dim)))
|
|
|
|
BAIL(retval);
|
|
|
|
|
|
|
|
exit:
|
|
|
|
if (spaceid && H5Sclose(spaceid) <0)
|
|
|
|
BAIL2(retval);
|
|
|
|
|
|
|
|
return retval;
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @internal Add callback function to list.
|
|
|
|
*
|
|
|
|
* @param udata - the callback state
|
|
|
|
* @param oinfo The object info.
|
|
|
|
*
|
|
|
|
* @return ::NC_NOERR No error.
|
|
|
|
* @return ::NC_ENOMEM Out of memory.
|
|
|
|
* @author Ed Hartnett
|
|
|
|
*/
|
|
|
|
static int
|
|
|
|
nc4_rec_read_metadata_cb_list_add(NC4_rec_read_metadata_ud_t* udata,
|
|
|
|
const NC4_rec_read_metadata_obj_info_t *oinfo)
|
|
|
|
{
|
|
|
|
NC4_rec_read_metadata_obj_info_t *new_oinfo; /* Pointer to info for object */
|
|
|
|
|
|
|
|
/* Allocate memory for the object's info */
|
|
|
|
if (!(new_oinfo = calloc(1, sizeof(*new_oinfo))))
|
|
|
|
return NC_ENOMEM;
|
|
|
|
|
|
|
|
/* Make a copy of the object's info */
|
|
|
|
memcpy(new_oinfo, oinfo, sizeof(*oinfo));
|
|
|
|
|
|
|
|
nclistpush(udata->grps,new_oinfo);
|
|
|
|
return (NC_NOERR);
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @internal Callback function called from nc4_rec_read_metadata().
|
|
|
|
*
|
|
|
|
* @param grpid HDF5 group ID.
|
|
|
|
* @param name Name of object.
|
|
|
|
* @param info Info struct for object.
|
|
|
|
* @param _op_data Pointer to data.
|
|
|
|
*
|
|
|
|
* @return ::NC_NOERR No error.
|
|
|
|
* @return H5_ITER_ERROR HDF5 error.
|
|
|
|
* @author Ed Hartnett
|
|
|
|
*/
|
|
|
|
static int
|
|
|
|
nc4_rec_read_metadata_cb(hid_t grpid, const char *name, const H5L_info_t *info,
|
|
|
|
void *_op_data)
|
|
|
|
{
|
|
|
|
NC4_rec_read_metadata_ud_t *udata = (NC4_rec_read_metadata_ud_t *)_op_data; /* Pointer to user data for callback */
|
|
|
|
NC4_rec_read_metadata_obj_info_t oinfo; /* Pointer to info for object */
|
|
|
|
int retval = H5_ITER_CONT;
|
|
|
|
|
|
|
|
/* Reset the memory for the object's info */
|
|
|
|
memset(&oinfo, 0, sizeof(oinfo));
|
|
|
|
|
|
|
|
/* Open this critter. */
|
|
|
|
if ((oinfo.oid = H5Oopen(grpid, name, H5P_DEFAULT)) < 0)
|
|
|
|
BAIL(H5_ITER_ERROR);
|
|
|
|
|
|
|
|
/* Get info about the object.*/
|
|
|
|
if (H5Gget_objinfo(oinfo.oid, ".", 1, &oinfo.statbuf) < 0)
|
|
|
|
BAIL(H5_ITER_ERROR);
|
|
|
|
|
|
|
|
strncpy(oinfo.oname, name, NC_MAX_NAME);
|
|
|
|
|
|
|
|
/* Add object to list, for later */
|
|
|
|
switch(oinfo.statbuf.type)
|
|
|
|
{
|
|
|
|
case H5G_GROUP:
|
|
|
|
LOG((3, "found group %s", oinfo.oname));
|
|
|
|
|
|
|
|
/* Defer descending into child group immediately, so that the types
|
|
|
|
* in the current group can be processed and be ready for use by
|
|
|
|
* vars in the child group(s).
|
|
|
|
*/
|
|
|
|
if (nc4_rec_read_metadata_cb_list_add(udata, &oinfo))
|
|
|
|
BAIL(H5_ITER_ERROR);
|
|
|
|
break;
|
|
|
|
|
|
|
|
case H5G_DATASET:
|
|
|
|
LOG((3, "found dataset %s", oinfo.oname));
|
|
|
|
|
|
|
|
/* Learn all about this dataset, which may be a dimscale
|
|
|
|
* (i.e. dimension metadata), or real data. */
|
2018-07-17 23:03:19 +08:00
|
|
|
if ((retval = read_dataset(udata->grp, oinfo.oid, oinfo.oname,
|
|
|
|
&oinfo.statbuf)))
|
2018-07-17 22:29:47 +08:00
|
|
|
{
|
|
|
|
/* Allow NC_EBADTYPID to transparently skip over datasets
|
|
|
|
* which have a datatype that netCDF-4 doesn't undertand
|
|
|
|
* (currently), but break out of iteration for other
|
|
|
|
* errors.
|
|
|
|
*/
|
|
|
|
if(NC_EBADTYPID != retval)
|
|
|
|
BAIL(H5_ITER_ERROR);
|
|
|
|
else
|
|
|
|
retval = H5_ITER_CONT;
|
|
|
|
}
|
|
|
|
|
|
|
|
/* Close the object */
|
|
|
|
if (H5Oclose(oinfo.oid) < 0)
|
|
|
|
BAIL(H5_ITER_ERROR);
|
|
|
|
break;
|
|
|
|
|
|
|
|
case H5G_TYPE:
|
|
|
|
LOG((3, "found datatype %s", oinfo.oname));
|
|
|
|
|
|
|
|
/* Process the named datatype */
|
|
|
|
if (read_type(udata->grp, oinfo.oid, oinfo.oname))
|
|
|
|
BAIL(H5_ITER_ERROR);
|
|
|
|
|
|
|
|
/* Close the object */
|
|
|
|
if (H5Oclose(oinfo.oid) < 0)
|
|
|
|
BAIL(H5_ITER_ERROR);
|
|
|
|
break;
|
|
|
|
|
|
|
|
default:
|
|
|
|
LOG((0, "Unknown object class %d in %s!", oinfo.statbuf.type, __func__));
|
|
|
|
BAIL(H5_ITER_ERROR);
|
|
|
|
}
|
|
|
|
|
|
|
|
exit:
|
|
|
|
if (retval)
|
|
|
|
{
|
|
|
|
if (oinfo.oid > 0 && H5Oclose(oinfo.oid) < 0)
|
|
|
|
BAIL2(H5_ITER_ERROR);
|
|
|
|
}
|
|
|
|
|
|
|
|
return (retval);
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @internal This is the main function to recursively read all the
|
|
|
|
* metadata for the file. The links in the 'grp' are iterated over
|
|
|
|
* and added to the file's metadata information. Note that child
|
|
|
|
* groups are not immediately processed, but are deferred until all
|
|
|
|
* the other links in the group are handled (so that vars in the child
|
|
|
|
* groups are guaranteed to have types that they use in a parent group
|
|
|
|
* in place).
|
|
|
|
*
|
|
|
|
* @param grp Pointer to a group.
|
|
|
|
*
|
|
|
|
* @return ::NC_NOERR No error.
|
|
|
|
* @author Ed Hartnett
|
|
|
|
*/
|
|
|
|
static int
|
|
|
|
nc4_rec_read_metadata(NC_GRP_INFO_T *grp)
|
|
|
|
{
|
|
|
|
NC4_rec_read_metadata_ud_t udata; /* User data for iteration */
|
|
|
|
NC4_rec_read_metadata_obj_info_t *oinfo; /* Pointer to info for object */
|
|
|
|
hsize_t idx=0;
|
|
|
|
hid_t pid = 0;
|
|
|
|
unsigned crt_order_flags = 0;
|
|
|
|
H5_index_t iter_index;
|
|
|
|
int i, retval = NC_NOERR; /* everything worked! */
|
|
|
|
|
|
|
|
assert(grp && grp->hdr.name);
|
|
|
|
LOG((3, "%s: grp->hdr.name %s", __func__, grp->hdr.name));
|
|
|
|
|
|
|
|
/* Portably initialize user data for later */
|
|
|
|
memset(&udata, 0, sizeof(udata));
|
|
|
|
|
|
|
|
/* Open this HDF5 group and retain its grpid. It will remain open
|
|
|
|
* with HDF5 until this file is nc_closed. */
|
|
|
|
if (!grp->hdf_grpid)
|
|
|
|
{
|
|
|
|
if (grp->parent)
|
|
|
|
{
|
|
|
|
if ((grp->hdf_grpid = H5Gopen2(grp->parent->hdf_grpid,
|
|
|
|
grp->hdr.name, H5P_DEFAULT)) < 0)
|
|
|
|
BAIL(NC_EHDFERR);
|
|
|
|
}
|
|
|
|
else
|
|
|
|
{
|
2018-07-20 02:47:43 +08:00
|
|
|
NC_HDF5_FILE_INFO_T *hdf5_info;
|
|
|
|
hdf5_info = (NC_HDF5_FILE_INFO_T *)grp->nc4_info->format_file_info;
|
|
|
|
|
|
|
|
if ((grp->hdf_grpid = H5Gopen2(hdf5_info->hdfid, "/",
|
|
|
|
H5P_DEFAULT)) < 0)
|
2018-07-17 22:29:47 +08:00
|
|
|
BAIL(NC_EHDFERR);
|
|
|
|
}
|
|
|
|
}
|
|
|
|
assert(grp->hdf_grpid > 0);
|
|
|
|
|
|
|
|
/* Get the group creation flags, to check for creation ordering */
|
|
|
|
pid = H5Gget_create_plist(grp->hdf_grpid);
|
|
|
|
H5Pget_link_creation_order(pid, &crt_order_flags);
|
|
|
|
if (H5Pclose(pid) < 0)
|
|
|
|
BAIL(NC_EHDFERR);
|
|
|
|
|
|
|
|
/* Set the iteration index to use */
|
|
|
|
if (crt_order_flags & H5P_CRT_ORDER_TRACKED)
|
|
|
|
iter_index = H5_INDEX_CRT_ORDER;
|
|
|
|
else
|
|
|
|
{
|
|
|
|
NC_FILE_INFO_T *h5 = grp->nc4_info;
|
|
|
|
|
|
|
|
/* Without creation ordering, file must be read-only. */
|
|
|
|
if (!h5->no_write)
|
|
|
|
BAIL(NC_ECANTWRITE);
|
|
|
|
|
|
|
|
iter_index = H5_INDEX_NAME;
|
|
|
|
}
|
|
|
|
|
|
|
|
/* Set user data for iteration */
|
|
|
|
udata.grp = grp;
|
|
|
|
udata.grps = nclistnew();
|
|
|
|
|
|
|
|
/* Iterate over links in this group, building lists for the types,
|
|
|
|
* datasets and groups encountered. */
|
|
|
|
if (H5Literate(grp->hdf_grpid, iter_index, H5_ITER_INC, &idx,
|
|
|
|
nc4_rec_read_metadata_cb, (void *)&udata) < 0)
|
|
|
|
BAIL(NC_EHDFERR);
|
|
|
|
|
|
|
|
/* Process the child groups found. (Deferred until now, so that the
|
|
|
|
* types in the current group get processed and are available for
|
|
|
|
* vars in the child group(s).) */
|
|
|
|
for(i=0;i<nclistlength(udata.grps);i++)
|
|
|
|
{
|
|
|
|
NC_GRP_INFO_T *child_grp;
|
|
|
|
oinfo = (NC4_rec_read_metadata_obj_info_t*)nclistget(udata.grps,i);
|
|
|
|
|
|
|
|
/* Add group to file's hierarchy */
|
|
|
|
if ((retval = nc4_grp_list_add(grp, oinfo->oname, &child_grp)))
|
|
|
|
BAIL(retval);
|
|
|
|
|
|
|
|
/* Recursively read the child group's metadata */
|
|
|
|
if ((retval = nc4_rec_read_metadata(child_grp)))
|
|
|
|
BAIL(retval);
|
|
|
|
|
|
|
|
/* Close the object */
|
|
|
|
if (H5Oclose(oinfo->oid) < 0)
|
|
|
|
BAIL(NC_EHDFERR);
|
|
|
|
}
|
|
|
|
|
|
|
|
/* Defer the reading of global atts until someone asks for one. */
|
|
|
|
grp->atts_not_read = 1;
|
|
|
|
|
|
|
|
/* when exiting define mode, mark all variable written */
|
|
|
|
for (i=0; i<ncindexsize(grp->vars); i++) {
|
|
|
|
NC_VAR_INFO_T* var = (NC_VAR_INFO_T*)ncindexith(grp->vars,i);
|
|
|
|
if(var == NULL) continue;
|
|
|
|
var->written_to = NC_TRUE;
|
|
|
|
}
|
|
|
|
|
|
|
|
exit:
|
|
|
|
/* Clean up local information, if anything remains */
|
|
|
|
for(i=0;i<nclistlength(udata.grps);i++)
|
|
|
|
{
|
|
|
|
oinfo = (NC4_rec_read_metadata_obj_info_t*)nclistget(udata.grps,i);
|
|
|
|
if (retval)
|
|
|
|
{
|
|
|
|
/* Close the object */
|
|
|
|
if (H5Oclose(oinfo->oid) < 0)
|
|
|
|
BAIL2(NC_EHDFERR);
|
|
|
|
}
|
|
|
|
free(oinfo);
|
|
|
|
}
|
|
|
|
nclistfree(udata.grps);
|
|
|
|
udata.grps = NULL;
|
|
|
|
|
|
|
|
return retval;
|
|
|
|
}
|