[svn-r2652] Purpose:

    Maintainance & performance enhancements
Description:
    Re-arranged header files to protect private symbols better.

    Changed optimized regular hyperslab I/O to compute the offsets more
    efficiently from previous method of using matrix operations.

    Added sequential I/O operations at a more abstract level (at the same level
    as H5F_arr_read/write), to support the optimized hyperslab I/O.

Platforms tested:
    Solaris 2.6 (baldric) & FreeBSD 4.1.1 (hawkwind)

1 files changed, 234 insertions, 0 deletions

diff --git a/src/H5Spkg.h b/src/H5Spkg.h
new file mode 100644
index 0000000..a517378
--- /dev/null
+++ b/src/H5Spkg.h
@@ -0,0 +1,234 @@
+/*
+ * Copyright (C) 2000 NCSA
+ *		      All rights reserved.
+ *
+ * Programmer:	Quincey Koziol <koziol@ncsa.uiuc.edu>
+ *		Thursday, September 28, 2000
+ *
+ * Purpose:	This file contains declarations which are visible only within
+ *		the H5S package.  Source files outside the H5S package should
+ *		include H5Sprivate.h instead.
+ */
+#ifndef H5S_PACKAGE
+#error "Do not include this file outside the H5S package!"
+#endif
+
+#ifndef _H5Spkg_H
+#define _H5Spkg_H
+
+#include <H5Sprivate.h>
+
+/* 
+ * Dataspace extent information
+ */
+/* Simple extent container */
+typedef struct H5S_simple_t {
+    intn rank;          /* Number of dimensions */
+    hsize_t *size;      /* Current size of the dimensions */
+    hsize_t *max;       /* Maximum size of the dimensions */
+#ifdef LATER
+    hsize_t *perm;      /* Dimension permutation array */
+#endif /* LATER */
+} H5S_simple_t;
+
+/* Extent container */
+typedef struct {
+    H5S_class_t	type;		    /* Type of extent */
+    union {
+        H5S_simple_t	simple;	/* Simple dimensionality information  */
+    } u;
+} H5S_extent_t;
+
+/* 
+ * Dataspace selection information
+ */
+/* Node in point selection list (typedef'd in H5Sprivate.h) */
+struct H5S_pnt_node_t {
+    hssize_t *pnt;          /* Pointer to a selected point */
+    struct H5S_pnt_node_t *next;  /* pointer to next point in list */
+};
+
+/* Information about point selection list */
+typedef struct {
+    H5S_pnt_node_t *head;   /* Pointer to head of point list */
+} H5S_pnt_list_t;
+
+/* Node in hyperslab selection list */
+typedef struct H5S_hyper_node_tag {
+    hssize_t *start;    /* Pointer to a corner of a hyperslab closest to the origin */
+    hssize_t *end;      /* Pointer to a corner of a hyperslab furthest from the origin */
+    struct {
+        uintn cached;   /* Flag to indicate that the block is cached (during I/O only) */
+        size_t size;    /* Size of cached block (in elements) */
+        uintn rleft;    /* Read elements left to access in block */
+        uintn wleft;    /* Write elements left to access in block */
+        uint8_t *block; /* Pointer into buffer for cache */
+        uint8_t *rpos;  /* Pointer to current read location within block */
+        uint8_t *wpos;  /* Pointer to current write location within block */
+    } cinfo;
+    struct H5S_hyper_node_tag *next;  /* pointer to next hyperslab in list */
+} H5S_hyper_node_t;
+
+/* Region in dimension */
+typedef struct H5S_hyper_region_tag {
+    hssize_t start;    /* The low bound of a region in a dimension */
+    hssize_t end;      /* The high bound of a region in a dimension */
+    H5S_hyper_node_t *node; /* pointer to the node the region is in */
+} H5S_hyper_region_t;
+
+/* Information about hyperslab boundary and pointer to hyperslab node */
+typedef struct {
+    hssize_t bound;         /* Location of boundary */
+    H5S_hyper_node_t *node; /* Boundary's node */
+} H5S_hyper_bound_t;
+
+/* Information about hyperslab list */
+typedef struct {
+    size_t count;               /* Number of nodes in list */
+    H5S_hyper_node_t *head;     /* Pointer to head of hyperslab list */
+    H5S_hyper_bound_t **lo_bounds;    /* Lower (closest to the origin) bound array for each dimension */
+} H5S_hyper_list_t;
+
+/* Information about one dimension in a hyperslab selection */
+typedef struct {
+    hssize_t start;
+    hsize_t  stride;
+    hsize_t  count;
+    hsize_t  block;
+} H5S_hyper_dim_t;
+
+/* Information about hyperslab selection */
+typedef struct {
+    H5S_hyper_dim_t *diminfo;    /* ->[rank] of per-dim selection info */
+	/* diminfo only points to one array, which holds the information
+	 * for one hyperslab selection. Perhaps this might need to be
+	 * expanded into a list of arrays when the H5Sselect_hyperslab's
+	 * restriction to H5S_SELECT_SET is removed. */
+    H5S_hyper_dim_t *app_diminfo;/* ->[rank] of per-dim selection info */
+	/* 'diminfo' points to a [potentially] optimized version of the user's
+     * hyperslab information.  'app_diminfo' points to the actual parameters
+     * that the application used for setting the hyperslab selection.  These
+     * are only used for re-gurgitating the original values used to set the
+     * hyperslab to the application when it queries the hyperslab selection
+     * information. */
+    H5S_hyper_list_t *hyper_lst; /* List of selected hyperslabs (order is not important) */
+} H5S_hyper_sel_t;
+
+/* Selection information container */
+typedef struct {
+    H5S_sel_type type;  /* Type of selection (list of points or hyperslabs) */
+    hssize_t *offset;   /* Offset within the extent (NULL means a 0 offset) */
+    hsize_t *order;     /* Selection order.  (NULL means a specific ordering of points) */
+    hsize_t num_elem;   /* Number of elements in selection */
+    union {
+        H5S_pnt_list_t *pnt_lst; /* List of selected points (order is important) */
+        H5S_hyper_sel_t hslab;   /* Info about hyperslab selections */
+    } sel_info;
+} H5S_select_t;
+
+/* Main dataspace structure (typedef'd in H5Sprivate.h) */
+struct H5S_t {
+    H5S_extent_t extent;        /* Dataspace extent */
+    H5S_select_t select;		/* Dataspace selection */
+};
+
+__DLL__ herr_t H5S_close_simple(H5S_simple_t *simple);
+__DLL__ herr_t H5S_release_simple(H5S_simple_t *simple);
+__DLL__ herr_t H5S_extent_copy(H5S_extent_t *dst, const H5S_extent_t *src);
+__DLL__ herr_t H5S_register(H5S_sel_type cls, const H5S_fconv_t *fconv,
+			    const H5S_mconv_t *mconv);
+
+/* Point select functions */
+__DLL__ herr_t H5S_point_add(H5S_t *space, H5S_seloper_t op, size_t num_elem,
+			     const hssize_t **coord);
+__DLL__ herr_t H5S_point_release(H5S_t *space);
+__DLL__ hsize_t H5S_point_npoints(const H5S_t *space);
+__DLL__ herr_t H5S_point_copy(H5S_t *dst, const H5S_t *src);
+__DLL__ htri_t H5S_point_select_valid(const H5S_t *space);
+__DLL__ hssize_t H5S_point_select_serial_size(const H5S_t *space);
+__DLL__ herr_t H5S_point_select_serialize(const H5S_t *space, uint8_t *buf);
+__DLL__ herr_t H5S_point_select_deserialize(H5S_t *space, const uint8_t *buf);
+__DLL__ herr_t H5S_point_bounds(H5S_t *space, hsize_t *start, hsize_t *end);
+__DLL__ htri_t H5S_point_select_contiguous(const H5S_t *space);
+__DLL__ herr_t H5S_point_select_iterate(void *buf, hid_t type_id, H5S_t *space,
+					H5D_operator_t op,
+					void *operator_data);
+
+/* "All" select functions */
+__DLL__ herr_t H5S_all_release(H5S_t *space);
+__DLL__ hsize_t H5S_all_npoints(const H5S_t *space);
+__DLL__ herr_t H5S_all_select_serialize(const H5S_t *space, uint8_t *buf);
+__DLL__ herr_t H5S_all_select_deserialize(H5S_t *space, const uint8_t *buf);
+__DLL__ herr_t H5S_all_bounds(H5S_t *space, hsize_t *start, hsize_t *end);
+__DLL__ herr_t H5S_all_read(H5F_t *f, const struct H5O_layout_t *layout,
+			    const struct H5O_pline_t *pline,
+			    const struct H5O_efl_t *efl, size_t elmt_size,
+			    const H5S_t *file_space, const H5S_t *mem_space,
+			    hid_t dxpl_id, void *buf/*out*/,
+			    hbool_t *must_convert/*out*/);
+__DLL__ herr_t H5S_all_write(H5F_t *f, const struct H5O_layout_t *layout,
+			     const struct H5O_pline_t *pline,
+			     const struct H5O_efl_t *efl, size_t elmt_size,
+			     const H5S_t *file_space, const H5S_t *mem_space,
+			     hid_t dxpl_id, const void *buf,
+			     hbool_t *must_convert/*out*/);
+__DLL__ herr_t H5S_all_select_iterate(void *buf, hid_t type_id, H5S_t *space,
+				      H5D_operator_t op, void *operator_data);
+
+/* Hyperslab selection functions */
+__DLL__ herr_t H5S_hyper_release(H5S_t *space);
+__DLL__ herr_t H5S_hyper_sel_iter_release(H5S_sel_iter_t *sel_iter);
+__DLL__ hsize_t H5S_hyper_npoints(const H5S_t *space);
+__DLL__ int H5S_hyper_compare_regions(const void *r1, const void *r2);
+__DLL__ int H5S_hyper_compare_bounds(const void *r1, const void *r2);
+__DLL__ herr_t H5S_hyper_copy(H5S_t *dst, const H5S_t *src);
+__DLL__ htri_t H5S_hyper_select_valid(const H5S_t *space);
+__DLL__ intn H5S_hyper_bound_comp(const void *_b1, const void *_b2);
+__DLL__ herr_t H5S_hyper_node_add(H5S_hyper_node_t **head, intn endflag,
+				  intn rank, const hssize_t *start,
+				  const hsize_t *size);
+__DLL__ herr_t H5S_hyper_clip(H5S_t *space, H5S_hyper_node_t *nodes,
+			      H5S_hyper_node_t **uniq,
+			      H5S_hyper_node_t **overlap);
+__DLL__ hssize_t H5S_hyper_select_serial_size(const H5S_t *space);
+__DLL__ herr_t H5S_hyper_select_serialize(const H5S_t *space, uint8_t *buf);
+__DLL__ herr_t H5S_hyper_select_deserialize(H5S_t *space, const uint8_t *buf);
+__DLL__ herr_t H5S_hyper_bounds(H5S_t *space, hsize_t *start, hsize_t *end);
+__DLL__ htri_t H5S_hyper_select_contiguous(const H5S_t *space);
+__DLL__ herr_t H5S_hyper_select_iterate(void *buf, hid_t type_id, H5S_t *space,
+                H5D_operator_t op, void *operator_data);
+
+/* "None" selection functions */
+__DLL__ herr_t H5S_none_select_serialize(const H5S_t *space, uint8_t *buf);
+__DLL__ herr_t H5S_none_select_deserialize(H5S_t *space, const uint8_t *buf);
+__DLL__ herr_t H5S_none_select_iterate(void *buf, hid_t type_id, H5S_t *space,
+				       H5D_operator_t op, void *operator_data);
+
+#ifdef H5_HAVE_PARALLEL
+/* MPI-IO function to read directly from app buffer to file rky980813 */
+__DLL__ herr_t H5S_mpio_spaces_read(H5F_t *f,
+				    const struct H5O_layout_t *layout,
+				    const struct H5O_pline_t *pline,
+				    const struct H5O_efl_t *efl,
+				    size_t elmt_size, const H5S_t *file_space,
+				    const H5S_t *mem_space, hid_t dxpl_id,
+				    void *buf/*out*/,
+				    hbool_t *must_convert /*out*/ );
+
+/* MPI-IO function to write directly from app buffer to file rky980813 */
+__DLL__ herr_t H5S_mpio_spaces_write(H5F_t *f,
+				     const struct H5O_layout_t *layout,
+				     const struct H5O_pline_t *pline,
+				     const struct H5O_efl_t *efl,
+				     size_t elmt_size, const H5S_t *file_space,
+				     const H5S_t *mem_space, hid_t dxpl_id,
+				     const void *buf,
+				     hbool_t *must_convert /*out*/ );
+#ifndef _H5S_IN_H5S_C
+/* Global var whose value comes from environment variable */
+__DLLVAR__ hbool_t		H5_mpi_opt_types_g;
+#endif /* _H5S_IN_H5S_C */
+
+#endif /* H5_HAVE_PARALLEL */
+
+#endif