Updated the flush1/2 test to not be a mess and to handle

non-SWMR-enabled VFDs.

1 files changed, 241 insertions, 111 deletions

diff --git a/test/flush1.c b/test/flush1.c
index 0e53f2b..4f63093 100644
--- a/test/flush1.c
+++ b/test/flush1.c
@@ -25,6 +25,11 @@
  */
 #include "h5test.h"
 
+/* This file needs to access the file driver testing code */
+#define H5FD_FRIEND     /*suppress error about including H5FDpkg      */
+#define H5FD_TESTING
+#include "H5FDpkg.h"    /* File drivers             */
+
 const char *FILENAME[] = {
     "flush",
     "flush-swmr",
@@ -37,179 +42,304 @@ const char *FILENAME[] = {
     NULL
 };
 
-static double	the_data[100][100];
+/* Number and size of dataset dims, chunk size, etc. */
+#define NDIMS       1
+#define NELEMENTS   10000
+#define CHUNK_SIZE  25
+#define FIRST_DSET_NAME     "dset1"
+#define SECOND_DSET_NAME    "dset2"
+
+/* Number of sub-groups created in the containing group */
+#define NGROUPS     100
+
+static hid_t create_file(const char *filename, hid_t fapl_id, hbool_t swmr);
+static herr_t add_dset_to_file(hid_t fid, const char *dset_name);
 
+
 /*-------------------------------------------------------------------------
- * Function:	create_file
+ * Function:    create_file
  *
- * Purpose:	Creates files used in part 1 of the test
+ * Purpose:     Creates files and datasets used in part 1 of the test
  *
- * Return:	Success:	0
- *
- *		Failure:	1
+ * Return:      Success:	a valid file ID
+ *              Failure:	-1
  *
  * Programmer:	Leon Arber
  *              Sept. 26, 2006
  *
- * Modifications:
- *
  *-------------------------------------------------------------------------
  */
 static hid_t
-create_file(char* name, hid_t fapl, hbool_t swmr)
+create_file(const char *filename, hid_t fapl_id, hbool_t swmr)
 {
-    hid_t	file, dcpl, space, dset, groups, grp;
-    hsize_t	ds_size[2] = {100, 100};
-    hsize_t	ch_size[2] = {5, 5};
-    unsigned    flags;
-    size_t	i, j;
+    hid_t   fid = -1;               /* file ID                          */
+    hid_t   top_gid = -1;           /* containing group ID              */
+    hid_t   gid = -1;               /* subgroup ID                      */
+    char    group_name[16];         /* group name                       */
+    unsigned    flags;              /* file open flags                  */
+    int     i;                      /* iterator                         */
 
     flags = H5F_ACC_TRUNC | (swmr ? H5F_ACC_SWMR_WRITE : 0);
 
-    if((file = H5Fcreate(name, flags, H5P_DEFAULT, fapl)) < 0) FAIL_STACK_ERROR
+    if((fid = H5Fcreate(filename, flags, H5P_DEFAULT, fapl_id)) < 0)
+        STACK_ERROR
 
     /* Create a chunked dataset */
-    if((dcpl = H5Pcreate(H5P_DATASET_CREATE)) < 0) FAIL_STACK_ERROR
-    if(H5Pset_chunk(dcpl, 2, ch_size) < 0) FAIL_STACK_ERROR
-    if((space = H5Screate_simple(2, ds_size, NULL)) < 0) FAIL_STACK_ERROR
-    if((dset = H5Dcreate2(file, "dset", H5T_NATIVE_FLOAT, space, H5P_DEFAULT, H5P_DEFAULT, H5P_DEFAULT)) < 0) FAIL_STACK_ERROR
-
-    /* Write some data */
-    for(i = 0; i < ds_size[0]; i++)
-        for(j = 0; j < (size_t)ds_size[1]; j++)
-	    the_data[i][j] = (double)i / (double)(j + 1);
-    if(H5Dwrite(dset, H5T_NATIVE_DOUBLE, space, space, H5P_DEFAULT, the_data) < 0) FAIL_STACK_ERROR
+    if(add_dset_to_file(fid, FIRST_DSET_NAME) < 0)
+        TEST_ERROR
 
     /* Create some groups */
-    if((groups = H5Gcreate2(file, "some_groups", H5P_DEFAULT, H5P_DEFAULT, H5P_DEFAULT)) < 0) FAIL_STACK_ERROR
-    for(i = 0; i < 100; i++) {
-	sprintf(name, "grp%02u", (unsigned)i);
-	if((grp = H5Gcreate2(groups, name, H5P_DEFAULT, H5P_DEFAULT, H5P_DEFAULT)) < 0) FAIL_STACK_ERROR
-	if(H5Gclose(grp) < 0) FAIL_STACK_ERROR
+    if((top_gid = H5Gcreate2(fid, "top_group", H5P_DEFAULT, H5P_DEFAULT, H5P_DEFAULT)) < 0)
+        STACK_ERROR
+    for(i = 0; i < NGROUPS; i++) {
+        HDsprintf(group_name, "group%02d", i);
+        if((gid = H5Gcreate2(top_gid, group_name, H5P_DEFAULT, H5P_DEFAULT, H5P_DEFAULT)) < 0)
+            STACK_ERROR
+        if(H5Gclose(gid) < 0)
+            STACK_ERROR
     } /* end for */
 
-    return file;
+    if(H5Gclose(top_gid) < 0)
+        STACK_ERROR
+    
+    return fid;
 
 error:
-    HD_exit(EXIT_FAILURE);
-}
+    H5E_BEGIN_TRY {
+        H5Fclose(fid);
+        H5Gclose(gid);
+        H5Gclose(top_gid);
+     } H5E_END_TRY;
 
+    return -1;
+} /* end create_file() */
 
+
 /*-------------------------------------------------------------------------
- * Function:	extend_file
+ * Function:    add_dset_to_file
  *
- * Purpose:	Add a small dataset to the file.
+ * Purpose:     Add a dataset to the file.
  *
- * Return:	Success:	0
- *
- *		Failure:	1
+ * Return:      SUCCEED/FAIL
  *
  * Programmer:	Leon Arber
  *              Oct. 4, 2006
  *
- * Modifications:
- *
  *-------------------------------------------------------------------------
  */
-static hid_t
-extend_file(hid_t file)
+static herr_t
+add_dset_to_file(hid_t fid, const char *dset_name)
 {
-    hid_t	dcpl, space, dset;
-    hsize_t	ds_size[2] = {100, 100};
-    hsize_t	ch_size[2] = {5, 5};
-    size_t	i, j;
+    hid_t   dcpl_id = -1;           /* dataset creation plist ID        */
+    hid_t   sid = -1;               /* dataspace ID                     */
+    hid_t   did = -1;               /* dataset ID                       */
+    int    *data = NULL;            /* data buffer                      */
+    hsize_t dims[1] = {NELEMENTS};  /* size of dataset                  */
+    hsize_t chunk_dims[1] = {CHUNK_SIZE};   /* chunk size               */
+    int     i;                      /* iterator                         */
 
     /* Create a chunked dataset */
-    if((dcpl = H5Pcreate(H5P_DATASET_CREATE)) < 0) goto error;
-    if(H5Pset_chunk(dcpl, 2, ch_size) < 0) goto error;
-    if((space = H5Screate_simple(2, ds_size, NULL)) < 0) goto error;
-    if((dset = H5Dcreate2(file, "dset2", H5T_NATIVE_FLOAT, space, H5P_DEFAULT, H5P_DEFAULT, H5P_DEFAULT)) < 0)
-	goto error;
+    if((dcpl_id = H5Pcreate(H5P_DATASET_CREATE)) < 0)
+        STACK_ERROR
+    if(H5Pset_chunk(dcpl_id, NDIMS, chunk_dims) < 0)
+        STACK_ERROR
+    if((sid = H5Screate_simple(NDIMS, dims, NULL)) < 0)
+        STACK_ERROR
+    if((did = H5Dcreate2(fid, dset_name, H5T_NATIVE_FLOAT, sid, H5P_DEFAULT, H5P_DEFAULT, H5P_DEFAULT)) < 0)
+        STACK_ERROR
 
     /* Write some data */
-    for(i = 0; i < ds_size[0]; i++)
-	for(j = 0; j < (size_t)ds_size[1]; j++)
-	    the_data[i][j] = (double)i / (double)(j + 1);
-    if(H5Dwrite(dset, H5T_NATIVE_DOUBLE, space, space, H5P_DEFAULT, the_data) < 0) goto error;
+    if(NULL == (data = (int *)HDcalloc((size_t)NELEMENTS, sizeof(int))))
+        STACK_ERROR
+    for(i = 0; i < NELEMENTS; i++)
+        data[i] = i;
+    if(H5Dwrite(did, H5T_NATIVE_INT, sid, sid, H5P_DEFAULT, data) < 0)
+        STACK_ERROR
+
+    if(H5Pclose(dcpl_id) < 0)
+        STACK_ERROR
+    if(H5Sclose(sid) < 0)
+        STACK_ERROR
+    if(H5Dclose(did) < 0)
+        STACK_ERROR
 
-    return file;
+    HDfree(data);
+
+    return SUCCEED;
 
 error:
-    HD_exit(EXIT_FAILURE);
-}
+    H5E_BEGIN_TRY {
+        H5Pclose(dcpl_id);
+        H5Sclose(sid);
+        H5Dclose(did);
+     } H5E_END_TRY;
+
+    HDfree(data);
 
+    return FAIL;
+} /* end add_dset_to_file() */
+
+
 /*-------------------------------------------------------------------------
  * Function:	main
  *
- * Purpose:	Part 1 of a two-part H5Fflush() test.
- *
- * Return:	Success:	0
+ * Purpose:     Creates files and datasets with and without flushing in
+ *              a variety of situations.
  *
- *		Failure:	1
+ *              Part 1 of a two-part H5Fflush() test.
+ *   
+ * Return:      EXIT_SUCCESS/EXIT_FAILURE
  *
  * Programmer:	Robb Matzke
  *              Friday, October 23, 1998
  *
- * Modifications:
- * 		Leon Arber
- * 		Sept. 26, 2006, expand test to check for failure if H5Fflush is not called.
- * 		Oct. 4 2006, expand test to check for partial failure in case file is flushed, but then
- * 				new datasets are created after the flush.
- *
- *
  *-------------------------------------------------------------------------
  */
 int
 main(void)
 {
-    hid_t file, fapl;
-    char	name[1024];
-    unsigned swmr;
+    char   *driver = NULL;      /* name of current VFD (from env var)       */
+    hbool_t vfd_supports_swmr;  /* whether the current VFD supports SWMR    */
+    hid_t   fid = -1;           /* file ID                                  */
+    hid_t   fapl_id = -1;       /* file access proplist ID                  */
+    char    filename[1024];     /* filename                                 */
+    hbool_t use_swmr;           /* whether or not to use SWMR I/O           */
 
     h5_reset();
-    fapl = h5_fileaccess();
-
-    TESTING("H5Fflush (part1)");
-
-    /* Loop over SWMR & non-SWMR opens for the file */
-    for(swmr = 0; swmr <= 1; swmr++) {
-        /* Create the file */
-        h5_fixname(FILENAME[0 + swmr], fapl, name, sizeof name);
-        file = create_file(name, fapl, swmr);
-        /* Flush and exit without closing the library */
-        if (H5Fflush(file, H5F_SCOPE_GLOBAL) < 0) goto error;
-
-        /* Create the other file which will not be flushed */
-        h5_fixname(FILENAME[2 + swmr], fapl, name, sizeof name);
-        file = create_file(name, fapl, swmr);
-
-        /* Create the file */
-        h5_fixname(FILENAME[4 + swmr], fapl, name, sizeof name);
-        file = create_file(name, fapl, swmr);
-        /* Flush and exit without closing the library */
-        if(H5Fflush(file, H5F_SCOPE_GLOBAL) < 0) goto error;
-        /* Add a bit to the file and don't flush the new part */
-        extend_file(file);
-        /* Flush and exit without closing the library */
-        if (H5Fflush(file, H5F_SCOPE_GLOBAL) < 0) goto error;
-
-        /* Create the file */
-        h5_fixname(FILENAME[6 + swmr], fapl, name, sizeof name);
-        file = create_file(name, fapl, swmr);
-        /* Flush and exit without closing the library */
-        if(H5Fflush(file, H5F_SCOPE_GLOBAL) < 0) goto error;
-        /* Add a bit to the file and don't flush the new part */
-        extend_file(file);
-    } /* end for */
+    if((fapl_id = h5_fileaccess()) < 0)
+        TEST_ERROR
+
+    /* Check if the current VFD supports SWMR */
+    driver = HDgetenv("HDF5_DRIVER");
+    vfd_supports_swmr = H5FD_supports_swmr_test(driver);
+
+    /*************************************************/
+    /* NOTE: Not closing the file ID is intentional! */
+    /*************************************************/
+
+    /* Create a file and flush */
+    TESTING("H5Fflush (part1 with flush)");
+    h5_fixname(FILENAME[0], fapl_id, filename, sizeof(filename));
+    use_swmr = FALSE;
+    if((fid = create_file(filename, fapl_id, use_swmr)) < 0)
+        TEST_ERROR
+    if(H5Fflush(fid, H5F_SCOPE_GLOBAL) < 0)
+        FAIL_STACK_ERROR
+    PASSED();
+
+    /* Create a file and flush w/ SWMR I/O */
+    TESTING("H5Fflush (part1 with flush + SWMR)");
+    if(vfd_supports_swmr) {
+        h5_fixname(FILENAME[1], fapl_id, filename, sizeof(filename));
+        use_swmr = TRUE;
+        if((fid = create_file(filename, fapl_id, use_swmr)) < 0)
+            TEST_ERROR
+        if(H5Fflush(fid, H5F_SCOPE_GLOBAL) < 0)
+            FAIL_STACK_ERROR
+        PASSED();
+    } /* end if */
+    else
+        SKIPPED();
+
+    /* Create a file which will not be flushed */
+    TESTING("H5Fflush (part1 without flush)");
+    h5_fixname(FILENAME[2], fapl_id, filename, sizeof(filename));
+    use_swmr = FALSE;
+    if((fid = create_file(filename, fapl_id, use_swmr)) < 0)
+        TEST_ERROR
+    PASSED();
+
+    /* Create a file which will not be flushed w/ SWMR I/O */
+    TESTING("H5Fflush (part1 without flush + SWMR)");
+    if(vfd_supports_swmr) {
+        h5_fixname(FILENAME[3], fapl_id, filename, sizeof(filename));
+        use_swmr = TRUE;
+        if((fid = create_file(filename, fapl_id, use_swmr)) < 0)
+            TEST_ERROR
+        PASSED();
+    } /* end if */
+    else
+        SKIPPED();
 
+    /* Create a file, flush, add a dataset, flush */
+    TESTING("H5Fflush (part1 with flush and later addition and another flush)");
+    h5_fixname(FILENAME[4], fapl_id, filename, sizeof(filename));
+    use_swmr = FALSE;
+    if((fid = create_file(filename, fapl_id, use_swmr)) < 0)
+        TEST_ERROR
+    if(H5Fflush(fid, H5F_SCOPE_GLOBAL) < 0)
+        FAIL_STACK_ERROR
+    if(add_dset_to_file(fid, SECOND_DSET_NAME) < 0)
+        TEST_ERROR
+    if(H5Fflush(fid, H5F_SCOPE_GLOBAL) < 0)
+        FAIL_STACK_ERROR
     PASSED();
-    fflush(stdout);
-    fflush(stderr);
 
+    /* Create a file, flush, add a dataset, flush w/ SWMR I/O */
+    TESTING("H5Fflush (part1 with flush and later addition and another flush + SWMR)");
+    if(vfd_supports_swmr) {
+        h5_fixname(FILENAME[5], fapl_id, filename, sizeof(filename));
+        use_swmr = TRUE;
+        if((fid = create_file(filename, fapl_id, use_swmr)) < 0)
+            TEST_ERROR
+        if(H5Fflush(fid, H5F_SCOPE_GLOBAL) < 0)
+            FAIL_STACK_ERROR
+        if(add_dset_to_file(fid, SECOND_DSET_NAME) < 0)
+            TEST_ERROR
+        if(H5Fflush(fid, H5F_SCOPE_GLOBAL) < 0)
+            FAIL_STACK_ERROR
+        PASSED();
+    } /* end if */
+    else
+        SKIPPED();
+
+    /* Create a file, flush, add a dataset, (no flush) */
+    TESTING("H5Fflush (part1 with flush and later addition)");
+    h5_fixname(FILENAME[6], fapl_id, filename, sizeof(filename));
+    use_swmr = FALSE;
+    if((fid = create_file(filename, fapl_id, use_swmr)) < 0)
+        TEST_ERROR
+    if(H5Fflush(fid, H5F_SCOPE_GLOBAL) < 0)
+        FAIL_STACK_ERROR
+    if(add_dset_to_file(fid, SECOND_DSET_NAME) < 0)
+        TEST_ERROR
+    PASSED();
+
+    /* Create a file, flush, add a dataset, (no flush) w/ SWMR I/O */
+    TESTING("H5Fflush (part1 with flush and later addition + SWMR)");
+    if(vfd_supports_swmr) {
+        h5_fixname(FILENAME[7], fapl_id, filename, sizeof(filename));
+        use_swmr = TRUE;
+        if((fid = create_file(filename, fapl_id, use_swmr)) < 0)
+            TEST_ERROR
+        if(H5Fflush(fid, H5F_SCOPE_GLOBAL) < 0)
+            FAIL_STACK_ERROR
+        if(add_dset_to_file(fid, SECOND_DSET_NAME) < 0)
+            TEST_ERROR
+        PASSED();
+    } /* end if */
+    else
+        SKIPPED();
+
+    if(!vfd_supports_swmr)
+        HDprintf("NOTE: Some tests were skipped since the current VFD lacks SWMR support\n");
+
+    /* Flush console output streams */
+    HDfflush(stdout);
+    HDfflush(stderr);
+
+    /* DO NOT CLOSE FILE ID! */
+    if(H5Pclose(fapl_id) < 0)
+        STACK_ERROR
+
+    /* _exit() is necessary since we want a hard close of the library */
     HD_exit(EXIT_SUCCESS);
 
 error:
-    HD_exit(EXIT_FAILURE);
-    return 1;
-}
+    H5E_BEGIN_TRY {
+        H5Pclose(fapl_id);
+    } H5E_END_TRY;
+
+    HDexit(EXIT_FAILURE);
+} /* end main() */