[test-suite] New SPEC2017 macro and enhancements to run_specpp macro

[naromero77]

Summary

These changes are needed to support the wrf test which will be submitted in a seperate patch.

• speccpu2017_run_specpp requires a target arguement.
• Macro for requiring convert big-endian IO compiler flag.
• Update pop2 test.

[Meinersbur]

External/SPEC/SpecCPU2017.cmake

376

[suggestion] Argument could be more self-explanatory or documented. Suggestion: ADD_SOURCES_TO_TARGET

(The SPECPP_ prefixes seem unnecessary, these are function arguments that don't clash with any namespace)

[naromero77]

External/SPEC/SpecCPU2017.cmake

376

Would this work?

cmake_parse_arguments(_arg "" "TARGET" "ADD_SRCS_TO_TARGET;DEFS" ${ARGN})

[Meinersbur]

External/SPEC/SpecCPU2017.cmake

376

ADD_SRCS_TO_TARGET doesn't sound like an option to list source files. SRCS_TO_BE_PROCESSED_AND_ADDED_TO_TARGET would match better, but unreasonable long.

Maybe just TARGET and SRCS and add to the description of speccpu2017_run_specpp that the command adds the result from specpp to TARGET as source files. The name speccpu2017_run_specpp itself doesn't indicate that.

[naromero77]

• Remove SPECPP from variable names.
• Improve description of speccpu2017_run_specpp

External/SPEC/CFP2017speed/628.pop2_s/CMakeLists.txt

 # https://www.spec.org/cpu2017/Docs/benchmarks/628.pop2_s.html
 include(../../SpecCPU2017.cmake)
 if (NOT TEST_SUITE_SPEC2017_ROOT)
   return ()
 endif ()
 
 ninja_required()
 
-speccpu2017_benchmark(SPEED)
+speccpu2017_convert_bigendian_required()
 
-# Check if compiler can support big-endian IO format, if true proceed
-# otherwise, return immediately. This is due to some binary input
-# files stored in big-endian format
-if (ENDIAN STREQUAL "little")
-  # GCC
-  check_fortran_compiler_flag("-fconvert=big-endian" SUPPORTS_FCONVERT_BIG_ENDIAN)
-  # Intel
-  check_fortran_compiler_flag("-convert big_endian" SUPPORTS_CONVERT_BIG_ENDIAN)
-  # Flang
-  # TBD
-  if (NOT SUPPORTS_FCONVERT_BIG_ENDIAN)
-  elseif (NOT SUPPORTS_CONVERT_BIG_ENDIAN)
-  else ()
-    message(WARN "628.pop2_s not supported. No way to read big-endian binary IO on little-endian architecture.")
-    return ()
-  endif ()
-endif ()
+speccpu2017_benchmark(SPEED)
 
 macro(pop2_prepare_rundir)
   # Re-use the speccpu2017_prepare_rundir but then implement an input
   # file fix at the end. input file for pop2 is hard-coded to drv_in,
   # but actual filename in SPEC2017 benchmark input directory is
   # drv_in.in. The SPEC perl run script renames the file as well.
   speccpu2017_prepare_rundir()
   foreach (_runtype IN LISTS TEST_SUITE_RUN_TYPE)
speccpu2017_add_executable(
   shr_vmath_fwrap.c
   threadutil.c
 )
 
 # Preprocess *.F90 with specpp and add sources to target
 file(GLOB POP2_F90_SRCS ${SRC_DIR}/*.F90)
 list(REMOVE_ITEM POP2_F90_SRCS ${SRC_DIR}/test.F90)
 
-speccpu2017_run_specpp(
-  SPECPP_SRCS ${POP2_F90_SRCS} SPECPP_DEFS
+speccpu2017_run_specpp(TARGET ${PROG}
+  SRCS ${POP2_F90_SRCS} DEFS
   -D_MPISERIAL
   -D_NETCDF
   -D_USEBOX
   -DCCSMCOUPLED=1
   -DNO_SHR_VMATH
   -DBLCKX=50
   -DBLCKY=4
   -DMXBLCKS=58

External/SPEC/SpecCPU2017.cmake

macro(speccpu2017_prepare_rundir)
   foreach (_runtype IN LISTS TEST_SUITE_RUN_TYPE)
     if (EXISTS "${INPUT_all_DIR}")
       llvm_copy_dir(${PROG} "${RUN_${_runtype}_DIR}" "${INPUT_all_DIR}")
     endif ()
     llvm_copy_dir(${PROG} "${RUN_${_runtype}_DIR}" "${INPUT_${_runtype}_DIR}")
   endforeach ()
 endmacro()
 
-# Run specpp on all Fortran files, but do not do it recursively.
+# Run specpp on a list of SRCS provided and add them to the TARGET.
+# Three arguments are required:
+# TARGET must be already be defined prior to calling this command.
+# SRCS is provided usually via a GLOB command external to this macro.
+# DEFS are the arguments that would normally be passed to specpp.
 # https://www.spec.org/cpu2017/Docs/specpp.html
-# specpp is needed due to legacy use of filepp by climate/weather codes.
+# specpp is needed due to legacy use of filepp by a number of
+# climate/weather codes.
 macro(speccpu2017_run_specpp)
-  cmake_parse_arguments(_arg "" "" "SPECPP_SRCS;SPECPP_DEFS" ${ARGN})
+  cmake_parse_arguments(_arg "" "TARGET" "SRCS;DEFS" ${ARGN})
   set(_specpp_bin ${TEST_SUITE_SPEC2017_ROOT}/bin/specpp)
   # Add common specpp arguments used by all SPEC CPU 2017 tests.
   # -U__FILE__ is included as a work around. Source files uses _FILE_
   # as the filename without the path, but a few source files have a
   # typo and use __FILE__ instead which is an absolute path. So specpp
   # fails to do a replacement with just the filename (i.e. without the
   # path as intended). This is usually a benign error, but __FILE__
   # can lead to a deeply nested directory due CMake's build
   # directories. As a result, the source file line length becomes
   # incredibly long, so you end up with a ridiculously long line that
   # some compilers, like GCC, are unable to compile.
   set(ARG_COMMON -w -U__FILE__ ${SPEC_COMMON_DEFS} -DSPEC_CASE_FLAG -I${SRC_DIR})
 
-  foreach(_absfilename ${_arg_SPECPP_SRCS})
+  foreach(_absfilename ${_arg_SRCS})
     # message("Adding to source ${_absfilename} to target ${PROG}")
     get_filename_component(_filename ${_absfilename} NAME)
     add_custom_command(
       OUTPUT "${CMAKE_CURRENT_BINARY_DIR}/${_filename}"
-      COMMAND "${_specpp_bin}" ${ARG_COMMON} ${_arg_SPECPP_DEFS} "${_absfilename}" > "${CMAKE_CURRENT_BINARY_DIR}/${_filename}"
+      COMMAND "${_specpp_bin}" ${ARG_COMMON} ${_arg_DEFS} "${_absfilename}" > "${CMAKE_CURRENT_BINARY_DIR}/${_filename}"
       DEPENDS "${_absfilename}"
       VERBATIM
       )
-    target_sources(${PROG} PRIVATE "${CMAKE_CURRENT_BINARY_DIR}/${_filename}")
+    target_sources(${_arg_TARGET} PRIVATE "${CMAKE_CURRENT_BINARY_DIR}/${_filename}")
   endforeach ()
 endmacro()
+
+
+# Check if compiler can support big-endian IO format, if true proceed
+# otherwise, return immediately. This is due to some binary input
+# files stored in big-endian format that are required by the SPEC tests
+macro(speccpu2017_convert_bigendian_required)
+  if (ENDIAN STREQUAL "little")
+    # GCC
+    check_fortran_compiler_flag("-fconvert=big-endian" SUPPORTS_FCONVERT_BIG_ENDIAN)
+    # Intel
+    check_fortran_compiler_flag("-convert big_endian" SUPPORTS_CONVERT_BIG_ENDIAN)
+    # Flang
+    # TBD
+    if (NOT SUPPORTS_FCONVERT_BIG_ENDIAN)
+    elseif (NOT SUPPORTS_CONVERT_BIG_ENDIAN)
+    else ()
+      message(WARN "Test not supported. No way to read big-endian binary IO on little-endian architecture.")
+      return ()
+    endif ()
+  endif ()
+endmacro ()