HDF5  1.12.0
Data Structures | Functions | Variables
H5F.c File Reference

Data Structures

struct  H5F_trav_obj_cnt_t
 
struct  H5F_trav_obj_ids_t
 

Functions

 H5FL_EXTERN (H5VL_t)
 
 H5FL_EXTERN (H5VL_object_t)
 
herr_t H5F_init (void)
 
herr_t H5F__init_package (void)
 
int H5F_term_package (void)
 
hid_t H5Fget_create_plist (hid_t file_id)
 
hid_t H5Fget_access_plist (hid_t file_id)
 
ssize_t H5Fget_obj_count (hid_t file_id, unsigned types)
 
ssize_t H5Fget_obj_ids (hid_t file_id, unsigned types, size_t max_objs, hid_t *oid_list)
 
herr_t H5Fget_vfd_handle (hid_t file_id, hid_t fapl_id, void **file_handle)
 
htri_t H5Fis_accessible (const char *filename, hid_t fapl_id)
 
hid_t H5Fcreate (const char *filename, unsigned flags, hid_t fcpl_id, hid_t fapl_id)
 
hid_t H5Fopen (const char *filename, unsigned flags, hid_t fapl_id)
 
herr_t H5Fflush (hid_t object_id, H5F_scope_t scope)
 
herr_t H5Fclose (hid_t file_id)
 
herr_t H5Fdelete (const char *filename, hid_t fapl_id)
 
hid_t H5Freopen (hid_t file_id)
 
herr_t H5Fget_intent (hid_t file_id, unsigned *intent_flags)
 
herr_t H5Fget_fileno (hid_t file_id, unsigned long *fnumber)
 
hssize_t H5Fget_freespace (hid_t file_id)
 
herr_t H5Fget_filesize (hid_t file_id, hsize_t *size)
 
ssize_t H5Fget_file_image (hid_t file_id, void *buf_ptr, size_t buf_len)
 
herr_t H5Fget_mdc_config (hid_t file_id, H5AC_cache_config_t *config_ptr)
 
herr_t H5Fset_mdc_config (hid_t file_id, H5AC_cache_config_t *config_ptr)
 
herr_t H5Fget_mdc_hit_rate (hid_t file_id, double *hit_rate_ptr)
 
herr_t H5Fget_mdc_size (hid_t file_id, size_t *max_size_ptr, size_t *min_clean_size_ptr, size_t *cur_size_ptr, int *cur_num_entries_ptr)
 
herr_t H5Freset_mdc_hit_rate_stats (hid_t file_id)
 
ssize_t H5Fget_name (hid_t obj_id, char *name, size_t size)
 
herr_t H5Fget_info2 (hid_t obj_id, H5F_info2_t *finfo)
 
herr_t H5Fget_metadata_read_retry_info (hid_t file_id, H5F_retry_info_t *info)
 
ssize_t H5Fget_free_sections (hid_t file_id, H5F_mem_t type, size_t nsects, H5F_sect_info_t *sect_info)
 
herr_t H5Fclear_elink_file_cache (hid_t file_id)
 
herr_t H5Fstart_swmr_write (hid_t file_id)
 
herr_t H5Fstart_mdc_logging (hid_t file_id)
 
herr_t H5Fstop_mdc_logging (hid_t file_id)
 
herr_t H5Fget_mdc_logging_status (hid_t file_id, hbool_t *is_enabled, hbool_t *is_currently_logging)
 
herr_t H5Fset_libver_bounds (hid_t file_id, H5F_libver_t low, H5F_libver_t high)
 
herr_t H5Fformat_convert (hid_t file_id)
 
herr_t H5Freset_page_buffering_stats (hid_t file_id)
 
herr_t H5Fget_page_buffering_stats (hid_t file_id, unsigned accesses[2], unsigned hits[2], unsigned misses[2], unsigned evictions[2], unsigned bypasses[2])
 
herr_t H5Fget_mdc_image_info (hid_t file_id, haddr_t *image_addr, hsize_t *image_len)
 
herr_t H5Fget_eoa (hid_t file_id, haddr_t *eoa)
 
herr_t H5Fincrement_filesize (hid_t file_id, hsize_t increment)
 
herr_t H5Fget_dset_no_attrs_hint (hid_t file_id, hbool_t *minimize)
 
herr_t H5Fset_dset_no_attrs_hint (hid_t file_id, hbool_t minimize)
 

Variables

hbool_t H5_PKG_INIT_VAR = FALSE
 

Function Documentation

◆ H5F__init_package()

herr_t H5F__init_package ( void  )

References H5I_register_type(), and ret_value.

◆ H5F_init()

herr_t H5F_init ( void  )

References FAIL, FUNC_ENTER_NOAPI(), FUNC_LEAVE_NOAPI(), and ret_value.

Referenced by H5VL_init_phase2().

◆ H5F_term_package()

int H5F_term_package ( void  )

References FUNC_LEAVE_NOAPI(), H5_PKG_INIT_VAR, H5F_sfile_assert_num(), H5I_clear_type(), H5I_dec_type_ref(), H5I_FILE, H5I_nmembers(), and n.

◆ H5Fclear_elink_file_cache()

herr_t H5Fclear_elink_file_cache ( hid_t  file_id)

References FAIL, H5E_BADVALUE, H5I_FILE, H5I_object_verify(), H5VL_file_optional(), NULL, and ret_value.

◆ H5Fclose()

herr_t H5Fclose ( hid_t  file_id)

References FAIL, H5I_dec_app_ref(), H5I_FILE, H5I_get_type(), and ret_value.

◆ H5Fcreate()

hid_t H5Fcreate ( const char *  filename,
unsigned  flags,
hid_t  fcpl_id,
hid_t  fapl_id 
)

References H5VL_connector_prop_t::connector_id, fapl_id, flags, H5CX_set_apl(), H5CX_set_vol_connector_prop(), H5E_BADVALUE, H5E_CANTINIT, H5E_CANTREGISTER, H5I_FILE, H5I_object(), H5P_CLS_FACC, H5P_isa_class(), H5P_peek(), H5VL_file_create(), H5VL_file_optional(), H5VL_introspect_opt_query(), H5VL_register_using_vol_id(), H5VL_SUBCLS_FILE, H5VL_vol_object(), NULL, and ret_value.

◆ H5Fdelete()

herr_t H5Fdelete ( const char *  filename,
hid_t  fapl_id 
)

References FAIL, fapl_id, H5CX_set_apl(), H5CX_set_vol_connector_prop(), H5I_GENPROP_LST, H5I_object_verify(), H5P_CLS_FACC, H5P_peek(), H5VL_FILE_DELETE, H5VL_FILE_IS_ACCESSIBLE, H5VL_file_specific(), NULL, and ret_value.

◆ H5Fflush()

herr_t H5Fflush ( hid_t  object_id,
H5F_scope_t  scope 
)

References FAIL, H5I_ATTR, H5I_DATASET, H5I_DATATYPE, H5I_FILE, H5I_get_type(), H5I_GROUP, H5VL_FILE_FLUSH, H5VL_file_specific(), H5VL_vol_object(), NULL, and ret_value.

◆ H5Fformat_convert()

herr_t H5Fformat_convert ( hid_t  file_id)

References FAIL, H5CX_set_loc(), H5I_FILE, H5I_object_verify(), H5VL_file_optional(), NULL, and ret_value.

◆ H5Fget_access_plist()

hid_t H5Fget_access_plist ( hid_t  file_id)

References H5I_object(), H5VL_file_get(), H5VL_FILE_GET_FAPL, NULL, and ret_value.

◆ H5Fget_create_plist()

hid_t H5Fget_create_plist ( hid_t  file_id)

References H5I_object(), H5VL_file_get(), H5VL_FILE_GET_FCPL, NULL, and ret_value.

◆ H5Fget_dset_no_attrs_hint()

herr_t H5Fget_dset_no_attrs_hint ( hid_t  file_id,
hbool_t *  minimize 
)

References FAIL, H5E_BADVALUE, H5I_FILE, H5I_object_verify(), H5VL_file_optional(), NULL, and ret_value.

◆ H5Fget_eoa()

herr_t H5Fget_eoa ( hid_t  file_id,
haddr_t *  eoa 
)

References eoa, FAIL, H5I_FILE, H5I_object_verify(), H5VL_file_optional(), NULL, and ret_value.

◆ H5Fget_file_image()

ssize_t H5Fget_file_image ( hid_t  file_id,
void *  buf_ptr,
size_t  buf_len 
)

References H5E_BADVALUE, H5I_FILE, H5I_object_verify(), H5VL_file_optional(), NULL, and ret_value.

◆ H5Fget_fileno()

herr_t H5Fget_fileno ( hid_t  file_id,
unsigned long *  fnumber 
)

References FAIL, H5I_object(), H5VL_file_get(), H5VL_FILE_GET_FILENO, NULL, and ret_value.

◆ H5Fget_filesize()

herr_t H5Fget_filesize ( hid_t  file_id,
hsize_t *  size 
)

References FAIL, H5E_BADVALUE, H5I_FILE, H5I_object_verify(), H5VL_file_optional(), NULL, ret_value, and size.

◆ H5Fget_free_sections()

ssize_t H5Fget_free_sections ( hid_t  file_id,
H5F_mem_t  type,
size_t  nsects,
H5F_sect_info_t *  sect_info 
)

References H5E_BADVALUE, H5I_FILE, H5I_object_verify(), H5VL_file_optional(), NULL, ret_value, and type.

◆ H5Fget_freespace()

hssize_t H5Fget_freespace ( hid_t  file_id)

References H5I_object(), H5VL_file_optional(), NULL, and ret_value.

◆ H5Fget_info2()

herr_t H5Fget_info2 ( hid_t  obj_id,
H5F_info2_t *  finfo 
)

References FAIL, H5E_BADVALUE, H5I_ATTR, H5I_DATASET, H5I_DATATYPE, H5I_FILE, H5I_get_type(), H5I_GROUP, H5VL_file_optional(), H5VL_vol_object(), NULL, ret_value, and type.

◆ H5Fget_intent()

herr_t H5Fget_intent ( hid_t  file_id,
unsigned *  intent_flags 
)

References FAIL, H5I_object(), H5VL_file_get(), H5VL_FILE_GET_INTENT, NULL, and ret_value.

◆ H5Fget_mdc_config()

herr_t H5Fget_mdc_config ( hid_t  file_id,
H5AC_cache_config_t *  config_ptr 
)

References FAIL, H5E_BADVALUE, H5I_object(), H5VL_file_optional(), NULL, ret_value, and H5AC_cache_config_t::version.

◆ H5Fget_mdc_hit_rate()

herr_t H5Fget_mdc_hit_rate ( hid_t  file_id,
double *  hit_rate_ptr 
)

References FAIL, H5E_BADVALUE, H5I_FILE, H5I_object_verify(), H5VL_file_optional(), NULL, and ret_value.

◆ H5Fget_mdc_image_info()

herr_t H5Fget_mdc_image_info ( hid_t  file_id,
haddr_t *  image_addr,
hsize_t *  image_len 
)

References FAIL, H5I_FILE, H5I_object_verify(), H5VL_file_optional(), image_addr, image_len, NULL, and ret_value.

◆ H5Fget_mdc_logging_status()

herr_t H5Fget_mdc_logging_status ( hid_t  file_id,
hbool_t *  is_enabled,
hbool_t *  is_currently_logging 
)

References FAIL, H5I_FILE, H5I_object_verify(), H5VL_file_optional(), NULL, and ret_value.

◆ H5Fget_mdc_size()

herr_t H5Fget_mdc_size ( hid_t  file_id,
size_t *  max_size_ptr,
size_t *  min_clean_size_ptr,
size_t *  cur_size_ptr,
int *  cur_num_entries_ptr 
)

References FAIL, H5E_BADVALUE, H5I_FILE, H5I_object_verify(), H5VL_file_optional(), NULL, and ret_value.

◆ H5Fget_metadata_read_retry_info()

herr_t H5Fget_metadata_read_retry_info ( hid_t  file_id,
H5F_retry_info_t *  info 
)

References FAIL, H5E_BADVALUE, H5I_FILE, H5I_object_verify(), H5VL_file_optional(), NULL, and ret_value.

◆ H5Fget_name()

ssize_t H5Fget_name ( hid_t  obj_id,
char *  name,
size_t  size 
)

References H5I_ATTR, H5I_DATASET, H5I_DATATYPE, H5I_FILE, H5I_get_type(), H5I_GROUP, H5VL_file_get(), H5VL_FILE_GET_NAME, H5VL_vol_object(), name, NULL, ret_value, size, and type.

◆ H5Fget_obj_count()

ssize_t H5Fget_obj_count ( hid_t  file_id,
unsigned  types 
)

References H5E_BADVALUE, H5I_FILE, H5I_iterate(), H5I_object_verify(), H5VL_file_get(), H5VL_FILE_GET_OBJ_COUNT, NULL, H5F_trav_obj_cnt_t::obj_count, ret_value, and H5F_trav_obj_cnt_t::types.

◆ H5Fget_obj_ids()

ssize_t H5Fget_obj_ids ( hid_t  file_id,
unsigned  types,
size_t  max_objs,
hid_t *  oid_list 
)

References H5E_BADVALUE, H5I_FILE, H5I_iterate(), H5I_object_verify(), H5VL_file_get(), H5VL_FILE_GET_OBJ_IDS, H5F_trav_obj_ids_t::max_objs, NULL, H5F_trav_obj_ids_t::obj_count, H5F_trav_obj_ids_t::oid_list, and ret_value.

◆ H5Fget_page_buffering_stats()

herr_t H5Fget_page_buffering_stats ( hid_t  file_id,
unsigned  accesses[2],
unsigned  hits[2],
unsigned  misses[2],
unsigned  evictions[2],
unsigned  bypasses[2] 
)

References FAIL, H5E_BADVALUE, H5I_FILE, H5I_object_verify(), H5VL_file_optional(), NULL, and ret_value.

◆ H5Fget_vfd_handle()

herr_t H5Fget_vfd_handle ( hid_t  file_id,
hid_t  fapl_id,
void **  file_handle 
)

References FAIL, fapl_id, H5E_BADVALUE, H5I_object(), H5VL_file_optional(), NULL, and ret_value.

◆ H5Fincrement_filesize()

herr_t H5Fincrement_filesize ( hid_t  file_id,
hsize_t  increment 
)

References FAIL, H5I_FILE, H5I_object_verify(), H5VL_file_optional(), NULL, and ret_value.

◆ H5Fis_accessible()

htri_t H5Fis_accessible ( const char *  filename,
hid_t  fapl_id 
)

References FAIL, fapl_id, H5P_isa_class(), H5VL_FILE_IS_ACCESSIBLE, H5VL_file_specific(), NULL, and ret_value.

◆ H5FL_EXTERN() [1/2]

H5FL_EXTERN ( H5VL_object_t  )

◆ H5FL_EXTERN() [2/2]

H5FL_EXTERN ( H5VL_t  )

◆ H5Fopen()

hid_t H5Fopen ( const char *  filename,
unsigned  flags,
hid_t  fapl_id 
)

References H5VL_connector_prop_t::connector_id, fapl_id, flags, H5CX_set_apl(), H5CX_set_vol_connector_prop(), H5E_BADVALUE, H5E_CANTINIT, H5E_CANTREGISTER, H5I_FILE, H5I_object(), H5P_CLS_FACC, H5P_peek(), H5VL_file_open(), H5VL_file_optional(), H5VL_introspect_opt_query(), H5VL_register_using_vol_id(), H5VL_SUBCLS_FILE, H5VL_vol_object(), NULL, and ret_value.

◆ H5Freopen()

hid_t H5Freopen ( hid_t  file_id)

References H5VL_object_t::connector, H5E_CANTINIT, H5E_CANTREGISTER, H5I_FILE, H5I_object_verify(), H5VL_file_optional(), H5VL_FILE_REOPEN, H5VL_file_specific(), H5VL_introspect_opt_query(), H5VL_register(), H5VL_SUBCLS_FILE, H5VL_vol_object(), NULL, and ret_value.

◆ H5Freset_mdc_hit_rate_stats()

herr_t H5Freset_mdc_hit_rate_stats ( hid_t  file_id)

References FAIL, H5I_object(), H5VL_file_optional(), NULL, and ret_value.

◆ H5Freset_page_buffering_stats()

herr_t H5Freset_page_buffering_stats ( hid_t  file_id)

References FAIL, H5I_FILE, H5I_object_verify(), H5VL_file_optional(), NULL, and ret_value.

◆ H5Fset_dset_no_attrs_hint()

herr_t H5Fset_dset_no_attrs_hint ( hid_t  file_id,
hbool_t  minimize 
)

References FAIL, H5I_FILE, H5I_object_verify(), H5VL_file_optional(), NULL, and ret_value.

◆ H5Fset_libver_bounds()

herr_t H5Fset_libver_bounds ( hid_t  file_id,
H5F_libver_t  low,
H5F_libver_t  high 
)

References FAIL, H5CX_set_loc(), H5E_BADVALUE, H5I_FILE, H5I_object_verify(), H5VL_file_optional(), NULL, and ret_value.

◆ H5Fset_mdc_config()

herr_t H5Fset_mdc_config ( hid_t  file_id,
H5AC_cache_config_t *  config_ptr 
)

References FAIL, H5I_object(), H5VL_file_optional(), NULL, and ret_value.

◆ H5Fstart_mdc_logging()

herr_t H5Fstart_mdc_logging ( hid_t  file_id)

References FAIL, H5I_FILE, H5I_object_verify(), H5VL_file_optional(), NULL, and ret_value.

◆ H5Fstart_swmr_write()

herr_t H5Fstart_swmr_write ( hid_t  file_id)

References FAIL, H5CX_set_loc(), H5I_FILE, H5I_object_verify(), H5VL_file_optional(), NULL, and ret_value.

◆ H5Fstop_mdc_logging()

herr_t H5Fstop_mdc_logging ( hid_t  file_id)

References FAIL, H5I_FILE, H5I_object_verify(), H5VL_file_optional(), NULL, and ret_value.

Variable Documentation

◆ H5_PKG_INIT_VAR

hbool_t H5_PKG_INIT_VAR = FALSE

Referenced by H5F_term_package().