Simplify function enter macros for performance benefits (#1024)

* 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>

1 files changed, 55 insertions, 90 deletions

diff --git a/src/H5E.c b/src/H5E.c
index a5a9a2e..7f657fd 100644
--- a/src/H5E.c
+++ b/src/H5E.c
@@ -92,9 +92,6 @@ static herr_t     H5E__append_stack(H5E_t *dst_estack, const H5E_t *src_stack);
 /* Package Variables */
 /*********************/
 
-/* Package initialization variable */
-hbool_t H5_PKG_INIT_VAR = FALSE;
-
 /*****************************/
 /* Library Private Variables */
 /*****************************/
@@ -141,46 +138,19 @@ static const H5I_class_t H5I_ERRSTK_CLS[1] = {{
  *
  * Purpose:     Initialize the interface from some other layer.
  *
- * Return:      SUCCEED/FAIL
- *
- * Programmer:	Quincey Koziol
- *              Tuesday, June 29, 2004
- *
+ * Return:      Success:        non-negative
+ *              Failure:        negative
  *-------------------------------------------------------------------------
  */
 herr_t
 H5E_init(void)
 {
-    herr_t ret_value = SUCCEED; /* Return value */
-
-    FUNC_ENTER_NOAPI(FAIL)
-    /* FUNC_ENTER() does all the work */
-
-done:
-    FUNC_LEAVE_NOAPI(ret_value)
-} /* end H5E_init() */
-
-/*--------------------------------------------------------------------------
- * Function:    H5E__init_package
- *
- * Purpose:     Initialize interface-specific information
- *
- * Return:      SUCCEED/FAIL
- *
- * Programmer:  Raymond Lu
- *              Friday, July 11, 2003
- *
- *--------------------------------------------------------------------------
- */
-herr_t
-H5E__init_package(void)
-{
     H5E_cls_t *cls;                 /* Pointer to error class */
     H5E_msg_t *msg;                 /* Pointer to new error message */
     char       lib_vers[128];       /* Buffer to constructu library version within */
     herr_t     ret_value = SUCCEED; /* Return value */
 
-    FUNC_ENTER_PACKAGE
+    FUNC_ENTER_NOAPI(FAIL)
 
     /* Initialize the ID group for the error class IDs */
     if (H5I_register_type(H5I_ERRCLS_CLS) < 0)
@@ -213,7 +183,7 @@ H5E__init_package(void)
 
 done:
     FUNC_LEAVE_NOAPI(ret_value)
-} /* end H5E__init_package() */
+}
 
 /*-------------------------------------------------------------------------
  * Function:    H5E_term_package
@@ -237,66 +207,61 @@ H5E_term_package(void)
 
     FUNC_ENTER_NOAPI_NOINIT_NOERR
 
-    if (H5_PKG_INIT_VAR) {
-        int64_t ncls, nmsg, nstk;
-
-        /* Check if there are any open error stacks, classes or messages */
-        ncls = H5I_nmembers(H5I_ERROR_CLASS);
-        nmsg = H5I_nmembers(H5I_ERROR_MSG);
-        nstk = H5I_nmembers(H5I_ERROR_STACK);
-
-        if ((ncls + nmsg + nstk) > 0) {
-            /* Clear the default error stack. Note that
-             * the following H5I_clear_type calls do not
-             * force the clears and will not be able to
-             * clear any error message IDs that are still
-             * in use by the default error stack unless we
-             * clear that stack manually.
-             *
-             * Error message IDs will typically still be
-             * in use by the default error stack when the
-             * application does H5E_BEGIN/END_TRY cleanup
-             * at the very end.
-             */
-            H5E_clear_stack(NULL);
-
-            /* Clear any outstanding error stacks */
-            if (nstk > 0)
-                (void)H5I_clear_type(H5I_ERROR_STACK, FALSE, FALSE);
-
-            /* Clear all the error classes */
-            if (ncls > 0) {
-                (void)H5I_clear_type(H5I_ERROR_CLASS, FALSE, FALSE);
-
-                /* Reset the HDF5 error class, if its been closed */
-                if (H5I_nmembers(H5I_ERROR_CLASS) == 0)
-                    H5E_ERR_CLS_g = -1;
-            } /* end if */
+    int64_t ncls, nmsg, nstk;
+
+    /* Check if there are any open error stacks, classes or messages */
+    ncls = H5I_nmembers(H5I_ERROR_CLASS);
+    nmsg = H5I_nmembers(H5I_ERROR_MSG);
+    nstk = H5I_nmembers(H5I_ERROR_STACK);
+
+    if ((ncls + nmsg + nstk) > 0) {
+        /* Clear the default error stack. Note that
+         * the following H5I_clear_type calls do not
+         * force the clears and will not be able to
+         * clear any error message IDs that are still
+         * in use by the default error stack unless we
+         * clear that stack manually.
+         *
+         * Error message IDs will typically still be
+         * in use by the default error stack when the
+         * application does H5E_BEGIN/END_TRY cleanup
+         * at the very end.
+         */
+        H5E_clear_stack(NULL);
+
+        /* Clear any outstanding error stacks */
+        if (nstk > 0)
+            (void)H5I_clear_type(H5I_ERROR_STACK, FALSE, FALSE);
+
+        /* Clear all the error classes */
+        if (ncls > 0) {
+            (void)H5I_clear_type(H5I_ERROR_CLASS, FALSE, FALSE);
 
-            /* Clear all the error messages */
-            if (nmsg > 0) {
-                (void)H5I_clear_type(H5I_ERROR_MSG, FALSE, FALSE);
+            /* Reset the HDF5 error class, if its been closed */
+            if (H5I_nmembers(H5I_ERROR_CLASS) == 0)
+                H5E_ERR_CLS_g = -1;
+        } /* end if */
 
-                /* Reset the HDF5 error messages, if they've been closed */
-                if (H5I_nmembers(H5I_ERROR_MSG) == 0) {
+        /* Clear all the error messages */
+        if (nmsg > 0) {
+            (void)H5I_clear_type(H5I_ERROR_MSG, FALSE, FALSE);
+
+            /* Reset the HDF5 error messages, if they've been closed */
+            if (H5I_nmembers(H5I_ERROR_MSG) == 0) {
 /* Include the automatically generated error code termination */
 #include "H5Eterm.h"
-                } /* end if */
-            }     /* end if */
-
-            n++; /*H5I*/
-        }        /* end if */
-        else {
-            /* Destroy the error class, message, and stack id groups */
-            n += (H5I_dec_type_ref(H5I_ERROR_STACK) > 0);
-            n += (H5I_dec_type_ref(H5I_ERROR_CLASS) > 0);
-            n += (H5I_dec_type_ref(H5I_ERROR_MSG) > 0);
-
-            /* Mark closed */
-            if (0 == n)
-                H5_PKG_INIT_VAR = FALSE;
-        } /* end else */
-    }     /* end if */
+            } /* end if */
+        }     /* end if */
+
+        n++; /*H5I*/
+    }        /* end if */
+    else {
+        /* Destroy the error class, message, and stack id groups */
+        n += (H5I_dec_type_ref(H5I_ERROR_STACK) > 0);
+        n += (H5I_dec_type_ref(H5I_ERROR_CLASS) > 0);
+        n += (H5I_dec_type_ref(H5I_ERROR_MSG) > 0);
+
+    } /* end else */
 
     FUNC_LEAVE_NOAPI(n)
 } /* end H5E_term_package() */