Brings file locking changes from develop

3 files changed, 154 insertions, 33 deletions

diff --git a/test/h5test.c b/test/h5test.c
index 2613ce1..5e6f01a 100644
--- a/test/h5test.c
+++ b/test/h5test.c
@@ -1941,3 +1941,61 @@ const char *H5_get_srcdir(void)
         return(NULL);
 } /* end H5_get_srcdir() */
 
+/*-------------------------------------------------------------------------
+ * Function:    h5_check_if_file_locking_enabled
+ *
+ * Purpose:     Checks if file locking is enabled on this file system.
+ *
+ * Return:      SUCCEED/FAIL
+ *              are_enabled will be FALSE if file locking is disabled on
+ *              the file system of if there were errors.
+ *
+ *-------------------------------------------------------------------------
+ */
+herr_t
+h5_check_if_file_locking_enabled(hbool_t *is_enabled)
+{
+    const char *filename = "locking_test_file";
+    int pmode = O_RDWR | O_CREAT | O_TRUNC;
+    int fd = -1;
+
+    *is_enabled = TRUE;
+
+    if((fd = HDopen(filename, pmode, H5_POSIX_CREATE_MODE_RW)) < 0)
+        goto error;
+
+    /* Test HDflock() to see if it works */
+    if(HDflock(fd, LOCK_EX | LOCK_NB) < 0) {
+        if(ENOSYS == errno) {
+            /* When errno is set to ENOSYS, the file system does not support
+             * locking, so ignore it. This is most frequently used on
+             * Lustre. If we also want to check for disabled NFS locks
+             * we'll need to check for ENOLCK, too. That isn't done by
+             * default here since that could also represent an actual
+             * error condition.
+             */
+            errno = 0;
+            *is_enabled = FALSE;
+        }
+        else
+            goto error;
+    }
+    if(HDflock(fd, LOCK_UN) < 0)
+        goto error;
+
+    if(HDclose(fd) < 0)
+        goto error;
+    if(HDremove(filename) < 0)
+        goto error;
+
+    return SUCCEED;
+
+error:
+    *is_enabled = FALSE;
+    if (fd > -1) {
+        HDclose(fd);
+        HDremove(filename);
+    }
+    return FAIL;
+} /* end h5_check_if_file_locking_enabled() */
+
diff --git a/test/h5test.h b/test/h5test.h
index 0d937e1..35eea98 100644
--- a/test/h5test.h
+++ b/test/h5test.h
@@ -206,6 +206,7 @@ H5TEST_DLL int h5_make_local_copy(const char *origfilename, const char *local_co
 H5TEST_DLL herr_t h5_verify_cached_stabs(const char *base_name[], hid_t fapl);
 H5TEST_DLL H5FD_class_t *h5_get_dummy_vfd_class(void);
 H5TEST_DLL const char *h5_get_version_string(H5F_libver_t libver);
+H5TEST_DLL herr_t h5_check_if_file_locking_enabled(hbool_t *are_enabled);
 
 /* Functions that will replace components of a FAPL */
 H5TEST_DLL herr_t h5_get_vfd_fapl(hid_t fapl_id);
diff --git a/test/swmr.c b/test/swmr.c
index 700a68c..a407dac 100644
--- a/test/swmr.c
+++ b/test/swmr.c
@@ -90,7 +90,7 @@ static int test_file_lock_concur(hid_t fapl);
 static int test_file_lock_swmr_concur(hid_t fapl);
 
 /* Test file lock environment variable */
-static int test_file_lock_env_var(hid_t fapl);
+static int test_file_locking(hid_t in_fapl, hbool_t turn_locking_on, hbool_t env_var_override);
 
 /* Tests for SWMR VFD flag */
 static int test_swmr_vfd_flag(void);
@@ -4255,8 +4255,11 @@ test_file_lock_same(hid_t in_fapl)
     /* Output message about test being performed */
     TESTING("File open with different combinations of flags--single process access");
 
+    /* Set locking in the fapl */
     if((fapl = H5Pcopy(in_fapl)) < 0)
         FAIL_STACK_ERROR
+    if(H5Pset_file_locking(fapl, TRUE, TRUE) < 0)
+        FAIL_STACK_ERROR
 
     /* Set the filename to use for this test (dependent on fapl) */
     h5_fixname(FILENAME[1], fapl, filename, sizeof(filename));
@@ -4415,9 +4418,11 @@ test_file_lock_swmr_same(hid_t in_fapl)
     /* Output message about test being performed */
     TESTING("File open with different combinations of flags + SWMR flags--single process access");
 
-    /* Get a copy of the parameter in_fapl */
+    /* Set locking in the fapl */
     if((fapl = H5Pcopy(in_fapl)) < 0)
         FAIL_STACK_ERROR
+    if(H5Pset_file_locking(fapl, TRUE, TRUE) < 0)
+        FAIL_STACK_ERROR
 
     /* Set the filename to use for this test (dependent on fapl) */
     h5_fixname(FILENAME[1], fapl, filename, sizeof(filename));
@@ -4725,8 +4730,11 @@ test_file_lock_concur(hid_t in_fapl)
     /* Output message about test being performed */
     TESTING("File open with different combinations of flags--concurrent access");
 
+    /* Set locking in the fapl */
     if((fapl = H5Pcopy(in_fapl)) < 0)
         FAIL_STACK_ERROR
+    if(H5Pset_file_locking(fapl, TRUE, TRUE) < 0)
+        FAIL_STACK_ERROR
 
     /* Set the filename to use for this test (dependent on fapl) */
     h5_fixname(FILENAME[1], fapl, filename, sizeof(filename));
@@ -5101,8 +5109,11 @@ test_file_lock_swmr_concur(hid_t in_fapl)
     /* Output message about test being performed */
     TESTING("File open with different combintations of flags + SWMR flags--concurrent access");
 
+    /* Set locking in the fapl */
     if((fapl = H5Pcopy(in_fapl)) < 0)
         FAIL_STACK_ERROR
+    if(H5Pset_file_locking(fapl, TRUE, TRUE) < 0)
+        FAIL_STACK_ERROR
 
     /* Set the filename to use for this test (dependent on fapl) */
     h5_fixname(FILENAME[2], fapl, filename, sizeof(filename));
@@ -5597,7 +5608,7 @@ test_file_lock_swmr_concur(hid_t in_fapl)
 
         /* Open the test file */
         H5E_BEGIN_TRY {
-            child_fid = H5Fopen(filename, H5F_ACC_RDWR, H5P_DEFAULT);
+            child_fid = H5Fopen(filename, H5F_ACC_RDWR, fapl);
         } H5E_END_TRY;
 
         /* Should fail */
@@ -5921,7 +5932,7 @@ test_file_lock_swmr_concur(hid_t in_fapl)
         FAIL_STACK_ERROR
 
     /* Open the test file */
-    if((fid = H5Fopen(filename, H5F_ACC_RDONLY, H5P_DEFAULT)) < 0)
+    if((fid = H5Fopen(filename, H5F_ACC_RDONLY, fapl)) < 0)
         FAIL_STACK_ERROR
 
     /* Notify child process */
@@ -6058,7 +6069,7 @@ error:
 **
 *****************************************************************/
 static int
-test_file_lock_env_var(hid_t in_fapl)
+test_file_locking(hid_t in_fapl, hbool_t turn_locking_on, hbool_t env_var_override)
 {
 #if !(defined(H5_HAVE_FORK) && defined(H5_HAVE_WAITPID))
     SKIPPED();
@@ -6073,18 +6084,40 @@ test_file_lock_env_var(hid_t in_fapl)
     int child_wait_option=0;        /* Options passed to waitpid */
     int out_pdf[2];
     int notify = 0;
+    int exit_status = 0;
+    herr_t ret;
+
+    if (turn_locking_on && env_var_override)
+        TESTING("File locking: ON w/ env var override")
+    else if (turn_locking_on && !env_var_override)
+        TESTING("File locking: ON")
+    else if (!turn_locking_on && env_var_override)
+        TESTING("File locking: OFF w/ env var override")
+    else
+        TESTING("File locking: OFF")
 
-
-    TESTING("File locking environment variable");
-
-
-    /* Set the environment variable */
-    if(HDsetenv("HDF5_USE_FILE_LOCKING", "FALSE", TRUE) < 0)
+    /* Copy the incoming fapl */
+    if((fapl = H5Pcopy(in_fapl)) < 0)
         TEST_ERROR
 
-    if((fapl = H5Pcopy(in_fapl)) < 0)
+    /* Set locking in the fapl */
+    if(H5Pset_file_locking(fapl, turn_locking_on ? TRUE : FALSE, TRUE) < 0)
         TEST_ERROR
 
+    /* If requested, set the environment variable */
+    if (env_var_override) {
+        if(HDsetenv("HDF5_USE_FILE_LOCKING", turn_locking_on ? "FALSE" : "TRUE", TRUE) < 0)
+            TEST_ERROR
+        if(H5F__reparse_file_lock_variable_test() < 0)
+            TEST_ERROR
+    }
+    else {
+        if(HDsetenv("HDF5_USE_FILE_LOCKING", "", TRUE) < 0)
+            TEST_ERROR
+        if(H5F__reparse_file_lock_variable_test() < 0)
+            TEST_ERROR
+    }
+
     /* Set the filename to use for this test (dependent on fapl) */
     h5_fixname(FILENAME[1], fapl, filename, sizeof(filename));
 
@@ -6096,10 +6129,8 @@ test_file_lock_env_var(hid_t in_fapl)
     if(H5Fclose(fid) < 0)
         TEST_ERROR
 
-    /* Open a file for read-only and then read-write. This would
-     * normally fail due to the file locking scheme but should
-     * pass when the environment variable is set to disable file
-     * locking.
+    /* Open a file for read-only and then read-write. This will fail
+     * when the locking scheme is turned on.
      */
 
     /* Create 1 pipe */
@@ -6114,7 +6145,7 @@ test_file_lock_env_var(hid_t in_fapl)
 
         /* Child process */
 
-        hid_t child_fid;    /* File ID */
+        hid_t child_fid = H5I_INVALID_HID;  /* File ID */
         int child_notify = 0;
 
         /* Close unused write end for out_pdf */
@@ -6125,18 +6156,23 @@ test_file_lock_env_var(hid_t in_fapl)
         while(child_notify != 1) {
             if(HDread(out_pdf[0], &child_notify, sizeof(int)) < 0)
                 HDexit(EXIT_FAILURE);
-        } /* end while */
+        }
 
-        /* Open the test file */
-        if((child_fid = H5Fopen(filename, H5F_ACC_RDWR, fapl)) < 0)
-            TEST_ERROR
+        /* Open and close the test file */
+        H5E_BEGIN_TRY {
+            child_fid = H5Fopen(filename, H5F_ACC_RDWR, fapl);
+            ret = H5Fclose(child_fid);
+        } H5E_END_TRY; 
 
         /* Close the pipe */
         if(HDclose(out_pdf[0]) < 0)
             HDexit(EXIT_FAILURE);
 
-        HDexit(EXIT_SUCCESS);
-    } /* end if */
+        if(H5I_INVALID_HID == child_fid || FAIL == ret)
+            HDexit(EXIT_FAILURE);
+        else
+            HDexit(EXIT_SUCCESS);
+    } /* end child process work */
 
     /* close unused read end for out_pdf */
     if(HDclose(out_pdf[0]) < 0)
@@ -6159,15 +6195,28 @@ test_file_lock_env_var(hid_t in_fapl)
     if(HDwaitpid(childpid, &child_status, child_wait_option) < 0)
         TEST_ERROR
 
-    /* Check if child terminated normally */
-    if(WIFEXITED(child_status)) {
-        /* Check exit status of the child */
-        if(WEXITSTATUS(child_status) != 0)
-            TEST_ERROR
-    } /* end if */
+    /* Check exit status of the child */
+    if(WIFEXITED(child_status))
+        exit_status = WEXITSTATUS(child_status);
     else
         TEST_ERROR
 
+    /* The child process should have passed or failed as follows:
+     *
+     * locks on:                            FAIL
+     * locks off:                           PASS
+     * locks on, env var override:          PASS
+     * locks off, env var override:         FAIL
+     */
+    if(turn_locking_on && !env_var_override && (0 == exit_status))
+        TEST_ERROR
+    else if(!turn_locking_on && !env_var_override && (0 != exit_status))
+        TEST_ERROR
+    else if(turn_locking_on && env_var_override && (0 != exit_status))
+        TEST_ERROR
+    else if(!turn_locking_on && env_var_override && (0 == exit_status))
+        TEST_ERROR
+
     /* Close the file */
     if(H5Fclose(fid) < 0)
         TEST_ERROR
@@ -6191,7 +6240,7 @@ error:
 
 #endif /* !(defined(H5_HAVE_FORK && defined(H5_HAVE_WAITPID)) */
 
-} /* end test_file_lock_env_var() */
+} /* end test_file_locking() */
 
 
 static int
@@ -7018,7 +7067,7 @@ error:
         H5Fclose(fid3);
     } H5E_END_TRY;
 
-    return -1;
+    return 1;
 
 } /* test_multiple_same() */
 
@@ -7035,6 +7084,7 @@ main(void)
     char *driver = NULL;    /* VFD string (from env variable) */
     char *lock_env_var = NULL; /* file locking env var pointer */
     hbool_t use_file_locking;   /* read from env var */
+    hbool_t file_locking_enabled = FALSE;   /* Checks if the file system supports locks */
 
     /* Skip this test if SWMR I/O is not supported for the VFD specified
      * by the environment variable.
@@ -7055,6 +7105,13 @@ main(void)
     else
         use_file_locking = TRUE;
 
+    /* Check if file locking is enabled on this file system */
+    if(use_file_locking)
+        if(h5_check_if_file_locking_enabled(&file_locking_enabled) < 0) {
+            HDprintf("Error when determining if file locks are enabled\n");
+            return EXIT_FAILURE;
+        }
+
     /* Set up */
     h5_reset();
 
@@ -7096,7 +7153,7 @@ main(void)
     nerrors += test_append_flush_dataset_fixed(fapl);
     nerrors += test_append_flush_dataset_multiple(fapl);
 
-    if(use_file_locking) {
+    if(use_file_locking && file_locking_enabled) {
         /*
          * Tests for:
          *   file open flags--single process access
@@ -7126,7 +7183,12 @@ main(void)
     /* This test changes the HDF5_USE_FILE_LOCKING environment variable
      * so it should be run last.
      */
-    nerrors += test_file_lock_env_var(fapl);
+    if (use_file_locking && file_locking_enabled) {
+        nerrors += test_file_locking(fapl, TRUE, TRUE);
+        nerrors += test_file_locking(fapl, TRUE, FALSE);
+        nerrors += test_file_locking(fapl, FALSE, TRUE);
+        nerrors += test_file_locking(fapl, FALSE, FALSE);
+    }
 
     if(nerrors)
         goto error;