[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, 321 insertions, 0 deletions

diff --git a/src/H5FAdbg.c b/src/H5FAdbg.c
new file mode 100644
index 0000000..b882c04
--- /dev/null
+++ b/src/H5FAdbg.c
@@ -0,0 +1,321 @@
+/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
+ * 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:		H5FAdbg.c
+ *
+ * Purpose:		Dump debugging information about a fixed array.
+ *
+ *-------------------------------------------------------------------------
+ */
+
+/**********************/
+/* 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 "H5Oprivate.h"		/* Object Header 			*/
+#include "H5Vprivate.h"         /* Vector functions                     */
+
+
+/****************/
+/* Local Macros */
+/****************/
+
+
+/******************/
+/* Local Typedefs */
+/******************/
+
+/* Fixed array create/open user data */
+typedef struct ctx_ud_t {
+    const H5F_t *f;             /* Pointer to file info */
+    const H5O_layout_t *layout; /* Pointer to layout info */
+} ctx_ud_t;
+
+
+/********************/
+/* Package Typedefs */
+/********************/
+
+
+/********************/
+/* Local Prototypes */
+/********************/
+
+
+/*********************/
+/* Package Variables */
+/*********************/
+
+
+/*****************************/
+/* Library Private Variables */
+/*****************************/
+
+
+/*******************/
+/* Local Variables */
+/*******************/
+
+
+
+/*-------------------------------------------------------------------------
+ * Function:	H5FA__hdr_debug
+ *
+ * Purpose:	Prints debugging info about a fixed array header.
+ *
+ * Return:	Non-negative on success/Negative on failure
+ *
+ * Programmer:	Vailin Choi
+ *              Thursday, April 30, 2009
+ *
+ *-------------------------------------------------------------------------
+ */
+BEGIN_FUNC(PKG, ERR,
+herr_t, SUCCEED, FAIL,
+H5FA__hdr_debug(H5F_t *f, hid_t dxpl_id, haddr_t addr, FILE *stream, int indent,
+    int fwidth, const H5FA_class_t *cls, haddr_t obj_addr))
+
+    /* Local variables */
+    H5FA_hdr_t *hdr = NULL; 	/* Shared fixed array header */
+    H5O_loc_t obj_loc;		/* Pointer to an object's location */
+    H5O_layout_t layout;	/* Layout message */
+    ctx_ud_t udata;		/* User data */
+
+    /* Check arguments */
+    HDassert(f);
+    HDassert(H5F_addr_defined(addr));
+    HDassert(H5F_addr_defined(obj_addr));
+    HDassert(stream);
+    HDassert(indent >= 0);
+    HDassert(fwidth >= 0);
+    HDassert(cls);
+
+    H5O_loc_reset(&obj_loc);
+    obj_loc.file = f;
+    obj_loc.addr = obj_addr;
+
+    /* Open the object header where the layout message resides */
+    if(H5O_open(&obj_loc) < 0)
+	H5E_THROW(H5E_CANTPROTECT, "unable to open object header")
+
+    /* Read the layout message */
+    if(NULL == H5O_msg_read(&obj_loc, H5O_LAYOUT_ID, &layout, dxpl_id))
+	H5E_THROW(H5E_CANTPROTECT, "unable to read layout message")
+
+    /* close the object header */
+    if(H5O_close(&obj_loc) < 0)
+	H5E_THROW(H5E_CANTPROTECT, "unable to close object header")
+
+    /* Create user data */
+    udata.f = f;
+    udata.layout = &layout;
+
+    /* Load the fixed array header */
+    if(NULL == (hdr = (H5FA_hdr_t *)H5AC_protect(f, dxpl_id, H5AC_FARRAY_HDR, addr, cls, &udata, H5AC_READ)))
+	H5E_THROW(H5E_CANTPROTECT, "unable to load fixed array header")
+
+    /* Print opening message */
+    HDfprintf(stream, "%*sFixed Array Header...\n", indent, "");
+
+    /* Print the values */
+    HDfprintf(stream, "%*s%-*s %s\n", indent, "", fwidth,
+	      "Array class ID:", hdr->cparam.cls->name);
+    HDfprintf(stream, "%*s%-*s %Zu\n", indent, "", fwidth,
+	      "Header size:",
+	      hdr->size);
+    HDfprintf(stream, "%*s%-*s %u\n", indent, "", fwidth,
+	      "Raw Element Size:",
+	      (unsigned)hdr->cparam.raw_elmt_size);
+    HDfprintf(stream, "%*s%-*s %Zu\n", indent, "", fwidth,
+	      "Native Element Size (on this platform):",
+	      hdr->cparam.cls->nat_elmt_size);
+
+
+    HDfprintf(stream, "%*s%-*s %u\n", indent, "", fwidth,
+	      "Max. # of elements in data block page:",
+	      (unsigned)((size_t)1 << hdr->cparam.max_dblk_page_nelmts_bits));
+
+    HDfprintf(stream, "%*s%-*s %Hu\n", indent, "", fwidth,
+	      "Number of elements in Fixed Array:", hdr->stats.nelmts);
+
+    HDfprintf(stream, "%*s%-*s %a\n", indent, "", fwidth,
+	      "Fixed Array Data Block Address:", hdr->dblk_addr);
+
+CATCH
+    if(hdr && H5AC_unprotect(f, dxpl_id, H5AC_FARRAY_HDR, addr, hdr, H5AC__NO_FLAGS_SET) < 0)
+	H5E_THROW(H5E_CANTUNPROTECT, "unable to release fixed array header")
+
+END_FUNC(PKG)   /* end H5FA__hdr_debug() */
+
+
+
+/*-------------------------------------------------------------------------
+ * Function:	H5FA__dblock_debug
+ *
+ * Purpose:	Prints debugging info about a 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_debug(H5F_t *f, hid_t dxpl_id, haddr_t addr, FILE *stream, int indent,
+    int fwidth, const H5FA_class_t *cls, haddr_t hdr_addr, haddr_t obj_addr))
+
+    /* Local variables */
+    H5FA_hdr_t *hdr = NULL;             /* Shared fixed array header */
+    H5FA_dblock_t *dblock = NULL;       /* Fixed array data block */
+    size_t u;                           /* Local index variable */
+    H5O_loc_t obj_loc;		/* Pointer to an object's location */
+    H5O_layout_t layout;	/* Layout message */
+    ctx_ud_t udata;		/* User data */
+
+    /* Check arguments */
+    HDassert(f);
+    HDassert(H5F_addr_defined(addr));
+    HDassert(stream);
+    HDassert(indent >= 0);
+    HDassert(fwidth >= 0);
+    HDassert(cls);
+    HDassert(H5F_addr_defined(hdr_addr));
+    HDassert(H5F_addr_defined(obj_addr));
+
+    H5O_loc_reset(&obj_loc);
+    obj_loc.file = f;
+    obj_loc.addr = obj_addr;
+
+    /* Open the object header where the layout message resides */
+    if(H5O_open(&obj_loc) < 0)
+	H5E_THROW(H5E_CANTPROTECT, "unable to open object header")
+
+    /* Read the layout message */
+    if(NULL == H5O_msg_read(&obj_loc, H5O_LAYOUT_ID, &layout, dxpl_id))
+        H5E_THROW(H5E_CANTPROTECT, "unable to read layout message")
+
+    /* close the object header */
+    if(H5O_close(&obj_loc) < 0)
+	H5E_THROW(H5E_CANTPROTECT, "unable to close object header")
+
+    /* Create user data */
+    udata.f = f;
+    udata.layout = &layout;
+
+    /* Load the fixed array header */
+    if(NULL == (hdr = (H5FA_hdr_t *)H5AC_protect(f, dxpl_id, H5AC_FARRAY_HDR, hdr_addr, cls, &udata, H5AC_READ)))
+	H5E_THROW(H5E_CANTPROTECT, "unable to load fixed array header")
+
+    /* Protect data block */
+    if(NULL == (dblock = H5FA__dblock_protect(hdr, dxpl_id, addr, hdr->cparam.nelmts, H5AC_READ)))
+        H5E_THROW(H5E_CANTPROTECT, "unable to protect fixed array data block, address = %llu", (unsigned long long)addr)
+
+    /* Print opening message */
+    HDfprintf(stream, "%*sFixed Array data Block...\n", indent, "");
+
+
+    /* Print the values */
+    HDfprintf(stream, "%*s%-*s %s\n", indent, "", fwidth,
+	      "Array class ID:", hdr->cparam.cls->name);
+    HDfprintf(stream, "%*s%-*s %a\n", indent, "", fwidth, "Address of Data Block:", dblock->addr);
+    HDfprintf(stream, "%*s%-*s %Zu\n", indent, "", fwidth, "Data Block size:", dblock->size);
+    HDfprintf(stream, "%*s%-*s %Hu\n", indent, "", fwidth,
+	      "Number of elements in Data Block:", hdr->cparam.nelmts);
+    HDfprintf(stream, "%*s%-*s %Hu\n", indent, "", fwidth,
+	      "Number of pages in Data Block:", dblock->npages);
+    HDfprintf(stream, "%*s%-*s %Hu\n", indent, "", fwidth,
+	      "Number of elements per Data Block page:", dblock->dblk_page_nelmts);
+
+    if(dblock->npages) { /* paging */
+        size_t  dblk_page_nelmts;	/* # of elements in a data block page */
+        haddr_t dblk_page_addr;     /* Address of a data block page */
+        size_t  page_idx;           /* Page index within data block */
+
+	HDfprintf(stream, "%*sPaging:\n", indent, "");
+
+	/* Iterate over the pages */
+	dblk_page_addr = dblock->addr + H5FA_DBLOCK_PREFIX_SIZE(dblock);
+	dblk_page_nelmts = dblock->dblk_page_nelmts;
+
+	/* Read and print each page's elements in the data block */
+	for(page_idx = 0; page_idx < dblock->npages; page_idx++) {
+	    if(!H5V_bit_get(dblock->dblk_page_init, page_idx)) {
+		HDfprintf(stream, "%*s%-*s %Hu %s\n", indent, "", fwidth,
+		    "Page %Zu:", page_idx, "empty");
+
+	    } /* end if */
+            else { /* get the page */
+                H5FA_dblk_page_t *dblk_page;    /* Pointer to a data block page */
+                hsize_t  nelmts_left;	        /* Remaining elements in the last data block page */
+
+                /* Check for last page */
+		if(((page_idx + 1) == dblock->npages) && (nelmts_left = hdr->cparam.nelmts % dblock->dblk_page_nelmts))
+		    dblk_page_nelmts = (size_t)nelmts_left;
+
+		if(NULL == (dblk_page = H5FA__dblk_page_protect(hdr, dxpl_id, dblk_page_addr, dblk_page_nelmts, H5AC_READ)))
+		    H5E_THROW(H5E_CANTPROTECT, "unable to protect fixed array data block page, address = %llu", (unsigned long long)dblk_page_addr)
+
+		HDfprintf(stream, "%*sElements in page %Zu:\n", indent, "", page_idx);
+		for(u = 0; u < dblk_page_nelmts; u++) {
+		    /* Call the class's 'debug' callback */
+		    if((hdr->cparam.cls->debug)(stream, (indent + 3), MAX(0, (fwidth - 3)), (hsize_t)u,
+			    ((uint8_t *)dblk_page->elmts) + (hdr->cparam.cls->nat_elmt_size * u)) < 0)
+			H5E_THROW(H5E_CANTGET, "can't get element for debugging")
+		} /* end for */
+		if(H5FA__dblk_page_unprotect(dblk_page, dxpl_id, H5AC__NO_FLAGS_SET) < 0)
+		    H5E_THROW(H5E_CANTUNPROTECT, "unable to release fixed array data block page")
+
+		/* Advance to next page address */
+		dblk_page_addr += dblock->dblk_page_size;
+	    } /* paging */
+	} /* end for npages */
+    } /* end if */
+    else { /* not paging */
+	/* Print the elements in the data block */
+	HDfprintf(stream, "%*sElements:\n", indent, "");
+	for(u = 0; u < hdr->cparam.nelmts; u++) {
+	    /* Call the class's 'debug' callback */
+	    if((hdr->cparam.cls->debug)(stream, (indent + 3), MAX(0, (fwidth - 3)), (hsize_t)u,
+		    ((uint8_t *)dblock->elmts) + (hdr->cparam.cls->nat_elmt_size * u)) < 0)
+		H5E_THROW(H5E_CANTGET, "can't get element for debugging")
+	} /* end for */
+    } /* end else */
+
+CATCH
+    if(dblock && H5FA__dblock_unprotect(dblock, dxpl_id, H5AC__NO_FLAGS_SET) < 0)
+        H5E_THROW(H5E_CANTUNPROTECT, "unable to release fixed array data block")
+    if(hdr && H5AC_unprotect(f, dxpl_id, H5AC_FARRAY_HDR, hdr_addr, hdr, H5AC__NO_FLAGS_SET) < 0)
+	H5E_THROW(H5E_CANTUNPROTECT, "unable to release fixed array header")
+
+END_FUNC(PKG)   /* end H5FA__dblock_debug() */
+