mirror/hdf5
2
0
Fork 0
mirror of https://github.com/HDFGroup/hdf5.git synced 2025-04-12 17:31:09 +08:00
Code Issues Packages Projects Releases Wiki Activity
hdf5/src/H5P.c
Robb Matzke e4834c43ce [svn-r1548] Changes since 19990727 
----------------------

./src/H5.c		[1.3]
./src/H5AC.c		[1.3]
./src/H5ACprivate.h	[1.3]
./src/H5B.c		[1.3]
./src/H5Bprivate.h	[1.3]
./src/H5D.c		[1.3]
./src/H5F.c		[1.3]
./src/H5Farray.c	[1.3]
./src/H5Fcore.c		[1.3]
./src/H5Ffamily.c	[1.3]
./src/H5Fistore.c	[1.3]
./src/H5Flow.c		[1.3]
./src/H5Fmpio.c		[1.3]
./src/H5Fprivate.h	[1.3]
./src/H5Fsec2.c		[1.3]
./src/H5Fsplit.c	[1.3]
./src/H5Fstdio.c	[1.3]
./src/H5G.c		[1.3]
./src/H5Gent.c		[1.3]
./src/H5Gnode.c		[1.3]
./src/H5Gprivate.h	[1.3]
./src/H5Gstab.c		[1.3]
./src/H5HG.c		[1.3]
./src/H5HGprivate.h	[1.3]
./src/H5HL.c		[1.3]
./src/H5HLprivate.h	[1.3]
./src/H5MF.c		[1.3]
./src/H5MFprivate.h	[1.3]
./src/H5O.c		[1.3]
./src/H5Oattr.c		[1.3]
./src/H5Ocont.c		[1.3]
./src/H5Odtype.c	[1.3]
./src/H5Oefl.c		[1.3]
./src/H5Olayout.c	[1.3]
./src/H5Oprivate.h	[1.3]
./src/H5Oshared.c	[1.3]
./src/H5Ostab.c		[1.3]
./src/H5P.c		[1.3]
./src/H5R.c		[1.3]
./src/H5Smpio.c		[1.3]
./src/H5T.c		[1.3]
./src/H5Tvlen.c		[1.3]
./src/H5private.h	[1.3]
./test/dtypes.c		[1.3]
./test/gheap.c		[1.3]
./test/istore.c		[1.3]
./test/lheap.c		[1.3]
./test/ohdr.c		[1.3]
./tools/h5debug.c	[1.3]
	File addresses (the `haddr_t' type) are passed by value
	instead of by reference. The type is no longer a struct. This
	is one of the preliminary changes needed for the Virtual File
	Layer stuff.

./src/H5Fprivate.h	[1.3]
./src/H5Flow.c		[1.3]
	Some address functions were rewritten as macros.
1999-07-28 13:25:43 -05:00

3337 lines
96 KiB
C
Raw Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

/****************************************************************************
* NCSA HDF *
* Software Development Group *
* National Center for Supercomputing Applications *
* University of Illinois at Urbana-Champaign *
* 605 E. Springfield, Champaign IL 61820 *
* *
* For conditions of distribution and use, see the accompanying *
* hdf/COPYING file. *
* *
****************************************************************************/
#ifdef RCSID
static char RcsId[] = "@(#)$Revision$";
#endif
/* $Id$ */
/* Private header files */
#include <H5private.h> /* Generic Functions */
#include <H5Iprivate.h> /* IDs */
#include <H5Bprivate.h> /* B-tree subclass names */
#include <H5Dprivate.h> /* Datasets */
#include <H5Eprivate.h> /* Error handling */
#include <H5MMprivate.h> /* Memory management */
#include <H5Pprivate.h> /* Property lists */
#define PABLO_MASK H5P_mask
/* Is the interface initialized? */
static intn interface_initialize_g = 0;
#define INTERFACE_INIT H5P_init_interface
static herr_t H5P_init_interface(void);
/*--------------------------------------------------------------------------
NAME
H5P_init_interface -- Initialize interface-specific information
USAGE
herr_t H5P_init_interface()
RETURNS
Non-negative on success/Negative on failure
DESCRIPTION
Initializes any interface-specific data or routines.
--------------------------------------------------------------------------*/
static herr_t
H5P_init_interface(void)
{
herr_t ret_value = SUCCEED;
intn i;
herr_t status;
FUNC_ENTER(H5P_init_interface, FAIL);
/*
* Make sure the file creation and file access default property lists are
* initialized since this might be done at run-time instead of compile
* time.
*/
if (H5F_init()<0) {
HRETURN_ERROR (H5E_INTERNAL, H5E_CANTINIT, FAIL,
"unable to initialize H5F and H5P interfaces");
}
assert(H5P_NCLASSES <= H5I_TEMPLATE_MAX - H5I_TEMPLATE_0);
/*
* Initialize the mappings between property list classes and atom
* groups. We keep the two separate because property list classes are
* publicly visible but atom groups aren't.
*/
for (i = 0; i < H5P_NCLASSES; i++) {
status = H5I_init_group((H5I_type_t)(H5I_TEMPLATE_0 +i),
H5I_TEMPID_HASHSIZE, 0, NULL);
if (status < 0) ret_value = FAIL;
}
if (ret_value < 0) {
HRETURN_ERROR(H5E_ATOM, H5E_CANTINIT, FAIL,
"unable to initialize atom group");
}
FUNC_LEAVE(ret_value);
}
/*--------------------------------------------------------------------------
NAME
H5P_term_interface
PURPOSE
Terminate various H5P objects
USAGE
void H5P_term_interface()
RETURNS
Non-negative on success/Negative on failure
DESCRIPTION
Release the atom group and any other resources allocated.
GLOBAL VARIABLES
COMMENTS, BUGS, ASSUMPTIONS
Can't report errors...
EXAMPLES
REVISION LOG
--------------------------------------------------------------------------*/
intn
H5P_term_interface(void)
{
intn i, n=0;
if (interface_initialize_g) {
for (i=0; i<H5P_NCLASSES; i++) {
n += H5I_nmembers((H5I_type_t)(H5I_TEMPLATE_0+i));
}
if (n) {
for (i=0; i<H5P_NCLASSES; i++) {
H5I_clear_group((H5I_type_t)(H5I_TEMPLATE_0+i), FALSE);
}
} else {
for (i=0; i<H5P_NCLASSES; i++) {
H5I_destroy_group((H5I_type_t)(H5I_TEMPLATE_0 + i));
n++; /*H5I*/
}
interface_initialize_g = 0;
}
}
return n;
}
/*--------------------------------------------------------------------------
NAME
H5Pcreate
PURPOSE
Returns a copy of the default property list for some class of property
* lists.
USAGE
herr_t H5Pcreate (type)
H5P_class_t type; IN: Property list class whose default is
* desired.
RETURNS
Property list ID or Negative
ERRORS
ARGS BADVALUE Unknown property list class.
ATOM CANTINIT Can't register property list.
INTERNAL UNSUPPORTED Not implemented yet.
DESCRIPTION
Returns a copy of the default property list for some class of property
* lists.
--------------------------------------------------------------------------*/
hid_t
H5Pcreate(H5P_class_t type)
{
hid_t ret_value = FAIL;
void *plist = NULL;
FUNC_ENTER(H5Pcreate, FAIL);
H5TRACE1("i","p",type);
/* Allocate a new property list and initialize it with default values */
switch (type) {
case H5P_FILE_CREATE:
if (NULL==(plist = H5MM_malloc(sizeof(H5F_create_t)))) {
HRETURN_ERROR (H5E_RESOURCE, H5E_NOSPACE, FAIL,
"memory allocation failed");
}
HDmemcpy(plist, &H5F_create_dflt, sizeof(H5F_create_t));
break;
case H5P_FILE_ACCESS:
if (NULL==(plist = H5MM_malloc(sizeof(H5F_access_t)))) {
HRETURN_ERROR (H5E_RESOURCE, H5E_NOSPACE, FAIL,
"memory allocation failed");
}
HDmemcpy(plist, &H5F_access_dflt, sizeof(H5F_access_t));
break;
case H5P_DATASET_CREATE:
if (NULL==(plist = H5MM_malloc(sizeof(H5D_create_t)))) {
HRETURN_ERROR (H5E_RESOURCE, H5E_NOSPACE, FAIL,
"memory allocation failed");
}
HDmemcpy(plist, &H5D_create_dflt, sizeof(H5D_create_t));
break;
case H5P_DATASET_XFER:
if (NULL==(plist = H5MM_malloc(sizeof(H5F_xfer_t)))) {
HRETURN_ERROR (H5E_RESOURCE, H5E_NOSPACE, FAIL,
"memory allocation failed");
}
HDmemcpy(plist, &H5F_xfer_dflt, sizeof(H5F_xfer_t));
break;
case H5P_MOUNT:
if (NULL==(plist = H5MM_malloc(sizeof(H5F_mprop_t)))) {
HRETURN_ERROR(H5E_RESOURCE, H5E_NOSPACE, FAIL,
"memory allocation failed");
}
HDmemcpy(plist, &H5F_mount_dflt, sizeof(H5F_mprop_t));
break;
default:
HRETURN_ERROR(H5E_ARGS, H5E_BADVALUE, FAIL,
"unknown property list class");
}
/* Atomize the new property list */
if ((ret_value = H5P_create(type, plist)) < 0) {
HRETURN_ERROR(H5E_ATOM, H5E_CANTINIT, FAIL,
"unable to register property list");
}
FUNC_LEAVE(ret_value);
}
/*-------------------------------------------------------------------------
* Function: H5P_create
*
* Purpose: Given a pointer to some property list struct, atomize the
* property list and return its ID. The property list memory is
* not copied, so the caller should not free it; it will be
* freed by H5P_release().
*
* Return: Success: A new property list ID.
*
* Failure: Negative
*
* Programmer: Robb Matzke
* Wednesday, December 3, 1997
*
* Modifications:
*
*-------------------------------------------------------------------------
*/
hid_t
H5P_create(H5P_class_t type, void *plist)
{
hid_t ret_value = FAIL;
FUNC_ENTER(H5P_create, FAIL);
/* check args */
assert(type >= 0 && type < H5P_NCLASSES);
assert(plist);
/* Atomize the new property list */
if ((ret_value=H5I_register((H5I_type_t)(H5I_TEMPLATE_0+type), plist))<0) {
HRETURN_ERROR(H5E_ATOM, H5E_CANTINIT, FAIL,
"unable to register property list");
}
FUNC_LEAVE(ret_value);
}
/*--------------------------------------------------------------------------
NAME
H5Pclose
PURPOSE
Release access to a property list object.
USAGE
herr_t H5Pclose(oid)
hid_t oid; IN: property list object to release access to
RETURNS
Non-negative on success/Negative on failure
DESCRIPTION
This function releases access to a property list object
--------------------------------------------------------------------------*/
herr_t
H5Pclose(hid_t plist_id)
{
H5P_class_t type;
void *plist = NULL;
FUNC_ENTER(H5Pclose, FAIL);
H5TRACE1("e","i",plist_id);
/* Check arguments */
if (plist_id==H5P_DEFAULT)
HRETURN_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL,
"unable to close predefined object");
if ((type=H5P_get_class (plist_id))<0 || NULL==(plist=H5I_object (plist_id))) {
HRETURN_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL, "not a property list");
}
/*
* Chuck the object! When the reference count reaches zero then
* H5I_dec_ref() removes it from the group and we should free it. The
* free function is not registered as part of the group because it takes
* an extra argument.
*/
if (0==H5I_dec_ref(plist_id)) H5P_close (type, plist);
FUNC_LEAVE (SUCCEED);
}
/*-------------------------------------------------------------------------
* Function: H5P_close
*
* Purpose: Closes a property list and frees the memory associated with
* the property list.
*
* Return: Non-negative on success/Negative on failure
*
* Programmer: Robb Matzke
* Wednesday, February 18, 1998
*
* Modifications:
*
*-------------------------------------------------------------------------
*/
herr_t
H5P_close(H5P_class_t type, void *plist)
{
H5F_access_t *fa_list = (H5F_access_t*)plist;
H5D_create_t *dc_list = (H5D_create_t*)plist;
FUNC_ENTER (H5P_close, FAIL);
/* Check args */
if (!plist) HRETURN (SUCCEED);
/* Some property lists may need to do special things */
switch (type) {
case H5P_FILE_ACCESS:
switch (fa_list->driver) {
case H5F_LOW_ERROR:
case H5F_LOW_SEC2:
case H5F_LOW_STDIO:
case H5F_LOW_CORE:
/* Nothing to do */
break;
case H5F_LOW_MPIO:
#ifdef LATER
/* Need to free the COMM and INFO objects too. */
#endif
break;
case H5F_LOW_SPLIT:
/* Free member info */
fa_list->driver = H5F_LOW_ERROR; /*prevent cycles*/
H5P_close (H5P_FILE_ACCESS, fa_list->u.split.meta_access);
H5P_close (H5P_FILE_ACCESS, fa_list->u.split.raw_access);
H5MM_xfree (fa_list->u.split.meta_ext);
H5MM_xfree (fa_list->u.split.raw_ext);
break;
case H5F_LOW_FAMILY:
/* Free member info */
H5P_close (H5P_FILE_ACCESS, fa_list->u.fam.memb_access);
break;
}
break;
case H5P_FILE_CREATE:
/*nothing to do*/
break;
case H5P_DATASET_CREATE:
H5O_reset(H5O_FILL, &(dc_list->fill));
H5O_reset(H5O_EFL, &(dc_list->efl));
H5O_reset(H5O_PLINE, &(dc_list->pline));
break;
case H5P_DATASET_XFER:
/*nothing to do*/
break;
case H5P_MOUNT:
/*nothing to do*/
break;
default:
HRETURN_ERROR (H5E_ARGS, H5E_BADTYPE, FAIL,
"unknown property list class");
}
/* Free the property list struct and return */
H5MM_xfree(plist);
FUNC_LEAVE(SUCCEED);
}
/*-------------------------------------------------------------------------
* Function: H5Pget_class
*
* Purpose: Returns the class identifier for a property list.
*
* Return: Success: A property list class
*
* Failure: H5P_NO_CLASS (-1)
*
* Programmer: Robb Matzke
* Wednesday, December 3, 1997
*
* Modifications:
*
*-------------------------------------------------------------------------
*/
H5P_class_t
H5Pget_class(hid_t plist_id)
{
H5I_type_t group;
H5P_class_t ret_value = H5P_NO_CLASS;
FUNC_ENTER(H5Pget_class, H5P_NO_CLASS);
H5TRACE1("p","i",plist_id);
if ((group = H5I_get_type(plist_id)) < 0 ||
#ifndef NDEBUG
group >= H5I_TEMPLATE_MAX ||
#endif
group < H5I_TEMPLATE_0) {
HRETURN_ERROR(H5E_ATOM, H5E_BADATOM, H5P_NO_CLASS,
"not a property list");
}
ret_value = (H5P_class_t)(group - H5I_TEMPLATE_0);
FUNC_LEAVE(ret_value);
}
/*-------------------------------------------------------------------------
* Function: H5P_get_class
*
* Purpose: Internal function for getting the property list class.
*
* Return: Success: A property list class
*
* Failure: H5P_NO_CLASS (-1)
*
* Programmer: Robb Matzke
* Tuesday, July 7, 1998
*
* Modifications:
*
*-------------------------------------------------------------------------
*/
H5P_class_t
H5P_get_class(hid_t plist_id)
{
H5I_type_t group;
H5P_class_t ret_value = H5P_NO_CLASS;
FUNC_ENTER(H5P_get_class, H5P_NO_CLASS);
if ((group = H5I_get_type(plist_id)) < 0 ||
#ifndef NDEBUG
group >= H5I_TEMPLATE_MAX ||
#endif
group < H5I_TEMPLATE_0) {
HRETURN_ERROR(H5E_ATOM, H5E_BADATOM, H5P_NO_CLASS,
"not a property list");
}
ret_value = (H5P_class_t)(group - H5I_TEMPLATE_0);
FUNC_LEAVE(ret_value);
}
/*-------------------------------------------------------------------------
* Function: H5Pget_version
*
* Purpose: Retrieves version information for various parts of a file.
*
* BOOT: The file boot block.
* HEAP: The global heap.
* FREELIST: The global free list.
* STAB: The root symbol table entry.
* SHHDR: Shared object headers.
*
* Any (or even all) of the output arguments can be null
* pointers.
*
* Return: Success: Non-negative, version information is returned
* through the arguments.
*
* Failure: Negative
*
* Programmer: Robb Matzke
* Wednesday, January 7, 1998
*
* Modifications:
*
*-------------------------------------------------------------------------
*/
herr_t
H5Pget_version(hid_t plist_id, int *boot/*out*/, int *freelist/*out*/,
int *stab/*out*/, int *shhdr/*out*/)
{
H5F_create_t *plist = NULL;
FUNC_ENTER(H5Pget_version, FAIL);
H5TRACE5("e","ixxxx",plist_id,boot,freelist,stab,shhdr);
/* Check arguments */
if (H5P_FILE_CREATE != H5P_get_class(plist_id) ||
NULL == (plist = H5I_object(plist_id))) {
HRETURN_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL,
"not a file creation property list");
}
/* Get values */
if (boot) *boot = plist->bootblock_ver;
if (freelist) *freelist = plist->freespace_ver;
if (stab) *stab = plist->objectdir_ver;
if (shhdr) *shhdr = plist->sharedheader_ver;
FUNC_LEAVE(SUCCEED);
}
/*-------------------------------------------------------------------------
* Function: H5Pset_userblock
*
* Purpose: Sets the userblock size field of a file creation property
* list.
*
* Return: Non-negative on success/Negative on failure
*
* Programmer: Robb Matzke
* Tuesday, January 6, 1998
*
* Modifications:
*
*-------------------------------------------------------------------------
*/
herr_t
H5Pset_userblock(hid_t plist_id, hsize_t size)
{
uintn i;
H5F_create_t *plist = NULL;
FUNC_ENTER(H5Pset_userblock, FAIL);
H5TRACE2("e","ih",plist_id,size);
/* Check arguments */
if (H5P_FILE_CREATE != H5P_get_class(plist_id) ||
NULL == (plist = H5I_object(plist_id))) {
HRETURN_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL,
"not a file creation property list");
}
for (i=8; i<8*sizeof(hsize_t); i++) {
hsize_t p2 = 8==i ? 0 : ((hsize_t)1<<i);
if (size == p2) break;
}
if (i>=8*sizeof(hsize_t)) {
HRETURN_ERROR(H5E_ARGS, H5E_BADVALUE, FAIL,
"userblock size is not valid");
}
/* Set value */
plist->userblock_size = size;
FUNC_LEAVE(SUCCEED);
}
/*-------------------------------------------------------------------------
* Function: H5Pget_userblock
*
* Purpose: Queries the size of a user block in a file creation property
* list.
*
* Return: Success: Non-negative, size returned through SIZE argument.
*
* Failure: Negative
*
* Programmer: Robb Matzke
* Wednesday, January 7, 1998
*
* Modifications:
*
*-------------------------------------------------------------------------
*/
herr_t
H5Pget_userblock(hid_t plist_id, hsize_t *size)
{
H5F_create_t *plist = NULL;
FUNC_ENTER(H5Pget_userblock, FAIL);
H5TRACE2("e","i*h",plist_id,size);
/* Check args */
if (H5P_FILE_CREATE != H5P_get_class(plist_id) ||
NULL == (plist = H5I_object(plist_id))) {
HRETURN_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL,
"not a file creation property list");
}
/* Get value */
if (size) *size = plist->userblock_size;
FUNC_LEAVE(SUCCEED);
}
/*-------------------------------------------------------------------------
* Function: H5Pset_alignment
*
* Purpose: Sets the alignment properties of a file access property list
* so that any file object >= THRESHOLD bytes will be aligned on
* an address which is a multiple of ALIGNMENT. The addresses
* are relative to the end of the user block; the alignment is
* calculated by subtracting the user block size from the
* absolute file address and then adjusting the address to be a
* multiple of ALIGNMENT.
*
* Default values for THRESHOLD and ALIGNMENT are one, implying
* no alignment. Generally the default values will result in
* the best performance for single-process access to the file.
* For MPI-IO and other parallel systems, choose an alignment
* which is a multiple of the disk block size.
*
* Return: Non-negative on success/Negative on failure
*
* Programmer: Robb Matzke
* Tuesday, June 9, 1998
*
* Modifications:
*
*-------------------------------------------------------------------------
*/
herr_t
H5Pset_alignment(hid_t fapl_id, hsize_t threshold, hsize_t alignment)
{
H5F_access_t *fapl = NULL;
FUNC_ENTER (H5Pset_alignment, FAIL);
H5TRACE3("e","ihh",fapl_id,threshold,alignment);
/* Check args */
if (H5P_FILE_ACCESS != H5P_get_class (fapl_id) ||
NULL == (fapl = H5I_object (fapl_id))) {
HRETURN_ERROR (H5E_ARGS, H5E_BADTYPE, FAIL,
"not a file access property list");
}
if (alignment<1) {
HRETURN_ERROR (H5E_ARGS, H5E_BADVALUE, FAIL,
"alignment must be positive");
}
/* Set values */
fapl->threshold = threshold;
fapl->alignment = alignment;
FUNC_LEAVE (SUCCEED);
}
/*-------------------------------------------------------------------------
* Function: H5Pget_alignment
*
* Purpose: Returns the current settings for alignment properties from a
* file access property list. The THRESHOLD and/or ALIGNMENT
* pointers may be null pointers.
*
* Return: Non-negative on success/Negative on failure
*
* Programmer: Robb Matzke
* Tuesday, June 9, 1998
*
* Modifications:
*
*-------------------------------------------------------------------------
*/
herr_t
H5Pget_alignment(hid_t fapl_id, hsize_t *threshold/*out*/,
hsize_t *alignment/*out*/)
{
H5F_access_t *fapl = NULL;
FUNC_ENTER (H5Pget_alignment, FAIL);
H5TRACE3("e","ixx",fapl_id,threshold,alignment);
/* Check args */
if (H5P_FILE_ACCESS != H5P_get_class (fapl_id) ||
NULL == (fapl = H5I_object (fapl_id))) {
HRETURN_ERROR (H5E_ARGS, H5E_BADTYPE, FAIL,
"not a file access property list");
}
/* Get values */
if (threshold) *threshold = fapl->threshold;
if (alignment) *alignment = fapl->alignment;
FUNC_LEAVE (SUCCEED);
}
/*-------------------------------------------------------------------------
* Function: H5Pset_sizes
*
* Purpose: Sets file size-of addresses and sizes. PLIST_ID should be a
* file creation property list. A value of zero causes the
* property to not change.
*
* Return: Non-negative on success/Negative on failure
*
* Programmer: Robb Matzke
* Tuesday, January 6, 1998
*
* Modifications:
*
*-------------------------------------------------------------------------
*/
herr_t
H5Pset_sizes(hid_t plist_id, size_t sizeof_addr, size_t sizeof_size)
{
H5F_create_t *plist = NULL;
FUNC_ENTER(H5Pset_sizeof_addr, FAIL);
H5TRACE3("e","izz",plist_id,sizeof_addr,sizeof_size);
/* Check arguments */
if (H5P_FILE_CREATE != H5P_get_class(plist_id) ||
NULL == (plist = H5I_object(plist_id))) {
HRETURN_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL,
"not a file creation property list");
}
if (sizeof_addr) {
if (sizeof_addr != 2 && sizeof_addr != 4 &&
sizeof_addr != 8 && sizeof_addr != 16) {
HRETURN_ERROR(H5E_ARGS, H5E_BADVALUE, FAIL,
"file haddr_t size is not valid");
}
}
if (sizeof_size) {
if (sizeof_size != 2 && sizeof_size != 4 &&
sizeof_size != 8 && sizeof_size != 16) {
HRETURN_ERROR(H5E_ARGS, H5E_BADVALUE, FAIL,
"file size_t size is not valid");
}
}
/* Set value */
if (sizeof_addr)
plist->sizeof_addr = sizeof_addr;
if (sizeof_size)
plist->sizeof_size = sizeof_size;
FUNC_LEAVE(SUCCEED);
}
/*-------------------------------------------------------------------------
* Function: H5Pget_sizes
*
* Purpose: Returns the size of address and size quantities stored in a
* file according to a file creation property list. Either (or
* even both) SIZEOF_ADDR and SIZEOF_SIZE may be null pointers.
*
* Return: Success: Non-negative, sizes returned through arguments.
*
* Failure: Negative
*
* Programmer: Robb Matzke
* Wednesday, January 7, 1998
*
* Modifications:
*
*-------------------------------------------------------------------------
*/
herr_t
H5Pget_sizes(hid_t plist_id,
size_t *sizeof_addr /*out */ , size_t *sizeof_size /*out */ )
{
H5F_create_t *plist = NULL;
FUNC_ENTER(H5Pget_sizes, FAIL);
H5TRACE3("e","ixx",plist_id,sizeof_addr,sizeof_size);
/* Check args */
if (H5P_FILE_CREATE != H5P_get_class(plist_id) ||
NULL == (plist = H5I_object(plist_id))) {
HRETURN_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL,
"not a file creation property list");
}
/* Get values */
if (sizeof_addr)
*sizeof_addr = plist->sizeof_addr;
if (sizeof_size)
*sizeof_size = plist->sizeof_size;
FUNC_LEAVE(SUCCEED);
}
/*-------------------------------------------------------------------------
* Function: H5Pset_sym_k
*
* Purpose: IK is one half the rank of a tree that stores a symbol
* table for a group. Internal nodes of the symbol table are on
* average 75% full. That is, the average rank of the tree is
* 1.5 times the value of IK.
*
* LK is one half of the number of symbols that can be stored in
* a symbol table node. A symbol table node is the leaf of a
* symbol table tree which is used to store a group. When
* symbols are inserted randomly into a group, the group's
* symbol table nodes are 75% full on average. That is, they
* contain 1.5 times the number of symbols specified by LK.
*
* Either (or even both) of IK and LK can be zero in which case
* that value is left unchanged.
*
* Return: Non-negative on success/Negative on failure
*
* Programmer: Robb Matzke
* Tuesday, January 6, 1998
*
* Modifications:
*
*-------------------------------------------------------------------------
*/
herr_t
H5Pset_sym_k(hid_t plist_id, int ik, int lk)
{
H5F_create_t *plist = NULL;
FUNC_ENTER(H5Pset_sym_k, FAIL);
H5TRACE3("e","iIsIs",plist_id,ik,lk);
/* Check arguments */
if (H5P_FILE_CREATE != H5P_get_class(plist_id) ||
NULL == (plist = H5I_object(plist_id))) {
HRETURN_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL,
"not a file creation property list");
}
/* Set values */
if (ik > 0) {
plist->btree_k[H5B_SNODE_ID] = ik;
}
if (lk > 0) {
plist->sym_leaf_k = lk;
}
FUNC_LEAVE(SUCCEED);
}
/*-------------------------------------------------------------------------
* Function: H5Pget_sym_k
*
* Purpose: Retrieves the symbol table B-tree 1/2 rank (IK) and the
* symbol table leaf node 1/2 size (LK). See H5Pset_sym_k() for
* details. Either (or even both) IK and LK may be null
* pointers.
*
* Return: Non-negative on success/Negative on failure
*
* Programmer: Robb Matzke
* Wednesday, January 7, 1998
*
* Modifications:
*
*-------------------------------------------------------------------------
*/
herr_t
H5Pget_sym_k(hid_t plist_id, int *ik /*out */ , int *lk /*out */ )
{
H5F_create_t *plist = NULL;
FUNC_ENTER(H5Pget_sym_k, FAIL);
H5TRACE3("e","ixx",plist_id,ik,lk);
/* Check arguments */
if (H5P_FILE_CREATE != H5P_get_class(plist_id) ||
NULL == (plist = H5I_object(plist_id))) {
HRETURN_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL,
"not a file creation property list");
}
/* Get values */
if (ik)
*ik = plist->btree_k[H5B_SNODE_ID];
if (lk)
*lk = plist->sym_leaf_k;
FUNC_LEAVE(SUCCEED);
}
/*-------------------------------------------------------------------------
* Function: H5Pset_istore_k
*
* Purpose: IK is one half the rank of a tree that stores chunked raw
* data. On average, such a tree will be 75% full, or have an
* average rank of 1.5 times the value of IK.
*
* Return: Non-negative on success/Negative on failure
*
* Programmer: Robb Matzke
* Tuesday, January 6, 1998
*
* Modifications:
*
*-------------------------------------------------------------------------
*/
herr_t
H5Pset_istore_k(hid_t plist_id, int ik)
{
H5F_create_t *plist = NULL;
FUNC_ENTER(H5Pset_istore_k, FAIL);
H5TRACE2("e","iIs",plist_id,ik);
/* Check arguments */
if (H5P_FILE_CREATE != H5P_get_class(plist_id) ||
NULL == (plist = H5I_object(plist_id))) {
HRETURN_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL,
"not a file creation property list");
}
if (ik <= 0) {
HRETURN_ERROR(H5E_ARGS, H5E_BADVALUE, FAIL,
"istore IK value must be positive");
}
/* Set value */
plist->btree_k[H5B_ISTORE_ID] = ik;
FUNC_LEAVE(SUCCEED);
}
/*-------------------------------------------------------------------------
* Function: H5Pget_istore_k
*
* Purpose: Queries the 1/2 rank of an indexed storage B-tree. See
* H5Pset_istore_k() for details. The argument IK may be the
* null pointer.
*
* Return: Success: Non-negative, size returned through IK
*
* Failure: Negative
*
* Programmer: Robb Matzke
* Wednesday, January 7, 1998
*
* Modifications:
*
*-------------------------------------------------------------------------
*/
herr_t
H5Pget_istore_k(hid_t plist_id, int *ik /*out */ )
{
H5F_create_t *plist = NULL;
FUNC_ENTER(H5Pget_istore_k, FAIL);
H5TRACE2("e","ix",plist_id,ik);
/* Check arguments */
if (H5P_FILE_CREATE != H5P_get_class(plist_id) ||
NULL == (plist = H5I_object(plist_id))) {
HRETURN_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL,
"not a file creation property list");
}
/* Get value */
if (ik)
*ik = plist->btree_k[H5B_ISTORE_ID];
FUNC_LEAVE(SUCCEED);
}
/*-------------------------------------------------------------------------
* Function: H5Pset_layout
*
* Purpose: Sets the layout of raw data in the file.
*
* Return: Non-negative on success/Negative on failure
*
* Programmer: Robb Matzke
* Tuesday, January 6, 1998
*
* Modifications:
*
*-------------------------------------------------------------------------
*/
herr_t
H5Pset_layout(hid_t plist_id, H5D_layout_t layout)
{
H5D_create_t *plist = NULL;
FUNC_ENTER(H5Pset_layout, FAIL);
H5TRACE2("e","iDl",plist_id,layout);
/* Check arguments */
if (H5P_DATASET_CREATE != H5P_get_class(plist_id) ||
NULL == (plist = H5I_object(plist_id))) {
HRETURN_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL,
"not a dataset creation property list");
}
if (layout < 0 || layout >= H5D_NLAYOUTS) {
HRETURN_ERROR(H5E_ARGS, H5E_BADRANGE, FAIL,
"raw data layout method is not valid");
}
/* Set value */
plist->layout = layout;
FUNC_LEAVE(SUCCEED);
}
/*-------------------------------------------------------------------------
* Function: H5Pget_layout
*
* Purpose: Retrieves layout type of a dataset creation property list.
*
* Return: Success: The layout type
*
* Failure: H5D_LAYOUT_ERROR (negative)
*
* Programmer: Robb Matzke
* Wednesday, January 7, 1998
*
* Modifications:
*
*-------------------------------------------------------------------------
*/
H5D_layout_t
H5Pget_layout(hid_t plist_id)
{
H5D_create_t *plist = NULL;
FUNC_ENTER(H5Pget_layout, H5D_LAYOUT_ERROR);
H5TRACE1("Dl","i",plist_id);
/* Check arguments */
if (H5P_DATASET_CREATE != H5P_get_class(plist_id) ||
NULL == (plist = H5I_object(plist_id))) {
HRETURN_ERROR(H5E_ARGS, H5E_BADTYPE, H5D_LAYOUT_ERROR,
"not a dataset creation property list");
}
FUNC_LEAVE(plist->layout);
}
/*-------------------------------------------------------------------------
* Function: H5Pset_chunk
*
* Purpose: Sets the number of dimensions and the size of each chunk to
* the values specified. The dimensionality of the chunk should
* match the dimensionality of the data space.
*
* As a side effect, the layout method is changed to
* H5D_CHUNKED.
*
* Return: Non-negative on success/Negative on failure
*
* Programmer: Robb Matzke
* Tuesday, January 6, 1998
*
* Modifications:
*
*-------------------------------------------------------------------------
*/
herr_t
H5Pset_chunk(hid_t plist_id, int ndims, const hsize_t dim[/*ndims*/])
{
int i;
H5D_create_t *plist = NULL;
FUNC_ENTER(H5Pset_chunk, FAIL);
H5TRACE3("e","iIs*[a1]h",plist_id,ndims,dim);
/* Check arguments */
if (H5P_DATASET_CREATE != H5P_get_class(plist_id) ||
NULL == (plist = H5I_object(plist_id))) {
HRETURN_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL,
"not a dataset creation property list");
}
if (ndims <= 0) {
HRETURN_ERROR(H5E_ARGS, H5E_BADRANGE, FAIL,
"chunk dimensionality must be positive");
}
if (ndims > H5S_MAX_RANK) {
HRETURN_ERROR(H5E_ARGS, H5E_BADRANGE, FAIL,
"chunk dimensionality is too large");
}
if (!dim) {
HRETURN_ERROR(H5E_ARGS, H5E_BADVALUE, FAIL,
"no chunk dimensions specified");
}
for (i=0; i<ndims; i++) {
if (dim[i] <= 0) {
HRETURN_ERROR(H5E_ARGS, H5E_BADRANGE, FAIL,
"all chunk dimensions must be positive");
}
}
/* Set value */
plist->layout = H5D_CHUNKED;
plist->chunk_ndims = ndims;
for (i = 0; i < ndims; i++) {
plist->chunk_size[i] = dim[i];
}
FUNC_LEAVE(SUCCEED);
}
/*-------------------------------------------------------------------------
* Function: H5Pget_chunk
*
* Purpose: Retrieves the chunk size of chunked layout. The chunk
* dimensionality is returned and the chunk size in each
* dimension is returned through the DIM argument. At most
* MAX_NDIMS elements of DIM will be initialized.
*
* Return: Success: Positive Chunk dimensionality.
*
* Failure: Negative
*
* Programmer: Robb Matzke
* Wednesday, January 7, 1998
*
* Modifications:
*
*-------------------------------------------------------------------------
*/
int
H5Pget_chunk(hid_t plist_id, int max_ndims, hsize_t dim[]/*out*/)
{
int i;
H5D_create_t *plist = NULL;
FUNC_ENTER(H5Pget_chunk, FAIL);
H5TRACE3("Is","iIsx",plist_id,max_ndims,dim);
/* Check arguments */
if (H5P_DATASET_CREATE != H5P_get_class(plist_id) ||
NULL == (plist = H5I_object(plist_id))) {
HRETURN_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL,
"not a dataset creation property list");
}
if (H5D_CHUNKED != plist->layout) {
HRETURN_ERROR(H5E_ARGS, H5E_BADVALUE, FAIL,
"not a chunked storage layout");
}
for (i=0; i<plist->chunk_ndims && i<max_ndims && dim; i++) {
dim[i] = plist->chunk_size[i];
}
FUNC_LEAVE(plist->chunk_ndims);
}
/*-------------------------------------------------------------------------
* Function: H5Pset_external
*
* Purpose: Adds an external file to the list of external files. PLIST_ID
* should be an object ID for a dataset creation property list.
* NAME is the name of an external file, OFFSET is the location
* where the data starts in that file, and SIZE is the number of
* bytes reserved in the file for the data.
*
* If a dataset is split across multiple files then the files
* should be defined in order. The total size of the dataset is
* the sum of the SIZE arguments for all the external files. If
* the total size is larger than the size of a dataset then the
* dataset can be extended (provided the data space also allows
* the extending).
*
* Return: Non-negative on success/Negative on failure
*
* Programmer: Robb Matzke
* Tuesday, March 3, 1998
*
* Modifications:
*
*-------------------------------------------------------------------------
*/
herr_t
H5Pset_external(hid_t plist_id, const char *name, off_t offset, hsize_t size)
{
int idx;
size_t total, tmp;
H5D_create_t *plist = NULL;
FUNC_ENTER(H5Pset_external, FAIL);
H5TRACE4("e","isoh",plist_id,name,offset,size);
/* Check arguments */
if (H5P_DATASET_CREATE != H5P_get_class(plist_id) ||
NULL == (plist = H5I_object(plist_id))) {
HRETURN_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL,
"not a dataset creation property list");
}
if (!name || !*name) {
HRETURN_ERROR (H5E_ARGS, H5E_BADVALUE, FAIL,
"no name given");
}
if (offset<0) {
HRETURN_ERROR (H5E_ARGS, H5E_BADVALUE, FAIL,
"negative external file offset");
}
if (size<=0) {
HRETURN_ERROR (H5E_ARGS, H5E_BADVALUE, FAIL,
"zero size");
}
if (plist->efl.nused>0 &&
H5O_EFL_UNLIMITED==plist->efl.slot[plist->efl.nused-1].size) {
HRETURN_ERROR (H5E_ARGS, H5E_BADVALUE, FAIL,
"previous file size is unlimited");
}
if (H5O_EFL_UNLIMITED!=size) {
for (idx=0, total=size; idx<plist->efl.nused; idx++, total=tmp) {
tmp = total + plist->efl.slot[idx].size;
if (tmp <= total) {
HRETURN_ERROR (H5E_EFL, H5E_OVERFLOW, FAIL,
"total external data size overflowed");
}
}
}
/* Add to the list */
if (plist->efl.nused>=plist->efl.nalloc) {
intn na = plist->efl.nalloc + H5O_EFL_ALLOC;
H5O_efl_entry_t *x = H5MM_realloc (plist->efl.slot,
na*sizeof(H5O_efl_entry_t));
if (!x) {
HRETURN_ERROR (H5E_RESOURCE, H5E_NOSPACE, FAIL,
"memory allocation failed");
}
plist->efl.nalloc = na;
plist->efl.slot = x;
}
idx = plist->efl.nused;
plist->efl.slot[idx].name_offset = 0; /*not entered into heap yet*/
plist->efl.slot[idx].name = H5MM_xstrdup (name);
plist->efl.slot[idx].offset = offset;
plist->efl.slot[idx].size = size;
plist->efl.nused++;
FUNC_LEAVE(SUCCEED);
}
/*-------------------------------------------------------------------------
* Function: H5Pget_external_count
*
* Purpose: Returns the number of external files for this dataset.
*
* Return: Success: Number of external files
*
* Failure: Negative
*
* Programmer: Robb Matzke
* Tuesday, March 3, 1998
*
* Modifications:
*
*-------------------------------------------------------------------------
*/
int
H5Pget_external_count(hid_t plist_id)
{
H5D_create_t *plist = NULL;
FUNC_ENTER (H5Pget_external_count, FAIL);
H5TRACE1("Is","i",plist_id);
/* Check arguments */
if (H5P_DATASET_CREATE != H5P_get_class(plist_id) ||
NULL == (plist = H5I_object(plist_id))) {
HRETURN_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL,
"not a dataset creation property list");
}
/* Return */
FUNC_LEAVE (plist->efl.nused);
}
/*-------------------------------------------------------------------------
* Function: H5Pget_external
*
* Purpose: Returns information about an external file. External files
* are numbered from zero to N-1 where N is the value returned
* by H5Pget_external_count(). At most NAME_SIZE characters are
* copied into the NAME array. If the external file name is
* longer than NAME_SIZE with the null terminator, then the
* return value is not null terminated (similar to strncpy()).
*
* If NAME_SIZE is zero or NAME is the null pointer then the
* external file name is not returned. If OFFSET or SIZE are
* null pointers then the corresponding information is not
* returned.
*
* See Also: H5Pset_external()
*
* Return: Non-negative on success/Negative on failure
*
* Programmer: Robb Matzke
* Tuesday, March 3, 1998
*
* Modifications:
*
*-------------------------------------------------------------------------
*/
herr_t
H5Pget_external(hid_t plist_id, int idx, size_t name_size, char *name/*out*/,
off_t *offset/*out*/, hsize_t *size/*out*/)
{
H5D_create_t *plist = NULL;
FUNC_ENTER (H5Pget_external, FAIL);
H5TRACE6("e","iIszxxx",plist_id,idx,name_size,name,offset,size);
/* Check arguments */
if (H5P_DATASET_CREATE != H5P_get_class(plist_id) ||
NULL == (plist = H5I_object(plist_id))) {
HRETURN_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL,
"not a dataset creation property list");
}
if (idx<0 || idx>=plist->efl.nused) {
HRETURN_ERROR (H5E_ARGS, H5E_BADRANGE, FAIL,
"external file index is out of range");
}
/* Return values */
if (name_size>0 && name) {
HDstrncpy (name, plist->efl.slot[idx].name, name_size);
}
if (offset) *offset = plist->efl.slot[idx].offset;
if (size) *size = plist->efl.slot[idx].size;
FUNC_LEAVE (SUCCEED);
}
/*-------------------------------------------------------------------------
* Function: H5Pget_driver
*
* Purpose: Return the ID of the low-level file driver. PLIST_ID should
* be a file access property list.
*
* Return: Success: A low-level driver ID
*
* Failure: H5F_LOW_ERROR (a negative value)
*
* Programmer: Robb Matzke
* Thursday, February 26, 1998
*
* Modifications:
*
*-------------------------------------------------------------------------
*/
H5F_driver_t
H5Pget_driver(hid_t plist_id)
{
H5F_access_t *plist = NULL;
FUNC_ENTER (H5Pget_driver, H5F_LOW_ERROR);
H5TRACE1("Fd","i",plist_id);
/* Check arguments */
if (H5P_FILE_ACCESS != H5P_get_class (plist_id) ||
NULL == (plist = H5I_object (plist_id))) {
HRETURN_ERROR (H5E_ARGS, H5E_BADTYPE, H5F_LOW_ERROR,
"not a file access property list");
}
FUNC_LEAVE (plist->driver);
}
/*-------------------------------------------------------------------------
* Function: H5Pset_stdio
*
* Purpose: Set the low level file driver to use the functions declared
* in the stdio.h file: fopen(), fseek() or fseek64(), fread(),
* fwrite(), and fclose().
*
* Return: Non-negative on success/Negative on failure
*
* Programmer: Robb Matzke
* Thursday, February 19, 1998
*
* Modifications:
*
*-------------------------------------------------------------------------
*/
herr_t
H5Pset_stdio(hid_t plist_id)
{
H5F_access_t *plist = NULL;
FUNC_ENTER (H5Pset_stdio, FAIL);
H5TRACE1("e","i",plist_id);
/* Check arguments */
if (H5P_FILE_ACCESS != H5P_get_class(plist_id) ||
NULL == (plist = H5I_object(plist_id))) {
HRETURN_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL,
"not a file access property list");
}
/* Set driver */
plist->driver = H5F_LOW_STDIO;
FUNC_LEAVE (SUCCEED);
}
/*-------------------------------------------------------------------------
* Function: H5Pget_stdio
*
* Purpose: If the file access property list is set to the stdio driver
* then this function returns zero; otherwise it returns a
* negative value. In the future, additional arguments may be
* added to this function to match those added to H5Pset_stdio().
*
* Return: Non-negative on success/Negative on failure
*
* Programmer: Robb Matzke
* Thursday, February 26, 1998
*
* Modifications:
*
*-------------------------------------------------------------------------
*/
herr_t
H5Pget_stdio(hid_t plist_id)
{
H5F_access_t *plist = NULL;
FUNC_ENTER (H5Pget_stdio, FAIL);
H5TRACE1("e","i",plist_id);
/* Check arguments */
if (H5P_FILE_ACCESS != H5P_get_class (plist_id) ||
NULL == (plist = H5I_object (plist_id))) {
HRETURN_ERROR (H5E_ARGS, H5E_BADTYPE, FAIL,
"not a file access property list");
}
if (H5F_LOW_STDIO != plist->driver) {
HRETURN_ERROR (H5E_ARGS, H5E_BADVALUE, FAIL,
"the stdio driver is not set");
}
FUNC_LEAVE (SUCCEED);
}
/*-------------------------------------------------------------------------
* Function: H5Pset_sec2
*
* Purpose: Set the low-level file driver to use the functions declared
* in the unistd.h file: open(), lseek() or lseek64(), read(),
* write(), and close().
*
* Return: Non-negative on success/Negative on failure
*
* Programmer: Robb Matzke
* Thursday, February 19, 1998
*
* Modifications:
*
*-------------------------------------------------------------------------
*/
herr_t
H5Pset_sec2(hid_t plist_id)
{
H5F_access_t *plist = NULL;
FUNC_ENTER (H5Pset_sec2, FAIL);
H5TRACE1("e","i",plist_id);
/* Check arguments */
if (H5P_FILE_ACCESS != H5P_get_class(plist_id) ||
NULL == (plist = H5I_object(plist_id))) {
HRETURN_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL,
"not a file access property list");
}
/* Set driver */
plist->driver = H5F_LOW_SEC2;
FUNC_LEAVE (SUCCEED);
}
/*-------------------------------------------------------------------------
* Function: H5Pget_sec2
*
* Purpose: If the file access property list is set to the sec2 driver
* then this function returns zero; otherwise it returns a
* negative value. In the future, additional arguments may be
* added to this function to match those added to H5Pset_sec2().
*
* Return: Non-negative on success/Negative on failure
*
* Programmer: Robb Matzke
* Thursday, February 26, 1998
*
* Modifications:
*
*-------------------------------------------------------------------------
*/
herr_t
H5Pget_sec2(hid_t plist_id)
{
H5F_access_t *plist = NULL;
FUNC_ENTER (H5Pget_sec2, FAIL);
H5TRACE1("e","i",plist_id);
/* Check arguments */
if (H5P_FILE_ACCESS != H5P_get_class (plist_id) ||
NULL == (plist = H5I_object (plist_id))) {
HRETURN_ERROR (H5E_ARGS, H5E_BADTYPE, FAIL,
"not a file access property list");
}
if (H5F_LOW_SEC2 != plist->driver) {
HRETURN_ERROR (H5E_ARGS, H5E_BADVALUE, FAIL,
"the sec2 driver is not set");
}
FUNC_LEAVE (SUCCEED);
}
/*-------------------------------------------------------------------------
* Function: H5Pset_core
*
* Purpose: Set the low-level file driver to use malloc() and free().
* This driver is restricted to temporary files which are not
* larger than the amount of virtual memory available. The
* INCREMENT argument determines the file block size and memory
* will be allocated in multiples of INCREMENT bytes. A liberal
* INCREMENT results in fewer calls to realloc() and probably
* less memory fragmentation.
*
* Return: Non-negative on success/Negative on failure
*
* Programmer: Robb Matzke
* Thursday, February 19, 1998
*
* Modifications:
*
*-------------------------------------------------------------------------
*/
herr_t
H5Pset_core(hid_t plist_id, size_t increment)
{
H5F_access_t *plist = NULL;
FUNC_ENTER (H5Pset_core, FAIL);
H5TRACE2("e","iz",plist_id,increment);
/* Check arguments */
if (H5P_FILE_ACCESS != H5P_get_class(plist_id) ||
NULL == (plist = H5I_object(plist_id))) {
HRETURN_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL,
"not a file access property list");
}
if (increment<1) {
HRETURN_ERROR (H5E_ARGS, H5E_BADVALUE, FAIL,
"increment must be positive");
}
/* Set driver */
plist->driver = H5F_LOW_CORE;
plist->u.core.increment = increment;
FUNC_LEAVE (SUCCEED);
}
/*-------------------------------------------------------------------------
* Function: H5Pget_core
*
* Purpose: If the file access property list is set to the core driver
* then this function returns zero; otherwise it returns a
* negative value. On success, the block size is returned
* through the INCREMENT argument if it isn't the null pointer.
* In the future, additional arguments may be added to this
* function to match those added to H5Pset_core().
*
* Return: Non-negative on success/Negative on failure
*
* Programmer: Robb Matzke
* Thursday, February 26, 1998
*
* Modifications:
*
*-------------------------------------------------------------------------
*/
herr_t
H5Pget_core(hid_t plist_id, size_t *increment/*out*/)
{
H5F_access_t *plist = NULL;
FUNC_ENTER (H5Pget_core, FAIL);
H5TRACE2("e","ix",plist_id,increment);
/* Check arguments */
if (H5P_FILE_ACCESS != H5P_get_class (plist_id) ||
NULL == (plist = H5I_object (plist_id))) {
HRETURN_ERROR (H5E_ARGS, H5E_BADTYPE, FAIL,
"not a file access property list");
}
if (H5F_LOW_CORE != plist->driver) {
HRETURN_ERROR (H5E_ARGS, H5E_BADVALUE, FAIL,
"the core driver is not set");
}
/* Return values */
if (increment) {
*increment = plist->u.core.increment;
}
FUNC_LEAVE (SUCCEED);
}
/*-------------------------------------------------------------------------
* Function: H5Pset_split
*
* Purpose: Set the low-level driver to split meta data from raw data,
* storing meta data in one file and raw data in another file.
*
* Return: Non-negative on success/Negative on failure
*
* Programmer: Robb Matzke
* Thursday, February 19, 1998
*
* Modifications:
*
*-------------------------------------------------------------------------
*/
herr_t
H5Pset_split(hid_t plist_id, const char *meta_ext, hid_t meta_plist_id,
const char *raw_ext, hid_t raw_plist_id)
{
H5F_access_t *plist = NULL;
H5F_access_t *meta_plist = &H5F_access_dflt;
H5F_access_t *raw_plist = &H5F_access_dflt;
FUNC_ENTER (H5Pset_split, FAIL);
H5TRACE5("e","isisi",plist_id,meta_ext,meta_plist_id,raw_ext,raw_plist_id);
/* Check arguments */
if (H5P_FILE_ACCESS != H5P_get_class(plist_id) ||
NULL == (plist = H5I_object(plist_id))) {
HRETURN_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL,
"not a file access property list");
}
if (H5P_DEFAULT!=meta_plist_id &&
(H5P_FILE_ACCESS != H5P_get_class(meta_plist_id) ||
NULL == (meta_plist = H5I_object(meta_plist_id)))) {
HRETURN_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL,
"not a file access property list");
}
if (H5P_DEFAULT!=raw_plist_id &&
(H5P_FILE_ACCESS != H5P_get_class(raw_plist_id) ||
NULL == (raw_plist = H5I_object(raw_plist_id)))) {
HRETURN_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL,
"not a file access property list");
}
/* Set driver */
plist->driver = H5F_LOW_SPLIT;
plist->u.split.meta_access = H5P_copy (H5P_FILE_ACCESS, meta_plist);
plist->u.split.raw_access = H5P_copy (H5P_FILE_ACCESS, raw_plist);
plist->u.split.meta_ext = H5MM_xstrdup (meta_ext);
plist->u.split.raw_ext = H5MM_xstrdup (raw_ext);
FUNC_LEAVE (SUCCEED);
}
/*-------------------------------------------------------------------------
* Function: H5Pget_split
*
* Purpose: If the file access property list is set to the sec2 driver
* then this function returns zero; otherwise it returns a
* negative value. On success, at most META_EXT_SIZE characters
* are copied to the META_EXT buffer if non-null and at most
* RAW_EXT_SIZE characters are copied to the RAW_EXT buffer if
* non-null. If the actual extension is larger than the number
* of characters requested then the buffer will not be null
* terminated (that is, behavior like strncpy()). In addition,
* if META_PROPERTIES and/or RAW_PROPERTIES are non-null then
* the file access property list of the meta file and/or raw
* file is copied and its OID returned through these arguments.
* In the future, additional arguments may be added to this
* function to match those added to H5Pset_sec2().
*
* Return: Non-negative on success/Negative on failure
*
* Programmer: Robb Matzke
* Thursday, February 26, 1998
*
* Modifications:
*
*-------------------------------------------------------------------------
*/
herr_t
H5Pget_split(hid_t plist_id, size_t meta_ext_size, char *meta_ext/*out*/,
hid_t *meta_properties/*out*/, size_t raw_ext_size,
char *raw_ext/*out*/, hid_t *raw_properties/*out*/)
{
H5F_access_t *plist = NULL;
FUNC_ENTER (H5Pget_split, FAIL);
H5TRACE7("e","izxxzxx",plist_id,meta_ext_size,meta_ext,meta_properties,
raw_ext_size,raw_ext,raw_properties);
/* Check arguments */
if (H5P_FILE_ACCESS != H5P_get_class (plist_id) ||
NULL == (plist = H5I_object (plist_id))) {
HRETURN_ERROR (H5E_ARGS, H5E_BADTYPE, FAIL,
"not a file access property list");
}
if (H5F_LOW_SPLIT != plist->driver) {
HRETURN_ERROR (H5E_ARGS, H5E_BADVALUE, FAIL,
"the split driver is not set");
}
/* Reset output args for error handling */
if (meta_ext && meta_ext_size>0) *meta_ext = '\0';
if (raw_ext && raw_ext_size>0) *raw_ext = '\0';
if (meta_properties) *meta_properties = FAIL;
if (raw_properties) *raw_properties = FAIL;
/* Output arguments */
if (meta_ext && meta_ext_size>0) {
if (plist->u.split.meta_ext) {
HDstrncpy (meta_ext, plist->u.split.meta_ext, meta_ext_size);
} else {
HDstrncpy (meta_ext, ".meta", meta_ext_size);
}
}
if (raw_ext && raw_ext_size>0) {
if (plist->u.split.raw_ext) {
HDstrncpy (raw_ext, plist->u.split.raw_ext, raw_ext_size);
} else {
HDstrncpy (raw_ext, ".raw", raw_ext_size);
}
}
if (meta_properties) {
assert (plist->u.split.meta_access);
*meta_properties = H5P_create (H5P_FILE_ACCESS,
H5P_copy (H5P_FILE_ACCESS,
plist->u.split.meta_access));
}
if (raw_properties) {
assert (plist->u.split.raw_access);
*raw_properties = H5P_create (H5P_FILE_ACCESS,
H5P_copy (H5P_FILE_ACCESS,
plist->u.split.raw_access));
}
FUNC_LEAVE (SUCCEED);
}
/*-------------------------------------------------------------------------
* Function: H5Pset_family
*
* Purpose: Sets the low-level driver to stripe the hdf5 address space
* across a family of files. The MEMB_SIZE argument indicates
* the size in bytes of each family member and is only
* meaningful when creating new files or opening families that
* have only one member.
*
* Return: Non-negative on success/Negative on failure
*
* Programmer: Robb Matzke
* Thursday, February 19, 1998
*
* Modifications:
*
*-------------------------------------------------------------------------
*/
herr_t
H5Pset_family(hid_t plist_id, hsize_t memb_size, hid_t memb_plist_id)
{
H5F_access_t *plist = NULL;
H5F_access_t *memb_plist = &H5F_access_dflt;
FUNC_ENTER (H5Pset_family, FAIL);
H5TRACE3("e","ihi",plist_id,memb_size,memb_plist_id);
/* Check arguments */
if (H5P_FILE_ACCESS != H5P_get_class(plist_id) ||
NULL == (plist = H5I_object(plist_id))) {
HRETURN_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL,
"not a file access property list");
}
if (memb_size && memb_size<1024) {
HRETURN_ERROR (H5E_ARGS, H5E_BADRANGE, FAIL,
"family member size is too small");
}
if (H5P_DEFAULT!=memb_plist_id &&
(H5P_FILE_ACCESS != H5P_get_class(memb_plist_id) ||
NULL == (plist = H5I_object(memb_plist_id)))) {
HRETURN_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL,
"not a file access property list");
}
/* Set driver */
plist->driver = H5F_LOW_FAMILY;
H5F_addr_reset (&(plist->u.fam.memb_size));
H5F_addr_inc (&(plist->u.fam.memb_size), memb_size);
plist->u.fam.memb_access = H5P_copy (H5P_FILE_ACCESS, memb_plist);
FUNC_LEAVE (SUCCEED);
}
/*-------------------------------------------------------------------------
* Function: H5Pget_family
*
* Purpose: If the file access property list is set to the family driver
* then this function returns zero; otherwise it returns a
* negative value. On success, if MEMB_PLIST_ID is a non-null
* pointer it will be initialized with the id of an open
* property list: the file access property list for the family
* members. In the future, additional arguments may be added to
* this function to match those added to H5Pset_family().
*
* Return: Non-negative on success/Negative on failure
*
* Programmer: Robb Matzke
* Thursday, February 26, 1998
*
* Modifications:
*
*-------------------------------------------------------------------------
*/
herr_t
H5Pget_family(hid_t plist_id, hsize_t *memb_size/*out*/,
hid_t *memb_plist_id/*out*/)
{
H5F_access_t *plist = NULL;
FUNC_ENTER (H5Pget_family, FAIL);
H5TRACE3("e","ixx",plist_id,memb_size,memb_plist_id);
/* Check arguments */
if (H5P_FILE_ACCESS != H5P_get_class (plist_id) ||
NULL == (plist = H5I_object (plist_id))) {
HRETURN_ERROR (H5E_ARGS, H5E_BADTYPE, FAIL,
"not a file access property list");
}
if (H5F_LOW_FAMILY != plist->driver) {
HRETURN_ERROR (H5E_ARGS, H5E_BADVALUE, FAIL,
"the family driver is not set");
}
/* Output args */
if (memb_size) {
*memb_size = plist->u.fam.memb_size;
}
if (memb_plist_id) {
assert (plist->u.fam.memb_access);
*memb_plist_id = H5P_create (H5P_FILE_ACCESS,
H5P_copy (H5P_FILE_ACCESS,
plist->u.fam.memb_access));
}
FUNC_LEAVE (SUCCEED);
}
/*-------------------------------------------------------------------------
* Function: H5Pset_cache
*
* Purpose: Set the number of objects in the meta data cache and the
* maximum number of chunks and bytes in the raw data chunk
* cache.
*
* The RDCC_W0 value should be between 0 and 1 inclusive and
* indicates how much chunks that have been fully read or fully
* written are favored for preemption. A value of zero means
* fully read or written chunks are treated no differently than
* other chunks (the preemption is strictly LRU) while a value
* of one means fully read chunks are always preempted before
* other chunks.
*
* Return: Non-negative on success/Negative on failure
*
* Programmer: Robb Matzke
* Tuesday, May 19, 1998
*
* Modifications:
*
*-------------------------------------------------------------------------
*/
herr_t
H5Pset_cache(hid_t plist_id, int mdc_nelmts,
int rdcc_nelmts, size_t rdcc_nbytes, double rdcc_w0)
{
H5F_access_t *fapl = NULL;
FUNC_ENTER (H5Pset_cache, FAIL);
H5TRACE5("e","iIsIszd",plist_id,mdc_nelmts,rdcc_nelmts,rdcc_nbytes,
rdcc_w0);
/* Check arguments */
if (H5P_FILE_ACCESS!=H5P_get_class (plist_id) ||
NULL==(fapl=H5I_object (plist_id))) {
HRETURN_ERROR (H5E_ARGS, H5E_BADTYPE, FAIL,
"not a file access property list");
}
if (mdc_nelmts<0) {
HRETURN_ERROR (H5E_ARGS, H5E_BADVALUE, FAIL,
"meta data cache size must be non-negative");
}
if (rdcc_nelmts<0) {
HRETURN_ERROR(H5E_ARGS, H5E_BADVALUE, FAIL,
"raw data chunk cache nelmts must be non-negative");
}
if (rdcc_w0<0.0 || rdcc_w0>1.0) {
HRETURN_ERROR (H5E_ARGS, H5E_BADVALUE, FAIL,
"raw data cache w0 value must be between 0.0 and 1.0 "
"inclusive");
}
/* Set sizes */
fapl->mdc_nelmts = mdc_nelmts;
fapl->rdcc_nelmts = rdcc_nelmts;
fapl->rdcc_nbytes = rdcc_nbytes;
fapl->rdcc_w0 = rdcc_w0;
FUNC_LEAVE (SUCCEED);
}
/*-------------------------------------------------------------------------
* Function: H5Pget_cache
*
* Purpose: Retrieves the maximum possible number of elements in the meta
* data cache and the maximum possible number of elements and
* bytes and the RDCC_W0 value in the raw data chunk cache. Any
* (or all) arguments may be null pointers in which case the
* corresponding datum is not returned.
*
* Return: Non-negative on success/Negative on failure
*
* Programmer: Robb Matzke
* Tuesday, May 19, 1998
*
* Modifications:
*
*-------------------------------------------------------------------------
*/
herr_t
H5Pget_cache(hid_t plist_id, int *mdc_nelmts,
int *rdcc_nelmts, size_t *rdcc_nbytes, double *rdcc_w0)
{
H5F_access_t *fapl = NULL;
FUNC_ENTER (H5Pget_cache, FAIL);
H5TRACE5("e","i*Is*Is*z*d",plist_id,mdc_nelmts,rdcc_nelmts,rdcc_nbytes,
rdcc_w0);
/* Check arguments */
if (H5P_FILE_ACCESS!=H5P_get_class (plist_id) ||
NULL==(fapl=H5I_object (plist_id))) {
HRETURN_ERROR (H5E_ARGS, H5E_BADTYPE, FAIL,
"not a file access property list");
}
/* Get sizes */
if (mdc_nelmts) *mdc_nelmts = fapl->mdc_nelmts;
if (rdcc_nelmts) *rdcc_nelmts = fapl->rdcc_nelmts;
if (rdcc_nbytes) *rdcc_nbytes = fapl->rdcc_nbytes;
if (rdcc_w0) *rdcc_w0 = fapl->rdcc_w0;
FUNC_LEAVE (SUCCEED);
}
/*-------------------------------------------------------------------------
* Function: H5Pset_buffer
*
* Purpose: Given a dataset transfer property list, set the maximum size
* for the type conversion buffer and background buffer and
* optionally supply pointers to application-allocated buffers.
* If the buffer size is smaller than the entire amount of data
* being transfered between application and file, and a type
* conversion buffer or background buffer is required then
* strip mining will be used.
*
* If TCONV and/or BKG are null pointers then buffers will be
* allocated and freed during the data transfer.
*
* Return: Non-negative on success/Negative on failure
*
* Programmer: Robb Matzke
* Monday, March 16, 1998
*
* Modifications:
*
*-------------------------------------------------------------------------
*/
herr_t
H5Pset_buffer(hid_t plist_id, size_t size, void *tconv, void *bkg)
{
H5F_xfer_t *plist = NULL;
FUNC_ENTER (H5Pset_buffer, FAIL);
H5TRACE4("e","izxx",plist_id,size,tconv,bkg);
/* Check arguments */
if (H5P_DATASET_XFER != H5P_get_class (plist_id) ||
NULL == (plist = H5I_object (plist_id))) {
HRETURN_ERROR (H5E_ARGS, H5E_BADTYPE, FAIL,
"not a dataset transfer property list");
}
if (size<=0) {
HRETURN_ERROR (H5E_ARGS, H5E_BADVALUE, FAIL,
"buffer size must not be zero");
}
/* Update property list */
plist->buf_size = size;
plist->tconv_buf = tconv;
plist->bkg_buf = bkg;
FUNC_LEAVE (SUCCEED);
}
/*-------------------------------------------------------------------------
* Function: H5Pget_buffer
*
* Purpose: Reads values previously set with H5Pset_buffer().
*
* Return: Success: Buffer size.
*
* Failure: 0
*
* Programmer: Robb Matzke
* Monday, March 16, 1998
*
* Modifications:
*
*-------------------------------------------------------------------------
*/
size_t
H5Pget_buffer(hid_t plist_id, void **tconv/*out*/, void **bkg/*out*/)
{
H5F_xfer_t *plist = NULL;
FUNC_ENTER (H5Pget_buffer, 0);
H5TRACE3("z","ixx",plist_id,tconv,bkg);
/* Check arguments */
if (H5P_DATASET_XFER != H5P_get_class (plist_id) ||
NULL == (plist = H5I_object (plist_id))) {
HRETURN_ERROR (H5E_ARGS, H5E_BADTYPE, 0,
"not a dataset transfer property list");
}
/* Return values */
if (tconv) *tconv = plist->tconv_buf;
if (bkg) *bkg = plist->bkg_buf;
FUNC_LEAVE (plist->buf_size);
}
/*-------------------------------------------------------------------------
* Function: H5Pset_hyper_cache
*
* Purpose: Given a dataset transfer property list, indicate whether to
* cache the hyperslab blocks during the I/O (which speeds
* things up) and the maximum size of the hyperslab block to
* cache. If a block is smaller than to limit, it may still not
* be cached if no memory is available. Setting the limit to 0
* indicates no limitation on the size of block to attempt to
* cache.
*
* The default is to cache blocks with no limit on block size
* for serial I/O and to not cache blocks for parallel I/O
*
* Return: Non-negative on success/Negative on failure
*
* Programmer: Quincey Koziol
* Monday, September 21, 1998
*
* Modifications:
*
*-------------------------------------------------------------------------
*/
herr_t
H5Pset_hyper_cache(hid_t plist_id, unsigned cache, unsigned limit)
{
H5F_xfer_t *plist = NULL;
FUNC_ENTER (H5Pset_hyper_cache, FAIL);
H5TRACE3("e","iIuIu",plist_id,cache,limit);
/* Check arguments */
if (H5P_DATASET_XFER != H5P_get_class (plist_id) ||
NULL == (plist = H5I_object (plist_id))) {
HRETURN_ERROR (H5E_ARGS, H5E_BADTYPE, FAIL,
"not a dataset transfer property list");
}
/* Update property list */
plist->cache_hyper = (cache>0) ? 1 : 0;
plist->block_limit = limit;
FUNC_LEAVE (SUCCEED);
} /* end H5P_set_hyper_cache() */
/*-------------------------------------------------------------------------
* Function: H5Pget_hyper_cache
*
* Purpose: Reads values previously set with H5Pset_hyper_cache().
*
* Return: Non-negative on success/Negative on failure
*
* Programmer: Quincey Koziol
* Monday, September 21, 1998
*
* Modifications:
*
*-------------------------------------------------------------------------
*/
herr_t
H5Pget_hyper_cache(hid_t plist_id, unsigned *cache/*out*/,
unsigned *limit/*out*/)
{
H5F_xfer_t *plist = NULL;
FUNC_ENTER (H5Pget_hyper_cache, 0);
H5TRACE3("e","ixx",plist_id,cache,limit);
/* Check arguments */
if (H5P_DATASET_XFER != H5P_get_class (plist_id) ||
NULL == (plist = H5I_object (plist_id))) {
HRETURN_ERROR (H5E_ARGS, H5E_BADTYPE, 0,
"not a dataset transfer property list");
}
/* Return values */
if (cache) *cache = plist->cache_hyper;
if (limit) *limit = plist->block_limit;
FUNC_LEAVE (SUCCEED);
} /* end H5Pget_hyper_cache() */
/*-------------------------------------------------------------------------
* Function: H5Pset_preserve
*
* Purpose: When reading or writing compound data types and the
* destination is partially initialized and the read/write is
* intended to initialize the other members, one must set this
* property to TRUE. Otherwise the I/O pipeline treats the
* destination datapoints as completely uninitialized.
*
* Return: Non-negative on success/Negative on failure
*
* Programmer: Robb Matzke
* Tuesday, March 17, 1998
*
* Modifications:
*
*-------------------------------------------------------------------------
*/
herr_t
H5Pset_preserve(hid_t plist_id, hbool_t status)
{
H5F_xfer_t *plist = NULL;
FUNC_ENTER (H5Pset_preserve, FAIL);
H5TRACE2("e","ib",plist_id,status);
/* Check arguments */
if (H5P_DATASET_XFER != H5P_get_class (plist_id) ||
NULL == (plist = H5I_object (plist_id))) {
HRETURN_ERROR (H5E_ARGS, H5E_BADTYPE, FAIL,
"not a dataset transfer property list");
}
/* Update property list */
plist->need_bkg = status ? H5T_BKG_YES : H5T_BKG_NO;
FUNC_LEAVE (SUCCEED);
}
/*-------------------------------------------------------------------------
* Function: H5Pget_preserve
*
* Purpose: The inverse of H5Pset_preserve()
*
* Return: Success: TRUE or FALSE
*
* Failure: Negative
*
* Programmer: Robb Matzke
* Tuesday, March 17, 1998
*
* Modifications:
*
*-------------------------------------------------------------------------
*/
int
H5Pget_preserve(hid_t plist_id)
{
H5F_xfer_t *plist = NULL;
FUNC_ENTER (H5Pset_preserve, FAIL);
H5TRACE1("Is","i",plist_id);
/* Check arguments */
if (H5P_DATASET_XFER != H5P_get_class (plist_id) ||
NULL == (plist = H5I_object (plist_id))) {
HRETURN_ERROR (H5E_ARGS, H5E_BADTYPE, FAIL,
"not a dataset transfer property list");
}
FUNC_LEAVE (plist->need_bkg?TRUE:FALSE);
}
/*-------------------------------------------------------------------------
* Function: H5Pset_filter
*
* Purpose: Adds the specified FILTER and corresponding properties to the
* end of the transient or permanent output filter pipeline
* depending on whether PLIST is a dataset creation or dataset
* transfer property list. The FLAGS argument specifies certain
* general properties of the filter and is documented below.
* The CD_VALUES is an array of CD_NELMTS integers which are
* auxiliary data for the filter. The integer vlues will be
* stored in the dataset object header as part of the filter
* information.
*
* The FLAGS argument is a bit vector of the following fields:
*
* H5Z_FLAG_OPTIONAL(0x0001)
* If this bit is set then the filter is optional. If the
* filter fails during an H5Dwrite() operation then the filter
* is just excluded from the pipeline for the chunk for which it
* failed; the filter will not participate in the pipeline
* during an H5Dread() of the chunk. If this bit is clear and
* the filter fails then the entire I/O operation fails.
*
* Note: This function currently supports only the permanent filter
* pipeline. That is, PLIST_ID must be a dataset creation
* property list.
*
* Return: Non-negative on success/Negative on failure
*
* Programmer: Robb Matzke
* Wednesday, April 15, 1998
*
* Modifications:
*
*-------------------------------------------------------------------------
*/
herr_t
H5Pset_filter(hid_t plist_id, H5Z_filter_t filter, unsigned int flags,
size_t cd_nelmts, const unsigned int cd_values[/*cd_nelmts*/])
{
H5D_create_t *plist = NULL;
FUNC_ENTER (H5Pset_filter, FAIL);
H5TRACE5("e","iZfIuz*[a3]Iu",plist_id,filter,flags,cd_nelmts,cd_values);
/* Check arguments */
if (H5P_DATASET_XFER==H5P_get_class(plist_id)) {
HRETURN_ERROR(H5E_PLINE, H5E_UNSUPPORTED, FAIL,
"transient pipelines are not supported yet");
}
if (H5P_DATASET_CREATE!=H5P_get_class (plist_id) ||
NULL==(plist=H5I_object (plist_id))) {
HRETURN_ERROR (H5E_ARGS, H5E_BADTYPE, FAIL,
"not a dataset creation property list");
}
if (filter<0 || filter>H5Z_FILTER_MAX) {
HRETURN_ERROR (H5E_ARGS, H5E_BADVALUE, FAIL,
"invalid filter identifier");
}
if (flags & ~H5Z_FLAG_DEFMASK) {
HRETURN_ERROR(H5E_ARGS, H5E_BADVALUE, FAIL,
"invalid flags");
}
if (cd_nelmts>0 && !cd_values) {
HRETURN_ERROR(H5E_ARGS, H5E_BADVALUE, FAIL,
"no client data values supplied");
}
/* Do it */
if (H5Z_append(&(plist->pline), filter, flags, cd_nelmts, cd_values)<0) {
HRETURN_ERROR(H5E_PLINE, H5E_CANTINIT, FAIL,
"unable to add filter to pipeline");
}
FUNC_LEAVE (SUCCEED);
}
/*-------------------------------------------------------------------------
* Function: H5Pget_nfilters
*
* Purpose: Returns the number of filters in the permanent or transient
* pipeline depending on whether PLIST_ID is a dataset creation
* or dataset transfer property list. In each pipeline the
* filters are numbered from zero through N-1 where N is the
* value returned by this function. During output to the file
* the filters of a pipeline are applied in increasing order
* (the inverse is true for input).
*
* Note: Only permanent filters are supported at this time.
*
* Return: Success: Number of filters or zero if there are none.
*
* Failure: Negative
*
* Programmer: Robb Matzke
* Tuesday, August 4, 1998
*
* Modifications:
*
*-------------------------------------------------------------------------
*/
int
H5Pget_nfilters(hid_t plist_id)
{
H5D_create_t *plist = NULL;
FUNC_ENTER(H5Pget_nfilters, FAIL);
H5TRACE1("Is","i",plist_id);
if (H5P_DATASET_XFER==H5P_get_class(plist_id)) {
HRETURN_ERROR(H5E_PLINE, H5E_UNSUPPORTED, FAIL,
"transient pipelines are not supported yet");
}
if (H5P_DATASET_CREATE!=H5P_get_class(plist_id) ||
NULL==(plist=H5I_object(plist_id))) {
HRETURN_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL,
"not a dataset creation property list");
}
FUNC_LEAVE((int)(plist->pline.nfilters));
}
/*-------------------------------------------------------------------------
* Function: H5Pget_filter
*
* Purpose: This is the query counterpart of H5Pset_filter() and returns
* information about a particular filter number in a permanent
* or transient pipeline depending on whether PLIST_ID is a
* dataset creation or transfer property list. On input,
* CD_NELMTS indicates the number of entries in the CD_VALUES
* array allocated by the caller while on exit it contains the
* number of values defined by the filter. The IDX should be a
* value between zero and N-1 as described for H5Pget_nfilters()
* and the function will return failure if the filter number is
* out or range.
*
* Return: Success: Filter identification number.
*
* Failure: H5Z_FILTER_ERROR (Negative)
*
* Programmer: Robb Matzke
* Wednesday, April 15, 1998
*
* Modifications:
*
*-------------------------------------------------------------------------
*/
H5Z_filter_t
H5Pget_filter(hid_t plist_id, int idx, unsigned int *flags/*out*/,
size_t *cd_nelmts/*in_out*/, unsigned cd_values[]/*out*/,
size_t namelen, char name[]/*out*/)
{
H5D_create_t *plist = NULL;
size_t i;
FUNC_ENTER (H5Pget_filter, FAIL);
H5TRACE7("Zf","iIsx*zxzx",plist_id,idx,flags,cd_nelmts,cd_values,namelen,
name);
/* Check arguments */
if (H5P_DATASET_XFER==H5P_get_class(plist_id)) {
HRETURN_ERROR(H5E_PLINE, H5E_UNSUPPORTED, FAIL,
"transient filters are not supported yet");
}
if (H5P_DATASET_CREATE!=H5P_get_class (plist_id) ||
NULL==(plist=H5I_object (plist_id))) {
HRETURN_ERROR (H5E_ARGS, H5E_BADTYPE, FAIL,
"not a dataset creation property list");
}
if (idx<0 || (size_t)idx>=plist->pline.nfilters) {
HRETURN_ERROR(H5E_ARGS, H5E_BADVALUE, FAIL,
"filter number is invalid");
}
if (cd_nelmts || cd_values) {
if (cd_nelmts && *cd_nelmts>256) {
/*
* It's likely that users forget to initialize this on input, so
* we'll check that it has a reasonable value. The actual number
* is unimportant because the H5O layer will detect when a message
* is too large.
*/
HRETURN_ERROR(H5E_ARGS, H5E_BADVALUE, FAIL,
"probable uninitialized *cd_nelmts argument");
}
if (cd_nelmts && *cd_nelmts>0 && !cd_values) {
HRETURN_ERROR(H5E_ARGS, H5E_BADVALUE, FAIL,
"client data values not supplied");
}
/*
* If cd_nelmts is null but cd_values is non-null then just ignore
* cd_values
*/
if (!cd_nelmts) cd_values = NULL;
}
/* Output values */
if (flags) *flags = plist->pline.filter[idx].flags;
if (cd_values) {
for (i=0; i<plist->pline.filter[idx].cd_nelmts && i<*cd_nelmts; i++) {
cd_values[i] = plist->pline.filter[idx].cd_values[i];
}
}
if (cd_nelmts) *cd_nelmts = plist->pline.filter[idx].cd_nelmts;
if (namelen>0 && name) {
const char *s = plist->pline.filter[idx].name;
if (!s) {
H5Z_class_t *cls = H5Z_find(plist->pline.filter[idx].id);
if (cls) s = cls->name;
}
if (s) HDstrncpy(name, s, namelen);
else name[0] = '\0';
}
FUNC_LEAVE (plist->pline.filter[idx].id);
}
/*-------------------------------------------------------------------------
* Function: H5Pset_deflate
*
* Purpose: Sets the compression method for a permanent or transient
* filter pipeline (depending on whether PLIST_ID is a dataset
* creation or transfer property list) to H5Z_FILTER_DEFLATE
* and the compression level to LEVEL which should be a value
* between zero and nine, inclusive. Lower compression levels
* are faster but result in less compression. This is the same
* algorithm as used by the GNU gzip program.
*
* Return: Non-negative on success/Negative on failure
*
* Programmer: Robb Matzke
* Wednesday, April 15, 1998
*
* Modifications:
*
*-------------------------------------------------------------------------
*/
herr_t
H5Pset_deflate(hid_t plist_id, unsigned level)
{
H5D_create_t *plist = NULL;
FUNC_ENTER (H5Pset_deflate, FAIL);
H5TRACE2("e","iIu",plist_id,level);
/* Check arguments */
if (H5P_DATASET_XFER==H5P_get_class(plist_id)) {
HRETURN_ERROR(H5E_PLINE, H5E_UNSUPPORTED, FAIL,
"transient filter pipelines are not supported yet");
}
if (H5P_DATASET_CREATE!=H5P_get_class (plist_id) ||
NULL==(plist=H5I_object (plist_id))) {
HRETURN_ERROR (H5E_ARGS, H5E_BADTYPE, FAIL,
"not a dataset creation property list");
}
if (level>9) {
HRETURN_ERROR (H5E_ARGS, H5E_BADVALUE, FAIL,
"invalid deflate level");
}
/* Add the filter */
if (H5Z_append(&(plist->pline), H5Z_FILTER_DEFLATE, H5Z_FLAG_OPTIONAL,
1, &level)<0) {
HRETURN_ERROR(H5E_PLINE, H5E_CANTINIT, FAIL,
"unable to add deflate filter to pipeline");
}
FUNC_LEAVE (SUCCEED);
}
/*-------------------------------------------------------------------------
* Function: H5Pget_btree_ratios
*
* Purpose: Queries B-tree split ratios. See H5Pset_btree_ratios().
*
* Return: Success: Non-negative with split ratios returned through
* the non-null arguments.
*
* Failure: Negative
*
* Programmer: Robb Matzke
* Monday, September 28, 1998
*
* Modifications:
*
*-------------------------------------------------------------------------
*/
herr_t
H5Pget_btree_ratios(hid_t plist_id, double *left/*out*/, double *middle/*out*/,
double *right/*out*/)
{
H5F_xfer_t *plist = NULL;
FUNC_ENTER(H5Pget_btree_ratios, FAIL);
H5TRACE4("e","ixxx",plist_id,left,middle,right);
/* Check arguments */
if (H5P_DATASET_XFER!=H5P_get_class(plist_id) ||
NULL==(plist=H5I_object(plist_id))) {
HRETURN_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL,
"not a dataset transfer property list");
}
/* Get values */
if (left) *left = plist->split_ratios[0];
if (middle) *middle = plist->split_ratios[1];
if (right) *right = plist->split_ratios[2];
FUNC_LEAVE(SUCCEED);
}
/*-------------------------------------------------------------------------
* Function: H5Pset_btree_ratios
*
* Purpose: Sets B-tree split ratios for a dataset transfer property
* list. The split ratios determine what percent of children go
* in the first node when a node splits. The LEFT ratio is
* used when the splitting node is the left-most node at its
* level in the tree; the RIGHT ratio is when the splitting node
* is the right-most node at its level; and the MIDDLE ratio for
* all other cases. A node which is the only node at its level
* in the tree uses the RIGHT ratio when it splits. All ratios
* are real numbers between 0 and 1, inclusive.
*
* Return: Non-negative on success/Negative on failure
*
* Programmer: Robb Matzke
* Monday, September 28, 1998
*
* Modifications:
*
*-------------------------------------------------------------------------
*/
herr_t
H5Pset_btree_ratios(hid_t plist_id, double left, double middle,
double right)
{
H5F_xfer_t *plist = NULL;
FUNC_ENTER(H5Pget_btree_ratios, FAIL);
H5TRACE4("e","iddd",plist_id,left,middle,right);
/* Check arguments */
if (H5P_DATASET_XFER!=H5P_get_class(plist_id) ||
NULL==(plist=H5I_object(plist_id))) {
HRETURN_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL,
"not a dataset transfer property list");
}
if (left<0.0 || left>1.0 || middle<0.0 || middle>1.0 ||
right<0.0 || right>1.0) {
HRETURN_ERROR(H5E_ARGS, H5E_BADVALUE, FAIL,
"split ratio must satisfy 0.0<=X<=1.0");
}
/* Set values */
plist->split_ratios[0] = left;
plist->split_ratios[1] = middle;
plist->split_ratios[2] = right;
FUNC_LEAVE(SUCCEED);
}
/*-------------------------------------------------------------------------
* Function: H5Pset_fill_value
*
* Purpose: Set the fill value for a dataset creation property list. The
* VALUE is interpretted as being of type TYPE, which need not
* be the same type as the dataset but the library must be able
* to convert VALUE to the dataset type when the dataset is
* created.
*
* Return: Non-negative on success/Negative on failure
*
* Programmer: Robb Matzke
* Thursday, October 1, 1998
*
* Modifications:
*
*-------------------------------------------------------------------------
*/
herr_t
H5Pset_fill_value(hid_t plist_id, hid_t type_id, const void *value)
{
H5D_create_t *plist = NULL;
H5T_t *type = NULL;
FUNC_ENTER(H5Pset_fill_value, FAIL);
H5TRACE3("e","iix",plist_id,type_id,value);
/* Check arguments */
if (H5P_DATASET_CREATE!=H5P_get_class(plist_id) ||
NULL==(plist=H5I_object(plist_id))) {
HRETURN_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL,
"not a dataset creation property list");
}
if (H5I_DATATYPE!=H5I_get_type(type_id) ||
NULL==(type=H5I_object(type_id))) {
HRETURN_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL, "not a data type");
}
if (!value) {
HRETURN_ERROR(H5E_ARGS, H5E_BADVALUE, FAIL, "no fill value specified");
}
/* Set the fill value */
H5O_reset(H5O_FILL, &(plist->fill));
if (NULL==(plist->fill.type=H5T_copy(type, H5T_COPY_TRANSIENT))) {
HRETURN_ERROR(H5E_DATATYPE, H5E_CANTINIT, FAIL,
"unable to copy data type");
}
plist->fill.size = H5T_get_size(type);
if (NULL==(plist->fill.buf=H5MM_malloc(plist->fill.size))) {
HRETURN_ERROR(H5E_RESOURCE, H5E_CANTINIT, FAIL,
"memory allocation failed for fill value");
}
HDmemcpy(plist->fill.buf, value, plist->fill.size);
FUNC_LEAVE(SUCCEED);
}
/*-------------------------------------------------------------------------
* Function: H5Pget_fill_value
*
* Purpose: Queries the fill value property of a dataset creation
* property list. The fill value is returned through the VALUE
* pointer and the memory is allocated by the caller. The fill
* value will be converted from its current data type to the
* specified TYPE.
*
* Return: Non-negative on success/Negative on failure
*
* Programmer: Robb Matzke
* Thursday, October 1, 1998
*
* Modifications:
*
*-------------------------------------------------------------------------
*/
herr_t
H5Pget_fill_value(hid_t plist_id, hid_t type_id, void *value/*out*/)
{
H5D_create_t *plist = NULL; /*property list */
H5T_t *type = NULL; /*data type */
H5T_path_t *tpath = NULL; /*type conversion info */
void *buf = NULL; /*conversion buffer */
void *bkg = NULL; /*conversion buffer */
hid_t src_id = -1; /*source data type id */
herr_t ret_value = FAIL; /*return value */
FUNC_ENTER(H5Pget_fill_value, FAIL);
H5TRACE3("e","iix",plist_id,type_id,value);
/* Check arguments */
if (H5P_DATASET_CREATE!=H5P_get_class(plist_id) ||
NULL==(plist=H5I_object(plist_id))) {
HGOTO_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL,
"not a dataset creation proprety list");
}
if (H5I_DATATYPE!=H5I_get_type(type_id) ||
NULL==(type=H5I_object(type_id))) {
HGOTO_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL, "not a data type");
}
if (!value) {
HGOTO_ERROR(H5E_ARGS, H5E_BADVALUE, FAIL,
"no fill value output buffer");
}
/*
* If no fill value is defined then return an error. We can't even
* return zero because we don't know the data type of the dataset and
* data type conversion might not have resulted in zero.
*/
if (NULL==plist->fill.buf) {
HGOTO_ERROR(H5E_PLIST, H5E_NOTFOUND, FAIL, "no fill value defined");
}
/*
* Can we convert between the source and destination data types?
*/
if (NULL==(tpath=H5T_path_find(plist->fill.type, type, NULL, NULL))) {
HGOTO_ERROR(H5E_DATATYPE, H5E_CANTINIT, FAIL,
"unable to convert between src and dst data types");
}
src_id = H5I_register(H5I_DATATYPE,
H5T_copy (plist->fill.type, H5T_COPY_TRANSIENT));
if (src_id<0) {
HGOTO_ERROR(H5E_DATATYPE, H5E_CANTINIT, FAIL,
"unable to copy/register data type");
}
/*
* Data type conversions are always done in place, so we need a buffer
* other than the fill value buffer that is large enough for both source
* and destination. The app-supplied buffer might do okay.
*/
if (H5T_get_size(type)>=H5T_get_size(plist->fill.type)) {
buf = value;
if (tpath->cdata.need_bkg>=H5T_BKG_TEMP &&
NULL==(bkg=H5MM_malloc(H5T_get_size(type)))) {
HGOTO_ERROR(H5E_RESOURCE, H5E_NOSPACE, FAIL,
"memory allocation failed for type conversion");
}
} else {
if (NULL==(buf=H5MM_malloc(H5T_get_size(plist->fill.type)))) {
HGOTO_ERROR(H5E_RESOURCE, H5E_NOSPACE, FAIL,
"memory allocation failed for type conversion");
}
if (tpath->cdata.need_bkg>=H5T_BKG_TEMP) bkg = value;
}
HDmemcpy(buf, plist->fill.buf, H5T_get_size(plist->fill.type));
/* Do the conversion */
if (H5T_convert(tpath, src_id, type_id, 1, 0, buf, bkg, H5P_DEFAULT)<0) {
HGOTO_ERROR(H5E_DATATYPE, H5E_CANTINIT, FAIL,
"data type conversion failed");
}
if (buf!=value) HDmemcpy(value, buf, H5T_get_size(type));
ret_value = SUCCEED;
done:
if (buf!=value) H5MM_xfree(buf);
if (bkg!=value) H5MM_xfree(bkg);
if (src_id>=0) H5I_dec_ref(src_id);
FUNC_LEAVE(ret_value);
}
#ifdef HAVE_PARALLEL
/*-------------------------------------------------------------------------
* Function: H5Pset_mpi
*
* Signature: herr_t H5Pset_mpi(hid_t plist_id, MPI_Comm comm, MPI_Info info)
*
* Purpose: Store the access mode for MPIO call and the user supplied
* communicator and info in the access property list which can
* then be used to open file. This function is available only
* in the parallel HDF5 library and is not a collective
* function.
*
* Parameters:
* hid_t plist_id
* ID of property list to modify
* MPI_Comm comm
* MPI communicator to be used for file open as defined in
* MPI_FILE_OPEN of MPI-2. This function does not make a
* duplicated communicator. Any modification to comm after
* this function call returns may have undetermined effect
* to the access property list. Users should call this
* function again to setup the property list.
* MPI_Info info
* MPI info object to be used for file open as defined in
* MPI_FILE_OPEN of MPI-2. This function does not make a
* duplicated info. Any modification to info after
* this function call returns may have undetermined effect
* to the access property list. Users should call this
* function again to setup the property list.
*
* Return: Non-negative on success/Negative on failure
*
* Programmer: Albert Cheng
* Feb 3, 1998
*
* Modifications:
*
* Robb Matzke, 18 Feb 1998
* Check all arguments before the property list is updated so we don't
* leave the property list in a bad state if something goes wrong. Also,
* the property list data type changed to allow more generality so all
* the mpi-related stuff is in the `u.mpi' member. The `access_mode'
* will contain only mpi-related flags defined in H5Fpublic.h.
*
* Albert Cheng, Apr 16, 1998
* Removed the access_mode argument. The access_mode is changed
* to be controlled by data transfer property list during data
* read/write calls.
*
*-------------------------------------------------------------------------
*/
herr_t
H5Pset_mpi(hid_t plist_id, MPI_Comm comm, MPI_Info info)
{
H5F_access_t *plist = NULL;
FUNC_ENTER(H5Pset_mpi, FAIL);
H5TRACE3("e","iMcMi",plist_id,comm,info);
/* Check arguments */
if (H5P_FILE_ACCESS != H5P_get_class(plist_id) ||
NULL == (plist = H5I_object(plist_id))) {
HRETURN_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL,
"not a file access property list");
}
#ifdef LATER
/*
* Need to verify comm and info contain sensible information.
*/
#endif
plist->driver = H5F_LOW_MPIO;
plist->u.mpio.comm = comm;
plist->u.mpio.info = info;
FUNC_LEAVE(SUCCEED);
}
#endif /*HAVE_PARALLEL*/
#ifdef HAVE_PARALLEL
/*-------------------------------------------------------------------------
* Function: H5Pget_mpi
*
* Purpose: If the file access property list is set to the mpi driver
* then this function returns zero; otherwise it returns a
* negative value. In the future, additional arguments may be
* added to this function to match those added to H5Pset_mpi().
*
* Return: Non-negative on success/Negative on failure
*
* Programmer: Robb Matzke
* Thursday, February 26, 1998
*
* Modifications:
*
* Albert Cheng, Apr 16, 1998
* Removed the access_mode argument. The access_mode is changed
* to be controlled by data transfer property list during data
* read/write calls.
*
*-------------------------------------------------------------------------
*/
herr_t
H5Pget_mpi(hid_t plist_id, MPI_Comm *comm, MPI_Info *info)
{
H5F_access_t *plist = NULL;
FUNC_ENTER (H5Pget_mpi, FAIL);
H5TRACE3("e","i*Mc*Mi",plist_id,comm,info);
/* Check arguments */
if (H5P_FILE_ACCESS != H5P_get_class (plist_id) ||
NULL == (plist = H5I_object (plist_id))) {
HRETURN_ERROR (H5E_ARGS, H5E_BADTYPE, FAIL,
"not a file access property list");
}
if (H5F_LOW_MPIO != plist->driver) {
HRETURN_ERROR (H5E_ARGS, H5E_BADVALUE, FAIL,
"the mpi driver is not set");
}
*comm = plist->u.mpio.comm;
*info = plist->u.mpio.info;
FUNC_LEAVE (SUCCEED);
}
#endif /*HAVE_PARALLEL*/
#ifdef HAVE_PARALLEL
/*-------------------------------------------------------------------------
* Function: H5Pset_xfer
*
* Signature: herr_t H5Pset_xfer(hid_t plist_id,
* H5D_transfer_t data_xfer_mode)
*
* Purpose: Set the transfer mode of the dataset transfer property list.
* The list can then be used to control the I/O transfer mode
* during dataset accesses. This function is available only
* in the parallel HDF5 library and is not a collective function.
*
* Parameters:
* hid_t plist_id
* ID of a dataset transfer property list
* H5D_transfer_t data_xfer_mode
* Data transfer modes:
* H5D_XFER_INDEPENDENT
* Use independent I/O access.
* H5D_XFER_COLLECTIVE
* Use MPI collective I/O access.
* H5D_XFER_DFLT
* Use default I/O access. Currently,
* independent is the default mode.
*
*
* Return: Non-negative on success/Negative on failure
*
* Programmer: Albert Cheng
* April 2, 1998
*
* Modifications:
*
*-------------------------------------------------------------------------
*/
herr_t
H5Pset_xfer(hid_t plist_id, H5D_transfer_t data_xfer_mode)
{
H5F_xfer_t *plist = NULL;
FUNC_ENTER(H5Pset_xfer, FAIL);
H5TRACE2("e","iDt",plist_id,data_xfer_mode);
/* Check arguments */
if (H5P_DATASET_XFER != H5P_get_class(plist_id) ||
NULL == (plist = H5I_object(plist_id))) {
HRETURN_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL,
"not a dataset transfer property list");
}
switch (data_xfer_mode){
case H5D_XFER_INDEPENDENT:
case H5D_XFER_COLLECTIVE:
case H5D_XFER_DFLT:
plist->xfer_mode = data_xfer_mode;
break;
default:
HRETURN_ERROR (H5E_ARGS, H5E_BADVALUE, FAIL,
"invalid dataset transfer mode");
}
FUNC_LEAVE(SUCCEED);
}
#endif /*HAVE_PARALLEL*/
#ifdef HAVE_PARALLEL
/*-------------------------------------------------------------------------
* Function: H5Pget_xfer
*
* Purpose: Reads the transfer mode current set in the property list.
* This function is available only in the parallel HDF5 library
* and is not a collective function.
*
* Return: Non-negative on success/Negative on failure
*
* Programmer: Albert Cheng
* April 2, 1998
*
* Modifications:
*
*-------------------------------------------------------------------------
*/
herr_t
H5Pget_xfer(hid_t plist_id, H5D_transfer_t *data_xfer_mode)
{
H5F_xfer_t *plist = NULL;
FUNC_ENTER (H5Pget_xfer, FAIL);
H5TRACE2("e","i*Dt",plist_id,data_xfer_mode);
/* Check arguments */
if (H5P_DATASET_XFER != H5P_get_class(plist_id) ||
NULL == (plist = H5I_object(plist_id))) {
HRETURN_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL,
"not a dataset transfer property list");
}
*data_xfer_mode = plist->xfer_mode;
FUNC_LEAVE (SUCCEED);
}
#endif /*HAVE_PARALLEL*/
/*-------------------------------------------------------------------------
* Function: H5Pset_gc_references
*
* Purpose: Sets the flag for garbage collecting references for the file.
* Dataset region references (and other reference types probably) use
* space in the file heap. If garbage collection is on and the user
* passes in an uninitialized value in a reference structure, the heap
* might get corrupted. When garbage collection is off however and the
* user re-uses a reference, the previous heap block will be orphaned and
* not returned to the free heap space. When garbage collection is on,
* the user must initialize the reference structures to 0 or risk heap
* corruption.
*
* Default value for garbage collecting references is off, just to be
* on the safe side.
*
* Return: Non-negative on success/Negative on failure
*
* Programmer: Quincey Koziol
* Friday, November 13, 1998
*
* Modifications:
*
*-------------------------------------------------------------------------
*/
herr_t
H5Pset_gc_references(hid_t fapl_id, unsigned gc_ref)
{
H5F_access_t *fapl = NULL;
FUNC_ENTER (H5Pset_gc_references, FAIL);
H5TRACE2("e","iIu",fapl_id,gc_ref);
/* Check args */
if (H5P_FILE_ACCESS != H5P_get_class (fapl_id) || NULL == (fapl = H5I_object (fapl_id))) {
HRETURN_ERROR (H5E_ARGS, H5E_BADTYPE, FAIL, "not a file access property list");
}
/* Set values */
fapl->gc_ref = (gc_ref!=0);
FUNC_LEAVE (SUCCEED);
}
/*-------------------------------------------------------------------------
* Function: H5Pget_gc_refernces
*
* Purpose: Returns the current setting for the garbage collection refernces
* property from a file access property list.
*
* Return: Non-negative on success/Negative on failure
*
* Programmer: Robb Matzke
* Tuesday, June 9, 1998
*
* Modifications:
*
*-------------------------------------------------------------------------
*/
herr_t
H5Pget_gc_reference(hid_t fapl_id, unsigned *gc_ref/*out*/)
{
H5F_access_t *fapl = NULL;
FUNC_ENTER (H5Pget_alignment, FAIL);
H5TRACE2("e","ix",fapl_id,gc_ref);
/* Check args */
if (H5P_FILE_ACCESS != H5P_get_class (fapl_id) || NULL == (fapl = H5I_object (fapl_id))) {
HRETURN_ERROR (H5E_ARGS, H5E_BADTYPE, FAIL, "not a file access property list");
}
/* Get values */
if (gc_ref) *gc_ref = fapl->gc_ref;
FUNC_LEAVE (SUCCEED);
}
/*-------------------------------------------------------------------------
* Function: H5Pset_vlen_mem_manager
*
* Purpose: Sets the memory allocate/free pair for VL datatypes. The
* allocation routine is called when data is read into a new array
* and the free routine is called when H5Dvlen_reclaim is called.
* The alloc_info and free_info are user parameters which are passed
* to the allocation and freeing functions respectively.
* To reset the allocate/free functions to the default setting of using
* the system's malloc/free functions, call this routine with alloc_func
* and free_func set to NULL.
*
* Return: Non-negative on success/Negative on failure
*
* Programmer: Quincey Koziol
* Thursday, July 1, 1999
*
* Modifications:
*
*-------------------------------------------------------------------------
*/
herr_t
H5Pset_vlen_mem_manager(hid_t plist_id, H5MM_allocate_t alloc_func,
void *alloc_info, H5MM_free_t free_func, void *free_info)
{
H5F_xfer_t *plist = NULL;
FUNC_ENTER (H5Pset_vlen_mem_manager, FAIL);
H5TRACE5("e","ixxxx",plist_id,alloc_func,alloc_info,free_func,free_info);
/* Check arguments */
if (H5P_DATASET_XFER != H5P_get_class (plist_id) ||
NULL == (plist = H5I_object (plist_id))) {
HRETURN_ERROR (H5E_ARGS, H5E_BADTYPE, FAIL, "not a dataset transfer property list");
}
/* Update property list */
plist->vlen_alloc = alloc_func;
plist->alloc_info = alloc_info;
plist->vlen_free = free_func;
plist->free_info = free_info;
FUNC_LEAVE (SUCCEED);
}
/*-------------------------------------------------------------------------
* Function: H5Pget_vlen_mem_manager
*
* Purpose: The inverse of H5Pset_vlen_mem_manager()
*
* Return: Non-negative on success/Negative on failure
*
* Programmer: Quincey Koziol
* Thursday, July 1, 1999
*
* Modifications:
*
*-------------------------------------------------------------------------
*/
herr_t
H5Pget_vlen_mem_manager(hid_t plist_id, H5MM_allocate_t *alloc_func,
void **alloc_info, H5MM_free_t *free_func, void **free_info)
{
H5F_xfer_t *plist = NULL;
FUNC_ENTER (H5Pset_vlen_mem_manager, FAIL);
H5TRACE5("e","i*x*x*x*x",plist_id,alloc_func,alloc_info,free_func,
free_info);
/* Check arguments */
if (H5P_DATASET_XFER != H5P_get_class (plist_id) ||
NULL == (plist = H5I_object (plist_id))) {
HRETURN_ERROR (H5E_ARGS, H5E_BADTYPE, FAIL, "not a dataset transfer property list");
}
if(alloc_func!=NULL)
*alloc_func= plist->vlen_alloc;
if(alloc_info!=NULL)
*alloc_info= plist->alloc_info;
if(free_func!=NULL)
*free_func= plist->vlen_free;
if(free_info!=NULL)
*free_info= plist->free_info;
FUNC_LEAVE (SUCCEED);
}
/*--------------------------------------------------------------------------
NAME
H5Pcopy
PURPOSE
Copy a property list
USAGE
hid_t H5P_copy(plist_id)
hid_t plist_id; IN: property list object to copy
RETURNS
Returns property list ID (atom) on success, Negative on failure
ERRORS
ARGS BADRANGE Unknown property list class.
ATOM BADATOM Can't unatomize property list.
ATOM CANTREGISTER Register the atom for the new property list.
INTERNAL UNSUPPORTED Dataset transfer properties are not implemented
yet.
INTERNAL UNSUPPORTED File access properties are not implemented yet.
DESCRIPTION
* This function creates a new copy of a property list with all the same
* parameter settings.
--------------------------------------------------------------------------*/
hid_t
H5Pcopy(hid_t plist_id)
{
const void *plist = NULL;
void *new_plist = NULL;
H5P_class_t type;
hid_t ret_value = FAIL;
H5I_type_t group;
FUNC_ENTER(H5Pcopy, FAIL);
H5TRACE1("i","i",plist_id);
/* Check args */
if (NULL == (plist = H5I_object(plist_id)) ||
(type = H5P_get_class(plist_id)) < 0 ||
(group = H5I_get_type(plist_id)) < 0) {
HRETURN_ERROR(H5E_ATOM, H5E_BADATOM, FAIL,
"unable to unatomize property list");
}
/* Copy it */
if (NULL==(new_plist=H5P_copy (type, plist))) {
HRETURN_ERROR (H5E_INTERNAL, H5E_CANTINIT, FAIL,
"unable to copy property list");
}
/* Register the atom for the new property list */
if ((ret_value = H5I_register(group, new_plist)) < 0) {
HRETURN_ERROR(H5E_ATOM, H5E_CANTREGISTER, FAIL,
"unable to atomize property list pointer");
}
FUNC_LEAVE(ret_value);
}
/*-------------------------------------------------------------------------
* Function: H5P_copy
*
* Purpose: Creates a new property list and initializes it with some
* other property list.
*
* Return: Success: Ptr to new property list
*
* Failure: NULL
*
* Programmer: Robb Matzke
* Tuesday, February 3, 1998
*
* Modifications:
*
*-------------------------------------------------------------------------
*/
void *
H5P_copy (H5P_class_t type, const void *src)
{
size_t size;
void *dst = NULL;
const H5D_create_t *dc_src = NULL;
H5D_create_t *dc_dst = NULL;
const H5F_access_t *fa_src = NULL;
H5F_access_t *fa_dst = NULL;
FUNC_ENTER (H5P_copy, NULL);
/* How big is the property list */
switch (type) {
case H5P_FILE_CREATE:
size = sizeof(H5F_create_t);
break;
case H5P_FILE_ACCESS:
size = sizeof(H5F_access_t);
break;
case H5P_DATASET_CREATE:
size = sizeof(H5D_create_t);
break;
case H5P_DATASET_XFER:
size = sizeof(H5F_xfer_t);
break;
case H5P_MOUNT:
size = sizeof(H5F_mprop_t);
break;
default:
HRETURN_ERROR(H5E_ARGS, H5E_BADRANGE, NULL,
"unknown property list class");
}
/* Create the new property list */
if (NULL==(dst = H5MM_malloc(size))) {
HRETURN_ERROR (H5E_RESOURCE, H5E_NOSPACE, NULL,
"memory allocation failed");
}
HDmemcpy(dst, src, size);
/* Deep-copy pointers */
switch (type) {
case H5P_FILE_CREATE:
break;
case H5P_FILE_ACCESS:
fa_src = (const H5F_access_t*)src;
fa_dst = (H5F_access_t*)dst;
switch (fa_src->driver) {
case H5F_LOW_ERROR:
case H5F_LOW_SEC2:
case H5F_LOW_STDIO:
case H5F_LOW_CORE:
case H5F_LOW_MPIO:
/* Nothing to do */
break;
case H5F_LOW_FAMILY:
fa_dst->u.fam.memb_access = H5P_copy (H5P_FILE_ACCESS,
fa_src->u.fam.memb_access);
break;
case H5F_LOW_SPLIT:
fa_dst->u.split.meta_access=H5P_copy (H5P_FILE_ACCESS,
fa_src->u.split.meta_access);
fa_dst->u.split.raw_access = H5P_copy (H5P_FILE_ACCESS,
fa_src->u.split.raw_access);
break;
}
break;
case H5P_DATASET_CREATE:
dc_src = (const H5D_create_t*)src;
dc_dst = (H5D_create_t*)dst;
/* Copy the fill value */
if (NULL==H5O_copy(H5O_FILL, &(dc_src->fill), &(dc_dst->fill))) {
HRETURN_ERROR(H5E_PLIST, H5E_CANTINIT, NULL,
"unabe to copy fill value message");
}
/* Copy the external file list */
HDmemset(&(dc_dst->efl), 0, sizeof(dc_dst->efl));
if (NULL==H5O_copy(H5O_EFL, &(dc_src->efl), &(dc_dst->efl))) {
HRETURN_ERROR(H5E_PLIST, H5E_CANTINIT, NULL,
"unable to copy external file list message");
}
/* Copy the filter pipeline */
if (NULL==H5O_copy(H5O_PLINE, &(dc_src->pline), &(dc_dst->pline))) {
HRETURN_ERROR(H5E_PLIST, H5E_CANTINIT, NULL,
"unable to copy filter pipeline message");
}
break;
case H5P_DATASET_XFER:
/* Nothing to do */
break;
case H5P_MOUNT:
/* Nothing to do */
break;
default:
HRETURN_ERROR(H5E_ARGS, H5E_BADRANGE, NULL,
"unknown property list class");
}
FUNC_LEAVE (dst);
}
Reference in New Issue View Git Blame Copy Permalink