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, 69 insertions, 75 deletions

diff --git a/src/H5Z.c b/src/H5Z.c
index ea92a01..34af8eb 100644
--- a/src/H5Z.c
+++ b/src/H5Z.c
@@ -56,9 +56,6 @@ typedef enum {
     H5Z_PRELUDE_SET_LOCAL  /* Call "set local" callback */
 } H5Z_prelude_type_t;
 
-/* Package initialization variable */
-hbool_t H5_PKG_INIT_VAR = FALSE;
-
 /* Local variables */
 static size_t        H5Z_table_alloc_g = 0;
 static size_t        H5Z_table_used_g  = 0;
@@ -74,19 +71,23 @@ static int H5Z__check_unregister_group_cb(void *obj_ptr, hid_t obj_id, void *key
 static int H5Z__flush_file_cb(void *obj_ptr, hid_t obj_id, void *key);
 
 /*-------------------------------------------------------------------------
- * Function: H5Z__init_package
+ * Function:    H5Z_init
  *
- * Purpose:  Initializes the data filter layer.
+ * Purpose:     Initialize the interface from some other layer.
  *
- * Return:   Non-negative on success/Negative on failure
+ * Return:      Success:        non-negative
+ *              Failure:        negative
  *-------------------------------------------------------------------------
  */
 herr_t
-H5Z__init_package(void)
+H5Z_init(void)
 {
     herr_t ret_value = SUCCEED; /* Return value */
 
-    FUNC_ENTER_PACKAGE
+    FUNC_ENTER_NOAPI(FAIL)
+
+    if (H5_TERM_GLOBAL)
+        HGOTO_DONE(SUCCEED)
 
     /* Internal filters */
     if (H5Z_register(H5Z_SHUFFLE) < 0)
@@ -111,7 +112,7 @@ H5Z__init_package(void)
 
 done:
     FUNC_LEAVE_NOAPI(ret_value)
-} /* end H5Z__init_package() */
+}
 
 /*-------------------------------------------------------------------------
  * Function: H5Z_term_package
@@ -128,76 +129,70 @@ H5Z_term_package(void)
 
     FUNC_ENTER_NOAPI_NOINIT_NOERR
 
-    if (H5_PKG_INIT_VAR) {
 #ifdef H5Z_DEBUG
-        char   comment[16], bandwidth[32];
-        int    dir, nprint = 0;
-        size_t i;
-
-        if (H5DEBUG(Z)) {
-            for (i = 0; i < H5Z_table_used_g; i++) {
-                for (dir = 0; dir < 2; dir++) {
-                    struct {
-                        char *user;
-                        char *system;
-                        char *elapsed;
-                    } timestrs = {H5_timer_get_time_string(H5Z_stat_table_g[i].stats[dir].times.user),
-                                  H5_timer_get_time_string(H5Z_stat_table_g[i].stats[dir].times.system),
-                                  H5_timer_get_time_string(H5Z_stat_table_g[i].stats[dir].times.elapsed)};
-                    if (0 == H5Z_stat_table_g[i].stats[dir].total)
-                        goto next;
-
-                    if (0 == nprint++) {
-                        /* Print column headers */
-                        HDfprintf(H5DEBUG(Z), "H5Z: filter statistics "
-                                              "accumulated over life of library:\n");
-                        HDfprintf(H5DEBUG(Z), "   %-16s %10s %10s %8s %8s %8s %10s\n", "Filter", "Total",
-                                  "Errors", "User", "System", "Elapsed", "Bandwidth");
-                        HDfprintf(H5DEBUG(Z), "   %-16s %10s %10s %8s %8s %8s %10s\n", "------", "-----",
-                                  "------", "----", "------", "-------", "---------");
-                    } /* end if */
+    char   comment[16], bandwidth[32];
+    int    dir, nprint = 0;
+    size_t i;
 
-                    /* Truncate the comment to fit in the field */
-                    HDstrncpy(comment, H5Z_table_g[i].name, sizeof comment);
-                    comment[sizeof(comment) - 1] = '\0';
-
-                    /*
-                     * Format bandwidth to have four significant digits and
-                     * units of `B/s', `kB/s', `MB/s', `GB/s', or `TB/s' or
-                     * the word `Inf' if the elapsed time is zero.
-                     */
-                    H5_bandwidth(bandwidth, (double)(H5Z_stat_table_g[i].stats[dir].total),
-                                 H5Z_stat_table_g[i].stats[dir].times.elapsed);
-
-                    /* Print the statistics */
-                    HDfprintf(H5DEBUG(Z), "   %s%-15s %10" PRIdHSIZE " %10" PRIdHSIZE " %8s %8s %8s %10s\n",
-                              (dir ? "<" : ">"), comment, H5Z_stat_table_g[i].stats[dir].total,
-                              H5Z_stat_table_g[i].stats[dir].errors, timestrs.user, timestrs.system,
-                              timestrs.elapsed, bandwidth);
+    if (H5DEBUG(Z)) {
+        for (i = 0; i < H5Z_table_used_g; i++) {
+            for (dir = 0; dir < 2; dir++) {
+                struct {
+                    char *user;
+                    char *system;
+                    char *elapsed;
+                } timestrs = {H5_timer_get_time_string(H5Z_stat_table_g[i].stats[dir].times.user),
+                              H5_timer_get_time_string(H5Z_stat_table_g[i].stats[dir].times.system),
+                              H5_timer_get_time_string(H5Z_stat_table_g[i].stats[dir].times.elapsed)};
+                if (0 == H5Z_stat_table_g[i].stats[dir].total)
+                    goto next;
+
+                if (0 == nprint++) {
+                    /* Print column headers */
+                    HDfprintf(H5DEBUG(Z), "H5Z: filter statistics "
+                                          "accumulated over life of library:\n");
+                    HDfprintf(H5DEBUG(Z), "   %-16s %10s %10s %8s %8s %8s %10s\n", "Filter", "Total",
+                              "Errors", "User", "System", "Elapsed", "Bandwidth");
+                    HDfprintf(H5DEBUG(Z), "   %-16s %10s %10s %8s %8s %8s %10s\n", "------", "-----",
+                              "------", "----", "------", "-------", "---------");
+                } /* end if */
+
+                /* Truncate the comment to fit in the field */
+                HDstrncpy(comment, H5Z_table_g[i].name, sizeof comment);
+                comment[sizeof(comment) - 1] = '\0';
+
+                /*
+                 * Format bandwidth to have four significant digits and
+                 * units of `B/s', `kB/s', `MB/s', `GB/s', or `TB/s' or
+                 * the word `Inf' if the elapsed time is zero.
+                 */
+                H5_bandwidth(bandwidth, (double)(H5Z_stat_table_g[i].stats[dir].total),
+                             H5Z_stat_table_g[i].stats[dir].times.elapsed);
+
+                /* Print the statistics */
+                HDfprintf(H5DEBUG(Z), "   %s%-15s %10" PRIdHSIZE " %10" PRIdHSIZE " %8s %8s %8s %10s\n",
+                          (dir ? "<" : ">"), comment, H5Z_stat_table_g[i].stats[dir].total,
+                          H5Z_stat_table_g[i].stats[dir].errors, timestrs.user, timestrs.system,
+                          timestrs.elapsed, bandwidth);
 next:
-                    HDfree(timestrs.user);
-                    HDfree(timestrs.system);
-                    HDfree(timestrs.elapsed);
-                } /* end for */
-            }     /* end for */
-        }         /* end if */
-#endif            /* H5Z_DEBUG */
-
-        /* Free the table of filters */
-        if (H5Z_table_g) {
-            H5Z_table_g = (H5Z_class2_t *)H5MM_xfree(H5Z_table_g);
+                HDfree(timestrs.user);
+                HDfree(timestrs.system);
+                HDfree(timestrs.elapsed);
+            } /* end for */
+        }     /* end for */
+    }         /* end if */
+#endif        /* H5Z_DEBUG */
+
+    /* Free the table of filters */
+    if (H5Z_table_g) {
+        H5Z_table_g = (H5Z_class2_t *)H5MM_xfree(H5Z_table_g);
 
 #ifdef H5Z_DEBUG
-            H5Z_stat_table_g = (H5Z_stats_t *)H5MM_xfree(H5Z_stat_table_g);
+        H5Z_stat_table_g = (H5Z_stats_t *)H5MM_xfree(H5Z_stat_table_g);
 #endif /* H5Z_DEBUG */
-            H5Z_table_used_g = H5Z_table_alloc_g = 0;
-
-            n++;
-        } /* end if */
+        H5Z_table_used_g = H5Z_table_alloc_g = 0;
 
-        /* Mark interface as closed */
-        if (0 == n)
-            H5_PKG_INIT_VAR = FALSE;
+        n++;
     } /* end if */
 
     FUNC_LEAVE_NOAPI(n)
@@ -1520,7 +1515,7 @@ H5Z_filter_in_pline(const H5O_pline_t *pline, H5Z_filter_t filter)
     size_t idx;              /* Index of filter in pipeline */
     htri_t ret_value = TRUE; /* Return value */
 
-    FUNC_ENTER_NOAPI(FAIL)
+    FUNC_ENTER_NOAPI_NOERR
 
     HDassert(pline);
     HDassert(filter >= 0 && filter <= H5Z_FILTER_MAX);
@@ -1534,7 +1529,6 @@ H5Z_filter_in_pline(const H5O_pline_t *pline, H5Z_filter_t filter)
     if (idx >= pline->nused)
         ret_value = FALSE;
 
-done:
     FUNC_LEAVE_NOAPI(ret_value)
 } /* end H5Z_filter_in_pline() */
 
@@ -1554,7 +1548,7 @@ H5Z_all_filters_avail(const H5O_pline_t *pline)
     size_t i, j;             /* Local index variable */
     htri_t ret_value = TRUE; /* Return value */
 
-    FUNC_ENTER_NOAPI(FAIL)
+    FUNC_ENTER_NOAPI_NOERR
 
     /* Check args */
     HDassert(pline);