MISR Toolkit  1.5.1
Data Structures | Macros | Typedefs | Enumerations | Functions | Variables
H5Fpkg.h File Reference
#include "H5Fprivate.h"
#include "H5Bpublic.h"
#include "H5private.h"
#include "H5ACprivate.h"
#include "H5FLprivate.h"
#include "H5FOprivate.h"
#include "H5FSprivate.h"
#include "H5Gprivate.h"
#include "H5Oprivate.h"
#include "H5RCprivate.h"

Go to the source code of this file.

Data Structures

struct  H5F_blk_aggr_t
 
struct  H5F_meta_accum_t
 
struct  H5F_mount_t
 
struct  H5F_mtab_t
 
struct  H5F_super_t
 
struct  H5F_file_t
 
struct  H5F_t
 

Macros

#define H5F_SUPER_WRITE_ACCESS   0x01
 
#define H5F_SUPER_FILE_OK   0x02
 
#define H5F_SUPER_ALL_FLAGS   (H5F_SUPER_WRITE_ACCESS | H5F_SUPER_FILE_OK)
 
#define H5F_ACC_PUBLIC_FLAGS   0x001fu
 
#define H5F_FS_MERGE_METADATA   0x01 /* Section can merge with metadata aggregator */
 
#define H5F_FS_MERGE_RAWDATA   0x02 /* Section can merge with small 'raw' data aggregator */
 
#define H5F_HAVE_FREE_SPACE_MANAGER(F)   TRUE /* Currently always have a free space manager */
 
#define H5F_MAX_DRVINFOBLOCK_SIZE   1024 /* Maximum size of superblock driver info buffer */
 
#define H5F_DRVINFOBLOCK_HDR_SIZE   16 /* Size of superblock driver info header */
 
#define H5F_SIZEOF_CHKSUM   4 /* Checksum size in the file */
 
#define H5F_SUPERBLOCK_FIXED_SIZE
 
#define H5F_SUPERBLOCK_VARLEN_SIZE_COMMON
 
#define H5F_SUPERBLOCK_VARLEN_SIZE_V0(f)
 
#define H5F_SUPERBLOCK_VARLEN_SIZE_V1(f)
 
#define H5F_SUPERBLOCK_VARLEN_SIZE_V2(f)
 
#define H5F_SUPERBLOCK_VARLEN_SIZE(v, f)
 
#define H5F_SUPERBLOCK_SIZE(v, f)
 

Typedefs

typedef struct H5F_efc_t H5F_efc_t
 
typedef struct H5F_meta_accum_t H5F_meta_accum_t
 
typedef enum H5F_fs_state_t H5F_fs_state_t
 
typedef struct H5F_mount_t H5F_mount_t
 
typedef struct H5F_mtab_t H5F_mtab_t
 
typedef struct H5F_super_t H5F_super_t
 

Enumerations

enum  H5F_fs_state_t {
  H5F_FS_STATE_CLOSED,
  H5F_FS_STATE_OPEN,
  H5F_FS_STATE_DELETING
}
 

Functions

 H5FL_EXTERN (H5F_t)
 
 H5FL_EXTERN (H5F_file_t)
 
H5_DLL herr_t H5F_init (void)
 
H5_DLL herr_t H5F__term_deprec_interface (void)
 
H5F_t * H5F_new (H5F_file_t *shared, unsigned flags, hid_t fcpl_id, hid_t fapl_id, H5FD_t *lf)
 
herr_t H5F_dest (H5F_t *f, hid_t dxpl_id, hbool_t flush)
 
H5_DLL herr_t H5F_flush (H5F_t *f, hid_t dxpl_id, hbool_t closing)
 
H5_DLL htri_t H5F_is_hdf5 (const char *name)
 
H5_DLL herr_t H5F_get_objects (const H5F_t *f, unsigned types, size_t max_index, hid_t *obj_id_list, hbool_t app_ref, size_t *obj_id_count_ptr)
 
H5_DLL herr_t H5F_close (H5F_t *f)
 
H5_DLL herr_t H5F_close_mounts (H5F_t *f)
 
H5_DLL int H5F_term_unmount_cb (void *obj_ptr, hid_t obj_id, void *key)
 
H5_DLL herr_t H5F_mount_count_ids (H5F_t *f, unsigned *nopen_files, unsigned *nopen_objs)
 
H5_DLL herr_t H5F_super_init (H5F_t *f, hid_t dxpl_id)
 
H5_DLL herr_t H5F_super_read (H5F_t *f, hid_t dxpl_id)
 
H5_DLL herr_t H5F_super_size (H5F_t *f, hid_t dxpl_id, hsize_t *super_size, hsize_t *super_ext_info)
 
H5_DLL herr_t H5F_super_free (H5F_super_t *sblock)
 
H5_DLL herr_t H5F_super_ext_open (H5F_t *f, haddr_t ext_addr, H5O_loc_t *ext_ptr)
 
H5_DLL herr_t H5F_super_ext_write_msg (H5F_t *f, hid_t dxpl_id, unsigned id, void *mesg, hbool_t may_create)
 
H5_DLL herr_t H5F_super_ext_close (H5F_t *f, H5O_loc_t *ext_ptr, hid_t dxpl_id, hbool_t was_created)
 
H5_DLL herr_t H5F__accum_read (const H5F_io_info_t *fio_info, H5FD_mem_t type, haddr_t addr, size_t size, void *buf)
 
H5_DLL herr_t H5F__accum_write (const H5F_io_info_t *fio_info, H5FD_mem_t type, haddr_t addr, size_t size, const void *buf)
 
H5_DLL herr_t H5F__accum_free (const H5F_io_info_t *fio_info, H5FD_mem_t type, haddr_t addr, hsize_t size)
 
H5_DLL herr_t H5F__accum_flush (const H5F_io_info_t *fio_info)
 
H5_DLL herr_t H5F__accum_reset (const H5F_io_info_t *fio_info, hbool_t flush)
 
H5_DLL herr_t H5F_sfile_add (H5F_file_t *shared)
 
H5_DLL H5F_file_t * H5F_sfile_search (H5FD_t *lf)
 
H5_DLL herr_t H5F_sfile_remove (H5F_file_t *shared)
 
H5_DLL H5F_efc_t * H5F_efc_create (unsigned max_nfiles)
 
H5_DLL unsigned H5F_efc_max_nfiles (H5F_efc_t *efc)
 
H5_DLL herr_t H5F_efc_release (H5F_efc_t *efc)
 
H5_DLL herr_t H5F_efc_destroy (H5F_efc_t *efc)
 
H5_DLL herr_t H5F_efc_try_close (H5F_t *f)
 

Variables

H5_DLLVAR const H5AC_class_t H5AC_SUPERBLOCK [1]
 

Macro Definition Documentation

◆ H5F_ACC_PUBLIC_FLAGS

#define H5F_ACC_PUBLIC_FLAGS   0x001fu

Definition at line 60 of file H5Fpkg.h.

◆ H5F_DRVINFOBLOCK_HDR_SIZE

#define H5F_DRVINFOBLOCK_HDR_SIZE   16 /* Size of superblock driver info header */

Definition at line 71 of file H5Fpkg.h.

◆ H5F_FS_MERGE_METADATA

#define H5F_FS_MERGE_METADATA   0x01 /* Section can merge with metadata aggregator */

Definition at line 63 of file H5Fpkg.h.

◆ H5F_FS_MERGE_RAWDATA

#define H5F_FS_MERGE_RAWDATA   0x02 /* Section can merge with small 'raw' data aggregator */

Definition at line 64 of file H5Fpkg.h.

◆ H5F_HAVE_FREE_SPACE_MANAGER

#define H5F_HAVE_FREE_SPACE_MANAGER (   F)    TRUE /* Currently always have a free space manager */

Definition at line 67 of file H5Fpkg.h.

◆ H5F_MAX_DRVINFOBLOCK_SIZE

#define H5F_MAX_DRVINFOBLOCK_SIZE   1024 /* Maximum size of superblock driver info buffer */

Definition at line 70 of file H5Fpkg.h.

◆ H5F_SIZEOF_CHKSUM

#define H5F_SIZEOF_CHKSUM   4 /* Checksum size in the file */

Definition at line 74 of file H5Fpkg.h.

◆ H5F_SUPER_ALL_FLAGS

#define H5F_SUPER_ALL_FLAGS   (H5F_SUPER_WRITE_ACCESS | H5F_SUPER_FILE_OK)

Definition at line 57 of file H5Fpkg.h.

◆ H5F_SUPER_FILE_OK

#define H5F_SUPER_FILE_OK   0x02

Definition at line 56 of file H5Fpkg.h.

◆ H5F_SUPER_WRITE_ACCESS

#define H5F_SUPER_WRITE_ACCESS   0x01

Definition at line 55 of file H5Fpkg.h.

◆ H5F_SUPERBLOCK_FIXED_SIZE

#define H5F_SUPERBLOCK_FIXED_SIZE
Value:
( H5F_SIGNATURE_LEN \
+ 1) /* superblock version */

Definition at line 77 of file H5Fpkg.h.

◆ H5F_SUPERBLOCK_SIZE

#define H5F_SUPERBLOCK_SIZE (   v,
  f 
)
Value:
( H5F_SUPERBLOCK_FIXED_SIZE \
+ H5F_SUPERBLOCK_VARLEN_SIZE(v, f))
H5F_SUPERBLOCK_VARLEN_SIZE
#define H5F_SUPERBLOCK_VARLEN_SIZE(v, f)
Definition: H5Fpkg.h:112
H5F_SUPERBLOCK_FIXED_SIZE
#define H5F_SUPERBLOCK_FIXED_SIZE
Definition: H5Fpkg.h:77

Definition at line 118 of file H5Fpkg.h.

◆ H5F_SUPERBLOCK_VARLEN_SIZE

#define H5F_SUPERBLOCK_VARLEN_SIZE (   v,
  f 
)
Value:
( \
(v == 0 ? H5F_SUPERBLOCK_VARLEN_SIZE_V0(f) : 0) \
+ (v == 1 ? H5F_SUPERBLOCK_VARLEN_SIZE_V1(f) : 0) \
+ (v == 2 ? H5F_SUPERBLOCK_VARLEN_SIZE_V2(f) : 0))
H5F_SUPERBLOCK_VARLEN_SIZE_V0
#define H5F_SUPERBLOCK_VARLEN_SIZE_V0(f)
Definition: H5Fpkg.h:88
H5F_SUPERBLOCK_VARLEN_SIZE_V1
#define H5F_SUPERBLOCK_VARLEN_SIZE_V1(f)
Definition: H5Fpkg.h:95
H5F_SUPERBLOCK_VARLEN_SIZE_V2
#define H5F_SUPERBLOCK_VARLEN_SIZE_V2(f)
Definition: H5Fpkg.h:104

Definition at line 112 of file H5Fpkg.h.

◆ H5F_SUPERBLOCK_VARLEN_SIZE_COMMON

#define H5F_SUPERBLOCK_VARLEN_SIZE_COMMON
Value:
(2 /* freespace, and root group versions */ \
+ 1 /* reserved */ \
+ 3 /* shared header vers, size of address, size of lengths */ \
+ 1 /* reserved */ \
+ 4 /* group leaf k, group internal k */ \
+ 4) /* consistency flags */

Definition at line 81 of file H5Fpkg.h.

◆ H5F_SUPERBLOCK_VARLEN_SIZE_V0

#define H5F_SUPERBLOCK_VARLEN_SIZE_V0 (   f)
Value:
( H5F_SUPERBLOCK_VARLEN_SIZE_COMMON /* Common variable-length info */ \
+ H5F_SIZEOF_ADDR(f) /* base address */ \
+ H5F_SIZEOF_ADDR(f) /* <unused> */ \
+ H5F_SIZEOF_ADDR(f) /* EOF address */ \
+ H5F_SIZEOF_ADDR(f) /* driver block address */ \
+ H5G_SIZEOF_ENTRY(f)) /* root group ptr */
H5F_SUPERBLOCK_VARLEN_SIZE_COMMON
#define H5F_SUPERBLOCK_VARLEN_SIZE_COMMON
Definition: H5Fpkg.h:81

Definition at line 88 of file H5Fpkg.h.

◆ H5F_SUPERBLOCK_VARLEN_SIZE_V1

#define H5F_SUPERBLOCK_VARLEN_SIZE_V1 (   f)
Value:
( H5F_SUPERBLOCK_VARLEN_SIZE_COMMON /* Common variable-length info */ \
+ 2 /* indexed B-tree internal k */ \
+ 2 /* reserved */ \
+ H5F_SIZEOF_ADDR(f) /* base address */ \
+ H5F_SIZEOF_ADDR(f) /* <unused> */ \
+ H5F_SIZEOF_ADDR(f) /* EOF address */ \
+ H5F_SIZEOF_ADDR(f) /* driver block address */ \
+ H5G_SIZEOF_ENTRY(f)) /* root group ptr */
H5F_SUPERBLOCK_VARLEN_SIZE_COMMON
#define H5F_SUPERBLOCK_VARLEN_SIZE_COMMON
Definition: H5Fpkg.h:81

Definition at line 95 of file H5Fpkg.h.

◆ H5F_SUPERBLOCK_VARLEN_SIZE_V2

#define H5F_SUPERBLOCK_VARLEN_SIZE_V2 (   f)
Value:
( 2 /* size of address, size of lengths */ \
+ 1 /* consistency flags */ \
+ H5F_SIZEOF_ADDR(f) /* base address */ \
+ H5F_SIZEOF_ADDR(f) /* superblock extension address */ \
+ H5F_SIZEOF_ADDR(f) /* EOF address */ \
+ H5F_SIZEOF_ADDR(f) /* root group object header address */ \
+ H5F_SIZEOF_CHKSUM) /* superblock checksum (keep this last) */
H5F_SIZEOF_CHKSUM
#define H5F_SIZEOF_CHKSUM
Definition: H5Fpkg.h:74

Definition at line 104 of file H5Fpkg.h.

Typedef Documentation

◆ H5F_efc_t

typedef struct H5F_efc_t H5F_efc_t

Definition at line 124 of file H5Fpkg.h.

◆ H5F_fs_state_t

typedef enum H5F_fs_state_t H5F_fs_state_t

◆ H5F_meta_accum_t

typedef struct H5F_meta_accum_t H5F_meta_accum_t

◆ H5F_mount_t

typedef struct H5F_mount_t H5F_mount_t

◆ H5F_mtab_t

typedef struct H5F_mtab_t H5F_mtab_t

◆ H5F_super_t

typedef struct H5F_super_t H5F_super_t

Enumeration Type Documentation

◆ H5F_fs_state_t

enum H5F_fs_state_t
Enumerator
H5F_FS_STATE_CLOSED 
H5F_FS_STATE_OPEN 
H5F_FS_STATE_DELETING 

Definition at line 147 of file H5Fpkg.h.

Function Documentation

◆ H5F__accum_flush()

H5_DLL herr_t H5F__accum_flush ( const H5F_io_info_t *  fio_info)

◆ H5F__accum_free()

H5_DLL herr_t H5F__accum_free ( const H5F_io_info_t *  fio_info,
H5FD_mem_t  type,
haddr_t  addr,
hsize_t  size 
)

◆ H5F__accum_read()

H5_DLL herr_t H5F__accum_read ( const H5F_io_info_t *  fio_info,
H5FD_mem_t  type,
haddr_t  addr,
size_t  size,
void *  buf 
)

◆ H5F__accum_reset()

H5_DLL herr_t H5F__accum_reset ( const H5F_io_info_t *  fio_info,
hbool_t  flush 
)

◆ H5F__accum_write()

H5_DLL herr_t H5F__accum_write ( const H5F_io_info_t *  fio_info,
H5FD_mem_t  type,
haddr_t  addr,
size_t  size,
const void *  buf 
)

◆ H5F__term_deprec_interface()

H5_DLL herr_t H5F__term_deprec_interface ( void  )

◆ H5F_close()

H5_DLL herr_t H5F_close ( H5F_t *  f)

◆ H5F_close_mounts()

H5_DLL herr_t H5F_close_mounts ( H5F_t *  f)

◆ H5F_dest()

herr_t H5F_dest ( H5F_t *  f,
hid_t  dxpl_id,
hbool_t  flush 
)

◆ H5F_efc_create()

H5_DLL H5F_efc_t* H5F_efc_create ( unsigned  max_nfiles)

◆ H5F_efc_destroy()

H5_DLL herr_t H5F_efc_destroy ( H5F_efc_t *  efc)

◆ H5F_efc_max_nfiles()

H5_DLL unsigned H5F_efc_max_nfiles ( H5F_efc_t *  efc)

◆ H5F_efc_release()

H5_DLL herr_t H5F_efc_release ( H5F_efc_t *  efc)

◆ H5F_efc_try_close()

H5_DLL herr_t H5F_efc_try_close ( H5F_t *  f)

◆ H5F_flush()

H5_DLL herr_t H5F_flush ( H5F_t *  f,
hid_t  dxpl_id,
hbool_t  closing 
)

◆ H5F_get_objects()

H5_DLL herr_t H5F_get_objects ( const H5F_t *  f,
unsigned  types,
size_t  max_index,
hid_t *  obj_id_list,
hbool_t  app_ref,
size_t *  obj_id_count_ptr 
)

◆ H5F_init()

H5_DLL herr_t H5F_init ( void  )

◆ H5F_is_hdf5()

H5_DLL htri_t H5F_is_hdf5 ( const char *  name)

◆ H5F_mount_count_ids()

H5_DLL herr_t H5F_mount_count_ids ( H5F_t *  f,
unsigned *  nopen_files,
unsigned *  nopen_objs 
)

◆ H5F_new()

H5F_t* H5F_new ( H5F_file_t *  shared,
unsigned  flags,
hid_t  fcpl_id,
hid_t  fapl_id,
H5FD_t *  lf 
)

◆ H5F_sfile_add()

H5_DLL herr_t H5F_sfile_add ( H5F_file_t *  shared)

◆ H5F_sfile_remove()

H5_DLL herr_t H5F_sfile_remove ( H5F_file_t *  shared)

◆ H5F_sfile_search()

H5_DLL H5F_file_t* H5F_sfile_search ( H5FD_t *  lf)

◆ H5F_super_ext_close()

H5_DLL herr_t H5F_super_ext_close ( H5F_t *  f,
H5O_loc_t *  ext_ptr,
hid_t  dxpl_id,
hbool_t  was_created 
)

◆ H5F_super_ext_open()

H5_DLL herr_t H5F_super_ext_open ( H5F_t *  f,
haddr_t  ext_addr,
H5O_loc_t *  ext_ptr 
)

◆ H5F_super_ext_write_msg()

H5_DLL herr_t H5F_super_ext_write_msg ( H5F_t *  f,
hid_t  dxpl_id,
unsigned  id,
void *  mesg,
hbool_t  may_create 
)

◆ H5F_super_free()

H5_DLL herr_t H5F_super_free ( H5F_super_t *  sblock)

◆ H5F_super_init()

H5_DLL herr_t H5F_super_init ( H5F_t *  f,
hid_t  dxpl_id 
)

◆ H5F_super_read()

H5_DLL herr_t H5F_super_read ( H5F_t *  f,
hid_t  dxpl_id 
)

◆ H5F_super_size()

H5_DLL herr_t H5F_super_size ( H5F_t *  f,
hid_t  dxpl_id,
hsize_t *  super_size,
hsize_t *  super_ext_info 
)

◆ H5F_term_unmount_cb()

H5_DLL int H5F_term_unmount_cb ( void *  obj_ptr,
hid_t  obj_id,
void *  key 
)

◆ H5FL_EXTERN() [1/2]

H5FL_EXTERN ( H5F_t  )

◆ H5FL_EXTERN() [2/2]

H5FL_EXTERN ( H5F_file_t  )

Variable Documentation

◆ H5AC_SUPERBLOCK

H5_DLLVAR const H5AC_class_t H5AC_SUPERBLOCK[1]

Definition at line 279 of file H5Fpkg.h.

MISR Toolkit - Copyright © 2005 - 2020 Jet Propulsion Laboratory
Generated on Fri Jun 19 2020 22:49:54