Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

CMake confcheck switch to try_* functions #2090

Merged
merged 1 commit into from
Dec 20, 2024
Merged

CMake confcheck switch to try_* functions #2090

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
133 changes: 38 additions & 95 deletions cmake/confcheck.cmake
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,121 +1,60 @@
# WRF Macro for adding configuration checks from source file, default is fortran
# https://cmake.org/cmake/help/latest/module/CheckFortranSourceCompiles.html
# https://github.com/ufs-community/ufs-weather-model/issues/132
include( CheckFortranSourceRuns )
include( CheckFortranSourceCompiles )
include( CheckCSourceRuns )
include( CheckCSourceCompiles )
include( CheckCXXSourceRuns )
include( CheckCXXSourceCompiles )
# include( CheckFortranSourceRuns )
# include( CheckFortranSourceCompiles )
# include( CheckCSourceRuns )
# include( CheckCSourceCompiles )
# include( CheckCXXSourceRuns )
# include( CheckCXXSourceCompiles )

macro( wrf_conf_check )
function( wrf_conf_check )

set( options QUIET RUN REQUIRED )
set( oneValueArgs RESULT_VAR EXTENSION FAIL_REGEX SOURCE MESSAGE SOURCE_TYPE )
set( multiValueArgs ADDITIONAL_FLAGS ADDITIONAL_DEFINITIONS ADDITIONAL_INCLUDES ADDITIONAL_LINK_OPTIONS ADDITIONAL_LIBRARIES )
set( oneValueArgs RESULT_VAR MESSAGE )
set( multiValueArgs SOURCES OPTIONS )

cmake_parse_arguments(
WRF_CFG
"${options}" "${oneValueArgs}" "${multiValueArgs}"
${ARGN}
)

get_filename_component( WRF_CFG_SOURCE_FILE ${WRF_CFG_SOURCE} REALPATH )
file( READ ${WRF_CFG_SOURCE_FILE} WRF_CFG_CODE )

# Santize for newlines
string( REPLACE "\\n" "\\\\n" WRF_CFG_CODE "${WRF_CFG_CODE}" )

if ( NOT DEFINED WRF_CFG_SOURCE_TYPE )
set( WRF_CFG_SOURCE_TYPE fortran )
endif()

if ( DEFINED WRF_CFG_FAIL_REGEX )
if ( DEFINED WRF_CFG_RUN )
message( WARNING "wrf_conf_check: FAIL_REGEX ignored when running check" )
else()
set( WRF_CFG_FAIL_REGEX FAIL_REGEX ${WRF_CFG_FAIL_REGEX} )
endif()
if ( NOT DEFINED WRF_CFG_BINDIR )
set( WRF_CFG_BINDIR ${CMAKE_CURRENT_BINARY_DIR}/confcheck/${WRF_CFG_RESULT_VAR}/ )
endif()

if ( DEFINED WRF_CFG_EXTENSION )
set( WRF_CFG_EXTENSION SRC_EXT ${WRF_CFG_EXTENSION} )
endif()

# Additional options
if ( DEFINED WRF_CFG_QUIET AND ${WRF_CFG_QUIET} )
set( CMAKE_REQUIRED_QUIET ${WRF_CFG_QUIET} )
endif()
message( STATUS "Performing Check ${WRF_CFG_RESULT_VAR}" )

if ( DEFINED WRF_CFG_ADDITIONAL_FLAGS )
set( CMAKE_REQUIRED_FLAGS ${WRF_CFG_ADDITIONAL_FLAGS} )
endif()

if ( DEFINED WRF_CFG_ADDITIONAL_DEFINITIONS )
set( CMAKE_REQUIRED_DEFINITIONS ${WRF_CFG_ADDITIONAL_DEFINITIONS} )
endif()

if ( DEFINED WRF_CFG_ADDITIONAL_INCLUDES )
set( CMAKE_REQUIRED_INCLUDES ${WRF_CFG_ADDITIONAL_INCLUDES} )
endif()

if ( DEFINED WRF_CFG_ADDITIONAL_LINK_OPTIONS )
set( CMAKE_REQUIRED_LINK_OPTIONS ${WRF_CFG_ADDITIONAL_LINK_OPTIONS} )
endif()

if ( DEFINED WRF_CFG_ADDITIONAL_LIBRARIES )
set( CMAKE_REQUIRED_LIBRARIES ${WRF_CFG_ADDITIONAL_LIBRARIES} )
endif()

string( TOLOWER "${WRF_CFG_SOURCE_TYPE}" WRF_CFG_SOURCE_TYPE )
if ( DEFINED WRF_CFG_RUN )
if ( ${WRF_CFG_SOURCE_TYPE} STREQUAL "fortran" )
check_fortran_source_runs(
"${WRF_CFG_CODE}"
${WRF_CFG_RESULT_VAR}
${WRF_CFG_FAIL_REGEX}
${WRF_CFG_EXTENSION}
)
elseif ( ${WRF_CFG_SOURCE_TYPE} STREQUAL "c" )
check_c_source_runs(
"${WRF_CFG_CODE}"
${WRF_CFG_RESULT_VAR}
${WRF_CFG_FAIL_REGEX}
${WRF_CFG_EXTENSION}
)
elseif ( ${WRF_CFG_SOURCE_TYPE} STREQUAL "cpp" )
check_cpp_source_runs(
"${WRF_CFG_CODE}"
${WRF_CFG_RESULT_VAR}
${WRF_CFG_FAIL_REGEX}
${WRF_CFG_EXTENSION}
)
try_run(
${WRF_CFG_RESULT_VAR}
WRF_CFG_COMPILE_RESULT_VAR
${WRF_CFG_BINDIR}
${WRF_CFG_SOURCES}
${WRF_CFG_OPTIONS}
)
if ( ${WRF_CFG_COMPILE_RESULT_VAR} )
# Did it run successfully
if ( ${${WRF_CFG_RESULT_VAR}} EQUAL 0 )
set( ${WRF_CFG_RESULT_VAR} TRUE )
endif()
else()
set( ${WRF_CFG_RESULT_VAR} FALSE )
endif()
else()
if ( ${WRF_CFG_SOURCE_TYPE} STREQUAL "fortran" )
check_fortran_source_compiles(
"${WRF_CFG_CODE}"
${WRF_CFG_RESULT_VAR}
${WRF_CFG_EXTENSION}
)
elseif ( ${WRF_CFG_SOURCE_TYPE} STREQUAL "c" )
check_c_source_compiles(
"${WRF_CFG_CODE}"
${WRF_CFG_RESULT_VAR}
${WRF_CFG_EXTENSION}
)
elseif ( ${WRF_CFG_SOURCE_TYPE} STREQUAL "cpp" )
check_cpp_source_compiles(
"${WRF_CFG_CODE}"
${WRF_CFG_RESULT_VAR}
${WRF_CFG_EXTENSION}
)
endif()
try_compile(
${WRF_CFG_RESULT_VAR}
${WRF_CFG_BINDIR}
SOURCES ${WRF_CFG_SOURCES}
${WRF_CFG_OPTIONS}
)
endif()

# If it failed - note that since this is a run/compile test we expect pass/true
# to just proceed as normal, but if failure we should do something about it
if ( NOT ( DEFINED ${WRF_CFG_RESULT_VAR} AND "${${WRF_CFG_RESULT_VAR}}" ) )
message( STATUS "Performing Check ${WRF_CFG_RESULT_VAR} - Failure" )
set( WRF_CFG_MSG_TYPE STATUS )
if ( DEFINED WRF_CFG_REQUIRED AND ${WRF_CFG_REQUIRED} )
set( WRF_CFG_MSG_TYPE FATAL_ERROR )
Expand All @@ -126,8 +65,12 @@ macro( wrf_conf_check )
else()
message( ${WRF_CFG_MSG_TYPE} "${WRF_CFG_RESULT_VAR} marked as required, check failed" )
endif()
else()
message( STATUS "Performing Check ${WRF_CFG_RESULT_VAR} - Success" )
endif()

endmacro()
set( ${WRF_CFG_RESULT_VAR} ${${WRF_CFG_RESULT_VAR}} PARENT_SCOPE )

endfunction()


29 changes: 11 additions & 18 deletions confcheck/CMakeLists.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,65 +2,58 @@
wrf_conf_check(
RUN
RESULT_VAR Fortran_2003_IEEE
SOURCE ${PROJECT_SOURCE_DIR}/tools/fortran_2003_ieee_test.F
EXTENSION .F
SOURCES ${PROJECT_SOURCE_DIR}/tools/fortran_2003_ieee_test.F
MESSAGE "Some IEEE Fortran 2003 features missing, removing usage of these features"
)

wrf_conf_check(
RUN
RESULT_VAR Fortran_2003_ISO_C
SOURCE ${PROJECT_SOURCE_DIR}/tools/fortran_2003_iso_c_test.F
EXTENSION .F
SOURCES ${PROJECT_SOURCE_DIR}/tools/fortran_2003_iso_c_test.F
MESSAGE "Some ISO_C Fortran 2003 features missing, removing usage ISO_C and stubbing code dependent on it"
)

wrf_conf_check(
RUN
RESULT_VAR Fortran_2003_FLUSH
SOURCE ${PROJECT_SOURCE_DIR}/tools/fortran_2003_flush_test.F
EXTENSION .F
SOURCES ${PROJECT_SOURCE_DIR}/tools/fortran_2003_flush_test.F
MESSAGE "Standard FLUSH routine Fortran 2003 features missing, checking for alternate Fortran_2003_FFLUSH"
)

if ( NOT ${Fortran_2003_FLUSH} )
wrf_conf_check(
RUN
RESULT_VAR Fortran_2003_FFLUSH
SOURCE ${PROJECT_SOURCE_DIR}/tools/fortran_2003_fflush_test.F
EXTENSION .F
SOURCES ${PROJECT_SOURCE_DIR}/tools/fortran_2003_fflush_test.F
MESSAGE "Standard FFLUSH routine Fortran 2003 features missing, no alternate to FLUSH found, feature stubbed out"
)
endif()

wrf_conf_check(
RUN
RESULT_VAR Fortran_2003_GAMMA
SOURCE ${PROJECT_SOURCE_DIR}/tools/fortran_2008_gamma_test.F
EXTENSION .F
SOURCES ${PROJECT_SOURCE_DIR}/tools/fortran_2008_gamma_test.F
MESSAGE "Some Fortran 2003 features missing, removing usage gamma function intrinsic and stubbing code dependent on it"
)



wrf_conf_check(
RUN
SOURCE_TYPE C
RESULT_VAR FSEEKO64
SOURCE ${PROJECT_SOURCE_DIR}/tools/fseek_test.c
EXTENSION .c
ADDITIONAL_DEFINITIONS -DTEST_FSEEKO64 -D_FILE_OFFSET_BITS=64 -D_LARGEFILE_SOURCE=1 -DFILE_TO_TEST="${PROJECT_SOURCE_DIR}/CMakeLists.txt"
SOURCES ${PROJECT_SOURCE_DIR}/tools/fseek_test.c
OPTIONS
COMPILE_DEFINITIONS -DTEST_FSEEKO64 -D_FILE_OFFSET_BITS=64 -D_LARGEFILE_SOURCE=1 -DFILE_TO_TEST="${PROJECT_SOURCE_DIR}/CMakeLists.txt"
MESSAGE "fseeko64 not supported, checking alternate fseeko"
)

if ( NOT "${FSEEKO64}" )
wrf_conf_check(
RUN
SOURCE_TYPE C
RESULT_VAR FSEEKO
SOURCE ${PROJECT_SOURCE_DIR}/tools/fseek_test.c
EXTENSION .c
ADDITIONAL_DEFINITIONS -DTEST_FSEEKO -D_FILE_OFFSET_BITS=64 -D_LARGEFILE_SOURCE=1 -DFILE_TO_TEST="${PROJECT_SOURCE_DIR}/CMakeLists.txt"
SOURCES ${PROJECT_SOURCE_DIR}/tools/fseek_test.c
OPTIONS
COMPILE_DEFINITINOS -DTEST_FSEEKO -D_FILE_OFFSET_BITS=64 -D_LARGEFILE_SOURCE=1 -DFILE_TO_TEST="${PROJECT_SOURCE_DIR}/CMakeLists.txt"
MESSAGE "fseeko not supported, compiling with fseek (caution with large files)"
)
endif()
Expand Down