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, 54 insertions, 72 deletions

diff --git a/src/H5VLint.c b/src/H5VLint.c
index 936614f..b602ac0 100644
--- a/src/H5VLint.c
+++ b/src/H5VLint.c
@@ -32,6 +32,7 @@
 #include "H5CXprivate.h" /* API Contexts                         */
 #include "H5Dprivate.h"  /* Datasets                             */
 #include "H5Eprivate.h"  /* Error handling                       */
+#include "H5ESprivate.h" /* Event sets                           */
 #include "H5Fprivate.h"  /* Files                                */
 #include "H5FLprivate.h" /* Free lists                           */
 #include "H5Gprivate.h"  /* Groups                               */
@@ -94,9 +95,6 @@ static herr_t         H5VL__free_vol_wrapper(H5VL_wrap_ctx_t *vol_wrap_ctx);
 /* Package Variables */
 /*********************/
 
-/* Package initialization variable */
-hbool_t H5_PKG_INIT_VAR = FALSE;
-
 /*****************************/
 /* Library Private Variables */
 /*****************************/
@@ -149,7 +147,9 @@ H5VL_init_phase1(void)
 
     FUNC_ENTER_NOAPI(FAIL)
 
-    /* FUNC_ENTER() does all the work */
+    /* Initialize the ID group for the VL IDs */
+    if (H5I_register_type(H5I_VOL_CLS) < 0)
+        HGOTO_ERROR(H5E_VOL, H5E_CANTINIT, FAIL, "unable to initialize H5VL interface")
 
 done:
     FUNC_LEAVE_NOAPI(ret_value)
@@ -171,23 +171,39 @@ done:
 herr_t
 H5VL_init_phase2(void)
 {
+    size_t i;
     herr_t ret_value = SUCCEED; /* Return value */
 
     FUNC_ENTER_NOAPI(FAIL)
 
+    /* clang-format off */
+    struct {
+        herr_t (*func)(void);
+        const char *descr;
+    } initializer[] = {
+        {H5T_init, "datatype"}
+    ,   {H5O_init, "object header"}
+    ,   {H5D_init, "dataset"}
+    ,   {H5F_init, "file"}
+    ,   {H5G_init, "group"}
+    ,   {H5A_init, "attribute"}
+    ,   {H5M_init, "map"}
+    ,   {H5CX_init, "context"}
+    ,   {H5ES_init, "event set"}
+    ,   {H5Z_init, "transform"}
+    ,   {H5PL_init, "plugin"}
+    ,   {H5R_init, "reference"}
+    };
+
     /* Initialize all packages for VOL-managed objects */
-    if (H5T_init() < 0)
-        HGOTO_ERROR(H5E_VOL, H5E_CANTINIT, FAIL, "unable to initialize datatype interface")
-    if (H5D_init() < 0)
-        HGOTO_ERROR(H5E_VOL, H5E_CANTINIT, FAIL, "unable to initialize dataset interface")
-    if (H5F_init() < 0)
-        HGOTO_ERROR(H5E_VOL, H5E_CANTINIT, FAIL, "unable to initialize file interface")
-    if (H5G_init() < 0)
-        HGOTO_ERROR(H5E_VOL, H5E_CANTINIT, FAIL, "unable to initialize group interface")
-    if (H5A_init() < 0)
-        HGOTO_ERROR(H5E_VOL, H5E_CANTINIT, FAIL, "unable to initialize attribute interface")
-    if (H5M_init() < 0)
-        HGOTO_ERROR(H5E_VOL, H5E_CANTINIT, FAIL, "unable to initialize map interface")
+    for (i = 0; i < NELMTS(initializer); i++) {
+        if (initializer[i].func() < 0) {
+            HGOTO_ERROR(H5E_VOL, H5E_CANTINIT, FAIL,
+                "unable to initialize %s interface", initializer[i].descr)
+        }
+    }
+
+    /* clang-format on */
 
     /* Sanity check default VOL connector */
     HDassert(H5VL_def_conn_s.connector_id == (-1));
@@ -202,32 +218,6 @@ done:
 } /* end H5VL_init_phase2() */
 
 /*-------------------------------------------------------------------------
- * Function:	H5VL__init_package
- *
- * Purpose:     Initialize interface-specific information
- *
- * Return:      Success:    Non-negative
- *
- *              Failure:    Negative
- *
- *-------------------------------------------------------------------------
- */
-herr_t
-H5VL__init_package(void)
-{
-    herr_t ret_value = SUCCEED; /* Return value */
-
-    FUNC_ENTER_PACKAGE
-
-    /* Initialize the ID group for the VL IDs */
-    if (H5I_register_type(H5I_VOL_CLS) < 0)
-        HGOTO_ERROR(H5E_VOL, H5E_CANTINIT, FAIL, "unable to initialize H5VL interface")
-
-done:
-    FUNC_LEAVE_NOAPI(ret_value)
-} /* end H5VL__init_package() */
-
-/*-------------------------------------------------------------------------
  * Function:	H5VL_term_package
  *
  * Purpose:     Terminate various H5VL objects
@@ -245,37 +235,31 @@ H5VL_term_package(void)
 
     FUNC_ENTER_NOAPI_NOINIT_NOERR
 
-    if (H5_PKG_INIT_VAR) {
-        if (H5VL_def_conn_s.connector_id > 0) {
-            /* Release the default VOL connector */
-            (void)H5VL_conn_free(&H5VL_def_conn_s);
-            H5VL_def_conn_s.connector_id   = -1;
-            H5VL_def_conn_s.connector_info = NULL;
+    if (H5VL_def_conn_s.connector_id > 0) {
+        /* Release the default VOL connector */
+        (void)H5VL_conn_free(&H5VL_def_conn_s);
+        H5VL_def_conn_s.connector_id   = -1;
+        H5VL_def_conn_s.connector_info = NULL;
+        n++;
+    } /* end if */
+    else {
+        if (H5I_nmembers(H5I_VOL) > 0) {
+            /* Unregister all VOL connectors */
+            (void)H5I_clear_type(H5I_VOL, TRUE, FALSE);
             n++;
         } /* end if */
         else {
-            if (H5I_nmembers(H5I_VOL) > 0) {
-                /* Unregister all VOL connectors */
-                (void)H5I_clear_type(H5I_VOL, TRUE, FALSE);
+            if (H5VL__num_opt_operation() > 0) {
+                /* Unregister all dynamically registered optional operations */
+                (void)H5VL__term_opt_operation();
                 n++;
             } /* end if */
             else {
-                if (H5VL__num_opt_operation() > 0) {
-                    /* Unregister all dynamically registered optional operations */
-                    (void)H5VL__term_opt_operation();
-                    n++;
-                } /* end if */
-                else {
-                    /* Destroy the VOL connector ID group */
-                    n += (H5I_dec_type_ref(H5I_VOL) > 0);
-
-                    /* Mark interface as closed */
-                    if (0 == n)
-                        H5_PKG_INIT_VAR = FALSE;
-                } /* end else */
-            }     /* end else */
-        }         /* end else */
-    }             /* end if */
+                /* Destroy the VOL connector ID group */
+                n += (H5I_dec_type_ref(H5I_VOL) > 0);
+            } /* end else */
+        }     /* end else */
+    }         /* end else */
 
     FUNC_LEAVE_NOAPI(n)
 } /* end H5VL_term_package() */
@@ -972,7 +956,7 @@ H5VL_conn_inc_rc(H5VL_t *connector)
 {
     int64_t ret_value = -1;
 
-    FUNC_ENTER_NOAPI(-1)
+    FUNC_ENTER_NOAPI_NOERR
 
     /* Check arguments */
     HDassert(connector);
@@ -982,7 +966,6 @@ H5VL_conn_inc_rc(H5VL_t *connector)
 
     ret_value = connector->nrefs;
 
-done:
     FUNC_LEAVE_NOAPI(ret_value)
 } /* end H5VL_conn_inc_rc() */
 
@@ -2004,7 +1987,7 @@ H5VL_cmp_connector_cls(int *cmp_value, const H5VL_class_t *cls1, const H5VL_clas
 {
     herr_t ret_value = SUCCEED; /* Return value */
 
-    FUNC_ENTER_NOAPI(FAIL)
+    FUNC_ENTER_NOAPI_NOERR
 
     /* Sanity checks */
     HDassert(cls1);
@@ -2532,7 +2515,7 @@ H5VL_check_plugin_load(const H5VL_class_t *cls, const H5PL_key_t *key, hbool_t *
 {
     herr_t ret_value = SUCCEED; /* Return value */
 
-    FUNC_ENTER_NOAPI(FAIL)
+    FUNC_ENTER_NOAPI_NOERR
 
     /* Sanity checks */
     HDassert(cls);
@@ -2558,7 +2541,6 @@ H5VL_check_plugin_load(const H5VL_class_t *cls, const H5PL_key_t *key, hbool_t *
     if (*success && cls->version != H5VL_VERSION)
         *success = FALSE;
 
-done:
     FUNC_LEAVE_NOAPI(ret_value)
 } /* end H5VL_check_plugin_load() */