Merge pull request #1708 in HDFFV/hdf5 from ~BRTNFLD/hdf5_msb:H10621 to develop

* commit '0742c15fca95965ed4eb87c6d54f41bb07bd4526':
  makefile clean-up
  move the vol_info to an optional parameter
  added H5Pset_vol
  added vol connector
  added test for vol_connector
  removed H5VL constants
  removed VOLL NULL connector and replaced it with native VOL
  added connector_name test
  added missing files
  add tests
  added more tests
  added missing files
  Implemented VOL APIs and C constants, no tests
  Implemented VOL APIs and C constants, no tests
  initial API impl.

4 files changed, 352 insertions, 1 deletions

diff --git a/fortran/test/CMakeLists.txt b/fortran/test/CMakeLists.txt
index b862fcd..719a9f3 100644
--- a/fortran/test/CMakeLists.txt
+++ b/fortran/test/CMakeLists.txt
@@ -569,4 +569,65 @@ if (BUILD_SHARED_LIBS)
   add_dependencies (fflush2-shared ${HDF5_F90_TEST_LIBSH_TARGET})
 endif ()
 
+#-- Adding test for vol_connector
+add_executable (vol_connector vol_connector.F90)
+target_include_directories (vol_connector
+    PRIVATE
+        ${CMAKE_Fortran_MODULE_DIRECTORY}/static
+)
+target_compile_options(vol_connector
+    PRIVATE
+        $<$<STREQUAL:"x${CMAKE_Fortran_SIMULATE_ID}","xMSVC">:${WIN_COMPILE_FLAGS}>
+)
+target_link_libraries (vol_connector
+    PRIVATE
+        ${HDF5_F90_LIB_TARGET} ${HDF5_F90_TEST_LIB_TARGET} ${HDF5_LIB_TARGET} $<$<PLATFORM_ID:Windows>:ws2_32.lib>
+)
+#set_property(TARGET vol_connector APPEND PROPERTY
+#    LINK_FLAGS $<$<STREQUAL:"x${CMAKE_Fortran_SIMULATE_ID}","xMSVC">:"-SUBSYSTEM:CONSOLE">
+#)
+#set_property(TARGET vol_connector APPEND PROPERTY
+#    LINK_FLAGS $<$<STREQUAL:"x${CMAKE_Fortran_SIMULATE_ID}","xMSVC">:${WIN_LINK_FLAGS}>
+#)
+if(MSVC)
+  set_property(TARGET vol_connector PROPERTY LINK_FLAGS "/SUBSYSTEM:CONSOLE ${WIN_LINK_FLAGS}")
+endif()
+set_target_properties (vol_connector PROPERTIES
+    LINKER_LANGUAGE Fortran
+    FOLDER test/fortran
+    Fortran_MODULE_DIRECTORY ${CMAKE_Fortran_MODULE_DIRECTORY}/static
+)
+add_dependencies (vol_connector ${HDF5_F90_TEST_LIB_TARGET})
+
+if (BUILD_SHARED_LIBS)
+  add_executable (vol_connector-shared vol_connector.F90)
+  target_include_directories (vol_connector-shared
+      PRIVATE
+          ${CMAKE_Fortran_MODULE_DIRECTORY}/shared
+  )
+  target_compile_options(vol_connector-shared
+      PRIVATE
+          $<$<STREQUAL:"x${CMAKE_Fortran_SIMULATE_ID}","xMSVC">:${WIN_COMPILE_FLAGS}>
+  )
+  target_link_libraries (vol_connector-shared
+      PRIVATE
+          ${HDF5_F90_LIBSH_TARGET} ${HDF5_F90_TEST_LIBSH_TARGET} ${HDF5_LIBSH_TARGET} $<$<PLATFORM_ID:Windows>:ws2_32.lib>
+  )
+#  set_property(TARGET vol_connector-shared APPEND PROPERTY
+#      LINK_FLAGS $<$<STREQUAL:"x${CMAKE_Fortran_SIMULATE_ID}","xMSVC">:"-SUBSYSTEM:CONSOLE">
+#  )
+#  set_property(TARGET vol_connector-shared APPEND PROPERTY
+#      LINK_FLAGS $<$<STREQUAL:"x${CMAKE_Fortran_SIMULATE_ID}","xMSVC">:${WIN_LINK_FLAGS}>
+#  )
+  if(MSVC)
+    set_property(TARGET vol_connector-shared  PROPERTY LINK_FLAGS "/SUBSYSTEM:CONSOLE ${WIN_LINK_FLAGS}")
+  endif()
+  set_target_properties (vol_connector-shared PROPERTIES
+      LINKER_LANGUAGE Fortran
+      FOLDER test/fortran
+      Fortran_MODULE_DIRECTORY ${CMAKE_Fortran_MODULE_DIRECTORY}/shared
+  )
+  add_dependencies (vol_connector-shared ${HDF5_F90_TEST_LIBSH_TARGET})
+endif ()
+
 include (CMakeTests.cmake)
diff --git a/fortran/test/CMakeTests.cmake b/fortran/test/CMakeTests.cmake
index 5fa10f4..306a3f8 100644
--- a/fortran/test/CMakeTests.cmake
+++ b/fortran/test/CMakeTests.cmake
@@ -130,6 +130,10 @@ set_tests_properties (FORTRAN_fflush1 PROPERTIES DEPENDS FORTRAN_testhdf5-clear-
 add_test (NAME FORTRAN_fflush2 COMMAND $<TARGET_FILE:fflush2>)
 set_tests_properties (FORTRAN_fflush2 PROPERTIES DEPENDS FORTRAN_fflush1)
 
+#-- Adding test for vol_connector
+add_test (NAME FORTRAN_vol_connector COMMAND $<TARGET_FILE:vol_connector>)
+set_tests_properties (FORTRAN_vol_connector PROPERTIES DEPENDS FORTRAN_testhdf5-clear-objects)
+
 if (BUILD_SHARED_LIBS)
   add_test (
     NAME FORTRAN_testhdf5-shared-clear-objects
@@ -239,4 +243,8 @@ if (BUILD_SHARED_LIBS)
   #-- Adding test for fflush2
   add_test (NAME FORTRAN_fflush2-shared COMMAND $<TARGET_FILE:fflush2-shared>)
   set_tests_properties (FORTRAN_fflush2-shared PROPERTIES DEPENDS FORTRAN_fflush1-shared)
+
+  #-- Adding test for vol_connector
+  add_test (NAME FORTRAN_vol_connector-shared COMMAND $<TARGET_FILE:vol_connector-shared>)
+  set_tests_properties (FORTRAN_vol_connector-shared PROPERTIES DEPENDS FORTRAN_vol_connector-shared)
 endif ()
diff --git a/fortran/test/Makefile.am b/fortran/test/Makefile.am
index 8613cf9..f0d7f03 100644
--- a/fortran/test/Makefile.am
+++ b/fortran/test/Makefile.am
@@ -35,7 +35,7 @@ else
 endif
 
 # Our main targets, the tests themselves
-TEST_PROG=fortranlib_test fflush1 fflush2 fortranlib_test_1_8 fortranlib_test_F03
+TEST_PROG=fortranlib_test fflush1 fflush2 fortranlib_test_1_8 fortranlib_test_F03 vol_connector
 
 check_PROGRAMS=$(TEST_PROG)
 
@@ -50,6 +50,7 @@ fortranlib_test_1_8_SOURCES = tH5O.F90 tH5A_1_8.F90 tH5G_1_8.F90 tH5MISC_1_8.F90
 fortranlib_test_F03_SOURCES = tH5E_F03.F90 tH5F_F03.F90 tH5L_F03.F90 \
         tH5O_F03.F90 tH5P_F03.F90 tH5T_F03.F90 tHDF5_F03.F90 fortranlib_test_F03.F90
 
+vol_connector_SOURCES=vol_connector.F90
 
 fflush1_SOURCES=fflush1.F90
 fflush2_SOURCES=fflush2.F90
diff --git a/fortran/test/vol_connector.F90 b/fortran/test/vol_connector.F90
new file mode 100644
index 0000000..62e3f8d
--- /dev/null
+++ b/fortran/test/vol_connector.F90
@@ -0,0 +1,281 @@
+!****h* root/fortran/test/vol_connector.F90
+!
+! NAME
+!  vol_connector.F90
+!
+! FUNCTION
+!
+!  Tests basic Fortran VOL plugin operations (registration, etc.).
+!  Uses the null VOL connector (built with the testing code)
+!  which is loaded as a dynamic plugin.
+!
+! COPYRIGHT
+! * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
+!   Copyright by The HDF Group.                                               *
+!   Copyright by the Board of Trustees of the University of Illinois.         *
+!   All rights reserved.                                                      *
+!                                                                             *
+!   This file is part of HDF5.  The full HDF5 copyright notice, including     *
+!   terms governing use, modification, and redistribution, is contained in    *
+!   the COPYING file, which can be found at the root of the source code       *
+!   distribution tree, or in https://support.hdfgroup.org/ftp/HDF5/releases.  *
+!   If you do not have access to either file, you may request a copy from     *
+!   help@hdfgroup.org.                                                        *
+! * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
+!
+!*****
+
+MODULE VOL_TMOD
+
+  USE HDF5
+  USE THDF5_F03
+  IMPLICIT NONE
+
+  INTEGER, PARAMETER :: NATIVE_VOL_CONNECTOR_VALUE = 0
+  CHARACTER(LEN=6), PARAMETER :: NATIVE_VOL_CONNECTOR_NAME = "native"
+
+CONTAINS
+
+  !-------------------------------------------------------------------------
+  ! Function:    test_registration_by_name()
+  !
+  ! Purpose:     Tests if we can load, register, and close a VOL
+  !              connector by name.
+  !
+  !-------------------------------------------------------------------------
+  !
+
+  SUBROUTINE test_registration_by_name(total_error)
+
+    IMPLICIT NONE
+
+    INTEGER, INTENT(INOUT) :: total_error
+    INTEGER :: error = 0
+
+    LOGICAL :: is_registered = .FALSE.
+    INTEGER(hid_t) :: vol_id = 0, vol_id_out = 1
+    CHARACTER(LEN=64) :: name
+    INTEGER(SIZE_T) :: name_len
+    INTEGER(hid_t) :: file_id
+    INTEGER :: cmp = -1
+
+    ! The null VOL connector should not be registered at the start of the test
+    CALL H5VLis_connector_registered_f( "FAKE_VOL_CONNECTOR_NAME", is_registered, error)
+    CALL check("H5VLis_connector_registered_f",error,total_error)
+    CALL VERIFY("H5VLis_connector_registered_f", is_registered, .FALSE., total_error)
+
+    ! Register the connector by name
+    CALL H5VLregister_connector_by_name_f(NATIVE_VOL_CONNECTOR_NAME, vol_id, error)
+    CALL check("H5VLregister_connector_by_name_f",error,total_error)
+    
+    ! The connector should be registered now
+    CALL H5VLis_connector_registered_f(NATIVE_VOL_CONNECTOR_NAME, is_registered, error)
+    CALL check("H5VLis_connector_registered_f",error,total_error)
+    CALL VERIFY("H5VLis_connector_registered_f", is_registered, .TRUE., total_error)
+
+    CALL H5VLget_connector_id_f(NATIVE_VOL_CONNECTOR_NAME, vol_id_out, error)
+    CALL check("H5VLget_connector_id_f",error,total_error)
+
+    CALL H5Fcreate_f("voltest.h5",H5F_ACC_TRUNC_F, file_id, error)
+    CALL check("H5F_create_f",error,total_error)
+
+    CALL H5VLget_connector_name_f(file_id, name, error, name_len)
+    CALL check("H5VLget_connector_name_f",error,total_error)
+    CALL VERIFY("H5VLget_connector_name_f", INT(name_len), LEN_TRIM(NATIVE_VOL_CONNECTOR_NAME), total_error)
+
+    CALL H5VLget_connector_name_f(file_id, name, error)
+    CALL check("H5VLget_connector_name_f",error,total_error)
+    CALL VERIFY("H5VLget_connector_name_f", name, NATIVE_VOL_CONNECTOR_NAME, total_error)
+
+    CALL H5Fclose_f(file_id, error)
+    CALL check("H5Fclose_f",error,total_error)
+
+    CALL H5VLclose_f(vol_id_out, error)
+    CALL check("H5VLclose_f",error, total_error)
+
+    ! Unregister the connector
+    CALL H5VLunregister_connector_f(vol_id, error)
+    CALL check("H5VLunregister_connector_f", error, total_error)
+
+  END SUBROUTINE test_registration_by_name
+
+  !-------------------------------------------------------------------------
+  ! Function:    test_registration_by_value()
+  !
+  ! Purpose:     Tests if we can load, register, and close a VOL
+  !              connector by value.
+  !
+  !-------------------------------------------------------------------------
+
+  SUBROUTINE test_registration_by_value(total_error)
+
+    IMPLICIT NONE
+
+    INTEGER, INTENT(INOUT) :: total_error
+    INTEGER :: error = 0
+    
+    LOGICAL :: is_registered = .FALSE.
+    INTEGER(hid_t) :: vol_id = 0
+
+
+    ! The null VOL connector should not be registered at the start of the test
+    CALL H5VLis_connector_registered_f( "FAKE_VOL_CONNECTOR_NAME", is_registered, error)
+    CALL check("H5VLis_connector_registered_f",error,total_error)
+    CALL VERIFY("H5VLis_connector_registered_f", is_registered, .FALSE., total_error)
+
+    ! Register the connector by value
+    CALL H5VLregister_connector_by_value_f(NATIVE_VOL_CONNECTOR_VALUE, vol_id, error)
+    CALL check("H5VLregister_connector_by_value_f", error, total_error)
+
+    ! The connector should be registered now
+    CALL H5VLis_connector_registered_f(NATIVE_VOL_CONNECTOR_NAME, is_registered, error)
+    CALL check("H5VLis_connector_registered_f",error,total_error)
+    CALL VERIFY("H5VLis_connector_registered_f", is_registered, .TRUE., total_error)
+
+    ! Unregister the connector
+    CALL H5VLunregister_connector_f(vol_id, error)
+    CALL check("H5VLunregister_connector_f", error, total_error)
+
+  END SUBROUTINE test_registration_by_value
+
+
+  !-------------------------------------------------------------------------
+  ! Function:    test_registration_by_name()
+  !
+  ! Purpose:     Tests if we can load, register, and close a VOL
+  !              connector by name.
+  !
+  !-------------------------------------------------------------------------
+  !
+
+  SUBROUTINE test_registration_by_fapl(total_error)
+
+    IMPLICIT NONE
+
+    INTEGER, INTENT(INOUT) :: total_error
+    INTEGER :: error = 0
+
+    LOGICAL :: is_registered = .FALSE.
+    INTEGER(hid_t) :: vol_id = 0, vol_id_out = 1
+    CHARACTER(LEN=64) :: name
+    INTEGER(SIZE_T) :: name_len
+    INTEGER(hid_t) :: file_id
+    INTEGER :: cmp = -1
+    INTEGER(hid_t) :: fapl_id
+    TYPE(C_PTR) :: f_ptr
+    INTEGER(hid_t), TARGET :: under_fapl
+
+    CALL H5VLis_connector_registered_f( "FAKE_VOL_CONNECTOR_NAME", is_registered, error)
+    CALL check("H5VLis_connector_registered_f",error,total_error)
+    CALL VERIFY("H5VLis_connector_registered_f", is_registered, .FALSE., total_error)
+
+
+    ! The null VOL connector should not be registered at the start of the test
+    CALL H5VLis_connector_registered_f( "FAKE_VOL_CONNECTOR_NAME", is_registered, error)
+    CALL check("H5VLis_connector_registered_f",error,total_error)
+    CALL VERIFY("H5VLis_connector_registered_f", is_registered, .FALSE., total_error)
+
+    CALL H5VLregister_connector_by_name_f(NATIVE_VOL_CONNECTOR_NAME, vol_id, error)
+    CALL check("H5VLregister_connector_by_name_f",error,total_error)
+    
+    ! The connector should be registered now
+    CALL H5VLis_connector_registered_f(NATIVE_VOL_CONNECTOR_NAME, is_registered, error)
+    CALL check("H5VLis_connector_registered_f",error,total_error)
+    CALL VERIFY("H5VLis_connector_registered_f", is_registered, .TRUE., total_error)
+
+    ! Register the connector
+    CALL H5Pcreate_f(H5P_FILE_ACCESS_F, fapl_id, error)
+    CALL check("H5Pcreate_f",error,total_error)
+
+    f_ptr = C_NULL_PTR
+    CALL H5Pset_vol_f(fapl_id, vol_id, error)
+    CALL check("H5Pset_vol_f",error,total_error)
+
+    CALL H5Pget_vol_id_f(fapl_id, vol_id_out, error)
+    CALL check("H5Pget_vol_id_f",error,total_error)
+    CALL VERIFY("H5Pget_vol_id_f", vol_id_out, vol_id, total_error)
+
+    f_ptr = C_NULL_PTR
+    CALL H5Pset_vol_f(fapl_id, vol_id, error, f_ptr)
+    CALL check("H5Pset_vol_f",error,total_error)
+
+    CALL H5Pget_vol_id_f(fapl_id, vol_id_out, error)
+    CALL check("H5Pget_vol_id_f",error,total_error)
+    CALL VERIFY("H5Pget_vol_id_f", vol_id_out, vol_id, total_error)
+
+    CALL H5VLget_connector_id_f(NATIVE_VOL_CONNECTOR_NAME, vol_id_out, error)
+    CALL check("H5VLget_connector_id_f",error,total_error)
+    CALL VERIFY("H5VLget_connector_id_f", vol_id_out, vol_id, total_error)
+
+    CALL H5Fcreate_f("voltest.h5",H5F_ACC_TRUNC_F, file_id, error, H5P_DEFAULT_F, fapl_id)
+    CALL check("H5F_create_f",error,total_error)
+
+    CALL H5VLclose_f(vol_id_out, error)
+    CALL check("H5VLclose_f",error, total_error)
+
+    CALL H5VLclose_f(vol_id, error)
+    CALL check("H5VLclose_f",error, total_error)
+
+    ! Unregister the connector
+    CALL H5VLunregister_connector_f(vol_id, error)
+    CALL check("H5VLunregister_connector_f", error, total_error)
+
+    CALL H5Fclose_f(file_id, error)
+    CALL check("H5Fclose_f",error,total_error)
+
+    CALL H5Pclose_f(fapl_id, error)
+    CALL check("H5Pclose_f",error,total_error)
+
+  END SUBROUTINE test_registration_by_fapl
+
+
+END MODULE VOL_TMOD
+
+
+PROGRAM vol_connector
+
+  USE HDF5
+  USE THDF5_F03
+  USE VOL_TMOD
+
+  IMPLICIT NONE
+  INTEGER :: total_error = 0
+  INTEGER :: error
+  INTEGER :: ret_total_error
+  LOGICAL :: cleanup, status
+
+  CALL h5open_f(error)
+
+  cleanup = .TRUE.
+  CALL h5_env_nocleanup_f(status)
+  IF(status) cleanup=.FALSE.
+
+  WRITE(*,'(18X,A)') '=============================='
+  WRITE(*,'(24X,A)') 'FORTRAN VOL tests'
+  WRITE(*,'(18X,A)') '=============================='
+
+  WRITE(*,'(A)') "Testing VOL connector plugin functionality."
+  ret_total_error = 0
+  CALL test_registration_by_name(ret_total_error)
+  CALL write_test_status(ret_total_error, ' Testing VOL registration by name', total_error)
+
+  ret_total_error = 0
+  CALL test_registration_by_value(ret_total_error)
+  CALL write_test_status(ret_total_error, ' Testing VOL registration by value', total_error)
+
+  ret_total_error = 0
+  CALL test_registration_by_fapl(ret_total_error)
+  CALL write_test_status(ret_total_error, ' Testing VOL registration by fapl', total_error)
+
+  WRITE(*, fmt = '(/18X,A)') '============================================'
+  WRITE(*, fmt = '(19X, A)', advance='NO') ' FORTRAN VOL tests completed with '
+  WRITE(*, fmt = '(I4)', advance='NO') total_error
+  WRITE(*, fmt = '(A)' ) ' error(s) ! '
+  WRITE(*,'(18X,A)') '============================================'
+  
+  CALL h5close_f(error)
+
+  ! if errors detected, exit with non-zero code.
+  IF (total_error .NE. 0) CALL h5_exit_f(1)
+
+END PROGRAM vol_connector