FindMPI¶
查找消息传递接口(MPI)实现。
消息传递接口(MPI)是一个用于编写高性能分布式内存并行应用程序的库,通常部署在集群上。MPI 是一个标准接口(由 MPI 论坛定义),有许多可用的实现。
3.10 版本新增:模块的大幅改进:许多新变量,按语言划分的组件,支持更广泛的运行时。
使用 MPI 的变量¶
该模块公开了组件 C
、CXX
、MPICXX
和 Fortran
。每个组件都控制要搜索的各种 MPI 语言。CXX
和 MPICXX
的区别在于,CXX
指的是 MPI C API 可在 C++ 中使用,而 MPICXX
指的是在 MPI-3 中再次删除的 MPI-2 C++ API。
根据启用的组件,将设置以下变量
MPI_FOUND
变量,指示已找到所有请求语言的 MPI 设置。如果未指定组件,则如果检测到所有已启用语言的 MPI 设置,则此变量为 true。请注意,
MPICXX
组件不影响此变量。MPI_VERSION
在请求的语言中检测到的 MPI 的最低版本,如果未指定组件,则为所有已启用语言中的最低版本。
此模块将在您的项目中为每种语言设置以下变量,其中 <lang>
是 C、CXX 或 Fortran 之一
MPI_<lang>_FOUND
变量,指示已找到
<lang>
的 MPI 设置,并且简单的 MPI 测试程序可以使用提供的设置进行编译。MPI_<lang>_COMPILER
如果存在,则为
<lang>
的 MPI 编译器。MPI_<lang>_COMPILE_OPTIONS
作为 分号列表 给出,用于
<lang>
中 MPI 程序的编译选项。MPI_<lang>_COMPILE_DEFINITIONS
作为 分号列表 给出,用于
<lang>
中 MPI 程序的编译定义。MPI_<lang>_INCLUDE_DIRS
MPI 头文件的包含路径。
MPI_<lang>_LINK_FLAGS
MPI 程序的链接器标志。
MPI_<lang>_LIBRARIES
链接 MPI 程序所需的所有库。
3.9 版本新增:此外,还定义了以下 IMPORTED
目标
MPI::MPI_<lang>
用于从
<lang>
使用 MPI 的目标。
将定义以下指示存在哪些绑定的变量
MPI_MPICXX_FOUND
变量,指示是否存在 MPI-2 C++ 绑定(在 MPI-2 中引入,在 MPI-3 中移除)。
MPI_Fortran_HAVE_F77_HEADER
如果 Fortran 77 头文件
mpif.h
可用,则为 True。MPI_Fortran_HAVE_F90_MODULE
如果 Fortran 90 模块
mpi
可用于访问 MPI,则为 True(仅适用于 MPI-2 及更高版本)。MPI_Fortran_HAVE_F08_MODULE
如果 Fortran 2008
mpi_f08
可用于 MPI 程序,则为 True(仅适用于 MPI-3 及更高版本)。
如果可能,MPI 版本将由该模块确定。检测 MPI 版本的工具是在 MPI-1.2 中引入的,因此无法在较旧的 MPI 版本中找到。
MPI_<lang>_VERSION_MAJOR
MPI 分发为
<lang>
实现的 MPI 主版本。MPI_<lang>_VERSION_MINOR
MPI 分发为
<lang>
实现的 MPI 次版本。MPI_<lang>_VERSION
MPI 分发为
<lang>
实现的 MPI 版本。
请注意,没有通过 mpi.h
访问 C 绑定的变量,因为 MPI 标准始终要求此绑定在 C 和 C++ 代码中都有效。
对于运行 MPI 程序,该模块设置以下变量
MPIEXEC_EXECUTABLE
用于运行 MPI 程序的可执行文件,如果存在。
MPIEXEC_NUMPROC_FLAG
在给出要运行的处理器数量之前,传递给
mpiexec
的标志。MPIEXEC_MAX_NUMPROCS
要利用的 MPI 处理器数量。默认为主机系统上检测到的处理器数量。
MPIEXEC_PREFLAGS
在要运行的可执行文件之前,直接传递给
mpiexec
的标志。MPIEXEC_POSTFLAGS
在其他标志之后,传递给
mpiexec
的标志。
定位 MPI 的变量¶
此模块执行四步搜索 MPI 实现
搜索
MPIEXEC_EXECUTABLE
,如果找到,则使用其基本目录。检查编译器是否内置 MPI 支持。如果用户将编译器包装器作为
CMAKE_<LANG>_COMPILER
传递,或者他们使用 Cray 系统编译器包装器,则属于这种情况。尝试查找 MPI 编译器包装器并从中确定编译器信息。
尝试通过猜测设置来查找不附带此类包装器的 MPI 实现。目前,仅支持 Windows 上的 Microsoft MPI 和 MPICH2。
为了控制 MPIEXEC_EXECUTABLE
步骤,可以设置以下变量
MPIEXEC_EXECUTABLE
手动指定
mpiexec
的位置。MPI_HOME
指定 MPI 安装的基本目录。
ENV{MPI_HOME}
指定 MPI 安装基本目录的环境变量。
ENV{I_MPI_ROOT}
指定 MPI 安装基本目录的环境变量。
为了控制编译器包装步骤,可以设置以下变量
MPI_<lang>_COMPILER
搜索指定的编译器包装器并使用它。
MPI_<lang>_COMPILER_FLAGS
在查询期间传递给 MPI 编译器包装器的标志。某些编译器包装器支持在传递特定标志时链接调试或跟踪库,此变量可用于获取它们。
MPI_COMPILER_FLAGS
如果未给出语言特定标志,则用于初始化
MPI_<lang>_COMPILER_FLAGS
。默认情况下为空。MPI_EXECUTABLE_SUFFIX
一个附加到所有正在查找的名称的后缀。例如,您可以将其设置为
.mpich
或.openmpi
,以便在 Debian 及其衍生产品上优先选择其中一个。
为了控制猜测步骤,可以设置以下变量
MPI_GUESS_LIBRARY_NAME
有效值为
MSMPI
和MPICH2
。如果设置,则仅搜索给定的库。默认情况下,如果两者都可用,MSMPI
将优先于MPICH2
。这也会将MPI_SKIP_COMPILER_WRAPPER
设置为true
,这可能会被覆盖。
每个搜索步骤都可以通过以下控制变量跳过
MPI_ASSUME_NO_BUILTIN_MPI
如果为 true,则模块假定编译器本身不提供 MPI 实现,并跳到步骤 2。
MPI_SKIP_COMPILER_WRAPPER
如果为 true,则不会搜索编译器包装器。
MPI_SKIP_GUESSING
如果为 true,则跳过猜测步骤。
此外,以下控制变量可用于更改搜索行为
MPI_CXX_SKIP_MPICXX
添加一些定义,这些定义将禁用 MPI-2 C++ 绑定。目前支持 MPICH、Open MPI、Platform MPI 及其衍生产品,例如 MVAPICH 或 Intel MPI。
如果变量 MPI_<lang>_WORKS
的查找过程失败,则模块检测到或传递给模块的设置不起作用,甚至简单的 MPI 测试程序也无法编译。
如果所有这些参数不足以找到正确的 MPI 实现,用户可以通过在 MPI_<lang>_LIBRARIES
中指定库列表并在 MPI_<lang>_ADDITIONAL_INCLUDE_DIRS
中指定包含目录列表来禁用整个自动检测过程。除此之外,还可以设置任何其他变量。然后模块将验证 MPI 设置并将设置存储在缓存中。
MPI 的缓存变量¶
变量 MPI_<lang>_INCLUDE_DIRS
将由以下变量组合而成。对于 C 和 CXX
MPI_<lang>_HEADER_DIR
mpi.h
头文件在磁盘上的位置。
对于 Fortran
MPI_Fortran_F77_HEADER_DIR
Fortran 77 头文件
mpif.h
的位置,如果存在。MPI_Fortran_MODULE_DIR
模块
mpi
或mpi_f08
的位置,如果可用。
对于所有语言,还考虑以下变量
MPI_<lang>_ADDITIONAL_INCLUDE_DIRS
一个 分号列表 的路径,除了正常包含目录之外还需要这些路径。
MPI_<include_name>_INCLUDE_DIR
由
<include_name>
引用的包含文件夹的路径变量。MPI_<lang>_ADDITIONAL_INCLUDE_VARS
一个 分号列表 的
<include_name>
,将添加到<lang>
的包含位置。
变量 MPI_<lang>_LIBRARIES
将由以下变量组合而成
MPI_<lib_name>_LIBRARY
名为
<lib_name>
的库的位置,用于 MPI。MPI_<lang>_LIB_NAMES
一个 分号列表 的
<lib_name>
,将添加到<lang>
的包含位置。
mpiexec 的用法¶
当使用 MPIEXEC_EXECUTABLE
执行 MPI 应用程序时,您通常应该按以下方式使用所有 MPIEXEC_EXECUTABLE
标志
${MPIEXEC_EXECUTABLE} ${MPIEXEC_NUMPROC_FLAG} ${MPIEXEC_MAX_NUMPROCS}
${MPIEXEC_PREFLAGS} EXECUTABLE ${MPIEXEC_POSTFLAGS} ARGS
其中 EXECUTABLE
是 MPI 程序,ARGS
是要传递给 MPI 程序的参数。
使用 MPI 的高级变量¶
该模块可以根据明确的请求执行一些高级功能检测。
重要提示: 在不执行 MPI 测试程序的情况下,无法执行以下检查。考虑交叉编译期间 try_run()
行为的特殊注意事项。此外,运行 MPI 程序可能会导致额外的问题,例如某些系统上的防火墙通知。您只应在绝对需要此信息时启用这些检测。
如果以下变量设置为 true,则将执行相应的搜索
MPI_DETERMINE_Fortran_CAPABILITIES
确定所有可用的 Fortran 绑定的
MPI_SUBARRAYS_SUPPORTED
和MPI_ASYNC_PROTECTS_NONBLOCKING
的值,并将其值作为MPI_Fortran_<binding>_SUBARRAYS
和MPI_Fortran_<binding>_ASYNCPROT
提供,其中<binding>
是F77_HEADER
、F90_MODULE
和F08_MODULE
之一。MPI_DETERMINE_LIBRARY_VERSION
对于每种语言,查找
MPI_Get_library_version
的输出,并将其作为MPI_<lang>_LIBRARY_VERSION_STRING
提供。此信息通常与 MPI 实现的运行时组件相关联,并且可能因<lang>
而异。请注意,返回值完全由实现定义。此信息可用于识别 MPI 供应商,例如选择与 MPI 供应商匹配的多个第三方二进制文件中的正确一个。
向后兼容性¶
自 3.10 版本起已弃用。
为了向后兼容旧版本的 FindMPI,设置了这些变量
MPI_COMPILER MPI_LIBRARY MPI_EXTRA_LIBRARY
MPI_COMPILE_FLAGS MPI_INCLUDE_PATH MPI_LINK_FLAGS
MPI_LIBRARIES
在新项目中,请使用 MPI_<lang>_XXX
等效项。此外,以下变量已弃用
MPI_<lang>_COMPILE_FLAGS
请改用
MPI_<lang>_COMPILE_OPTIONS
和MPI_<lang>_COMPILE_DEFINITIONS
。MPI_<lang>_INCLUDE_PATH
对于消费使用
MPI_<lang>_INCLUDE_DIRS
,对于指定文件夹请改用MPI_<lang>_ADDITIONAL_INCLUDE_DIRS
。MPIEXEC
请改用
MPIEXEC_EXECUTABLE
。