H5FDprivate.h File Reference

Data Structures
struct	H5FD_class_mpi_t
struct	H5FD_file_image_info_t
struct	H5FD_driver_prop_t

Typedefs
typedef struct H5FD_class_mpi_t	H5FD_class_mpi_t

Enumerations
enum	H5FD_file_op_t { OP_UNKNOWN = 0, OP_READ = 1, OP_WRITE = 2 }

Functions
H5_DLL int	H5FD_term_interface (void)
H5_DLL herr_t	H5FD_locate_signature (H5FD_t *file, haddr_t *sig_addr)
H5_DLL H5FD_class_t *	H5FD_get_class (hid_t id)
H5_DLL hsize_t	H5FD_sb_size (H5FD_t *file)
H5_DLL herr_t	H5FD_sb_encode (H5FD_t *file, char *name, uint8_t *buf)
H5_DLL herr_t	H5FD_sb_load (H5FD_t *file, const char *name, const uint8_t *buf)
H5_DLL void *	H5FD_fapl_get (H5FD_t *file)
H5_DLL herr_t	H5FD_fapl_close (hid_t driver_id, const void *fapl)
H5_DLL hid_t	H5FD_register (const void *cls, size_t size, hbool_t app_ref)
H5_DLL H5FD_t *	H5FD_open (const char *name, unsigned flags, hid_t fapl_id, haddr_t maxaddr)
H5_DLL herr_t	H5FD_close (H5FD_t *file)
H5_DLL int	H5FD_cmp (const H5FD_t *f1, const H5FD_t *f2)
H5_DLL herr_t	H5FD_driver_query (const H5FD_class_t *driver, unsigned long *flags)
H5_DLL haddr_t	H5FD_alloc (H5FD_t *file, H5FD_mem_t type, struct H5F_t *f, hsize_t size, haddr_t *frag_addr, hsize_t *frag_size)
H5_DLL herr_t	H5FD_free (H5FD_t *file, H5FD_mem_t type, struct H5F_t *f, haddr_t addr, hsize_t size)
H5_DLL htri_t	H5FD_try_extend (H5FD_t *file, H5FD_mem_t type, struct H5F_t *f, haddr_t blk_end, hsize_t extra_requested)
H5_DLL haddr_t	H5FD_get_eoa (const H5FD_t *file, H5FD_mem_t type)
H5_DLL herr_t	H5FD_set_eoa (H5FD_t *file, H5FD_mem_t type, haddr_t addr)
H5_DLL haddr_t	H5FD_get_eof (const H5FD_t *file, H5FD_mem_t type)
H5_DLL haddr_t	H5FD_get_maxaddr (const H5FD_t *file)
H5_DLL herr_t	H5FD_get_feature_flags (const H5FD_t *file, unsigned long *feature_flags)
H5_DLL herr_t	H5FD_set_feature_flags (H5FD_t *file, unsigned long feature_flags)
H5_DLL herr_t	H5FD_get_fs_type_map (const H5FD_t *file, H5FD_mem_t *type_map)
H5_DLL herr_t	H5FD_read (H5FD_t *file, H5FD_mem_t type, haddr_t addr, size_t size, void *buf)
H5_DLL herr_t	H5FD_write (H5FD_t *file, H5FD_mem_t type, haddr_t addr, size_t size, const void *buf)
H5_DLL herr_t	H5FD_flush (H5FD_t *file, hbool_t closing)
H5_DLL herr_t	H5FD_truncate (H5FD_t *file, hbool_t closing)
H5_DLL herr_t	H5FD_lock (H5FD_t *file, hbool_t rw)
H5_DLL herr_t	H5FD_unlock (H5FD_t *file)
H5_DLL herr_t	H5FD_get_fileno (const H5FD_t *file, unsigned long *filenum)
H5_DLL herr_t	H5FD_get_vfd_handle (H5FD_t *file, hid_t fapl, void **file_handle)
H5_DLL herr_t	H5FD_set_base_addr (H5FD_t *file, haddr_t base_addr)
H5_DLL haddr_t	H5FD_get_base_addr (const H5FD_t *file)
H5_DLL herr_t	H5FD_set_paged_aggr (H5FD_t *file, hbool_t paged)
H5_DLL haddr_t	H5FD_mpi_MPIOff_to_haddr (MPI_Offset mpi_off)
H5_DLL herr_t	H5FD_mpi_haddr_to_MPIOff (haddr_t addr, MPI_Offset *mpi_off)
H5_DLL herr_t	H5FD_mpio_wait_for_left_neighbor (H5FD_t *file)
H5_DLL herr_t	H5FD_mpio_signal_right_neighbor (H5FD_t *file)
H5_DLL herr_t	H5FD_set_mpio_atomicity (H5FD_t *file, hbool_t flag)
H5_DLL herr_t	H5FD_get_mpio_atomicity (H5FD_t *file, hbool_t *flag)
H5_DLL int	H5FD_mpi_get_rank (const H5FD_t *file)
H5_DLL int	H5FD_mpi_get_size (const H5FD_t *file)
H5_DLL MPI_Comm	H5FD_mpi_get_comm (const H5FD_t *_file)
H5_DLL herr_t	H5FD_get_mpi_info (H5FD_t *file, void **file_info)

Typedef Documentation

H5FD_class_mpi_t

typedef struct H5FD_class_mpi_t H5FD_class_mpi_t

Enumeration Type Documentation

H5FD_file_op_t

enum H5FD_file_op_t

Enumerator
OP_UNKNOWN
OP_READ
OP_WRITE

Function Documentation

H5FD_alloc()

H5_DLL haddr_t H5FD_alloc	(	H5FD_t *	file,
		H5FD_mem_t	type,
		struct H5F_t *	f,
		hsize_t	size,
		haddr_t *	frag_addr,
		hsize_t *	frag_size
	)

References H5FD_t::cls, f, FUNC_ENTER_NOAPI(), FUNC_LEAVE_NOAPI(), H5F_eoa_dirty(), H5FD__alloc_real(), H5FD_MEM_DEFAULT, H5FD_MEM_NTYPES, HDassert(), ret_value, size, and type.

Referenced by H5F__alloc().

H5FD_close()

H5_DLL herr_t H5FD_close

(

H5FD_t *

file

)

References H5FD_class_t::close, H5FD_t::cls, H5FD_t::driver_id, FAIL, FUNC_ENTER_NOAPI(), FUNC_LEAVE_NOAPI(), H5I_dec_ref(), HDassert(), and ret_value.

Referenced by H5F__is_hdf5(), H5F_open(), and H5FDclose().

H5FD_cmp()

H5_DLL int H5FD_cmp	(	const H5FD_t *	f1,
		const H5FD_t *	f2
	)

References H5FD_t::cls, H5FD_class_t::cmp, FUNC_ENTER_NOAPI(), FUNC_LEAVE_NOAPI(), and ret_value.

Referenced by H5F__sfile_search(), and H5FDcmp().

H5FD_driver_query()

H5_DLL herr_t H5FD_driver_query	(	const H5FD_class_t *	driver,
		unsigned long *	flags
	)

References flags, FUNC_LEAVE_NOAPI(), HDassert(), NULL, H5FD_class_t::query, and ret_value.

Referenced by H5FD_open(), and H5FDdriver_query().

H5FD_fapl_close()

H5_DLL herr_t H5FD_fapl_close	(	hid_t	driver_id,
		const void *	fapl
	)

References FAIL, H5FD_class_t::fapl_free, FUNC_ENTER_NOAPI(), FUNC_LEAVE_NOAPI(), H5I_object(), H5MM_xfree(), NULL, and ret_value.

Referenced by H5F_get_access_plist().

H5FD_fapl_get()

H5_DLL void* H5FD_fapl_get

(

H5FD_t *

file

)

References H5FD_t::cls, H5FD_class_t::fapl_get, FUNC_ENTER_NOAPI(), FUNC_LEAVE_NOAPI(), HDassert(), NULL, and ret_value.

Referenced by H5F_get_access_plist().

H5FD_flush()

H5_DLL herr_t H5FD_flush	(	H5FD_t *	file,
		hbool_t	closing
	)

References H5FD_t::cls, FAIL, H5FD_class_t::flush, FUNC_ENTER_NOAPI(), FUNC_LEAVE_NOAPI(), H5CX_get_dxpl(), H5E_CANTINIT, HDassert(), and ret_value.

Referenced by H5F_flush_tagged_metadata(), and H5FDflush().

H5FD_free()

H5_DLL herr_t H5FD_free	(	H5FD_t *	file,
		H5FD_mem_t	type,
		struct H5F_t *	f,
		haddr_t	addr,
		hsize_t	size
	)

References addr, H5FD_t::cls, f, FAIL, FUNC_ENTER_NOAPI(), FUNC_LEAVE_NOAPI(), H5F_eoa_dirty(), H5FD__free_real(), H5FD_MEM_DEFAULT, H5FD_MEM_NTYPES, HDassert(), ret_value, size, and type.

Referenced by H5F__free().

H5FD_get_base_addr()

H5_DLL haddr_t H5FD_get_base_addr

(

const H5FD_t *

file

)

References H5FD_t::base_addr, FUNC_LEAVE_NOAPI(), and HDassert().

Referenced by H5VL__native_file_optional().

H5FD_get_class()

H5_DLL H5FD_class_t* H5FD_get_class

(

hid_t

id

)

References H5FD_driver_prop_t::driver_id, FUNC_ENTER_NOAPI(), FUNC_LEAVE_NOAPI(), H5FD_get_class(), H5I_get_type(), H5I_object(), H5I_VFL, H5P_isa_class(), H5P_peek(), NULL, and ret_value.

Referenced by H5F_open(), and H5FD_get_class().

H5FD_get_eoa()

H5_DLL haddr_t H5FD_get_eoa	(	const H5FD_t *	file,
		H5FD_mem_t	type
	)

References H5FD_t::base_addr, H5FD_t::cls, FUNC_ENTER_NOAPI(), FUNC_LEAVE_NOAPI(), H5FD_class_t::get_eoa, H5E_CANTINIT, HDassert(), ret_value, and type.

Referenced by H5F__get_file_image(), H5F__get_max_eof_eoa(), H5F_get_eoa(), H5F_shared_get_eoa(), H5FD_locate_signature(), and H5FDget_eoa().

H5FD_get_eof()

H5_DLL haddr_t H5FD_get_eof	(	const H5FD_t *	file,
		H5FD_mem_t	type
	)

References H5FD_t::base_addr, H5FD_t::cls, FUNC_ENTER_NOAPI(), FUNC_LEAVE_NOAPI(), H5FD_class_t::get_eof, HDassert(), H5FD_t::maxaddr, ret_value, and type.

Referenced by H5F__get_max_eof_eoa(), H5FD_locate_signature(), and H5FDget_eof().

H5FD_get_feature_flags()

H5_DLL herr_t H5FD_get_feature_flags	(	const H5FD_t *	file,
		unsigned long *	feature_flags
	)

References H5FD_t::feature_flags, FUNC_LEAVE_NOAPI(), and HDassert().

H5FD_get_fileno()

H5_DLL herr_t H5FD_get_fileno	(	const H5FD_t *	file,
		unsigned long *	filenum
	)

References H5FD_t::fileno, FUNC_LEAVE_NOAPI(), and HDassert().

Referenced by H5F_get_fileno().

H5FD_get_fs_type_map()

H5_DLL herr_t H5FD_get_fs_type_map	(	const H5FD_t *	file,
		H5FD_mem_t *	type_map
	)

References H5FD_t::cls, FAIL, H5FD_class_t::fl_map, FUNC_ENTER_NOAPI(), FUNC_LEAVE_NOAPI(), H5FD_class_t::get_type_map, H5MM_memcpy(), HDassert(), and ret_value.

H5FD_get_maxaddr()

H5_DLL haddr_t H5FD_get_maxaddr

(

const H5FD_t *

file

)

References FUNC_ENTER_NOAPI(), FUNC_LEAVE_NOAPI(), HDassert(), H5FD_t::maxaddr, and ret_value.

H5FD_get_mpi_info()

H5_DLL herr_t H5FD_get_mpi_info	(	H5FD_t *	file,
		void **	file_info
	)

References H5FD_t::cls, FAIL, FUNC_LEAVE_NOAPI(), H5FD_class_mpi_t::get_mpi_info, HDassert(), and ret_value.

Referenced by H5F_get_mpi_info().

H5FD_get_mpio_atomicity()

H5_DLL herr_t H5FD_get_mpio_atomicity	(	H5FD_t *	file,
		hbool_t *	flag
	)

References ret_value.

Referenced by H5F_get_mpi_atomicity().

H5FD_get_vfd_handle()

H5_DLL herr_t H5FD_get_vfd_handle	(	H5FD_t *	file,
		hid_t	fapl,
		void **	file_handle
	)

References H5FD_t::cls, FAIL, fapl_id, FUNC_ENTER_NOAPI(), FUNC_LEAVE_NOAPI(), H5FD_class_t::get_handle, HDassert(), NULL, and ret_value.

Referenced by H5F_get_mpi_handle(), H5F_get_vfd_handle(), and H5FDget_vfd_handle().

H5FD_locate_signature()

H5_DLL herr_t H5FD_locate_signature	(	H5FD_t *	file,
		haddr_t *	sig_addr
	)

References addr, eoa, eof, FAIL, FUNC_LEAVE_NOAPI(), H5E_CANTINIT, H5FD_get_eoa(), H5FD_get_eof(), H5FD_MEM_SUPER, H5FD_read(), H5FD_set_eoa(), HDassert(), n, and ret_value.

Referenced by H5F__is_hdf5(), and H5F__super_read().

H5FD_lock()

H5_DLL herr_t H5FD_lock	(	H5FD_t *	file,
		hbool_t	rw
	)

References H5FD_t::cls, FAIL, FUNC_ENTER_NOAPI(), FUNC_LEAVE_NOAPI(), HDassert(), H5FD_class_t::lock, ret_value, and rw.

Referenced by H5FDlock().

H5FD_mpi_get_comm()

H5_DLL MPI_Comm H5FD_mpi_get_comm

(

const H5FD_t *

_file

)

References H5FD_t::cls, FUNC_ENTER_NOAPI(), FUNC_LEAVE_NOAPI(), H5FD_class_mpi_t::get_comm, HDassert(), and ret_value.

Referenced by H5F_mpi_get_comm().

H5FD_mpi_get_rank()

H5_DLL int H5FD_mpi_get_rank

(

const H5FD_t *

file

)

References H5FD_t::cls, FAIL, FUNC_ENTER_NOAPI(), FUNC_LEAVE_NOAPI(), H5FD_class_mpi_t::get_rank, HDassert(), and ret_value.

Referenced by H5F_mpi_get_rank().

H5FD_mpi_get_size()

H5_DLL int H5FD_mpi_get_size

(

const H5FD_t *

file

)

References H5FD_t::cls, FAIL, FUNC_ENTER_NOAPI(), FUNC_LEAVE_NOAPI(), H5FD_class_mpi_t::get_size, HDassert(), and ret_value.

Referenced by H5F_mpi_get_size(), and H5F_shared_mpi_get_size().

H5FD_mpi_haddr_to_MPIOff()

H5_DLL herr_t H5FD_mpi_haddr_to_MPIOff	(	haddr_t	addr,
		MPI_Offset *	mpi_off
	)

References addr, FAIL, FUNC_LEAVE_NOAPI(), HDassert(), and ret_value.

H5FD_mpi_MPIOff_to_haddr()

H5_DLL haddr_t H5FD_mpi_MPIOff_to_haddr

(

MPI_Offset

mpi_off

)

References FUNC_LEAVE_NOAPI(), and ret_value.

H5FD_mpio_signal_right_neighbor()

H5_DLL herr_t H5FD_mpio_signal_right_neighbor

(

H5FD_t *

file

)

References H5FD_mpio_t::comm, H5FD_t::driver_id, FAIL, FUNC_ENTER_NOAPI(), FUNC_LEAVE_NOAPI(), HDassert(), H5FD_mpio_t::mpi_rank, H5FD_mpio_t::mpi_size, H5FD_mpio_t::pub, and ret_value.

H5FD_mpio_wait_for_left_neighbor()

H5_DLL herr_t H5FD_mpio_wait_for_left_neighbor

(

H5FD_t *

file

)

References H5FD_mpio_t::comm, H5FD_t::driver_id, FAIL, FUNC_ENTER_NOAPI(), FUNC_LEAVE_NOAPI(), HDassert(), H5FD_mpio_t::mpi_rank, H5FD_mpio_t::pub, and ret_value.

H5FD_open()

H5_DLL H5FD_t* H5FD_open	(	const char *	name,
		unsigned	flags,
		hid_t	fapl_id,
		haddr_t	maxaddr
	)

References H5FD_t::access_flags, H5FD_t::alignment, H5FD_file_image_info_t::buffer, H5FD_t::cls, H5FD_driver_prop_t::driver_id, H5FD_t::driver_id, fapl_id, flags, FUNC_ENTER_NOAPI(), H5E_BADVALUE, H5E_CANTINIT, H5FD_driver_query(), H5I_inc_ref(), H5I_object(), H5P_get(), H5P_peek(), HDassert(), H5FD_class_t::maxaddr, H5FD_t::maxaddr, maxaddr, name, NULL, H5FD_class_t::open, ret_value, H5FD_file_image_info_t::size, and H5FD_t::threshold.

Referenced by H5F__is_hdf5(), H5F_open(), and H5FDopen().

H5FD_read()

H5_DLL herr_t H5FD_read	(	H5FD_t *	file,
		H5FD_mem_t	type,
		haddr_t	addr,
		size_t	size,
		void *	buf
	)

References H5FD_t::access_flags, addr, H5FD_t::base_addr, H5FD_t::cls, eoa, FAIL, FUNC_ENTER_NOAPI(), FUNC_LEAVE_NOAPI(), H5FD_class_t::get_eoa, H5CX_get_dxpl(), H5E_CANTINIT, HDassert(), H5FD_class_t::read, ret_value, size, and type.

Referenced by H5F__get_file_image(), H5FD_locate_signature(), and H5FDread().

H5FD_register()

H5_DLL hid_t H5FD_register	(	const void *	cls,
		size_t	size,
		hbool_t	app_ref
	)

References H5FD_class_t::close, H5FD_class_t::fl_map, FUNC_ENTER_NOAPI(), FUNC_LEAVE_NOAPI(), H5FD_class_t::get_eoa, H5FD_class_t::get_eof, H5E_CANTREGISTER, H5FD_MEM_DEFAULT, H5FD_MEM_NOLIST, H5FD_MEM_NTYPES, H5I_register(), H5I_VFL, H5MM_malloc(), H5MM_memcpy(), H5MM_xfree(), HDassert(), NULL, H5FD_class_t::open, H5FD_class_t::read, ret_value, H5FD_class_t::set_eoa, size, type, and H5FD_class_t::write.

Referenced by H5FDregister().

H5FD_sb_encode()

H5_DLL herr_t H5FD_sb_encode	(	H5FD_t *	file,
		char *	name,
		uint8_t *	buf
	)

References H5FD_t::cls, FAIL, FUNC_ENTER_NOAPI(), FUNC_LEAVE_NOAPI(), H5E_CANTINIT, HDassert(), name, ret_value, and H5FD_class_t::sb_encode.

H5FD_sb_load()

H5_DLL herr_t H5FD_sb_load	(	H5FD_t *	file,
		const char *	name,
		const uint8_t *	buf
	)

References FAIL, FUNC_ENTER_NOAPI(), H5E_BADVALUE, HDassert(), name, and ret_value.

H5FD_sb_size()

H5_DLL hsize_t H5FD_sb_size

(

H5FD_t *

file

)

References H5FD_t::cls, FUNC_ENTER_NOAPI(), FUNC_LEAVE_NOAPI(), HDassert(), ret_value, and H5FD_class_t::sb_size.

H5FD_set_base_addr()

H5_DLL herr_t H5FD_set_base_addr	(	H5FD_t *	file,
		haddr_t	base_addr
	)

References H5FD_t::base_addr, FUNC_LEAVE_NOAPI(), and HDassert().

Referenced by H5F__set_base_addr().

H5FD_set_eoa()

H5_DLL herr_t H5FD_set_eoa	(	H5FD_t *	file,
		H5FD_mem_t	type,
		haddr_t	addr
	)

References addr, H5FD_t::base_addr, H5FD_t::cls, FAIL, FUNC_ENTER_NOAPI(), FUNC_LEAVE_NOAPI(), H5E_CANTINIT, HDassert(), maxaddr, ret_value, H5FD_class_t::set_eoa, and type.

Referenced by H5F__set_eoa(), H5FD_locate_signature(), H5FDset_eoa(), and if().

H5FD_set_feature_flags()

H5_DLL herr_t H5FD_set_feature_flags	(	H5FD_t *	file,
		unsigned long	feature_flags
	)

References H5FD_t::feature_flags, FUNC_LEAVE_NOAPI(), and HDassert().

Referenced by H5F__start_swmr_write().

H5FD_set_mpio_atomicity()

H5_DLL herr_t H5FD_set_mpio_atomicity	(	H5FD_t *	file,
		hbool_t	flag
	)

References ret_value.

Referenced by H5F_set_mpi_atomicity().

H5FD_set_paged_aggr()

H5_DLL herr_t H5FD_set_paged_aggr	(	H5FD_t *	file,
		hbool_t	paged
	)

References FUNC_LEAVE_NOAPI(), HDassert(), and H5FD_t::paged_aggr.

Referenced by H5F__set_paged_aggr().

H5FD_term_interface()

H5_DLL int H5FD_term_interface

(

void

)

H5FD_truncate()

H5_DLL herr_t H5FD_truncate	(	H5FD_t *	file,
		hbool_t	closing
	)

References H5FD_t::cls, FAIL, FUNC_ENTER_NOAPI(), FUNC_LEAVE_NOAPI(), H5CX_get_dxpl(), HDassert(), ret_value, and H5FD_class_t::truncate.

Referenced by H5FDtruncate().

H5FD_try_extend()

H5_DLL htri_t H5FD_try_extend	(	H5FD_t *	file,
		H5FD_mem_t	type,
		struct H5F_t *	f,
		haddr_t	blk_end,
		hsize_t	extra_requested
	)

References H5FD_t::base_addr, H5FD_t::cls, eoa, f, FAIL, FUNC_ENTER_NOAPI(), H5FD_class_t::get_eoa, H5FD_MEM_DEFAULT, H5FD_MEM_NTYPES, HDassert(), ret_value, and type.

Referenced by H5F__try_extend().

H5FD_unlock()

H5_DLL herr_t H5FD_unlock

(

H5FD_t *

file

)

References H5FD_t::cls, FAIL, FUNC_ENTER_NOAPI(), FUNC_LEAVE_NOAPI(), HDassert(), ret_value, and H5FD_class_t::unlock.

Referenced by H5F__start_swmr_write(), and H5FDunlock().

H5FD_write()

H5_DLL herr_t H5FD_write	(	H5FD_t *	file,
		H5FD_mem_t	type,
		haddr_t	addr,
		size_t	size,
		const void *	buf
	)

References addr, H5FD_t::base_addr, H5FD_t::cls, eoa, FAIL, FUNC_ENTER_NOAPI(), FUNC_LEAVE_NOAPI(), H5FD_class_t::get_eoa, H5CX_get_dxpl(), H5E_CANTINIT, HDassert(), ret_value, size, type, and H5FD_class_t::write.

Referenced by H5F__accum_flush(), H5F__accum_free(), and H5FDwrite().