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, 92 insertions, 63 deletions

diff --git a/src/H5FAdblock.c b/src/H5FAdblock.c
index 21e2e03..1ccc97d 100644
--- a/src/H5FAdblock.c
+++ b/src/H5FAdblock.c
@@ -88,10 +88,13 @@ H5FL_BLK_DEFINE(fa_page_init);
  *
  *-------------------------------------------------------------------------
  */
-BEGIN_FUNC(PKG, ERR, H5FA_dblock_t *, NULL, NULL, H5FA__dblock_alloc(H5FA_hdr_t *hdr))
+H5FA_dblock_t *
+H5FA__dblock_alloc(H5FA_hdr_t *hdr)
+{
+    H5FA_dblock_t *dblock    = NULL; /* fixed array data block */
+    H5FA_dblock_t *ret_value = NULL;
 
-    /* Local variables */
-    H5FA_dblock_t *dblock = NULL; /* fixed array data block */
+    FUNC_ENTER_PACKAGE
 
     /* Check arguments */
     HDassert(hdr);
@@ -99,11 +102,11 @@ BEGIN_FUNC(PKG, ERR, H5FA_dblock_t *, NULL, NULL, H5FA__dblock_alloc(H5FA_hdr_t
 
     /* Allocate memory for the data block */
     if (NULL == (dblock = H5FL_CALLOC(H5FA_dblock_t)))
-        H5E_THROW(H5E_CANTALLOC, "memory allocation failed for fixed array data block")
+        HGOTO_ERROR(H5E_FARRAY, H5E_CANTALLOC, NULL, "memory allocation failed for fixed array data block")
 
     /* Share common array information */
     if (H5FA__hdr_incr(hdr) < 0)
-        H5E_THROW(H5E_CANTINC, "can't increment reference count on shared array header")
+        HGOTO_ERROR(H5E_FARRAY, H5E_CANTINC, NULL, "can't increment reference count on shared array header")
     dblock->hdr = hdr;
 
     /* Set non-zero internal fields */
@@ -126,7 +129,7 @@ BEGIN_FUNC(PKG, ERR, H5FA_dblock_t *, NULL, NULL, H5FA__dblock_alloc(H5FA_hdr_t
 
         /* Allocate space for 'page init' flags */
         if (NULL == (dblock->dblk_page_init = H5FL_BLK_CALLOC(fa_page_init, dblock->dblk_page_init_size)))
-            H5E_THROW(H5E_CANTALLOC, "memory allocation failed for page init bitmask")
+            HGOTO_ERROR(H5E_FARRAY, H5E_CANTALLOC, NULL, "memory allocation failed for page init bitmask")
 
         /* Compute data block page size */
         dblock->dblk_page_size = (dblock->dblk_page_nelmts * hdr->cparam.raw_elmt_size) + H5FA_SIZEOF_CHKSUM;
@@ -143,19 +146,20 @@ BEGIN_FUNC(PKG, ERR, H5FA_dblock_t *, NULL, NULL, H5FA__dblock_alloc(H5FA_hdr_t
         /* Allocate buffer for elements in data block */
         H5_CHECK_OVERFLOW(dblk_size, /* From: */ hsize_t, /* To: */ size_t);
         if (NULL == (dblock->elmts = H5FL_BLK_MALLOC(chunk_elmts, (size_t)dblk_size)))
-            H5E_THROW(H5E_CANTALLOC, "memory allocation failed for data block element buffer")
+            HGOTO_ERROR(H5E_FARRAY, H5E_CANTALLOC, NULL,
+                        "memory allocation failed for data block element buffer")
     } /* end else */
 
     /* Set the return value */
     ret_value = dblock;
 
-    CATCH
-
+done:
     if (!ret_value)
         if (dblock && H5FA__dblock_dest(dblock) < 0)
-            H5E_THROW(H5E_CANTFREE, "unable to destroy fixed array data block")
+            HDONE_ERROR(H5E_FARRAY, H5E_CANTFREE, NULL, "unable to destroy fixed array data block")
 
-END_FUNC(PKG) /* end H5FA__dblock_alloc() */
+    FUNC_LEAVE_NOAPI(ret_value)
+} /* end H5FA__dblock_alloc() */
 
 /*-------------------------------------------------------------------------
  * Function:    H5FA__dblock_create
@@ -169,13 +173,15 @@ END_FUNC(PKG) /* end H5FA__dblock_alloc() */
  *
  *-------------------------------------------------------------------------
  */
-BEGIN_FUNC(PKG, ERR, haddr_t, HADDR_UNDEF, HADDR_UNDEF,
-           H5FA__dblock_create(H5FA_hdr_t *hdr, hbool_t *hdr_dirty))
+haddr_t
+H5FA__dblock_create(H5FA_hdr_t *hdr, hbool_t *hdr_dirty)
+{
+    H5FA_dblock_t *dblock = NULL;     /* Fixed array data block */
+    haddr_t        dblock_addr;       /* Fixed array data block address */
+    hbool_t        inserted  = FALSE; /* Whether the header was inserted into cache */
+    haddr_t        ret_value = HADDR_UNDEF;
 
-    /* Local variables */
-    H5FA_dblock_t *dblock = NULL;    /* Fixed array data block */
-    haddr_t        dblock_addr;      /* Fixed array data block address */
-    hbool_t        inserted = FALSE; /* Whether the header was inserted into cache */
+    FUNC_ENTER_PACKAGE
 
     /* Sanity check */
     HDassert(hdr);
@@ -183,31 +189,35 @@ BEGIN_FUNC(PKG, ERR, haddr_t, HADDR_UNDEF, HADDR_UNDEF,
 
     /* Allocate the data block */
     if (NULL == (dblock = H5FA__dblock_alloc(hdr)))
-        H5E_THROW(H5E_CANTALLOC, "memory allocation failed for fixed array data block")
+        HGOTO_ERROR(H5E_FARRAY, H5E_CANTALLOC, HADDR_UNDEF,
+                    "memory allocation failed for fixed array data block")
 
     /* Set size of data block on disk */
     hdr->stats.dblk_size = dblock->size = H5FA_DBLOCK_SIZE(dblock);
 
     /* Allocate space for the data block on disk */
     if (HADDR_UNDEF == (dblock_addr = H5MF_alloc(hdr->f, H5FD_MEM_FARRAY_DBLOCK, (hsize_t)dblock->size)))
-        H5E_THROW(H5E_CANTALLOC, "file allocation failed for fixed array data block")
+        HGOTO_ERROR(H5E_FARRAY, H5E_CANTALLOC, HADDR_UNDEF,
+                    "file allocation failed for fixed array data block")
     dblock->addr = dblock_addr;
 
     /* Don't initialize elements if paged */
     if (!dblock->npages)
         /* Clear any elements in data block to fill value */
         if ((hdr->cparam.cls->fill)(dblock->elmts, (size_t)hdr->cparam.nelmts) < 0)
-            H5E_THROW(H5E_CANTSET, "can't set fixed array data block elements to class's fill value")
+            HGOTO_ERROR(H5E_FARRAY, H5E_CANTSET, HADDR_UNDEF,
+                        "can't set fixed array data block elements to class's fill value")
 
     /* Cache the new fixed array data block */
     if (H5AC_insert_entry(hdr->f, H5AC_FARRAY_DBLOCK, dblock_addr, dblock, H5AC__NO_FLAGS_SET) < 0)
-        H5E_THROW(H5E_CANTINSERT, "can't add fixed array data block to cache")
+        HGOTO_ERROR(H5E_FARRAY, H5E_CANTINSERT, HADDR_UNDEF, "can't add fixed array data block to cache")
     inserted = TRUE;
 
     /* Add data block as child of 'top' proxy */
     if (hdr->top_proxy) {
         if (H5AC_proxy_entry_add_child(hdr->top_proxy, hdr->f, dblock) < 0)
-            H5E_THROW(H5E_CANTSET, "unable to add fixed array entry as child of array proxy")
+            HGOTO_ERROR(H5E_FARRAY, H5E_CANTSET, HADDR_UNDEF,
+                        "unable to add fixed array entry as child of array proxy")
         dblock->top_proxy = hdr->top_proxy;
     } /* end if */
 
@@ -217,26 +227,28 @@ BEGIN_FUNC(PKG, ERR, haddr_t, HADDR_UNDEF, HADDR_UNDEF,
     /* Set address of data block to return */
     ret_value = dblock_addr;
 
-    CATCH
+done:
 
     if (!H5F_addr_defined(ret_value))
         if (dblock) {
             /* Remove from cache, if inserted */
             if (inserted)
                 if (H5AC_remove_entry(dblock) < 0)
-                    H5E_THROW(H5E_CANTREMOVE, "unable to remove fixed array data block from cache")
+                    HDONE_ERROR(H5E_FARRAY, H5E_CANTREMOVE, HADDR_UNDEF,
+                                "unable to remove fixed array data block from cache")
 
             /* Release data block's disk space */
             if (H5F_addr_defined(dblock->addr) &&
                 H5MF_xfree(hdr->f, H5FD_MEM_FARRAY_DBLOCK, dblock->addr, (hsize_t)dblock->size) < 0)
-                H5E_THROW(H5E_CANTFREE, "unable to release fixed array data block")
+                HDONE_ERROR(H5E_FARRAY, H5E_CANTFREE, HADDR_UNDEF, "unable to release fixed array data block")
 
             /* Destroy data block */
             if (H5FA__dblock_dest(dblock) < 0)
-                H5E_THROW(H5E_CANTFREE, "unable to destroy fixed array data block")
+                HDONE_ERROR(H5E_FARRAY, H5E_CANTFREE, HADDR_UNDEF, "unable to destroy fixed array data block")
         } /* end if */
 
-END_FUNC(PKG) /* end H5FA__dblock_create() */
+    FUNC_LEAVE_NOAPI(ret_value)
+} /* end H5FA__dblock_create() */
 
 /*-------------------------------------------------------------------------
  * Function:    H5FA__dblock_protect
@@ -250,12 +262,14 @@ END_FUNC(PKG) /* end H5FA__dblock_create() */
  *
  *-------------------------------------------------------------------------
  */
-BEGIN_FUNC(PKG, ERR, H5FA_dblock_t *, NULL, NULL,
-           H5FA__dblock_protect(H5FA_hdr_t *hdr, haddr_t dblk_addr, unsigned flags))
+H5FA_dblock_t *
+H5FA__dblock_protect(H5FA_hdr_t *hdr, haddr_t dblk_addr, unsigned flags)
+{
+    H5FA_dblock_t *        dblock = NULL; /* Fixed array data block */
+    H5FA_dblock_cache_ud_t udata;         /* Information needed for loading data block */
+    H5FA_dblock_t *        ret_value = NULL;
 
-    /* Local variables */
-    H5FA_dblock_t *        dblock; /* Fixed array data block */
-    H5FA_dblock_cache_ud_t udata;  /* Information needed for loading data block */
+    FUNC_ENTER_PACKAGE
 
     /* Sanity check */
     HDassert(hdr);
@@ -271,31 +285,33 @@ BEGIN_FUNC(PKG, ERR, H5FA_dblock_t *, NULL, NULL,
     /* Protect the data block */
     if (NULL ==
         (dblock = (H5FA_dblock_t *)H5AC_protect(hdr->f, H5AC_FARRAY_DBLOCK, dblk_addr, &udata, flags)))
-        H5E_THROW(H5E_CANTPROTECT, "unable to protect fixed array data block, address = %llu",
-                  (unsigned long long)dblk_addr)
+        HGOTO_ERROR(H5E_FARRAY, H5E_CANTPROTECT, NULL,
+                    "unable to protect fixed array data block, address = %llu", (unsigned long long)dblk_addr)
 
     /* Create top proxy, if it doesn't exist */
     if (hdr->top_proxy && NULL == dblock->top_proxy) {
         /* Add data block as child of 'top' proxy */
         if (H5AC_proxy_entry_add_child(hdr->top_proxy, hdr->f, dblock) < 0)
-            H5E_THROW(H5E_CANTSET, "unable to add fixed array entry as child of array proxy")
+            HGOTO_ERROR(H5E_FARRAY, H5E_CANTSET, NULL,
+                        "unable to add fixed array entry as child of array proxy")
         dblock->top_proxy = hdr->top_proxy;
     } /* end if */
 
     /* Set return value */
     ret_value = dblock;
 
-    CATCH
-
+done:
     /* Clean up on error */
     if (!ret_value)
         /* Release the data block, if it was protected */
         if (dblock &&
             H5AC_unprotect(hdr->f, H5AC_FARRAY_DBLOCK, dblock->addr, dblock, H5AC__NO_FLAGS_SET) < 0)
-            H5E_THROW(H5E_CANTUNPROTECT, "unable to unprotect fixed array data block, address = %llu",
-                      (unsigned long long)dblock->addr)
+            HDONE_ERROR(H5E_FARRAY, H5E_CANTUNPROTECT, NULL,
+                        "unable to unprotect fixed array data block, address = %llu",
+                        (unsigned long long)dblock->addr)
 
-END_FUNC(PKG) /* end H5FA__dblock_protect() */
+    FUNC_LEAVE_NOAPI(ret_value)
+} /* end H5FA__dblock_protect() */
 
 /*-------------------------------------------------------------------------
  * Function:    H5FA__dblock_unprotect
@@ -309,22 +325,25 @@ END_FUNC(PKG) /* end H5FA__dblock_protect() */
  *
  *-------------------------------------------------------------------------
  */
-BEGIN_FUNC(PKG, ERR, herr_t, SUCCEED, FAIL,
-           H5FA__dblock_unprotect(H5FA_dblock_t *dblock, unsigned cache_flags))
+herr_t
+H5FA__dblock_unprotect(H5FA_dblock_t *dblock, unsigned cache_flags)
+{
+    herr_t ret_value = SUCCEED;
 
-    /* Local variables */
+    FUNC_ENTER_PACKAGE
 
     /* Sanity check */
     HDassert(dblock);
 
     /* Unprotect the data block */
     if (H5AC_unprotect(dblock->hdr->f, H5AC_FARRAY_DBLOCK, dblock->addr, dblock, cache_flags) < 0)
-        H5E_THROW(H5E_CANTUNPROTECT, "unable to unprotect fixed array data block, address = %llu",
-                  (unsigned long long)dblock->addr)
-
-    CATCH
+        HGOTO_ERROR(H5E_FARRAY, H5E_CANTUNPROTECT, FAIL,
+                    "unable to unprotect fixed array data block, address = %llu",
+                    (unsigned long long)dblock->addr)
 
-END_FUNC(PKG) /* end H5FA__dblock_unprotect() */
+done:
+    FUNC_LEAVE_NOAPI(ret_value)
+} /* end H5FA__dblock_unprotect() */
 
 /*-------------------------------------------------------------------------
  * Function:    H5FA__dblock_delete
@@ -338,10 +357,13 @@ END_FUNC(PKG) /* end H5FA__dblock_unprotect() */
  *
  *-------------------------------------------------------------------------
  */
-BEGIN_FUNC(PKG, ERR, herr_t, SUCCEED, FAIL, H5FA__dblock_delete(H5FA_hdr_t *hdr, haddr_t dblk_addr))
+herr_t
+H5FA__dblock_delete(H5FA_hdr_t *hdr, haddr_t dblk_addr)
+{
+    H5FA_dblock_t *dblock    = NULL; /* Pointer to data block */
+    herr_t         ret_value = SUCCEED;
 
-    /* Local variables */
-    H5FA_dblock_t *dblock = NULL; /* Pointer to data block */
+    FUNC_ENTER_PACKAGE
 
     /* Sanity check */
     HDassert(hdr);
@@ -349,8 +371,8 @@ BEGIN_FUNC(PKG, ERR, herr_t, SUCCEED, FAIL, H5FA__dblock_delete(H5FA_hdr_t *hdr,
 
     /* Protect data block */
     if (NULL == (dblock = H5FA__dblock_protect(hdr, dblk_addr, H5AC__NO_FLAGS_SET)))
-        H5E_THROW(H5E_CANTPROTECT, "unable to protect fixed array data block, address = %llu",
-                  (unsigned long long)dblk_addr)
+        HGOTO_ERROR(H5E_FARRAY, H5E_CANTPROTECT, FAIL,
+                    "unable to protect fixed array data block, address = %llu", (unsigned long long)dblk_addr)
 
     /* Check if data block is paged */
     if (dblock->npages) {
@@ -365,21 +387,22 @@ BEGIN_FUNC(PKG, ERR, herr_t, SUCCEED, FAIL, H5FA__dblock_delete(H5FA_hdr_t *hdr,
             /* Evict the data block page from the metadata cache */
             /* (OK to call if it doesn't exist in the cache) */
             if (H5AC_expunge_entry(hdr->f, H5AC_FARRAY_DBLK_PAGE, dblk_page_addr, H5AC__NO_FLAGS_SET) < 0)
-                H5E_THROW(H5E_CANTEXPUNGE, "unable to remove array data block page from metadata cache")
+                HGOTO_ERROR(H5E_FARRAY, H5E_CANTEXPUNGE, FAIL,
+                            "unable to remove array data block page from metadata cache")
 
             /* Advance to next page address */
             dblk_page_addr += dblock->dblk_page_size;
         } /* end for */
     }     /* end if */
 
-    CATCH
-
+done:
     /* Finished deleting data block in metadata cache */
     if (dblock && H5FA__dblock_unprotect(dblock, H5AC__DIRTIED_FLAG | H5AC__DELETED_FLAG |
                                                      H5AC__FREE_FILE_SPACE_FLAG) < 0)
-        H5E_THROW(H5E_CANTUNPROTECT, "unable to release fixed array data block")
+        HDONE_ERROR(H5E_FARRAY, H5E_CANTUNPROTECT, FAIL, "unable to release fixed array data block")
 
-END_FUNC(PKG) /* end H5FA__dblock_delete() */
+    FUNC_LEAVE_NOAPI(ret_value)
+} /* end H5FA__dblock_delete() */
 
 /*-------------------------------------------------------------------------
  * Function:    H5FA__dblock_dest
@@ -393,7 +416,12 @@ END_FUNC(PKG) /* end H5FA__dblock_delete() */
  *
  *-------------------------------------------------------------------------
  */
-BEGIN_FUNC(PKG, ERR, herr_t, SUCCEED, FAIL, H5FA__dblock_dest(H5FA_dblock_t *dblock))
+herr_t
+H5FA__dblock_dest(H5FA_dblock_t *dblock)
+{
+    herr_t ret_value = SUCCEED;
+
+    FUNC_ENTER_PACKAGE
 
     /* Sanity check */
     HDassert(dblock);
@@ -417,7 +445,8 @@ BEGIN_FUNC(PKG, ERR, herr_t, SUCCEED, FAIL, H5FA__dblock_dest(H5FA_dblock_t *dbl
 
         /* Decrement reference count on shared info */
         if (H5FA__hdr_decr(dblock->hdr) < 0)
-            H5E_THROW(H5E_CANTDEC, "can't decrement reference count on shared array header")
+            HGOTO_ERROR(H5E_FARRAY, H5E_CANTDEC, FAIL,
+                        "can't decrement reference count on shared array header")
         dblock->hdr = NULL;
     } /* end if */
 
@@ -427,6 +456,6 @@ BEGIN_FUNC(PKG, ERR, herr_t, SUCCEED, FAIL, H5FA__dblock_dest(H5FA_dblock_t *dbl
     /* Free the data block itself */
     dblock = H5FL_FREE(H5FA_dblock_t, dblock);
 
-    CATCH
-
-END_FUNC(PKG) /* end H5FA__dblock_dest() */
+done:
+    FUNC_LEAVE_NOAPI(ret_value)
+} /* end H5FA__dblock_dest() */