Merge pull request #465 from sourceryinstitute/issue-461-and-issue-457

Fix Issue 461 and issue 457

Author: zbeekman

CMakeLists.txt

@@ -500,6 +500,22 @@ function(check_script_style script_full_path)
   endif()
 endfunction()
 
+#------------------------------------------------------------------------------
+# Add custom properties on targets for controling number of images during tests
+#------------------------------------------------------------------------------
+define_property(TARGET
+  PROPERTY MIN_IMAGES
+  BRIEF_DOCS "Minimum allowable images for the test <integer>"
+  FULL_DOCS "Property to mark executable targets run as tests that they require at least <MIN_IMAGES> images to run"
+  )
+
+define_property(TARGET
+  PROPERTY POWER_2_IMGS
+  BRIEF_DOCS "True if test must be run with a power of 2 images (T/F)"
+  FULL_DOCS "Property to mark executable targets run as tests that they require 2^n images."
+  )
+
+
 #-------------------------------
 # Recurse into the src directory
 #-------------------------------
@@ -566,20 +582,32 @@ endif ()
 include( ProcessorCount )
 ProcessorCount(N_CPU)
 function(add_caf_test name num_caf_img test_target)
-   # Function to add MPI tests.
-   if ( ((N_CPU LESS num_caf_img) OR (N_CPU EQUAL 0)) )
-     message(STATUS "Test ${name} is oversubscribed: ${num_caf_img} CAF images requested with ${N_CPU} system processor available.")
-     if ( openmpi )
-       if ( N_CPU LESS 2 )
-	 set( num_caf_img 2 )
-       endif()
-       set (test_parameters --oversubscribe)
-       message( STATUS "Open-MPI back end detected, passing --oversubscribe for oversubscribed test, ${name}, with ${num_caf_img} ranks/images." )
-     endif()
-   endif()
-   set(test_parameters -np ${num_caf_img} ${test_parameters})
-   add_test(NAME ${name} COMMAND "${CMAKE_BINARY_DIR}/${CMAKE_INSTALL_BINDIR}/cafrun" ${test_parameters} "${CMAKE_RUNTIME_OUTPUT_DIRECTORY}/${test_target}")
-   set_property(TEST ${name} PROPERTY PASS_REGULAR_EXPRESSION "Test passed.")
+  # Function to add MPI tests.
+  if(TARGET ${test_target})
+    get_target_property(min_test_imgs ${test_target} MIN_IMAGES)
+  elseif(TARGET build_${test_target})
+    get_target_property(min_test_imgs build_${test_target} MIN_IMAGES)
+  endif()
+  if(min_test_imgs)
+    if(num_caf_img LESS min_test_imgs)
+      message( FATAL_ERROR "Test ${name} requires ${min_test_imgs} but was only given ${num_caf_images}" )
+    endif()
+  endif()
+  if ( ((N_CPU LESS num_caf_img) OR (N_CPU EQUAL 0)) )
+    message(STATUS "Test ${name} is oversubscribed: ${num_caf_img} CAF images requested with ${N_CPU} system processor available.")
+    if ( openmpi )
+      if (min_test_imgs)
+	set( num_caf_img ${min_test_imgs} )
+      elseif ( N_CPU LESS 2 )
+        set( num_caf_img 2 )
+      endif()
+      set (test_parameters --oversubscribe)
+      message( STATUS "Open-MPI back end detected, passing --oversubscribe for oversubscribed test, ${name}, with ${num_caf_img} ranks/images." )
+    endif()
+  endif()
+  set(test_parameters -np ${num_caf_img} ${test_parameters})
+  add_test(NAME ${name} COMMAND "bash" "${CMAKE_BINARY_DIR}/${CMAKE_INSTALL_BINDIR}/cafrun" ${test_parameters} "${CMAKE_RUNTIME_OUTPUT_DIRECTORY}/${test_target}")
+  set_property(TEST ${name} PROPERTY PASS_REGULAR_EXPRESSION "Test passed.")
 endfunction(add_caf_test)
 
 #--------------

prerequisites/install-functions/build_opencoarrays.sh

@@ -13,8 +13,8 @@ build_opencoarrays()
   if [[ -z ${MPIFC:-} || -z ${MPICC:-} ]]; then
     emergency "build_opencoarrays.sh: empty \${MPIFC}=${MPIFC:-} or \${MPICC}=${MPICC:-}"
   fi
-  MPIFC_show=($($MPIFC -show))
-  MPICC_show=($($MPICC -show))
+  MPIFC_show=($("$MPIFC" -show))
+  MPICC_show=($("$MPICC" -show))
   if [[ "${MPIFC_show[0]}" != *gfortran* || "${MPICC_show[0]}" != *gcc* ]]; then
     emergency "build_opencoarrays.sh: MPI doesn't wrap gfortran/gcc: \${MPIFC_show}=${MPIFC_show[*]}, \${MPICC_show}=${MPICC_show[*]}"
   fi

prerequisites/install-functions/find_or_install.sh

@@ -212,7 +212,7 @@ find_or_install()
 
     # Check consistency of MPIFC, if set, and user-specified Fortran compiler
     if [[ ! -z ${MPIFC:-} && ! -z "${arg_f:-}" ]]; then
-      MPIFC_wraps=$(${MPIFC} --version)
+      MPIFC_wraps=$("${MPIFC}" --version)
       compiler=$(${arg_f} --version)
       if [[ "${MPIFC_wraps}" != "${compiler}"   ]]; then
         emergency "Specified MPI ${MPIFC_wraps} wraps a compiler other than the specified Fortran compiler ${compiler}"

src/extensions/caf.in

@@ -122,13 +122,13 @@ cmd="${__base}"
 # mac OS doesn't have readlink -f, so need to crawl symlinks manually.
 # See: https://stackoverflow.com/questions/1055671/how-can-i-get-the-behavior-of-gnus-readlink-f-on-a-mac
 current_dir="${PWD}"
-cd "${__dir}"
+cd "${__dir}" || exit 5
   target_file="${__file}"
   max_iter=1000
   iter=0
   while [[ -L "${target_file}" ]]; do
     target_file="$(readlink "${target_file}")"
-    cd "$(dirname "${target_file}")"
+    cd "$(dirname "${target_file}")" || exit 5
     target_file="$(basename "${target_file}")"
     if ((++iter >= max_iter)); then
       echo "Failed to compute OpenCoarrays instalation prefix!" >&2
@@ -142,7 +142,7 @@ cd "${__dir}"
   # shellcheck disable=SC2034
   prefix="${true_dir%/bin}"
   # echo "Install prefix is ${prefix}" # for debugging
-cd "${current_dir}"
+cd "${current_dir}" || exit 5
 # echo "Current directory is $(pwd)"
 # echo "This script is in ${__dir}"
 

src/extensions/cafrun.in

@@ -34,6 +34,17 @@
 #    2. The environment variable "FC" is used to determine the identity fo the Fortran compiler/linker.
 #    3. If "FC" is empty, a default value of "mpifort" is used.
 
+# Exit on error. Append "|| true" if you expect an error.
+set -o errexit
+# Exit on error inside any functions or subshells.
+set -o errtrace
+# Do not allow use of undefined vars. Use ${VAR:-} to use an undefined VAR
+set -o nounset
+# Catch the error in case mysqldump fails (but gzip succeeds) in `mysqldump |gzip`
+set -o pipefail
+# Turn on traces, useful while debugging but commented out by default
+# set -o xtrace
+
 
 #---------------------
 # Configured variables
@@ -44,8 +55,8 @@
 #
 
 caf_version='@CAF_VERSION@'
-CAFRUN='@MPIEXEC@'
-if [[ ${CAFRUN} == @*@ ]]; then
+CAFRUN="@MPIEXEC@"
+if [[ "${CAFRUN}" == @*@ ]]; then
   CAFRUN=mpiexec
 fi
 have_failed_img=@HAVE_FAILED_IMG@
@@ -56,17 +67,82 @@ numproc_flag='@MPIEXEC_NUMPROC_FLAG@'
 if [[ ${numproc_flag} == @*@ ]]; then
   numproc_flag='-np'
 fi
-preflags='@MPIEXEC_PREFLAGS@'
-if [[ ${preflags} == @*@ ]]; then
+preflags="@MPIEXEC_PREFLAGS@"
+if [[ "${preflags}" == @*@ ]]; then
   unset preflags
 fi
-postflags='@MPIEXEC_POSTFLAGS@'
-if [[ ${postflags} == @*@ ]]; then
+postflags="@MPIEXEC_POSTFLAGS@"
+if [[ "${postflags}" == @*@ ]]; then
   unset postflags
 fi
+#-------------------------
+# End configured variables
+#-------------------------
+
+if [[ "${BASH_SOURCE[0]}" != "${0}" ]]; then
+  __i_am_main_script="0" # false
+
+  # shellcheck disable=SC2154
+  if [[ "${__usage+x}" ]]; then
+    if [[ "${BASH_SOURCE[1]}" == "${0}" ]]; then
+      __i_am_main_script="1" # true
+    fi
+    __caf_tmp_source_idx=1
+  fi
+else
+  # shellcheck disable=SC2034
+  __i_am_main_script="1" # true
+fi
+
+# Set magic variables for current file, directory, os, etc.
+__dir="$(cd "$(dirname "${BASH_SOURCE[${__caf_tmp_source_idx:-0}]}")" && pwd)"
+__file="${__dir}/$(basename "${BASH_SOURCE[${__caf_tmp_source_idx:-0}]}")"
+# shellcheck disable=SC2034
+__base="$(basename "${__file}")"
+cmd="${__base}"
+
+# Set installation prefix. Compute this dynamically assuming this script is in a bin/ subdir
+# Dereference symbolic links and canonicalize (i.e., abs path) prefix in case stow, homebrew, etc being used
+# mac OS doesn't have readlink -f, so need to crawl symlinks manually.
+# See: https://stackoverflow.com/questions/1055671/how-can-i-get-the-behavior-of-gnus-readlink-f-on-a-mac
+current_dir="${PWD}"
+cd "${__dir}" || exit 5
+  target_file="${__file}"
+  max_iter=1000
+  iter=0
+  while [[ -L "${target_file}" ]]; do
+    target_file="$(readlink "${target_file}")"
+    cd "$(dirname "${target_file}")" || exit 5
+    target_file="$(basename "${target_file}")"
+    if ((++iter >= max_iter)); then
+      echo "Failed to compute OpenCoarrays instalation prefix!" >&2
+      echo "Likely cause: circular symlink cycles." >&2
+      echo "Aborting!" >&2
+      exit 200
+    fi
+  done
+  true_dir="$(pwd -P)"
+  true_dir="${true_dir%/}"
+  # shellcheck disable=SC2034
+  prefix="${true_dir%/bin}"
+  # echo "Install prefix is ${prefix}" # for debugging
+cd "${current_dir}" || exit 5
+# echo "Current directory is $(pwd)"
+# echo "This script is in ${__dir}"
+
+# Error tracing
+# requires `set -o errtrace`
+__caf_err_report() {
+  local error_code
+  error_code=${?}
+  echo "Error in ${__file} in function ${1} on line ${2}. Please report this error at http://bit.ly/OpenCoarrays-new-issue" >&2
+  exit ${error_code}
+}
+# Always provide an error backtrace
+trap '__caf_err_report "${FUNCNAME:-.}" ${LINENO}' ERR
+
 
 usage() {
-  cmd="$(basename "${0}")"
   echo ""
   echo " ${cmd} - Coarray Fortran executable launcher for OpenCoarrays"
   echo ""
@@ -75,7 +151,7 @@ usage() {
   echo " Options:"
   echo "   --help, -h               Show this help message"
   echo "   --version, -v, -V        Report version and copyright information"
-  echo "   --wraps, -w,             Report the name of the wrapped compiler"
+  echo "   --wraps, -w,             Report info about the wrapped MPI launcher"
   echo "   -np <N>,                 Number of images, N, to execute, N must be a positive integer"
   echo "   --reenable-auto-cleanup  Turn off failed images support (if library support is present)"
   echo "                            This option re-enables MPI auto cleanup, which is disabled by"
@@ -84,6 +160,9 @@ usage() {
   echo "                            failed image support is present, OpenCoarrays triggers cleanup"
   echo "                            explicitly when a failed/stopped image is encountered in an"
   echo "                            image control statement without a \`stat=\` clause."
+  ehco "   --show, -s,              Show the command that the wrapper will execute. You can pass"
+  echo "                            this as the first argument and then the additional arguments"
+  echo "                            that you're planning to pass to perform a dry run."
   echo ""
   echo " Example usage:"
   echo ""

src/mpi/CMakeLists.txt

@@ -49,8 +49,9 @@ CHECK_SYMBOL_EXISTS(SIGKILL "signal.h" HAVE_SIGKILL)
 if(NOT HAVE_SIGKILL) # try -D_POSIX, needed for mingw-w64, maybe others, see #435
                      # https://github.com/sourceryinstitute/OpenCoarrays/issues/435#issuecomment-323592433
   list( APPEND CMAKE_REQUIRED_DEFINITIONS -D_POSIX)
-  CHECK_SYMBOL_EXISTS(SIGKILL "signal.h" HAVE_SIGKILL)
-  if(HAVE_SIGKILL)
+  CHECK_SYMBOL_EXISTS(SIGKILL "signal.h" HAVE_SIGKILL2)
+  if(HAVE_SIGKILL2)
+    set(HAVE_SIGKILL ${HAVE_SIGKILL2})
     add_definitions(-D_POSIX)
   endif()
 endif()
@@ -115,11 +116,18 @@ endif()
 #---------------------------------------------------
 # Windows Intel MPI compatibility, see GH issue #435
 #---------------------------------------------------
-CHECK_SYMBOL_EXISTS(I_MPI_VERSION mpi.h HAVE_Intel_MPI)
+set(old_cmake_required_includes "${CMAKE_REQUIRED_INCLUDES}")
+if(CMAKE_REQUIRED_INCLUDES)
+  set(CMAKE_REQUIRED_INCLUDES ${CMAKE_REQUIRED_INCLUDES};${MPI_C_INCLUDE_PATH})
+else()
+  set(CMAKE_REQUIRED_INCLUDES ${MPI_C_INCLUDE_PATH})
+endif()
+CHECK_INCLUDE_FILES("mpi.h" HAVE_MPI_H)
+CHECK_SYMBOL_EXISTS(I_MPI_VERSION "mpi.h" HAVE_Intel_MPI)
 if(HAVE_Intel_MPI AND WIN32)
   add_definitions(-DUSE_GCC)
 endif()
-
+set(CMAKE_REQUIRED_INCLUDES ${old_cmake_required_includes})
 
 add_library(opencoarrays_mod OBJECT ../extensions/opencoarrays.F90)
 set_target_properties(opencoarrays_mod
@@ -148,10 +156,12 @@ set_target_properties ( caf_mpi
 )
 
 # Create a symlink in the include dir
-add_custom_command(TARGET caf_mpi
-  POST_BUILD
-  COMMAND ${CMAKE_COMMAND} -E create_symlink "./${mod_dir_tail}/opencoarrays.mod" "${CMAKE_BINARY_DIR}/${CMAKE_INSTALL_INCLUDEDIR}/opencoarrays.mod"
-  COMMENT "Creating symlink ${CMAKE_INSTALL_INCLUDEDIR}/opencoarrays.mod --> ${CMAKE_INSTALL_INCLUDEDIR}/${mod_dir_tail}/opencoarrays.mod")
+if(UNIX)
+  add_custom_command(TARGET caf_mpi
+    POST_BUILD
+    COMMAND ${CMAKE_COMMAND} -E create_symlink "./${mod_dir_tail}/opencoarrays.mod" "${CMAKE_BINARY_DIR}/${CMAKE_INSTALL_INCLUDEDIR}/opencoarrays.mod"
+    COMMENT "Creating symlink ${CMAKE_INSTALL_INCLUDEDIR}/opencoarrays.mod --> ${CMAKE_INSTALL_INCLUDEDIR}/${mod_dir_tail}/opencoarrays.mod")
+endif()
 
 install(DIRECTORY "${CMAKE_BINARY_DIR}/${CMAKE_INSTALL_INCLUDEDIR}/" DESTINATION "${CMAKE_INSTALL_INCLUDEDIR}"
   FILES_MATCHING PATTERN "*.mod")

src/tests/unit/events/CMakeLists.txt

@@ -1,2 +1,8 @@
 caf_compile_executable(allocatable_p2p_event_post allocatable_p2p_event_post.f90)
+set_target_properties(build_allocatable_p2p_event_post
+  PROPERTIES MIN_IMAGES 4
+  )
 caf_compile_executable(static_event_post_issue_293 static_event_post_issue_293.f90)
+set_target_properties(build_static_event_post_issue_293
+  PROPERTIES MIN_IMAGES 3
+  )

src/tests/unit/fail_images/CMakeLists.txt

@@ -10,3 +10,12 @@ caf_compile_executable(image_fail_and_status_test_1 image_fail_and_status_test_1
 caf_compile_executable(image_fail_and_get_test_1 image_fail_and_get_test_1.f90)
 caf_compile_executable(image_fail_and_failed_images_test_1 image_fail_and_failed_images_test_1.f90)
 caf_compile_executable(image_fail_and_stopped_images_test_1 image_fail_and_stopped_images_test_1.f90)
+set_target_properties(build_image_fail_test_1
+  build_image_fail_and_sync_test_1
+  build_image_fail_and_sync_test_2
+  build_image_fail_and_sync_test_3
+  build_image_fail_and_status_test_1
+  build_image_fail_and_get_test_1
+  build_image_fail_and_failed_images_test_1
+  build_image_fail_and_stopped_images_test_1
+  PROPERTIES MIN_IMAGES 3)

src/tests/unit/init_register/CMakeLists.txt

@@ -1,12 +1,16 @@
 caf_compile_executable(initialize_mpi initialize_mpi.F90)
 caf_compile_executable(register register.f90)
+set_target_properties(build_register
+  PROPERTIES MIN_IMAGES 2)
 caf_compile_executable(register_vector register_vector.f90)
 caf_compile_executable(register_alloc_vector register_alloc_vector.f90)
 caf_compile_executable(allocate_as_barrier allocate_as_barrier.f90)
 caf_compile_executable(allocate_as_barrier_proc allocate_as_barrier_proc.f90)
 
 if (gfortran_compiler AND (NOT CMAKE_Fortran_COMPILER_VERSION VERSION_LESS 7.0.0))
   caf_compile_executable(async_comp_alloc async_comp_alloc.f90)
+  set_target_properties(build_async_comp_alloc
+    PROPERTIES MIN_IMAGES 2)
   caf_compile_executable(async_comp_alloc_2 async_comp_alloc_2.f90)
   caf_compile_executable(register_alloc_comp_1 register_alloc_comp_1.f90)
   caf_compile_executable(register_alloc_comp_2 register_alloc_comp_2.f90)

src/tests/unit/send-get/CMakeLists.txt

@@ -9,3 +9,5 @@ caf_compile_executable(get_with_offset_1d get_with_offset_1d.f90)
 caf_compile_executable(whole_get_array whole_get_array.f90)
 caf_compile_executable(strided_get strided_get.f90)
 caf_compile_executable(strided_sendget strided_sendget.f90)
+set_target_properties(build_strided_sendget
+  PROPERTIES MIN_IMAGES 3)