mirror of
https://github.com/HDFGroup/hdf5.git
synced 2025-02-17 16:10:24 +08:00
4be636f4f0
Various code cleanups and refactor recent changes for h5stat to fit into the existing library data structures better. Tested on: Mac OS X/32 10.4.10 (amazon) FreeBSD/32 6.2 (duty) Linux/32 2.6 (chicago) Linux/64 2.6 (chicago2)
152 lines
6.5 KiB
C
152 lines
6.5 KiB
C
/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
|
|
* Copyright by The HDF Group. *
|
|
* 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://hdfgroup.org/HDF5/doc/Copyright.html. If you do not have *
|
|
* access to either file, you may request a copy from help@hdfgroup.org. *
|
|
* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
|
|
|
|
/*
|
|
* This file contains public declarations for the H5F module.
|
|
*/
|
|
#ifndef _H5Fpublic_H
|
|
#define _H5Fpublic_H
|
|
|
|
/* Public header files needed by this file */
|
|
#include "H5public.h"
|
|
#include "H5Cpublic.h"
|
|
#include "H5ACpublic.h"
|
|
#include "H5Ipublic.h"
|
|
|
|
/* When this header is included from a private header, don't make calls to H5check() */
|
|
#undef H5CHECK
|
|
#ifndef _H5private_H
|
|
#define H5CHECK H5check(),
|
|
#else /* _H5private_H */
|
|
#define H5CHECK
|
|
#endif /* _H5private_H */
|
|
|
|
/*
|
|
* These are the bits that can be passed to the `flags' argument of
|
|
* H5Fcreate() and H5Fopen(). Use the bit-wise OR operator (|) to combine
|
|
* them as needed. As a side effect, they call H5check_version() to make sure
|
|
* that the application is compiled with a version of the hdf5 header files
|
|
* which are compatible with the library to which the application is linked.
|
|
* We're assuming that these constants are used rather early in the hdf5
|
|
* session.
|
|
*
|
|
*/
|
|
#define H5F_ACC_RDONLY (H5CHECK 0x0000u) /*absence of rdwr => rd-only */
|
|
#define H5F_ACC_RDWR (H5CHECK 0x0001u) /*open for read and write */
|
|
#define H5F_ACC_TRUNC (H5CHECK 0x0002u) /*overwrite existing files */
|
|
#define H5F_ACC_EXCL (H5CHECK 0x0004u) /*fail if file already exists*/
|
|
#define H5F_ACC_DEBUG (H5CHECK 0x0008u) /*print debug info */
|
|
#define H5F_ACC_CREAT (H5CHECK 0x0010u) /*create non-existing files */
|
|
|
|
/* Flags for H5Fget_obj_count() & H5Fget_obj_ids() calls */
|
|
#define H5F_OBJ_FILE (0x0001u) /* File objects */
|
|
#define H5F_OBJ_DATASET (0x0002u) /* Dataset objects */
|
|
#define H5F_OBJ_GROUP (0x0004u) /* Group objects */
|
|
#define H5F_OBJ_DATATYPE (0x0008u) /* Named datatype objects */
|
|
#define H5F_OBJ_ATTR (0x0010u) /* Attribute objects */
|
|
#define H5F_OBJ_ALL (H5F_OBJ_FILE|H5F_OBJ_DATASET|H5F_OBJ_GROUP|H5F_OBJ_DATATYPE|H5F_OBJ_ATTR)
|
|
#define H5F_OBJ_LOCAL (0x0020u) /* Restrict search to objects opened through current file ID */
|
|
/* (as opposed to objects opened through any file ID accessing this file) */
|
|
|
|
#define H5F_FAMILY_DEFAULT (hsize_t)0
|
|
|
|
#ifdef H5_HAVE_PARALLEL
|
|
/*
|
|
* Use this constant string as the MPI_Info key to set H5Fmpio debug flags.
|
|
* To turn on H5Fmpio debug flags, set the MPI_Info value with this key to
|
|
* have the value of a string consisting of the characters that turn on the
|
|
* desired flags.
|
|
*/
|
|
#define H5F_MPIO_DEBUG_KEY "H5F_mpio_debug_key"
|
|
#endif /* H5_HAVE_PARALLEL */
|
|
|
|
/* The difference between a single file and a set of mounted files */
|
|
typedef enum H5F_scope_t {
|
|
H5F_SCOPE_LOCAL = 0, /*specified file handle only */
|
|
H5F_SCOPE_GLOBAL = 1, /*entire virtual file */
|
|
H5F_SCOPE_DOWN = 2 /*for internal use only */
|
|
} H5F_scope_t;
|
|
|
|
/* Unlimited file size for H5Pset_external() */
|
|
#define H5F_UNLIMITED ((hsize_t)(-1L))
|
|
|
|
/* How does file close behave?
|
|
* H5F_CLOSE_DEFAULT - Use the degree pre-defined by underlining VFL
|
|
* H5F_CLOSE_WEAK - file closes only after all opened objects are closed
|
|
* H5F_CLOSE_SEMI - if no opened objects, file is close; otherwise, file
|
|
close fails
|
|
* H5F_CLOSE_STRONG - if there are opened objects, close them first, then
|
|
close file
|
|
*/
|
|
typedef enum H5F_close_degree_t {
|
|
H5F_CLOSE_DEFAULT = 0,
|
|
H5F_CLOSE_WEAK = 1,
|
|
H5F_CLOSE_SEMI = 2,
|
|
H5F_CLOSE_STRONG = 3
|
|
} H5F_close_degree_t;
|
|
|
|
/* Current "global" information about file */
|
|
/* (just size info currently) */
|
|
typedef struct H5F_info_t {
|
|
hsize_t super_ext_size; /* Superblock extension size */
|
|
struct {
|
|
hsize_t hdr_size; /* Shared object header message header size */
|
|
H5_ih_info_t msgs_info; /* Shared object header message index & heap size */
|
|
} sohm;
|
|
} H5F_info_t;
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
/* Functions in H5F.c */
|
|
H5_DLL htri_t H5Fis_hdf5(const char *filename);
|
|
H5_DLL hid_t H5Fcreate(const char *filename, unsigned flags,
|
|
hid_t create_plist, hid_t access_plist);
|
|
H5_DLL hid_t H5Fopen(const char *filename, unsigned flags,
|
|
hid_t access_plist);
|
|
H5_DLL hid_t H5Freopen(hid_t file_id);
|
|
H5_DLL herr_t H5Fflush(hid_t object_id, H5F_scope_t scope);
|
|
H5_DLL herr_t H5Fclose(hid_t file_id);
|
|
H5_DLL hid_t H5Fget_create_plist(hid_t file_id);
|
|
H5_DLL hid_t H5Fget_access_plist(hid_t file_id);
|
|
H5_DLL herr_t H5Fget_intent(hid_t file_id, unsigned * intent);
|
|
H5_DLL int H5Fget_obj_count(hid_t file_id, unsigned types);
|
|
H5_DLL int H5Fget_obj_ids(hid_t file_id, unsigned types, int max_objs, hid_t *obj_id_list);
|
|
H5_DLL herr_t H5Fget_vfd_handle(hid_t file_id, hid_t fapl, void **file_handle);
|
|
H5_DLL herr_t H5Fmount(hid_t loc, const char *name, hid_t child, hid_t plist);
|
|
H5_DLL herr_t H5Funmount(hid_t loc, const char *name);
|
|
H5_DLL hssize_t H5Fget_freespace(hid_t file_id);
|
|
H5_DLL herr_t H5Fget_filesize(hid_t file_id, hsize_t *size);
|
|
H5_DLL herr_t H5Fget_mdc_config(hid_t file_id,
|
|
H5AC_cache_config_t * config_ptr);
|
|
H5_DLL herr_t H5Fset_mdc_config(hid_t file_id,
|
|
H5AC_cache_config_t * config_ptr);
|
|
H5_DLL herr_t H5Fget_mdc_hit_rate(hid_t file_id, double * hit_rate_ptr);
|
|
H5_DLL 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);
|
|
H5_DLL herr_t H5Freset_mdc_hit_rate_stats(hid_t file_id);
|
|
H5_DLL ssize_t H5Fget_name(hid_t obj_id, char *name, size_t size);
|
|
H5_DLL herr_t H5Fget_info(hid_t obj_id, H5F_info_t *bh_info);
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
#endif /* _H5Fpublic_H */
|
|
|