Make H5VL multi-thread safe

.github/workflows/test.yml

@@ -5,12 +5,17 @@ on:
         branches:
             - '*'
 
+env:
+  HDF5TestExpress: 1
+
 jobs:
     build-and-test:
         runs-on: ubuntu-latest
         strategy:
             matrix:
                 api_tests: ["--enable-api-tests", "--disable-api-tests"]
+                multi_thread: ["--enable-multithread --disable-hl", "--disable-multithread --enable-threadsafe --disable-hl", "--disable-multithread --disable-threadsafe"]
+                build_mode: ["production", "debug"]
             fail-fast: false
 
         steps:
@@ -25,22 +30,39 @@ jobs:
             - name: Configure HDF5
               working-directory: ${{github.workspace}}
               run: |
-                    autoreconf -if
-                    ./configure --enable-shared --enable-tests ${{ matrix.api_tests }}
+                    sh ./autogen.sh
+                    ./configure --enable-shared --enable-tests ${{ matrix.multi_thread }} ${{ matrix.api_tests }} --enable-build-mode=${{ matrix.build_mode }}
 
             - name: Build HDF5
               working-directory: ${{github.workspace}}
               run: |
                     make -j
-                    make install
-
+
             - name: API Tests
               if: matrix.api_tests == '--enable-api-tests'
               working-directory: ${{github.workspace}}
               run: |
                 valgrind ./test/API/api_tests
 
+            - name: API Tests with multithread test VOL
+              if: matrix.api_tests == '--enable-api-tests' && matrix.multi_thread == '--enable-multithread --disable-hl'
+              working-directory: ${{github.workspace}}
+              env:
+                HDF5_PLUGIN_PATH: ${{github.workspace}}/test/.libs
+                HDF5_VOL_CONNECTOR: "mt_native_wrapper_vol_connector"
+              run: |
+                valgrind ./test/API/api_tests
+
+            - name: API Tests with passthrough multithread test VOL
+              if: matrix.api_tests == '--enable-api-tests' && matrix.multi_thread == '--enable-multithread --disable-hl'
+              working-directory: ${{github.workspace}}
+              env:
+                HDF5_PLUGIN_PATH: ${{github.workspace}}/test/.libs
+                HDF5_VOL_CONNECTOR: "mt_native_wrapper_passthru_vol_connector under_vol=0\\;under_info={}"
+              run: |
+                valgrind ./test/API/api_tests
+
             - name: Test HDF5
               working-directory: ${{github.workspace}}
               run: |
-                    make check
+                make check

configure.ac

@@ -2043,6 +2043,7 @@ AC_SUBST([MULTITHREAD])
 ## Default is no multithread
 MULTITHREAD=no
 
+
 AC_MSG_CHECKING([for multithread configure option])
 AC_ARG_ENABLE([multithread],
               [AS_HELP_STRING([--enable-multithread],
@@ -2114,7 +2115,6 @@ esac
 
 if test "X$MULTITHREAD" = "Xyes"; then
     AC_DEFINE([HAVE_MULTITHREAD], [1], [Define if we have multithread support])
-
     ## ----------------------------------------------------------------------
     ## Is the Pthreads library present?  It has a header file `pthread.h' and
     ## a library `-lpthread' and their locations might be specified with the
@@ -2245,6 +2245,15 @@ if test "X$MULTITHREAD" = "Xyes"; then
     esac
 fi
 
+AC_SUBST([VIRTUAL_LOCK])
+VIRTUAL_LOCK=NO
+
+if test "X$MULTITHREAD" = "Xyes" -a "X$BUILD_MODE" = "Xdebug"; then
+  AC_DEFINE([HAVE_VIRTUAL_LOCK], [1], [Define if we enable the virtual lock])
+else
+  AC_DEFINE([HAVE_VIRTUAL_LOCK], [0], [Define if we enable the virtual lock])
+fi
+
 ## ----------------------------------------------------------------------
 ## Check for MONOTONIC_TIMER support (used in clock_gettime).  This has
 ## to be done after any POSIX defines to ensure that the test gets

src/H5.c

@@ -544,15 +544,15 @@ H5dont_atexit(void)
 {
     herr_t ret_value = SUCCEED; /* Return value */
 
-    FUNC_ENTER_API_NOINIT_NOERR_NOFS
+    FUNC_ENTER_API_NOINIT_NOERR_NOFS()
     H5TRACE0("e", "");
 
     if (H5_dont_atexit_g)
         ret_value = FAIL;
     else
         H5_dont_atexit_g = TRUE;
 
-    FUNC_LEAVE_API_NOFS(ret_value)
+    FUNC_LEAVE_API_NOFS(ret_value, H5I_INVALID_HID)
 } /* end H5dont_atexit() */
 
 /*-------------------------------------------------------------------------
@@ -577,15 +577,15 @@ H5garbage_collect(void)
 {
     herr_t ret_value = SUCCEED;
 
-    FUNC_ENTER_API(FAIL)
+    FUNC_ENTER_API(FAIL, H5I_INVALID_HID)
     H5TRACE0("e", "");
 
     /* Call the garbage collection routines in the library */
     if (H5FL_garbage_coll() < 0)
         HGOTO_ERROR(H5E_RESOURCE, H5E_CANTGC, FAIL, "can't garbage collect objects");
 
 done:
-    FUNC_LEAVE_API(ret_value)
+    FUNC_LEAVE_API(ret_value, H5I_INVALID_HID)
 } /* end H5garbage_collect() */
 
 /*-------------------------------------------------------------------------
@@ -621,7 +621,7 @@ H5set_free_list_limits(int reg_global_lim, int reg_list_lim, int arr_global_lim,
 {
     herr_t ret_value = SUCCEED;
 
-    FUNC_ENTER_API(FAIL)
+    FUNC_ENTER_API(FAIL, H5I_INVALID_HID)
     H5TRACE6("e", "IsIsIsIsIsIs", reg_global_lim, reg_list_lim, arr_global_lim, arr_list_lim, blk_global_lim,
              blk_list_lim);
 
@@ -631,7 +631,7 @@ H5set_free_list_limits(int reg_global_lim, int reg_list_lim, int arr_global_lim,
         HGOTO_ERROR(H5E_RESOURCE, H5E_CANTSET, FAIL, "can't set garbage collection limits");
 
 done:
-    FUNC_LEAVE_API(ret_value)
+    FUNC_LEAVE_API(ret_value, H5I_INVALID_HID)
 } /* end H5set_free_list_limits() */
 
 /*-------------------------------------------------------------------------
@@ -659,15 +659,15 @@ H5get_free_list_sizes(size_t *reg_size /*out*/, size_t *arr_size /*out*/, size_t
 {
     herr_t ret_value = SUCCEED; /* Return value */
 
-    FUNC_ENTER_API(FAIL)
+    FUNC_ENTER_API(FAIL, H5I_INVALID_HID)
     H5TRACE4("e", "xxxx", reg_size, arr_size, blk_size, fac_size);
 
     /* Call the free list function to actually get the sizes */
     if (H5FL_get_free_list_sizes(reg_size, arr_size, blk_size, fac_size) < 0)
         HGOTO_ERROR(H5E_RESOURCE, H5E_CANTGET, FAIL, "can't get garbage collection sizes");
 
 done:
-    FUNC_LEAVE_API(ret_value)
+    FUNC_LEAVE_API(ret_value, H5I_INVALID_HID)
 } /* end H5get_free_list_sizes() */
 
 /*-------------------------------------------------------------------------
@@ -819,7 +819,7 @@ H5get_libversion(unsigned *majnum /*out*/, unsigned *minnum /*out*/, unsigned *r
 {
     herr_t ret_value = SUCCEED;
 
-    FUNC_ENTER_API(FAIL)
+    FUNC_ENTER_API(FAIL, H5I_INVALID_HID)
     H5TRACE3("e", "xxx", majnum, minnum, relnum);
 
     /* Set the version information */
@@ -831,7 +831,7 @@ H5get_libversion(unsigned *majnum /*out*/, unsigned *minnum /*out*/, unsigned *r
         *relnum = H5_VERS_RELEASE;
 
 done:
-    FUNC_LEAVE_API(ret_value)
+    FUNC_LEAVE_API(ret_value, H5I_INVALID_HID)
 } /* end H5get_libversion() */
 
 /*-------------------------------------------------------------------------
@@ -882,7 +882,7 @@ H5check_version(unsigned majnum, unsigned minnum, unsigned relnum)
     static const char  *release_mismatch_warning = RELEASE_MISMATCH_WARNING;
     herr_t              ret_value                = SUCCEED; /* Return value */
 
-    FUNC_ENTER_API_NOINIT_NOERR_NOFS
+    FUNC_ENTER_API_NOINIT_NOERR_NOFS()
     H5TRACE3("e", "IuIuIu", majnum, minnum, relnum);
 
     /* Don't check again, if we already have */
@@ -1008,7 +1008,7 @@ H5check_version(unsigned majnum, unsigned minnum, unsigned relnum)
     }
 
 done:
-    FUNC_LEAVE_API_NOFS(ret_value)
+    FUNC_LEAVE_API_NOFS(ret_value, H5I_INVALID_HID)
 } /* end H5check_version() */
 
 /*-------------------------------------------------------------------------
@@ -1028,13 +1028,13 @@ H5open(void)
 {
     herr_t ret_value = SUCCEED; /* Return value */
 
-    FUNC_ENTER_API_NOPUSH(FAIL)
+    FUNC_ENTER_API_NOPUSH(FAIL, H5I_INVALID_HID)
     /*NO TRACE*/
 
     /* all work is done by FUNC_ENTER() */
 
 done:
-    FUNC_LEAVE_API_NOPUSH(ret_value)
+    FUNC_LEAVE_API_NOPUSH(ret_value, H5I_INVALID_HID)
 } /* end H5open() */
 
 /*-------------------------------------------------------------------------
@@ -1053,7 +1053,7 @@ H5atclose(H5_atclose_func_t func, void *ctx)
     H5_atclose_node_t *new_atclose;         /* New 'atclose' node */
     herr_t             ret_value = SUCCEED; /* Return value */
 
-    FUNC_ENTER_API(FAIL)
+    FUNC_ENTER_API(FAIL, H5I_INVALID_HID)
     H5TRACE2("e", "Hc*x", func, ctx);
 
     /* Check arguments */
@@ -1073,7 +1073,7 @@ H5atclose(H5_atclose_func_t func, void *ctx)
     H5_atclose_head   = new_atclose;
 
 done:
-    FUNC_LEAVE_API(ret_value)
+    FUNC_LEAVE_API(ret_value, H5I_INVALID_HID)
 } /* end H5atclose() */
 
 /*-------------------------------------------------------------------------
@@ -1093,12 +1093,12 @@ H5close(void)
      * whole library just to release it all right away.  It is safe to call
      * this function for an uninitialized library.
      */
-    FUNC_ENTER_API_NOINIT_NOERR_NOFS
+    FUNC_ENTER_API_NOINIT_NOERR_NOFS()
     H5TRACE0("e", "");
 
     H5_term_library();
 
-    FUNC_LEAVE_API_NOFS(SUCCEED)
+    FUNC_LEAVE_API_NOFS(SUCCEED, H5I_INVALID_HID)
 } /* end H5close() */
 
 /*-------------------------------------------------------------------------
@@ -1131,7 +1131,7 @@ H5allocate_memory(size_t size, hbool_t clear)
 {
     void *ret_value = NULL;
 
-    FUNC_ENTER_API_NOINIT
+    FUNC_ENTER_API_NOINIT()
     H5TRACE2("*x", "zb", size, clear);
 
     if (0 == size)
@@ -1142,7 +1142,7 @@ H5allocate_memory(size_t size, hbool_t clear)
     else
         ret_value = H5MM_malloc(size);
 
-    FUNC_LEAVE_API_NOINIT(ret_value)
+    FUNC_LEAVE_API_NOINIT(ret_value, H5I_INVALID_HID)
 } /* end H5allocate_memory() */
 
 /*-------------------------------------------------------------------------
@@ -1174,12 +1174,12 @@ H5resize_memory(void *mem, size_t size)
 {
     void *ret_value = NULL;
 
-    FUNC_ENTER_API_NOINIT
+    FUNC_ENTER_API_NOINIT()
     H5TRACE2("*x", "*xz", mem, size);
 
     ret_value = H5MM_realloc(mem, size);
 
-    FUNC_LEAVE_API_NOINIT(ret_value)
+    FUNC_LEAVE_API_NOINIT(ret_value, H5I_INVALID_HID)
 } /* end H5resize_memory() */
 
 /*-------------------------------------------------------------------------
@@ -1197,13 +1197,13 @@ H5resize_memory(void *mem, size_t size)
 herr_t
 H5free_memory(void *mem)
 {
-    FUNC_ENTER_API_NOINIT
+    FUNC_ENTER_API_NOINIT()
     H5TRACE1("e", "*x", mem);
 
     /* At this time, it is impossible for this to fail. */
     H5MM_xfree(mem);
 
-    FUNC_LEAVE_API_NOINIT(SUCCEED)
+    FUNC_LEAVE_API_NOINIT(SUCCEED, H5I_INVALID_HID)
 } /* end H5free_memory() */
 
 /*-------------------------------------------------------------------------
@@ -1221,7 +1221,7 @@ H5is_library_threadsafe(hbool_t *is_ts /*out*/)
 {
     herr_t ret_value = SUCCEED; /* Return value */
 
-    FUNC_ENTER_API_NOINIT
+    FUNC_ENTER_API_NOINIT()
     H5TRACE1("e", "x", is_ts);
 
     if (is_ts) {
@@ -1234,7 +1234,7 @@ H5is_library_threadsafe(hbool_t *is_ts /*out*/)
     else
         ret_value = FAIL;
 
-    FUNC_LEAVE_API_NOINIT(ret_value)
+    FUNC_LEAVE_API_NOINIT(ret_value, H5I_INVALID_HID)
 } /* end H5is_library_threadsafe() */
 
 /*-------------------------------------------------------------------------
@@ -1256,7 +1256,7 @@ H5is_library_terminating(hbool_t *is_terminating /*out*/)
 {
     herr_t ret_value = SUCCEED; /* Return value */
 
-    FUNC_ENTER_API_NOINIT
+    FUNC_ENTER_API_NOINIT()
     H5TRACE1("e", "x", is_terminating);
 
     assert(is_terminating);
@@ -1266,7 +1266,7 @@ H5is_library_terminating(hbool_t *is_terminating /*out*/)
     else
         ret_value = FAIL;
 
-    FUNC_LEAVE_API_NOINIT(ret_value)
+    FUNC_LEAVE_API_NOINIT(ret_value, H5I_INVALID_HID)
 } /* end H5is_library_terminating() */
 
 #if defined(H5_HAVE_THREADSAFE) && defined(H5_BUILT_AS_DYNAMIC_LIB) && defined(H5_HAVE_WIN32_API) &&         \
@@ -1328,3 +1328,18 @@ DllMain(_In_ HINSTANCE hinstDLL, _In_ DWORD fdwReason, _In_ LPVOID lpvReserved)
     return fOkay;
 }
 #endif /* H5_HAVE_WIN32_API && H5_BUILT_AS_DYNAMIC_LIB && H5_HAVE_WIN_THREADS && H5_HAVE_THREADSAFE*/
+
+#if defined(H5_HAVE_THREADSAFE) || defined(H5_HAVE_MULTITHREAD)
+// TODO
+bool H5_varname_is_id(const char *varname) {
+    const char *suffix = "_id";
+    size_t len_var = strlen(varname);
+    size_t len_suffix = strlen(suffix);
+
+    if (len_var < len_suffix) {
+        return false;
+    }
+
+    return strcmp(varname + len_var - len_suffix, suffix) == 0;
+}
+#endif