Combo set of async and other changes (#161)

* Update API tracing for new H5VL_request_status_t typedef

* Finish converting internal event set operations to use list iterator callbacks, instead of directly accessing the list structure

* Add H5VL_REQUEST_GET_ERR_STACK operation to request subclass, for retrieving a copy of the error stack for a failed asynchronous operation

* Remove 'canceled' event status from Java constants

* Be safer about releasing resources when inserting a newly opened/created object or file into an event set

* Remove H5EStest, add H5ES_WAIT_NONE for 0 timeout, and revise parameters to H5ESwait, to make it more "aggregate".

* Remove H5ES_STATUS_CANCELED from Java wrappers also

* Apply patch for dynamically registering optional VOL operations

* (a) Add async APIs for H5O module as listed in jira issue ID-283.
(b) Remove verification of name parameter in async related routines for H55A and H5L modules
    because it is checked in H5VL_setup* routine.
(c) Modify h5dump expected output due to the async changes.

* Corrections based on PR feedback.

* Further changes to make based on PR feedback.

* Remove H5Dwait & H5Fwait (moved to the async connector).  Added H5atclose
routine.  Updated 'optional op' operations.

* Fix missed merge marker, and reformatted line

* Update API tracing infrastructure for H5atclose callback

* Clean up some warnings

* Normalize against develop branch

* Correct level of indirection

* Add doxygen info for H5is_library_terminating and regression tests for it and H5atclose

* Relocate prototype (and doxygen info) for H5Aclose

* Align w/changes on develop

* Move group package initialization code to H5Gint.c, and update tracing macros

* Change non-static function declarations to be static

* Correct GCC diagnostic macro

* Ensure that H5TSpublic.h header gets installed (#129)

* Finish moving API routines that invoke VOL framework to main source files.

* Fix position of H5Fmount and H5Funmount

* Add 'wrapper' versions of async calls, to allow language wrappers and layers on top of HDF5 to pass in their application information.

* Add wrappers for dynamically registered optional operations

* Fix typo

* Update doxygen comment for H5atclose with additional detail.

* Add H5VL\*_vararg versions of H5VL routines that use va_list parameters

* Implement and test H5S_BLOCK

* Switch H5Aexists\*_async and H5Lexists\*_async to use flag to return status, instead of return value.  Make the corresponding changes through most of the v1 and v2 B-tree code.  Clean up warnings in H5public.h and cmpd_dtransform.c.

* Add H5Iregister_future routine and tests.

* Correct return value for H5Lexists_async

* Add H5_DLL macro to public H5ES API routines

* Update supported -> flags parameter for introspect_query callback

* Remove my email address.  Update passthrough VOL connector ID.

* Fix comment for post_open_api_common

* Remove unused non-blocking VOL connector

* Minor cleanup in async branch in preparation for merge to develop

* Update CMake and the Autotools to use the new pass-through VOL ID

* Finish another iteration on public H5ES routines, along with running the code reformatter

* Another round of reformatting

* Fix for SWMR daily test failures (#160)

The H5I_register_using_existing_id() call did not initialize the future
ID callbacks, causing the library to segfault when it tried to
resolve those function pointers.

* Added selective async APIs (#150)

* Added selective async APIs

Description:
    Added the following APIs:
        H5Ropen_attr_async
        H5Ropen_object_async
        H5Ropen_region_async

        H5Mcreate_async
        H5Mopen_async
        H5Mput_async
        H5Mget_async
        H5Mclose_async

        H5Tcommit_async
        H5Topen_async
        H5Tcopy_async
        H5Tclose_async
    - Updated an expected output file to include a new internal function
      in the error stack for the failure case.

* Updated async APIs per reviews, including removing async version of
H5Tcopy.

* Removed statements that were added by mistake in the previous commit.

* Fix compile issues in H5M and warnings elsewhere

* Reformat code

* Brings VOL_LIST changes from develop. (#163)

* Remove H5Dwait and H5Fwait calls, which were incorrectly brought back in

* Tiny cleanup of H5Lcreate_hard_async

* Run source formatter

* Allow for canceled operation in wait_cb

* Attempt to fix switch on string value

* Re-run source formatter

* Add H5S_BLOCK testfile to CMake clean target

* Add H5Pset_vol_async API routine and 'get_cap_flags' VOL introspection callback

* Clean up warnings

* Add H5P(set\|get)_vol_implicit_async API routines to allow \/ disallow implicit asynchronous operations (default is disallowed)

* Run formatting script

* Remove H5VL_REQUEST_WAIT\*

* Warning cleanup

* Eliminate strdup()s on statically allocated strings

* Warning cleanup

* Split H5VLrestore_lib_state into H5VLstart_lib_state and H5VLrestore_lib_state, and rename H5VLreset_lib_state to H5VLfinish_lib_state.

* Duplicate strings when building err_info to return to applicatin

* Move connector author routines into seperate header files, all included in the new hdf5dev.h header

* Run bin/trace to add TRACE macros

* Allow H5ES_NONE as a valid, but no-op, parameter to all H5ES API routines that accept an event set ID

* Clean up formatting

* Remove H5Pset/get_vol_implicit_async

* Clean up warning

* Remove H5Pget_vol_async and replace with more generic H5Pget_vol_cap_flags

* Clean up warnings

* Add H5ESfree_err_info convenience routine

* Fix typo

* Correct matching for cached VOL plugins

* Add developer header file

* Update for C99 compatibility

* Add missing trace macro

* Stop clang-format from messing with the trace macros.  Don't set up VOL wrappers for 'infrastructure' objects like requests and blobs

* Fix warning about formatting a directory

* Clean up formatting for H5E_BEGIN_TRY / H5E_END_TRY

* Reduce scope of H5ES__close

* Enable CMake checks for various types on MacOS

* Clean up properly when H5CX_retrieve_state() fails.  Also clean up many compiler warnings.

* Committing clang-format changes

* Merge from develop

* Fix mis-placed assert

* Remove commented-out code

* Re-add macro for unsetenv on Windows (I think it accidentally was merged out)

* Strengthen sanity check from error report to assertion

* Committing clang-format changes

* Add units to the comments for a few fields

* Switch 'get execution time' operation for async request tokens to be an optional operation and query if connector supports operation before retrieving it.

* Committing clang-format changes

* Remove H5ESget_time_estimate

* Committing clang-format changes

* Create developer header for datatype routines and move type conversion register/unregister routines there.

* Simplify internal H5VL_setup_name_args and H5VL_setup_idx_args routines

* Add H5VLlink_optional_op, allowing dynamicly registered optional operations for the link VOL subclass, also added H5VL_loc_params argument to the link 'optional' callback to allow them to work correctly.

* Run bin/format_source on current code

* Add H5VLobject_optional_op, allowing dynamicly registered optional operations for the object VOL subclass, also added H5VL_loc_params argument to the object 'optional' callback to allow them to work correctly.

* Run bin/format_source on current code

* Committing clang-format changes

* Revert "Switch 'get execution time' operation for async request tokens to be an optional operation and query if connector supports operation before retrieving it."

This reverts commit 5ac92014da2682bdba62d7a2524b8d90e38f6b19.

* Committing clang-format changes

* Convert attribute 'get' operation to use struct-of-tagged-union pattern for VOL callback arguments, instead of using varargs.

* Update tracing macros

* Convert attribute 'specific' operation to use struct-of-tagged-union pattern for VOL callback arguments, instead of using varargs.

* Convert dataset 'get' and 'specific' operations to use struct-of-tagged-union pattern for VOL callback arguments, instead of using varargs.  Also, minor tweaks to attribute 'get' and 'specific' operation parameters.

* Convert datatype 'get' and 'specific' operations to use struct-of-tagged-union pattern for VOL callback arguments, instead of using varargs.  Also, minor tweaks to H5O_refresh_metadata arguments.

* Reduce warnings

* Reduce warnings

* Track change to datatype 'get' callback

* Fix bug with file pointer getting invalidated when object closed

* Reformat source

* Convert file and group VOL classes 'get' and 'specific' operations to use
struct-of-tagged-union pattern for VOL callback arguments, instead of using
varargs.  Also small cleanup to the attribute get name operation.  Also moved
'mount' and 'unmount' operations to be group specific operations, instead of
file specific, to better align with their behavior (mounted files are on
groups, so a group is what is operated on).

* Remove remainder of merge conflict marking

* Convert link VOL class 'create' operations to use struct-of-tagged-union pattern for VOL callback arguments, instead of using varargs.

* Remove some unused local variables

* Convert link VOL class 'get' operations to use struct-of-tagged-union pattern for VOL callback arguments, instead of using varargs.  Also refactor 'get name by idx' routines to return actual length of name with a parameter instead of the return value, and move some callback context structs for the link interface from the private header file into the source code module, to reduce their visibility scope.

* Update tracing macros

* Convert link VOL class 'specific' operations to use struct-of-tagged-union pattern for VOL callback arguments, instead of using varargs.

* Convert object VOL class 'get' operations to use struct-of-tagged-union pattern for VOL callback arguments, instead of using varargs.

* Convert object VOL class 'specific' operations to use struct-of-tagged-union pattern for VOL callback arguments, instead of using varargs.  Also refactor H5G_loc_exists, et al, to return 'exists' flag in a parameter and errors with the function return value, instead of overloading both into the return value.  And, corrected logic error in test/links.c around non-existant objects in a file.

* Convert request VOL class 'specific' operations to use struct-of-tagged-union pattern for VOL callback arguments, instead of using varargs.

* Convert blob VOL class 'specific' operations to use struct-of-tagged-union pattern for VOL callback arguments, instead of using varargs.  Also removes the H5VL_BLOB_GETSIZE operation, as it's unused in the library and the blob ID size for a container is now returned with H5VL_FILE_GET_CONT_INFO.

* Add 'const' to several parameters that are only queried.

* Convert all VOL classes' 'optional' operations to use struct-of-tagged-union pattern for VOL callback arguments, instead of using varargs.  Convert several 'get' routines to return the length of an array in a parameter instead of combining it into the return value.  Move several routines to be in less public namespace.  Correct direct_chunk test to verify that parameters aren't modified on error.

* Switch get/specific/optional VOL callback argument structures to be 'async-friendly'.  Also other minor cleanups and bug-fixes.

* Add H5Pset_dataset_io_hyperslab_selection / H5S_PLIST feature, to allow skipping H5Dget_space + H5Sselect_hyperslab for async operation

* Add dynamic optional operations for request objects

* Update dynamic operation test for optional request operations

* Update a comment for an operation argument

* Run trace and format_source scripts

* Committing clang-format changes

* Committing clang-format changes

Co-authored-by: vchoi <vchoi@jelly.ad.hdfgroup.org>
Co-authored-by: vchoi-hdfgroup <55293060+vchoi-hdfgroup@users.noreply.github.com>
Co-authored-by: jhendersonHDF <jhenderson@hdfgroup.org>
Co-authored-by: Dana Robinson <derobins@hdfgroup.org>
Co-authored-by: Dana Robinson <43805+derobins@users.noreply.github.com>
Co-authored-by: bmribler <39579120+bmribler@users.noreply.github.com>
Co-authored-by: github-actions <41898282+github-actions[bot]@users.noreply.github.com>

1 files changed, 0 insertions, 257 deletions

diff --git a/src/H5Lpublic.h b/src/H5Lpublic.h
index 5274649..f665526 100644
--- a/src/H5Lpublic.h
+++ b/src/H5Lpublic.h
@@ -46,11 +46,6 @@
  */
 #define H5L_SAME_LOC 0 /* (hid_t) */
 
-/**
- * \brief Current version of the H5L_class_t struct
- */
-#define H5L_LINK_CLASS_T_VERS 1
-
 #ifdef __cplusplus
 extern "C" {
 #endif
@@ -105,65 +100,6 @@ typedef struct {
 } H5L_info2_t;
 //! <!-- [H5L_info2_t_snip] -->
 
-/* The H5L_class_t struct can be used to override the behavior of a
- * "user-defined" link class. Users should populate the struct with callback
- * functions defined below.
- */
-/* Callback prototypes for user-defined links */
-/**
- * \brief Link creation callback
- */
-typedef herr_t (*H5L_create_func_t)(const char *link_name, hid_t loc_group, const void *lnkdata,
-                                    size_t lnkdata_size, hid_t lcpl_id);
-/**
- * \brief Callback for link move
- */
-typedef herr_t (*H5L_move_func_t)(const char *new_name, hid_t new_loc, const void *lnkdata,
-                                  size_t lnkdata_size);
-/**
- * \brief Callback for link copy
- */
-typedef herr_t (*H5L_copy_func_t)(const char *new_name, hid_t new_loc, const void *lnkdata,
-                                  size_t lnkdata_size);
-/**
- * \brief Callback during link traversal
- */
-typedef hid_t (*H5L_traverse_func_t)(const char *link_name, hid_t cur_group, const void *lnkdata,
-                                     size_t lnkdata_size, hid_t lapl_id, hid_t dxpl_id);
-/**
- * \brief Callback for link deletion
- */
-typedef herr_t (*H5L_delete_func_t)(const char *link_name, hid_t file, const void *lnkdata,
-                                    size_t lnkdata_size);
-/**
- * \brief Callback for querying the link.
- *
- * Returns the size of the buffer needed.
- */
-typedef ssize_t (*H5L_query_func_t)(const char *link_name, const void *lnkdata, size_t lnkdata_size,
-                                    void *buf /*out*/, size_t buf_size);
-
-/**
- * \brief Link prototype
- *
- * The H5L_class_t struct can be used to override the behavior of a
- * "user-defined" link class. Users should populate the struct with callback
- * functions defined elsewhere.
- */
-//! <!-- [H5L_class_t_snip] -->
-typedef struct {
-    int                 version;     /**< Version number of this struct       */
-    H5L_type_t          id;          /**< Link type ID                        */
-    const char *        comment;     /**< Comment for debugging               */
-    H5L_create_func_t   create_func; /**< Callback during link creation       */
-    H5L_move_func_t     move_func;   /**< Callback after moving link          */
-    H5L_copy_func_t     copy_func;   /**< Callback after copying link         */
-    H5L_traverse_func_t trav_func;   /**< Callback during link traversal      */
-    H5L_delete_func_t   del_func;    /**< Callback for link deletion          */
-    H5L_query_func_t    query_func;  /**< Callback for queries                */
-} H5L_class_t;
-//! <!-- [H5L_class_t_snip] -->
-
 /**
  * \brief Prototype for H5Literate2(), H5Literate_by_name2() operator
  *
@@ -1250,179 +1186,6 @@ H5_DLL herr_t H5Lcreate_ud(hid_t link_loc_id, const char *link_name, H5L_type_t
 /**
  * \ingroup H5LA
  *
- * \brief Registers a user-defined link class or changes behavior of an
- *        existing class
- *
- * \param[in] cls Pointer to a buffer containing the struct describing the
- *            user-defined link class
- *
- * \return \herr_t
- *
- * \details H5Lregister() registers a class of user-defined links, or changes
- *          the behavior of an existing class.
- *
- *          \p cls is a pointer to a buffer containing a copy of the
- *          H5L_class_t struct. This struct is defined in H5Lpublic.h as
- *          follows:
- *          \snippet this H5L_class_t_snip
- *
- *          The class definition passed with \p cls must include at least the
- *          following:
- *          \li An H5L_class_t version (which should be #H5L_LINK_CLASS_T_VERS)
- *          \li A link class identifier, \c class_id
- *          \li A traversal function, \c trav_func
- *
- *          Remaining \c struct members are optional and may be passed as NULL.
- *
- *          The link class passed in \c class_id must be in the user-definable
- *          range between #H5L_TYPE_UD_MIN and #H5L_TYPE_UD_MAX
- *          (see the table below) and will override
- *          any existing link class with that identifier.
- *
- *          As distributed, valid values of \c class_id used in HDF5 include
- *          the following (defined in H5Lpublic.h):
- *          \link_types
- *
- *          The hard and soft link class identifiers cannot be modified or
- *          reassigned, but the external link class is implemented as an
- *          example in the user-definable link class identifier range.
- *          H5Lregister() is used to register additional link classes. It could
- *          also be used to modify the behavior of the external link class,
- *          though that is not recommended.
- *
- *          The following table summarizes existing link types and values and
- *          the reserved and user-definable link class identifier value ranges.
- *          <table>
- *            <tr>
- *              <th>Link class identifier or Value range</th>
- *              <th>Description</th>
- *              <th>Link class or label</th>
- *            </tr>
- *            <tr>
- *              <td>0 to 63</td>
- *              <td>Reserved range</td>
- *              <td></td>
- *            </tr>
- *            <tr>
- *              <td>64 to 255</td>
- *              <td>User-definable range</td>
- *              <td></td>
- *            </tr>
- *            <tr>
- *              <td>64</td>
- *              <td>Minimum user-defined value</td>
- *              <td>#H5L_TYPE_UD_MIN</td>
- *            </tr>
- *            <tr>
- *              <td>64</td>
- *              <td>External link</td>
- *              <td>#H5L_TYPE_EXTERNAL</td>
- *            </tr>
- *            <tr>
- *              <td>255</td>
- *              <td>Maximum user-defined value</td>
- *              <td>#H5L_TYPE_UD_MAX</td>
- *            </tr>
- *            <tr>
- *              <td>255</td>
- *              <td>Maximum value</td>
- *              <td>#H5L_TYPE_MAX</td>
- *            </tr>
- *            <tr>
- *              <td>-1</td>
- *              <td>Error</td>
- *              <td>#H5L_TYPE_ERROR</td>
- *            </tr>
- *          </table>
- *
- *          Note that HDF5 internally registers user-defined link classes only
- *          by the numeric value of the link class identifier. An application,
- *          on the other hand, will generally use a name for a user-defined
- *          class, if for no other purpose than as a variable name. Assume,
- *          for example, that a complex link type is registered with the link
- *          class identifier 73 and that the code includes the following
- *          assignment:
- *          \code
- *          H5L_TYPE_COMPLEX_A = 73
- *          \endcode
- *          The application can refer to the link class with a term,
- *          \c  H5L_TYPE_COMPLEX_A, that conveys meaning to a human reviewing
- *          the code, while HDF5 recognizes it by the more cryptic numeric
- *          identifier, 73.
- *
- * \attention Important details and considerations include the following:
- *            \li If you plan to distribute files or software with a
- *                user-defined link class, please contact the Help Desk at
- *                The HDF Group to help prevent collisions between \c class_id
- *                values. See below.
- *            \li As distributed with HDF5, the external link class is
- *                implemented as an example of a user-defined link class with
- *                #H5L_TYPE_EXTERNAL equal to #H5L_TYPE_UD_MIN. \c class_id in
- *                the H5L_class_t \c struct must not equal #H5L_TYPE_UD_MIN
- *                unless you intend to overwrite or modify the behavior of
- *                external links.
- *            \li H5Lregister() can be used only with link class identifiers
- *                in the user-definable range (see table above).
- *            \li The hard and soft links defined by the HDF5 library,
- *                #H5L_TYPE_HARD and #H5L_TYPE_SOFT, reside in the reserved
- *                range below #H5L_TYPE_UD_MIN and cannot be redefined or
- *                modified.
- *            \li H5Lis_registered() can be used to determine whether a desired
- *                link class identifier is available. \Emph{Note that this
- *                function will tell you only whether the link class identifier
- *                has been registered with the installed copy of HDF5; it
- *                cannot tell you whether the link class has been registered
- *                with The HDF Group.}
- *            \li #H5L_TYPE_MAX is the maximum allowed value for a link type
- *                identifier.
- *            \li #H5L_TYPE_UD_MIN equals #H5L_TYPE_EXTERNAL.
- *            \li #H5L_TYPE_UD_MAX equals #H5L_TYPE_MAX.
- *            \li #H5L_TYPE_ERROR indicates that an error has occurred.
- *
- * \note \Bold{Registration with The HDF Group:}\n
- *       There are sometimes reasons to take a broader approach to registering
- *       a user-defined link class than just invoking H5Lregister(). For
- *       example:
- *       \li A user-defined link class is intended for use across an
- *           organization, among collaborators, or across a community of users.
- *       \li An application or library overlying HDF5 invokes a user-defined
- *           link class that must be shipped with the software.
- *       \li Files are distributed that make use of a user-defined link class.
- *       \li Or simply, a specific user-defined link class is thought to be
- *           widely useful.
- *
- *       In such cases, you are encouraged to register that link class with
- *       The HDF Group's Helpdesk. The HDF Group maintains a registry of known
- *       user-defined link classes and tracks the selected link class
- *       identifiers. This registry is intended to reduce the risk of
- *       collisions between \c class_id values and to help coordinate the use
- *       of specialized link classes.
- *
- * \since 1.8.0
- *
- */
-H5_DLL herr_t H5Lregister(const H5L_class_t *cls);
-/**
- * \ingroup H5LA
- *
- * \brief Unregisters a class of user-defined links
- *
- * \param[in] id User-defined link class identifier
- *
- * \return \herr_t
- *
- * \details H5Lunregister() unregisters a class of user-defined links,
- *          preventing them from being traversed, queried, moved, etc.
- *
- * \note A link class can be re-registered using H5Lregister().
- *
- * \since 1.8.0
- *
- */
-H5_DLL herr_t H5Lunregister(H5L_type_t id);
-/**
- * \ingroup H5LA
- *
  * \brief Determines whether a class of user-defined links is registered
  *
  * \param[in] id User-defined link class identifier
@@ -1647,9 +1410,6 @@ H5_DLL herr_t H5Lcreate_external(const char *file_name, const char *obj_name, hi
 
 /* Macros */
 
-/* Previous versions of the H5L_class_t struct */
-#define H5L_LINK_CLASS_T_VERS_0 0
-
 /* Typedefs */
 
 //! <!-- [H5L_info1_t_snip] -->
@@ -1668,23 +1428,6 @@ typedef struct {
 } H5L_info1_t;
 //! <!-- [H5L_info1_t_snip] -->
 
-/** Callback during link traversal */
-typedef hid_t (*H5L_traverse_0_func_t)(const char *link_name, hid_t cur_group, const void *lnkdata,
-                                       size_t lnkdata_size, hid_t lapl_id);
-
-/** User-defined link types */
-typedef struct {
-    int                   version;     /**< Version number of this struct        */
-    H5L_type_t            id;          /**< Link type ID                         */
-    const char *          comment;     /**< Comment for debugging                */
-    H5L_create_func_t     create_func; /**< Callback during link creation        */
-    H5L_move_func_t       move_func;   /**< Callback after moving link           */
-    H5L_copy_func_t       copy_func;   /**< Callback after copying link          */
-    H5L_traverse_0_func_t trav_func;   /**< Callback during link traversal       */
-    H5L_delete_func_t     del_func;    /**< Callback for link deletion           */
-    H5L_query_func_t      query_func;  /**< Callback for queries                 */
-} H5L_class_0_t;
-
 /** Prototype for H5Literate1() / H5Literate_by_name1() operator */
 //! <!-- [H5L_iterate1_t_snip] -->
 typedef herr_t (*H5L_iterate1_t)(hid_t group, const char *name, const H5L_info1_t *info, void *op_data);