Merge pull request #423 from sourceryinstitute/issue-422-better-error-message

Fixes #422: better error message & more unit tests

Author: zbeekman

CMakeLists.txt

@@ -151,7 +151,7 @@ endif()
     set(opencoarrays_aware_compiler false)
     add_definitions(-DPREFIX_NAME=_caf_extensions_)
   endif()
-  if(gfortran_compiler AND (CMAKE_Fortran_COMPILER_VERSION VERSION_LESS 5.4))
+  if(gfortran_compiler AND (CMAKE_Fortran_COMPILER_VERSION VERSION_LESS 5.4.0))
     # GCC patch to fix issue accepted for 5.4 release
     # See https://github.com/sourceryinstitute/opencoarrays/issues/28 and
     # https://groups.google.com/forum/#!msg/opencoarrays/RZOwwYTqG80/46S9eL696dgJ
@@ -537,7 +537,12 @@ if(opencoarrays_aware_compiler)
   add_mpi_test(register_alloc_vector 2 ${tests_root}/unit/init_register/register_alloc_vector)
   add_mpi_test(allocate_as_barrier 2 ${tests_root}/unit/init_register/allocate_as_barrier)
   add_mpi_test(allocate_as_barrier_proc 8 ${tests_root}/unit/init_register/allocate_as_barrier_proc)
-  if (gfortran_compiler AND (NOT CMAKE_Fortran_COMPILER_VERSION VERSION_LESS 7))
+  if (gfortran_compiler AND (NOT CMAKE_Fortran_COMPILER_VERSION VERSION_LESS 7.0.0) OR (CAF_RUN_DEVELOPER_TESTS OR $ENV{OPENCOARRAYS_DEVELOPER}))
+    message( STATUS "Allocatable components of coarray derived types only supported in GFortran >= 7 with OpenCoarrays > 1.8.4" )
+    message( STATUS "(but full support not anticipated until OpenCoarrays 2.0 release)" )
+    if (CMAKE_Fortran_COMPILER_VERSION VERSION_LESS 7.0.0)
+      message( WARNING "Allocatable components of coarray derived type developer tests enabled, despite lack of support in GFortran < 7\n These tests should fail." )
+    endif()
     add_mpi_test(register_alloc_comp_1 2 ${tests_root}/unit/init_register/register_alloc_comp_1)
     add_mpi_test(register_alloc_comp_2 2 ${tests_root}/unit/init_register/register_alloc_comp_2)
     add_mpi_test(register_alloc_comp_3 2 ${tests_root}/unit/init_register/register_alloc_comp_3)
@@ -560,6 +565,7 @@ if(opencoarrays_aware_compiler)
   add_mpi_test(duplicate_syncimages 8 ${tests_root}/unit/sync/duplicate_syncimages)
   add_mpi_test(co_reduce 4 ${tests_root}/unit/collectives/co_reduce_test)
   add_mpi_test(co_reduce_res_im 4 ${tests_root}/unit/collectives/co_reduce_res_im)
+  add_mpi_test(co_reduce_string 4 ${tests_root}/unit/collectives/co_reduce_string)
   add_mpi_test(syncimages_status 8 ${tests_root}/unit/sync/syncimages_status)
   add_mpi_test(sync_ring_abort_np3 3 ${tests_root}/unit/sync/sync_image_ring_abort_on_stopped_image)
   add_mpi_test(sync_ring_abort_np7 7 ${tests_root}/unit/sync/sync_image_ring_abort_on_stopped_image)
@@ -574,21 +580,33 @@ if(opencoarrays_aware_compiler)
   add_mpi_test(asynchronous_hello_world 3 ${tests_root}/integration/events/asynchronous_hello_world)
 
   # Regression tests based on reported issues
-  if(gfortran_compiler AND (NOT CMAKE_Fortran_COMPILER_VERSION VERSION_LESS 7.0.0))
-    # GFortran PR 78505 only fixed on trunk/gcc 7
+  if((gfortran_compiler AND (NOT CMAKE_Fortran_COMPILER_VERSION VERSION_LESS 7.0.0)) OR (CAF_RUN_DEVELOPER_TESTS OR $ENV{OPENCOARRAYS_DEVELOPER}))
+    if( CMAKE_Fortran_COMPILER_VERSION VERSION_LESS 7.0.0 )
+      message( WARNING "Developer tests requested and GFortran < 7: test source-alloc-no-sync may fail" )
+    endif()
+    # GFortran PR 78505 only fixed on trunk/gcc 7, issue #243
     add_mpi_test(source-alloc-no-sync 8 ${tests_root}/regression/reported/source-alloc-sync)
   endif()
-  if (CAF_RUN_DEVELOPER_TESTS OR $ENV{OPENCOARRAYS_DEVELOPER})
+
+  # Open GCC 7 regressions
+  if ((CAF_RUN_DEVELOPER_TESTS OR $ENV{OPENCOARRAYS_DEVELOPER}) OR (gfortran_compiler AND (CMAKE_Fortran_COMPILER_VERSION VERSION_LESS 7.0.0)))
     add_mpi_test(convert-before-put 3 ${tests_root}/regression/reported/convert-before-put)
+    add_mpi_test(put-alloc-comp 2 ${tests_root}/regression/reported/issue-422-send)
+    add_mpi_test(get-put-alloc-comp 3 ${tests_root}/regression/reported/issue-422-send-get)
   endif()
+
+  # Fixed GCC 7 regressions, should run on GCC 6 and 7
   add_mpi_test(event-post 3 ${tests_root}/regression/reported/event-post)
+
+  # These co_reduce (#172, fixed by PR #332, addl discussion in PR
+  # #331) tests are for bugs not regressions. Should be fixed in all
+  # version of GCC, I beleive
   add_mpi_test(co_reduce-factorial 4 ${tests_root}/regression/reported/co_reduce-factorial)
   add_mpi_test(co_reduce-factorial-int8 4 ${tests_root}/regression/reported/co_reduce-factorial-int8)
   add_mpi_test(co_reduce-factorial-int64 4 ${tests_root}/regression/reported/co_reduce-factorial-int64)
-  add_mpi_test(co_reduce_string 4 ${tests_root}/unit/collectives/co_reduce_string)
 
   # IMAGE FAIL tests
-  if(NOT CMAKE_Fortran_COMPILER_VERSION VERSION_LESS 7)
+  if(NOT CMAKE_Fortran_COMPILER_VERSION VERSION_LESS 7.0.0)
     add_mpi_test(image_status_test_1 4 ${tests_root}/unit/fail_images/image_status_test_1)
     if(CAF_ENABLE_FAILED_IMAGES)
       # No other way to check that image_fail_test_1 passes.

src/mpi/mpi_caf.c

@@ -595,7 +595,7 @@ void mutex_lock(MPI_Win win, int image_index, int index, int *stat,
 #endif
 
       locking_atomic_op(win, &value, newval, compare, image_index, index);
-#ifdef WITH_FAILED_IMAGES      
+#ifdef WITH_FAILED_IMAGES
       if (image_stati[value] == STAT_FAILED_IMAGE)
         {
           CAF_Win_lock (MPI_LOCK_EXCLUSIVE, image_index - 1, win);
@@ -613,7 +613,7 @@ void mutex_lock(MPI_Win win, int image_index, int index, int *stat,
     *stat = ierr;
   else if (ierr == STAT_FAILED_IMAGE)
     terminate_internal (ierr, 0);
-  
+
   return;
 
 stat_error:
@@ -659,7 +659,7 @@ void mutex_unlock(MPI_Win win, int image_index, int index, int *stat,
     *stat = ierr;
   else if(ierr == STAT_FAILED_IMAGE)
     terminate_internal (ierr, 0);
-      
+
   return;
 
 stat_error:
@@ -4436,7 +4436,7 @@ PREFIX (event_post) (caf_token_t token, size_t index,
 
   if(!stat && ierr == STAT_FAILED_IMAGE)
     terminate_internal (ierr, 0);
-  
+
   if(ierr != MPI_SUCCESS)
     {
       if(stat != NULL)
@@ -4498,7 +4498,7 @@ PREFIX (event_wait) (caf_token_t token, size_t index,
 
   if(!stat && ierr == STAT_FAILED_IMAGE)
     terminate_internal (ierr, 0);
-  
+
   if(ierr != MPI_SUCCESS)
     {
       if(stat != NULL)
@@ -4796,10 +4796,11 @@ unsupported_fail_images_message (const char * functionname)
 void
 unimplemented_alloc_comps_message (const char * functionname)
 {
-  fprintf (stderr, "*** caf_mpi-lib runtime message on image %d:\n"
-           "*** The allocatable components feature '%s' of Fortran 2008 standard\n"
-           "*** is not yet supported by OpenCoarrays.\n",
-           caf_this_image, functionname);
+  fprintf (stderr,
+           "*** Message from libcaf_mpi runtime function '%s' on image %d:\n"
+           "*** Assigning to an allocatable coarray component of a derived type is not yet supported with GCC 7.\n"
+           "*** Either revert to GCC 6 or convert all puts (type(foo)::x; x%%y[recipient] = z) to gets (z = x%%y[provider]).\n",
+           functionname, caf_this_image );
 #ifdef STOP_ON_UNSUPPORTED
   exit (EXIT_FAILURE);
 #endif

src/tests/regression/open/issue-422-send.f90

@@ -0,0 +1 @@
+../reported/issue-422-send.f90

src/tests/regression/open/issue-422-sendget.f90

@@ -0,0 +1 @@
+../reported/issue-422-sendget.f90

src/tests/regression/reported/CMakeLists.txt

@@ -16,3 +16,8 @@ target_link_libraries(convert-before-put OpenCoarrays)
 add_executable(event-post issue-293-silent-event-failure.F90)
 target_link_libraries(event-post OpenCoarrays)
 
+add_executable(issue-422-send issue-422-send.F90)
+target_link_libraries(issue-422-send OpenCoarrays)
+
+add_executable(issue-422-send-get issue-422-send-get.F90)
+target_link_libraries(issue-422-send-get OpenCoarrays)

src/tests/regression/reported/issue-422-send-get.F90

@@ -0,0 +1,92 @@
+! BSD 3-Clause License
+!
+! Copyright (c) 2016, Sourcery Institute
+! All rights reserved.
+!
+! Redistribution and use in source and binary forms, with or without
+! modification, are permitted provided that the following conditions are met:
+!
+! * Redistributions of source code must retain the above copyright notice, this
+!   list of conditions and the following disclaimer.
+!
+! * Redistributions in binary form must reproduce the above copyright notice,
+!   this list of conditions and the following disclaimer in the documentation
+!   and/or other materials provided with the distribution.
+!
+! * Neither the name of the copyright holder nor the names of its
+!   contributors may be used to endorse or promote products derived from
+!   this software without specific prior written permission.
+!
+! THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+! AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+! IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+! DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+! FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+! DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+! SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+! CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+! OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+! OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+program main
+  !! author: Damian Rouson
+  !! date: 2017-08-01
+  !! category: regression
+  !! Test whether assigning an allocatable coarray component to an allocatable
+  !! coarray component works.
+  !! OpenCoarrays issue #422
+  use iso_fortran_env, only : error_unit
+  implicit none
+
+  type foo
+    !! A derived type is required to demonstrate issue #422
+    integer, allocatable :: bar(:)[:]
+  end type
+  type(foo) :: foobar
+
+  enum, bind(C)
+    enumerator :: recipient=1, provider, getter_putter
+    !! provider=2, getter_putter=3
+  end enum
+
+  integer, parameter :: bar_size=2, required_images=3
+
+  associate( me=>this_image(), N_images=>num_images() )
+
+    verify_num_images: if (N_images<required_images) then
+      write(error_unit,*)  "issue-422-send-get.f90 requires at least ",required_images," images"
+      error stop
+    end if verify_num_images
+
+    allocate(foobar%bar(bar_size)[*],source=me)
+    !! Assign each image's identifier to each element of foobar%bar
+#ifndef GCC_GE_7
+    sync all
+      !! Issue #243 not backported to GCC < 7: implicit sync happens
+      !! after allocataion but before assignment
+#endif
+
+    get_put_component: if (me==getter_putter) then
+      foobar%bar(:)[recipient] =  foobar%bar(:)[provider]
+        !! Get bar from provider image and put bar on recipient image
+      sync images(recipient)
+        !! Signal recipient that get and put have completed
+    end if get_put_component
+
+    wait_and_verify: if (me==recipient) then
+      sync images(getter_putter)
+        !! Wait for signal from getter-putter
+
+      verify_result: if (any(foobar%bar/=provider)) then
+        write(error_unit,*) "Recipient image ",recipient," received ",foobar%bar," but expected ",provider
+        error stop
+      end if verify_result
+
+      print *,"Test passed."
+        !! Report success
+
+    end if wait_and_verify
+
+  end associate
+
+end program

src/tests/regression/reported/issue-422-send.F90

@@ -0,0 +1,93 @@
+! BSD 3-Clause License
+!
+! Copyright (c) 2016, Sourcery Institute
+! All rights reserved.
+!
+! Redistribution and use in source and binary forms, with or without
+! modification, are permitted provided that the following conditions are met:
+!
+! * Redistributions of source code must retain the above copyright notice, this
+!   list of conditions and the following disclaimer.
+!
+! * Redistributions in binary form must reproduce the above copyright notice,
+!   this list of conditions and the following disclaimer in the documentation
+!   and/or other materials provided with the distribution.
+!
+! * Neither the name of the copyright holder nor the names of its
+!   contributors may be used to endorse or promote products derived from
+!   this software without specific prior written permission.
+!
+! THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+! AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+! IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+! DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+! FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+! DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+! SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+! CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+! OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+! OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+program main
+  !! author: Damian Rouson
+  !! date: 2017-08-01
+  !! category: regression
+  !! Test whether assigning an allocatable coarray component to an allocatable
+  !! coarray component works.
+  !! OpenCoarrays issue #422
+  use iso_fortran_env, only : error_unit
+  implicit none
+
+  type foo
+    !! A derived type is required to demonstrate issue #422
+    integer, allocatable :: bar(:)[:]
+  end type
+  type(foo) :: foobar
+
+  enum, bind(C)
+    enumerator :: recipient=1, provider
+    !! provider=2
+  end enum
+
+  integer, parameter :: message(*)=[3,4], required_images=2
+    !! Data for provider image to put on recipient image
+
+  associate( me=>this_image(), N_images=>num_images() )
+
+    verify_num_images: if (N_images<required_images) then
+      write(error_unit,*)  "issue-422-send.f90 requires at least ",required_images," images"
+      error stop
+    end if verify_num_images
+
+    allocate(foobar%bar(size(message))[*],source=me)
+      !! Assign each image's identifier to each element of foobar%bar
+#ifndef GCC_GE_7
+    sync all
+      !! Fix to #243 has not been backported to GCC < 7. Implicit sync
+      !! happens after allocation but before sourced assignment
+#endif
+
+    get_put_component: if (me==provider) then
+      foobar%bar(:)[recipient] =  message
+        !! Get bar from provider image and put bar on recipient image
+      sync images(recipient)
+        !! Signal recipient that get and put have completed
+    end if get_put_component
+
+    wait_and_verify: if (me==recipient) then
+      sync images(provider)
+        !! Wait for signal from provider image
+
+      verify_result: if (any(foobar%bar/=message)) then
+        write(error_unit,*) "Recipient image ",recipient," received ",foobar%bar," but expected ",provider
+        error stop
+      end if verify_result
+
+      print *,"Test passed."
+        !! Report success
+
+    end if wait_and_verify
+
+  end associate
+
+end program