H5CX.c File Reference

#include "H5CXmodule.h"
#include "H5private.h"
#include "H5CXprivate.h"
#include "H5Dprivate.h"
#include "H5Eprivate.h"
#include "H5FLprivate.h"
#include "H5Iprivate.h"
#include "H5Lprivate.h"
#include "H5MMprivate.h"
#include "H5Pprivate.h"

Data Structures
struct	H5CX_t
struct	H5CX_node_t
struct	H5CX_dxpl_cache_t
struct	H5CX_lcpl_cache_t
struct	H5CX_lapl_cache_t
struct	H5CX_dcpl_cache_t
struct	H5CX_dapl_cache_t
struct	H5CX_fapl_cache_t

Macros
#define	H5CX_get_my_context()   (&H5CX_head_g)
#define	H5CX_RETRIEVE_PLIST(PL, FAILVAL)
#define	H5CX_RETRIEVE_PROP_COMMON(PL, DEF_PL, PROP_NAME, PROP_FIELD)
#define	H5CX_RETRIEVE_PROP_VALID(PL, DEF_PL, PROP_NAME, PROP_FIELD)

Typedefs
typedef struct H5CX_t	H5CX_t
typedef struct H5CX_node_t	H5CX_node_t
typedef struct H5CX_dxpl_cache_t	H5CX_dxpl_cache_t
typedef struct H5CX_lcpl_cache_t	H5CX_lcpl_cache_t
typedef struct H5CX_lapl_cache_t	H5CX_lapl_cache_t
typedef struct H5CX_dcpl_cache_t	H5CX_dcpl_cache_t
typedef struct H5CX_dapl_cache_t	H5CX_dapl_cache_t
typedef struct H5CX_fapl_cache_t	H5CX_fapl_cache_t

Functions
	H5FL_DEFINE_STATIC (H5CX_node_t)
	H5FL_DEFINE_STATIC (H5CX_state_t)
herr_t	H5CX__init_package (void)
int	H5CX_term_package (void)
herr_t	H5CX_push (void)
void	H5CX_push_special (void)
herr_t	H5CX_retrieve_state (H5CX_state_t **api_state)
herr_t	H5CX_restore_state (const H5CX_state_t *api_state)
herr_t	H5CX_free_state (H5CX_state_t *api_state)
hbool_t	H5CX_is_def_dxpl (void)
void	H5CX_set_dxpl (hid_t dxpl_id)
void	H5CX_set_dcpl (hid_t dcpl_id)
herr_t	H5CX_set_libver_bounds (H5F_t *f)
void	H5CX_set_lcpl (hid_t lcpl_id)
void	H5CX_set_lapl (hid_t lapl_id)
herr_t	H5CX_set_apl (hid_t *acspl_id, const H5P_libclass_t *libclass, hid_t H5_ATTR_UNUSED loc_id, hbool_t H5_ATTR_UNUSED is_collective)
herr_t	H5CX_set_loc (hid_t H5_ATTR_UNUSED loc_id)
herr_t	H5CX_set_vol_wrap_ctx (void *vol_wrap_ctx)
herr_t	H5CX_set_vol_connector_prop (const H5VL_connector_prop_t *vol_connector_prop)
hid_t	H5CX_get_dxpl (void)
hid_t	H5CX_get_lapl (void)
herr_t	H5CX_get_vol_wrap_ctx (void **vol_wrap_ctx)
herr_t	H5CX_get_vol_connector_prop (H5VL_connector_prop_t *vol_connector_prop)
haddr_t	H5CX_get_tag (void)
H5AC_ring_t	H5CX_get_ring (void)
herr_t	H5CX_get_btree_split_ratios (double split_ratio[3])
herr_t	H5CX_get_max_temp_buf (size_t *max_temp_buf)
herr_t	H5CX_get_tconv_buf (void **tconv_buf)
herr_t	H5CX_get_bkgr_buf (void **bkgr_buf)
herr_t	H5CX_get_bkgr_buf_type (H5T_bkg_t *bkgr_buf_type)
herr_t	H5CX_get_vec_size (size_t *vec_size)
herr_t	H5CX_get_err_detect (H5Z_EDC_t *err_detect)
herr_t	H5CX_get_filter_cb (H5Z_cb_t *filter_cb)
herr_t	H5CX_get_data_transform (H5Z_data_xform_t **data_transform)
herr_t	H5CX_get_vlen_alloc_info (H5T_vlen_alloc_info_t *vl_alloc_info)
herr_t	H5CX_get_dt_conv_cb (H5T_conv_cb_t *dt_conv_cb)
herr_t	H5CX_get_encoding (H5T_cset_t *encoding)
herr_t	H5CX_get_intermediate_group (unsigned *crt_intermed_group)
herr_t	H5CX_get_nlinks (size_t *nlinks)
herr_t	H5CX_get_libver_bounds (H5F_libver_t *low_bound, H5F_libver_t *high_bound)
herr_t	H5CX_get_dset_min_ohdr_flag (hbool_t *dset_min_ohdr_flag)
herr_t	H5CX_get_ext_file_prefix (const char **extfile_prefix)
herr_t	H5CX_get_vds_prefix (const char **vds_prefix)
void	H5CX_set_tag (haddr_t tag)
void	H5CX_set_ring (H5AC_ring_t ring)
herr_t	H5CX_set_vlen_alloc_info (H5MM_allocate_t alloc_func, void *alloc_info, H5MM_free_t free_func, void *free_info)
herr_t	H5CX_set_nlinks (size_t nlinks)
herr_t	H5CX_get_ohdr_flags (uint8_t *ohdr_flags)
herr_t	H5CX_pop (void)

Variables
hbool_t	H5_PKG_INIT_VAR = FALSE

Macro Definition Documentation

H5CX_get_my_context

#define H5CX_get_my_context

(

)

(&H5CX_head_g)

H5CX_RETRIEVE_PLIST

#define H5CX_RETRIEVE_PLIST	(		PL,
			FAILVAL
	)

Value:

    /* Check if the property list is already available */                     \
    if(NULL == (*head)->ctx.PL)                                               \
        /* Get the property list pointer */                                   \
        if(NULL == ((*head)->ctx.PL = (H5P_genplist_t *)H5I_object((*head)->ctx.H5_GLUE(PL,_id)))) \
            HGOTO_ERROR(H5E_CONTEXT, H5E_BADTYPE, (FAILVAL), "can't get property list")

H5CX_RETRIEVE_PROP_COMMON

#define H5CX_RETRIEVE_PROP_COMMON	(		PL,
			DEF_PL,
			PROP_NAME,
			PROP_FIELD
	)

Value:

    /* Check for default property list */                                     \
    if((*head)->ctx.H5_GLUE(PL,_id) == (DEF_PL))                              \
        H5MM_memcpy(&(*head)->ctx.PROP_FIELD, &H5_GLUE3(H5CX_def_,PL,_cache).PROP_FIELD, sizeof(H5_GLUE3(H5CX_def_,PL,_cache).PROP_FIELD)); \
    else {                                                                    \
        /* Retrieve the property list */                                      \
        H5CX_RETRIEVE_PLIST(PL, FAIL)                                         \
                                                                              \
        /* Get the property */                                                \
        if(H5P_get((*head)->ctx.PL, (PROP_NAME), &(*head)->ctx.PROP_FIELD) < 0) \
            HGOTO_ERROR(H5E_CONTEXT, H5E_CANTGET, FAIL, "can't retrieve value from API context") \
    } /* end else */                                                          \
                                                                              \
    /* Mark the field as valid */                                             \
    (*head)->ctx.H5_GLUE(PROP_FIELD,_valid) = TRUE;

H5CX_RETRIEVE_PROP_VALID

#define H5CX_RETRIEVE_PROP_VALID	(		PL,
			DEF_PL,
			PROP_NAME,
			PROP_FIELD
	)

Value:

    /* Check if the value has been retrieved already */                       \
    if(!(*head)->ctx.H5_GLUE(PROP_FIELD,_valid)) {                            \
        H5CX_RETRIEVE_PROP_COMMON(PL, DEF_PL, PROP_NAME, PROP_FIELD)          \
    } /* end if */

Typedef Documentation

H5CX_dapl_cache_t

typedef struct H5CX_dapl_cache_t H5CX_dapl_cache_t

H5CX_dcpl_cache_t

typedef struct H5CX_dcpl_cache_t H5CX_dcpl_cache_t

H5CX_dxpl_cache_t

typedef struct H5CX_dxpl_cache_t H5CX_dxpl_cache_t

H5CX_fapl_cache_t

typedef struct H5CX_fapl_cache_t H5CX_fapl_cache_t

H5CX_lapl_cache_t

typedef struct H5CX_lapl_cache_t H5CX_lapl_cache_t

H5CX_lcpl_cache_t

typedef struct H5CX_lcpl_cache_t H5CX_lcpl_cache_t

H5CX_node_t

typedef struct H5CX_node_t H5CX_node_t

H5CX_t

typedef struct H5CX_t H5CX_t

Function Documentation

H5CX__init_package()

herr_t H5CX__init_package

(

void

)

H5CX_free_state()

herr_t H5CX_free_state

(

H5CX_state_t *

api_state

)

H5CX_get_bkgr_buf()

herr_t H5CX_get_bkgr_buf

(

void **

bkgr_buf

)

H5CX_get_bkgr_buf_type()

herr_t H5CX_get_bkgr_buf_type

(

H5T_bkg_t *

bkgr_buf_type

)

H5CX_get_btree_split_ratios()

herr_t H5CX_get_btree_split_ratios

(

double

split_ratio[3]

)

H5CX_get_data_transform()

herr_t H5CX_get_data_transform

(

H5Z_data_xform_t **

data_transform

)

H5CX_get_dset_min_ohdr_flag()

herr_t H5CX_get_dset_min_ohdr_flag

(

hbool_t *

dset_min_ohdr_flag

)

H5CX_get_dt_conv_cb()

herr_t H5CX_get_dt_conv_cb

(

H5T_conv_cb_t *

dt_conv_cb

)

H5CX_get_dxpl()

hid_t H5CX_get_dxpl

(

void

)

H5CX_get_encoding()

herr_t H5CX_get_encoding

(

H5T_cset_t *

encoding

)

H5CX_get_err_detect()

herr_t H5CX_get_err_detect

(

H5Z_EDC_t *

err_detect

)

H5CX_get_ext_file_prefix()

herr_t H5CX_get_ext_file_prefix

(

const char **

extfile_prefix

)

H5CX_get_filter_cb()

herr_t H5CX_get_filter_cb

(

H5Z_cb_t *

filter_cb

)

H5CX_get_intermediate_group()

herr_t H5CX_get_intermediate_group

(

unsigned *

crt_intermed_group

)

H5CX_get_lapl()

hid_t H5CX_get_lapl

(

void

)

H5CX_get_libver_bounds()

herr_t H5CX_get_libver_bounds	(	H5F_libver_t *	low_bound,
		H5F_libver_t *	high_bound
	)

H5CX_get_max_temp_buf()

herr_t H5CX_get_max_temp_buf

(

size_t *

max_temp_buf

)

H5CX_get_nlinks()

herr_t H5CX_get_nlinks

(

size_t *

nlinks

)

H5CX_get_ohdr_flags()

herr_t H5CX_get_ohdr_flags

(

uint8_t *

ohdr_flags

)

H5CX_get_ring()

H5AC_ring_t H5CX_get_ring

(

void

)

H5CX_get_tag()

haddr_t H5CX_get_tag

(

void

)

H5CX_get_tconv_buf()

herr_t H5CX_get_tconv_buf

(

void **

tconv_buf

)

H5CX_get_vds_prefix()

herr_t H5CX_get_vds_prefix

(

const char **

vds_prefix

)

H5CX_get_vec_size()

herr_t H5CX_get_vec_size

(

size_t *

vec_size

)

H5CX_get_vlen_alloc_info()

herr_t H5CX_get_vlen_alloc_info

(

H5T_vlen_alloc_info_t *

vl_alloc_info

)

H5CX_get_vol_connector_prop()

herr_t H5CX_get_vol_connector_prop

(

H5VL_connector_prop_t *

vol_connector_prop

)

H5CX_get_vol_wrap_ctx()

herr_t H5CX_get_vol_wrap_ctx

(

void **

vol_wrap_ctx

)

H5CX_is_def_dxpl()

hbool_t H5CX_is_def_dxpl

(

void

)

H5CX_pop()

herr_t H5CX_pop

(

void

)

H5CX_push()

herr_t H5CX_push

(

void

)

H5CX_push_special()

void H5CX_push_special

(

void

)

H5CX_restore_state()

herr_t H5CX_restore_state

(

const H5CX_state_t *

api_state

)

H5CX_retrieve_state()

herr_t H5CX_retrieve_state

(

H5CX_state_t **

api_state

)

H5CX_set_apl()

herr_t H5CX_set_apl	(	hid_t *	acspl_id,
		const H5P_libclass_t *	libclass,
		hid_t H5_ATTR_UNUSED	loc_id,
		hbool_t H5_ATTR_UNUSED	is_collective
	)

H5CX_set_dcpl()

void H5CX_set_dcpl

(

hid_t

dcpl_id

)

H5CX_set_dxpl()

void H5CX_set_dxpl

(

hid_t

dxpl_id

)

H5CX_set_lapl()

void H5CX_set_lapl

(

hid_t

lapl_id

)

H5CX_set_lcpl()

void H5CX_set_lcpl

(

hid_t

lcpl_id

)

H5CX_set_libver_bounds()

herr_t H5CX_set_libver_bounds

(

H5F_t *

f

)

H5CX_set_loc()

herr_t H5CX_set_loc

(

hid_t H5_ATTR_UNUSED

loc_id

)

H5CX_set_nlinks()

herr_t H5CX_set_nlinks

(

size_t

nlinks

)

H5CX_set_ring()

void H5CX_set_ring

(

H5AC_ring_t

ring

)

H5CX_set_tag()

void H5CX_set_tag

(

haddr_t

tag

)

H5CX_set_vlen_alloc_info()

herr_t H5CX_set_vlen_alloc_info	(	H5MM_allocate_t	alloc_func,
		void *	alloc_info,
		H5MM_free_t	free_func,
		void *	free_info
	)

H5CX_set_vol_connector_prop()

herr_t H5CX_set_vol_connector_prop

(

const H5VL_connector_prop_t *

vol_connector_prop

)

H5CX_set_vol_wrap_ctx()

herr_t H5CX_set_vol_wrap_ctx

(

void *

vol_wrap_ctx

)

H5CX_term_package()

int H5CX_term_package

(

void

)

H5FL_DEFINE_STATIC() [1/2]

H5FL_DEFINE_STATIC

(

H5CX_node_t

)

H5FL_DEFINE_STATIC() [2/2]

H5FL_DEFINE_STATIC

(

H5CX_state_t

)

Variable Documentation

H5_PKG_INIT_VAR

hbool_t H5_PKG_INIT_VAR = FALSE