mirror of
https://github.com/HDFGroup/hdf5.git
synced 2026-09-25 04:09:44 +03:00
Quincey Koziol
331193f357
Added infrastructure support for multithreaded concurrency by adding an optional way to switch to using a non-recursive R/W lock for the global API lock. This is enabled with a new 'concurrency' configuration flag for the autotools & CMake builds, which is disabled by default. When the 'concurrency' build option is chosen, the global API lock will use the R/W lock and all API calls currently will acquire a write lock, ensuring exclusive access by one thread. Over time, the API routines that are converted to support multithreaded concurrency will switch to acquiring a read lock instead. Reentering the library from application callbacks is managed by the 'disable locking for this thread' (DLFTT) threadsafety protocol. This is internally handled within the H5_API_LOCK / H5_API_UNLOCK macros in H5private.h (as before), which invoke the 'dlftt' routines in H5TSint.c. To support this change, the threadsafety configuration macros for the library have been updated: - --enable-threadsafe now defines the H5_HAVE_THREADSAFE macro - --enable-concurrency defines the H5_HAVE_CONCURRENCY macro The new H5_HAVE_THREADSAFE_API macro is set if either H5_HAVE_THREADSAFE or H5_HAVE_CONCURRENCY is enabled. New Github actions are added to include the concurrency configuration in the CI for the develop branch. To support the new non-recursive R/W locking for API routines, some other changes are necessary: Added macro wrappers around all callback invocations that could call an application function, and therefore re-enter the library: H5_BEFORE_USER_CB* / H5_AFTER_USER_CB* Added H5_user_cb_prepare / H5_user_cb_restore routines that save the state of the library when callback leaves the library. Includes error stack and threadsafe reentry state currently. There's also some small cleanups to various places in the library: Moved the H5E_mpi_error_str / H5E_mpi_error_str_len globals to be local for pushing MPI errors, so that multiple threads can't interfere with each other. Added H5TS_rwlock_trywrlock() routine to R/W lock interface. Emulate R/W locks on MacOS because its implementation of pthread_rwlock_wrlock() does not conform to the POSIX standard. Don't acquire the global API lock in H5close, since it's acquired in H5_term_library, which is necessary because H5_term_library is invoked via other code paths that don't hold the global API lock. Don't call H5Eget_auto2 API routine within H5_term_library. Switched 'return NULL' in H5allocate_memory to HGOTO_DONE(NULL). Switched H5Pget_file_space_strategy / H5Pset_file_space_strategy to use internal routines instead of API routines. Switched H5Oopen_by_addr & H5Ovisit1 to use internal routines instead of API routines. Fixed a few places in src/H5Odeprec.c where a major error ID was passed as a minor ID.
245 lines
17 KiB
C
245 lines
17 KiB
C
/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
|
|
* Copyright by The HDF Group. *
|
|
* 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 LICENSE 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. *
|
|
* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
|
|
|
|
/*
|
|
* Header file for error values, etc.
|
|
*/
|
|
#ifndef H5TOOLS_ERROR_H
|
|
#define H5TOOLS_ERROR_H
|
|
|
|
#include "H5private.h"
|
|
#include "H5Eprivate.h" /* Error handling */
|
|
|
|
/* tools-HDF5 Error variables */
|
|
H5TOOLS_DLLVAR int H5tools_INDENT_g;
|
|
H5TOOLS_DLLVAR hid_t H5tools_ERR_STACK_g;
|
|
H5TOOLS_DLLVAR hid_t H5tools_ERR_CLS_g;
|
|
H5TOOLS_DLLVAR hid_t H5E_tools_g;
|
|
H5TOOLS_DLLVAR hid_t H5E_tools_min_id_g;
|
|
H5TOOLS_DLLVAR hid_t H5E_tools_min_info_id_g;
|
|
H5TOOLS_DLLVAR hid_t H5E_tools_min_dbg_id_g;
|
|
|
|
/*
|
|
* H5TOOLS_INIT_ERROR macro, used to initialize error reporting.
|
|
*/
|
|
#define H5TOOLS_INIT_ERROR() \
|
|
do { \
|
|
char lib_str[256]; \
|
|
\
|
|
/* Initialize library version string for error class */ \
|
|
snprintf(lib_str, sizeof(lib_str), "%d.%d.%d", H5_VERS_MAJOR, H5_VERS_MINOR, H5_VERS_RELEASE); \
|
|
\
|
|
/* Create new HDF5 error stack for the tools to use */ \
|
|
if ((H5tools_ERR_STACK_g = H5Ecreate_stack()) < 0) \
|
|
fprintf(stderr, "Failed to create HDF5 tools error stack\n"); \
|
|
\
|
|
/* Register errors from the HDF5 tools as a new error class */ \
|
|
if ((H5tools_ERR_CLS_g = H5Eregister_class("H5tools", "HDF5:tools", lib_str)) < 0) \
|
|
fprintf(stderr, "Failed to register HDF5 tools error class\n"); \
|
|
\
|
|
/* Create a new HDF5 major error message for errors from the tools library */ \
|
|
if ((H5E_tools_g = H5Ecreate_msg(H5tools_ERR_CLS_g, H5E_MAJOR, "Failure in tools library")) < 0) \
|
|
fprintf(stderr, "Failed to register major error message for tools library errors\n"); \
|
|
\
|
|
/* Create a new HDF5 minor error message for errors from the tools library */ \
|
|
if ((H5E_tools_min_id_g = H5Ecreate_msg(H5tools_ERR_CLS_g, H5E_MINOR, "error in function")) < 0) \
|
|
fprintf(stderr, "Failed to register minor error message for tools library errors\n"); \
|
|
\
|
|
/* Create a new HDF5 minor error message for info messages from the tools library */ \
|
|
if ((H5E_tools_min_info_id_g = H5Ecreate_msg(H5tools_ERR_CLS_g, H5E_MINOR, "function info")) < 0) \
|
|
fprintf(stderr, "Failed to register minor error message for tools library info messages\n"); \
|
|
\
|
|
/* Create a new HDF5 minor error message for debug messages from the tools library */ \
|
|
if ((H5E_tools_min_dbg_id_g = H5Ecreate_msg(H5tools_ERR_CLS_g, H5E_MINOR, "function debug")) < 0) \
|
|
fprintf(stderr, "Failed to register minor error message for tools library debug messages\n"); \
|
|
} while (0)
|
|
|
|
/*
|
|
* H5TOOLS_CLOSE_ERROR macro, used to terminate error reporting.
|
|
*/
|
|
#define H5TOOLS_CLOSE_ERROR() \
|
|
do { \
|
|
/* Close all error messages created by H5TOOLS_INIT_ERROR() */ \
|
|
if (H5Eclose_msg(H5E_tools_min_dbg_id_g) < 0) \
|
|
fprintf(stderr, "Failed to close minor error message for tools library debug messages\n"); \
|
|
if (H5Eclose_msg(H5E_tools_min_info_id_g) < 0) \
|
|
fprintf(stderr, "Failed to close minor error message for tools library info messages\n"); \
|
|
if (H5Eclose_msg(H5E_tools_min_id_g) < 0) \
|
|
fprintf(stderr, "Failed to close minor error message for tools library errors\n"); \
|
|
if (H5Eclose_msg(H5E_tools_g) < 0) \
|
|
fprintf(stderr, "Failed to close major error message for tools library errors\n"); \
|
|
\
|
|
/* Unregister the HDF5 tools error class */ \
|
|
if (H5Eunregister_class(H5tools_ERR_CLS_g) < 0) \
|
|
fprintf(stderr, "Failed to unregister the HDF5 tools error class\n"); \
|
|
\
|
|
/* Close the tools error stack */ \
|
|
if (H5Eclose_stack(H5tools_ERR_STACK_g) < 0) \
|
|
fprintf(stderr, "Failed to close HDF5 tools error stack\n"); \
|
|
} while (0)
|
|
|
|
/*
|
|
* H5TOOLS_PUSH_ERROR macro, used to push an error to an error stack. Not meant to
|
|
* be called directly.
|
|
*/
|
|
#define H5TOOLS_PUSH_ERROR(estack_id, err_cls, maj_err_id, min_err_id, ...) \
|
|
do { \
|
|
if (enable_error_stack > 0) { \
|
|
if (estack_id >= 0 && err_cls >= 0) \
|
|
H5Epush2(estack_id, __FILE__, __func__, __LINE__, err_cls, maj_err_id, min_err_id, \
|
|
__VA_ARGS__); \
|
|
else { \
|
|
fprintf(stderr, __VA_ARGS__); \
|
|
fprintf(stderr, "\n"); \
|
|
} \
|
|
} \
|
|
} while (0)
|
|
|
|
/*
|
|
* H5TOOLS_ERROR macro, used to facilitate error reporting within a function body.
|
|
* The arguments are the return value and an error string. The return value is assigned
|
|
* to a variable `ret_value'. This macro is meant to be used for reporting an error without
|
|
* having control branch to the `done' label. This is often used when an error occurs
|
|
* after the `done' label, in which case an infinite loop would ensue if control branched
|
|
* backwards.
|
|
*/
|
|
#define H5TOOLS_ERROR(ret_val, ...) \
|
|
do { \
|
|
H5TOOLS_PUSH_ERROR(H5tools_ERR_STACK_g, H5tools_ERR_CLS_g, H5E_tools_g, H5E_tools_min_id_g, \
|
|
__VA_ARGS__); \
|
|
ret_value = ret_val; \
|
|
} while (0)
|
|
|
|
/*
|
|
* H5TOOLS_GOTO_ERROR macro, used to facilitate error reporting within a function body.
|
|
* The arguments are the return value and an error string. The return value is assigned
|
|
* to a variable `ret_value' and control branches to the `done' label.
|
|
*/
|
|
#define H5TOOLS_GOTO_ERROR(ret_val, ...) \
|
|
do { \
|
|
H5TOOLS_PUSH_ERROR(H5tools_ERR_STACK_g, H5tools_ERR_CLS_g, H5E_tools_g, H5E_tools_min_id_g, \
|
|
__VA_ARGS__); \
|
|
H5TOOLS_GOTO_DONE(ret_val); \
|
|
} while (0)
|
|
|
|
/*
|
|
* H5TOOLS_GOTO_DONE macro, used to facilitate normal return within a function body.
|
|
* The argument is the return value which is assigned to the `ret_value'
|
|
* variable. Control branches to the `done' label.
|
|
*/
|
|
#define H5TOOLS_GOTO_DONE(ret_val) \
|
|
do { \
|
|
ret_value = ret_val; \
|
|
goto done; \
|
|
} while (0)
|
|
|
|
/*
|
|
* H5TOOLS_GOTO_DONE_NO_RET macro, used to facilitate normal return within a function body.
|
|
* Control simply branches to the `done' label without setting any return value.
|
|
*/
|
|
#define H5TOOLS_GOTO_DONE_NO_RET() \
|
|
do { \
|
|
goto done; \
|
|
} while (0)
|
|
|
|
/*
|
|
* H5TOOLS_INFO macro, used to facilitate error reporting. The arguments are
|
|
* a description of the error.
|
|
*/
|
|
#define H5TOOLS_INFO(...) \
|
|
do { \
|
|
H5TOOLS_PUSH_ERROR(H5tools_ERR_STACK_g, H5tools_ERR_CLS_g, H5E_tools_g, H5E_tools_min_info_id_g, \
|
|
__VA_ARGS__); \
|
|
} while (0)
|
|
|
|
#ifdef H5_TOOLS_DEBUG
|
|
|
|
#define H5TOOLS_START_DEBUG(...) \
|
|
do { \
|
|
H5tools_INDENT_g += 2; \
|
|
fprintf(stderr, "%*sENTER %s:%d in %s()...", H5tools_INDENT_g, "", __FILE__, __LINE__, __func__); \
|
|
fprintf(stderr, __VA_ARGS__); \
|
|
fprintf(stderr, "\n"); \
|
|
fflush(stderr); \
|
|
} while (0)
|
|
|
|
#define H5TOOLS_DEBUG(...) \
|
|
do { \
|
|
fprintf(stderr, "%*s %s:%d in %s()...", H5tools_INDENT_g, "", __FILE__, __LINE__, __func__); \
|
|
fprintf(stderr, __VA_ARGS__); \
|
|
fprintf(stderr, "\n"); \
|
|
fflush(stderr); \
|
|
} while (0)
|
|
|
|
#define H5TOOLS_ENDDEBUG(...) \
|
|
do { \
|
|
fprintf(stderr, "%*sEXIT %s:%d in %s()...", H5tools_INDENT_g, "", __FILE__, __LINE__, __func__); \
|
|
fprintf(stderr, __VA_ARGS__); \
|
|
fprintf(stderr, "\n"); \
|
|
H5tools_INDENT_g -= 2; \
|
|
fflush(stderr); \
|
|
} while (0)
|
|
|
|
#else
|
|
|
|
#define H5TOOLS_START_DEBUG(...) \
|
|
do { \
|
|
; \
|
|
} while (0)
|
|
|
|
#define H5TOOLS_DEBUG(...) \
|
|
do { \
|
|
; \
|
|
} while (0)
|
|
|
|
#define H5TOOLS_ENDDEBUG(...) \
|
|
do { \
|
|
; \
|
|
} while (0)
|
|
|
|
#endif
|
|
|
|
/* Macro for "catching" flow of control when an error occurs. Note that the
|
|
* H5_LEAVE macro won't jump back here once it's past this point.
|
|
*/
|
|
#define CATCH \
|
|
catch_except:; \
|
|
past_catch = true;
|
|
|
|
/*
|
|
* H5_LEAVE macro, used to facilitate control flow in a function. The argument
|
|
* is the return value. The return value is assigned to a variable `ret_value'
|
|
* and control branches to the `catch_except' label, if we're not already past
|
|
* it.
|
|
*/
|
|
#define H5_LEAVE(v) \
|
|
do { \
|
|
ret_value = v; \
|
|
if (!past_catch) \
|
|
goto catch_except; \
|
|
} while (0)
|
|
|
|
/*
|
|
* H5TOOLS_THROW macro, used to facilitate error reporting within a function body.
|
|
* The arguments are the minor error number, and an error string.
|
|
* The return value is assigned to a variable `ret_value' and control branches
|
|
* to the `catch_except' label, if we're not already past it.
|
|
*/
|
|
#define H5TOOLS_THROW(ret_val, ...) \
|
|
do { \
|
|
H5TOOLS_PUSH_ERROR(H5tools_ERR_STACK_g, H5tools_ERR_CLS_g, H5E_tools_g, H5E_tools_min_id_g, \
|
|
__VA_ARGS__); \
|
|
H5_LEAVE(ret_val); \
|
|
} while (0)
|
|
|
|
#endif /* H5TOOLS_ERROR_H */
|