Removes alternative function enter/leave macro scheme (#678)

* Committing clang-format changes

* Converted BEGIN_FUNC, etc. macros to FUNC_ENTER

* Rips out the BEGIN_FUNC, etc. macros

* Removes 'end if', etc. comments from H5HL package

* Committing clang-format changes

* Fixes an H5EA iterate issue

* Fixes an issue in the H5FA iterator code

* Further cleanup in bin/trace after macro removal

* Iterator changes in H5EA and H5FA

Co-authored-by: github-actions <41898282+github-actions[bot]@users.noreply.github.com>

1 files changed, 99 insertions, 65 deletions

diff --git a/src/H5EAsblock.c b/src/H5EAsblock.c
index 8639217..30cb220 100644
--- a/src/H5EAsblock.c
+++ b/src/H5EAsblock.c
@@ -91,22 +91,25 @@ H5FL_BLK_DEFINE(page_init);
  *
  *-------------------------------------------------------------------------
  */
-BEGIN_FUNC(PKG, ERR, H5EA_sblock_t *, NULL, NULL,
-           H5EA__sblock_alloc(H5EA_hdr_t *hdr, H5EA_iblock_t *parent, unsigned sblk_idx))
+H5EA_sblock_t *
+H5EA__sblock_alloc(H5EA_hdr_t *hdr, H5EA_iblock_t *parent, unsigned sblk_idx)
+{
+    H5EA_sblock_t *sblock    = NULL; /* Extensible array super block */
+    H5EA_sblock_t *ret_value = NULL;
 
-    /* Local variables */
-    H5EA_sblock_t *sblock = NULL; /* Extensible array super block */
+    FUNC_ENTER_PACKAGE
 
     /* Check arguments */
     HDassert(hdr);
 
     /* Allocate memory for the index block */
     if (NULL == (sblock = H5FL_CALLOC(H5EA_sblock_t)))
-        H5E_THROW(H5E_CANTALLOC, "memory allocation failed for extensible array super block")
+        HGOTO_ERROR(H5E_EARRAY, H5E_CANTALLOC, NULL,
+                    "memory allocation failed for extensible array super block")
 
     /* Share common array information */
     if (H5EA__hdr_incr(hdr) < 0)
-        H5E_THROW(H5E_CANTINC, "can't increment reference count on shared array header")
+        HGOTO_ERROR(H5E_EARRAY, H5E_CANTINC, NULL, "can't increment reference count on shared array header")
     sblock->hdr = hdr;
 
     /* Set non-zero internal fields */
@@ -121,7 +124,8 @@ BEGIN_FUNC(PKG, ERR, H5EA_sblock_t *, NULL, NULL,
 
     /* Allocate buffer for data block addresses in super block */
     if (NULL == (sblock->dblk_addrs = H5FL_SEQ_MALLOC(haddr_t, sblock->ndblks)))
-        H5E_THROW(H5E_CANTALLOC, "memory allocation failed for super block data block addresses")
+        HGOTO_ERROR(H5E_EARRAY, H5E_CANTALLOC, NULL,
+                    "memory allocation failed for super block data block addresses")
 
     /* Check if # of elements in data blocks requires paging */
     if (sblock->dblk_nelmts > hdr->dblk_page_nelmts) {
@@ -141,7 +145,8 @@ BEGIN_FUNC(PKG, ERR, H5EA_sblock_t *, NULL, NULL,
         /* Allocate buffer for all 'page init' bitmasks in super block */
         if (NULL ==
             (sblock->page_init = H5FL_BLK_CALLOC(page_init, sblock->ndblks * sblock->dblk_page_init_size)))
-            H5E_THROW(H5E_CANTALLOC, "memory allocation failed for super block page init bitmask")
+            HGOTO_ERROR(H5E_EARRAY, H5E_CANTALLOC, NULL,
+                        "memory allocation failed for super block page init bitmask")
 
         /* Compute data block page size */
         sblock->dblk_page_size = (hdr->dblk_page_nelmts * hdr->cparam.raw_elmt_size) + H5EA_SIZEOF_CHKSUM;
@@ -150,12 +155,13 @@ BEGIN_FUNC(PKG, ERR, H5EA_sblock_t *, NULL, NULL,
     /* Set the return value */
     ret_value = sblock;
 
-    CATCH
+done:
     if (!ret_value)
         if (sblock && H5EA__sblock_dest(sblock) < 0)
-            H5E_THROW(H5E_CANTFREE, "unable to destroy extensible array super block")
+            HDONE_ERROR(H5E_EARRAY, H5E_CANTFREE, NULL, "unable to destroy extensible array super block")
 
-END_FUNC(PKG) /* end H5EA__sblock_alloc() */
+    FUNC_LEAVE_NOAPI(ret_value)
+} /* end H5EA__sblock_alloc() */
 
 /*-------------------------------------------------------------------------
  * Function:	H5EA__sblock_create
@@ -169,15 +175,16 @@ END_FUNC(PKG) /* end H5EA__sblock_alloc() */
  *
  *-------------------------------------------------------------------------
  */
-BEGIN_FUNC(PKG, ERR, haddr_t, HADDR_UNDEF, HADDR_UNDEF,
-           H5EA__sblock_create(H5EA_hdr_t *hdr, H5EA_iblock_t *parent, hbool_t *stats_changed,
-                               unsigned sblk_idx))
+haddr_t
+H5EA__sblock_create(H5EA_hdr_t *hdr, H5EA_iblock_t *parent, hbool_t *stats_changed, unsigned sblk_idx)
+{
+    H5EA_sblock_t *sblock = NULL;           /* Extensible array super block */
+    haddr_t        sblock_addr;             /* Extensible array super block address */
+    haddr_t        tmp_addr  = HADDR_UNDEF; /* Address value to fill data block addresses with */
+    hbool_t        inserted  = FALSE;       /* Whether the header was inserted into cache */
+    haddr_t        ret_value = HADDR_UNDEF;
 
-    /* Local variables */
-    H5EA_sblock_t *sblock = NULL;          /* Extensible array super block */
-    haddr_t        sblock_addr;            /* Extensible array super block address */
-    haddr_t        tmp_addr = HADDR_UNDEF; /* Address value to fill data block addresses with */
-    hbool_t        inserted = FALSE;       /* Whether the header was inserted into cache */
+    FUNC_ENTER_PACKAGE
 
     /* Sanity check */
     HDassert(hdr);
@@ -185,7 +192,8 @@ BEGIN_FUNC(PKG, ERR, haddr_t, HADDR_UNDEF, HADDR_UNDEF,
 
     /* Allocate the super block */
     if (NULL == (sblock = H5EA__sblock_alloc(hdr, parent, sblk_idx)))
-        H5E_THROW(H5E_CANTALLOC, "memory allocation failed for extensible array super block")
+        HGOTO_ERROR(H5E_EARRAY, H5E_CANTALLOC, HADDR_UNDEF,
+                    "memory allocation failed for extensible array super block")
 
     /* Set size of super block on disk */
     sblock->size = H5EA_SBLOCK_SIZE(sblock);
@@ -195,7 +203,8 @@ BEGIN_FUNC(PKG, ERR, haddr_t, HADDR_UNDEF, HADDR_UNDEF,
 
     /* Allocate space for the super block on disk */
     if (HADDR_UNDEF == (sblock_addr = H5MF_alloc(hdr->f, H5FD_MEM_EARRAY_SBLOCK, (hsize_t)sblock->size)))
-        H5E_THROW(H5E_CANTALLOC, "file allocation failed for extensible array super block")
+        HGOTO_ERROR(H5E_EARRAY, H5E_CANTALLOC, HADDR_UNDEF,
+                    "file allocation failed for extensible array super block")
     sblock->addr = sblock_addr;
 
     /* Reset data block addresses to "undefined" address value */
@@ -203,13 +212,15 @@ BEGIN_FUNC(PKG, ERR, haddr_t, HADDR_UNDEF, HADDR_UNDEF,
 
     /* Cache the new extensible array super block */
     if (H5AC_insert_entry(hdr->f, H5AC_EARRAY_SBLOCK, sblock_addr, sblock, H5AC__NO_FLAGS_SET) < 0)
-        H5E_THROW(H5E_CANTINSERT, "can't add extensible array super block to cache")
+        HGOTO_ERROR(H5E_EARRAY, H5E_CANTINSERT, HADDR_UNDEF,
+                    "can't add extensible array super block to cache")
     inserted = TRUE;
 
     /* Add super block as child of 'top' proxy */
     if (hdr->top_proxy) {
         if (H5AC_proxy_entry_add_child(hdr->top_proxy, hdr->f, sblock) < 0)
-            H5E_THROW(H5E_CANTSET, "unable to add extensible array entry as child of array proxy")
+            HGOTO_ERROR(H5E_EARRAY, H5E_CANTSET, HADDR_UNDEF,
+                        "unable to add extensible array entry as child of array proxy")
         sblock->top_proxy = hdr->top_proxy;
     } /* end if */
 
@@ -223,25 +234,29 @@ BEGIN_FUNC(PKG, ERR, haddr_t, HADDR_UNDEF, HADDR_UNDEF,
     /* Set address of super block to return */
     ret_value = sblock_addr;
 
-    CATCH
+done:
     if (!H5F_addr_defined(ret_value))
         if (sblock) {
             /* Remove from cache, if inserted */
             if (inserted)
                 if (H5AC_remove_entry(sblock) < 0)
-                    H5E_THROW(H5E_CANTREMOVE, "unable to remove extensible array super block from cache")
+                    HDONE_ERROR(H5E_EARRAY, H5E_CANTREMOVE, HADDR_UNDEF,
+                                "unable to remove extensible array super block from cache")
 
             /* Release super block's disk space */
             if (H5F_addr_defined(sblock->addr) &&
                 H5MF_xfree(hdr->f, H5FD_MEM_EARRAY_SBLOCK, sblock->addr, (hsize_t)sblock->size) < 0)
-                H5E_THROW(H5E_CANTFREE, "unable to release extensible array super block")
+                HDONE_ERROR(H5E_EARRAY, H5E_CANTFREE, HADDR_UNDEF,
+                            "unable to release extensible array super block")
 
             /* Destroy super block */
             if (H5EA__sblock_dest(sblock) < 0)
-                H5E_THROW(H5E_CANTFREE, "unable to destroy extensible array super block")
+                HDONE_ERROR(H5E_EARRAY, H5E_CANTFREE, HADDR_UNDEF,
+                            "unable to destroy extensible array super block")
         } /* end if */
 
-END_FUNC(PKG) /* end H5EA__sblock_create() */
+    FUNC_LEAVE_NOAPI(ret_value)
+} /* end H5EA__sblock_create() */
 
 /*-------------------------------------------------------------------------
  * Function:	H5EA__sblock_protect
@@ -255,13 +270,15 @@ END_FUNC(PKG) /* end H5EA__sblock_create() */
  *
  *-------------------------------------------------------------------------
  */
-BEGIN_FUNC(PKG, ERR, H5EA_sblock_t *, NULL, NULL,
-           H5EA__sblock_protect(H5EA_hdr_t *hdr, H5EA_iblock_t *parent, haddr_t sblk_addr, unsigned sblk_idx,
-                                unsigned flags))
-
-    /* Local variables */
+H5EA_sblock_t *
+H5EA__sblock_protect(H5EA_hdr_t *hdr, H5EA_iblock_t *parent, haddr_t sblk_addr, unsigned sblk_idx,
+                     unsigned flags)
+{
     H5EA_sblock_t *        sblock = NULL; /* Pointer to super block */
     H5EA_sblock_cache_ud_t udata;         /* Information needed for loading super block */
+    H5EA_sblock_t *        ret_value = NULL;
+
+    FUNC_ENTER_PACKAGE
 
     /* Sanity check */
     HDassert(hdr);
@@ -279,31 +296,35 @@ BEGIN_FUNC(PKG, ERR, H5EA_sblock_t *, NULL, NULL,
     /* Protect the super block */
     if (NULL ==
         (sblock = (H5EA_sblock_t *)H5AC_protect(hdr->f, H5AC_EARRAY_SBLOCK, sblk_addr, &udata, flags)))
-        H5E_THROW(H5E_CANTPROTECT, "unable to protect extensible array super block, address = %llu",
-                  (unsigned long long)sblk_addr)
+        HGOTO_ERROR(H5E_EARRAY, H5E_CANTPROTECT, NULL,
+                    "unable to protect extensible array super block, address = %llu",
+                    (unsigned long long)sblk_addr)
 
     /* Create top proxy, if it doesn't exist */
     if (hdr->top_proxy && NULL == sblock->top_proxy) {
         /* Add super block as child of 'top' proxy */
         if (H5AC_proxy_entry_add_child(hdr->top_proxy, hdr->f, sblock) < 0)
-            H5E_THROW(H5E_CANTSET, "unable to add extensible array entry as child of array proxy")
+            HGOTO_ERROR(H5E_EARRAY, H5E_CANTSET, NULL,
+                        "unable to add extensible array entry as child of array proxy")
         sblock->top_proxy = hdr->top_proxy;
-    } /* end if */
+    }
 
     /* Set return value */
     ret_value = sblock;
 
-    CATCH
+done:
     /* Clean up on error */
     if (!ret_value) {
         /* Release the super block, if it was protected */
         if (sblock &&
             H5AC_unprotect(hdr->f, H5AC_EARRAY_SBLOCK, sblock->addr, sblock, H5AC__NO_FLAGS_SET) < 0)
-            H5E_THROW(H5E_CANTUNPROTECT, "unable to unprotect extensible array super block, address = %llu",
-                      (unsigned long long)sblock->addr)
-    } /* end if */
+            HDONE_ERROR(H5E_EARRAY, H5E_CANTUNPROTECT, NULL,
+                        "unable to unprotect extensible array super block, address = %llu",
+                        (unsigned long long)sblock->addr)
+    }
 
-END_FUNC(PKG) /* end H5EA__sblock_protect() */
+    FUNC_LEAVE_NOAPI(ret_value)
+} /* end H5EA__sblock_protect() */
 
 /*-------------------------------------------------------------------------
  * Function:	H5EA__sblock_unprotect
@@ -317,22 +338,25 @@ END_FUNC(PKG) /* end H5EA__sblock_protect() */
  *
  *-------------------------------------------------------------------------
  */
-BEGIN_FUNC(PKG, ERR, herr_t, SUCCEED, FAIL,
-           H5EA__sblock_unprotect(H5EA_sblock_t *sblock, unsigned cache_flags))
+herr_t
+H5EA__sblock_unprotect(H5EA_sblock_t *sblock, unsigned cache_flags)
+{
+    herr_t ret_value = SUCCEED;
 
-    /* Local variables */
+    FUNC_ENTER_PACKAGE
 
     /* Sanity check */
     HDassert(sblock);
 
     /* Unprotect the super block */
     if (H5AC_unprotect(sblock->hdr->f, H5AC_EARRAY_SBLOCK, sblock->addr, sblock, cache_flags) < 0)
-        H5E_THROW(H5E_CANTUNPROTECT, "unable to unprotect extensible array super block, address = %llu",
-                  (unsigned long long)sblock->addr)
-
-    CATCH
+        HGOTO_ERROR(H5E_EARRAY, H5E_CANTUNPROTECT, FAIL,
+                    "unable to unprotect extensible array super block, address = %llu",
+                    (unsigned long long)sblock->addr)
 
-END_FUNC(PKG) /* end H5EA__sblock_unprotect() */
+done:
+    FUNC_LEAVE_NOAPI(ret_value)
+} /* end H5EA__sblock_unprotect() */
 
 /*-------------------------------------------------------------------------
  * Function:	H5EA__sblock_delete
@@ -346,12 +370,14 @@ END_FUNC(PKG) /* end H5EA__sblock_unprotect() */
  *
  *-------------------------------------------------------------------------
  */
-BEGIN_FUNC(PKG, ERR, herr_t, SUCCEED, FAIL,
-           H5EA__sblock_delete(H5EA_hdr_t *hdr, H5EA_iblock_t *parent, haddr_t sblk_addr, unsigned sblk_idx))
-
-    /* Local variables */
+herr_t
+H5EA__sblock_delete(H5EA_hdr_t *hdr, H5EA_iblock_t *parent, haddr_t sblk_addr, unsigned sblk_idx)
+{
     H5EA_sblock_t *sblock = NULL; /* Pointer to super block */
     size_t         u;             /* Local index variable */
+    herr_t         ret_value = SUCCEED;
+
+    FUNC_ENTER_PACKAGE
 
     /* Sanity check */
     HDassert(hdr);
@@ -359,8 +385,9 @@ BEGIN_FUNC(PKG, ERR, herr_t, SUCCEED, FAIL,
 
     /* Protect super block */
     if (NULL == (sblock = H5EA__sblock_protect(hdr, parent, sblk_addr, sblk_idx, H5AC__NO_FLAGS_SET)))
-        H5E_THROW(H5E_CANTPROTECT, "unable to protect extensible array super block, address = %llu",
-                  (unsigned long long)sblk_addr)
+        HGOTO_ERROR(H5E_EARRAY, H5E_CANTPROTECT, FAIL,
+                    "unable to protect extensible array super block, address = %llu",
+                    (unsigned long long)sblk_addr)
 
     /* Iterate over data blocks */
     for (u = 0; u < sblock->ndblks; u++) {
@@ -368,18 +395,19 @@ BEGIN_FUNC(PKG, ERR, herr_t, SUCCEED, FAIL,
         if (H5F_addr_defined(sblock->dblk_addrs[u])) {
             /* Delete data block */
             if (H5EA__dblock_delete(hdr, sblock, sblock->dblk_addrs[u], sblock->dblk_nelmts) < 0)
-                H5E_THROW(H5E_CANTDELETE, "unable to delete extensible array data block")
+                HGOTO_ERROR(H5E_EARRAY, H5E_CANTDELETE, FAIL, "unable to delete extensible array data block")
             sblock->dblk_addrs[u] = HADDR_UNDEF;
         } /* end if */
     }     /* end for */
 
-    CATCH
+done:
     /* Finished deleting super block in metadata cache */
     if (sblock && H5EA__sblock_unprotect(sblock, H5AC__DIRTIED_FLAG | H5AC__DELETED_FLAG |
                                                      H5AC__FREE_FILE_SPACE_FLAG) < 0)
-        H5E_THROW(H5E_CANTUNPROTECT, "unable to release extensible array super block")
+        HDONE_ERROR(H5E_EARRAY, H5E_CANTUNPROTECT, FAIL, "unable to release extensible array super block")
 
-END_FUNC(PKG) /* end H5EA__sblock_delete() */
+    FUNC_LEAVE_NOAPI(ret_value)
+} /* end H5EA__sblock_delete() */
 
 /*-------------------------------------------------------------------------
  * Function:	H5EA__sblock_dest
@@ -393,7 +421,12 @@ END_FUNC(PKG) /* end H5EA__sblock_delete() */
  *
  *-------------------------------------------------------------------------
  */
-BEGIN_FUNC(PKG, ERR, herr_t, SUCCEED, FAIL, H5EA__sblock_dest(H5EA_sblock_t *sblock))
+herr_t
+H5EA__sblock_dest(H5EA_sblock_t *sblock)
+{
+    herr_t ret_value = SUCCEED;
+
+    FUNC_ENTER_PACKAGE
 
     /* Sanity check */
     HDassert(sblock);
@@ -413,7 +446,8 @@ BEGIN_FUNC(PKG, ERR, herr_t, SUCCEED, FAIL, H5EA__sblock_dest(H5EA_sblock_t *sbl
 
         /* Decrement reference count on shared info */
         if (H5EA__hdr_decr(sblock->hdr) < 0)
-            H5E_THROW(H5E_CANTDEC, "can't decrement reference count on shared array header")
+            HGOTO_ERROR(H5E_EARRAY, H5E_CANTDEC, FAIL,
+                        "can't decrement reference count on shared array header")
         sblock->hdr = NULL;
     } /* end if */
 
@@ -423,6 +457,6 @@ BEGIN_FUNC(PKG, ERR, herr_t, SUCCEED, FAIL, H5EA__sblock_dest(H5EA_sblock_t *sbl
     /* Free the super block itself */
     sblock = H5FL_FREE(H5EA_sblock_t, sblock);
 
-    CATCH
-
-END_FUNC(PKG) /* end H5EA__sblock_dest() */
+done:
+    FUNC_LEAVE_NOAPI(ret_value)
+} /* end H5EA__sblock_dest() */