mirror of
https://github.com/HDFGroup/hdf5.git
synced 2024-12-21 07:51:46 +08:00
e100695eb0
been run in a while, so many of the source files were updated with tracing macros, etc. No code changes by me. Tested on kagiso and smirom.
1947 lines
68 KiB
C
1947 lines
68 KiB
C
/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
|
||
* 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://hdf.ncsa.uiuc.edu/HDF5/doc/Copyright.html. If you do not have *
|
||
* access to either file, you may request a copy from hdfhelp@ncsa.uiuc.edu. *
|
||
* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
|
||
|
||
/*-------------------------------------------------------------------------
|
||
*
|
||
* Created: H5Pfapl.c
|
||
* February 26 1998
|
||
* Robb Matzke <matzke@llnl.gov>
|
||
*
|
||
* Purpose: File access property list class routines
|
||
*
|
||
*-------------------------------------------------------------------------
|
||
*/
|
||
|
||
/****************/
|
||
/* Module Setup */
|
||
/****************/
|
||
#define H5P_PACKAGE /*suppress error about including H5Ppkg */
|
||
|
||
|
||
/***********/
|
||
/* Headers */
|
||
/***********/
|
||
#include "H5private.h" /* Generic Functions */
|
||
#include "H5Dprivate.h" /* Datasets */
|
||
#include "H5Eprivate.h" /* Error handling */
|
||
#include "H5Fprivate.h" /* Files */
|
||
#include "H5FDprivate.h" /* File drivers */
|
||
#include "H5Iprivate.h" /* IDs */
|
||
#include "H5Ppkg.h" /* Property lists */
|
||
|
||
/* Default file driver - see H5Pget_driver() */
|
||
#include "H5FDsec2.h" /* Posix unbuffered I/O file driver */
|
||
|
||
|
||
/****************/
|
||
/* Local Macros */
|
||
/****************/
|
||
|
||
/* ========= File Access properties ============ */
|
||
/* Definitions for the initial metadata cache resize configuration */
|
||
#define H5F_ACS_META_CACHE_INIT_CONFIG_SIZE sizeof(H5AC_cache_config_t)
|
||
#define H5F_ACS_META_CACHE_INIT_CONFIG_DEF H5AC__DEFAULT_CACHE_CONFIG
|
||
/* Definitions for size of raw data chunk cache(elements) */
|
||
#define H5F_ACS_DATA_CACHE_ELMT_SIZE_SIZE sizeof(size_t)
|
||
#define H5F_ACS_DATA_CACHE_ELMT_SIZE_DEF 521
|
||
/* Definition for size of raw data chunk cache(bytes) */
|
||
#define H5F_ACS_DATA_CACHE_BYTE_SIZE_SIZE sizeof(size_t)
|
||
#define H5F_ACS_DATA_CACHE_BYTE_SIZE_DEF (1024*1024)
|
||
/* Definition for preemption read chunks first */
|
||
#define H5F_ACS_PREEMPT_READ_CHUNKS_SIZE sizeof(double)
|
||
#define H5F_ACS_PREEMPT_READ_CHUNKS_DEF 0.75
|
||
/* Definition for threshold for alignment */
|
||
#define H5F_ACS_ALIGN_THRHD_SIZE sizeof(hsize_t)
|
||
#define H5F_ACS_ALIGN_THRHD_DEF 1
|
||
/* Definition for alignment */
|
||
#define H5F_ACS_ALIGN_SIZE sizeof(hsize_t)
|
||
#define H5F_ACS_ALIGN_DEF 1
|
||
/* Definition for minimum metadata allocation block size (when
|
||
aggregating metadata allocations. */
|
||
#define H5F_ACS_META_BLOCK_SIZE_SIZE sizeof(hsize_t)
|
||
#define H5F_ACS_META_BLOCK_SIZE_DEF 2048
|
||
/* Definition for maximum sieve buffer size (when data sieving
|
||
is allowed by file driver */
|
||
#define H5F_ACS_SIEVE_BUF_SIZE_SIZE sizeof(size_t)
|
||
#define H5F_ACS_SIEVE_BUF_SIZE_DEF (64*1024)
|
||
/* Definition for minimum "small data" allocation block size (when
|
||
aggregating "small" raw data allocations. */
|
||
#define H5F_ACS_SDATA_BLOCK_SIZE_SIZE sizeof(hsize_t)
|
||
#define H5F_ACS_SDATA_BLOCK_SIZE_DEF 2048
|
||
/* Definition for garbage-collect references */
|
||
#define H5F_ACS_GARBG_COLCT_REF_SIZE sizeof(unsigned)
|
||
#define H5F_ACS_GARBG_COLCT_REF_DEF 0
|
||
/* Definition for file driver ID */
|
||
#define H5F_ACS_FILE_DRV_ID_SIZE sizeof(hid_t)
|
||
#define H5F_ACS_FILE_DRV_ID_DEF H5FD_SEC2
|
||
/* Definition for file driver info */
|
||
#define H5F_ACS_FILE_DRV_INFO_SIZE sizeof(void*)
|
||
#define H5F_ACS_FILE_DRV_INFO_DEF NULL
|
||
/* Definition for file close degree */
|
||
#define H5F_CLOSE_DEGREE_SIZE sizeof(H5F_close_degree_t)
|
||
#define H5F_CLOSE_DEGREE_DEF H5F_CLOSE_DEFAULT
|
||
/* Definition for offset position in file for family file driver */
|
||
#define H5F_ACS_FAMILY_OFFSET_SIZE sizeof(hsize_t)
|
||
#define H5F_ACS_FAMILY_OFFSET_DEF 0
|
||
/* Definition for new member size of family driver. It's private
|
||
* property only used by h5repart */
|
||
#define H5F_ACS_FAMILY_NEWSIZE_SIZE sizeof(hsize_t)
|
||
#define H5F_ACS_FAMILY_NEWSIZE_DEF 0
|
||
/* Definition for whether to convert family to sec2 driver. It's private
|
||
* property only used by h5repart */
|
||
#define H5F_ACS_FAMILY_TO_SEC2_SIZE sizeof(hbool_t)
|
||
#define H5F_ACS_FAMILY_TO_SEC2_DEF FALSE
|
||
/* Definition for data type in multi file driver */
|
||
#define H5F_ACS_MULTI_TYPE_SIZE sizeof(H5FD_mem_t)
|
||
#define H5F_ACS_MULTI_TYPE_DEF H5FD_MEM_DEFAULT
|
||
/* Definition for 'use latest format version' flag */
|
||
#define H5F_ACS_LATEST_FORMAT_SIZE sizeof(hbool_t)
|
||
#define H5F_ACS_LATEST_FORMAT_DEF FALSE
|
||
|
||
|
||
/******************/
|
||
/* Local Typedefs */
|
||
/******************/
|
||
|
||
|
||
/********************/
|
||
/* Package Typedefs */
|
||
/********************/
|
||
|
||
|
||
/********************/
|
||
/* Local Prototypes */
|
||
/********************/
|
||
|
||
/* General routines */
|
||
static herr_t H5P_set_family_offset(H5P_genplist_t *plist, hsize_t offset);
|
||
static herr_t H5P_get_family_offset(H5P_genplist_t *plist, hsize_t *offset);
|
||
static herr_t H5P_set_multi_type(H5P_genplist_t *plist, H5FD_mem_t type);
|
||
static herr_t H5P_get_multi_type(H5P_genplist_t *plist, H5FD_mem_t *type);
|
||
|
||
/* Property class callbacks */
|
||
static herr_t H5P_facc_reg_prop(H5P_genclass_t *pclass);
|
||
static herr_t H5P_facc_create(hid_t fapl_id, void *copy_data);
|
||
static herr_t H5P_facc_copy(hid_t new_plist_t, hid_t old_plist_t, void *copy_data);
|
||
|
||
|
||
/*********************/
|
||
/* Package Variables */
|
||
/*********************/
|
||
|
||
/* File access property list class library initialization object */
|
||
const H5P_libclass_t H5P_CLS_FACC[1] = {{
|
||
"file access", /* Class name for debugging */
|
||
&H5P_CLS_ROOT_g, /* Parent class ID */
|
||
&H5P_CLS_FILE_ACCESS_g, /* Pointer to class ID */
|
||
&H5P_LST_FILE_ACCESS_g, /* Pointer to default property list ID */
|
||
H5P_facc_reg_prop, /* Default property registration routine */
|
||
H5P_facc_create, /* Class creation callback */
|
||
NULL, /* Class creation callback info */
|
||
H5P_facc_copy, /* Class copy callback */
|
||
NULL, /* Class copy callback info */
|
||
H5P_facc_close, /* Class close callback */
|
||
NULL /* Class close callback info */
|
||
}};
|
||
|
||
|
||
/*****************************/
|
||
/* Library Private Variables */
|
||
/*****************************/
|
||
|
||
|
||
/*******************/
|
||
/* Local Variables */
|
||
/*******************/
|
||
|
||
|
||
|
||
/*-------------------------------------------------------------------------
|
||
* Function: H5P_facc_reg_prop
|
||
*
|
||
* Purpose: Register the file access property list class's properties
|
||
*
|
||
* Return: Non-negative on success/Negative on failure
|
||
*
|
||
* Programmer: Quincey Koziol
|
||
* October 31, 2006
|
||
*-------------------------------------------------------------------------
|
||
*/
|
||
static herr_t
|
||
H5P_facc_reg_prop(H5P_genclass_t *pclass)
|
||
{
|
||
H5AC_cache_config_t mdc_initCacheCfg = H5F_ACS_META_CACHE_INIT_CONFIG_DEF; /* Default metadata cache settings */
|
||
size_t rdcc_nelmts = H5F_ACS_DATA_CACHE_ELMT_SIZE_DEF; /* Default raw data chunk cache # of elements */
|
||
size_t rdcc_nbytes = H5F_ACS_DATA_CACHE_BYTE_SIZE_DEF; /* Default raw data chunk cache # of bytes */
|
||
double rdcc_w0 = H5F_ACS_PREEMPT_READ_CHUNKS_DEF; /* Default raw data chunk cache dirty ratio */
|
||
hsize_t threshold = H5F_ACS_ALIGN_THRHD_DEF; /* Default allocation alignment threshold */
|
||
hsize_t alignment = H5F_ACS_ALIGN_DEF; /* Default allocation alignment value */
|
||
hsize_t meta_block_size = H5F_ACS_META_BLOCK_SIZE_DEF; /* Default metadata allocation block size */
|
||
size_t sieve_buf_size = H5F_ACS_SIEVE_BUF_SIZE_DEF; /* Default raw data I/O sieve buffer size */
|
||
hsize_t sdata_block_size = H5F_ACS_SDATA_BLOCK_SIZE_DEF; /* Default small data allocation block size */
|
||
unsigned gc_ref = H5F_ACS_GARBG_COLCT_REF_DEF; /* Default garbage collection for references setting */
|
||
hid_t driver_id = H5F_ACS_FILE_DRV_ID_DEF; /* Default VFL driver ID */
|
||
void *driver_info = H5F_ACS_FILE_DRV_INFO_DEF; /* Default VFL driver info */
|
||
H5F_close_degree_t close_degree = H5F_CLOSE_DEGREE_DEF; /* Default file close degree */
|
||
hsize_t family_offset = H5F_ACS_FAMILY_OFFSET_DEF; /* Default offset for family VFD */
|
||
hsize_t family_newsize = H5F_ACS_FAMILY_NEWSIZE_DEF; /* Default size of new files for family VFD */
|
||
hbool_t family_to_sec2 = H5F_ACS_FAMILY_TO_SEC2_DEF; /* Default ?? for family VFD */
|
||
H5FD_mem_t mem_type = H5F_ACS_MULTI_TYPE_DEF; /* Default file space type for multi VFD */
|
||
hbool_t latest_format = H5F_ACS_LATEST_FORMAT_DEF; /* Default setting for "use the latest version of the format" flag */
|
||
herr_t ret_value = SUCCEED; /* Return value */
|
||
|
||
FUNC_ENTER_NOAPI_NOINIT(H5P_facc_reg_prop)
|
||
|
||
/* Register the initial metadata cache resize configuration */
|
||
if(H5P_register(pclass, H5F_ACS_META_CACHE_INIT_CONFIG_NAME, H5F_ACS_META_CACHE_INIT_CONFIG_SIZE, &mdc_initCacheCfg, NULL, NULL, NULL, NULL, NULL, NULL, NULL) < 0)
|
||
HGOTO_ERROR(H5E_PLIST, H5E_CANTINSERT, FAIL, "can't insert property into class")
|
||
|
||
/* Register the size of raw data chunk cache (elements) */
|
||
if(H5P_register(pclass, H5F_ACS_DATA_CACHE_ELMT_SIZE_NAME, H5F_ACS_DATA_CACHE_ELMT_SIZE_SIZE, &rdcc_nelmts, NULL, NULL, NULL, NULL, NULL, NULL, NULL) < 0)
|
||
HGOTO_ERROR(H5E_PLIST, H5E_CANTINSERT, FAIL, "can't insert property into class")
|
||
|
||
/* Register the size of raw data chunk cache(bytes) */
|
||
if(H5P_register(pclass, H5F_ACS_DATA_CACHE_BYTE_SIZE_NAME, H5F_ACS_DATA_CACHE_BYTE_SIZE_SIZE, &rdcc_nbytes, NULL, NULL, NULL, NULL, NULL, NULL, NULL) < 0)
|
||
HGOTO_ERROR(H5E_PLIST, H5E_CANTINSERT, FAIL, "can't insert property into class")
|
||
|
||
/* Register the preemption for reading chunks */
|
||
if(H5P_register(pclass, H5F_ACS_PREEMPT_READ_CHUNKS_NAME, H5F_ACS_PREEMPT_READ_CHUNKS_SIZE, &rdcc_w0, NULL, NULL, NULL, NULL, NULL, NULL, NULL) < 0)
|
||
HGOTO_ERROR(H5E_PLIST, H5E_CANTINSERT, FAIL, "can't insert property into class")
|
||
|
||
/* Register the threshold for alignment */
|
||
if(H5P_register(pclass, H5F_ACS_ALIGN_THRHD_NAME, H5F_ACS_ALIGN_THRHD_SIZE, &threshold, NULL, NULL, NULL, NULL, NULL, NULL, NULL) < 0)
|
||
HGOTO_ERROR(H5E_PLIST, H5E_CANTINSERT, FAIL, "can't insert property into class")
|
||
|
||
/* Register the alignment */
|
||
if(H5P_register(pclass, H5F_ACS_ALIGN_NAME, H5F_ACS_ALIGN_SIZE, &alignment, NULL, NULL, NULL, NULL, NULL, NULL, NULL) < 0)
|
||
HGOTO_ERROR(H5E_PLIST, H5E_CANTINSERT, FAIL, "can't insert property into class")
|
||
|
||
/* Register the minimum metadata allocation block size */
|
||
if(H5P_register(pclass, H5F_ACS_META_BLOCK_SIZE_NAME, H5F_ACS_META_BLOCK_SIZE_SIZE, &meta_block_size, NULL, NULL, NULL, NULL, NULL, NULL, NULL) < 0)
|
||
HGOTO_ERROR(H5E_PLIST, H5E_CANTINSERT, FAIL, "can't insert property into class")
|
||
|
||
/* Register the maximum sieve buffer size */
|
||
if(H5P_register(pclass, H5F_ACS_SIEVE_BUF_SIZE_NAME, H5F_ACS_SIEVE_BUF_SIZE_SIZE, &sieve_buf_size, NULL, NULL, NULL, NULL, NULL, NULL, NULL) < 0)
|
||
HGOTO_ERROR(H5E_PLIST, H5E_CANTINSERT, FAIL, "can't insert property into class")
|
||
|
||
/* Register the minimum "small data" allocation block size */
|
||
if(H5P_register(pclass, H5F_ACS_SDATA_BLOCK_SIZE_NAME, H5F_ACS_SDATA_BLOCK_SIZE_SIZE, &sdata_block_size, NULL, NULL, NULL, NULL, NULL, NULL, NULL) < 0)
|
||
HGOTO_ERROR(H5E_PLIST, H5E_CANTINSERT, FAIL, "can't insert property into class")
|
||
|
||
/* Register the garbage collection reference */
|
||
if(H5P_register(pclass, H5F_ACS_GARBG_COLCT_REF_NAME, H5F_ACS_GARBG_COLCT_REF_SIZE, &gc_ref, NULL, NULL, NULL, NULL, NULL, NULL, NULL) < 0)
|
||
HGOTO_ERROR(H5E_PLIST, H5E_CANTINSERT, FAIL, "can't insert property into class")
|
||
|
||
/* Register the file driver ID */
|
||
if(H5P_register(pclass, H5F_ACS_FILE_DRV_ID_NAME, H5F_ACS_FILE_DRV_ID_SIZE, &driver_id, NULL, NULL, NULL, NULL, NULL, NULL, NULL) < 0)
|
||
HGOTO_ERROR(H5E_PLIST, H5E_CANTINSERT, FAIL, "can't insert property into class")
|
||
|
||
/* Register the file driver info */
|
||
if(H5P_register(pclass, H5F_ACS_FILE_DRV_INFO_NAME, H5F_ACS_FILE_DRV_INFO_SIZE, &driver_info, NULL, NULL, NULL, NULL, NULL, NULL, NULL) < 0)
|
||
HGOTO_ERROR(H5E_PLIST, H5E_CANTINSERT, FAIL, "can't insert property into class")
|
||
|
||
/* Register the file close degree */
|
||
if(H5P_register(pclass, H5F_ACS_CLOSE_DEGREE_NAME, H5F_CLOSE_DEGREE_SIZE, &close_degree, NULL, NULL, NULL, NULL, NULL, NULL, NULL) < 0)
|
||
HGOTO_ERROR(H5E_PLIST, H5E_CANTINSERT, FAIL, "can't insert property into class")
|
||
|
||
/* Register the offset of family driver info */
|
||
if(H5P_register(pclass, H5F_ACS_FAMILY_OFFSET_NAME, H5F_ACS_FAMILY_OFFSET_SIZE, &family_offset, NULL, NULL, NULL, NULL, NULL, NULL, NULL) < 0)
|
||
HGOTO_ERROR(H5E_PLIST, H5E_CANTINSERT, FAIL, "can't insert property into class")
|
||
|
||
/* Register the private property of new family file size. It's used by h5repart only. */
|
||
if(H5P_register(pclass, H5F_ACS_FAMILY_NEWSIZE_NAME, H5F_ACS_FAMILY_NEWSIZE_SIZE, &family_newsize, NULL, NULL, NULL, NULL, NULL, NULL, NULL) < 0)
|
||
HGOTO_ERROR(H5E_PLIST, H5E_CANTINSERT, FAIL, "can't insert property into class")
|
||
|
||
/* Register the private property of whether convert family to sec2 driver. It's used by h5repart only. */
|
||
if(H5P_register(pclass, H5F_ACS_FAMILY_TO_SEC2_NAME, H5F_ACS_FAMILY_TO_SEC2_SIZE, &family_to_sec2, NULL, NULL, NULL, NULL, NULL, NULL, NULL) < 0)
|
||
HGOTO_ERROR(H5E_PLIST, H5E_CANTINSERT, FAIL, "can't insert property into class")
|
||
|
||
/* Register the data type of multi driver info */
|
||
if(H5P_register(pclass, H5F_ACS_MULTI_TYPE_NAME, H5F_ACS_MULTI_TYPE_SIZE, &mem_type, NULL, NULL, NULL, NULL, NULL, NULL, NULL) < 0)
|
||
HGOTO_ERROR(H5E_PLIST, H5E_CANTINSERT, FAIL, "can't insert property into class")
|
||
|
||
/* Register the 'use the latest version of the format' flag */
|
||
if(H5P_register(pclass, H5F_ACS_LATEST_FORMAT_NAME, H5F_ACS_LATEST_FORMAT_SIZE, &latest_format, NULL, NULL, NULL, NULL, NULL, NULL, NULL) < 0)
|
||
HGOTO_ERROR(H5E_PLIST, H5E_CANTINSERT, FAIL, "can't insert property into class")
|
||
|
||
done:
|
||
FUNC_LEAVE_NOAPI(ret_value)
|
||
} /* end H5P_facc_reg_prop() */
|
||
|
||
|
||
/*----------------------------------------------------------------------------
|
||
* Function: H5P_facc_create
|
||
*
|
||
* Purpose: Callback routine which is called whenever a file access
|
||
* property list is closed. This routine performs any generic
|
||
* initialization needed on the properties the library put into
|
||
* the list.
|
||
*
|
||
* Return: Success: Non-negative
|
||
* Failure: Negative
|
||
*
|
||
* Programmer: Raymond Lu
|
||
* Tuesday, Oct 23, 2001
|
||
*
|
||
*----------------------------------------------------------------------------
|
||
*/
|
||
/* ARGSUSED */
|
||
static herr_t
|
||
H5P_facc_create(hid_t fapl_id, void UNUSED *copy_data)
|
||
{
|
||
hid_t driver_id;
|
||
H5P_genplist_t *plist; /* Property list */
|
||
herr_t ret_value = SUCCEED;
|
||
|
||
FUNC_ENTER_NOAPI_NOINIT(H5P_facc_create)
|
||
|
||
/* Check argument */
|
||
if(NULL == (plist = H5I_object(fapl_id)))
|
||
HGOTO_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL, "not a property list")
|
||
|
||
/* Retrieve driver ID property */
|
||
if(H5P_get(plist, H5F_ACS_FILE_DRV_ID_NAME, &driver_id) < 0)
|
||
HGOTO_ERROR(H5E_PLIST, H5E_CANTGET, FAIL, "can't get driver ID")
|
||
|
||
if(driver_id > 0) {
|
||
void *driver_info;
|
||
|
||
/* Retrieve driver info property */
|
||
if(H5P_get(plist, H5F_ACS_FILE_DRV_INFO_NAME, &driver_info) < 0)
|
||
HGOTO_ERROR(H5E_PLIST, H5E_CANTGET, FAIL, "can't get driver info")
|
||
|
||
/* Set the driver for the property list */
|
||
if(H5FD_fapl_open(plist, driver_id, driver_info) < 0)
|
||
HGOTO_ERROR(H5E_PLIST, H5E_CANTSET, FAIL, "can't set driver")
|
||
} /* end if */
|
||
|
||
done:
|
||
FUNC_LEAVE_NOAPI(ret_value)
|
||
} /* end H5P_facc_create() */
|
||
|
||
|
||
/*--------------------------------------------------------------------------
|
||
* Function: H5P_facc_copy
|
||
*
|
||
* Purpose: Callback routine which is called whenever a file access
|
||
* property list is copied. This routine performs any generic
|
||
* copy needed on the properties.
|
||
*
|
||
* Return: Success: Non-negative
|
||
* Failure: Negative
|
||
*
|
||
* Programmer: Raymond Lu
|
||
* Tuesday, Oct 23, 2001
|
||
*
|
||
*--------------------------------------------------------------------------
|
||
*/
|
||
/* ARGSUSED */
|
||
static herr_t
|
||
H5P_facc_copy(hid_t dst_fapl_id, hid_t src_fapl_id, void UNUSED *copy_data)
|
||
{
|
||
hid_t driver_id;
|
||
H5P_genplist_t *src_plist; /* Source property list */
|
||
herr_t ret_value = SUCCEED;
|
||
|
||
FUNC_ENTER_NOAPI_NOINIT(H5P_facc_copy)
|
||
|
||
/* Get driver ID from source property list */
|
||
if(NULL == (src_plist = H5I_object(src_fapl_id)))
|
||
HGOTO_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL, "can't get property list")
|
||
if(H5P_get(src_plist, H5F_ACS_FILE_DRV_ID_NAME, &driver_id) < 0)
|
||
HGOTO_ERROR(H5E_PLIST, H5E_CANTGET, FAIL, "can't get driver ID")
|
||
|
||
if(driver_id > 0) {
|
||
H5P_genplist_t *dst_plist; /* Destination property list */
|
||
void *driver_info;
|
||
|
||
/* Get driver info from source property list */
|
||
if(H5P_get(src_plist, H5F_ACS_FILE_DRV_INFO_NAME, &driver_info) < 0)
|
||
HGOTO_ERROR(H5E_PLIST, H5E_CANTGET, FAIL, "can't get driver info")
|
||
|
||
/* Set the driver for the destination property list */
|
||
if(NULL == (dst_plist = H5I_object(dst_fapl_id)))
|
||
HGOTO_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL, "can't get property list")
|
||
if(H5FD_fapl_open(dst_plist, driver_id, driver_info) < 0)
|
||
HGOTO_ERROR(H5E_PLIST, H5E_CANTSET, FAIL, "can't set driver")
|
||
} /* end if */
|
||
|
||
done:
|
||
FUNC_LEAVE_NOAPI(ret_value)
|
||
} /* end H5P_facc_copy() */
|
||
|
||
|
||
/*--------------------------------------------------------------------------
|
||
* Function: H5P_facc_close
|
||
*
|
||
* Purpose: Callback routine which is called whenever a file access
|
||
* property list is closed. This routine performs any generic
|
||
* cleanup needed on the properties.
|
||
*
|
||
* Return: Success: Non-negative
|
||
* Failure: Negative
|
||
*
|
||
* Programmer: Raymond Lu
|
||
* Tuesday, Oct 23, 2001
|
||
*
|
||
*---------------------------------------------------------------------------
|
||
*/
|
||
/* ARGSUSED */
|
||
herr_t
|
||
H5P_facc_close(hid_t fapl_id, void UNUSED *close_data)
|
||
{
|
||
hid_t driver_id;
|
||
H5P_genplist_t *plist; /* Property list */
|
||
herr_t ret_value = SUCCEED;
|
||
|
||
FUNC_ENTER_NOAPI(H5P_facc_close, FAIL)
|
||
|
||
/* Check argument */
|
||
if(NULL == (plist = H5I_object(fapl_id)))
|
||
HGOTO_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL, "not a property list")
|
||
|
||
/* Get driver ID property */
|
||
if(H5P_get(plist, H5F_ACS_FILE_DRV_ID_NAME, &driver_id) < 0)
|
||
HGOTO_DONE(FAIL) /* Can't return errors when library is shutting down */
|
||
|
||
if(driver_id > 0) {
|
||
void *driver_info;
|
||
|
||
/* Get driver info property */
|
||
if(H5P_get(plist, H5F_ACS_FILE_DRV_INFO_NAME, &driver_info) < 0)
|
||
HGOTO_DONE(FAIL) /* Can't return errors when library is shutting down */
|
||
|
||
/* Close the driver for the property list */
|
||
if(H5FD_fapl_close(driver_id, driver_info) < 0)
|
||
HGOTO_DONE(FAIL) /* Can't return errors when library is shutting down */
|
||
} /* end if */
|
||
|
||
done:
|
||
FUNC_LEAVE_NOAPI(ret_value)
|
||
} /* end H5P_facc_close() */
|
||
|
||
|
||
/*-------------------------------------------------------------------------
|
||
* 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:
|
||
*
|
||
* Raymond Lu
|
||
* Tuesday, Oct 23, 2001
|
||
* Changed file access property list mechanism to the new
|
||
* generic property list.
|
||
*-------------------------------------------------------------------------
|
||
*/
|
||
herr_t
|
||
H5Pset_alignment(hid_t fapl_id, hsize_t threshold, hsize_t alignment)
|
||
{
|
||
H5P_genplist_t *plist; /* Property list pointer */
|
||
herr_t ret_value=SUCCEED; /* return value */
|
||
|
||
FUNC_ENTER_API(H5Pset_alignment, FAIL);
|
||
H5TRACE3("e", "ihh", fapl_id, threshold, alignment);
|
||
|
||
/* Check args */
|
||
if (alignment<1)
|
||
HGOTO_ERROR (H5E_ARGS, H5E_BADVALUE, FAIL, "alignment must be positive");
|
||
|
||
/* Get the plist structure */
|
||
if(NULL == (plist = H5P_object_verify(fapl_id,H5P_FILE_ACCESS)))
|
||
HGOTO_ERROR(H5E_ATOM, H5E_BADATOM, FAIL, "can't find object for ID");
|
||
|
||
/* Set values */
|
||
if(H5P_set(plist, H5F_ACS_ALIGN_THRHD_NAME, &threshold) < 0)
|
||
HGOTO_ERROR(H5E_PLIST, H5E_CANTSET, FAIL, "can't set threshold");
|
||
if(H5P_set(plist, H5F_ACS_ALIGN_NAME, &alignment) < 0)
|
||
HGOTO_ERROR(H5E_PLIST, H5E_CANTSET, FAIL, "can't set alignment");
|
||
|
||
done:
|
||
FUNC_LEAVE_API(ret_value);
|
||
}
|
||
|
||
|
||
/*-------------------------------------------------------------------------
|
||
* 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:
|
||
*
|
||
* Raymond Lu
|
||
* Tuesday, Oct 23, 2001
|
||
* Changed the file access list design to the new generic
|
||
* property list.
|
||
*
|
||
*-------------------------------------------------------------------------
|
||
*/
|
||
herr_t
|
||
H5Pget_alignment(hid_t fapl_id, hsize_t *threshold/*out*/,
|
||
hsize_t *alignment/*out*/)
|
||
{
|
||
H5P_genplist_t *plist; /* Property list pointer */
|
||
herr_t ret_value=SUCCEED; /* Return value */
|
||
|
||
FUNC_ENTER_API(H5Pget_alignment, FAIL);
|
||
H5TRACE3("e", "ixx", fapl_id, threshold, alignment);
|
||
|
||
/* Get the plist structure */
|
||
if(NULL == (plist = H5P_object_verify(fapl_id,H5P_FILE_ACCESS)))
|
||
HGOTO_ERROR(H5E_ATOM, H5E_BADATOM, FAIL, "can't find object for ID");
|
||
|
||
/* Get values */
|
||
if (threshold)
|
||
if(H5P_get(plist, H5F_ACS_ALIGN_THRHD_NAME, threshold) < 0)
|
||
HGOTO_ERROR(H5E_PLIST, H5E_CANTGET, FAIL, "can't get threshold");
|
||
if (alignment)
|
||
if(H5P_get(plist, H5F_ACS_ALIGN_NAME, alignment) < 0)
|
||
HGOTO_ERROR(H5E_PLIST, H5E_CANTGET, FAIL, "can't get alignment");
|
||
|
||
done:
|
||
FUNC_LEAVE_API(ret_value);
|
||
}
|
||
|
||
|
||
/*-------------------------------------------------------------------------
|
||
* Function: H5P_set_driver
|
||
*
|
||
* Purpose: Set the file driver (DRIVER_ID) for a file access or data
|
||
* transfer property list (PLIST_ID) and supply an optional
|
||
* struct containing the driver-specific properites
|
||
* (DRIVER_INFO). The driver properties will be copied into the
|
||
* property list and the reference count on the driver will be
|
||
* incremented, allowing the caller to close the driver ID but
|
||
* still use the property list.
|
||
*
|
||
* Return: Success: Non-negative
|
||
*
|
||
* Failure: Negative
|
||
*
|
||
* Programmer: Robb Matzke
|
||
* Tuesday, August 3, 1999
|
||
*
|
||
* Modifications:
|
||
*
|
||
* Raymond Lu
|
||
* Tuesday, Oct 23, 2001
|
||
* Changed the file access list design to the new generic
|
||
* property list.
|
||
*
|
||
*-------------------------------------------------------------------------
|
||
*/
|
||
herr_t
|
||
H5P_set_driver(H5P_genplist_t *plist, hid_t new_driver_id, const void *new_driver_info)
|
||
{
|
||
hid_t driver_id; /* VFL driver ID */
|
||
void *driver_info; /* VFL driver info */
|
||
herr_t ret_value=SUCCEED; /* Return value */
|
||
|
||
FUNC_ENTER_NOAPI(H5P_set_driver, FAIL);
|
||
|
||
if (NULL==H5I_object_verify(new_driver_id, H5I_VFL))
|
||
HGOTO_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL, "not a file driver ID");
|
||
|
||
if( TRUE == H5P_isa_class(plist->plist_id, H5P_FILE_ACCESS) ) {
|
||
/* Get the current driver information */
|
||
if(H5P_get(plist, H5F_ACS_FILE_DRV_ID_NAME, &driver_id) < 0)
|
||
HGOTO_ERROR(H5E_PLIST, H5E_CANTGET, FAIL, "can't get driver ID");
|
||
if(H5P_get(plist, H5F_ACS_FILE_DRV_INFO_NAME, &driver_info) < 0)
|
||
HGOTO_ERROR(H5E_PLIST, H5E_CANTGET,FAIL,"can't get driver info");
|
||
|
||
/* Close the driver for the property list */
|
||
if(H5FD_fapl_close(driver_id, driver_info)<0)
|
||
HGOTO_ERROR(H5E_PLIST, H5E_CANTSET, FAIL, "can't reset driver")
|
||
|
||
/* Set the driver for the property list */
|
||
if(H5FD_fapl_open(plist, new_driver_id, new_driver_info)<0)
|
||
HGOTO_ERROR(H5E_PLIST, H5E_CANTSET, FAIL, "can't set driver")
|
||
} else if( TRUE == H5P_isa_class(plist->plist_id, H5P_DATASET_XFER) ) {
|
||
/* Get the current driver information */
|
||
if(H5P_get(plist, H5D_XFER_VFL_ID_NAME, &driver_id)<0)
|
||
HGOTO_ERROR (H5E_PLIST, H5E_CANTGET, FAIL, "can't retrieve VFL driver ID");
|
||
if(H5P_get(plist, H5D_XFER_VFL_INFO_NAME, &driver_info)<0)
|
||
HGOTO_ERROR (H5E_PLIST, H5E_CANTGET, FAIL, "can't retrieve VFL driver info");
|
||
|
||
/* Close the driver for the property list */
|
||
if(H5FD_dxpl_close(driver_id, driver_info)<0)
|
||
HGOTO_ERROR(H5E_PLIST, H5E_CANTSET, FAIL, "can't reset driver")
|
||
|
||
/* Set the driver for the property list */
|
||
if(H5FD_dxpl_open(plist, new_driver_id, new_driver_info)<0)
|
||
HGOTO_ERROR(H5E_PLIST, H5E_CANTSET, FAIL, "can't set driver")
|
||
} else {
|
||
HGOTO_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL, "not a file access or data transfer property list");
|
||
}
|
||
|
||
done:
|
||
FUNC_LEAVE_NOAPI(ret_value);
|
||
} /* end H5P_set_driver() */
|
||
|
||
|
||
/*-------------------------------------------------------------------------
|
||
* Function: H5Pset_driver
|
||
*
|
||
* Purpose: Set the file driver (DRIVER_ID) for a file access or data
|
||
* transfer property list (PLIST_ID) and supply an optional
|
||
* struct containing the driver-specific properites
|
||
* (DRIVER_INFO). The driver properties will be copied into the
|
||
* property list and the reference count on the driver will be
|
||
* incremented, allowing the caller to close the driver ID but
|
||
* still use the property list.
|
||
*
|
||
* Return: Success: Non-negative
|
||
*
|
||
* Failure: Negative
|
||
*
|
||
* Programmer: Robb Matzke
|
||
* Tuesday, August 3, 1999
|
||
*
|
||
* Modifications:
|
||
*
|
||
* Raymond Lu
|
||
* Tuesday, Oct 23, 2001
|
||
* Changed the file access list design to the new generic
|
||
* property list.
|
||
*
|
||
*-------------------------------------------------------------------------
|
||
*/
|
||
herr_t
|
||
H5Pset_driver(hid_t plist_id, hid_t new_driver_id, const void *new_driver_info)
|
||
{
|
||
H5P_genplist_t *plist; /* Property list pointer */
|
||
herr_t ret_value=SUCCEED; /* Return value */
|
||
|
||
FUNC_ENTER_API(H5Pset_driver, FAIL);
|
||
H5TRACE3("e", "iix", plist_id, new_driver_id, new_driver_info);
|
||
|
||
/* Check arguments */
|
||
if(NULL == (plist = H5I_object_verify(plist_id, H5I_GENPROP_LST)))
|
||
HGOTO_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL, "not a property list");
|
||
if (NULL==H5I_object_verify(new_driver_id, H5I_VFL))
|
||
HGOTO_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL, "not a file driver ID");
|
||
|
||
/* Set the driver */
|
||
if(H5P_set_driver(plist,new_driver_id,new_driver_info)<0)
|
||
HGOTO_ERROR(H5E_PLIST, H5E_CANTSET, FAIL, "can't set driver info");
|
||
|
||
done:
|
||
FUNC_LEAVE_API(ret_value);
|
||
} /* end H5Pset_driver() */
|
||
|
||
|
||
/*-------------------------------------------------------------------------
|
||
* Function: H5P_get_driver
|
||
*
|
||
* Purpose: Return the ID of the low-level file driver. PLIST_ID should
|
||
* be a file access property list or data transfer propert list.
|
||
*
|
||
* Return: Success: A low-level driver ID which is the same ID
|
||
* used when the driver was set for the property
|
||
* list. The driver ID is only valid as long as
|
||
* the file driver remains registered.
|
||
*
|
||
* Failure: Negative
|
||
*
|
||
* Programmer: Robb Matzke
|
||
* Thursday, February 26, 1998
|
||
*
|
||
* Modifications:
|
||
* Robb Matzke, 1999-08-03
|
||
* Rewritten to use the virtual file layer.
|
||
*
|
||
* Robb Matzke, 1999-08-05
|
||
* If the driver ID is H5FD_VFD_DEFAULT then substitute the
|
||
* current value of H5FD_SEC2.
|
||
*
|
||
* Quincey Koziol 2000-11-28
|
||
* Added internal function..
|
||
*
|
||
* Raymond Lu, 2001-10-23
|
||
* Changed the file access list design to the new generic
|
||
* property list.
|
||
*
|
||
*-------------------------------------------------------------------------
|
||
*/
|
||
hid_t
|
||
H5P_get_driver(H5P_genplist_t *plist)
|
||
{
|
||
hid_t ret_value=FAIL; /* Return value */
|
||
|
||
FUNC_ENTER_NOAPI(H5P_get_driver, FAIL);
|
||
|
||
/* Get the current driver ID */
|
||
if(TRUE == H5P_isa_class(plist->plist_id, H5P_FILE_ACCESS) ) {
|
||
if(H5P_get(plist, H5F_ACS_FILE_DRV_ID_NAME, &ret_value) < 0)
|
||
HGOTO_ERROR(H5E_PLIST, H5E_CANTGET, FAIL, "can't get driver ID");
|
||
} else if( TRUE == H5P_isa_class(plist->plist_id, H5P_DATASET_XFER) ) {
|
||
if(H5P_get(plist, H5D_XFER_VFL_ID_NAME, &ret_value)<0)
|
||
HGOTO_ERROR (H5E_PLIST, H5E_CANTGET, FAIL, "Can't retrieve VFL driver ID");
|
||
} else {
|
||
HGOTO_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL, "not a file access or data transfer property list");
|
||
}
|
||
|
||
if (H5FD_VFD_DEFAULT==ret_value)
|
||
ret_value = H5FD_SEC2;
|
||
|
||
done:
|
||
FUNC_LEAVE_NOAPI(ret_value);
|
||
}
|
||
|
||
|
||
/*-------------------------------------------------------------------------
|
||
* Function: H5Pget_driver
|
||
*
|
||
* Purpose: Return the ID of the low-level file driver. PLIST_ID should
|
||
* be a file access property list or data transfer propert list.
|
||
*
|
||
* Return: Success: A low-level driver ID which is the same ID
|
||
* used when the driver was set for the property
|
||
* list. The driver ID is only valid as long as
|
||
* the file driver remains registered.
|
||
*
|
||
* Failure: Negative
|
||
*
|
||
* Programmer: Robb Matzke
|
||
* Thursday, February 26, 1998
|
||
*
|
||
* Modifications:
|
||
* Robb Matzke, 1999-08-03
|
||
* Rewritten to use the virtual file layer.
|
||
*
|
||
* Robb Matzke, 1999-08-05
|
||
* If the driver ID is H5FD_VFD_DEFAULT then substitute the current value of
|
||
* H5FD_SEC2.
|
||
*
|
||
* Quincey Koziol 2000-11-28
|
||
* Added internal function..
|
||
*-------------------------------------------------------------------------
|
||
*/
|
||
hid_t
|
||
H5Pget_driver(hid_t plist_id)
|
||
{
|
||
H5P_genplist_t *plist; /* Property list pointer */
|
||
hid_t ret_value; /* Return value */
|
||
|
||
FUNC_ENTER_API(H5Pget_driver, FAIL);
|
||
H5TRACE1("i", "i", plist_id);
|
||
|
||
if(NULL == (plist = H5I_object_verify(plist_id, H5I_GENPROP_LST)))
|
||
HGOTO_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL, "not a property list");
|
||
|
||
ret_value = H5P_get_driver(plist);
|
||
|
||
done:
|
||
FUNC_LEAVE_API(ret_value);
|
||
}
|
||
|
||
|
||
/*-------------------------------------------------------------------------
|
||
* Function: H5P_get_driver_info
|
||
*
|
||
* Purpose: Returns a pointer directly to the file driver-specific
|
||
* information of a file access or data transfer property list.
|
||
*
|
||
* Return: Success: Ptr to *uncopied* driver specific data
|
||
* structure if any.
|
||
*
|
||
* Failure: NULL. Null is also returned if the driver has
|
||
* not registered any driver-specific properties
|
||
* although no error is pushed on the stack in
|
||
* this case.
|
||
*
|
||
* Programmer: Robb Matzke
|
||
* Wednesday, August 4, 1999
|
||
*
|
||
* Modifications:
|
||
*
|
||
* Raymond Lu
|
||
* Tuesday, Oct 23, 2001
|
||
* Changed the file access list design to the new generic
|
||
* property list.
|
||
*
|
||
*-------------------------------------------------------------------------
|
||
*/
|
||
void *
|
||
H5P_get_driver_info(H5P_genplist_t *plist)
|
||
{
|
||
void *ret_value=NULL;
|
||
|
||
FUNC_ENTER_NOAPI(H5P_get_driver_info, NULL);
|
||
|
||
/* Get the current driver info */
|
||
if( TRUE == H5P_isa_class(plist->plist_id, H5P_FILE_ACCESS) ) {
|
||
if(H5P_get(plist, H5F_ACS_FILE_DRV_INFO_NAME, &ret_value) < 0)
|
||
HGOTO_ERROR(H5E_PLIST, H5E_CANTGET,NULL,"can't get driver info");
|
||
} else if( TRUE == H5P_isa_class(plist->plist_id, H5P_DATASET_XFER) ) {
|
||
if(H5P_get(plist, H5D_XFER_VFL_INFO_NAME, &ret_value)<0)
|
||
HGOTO_ERROR (H5E_PLIST, H5E_CANTGET, NULL, "Can't retrieve VFL driver ID");
|
||
} else {
|
||
HGOTO_ERROR(H5E_ARGS, H5E_BADTYPE, NULL, "not a file access or data transfer property list");
|
||
}
|
||
|
||
done:
|
||
FUNC_LEAVE_NOAPI(ret_value);
|
||
} /* end H5P_get_driver_info() */
|
||
|
||
|
||
/*-------------------------------------------------------------------------
|
||
* Function: H5Pget_driver_info
|
||
*
|
||
* Purpose: Returns a pointer directly to the file driver-specific
|
||
* information of a file access or data transfer property list.
|
||
*
|
||
* Return: Success: Ptr to *uncopied* driver specific data
|
||
* structure if any.
|
||
*
|
||
* Failure: NULL. Null is also returned if the driver has
|
||
* not registered any driver-specific properties
|
||
* although no error is pushed on the stack in
|
||
* this case.
|
||
*
|
||
* Programmer: Robb Matzke
|
||
* Wednesday, August 4, 1999
|
||
*
|
||
* Modifications:
|
||
*
|
||
* Raymond Lu
|
||
* Tuesday, Oct 23, 2001
|
||
* Changed the file access list design to the new generic
|
||
* property list.
|
||
*
|
||
*-------------------------------------------------------------------------
|
||
*/
|
||
void *
|
||
H5Pget_driver_info(hid_t plist_id)
|
||
{
|
||
H5P_genplist_t *plist; /* Property list pointer */
|
||
void *ret_value; /* Return value */
|
||
|
||
FUNC_ENTER_API(H5Pget_driver_info, NULL);
|
||
|
||
if(NULL == (plist = H5I_object_verify(plist_id, H5I_GENPROP_LST)))
|
||
HGOTO_ERROR(H5E_ARGS, H5E_BADTYPE, NULL, "not a property list");
|
||
|
||
if((ret_value=H5P_get_driver_info(plist))==NULL)
|
||
HGOTO_ERROR(H5E_PLIST,H5E_CANTGET,NULL,"can't get driver info");
|
||
|
||
done:
|
||
FUNC_LEAVE_API(ret_value);
|
||
} /* end H5Pget_driver_info() */
|
||
|
||
|
||
/*-------------------------------------------------------------------------
|
||
* Function: H5Pset_family_offset
|
||
*
|
||
* Purpose: Set offset for family driver. This file access property
|
||
* list will be passed to H5Fget_vfd_handle or H5FDget_vfd_handle
|
||
* to retrieve VFD file handle.
|
||
*
|
||
* Return: Success: Non-negative value.
|
||
*
|
||
* Failure: Negative value.
|
||
*
|
||
* Programmer: Raymond Lu
|
||
* Sep 17, 2002
|
||
*
|
||
* Modifications:
|
||
*
|
||
*-------------------------------------------------------------------------
|
||
*/
|
||
herr_t
|
||
H5Pset_family_offset(hid_t fapl_id, hsize_t offset)
|
||
{
|
||
H5P_genplist_t *plist; /* Property list pointer */
|
||
herr_t ret_value=SUCCEED; /* return value */
|
||
|
||
FUNC_ENTER_API(H5Pset_family_offset, FAIL);
|
||
H5TRACE2("e", "ih", fapl_id, offset);
|
||
|
||
/* Get the plist structure */
|
||
if(H5P_DEFAULT == fapl_id)
|
||
HGOTO_ERROR(H5E_ARGS, H5E_BADVALUE, FAIL, "can't modify default property list");
|
||
if(NULL == (plist = H5P_object_verify(fapl_id,H5P_FILE_ACCESS)))
|
||
HGOTO_ERROR(H5E_ATOM, H5E_BADATOM, FAIL, "can't find object for ID");
|
||
/* Set values */
|
||
if((ret_value=H5P_set_family_offset(plist, offset)) < 0)
|
||
HGOTO_ERROR(H5E_PLIST, H5E_CANTSET, FAIL, "can't set family offset");
|
||
|
||
done:
|
||
FUNC_LEAVE_API(ret_value);
|
||
}
|
||
|
||
|
||
/*-------------------------------------------------------------------------
|
||
* Function: H5P_set_family_offset
|
||
*
|
||
* Purpose: Set offset for family driver. Private function for
|
||
* H5Pset_family_offset
|
||
*
|
||
* Return: Success: Non-negative value.
|
||
*
|
||
* Failure: Negative value.
|
||
*
|
||
* Programmer: Raymond Lu
|
||
* Sep 17, 2002
|
||
*
|
||
* Modifications:
|
||
*
|
||
*-------------------------------------------------------------------------
|
||
*/
|
||
static herr_t
|
||
H5P_set_family_offset(H5P_genplist_t *plist, hsize_t offset)
|
||
{
|
||
herr_t ret_value=SUCCEED;
|
||
|
||
FUNC_ENTER_NOAPI(H5P_set_family_offset, FAIL);
|
||
|
||
if( TRUE == H5P_isa_class(plist->plist_id, H5P_FILE_ACCESS) ) {
|
||
if(H5P_set(plist, H5F_ACS_FAMILY_OFFSET_NAME, &offset) < 0)
|
||
HGOTO_ERROR(H5E_PLIST, H5E_CANTSET,FAIL,"can't set offset for family file");
|
||
} else {
|
||
HGOTO_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL, "not a file access or data transfer property list");
|
||
}
|
||
|
||
done:
|
||
FUNC_LEAVE_NOAPI(ret_value);
|
||
}
|
||
|
||
|
||
/*-------------------------------------------------------------------------
|
||
* Function: H5Pget_family_offset
|
||
*
|
||
* Purpose: Get offset for family driver. This file access property
|
||
* list will be passed to H5Fget_vfd_handle or H5FDget_vfd_handle
|
||
* to retrieve VFD file handle.
|
||
*
|
||
* Return: Success: Non-negative value.
|
||
*
|
||
* Failure: Negative value.
|
||
*
|
||
* Programmer: Raymond Lu
|
||
* Sep 17, 2002
|
||
*
|
||
* Modifications:
|
||
*
|
||
*-------------------------------------------------------------------------
|
||
*/
|
||
herr_t
|
||
H5Pget_family_offset(hid_t fapl_id, hsize_t *offset)
|
||
{
|
||
H5P_genplist_t *plist; /* Property list pointer */
|
||
herr_t ret_value=SUCCEED; /* return value */
|
||
|
||
FUNC_ENTER_API(H5Pget_family_offset, FAIL);
|
||
H5TRACE2("e", "i*h", fapl_id, offset);
|
||
|
||
/* Get the plist structure */
|
||
if(H5P_DEFAULT == fapl_id)
|
||
HGOTO_ERROR(H5E_ARGS, H5E_BADVALUE, FAIL, "can't modify default property list");
|
||
if(NULL == (plist = H5P_object_verify(fapl_id,H5P_FILE_ACCESS)))
|
||
HGOTO_ERROR(H5E_ATOM, H5E_BADATOM, FAIL, "can't find object for ID");
|
||
/* Set values */
|
||
if((ret_value=H5P_get_family_offset(plist, offset)) < 0)
|
||
HGOTO_ERROR(H5E_PLIST, H5E_CANTSET, FAIL, "can't get family offset");
|
||
|
||
done:
|
||
FUNC_LEAVE_API(ret_value);
|
||
}
|
||
|
||
|
||
/*-------------------------------------------------------------------------
|
||
* Function: H5P_get_family_offset
|
||
*
|
||
* Purpose: Get offset for family driver. Private function for
|
||
* H5Pget_family_offset
|
||
*
|
||
* Return: Success: Non-negative value.
|
||
*
|
||
* Failure: Negative value.
|
||
*
|
||
* Programmer: Raymond Lu
|
||
* Sep 17, 2002
|
||
*
|
||
* Modifications:
|
||
*
|
||
*-------------------------------------------------------------------------
|
||
*/
|
||
static herr_t
|
||
H5P_get_family_offset(H5P_genplist_t *plist, hsize_t *offset)
|
||
{
|
||
herr_t ret_value=SUCCEED;
|
||
|
||
FUNC_ENTER_NOAPI(H5P_get_family_offset, FAIL);
|
||
|
||
if( TRUE == H5P_isa_class(plist->plist_id, H5P_FILE_ACCESS) ) {
|
||
if(H5P_get(plist, H5F_ACS_FAMILY_OFFSET_NAME, offset) < 0)
|
||
HGOTO_ERROR(H5E_PLIST, H5E_CANTSET,FAIL,"can't set offset for family file");
|
||
} else {
|
||
HGOTO_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL, "not a file access or data transfer property list");
|
||
}
|
||
|
||
done:
|
||
FUNC_LEAVE_NOAPI(ret_value);
|
||
}
|
||
|
||
|
||
/*-------------------------------------------------------------------------
|
||
* Function: H5Pset_multi_type
|
||
*
|
||
* Purpose: Set data type for multi driver. This file access property
|
||
* list will be passed to H5Fget_vfd_handle or H5FDget_vfd_handle
|
||
* to retrieve VFD file handle.
|
||
*
|
||
* Return: Success: Non-negative value.
|
||
*
|
||
* Failure: Negative value.
|
||
*
|
||
* Programmer: Raymond Lu
|
||
* Sep 17, 2002
|
||
*
|
||
* Modifications:
|
||
*
|
||
*-------------------------------------------------------------------------
|
||
*/
|
||
herr_t
|
||
H5Pset_multi_type(hid_t fapl_id, H5FD_mem_t type)
|
||
{
|
||
H5P_genplist_t *plist; /* Property list pointer */
|
||
herr_t ret_value=SUCCEED; /* return value */
|
||
|
||
FUNC_ENTER_API(H5Pset_multi_type, FAIL);
|
||
H5TRACE2("e", "iMt", fapl_id, type);
|
||
|
||
/* Get the plist structure */
|
||
if(H5P_DEFAULT == fapl_id)
|
||
HGOTO_ERROR(H5E_ARGS, H5E_BADVALUE, FAIL, "can't modify default property list");
|
||
if(NULL == (plist = H5P_object_verify(fapl_id,H5P_FILE_ACCESS)))
|
||
HGOTO_ERROR(H5E_ATOM, H5E_BADATOM, FAIL, "can't find object for ID");
|
||
/* Set values */
|
||
if((ret_value=H5P_set_multi_type(plist, type)) < 0)
|
||
HGOTO_ERROR(H5E_PLIST, H5E_CANTSET, FAIL, "can't set data type for multi driver");
|
||
|
||
done:
|
||
FUNC_LEAVE_API(ret_value);
|
||
}
|
||
|
||
|
||
/*-------------------------------------------------------------------------
|
||
* Function: H5P_set_multi_type
|
||
*
|
||
* Purpose: Set data type for multi file driver. Private function for
|
||
* H5Pset_multi_type.
|
||
*
|
||
* Return: Success: Non-negative value.
|
||
*
|
||
* Failure: Negative value.
|
||
*
|
||
* Programmer: Raymond Lu
|
||
* Sep 17, 2002
|
||
*
|
||
* Modifications:
|
||
*
|
||
*-------------------------------------------------------------------------
|
||
*/
|
||
static herr_t
|
||
H5P_set_multi_type(H5P_genplist_t *plist, H5FD_mem_t type)
|
||
{
|
||
herr_t ret_value=SUCCEED;
|
||
|
||
FUNC_ENTER_NOAPI(H5P_set_multi_type, FAIL);
|
||
|
||
if( TRUE == H5P_isa_class(plist->plist_id, H5P_FILE_ACCESS) ) {
|
||
if(H5P_set(plist, H5F_ACS_MULTI_TYPE_NAME, &type) < 0)
|
||
HGOTO_ERROR(H5E_PLIST, H5E_CANTSET,FAIL,"can't set type for multi driver");
|
||
} else {
|
||
HGOTO_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL, "not a file access or data transfer property list");
|
||
}
|
||
|
||
done:
|
||
FUNC_LEAVE_NOAPI(ret_value);
|
||
}
|
||
|
||
|
||
/*-------------------------------------------------------------------------
|
||
* Function: H5Pget_multi_type
|
||
*
|
||
* Purpose: Get data type for multi driver. This file access property
|
||
* list will be passed to H5Fget_vfd_handle or H5FDget_vfd_handle
|
||
* to retrieve VFD file handle.
|
||
*
|
||
* Return: Success: Non-negative value.
|
||
*
|
||
* Failure: Negative value.
|
||
*
|
||
* Programmer: Raymond Lu
|
||
* Sep 17, 2002
|
||
*
|
||
* Modifications:
|
||
*
|
||
*-------------------------------------------------------------------------
|
||
*/
|
||
herr_t
|
||
H5Pget_multi_type(hid_t fapl_id, H5FD_mem_t *type)
|
||
{
|
||
H5P_genplist_t *plist; /* Property list pointer */
|
||
herr_t ret_value=SUCCEED; /* return value */
|
||
|
||
FUNC_ENTER_API(H5Pget_multi_type, FAIL);
|
||
H5TRACE2("e", "i*Mt", fapl_id, type);
|
||
|
||
/* Get the plist structure */
|
||
if(H5P_DEFAULT == fapl_id)
|
||
HGOTO_ERROR(H5E_ARGS, H5E_BADVALUE, FAIL, "can't modify default property list");
|
||
if(NULL == (plist = H5P_object_verify(fapl_id,H5P_FILE_ACCESS)))
|
||
HGOTO_ERROR(H5E_ATOM, H5E_BADATOM, FAIL, "can't find object for ID");
|
||
/* Set values */
|
||
if((ret_value=H5P_get_multi_type(plist, type)) < 0)
|
||
HGOTO_ERROR(H5E_PLIST, H5E_CANTSET, FAIL, "can't get data type for multi driver");
|
||
|
||
done:
|
||
FUNC_LEAVE_API(ret_value);
|
||
}
|
||
|
||
|
||
/*-------------------------------------------------------------------------
|
||
* Function: H5P_get_multi_type
|
||
*
|
||
* Purpose: Get data type for multi file driver. Private function for
|
||
* H5Pget_multi_type.
|
||
*
|
||
* Return: Success: Non-negative value.
|
||
*
|
||
* Failure: Negative value.
|
||
*
|
||
* Programmer: Raymond Lu
|
||
* Sep 17, 2002
|
||
*
|
||
* Modifications:
|
||
*
|
||
*-------------------------------------------------------------------------
|
||
*/
|
||
static herr_t
|
||
H5P_get_multi_type(H5P_genplist_t *plist, H5FD_mem_t *type)
|
||
{
|
||
herr_t ret_value=SUCCEED;
|
||
|
||
FUNC_ENTER_NOAPI(H5P_get_multi_type, FAIL);
|
||
|
||
if( TRUE == H5P_isa_class(plist->plist_id, H5P_FILE_ACCESS) ) {
|
||
if(H5P_get(plist, H5F_ACS_MULTI_TYPE_NAME, type) < 0)
|
||
HGOTO_ERROR(H5E_PLIST, H5E_CANTSET,FAIL,"can't get type for multi driver");
|
||
} else {
|
||
HGOTO_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL, "not a file access property list");
|
||
}
|
||
|
||
done:
|
||
FUNC_LEAVE_NOAPI(ret_value);
|
||
}
|
||
|
||
|
||
/*-------------------------------------------------------------------------
|
||
* 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:
|
||
*
|
||
* Raymond Lu
|
||
* Tuesday, Oct 23, 2001
|
||
* Changed the file access list to the new generic property list.
|
||
*
|
||
* J. Mainzer
|
||
* Thurs. 3/17/05
|
||
* The mdc_nelmts entry is no more in the FAPL, so I modified
|
||
* the code to ignore it.
|
||
*
|
||
*-------------------------------------------------------------------------
|
||
*/
|
||
herr_t
|
||
H5Pset_cache(hid_t plist_id, int UNUSED mdc_nelmts,
|
||
size_t rdcc_nelmts, size_t rdcc_nbytes, double rdcc_w0)
|
||
{
|
||
H5P_genplist_t *plist; /* Property list pointer */
|
||
herr_t ret_value=SUCCEED; /* return value */
|
||
|
||
FUNC_ENTER_API(H5Pset_cache, FAIL);
|
||
H5TRACE5("e", "iIszzd", plist_id, mdc_nelmts, rdcc_nelmts, rdcc_nbytes,
|
||
rdcc_w0);
|
||
|
||
/* Check arguments */
|
||
if (rdcc_w0<0.0 || rdcc_w0>1.0)
|
||
HGOTO_ERROR (H5E_ARGS, H5E_BADVALUE, FAIL, "raw data cache w0 value must be between 0.0 and 1.0 inclusive");
|
||
|
||
/* Get the plist structure */
|
||
if(NULL == (plist = H5P_object_verify(plist_id,H5P_FILE_ACCESS)))
|
||
HGOTO_ERROR(H5E_ATOM, H5E_BADATOM, FAIL, "can't find object for ID");
|
||
|
||
/* Set sizes */
|
||
if(H5P_set(plist, H5F_ACS_DATA_CACHE_ELMT_SIZE_NAME, &rdcc_nelmts) < 0)
|
||
HGOTO_ERROR(H5E_PLIST, H5E_CANTSET,FAIL, "can't set data cache element size");
|
||
if(H5P_set(plist, H5F_ACS_DATA_CACHE_BYTE_SIZE_NAME, &rdcc_nbytes) < 0)
|
||
HGOTO_ERROR(H5E_PLIST, H5E_CANTSET,FAIL, "can't set data cache byte size");
|
||
if(H5P_set(plist, H5F_ACS_PREEMPT_READ_CHUNKS_NAME, &rdcc_w0) < 0)
|
||
HGOTO_ERROR(H5E_PLIST, H5E_CANTSET,FAIL, "can't set preempt read chunks");
|
||
|
||
done:
|
||
FUNC_LEAVE_API(ret_value);
|
||
}
|
||
|
||
|
||
/*-------------------------------------------------------------------------
|
||
* 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:
|
||
*
|
||
* Raymond Lu
|
||
* Tuesday, Oct 23, 2001
|
||
* Changed the file access list to the new generic property
|
||
* list.
|
||
*
|
||
* J Mainzer
|
||
* Thurs, 3/17/05
|
||
* The mdc_nelmts fapl entry is no more, so we now just
|
||
* return a constant when that value is requested.
|
||
*
|
||
*-------------------------------------------------------------------------
|
||
*/
|
||
herr_t
|
||
H5Pget_cache(hid_t plist_id, int *mdc_nelmts,
|
||
size_t *rdcc_nelmts, size_t *rdcc_nbytes, double *rdcc_w0)
|
||
{
|
||
H5P_genplist_t *plist; /* Property list pointer */
|
||
herr_t ret_value=SUCCEED; /* return value */
|
||
|
||
FUNC_ENTER_API(H5Pget_cache, FAIL);
|
||
H5TRACE5("e", "i*Is*z*z*d", plist_id, mdc_nelmts, rdcc_nelmts, rdcc_nbytes,
|
||
rdcc_w0);
|
||
|
||
/* Get the plist structure */
|
||
if(NULL == (plist = H5P_object_verify(plist_id,H5P_FILE_ACCESS)))
|
||
HGOTO_ERROR(H5E_ATOM, H5E_BADATOM, FAIL, "can't find object for ID");
|
||
|
||
/* Get sizes */
|
||
|
||
/* the mdc_nelmts FAPL entry no longer exists, so just return a constant */
|
||
if (mdc_nelmts)
|
||
*mdc_nelmts = 0;
|
||
|
||
if (rdcc_nelmts)
|
||
if(H5P_get(plist, H5F_ACS_DATA_CACHE_ELMT_SIZE_NAME, rdcc_nelmts) < 0)
|
||
HGOTO_ERROR(H5E_PLIST, H5E_CANTGET,FAIL, "can't get data cache element size");
|
||
if (rdcc_nbytes)
|
||
if(H5P_get(plist, H5F_ACS_DATA_CACHE_BYTE_SIZE_NAME, rdcc_nbytes) < 0)
|
||
HGOTO_ERROR(H5E_PLIST, H5E_CANTGET,FAIL, "can't get data cache byte size");
|
||
if (rdcc_w0)
|
||
if(H5P_get(plist, H5F_ACS_PREEMPT_READ_CHUNKS_NAME, rdcc_w0) < 0)
|
||
HGOTO_ERROR(H5E_PLIST, H5E_CANTGET,FAIL, "can't get preempt read chunks");
|
||
|
||
done:
|
||
FUNC_LEAVE_API(ret_value);
|
||
}
|
||
|
||
|
||
/*-------------------------------------------------------------------------
|
||
* Function: H5Pset_mdc_config
|
||
*
|
||
* Purpose: Set the initial metadata cache resize configuration in the
|
||
* target FAPL.
|
||
*
|
||
* Return: Non-negative on success/Negative on failure
|
||
*
|
||
* Programmer: J. Mainzer
|
||
* Thursday, April 7, 2005
|
||
*
|
||
* Modifications:
|
||
*
|
||
* Done.
|
||
*
|
||
*-------------------------------------------------------------------------
|
||
*/
|
||
herr_t
|
||
H5Pset_mdc_config(hid_t plist_id,
|
||
H5AC_cache_config_t *config_ptr)
|
||
{
|
||
H5P_genplist_t *plist; /* Property list pointer */
|
||
herr_t ret_value=SUCCEED; /* return value */
|
||
|
||
FUNC_ENTER_API(H5Pset_mdc_config, FAIL);
|
||
H5TRACE2("e", "ix", plist_id, config_ptr);
|
||
|
||
/* Get the plist structure */
|
||
if( NULL == ( plist = H5P_object_verify(plist_id,H5P_FILE_ACCESS) ) ) {
|
||
|
||
HGOTO_ERROR(H5E_ATOM, H5E_BADATOM, FAIL, "can't find object for ID");
|
||
}
|
||
|
||
/* validate the new configuration */
|
||
if ( H5AC_validate_config(config_ptr) < 0 ) {
|
||
|
||
HGOTO_ERROR(H5E_ARGS, H5E_BADVALUE, FAIL, \
|
||
"invalid metadata cache configuration");
|
||
}
|
||
|
||
/* set the modified config */
|
||
|
||
/* If we ever support multiple versions of H5AC_cache_config_t, we
|
||
* will have to test the version and do translation here.
|
||
*/
|
||
|
||
if(H5P_set(plist, H5F_ACS_META_CACHE_INIT_CONFIG_NAME, config_ptr)<0) {
|
||
|
||
HGOTO_ERROR(H5E_PLIST, H5E_CANTSET, FAIL, \
|
||
"can't set metadata cache initial config");
|
||
}
|
||
|
||
done:
|
||
|
||
FUNC_LEAVE_API(ret_value);
|
||
|
||
} /* H5Pset_mdc_config() */
|
||
|
||
|
||
/*-------------------------------------------------------------------------
|
||
* Function: H5Pget_mdc_config
|
||
*
|
||
* Purpose: Retrieve the metadata cache initial resize configuration
|
||
* from the target FAPL.
|
||
*
|
||
* Observe that the function will fail if config_ptr is
|
||
* NULL, or if config_ptr->version specifies an unknown
|
||
* version of H5AC_cache_config_t.
|
||
*
|
||
* Return: Non-negative on success/Negative on failure
|
||
*
|
||
* Programmer: J. Mainzer
|
||
* Thursday, April 7, 2005
|
||
*
|
||
* Modifications:
|
||
*
|
||
* None.
|
||
*
|
||
*-------------------------------------------------------------------------
|
||
*/
|
||
|
||
herr_t
|
||
H5Pget_mdc_config(hid_t plist_id,
|
||
H5AC_cache_config_t *config_ptr)
|
||
{
|
||
H5P_genplist_t *plist; /* Property list pointer */
|
||
herr_t ret_value = SUCCEED; /* return value */
|
||
|
||
FUNC_ENTER_API(H5Pget_mdc_config, FAIL);
|
||
H5TRACE2("e", "ix", plist_id, config_ptr);
|
||
|
||
/* Get the plist structure */
|
||
if ( NULL == (plist = H5P_object_verify(plist_id,H5P_FILE_ACCESS)) ) {
|
||
|
||
HGOTO_ERROR(H5E_ATOM, H5E_BADATOM, FAIL, "can't find object for ID");
|
||
}
|
||
|
||
/* validate the config_ptr */
|
||
if ( config_ptr == NULL ) {
|
||
|
||
HGOTO_ERROR(H5E_ARGS, H5E_BADVALUE, FAIL, "NULL config_ptr on entry.")
|
||
}
|
||
|
||
if ( config_ptr->version != H5AC__CURR_CACHE_CONFIG_VERSION ) {
|
||
|
||
HGOTO_ERROR(H5E_ARGS, H5E_BADVALUE, FAIL, "Unknown config version.")
|
||
}
|
||
|
||
/* If we ever support multiple versions of H5AC_cache_config_t, we
|
||
* will have to get the cannonical version here, and then translate
|
||
* to the version of the structure supplied.
|
||
*/
|
||
|
||
/* Get the current initial metadata cache resize configuration */
|
||
if ( H5P_get(plist, H5F_ACS_META_CACHE_INIT_CONFIG_NAME, config_ptr) < 0 ) {
|
||
|
||
HGOTO_ERROR(H5E_PLIST, H5E_CANTGET,FAIL, \
|
||
"can't get metadata cache initial resize config");
|
||
}
|
||
|
||
done:
|
||
|
||
FUNC_LEAVE_API(ret_value);
|
||
|
||
} /* H5Pget_mdc_config() */
|
||
|
||
|
||
/*-------------------------------------------------------------------------
|
||
* 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
|
||
* June, 1999
|
||
*
|
||
* Modifications:
|
||
*
|
||
* Raymond Lu
|
||
* Tuesday, Oct 23, 2001
|
||
* Changed the file access list to the new generic property
|
||
* list.
|
||
*
|
||
*-------------------------------------------------------------------------
|
||
*/
|
||
herr_t
|
||
H5Pset_gc_references(hid_t plist_id, unsigned gc_ref)
|
||
{
|
||
H5P_genplist_t *plist; /* Property list pointer */
|
||
herr_t ret_value=SUCCEED; /* return value */
|
||
|
||
FUNC_ENTER_API(H5Pset_gc_references, FAIL);
|
||
H5TRACE2("e", "iIu", plist_id, gc_ref);
|
||
|
||
/* Get the plist structure */
|
||
if(NULL == (plist = H5P_object_verify(plist_id,H5P_FILE_ACCESS)))
|
||
HGOTO_ERROR(H5E_ATOM, H5E_BADATOM, FAIL, "can't find object for ID");
|
||
|
||
/* Set values */
|
||
if(H5P_set(plist, H5F_ACS_GARBG_COLCT_REF_NAME, &gc_ref) < 0)
|
||
HGOTO_ERROR(H5E_PLIST, H5E_CANTSET, FAIL, "can't set garbage collect reference");
|
||
|
||
done:
|
||
FUNC_LEAVE_API(ret_value);
|
||
}
|
||
|
||
|
||
/*-------------------------------------------------------------------------
|
||
* Function: H5Pget_gc_references
|
||
*
|
||
* Purpose: Returns the current setting for the garbage collection
|
||
* references property from a file access property list.
|
||
*
|
||
* Return: Non-negative on success/Negative on failure
|
||
*
|
||
* Programmer: Quincey Koziol
|
||
* June, 1999
|
||
*
|
||
* Modifications:
|
||
*
|
||
* Raymond Lu
|
||
* Tuesday, Oct 23, 2001
|
||
* Changed the file access list to the new generic property
|
||
* list.
|
||
*
|
||
*-------------------------------------------------------------------------
|
||
*/
|
||
herr_t
|
||
H5Pget_gc_references(hid_t plist_id, unsigned *gc_ref/*out*/)
|
||
{
|
||
H5P_genplist_t *plist; /* Property list pointer */
|
||
herr_t ret_value=SUCCEED; /* return value */
|
||
|
||
FUNC_ENTER_API(H5Pget_gc_references, FAIL);
|
||
H5TRACE2("e", "ix", plist_id, gc_ref);
|
||
|
||
/* Get the plist structure */
|
||
if(NULL == (plist = H5P_object_verify(plist_id,H5P_FILE_ACCESS)))
|
||
HGOTO_ERROR(H5E_ATOM, H5E_BADATOM, FAIL, "can't find object for ID");
|
||
|
||
/* Get values */
|
||
if (gc_ref)
|
||
if(H5P_get(plist, H5F_ACS_GARBG_COLCT_REF_NAME, gc_ref) < 0)
|
||
HGOTO_ERROR(H5E_PLIST, H5E_CANTGET, FAIL, "can't get garbage collect reference");
|
||
|
||
done:
|
||
FUNC_LEAVE_API(ret_value);
|
||
}
|
||
|
||
|
||
/*-------------------------------------------------------------------------
|
||
* Function: H5Pset_fclose_degree
|
||
*
|
||
* Purpose: Sets the degree for the file close behavior.
|
||
*
|
||
* Return: Non-negative on success/Negative on failure
|
||
*
|
||
* Programmer: Raymond Lu
|
||
* November, 2001
|
||
*
|
||
* Modifications:
|
||
*
|
||
*-------------------------------------------------------------------------
|
||
*/
|
||
herr_t
|
||
H5Pset_fclose_degree(hid_t plist_id, H5F_close_degree_t degree)
|
||
{
|
||
H5P_genplist_t *plist; /* Property list pointer */
|
||
herr_t ret_value = SUCCEED; /* return value */
|
||
|
||
FUNC_ENTER_API(H5Pset_fclose_degree, FAIL)
|
||
H5TRACE2("e", "iFd", plist_id, degree);
|
||
|
||
/* Get the plist structure */
|
||
if(NULL == (plist = H5P_object_verify(plist_id,H5P_FILE_ACCESS)))
|
||
HGOTO_ERROR(H5E_ATOM, H5E_BADATOM, FAIL, "can't find object for ID")
|
||
|
||
/* Set values */
|
||
if(H5P_set(plist, H5F_ACS_CLOSE_DEGREE_NAME, °ree) < 0)
|
||
HGOTO_ERROR(H5E_PLIST, H5E_CANTSET, FAIL, "can't set file close degree")
|
||
|
||
done:
|
||
FUNC_LEAVE_API(ret_value)
|
||
} /* end H5Pset_fclose_degree() */
|
||
|
||
|
||
/*-------------------------------------------------------------------------
|
||
* Function: H5Pget_fclose_degree
|
||
*
|
||
* Purpose: Returns the degree for the file close behavior.
|
||
*
|
||
* Return: Non-negative on success/Negative on failure
|
||
*
|
||
* Programmer: Raymond Lu
|
||
* November, 2001
|
||
*
|
||
* Modifications:
|
||
*
|
||
*-------------------------------------------------------------------------
|
||
*/
|
||
herr_t
|
||
H5Pget_fclose_degree(hid_t plist_id, H5F_close_degree_t *degree)
|
||
{
|
||
H5P_genplist_t *plist; /* Property list pointer */
|
||
herr_t ret_value = SUCCEED; /* return value */
|
||
|
||
FUNC_ENTER_API(H5Pget_fclose_degree, FAIL)
|
||
H5TRACE2("e", "i*Fd", plist_id, degree);
|
||
|
||
/* Get the plist structure */
|
||
if(NULL == (plist = H5P_object_verify(plist_id, H5P_FILE_ACCESS)))
|
||
HGOTO_ERROR(H5E_ATOM, H5E_BADATOM, FAIL, "can't find object for ID")
|
||
|
||
if(degree && H5P_get(plist, H5F_ACS_CLOSE_DEGREE_NAME, degree) < 0)
|
||
HGOTO_ERROR(H5E_PLIST, H5E_CANTGET, FAIL, "can't get file close degree")
|
||
|
||
done:
|
||
FUNC_LEAVE_API(ret_value)
|
||
} /* end H5Pget_fclose_degree() */
|
||
|
||
|
||
/*-------------------------------------------------------------------------
|
||
* Function: H5Pset_meta_block_size
|
||
*
|
||
* Purpose: Sets the minimum size of metadata block allocations when
|
||
* the H5FD_FEAT_AGGREGATE_METADATA is set by a VFL driver.
|
||
* Each "raw" metadata block is allocated to be this size and then
|
||
* specific pieces of metadata (object headers, local heaps, B-trees, etc)
|
||
* are sub-allocated from this block.
|
||
*
|
||
* The default value is set to 2048 (bytes), indicating that metadata
|
||
* will be attempted to be bunched together in (at least) 2K blocks in
|
||
* the file. Setting the value to 0 with this API function will
|
||
* turn off the metadata aggregation, even if the VFL driver attempts to
|
||
* use that strategy.
|
||
*
|
||
* Return: Non-negative on success/Negative on failure
|
||
*
|
||
* Programmer: Quincey Koziol
|
||
* Friday, August 25, 2000
|
||
*
|
||
* Modifications:
|
||
*
|
||
* Raymond Lu
|
||
* Tuesday, Oct 23, 2001
|
||
* Changed the file access list to the new generic property
|
||
* list.
|
||
*
|
||
*-------------------------------------------------------------------------
|
||
*/
|
||
herr_t
|
||
H5Pset_meta_block_size(hid_t plist_id, hsize_t size)
|
||
{
|
||
H5P_genplist_t *plist; /* Property list pointer */
|
||
herr_t ret_value=SUCCEED; /* return value */
|
||
|
||
FUNC_ENTER_API(H5Pset_meta_block_size, FAIL);
|
||
H5TRACE2("e", "ih", plist_id, size);
|
||
|
||
/* Get the plist structure */
|
||
if(NULL == (plist = H5P_object_verify(plist_id,H5P_FILE_ACCESS)))
|
||
HGOTO_ERROR(H5E_ATOM, H5E_BADATOM, FAIL, "can't find object for ID");
|
||
|
||
/* Set values */
|
||
if(H5P_set(plist, H5F_ACS_META_BLOCK_SIZE_NAME, &size) < 0)
|
||
HGOTO_ERROR(H5E_PLIST, H5E_CANTSET, FAIL, "can't set meta data block size");
|
||
|
||
done:
|
||
FUNC_LEAVE_API(ret_value);
|
||
}
|
||
|
||
|
||
/*-------------------------------------------------------------------------
|
||
* Function: H5Pget_meta_block_size
|
||
*
|
||
* Purpose: Returns the current settings for the metadata block allocation
|
||
* property from a file access property list.
|
||
*
|
||
* Return: Non-negative on success/Negative on failure
|
||
*
|
||
* Programmer: Quincey Koziol
|
||
* Friday, August 29, 2000
|
||
*
|
||
* Modifications:
|
||
*
|
||
* Raymond Lu
|
||
* Tuesday, Oct 23, 2001
|
||
* Changed the file access list to the new generic property
|
||
* list.
|
||
*
|
||
*-------------------------------------------------------------------------
|
||
*/
|
||
herr_t
|
||
H5Pget_meta_block_size(hid_t plist_id, hsize_t *size/*out*/)
|
||
{
|
||
H5P_genplist_t *plist; /* Property list pointer */
|
||
herr_t ret_value=SUCCEED; /* return value */
|
||
|
||
FUNC_ENTER_API(H5Pget_meta_block_size, FAIL);
|
||
H5TRACE2("e", "ix", plist_id, size);
|
||
|
||
/* Get the plist structure */
|
||
if(NULL == (plist = H5P_object_verify(plist_id,H5P_FILE_ACCESS)))
|
||
HGOTO_ERROR(H5E_ATOM, H5E_BADATOM, FAIL, "can't find object for ID");
|
||
|
||
/* Get values */
|
||
if (size) {
|
||
if(H5P_get(plist, H5F_ACS_META_BLOCK_SIZE_NAME, size) < 0)
|
||
HGOTO_ERROR(H5E_PLIST, H5E_CANTGET, FAIL, "can't get meta data block size");
|
||
} /* end if */
|
||
|
||
done:
|
||
FUNC_LEAVE_API(ret_value);
|
||
}
|
||
|
||
|
||
/*-------------------------------------------------------------------------
|
||
* Function: H5Pset_sieve_buf_size
|
||
*
|
||
* Purpose: Sets the maximum size of the data seive buffer used for file
|
||
* drivers which are capable of using data sieving. The data sieve
|
||
* buffer is used when performing I/O on datasets in the file. Using a
|
||
* buffer which is large anough to hold several pieces of the dataset
|
||
* being read in for hyperslab selections boosts performance by quite a
|
||
* bit.
|
||
*
|
||
* The default value is set to 64KB, indicating that file I/O for raw data
|
||
* reads and writes will occur in at least 64KB blocks.
|
||
* Setting the value to 0 with this API function will turn off the
|
||
* data sieving, even if the VFL driver attempts to use that strategy.
|
||
*
|
||
* Return: Non-negative on success/Negative on failure
|
||
*
|
||
* Programmer: Quincey Koziol
|
||
* Thursday, September 21, 2000
|
||
*
|
||
* Modifications:
|
||
*
|
||
* Raymond Lu
|
||
* Tuesday, Oct 23, 2001
|
||
* Changed the file access list to the new generic property
|
||
* list.
|
||
*
|
||
*-------------------------------------------------------------------------
|
||
*/
|
||
herr_t
|
||
H5Pset_sieve_buf_size(hid_t plist_id, size_t size)
|
||
{
|
||
H5P_genplist_t *plist; /* Property list pointer */
|
||
herr_t ret_value=SUCCEED; /* return value */
|
||
|
||
FUNC_ENTER_API(H5Pset_sieve_buf_size, FAIL);
|
||
H5TRACE2("e", "iz", plist_id, size);
|
||
|
||
/* Get the plist structure */
|
||
if(NULL == (plist = H5P_object_verify(plist_id,H5P_FILE_ACCESS)))
|
||
HGOTO_ERROR(H5E_ATOM, H5E_BADATOM, FAIL, "can't find object for ID");
|
||
|
||
/* Set values */
|
||
if(H5P_set(plist, H5F_ACS_SIEVE_BUF_SIZE_NAME, &size) < 0)
|
||
HGOTO_ERROR(H5E_PLIST, H5E_CANTSET, FAIL, "can't set sieve buffer size");
|
||
|
||
done:
|
||
FUNC_LEAVE_API(ret_value);
|
||
} /* end H5Pset_sieve_buf_size() */
|
||
|
||
|
||
/*-------------------------------------------------------------------------
|
||
* Function: H5Pget_sieve_buf_size
|
||
*
|
||
* Purpose: Returns the current settings for the data sieve buffer size
|
||
* property from a file access property list.
|
||
*
|
||
* Return: Non-negative on success/Negative on failure
|
||
*
|
||
* Programmer: Quincey Koziol
|
||
* Thursday, September 21, 2000
|
||
*
|
||
* Modifications:
|
||
*
|
||
* Raymond Lu
|
||
* Tuesday, Oct 23, 2001
|
||
* Changed the file access list to the new generic property
|
||
* list.
|
||
*
|
||
*-------------------------------------------------------------------------
|
||
*/
|
||
herr_t
|
||
H5Pget_sieve_buf_size(hid_t plist_id, size_t *size/*out*/)
|
||
{
|
||
H5P_genplist_t *plist; /* Property list pointer */
|
||
herr_t ret_value=SUCCEED; /* return value */
|
||
|
||
FUNC_ENTER_API(H5Pget_sieve_buf_size, FAIL);
|
||
H5TRACE2("e", "ix", plist_id, size);
|
||
|
||
/* Get the plist structure */
|
||
if(NULL == (plist = H5P_object_verify(plist_id,H5P_FILE_ACCESS)))
|
||
HGOTO_ERROR(H5E_ATOM, H5E_BADATOM, FAIL, "can't find object for ID");
|
||
|
||
/* Get values */
|
||
if (size)
|
||
if(H5P_get(plist, H5F_ACS_SIEVE_BUF_SIZE_NAME, size) < 0)
|
||
HGOTO_ERROR(H5E_PLIST, H5E_CANTGET, FAIL, "can't get sieve buffer size");
|
||
|
||
done:
|
||
FUNC_LEAVE_API(ret_value);
|
||
} /* end H5Pget_sieve_buf_size() */
|
||
|
||
|
||
/*-------------------------------------------------------------------------
|
||
* Function: H5Pset_small_data_block_size
|
||
*
|
||
* Purpose: Sets the minimum size of "small" raw data block allocations
|
||
* when the H5FD_FEAT_AGGREGATE_SMALLDATA is set by a VFL driver.
|
||
* Each "small" raw data block is allocated to be this size and then
|
||
* pieces of raw data which are small enough to fit are sub-allocated from
|
||
* this block.
|
||
*
|
||
* The default value is set to 2048 (bytes), indicating that raw data
|
||
* smaller than this value will be attempted to be bunched together in (at
|
||
* least) 2K blocks in the file. Setting the value to 0 with this API
|
||
* function will turn off the "small" raw data aggregation, even if the
|
||
* VFL driver attempts to use that strategy.
|
||
*
|
||
* Return: Non-negative on success/Negative on failure
|
||
*
|
||
* Programmer: Quincey Koziol
|
||
* Wednesday, June 5, 2002
|
||
*
|
||
* Modifications:
|
||
*
|
||
*-------------------------------------------------------------------------
|
||
*/
|
||
herr_t
|
||
H5Pset_small_data_block_size(hid_t plist_id, hsize_t size)
|
||
{
|
||
H5P_genplist_t *plist; /* Property list pointer */
|
||
herr_t ret_value=SUCCEED; /* return value */
|
||
|
||
FUNC_ENTER_API(H5Pset_small_data_block_size, FAIL);
|
||
H5TRACE2("e", "ih", plist_id, size);
|
||
|
||
/* Get the plist structure */
|
||
if(NULL == (plist = H5P_object_verify(plist_id,H5P_FILE_ACCESS)))
|
||
HGOTO_ERROR(H5E_ATOM, H5E_BADATOM, FAIL, "can't find object for ID");
|
||
|
||
/* Set values */
|
||
if(H5P_set(plist, H5F_ACS_SDATA_BLOCK_SIZE_NAME, &size) < 0)
|
||
HGOTO_ERROR(H5E_PLIST, H5E_CANTSET, FAIL, "can't set 'small data' block size");
|
||
|
||
done:
|
||
FUNC_LEAVE_API(ret_value);
|
||
} /* end H5Pset_small_data_block_size() */
|
||
|
||
|
||
/*-------------------------------------------------------------------------
|
||
* Function: H5Pget_small_data_block_size
|
||
*
|
||
* Purpose: Returns the current settings for the "small" raw data block
|
||
* allocation property from a file access property list.
|
||
*
|
||
* Return: Non-negative on success/Negative on failure
|
||
*
|
||
* Programmer: Quincey Koziol
|
||
* Wednesday, June 5, 2002
|
||
*
|
||
* Modifications:
|
||
*
|
||
*-------------------------------------------------------------------------
|
||
*/
|
||
herr_t
|
||
H5Pget_small_data_block_size(hid_t plist_id, hsize_t *size/*out*/)
|
||
{
|
||
H5P_genplist_t *plist; /* Property list pointer */
|
||
herr_t ret_value=SUCCEED; /* return value */
|
||
|
||
FUNC_ENTER_API(H5Pget_small_data_block_size, FAIL);
|
||
H5TRACE2("e", "ix", plist_id, size);
|
||
|
||
/* Get the plist structure */
|
||
if(NULL == (plist = H5P_object_verify(plist_id,H5P_FILE_ACCESS)))
|
||
HGOTO_ERROR(H5E_ATOM, H5E_BADATOM, FAIL, "can't find object for ID");
|
||
|
||
/* Get values */
|
||
if (size) {
|
||
if(H5P_get(plist, H5F_ACS_SDATA_BLOCK_SIZE_NAME, size) < 0)
|
||
HGOTO_ERROR(H5E_PLIST, H5E_CANTGET, FAIL, "can't get 'small data' block size");
|
||
} /* end if */
|
||
|
||
done:
|
||
FUNC_LEAVE_API(ret_value);
|
||
} /* end H5Pget_small_data_block_size() */
|
||
|
||
|
||
/*-------------------------------------------------------------------------
|
||
* Function: H5Pset_latest_format
|
||
*
|
||
* Purpose: Indicates that the library should always use the latest version
|
||
* of the file format when creating objects. If this flag is not set,
|
||
* the library will always use the most backwardly compatibly format
|
||
* possible that can store the information about an object.
|
||
*
|
||
* The default value is set to FALSE (creating backwardly compatible files)
|
||
*
|
||
* Return: Non-negative on success/Negative on failure
|
||
*
|
||
* Programmer: Quincey Koziol
|
||
* Friday, September 9, 2006
|
||
*
|
||
*-------------------------------------------------------------------------
|
||
*/
|
||
herr_t
|
||
H5Pset_latest_format(hid_t plist_id, hbool_t latest)
|
||
{
|
||
H5P_genplist_t *plist; /* Property list pointer */
|
||
herr_t ret_value = SUCCEED; /* return value */
|
||
|
||
FUNC_ENTER_API(H5Pset_latest_format, FAIL)
|
||
H5TRACE2("e", "ib", plist_id, latest);
|
||
|
||
/* Get the plist structure */
|
||
if(NULL == (plist = H5P_object_verify(plist_id, H5P_FILE_ACCESS)))
|
||
HGOTO_ERROR(H5E_ATOM, H5E_BADATOM, FAIL, "can't find object for ID")
|
||
|
||
/* Set values */
|
||
if(H5P_set(plist, H5F_ACS_LATEST_FORMAT_NAME, &latest) < 0)
|
||
HGOTO_ERROR(H5E_PLIST, H5E_CANTSET, FAIL, "can't set 'latest format' flag")
|
||
|
||
done:
|
||
FUNC_LEAVE_API(ret_value)
|
||
} /* end H5Pset_latest_format() */
|
||
|
||
|
||
/*-------------------------------------------------------------------------
|
||
* Function: H5Pget_latest_format
|
||
*
|
||
* Purpose: Returns the current settings for the 'latest format' flag
|
||
* from a file access property list.
|
||
*
|
||
* Return: Non-negative on success/Negative on failure
|
||
*
|
||
* Programmer: Quincey Koziol
|
||
* Friday, September 9, 2006
|
||
*
|
||
*-------------------------------------------------------------------------
|
||
*/
|
||
herr_t
|
||
H5Pget_latest_format(hid_t plist_id, hbool_t *latest/*out*/)
|
||
{
|
||
H5P_genplist_t *plist; /* Property list pointer */
|
||
herr_t ret_value = SUCCEED; /* return value */
|
||
|
||
FUNC_ENTER_API(H5Pget_latest_format, FAIL)
|
||
H5TRACE2("e", "ix", plist_id, latest);
|
||
|
||
/* Get the plist structure */
|
||
if(NULL == (plist = H5P_object_verify(plist_id, H5P_FILE_ACCESS)))
|
||
HGOTO_ERROR(H5E_ATOM, H5E_BADATOM, FAIL, "can't find object for ID")
|
||
|
||
/* Get value */
|
||
if(latest)
|
||
if(H5P_get(plist, H5F_ACS_LATEST_FORMAT_NAME, latest) < 0)
|
||
HGOTO_ERROR(H5E_PLIST, H5E_CANTGET, FAIL, "can't get 'latest format' flag")
|
||
|
||
done:
|
||
FUNC_LEAVE_API(ret_value)
|
||
} /* end H5Pget_latest_format() */
|
||
|