Fix for HDFFV-10051

Fix for issue #2 reported in HDFFV-10051:
The layout "dirty" flag for a compact dataset is not reset properly after flusing the data at dataset close.
--Reset the "dirty" flag before flushing the message.
Issue #1 reported in HDFFV-10051 is not a problem for 1.8.

4 files changed, 150 insertions, 2 deletions

diff --git a/src/H5Dcompact.c b/src/H5Dcompact.c
index 826daad..49c28a6 100644
--- a/src/H5Dcompact.c
+++ b/src/H5Dcompact.c
@@ -373,9 +373,11 @@ H5D__compact_flush(H5D_t *dset, hid_t dxpl_id)
 
     /* Check if the buffered compact information is dirty */
     if(dset->shared->layout.storage.u.compact.dirty) {
-        if(H5O_msg_write(&(dset->oloc), H5O_LAYOUT_ID, 0, H5O_UPDATE_TIME, &(dset->shared->layout), dxpl_id) < 0)
-            HGOTO_ERROR(H5E_FILE, H5E_CANTINIT, FAIL, "unable to update layout message")
         dset->shared->layout.storage.u.compact.dirty = FALSE;
+        if(H5O_msg_write(&(dset->oloc), H5O_LAYOUT_ID, 0, H5O_UPDATE_TIME, &(dset->shared->layout), dxpl_id) < 0) {
+            dset->shared->layout.storage.u.compact.dirty = TRUE;
+            HGOTO_ERROR(H5E_FILE, H5E_CANTINIT, FAIL, "unable to update layout message")
+        }
     } /* end if */
 
 done:
diff --git a/src/H5Dpkg.h b/src/H5Dpkg.h
index 91cf5f3..13d7284 100644
--- a/src/H5Dpkg.h
+++ b/src/H5Dpkg.h
@@ -714,6 +714,7 @@ H5_DLL htri_t H5D__mpio_opt_possible(const H5D_io_info_t *io_info,
 #ifdef H5D_TESTING
 H5_DLL herr_t H5D__layout_version_test(hid_t did, unsigned *version);
 H5_DLL herr_t H5D__layout_contig_size_test(hid_t did, hsize_t *size);
+H5_DLL herr_t H5D__layout_compact_dirty_test(hid_t did, hbool_t *dirty);
 H5_DLL herr_t H5D__current_cache_size_test(hid_t did, size_t *nbytes_used, int *nused);
 #endif /* H5D_TESTING */
 
diff --git a/src/H5Dtest.c b/src/H5Dtest.c
index eef3c91..2e62a75 100644
--- a/src/H5Dtest.c
+++ b/src/H5Dtest.c
@@ -144,6 +144,47 @@ done:
 
 /*--------------------------------------------------------------------------
  NAME
+    H5D__layout_compact_dirty_test
+ PURPOSE
+    Determine the "dirty" flag of a compact layout for a dataset's layout information
+ USAGE
+    herr_t H5D__layout_compact_dirty_test(did, dirty)
+        hid_t did;              IN: Dataset to query
+        hbool_t *dirty;         OUT: Pointer to location to place "dirty" info
+ RETURNS
+    Non-negative on success, negative on failure
+ DESCRIPTION
+    Checks the "dirty" flag of a compact dataset.
+ GLOBAL VARIABLES
+ COMMENTS, BUGS, ASSUMPTIONS
+    DO NOT USE THIS FUNCTION FOR ANYTHING EXCEPT TESTING
+ EXAMPLES
+ REVISION LOG
+--------------------------------------------------------------------------*/
+herr_t
+H5D__layout_compact_dirty_test(hid_t did, hbool_t *dirty)
+{
+    H5D_t *dset;                /* Pointer to dataset to query */
+    herr_t ret_value = SUCCEED; /* return value */
+
+    FUNC_ENTER_PACKAGE
+
+    /* Check args */
+    if(NULL == (dset = (H5D_t *)H5I_object_verify(did, H5I_DATASET)))
+        HGOTO_ERROR(H5E_DATASET, H5E_BADTYPE, FAIL, "not a dataset")
+
+    if(dirty) {
+        HDassert(dset->shared->layout.type == H5D_COMPACT);
+        *dirty = dset->shared->layout.storage.u.compact.dirty;
+    } /* end if */
+
+done:
+    FUNC_LEAVE_NOAPI(ret_value)
+}   /* H5D__layout_compact_dirty_test() */
+
+
+/*--------------------------------------------------------------------------
+ NAME
     H5D__current_cache_size_test
  PURPOSE
     Determine current the size of the dataset's chunk cache
diff --git a/test/dsets.c b/test/dsets.c
index e523680..cff7204 100644
--- a/test/dsets.c
+++ b/test/dsets.c
@@ -9083,6 +9083,109 @@ error:
     return -1;
 } /* end test_gather_error() */
 
+/*-------------------------------------------------------------------------
+ * Function:    test_compact_dirty
+ *
+ * Purpose:     Verify that issue #2 reported in HDFFV-10051 is fixed:
+ *              --the layout "dirty" flag for a compact dataset is not reset
+ *                properly after flushing the data at dataset close.
+ *
+ * Return:      Success:        0
+ *              Failure:        -1
+ *
+ * Programmer:  Vailin Choi; April 2017
+ *
+ *-------------------------------------------------------------------------
+ */
+static herr_t
+test_compact_dirty(hid_t fapl)
+{
+    hid_t       fid = -1;       /* File ID */
+    hid_t       did = -1;       /* Dataset ID */
+    hid_t       sid = -1;       /* Dataspace ID */
+    hid_t       dcpl = -1;      /* Dataset creation property list */
+    hsize_t     dims[1] = {10}; /* Dimension */
+    int         wbuf[10];       /* Data buffer */
+    char	    filename[FILENAME_BUF_SIZE];    /* Filename */
+    int         i;              /* Local index variable */
+    hbool_t     dirty;          /* The dirty flag */
+
+    TESTING("compact dataset repeated open/close and dirty flag");
+
+    /* Create a file */
+    h5_fixname(FILENAME[1], fapl, filename, sizeof filename);
+    if((fid = H5Fcreate(filename, H5F_ACC_TRUNC, H5P_DEFAULT, fapl)) < 0)
+        TEST_ERROR
+
+    /* Initialize data */
+    for(i = 0; i < 10; i++)
+        wbuf[i] = i;
+
+    /* Create dataspace */
+    if((sid = H5Screate_simple(1, dims, NULL)) < 0) 
+        TEST_ERROR
+
+    /* Set compact layout */
+    if((dcpl = H5Pcreate(H5P_DATASET_CREATE)) < 0) 
+        TEST_ERROR
+    if(H5Pset_layout(dcpl, H5D_COMPACT) < 0) 
+        TEST_ERROR
+    if(H5Pset_alloc_time(dcpl, H5D_ALLOC_TIME_EARLY) < 0) 
+        TEST_ERROR
+
+    /* Create a compact dataset */
+    if((did = H5Dcreate2(fid, DSET_COMPACT_MAX_NAME, H5T_NATIVE_INT, sid, H5P_DEFAULT, dcpl, H5P_DEFAULT)) < 0)
+        TEST_ERROR
+
+    /* Write to the dataset */
+    if(H5Dwrite(did, H5T_NATIVE_INT, H5S_ALL, H5S_ALL, H5P_DEFAULT, wbuf) < 0)
+        TEST_ERROR
+
+    /* Close the dataset */
+    if(H5Dclose(did) < 0) 
+        TEST_ERROR
+
+    /* Open the dataset */
+    if((did = H5Dopen2(fid, DSET_COMPACT_MAX_NAME, H5P_DEFAULT)) < 0)
+        TEST_ERROR
+
+    /* Retrieve the "dirty" flag from the compact dataset layout */
+    if(H5D__layout_compact_dirty_test(did, &dirty) < 0)
+        TEST_ERROR
+
+    /* Verify that the "dirty" flag is false */
+    if(dirty)
+        TEST_ERROR
+
+    /* Close the dataset */
+    if(H5Dclose(did) < 0) 
+        TEST_ERROR
+
+    /* Close the dataspace */
+    if(H5Sclose(sid) < 0) 
+        TEST_ERROR
+
+    /* Close the dataset creation property list */
+    if(H5Pclose(dcpl) < 0)
+        TEST_ERROR
+
+    /* Close the file */
+    if(H5Fclose(fid) < 0)
+        TEST_ERROR
+
+     PASSED();
+     return 0;
+
+error:
+    H5E_BEGIN_TRY {
+        H5Sclose(sid);
+        H5Pclose(dcpl);
+        H5Dclose(did);
+        H5Fclose(fid);
+    } H5E_END_TRY;
+    return -1;
+} /* test_compact_dirty() */
+
 
 /*-------------------------------------------------------------------------
  * Function:	main
@@ -9168,6 +9271,7 @@ main(void)
         nerrors += (test_simple_io(envval, my_fapl) < 0		? 1 : 0);
         nerrors += (test_compact_io(my_fapl) < 0  		? 1 : 0);
         nerrors += (test_max_compact(my_fapl) < 0  		? 1 : 0);
+        nerrors += (test_compact_dirty(my_fapl) < 0     ? 1 : 0);
         nerrors += (test_conv_buffer(file) < 0		? 1 : 0);
         nerrors += (test_tconv(file) < 0			? 1 : 0);
         nerrors += (test_filters(file, my_fapl) < 0		? 1 : 0);