Manual sync with develop (#95)

Brings all features from develop. Note that RELEASE.txt has not been
updated (will be done in a future PR).

1 files changed, 186 insertions, 45 deletions

diff --git a/test/swmr.c b/test/swmr.c
index 44f4277..61d312b 100644
--- a/test/swmr.c
+++ b/test/swmr.c
@@ -87,7 +87,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);
@@ -4239,8 +4239,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));
@@ -4400,7 +4403,7 @@ 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
 
@@ -4702,8 +4705,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));
@@ -5080,8 +5086,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));
@@ -6031,38 +6040,61 @@ error:
 
 /****************************************************************
 **
-**  test_file_lock_swmr_concur(): low-level file test routine.
-**    With the implementation of file locking, this test checks file
-**    open with different combinations of flags + SWMR flags.
-**    This is for concurrent access.
+**  test_file_locking():
+**    Tests various combinations of file locking flags and
+**    and environment variables.
 **
 *****************************************************************/
 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();
     HDputs("    Test skipped due to fork or waitpid not defined.");
     return 0;
 #else
-    hid_t fid  = -1;               /* File ID */
-    hid_t fapl = -1;               /* File access property list */
-    char  filename[NAME_BUF_SIZE]; /* file name */
-    pid_t childpid = 0;            /* Child process ID */
-    int   child_status;            /* Status passed to waitpid */
-    int   child_wait_option = 0;   /* Options passed to waitpid */
-    int   out_pdf[2];
-    int   notify = 0;
-
-    TESTING("File locking environment variable");
+    hid_t  fid  = -1;               /* File ID */
+    hid_t  fapl = -1;               /* File access property list */
+    char   filename[NAME_BUF_SIZE]; /* file name */
+    pid_t  childpid = 0;            /* Child process ID */
+    int    child_status;            /* Status passed to waitpid */
+    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")
 
-    /* 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));
 
@@ -6074,10 +6106,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 */
@@ -6105,16 +6135,23 @@ test_file_lock_env_var(hid_t in_fapl)
                 HDexit(EXIT_FAILURE);
         }
 
-        /* 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)
@@ -6137,15 +6174,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
@@ -6170,7 +6220,81 @@ error:
 
 #endif /* !(defined(H5_HAVE_FORK && defined(H5_HAVE_WAITPID)) */
 
-} /* end test_file_lock_env_var() */
+} /* end test_file_locking() */
+
+/****************************************************************
+**
+**  test_different_lock_flags():
+**    Tests opening a file multiple times with different lock
+**    flags.
+**
+*****************************************************************/
+static int
+test_different_lock_flags(hid_t in_fapl)
+{
+    hid_t fid1    = H5I_INVALID_HID; /* File ID */
+    hid_t fid2    = H5I_INVALID_HID; /* File ID */
+    hid_t fid3    = H5I_INVALID_HID; /* File ID */
+    hid_t fapl_id = H5I_INVALID_HID; /* File access property list */
+    char  filename[NAME_BUF_SIZE];   /* File name */
+
+    TESTING("Using different lock flags")
+
+    /* Copy the incoming fapl */
+    if ((fapl_id = H5Pcopy(in_fapl)) < 0)
+        TEST_ERROR
+
+    /* Set locking in the fapl */
+    if (H5Pset_file_locking(fapl_id, TRUE, TRUE) < 0)
+        TEST_ERROR
+
+    /* Set the filename to use for this test (dependent on fapl) */
+    h5_fixname(FILENAME[1], fapl_id, filename, sizeof(filename));
+
+    /* Create the test file */
+    if ((fid1 = H5Fcreate(filename, H5F_ACC_TRUNC, H5P_DEFAULT, fapl_id)) < 0)
+        TEST_ERROR
+
+    /* Open the test file with the same flags (should pass) */
+    if ((fid2 = H5Fopen(filename, H5F_ACC_RDWR, fapl_id)) < 0)
+        TEST_ERROR
+
+    /* Unset locking in the fapl */
+    if (H5Pset_file_locking(fapl_id, FALSE, FALSE) < 0)
+        TEST_ERROR
+
+    /* Open the test file with different flags (should FAIL) */
+    H5E_BEGIN_TRY { fid3 = H5Fopen(filename, H5F_ACC_RDWR, fapl_id); }
+    H5E_END_TRY;
+    if (H5I_INVALID_HID != fid3)
+        FAIL_PUTS_ERROR("Should not have been able to open a file with different locking flags")
+
+    /* Close the files */
+    if (H5Fclose(fid1) < 0)
+        TEST_ERROR
+    if (H5Fclose(fid2) < 0)
+        TEST_ERROR
+
+    /* Close the copied property list */
+    if (H5Pclose(fapl_id) < 0)
+        TEST_ERROR
+
+    PASSED();
+
+    return 0;
+
+error:
+    H5E_BEGIN_TRY
+    {
+        H5Pclose(fapl_id);
+        H5Fclose(fid1);
+        H5Fclose(fid2);
+        H5Fclose(fid3);
+    }
+    H5E_END_TRY;
+
+    return -1;
+} /* end test_different_lock_flags() */
 
 static int
 test_swmr_vfd_flag(void)
@@ -7025,11 +7149,12 @@ error:
 int
 main(void)
 {
-    int     nerrors      = 0;    /* The # of errors */
-    hid_t   fapl         = -1;   /* File access property list ID */
-    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 */
+    int     nerrors      = 0;             /* The # of errors */
+    hid_t   fapl         = -1;            /* File access property list ID */
+    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.
@@ -7050,6 +7175,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();
 
@@ -7091,7 +7223,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
@@ -7118,10 +7250,19 @@ main(void)
     if (NULL == driver || !HDstrcmp(driver, "") || !HDstrcmp(driver, "sec2"))
         nerrors += test_swmr_vfd_flag();
 
-    /* This test changes the HDF5_USE_FILE_LOCKING environment variable
-     * so it should be run last.
+    /* Test multiple opens via different locking flags */
+    if (use_file_locking && file_locking_enabled)
+        nerrors += test_different_lock_flags(fapl);
+
+    /* These tests change the HDF5_USE_FILE_LOCKING environment variable
+     * so they 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;