mirror of
https://github.com/HDFGroup/hdf5.git
synced 2025-02-11 16:01:00 +08:00
1eaaae9821
Cache the dataset's rank & dimension sizes, instead of querying them
frequently, to speed up various checks & algorithms. Also, a few minor
cleanups.
Tested on:
MacOSX/64 10.10.2 (amazon) w/serial & parallel
Linux/32 2.6.18 (jam) w/serial & parallel
409 lines
14 KiB
C
409 lines
14 KiB
C
/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
|
||
* Copyright by The HDF Group. *
|
||
* Copyright by the Board of Trustees of the University of Illinois. *
|
||
* All rights reserved. *
|
||
* *
|
||
* This file is part of HDF5. The full HDF5 copyright notice, including *
|
||
* terms governing use, modification, and redistribution, is contained in *
|
||
* the files COPYING and Copyright.html. COPYING can be found at the root *
|
||
* of the source code distribution tree; Copyright.html can be found at the *
|
||
* root level of an installed copy of the electronic HDF5 document set and *
|
||
* is linked from the top-level documents page. It can also be found at *
|
||
* http://hdfgroup.org/HDF5/doc/Copyright.html. If you do not have *
|
||
* access to either file, you may request a copy from help@hdfgroup.org. *
|
||
* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
|
||
|
||
/*-------------------------------------------------------------------------
|
||
*
|
||
* Created: H5Ddeprec.c
|
||
* April 5 2007
|
||
* Quincey Koziol <koziol@hdfgroup.org>
|
||
*
|
||
* Purpose: Deprecated functions from the H5D interface. These
|
||
* functions are here for compatibility purposes and may be
|
||
* removed in the future. Applications should switch to the
|
||
* newer APIs.
|
||
*
|
||
*-------------------------------------------------------------------------
|
||
*/
|
||
|
||
/****************/
|
||
/* Module Setup */
|
||
/****************/
|
||
|
||
#define H5D_PACKAGE /*suppress error about including H5Dpkg */
|
||
|
||
/* Interface initialization */
|
||
#define H5_INTERFACE_INIT_FUNC H5D__init_deprec_interface
|
||
|
||
|
||
/***********/
|
||
/* Headers */
|
||
/***********/
|
||
#include "H5private.h" /* Generic Functions */
|
||
#include "H5Dpkg.h" /* Datasets */
|
||
#include "H5Eprivate.h" /* Error handling */
|
||
#include "H5Iprivate.h" /* IDs */
|
||
|
||
|
||
/****************/
|
||
/* Local Macros */
|
||
/****************/
|
||
|
||
|
||
/******************/
|
||
/* Local Typedefs */
|
||
/******************/
|
||
|
||
|
||
/********************/
|
||
/* Package Typedefs */
|
||
/********************/
|
||
|
||
|
||
/********************/
|
||
/* Local Prototypes */
|
||
/********************/
|
||
|
||
#ifndef H5_NO_DEPRECATED_SYMBOLS
|
||
static herr_t H5D__extend(H5D_t *dataset, const hsize_t *size, hid_t dxpl_id);
|
||
#endif /* H5_NO_DEPRECATED_SYMBOLS */
|
||
|
||
|
||
/*********************/
|
||
/* Package Variables */
|
||
/*********************/
|
||
|
||
|
||
/*****************************/
|
||
/* Library Private Variables */
|
||
/*****************************/
|
||
|
||
|
||
/*******************/
|
||
/* Local Variables */
|
||
/*******************/
|
||
|
||
|
||
|
||
/*--------------------------------------------------------------------------
|
||
NAME
|
||
H5D__init_deprec_interface -- Initialize interface-specific information
|
||
USAGE
|
||
herr_t H5D__init_deprec_interface()
|
||
RETURNS
|
||
Non-negative on success/Negative on failure
|
||
DESCRIPTION
|
||
Initializes any interface-specific data or routines. (Just calls
|
||
H5D_init() currently).
|
||
|
||
--------------------------------------------------------------------------*/
|
||
static herr_t
|
||
H5D__init_deprec_interface(void)
|
||
{
|
||
FUNC_ENTER_STATIC_NOERR
|
||
|
||
FUNC_LEAVE_NOAPI(H5D_init())
|
||
} /* H5D__init_deprec_interface() */
|
||
|
||
|
||
/*--------------------------------------------------------------------------
|
||
NAME
|
||
H5D__term_deprec_interface -- Terminate interface
|
||
USAGE
|
||
herr_t H5D__term_deprec_interface()
|
||
RETURNS
|
||
Non-negative on success/Negative on failure
|
||
DESCRIPTION
|
||
Terminates interface. (Just resets H5_interface_initialize_g
|
||
currently).
|
||
|
||
--------------------------------------------------------------------------*/
|
||
herr_t
|
||
H5D__term_deprec_interface(void)
|
||
{
|
||
FUNC_ENTER_PACKAGE_NOERR
|
||
|
||
/* Mark closed */
|
||
H5_interface_initialize_g = 0;
|
||
|
||
FUNC_LEAVE_NOAPI(0)
|
||
} /* H5D__term_deprec_interface() */
|
||
|
||
#ifndef H5_NO_DEPRECATED_SYMBOLS
|
||
|
||
/*-------------------------------------------------------------------------
|
||
* Function: H5Dcreate1
|
||
*
|
||
* Purpose: Creates a new dataset named NAME at LOC_ID, opens the
|
||
* dataset for access, and associates with that dataset constant
|
||
* and initial persistent properties including the type of each
|
||
* datapoint as stored in the file (TYPE_ID), the size of the
|
||
* dataset (SPACE_ID), and other initial miscellaneous
|
||
* properties (DCPL_ID).
|
||
*
|
||
* All arguments are copied into the dataset, so the caller is
|
||
* allowed to derive new types, data spaces, and creation
|
||
* parameters from the old ones and reuse them in calls to
|
||
* create other datasets.
|
||
*
|
||
* Return: Success: The object ID of the new dataset. At this
|
||
* point, the dataset is ready to receive its
|
||
* raw data. Attempting to read raw data from
|
||
* the dataset will probably return the fill
|
||
* value. The dataset should be closed when
|
||
* the caller is no longer interested in it.
|
||
*
|
||
* Failure: FAIL
|
||
*
|
||
* Programmer: Robb Matzke
|
||
* Wednesday, December 3, 1997
|
||
*
|
||
*-------------------------------------------------------------------------
|
||
*/
|
||
hid_t
|
||
H5Dcreate1(hid_t loc_id, const char *name, hid_t type_id, hid_t space_id,
|
||
hid_t dcpl_id)
|
||
{
|
||
H5G_loc_t loc; /* Object location to insert dataset into */
|
||
H5D_t *dset = NULL; /* New dataset's info */
|
||
const H5S_t *space; /* Dataspace for dataset */
|
||
hid_t ret_value; /* Return value */
|
||
|
||
FUNC_ENTER_API(FAIL)
|
||
H5TRACE5("i", "i*siii", loc_id, name, type_id, space_id, dcpl_id);
|
||
|
||
/* Check arguments */
|
||
if(H5G_loc(loc_id, &loc) < 0)
|
||
HGOTO_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL, "not a location ID")
|
||
if(!name || !*name)
|
||
HGOTO_ERROR(H5E_ARGS, H5E_BADVALUE, FAIL, "no name")
|
||
if(H5I_DATATYPE != H5I_get_type(type_id))
|
||
HGOTO_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL, "not a datatype ID")
|
||
if(NULL == (space = (const H5S_t *)H5I_object_verify(space_id,H5I_DATASPACE)))
|
||
HGOTO_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL, "not a dataspace ID")
|
||
if(H5P_DEFAULT == dcpl_id)
|
||
dcpl_id = H5P_DATASET_CREATE_DEFAULT;
|
||
else
|
||
if(TRUE != H5P_isa_class(dcpl_id, H5P_DATASET_CREATE))
|
||
HGOTO_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL, "not dataset create property list ID")
|
||
|
||
/* Build and open the new dataset */
|
||
if(NULL == (dset = H5D__create_named(&loc, name, type_id, space, H5P_LINK_CREATE_DEFAULT, dcpl_id, H5P_DATASET_ACCESS_DEFAULT, H5AC_dxpl_id)))
|
||
HGOTO_ERROR(H5E_DATASET, H5E_CANTINIT, FAIL, "unable to create dataset")
|
||
|
||
/* Register the new dataset to get an ID for it */
|
||
if((ret_value = H5I_register(H5I_DATASET, dset, TRUE)) < 0)
|
||
HGOTO_ERROR(H5E_DATASET, H5E_CANTREGISTER, FAIL, "unable to register dataset")
|
||
|
||
done:
|
||
if(ret_value < 0)
|
||
if(dset && H5D_close(dset) < 0)
|
||
HDONE_ERROR(H5E_DATASET, H5E_CLOSEERROR, FAIL, "unable to release dataset")
|
||
|
||
FUNC_LEAVE_API(ret_value)
|
||
} /* end H5Dcreate1() */
|
||
|
||
|
||
/*-------------------------------------------------------------------------
|
||
* Function: H5Dopen1
|
||
*
|
||
* Purpose: Finds a dataset named NAME at LOC_ID, opens it, and returns
|
||
* its ID. The dataset should be close when the caller is no
|
||
* longer interested in it.
|
||
*
|
||
* Note: Deprecated in favor of H5Dopen2
|
||
*
|
||
* Return: Success: A new dataset ID
|
||
* Failure: FAIL
|
||
*
|
||
* Programmer: Robb Matzke
|
||
* Thursday, December 4, 1997
|
||
*
|
||
*-------------------------------------------------------------------------
|
||
*/
|
||
hid_t
|
||
H5Dopen1(hid_t loc_id, const char *name)
|
||
{
|
||
H5D_t *dset = NULL;
|
||
H5G_loc_t loc; /* Object location of group */
|
||
H5G_loc_t dset_loc; /* Object location of dataset */
|
||
H5G_name_t path; /* Dataset group hier. path */
|
||
H5O_loc_t oloc; /* Dataset object location */
|
||
H5O_type_t obj_type; /* Type of object at location */
|
||
hbool_t loc_found = FALSE; /* Location at 'name' found */
|
||
hid_t dapl_id = H5P_DATASET_ACCESS_DEFAULT; /* dapl to use to open dataset */
|
||
hid_t dxpl_id = H5AC_ind_dxpl_id; /* dxpl to use to open datset */
|
||
hid_t ret_value;
|
||
|
||
FUNC_ENTER_API(FAIL)
|
||
H5TRACE2("i", "i*s", loc_id, name);
|
||
|
||
/* Check args */
|
||
if(H5G_loc(loc_id, &loc) < 0)
|
||
HGOTO_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL, "not a location")
|
||
if(!name || !*name)
|
||
HGOTO_ERROR(H5E_ARGS, H5E_BADVALUE, FAIL, "no name")
|
||
|
||
/* Set up dataset location to fill in */
|
||
dset_loc.oloc = &oloc;
|
||
dset_loc.path = &path;
|
||
H5G_loc_reset(&dset_loc);
|
||
|
||
/* Find the dataset object */
|
||
if(H5G_loc_find(&loc, name, &dset_loc, H5P_DEFAULT, dxpl_id) < 0)
|
||
HGOTO_ERROR(H5E_DATASET, H5E_NOTFOUND, FAIL, "not found")
|
||
loc_found = TRUE;
|
||
|
||
/* Check that the object found is the correct type */
|
||
if(H5O_obj_type(&oloc, &obj_type, dxpl_id) < 0)
|
||
HGOTO_ERROR(H5E_DATASET, H5E_CANTGET, FAIL, "can't get object type")
|
||
if(obj_type != H5O_TYPE_DATASET)
|
||
HGOTO_ERROR(H5E_DATASET, H5E_BADTYPE, FAIL, "not a dataset")
|
||
|
||
/* Open the dataset */
|
||
if(NULL == (dset = H5D_open(&dset_loc, dapl_id, dxpl_id)))
|
||
HGOTO_ERROR(H5E_DATASET, H5E_CANTINIT, FAIL, "can't open dataset")
|
||
|
||
/* Register an atom for the dataset */
|
||
if((ret_value = H5I_register(H5I_DATASET, dset, TRUE)) < 0)
|
||
HGOTO_ERROR(H5E_ATOM, H5E_CANTREGISTER, FAIL, "can't register dataset atom")
|
||
|
||
done:
|
||
if(ret_value < 0) {
|
||
if(dset != NULL) {
|
||
if(H5D_close(dset) < 0)
|
||
HDONE_ERROR(H5E_DATASET, H5E_CLOSEERROR, FAIL, "unable to release dataset")
|
||
} /* end if */
|
||
else {
|
||
if(loc_found && H5G_loc_free(&dset_loc) < 0)
|
||
HDONE_ERROR(H5E_SYM, H5E_CANTRELEASE, FAIL, "can't free location")
|
||
} /* end else */
|
||
} /* end if */
|
||
|
||
FUNC_LEAVE_API(ret_value)
|
||
} /* end H5Dopen1() */
|
||
|
||
|
||
/*-------------------------------------------------------------------------
|
||
* Function: H5Dextend
|
||
*
|
||
* Purpose: This function makes sure that the dataset is at least of size
|
||
* SIZE. The dimensionality of SIZE is the same as the data
|
||
* space of the dataset being changed.
|
||
*
|
||
* Note: Deprecated in favor of H5Dset_extent
|
||
*
|
||
* Return: Non-negative on success/Negative on failure
|
||
*
|
||
* Programmer: Robb Matzke
|
||
* Friday, January 30, 1998
|
||
*
|
||
*-------------------------------------------------------------------------
|
||
*/
|
||
herr_t
|
||
H5Dextend(hid_t dset_id, const hsize_t size[])
|
||
{
|
||
H5D_t *dset;
|
||
herr_t ret_value = SUCCEED; /* Return value */
|
||
|
||
FUNC_ENTER_API(FAIL)
|
||
H5TRACE2("e", "i*h", dset_id, size);
|
||
|
||
/* Check args */
|
||
if(NULL == (dset = (H5D_t *)H5I_object_verify(dset_id, H5I_DATASET)))
|
||
HGOTO_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL, "not a dataset")
|
||
if(!size)
|
||
HGOTO_ERROR(H5E_ARGS, H5E_BADVALUE, FAIL, "no size specified")
|
||
|
||
/* Increase size */
|
||
if(H5D__extend(dset, size, H5AC_dxpl_id) < 0)
|
||
HGOTO_ERROR(H5E_DATASET, H5E_CANTINIT, FAIL, "unable to extend dataset")
|
||
|
||
done:
|
||
FUNC_LEAVE_API(ret_value)
|
||
} /* end H5Dextend() */
|
||
|
||
|
||
/*-------------------------------------------------------------------------
|
||
* Function: H5D__extend
|
||
*
|
||
* Purpose: Increases the size of a dataset.
|
||
*
|
||
* Return: Non-negative on success/Negative on failure
|
||
*
|
||
* Programmer: Robb Matzke
|
||
* Friday, January 30, 1998
|
||
*
|
||
*-------------------------------------------------------------------------
|
||
*/
|
||
static herr_t
|
||
H5D__extend(H5D_t *dataset, const hsize_t *size, hid_t dxpl_id)
|
||
{
|
||
htri_t changed; /* Flag to indicate that the dataspace was successfully extended */
|
||
hsize_t old_dims[H5S_MAX_RANK]; /* Current (i.e. old, if changed) dimension sizes */
|
||
H5O_fill_t *fill; /* Dataset's fill value */
|
||
herr_t ret_value = SUCCEED; /* Return value */
|
||
|
||
FUNC_ENTER_STATIC
|
||
|
||
/* Check args */
|
||
HDassert(dataset);
|
||
HDassert(size);
|
||
|
||
/* Check if the filters in the DCPL will need to encode, and if so, can they? */
|
||
if(H5D__check_filters(dataset) < 0)
|
||
HGOTO_ERROR(H5E_DATASET, H5E_CANTINIT, FAIL, "can't apply filters")
|
||
|
||
/*
|
||
* NOTE: Restrictions on extensions were checked when the dataset was
|
||
* created. All extensions are allowed here since none should be
|
||
* able to muck things up.
|
||
*/
|
||
|
||
/* Retrieve the current dimensions */
|
||
HDcompile_assert(sizeof(old_dims) == sizeof(dataset->shared->curr_dims));
|
||
HDmemcpy(old_dims, dataset->shared->curr_dims, H5S_MAX_RANK * sizeof(old_dims[0]));
|
||
|
||
/* Increase the size of the data space */
|
||
if((changed = H5S_extend(dataset->shared->space, size)) < 0)
|
||
HGOTO_ERROR(H5E_DATASET, H5E_CANTINIT, FAIL, "unable to increase size of dataspace")
|
||
|
||
/* Updated the dataset's info if the dataspace was successfully extended */
|
||
if(changed) {
|
||
/* Get the extended dimension sizes */
|
||
/* (Need to retrieve this here, since the 'size' dimensions could
|
||
* extend one dimension but be smaller in a different dimension,
|
||
* and the dataspace's extent is the larger of the current and
|
||
* 'size' dimension values. - QAK)
|
||
*/
|
||
if(H5S_get_simple_extent_dims(dataset->shared->space, dataset->shared->curr_dims, NULL) < 0)
|
||
HGOTO_ERROR(H5E_DATASET, H5E_CANTGET, FAIL, "can't get dataset dimensions")
|
||
|
||
/* Update the index values for the cached chunks for this dataset */
|
||
if(H5D_CHUNKED == dataset->shared->layout.type) {
|
||
/* Update general information for chunks */
|
||
if(H5D__chunk_set_info(dataset) < 0)
|
||
HGOTO_ERROR(H5E_DATASET, H5E_CANTSET, FAIL, "unable to update # of chunks")
|
||
/* Update the chunk cache indices */
|
||
if(H5D__chunk_update_cache(dataset, dxpl_id) < 0)
|
||
HGOTO_ERROR(H5E_DATASET, H5E_WRITEERROR, FAIL, "unable to update cached chunk indices")
|
||
} /* end if */
|
||
|
||
/* Allocate space for the new parts of the dataset, if appropriate */
|
||
fill = &dataset->shared->dcpl_cache.fill;
|
||
if(fill->alloc_time == H5D_ALLOC_TIME_EARLY)
|
||
if(H5D__alloc_storage(dataset, dxpl_id, H5D_ALLOC_EXTEND, FALSE, old_dims) < 0)
|
||
HGOTO_ERROR(H5E_DATASET, H5E_CANTINIT, FAIL, "unable to initialize dataset with fill value")
|
||
|
||
/* Mark the dataspace as dirty, for later writing to the file */
|
||
if(H5D__mark(dataset, dxpl_id, H5D_MARK_SPACE) < 0)
|
||
HGOTO_ERROR(H5E_DATASET, H5E_CANTSET, FAIL, "unable to mark dataspace as dirty")
|
||
} /* end if */
|
||
|
||
done:
|
||
FUNC_LEAVE_NOAPI(ret_value)
|
||
} /* end H5D__extend() */
|
||
#endif /* H5_NO_DEPRECATED_SYMBOLS */
|
||
|