summaryrefslogtreecommitdiffstats
path: root/src/H5EA.c
diff options
context:
space:
mode:
authorAllen Byrne <byrn@hdfgroup.org>2020-09-30 14:27:10 (GMT)
committerAllen Byrne <byrn@hdfgroup.org>2020-09-30 14:27:10 (GMT)
commitb2d661b508a7fc7a2592c13bc6bdc175551f075d (patch)
tree13baeb0d83a7c2a4c6299993c182b1227c2f6114 /src/H5EA.c
parent29ab58b58dce556639ea3154e262895773a8a8df (diff)
downloadhdf5-b2d661b508a7fc7a2592c13bc6bdc175551f075d.zip
hdf5-b2d661b508a7fc7a2592c13bc6bdc175551f075d.tar.gz
hdf5-b2d661b508a7fc7a2592c13bc6bdc175551f075d.tar.bz2
Clang-format of source files
Diffstat (limited to 'src/H5EA.c')
-rw-r--r--src/H5EA.c1327
1 files changed, 654 insertions, 673 deletions
diff --git a/src/H5EA.c b/src/H5EA.c
index bf50452..f246686 100644
--- a/src/H5EA.c
+++ b/src/H5EA.c
@@ -31,30 +31,26 @@
/* Module Declaration */
/**********************/
-#include "H5EAmodule.h" /* This source code file is part of the H5EA module */
-
+#include "H5EAmodule.h" /* This source code file is part of the H5EA module */
/***********************/
/* Other Packages Used */
/***********************/
-
/***********/
/* Headers */
/***********/
-#include "H5private.h" /* Generic Functions */
-#include "H5Eprivate.h" /* Error handling */
-#include "H5EApkg.h" /* Extensible Arrays */
-#include "H5FLprivate.h" /* Free Lists */
-#include "H5MMprivate.h" /* Memory management */
-#include "H5VMprivate.h" /* Vector functions */
-
+#include "H5private.h" /* Generic Functions */
+#include "H5Eprivate.h" /* Error handling */
+#include "H5EApkg.h" /* Extensible Arrays */
+#include "H5FLprivate.h" /* Free Lists */
+#include "H5MMprivate.h" /* Memory management */
+#include "H5VMprivate.h" /* Vector functions */
/****************/
/* Local Macros */
/****************/
-
/******************/
/* Local Typedefs */
/******************/
@@ -62,23 +58,18 @@
/* Typedef for generically unprotecting an object */
typedef herr_t (*H5EA__unprotect_func_t)(void *thing, unsigned cache_flags);
-
/********************/
/* Package Typedefs */
/********************/
-
/********************/
/* Local Prototypes */
/********************/
-static herr_t
-H5EA__lookup_elmt(const H5EA_t *ea, hsize_t idx, hbool_t will_extend,
- unsigned thing_acc, void **thing, uint8_t **thing_elmt_buf,
- hsize_t *thing_elmt_idx, H5EA__unprotect_func_t *thing_unprot_func);
-static H5EA_t *H5EA__new(H5F_t *f, haddr_t ea_addr, hbool_t from_open,
- void *ctx_udata);
-
+static herr_t H5EA__lookup_elmt(const H5EA_t *ea, hsize_t idx, hbool_t will_extend, unsigned thing_acc,
+ void **thing, uint8_t **thing_elmt_buf, hsize_t *thing_elmt_idx,
+ H5EA__unprotect_func_t *thing_unprot_func);
+static H5EA_t *H5EA__new(H5F_t *f, haddr_t ea_addr, hbool_t from_open, void *ctx_udata);
/*********************/
/* Package Variables */
@@ -93,17 +84,15 @@ hbool_t H5_PKG_INIT_VAR = FALSE;
* client class..
*/
const H5EA_class_t *const H5EA_client_class_g[] = {
- H5EA_CLS_CHUNK, /* 0 - H5EA_CLS_CHUNK_ID */
- H5EA_CLS_FILT_CHUNK, /* 1 - H5EA_CLS_FILT_CHUNK_ID */
- H5EA_CLS_TEST, /* ? - H5EA_CLS_TEST_ID */
+ H5EA_CLS_CHUNK, /* 0 - H5EA_CLS_CHUNK_ID */
+ H5EA_CLS_FILT_CHUNK, /* 1 - H5EA_CLS_FILT_CHUNK_ID */
+ H5EA_CLS_TEST, /* ? - H5EA_CLS_TEST_ID */
};
-
/*****************************/
/* Library Private Variables */
/*****************************/
-
/*******************/
/* Local Variables */
/*******************/
@@ -114,7 +103,6 @@ H5FL_DEFINE_STATIC(H5EA_t);
/* Declare a PQ free list to manage the element */
H5FL_BLK_DEFINE(ea_native_elmt);
-
/*-------------------------------------------------------------------------
* Function: H5EA__new
*
@@ -128,58 +116,56 @@ H5FL_BLK_DEFINE(ea_native_elmt);
*
*-------------------------------------------------------------------------
*/
-BEGIN_FUNC(STATIC, ERR,
-H5EA_t *, NULL, NULL,
-H5EA__new(H5F_t *f, haddr_t ea_addr, hbool_t from_open, void *ctx_udata))
+BEGIN_FUNC(STATIC, ERR, H5EA_t *, NULL, NULL,
+ H5EA__new(H5F_t *f, haddr_t ea_addr, hbool_t from_open, void *ctx_udata))
- /* Local variables */
- H5EA_t *ea = NULL; /* Pointer to new extensible array */
- H5EA_hdr_t *hdr = NULL; /* The extensible array header information */
+/* Local variables */
+H5EA_t * ea = NULL; /* Pointer to new extensible array */
+H5EA_hdr_t *hdr = NULL; /* The extensible array header information */
- /*
- * Check arguments.
- */
- HDassert(f);
- HDassert(H5F_addr_defined(ea_addr));
+/*
+ * Check arguments.
+ */
+HDassert(f);
+HDassert(H5F_addr_defined(ea_addr));
- /* Allocate extensible array wrapper */
- if(NULL == (ea = H5FL_CALLOC(H5EA_t)))
- H5E_THROW(H5E_CANTALLOC, "memory allocation failed for extensible array info")
+/* Allocate extensible array wrapper */
+if (NULL == (ea = H5FL_CALLOC(H5EA_t)))
+ H5E_THROW(H5E_CANTALLOC, "memory allocation failed for extensible array info")
- /* Lock the array header into memory */
- if(NULL == (hdr = H5EA__hdr_protect(f, ea_addr, ctx_udata, H5AC__READ_ONLY_FLAG)))
- H5E_THROW(H5E_CANTPROTECT, "unable to load extensible array header")
+/* Lock the array header into memory */
+if (NULL == (hdr = H5EA__hdr_protect(f, ea_addr, ctx_udata, H5AC__READ_ONLY_FLAG)))
+ H5E_THROW(H5E_CANTPROTECT, "unable to load extensible array header")
- /* Check for pending array deletion */
- if(from_open && hdr->pending_delete)
- H5E_THROW(H5E_CANTOPENOBJ, "can't open extensible array pending deletion")
+/* Check for pending array deletion */
+if (from_open && hdr->pending_delete)
+ H5E_THROW(H5E_CANTOPENOBJ, "can't open extensible array pending deletion")
- /* Point extensible array wrapper at header and bump it's ref count */
- ea->hdr = hdr;
- if(H5EA__hdr_incr(ea->hdr) < 0)
- H5E_THROW(H5E_CANTINC, "can't increment reference count on shared array header")
+/* Point extensible array wrapper at header and bump it's ref count */
+ea->hdr = hdr;
+if (H5EA__hdr_incr(ea->hdr) < 0)
+ H5E_THROW(H5E_CANTINC, "can't increment reference count on shared array header")
- /* Increment # of files using this array header */
- if(H5EA__hdr_fuse_incr(ea->hdr) < 0)
- H5E_THROW(H5E_CANTINC, "can't increment file reference count on shared array header")
+/* Increment # of files using this array header */
+if (H5EA__hdr_fuse_incr(ea->hdr) < 0)
+ H5E_THROW(H5E_CANTINC, "can't increment file reference count on shared array header")
- /* Set file pointer for this array open context */
- ea->f = f;
+/* Set file pointer for this array open context */
+ea->f = f;
- /* Set the return value */
- ret_value = ea;
+/* Set the return value */
+ret_value = ea;
CATCH
- if(hdr && H5EA__hdr_unprotect(hdr, H5AC__NO_FLAGS_SET) < 0)
- H5E_THROW(H5E_CANTUNPROTECT, "unable to release extensible array header")
- if(!ret_value)
- if(ea && H5EA_close(ea) < 0)
- H5E_THROW(H5E_CLOSEERROR, "unable to close extensible array")
+if (hdr && H5EA__hdr_unprotect(hdr, H5AC__NO_FLAGS_SET) < 0)
+ H5E_THROW(H5E_CANTUNPROTECT, "unable to release extensible array header")
+if (!ret_value)
+ if (ea && H5EA_close(ea) < 0)
+ H5E_THROW(H5E_CLOSEERROR, "unable to close extensible array")
-END_FUNC(STATIC) /* end H5EA__new() */
+END_FUNC(STATIC) /* end H5EA__new() */
-
/*-------------------------------------------------------------------------
* Function: H5EA_create
*
@@ -193,43 +179,41 @@ END_FUNC(STATIC) /* end H5EA__new() */
*
*-------------------------------------------------------------------------
*/
-BEGIN_FUNC(PRIV, ERR,
-H5EA_t *, NULL, NULL,
-H5EA_create(H5F_t *f, const H5EA_create_t *cparam, void *ctx_udata))
+BEGIN_FUNC(PRIV, ERR, H5EA_t *, NULL, NULL,
+ H5EA_create(H5F_t *f, const H5EA_create_t *cparam, void *ctx_udata))
- /* Local variables */
- H5EA_t *ea = NULL; /* Pointer to new extensible array */
- haddr_t ea_addr; /* Array header address */
+/* Local variables */
+H5EA_t *ea = NULL; /* Pointer to new extensible array */
+haddr_t ea_addr; /* Array header address */
- /*
- * Check arguments.
- */
- HDassert(f);
- HDassert(cparam);
+/*
+ * Check arguments.
+ */
+HDassert(f);
+HDassert(cparam);
- /* H5EA interface sanity check */
- HDcompile_assert(H5EA_NUM_CLS_ID == NELMTS(H5EA_client_class_g));
+/* H5EA interface sanity check */
+HDcompile_assert(H5EA_NUM_CLS_ID == NELMTS(H5EA_client_class_g));
- /* Create extensible array header */
- if(HADDR_UNDEF == (ea_addr = H5EA__hdr_create(f, cparam, ctx_udata)))
- H5E_THROW(H5E_CANTINIT, "can't create extensible array header")
+/* Create extensible array header */
+if (HADDR_UNDEF == (ea_addr = H5EA__hdr_create(f, cparam, ctx_udata)))
+ H5E_THROW(H5E_CANTINIT, "can't create extensible array header")
- /* Allocate and initialize new extensible array wrapper */
- if(NULL == (ea = H5EA__new(f, ea_addr, FALSE, ctx_udata)))
- H5E_THROW(H5E_CANTINIT, "allocation and/or initialization failed for extensible array wrapper")
+/* Allocate and initialize new extensible array wrapper */
+if (NULL == (ea = H5EA__new(f, ea_addr, FALSE, ctx_udata)))
+ H5E_THROW(H5E_CANTINIT, "allocation and/or initialization failed for extensible array wrapper")
- /* Set the return value */
- ret_value = ea;
+/* Set the return value */
+ret_value = ea;
CATCH
- if(!ret_value)
- if(ea && H5EA_close(ea) < 0)
- H5E_THROW(H5E_CLOSEERROR, "unable to close extensible array")
+if (!ret_value)
+ if (ea && H5EA_close(ea) < 0)
+ H5E_THROW(H5E_CLOSEERROR, "unable to close extensible array")
-END_FUNC(PRIV) /* end H5EA_create() */
+END_FUNC(PRIV) /* end H5EA_create() */
-
/*-------------------------------------------------------------------------
* Function: H5EA_open
*
@@ -243,35 +227,32 @@ END_FUNC(PRIV) /* end H5EA_create() */
*
*-------------------------------------------------------------------------
*/
-BEGIN_FUNC(PRIV, ERR,
-H5EA_t *, NULL, NULL,
-H5EA_open(H5F_t *f, haddr_t ea_addr, void *ctx_udata))
+BEGIN_FUNC(PRIV, ERR, H5EA_t *, NULL, NULL, H5EA_open(H5F_t *f, haddr_t ea_addr, void *ctx_udata))
- /* Local variables */
- H5EA_t *ea = NULL; /* Pointer to new extensible array wrapper */
+/* Local variables */
+H5EA_t *ea = NULL; /* Pointer to new extensible array wrapper */
- /*
- * Check arguments.
- */
- HDassert(f);
- HDassert(H5F_addr_defined(ea_addr));
+/*
+ * Check arguments.
+ */
+HDassert(f);
+HDassert(H5F_addr_defined(ea_addr));
- /* Allocate and initialize new extensible array wrapper */
- if(NULL == (ea = H5EA__new(f, ea_addr, TRUE, ctx_udata)))
- H5E_THROW(H5E_CANTINIT, "allocation and/or initialization failed for extensible array wrapper")
+/* Allocate and initialize new extensible array wrapper */
+if (NULL == (ea = H5EA__new(f, ea_addr, TRUE, ctx_udata)))
+ H5E_THROW(H5E_CANTINIT, "allocation and/or initialization failed for extensible array wrapper")
- /* Set the return value */
- ret_value = ea;
+/* Set the return value */
+ret_value = ea;
CATCH
- if(!ret_value)
- if(ea && H5EA_close(ea) < 0)
- H5E_THROW(H5E_CLOSEERROR, "unable to close extensible array")
+if (!ret_value)
+ if (ea && H5EA_close(ea) < 0)
+ H5E_THROW(H5E_CLOSEERROR, "unable to close extensible array")
-END_FUNC(PRIV) /* end H5EA_open() */
+END_FUNC(PRIV) /* end H5EA_open() */
-
/*-------------------------------------------------------------------------
* Function: H5EA_get_nelmts
*
@@ -284,24 +265,21 @@ END_FUNC(PRIV) /* end H5EA_open() */
*
*-------------------------------------------------------------------------
*/
-BEGIN_FUNC(PRIV, NOERR,
-herr_t, SUCCEED, -,
-H5EA_get_nelmts(const H5EA_t *ea, hsize_t *nelmts))
+BEGIN_FUNC(PRIV, NOERR, herr_t, SUCCEED, -, H5EA_get_nelmts(const H5EA_t *ea, hsize_t *nelmts))
- /* Local variables */
+/* Local variables */
- /*
- * Check arguments.
- */
- HDassert(ea);
- HDassert(nelmts);
+/*
+ * Check arguments.
+ */
+HDassert(ea);
+HDassert(nelmts);
- /* Retrieve the max. index set */
- *nelmts = ea->hdr->stats.stored.max_idx_set;
+/* Retrieve the max. index set */
+*nelmts = ea->hdr->stats.stored.max_idx_set;
-END_FUNC(PRIV) /* end H5EA_get_nelmts() */
+END_FUNC(PRIV) /* end H5EA_get_nelmts() */
-
/*-------------------------------------------------------------------------
* Function: H5EA_get_addr
*
@@ -314,25 +292,22 @@ END_FUNC(PRIV) /* end H5EA_get_nelmts() */
*
*-------------------------------------------------------------------------
*/
-BEGIN_FUNC(PRIV, NOERR,
-herr_t, SUCCEED, -,
-H5EA_get_addr(const H5EA_t *ea, haddr_t *addr))
+BEGIN_FUNC(PRIV, NOERR, herr_t, SUCCEED, -, H5EA_get_addr(const H5EA_t *ea, haddr_t *addr))
- /* Local variables */
+/* Local variables */
- /*
- * Check arguments.
- */
- HDassert(ea);
- HDassert(ea->hdr);
- HDassert(addr);
+/*
+ * Check arguments.
+ */
+HDassert(ea);
+HDassert(ea->hdr);
+HDassert(addr);
- /* Retrieve the address of the extensible array's header */
- *addr = ea->hdr->addr;
+/* Retrieve the address of the extensible array's header */
+*addr = ea->hdr->addr;
-END_FUNC(PRIV) /* end H5EA_get_addr() */
+END_FUNC(PRIV) /* end H5EA_get_addr() */
-
/*-------------------------------------------------------------------------
* Function: H5EA__lookup_elmt
*
@@ -346,302 +321,322 @@ END_FUNC(PRIV) /* end H5EA_get_addr() */
*
*-------------------------------------------------------------------------
*/
-BEGIN_FUNC(STATIC, ERR,
-herr_t, SUCCEED, FAIL,
-H5EA__lookup_elmt(const H5EA_t *ea, hsize_t idx, hbool_t will_extend,
- unsigned thing_acc, void **thing, uint8_t **thing_elmt_buf,
- hsize_t *thing_elmt_idx, H5EA__unprotect_func_t *thing_unprot_func))
-
- /* Local variables */
- H5EA_hdr_t *hdr = ea->hdr; /* Header for EA */
- H5EA_iblock_t *iblock = NULL; /* Pointer to index block for EA */
- H5EA_sblock_t *sblock = NULL; /* Pointer to super block for EA */
- H5EA_dblock_t *dblock = NULL; /* Pointer to data block for EA */
- H5EA_dblk_page_t *dblk_page = NULL; /* Pointer to data block page for EA */
- unsigned iblock_cache_flags = H5AC__NO_FLAGS_SET; /* Flags to unprotecting index block */
- unsigned sblock_cache_flags = H5AC__NO_FLAGS_SET; /* Flags to unprotecting super block */
- hbool_t stats_changed = FALSE; /* Whether array statistics changed */
- hbool_t hdr_dirty = FALSE; /* Whether the array header changed */
-
- /*
- * Check arguments.
- */
- HDassert(ea);
- HDassert(hdr);
- HDassert(thing);
- HDassert(thing_elmt_buf);
- HDassert(thing_unprot_func);
-
- /* only the H5AC__READ_ONLY_FLAG may be set in thing_acc */
- HDassert((thing_acc & (unsigned)(~H5AC__READ_ONLY_FLAG)) == 0);
-
- /* Set the shared array header's file context for this operation */
- hdr->f = ea->f;
-
- /* Reset the pointers to the 'thing' info */
- *thing = NULL;
- *thing_elmt_buf = NULL;
- *thing_elmt_idx = 0;
- *thing_unprot_func = (H5EA__unprotect_func_t)NULL;
+BEGIN_FUNC(STATIC, ERR, herr_t, SUCCEED, FAIL,
+ H5EA__lookup_elmt(const H5EA_t *ea, hsize_t idx, hbool_t will_extend, unsigned thing_acc,
+ void **thing, uint8_t **thing_elmt_buf, hsize_t *thing_elmt_idx,
+ H5EA__unprotect_func_t *thing_unprot_func))
+
+/* Local variables */
+H5EA_hdr_t * hdr = ea->hdr; /* Header for EA */
+H5EA_iblock_t * iblock = NULL; /* Pointer to index block for EA */
+H5EA_sblock_t * sblock = NULL; /* Pointer to super block for EA */
+H5EA_dblock_t * dblock = NULL; /* Pointer to data block for EA */
+H5EA_dblk_page_t *dblk_page = NULL; /* Pointer to data block page for EA */
+unsigned iblock_cache_flags = H5AC__NO_FLAGS_SET; /* Flags to unprotecting index block */
+unsigned sblock_cache_flags = H5AC__NO_FLAGS_SET; /* Flags to unprotecting super block */
+hbool_t stats_changed = FALSE; /* Whether array statistics changed */
+hbool_t hdr_dirty = FALSE; /* Whether the array header changed */
+
+/*
+ * Check arguments.
+ */
+HDassert(ea);
+HDassert(hdr);
+HDassert(thing);
+HDassert(thing_elmt_buf);
+HDassert(thing_unprot_func);
+
+/* only the H5AC__READ_ONLY_FLAG may be set in thing_acc */
+HDassert((thing_acc & (unsigned)(~H5AC__READ_ONLY_FLAG)) == 0);
+
+/* Set the shared array header's file context for this operation */
+hdr->f = ea->f;
+
+/* Reset the pointers to the 'thing' info */
+*thing = NULL;
+*thing_elmt_buf = NULL;
+*thing_elmt_idx = 0;
+*thing_unprot_func = (H5EA__unprotect_func_t)NULL;
+
+/* Check if we should create the index block */
+if (!H5F_addr_defined(hdr->idx_blk_addr)) {
+ /* Check if we are allowed to create the thing */
+ if (0 == (thing_acc & H5AC__READ_ONLY_FLAG)) { /* i.e. r/w access */
+ /* Create the index block */
+ hdr->idx_blk_addr = H5EA__iblock_create(hdr, &stats_changed);
+ if (!H5F_addr_defined(hdr->idx_blk_addr))
+ H5E_THROW(H5E_CANTCREATE, "unable to create index block")
+ hdr_dirty = TRUE;
+ } /* end if */
+ else
+ H5_LEAVE(SUCCEED)
+} /* end if */
+
+/* Protect index block */
+if (NULL == (iblock = H5EA__iblock_protect(hdr, thing_acc)))
+ H5E_THROW(H5E_CANTPROTECT, "unable to protect extensible array index block, address = %llu",
+ (unsigned long long)hdr->idx_blk_addr)
+
+/* Check if element is in index block */
+if (idx < hdr->cparam.idx_blk_elmts) {
+ /* Set 'thing' info to refer to the index block */
+ *thing = iblock;
+ *thing_elmt_buf = (uint8_t *)iblock->elmts;
+ *thing_elmt_idx = idx;
+ *thing_unprot_func = (H5EA__unprotect_func_t)H5EA__iblock_unprotect;
+} /* end if */
+else {
+ unsigned sblk_idx; /* Which superblock does this index fall in? */
+ size_t dblk_idx; /* Data block index */
+ hsize_t elmt_idx; /* Offset of element in super block */
+
+ /* Get super block index where element is located */
+ sblk_idx = H5EA__dblock_sblk_idx(hdr, idx);
+
+ /* Adjust index to offset in super block */
+ elmt_idx = idx - (hdr->cparam.idx_blk_elmts + hdr->sblk_info[sblk_idx].start_idx);
+
+ /* Check for data block containing element address in the index block */
+ if (sblk_idx < iblock->nsblks) {
+ /* Compute the data block index in index block */
+ dblk_idx =
+ (size_t)(hdr->sblk_info[sblk_idx].start_dblk + (elmt_idx / hdr->sblk_info[sblk_idx].dblk_nelmts));
+ HDassert(dblk_idx < iblock->ndblk_addrs);
+
+ /* Check if the data block has been allocated on disk yet */
+ if (!H5F_addr_defined(iblock->dblk_addrs[dblk_idx])) {
+ /* Check if we are allowed to create the thing */
+ if (0 == (thing_acc & H5AC__READ_ONLY_FLAG)) { /* i.e. r/w access */
+ haddr_t dblk_addr; /* Address of data block created */
+ hsize_t dblk_off; /* Offset of data block in array */
+
+ /* Create data block */
+ dblk_off =
+ hdr->sblk_info[sblk_idx].start_idx + (dblk_idx * hdr->sblk_info[sblk_idx].dblk_nelmts);
+ dblk_addr = H5EA__dblock_create(hdr, iblock, &stats_changed, dblk_off,
+ hdr->sblk_info[sblk_idx].dblk_nelmts);
+ if (!H5F_addr_defined(dblk_addr))
+ H5E_THROW(H5E_CANTCREATE, "unable to create extensible array data block")
+
+ /* Set data block address in index block */
+ iblock->dblk_addrs[dblk_idx] = dblk_addr;
+ iblock_cache_flags |= H5AC__DIRTIED_FLAG;
+ } /* end if */
+ else
+ H5_LEAVE(SUCCEED)
+ } /* end if */
- /* Check if we should create the index block */
- if(!H5F_addr_defined(hdr->idx_blk_addr)) {
- /* Check if we are allowed to create the thing */
- if(0 == (thing_acc & H5AC__READ_ONLY_FLAG)) { /* i.e. r/w access */
- /* Create the index block */
- hdr->idx_blk_addr = H5EA__iblock_create(hdr, &stats_changed);
- if(!H5F_addr_defined(hdr->idx_blk_addr))
- H5E_THROW(H5E_CANTCREATE, "unable to create index block")
- hdr_dirty = TRUE;
+ /* Protect data block */
+ if (NULL == (dblock = H5EA__dblock_protect(hdr, iblock, iblock->dblk_addrs[dblk_idx],
+ hdr->sblk_info[sblk_idx].dblk_nelmts, thing_acc)))
+ H5E_THROW(H5E_CANTPROTECT, "unable to protect extensible array data block, address = %llu",
+ (unsigned long long)iblock->dblk_addrs[dblk_idx])
+
+ /* Adjust index to offset in data block */
+ elmt_idx %= hdr->sblk_info[sblk_idx].dblk_nelmts;
+
+ /* Check if there is already a dependency on the header */
+ if (will_extend && !dblock->has_hdr_depend) {
+ if (H5EA__create_flush_depend((H5AC_info_t *)hdr, (H5AC_info_t *)dblock) < 0)
+ H5E_THROW(H5E_CANTDEPEND,
+ "unable to create flush dependency between data block and header, index = %llu",
+ (unsigned long long)idx)
+ dblock->has_hdr_depend = TRUE;
} /* end if */
- else
- H5_LEAVE(SUCCEED)
- } /* end if */
- /* Protect index block */
- if(NULL == (iblock = H5EA__iblock_protect(hdr, thing_acc)))
- H5E_THROW(H5E_CANTPROTECT, "unable to protect extensible array index block, address = %llu", (unsigned long long)hdr->idx_blk_addr)
-
- /* Check if element is in index block */
- if(idx < hdr->cparam.idx_blk_elmts) {
- /* Set 'thing' info to refer to the index block */
- *thing = iblock;
- *thing_elmt_buf = (uint8_t *)iblock->elmts;
- *thing_elmt_idx = idx;
- *thing_unprot_func = (H5EA__unprotect_func_t)H5EA__iblock_unprotect;
+ /* Set 'thing' info to refer to the data block */
+ *thing = dblock;
+ *thing_elmt_buf = (uint8_t *)dblock->elmts;
+ *thing_elmt_idx = elmt_idx;
+ *thing_unprot_func = (H5EA__unprotect_func_t)H5EA__dblock_unprotect;
} /* end if */
else {
- unsigned sblk_idx; /* Which superblock does this index fall in? */
- size_t dblk_idx; /* Data block index */
- hsize_t elmt_idx; /* Offset of element in super block */
+ size_t sblk_off; /* Offset of super block in index block array of super blocks */
- /* Get super block index where element is located */
- sblk_idx = H5EA__dblock_sblk_idx(hdr, idx);
+ /* Calculate offset of super block in index block's array */
+ sblk_off = sblk_idx - iblock->nsblks;
- /* Adjust index to offset in super block */
- elmt_idx = idx - (hdr->cparam.idx_blk_elmts + hdr->sblk_info[sblk_idx].start_idx);
+ /* Check if the super block has been allocated on disk yet */
+ if (!H5F_addr_defined(iblock->sblk_addrs[sblk_off])) {
+ /* Check if we are allowed to create the thing */
+ if (0 == (thing_acc & H5AC__READ_ONLY_FLAG)) { /* i.e. r/w access */
+ haddr_t sblk_addr; /* Address of data block created */
- /* Check for data block containing element address in the index block */
- if(sblk_idx < iblock->nsblks) {
- /* Compute the data block index in index block */
- dblk_idx = (size_t)(hdr->sblk_info[sblk_idx].start_dblk + (elmt_idx / hdr->sblk_info[sblk_idx].dblk_nelmts));
- HDassert(dblk_idx < iblock->ndblk_addrs);
+ /* Create super block */
+ sblk_addr = H5EA__sblock_create(hdr, iblock, &stats_changed, sblk_idx);
+ if (!H5F_addr_defined(sblk_addr))
+ H5E_THROW(H5E_CANTCREATE, "unable to create extensible array super block")
- /* Check if the data block has been allocated on disk yet */
- if(!H5F_addr_defined(iblock->dblk_addrs[dblk_idx])) {
- /* Check if we are allowed to create the thing */
- if(0 == (thing_acc & H5AC__READ_ONLY_FLAG)) { /* i.e. r/w access */
- haddr_t dblk_addr; /* Address of data block created */
- hsize_t dblk_off; /* Offset of data block in array */
-
- /* Create data block */
- dblk_off = hdr->sblk_info[sblk_idx].start_idx + (dblk_idx * hdr->sblk_info[sblk_idx].dblk_nelmts);
- dblk_addr = H5EA__dblock_create(hdr, iblock, &stats_changed, dblk_off, hdr->sblk_info[sblk_idx].dblk_nelmts);
- if(!H5F_addr_defined(dblk_addr))
- H5E_THROW(H5E_CANTCREATE, "unable to create extensible array data block")
-
- /* Set data block address in index block */
- iblock->dblk_addrs[dblk_idx] = dblk_addr;
- iblock_cache_flags |= H5AC__DIRTIED_FLAG;
- } /* end if */
- else
- H5_LEAVE(SUCCEED)
- } /* end if */
-
- /* Protect data block */
- if(NULL == (dblock = H5EA__dblock_protect(hdr, iblock, iblock->dblk_addrs[dblk_idx], hdr->sblk_info[sblk_idx].dblk_nelmts, thing_acc)))
- H5E_THROW(H5E_CANTPROTECT, "unable to protect extensible array data block, address = %llu", (unsigned long long)iblock->dblk_addrs[dblk_idx])
-
- /* Adjust index to offset in data block */
- elmt_idx %= hdr->sblk_info[sblk_idx].dblk_nelmts;
-
- /* Check if there is already a dependency on the header */
- if(will_extend && !dblock->has_hdr_depend) {
- if(H5EA__create_flush_depend((H5AC_info_t *)hdr, (H5AC_info_t *)dblock) < 0)
- H5E_THROW(H5E_CANTDEPEND, "unable to create flush dependency between data block and header, index = %llu", (unsigned long long)idx)
- dblock->has_hdr_depend = TRUE;
+ /* Set super block address in index block */
+ iblock->sblk_addrs[sblk_off] = sblk_addr;
+ iblock_cache_flags |= H5AC__DIRTIED_FLAG;
} /* end if */
+ else
+ H5_LEAVE(SUCCEED)
+ } /* end if */
- /* Set 'thing' info to refer to the data block */
- *thing = dblock;
- *thing_elmt_buf = (uint8_t *)dblock->elmts;
- *thing_elmt_idx = elmt_idx;
- *thing_unprot_func = (H5EA__unprotect_func_t)H5EA__dblock_unprotect;
+ /* Protect super block */
+ if (NULL ==
+ (sblock = H5EA__sblock_protect(hdr, iblock, iblock->sblk_addrs[sblk_off], sblk_idx, thing_acc)))
+ H5E_THROW(H5E_CANTPROTECT, "unable to protect extensible array super block, address = %llu",
+ (unsigned long long)iblock->sblk_addrs[sblk_off])
+
+ /* Compute the data block index in super block */
+ dblk_idx = (size_t)(elmt_idx / sblock->dblk_nelmts);
+ HDassert(dblk_idx < sblock->ndblks);
+
+ /* Check if the data block has been allocated on disk yet */
+ if (!H5F_addr_defined(sblock->dblk_addrs[dblk_idx])) {
+ /* Check if we are allowed to create the thing */
+ if (0 == (thing_acc & H5AC__READ_ONLY_FLAG)) { /* i.e. r/w access */
+ haddr_t dblk_addr; /* Address of data block created */
+ hsize_t dblk_off; /* Offset of data block in array */
+
+ /* Create data block */
+ dblk_off =
+ hdr->sblk_info[sblk_idx].start_idx + (dblk_idx * hdr->sblk_info[sblk_idx].dblk_nelmts);
+ dblk_addr = H5EA__dblock_create(hdr, sblock, &stats_changed, dblk_off, sblock->dblk_nelmts);
+ if (!H5F_addr_defined(dblk_addr))
+ H5E_THROW(H5E_CANTCREATE, "unable to create extensible array data block")
+
+ /* Set data block address in index block */
+ sblock->dblk_addrs[dblk_idx] = dblk_addr;
+ sblock_cache_flags |= H5AC__DIRTIED_FLAG;
+
+ /* Create flush dependency on header, if extending the array and one doesn't already exist */
+ if (will_extend && !sblock->has_hdr_depend) {
+ if (H5EA__create_flush_depend((H5AC_info_t *)sblock->hdr, (H5AC_info_t *)sblock) < 0)
+ H5E_THROW(H5E_CANTDEPEND,
+ "unable to create flush dependency between super block and header, address "
+ "= %llu",
+ (unsigned long long)sblock->addr)
+ sblock->has_hdr_depend = TRUE;
+ } /* end if */
+ } /* end if */
+ else
+ H5_LEAVE(SUCCEED)
} /* end if */
- else {
- size_t sblk_off; /* Offset of super block in index block array of super blocks */
- /* Calculate offset of super block in index block's array */
- sblk_off = sblk_idx - iblock->nsblks;
+ /* Adjust index to offset in data block */
+ elmt_idx %= sblock->dblk_nelmts;
- /* Check if the super block has been allocated on disk yet */
- if(!H5F_addr_defined(iblock->sblk_addrs[sblk_off])) {
- /* Check if we are allowed to create the thing */
- if(0 == (thing_acc & H5AC__READ_ONLY_FLAG)) { /* i.e. r/w access */
- haddr_t sblk_addr; /* Address of data block created */
+ /* Check if the data block is paged */
+ if (sblock->dblk_npages) {
+ haddr_t dblk_page_addr; /* Address of data block page */
+ size_t page_idx; /* Index of page within data block */
+ size_t page_init_idx; /* Index of 'page init' bit */
- /* Create super block */
- sblk_addr = H5EA__sblock_create(hdr, iblock, &stats_changed, sblk_idx);
- if(!H5F_addr_defined(sblk_addr))
- H5E_THROW(H5E_CANTCREATE, "unable to create extensible array super block")
+ /* Compute page index */
+ page_idx = (size_t)elmt_idx / hdr->dblk_page_nelmts;
- /* Set super block address in index block */
- iblock->sblk_addrs[sblk_off] = sblk_addr;
- iblock_cache_flags |= H5AC__DIRTIED_FLAG;
- } /* end if */
- else
- H5_LEAVE(SUCCEED)
- } /* end if */
+ /* Compute 'page init' index */
+ page_init_idx = (dblk_idx * sblock->dblk_npages) + page_idx;
- /* Protect super block */
- if(NULL == (sblock = H5EA__sblock_protect(hdr, iblock, iblock->sblk_addrs[sblk_off], sblk_idx, thing_acc)))
- H5E_THROW(H5E_CANTPROTECT, "unable to protect extensible array super block, address = %llu", (unsigned long long)iblock->sblk_addrs[sblk_off])
+ /* Adjust index to offset in data block page */
+ elmt_idx %= hdr->dblk_page_nelmts;
- /* Compute the data block index in super block */
- dblk_idx = (size_t)(elmt_idx / sblock->dblk_nelmts);
- HDassert(dblk_idx < sblock->ndblks);
+ /* Compute data block page address */
+ dblk_page_addr = sblock->dblk_addrs[dblk_idx] + H5EA_DBLOCK_PREFIX_SIZE(sblock) +
+ (page_idx * sblock->dblk_page_size);
- /* Check if the data block has been allocated on disk yet */
- if(!H5F_addr_defined(sblock->dblk_addrs[dblk_idx])) {
+ /* Check if page has been initialized yet */
+ if (!H5VM_bit_get(sblock->page_init, page_init_idx)) {
/* Check if we are allowed to create the thing */
- if(0 == (thing_acc & H5AC__READ_ONLY_FLAG)) { /* i.e. r/w access */
- haddr_t dblk_addr; /* Address of data block created */
- hsize_t dblk_off; /* Offset of data block in array */
-
- /* Create data block */
- dblk_off = hdr->sblk_info[sblk_idx].start_idx + (dblk_idx * hdr->sblk_info[sblk_idx].dblk_nelmts);
- dblk_addr = H5EA__dblock_create(hdr, sblock, &stats_changed, dblk_off, sblock->dblk_nelmts);
- if(!H5F_addr_defined(dblk_addr))
- H5E_THROW(H5E_CANTCREATE, "unable to create extensible array data block")
-
- /* Set data block address in index block */
- sblock->dblk_addrs[dblk_idx] = dblk_addr;
- sblock_cache_flags |= H5AC__DIRTIED_FLAG;
+ if (0 == (thing_acc & H5AC__READ_ONLY_FLAG)) { /* i.e. r/w access */
+ /* Create the data block page */
+ if (H5EA__dblk_page_create(hdr, sblock, dblk_page_addr) < 0)
+ H5E_THROW(H5E_CANTCREATE, "unable to create data block page")
- /* Create flush dependency on header, if extending the array and one doesn't already exist */
- if(will_extend && !sblock->has_hdr_depend) {
- if(H5EA__create_flush_depend((H5AC_info_t *)sblock->hdr, (H5AC_info_t *)sblock) < 0)
- H5E_THROW(H5E_CANTDEPEND, "unable to create flush dependency between super block and header, address = %llu", (unsigned long long)sblock->addr)
- sblock->has_hdr_depend = TRUE;
- } /* end if */
+ /* Mark data block page as initialized in super block */
+ H5VM_bit_set(sblock->page_init, page_init_idx, TRUE);
+ sblock_cache_flags |= H5AC__DIRTIED_FLAG;
} /* end if */
else
H5_LEAVE(SUCCEED)
} /* end if */
- /* Adjust index to offset in data block */
- elmt_idx %= sblock->dblk_nelmts;
-
- /* Check if the data block is paged */
- if(sblock->dblk_npages) {
- haddr_t dblk_page_addr; /* Address of data block page */
- size_t page_idx; /* Index of page within data block */
- size_t page_init_idx; /* Index of 'page init' bit */
-
- /* Compute page index */
- page_idx = (size_t)elmt_idx / hdr->dblk_page_nelmts;
-
- /* Compute 'page init' index */
- page_init_idx = (dblk_idx * sblock->dblk_npages) + page_idx;
-
- /* Adjust index to offset in data block page */
- elmt_idx %= hdr->dblk_page_nelmts;
-
- /* Compute data block page address */
- dblk_page_addr = sblock->dblk_addrs[dblk_idx] +
- H5EA_DBLOCK_PREFIX_SIZE(sblock) +
- (page_idx * sblock->dblk_page_size);
-
- /* Check if page has been initialized yet */
- if(!H5VM_bit_get(sblock->page_init, page_init_idx)) {
- /* Check if we are allowed to create the thing */
- if(0 == (thing_acc & H5AC__READ_ONLY_FLAG)) { /* i.e. r/w access */
- /* Create the data block page */
- if(H5EA__dblk_page_create(hdr, sblock, dblk_page_addr) < 0)
- H5E_THROW(H5E_CANTCREATE, "unable to create data block page")
-
- /* Mark data block page as initialized in super block */
- H5VM_bit_set(sblock->page_init, page_init_idx, TRUE);
- sblock_cache_flags |= H5AC__DIRTIED_FLAG;
- } /* end if */
- else
- H5_LEAVE(SUCCEED)
- } /* end if */
+ /* Protect data block page */
+ if (NULL == (dblk_page = H5EA__dblk_page_protect(hdr, sblock, dblk_page_addr, thing_acc)))
+ H5E_THROW(H5E_CANTPROTECT,
+ "unable to protect extensible array data block page, address = %llu",
+ (unsigned long long)dblk_page_addr)
- /* Protect data block page */
- if(NULL == (dblk_page = H5EA__dblk_page_protect(hdr, sblock, dblk_page_addr, thing_acc)))
- H5E_THROW(H5E_CANTPROTECT, "unable to protect extensible array data block page, address = %llu", (unsigned long long)dblk_page_addr)
+ /* Check if there is already a dependency on the header */
+ if (will_extend && !dblk_page->has_hdr_depend) {
+ if (H5EA__create_flush_depend((H5AC_info_t *)hdr, (H5AC_info_t *)dblk_page) < 0)
+ H5E_THROW(
+ H5E_CANTDEPEND,
+ "unable to create flush dependency between data block page and header, index = %llu",
+ (unsigned long long)idx)
+ dblk_page->has_hdr_depend = TRUE;
+ } /* end if */
- /* Check if there is already a dependency on the header */
- if(will_extend && !dblk_page->has_hdr_depend) {
- if(H5EA__create_flush_depend((H5AC_info_t *)hdr, (H5AC_info_t *)dblk_page) < 0)
- H5E_THROW(H5E_CANTDEPEND, "unable to create flush dependency between data block page and header, index = %llu", (unsigned long long)idx)
- dblk_page->has_hdr_depend = TRUE;
- } /* end if */
+ /* Set 'thing' info to refer to the data block page */
+ *thing = dblk_page;
+ *thing_elmt_buf = (uint8_t *)dblk_page->elmts;
+ *thing_elmt_idx = elmt_idx;
+ *thing_unprot_func = (H5EA__unprotect_func_t)H5EA__dblk_page_unprotect;
+ } /* end if */
+ else {
+ /* Protect data block */
+ if (NULL == (dblock = H5EA__dblock_protect(hdr, sblock, sblock->dblk_addrs[dblk_idx],
+ sblock->dblk_nelmts, thing_acc)))
+ H5E_THROW(H5E_CANTPROTECT, "unable to protect extensible array data block, address = %llu",
+ (unsigned long long)sblock->dblk_addrs[dblk_idx])
- /* Set 'thing' info to refer to the data block page */
- *thing = dblk_page;
- *thing_elmt_buf = (uint8_t *)dblk_page->elmts;
- *thing_elmt_idx = elmt_idx;
- *thing_unprot_func = (H5EA__unprotect_func_t)H5EA__dblk_page_unprotect;
+ /* Check if there is already a dependency on the header */
+ if (will_extend && !dblock->has_hdr_depend) {
+ if (H5EA__create_flush_depend((H5AC_info_t *)hdr, (H5AC_info_t *)dblock) < 0)
+ H5E_THROW(H5E_CANTDEPEND,
+ "unable to create flush dependency between data block and header, index = %llu",
+ (unsigned long long)idx)
+ dblock->has_hdr_depend = TRUE;
} /* end if */
- else {
- /* Protect data block */
- if(NULL == (dblock = H5EA__dblock_protect(hdr, sblock, sblock->dblk_addrs[dblk_idx], sblock->dblk_nelmts, thing_acc)))
- H5E_THROW(H5E_CANTPROTECT, "unable to protect extensible array data block, address = %llu", (unsigned long long)sblock->dblk_addrs[dblk_idx])
-
- /* Check if there is already a dependency on the header */
- if(will_extend && !dblock->has_hdr_depend) {
- if(H5EA__create_flush_depend((H5AC_info_t *)hdr, (H5AC_info_t *)dblock) < 0)
- H5E_THROW(H5E_CANTDEPEND, "unable to create flush dependency between data block and header, index = %llu", (unsigned long long)idx)
- dblock->has_hdr_depend = TRUE;
- } /* end if */
- /* Set 'thing' info to refer to the data block */
- *thing = dblock;
- *thing_elmt_buf = (uint8_t *)dblock->elmts;
- *thing_elmt_idx = elmt_idx;
- *thing_unprot_func = (H5EA__unprotect_func_t)H5EA__dblock_unprotect;
- } /* end else */
+ /* Set 'thing' info to refer to the data block */
+ *thing = dblock;
+ *thing_elmt_buf = (uint8_t *)dblock->elmts;
+ *thing_elmt_idx = elmt_idx;
+ *thing_unprot_func = (H5EA__unprotect_func_t)H5EA__dblock_unprotect;
} /* end else */
- } /* end else */
+ } /* end else */
+} /* end else */
- /* Sanity checks */
- HDassert(*thing != NULL);
- HDassert(*thing_unprot_func != NULL);
+/* Sanity checks */
+HDassert(*thing != NULL);
+HDassert(*thing_unprot_func != NULL);
CATCH
- /* Reset 'thing' info on error */
- if(ret_value < 0) {
- *thing = NULL;
- *thing_elmt_buf = NULL;
- *thing_elmt_idx = 0;
- *thing_unprot_func = (H5EA__unprotect_func_t)NULL;
- } /* end if */
-
- /* Check for updating array statistics */
- if(stats_changed)
- hdr_dirty = TRUE;
+/* Reset 'thing' info on error */
+if (ret_value < 0) {
+ *thing = NULL;
+ *thing_elmt_buf = NULL;
+ *thing_elmt_idx = 0;
+ *thing_unprot_func = (H5EA__unprotect_func_t)NULL;
+} /* end if */
+
+/* Check for updating array statistics */
+if (stats_changed)
+ hdr_dirty = TRUE;
+
+/* Check for header modified */
+if (hdr_dirty)
+ if (H5EA__hdr_modified(hdr) < 0)
+ H5E_THROW(H5E_CANTMARKDIRTY, "unable to mark extensible array header as modified")
+
+/* Release resources */
+if (iblock && *thing != iblock && H5EA__iblock_unprotect(iblock, iblock_cache_flags) < 0)
+ H5E_THROW(H5E_CANTUNPROTECT, "unable to release extensible array index block")
+/* (Note: super blocks don't contain elements, so don't have a '*thing != sblock' check) */
+if (sblock && H5EA__sblock_unprotect(sblock, sblock_cache_flags) < 0)
+ H5E_THROW(H5E_CANTUNPROTECT, "unable to release extensible array super block")
+if (dblock && *thing != dblock && H5EA__dblock_unprotect(dblock, H5AC__NO_FLAGS_SET) < 0)
+ H5E_THROW(H5E_CANTUNPROTECT, "unable to release extensible array data block")
+if (dblk_page && *thing != dblk_page && H5EA__dblk_page_unprotect(dblk_page, H5AC__NO_FLAGS_SET) < 0)
+ H5E_THROW(H5E_CANTUNPROTECT, "unable to release extensible array data block page")
+
+END_FUNC(STATIC) /* end H5EA__lookup_elmt() */
- /* Check for header modified */
- if(hdr_dirty)
- if(H5EA__hdr_modified(hdr) < 0)
- H5E_THROW(H5E_CANTMARKDIRTY, "unable to mark extensible array header as modified")
-
- /* Release resources */
- if(iblock && *thing != iblock && H5EA__iblock_unprotect(iblock, iblock_cache_flags) < 0)
- H5E_THROW(H5E_CANTUNPROTECT, "unable to release extensible array index block")
- /* (Note: super blocks don't contain elements, so don't have a '*thing != sblock' check) */
- if(sblock && H5EA__sblock_unprotect(sblock, sblock_cache_flags) < 0)
- H5E_THROW(H5E_CANTUNPROTECT, "unable to release extensible array super block")
- if(dblock && *thing != dblock && H5EA__dblock_unprotect(dblock, H5AC__NO_FLAGS_SET) < 0)
- H5E_THROW(H5E_CANTUNPROTECT, "unable to release extensible array data block")
- if(dblk_page && *thing != dblk_page && H5EA__dblk_page_unprotect(dblk_page, H5AC__NO_FLAGS_SET) < 0)
- H5E_THROW(H5E_CANTUNPROTECT, "unable to release extensible array data block page")
-
-END_FUNC(STATIC) /* end H5EA__lookup_elmt() */
-
-
/*-------------------------------------------------------------------------
* Function: H5EA_set
*
@@ -654,58 +649,57 @@ END_FUNC(STATIC) /* end H5EA__lookup_elmt() */
*
*-------------------------------------------------------------------------
*/
-BEGIN_FUNC(PRIV, ERR,
-herr_t, SUCCEED, FAIL,
-H5EA_set(const H5EA_t *ea, hsize_t idx, const void *elmt))
-
- /* Local variables */
- H5EA_hdr_t *hdr = ea->hdr; /* Header for EA */
- void *thing = NULL; /* Pointer to the array metadata containing the array index we are interested in */
- uint8_t *thing_elmt_buf; /* Pointer to the element buffer for the array metadata */
- hsize_t thing_elmt_idx; /* Index of the element in the element buffer for the array metadata */
- H5EA__unprotect_func_t thing_unprot_func; /* Function pointer for unprotecting the array metadata */
- hbool_t will_extend; /* Flag indicating if setting the element will extend the array */
- unsigned thing_cache_flags = H5AC__NO_FLAGS_SET; /* Flags for unprotecting array metadata */
-
- /*
- * Check arguments.
- */
- HDassert(ea);
- HDassert(hdr);
-
- /* Set the shared array header's file context for this operation */
- hdr->f = ea->f;
-
- /* Look up the array metadata containing the element we want to set */
- will_extend = (idx >= hdr->stats.stored.max_idx_set);
- if(H5EA__lookup_elmt(ea, idx, will_extend, H5AC__NO_FLAGS_SET, &thing, &thing_elmt_buf, &thing_elmt_idx, &thing_unprot_func) < 0)
- H5E_THROW(H5E_CANTPROTECT, "unable to protect array metadata")
-
- /* Sanity check */
- HDassert(thing);
- HDassert(thing_elmt_buf);
- HDassert(thing_unprot_func);
-
- /* Set element in thing's element buffer */
- H5MM_memcpy(thing_elmt_buf + (hdr->cparam.cls->nat_elmt_size * thing_elmt_idx), elmt, hdr->cparam.cls->nat_elmt_size);
- thing_cache_flags |= H5AC__DIRTIED_FLAG;
-
- /* Update max. element set in array, if appropriate */
- if(will_extend) {
- /* Update the max index for the array */
- hdr->stats.stored.max_idx_set = idx + 1;
- if(H5EA__hdr_modified(hdr) < 0)
- H5E_THROW(H5E_CANTMARKDIRTY, "unable to mark extensible array header as modified")
- } /* end if */
+BEGIN_FUNC(PRIV, ERR, herr_t, SUCCEED, FAIL, H5EA_set(const H5EA_t *ea, hsize_t idx, const void *elmt))
+
+/* Local variables */
+H5EA_hdr_t *hdr = ea->hdr; /* Header for EA */
+void * thing = NULL; /* Pointer to the array metadata containing the array index we are interested in */
+uint8_t * thing_elmt_buf; /* Pointer to the element buffer for the array metadata */
+hsize_t thing_elmt_idx; /* Index of the element in the element buffer for the array metadata */
+H5EA__unprotect_func_t thing_unprot_func; /* Function pointer for unprotecting the array metadata */
+hbool_t will_extend; /* Flag indicating if setting the element will extend the array */
+unsigned thing_cache_flags = H5AC__NO_FLAGS_SET; /* Flags for unprotecting array metadata */
+
+/*
+ * Check arguments.
+ */
+HDassert(ea);
+HDassert(hdr);
+
+/* Set the shared array header's file context for this operation */
+hdr->f = ea->f;
+
+/* Look up the array metadata containing the element we want to set */
+will_extend = (idx >= hdr->stats.stored.max_idx_set);
+if (H5EA__lookup_elmt(ea, idx, will_extend, H5AC__NO_FLAGS_SET, &thing, &thing_elmt_buf, &thing_elmt_idx,
+ &thing_unprot_func) < 0)
+ H5E_THROW(H5E_CANTPROTECT, "unable to protect array metadata")
+
+/* Sanity check */
+HDassert(thing);
+HDassert(thing_elmt_buf);
+HDassert(thing_unprot_func);
+
+/* Set element in thing's element buffer */
+H5MM_memcpy(thing_elmt_buf + (hdr->cparam.cls->nat_elmt_size * thing_elmt_idx), elmt,
+ hdr->cparam.cls->nat_elmt_size);
+thing_cache_flags |= H5AC__DIRTIED_FLAG;
+
+/* Update max. element set in array, if appropriate */
+if (will_extend) {
+ /* Update the max index for the array */
+ hdr->stats.stored.max_idx_set = idx + 1;
+ if (H5EA__hdr_modified(hdr) < 0)
+ H5E_THROW(H5E_CANTMARKDIRTY, "unable to mark extensible array header as modified")
+} /* end if */
CATCH
- /* Release resources */
- if(thing && (thing_unprot_func)(thing, thing_cache_flags) < 0)
- H5E_THROW(H5E_CANTUNPROTECT, "unable to release extensible array metadata")
+/* Release resources */
+if (thing && (thing_unprot_func)(thing, thing_cache_flags) < 0)
+ H5E_THROW(H5E_CANTUNPROTECT, "unable to release extensible array metadata")
-END_FUNC(PRIV) /* end H5EA_set() */
+END_FUNC(PRIV) /* end H5EA_set() */
-
/*-------------------------------------------------------------------------
* Function: H5EA_get
*
@@ -718,57 +712,56 @@ END_FUNC(PRIV) /* end H5EA_set() */
*
*-------------------------------------------------------------------------
*/
-BEGIN_FUNC(PRIV, ERR,
-herr_t, SUCCEED, FAIL,
-H5EA_get(const H5EA_t *ea, hsize_t idx, void *elmt))
-
- /* Local variables */
- H5EA_hdr_t *hdr = ea->hdr; /* Header for EA */
- void *thing = NULL; /* Pointer to the array metadata containing the array index we are interested in */
- H5EA__unprotect_func_t thing_unprot_func; /* Function pointer for unprotecting the array metadata */
-
- /*
- * Check arguments.
- */
- HDassert(ea);
- HDassert(hdr);
-
- /* Check for element beyond max. element in array */
- if(idx >= hdr->stats.stored.max_idx_set) {
- /* Call the class's 'fill' callback */
- if((hdr->cparam.cls->fill)(elmt, (size_t)1) < 0)
- H5E_THROW(H5E_CANTSET, "can't set element to class's fill value")
- } /* end if */
- else {
- uint8_t *thing_elmt_buf; /* Pointer to the element buffer for the array metadata */
- hsize_t thing_elmt_idx; /* Index of the element in the element buffer for the array metadata */
+BEGIN_FUNC(PRIV, ERR, herr_t, SUCCEED, FAIL, H5EA_get(const H5EA_t *ea, hsize_t idx, void *elmt))
- /* Set the shared array header's file context for this operation */
- hdr->f = ea->f;
+/* Local variables */
+H5EA_hdr_t *hdr = ea->hdr; /* Header for EA */
+void * thing = NULL; /* Pointer to the array metadata containing the array index we are interested in */
+H5EA__unprotect_func_t thing_unprot_func; /* Function pointer for unprotecting the array metadata */
- /* Look up the array metadata containing the element we want to set */
- if(H5EA__lookup_elmt(ea, idx, FALSE, H5AC__READ_ONLY_FLAG, &thing, &thing_elmt_buf, &thing_elmt_idx, &thing_unprot_func) < 0)
- H5E_THROW(H5E_CANTPROTECT, "unable to protect array metadata")
+/*
+ * Check arguments.
+ */
+HDassert(ea);
+HDassert(hdr);
+
+/* Check for element beyond max. element in array */
+if (idx >= hdr->stats.stored.max_idx_set) {
+ /* Call the class's 'fill' callback */
+ if ((hdr->cparam.cls->fill)(elmt, (size_t)1) < 0)
+ H5E_THROW(H5E_CANTSET, "can't set element to class's fill value")
+} /* end if */
+else {
+ uint8_t *thing_elmt_buf; /* Pointer to the element buffer for the array metadata */
+ hsize_t thing_elmt_idx; /* Index of the element in the element buffer for the array metadata */
- /* Check if the thing holding the element has been created yet */
- if(NULL == thing) {
- /* Call the class's 'fill' callback */
- if((hdr->cparam.cls->fill)(elmt, (size_t)1) < 0)
- H5E_THROW(H5E_CANTSET, "can't set element to class's fill value")
- } /* end if */
- else
- /* Get element from thing's element buffer */
- H5MM_memcpy(elmt, thing_elmt_buf + (hdr->cparam.cls->nat_elmt_size * thing_elmt_idx), hdr->cparam.cls->nat_elmt_size);
- } /* end else */
+ /* Set the shared array header's file context for this operation */
+ hdr->f = ea->f;
+
+ /* Look up the array metadata containing the element we want to set */
+ if (H5EA__lookup_elmt(ea, idx, FALSE, H5AC__READ_ONLY_FLAG, &thing, &thing_elmt_buf, &thing_elmt_idx,
+ &thing_unprot_func) < 0)
+ H5E_THROW(H5E_CANTPROTECT, "unable to protect array metadata")
+
+ /* Check if the thing holding the element has been created yet */
+ if (NULL == thing) {
+ /* Call the class's 'fill' callback */
+ if ((hdr->cparam.cls->fill)(elmt, (size_t)1) < 0)
+ H5E_THROW(H5E_CANTSET, "can't set element to class's fill value")
+ } /* end if */
+ else
+ /* Get element from thing's element buffer */
+ H5MM_memcpy(elmt, thing_elmt_buf + (hdr->cparam.cls->nat_elmt_size * thing_elmt_idx),
+ hdr->cparam.cls->nat_elmt_size);
+} /* end else */
CATCH
- /* Release thing */
- if(thing && (thing_unprot_func)(thing, H5AC__NO_FLAGS_SET) < 0)
- H5E_THROW(H5E_CANTUNPROTECT, "unable to release extensible array metadata")
+/* Release thing */
+if (thing && (thing_unprot_func)(thing, H5AC__NO_FLAGS_SET) < 0)
+ H5E_THROW(H5E_CANTUNPROTECT, "unable to release extensible array metadata")
-END_FUNC(PRIV) /* end H5EA_get() */
+END_FUNC(PRIV) /* end H5EA_get() */
-
/*-------------------------------------------------------------------------
* Function: H5EA_depend
*
@@ -782,43 +775,40 @@ END_FUNC(PRIV) /* end H5EA_get() */
*
*-------------------------------------------------------------------------
*/
-BEGIN_FUNC(PRIV, ERR,
-herr_t, SUCCEED, FAIL,
-H5EA_depend(H5EA_t *ea, H5AC_proxy_entry_t *parent))
-
- /* Local variables */
- H5EA_hdr_t *hdr = ea->hdr; /* Header for EA */
-
- /*
- * Check arguments.
- */
- HDassert(ea);
- HDassert(hdr);
- HDassert(parent);
-
- /*
- * Check to see if a flush dependency between the extensible array
- * and another data structure in the file has already been set up.
- * If it hasn't, do so now.
- */
- if(NULL == hdr->parent) {
- /* Sanity check */
- HDassert(hdr->top_proxy);
+BEGIN_FUNC(PRIV, ERR, herr_t, SUCCEED, FAIL, H5EA_depend(H5EA_t *ea, H5AC_proxy_entry_t *parent))
- /* Set the shared array header's file context for this operation */
- hdr->f = ea->f;
+/* Local variables */
+H5EA_hdr_t *hdr = ea->hdr; /* Header for EA */
- /* Add the extensible array as a child of the parent (proxy) */
- if(H5AC_proxy_entry_add_child(parent, hdr->f, hdr->top_proxy) < 0)
- H5E_THROW(H5E_CANTSET, "unable to add extensible array as child of proxy")
- hdr->parent = parent;
- } /* end if */
+/*
+ * Check arguments.
+ */
+HDassert(ea);
+HDassert(hdr);
+HDassert(parent);
+
+/*
+ * Check to see if a flush dependency between the extensible array
+ * and another data structure in the file has already been set up.
+ * If it hasn't, do so now.
+ */
+if (NULL == hdr->parent) {
+ /* Sanity check */
+ HDassert(hdr->top_proxy);
+
+ /* Set the shared array header's file context for this operation */
+ hdr->f = ea->f;
+
+ /* Add the extensible array as a child of the parent (proxy) */
+ if (H5AC_proxy_entry_add_child(parent, hdr->f, hdr->top_proxy) < 0)
+ H5E_THROW(H5E_CANTSET, "unable to add extensible array as child of proxy")
+ hdr->parent = parent;
+} /* end if */
CATCH
-END_FUNC(PRIV) /* end H5EA_depend() */
+END_FUNC(PRIV) /* end H5EA_depend() */
-
/*-------------------------------------------------------------------------
* Function: H5EA_close
*
@@ -831,94 +821,92 @@ END_FUNC(PRIV) /* end H5EA_depend() */
*
*-------------------------------------------------------------------------
*/
-BEGIN_FUNC(PRIV, ERR,
-herr_t, SUCCEED, FAIL,
-H5EA_close(H5EA_t *ea))
-
- /* Local variables */
- hbool_t pending_delete = FALSE; /* Whether the array is pending deletion */
- haddr_t ea_addr = HADDR_UNDEF; /* Address of array (for deletion) */
-
- /*
- * Check arguments.
- */
- HDassert(ea);
-
- /* Close the header, if it was set */
- if(ea->hdr) {
- /* Decrement file reference & check if this is the last open extensible array using the shared array header */
- if(0 == H5EA__hdr_fuse_decr(ea->hdr)) {
- /* Set the shared array header's file context for this operation */
- ea->hdr->f = ea->f;
-
- /* Shut down anything that can't be put in the header's 'flush' callback */
-
- /* Check for pending array deletion */
- if(ea->hdr->pending_delete) {
- /* Set local info, so array deletion can occur after decrementing the
- * header's ref count
- */
- pending_delete = TRUE;
- ea_addr = ea->hdr->addr;
- } /* end if */
- } /* end if */
+BEGIN_FUNC(PRIV, ERR, herr_t, SUCCEED, FAIL, H5EA_close(H5EA_t *ea))
+
+/* Local variables */
+hbool_t pending_delete = FALSE; /* Whether the array is pending deletion */
+haddr_t ea_addr = HADDR_UNDEF; /* Address of array (for deletion) */
+
+/*
+ * Check arguments.
+ */
+HDassert(ea);
+
+/* Close the header, if it was set */
+if (ea->hdr) {
+ /* Decrement file reference & check if this is the last open extensible array using the shared array
+ * header */
+ if (0 == H5EA__hdr_fuse_decr(ea->hdr)) {
+ /* Set the shared array header's file context for this operation */
+ ea->hdr->f = ea->f;
+
+ /* Shut down anything that can't be put in the header's 'flush' callback */
/* Check for pending array deletion */
- if(pending_delete) {
- H5EA_hdr_t *hdr; /* Another pointer to extensible array header */
+ if (ea->hdr->pending_delete) {
+ /* Set local info, so array deletion can occur after decrementing the
+ * header's ref count
+ */
+ pending_delete = TRUE;
+ ea_addr = ea->hdr->addr;
+ } /* end if */
+ } /* end if */
+
+ /* Check for pending array deletion */
+ if (pending_delete) {
+ H5EA_hdr_t *hdr; /* Another pointer to extensible array header */
#ifndef NDEBUG
-{
- unsigned hdr_status = 0; /* Header's status in the metadata cache */
-
- /* Check the header's status in the metadata cache */
- if(H5AC_get_entry_status(ea->f, ea_addr, &hdr_status) < 0)
- H5E_THROW(H5E_CANTGET, "unable to check metadata cache status for extensible array header")
-
- /* Sanity checks on header */
- HDassert(hdr_status & H5AC_ES__IN_CACHE);
- HDassert(hdr_status & H5AC_ES__IS_PINNED);
- HDassert(!(hdr_status & H5AC_ES__IS_PROTECTED));
-}
+ {
+ unsigned hdr_status = 0; /* Header's status in the metadata cache */
+
+ /* Check the header's status in the metadata cache */
+ if (H5AC_get_entry_status(ea->f, ea_addr, &hdr_status) < 0)
+ H5E_THROW(H5E_CANTGET, "unable to check metadata cache status for extensible array header")
+
+ /* Sanity checks on header */
+ HDassert(hdr_status & H5AC_ES__IN_CACHE);
+ HDassert(hdr_status & H5AC_ES__IS_PINNED);
+ HDassert(!(hdr_status & H5AC_ES__IS_PROTECTED));
+ }
#endif /* NDEBUG */
- /* Lock the array header into memory */
- /* (OK to pass in NULL for callback context, since we know the header must be in the cache) */
- if(NULL == (hdr = H5EA__hdr_protect(ea->f, ea_addr, NULL, H5AC__NO_FLAGS_SET)))
- H5E_THROW(H5E_CANTLOAD, "unable to load extensible array header")
+ /* Lock the array header into memory */
+ /* (OK to pass in NULL for callback context, since we know the header must be in the cache) */
+ if (NULL == (hdr = H5EA__hdr_protect(ea->f, ea_addr, NULL, H5AC__NO_FLAGS_SET)))
+ H5E_THROW(H5E_CANTLOAD, "unable to load extensible array header")
- /* Set the shared array header's file context for this operation */
- hdr->f = ea->f;
+ /* Set the shared array header's file context for this operation */
+ hdr->f = ea->f;
- /* Decrement the reference count on the array header */
- /* (don't put in H5EA_hdr_fuse_decr() as the array header may be evicted
- * immediately -QAK)
- */
- if(H5EA__hdr_decr(ea->hdr) < 0)
- H5E_THROW(H5E_CANTDEC, "can't decrement reference count on shared array header")
+ /* Decrement the reference count on the array header */
+ /* (don't put in H5EA_hdr_fuse_decr() as the array header may be evicted
+ * immediately -QAK)
+ */
+ if (H5EA__hdr_decr(ea->hdr) < 0)
+ H5E_THROW(H5E_CANTDEC, "can't decrement reference count on shared array header")
- /* Delete array, starting with header (unprotects header) */
- if(H5EA__hdr_delete(hdr) < 0)
- H5E_THROW(H5E_CANTDELETE, "unable to delete extensible array")
- } /* end if */
- else {
- /* Decrement the reference count on the array header */
- /* (don't put in H5EA_hdr_fuse_decr() as the array header may be evicted
- * immediately -QAK)
- */
- if(H5EA__hdr_decr(ea->hdr) < 0)
- H5E_THROW(H5E_CANTDEC, "can't decrement reference count on shared array header")
- } /* end else */
+ /* Delete array, starting with header (unprotects header) */
+ if (H5EA__hdr_delete(hdr) < 0)
+ H5E_THROW(H5E_CANTDELETE, "unable to delete extensible array")
} /* end if */
+ else {
+ /* Decrement the reference count on the array header */
+ /* (don't put in H5EA_hdr_fuse_decr() as the array header may be evicted
+ * immediately -QAK)
+ */
+ if (H5EA__hdr_decr(ea->hdr) < 0)
+ H5E_THROW(H5E_CANTDEC, "can't decrement reference count on shared array header")
+ } /* end else */
+} /* end if */
- /* Release the extensible array wrapper */
- ea = (H5EA_t *)H5FL_FREE(H5EA_t, ea);
+/* Release the extensible array wrapper */
+ea = (H5EA_t *)H5FL_FREE(H5EA_t, ea);
CATCH
-END_FUNC(PRIV) /* end H5EA_close() */
+END_FUNC(PRIV) /* end H5EA_close() */
-
/*-------------------------------------------------------------------------
* Function: H5EA_delete
*
@@ -931,45 +919,43 @@ END_FUNC(PRIV) /* end H5EA_close() */
*
*-------------------------------------------------------------------------
*/
-BEGIN_FUNC(PRIV, ERR,
-herr_t, SUCCEED, FAIL,
-H5EA_delete(H5F_t *f, haddr_t ea_addr, void *ctx_udata))
-
- /* Local variables */
- H5EA_hdr_t *hdr = NULL; /* The fractal heap header information */
-
- /*
- * Check arguments.
- */
- HDassert(f);
- HDassert(H5F_addr_defined(ea_addr));
-
- /* Lock the array header into memory */
- if(NULL == (hdr = H5EA__hdr_protect(f, ea_addr, ctx_udata, H5AC__NO_FLAGS_SET)))
- H5E_THROW(H5E_CANTPROTECT, "unable to protect extensible array header, address = %llu", (unsigned long long)ea_addr)
-
- /* Check for files using shared array header */
- if(hdr->file_rc)
- hdr->pending_delete = TRUE;
- else {
- /* Set the shared array header's file context for this operation */
- hdr->f = f;
+BEGIN_FUNC(PRIV, ERR, herr_t, SUCCEED, FAIL, H5EA_delete(H5F_t *f, haddr_t ea_addr, void *ctx_udata))
- /* Delete array now, starting with header (unprotects header) */
- if(H5EA__hdr_delete(hdr) < 0)
- H5E_THROW(H5E_CANTDELETE, "unable to delete extensible array")
- hdr = NULL;
- } /* end if */
+/* Local variables */
+H5EA_hdr_t *hdr = NULL; /* The fractal heap header information */
+
+/*
+ * Check arguments.
+ */
+HDassert(f);
+HDassert(H5F_addr_defined(ea_addr));
+
+/* Lock the array header into memory */
+if (NULL == (hdr = H5EA__hdr_protect(f, ea_addr, ctx_udata, H5AC__NO_FLAGS_SET)))
+ H5E_THROW(H5E_CANTPROTECT, "unable to protect extensible array header, address = %llu",
+ (unsigned long long)ea_addr)
+
+/* Check for files using shared array header */
+if (hdr->file_rc)
+ hdr->pending_delete = TRUE;
+else {
+ /* Set the shared array header's file context for this operation */
+ hdr->f = f;
+
+ /* Delete array now, starting with header (unprotects header) */
+ if (H5EA__hdr_delete(hdr) < 0)
+ H5E_THROW(H5E_CANTDELETE, "unable to delete extensible array")
+ hdr = NULL;
+} /* end if */
CATCH
- /* Unprotect the header, if an error occurred */
- if(hdr && H5EA__hdr_unprotect(hdr, H5AC__NO_FLAGS_SET) < 0)
- H5E_THROW(H5E_CANTUNPROTECT, "unable to release extensible array header")
+/* Unprotect the header, if an error occurred */
+if (hdr && H5EA__hdr_unprotect(hdr, H5AC__NO_FLAGS_SET) < 0)
+ H5E_THROW(H5E_CANTUNPROTECT, "unable to release extensible array header")
-END_FUNC(PRIV) /* end H5EA_delete() */
+END_FUNC(PRIV) /* end H5EA_delete() */
-
/*-------------------------------------------------------------------------
* Function: H5EA_iterate
*
@@ -982,45 +968,43 @@ END_FUNC(PRIV) /* end H5EA_delete() */
*
*-------------------------------------------------------------------------
*/
-BEGIN_FUNC(PRIV, ERR,
-int, H5_ITER_CONT, H5_ITER_ERROR,
-H5EA_iterate(H5EA_t *ea, H5EA_operator_t op, void *udata))
-
- /* Local variables */
- uint8_t *elmt = NULL;
- hsize_t u;
- int cb_ret = H5_ITER_CONT; /* Return value from callback */
-
- /* Check arguments */
- HDassert(ea);
- HDassert(op);
- HDassert(udata);
-
- /* Allocate space for a native array element */
- if(NULL == (elmt = H5FL_BLK_MALLOC(ea_native_elmt, ea->hdr->cparam.cls->nat_elmt_size)))
- H5E_THROW(H5E_CANTALLOC, "memory allocation failed for extensible array element")
-
- /* Iterate over all elements in array */
- for(u = 0; u < ea->hdr->stats.stored.max_idx_set && cb_ret == H5_ITER_CONT; u++) {
- /* Get array element */
- if(H5EA_get(ea, u, elmt) < 0)
- H5E_THROW(H5E_CANTGET, "unable to delete fixed array")
-
- /* Make callback */
- if((cb_ret = (*op)(u, elmt, udata)) < 0) {
- H5E_PRINTF(H5E_BADITER, "iterator function failed");
- H5_LEAVE(cb_ret)
- } /* end if */
- } /* end for */
+BEGIN_FUNC(PRIV, ERR, int, H5_ITER_CONT, H5_ITER_ERROR,
+ H5EA_iterate(H5EA_t *ea, H5EA_operator_t op, void *udata))
+
+/* Local variables */
+uint8_t *elmt = NULL;
+hsize_t u;
+int cb_ret = H5_ITER_CONT; /* Return value from callback */
+
+/* Check arguments */
+HDassert(ea);
+HDassert(op);
+HDassert(udata);
+
+/* Allocate space for a native array element */
+if (NULL == (elmt = H5FL_BLK_MALLOC(ea_native_elmt, ea->hdr->cparam.cls->nat_elmt_size)))
+ H5E_THROW(H5E_CANTALLOC, "memory allocation failed for extensible array element")
+
+/* Iterate over all elements in array */
+for (u = 0; u < ea->hdr->stats.stored.max_idx_set && cb_ret == H5_ITER_CONT; u++) {
+ /* Get array element */
+ if (H5EA_get(ea, u, elmt) < 0)
+ H5E_THROW(H5E_CANTGET, "unable to delete fixed array")
+
+ /* Make callback */
+ if ((cb_ret = (*op)(u, elmt, udata)) < 0) {
+ H5E_PRINTF(H5E_BADITER, "iterator function failed");
+ H5_LEAVE(cb_ret)
+ } /* end if */
+} /* end for */
CATCH
- if(elmt)
- elmt = H5FL_BLK_FREE(ea_native_elmt, elmt);
+if (elmt)
+ elmt = H5FL_BLK_FREE(ea_native_elmt, elmt);
-END_FUNC(PRIV) /* end H5EA_iterate() */
+END_FUNC(PRIV) /* end H5EA_iterate() */
-
/*-------------------------------------------------------------------------
* Function: H5EA_patch_file
*
@@ -1033,20 +1017,17 @@ END_FUNC(PRIV) /* end H5EA_iterate() */
*
*-------------------------------------------------------------------------
*/
-BEGIN_FUNC(PRIV, NOERR,
-herr_t, SUCCEED, -,
-H5EA_patch_file(H5EA_t *ea, H5F_t *f))
+BEGIN_FUNC(PRIV, NOERR, herr_t, SUCCEED, -, H5EA_patch_file(H5EA_t *ea, H5F_t *f))
- /* Local variables */
+/* Local variables */
- /*
- * Check arguments.
- */
- HDassert(ea);
- HDassert(f);
-
- if(ea->f != f || ea->hdr->f != f)
- ea->f = ea->hdr->f = f;
+/*
+ * Check arguments.
+ */
+HDassert(ea);
+HDassert(f);
-END_FUNC(PRIV) /* end H5EA_patch_file() */
+if (ea->f != f || ea->hdr->f != f)
+ ea->f = ea->hdr->f = f;
+END_FUNC(PRIV) /* end H5EA_patch_file() */