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, 98 insertions, 129 deletions

diff --git a/src/H5Pint.c b/src/H5Pint.c
index 9206d4c..7175fda 100644
--- a/src/H5Pint.c
+++ b/src/H5Pint.c
@@ -123,7 +123,7 @@ static herr_t H5P__free_del_name_cb(void *item, void H5_ATTR_UNUSED *key, void H
 
 /*
  * Predefined property list classes. These are initialized at runtime by
- * H5P__init_package() in this source file.
+ * H5P_init() in this source file.
  */
 hid_t           H5P_CLS_ROOT_ID_g             = H5I_INVALID_HID;
 H5P_genclass_t *H5P_CLS_ROOT_g                = NULL;
@@ -172,7 +172,7 @@ H5P_genclass_t *H5P_CLS_REFERENCE_ACCESS_g    = NULL;
 
 /*
  * Predefined property lists for each predefined class. These are initialized
- * at runtime by H5P__init_package() in this source file.
+ * at runtime by H5P_init() in this source file.
  */
 hid_t H5P_LST_FILE_CREATE_ID_g      = H5I_INVALID_HID;
 hid_t H5P_LST_FILE_ACCESS_ID_g      = H5I_INVALID_HID;
@@ -429,63 +429,12 @@ static const H5I_class_t H5I_GENPROPLST_CLS[1] = {{
 herr_t
 H5P_init_phase1(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 H5P_init_phase1() */
-
-/*-------------------------------------------------------------------------
- * Function:    H5P_init_phase2
- *
- * Purpose:     Finish initializing the interface from some other package.
- *
- * Note:        This is broken out as a separate routine so that the
- *              library's default VFL driver can be chosen and initialized
- *              after the entire H5P interface has been initialized.
- *
- * Return:      Success:    Non-negative
- *              Failure:    Negative
- *
- *-------------------------------------------------------------------------
- */
-herr_t
-H5P_init_phase2(void)
-{
-    herr_t ret_value = SUCCEED;
-
-    FUNC_ENTER_NOAPI(FAIL)
-
-    /* Set up the default VFL driver */
-    if (H5P__facc_set_def_driver() < 0)
-        HGOTO_ERROR(H5E_VFL, H5E_CANTSET, FAIL, "unable to set default VFL driver")
-
-done:
-    FUNC_LEAVE_NOAPI(ret_value)
-} /* end H5P_init_phase2() */
-
-/*--------------------------------------------------------------------------
-NAME
-   H5P__init_package -- Initialize interface-specific information
-USAGE
-    herr_t H5P__init_package()
-RETURNS
-    Non-negative on success/Negative on failure
-DESCRIPTION
-    Initializes any interface-specific data or routines.
---------------------------------------------------------------------------*/
-herr_t
-H5P__init_package(void)
-{
     size_t tot_init = 0; /* Total # of classes initialized */
     size_t pass_init;    /* # of classes initialized in each pass */
     size_t u;
     herr_t ret_value = SUCCEED; /* Return value */
 
-    FUNC_ENTER_PACKAGE
+    FUNC_ENTER_NOAPI(FAIL)
 
     /* Sanity check */
     HDcompile_assert(H5P_TYPE_REFERENCE_ACCESS == (H5P_TYPE_MAX_TYPE - 1));
@@ -576,7 +525,36 @@ done:
     }
 
     FUNC_LEAVE_NOAPI(ret_value)
-} /* end H5P__init_package() */
+}
+
+/*-------------------------------------------------------------------------
+ * Function:    H5P_init_phase2
+ *
+ * Purpose:     Finish initializing the interface from some other package.
+ *
+ * Note:        This is broken out as a separate routine so that the
+ *              library's default VFL driver can be chosen and initialized
+ *              after the entire H5P interface has been initialized.
+ *
+ * Return:      Success:    Non-negative
+ *              Failure:    Negative
+ *
+ *-------------------------------------------------------------------------
+ */
+herr_t
+H5P_init_phase2(void)
+{
+    herr_t ret_value = SUCCEED;
+
+    FUNC_ENTER_NOAPI(FAIL)
+
+    /* Set up the default VFL driver */
+    if (H5P__facc_set_def_driver() < 0)
+        HGOTO_ERROR(H5E_VFL, H5E_CANTSET, FAIL, "unable to set default VFL driver")
+
+done:
+    FUNC_LEAVE_NOAPI(ret_value)
+} /* end H5P_init_phase2() */
 
 /*--------------------------------------------------------------------------
  NAME
@@ -602,77 +580,70 @@ H5P_term_package(void)
 
     FUNC_ENTER_NOAPI_NOINIT_NOERR
 
-    if (H5_PKG_INIT_VAR) {
-        int64_t nlist, nclass;
-
-        /* Destroy HDF5 library property classes & lists */
-
-        /* Check if there are any open property list classes or lists */
-        nclass = H5I_nmembers(H5I_GENPROP_CLS);
-        nlist  = H5I_nmembers(H5I_GENPROP_LST);
-
-        /* If there are any open classes or groups, attempt to get rid of them. */
-        if ((nclass + nlist) > 0) {
-            /* Clear the lists */
-            if (nlist > 0) {
-                (void)H5I_clear_type(H5I_GENPROP_LST, FALSE, FALSE);
-
-                /* Reset the default property lists, if they've been closed */
-                if (H5I_nmembers(H5I_GENPROP_LST) == 0) {
-                    H5P_LST_FILE_CREATE_ID_g = H5P_LST_FILE_ACCESS_ID_g = H5P_LST_DATASET_CREATE_ID_g =
-                        H5P_LST_DATASET_ACCESS_ID_g = H5P_LST_DATASET_XFER_ID_g = H5P_LST_GROUP_CREATE_ID_g =
-                            H5P_LST_GROUP_ACCESS_ID_g                       = H5P_LST_DATATYPE_CREATE_ID_g =
-                                H5P_LST_DATATYPE_ACCESS_ID_g                = H5P_LST_MAP_CREATE_ID_g =
-                                    H5P_LST_MAP_ACCESS_ID_g                 = H5P_LST_ATTRIBUTE_CREATE_ID_g =
-                                        H5P_LST_ATTRIBUTE_ACCESS_ID_g       = H5P_LST_OBJECT_COPY_ID_g =
-                                            H5P_LST_LINK_CREATE_ID_g        = H5P_LST_LINK_ACCESS_ID_g =
-                                                H5P_LST_VOL_INITIALIZE_ID_g = H5P_LST_REFERENCE_ACCESS_ID_g =
-                                                    H5P_LST_FILE_MOUNT_ID_g = H5I_INVALID_HID;
-                } /* end if */
-            }     /* end if */
-
-            /* Only attempt to close the classes after all the lists are closed */
-            if (nlist == 0 && nclass > 0) {
-                (void)H5I_clear_type(H5I_GENPROP_CLS, FALSE, FALSE);
-
-                /* Reset the default property classes, if they've been closed */
-                if (H5I_nmembers(H5I_GENPROP_CLS) == 0) {
-                    H5P_CLS_ROOT_g = H5P_CLS_OBJECT_CREATE_g = H5P_CLS_FILE_CREATE_g = H5P_CLS_FILE_ACCESS_g =
-                        H5P_CLS_DATASET_CREATE_g = H5P_CLS_DATASET_ACCESS_g = H5P_CLS_DATASET_XFER_g =
-                            H5P_CLS_GROUP_CREATE_g = H5P_CLS_GROUP_ACCESS_g = H5P_CLS_DATATYPE_CREATE_g =
-                                H5P_CLS_DATATYPE_ACCESS_g = H5P_CLS_MAP_CREATE_g = H5P_CLS_MAP_ACCESS_g =
-                                    H5P_CLS_STRING_CREATE_g              = H5P_CLS_ATTRIBUTE_CREATE_g =
-                                        H5P_CLS_ATTRIBUTE_ACCESS_g       = H5P_CLS_OBJECT_COPY_g =
-                                            H5P_CLS_LINK_CREATE_g        = H5P_CLS_LINK_ACCESS_g =
-                                                H5P_CLS_VOL_INITIALIZE_g = H5P_CLS_REFERENCE_ACCESS_g =
-                                                    H5P_CLS_FILE_MOUNT_g = NULL;
-
-                    H5P_CLS_ROOT_ID_g = H5P_CLS_OBJECT_CREATE_ID_g = H5P_CLS_FILE_CREATE_ID_g =
-                        H5P_CLS_FILE_ACCESS_ID_g = H5P_CLS_DATASET_CREATE_ID_g = H5P_CLS_DATASET_ACCESS_ID_g =
-                            H5P_CLS_DATASET_XFER_ID_g                          = H5P_CLS_GROUP_CREATE_ID_g =
-                                H5P_CLS_GROUP_ACCESS_ID_g                    = H5P_CLS_DATATYPE_CREATE_ID_g =
-                                    H5P_CLS_DATATYPE_ACCESS_ID_g             = H5P_CLS_MAP_CREATE_ID_g =
-                                        H5P_CLS_MAP_ACCESS_ID_g              = H5P_CLS_STRING_CREATE_ID_g =
-                                            H5P_CLS_ATTRIBUTE_CREATE_ID_g    = H5P_CLS_ATTRIBUTE_ACCESS_ID_g =
-                                                H5P_CLS_OBJECT_COPY_ID_g     = H5P_CLS_LINK_CREATE_ID_g =
-                                                    H5P_CLS_LINK_ACCESS_ID_g = H5P_CLS_VOL_INITIALIZE_ID_g =
-                                                        H5P_CLS_REFERENCE_ACCESS_ID_g =
-                                                            H5P_CLS_FILE_MOUNT_ID_g = H5I_INVALID_HID;
-                } /* end if */
-            }     /* end if */
+    int64_t nlist, nclass;
+
+    /* Destroy HDF5 library property classes & lists */
+
+    /* Check if there are any open property list classes or lists */
+    nclass = H5I_nmembers(H5I_GENPROP_CLS);
+    nlist  = H5I_nmembers(H5I_GENPROP_LST);
+
+    /* If there are any open classes or groups, attempt to get rid of them. */
+    if ((nclass + nlist) > 0) {
+        /* Clear the lists */
+        if (nlist > 0) {
+            (void)H5I_clear_type(H5I_GENPROP_LST, FALSE, FALSE);
+
+            /* Reset the default property lists, if they've been closed */
+            if (H5I_nmembers(H5I_GENPROP_LST) == 0) {
+                H5P_LST_FILE_CREATE_ID_g = H5P_LST_FILE_ACCESS_ID_g = H5P_LST_DATASET_CREATE_ID_g =
+                    H5P_LST_DATASET_ACCESS_ID_g = H5P_LST_DATASET_XFER_ID_g = H5P_LST_GROUP_CREATE_ID_g =
+                        H5P_LST_GROUP_ACCESS_ID_g                           = H5P_LST_DATATYPE_CREATE_ID_g =
+                            H5P_LST_DATATYPE_ACCESS_ID_g = H5P_LST_MAP_CREATE_ID_g = H5P_LST_MAP_ACCESS_ID_g =
+                                H5P_LST_ATTRIBUTE_CREATE_ID_g             = H5P_LST_ATTRIBUTE_ACCESS_ID_g =
+                                    H5P_LST_OBJECT_COPY_ID_g              = H5P_LST_LINK_CREATE_ID_g =
+                                        H5P_LST_LINK_ACCESS_ID_g          = H5P_LST_VOL_INITIALIZE_ID_g =
+                                            H5P_LST_REFERENCE_ACCESS_ID_g = H5P_LST_FILE_MOUNT_ID_g =
+                                                H5I_INVALID_HID;
+            } /* end if */
+        }     /* end if */
 
-            n++; /*H5I*/
-        }
-        else {
-            /* Destroy the property list and class id groups */
-            n += (H5I_dec_type_ref(H5I_GENPROP_LST) > 0);
-            n += (H5I_dec_type_ref(H5I_GENPROP_CLS) > 0);
+        /* Only attempt to close the classes after all the lists are closed */
+        if (nlist == 0 && nclass > 0) {
+            (void)H5I_clear_type(H5I_GENPROP_CLS, FALSE, FALSE);
+
+            /* Reset the default property classes, if they've been closed */
+            if (H5I_nmembers(H5I_GENPROP_CLS) == 0) {
+                H5P_CLS_ROOT_g = H5P_CLS_OBJECT_CREATE_g = H5P_CLS_FILE_CREATE_g = H5P_CLS_FILE_ACCESS_g =
+                    H5P_CLS_DATASET_CREATE_g = H5P_CLS_DATASET_ACCESS_g = H5P_CLS_DATASET_XFER_g =
+                        H5P_CLS_GROUP_CREATE_g = H5P_CLS_GROUP_ACCESS_g = H5P_CLS_DATATYPE_CREATE_g =
+                            H5P_CLS_DATATYPE_ACCESS_g = H5P_CLS_MAP_CREATE_g = H5P_CLS_MAP_ACCESS_g =
+                                H5P_CLS_STRING_CREATE_g                      = H5P_CLS_ATTRIBUTE_CREATE_g =
+                                    H5P_CLS_ATTRIBUTE_ACCESS_g               = H5P_CLS_OBJECT_COPY_g =
+                                        H5P_CLS_LINK_CREATE_g                = H5P_CLS_LINK_ACCESS_g =
+                                            H5P_CLS_VOL_INITIALIZE_g         = H5P_CLS_REFERENCE_ACCESS_g =
+                                                H5P_CLS_FILE_MOUNT_g         = NULL;
+
+                H5P_CLS_ROOT_ID_g = H5P_CLS_OBJECT_CREATE_ID_g = H5P_CLS_FILE_CREATE_ID_g =
+                    H5P_CLS_FILE_ACCESS_ID_g = H5P_CLS_DATASET_CREATE_ID_g = H5P_CLS_DATASET_ACCESS_ID_g =
+                        H5P_CLS_DATASET_XFER_ID_g = H5P_CLS_GROUP_CREATE_ID_g = H5P_CLS_GROUP_ACCESS_ID_g =
+                            H5P_CLS_DATATYPE_CREATE_ID_g                      = H5P_CLS_DATATYPE_ACCESS_ID_g =
+                                H5P_CLS_MAP_CREATE_ID_g                       = H5P_CLS_MAP_ACCESS_ID_g =
+                                    H5P_CLS_STRING_CREATE_ID_g              = H5P_CLS_ATTRIBUTE_CREATE_ID_g =
+                                        H5P_CLS_ATTRIBUTE_ACCESS_ID_g       = H5P_CLS_OBJECT_COPY_ID_g =
+                                            H5P_CLS_LINK_CREATE_ID_g        = H5P_CLS_LINK_ACCESS_ID_g =
+                                                H5P_CLS_VOL_INITIALIZE_ID_g = H5P_CLS_REFERENCE_ACCESS_ID_g =
+                                                    H5P_CLS_FILE_MOUNT_ID_g = H5I_INVALID_HID;
+            } /* end if */
+        }     /* end if */
 
-            /* Mark closed */
-            if (0 == n)
-                H5_PKG_INIT_VAR = FALSE;
-        } /* end else */
-    }     /* end if */
+        n++; /*H5I*/
+    }
+    else {
+        /* Destroy the property list and class id groups */
+        n += (H5I_dec_type_ref(H5I_GENPROP_LST) > 0);
+        n += (H5I_dec_type_ref(H5I_GENPROP_CLS) > 0);
+    } /* end else */
 
     FUNC_LEAVE_NOAPI(n)
 } /* end H5P_term_package() */
@@ -3553,7 +3524,7 @@ H5P_get_nprops_pclass(const H5P_genclass_t *pclass, size_t *nprops, hbool_t recu
 {
     herr_t ret_value = SUCCEED; /* Return value */
 
-    FUNC_ENTER_NOAPI(FAIL)
+    FUNC_ENTER_NOAPI_NOERR
 
     HDassert(pclass);
     HDassert(nprops);
@@ -3568,7 +3539,6 @@ H5P_get_nprops_pclass(const H5P_genclass_t *pclass, size_t *nprops, hbool_t recu
             *nprops += pclass->nprops;
         } /* end while */
 
-done:
     FUNC_LEAVE_NOAPI(ret_value)
 } /* H5P_get_nprops_pclass() */
 
@@ -3999,7 +3969,7 @@ H5P_class_isa(const H5P_genclass_t *pclass1, const H5P_genclass_t *pclass2)
 {
     htri_t ret_value = FAIL; /* Return value */
 
-    FUNC_ENTER_NOAPI(FAIL)
+    FUNC_ENTER_NOAPI_NOERR
 
     HDassert(pclass1);
     HDassert(pclass2);
@@ -5301,14 +5271,13 @@ H5P_get_class_name(H5P_genclass_t *pclass)
 {
     char *ret_value = NULL; /* Return value */
 
-    FUNC_ENTER_NOAPI(NULL)
+    FUNC_ENTER_NOAPI_NOERR
 
     HDassert(pclass);
 
     /* Get class name */
     ret_value = H5MM_xstrdup(pclass->name);
 
-done:
     FUNC_LEAVE_NOAPI(ret_value)
 } /* H5P_get_class_name() */