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

diff --git a/src/H5FAprivate.h b/src/H5FAprivate.h
new file mode 100644
index 0000000..2450218
--- /dev/null
+++ b/src/H5FAprivate.h
@@ -0,0 +1,132 @@
+/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
+ * 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:		H5FAprivate.h
+ *
+ * Purpose:		Private header for library accessible Fixed
+ *                      Array routines.
+ *
+ *-------------------------------------------------------------------------
+ */
+
+#ifndef _H5FAprivate_H
+#define _H5FAprivate_H
+
+/* Include package's public header */
+#ifdef NOT_YET
+#include "H5FApublic.h"
+#endif /* NOT_YET */
+
+/* Private headers needed by this file */
+#include "H5Fprivate.h"		/* File access				*/
+
+
+/**************************/
+/* Library Private Macros */
+/**************************/
+
+
+/****************************/
+/* Library Private Typedefs */
+/****************************/
+
+/* Fixed Array class IDs */
+typedef enum H5FA_cls_id_t {
+    H5FA_CLS_CHUNK_ID = 0,      /* Fixed array is for indexing dataset chunks w/o filters */
+    H5FA_CLS_FILT_CHUNK_ID,     /* Fixed array is for indexing dataset chunks w/filters */
+
+    /* (keep these last) */
+    H5FA_CLS_TEST_ID,	        /* Fixed array is for testing (do not use for actual data) */
+    H5FA_NUM_CLS_ID             /* Number of Fixed Array class IDs (must be last) */
+} H5FA_cls_id_t;
+
+/*
+ * Each type of element that can be stored in a Fixed Array has a
+ * variable of this type that contains class variables and methods.
+ */
+typedef struct H5FA_class_t {
+    H5FA_cls_id_t id;           /* ID of Fixed Array class, as found in file */
+    const char *name;           /* Name of class (for debugging) */
+    size_t nat_elmt_size;       /* Size of native (memory) element */
+
+    /* Fixed array client callback methods */
+    void *(*crt_context)(void *udata);          /* Create context for other callbacks */
+    herr_t (*dst_context)(void *ctx);           /* Destroy context */
+    herr_t (*fill)(void *nat_blk, size_t nelmts);    /* Fill array of elements with encoded form of "missing element" value */
+    herr_t (*encode)(void *raw, const void *elmt, size_t nelmts, void *ctx);   /* Encode elements from native form to disk storage form */
+    herr_t (*decode)(const void *raw, void *elmt, size_t nelmts, void *ctx);   /* Decode elements from disk storage form to native form */
+    herr_t (*debug)(FILE *stream, int indent, int fwidth, hsize_t idx, const void *elmt); /* Print an element for debugging */
+} H5FA_class_t;
+
+/* Fixed array creation parameters */
+typedef struct H5FA_create_t {
+    const H5FA_class_t *cls;            /* Class of Fixed Array to create */
+    uint8_t raw_elmt_size;              /* Element size in file (in bytes) */
+    uint8_t max_dblk_page_nelmts_bits;  /* Log2(Max. # of elements in a data block page) - 
+					   i.e. # of bits needed to store max. # of elements 
+					   in a data block page */
+    hsize_t nelmts; 			/* # of elements in array */
+} H5FA_create_t;
+
+/* Fixed array metadata statistics info */
+typedef struct H5FA_stat_t {
+    /* Non-stored (i.e. computed) fields */
+    hsize_t hdr_size;           /* Size of header */
+    hsize_t dblk_size;          /* Size of data block */
+
+    /* Stored fields */
+    hsize_t nelmts;             /* # of elements */
+} H5FA_stat_t;
+
+/* Fixed Array info (forward decl - defined in H5FApkg.h) */
+typedef struct H5FA_t H5FA_t;
+
+/* Define the operator callback function pointer for H5FA_iterate() */
+typedef int (*H5FA_operator_t)(hsize_t idx, const void *_elmt, void *_udata);
+
+
+/*****************************/
+/* Library-private Variables */
+/*****************************/
+
+
+/***************************************/
+/* Library-private Function Prototypes */
+/***************************************/
+
+/* General routines */
+H5_DLL H5FA_t *H5FA_create(H5F_t *f, hid_t dxpl_id, const H5FA_create_t *cparam,
+    void *ctx_udata);
+H5_DLL H5FA_t *H5FA_open(H5F_t *f, hid_t dxpl_id, haddr_t ea_addr, const H5FA_class_t *cls, 
+    void *ctx_udata);
+H5_DLL herr_t H5FA_get_nelmts(const H5FA_t *ea, hsize_t *nelmts);
+H5_DLL herr_t H5FA_get_addr(const H5FA_t *ea, haddr_t *addr);
+H5_DLL herr_t H5FA_set(const H5FA_t *ea, hid_t dxpl_id, hsize_t idx, const void *elmt);
+H5_DLL herr_t H5FA_get(const H5FA_t *ea, hid_t dxpl_id, hsize_t idx, void *elmt);
+H5_DLL herr_t H5FA_close(H5FA_t *ea, hid_t dxpl_id);
+H5_DLL herr_t H5FA_delete(H5F_t *f, hid_t dxpl_id, haddr_t ea_addr);
+H5_DLL herr_t H5FA_iterate(H5FA_t *fa, hid_t dxpl_id, H5FA_operator_t op, void *udata);
+
+/* Statistics routines */
+H5_DLL herr_t H5FA_get_stats(const H5FA_t *ea, H5FA_stat_t *stats);
+
+/* Debugging routines */
+#ifdef H5FA_DEBUGGING
+#endif /* H5FA_DEBUGGING */
+
+#endif /* _H5FAprivate_H */
+