mirror of
https://github.com/HDFGroup/hdf5.git
synced 2025-02-11 16:01:00 +08:00
a0445d806c
* Take a stab at using constructors to initialize instead of
function-entry macros. This is a work in progress. It's good enough to
run `many_dsets`.
* Committing clang-format changes
* Add the `many_dsets` benchmark and some scripts I used on jelly for
setting up the build/test environment and for recording/flame-graphing
profiles.
* Committing clang-format changes
* Change my Makefile and environment script to work both on jelly
and on mayll (and probably on Summit).
* Disable clang-format "fix."
* Replace the `if (!H5_TERM_GLOBAL)` test in each FUNC_ENTER_ macro with
`if (true)`.
* Fix bad grammar in a comment.
* Instead of labeling the H5*__init_package routines constructors, fold
each into an initialization routine, H5*_init(), and call each of
the H5*_init() routines. Call most of the H5*_init() routines from
H5_init_library() in an explicit order that I found out earlier by
instrumenting each __init_package routine and running the library
tests. Roll H5FD*__init_package routines into H5FD*_init() routines.
This change ends just-in-time initialization of package dependencies by
package initializers.
Don't track in per-package variables (H5_PKG_INIT_VAR) whether each
package has been initialized. Instead, track in a single library
variable whether the whole library is initialized or not.
Drive the initialization of packages by H5_init_library() with a table
of initializer routines. Also drive the termination of packages by
H5_term_library() with a table.
Perform initialization as needed from FUNC_ENTER_API_INIT(err). This
basically restores the old behavior of that macro.
Delete a bunch of #definitions in H5private.h that have fallen out of
use with these changes.
* Committing clang-format changes
* Undo the bad auto-formatting that appears to have occurred in spite
of my disabling it. Bracket some code in /* clang-format off */ /*
clang-format on */ to prevent a recurrence.
* Remove a diagnostic abort().
* Fix a logic error: print a comma between every package terminator run,
and don't print an initial comma.
* Complete the changes I started in H5_term_library() that undo the bad
auto-formatting.
Stop tracking whether package "tops" were initialized in per-package
variables H5*_top_package_initialize_s. H5_term_library() takes care of
that for them.
Remove H5R_top_term_package() and H5R_term_package(), they don't do
anything.
* Committing clang-format changes
* NFCI. Simplify macro text: replace `if (true) {` with `{`.
* Fix formatting and suppress clang-format on a longer range.
* Quiet some unused label, unused variable complaints that cropped up
after I simplified the FUNC_ENTER_ macros for the sake of performance.
* Committing clang-format changes
* Delete some programs and scripts that don't belong in the pull request.
* Use the right function-entry macro.
* Use a sensible format and disable auto-formatting.
* Stop calling do-nothing initializer H5FS_init(). Delete it.
* Document what changes to make if the default VFD changes.
* While I am here, change an `await_prior` flag on the terminator table
to `true` to match the previous, non-table-driven code that was here.
Found the oversight making the following changes:
NFCI: insert an empty line and copy over slightly-edited comments from
the previous version, where those comments still correctly explained how
library termination operated.
* NFCI: lower a staircase.
* Replace every occurrence of FUNC_ENTER_NOAPI_INIT(...) with H5_PUSH_FUNC
since that is all that that macro does any more.
Quiet a bunch of new warnings by changing FUNC_ENTER_NOAPI(...) to
FUNC_ENTER_NOAPI_NOERR and removing disused `done:` labels.
* NFCI: add curly braces around a multiline statement.
* Quiet a signed/unsigned comparison warning.
* Add some documentation about library initialization and shutdown.
* Make sure that the library is initialized, or else that initialization
is already underway, before performing any VFD's initialization.
* Committing clang-format changes
* Committing clang-format changes
* Reduce differences from `develop` branch.
* Always initialize `tot_init`.
* Committing clang-format changes
* Fix typo: H5SL_init initializes skip lists, not VOL.
* Remove H5_TERM_GLOBAL test in H5T_init. H5T_init was unusual in that
it tested H5_TERM_GLOBAL and exited early if it was set. No other
module initializers did that, and I cannot find any reason that should
be necessary. Tests still pass when I remove it, so away it goes.
* Use HD prefix.
* Add function header comments.
* Drop the intermediate variable, it's only used once.
* Extract subroutine `H5FDperform_init(hid_t (*init)(void))` that
initializes the library, if necessary, before calling its VFD-initializer
argument. Use H5FDperform_init in the definition of the symbols
H5FD_<vfd> (e.g., H5FD_SEC2), which may be evaluated before the library
is initialized, like so:
```
```
I implement H5FDperform_init in its own source file, H5FDperform.c,
and exclude that file from trace processing because the `bin/trace`
cannot deal with the function-pointer type.
* Straggler from last: add new source file src/H5FDperform.c.
* Committing clang-format changes
* Add a missing file to the MANIFEST.
* Switch to FUNC_ENTER_API_NOINIT in H5FDperform_init() and hbool_t in
H5_term_library().
Co-authored-by: github-actions <41898282+github-actions[bot]@users.noreply.github.com>
176 lines
8.8 KiB
C
176 lines
8.8 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 COPYING file, which can be found at the root of the source code *
|
|
* distribution tree, or in https://www.hdfgroup.org/licenses. *
|
|
* If you do not have access to either file, you may request a copy from *
|
|
* help@hdfgroup.org. *
|
|
* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
|
|
|
|
/*
|
|
* Programmer: Robb Matzke
|
|
* Monday, July 26, 1999
|
|
*/
|
|
#ifndef H5FDprivate_H
|
|
#define H5FDprivate_H
|
|
|
|
/* Include package's public headers */
|
|
#include "H5FDpublic.h"
|
|
#include "H5FDdevelop.h"
|
|
|
|
/* Private headers needed by this file */
|
|
#include "H5Pprivate.h" /* Property lists */
|
|
|
|
/*
|
|
* The MPI drivers are needed because there are
|
|
* places where we check for things that aren't handled by these drivers.
|
|
*/
|
|
#include "H5FDmpi.h" /* MPI-based file drivers */
|
|
|
|
/**************************/
|
|
/* Library Private Macros */
|
|
/**************************/
|
|
|
|
/* Length of filename buffer */
|
|
#define H5FD_MAX_FILENAME_LEN 1024
|
|
|
|
#ifdef H5_HAVE_PARALLEL
|
|
/* ======== Temporary data transfer properties ======== */
|
|
/* Definitions for memory MPI type property */
|
|
#define H5FD_MPI_XFER_MEM_MPI_TYPE_NAME "H5FD_mpi_mem_mpi_type"
|
|
/* Definitions for file MPI type property */
|
|
#define H5FD_MPI_XFER_FILE_MPI_TYPE_NAME "H5FD_mpi_file_mpi_type"
|
|
|
|
#endif
|
|
|
|
/****************************/
|
|
/* Library Private Typedefs */
|
|
/****************************/
|
|
|
|
/* File operations */
|
|
typedef enum {
|
|
OP_UNKNOWN = 0, /* Unknown last file operation */
|
|
OP_READ = 1, /* Last file I/O operation was a read */
|
|
OP_WRITE = 2 /* Last file I/O operation was a write */
|
|
} H5FD_file_op_t;
|
|
|
|
/* Define structure to hold initial file image and other relevant information */
|
|
typedef struct {
|
|
void * buffer;
|
|
size_t size;
|
|
H5FD_file_image_callbacks_t callbacks;
|
|
} H5FD_file_image_info_t;
|
|
|
|
/* Define default file image info */
|
|
#define H5FD_DEFAULT_FILE_IMAGE_INFO \
|
|
{ \
|
|
NULL, /* file image buffer */ \
|
|
0, /* buffer size */ \
|
|
{ /* Callbacks */ \
|
|
NULL, /* image_malloc */ \
|
|
NULL, /* image_memcpy */ \
|
|
NULL, /* image_realloc */ \
|
|
NULL, /* image_free */ \
|
|
NULL, /* udata_copy */ \
|
|
NULL, /* udata_free */ \
|
|
NULL, /* udata */ \
|
|
} \
|
|
}
|
|
|
|
/* Define structure to hold driver ID, info & configuration string for FAPLs */
|
|
typedef struct {
|
|
hid_t driver_id; /* Driver's ID */
|
|
const void *driver_info; /* Driver info, for open callbacks */
|
|
const char *driver_config_str; /* Driver configuration string */
|
|
} H5FD_driver_prop_t;
|
|
|
|
/* Which kind of VFD field to use for searching */
|
|
typedef enum H5FD_get_driver_kind_t {
|
|
H5FD_GET_DRIVER_BY_NAME, /* Name field is set */
|
|
H5FD_GET_DRIVER_BY_VALUE /* Value field is set */
|
|
} H5FD_get_driver_kind_t;
|
|
|
|
/*****************************/
|
|
/* Library Private Variables */
|
|
/*****************************/
|
|
|
|
/******************************/
|
|
/* Library Private Prototypes */
|
|
/******************************/
|
|
|
|
/* Forward declarations for prototype arguments */
|
|
struct H5F_t;
|
|
union H5PL_key_t;
|
|
|
|
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 /*out*/, 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_free_driver_info(hid_t driver_id, const void *driver_info);
|
|
H5_DLL hid_t H5FD_register(const void *cls, size_t size, hbool_t app_ref);
|
|
H5_DLL hid_t H5FD_register_driver_by_name(const char *name, hbool_t app_ref);
|
|
H5_DLL hid_t H5FD_register_driver_by_value(H5FD_class_value_t value, hbool_t app_ref);
|
|
H5_DLL htri_t H5FD_is_driver_registered_by_name(const char *driver_name, hid_t *registered_id);
|
|
H5_DLL htri_t H5FD_is_driver_registered_by_value(H5FD_class_value_t driver_value, hid_t *registered_id);
|
|
H5_DLL hid_t H5FD_get_driver_id_by_name(const char *name, hbool_t is_api);
|
|
H5_DLL hid_t H5FD_get_driver_id_by_value(H5FD_class_value_t value, hbool_t is_api);
|
|
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 /*out*/);
|
|
H5_DLL herr_t H5FD_check_plugin_load(const H5FD_class_t *cls, const union H5PL_key_t *key, hbool_t *success);
|
|
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 /*out*/);
|
|
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_delete(const char *name, hid_t fapl_id);
|
|
H5_DLL herr_t H5FD_ctl(H5FD_t *file, uint64_t op_code, uint64_t flags, const void *input, void **output);
|
|
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 herr_t H5FD_init(void);
|
|
|
|
/* Function prototypes for MPI based VFDs*/
|
|
#ifdef H5_HAVE_PARALLEL
|
|
/* General routines */
|
|
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 /*out*/);
|
|
#ifdef NOT_YET
|
|
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);
|
|
#endif /* NOT_YET */
|
|
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);
|
|
|
|
/* Driver specific methods */
|
|
H5_DLL int H5FD_mpi_get_rank(H5FD_t *file);
|
|
H5_DLL int H5FD_mpi_get_size(H5FD_t *file);
|
|
H5_DLL MPI_Comm H5FD_mpi_get_comm(H5FD_t *file);
|
|
#endif /* H5_HAVE_PARALLEL */
|
|
|
|
#endif /* H5FDprivate_H */
|