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, 32 insertions, 78 deletions

diff --git a/src/H5Dint.c b/src/H5Dint.c
index 6d3f4a3..8a09364 100644
--- a/src/H5Dint.c
+++ b/src/H5Dint.c
@@ -139,9 +139,6 @@ static const H5I_class_t H5I_DATASET_CLS[1] = {{
     (H5I_free_t)H5D__close_cb /* Callback routine for closing objects of this class */
 }};
 
-/* Flag indicating "top" of interface has been initialized */
-static hbool_t H5D_top_package_initialize_s = FALSE;
-
 /* Prefixes of VDS and external file from the environment variables
  * HDF5_EXTFILE_PREFIX and HDF5_VDS_PREFIX */
 static const char *H5D_prefix_ext_env = NULL;
@@ -160,37 +157,10 @@ static const char *H5D_prefix_vds_env = NULL;
 herr_t
 H5D_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 H5D_init() */
-
-/*--------------------------------------------------------------------------
-NAME
-    H5D__init_package -- Initialize interface-specific information
-USAGE
-    herr_t H5D__init_package()
-
-RETURNS
-    Non-negative on success/Negative on failure
-DESCRIPTION
-    Initializes any interface-specific data or routines.
-NOTES
-    Care must be taken when using the H5P functions, since they can cause
-    a deadlock in the library when the library is attempting to terminate -QAK
-
---------------------------------------------------------------------------*/
-herr_t
-H5D__init_package(void)
-{
     H5P_genplist_t *def_dcpl;            /* Default Dataset Creation Property list */
     herr_t          ret_value = SUCCEED; /* Return value */
 
-    FUNC_ENTER_PACKAGE
+    FUNC_ENTER_NOAPI(FAIL)
 
     /* Initialize the ID group for the dataset IDs */
     if (H5I_register_type(H5I_DATASET_CLS) < 0)
@@ -220,16 +190,13 @@ H5D__init_package(void)
     if (H5P_get(def_dcpl, H5O_CRT_PIPELINE_NAME, &H5D_def_dset.dcpl_cache.pline) < 0)
         HGOTO_ERROR(H5E_PLIST, H5E_CANTGET, FAIL, "can't retrieve pipeline filter")
 
-    /* Mark "top" of interface as initialized, too */
-    H5D_top_package_initialize_s = TRUE;
-
     /* Retrieve the prefixes of VDS and external file from the environment variable */
     H5D_prefix_vds_env = HDgetenv("HDF5_VDS_PREFIX");
     H5D_prefix_ext_env = HDgetenv("HDF5_EXTFILE_PREFIX");
 
 done:
     FUNC_LEAVE_NOAPI(ret_value)
-} /* end H5D__init_package() */
+} /* end H5D_init() */
 
 /*-------------------------------------------------------------------------
  * Function: H5D_top_term_package
@@ -248,38 +215,32 @@ H5D_top_term_package(void)
 
     FUNC_ENTER_NOAPI_NOINIT_NOERR
 
-    if (H5D_top_package_initialize_s) {
-        if (H5I_nmembers(H5I_DATASET) > 0) {
-            /* The dataset API uses the "force" flag set to true because it
-             * is using the "file objects" (H5FO) API functions to track open
-             * objects in the file.  Using the H5FO code means that dataset
-             * IDs can have reference counts >1, when an existing dataset is
-             * opened more than once.  However, the H5I code does not attempt
-             * to close objects with reference counts>1 unless the "force" flag
-             * is set to true.
-             *
-             * At some point (probably after the group and datatypes use the
-             * the H5FO code), the H5FO code might need to be switched around
-             * to storing pointers to the objects being tracked (H5D_t, H5G_t,
-             * etc) and reference count those itself instead of relying on the
-             * reference counting in the H5I layer.  Then, the "force" flag can
-             * be put back to false.
-             *
-             * Setting the "force" flag to true for all the interfaces won't
-             * work because the "file driver" (H5FD) APIs use the H5I reference
-             * counting to avoid closing a file driver out from underneath an
-             * open file...
-             *
-             * QAK - 5/13/03
-             */
-            (void)H5I_clear_type(H5I_DATASET, TRUE, FALSE);
-            n++; /*H5I*/
-        }        /* end if */
-
-        /* Mark closed */
-        if (0 == n)
-            H5D_top_package_initialize_s = FALSE;
-    } /* end if */
+    if (H5I_nmembers(H5I_DATASET) > 0) {
+        /* The dataset API uses the "force" flag set to true because it
+         * is using the "file objects" (H5FO) API functions to track open
+         * objects in the file.  Using the H5FO code means that dataset
+         * IDs can have reference counts >1, when an existing dataset is
+         * opened more than once.  However, the H5I code does not attempt
+         * to close objects with reference counts>1 unless the "force" flag
+         * is set to true.
+         *
+         * At some point (probably after the group and datatypes use the
+         * the H5FO code), the H5FO code might need to be switched around
+         * to storing pointers to the objects being tracked (H5D_t, H5G_t,
+         * etc) and reference count those itself instead of relying on the
+         * reference counting in the H5I layer.  Then, the "force" flag can
+         * be put back to false.
+         *
+         * Setting the "force" flag to true for all the interfaces won't
+         * work because the "file driver" (H5FD) APIs use the H5I reference
+         * counting to avoid closing a file driver out from underneath an
+         * open file...
+         *
+         * QAK - 5/13/03
+         */
+        (void)H5I_clear_type(H5I_DATASET, TRUE, FALSE);
+        n++; /*H5I*/
+    }
 
     FUNC_LEAVE_NOAPI(n)
 } /* end H5D_top_term_package() */
@@ -304,18 +265,11 @@ H5D_term_package(void)
 
     FUNC_ENTER_NOAPI_NOINIT_NOERR
 
-    if (H5_PKG_INIT_VAR) {
-        /* Sanity checks */
-        HDassert(0 == H5I_nmembers(H5I_DATASET));
-        HDassert(FALSE == H5D_top_package_initialize_s);
-
-        /* Destroy the dataset object id group */
-        n += (H5I_dec_type_ref(H5I_DATASET) > 0);
+    /* Sanity checks */
+    HDassert(0 == H5I_nmembers(H5I_DATASET));
 
-        /* Mark closed */
-        if (0 == n)
-            H5_PKG_INIT_VAR = FALSE;
-    } /* end if */
+    /* Destroy the dataset object id group */
+    n += (H5I_dec_type_ref(H5I_DATASET) > 0);
 
     FUNC_LEAVE_NOAPI(n)
 } /* end H5D_term_package() */