[svn-r15549] Description:

	Initial checkin of extensible array data structure prototype code and
regression tests.

	Initial definitions for revised FUNC_ENTER/LEAVE and error reporting
macros, which are being vetted in the extensible array code.

	Minor warning and formatting cleanups in other sections of code.

Tested on:
        Mac OS X/32 10.5.4 (amazon) in debug mode
        Mac OS X/32 10.5.4 (amazon) w/C++ & FORTRAN, w/threadsafe,
                                in production mode
        FreeBSD/32 6.3 (duty) in debug mode
        FreeBSD/64 6.3 (liberty) w/C++ & FORTRAN, in debug mode
        Linux/32 2.6 (kagiso) w/PGI compilers, w/C++ & FORTRAN, w/threadsafe,
                                in debug mode
        Linux/64-amd64 2.6 (smirom) w/Intel compilers w/default API=1.6.x,
                                w/C++ & FORTRAN, in production mode
        Solaris/32 2.10 (linew) w/deprecated symbols disabled, w/C++ & FORTRAN,
                                w/szip filter, in production mode
        Linux/64-ia64 2.6 (cobalt) w/Intel compilers, w/C++ & FORTRAN,
                                in production mode
        Linux/64-ia64 2.4 (tg-login3) w/parallel, w/FORTRAN, in production mode
        Linux/64-amd64 2.6 (abe) w/parallel, w/FORTRAN, in production mode

1 files changed, 392 insertions, 0 deletions

diff --git a/src/H5EAcache.c b/src/H5EAcache.c
new file mode 100644
index 0000000..3fc408d
--- /dev/null
+++ b/src/H5EAcache.c
@@ -0,0 +1,392 @@
+/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
+ * Copyright by The HDF Group.                                               *
+ * Copyright by the Board of Trustees of the University of Illinois.         *
+ * All rights reserved.                                                      *
+ *                                                                           *
+ * This file is part of HDF5.  The full HDF5 copyright notice, including     *
+ * terms governing use, modification, and redistribution, is contained in    *
+ * the files COPYING and Copyright.html.  COPYING can be found at the root   *
+ * of the source code distribution tree; Copyright.html can be found at the  *
+ * root level of an installed copy of the electronic HDF5 document set and   *
+ * is linked from the top-level documents page.  It can also be found at     *
+ * http://hdfgroup.org/HDF5/doc/Copyright.html.  If you do not have          *
+ * access to either file, you may request a copy from help@hdfgroup.org.     *
+ * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
+
+/*-------------------------------------------------------------------------
+ *
+ * Created:		H5EAcache.c
+ *			Aug 26 2008
+ *			Quincey Koziol <koziol@hdfgroup.org>
+ *
+ * Purpose:		Implement extensible array metadata cache methods.
+ *
+ *-------------------------------------------------------------------------
+ */
+
+/**********************/
+/* Module Declaration */
+/**********************/
+
+#define H5EA_MODULE
+
+
+/***********************/
+/* Other Packages Used */
+/***********************/
+
+
+/***********/
+/* Headers */
+/***********/
+#include "H5private.h"		/* Generic Functions			*/
+#include "H5Eprivate.h"		/* Error handling		  	*/
+#include "H5EApkg.h"		/* Extensible Arrays			*/
+#include "H5MFprivate.h"	/* File memory management		*/
+#include "H5WBprivate.h"        /* Wrapped Buffers                      */
+
+
+/****************/
+/* Local Macros */
+/****************/
+
+/* Fractal heap format version #'s */
+#define H5EA_HDR_VERSION        0               /* Header */
+
+/* Size of stack buffer for serialized headers */
+#define H5EA_HDR_BUF_SIZE       512
+
+
+/******************/
+/* Local Typedefs */
+/******************/
+
+
+/********************/
+/* Package Typedefs */
+/********************/
+
+
+/********************/
+/* Local Prototypes */
+/********************/
+
+/* Metadata cache (H5AC) callbacks */
+static H5EA_hdr_t *H5EA__cache_hdr_load(H5F_t *f, hid_t dxpl_id, haddr_t addr, const void *udata, void *udata2);
+static herr_t H5EA__cache_hdr_flush(H5F_t *f, hid_t dxpl_id, hbool_t destroy, haddr_t addr, H5EA_hdr_t *hdr, unsigned UNUSED * flags_ptr);
+static herr_t H5EA__cache_hdr_clear(H5F_t *f, H5EA_hdr_t *hdr, hbool_t destroy);
+static herr_t H5EA__cache_hdr_size(const H5F_t *f, const H5EA_hdr_t *hdr, size_t *size_ptr);
+
+
+/*********************/
+/* Package Variables */
+/*********************/
+
+/* H5EA header inherits cache-like properties from H5AC */
+const H5AC_class_t H5AC_EARRAY_HDR[1] = {{
+    H5AC_EARRAY_HDR_ID,
+    (H5AC_load_func_t)H5EA__cache_hdr_load,
+    (H5AC_flush_func_t)H5EA__cache_hdr_flush,
+    (H5AC_dest_func_t)H5EA__cache_hdr_dest,
+    (H5AC_clear_func_t)H5EA__cache_hdr_clear,
+    (H5AC_size_func_t)H5EA__cache_hdr_size,
+}};
+
+
+/*****************************/
+/* Library Private Variables */
+/*****************************/
+
+
+/*******************/
+/* Local Variables */
+/*******************/
+
+
+
+/*-------------------------------------------------------------------------
+ * Function:	H5EA_cache_hdr_load
+ *
+ * Purpose:	Loads an extensible array header from the disk.
+ *
+ * Return:	Success:	Pointer to a new extensible array
+ *		Failure:	NULL
+ *
+ * Programmer:	Quincey Koziol
+ *		koziol@hdfgroup.org
+ *		Aug 26 2008
+ *
+ *-------------------------------------------------------------------------
+ */
+BEGIN_FUNC(STATIC, ERR,
+H5EA_hdr_t *, NULL, NULL,
+H5EA__cache_hdr_load(H5F_t *f, hid_t dxpl_id, haddr_t addr, const void UNUSED *udata1, void UNUSED *udata2))
+
+    H5EA_hdr_t		*hdr = NULL;     /* Fractal heap info */
+    size_t		size;           /* Header size */
+    H5WB_t              *wb = NULL;     /* Wrapped buffer for header data */
+    uint8_t             hdr_buf[H5EA_HDR_BUF_SIZE]; /* Buffer for header */
+    uint8_t		*buf;           /* Pointer to header buffer */
+    const uint8_t	*p;             /* Pointer into raw data buffer */
+    uint32_t            stored_chksum;  /* Stored metadata checksum value */
+    uint32_t            computed_chksum; /* Computed metadata checksum value */
+
+    /* Check arguments */
+    HDassert(f);
+    HDassert(H5F_addr_defined(addr));
+
+    /* Allocate space for the extensible array data structure */
+    if(NULL == (hdr = H5EA__hdr_alloc(f)))
+	H5E_THROW(H5E_CANTALLOC, "memory allocation failed for extensible array shared header")
+
+    /* Set the extensible array header's address */
+    hdr->addr = addr;
+
+    /* Wrap the local buffer for serialized header info */
+    if(NULL == (wb = H5WB_wrap(hdr_buf, sizeof(hdr_buf))))
+	H5E_THROW(H5E_CANTINIT, "can't wrap buffer")
+
+    /* Compute the 'base' size of the fractal heap header on disk */
+    size = H5EA_HEADER_SIZE(hdr);
+
+    /* Get a pointer to a buffer that's large enough for serialized header */
+    if(NULL == (buf = (uint8_t *)H5WB_actual(wb, size)))
+	H5E_THROW(H5E_CANTGET, "can't get actual buffer")
+
+    /* Read header from disk */
+    if(H5F_block_read(f, H5FD_MEM_EARRAY_HDR, addr, size, dxpl_id, buf) < 0)
+	H5E_THROW(H5E_READERROR, "can't read extensible array header")
+
+    /* Get temporary pointer to serialized header */
+    p = buf;
+
+    /* Magic number */
+    if(HDmemcmp(p, H5EA_HDR_MAGIC, (size_t)H5EA_SIZEOF_MAGIC))
+	H5E_THROW(H5E_BADVALUE, "wrong extensible array header signature")
+    p += H5EA_SIZEOF_MAGIC;
+
+    /* Version */
+    if(*p++ != H5EA_HDR_VERSION)
+	H5E_THROW(H5E_VERSION, "wrong extensible array header version")
+
+    /* General array information */
+    hdr->elmt_size = *p++;              /* Element size (in bytes) */
+    hdr->idx_blk_elmts = *p++;          /* # of elements to store in index block */
+    hdr->data_blk_min_elmts = *p++;     /* Min. # of elements per data block */
+    hdr->sup_blk_min_data_ptrs = *p++;  /* Min. # of data block pointers for a super block */
+
+    /* Sanity check */
+    /* (allow for checksum not decoded yet) */
+    HDassert((size_t)(p - buf) == (size - H5EA_SIZEOF_CHKSUM));
+
+    /* Set the array header's size */
+    hdr->size = size;
+
+    /* Compute checksum on entire header */
+    /* (including the filter information, if present) */
+    computed_chksum = H5_checksum_metadata(buf, (size_t)(p - buf), 0);
+
+    /* Metadata checksum */
+    UINT32DECODE(p, stored_chksum);
+
+    /* Sanity check */
+    HDassert((size_t)(p - buf) == hdr->size);
+
+    /* Verify checksum */
+    if(stored_chksum != computed_chksum)
+	H5E_THROW(H5E_BADVALUE, "incorrect metadata checksum for extensible array header")
+
+    /* Set return value */
+    ret_value = hdr;
+
+CATCH
+
+    /* Release resources */
+    if(wb && H5WB_unwrap(wb) < 0)
+	H5E_THROW(H5E_CLOSEERROR, "can't close wrapped buffer")
+    if(!ret_value)
+        if(hdr && H5EA__cache_hdr_dest(f, hdr) < 0)
+            H5E_THROW(H5E_CANTFREE, "unable to destroy extensible array header")
+
+END_FUNC(STATIC)   /* end H5EA__cache_hdr_load() */
+
+
+/*-------------------------------------------------------------------------
+ * Function:	H5EA__cache_hdr_flush
+ *
+ * Purpose:	Flushes a dirty extensible array header to disk.
+ *
+ * Return:	Non-negative on success/Negative on failure
+ *
+ * Programmer:	Quincey Koziol
+ *		koziol@hdfgroup.org
+ *		Aug 26 2008
+ *
+ *-------------------------------------------------------------------------
+ */
+BEGIN_FUNC(STATIC, ERR,
+herr_t, SUCCEED, FAIL,
+H5EA__cache_hdr_flush(H5F_t *f, hid_t dxpl_id, hbool_t destroy, haddr_t addr, H5EA_hdr_t *hdr, unsigned UNUSED * flags_ptr))
+
+    H5WB_t *wb = NULL;                  /* Wrapped buffer for header data */
+    uint8_t hdr_buf[H5EA_HDR_BUF_SIZE]; /* Buffer for header */
+
+    /* check arguments */
+    HDassert(f);
+    HDassert(H5F_addr_defined(addr));
+    HDassert(hdr);
+
+    if(hdr->cache_info.is_dirty) {
+        uint8_t	*buf;           /* Temporary raw data buffer */
+        uint8_t *p;             /* Pointer into raw data buffer */
+        size_t	size;           /* Header size on disk */
+        uint32_t metadata_chksum; /* Computed metadata checksum value */
+
+        /* Wrap the local buffer for serialized header info */
+        if(NULL == (wb = H5WB_wrap(hdr_buf, sizeof(hdr_buf))))
+            H5E_THROW(H5E_CANTINIT, "can't wrap buffer")
+
+        /* Compute the size of the heap header on disk */
+        size = hdr->size;
+
+        /* Get a pointer to a buffer that's large enough for serialized header */
+        if(NULL == (buf = (uint8_t *)H5WB_actual(wb, size)))
+            H5E_THROW(H5E_CANTGET, "can't get actual buffer")
+
+        /* Get temporary pointer to serialized header */
+        p = buf;
+
+        /* Magic number */
+        HDmemcpy(p, H5EA_HDR_MAGIC, (size_t)H5EA_SIZEOF_MAGIC);
+        p += H5EA_SIZEOF_MAGIC;
+
+        /* Version # */
+        *p++ = H5EA_HDR_VERSION;
+
+        /* General array information */
+        *p++ = hdr->elmt_size;              /* Element size (in bytes) */
+        *p++ = hdr->idx_blk_elmts;          /* # of elements to store in index block */
+        *p++ = hdr->data_blk_min_elmts;     /* Min. # of elements per data block */
+        *p++ = hdr->sup_blk_min_data_ptrs;  /* Min. # of data block pointers for a super block */
+
+        /* Compute metadata checksum */
+        metadata_chksum = H5_checksum_metadata(buf, (size_t)(p - buf), 0);
+
+        /* Metadata checksum */
+        UINT32ENCODE(p, metadata_chksum);
+
+	/* Write the array header. */
+        HDassert((size_t)(p - buf) == size);
+	if(H5F_block_write(f, H5FD_MEM_EARRAY_HDR, addr, size, dxpl_id, buf) < 0)
+            H5E_THROW(H5E_WRITEERROR, "unable to save extensible array header to disk")
+
+	hdr->cache_info.is_dirty = FALSE;
+    } /* end if */
+
+    if(destroy)
+        if(H5EA__cache_hdr_dest(f, hdr) < 0)
+            H5E_THROW(H5E_CANTFREE, "unable to destroy extensible array header")
+
+CATCH
+
+    /* Release resources */
+    if(wb && H5WB_unwrap(wb) < 0)
+	H5E_THROW(H5E_CLOSEERROR, "can't close wrapped buffer")
+
+END_FUNC(STATIC)   /* end H5EA__cache_hdr_flush() */
+
+
+/*-------------------------------------------------------------------------
+ * Function:	H5EA__cache_hdr_dest
+ *
+ * Purpose:	Destroys a extensible array header in memory.
+ *
+ * Return:	Non-negative on success/Negative on failure
+ *
+ * Programmer:	Quincey Koziol
+ *		koziol@hdfgroup.org
+ *		Aug 26 2008
+ *
+ *-------------------------------------------------------------------------
+ */
+/* ARGSUSED */
+BEGIN_FUNC(PKG, NOERR,
+herr_t, SUCCEED, -,
+H5EA__cache_hdr_dest(H5F_t UNUSED *f, H5EA_hdr_t *hdr))
+
+    /*
+     * Check arguments.
+     */
+    HDassert(hdr);
+    HDassert(hdr->rc == 0);
+
+    /* Free the shared info itself */
+    (void)H5FL_FREE(H5EA_hdr_t, hdr);
+
+END_FUNC(PKG)   /* end H5EA__cache_hdr_dest() */
+
+
+/*-------------------------------------------------------------------------
+ * Function:	H5EA__cache_hdr_clear
+ *
+ * Purpose:	Mark a extensible array header in memory as non-dirty.
+ *
+ * Return:	Non-negative on success/Negative on failure
+ *
+ * Programmer:	Quincey Koziol
+ *		koziol@hdfgroup.org
+ *		Aug 26 2008
+ *
+ *-------------------------------------------------------------------------
+ */
+BEGIN_FUNC(STATIC, ERR,
+herr_t, SUCCEED, FAIL,
+H5EA__cache_hdr_clear(H5F_t *f, H5EA_hdr_t *hdr, hbool_t destroy))
+
+    /*
+     * Check arguments.
+     */
+    HDassert(hdr);
+
+    /* Reset the dirty flag.  */
+    hdr->cache_info.is_dirty = FALSE;
+
+    if(destroy)
+        if(H5EA__cache_hdr_dest(f, hdr) < 0)
+            H5E_THROW(H5E_CANTFREE, "unable to destroy extensible array header")
+
+CATCH
+
+END_FUNC(STATIC)   /* end H5EA__cache_hdr_clear() */
+
+
+/*-------------------------------------------------------------------------
+ * Function:	H5EA__cache_hdr_size
+ *
+ * Purpose:	Compute the size in bytes of a extensible array header
+ *		on disk, and return it in *size_ptr.  On failure,
+ *		the value of *size_ptr is undefined.
+ *
+ * Return:	Non-negative on success/Negative on failure
+ *
+ * Programmer:	Quincey Koziol
+ *		koziol@hdfgroup.org
+ *		Aug 26 2008
+ *
+ *-------------------------------------------------------------------------
+ */
+/* ARGSUSED */
+BEGIN_FUNC(STATIC, NOERR,
+herr_t, SUCCEED, -,
+H5EA__cache_hdr_size(const H5F_t UNUSED *f, const H5EA_hdr_t *hdr, size_t *size_ptr))
+
+    /* check arguments */
+    HDassert(f);
+    HDassert(hdr);
+    HDassert(size_ptr);
+
+    /* Set size value */
+    *size_ptr = hdr->size;
+
+END_FUNC(STATIC)   /* end H5EA__cache_hdr_size() */
+