[svn-r17155] Description:

	Bring r17154 from 'revise_chunks' branch to trunk:

	Add fixed array data structure.  (For initial use as a chunk index)

Tested on:
        FreeBSD/32 6.3 (duty) in debug mode
        FreeBSD/64 6.3 (liberty) w/C++ & FORTRAN, in debug mode
        Linux/32 2.6 (jam) 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 debug mode
        Linux/64-amd64 2.6 (abe) w/parallel, w/FORTRAN, in production mode
        Mac OS X/32 10.5.7 (amazon) in debug mode
        Mac OS X/32 10.5.7 (amazon) w/C++ & FORTRAN, w/threadsafe,
                                in production mode

1 files changed, 442 insertions, 0 deletions

diff --git a/src/H5FAdblock.c b/src/H5FAdblock.c
new file mode 100644
index 0000000..f564fee
--- /dev/null
+++ b/src/H5FAdblock.c
@@ -0,0 +1,442 @@
+/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
+ * 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:		H5FAdblock.c
+ *
+ * Purpose:		Data block routines for fixed arrays.
+ *
+ *-------------------------------------------------------------------------
+ */
+
+/**********************/
+/* Module Declaration */
+/**********************/
+
+#define H5FA_MODULE
+
+
+/***********************/
+/* Other Packages Used */
+/***********************/
+
+
+/***********/
+/* Headers */
+/***********/
+#include "H5private.h"		/* Generic Functions			*/
+#include "H5Eprivate.h"		/* Error handling		  	*/
+#include "H5FApkg.h"		/* Fixed Arrays				*/
+#include "H5FLprivate.h"	/* Free Lists                           */
+#include "H5MFprivate.h"	/* File memory management		*/
+
+
+/****************/
+/* Local Macros */
+/****************/
+
+
+/******************/
+/* Local Typedefs */
+/******************/
+
+
+/********************/
+/* Package Typedefs */
+/********************/
+
+
+/********************/
+/* Local Prototypes */
+/********************/
+
+
+/*********************/
+/* Package Variables */
+/*********************/
+
+
+/*****************************/
+/* Library Private Variables */
+/*****************************/
+
+
+/*******************/
+/* Local Variables */
+/*******************/
+
+/* Declare a free list to manage the H5FA_dblock_t struct */
+H5FL_DEFINE_STATIC(H5FA_dblock_t);
+
+/* Declare a free list to manage the chunk elements */
+H5FL_BLK_DEFINE(chunk_elmts);
+
+/* Declare a free list to manage blocks of 'page init' bitmasks */
+H5FL_BLK_DEFINE(fa_page_init);
+
+
+/*-------------------------------------------------------------------------
+ * Function:	H5FA__dblock_alloc
+ *
+ * Purpose:	Allocate fixed array data block
+ *
+ * Return:	Non-NULL pointer to data block on success/NULL on failure
+ *
+ * Programmer:	Vailin Choi
+ *              Thursday, April 30, 2009
+ *
+ *-------------------------------------------------------------------------
+ */
+BEGIN_FUNC(PKG, ERR,
+H5FA_dblock_t *, NULL, NULL,
+H5FA__dblock_alloc(H5FA_hdr_t *hdr, hsize_t nelmts))
+
+    /* Local variables */
+    H5FA_dblock_t *dblock = NULL;          /* fixed array data block */
+
+    /* Check arguments */
+    HDassert(hdr);
+    HDassert(nelmts > 0);
+
+    /* 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")
+
+    /* Share common array information */
+    if(H5FA__hdr_incr(hdr) < 0)
+	H5E_THROW(H5E_CANTINC, "can't increment reference count on shared array header")
+    dblock->hdr = hdr;
+
+    /* Set non-zero internal fields */
+    dblock->dblk_page_nelmts = (size_t)1 << hdr->cparam.max_dblk_page_nelmts_bits;
+
+    /* Check if this data block should be paged */
+    if(nelmts > dblock->dblk_page_nelmts) {
+        /* Compute number of pages */
+        hsize_t npages = ((nelmts + dblock->dblk_page_nelmts) - 1) / dblock->dblk_page_nelmts;
+
+        /* Safely assign the number of pages */
+        H5_ASSIGN_OVERFLOW(/* To: */ dblock->npages, /* From: */ npages, /* From: */ hsize_t, /* To: */ size_t);
+
+	/* Sanity check that we have at least 1 page */
+	HDassert(dblock->npages > 0);
+
+        /* Compute size of 'page init' flag array, in bytes */
+	dblock->dblk_page_init_size = (dblock->npages + 7) / 8;
+	HDassert(dblock->dblk_page_init_size > 0);
+
+	/* 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")
+
+	/* Compute data block page size */
+	dblock->dblk_page_size = (dblock->dblk_page_nelmts * hdr->cparam.raw_elmt_size) + H5FA_SIZEOF_CHKSUM;
+
+        /* Compute the # of elements on last page */
+        if(0 == nelmts % dblock->dblk_page_nelmts)
+            dblock->last_page_nelmts = dblock->dblk_page_nelmts;
+        else
+            dblock->last_page_nelmts = (size_t)(nelmts % dblock->dblk_page_nelmts);
+    } /* end if */
+    else {
+        hsize_t dblk_size = hdr->cparam.nelmts * hdr->cparam.cls->nat_elmt_size;
+
+        /* 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")
+    } /* end else */
+
+    /* Set the return value */
+    ret_value = dblock;
+
+CATCH
+
+    if(!ret_value)
+        if(dblock && H5FA__dblock_dest(hdr->f, dblock) < 0)
+            H5E_THROW(H5E_CANTFREE, "unable to destroy fixed array data block")
+
+END_FUNC(PKG)   /* end H5FA__dblock_alloc() */
+
+
+/*-------------------------------------------------------------------------
+ * Function:	H5FA__dblock_create
+ *
+ * Purpose:	Creates a fixed array data block in the file
+ *
+ * Return:	Valid file address on success/HADDR_UNDEF on failure
+ *
+ * Programmer:	Vailin Choi
+ *              Thursday, April 30, 2009
+ *
+ *-------------------------------------------------------------------------
+ */
+BEGIN_FUNC(PKG, ERR,
+haddr_t, HADDR_UNDEF, HADDR_UNDEF,
+H5FA__dblock_create(H5FA_hdr_t *hdr, hid_t dxpl_id, hbool_t *hdr_dirty,
+    hsize_t nelmts))
+
+    /* Local variables */
+    H5FA_dblock_t *dblock = NULL;       /* fixed array data block */
+    haddr_t dblock_addr;                /* fixed array data block address */
+
+#ifdef H5FA_DEBUG
+HDfprintf(stderr, "%s: Called, hdr->stats.nelmts = %Zu, nelmts = %Zu\n", FUNC, hdr->stats.nelmts, nelmts);
+#endif /* H5FA_DEBUG */
+
+    /* Sanity check */
+    HDassert(hdr);
+    HDassert(hdr_dirty);
+    HDassert(nelmts > 0);
+
+    /* Allocate the data block */
+    if(NULL == (dblock = H5FA__dblock_alloc(hdr, nelmts)))
+	H5E_THROW(H5E_CANTALLOC, "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);
+#ifdef H5FA_DEBUG
+HDfprintf(stderr, "%s: dblock->size = %Zu\n", FUNC, dblock->size);
+#endif /* H5FA_DEBUG */
+
+
+    /* Allocate space for the data block on disk */
+    if(HADDR_UNDEF == (dblock_addr = H5MF_alloc(hdr->f, H5FD_MEM_FARRAY_DBLOCK, dxpl_id, (hsize_t)dblock->size)))
+	H5E_THROW(H5E_CANTALLOC, "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")
+
+    /* Cache the new fixed array data block */
+    if(H5AC_set(hdr->f, dxpl_id, H5AC_FARRAY_DBLOCK, dblock_addr, dblock, H5AC__NO_FLAGS_SET) < 0)
+	H5E_THROW(H5E_CANTINSERT, "can't add fixed array data block to cache")
+
+    /* Mark the header dirty (for updating statistics) */
+    *hdr_dirty = TRUE;
+
+    /* Set address of data block to return */
+    ret_value = dblock_addr;
+
+CATCH
+
+    if(!H5F_addr_defined(ret_value))
+        if(dblock) {
+            /* Release data block's disk space */
+            if(H5F_addr_defined(dblock->addr) && H5MF_xfree(hdr->f, H5FD_MEM_FARRAY_DBLOCK, dxpl_id, dblock->addr, (hsize_t)dblock->size) < 0)
+                H5E_THROW(H5E_CANTFREE, "unable to release fixed array data block")
+
+            /* Destroy data block */
+            if(H5FA__dblock_dest(hdr->f, dblock) < 0)
+                H5E_THROW(H5E_CANTFREE, "unable to destroy fixed array data block")
+        } /* end if */
+
+END_FUNC(PKG)   /* end H5FA__dblock_create() */
+
+
+/*-------------------------------------------------------------------------
+ * Function:	H5FA__dblock_protect
+ *
+ * Purpose:	Convenience wrapper around protecting fixed array data block
+ *
+ * Return:	Non-NULL pointer to data block on success/NULL on failure
+ *
+ * Programmer:	Vailin Choi
+ *              Thursday, April 30, 2009
+ *
+ *-------------------------------------------------------------------------
+ */
+BEGIN_FUNC(PKG, ERR,
+H5FA_dblock_t *, NULL, NULL,
+H5FA__dblock_protect(H5FA_hdr_t *hdr, hid_t dxpl_id, haddr_t dblk_addr,
+    hsize_t dblk_nelmts, H5AC_protect_t rw))
+
+    /* Local variables */
+
+#ifdef H5FA_DEBUG
+HDfprintf(stderr, "%s: Called\n", FUNC);
+#endif /* H5FA_DEBUG */
+
+    /* Sanity check */
+    HDassert(hdr);
+    HDassert(H5F_addr_defined(dblk_addr));
+    HDassert(dblk_nelmts);
+
+    /* Protect the data block */
+    if(NULL == (ret_value = (H5FA_dblock_t *)H5AC_protect(hdr->f, dxpl_id, H5AC_FARRAY_DBLOCK, dblk_addr, &dblk_nelmts, hdr, rw)))
+        H5E_THROW(H5E_CANTPROTECT, "unable to protect fixed array data block, address = %llu", (unsigned long long)dblk_addr)
+
+CATCH
+
+END_FUNC(PKG)   /* end H5FA__dblock_protect() */
+
+
+/*-------------------------------------------------------------------------
+ * Function:	H5FA__dblock_unprotect
+ *
+ * Purpose:	Convenience wrapper around unprotecting fixed array data block
+ *
+ * Return:	Non-negative on success/Negative on failure
+ *
+ * Programmer:	Vailin Choi
+ *              Thursday, April 30, 2009
+ *
+ *-------------------------------------------------------------------------
+ */
+BEGIN_FUNC(PKG, ERR,
+herr_t, SUCCEED, FAIL,
+H5FA__dblock_unprotect(H5FA_dblock_t *dblock, hid_t dxpl_id, unsigned cache_flags))
+
+    /* Local variables */
+
+#ifdef H5FA_DEBUG
+HDfprintf(stderr, "%s: Called\n", FUNC);
+#endif /* H5FA_DEBUG */
+
+    /* Sanity check */
+    HDassert(dblock);
+
+    /* Unprotect the data block */
+    if(H5AC_unprotect(dblock->hdr->f, dxpl_id, 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
+
+END_FUNC(PKG)   /* end H5FA__dblock_unprotect() */
+
+
+/*-------------------------------------------------------------------------
+ * Function:	H5FA__dblock_delete
+ *
+ * Purpose:	Delete a data block
+ *
+ * Return:	SUCCEED/FAIL
+ *
+ * Programmer:	Vailin Choi
+ *              Thursday, April 30, 2009
+ *
+ *-------------------------------------------------------------------------
+ */
+BEGIN_FUNC(PKG, ERR,
+herr_t, SUCCEED, FAIL,
+H5FA__dblock_delete(H5FA_hdr_t *hdr, hid_t dxpl_id, haddr_t dblk_addr,
+    hsize_t dblk_nelmts))
+
+    /* Local variables */
+    H5FA_dblock_t *dblock = NULL;       /* Pointer to data block */
+
+#ifdef H5FA_DEBUG
+HDfprintf(stderr, "%s: Called\n", FUNC);
+#endif /* H5FA_DEBUG */
+
+    /* Sanity check */
+    HDassert(hdr);
+    HDassert(H5F_addr_defined(dblk_addr));
+    HDassert(dblk_nelmts > 0);
+
+    /* Protect data block */
+    if(NULL == (dblock = H5FA__dblock_protect(hdr, dxpl_id, dblk_addr, dblk_nelmts, H5AC_WRITE)))
+        H5E_THROW(H5E_CANTPROTECT, "unable to protect fixed array data block, address = %llu", (unsigned long long)dblk_addr)
+
+    /* Check if data block is paged */
+    if(dblock->npages) {
+        haddr_t dblk_page_addr;         /* Address of each data block page */
+        size_t u;                       /* Local index variable */
+
+        /* Set up initial state */
+        dblk_page_addr = dblk_addr + H5FA_DBLOCK_PREFIX_SIZE(dblock);
+
+        /* Iterate over pages in data block */
+        for(u = 0; u < dblock->npages; u++) {
+#ifdef H5FA_DEBUG
+HDfprintf(stderr, "%s: Expunging data block page from cache\n", FUNC);
+#endif /* H5FA_DEBUG */
+            /* 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, dxpl_id, 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")
+#ifdef H5FA_DEBUG
+HDfprintf(stderr, "%s: Done expunging data block page from cache\n", FUNC);
+#endif /* H5FA_DEBUG */
+
+            /* Advance to next page address */
+            dblk_page_addr += dblock->dblk_page_size;
+        } /* end for */
+    } /* end if */
+
+CATCH
+
+    /* Finished deleting data block in metadata cache */
+    if(dblock && H5FA__dblock_unprotect(dblock, dxpl_id, H5AC__DIRTIED_FLAG | H5AC__DELETED_FLAG | H5AC__FREE_FILE_SPACE_FLAG) < 0)
+        H5E_THROW(H5E_CANTUNPROTECT, "unable to release fixed array data block")
+
+END_FUNC(PKG)   /* end H5FA__dblock_delete() */
+
+
+/*-------------------------------------------------------------------------
+ * Function:	H5FA__dblock_dest
+ *
+ * Purpose:	Destroys a fixed array data block in memory.
+ *
+ * Return:	Non-negative on success/Negative on failure
+ *
+ * Programmer:	Vailin Choi
+ *              Thursday, April 30, 2009
+ *
+ *-------------------------------------------------------------------------
+ */
+/* ARGSUSED */
+BEGIN_FUNC(PKG, ERR,
+herr_t, SUCCEED, FAIL,
+H5FA__dblock_dest(H5F_t UNUSED *f, H5FA_dblock_t *dblock))
+
+    /* Sanity check */
+    HDassert(dblock);
+
+    /* Check if shared header field has been initialized */
+    if(dblock->hdr) {
+        /* Check if we've got elements in the data block */
+        if(dblock->elmts && !dblock->npages) {
+            /* Free buffer for data block elements */
+            HDassert(dblock->hdr->cparam.nelmts > 0);
+	    (void) H5FL_BLK_FREE(chunk_elmts, dblock->elmts);
+            dblock->elmts = NULL;
+        } /* end if */
+
+        /* Check if data block is paged */
+	if(dblock->npages) {
+	    /* Free buffer for 'page init' bitmask, if there is one */
+	    HDassert(dblock->dblk_page_init_size > 0);
+	    if(dblock->dblk_page_init)
+		dblock->dblk_page_init = H5FL_BLK_FREE(fa_page_init, dblock->dblk_page_init);
+	} /* end if */
+
+        /* 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")
+        dblock->hdr = NULL;
+    } /* end if */
+
+    /* Free the data block itself */
+    (void)H5FL_FREE(H5FA_dblock_t, dblock);
+
+CATCH
+
+END_FUNC(PKG)   /* end H5FA__dblock_dest() */
+