1 # Distributed under the OSI-approved BSD 3-Clause License. See accompanying
2 # file Copyright.txt or https://cmake.org/licensing for details.
4 #[=======================================================================[.rst:
8 Find a Message Passing Interface (MPI) implementation.
10 The Message Passing Interface (MPI) is a library used to write
11 high-performance distributed-memory parallel applications, and is
12 typically deployed on a cluster. MPI is a standard interface (defined
13 by the MPI forum) for which many implementations are available.
15 Variables for using MPI
16 ^^^^^^^^^^^^^^^^^^^^^^^
18 The module exposes the components ``C``, ``CXX``, ``MPICXX`` and ``Fortran``.
19 Each of these controls the various MPI languages to search for.
20 The difference between ``CXX`` and ``MPICXX`` is that ``CXX`` refers to the
21 MPI C API being usable from C++, whereas ``MPICXX`` refers to the MPI-2 C++ API
22 that was removed again in MPI-3.
24 Depending on the enabled components the following variables will be set:
27 Variable indicating that MPI settings for all requested languages have been found.
28 If no components are specified, this is true if MPI settings for all enabled languages
29 were detected. Note that the ``MPICXX`` component does not affect this variable.
31 Minimal version of MPI detected among the requested languages, or all enabled languages
32 if no components were specified.
34 This module will set the following variables per language in your
35 project, where ``<lang>`` is one of C, CXX, or Fortran:
38 Variable indicating the MPI settings for ``<lang>`` were found and that
39 simple MPI test programs compile with the provided settings.
40 ``MPI_<lang>_COMPILER``
41 MPI compiler for ``<lang>`` if such a program exists.
42 ``MPI_<lang>_COMPILE_OPTIONS``
43 Compilation options for MPI programs in ``<lang>``, given as a :ref:`;-list <CMake Language Lists>`.
44 ``MPI_<lang>_COMPILE_DEFINITIONS``
45 Compilation definitions for MPI programs in ``<lang>``, given as a :ref:`;-list <CMake Language Lists>`.
46 ``MPI_<lang>_INCLUDE_DIRS``
47 Include path(s) for MPI header.
48 ``MPI_<lang>_LINK_FLAGS``
49 Linker flags for MPI programs.
50 ``MPI_<lang>_LIBRARIES``
51 All libraries to link MPI programs against.
53 Additionally, the following :prop_tgt:`IMPORTED` targets are defined:
56 Target for using MPI from ``<lang>``.
58 The following variables indicating which bindings are present will be defined:
61 Variable indicating whether the MPI-2 C++ bindings are present (introduced in MPI-2, removed with MPI-3).
62 ``MPI_Fortran_HAVE_F77_HEADER``
63 True if the Fortran 77 header ``mpif.h`` is available.
64 ``MPI_Fortran_HAVE_F90_MODULE``
65 True if the Fortran 90 module ``mpi`` can be used for accessing MPI (MPI-2 and higher only).
66 ``MPI_Fortran_HAVE_F08_MODULE``
67 True if the Fortran 2008 ``mpi_f08`` is available to MPI programs (MPI-3 and higher only).
69 If possible, the MPI version will be determined by this module. The facilities to detect the MPI version
70 were introduced with MPI-1.2, and therefore cannot be found for older MPI versions.
72 ``MPI_<lang>_VERSION_MAJOR``
73 Major version of MPI implemented for ``<lang>`` by the MPI distribution.
74 ``MPI_<lang>_VERSION_MINOR``
75 Minor version of MPI implemented for ``<lang>`` by the MPI distribution.
76 ``MPI_<lang>_VERSION``
77 MPI version implemented for ``<lang>`` by the MPI distribution.
79 Note that there's no variable for the C bindings being accessible through ``mpi.h``, since the MPI standards
80 always have required this binding to work in both C and C++ code.
82 For running MPI programs, the module sets the following variables
84 ``MPIEXEC_EXECUTABLE``
85 Executable for running MPI programs, if such exists.
86 ``MPIEXEC_NUMPROC_FLAG``
87 Flag to pass to ``mpiexec`` before giving it the number of processors to run on.
88 ``MPIEXEC_MAX_NUMPROCS``
89 Number of MPI processors to utilize. Defaults to the number
90 of processors detected on the host system.
92 Flags to pass to ``mpiexec`` directly before the executable to run.
94 Flags to pass to ``mpiexec`` after other flags.
96 Variables for locating MPI
97 ^^^^^^^^^^^^^^^^^^^^^^^^^^
99 This module performs a four step search for an MPI implementation:
101 1. Search for ``MPIEXEC_EXECUTABLE`` and, if found, use its base directory.
102 2. Check if the compiler has MPI support built-in. This is the case if the user passed a
103 compiler wrapper as ``CMAKE_<LANG>_COMPILER`` or if they're on a Cray system.
104 3. Attempt to find an MPI compiler wrapper and determine the compiler information from it.
105 4. Try to find an MPI implementation that does not ship such a wrapper by guessing settings.
106 Currently, only Microsoft MPI and MPICH2 on Windows are supported.
108 For controlling the ``MPIEXEC_EXECUTABLE`` step, the following variables may be set:
110 ``MPIEXEC_EXECUTABLE``
111 Manually specify the location of ``mpiexec``.
113 Specify the base directory of the MPI installation.
115 Environment variable to specify the base directory of the MPI installation.
117 Environment variable to specify the base directory of the MPI installation.
119 For controlling the compiler wrapper step, the following variables may be set:
121 ``MPI_<lang>_COMPILER``
122 Search for the specified compiler wrapper and use it.
123 ``MPI_<lang>_COMPILER_FLAGS``
124 Flags to pass to the MPI compiler wrapper during interrogation. Some compiler wrappers
125 support linking debug or tracing libraries if a specific flag is passed and this variable
126 may be used to obtain them.
127 ``MPI_COMPILER_FLAGS``
128 Used to initialize ``MPI_<lang>_COMPILER_FLAGS`` if no language specific flag has been given.
130 ``MPI_EXECUTABLE_SUFFIX``
131 A suffix which is appended to all names that are being looked for. For instance you may set this
132 to ``.mpich`` or ``.openmpi`` to prefer the one or the other on Debian and its derivatives.
134 In order to control the guessing step, the following variable may be set:
136 ``MPI_GUESS_LIBRARY_NAME``
137 Valid values are ``MSMPI`` and ``MPICH2``. If set, only the given library will be searched for.
138 By default, ``MSMPI`` will be preferred over ``MPICH2`` if both are available.
139 This also sets ``MPI_SKIP_COMPILER_WRAPPER`` to ``true``, which may be overridden.
141 Each of the search steps may be skipped with the following control variables:
143 ``MPI_ASSUME_NO_BUILTIN_MPI``
144 If true, the module assumes that the compiler itself does not provide an MPI implementation and
146 ``MPI_SKIP_COMPILER_WRAPPER``
147 If true, no compiler wrapper will be searched for.
148 ``MPI_SKIP_GUESSING``
149 If true, the guessing step will be skipped.
151 Additionally, the following control variable is available to change search behavior:
153 ``MPI_CXX_SKIP_MPICXX``
154 Add some definitions that will disable the MPI-2 C++ bindings.
155 Currently supported are MPICH, Open MPI, Platform MPI and derivatives thereof,
156 for example MVAPICH or Intel MPI.
158 If the find procedure fails for a variable ``MPI_<lang>_WORKS``, then the settings detected by or passed to
159 the module did not work and even a simple MPI test program failed to compile.
161 If all of these parameters were not sufficient to find the right MPI implementation, a user may
162 disable the entire autodetection process by specifying both a list of libraries in ``MPI_<lang>_LIBRARIES``
163 and a list of include directories in ``MPI_<lang>_ADDITIONAL_INCLUDE_DIRS``.
164 Any other variable may be set in addition to these two. The module will then validate the MPI settings and store the
165 settings in the cache.
167 Cache variables for MPI
168 ^^^^^^^^^^^^^^^^^^^^^^^
170 The variable ``MPI_<lang>_INCLUDE_DIRS`` will be assembled from the following variables.
173 ``MPI_<lang>_HEADER_DIR``
174 Location of the ``mpi.h`` header on disk.
178 ``MPI_Fortran_F77_HEADER_DIR``
179 Location of the Fortran 77 header ``mpif.h``, if it exists.
180 ``MPI_Fortran_MODULE_DIR``
181 Location of the ``mpi`` or ``mpi_f08`` modules, if available.
183 For all languages the following variables are additionally considered:
185 ``MPI_<lang>_ADDITIONAL_INCLUDE_DIRS``
186 A :ref:`;-list <CMake Language Lists>` of paths needed in addition to the normal include directories.
187 ``MPI_<include_name>_INCLUDE_DIR``
188 Path variables for include folders referred to by ``<include_name>``.
189 ``MPI_<lang>_ADDITIONAL_INCLUDE_VARS``
190 A :ref:`;-list <CMake Language Lists>` of ``<include_name>`` that will be added to the include locations of ``<lang>``.
192 The variable ``MPI_<lang>_LIBRARIES`` will be assembled from the following variables:
194 ``MPI_<lib_name>_LIBRARY``
195 The location of a library called ``<lib_name>`` for use with MPI.
196 ``MPI_<lang>_LIB_NAMES``
197 A :ref:`;-list <CMake Language Lists>` of ``<lib_name>`` that will be added to the include locations of ``<lang>``.
202 When using ``MPIEXEC_EXECUTABLE`` to execute MPI applications, you should typically
203 use all of the ``MPIEXEC_EXECUTABLE`` flags as follows:
207 ${MPIEXEC_EXECUTABLE} ${MPIEXEC_NUMPROC_FLAG} ${MPIEXEC_MAX_NUMPROCS}
208 ${MPIEXEC_PREFLAGS} EXECUTABLE ${MPIEXEC_POSTFLAGS} ARGS
210 where ``EXECUTABLE`` is the MPI program, and ``ARGS`` are the arguments to
211 pass to the MPI program.
213 Advanced variables for using MPI
214 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
216 The module can perform some advanced feature detections upon explicit request.
218 **Important notice:** The following checks cannot be performed without *executing* an MPI test program.
219 Consider the special considerations for the behavior of :command:`try_run` during cross compilation.
220 Moreover, running an MPI program can cause additional issues, like a firewall notification on some systems.
221 You should only enable these detections if you absolutely need the information.
223 If the following variables are set to true, the respective search will be performed:
225 ``MPI_DETERMINE_Fortran_CAPABILITIES``
226 Determine for all available Fortran bindings what the values of ``MPI_SUBARRAYS_SUPPORTED`` and
227 ``MPI_ASYNC_PROTECTS_NONBLOCKING`` are and make their values available as ``MPI_Fortran_<binding>_SUBARRAYS``
228 and ``MPI_Fortran_<binding>_ASYNCPROT``, where ``<binding>`` is one of ``F77_HEADER``, ``F90_MODULE`` and
230 ``MPI_DETERMINE_LIBRARY_VERSION``
231 For each language, find the output of ``MPI_Get_library_version`` and make it available as ``MPI_<lang>_LIBRARY_VERSION_STRING``.
232 This information is usually tied to the runtime component of an MPI implementation and might differ depending on ``<lang>``.
233 Note that the return value is entirely implementation defined. This information might be used to identify
234 the MPI vendor and for example pick the correct one of multiple third party binaries that matches the MPI vendor.
236 Backward Compatibility
237 ^^^^^^^^^^^^^^^^^^^^^^
239 For backward compatibility with older versions of FindMPI, these
240 variables are set, but deprecated:
244 MPI_COMPILER MPI_LIBRARY MPI_EXTRA_LIBRARY
245 MPI_COMPILE_FLAGS MPI_INCLUDE_PATH MPI_LINK_FLAGS
248 In new projects, please use the ``MPI_<lang>_XXX`` equivalents.
249 Additionally, the following variables are deprecated:
251 ``MPI_<lang>_COMPILE_FLAGS``
252 Use ``MPI_<lang>_COMPILE_OPTIONS`` and ``MPI_<lang>_COMPILE_DEFINITIONS`` instead.
253 ``MPI_<lang>_INCLUDE_PATH``
254 For consumption use ``MPI_<lang>_INCLUDE_DIRS`` and for specifying folders use ``MPI_<lang>_ADDITIONAL_INCLUDE_DIRS`` instead.
256 Use ``MPIEXEC_EXECUTABLE`` instead.
257 #]=======================================================================]
260 cmake_policy(SET CMP0057 NEW) # if IN_LIST
262 include(${CMAKE_CURRENT_LIST_DIR}/FindPackageHandleStandardArgs.cmake)
264 # Generic compiler names
265 set(_MPI_C_GENERIC_COMPILER_NAMES mpicc mpcc mpicc_r mpcc_r)
266 set(_MPI_CXX_GENERIC_COMPILER_NAMES mpicxx mpiCC mpcxx mpCC mpic++ mpc++
267 mpicxx_r mpiCC_r mpcxx_r mpCC_r mpic++_r mpc++_r)
268 set(_MPI_Fortran_GENERIC_COMPILER_NAMES mpif95 mpif95_r mpf95 mpf95_r
269 mpif90 mpif90_r mpf90 mpf90_r
270 mpif77 mpif77_r mpf77 mpf77_r
274 set(_MPI_GNU_C_COMPILER_NAMES mpigcc mpgcc mpigcc_r mpgcc_r)
275 set(_MPI_GNU_CXX_COMPILER_NAMES mpig++ mpg++ mpig++_r mpg++_r mpigxx)
276 set(_MPI_GNU_Fortran_COMPILER_NAMES mpigfortran mpgfortran mpigfortran_r mpgfortran_r
277 mpig77 mpig77_r mpg77 mpg77_r)
279 # Intel MPI compiler names on Windows
281 list(APPEND _MPI_C_GENERIC_COMPILER_NAMES mpicc.bat)
282 list(APPEND _MPI_CXX_GENERIC_COMPILER_NAMES mpicxx.bat)
283 list(APPEND _MPI_Fortran_GENERIC_COMPILER_NAMES mpifc.bat)
285 # Intel MPI compiler names
286 set(_MPI_Intel_C_COMPILER_NAMES mpiicc.bat)
287 set(_MPI_Intel_CXX_COMPILER_NAMES mpiicpc.bat)
288 set(_MPI_Intel_Fortran_COMPILER_NAMES mpiifort.bat mpif77.bat mpif90.bat)
290 # Intel MPI compiler names for MSMPI
291 set(_MPI_MSVC_C_COMPILER_NAMES mpicl.bat)
292 set(_MPI_MSVC_CXX_COMPILER_NAMES mpicl.bat)
294 # Intel compiler names
295 set(_MPI_Intel_C_COMPILER_NAMES mpiicc)
296 set(_MPI_Intel_CXX_COMPILER_NAMES mpiicpc mpiicxx mpiic++)
297 set(_MPI_Intel_Fortran_COMPILER_NAMES mpiifort mpiif95 mpiif90 mpiif77)
301 set(_MPI_PGI_C_COMPILER_NAMES mpipgicc mpipgcc mppgcc)
302 set(_MPI_PGI_CXX_COMPILER_NAMES mpipgic++ mpipgCC mppgCC)
303 set(_MPI_PGI_Fortran_COMPILER_NAMES mpipgifort mpipgf95 mpipgf90 mppgf95 mppgf90 mpipgf77 mppgf77)
305 # XLC MPI Compiler names
306 set(_MPI_XL_C_COMPILER_NAMES mpxlc mpxlc_r mpixlc mpixlc_r)
307 set(_MPI_XL_CXX_COMPILER_NAMES mpixlcxx mpixlC mpixlc++ mpxlcxx mpxlc++ mpixlc++ mpxlCC
308 mpixlcxx_r mpixlC_r mpixlc++_r mpxlcxx_r mpxlc++_r mpixlc++_r mpxlCC_r)
309 set(_MPI_XL_Fortran_COMPILER_NAMES mpixlf95 mpixlf95_r mpxlf95 mpxlf95_r
310 mpixlf90 mpixlf90_r mpxlf90 mpxlf90_r
311 mpixlf77 mpixlf77_r mpxlf77 mpxlf77_r
312 mpixlf mpixlf_r mpxlf mpxlf_r)
314 # Prepend vendor-specific compiler wrappers to the list. If we don't know the compiler,
315 # attempt all of them.
316 # By attempting vendor-specific compiler names first, we should avoid situations where the compiler wrapper
317 # stems from a proprietary MPI and won't know which compiler it's being used for. For instance, Intel MPI
318 # controls its settings via the I_MPI_CC environment variables if the generic name is being used.
319 # If we know which compiler we're working with, we can use the most specialized wrapper there is in order to
320 # pick up the right settings for it.
321 foreach (LANG IN ITEMS C CXX Fortran)
322 set(_MPI_${LANG}_COMPILER_NAMES "")
323 foreach (id IN ITEMS GNU Intel MSVC PGI XL)
324 if (NOT CMAKE_${LANG}_COMPILER_ID OR CMAKE_${LANG}_COMPILER_ID STREQUAL id)
325 foreach(_COMPILER_NAME IN LISTS _MPI_${id}_${LANG}_COMPILER_NAMES)
326 list(APPEND _MPI_${LANG}_COMPILER_NAMES ${_COMPILER_NAME}${MPI_EXECUTABLE_SUFFIX})
329 unset(_MPI_${id}_${LANG}_COMPILER_NAMES)
331 foreach(_COMPILER_NAME IN LISTS _MPI_${LANG}_GENERIC_COMPILER_NAMES)
332 list(APPEND _MPI_${LANG}_COMPILER_NAMES ${_COMPILER_NAME}${MPI_EXECUTABLE_SUFFIX})
334 unset(_MPI_${LANG}_GENERIC_COMPILER_NAMES)
337 # Names to try for mpiexec
338 # Only mpiexec commands are guaranteed to behave as described in the standard,
339 # mpirun commands are not covered by the standard in any way whatsoever.
340 # lamexec is the executable for LAM/MPI, srun is for SLURM or Open MPI with SLURM support.
341 # srun -n X <executable> is however a valid command, so it behaves 'like' mpiexec.
342 set(_MPIEXEC_NAMES_BASE mpiexec mpiexec.hydra mpiexec.mpd mpirun lamexec srun)
344 unset(_MPIEXEC_NAMES)
345 foreach(_MPIEXEC_NAME IN LISTS _MPIEXEC_NAMES_BASE)
346 list(APPEND _MPIEXEC_NAMES "${_MPIEXEC_NAME}${MPI_EXECUTABLE_SUFFIX}")
348 unset(_MPIEXEC_NAMES_BASE)
350 function (_MPI_check_compiler LANG QUERY_FLAG OUTPUT_VARIABLE RESULT_VARIABLE)
351 if(DEFINED MPI_${LANG}_COMPILER_FLAGS)
352 separate_arguments(_MPI_COMPILER_WRAPPER_OPTIONS NATIVE_COMMAND "${MPI_${LANG}_COMPILER_FLAGS}")
354 separate_arguments(_MPI_COMPILER_WRAPPER_OPTIONS NATIVE_COMMAND "${MPI_COMPILER_FLAGS}")
357 COMMAND ${MPI_${LANG}_COMPILER} ${_MPI_COMPILER_WRAPPER_OPTIONS} ${QUERY_FLAG}
358 OUTPUT_VARIABLE WRAPPER_OUTPUT OUTPUT_STRIP_TRAILING_WHITESPACE
359 ERROR_VARIABLE WRAPPER_OUTPUT ERROR_STRIP_TRAILING_WHITESPACE
360 RESULT_VARIABLE WRAPPER_RETURN)
361 # Some compiler wrappers will yield spurious zero return values, for example
362 # Intel MPI tolerates unknown arguments and if the MPI wrappers loads a shared
363 # library that has invalid or missing version information there would be warning
364 # messages emitted by ld.so in the compiler output. In either case, we'll treat
365 # the output as invalid.
366 if("${WRAPPER_OUTPUT}" MATCHES "undefined reference|unrecognized|need to set|no version information available|command not found")
367 set(WRAPPER_RETURN 255)
369 # Ensure that no error output might be passed upwards.
370 if(NOT WRAPPER_RETURN EQUAL 0)
371 unset(WRAPPER_OUTPUT)
373 # Strip leading whitespace
374 string(REGEX REPLACE "^ +" "" WRAPPER_OUTPUT "${WRAPPER_OUTPUT}")
376 set(${OUTPUT_VARIABLE} "${WRAPPER_OUTPUT}" PARENT_SCOPE)
377 set(${RESULT_VARIABLE} "${WRAPPER_RETURN}" PARENT_SCOPE)
380 macro(_MPI_env_set_ifnot VAR VALUE)
381 if(NOT DEFINED ENV{${VAR}})
382 set(_MPI_${VAR}_WAS_SET FALSE)
383 set(ENV{${VAR}} ${${VALUE}})
385 set(_MPI_${VAR}_WAS_SET TRUE)
389 macro(_MPI_env_unset_ifnot VAR)
390 if(NOT _MPI_${VAR}_WAS_SET)
395 function (_MPI_interrogate_compiler LANG)
396 unset(MPI_COMPILE_CMDLINE)
397 unset(MPI_LINK_CMDLINE)
399 unset(MPI_COMPILE_OPTIONS_WORK)
400 unset(MPI_COMPILE_DEFINITIONS_WORK)
401 unset(MPI_INCLUDE_DIRS_WORK)
402 unset(MPI_LINK_FLAGS_WORK)
403 unset(MPI_LIB_NAMES_WORK)
404 unset(MPI_LIB_FULLPATHS_WORK)
406 # Define the MPICH and Intel MPI compiler variables to the compilers set in CMake.
407 # It's possible to have a per-compiler configuration in these MPI implementations and
408 # a particular MPICH derivate might check compiler interoperability.
409 # Intel MPI in particular does this with I_MPI_CHECK_COMPILER.
410 file(TO_NATIVE_PATH "${CMAKE_${LANG}_COMPILER}" _MPI_UNDERLAYING_COMPILER)
411 # On Windows, the Intel MPI batch scripts can only work with filnames - Full paths will break them.
412 # Due to the lack of other MPICH-based wrappers for Visual C++, we may treat this as default.
414 get_filename_component(_MPI_UNDERLAYING_COMPILER "${_MPI_UNDERLAYING_COMPILER}" NAME)
416 if("${LANG}" STREQUAL "C")
417 _MPI_env_set_ifnot(I_MPI_CC _MPI_UNDERLAYING_COMPILER)
418 _MPI_env_set_ifnot(MPICH_CC _MPI_UNDERLAYING_COMPILER)
419 elseif("${LANG}" STREQUAL "CXX")
420 _MPI_env_set_ifnot(I_MPI_CXX _MPI_UNDERLAYING_COMPILER)
421 _MPI_env_set_ifnot(MPICH_CXX _MPI_UNDERLAYING_COMPILER)
422 elseif("${LANG}" STREQUAL "Fortran")
423 _MPI_env_set_ifnot(I_MPI_FC _MPI_UNDERLAYING_COMPILER)
424 _MPI_env_set_ifnot(MPICH_FC _MPI_UNDERLAYING_COMPILER)
425 _MPI_env_set_ifnot(I_MPI_F77 _MPI_UNDERLAYING_COMPILER)
426 _MPI_env_set_ifnot(MPICH_F77 _MPI_UNDERLAYING_COMPILER)
427 _MPI_env_set_ifnot(I_MPI_F90 _MPI_UNDERLAYING_COMPILER)
428 _MPI_env_set_ifnot(MPICH_F90 _MPI_UNDERLAYING_COMPILER)
431 # Set these two variables for Intel MPI:
432 # - I_MPI_DEBUG_INFO_STRIP: It adds 'objcopy' lines to the compiler output. We support stripping them
433 # (see below), but if we can avoid them in the first place, we should.
434 # - I_MPI_FORT_BIND: By default Intel MPI makes the C/C++ compiler wrappers link Fortran bindings.
435 # This is so that mixed-language code doesn't require additional libraries when linking with mpicc.
436 # For our purposes, this makes little sense, since correct MPI usage from CMake already circumvenes this.
437 set(_MPI_ENV_VALUE "disable")
438 _MPI_env_set_ifnot(I_MPI_DEBUG_INFO_STRIP _MPI_ENV_VALUE)
439 _MPI_env_set_ifnot(I_MPI_FORT_BIND _MPI_ENV_VALUE)
441 # Check whether the -showme:compile option works. This indicates that we have either Open MPI
442 # or a newer version of LAM/MPI, and implies that -showme:link will also work.
443 # Open MPI also supports -show, but separates linker and compiler information
444 _MPI_check_compiler(${LANG} "-showme:compile" MPI_COMPILE_CMDLINE MPI_COMPILER_RETURN)
445 if (MPI_COMPILER_RETURN EQUAL 0)
446 _MPI_check_compiler(${LANG} "-showme:link" MPI_LINK_CMDLINE MPI_COMPILER_RETURN)
448 if (NOT MPI_COMPILER_RETURN EQUAL 0)
449 unset(MPI_COMPILE_CMDLINE)
453 # MPICH and MVAPICH offer -compile-info and -link-info.
454 # For modern versions, both do the same as -show. However, for old versions, they do differ
455 # when called for mpicxx and mpif90 and it's necessary to use them over -show in order to find the
456 # removed MPI C++ bindings.
457 if (NOT MPI_COMPILER_RETURN EQUAL 0)
458 _MPI_check_compiler(${LANG} "-compile-info" MPI_COMPILE_CMDLINE MPI_COMPILER_RETURN)
460 if (MPI_COMPILER_RETURN EQUAL 0)
461 _MPI_check_compiler(${LANG} "-link-info" MPI_LINK_CMDLINE MPI_COMPILER_RETURN)
463 if (NOT MPI_COMPILER_RETURN EQUAL 0)
464 unset(MPI_COMPILE_CMDLINE)
469 # MPICH, MVAPICH2 and Intel MPI just use "-show". Open MPI also offers this, but the
470 # -showme commands are more specialized.
471 if (NOT MPI_COMPILER_RETURN EQUAL 0)
472 _MPI_check_compiler(${LANG} "-show" MPI_COMPILE_CMDLINE MPI_COMPILER_RETURN)
475 # Older versions of LAM/MPI have "-showme". Open MPI also supports this.
476 # Unknown to MPICH, MVAPICH and Intel MPI.
477 if (NOT MPI_COMPILER_RETURN EQUAL 0)
478 _MPI_check_compiler(${LANG} "-showme" MPI_COMPILE_CMDLINE MPI_COMPILER_RETURN)
481 if (MPI_COMPILER_RETURN EQUAL 0 AND DEFINED MPI_COMPILE_CMDLINE)
482 # Intel MPI can be run with -compchk or I_MPI_CHECK_COMPILER set to 1.
483 # In this case, -show will be prepended with a line to the compiler checker. This is a script that performs
484 # compatibility checks and returns a non-zero exit code together with an error if something fails.
485 # It has to be called as "compchk.sh <arch> <compiler>". Here, <arch> is one out of 32 (i686), 64 (ia64) or 32e (x86_64).
486 # The compiler is identified by filename, and can be either the MPI compiler or the underlying compiler.
487 # NOTE: It is vital to run this script while the environment variables are set up, otherwise it can check the wrong compiler.
488 if("${MPI_COMPILE_CMDLINE}" MATCHES "^([^\" ]+/compchk.sh|\"[^\"]+/compchk.sh\") +([^ ]+)")
489 # Now CMAKE_MATCH_1 contains the path to the compchk.sh file and CMAKE_MATCH_2 the architecture flag.
490 unset(COMPILER_CHECKER_OUTPUT)
492 COMMAND ${CMAKE_MATCH_1} ${CMAKE_MATCH_2} ${MPI_${LANG}_COMPILER}
493 OUTPUT_VARIABLE COMPILER_CHECKER_OUTPUT OUTPUT_STRIP_TRAILING_WHITESPACE
494 ERROR_VARIABLE COMPILER_CHECKER_OUTPUT ERROR_STRIP_TRAILING_WHITESPACE
495 RESULT_VARIABLE MPI_COMPILER_RETURN)
496 # If it returned a non-zero value, the check below will fail and cause the interrogation to be aborted.
497 if(NOT MPI_COMPILER_RETURN EQUAL 0)
498 if(NOT MPI_FIND_QUIETLY)
499 message(STATUS "Intel MPI compiler check failed: ${COMPILER_CHECKER_OUTPUT}")
502 # Since the check passed, we can remove the compchk.sh script.
503 string(REGEX REPLACE "^([^\" ]+|\"[^\"]+\")/compchk.sh.*\n" "" MPI_COMPILE_CMDLINE "${MPI_COMPILE_CMDLINE}")
508 # Revert changes to the environment made previously
509 if("${LANG}" STREQUAL "C")
510 _MPI_env_unset_ifnot(I_MPI_CC)
511 _MPI_env_unset_ifnot(MPICH_CC)
512 elseif("${LANG}" STREQUAL "CXX")
513 _MPI_env_unset_ifnot(I_MPI_CXX)
514 _MPI_env_unset_ifnot(MPICH_CXX)
515 elseif("${LANG}" STREQUAL "Fortran")
516 _MPI_env_unset_ifnot(I_MPI_FC)
517 _MPI_env_unset_ifnot(MPICH_FC)
518 _MPI_env_unset_ifnot(I_MPI_F77)
519 _MPI_env_unset_ifnot(MPICH_F77)
520 _MPI_env_unset_ifnot(I_MPI_F90)
521 _MPI_env_unset_ifnot(MPICH_F90)
524 _MPI_env_unset_ifnot(I_MPI_DEBUG_INFO_STRIP)
525 _MPI_env_unset_ifnot(I_MPI_FORT_BIND)
527 if (NOT (MPI_COMPILER_RETURN EQUAL 0) OR NOT (DEFINED MPI_COMPILE_CMDLINE))
528 # Cannot interrogate this compiler, so exit.
529 set(MPI_${LANG}_WRAPPER_FOUND FALSE PARENT_SCOPE)
532 unset(MPI_COMPILER_RETURN)
534 # We have our command lines, but we might need to copy MPI_COMPILE_CMDLINE
535 # into MPI_LINK_CMDLINE, if we didn't find the link line.
536 if (NOT DEFINED MPI_LINK_CMDLINE)
537 set(MPI_LINK_CMDLINE "${MPI_COMPILE_CMDLINE}")
540 # Visual Studio parsers permit each flag prefixed by either / or -.
541 # We'll normalize this to the - syntax we use for CMake purposes anyways.
543 foreach(_MPI_VARIABLE IN ITEMS COMPILE LINK)
544 # The Intel MPI wrappers on Windows prefix their output with some copyright boilerplate.
545 # To prevent possible problems, we discard this text before proceeding with any further matching.
546 string(REGEX REPLACE "^[^ ]+ for the Intel\\(R\\) MPI Library [^\n]+ for Windows\\*\nCopyright\\(C\\) [^\n]+, Intel Corporation\\. All rights reserved\\.\n\n" ""
547 MPI_${_MPI_VARIABLE}_CMDLINE "${MPI_${_MPI_VARIABLE}_CMDLINE}")
548 string(REGEX REPLACE "(^| )/" "\\1-" MPI_${_MPI_VARIABLE}_CMDLINE "${MPI_${_MPI_VARIABLE}_CMDLINE}")
549 string(REPLACE "-libpath:" "-LIBPATH:" MPI_${_MPI_VARIABLE}_CMDLINE "${MPI_${_MPI_VARIABLE}_CMDLINE}")
553 # For MSVC and cl-compatible compilers, the keyword /link indicates a point after which
554 # everything following is passed to the linker. In this case, we drop all prior information
555 # from the link line and treat any unknown extra flags as linker flags.
556 set(_MPI_FILTERED_LINK_INFORMATION FALSE)
558 if(MPI_LINK_CMDLINE MATCHES " -(link|LINK) ")
559 string(REGEX REPLACE ".+-(link|LINK) +" "" MPI_LINK_CMDLINE "${MPI_LINK_CMDLINE}")
560 set(_MPI_FILTERED_LINK_INFORMATION TRUE)
562 string(REGEX REPLACE " +-(link|LINK) .+" "" MPI_COMPILE_CMDLINE "${MPI_COMPILE_CMDLINE}")
566 # At this point, we obtained some output from a compiler wrapper that works.
567 # We'll now try to parse it into variables with meaning to us.
568 if("${LANG}" STREQUAL "Fortran")
569 # If MPICH (and derivates) didn't recognize the Fortran compiler include flag during configuration,
570 # they'll return a set of three commands, consisting out of a symlink command for mpif.h,
571 # the actual compiler command and deletion of the created symlink.
572 # Especially with M(VA)PICH-1, this appears to happen erroneously, and therefore we should translate
573 # this output into an additional include directory and then drop it from the output.
574 if("${MPI_COMPILE_CMDLINE}" MATCHES "^ln -s ([^\" ]+|\"[^\"]+\") mpif.h")
575 get_filename_component(MPI_INCLUDE_DIRS_WORK "${CMAKE_MATCH_1}" DIRECTORY)
576 string(REGEX REPLACE "^ln -s ([^\" ]+|\"[^\"]+\") mpif.h\n" "" MPI_COMPILE_CMDLINE "${MPI_COMPILE_CMDLINE}")
577 string(REGEX REPLACE "^ln -s ([^\" ]+|\"[^\"]+\") mpif.h\n" "" MPI_LINK_CMDLINE "${MPI_LINK_CMDLINE}")
578 string(REGEX REPLACE "\nrm -f mpif.h$" "" MPI_COMPILE_CMDLINE "${MPI_COMPILE_CMDLINE}")
579 string(REGEX REPLACE "\nrm -f mpif.h$" "" MPI_LINK_CMDLINE "${MPI_LINK_CMDLINE}")
583 # If Intel MPI was configured for static linkage with -static_mpi, the wrapper will by default strip
584 # debug information from resulting binaries (see I_MPI_DEBUG_INFO_STRIP).
585 # Since we cannot process this information into CMake logic, we need to discard the resulting objcopy
586 # commands from the output.
587 string(REGEX REPLACE "(^|\n)objcopy[^\n]+(\n|$)" "" MPI_COMPILE_CMDLINE "${MPI_COMPILE_CMDLINE}")
588 string(REGEX REPLACE "(^|\n)objcopy[^\n]+(\n|$)" "" MPI_LINK_CMDLINE "${MPI_LINK_CMDLINE}")
591 # For Visual C++, extracting compiler options in a generic fashion isn't easy. However, no MPI implementation
592 # on Windows seems to require any specific ones, either.
594 # Extract compile options from the compile command line.
595 string(REGEX MATCHALL "(^| )-f([^\" ]+|\"[^\"]+\")" MPI_ALL_COMPILE_OPTIONS "${MPI_COMPILE_CMDLINE}")
597 foreach(_MPI_COMPILE_OPTION IN LISTS MPI_ALL_COMPILE_OPTIONS)
598 string(REGEX REPLACE "^ " "" _MPI_COMPILE_OPTION "${_MPI_COMPILE_OPTION}")
600 # Ignore -fstack-protector directives: These occur on MPICH and MVAPICH when the libraries
601 # themselves were built with this flag. However, this flag is unrelated to using MPI, and
602 # we won't match the accompanying --param-ssp-size and -Wp,-D_FORTIFY_SOURCE flags and therefore
603 # produce inconsistent results with the regularly flags.
604 # Similarly, aliasing flags do not belong into our flag array.
605 if(NOT "${_MPI_COMPILE_OPTION}" MATCHES "^-f((no-|)(stack-protector|strict-aliasing)|PI[CE]|pi[ce])")
606 list(APPEND MPI_COMPILE_OPTIONS_WORK "${_MPI_COMPILE_OPTION}")
611 # For GNU-style compilers, it's possible to prefix includes and definitions with certain flags to pass them
612 # only to the preprocessor. For CMake purposes, we need to treat, but ignore such scopings.
613 # Note that we do not support spaces between the arguments, i.e. -Wp,-I -Wp,/opt/mympi will not be parsed
614 # correctly. This form does not seem to occur in any common MPI implementation, however.
616 set(_MPI_PREPROCESSOR_FLAG_REGEX "(-Wp,|-Xpreprocessor )?")
618 set(_MPI_PREPROCESSOR_FLAG_REGEX "")
621 # Same deal as above, for the definitions.
622 string(REGEX MATCHALL "(^| )${_MPI_PREPROCESSOR_FLAG_REGEX}-D *([^\" ]+|\"[^\"]+\")" MPI_ALL_COMPILE_DEFINITIONS "${MPI_COMPILE_CMDLINE}")
624 foreach(_MPI_COMPILE_DEFINITION IN LISTS MPI_ALL_COMPILE_DEFINITIONS)
625 string(REGEX REPLACE "^ ?${_MPI_PREPROCESSOR_FLAG_REGEX}-D *" "" _MPI_COMPILE_DEFINITION "${_MPI_COMPILE_DEFINITION}")
626 string(REPLACE "\"" "" _MPI_COMPILE_DEFINITION "${_MPI_COMPILE_DEFINITION}")
627 if(NOT "${_MPI_COMPILE_DEFINITION}" MATCHES "^_FORTIFY_SOURCE.*")
628 list(APPEND MPI_COMPILE_DEFINITIONS_WORK "${_MPI_COMPILE_DEFINITION}")
632 # Extract include paths from compile command line
633 string(REGEX MATCHALL "(^| )${_MPI_PREPROCESSOR_FLAG_REGEX}${CMAKE_INCLUDE_FLAG_${LANG}} *([^\" ]+|\"[^\"]+\")"
634 MPI_ALL_INCLUDE_PATHS "${MPI_COMPILE_CMDLINE}")
636 # If extracting failed to work, we'll try using -showme:incdirs.
637 # Unlike before, we do this without the environment variables set up, but since only MPICH derivates are affected by any of them, and
638 # -showme:... is only supported by Open MPI and LAM/MPI, this isn't a concern.
639 if (NOT MPI_ALL_INCLUDE_PATHS)
640 _MPI_check_compiler(${LANG} "-showme:incdirs" MPI_INCDIRS_CMDLINE MPI_INCDIRS_COMPILER_RETURN)
641 if(MPI_INCDIRS_COMPILER_RETURN)
642 separate_arguments(MPI_ALL_INCLUDE_PATHS NATIVE_COMMAND "${MPI_INCDIRS_CMDLINE}")
646 foreach(_MPI_INCLUDE_PATH IN LISTS MPI_ALL_INCLUDE_PATHS)
647 string(REGEX REPLACE "^ ?${_MPI_PREPROCESSOR_FLAG_REGEX}${CMAKE_INCLUDE_FLAG_${LANG}} *" "" _MPI_INCLUDE_PATH "${_MPI_INCLUDE_PATH}")
648 string(REPLACE "\"" "" _MPI_INCLUDE_PATH "${_MPI_INCLUDE_PATH}")
649 get_filename_component(_MPI_INCLUDE_PATH "${_MPI_INCLUDE_PATH}" REALPATH)
650 list(APPEND MPI_INCLUDE_DIRS_WORK "${_MPI_INCLUDE_PATH}")
653 # The next step are linker flags and library directories. Here, we first take the flags given in raw -L or -LIBPATH: syntax.
654 string(REGEX MATCHALL "(^| )${CMAKE_LIBRARY_PATH_FLAG} *([^\" ]+|\"[^\"]+\")" MPI_DIRECT_LINK_PATHS "${MPI_LINK_CMDLINE}")
655 foreach(_MPI_LPATH IN LISTS MPI_DIRECT_LINK_PATHS)
656 string(REGEX REPLACE "(^| )${CMAKE_LIBRARY_PATH_FLAG} *" "" _MPI_LPATH "${_MPI_LPATH}")
657 list(APPEND MPI_ALL_LINK_PATHS "${_MPI_LPATH}")
660 # If the link commandline hasn't been filtered (e.g. when using MSVC and /link), we need to extract the relevant parts first.
661 if(NOT _MPI_FILTERED_LINK_INFORMATION)
662 string(REGEX MATCHALL "(^| )(-Wl,|-Xlinker +)([^\" ]+|\"[^\"]+\")" MPI_LINK_FLAGS "${MPI_LINK_CMDLINE}")
664 # In this case, we could also find some indirectly given linker paths, e.g. prefixed by -Xlinker or -Wl,
665 # Since syntaxes like -Wl,-L -Wl,/my/path/to/lib are also valid, we parse these paths by first removing -Wl, and -Xlinker
666 # from the list of filtered flags and then parse the remainder of the output.
667 string(REGEX REPLACE "(-Wl,|-Xlinker +)" "" MPI_LINK_FLAGS_RAW "${MPI_LINK_FLAGS}")
669 # Now we can parse the leftover output. Note that spaces can now be handled since the above example would reduce to
670 # -L /my/path/to/lib and can be extracted correctly.
671 string(REGEX MATCHALL "^(${CMAKE_LIBRARY_PATH_FLAG},? *|--library-path=)([^\" ]+|\"[^\"]+\")"
672 MPI_INDIRECT_LINK_PATHS "${MPI_LINK_FLAGS_RAW}")
674 foreach(_MPI_LPATH IN LISTS MPI_INDIRECT_LINK_PATHS)
675 string(REGEX REPLACE "^(${CMAKE_LIBRARY_PATH_FLAG},? *|--library-path=)" "" _MPI_LPATH "${_MPI_LPATH}")
676 list(APPEND MPI_ALL_LINK_PATHS "${_MPI_LPATH}")
679 # We need to remove the flags we extracted from the linker flag list now.
680 string(REGEX REPLACE "(^| )(-Wl,|-Xlinker +)(${CMAKE_LIBRARY_PATH_FLAG},? *(-Wl,|-Xlinker +)?|--library-path=)([^\" ]+|\"[^\"]+\")" ""
681 MPI_LINK_CMDLINE_FILTERED "${MPI_LINK_CMDLINE}")
683 # Some MPI implementations pass on options they themselves were built with. Since -z,noexecstack is a common
684 # hardening, we should strip it. In general, the -z options should be undesirable.
685 string(REGEX REPLACE "(^| )-Wl,-z(,[^ ]+| +-Wl,[^ ]+)" "" MPI_LINK_CMDLINE_FILTERED "${MPI_LINK_CMDLINE_FILTERED}")
686 string(REGEX REPLACE "(^| )-Xlinker +-z +-Xlinker +[^ ]+" "" MPI_LINK_CMDLINE_FILTERED "${MPI_LINK_CMDLINE_FILTERED}")
688 # We only consider options of the form -Wl or -Xlinker:
689 string(REGEX MATCHALL "(^| )(-Wl,|-Xlinker +)([^\" ]+|\"[^\"]+\")" MPI_ALL_LINK_FLAGS "${MPI_LINK_CMDLINE_FILTERED}")
691 # As a next step, we assemble the linker flags extracted in a preliminary flags string
692 foreach(_MPI_LINK_FLAG IN LISTS MPI_ALL_LINK_FLAGS)
693 string(STRIP "${_MPI_LINK_FLAG}" _MPI_LINK_FLAG)
694 if (MPI_LINK_FLAGS_WORK)
695 string(APPEND MPI_LINK_FLAGS_WORK " ${_MPI_LINK_FLAG}")
697 set(MPI_LINK_FLAGS_WORK "${_MPI_LINK_FLAG}")
701 # In the filtered case, we obtain the link time flags by just stripping the library paths.
702 string(REGEX REPLACE "(^| )${CMAKE_LIBRARY_PATH_FLAG} *([^\" ]+|\"[^\"]+\")" "" MPI_LINK_CMDLINE_FILTERED "${MPI_LINK_CMDLINE}")
705 # If we failed to extract any linker paths, we'll try using the -showme:libdirs option with the MPI compiler.
706 # This will return a list of folders, not a set of flags!
707 if (NOT MPI_ALL_LINK_PATHS)
708 _MPI_check_compiler(${LANG} "-showme:libdirs" MPI_LIBDIRS_CMDLINE MPI_LIBDIRS_COMPILER_RETURN)
709 if(MPI_LIBDIRS_COMPILER_RETURN)
710 separate_arguments(MPI_ALL_LINK_PATHS NATIVE_COMMAND "${MPI_LIBDIRS_CMDLINE}")
714 # We need to remove potential quotes and convert the paths to CMake syntax while resolving them, too.
715 foreach(_MPI_LPATH IN LISTS MPI_ALL_LINK_PATHS)
716 string(REPLACE "\"" "" _MPI_LPATH "${_MPI_LPATH}")
717 get_filename_component(_MPI_LPATH "${_MPI_LPATH}" REALPATH)
718 list(APPEND MPI_LINK_DIRECTORIES_WORK "${_MPI_LPATH}")
721 # Extract the set of libraries to link against from the link command line
722 # This only makes sense if CMAKE_LINK_LIBRARY_FLAG is defined, i.e. a -lxxxx syntax is supported by the compiler.
723 if(CMAKE_LINK_LIBRARY_FLAG)
724 string(REGEX MATCHALL "(^| )${CMAKE_LINK_LIBRARY_FLAG}([^\" ]+|\"[^\"]+\")"
725 MPI_LIBNAMES "${MPI_LINK_CMDLINE}")
727 foreach(_MPI_LIB_NAME IN LISTS MPI_LIBNAMES)
728 string(REGEX REPLACE "^ ?${CMAKE_LINK_LIBRARY_FLAG}" "" _MPI_LIB_NAME "${_MPI_LIB_NAME}")
729 string(REPLACE "\"" "" _MPI_LIB_NAME "${_MPI_LIB_NAME}")
730 list(APPEND MPI_LIB_NAMES_WORK "${_MPI_LIB_NAME}")
734 # Treat linker objects given by full path, for example static libraries, import libraries
735 # or shared libraries if there aren't any import libraries in use on the system.
736 # Note that we do not consider CMAKE_<TYPE>_LIBRARY_PREFIX intentionally here: The linker will for a given file
737 # decide how to link it based on file type, not based on a prefix like 'lib'.
738 set(_MPI_LIB_SUFFIX_REGEX "${CMAKE_STATIC_LIBRARY_SUFFIX}")
739 if(DEFINED CMAKE_IMPORT_LIBRARY_SUFFIX)
740 if(NOT ("${CMAKE_IMPORT_LIBRARY_SUFFIX}" STREQUAL "${CMAKE_STATIC_LIBRARY_SUFFIX}"))
741 string(APPEND _MPI_SUFFIX_REGEX "|${CMAKE_IMPORT_LIBRARY_SUFFIX}")
744 string(APPEND _MPI_LIB_SUFFIX_REGEX "|${CMAKE_SHARED_LIBRARY_SUFFIX}")
746 set(_MPI_LIB_NAME_REGEX "(([^\" ]+(${_MPI_LIB_SUFFIX_REGEX}))|(\"[^\"]+(${_MPI_LIB_SUFFIX_REGEX})\"))( +|$)")
747 string(REPLACE "." "\\." _MPI_LIB_NAME_REGEX "${_MPI_LIB_NAME_REGEX}")
749 string(REGEX MATCHALL "${_MPI_LIB_NAME_REGEX}" MPI_LIBNAMES "${MPI_LINK_CMDLINE}")
750 foreach(_MPI_LIB_NAME IN LISTS MPI_LIBNAMES)
751 string(REGEX REPLACE "^ +\"?|\"? +$" "" _MPI_LIB_NAME "${_MPI_LIB_NAME}")
752 get_filename_component(_MPI_LIB_PATH "${_MPI_LIB_NAME}" DIRECTORY)
753 if(NOT "${_MPI_LIB_PATH}" STREQUAL "")
754 list(APPEND MPI_LIB_FULLPATHS_WORK "${_MPI_LIB_NAME}")
756 list(APPEND MPI_LIB_NAMES_WORK "${_MPI_LIB_NAME}")
760 # Save the explicitly given link directories
761 set(MPI_LINK_DIRECTORIES_LEFTOVER "${MPI_LINK_DIRECTORIES_WORK}")
763 # An MPI compiler wrapper could have its MPI libraries in the implictly
764 # linked directories of the compiler itself.
765 if(DEFINED CMAKE_${LANG}_IMPLICIT_LINK_DIRECTORIES)
766 list(APPEND MPI_LINK_DIRECTORIES_WORK "${CMAKE_${LANG}_IMPLICIT_LINK_DIRECTORIES}")
769 # Determine full path names for all of the libraries that one needs
770 # to link against in an MPI program
771 unset(MPI_PLAIN_LIB_NAMES_WORK)
772 foreach(_MPI_LIB_NAME IN LISTS MPI_LIB_NAMES_WORK)
773 get_filename_component(_MPI_PLAIN_LIB_NAME "${_MPI_LIB_NAME}" NAME_WE)
774 list(APPEND MPI_PLAIN_LIB_NAMES_WORK "${_MPI_PLAIN_LIB_NAME}")
775 find_library(MPI_${_MPI_PLAIN_LIB_NAME}_LIBRARY
776 NAMES "${_MPI_LIB_NAME}" "lib${_MPI_LIB_NAME}"
777 HINTS ${MPI_LINK_DIRECTORIES_WORK}
778 DOC "Location of the ${_MPI_PLAIN_LIB_NAME} library for MPI"
780 mark_as_advanced(MPI_${_MPI_PLAIN_LIB_NAME}_LIBRARY)
781 # Remove the directory from the remainder list.
782 if(MPI_${_MPI_PLAIN_LIB_NAME}_LIBRARY)
783 get_filename_component(_MPI_TAKEN_DIRECTORY "${MPI_${_MPI_PLAIN_LIB_NAME}_LIBRARY}" DIRECTORY)
784 list(REMOVE_ITEM MPI_LINK_DIRECTORIES_LEFTOVER "${_MPI_TAKEN_DIRECTORY}")
788 # Add the link directories given explicitly that we haven't used back as linker directories.
790 foreach(_MPI_LINK_DIRECTORY IN LISTS MPI_LINK_DIRECTORIES_LEFTOVER)
791 file(TO_NATIVE_PATH "${_MPI_LINK_DIRECTORY}" _MPI_LINK_DIRECTORY_ACTUAL)
792 string(FIND "${_MPI_LINK_DIRECTORY_ACTUAL}" " " _MPI_LINK_DIRECTORY_CONTAINS_SPACE)
793 if(NOT _MPI_LINK_DIRECTORY_CONTAINS_SPACE EQUAL -1)
794 set(_MPI_LINK_DIRECTORY_ACTUAL "\"${_MPI_LINK_DIRECTORY_ACTUAL}\"")
796 if(MPI_LINK_FLAGS_WORK)
797 string(APPEND MPI_LINK_FLAGS_WORK " ${CMAKE_LIBRARY_PATH_FLAG}${_MPI_LINK_DIRECTORY_ACTUAL}")
799 set(MPI_LINK_FLAGS_WORK "${CMAKE_LIBRARY_PATH_FLAG}${_MPI_LINK_DIRECTORY_ACTUAL}")
804 # Deal with the libraries given with full path next
805 unset(MPI_DIRECT_LIB_NAMES_WORK)
806 foreach(_MPI_LIB_FULLPATH IN LISTS MPI_LIB_FULLPATHS_WORK)
807 get_filename_component(_MPI_PLAIN_LIB_NAME "${_MPI_LIB_FULLPATH}" NAME_WE)
808 list(APPEND MPI_DIRECT_LIB_NAMES_WORK "${_MPI_PLAIN_LIB_NAME}")
809 set(MPI_${_MPI_PLAIN_LIB_NAME}_LIBRARY "${_MPI_LIB_FULLPATH}" CACHE FILEPATH "Location of the ${_MPI_PLAIN_LIB_NAME} library for MPI")
810 mark_as_advanced(MPI_${_MPI_PLAIN_LIB_NAME}_LIBRARY)
812 # Directly linked objects should be linked first in case some generic linker flags are needed for them.
813 if(MPI_DIRECT_LIB_NAMES_WORK)
814 set(MPI_PLAIN_LIB_NAMES_WORK "${MPI_DIRECT_LIB_NAMES_WORK};${MPI_PLAIN_LIB_NAMES_WORK}")
817 # MPI might require pthread to work. The above mechanism wouldn't detect it, but we need to
818 # link it in that case. -lpthread is covered by the normal library treatment on the other hand.
819 if("${MPI_COMPILE_CMDLINE}" MATCHES "-pthread")
820 list(APPEND MPI_COMPILE_OPTIONS_WORK "-pthread")
821 if(MPI_LINK_FLAGS_WORK)
822 string(APPEND MPI_LINK_FLAGS_WORK " -pthread")
824 set(MPI_LINK_FLAGS_WORK "-pthread")
828 if(MPI_${LANG}_EXTRA_COMPILE_DEFINITIONS)
829 list(APPEND MPI_COMPILE_DEFINITIONS_WORK "${MPI_${LANG}_EXTRA_COMPILE_DEFINITIONS}")
831 if(MPI_${LANG}_EXTRA_COMPILE_OPTIONS)
832 list(APPEND MPI_COMPILE_OPTIONS_WORK "${MPI_${LANG}_EXTRA_COMPILE_OPTIONS}")
834 if(MPI_${LANG}_EXTRA_LIB_NAMES)
835 list(APPEND MPI_PLAIN_LIB_NAMES_WORK "${MPI_${LANG}_EXTRA_LIB_NAMES}")
838 # If we found MPI, set up all of the appropriate cache entries
839 if(NOT MPI_${LANG}_COMPILE_OPTIONS)
840 set(MPI_${LANG}_COMPILE_OPTIONS ${MPI_COMPILE_OPTIONS_WORK} CACHE STRING "MPI ${LANG} compilation options" FORCE)
842 if(NOT MPI_${LANG}_COMPILE_DEFINITIONS)
843 set(MPI_${LANG}_COMPILE_DEFINITIONS ${MPI_COMPILE_DEFINITIONS_WORK} CACHE STRING "MPI ${LANG} compilation definitions" FORCE)
845 if(NOT MPI_${LANG}_COMPILER_INCLUDE_DIRS)
846 set(MPI_${LANG}_COMPILER_INCLUDE_DIRS ${MPI_INCLUDE_DIRS_WORK} CACHE STRING "MPI ${LANG} compiler wrapper include directories" FORCE)
848 if(NOT MPI_${LANG}_LINK_FLAGS)
849 set(MPI_${LANG}_LINK_FLAGS ${MPI_LINK_FLAGS_WORK} CACHE STRING "MPI ${LANG} linker flags" FORCE)
851 if(NOT MPI_${LANG}_LIB_NAMES)
852 set(MPI_${LANG}_LIB_NAMES ${MPI_PLAIN_LIB_NAMES_WORK} CACHE STRING "MPI ${LANG} libraries to link against" FORCE)
854 set(MPI_${LANG}_WRAPPER_FOUND TRUE PARENT_SCOPE)
857 function(_MPI_guess_settings LANG)
858 set(MPI_GUESS_FOUND FALSE)
859 # Currently only MSMPI and MPICH2 on Windows are supported, so we can skip this search if we're not targeting that.
863 # The environment variables MSMPI_INC and MSMPILIB32/64 are the only ways of locating the MSMPI_SDK,
864 # which is installed separately from the runtime. Thus it's possible to have mpiexec but not MPI headers
865 # or import libraries and vice versa.
866 if(NOT MPI_GUESS_LIBRARY_NAME OR "${MPI_GUESS_LIBRARY_NAME}" STREQUAL "MSMPI")
867 # We first attempt to locate the msmpi.lib. Should be find it, we'll assume that the MPI present is indeed
869 if("${CMAKE_SIZEOF_VOID_P}" EQUAL 8)
870 file(TO_CMAKE_PATH "$ENV{MSMPI_LIB64}" MPI_MSMPI_LIB_PATH)
871 file(TO_CMAKE_PATH "$ENV{MSMPI_INC}/x64" MPI_MSMPI_INC_PATH_EXTRA)
873 file(TO_CMAKE_PATH "$ENV{MSMPI_LIB32}" MPI_MSMPI_LIB_PATH)
874 file(TO_CMAKE_PATH "$ENV{MSMPI_INC}/x86" MPI_MSMPI_INC_PATH_EXTRA)
877 find_library(MPI_msmpi_LIBRARY
879 HINTS ${MPI_MSMPI_LIB_PATH}
880 DOC "Location of the msmpi library for Microsoft MPI")
881 mark_as_advanced(MPI_msmpi_LIBRARY)
883 if(MPI_msmpi_LIBRARY)
884 # Next, we attempt to locate the MPI header. Note that for Fortran we know that mpif.h is a way
885 # MSMPI can be used and therefore that header has to be present.
886 if(NOT MPI_${LANG}_ADDITIONAL_INCLUDE_DIRS)
887 get_filename_component(MPI_MSMPI_INC_DIR "$ENV{MSMPI_INC}" REALPATH)
888 set(MPI_${LANG}_ADDITIONAL_INCLUDE_DIRS "${MPI_MSMPI_INC_DIR}" CACHE STRING "MPI ${LANG} additional include directories" FORCE)
889 unset(MPI_MSMPI_INC_DIR)
892 # For MSMPI, one can compile the MPI module by building the mpi.f90 shipped with the MSMPI SDK,
893 # thus it might be present or provided by the user. Figuring out which is supported is done later on.
894 # The PGI Fortran compiler for instance ships a prebuilt set of modules in its own include folder.
895 # Should a user be employing PGI or have built its own set and provided it via cache variables, the
896 # splitting routine would have located the module files.
898 # For C and C++, we're done here (MSMPI does not ship the MPI-2 C++ bindings) - however, for Fortran
899 # we need some extra library to glue Fortran support together:
900 # MSMPI ships 2-4 Fortran libraries, each for different Fortran compiler behaviors. The library names
901 # ending with a c are using the cdecl calling convention, whereas those ending with an s are for Fortran
902 # implementations using stdcall. Therefore, the 64-bit MSMPI only ships those ending in 'c', whereas the 32-bit
903 # has both variants available.
904 # The second difference is the last but one letter, if it's an e(nd), the length of a string argument is
905 # passed by the Fortran compiler after all other arguments on the parameter list, if it's an m(ixed),
906 # it's passed immediately after the string address.
909 # - msmpifec: CHARACTER length passed after the parameter list and using cdecl calling convention
910 # - msmpifmc: CHARACTER length passed directly after string address and using cdecl calling convention
911 # - msmpifes: CHARACTER length passed after the parameter list and using stdcall calling convention
912 # - msmpifms: CHARACTER length passed directly after string address and using stdcall calling convention
913 # 32-bit MSMPI ships all four libraries, 64-bit MSMPI ships only the first two.
915 # As is, Intel Fortran and PGI Fortran both use the 'ec' variant of the calling convention, whereas
916 # the old Compaq Visual Fortran compiler defaulted to the 'ms' version. It's possible to make Intel Fortran
917 # use the CVF calling convention using /iface:cvf, but we assume - and this is also assumed in FortranCInterface -
918 # this isn't the case. It's also possible to make CVF use the 'ec' variant, using /iface=(cref,nomixed_str_len_arg).
920 # Our strategy is now to locate all libraries, but enter msmpifec into the LIB_NAMES array.
921 # Should this not be adequate it's a straightforward way for a user to change the LIB_NAMES array and
922 # have his library found. Still, this should not be necessary outside of exceptional cases, as reasoned.
923 if ("${LANG}" STREQUAL "Fortran")
924 set(MPI_MSMPI_CALLINGCONVS c)
925 if("${CMAKE_SIZEOF_VOID_P}" EQUAL 4)
926 list(APPEND MPI_MSMPI_CALLINGCONVS s)
928 foreach(mpistrlenpos IN ITEMS e m)
929 foreach(mpicallingconv IN LISTS MPI_MSMPI_CALLINGCONVS)
930 find_library(MPI_msmpif${mpistrlenpos}${mpicallingconv}_LIBRARY
931 NAMES msmpif${mpistrlenpos}${mpicallingconv}
932 HINTS "${MPI_MSMPI_LIB_PATH}"
933 DOC "Location of the msmpi${mpistrlenpos}${mpicallingconv} library for Microsoft MPI")
934 mark_as_advanced(MPI_msmpif${mpistrlenpos}${mpicallingconv}_LIBRARY)
937 if(NOT MPI_${LANG}_LIB_NAMES)
938 set(MPI_${LANG}_LIB_NAMES "msmpi;msmpifec" CACHE STRING "MPI ${LANG} libraries to link against" FORCE)
941 # At this point we're *not* done. MSMPI requires an additional include file for Fortran giving the value
942 # of MPI_AINT. This file is called mpifptr.h located in the x64 and x86 subfolders, respectively.
943 find_path(MPI_mpifptr_INCLUDE_DIR
945 HINTS "${MPI_MSMPI_INC_PATH_EXTRA}"
946 DOC "Location of the mpifptr.h extra header for Microsoft MPI")
947 if(NOT MPI_${LANG}_ADDITIONAL_INCLUDE_VARS)
948 set(MPI_${LANG}_ADDITIONAL_INCLUDE_VARS "mpifptr" CACHE STRING "MPI ${LANG} additional include directory variables, given in the form MPI_<name>_INCLUDE_DIR." FORCE)
950 mark_as_advanced(MPI_${LANG}_ADDITIONAL_INCLUDE_VARS MPI_mpifptr_INCLUDE_DIR)
952 if(NOT MPI_${LANG}_LIB_NAMES)
953 set(MPI_${LANG}_LIB_NAMES "msmpi" CACHE STRING "MPI ${LANG} libraries to link against" FORCE)
956 mark_as_advanced(MPI_${LANG}_LIB_NAMES)
957 set(MPI_GUESS_FOUND TRUE)
959 if(_MPIEXEC_NOT_GIVEN)
960 unset(MPIEXEC_EXECUTABLE CACHE)
963 find_program(MPIEXEC_EXECUTABLE
965 HINTS $ENV{MSMPI_BIN} "[HKEY_LOCAL_MACHINE\\SOFTWARE\\Microsoft\\MPI;InstallRoot]/Bin"
966 DOC "Executable for running MPI programs.")
970 # At this point there's not many MPIs that we could still consider.
971 # OpenMPI 1.6.x and below supported Windows, but these ship compiler wrappers that still work.
972 # The only other relevant MPI implementation without a wrapper is MPICH2, which had Windows support in 1.4.1p1 and older.
973 if(NOT MPI_GUESS_FOUND AND (NOT MPI_GUESS_LIBRARY_NAME OR "${MPI_GUESS_LIBRARY_NAME}" STREQUAL "MPICH2"))
974 set(MPI_MPICH_PREFIX_PATHS
975 "$ENV{ProgramW6432}/MPICH2/lib"
976 "[HKEY_LOCAL_MACHINE\\SOFTWARE\\MPICH\\SMPD;binary]/../lib"
977 "[HKEY_LOCAL_MACHINE\\SOFTWARE\\MPICH2;Path]/lib"
980 # All of C, C++ and Fortran will need mpi.lib, so we'll look for this first
981 find_library(MPI_mpi_LIBRARY
983 HINTS ${MPI_MPICH_PREFIX_PATHS})
984 mark_as_advanced(MPI_mpi_LIBRARY)
985 # If we found mpi.lib, we detect the rest of MPICH2
987 set(MPI_MPICH_LIB_NAMES "mpi")
988 # If MPI-2 C++ bindings are requested, we need to locate cxx.lib as well.
989 # Otherwise, MPICH_SKIP_MPICXX will be defined and these bindings aren't needed.
990 if("${LANG}" STREQUAL "CXX" AND NOT MPI_CXX_SKIP_MPICXX)
991 find_library(MPI_cxx_LIBRARY
993 HINTS ${MPI_MPICH_PREFIX_PATHS})
994 mark_as_advanced(MPI_cxx_LIBRARY)
995 list(APPEND MPI_MPICH_LIB_NAMES "cxx")
996 # For Fortran, MPICH2 provides three different libraries:
997 # fmpich2.lib which uses uppercase symbols and cdecl,
998 # fmpich2s.lib which uses uppercase symbols and stdcall (32-bit only),
999 # fmpich2g.lib which uses lowercase symbols with double underscores and cdecl.
1000 # fmpich2s.lib would be useful for Compaq Visual Fortran, fmpich2g.lib has to be used with GNU g77 and is also
1001 # provided in the form of an .a archive for MinGW and Cygwin. From our perspective, fmpich2.lib is the only one
1002 # we need to try, and if it doesn't work with the given Fortran compiler we'd find out later on during validation
1003 elseif("${LANG}" STREQUAL "Fortran")
1004 find_library(MPI_fmpich2_LIBRARY
1006 HINTS ${MPI_MPICH_PREFIX_PATHS})
1007 find_library(MPI_fmpich2s_LIBRARY
1009 HINTS ${MPI_MPICH_PREFIX_PATHS})
1010 find_library(MPI_fmpich2g_LIBRARY
1012 HINTS ${MPI_MPICH_PREFIX_PATHS})
1013 mark_as_advanced(MPI_fmpich2_LIBRARY MPI_fmpich2s_LIBRARY MPI_fmpich2g_LIBRARY)
1014 list(APPEND MPI_MPICH_LIB_NAMES "fmpich2")
1017 if(NOT MPI_${LANG}_LIB_NAMES)
1018 set(MPI_${LANG}_LIB_NAMES "${MPI_MPICH_LIB_NAMES}" CACHE STRING "MPI ${LANG} libraries to link against" FORCE)
1020 unset(MPI_MPICH_LIB_NAMES)
1022 if(NOT MPI_${LANG}_ADDITIONAL_INCLUDE_DIRS)
1023 # For MPICH2, the include folder would be in ../include relative to the library folder.
1024 get_filename_component(MPI_MPICH_ROOT_DIR "${MPI_mpi_LIBRARY}" DIRECTORY)
1025 get_filename_component(MPI_MPICH_ROOT_DIR "${MPI_MPICH_ROOT_DIR}" DIRECTORY)
1026 if(IS_DIRECTORY "${MPI_MPICH_ROOT_DIR}/include")
1027 set(MPI_${LANG}_ADDITIONAL_INCLUDE_DIRS "${MPI_MPICH_ROOT_DIR}/include" CACHE STRING "MPI ${LANG} additional include directory variables, given in the form MPI_<name>_INCLUDE_DIR." FORCE)
1029 unset(MPI_MPICH_ROOT_DIR)
1031 set(MPI_GUESS_FOUND TRUE)
1033 if(_MPIEXEC_NOT_GIVEN)
1034 unset(MPIEXEC_EXECUTABLE CACHE)
1037 find_program(MPIEXEC_EXECUTABLE
1038 NAMES ${_MPIEXEC_NAMES}
1039 HINTS "$ENV{ProgramW6432}/MPICH2/bin"
1040 "[HKEY_LOCAL_MACHINE\\SOFTWARE\\MPICH\\SMPD;binary]"
1041 "[HKEY_LOCAL_MACHINE\\SOFTWARE\\MPICH2;Path]/bin"
1042 DOC "Executable for running MPI programs.")
1044 unset(MPI_MPICH_PREFIX_PATHS)
1047 set(MPI_${LANG}_GUESS_FOUND "${MPI_GUESS_FOUND}" PARENT_SCOPE)
1050 function(_MPI_adjust_compile_definitions LANG)
1051 if("${LANG}" STREQUAL "CXX")
1052 # To disable the C++ bindings, we need to pass some definitions since the mpi.h header has to deal with both C and C++
1053 # bindings in MPI-2.
1054 if(MPI_CXX_SKIP_MPICXX AND NOT MPI_${LANG}_COMPILE_DEFINITIONS MATCHES "SKIP_MPICXX")
1055 # MPICH_SKIP_MPICXX is being used in MPICH and derivatives like MVAPICH or Intel MPI
1056 # OMPI_SKIP_MPICXX is being used in Open MPI
1057 # _MPICC_H is being used for IBM Platform MPI
1058 list(APPEND MPI_${LANG}_COMPILE_DEFINITIONS "MPICH_SKIP_MPICXX" "OMPI_SKIP_MPICXX" "_MPICC_H")
1059 set(MPI_${LANG}_COMPILE_DEFINITIONS "${MPI_${LANG}_COMPILE_DEFINITIONS}" CACHE STRING "MPI ${LANG} compilation definitions" FORCE)
1064 macro(_MPI_assemble_libraries LANG)
1065 set(MPI_${LANG}_LIBRARIES "")
1066 # Only for libraries do we need to check whether the compiler's linking stage is separate.
1067 if(NOT "${MPI_${LANG}_COMPILER}" STREQUAL "${CMAKE_${LANG}_COMPILER}" OR NOT MPI_${LANG}_WORKS_IMPLICIT)
1068 foreach(mpilib IN LISTS MPI_${LANG}_LIB_NAMES)
1069 list(APPEND MPI_${LANG}_LIBRARIES ${MPI_${mpilib}_LIBRARY})
1074 macro(_MPI_assemble_include_dirs LANG)
1075 set(MPI_${LANG}_INCLUDE_DIRS
1076 ${MPI_${LANG}_COMPILER_INCLUDE_DIRS}
1077 ${MPI_${LANG}_ADDITIONAL_INCLUDE_DIRS}
1079 if("${LANG}" MATCHES "(C|CXX)")
1080 if(MPI_${LANG}_HEADER_DIR)
1081 list(APPEND MPI_${LANG}_INCLUDE_DIRS "${MPI_${LANG}_HEADER_DIR}")
1084 if(MPI_${LANG}_F77_HEADER_DIR)
1085 list(APPEND MPI_${LANG}_INCLUDE_DIRS "${MPI_${LANG}_F77_HEADER_DIR}")
1087 if(MPI_${LANG}_MODULE_DIR)
1088 list(APPEND MPI_${LANG}_INCLUDE_DIRS "${MPI_${LANG}_MODULE_DIR}")
1091 if(MPI_${LANG}_INCLUDE_DIRS)
1092 list(REMOVE_DUPLICATES MPI_${LANG}_INCLUDE_DIRS)
1096 macro(_MPI_split_include_dirs LANG)
1097 # Backwards compatibility: Search INCLUDE_PATH if given.
1098 if(MPI_${LANG}_INCLUDE_PATH)
1099 list(APPEND MPI_${LANG}_ADDITIONAL_INCLUDE_DIRS "${MPI_${LANG}_INCLUDE_PATH}")
1102 # We try to find the headers/modules among those paths (and system paths)
1103 # For C/C++, we just need to have a look for mpi.h.
1104 if("${LANG}" MATCHES "(C|CXX)")
1105 find_path(MPI_${LANG}_HEADER_DIR "mpi.h"
1107 ${MPI_${LANG}_COMPILER_INCLUDE_DIRS}
1108 ${MPI_${LANG}_ADDITIONAL_INCLUDE_DIRS}
1110 mark_as_advanced(MPI_${LANG}_HEADER_DIR)
1111 if(MPI_${LANG}_ADDITIONAL_INCLUDE_DIRS)
1112 list(REMOVE_ITEM MPI_${LANG}_ADDITIONAL_INCLUDE_DIRS "${MPI_${LANG}_HEADER_DIR}")
1115 # Fortran is more complicated here: An implementation could provide
1116 # any of the Fortran 77/90/2008 APIs for MPI. For example, MSMPI
1117 # only provides Fortran 77 and - if mpi.f90 is built - potentially
1118 # a Fortran 90 module.
1119 elseif("${LANG}" STREQUAL "Fortran")
1120 find_path(MPI_${LANG}_F77_HEADER_DIR "mpif.h"
1122 ${MPI_${LANG}_COMPILER_INCLUDE_DIRS}
1123 ${MPI_${LANG}_ADDITIONAL_INCLUDE_DIRS}
1125 find_path(MPI_${LANG}_MODULE_DIR
1126 NAMES "mpi.mod" "mpi_f08.mod"
1128 ${MPI_${LANG}_COMPILER_INCLUDE_DIRS}
1129 ${MPI_${LANG}_ADDITIONAL_INCLUDE_DIRS}
1131 if(MPI_${LANG}_ADDITIONAL_INCLUDE_DIRS)
1132 list(REMOVE_ITEM MPI_${LANG}_ADDITIONAL_INCLUDE_DIRS
1133 "${MPI_${LANG}_F77_HEADER_DIR}"
1134 "${MPI_${LANG}_MODULE_DIR}"
1137 mark_as_advanced(MPI_${LANG}_F77_HEADER_DIR MPI_${LANG}_MODULE_DIR)
1140 # Remove duplicates and default system directories from the list.
1141 if(MPI_${LANG}_ADDITIONAL_INCLUDE_DIRS)
1142 list(REMOVE_DUPLICATES MPI_${LANG}_ADDITIONAL_INCLUDE_DIRS)
1143 foreach(MPI_IMPLICIT_INC_DIR IN LISTS CMAKE_${LANG}_IMPLICIT_LINK_DIRECTORIES)
1144 list(REMOVE_ITEM MPI_${LANG}_ADDITIONAL_INCLUDE_DIRS ${MPI_IMPLICIT_INC_DIR})
1148 set(MPI_${LANG}_ADDITIONAL_INCLUDE_DIRS ${MPI_${LANG}_ADDITIONAL_INCLUDE_DIRS} CACHE STRING "MPI ${LANG} additional include directories" FORCE)
1151 macro(_MPI_create_imported_target LANG)
1152 if(NOT TARGET MPI::MPI_${LANG})
1153 add_library(MPI::MPI_${LANG} INTERFACE IMPORTED)
1156 # When this is consumed for compiling CUDA, use '-Xcompiler' to wrap '-pthread' and '-fexceptions'.
1157 string(REPLACE "-pthread" "$<$<COMPILE_LANG_AND_ID:CUDA,NVIDIA>:SHELL:-Xcompiler >-pthread"
1158 _MPI_${LANG}_COMPILE_OPTIONS "${MPI_${LANG}_COMPILE_OPTIONS}")
1159 string(REPLACE "-fexceptions" "$<$<COMPILE_LANG_AND_ID:CUDA,NVIDIA>:SHELL:-Xcompiler >-fexceptions"
1160 _MPI_${LANG}_COMPILE_OPTIONS "${_MPI_${LANG}_COMPILE_OPTIONS}")
1161 set_property(TARGET MPI::MPI_${LANG} PROPERTY INTERFACE_COMPILE_OPTIONS "${_MPI_${LANG}_COMPILE_OPTIONS}")
1162 unset(_MPI_${LANG}_COMPILE_OPTIONS)
1164 set_property(TARGET MPI::MPI_${LANG} PROPERTY INTERFACE_COMPILE_DEFINITIONS "${MPI_${LANG}_COMPILE_DEFINITIONS}")
1166 if(MPI_${LANG}_LINK_FLAGS)
1167 string(REPLACE "-pthread" "$<$<LINK_LANG_AND_ID:CUDA,NVIDIA>:-Xlinker >-pthread"
1168 _MPI_${LANG}_LINK_FLAGS "${MPI_${LANG}_LINK_FLAGS}")
1169 set_property(TARGET MPI::MPI_${LANG} PROPERTY INTERFACE_LINK_OPTIONS "SHELL:${MPI_${LANG}_LINK_FLAGS}")
1171 # If the compiler links MPI implicitly, no libraries will be found as they're contained within
1172 # CMAKE_<LANG>_IMPLICIT_LINK_LIBRARIES already.
1173 if(MPI_${LANG}_LIBRARIES)
1174 set_property(TARGET MPI::MPI_${LANG} PROPERTY INTERFACE_LINK_LIBRARIES "${MPI_${LANG}_LIBRARIES}")
1176 # Given the new design of FindMPI, INCLUDE_DIRS will always be located, even under implicit linking.
1177 set_property(TARGET MPI::MPI_${LANG} PROPERTY INTERFACE_INCLUDE_DIRECTORIES "${MPI_${LANG}_INCLUDE_DIRS}")
1180 function(_MPI_try_staged_settings LANG MPI_TEST_FILE_NAME MODE RUN_BINARY SUPPRESS_ERRORS)
1181 set(WORK_DIR "${CMAKE_BINARY_DIR}${CMAKE_FILES_DIRECTORY}/FindMPI")
1182 set(SRC_DIR "${CMAKE_ROOT}/Modules/FindMPI")
1183 set(BIN_FILE "${CMAKE_BINARY_DIR}${CMAKE_FILES_DIRECTORY}/FindMPI/${MPI_TEST_FILE_NAME}_${LANG}.bin")
1184 unset(MPI_TEST_COMPILE_DEFINITIONS)
1185 if("${LANG}" STREQUAL "Fortran")
1186 if("${MODE}" STREQUAL "F90_MODULE")
1187 set(MPI_Fortran_INCLUDE_LINE "use mpi\n implicit none")
1188 elseif("${MODE}" STREQUAL "F08_MODULE")
1189 set(MPI_Fortran_INCLUDE_LINE "use mpi_f08\n implicit none")
1191 set(MPI_Fortran_INCLUDE_LINE "implicit none\n include 'mpif.h'")
1193 configure_file("${SRC_DIR}/${MPI_TEST_FILE_NAME}.f90.in" "${WORK_DIR}/${MPI_TEST_FILE_NAME}.f90" @ONLY)
1194 set(MPI_TEST_SOURCE_FILE "${WORK_DIR}/${MPI_TEST_FILE_NAME}.f90")
1195 elseif("${LANG}" STREQUAL "CXX")
1196 configure_file("${SRC_DIR}/${MPI_TEST_FILE_NAME}.c" "${WORK_DIR}/${MPI_TEST_FILE_NAME}.cpp" COPYONLY)
1197 set(MPI_TEST_SOURCE_FILE "${WORK_DIR}/${MPI_TEST_FILE_NAME}.cpp")
1198 if("${MODE}" STREQUAL "TEST_MPICXX")
1199 set(MPI_TEST_COMPILE_DEFINITIONS TEST_MPI_MPICXX)
1202 set(MPI_TEST_SOURCE_FILE "${SRC_DIR}/${MPI_TEST_FILE_NAME}.c")
1205 try_run(MPI_RUN_RESULT_${LANG}_${MPI_TEST_FILE_NAME}_${MODE} MPI_RESULT_${LANG}_${MPI_TEST_FILE_NAME}_${MODE}
1206 "${CMAKE_BINARY_DIR}" SOURCES "${MPI_TEST_SOURCE_FILE}"
1207 COMPILE_DEFINITIONS ${MPI_TEST_COMPILE_DEFINITIONS}
1208 LINK_LIBRARIES MPI::MPI_${LANG}
1209 RUN_OUTPUT_VARIABLE MPI_RUN_OUTPUT_${LANG}_${MPI_TEST_FILE_NAME}_${MODE}
1210 COMPILE_OUTPUT_VARIABLE _MPI_TRY_${MPI_TEST_FILE_NAME}_${MODE}_OUTPUT)
1211 set(MPI_RUN_OUTPUT_${LANG}_${MPI_TEST_FILE_NAME}_${MODE} "${MPI_RUN_OUTPUT_${LANG}_${MPI_TEST_FILE_NAME}_${MODE}}" PARENT_SCOPE)
1213 try_compile(MPI_RESULT_${LANG}_${MPI_TEST_FILE_NAME}_${MODE}
1214 "${CMAKE_BINARY_DIR}" SOURCES "${MPI_TEST_SOURCE_FILE}"
1215 COMPILE_DEFINITIONS ${MPI_TEST_COMPILE_DEFINITIONS}
1216 LINK_LIBRARIES MPI::MPI_${LANG}
1217 COPY_FILE "${BIN_FILE}"
1218 OUTPUT_VARIABLE _MPI_TRY_${MPI_TEST_FILE_NAME}_${MODE}_OUTPUT)
1220 if(NOT SUPPRESS_ERRORS)
1221 if(NOT MPI_RESULT_${LANG}_${MPI_TEST_FILE_NAME}_${MODE})
1222 file(APPEND ${CMAKE_BINARY_DIR}${CMAKE_FILES_DIRECTORY}/CMakeError.log
1223 "The MPI test ${MPI_TEST_FILE_NAME} for ${LANG} in mode ${MODE} failed to compile with the following output:\n${_MPI_TRY_${MPI_TEST_FILE_NAME}_${MODE}_OUTPUT}\n\n")
1224 elseif(DEFINED MPI_RUN_RESULT_${LANG}_${MPI_TEST_FILE_NAME}_${MODE} AND MPI_RUN_RESULT_${LANG}_${MPI_TEST_FILE_NAME}_${MODE})
1225 file(APPEND ${CMAKE_BINARY_DIR}${CMAKE_FILES_DIRECTORY}/CMakeError.log
1226 "The MPI test ${MPI_TEST_FILE_NAME} for ${LANG} in mode ${MODE} failed to run with the following output:\n${MPI_RUN_OUTPUT_${LANG}_${MPI_TEST_FILE_NAME}_${MODE}}\n\n")
1231 macro(_MPI_check_lang_works LANG SUPPRESS_ERRORS)
1232 # For Fortran we may have by the MPI-3 standard an implementation that provides:
1233 # - the mpi_f08 module
1234 # - *both*, the mpi module and 'mpif.h'
1235 # Since older MPI standards (MPI-1) did not define anything but 'mpif.h', we need to check all three individually.
1236 if( NOT MPI_${LANG}_WORKS )
1237 if("${LANG}" STREQUAL "Fortran")
1238 set(MPI_Fortran_INTEGER_LINE "(kind=MPI_INTEGER_KIND)")
1239 _MPI_try_staged_settings(${LANG} test_mpi F77_HEADER FALSE ${SUPPRESS_ERRORS})
1240 _MPI_try_staged_settings(${LANG} test_mpi F90_MODULE FALSE ${SUPPRESS_ERRORS})
1241 _MPI_try_staged_settings(${LANG} test_mpi F08_MODULE FALSE ${SUPPRESS_ERRORS})
1243 set(MPI_${LANG}_WORKS FALSE)
1245 foreach(mpimethod IN ITEMS F77_HEADER F08_MODULE F90_MODULE)
1246 if(MPI_RESULT_${LANG}_test_mpi_${mpimethod})
1247 set(MPI_${LANG}_WORKS TRUE)
1248 set(MPI_${LANG}_HAVE_${mpimethod} TRUE)
1250 set(MPI_${LANG}_HAVE_${mpimethod} FALSE)
1253 # MPI-1 versions had no MPI_INTGER_KIND defined, so we need to try without it.
1254 # However, MPI-1 also did not define the Fortran 90 and 08 modules, so we only try the F77 header.
1255 unset(MPI_Fortran_INTEGER_LINE)
1256 if(NOT MPI_${LANG}_WORKS)
1257 _MPI_try_staged_settings(${LANG} test_mpi F77_HEADER_NOKIND FALSE ${SUPPRESS_ERRORS})
1258 if(MPI_RESULT_${LANG}_test_mpi_F77_HEADER_NOKIND)
1259 set(MPI_${LANG}_WORKS TRUE)
1260 set(MPI_${LANG}_HAVE_F77_HEADER TRUE)
1264 _MPI_try_staged_settings(${LANG} test_mpi normal FALSE ${SUPPRESS_ERRORS})
1265 # If 'test_mpi' built correctly, we've found valid MPI settings. There might not be MPI-2 C++ support, but there can't
1266 # be MPI-2 C++ support without the C bindings being present, so checking for them is sufficient.
1267 set(MPI_${LANG}_WORKS "${MPI_RESULT_${LANG}_test_mpi_normal}")
1272 # Some systems install various MPI implementations in separate folders in some MPI prefix
1273 # This macro enumerates all such subfolders and adds them to the list of hints that will be searched.
1274 macro(MPI_search_mpi_prefix_folder PREFIX_FOLDER)
1275 if(EXISTS "${PREFIX_FOLDER}")
1276 file(GLOB _MPI_folder_children RELATIVE "${PREFIX_FOLDER}" "${PREFIX_FOLDER}/*")
1277 foreach(_MPI_folder_child IN LISTS _MPI_folder_children)
1278 if(IS_DIRECTORY "${PREFIX_FOLDER}/${_MPI_folder_child}")
1279 list(APPEND MPI_HINT_DIRS "${PREFIX_FOLDER}/${_MPI_folder_child}")
1285 set(MPI_HINT_DIRS ${MPI_HOME} $ENV{MPI_HOME} $ENV{I_MPI_ROOT})
1286 if("${CMAKE_HOST_SYSTEM_NAME}" STREQUAL "Linux")
1287 # SUSE Linux Enterprise Server stores its MPI implementations under /usr/lib64/mpi/gcc/<name>
1288 # We enumerate the subfolders and append each as a prefix
1289 MPI_search_mpi_prefix_folder("/usr/lib64/mpi/gcc")
1290 elseif("${CMAKE_HOST_SYSTEM_NAME}" STREQUAL "FreeBSD")
1291 # FreeBSD ships mpich under the normal system paths - but available openmpi implementations
1292 # will be found in /usr/local/mpi/<name>
1293 MPI_search_mpi_prefix_folder("/usr/local/mpi")
1296 # Most MPI distributions have some form of mpiexec or mpirun which gives us something we can look for.
1297 # The MPI standard does not mandate the existence of either, but instead only makes requirements if a distribution
1298 # ships an mpiexec program (mpirun executables are not regulated by the standard).
1300 # We defer searching for mpiexec binaries belonging to guesses until later. By doing so, mismatches between mpiexec
1301 # and the MPI we found should be reduced.
1302 if(NOT MPIEXEC_EXECUTABLE)
1303 set(_MPIEXEC_NOT_GIVEN TRUE)
1305 set(_MPIEXEC_NOT_GIVEN FALSE)
1308 find_program(MPIEXEC_EXECUTABLE
1309 NAMES ${_MPIEXEC_NAMES}
1310 PATH_SUFFIXES bin sbin
1311 HINTS ${MPI_HINT_DIRS}
1312 DOC "Executable for running MPI programs.")
1314 # call get_filename_component twice to remove mpiexec and the directory it exists in (typically bin).
1315 # This gives us a fairly reliable base directory to search for /bin /lib and /include from.
1316 get_filename_component(_MPI_BASE_DIR "${MPIEXEC_EXECUTABLE}" PATH)
1317 get_filename_component(_MPI_BASE_DIR "${_MPI_BASE_DIR}" PATH)
1319 # According to the MPI standard, section 8.8 -n is a guaranteed, and the only guaranteed way to
1320 # launch an MPI process using mpiexec if such a program exists.
1321 set(MPIEXEC_NUMPROC_FLAG "-n" CACHE STRING "Flag used by MPI to specify the number of processes for mpiexec; the next option will be the number of processes.")
1322 set(MPIEXEC_PREFLAGS "" CACHE STRING "These flags will be directly before the executable that is being run by mpiexec.")
1323 set(MPIEXEC_POSTFLAGS "" CACHE STRING "These flags will be placed after all flags passed to mpiexec.")
1325 # Set the number of processes to the physical processor count
1326 cmake_host_system_information(RESULT _MPIEXEC_NUMPROCS QUERY NUMBER_OF_PHYSICAL_CORES)
1327 set(MPIEXEC_MAX_NUMPROCS "${_MPIEXEC_NUMPROCS}" CACHE STRING "Maximum number of processors available to run MPI applications.")
1328 unset(_MPIEXEC_NUMPROCS)
1329 mark_as_advanced(MPIEXEC_EXECUTABLE MPIEXEC_NUMPROC_FLAG MPIEXEC_PREFLAGS MPIEXEC_POSTFLAGS MPIEXEC_MAX_NUMPROCS)
1331 #=============================================================================
1332 # Backward compatibility input hacks. Propagate the FindMPI hints to C and
1333 # CXX if the respective new versions are not defined. Translate the old
1334 # MPI_LIBRARY and MPI_EXTRA_LIBRARY to respective MPI_${LANG}_LIBRARIES.
1336 # Once we find the new variables, we translate them back into their old
1337 # equivalents below.
1338 if(NOT MPI_IGNORE_LEGACY_VARIABLES)
1339 foreach (LANG IN ITEMS C CXX)
1340 # Old input variables.
1341 set(_MPI_OLD_INPUT_VARS COMPILER COMPILE_FLAGS INCLUDE_PATH LINK_FLAGS)
1343 # Set new vars based on their old equivalents, if the new versions are not already set.
1344 foreach (var ${_MPI_OLD_INPUT_VARS})
1345 if (NOT MPI_${LANG}_${var} AND MPI_${var})
1346 set(MPI_${LANG}_${var} "${MPI_${var}}")
1350 # Chop the old compile flags into options and definitions
1352 unset(MPI_${LANG}_EXTRA_COMPILE_DEFINITIONS)
1353 unset(MPI_${LANG}_EXTRA_COMPILE_OPTIONS)
1354 if(MPI_${LANG}_COMPILE_FLAGS)
1355 separate_arguments(MPI_SEPARATE_FLAGS NATIVE_COMMAND "${MPI_${LANG}_COMPILE_FLAGS}")
1356 foreach(_MPI_FLAG IN LISTS MPI_SEPARATE_FLAGS)
1357 if("${_MPI_FLAG}" MATCHES "^ *-D([^ ]+)")
1358 list(APPEND MPI_${LANG}_EXTRA_COMPILE_DEFINITIONS "${CMAKE_MATCH_1}")
1360 list(APPEND MPI_${LANG}_EXTRA_COMPILE_OPTIONS "${_MPI_FLAG}")
1363 unset(MPI_SEPARATE_FLAGS)
1366 # If a list of libraries was given, we'll split it into new-style cache variables
1367 unset(MPI_${LANG}_EXTRA_LIB_NAMES)
1368 if(NOT MPI_${LANG}_LIB_NAMES)
1369 foreach(_MPI_LIB IN LISTS MPI_${LANG}_LIBRARIES MPI_LIBRARY MPI_EXTRA_LIBRARY)
1371 get_filename_component(_MPI_PLAIN_LIB_NAME "${_MPI_LIB}" NAME_WE)
1372 get_filename_component(_MPI_LIB_NAME "${_MPI_LIB}" NAME)
1373 get_filename_component(_MPI_LIB_DIR "${_MPI_LIB}" DIRECTORY)
1374 list(APPEND MPI_${LANG}_EXTRA_LIB_NAMES "${_MPI_PLAIN_LIB_NAME}")
1375 find_library(MPI_${_MPI_PLAIN_LIB_NAME}_LIBRARY
1376 NAMES "${_MPI_LIB_NAME}" "lib${_MPI_LIB_NAME}"
1377 HINTS ${_MPI_LIB_DIR} $ENV{MPI_LIB}
1378 DOC "Location of the ${_MPI_PLAIN_LIB_NAME} library for MPI"
1380 mark_as_advanced(MPI_${_MPI_PLAIN_LIB_NAME}_LIBRARY)
1386 #=============================================================================
1389 unset(MPI_VERSION_MAJOR)
1390 unset(MPI_VERSION_MINOR)
1392 unset(_MPI_MIN_VERSION)
1394 # If the user specified a library name we assume they prefer that library over a wrapper. If not, they can disable skipping manually.
1395 if(NOT DEFINED MPI_SKIP_COMPILER_WRAPPER AND MPI_GUESS_LIBRARY_NAME)
1396 set(MPI_SKIP_COMPILER_WRAPPER TRUE)
1399 # This loop finds the compilers and sends them off for interrogation.
1400 foreach(LANG IN ITEMS C CXX Fortran)
1401 if(CMAKE_${LANG}_COMPILER_LOADED)
1402 if(NOT MPI_FIND_COMPONENTS)
1403 set(_MPI_FIND_${LANG} TRUE)
1404 elseif( ${LANG} IN_LIST MPI_FIND_COMPONENTS)
1405 set(_MPI_FIND_${LANG} TRUE)
1406 elseif( ${LANG} STREQUAL CXX AND NOT MPI_CXX_SKIP_MPICXX AND MPICXX IN_LIST MPI_FIND_COMPONENTS )
1407 set(_MPI_FIND_${LANG} TRUE)
1409 set(_MPI_FIND_${LANG} FALSE)
1412 set(_MPI_FIND_${LANG} FALSE)
1413 string(APPEND _MPI_FAIL_REASON "MPI component '${LANG}' was requested, but language ${LANG} is not enabled. ")
1415 if(_MPI_FIND_${LANG})
1416 if( ${LANG} STREQUAL CXX AND NOT MPICXX IN_LIST MPI_FIND_COMPONENTS )
1417 set(MPI_CXX_SKIP_MPICXX FALSE CACHE BOOL "If true, the MPI-2 C++ bindings are disabled using definitions.")
1418 mark_as_advanced(MPI_CXX_SKIP_MPICXX)
1420 if(NOT (MPI_${LANG}_LIB_NAMES AND (MPI_${LANG}_INCLUDE_PATH OR MPI_${LANG}_INCLUDE_DIRS OR MPI_${LANG}_COMPILER_INCLUDE_DIRS)))
1421 set(MPI_${LANG}_TRIED_IMPLICIT FALSE)
1422 set(MPI_${LANG}_WORKS_IMPLICIT FALSE)
1423 if(NOT MPI_${LANG}_COMPILER AND NOT MPI_ASSUME_NO_BUILTIN_MPI)
1424 # Should the imported targets be empty, we effectively try whether the compiler supports MPI on its own, which is the case on e.g.
1426 _MPI_create_imported_target(${LANG})
1427 _MPI_check_lang_works(${LANG} TRUE)
1429 # If the compiler can build MPI code on its own, it functions as an MPI compiler and we'll set the variable to point to it.
1430 if(MPI_${LANG}_WORKS)
1431 set(MPI_${LANG}_COMPILER "${CMAKE_${LANG}_COMPILER}" CACHE FILEPATH "MPI compiler for ${LANG}" FORCE)
1432 set(MPI_${LANG}_WORKS_IMPLICIT TRUE)
1434 set(MPI_${LANG}_TRIED_IMPLICIT TRUE)
1437 if(NOT "${MPI_${LANG}_COMPILER}" STREQUAL "${CMAKE_${LANG}_COMPILER}" OR NOT MPI_${LANG}_WORKS)
1438 set(MPI_${LANG}_WRAPPER_FOUND FALSE)
1439 set(MPI_PINNED_COMPILER FALSE)
1441 if(NOT MPI_SKIP_COMPILER_WRAPPER)
1442 if(MPI_${LANG}_COMPILER)
1443 # If the user supplies a compiler *name* instead of an absolute path, assume that we need to find THAT compiler.
1444 if (NOT IS_ABSOLUTE "${MPI_${LANG}_COMPILER}")
1445 # Get rid of our default list of names and just search for the name the user wants.
1446 set(_MPI_${LANG}_COMPILER_NAMES "${MPI_${LANG}_COMPILER}")
1447 unset(MPI_${LANG}_COMPILER CACHE)
1449 # If the user specifies a compiler, we don't want to try to search libraries either.
1450 set(MPI_PINNED_COMPILER TRUE)
1453 # If we have an MPI base directory, we'll try all compiler names in that one first.
1454 # This should prevent mixing different MPI environments
1456 find_program(MPI_${LANG}_COMPILER
1457 NAMES ${_MPI_${LANG}_COMPILER_NAMES}
1458 PATH_SUFFIXES bin sbin
1459 HINTS ${_MPI_BASE_DIR}
1461 DOC "MPI compiler for ${LANG}"
1465 # If the base directory did not help (for example because the mpiexec isn't in the same directory as the compilers),
1466 # we shall try searching in the default paths.
1467 find_program(MPI_${LANG}_COMPILER
1468 NAMES ${_MPI_${LANG}_COMPILER_NAMES}
1469 PATH_SUFFIXES bin sbin
1470 DOC "MPI compiler for ${LANG}"
1473 if("${MPI_${LANG}_COMPILER}" STREQUAL "${CMAKE_${LANG}_COMPILER}")
1474 set(MPI_PINNED_COMPILER TRUE)
1476 # If we haven't made the implicit compiler test yet, perform it now.
1477 if(NOT MPI_${LANG}_TRIED_IMPLICIT)
1478 _MPI_create_imported_target(${LANG})
1479 _MPI_check_lang_works(${LANG} TRUE)
1482 # Should the MPI compiler not work implicitly for MPI, still interrogate it.
1483 # Otherwise, MPI compilers for which CMake has separate linking stages, e.g. Intel MPI on Windows where link.exe is being used
1484 # directly during linkage instead of CMAKE_<LANG>_COMPILER will not work.
1485 if(NOT MPI_${LANG}_WORKS)
1486 set(MPI_${LANG}_WORKS_IMPLICIT FALSE)
1487 _MPI_interrogate_compiler(${LANG})
1489 set(MPI_${LANG}_WORKS_IMPLICIT TRUE)
1491 elseif(MPI_${LANG}_COMPILER)
1492 _MPI_interrogate_compiler(${LANG})
1496 if(NOT MPI_PINNED_COMPILER AND NOT MPI_${LANG}_WRAPPER_FOUND)
1497 # If MPI_PINNED_COMPILER wasn't given, and the MPI compiler we potentially found didn't work, we withdraw it.
1498 set(MPI_${LANG}_COMPILER "MPI_${LANG}_COMPILER-NOTFOUND" CACHE FILEPATH "MPI compiler for ${LANG}" FORCE)
1499 if(NOT MPI_SKIP_GUESSING)
1500 # For C++, we may use the settings for C. Should a given compiler wrapper for C++ not exist, but one for C does, we copy over the
1501 # settings for C. An MPI distribution that is in this situation would be IBM Platform MPI.
1502 if("${LANG}" STREQUAL "CXX" AND MPI_C_WRAPPER_FOUND)
1503 set(MPI_${LANG}_COMPILE_OPTIONS ${MPI_C_COMPILE_OPTIONS} CACHE STRING "MPI ${LANG} compilation options" )
1504 set(MPI_${LANG}_COMPILE_DEFINITIONS ${MPI_C_COMPILE_DEFINITIONS} CACHE STRING "MPI ${LANG} compilation definitions" )
1505 set(MPI_${LANG}_COMPILER_INCLUDE_DIRS ${MPI_C_INCLUDE_DIRS} CACHE STRING "MPI ${LANG} compiler wrapper include directories")
1506 set(MPI_${LANG}_LINK_FLAGS ${MPI_C_LINK_FLAGS} CACHE STRING "MPI ${LANG} linker flags" )
1507 set(MPI_${LANG}_LIB_NAMES ${MPI_C_LIB_NAMES} CACHE STRING "MPI ${LANG} libraries to link against" )
1509 _MPI_guess_settings(${LANG})
1516 if(NOT "${MPI_${LANG}_COMPILER}" STREQUAL "${CMAKE_${LANG}_COMPILER}")
1517 _MPI_split_include_dirs(${LANG})
1518 _MPI_assemble_include_dirs(${LANG})
1520 set(MPI_${LANG}_INCLUDE_DIRS "")
1522 _MPI_assemble_libraries(${LANG})
1524 _MPI_adjust_compile_definitions(${LANG})
1525 # We always create imported targets even if they're empty
1526 _MPI_create_imported_target(${LANG})
1528 if(NOT MPI_${LANG}_WORKS)
1529 _MPI_check_lang_works(${LANG} FALSE)
1532 # Next, we'll initialize the MPI variables that have not been previously set.
1533 set(MPI_${LANG}_COMPILE_OPTIONS "" CACHE STRING "MPI ${LANG} compilation flags" )
1534 set(MPI_${LANG}_COMPILE_DEFINITIONS "" CACHE STRING "MPI ${LANG} compilation definitions" )
1535 set(MPI_${LANG}_COMPILER_INCLUDE_DIRS "" CACHE STRING "MPI ${LANG} compiler wrapper include directories")
1536 set(MPI_${LANG}_ADDITIONAL_INCLUDE_DIRS "" CACHE STRING "MPI ${LANG} additional include directories")
1537 set(MPI_${LANG}_LINK_FLAGS "" CACHE STRING "MPI ${LANG} linker flags" )
1538 if(NOT MPI_${LANG}_COMPILER STREQUAL CMAKE_${LANG}_COMPILER)
1539 set(MPI_${LANG}_LIB_NAMES "" CACHE STRING "MPI ${LANG} libraries to link against" )
1542 MPI_${LANG}_COMPILE_OPTIONS
1543 MPI_${LANG}_COMPILE_DEFINITIONS
1544 MPI_${LANG}_LINK_FLAGS
1545 MPI_${LANG}_LIB_NAMES
1546 MPI_${LANG}_COMPILER_INCLUDE_DIRS
1547 MPI_${LANG}_ADDITIONAL_INCLUDE_DIRS
1548 MPI_${LANG}_COMPILER
1551 # If we've found MPI, then we'll perform additional analysis: Determine the MPI version, MPI library version, supported
1552 # MPI APIs (i.e. MPI-2 C++ bindings). For Fortran we also need to find specific parameters if we're under MPI-3.
1553 if(MPI_${LANG}_WORKS)
1554 if("${LANG}" STREQUAL "CXX" AND NOT DEFINED MPI_MPICXX_FOUND)
1555 if(NOT MPI_CXX_SKIP_MPICXX AND NOT MPI_CXX_VALIDATE_SKIP_MPICXX)
1556 _MPI_try_staged_settings(${LANG} test_mpi MPICXX FALSE FALSE)
1557 if(MPI_RESULT_${LANG}_test_mpi_MPICXX)
1558 set(MPI_MPICXX_FOUND TRUE)
1560 set(MPI_MPICXX_FOUND FALSE)
1563 set(MPI_MPICXX_FOUND FALSE)
1567 # At this point, we know the bindings present but not the MPI version or anything else.
1568 if(NOT DEFINED MPI_${LANG}_VERSION)
1569 unset(MPI_${LANG}_VERSION_MAJOR)
1570 unset(MPI_${LANG}_VERSION_MINOR)
1572 set(MPI_BIN_FOLDER ${CMAKE_BINARY_DIR}${CMAKE_FILES_DIRECTORY}/FindMPI)
1574 # For Fortran, we'll want to use the most modern MPI binding to test capabilities other than the
1575 # Fortran parameters, since those depend on the method of consumption.
1576 # For C++, we can always use the C bindings, and should do so, since the C++ bindings do not exist in MPI-3
1577 # whereas the C bindings do, and the C++ bindings never offered any feature advantage over their C counterparts.
1578 if("${LANG}" STREQUAL "Fortran")
1579 if(MPI_${LANG}_HAVE_F08_MODULE)
1580 set(MPI_${LANG}_HIGHEST_METHOD F08_MODULE)
1581 elseif(MPI_${LANG}_HAVE_F90_MODULE)
1582 set(MPI_${LANG}_HIGHEST_METHOD F90_MODULE)
1584 set(MPI_${LANG}_HIGHEST_METHOD F77_HEADER)
1587 # Another difference between C and Fortran is that we can't use the preprocessor to determine whether MPI_VERSION
1588 # and MPI_SUBVERSION are provided. These defines did not exist in MPI 1.0 and 1.1 and therefore might not
1589 # exist. For C/C++, test_mpi.c will handle the MPI_VERSION extraction, but for Fortran, we need mpiver.f90.
1590 if(NOT DEFINED MPI_${LANG}_VERSION)
1591 _MPI_try_staged_settings(${LANG} mpiver ${MPI_${LANG}_HIGHEST_METHOD} FALSE FALSE)
1592 if(MPI_RESULT_${LANG}_mpiver_${MPI_${LANG}_HIGHEST_METHOD})
1593 file(STRINGS ${MPI_BIN_FOLDER}/mpiver_${LANG}.bin _MPI_VERSION_STRING LIMIT_COUNT 1 REGEX "INFO:MPI-VER")
1594 if("${_MPI_VERSION_STRING}" MATCHES ".*INFO:MPI-VER\\[([0-9]+)\\.([0-9]+)\\].*")
1595 set(MPI_${LANG}_VERSION_MAJOR "${CMAKE_MATCH_1}")
1596 set(MPI_${LANG}_VERSION_MINOR "${CMAKE_MATCH_2}")
1597 set(MPI_${LANG}_VERSION "${MPI_${LANG}_VERSION_MAJOR}.${MPI_${LANG}_VERSION_MINOR}")
1602 # Finally, we want to find out which capabilities a given interface supports, compare the MPI-3 standard.
1603 # This is determined by interface specific parameters MPI_SUBARRAYS_SUPPORTED and MPI_ASYNC_PROTECTS_NONBLOCKING
1604 # and might vary between the different methods of consumption.
1605 if(MPI_DETERMINE_Fortran_CAPABILITIES AND NOT MPI_Fortran_CAPABILITIES_DETERMINED)
1606 foreach(mpimethod IN ITEMS F08_MODULE F90_MODULE F77_HEADER)
1607 if(MPI_${LANG}_HAVE_${mpimethod})
1608 set(MPI_${LANG}_${mpimethod}_SUBARRAYS FALSE)
1609 set(MPI_${LANG}_${mpimethod}_ASYNCPROT FALSE)
1610 _MPI_try_staged_settings(${LANG} fortranparam_mpi ${mpimethod} TRUE FALSE)
1611 if(MPI_RESULT_${LANG}_fortranparam_mpi_${mpimethod} AND
1612 NOT "${MPI_RUN_RESULT_${LANG}_fortranparam_mpi_${mpimethod}}" STREQUAL "FAILED_TO_RUN")
1613 if("${MPI_RUN_OUTPUT_${LANG}_fortranparam_mpi_${mpimethod}}" MATCHES
1614 ".*INFO:SUBARRAYS\\[ *([TF]) *\\]-ASYNCPROT\\[ *([TF]) *\\].*")
1615 if("${CMAKE_MATCH_1}" STREQUAL "T")
1616 set(MPI_${LANG}_${mpimethod}_SUBARRAYS TRUE)
1618 if("${CMAKE_MATCH_2}" STREQUAL "T")
1619 set(MPI_${LANG}_${mpimethod}_ASYNCPROT TRUE)
1625 set(MPI_Fortran_CAPABILITIES_DETERMINED TRUE)
1628 set(MPI_${LANG}_HIGHEST_METHOD normal)
1630 # By the MPI-2 standard, MPI_VERSION and MPI_SUBVERSION are valid for both C and C++ bindings.
1631 if(NOT DEFINED MPI_${LANG}_VERSION)
1632 file(STRINGS ${MPI_BIN_FOLDER}/test_mpi_${LANG}.bin _MPI_VERSION_STRING LIMIT_COUNT 1 REGEX "INFO:MPI-VER")
1633 if("${_MPI_VERSION_STRING}" MATCHES ".*INFO:MPI-VER\\[([0-9]+)\\.([0-9]+)\\].*")
1634 set(MPI_${LANG}_VERSION_MAJOR "${CMAKE_MATCH_1}")
1635 set(MPI_${LANG}_VERSION_MINOR "${CMAKE_MATCH_2}")
1636 set(MPI_${LANG}_VERSION "${MPI_${LANG}_VERSION_MAJOR}.${MPI_${LANG}_VERSION_MINOR}")
1641 unset(MPI_BIN_FOLDER)
1643 # At this point, we have dealt with determining the MPI version and parameters for each Fortran method available.
1644 # The one remaining issue is to determine which MPI library is installed.
1645 # Determining the version and vendor of the MPI library is only possible via MPI_Get_library_version() at runtime,
1646 # and therefore we cannot do this while cross-compiling (a user may still define MPI_<lang>_LIBRARY_VERSION_STRING
1647 # themselves and we'll attempt splitting it, which is equivalent to provide the try_run output).
1648 # It's also worth noting that the installed version string can depend on the language, or on the system the binary
1649 # runs on if MPI is not statically linked.
1650 if(MPI_DETERMINE_LIBRARY_VERSION AND NOT MPI_${LANG}_LIBRARY_VERSION_STRING)
1651 _MPI_try_staged_settings(${LANG} libver_mpi ${MPI_${LANG}_HIGHEST_METHOD} TRUE FALSE)
1652 if(MPI_RESULT_${LANG}_libver_mpi_${MPI_${LANG}_HIGHEST_METHOD} AND
1653 "${MPI_RUN_RESULT_${LANG}_libver_mpi_${MPI_${LANG}_HIGHEST_METHOD}}" EQUAL "0")
1654 string(STRIP "${MPI_RUN_OUTPUT_${LANG}_libver_mpi_${MPI_${LANG}_HIGHEST_METHOD}}"
1655 MPI_${LANG}_LIBRARY_VERSION_STRING)
1657 set(MPI_${LANG}_LIBRARY_VERSION_STRING "NOTFOUND")
1662 set(MPI_${LANG}_FIND_QUIETLY ${MPI_FIND_QUIETLY})
1663 set(MPI_${LANG}_FIND_VERSION ${MPI_FIND_VERSION})
1664 set(MPI_${LANG}_FIND_VERSION_EXACT ${MPI_FIND_VERSION_EXACT})
1666 unset(MPI_${LANG}_REQUIRED_VARS)
1667 if (NOT "${MPI_${LANG}_COMPILER}" STREQUAL "${CMAKE_${LANG}_COMPILER}")
1668 foreach(mpilibname IN LISTS MPI_${LANG}_LIB_NAMES)
1669 list(APPEND MPI_${LANG}_REQUIRED_VARS "MPI_${mpilibname}_LIBRARY")
1671 list(APPEND MPI_${LANG}_REQUIRED_VARS "MPI_${LANG}_LIB_NAMES")
1672 if("${LANG}" STREQUAL "Fortran")
1673 # For Fortran we only need one of the module or header directories to have *some* support for MPI.
1674 if(NOT MPI_${LANG}_MODULE_DIR)
1675 list(APPEND MPI_${LANG}_REQUIRED_VARS "MPI_${LANG}_F77_HEADER_DIR")
1677 if(NOT MPI_${LANG}_F77_HEADER_DIR)
1678 list(APPEND MPI_${LANG}_REQUIRED_VARS "MPI_${LANG}_MODULE_DIR")
1681 list(APPEND MPI_${LANG}_REQUIRED_VARS "MPI_${LANG}_HEADER_DIR")
1683 if(MPI_${LANG}_ADDITIONAL_INCLUDE_VARS)
1684 foreach(mpiincvar IN LISTS MPI_${LANG}_ADDITIONAL_INCLUDE_VARS)
1685 list(APPEND MPI_${LANG}_REQUIRED_VARS "MPI_${mpiincvar}_INCLUDE_DIR")
1688 # Append the works variable now. If the settings did not work, this will show up properly.
1689 list(APPEND MPI_${LANG}_REQUIRED_VARS "MPI_${LANG}_WORKS")
1691 # If the compiler worked implicitly, use its path as output.
1692 # Should the compiler variable be set, we also require it to work.
1693 list(APPEND MPI_${LANG}_REQUIRED_VARS "MPI_${LANG}_COMPILER")
1694 if(MPI_${LANG}_COMPILER)
1695 list(APPEND MPI_${LANG}_REQUIRED_VARS "MPI_${LANG}_WORKS")
1698 find_package_handle_standard_args(MPI_${LANG} NAME_MISMATCHED
1699 REQUIRED_VARS ${MPI_${LANG}_REQUIRED_VARS}
1700 VERSION_VAR MPI_${LANG}_VERSION)
1702 if(DEFINED MPI_${LANG}_VERSION)
1703 if(NOT _MPI_MIN_VERSION OR _MPI_MIN_VERSION VERSION_GREATER MPI_${LANG}_VERSION)
1704 set(_MPI_MIN_VERSION MPI_${LANG}_VERSION)
1710 unset(_MPI_REQ_VARS)
1711 foreach(LANG IN ITEMS C CXX Fortran)
1712 if((NOT MPI_FIND_COMPONENTS AND CMAKE_${LANG}_COMPILER_LOADED) OR LANG IN_LIST MPI_FIND_COMPONENTS)
1713 list(APPEND _MPI_REQ_VARS "MPI_${LANG}_FOUND")
1717 if(MPICXX IN_LIST MPI_FIND_COMPONENTS)
1718 list(APPEND _MPI_REQ_VARS "MPI_MPICXX_FOUND")
1721 find_package_handle_standard_args(MPI
1722 REQUIRED_VARS ${_MPI_REQ_VARS}
1723 VERSION_VAR ${_MPI_MIN_VERSION}
1724 REASON_FAILURE_MESSAGE "${_MPI_FAIL_REASON}"
1727 #=============================================================================
1728 # More backward compatibility stuff
1730 # For compatibility reasons, we also define MPIEXEC
1731 set(MPIEXEC "${MPIEXEC_EXECUTABLE}")
1733 # Copy over MPI_<LANG>_INCLUDE_PATH from the assembled INCLUDE_DIRS.
1734 foreach(LANG IN ITEMS C CXX Fortran)
1735 if(MPI_${LANG}_FOUND)
1736 set(MPI_${LANG}_INCLUDE_PATH "${MPI_${LANG}_INCLUDE_DIRS}")
1737 unset(MPI_${LANG}_COMPILE_FLAGS)
1738 if(MPI_${LANG}_COMPILE_OPTIONS)
1739 list(JOIN MPI_${LANG}_COMPILE_OPTIONS " " MPI_${LANG}_COMPILE_FLAGS)
1741 if(MPI_${LANG}_COMPILE_DEFINITIONS)
1742 foreach(_MPI_DEF IN LISTS MPI_${LANG}_COMPILE_DEFINITIONS)
1743 string(APPEND MPI_${LANG}_COMPILE_FLAGS " -D${_MPI_DEF}")
1749 # Bare MPI sans ${LANG} vars are set to CXX then C, depending on what was found.
1750 # This mimics the behavior of the old language-oblivious FindMPI.
1751 set(_MPI_OLD_VARS COMPILER INCLUDE_PATH COMPILE_FLAGS LINK_FLAGS LIBRARIES)
1753 foreach (var ${_MPI_OLD_VARS})
1754 set(MPI_${var} ${MPI_CXX_${var}})
1756 elseif (MPI_C_FOUND)
1757 foreach (var ${_MPI_OLD_VARS})
1758 set(MPI_${var} ${MPI_C_${var}})
1762 # Chop MPI_LIBRARIES into the old-style MPI_LIBRARY and MPI_EXTRA_LIBRARY, and set them in cache.
1764 list(GET MPI_LIBRARIES 0 MPI_LIBRARY_WORK)
1765 set(MPI_LIBRARY "${MPI_LIBRARY_WORK}")
1766 unset(MPI_LIBRARY_WORK)
1768 set(MPI_LIBRARY "MPI_LIBRARY-NOTFOUND")
1771 list(LENGTH MPI_LIBRARIES MPI_NUMLIBS)
1772 if (MPI_NUMLIBS GREATER 1)
1773 set(MPI_EXTRA_LIBRARY_WORK "${MPI_LIBRARIES}")
1774 list(REMOVE_AT MPI_EXTRA_LIBRARY_WORK 0)
1775 set(MPI_EXTRA_LIBRARY "${MPI_EXTRA_LIBRARY_WORK}")
1776 unset(MPI_EXTRA_LIBRARY_WORK)
1778 set(MPI_EXTRA_LIBRARY "MPI_EXTRA_LIBRARY-NOTFOUND")
1780 set(MPI_IGNORE_LEGACY_VARIABLES TRUE)
1781 #=============================================================================
1783 # unset these vars to cleanup namespace
1784 unset(_MPI_OLD_VARS)
1785 unset(_MPI_PREFIX_PATH)
1786 unset(_MPI_BASE_DIR)
1787 foreach (lang C CXX Fortran)
1788 unset(_MPI_${LANG}_COMPILER_NAMES)