FindMPI

Найдите реализацию Message Passing Interface (MPI).

Message Passing Interface (MPI) — это библиотека, используемая для написания высокопроизводительных распределённых параллельных приложений, обычно развертываемых на кластере. MPI — это стандартный интерфейс (определённый форумом MPI), для которого доступно множество реализаций.

Переменные для использования MPI

Модуль предоставляет компоненты C, CXX, MPICXX и Fortran. Каждый из них управляет различными языками MPI для поиска. Разница между CXX и MPICXX заключается в том, что CXX относится к API MPI C, доступному из C++, тогда как MPICXX относится к API MPI-2 C++, который был удалён в MPI-3.

В зависимости от включённых компонентов будут установлены следующие переменные:

MPI_FOUND

Переменная, указывающая, что настройки MPI для всех запрошенных языков были найдены. Если компоненты не указаны, это верно, если настройки MPI для всех включенных языков были обнаружены. Обратите внимание, что компонент MPICXX не влияет на эту переменную.

MPI_VERSION

Минимальная версия MPI, обнаруженная среди запрошенных языков, или всех включённых языков, если компоненты не были указаны.

Этот модуль установит следующие переменные для каждого языка в вашем проекте, где <lang> — это один из C, CXX или Fortran:

MPI_<lang>_FOUND

Переменная, указывающая, что настройки MPI для <lang> были найдены и что простые тестовые программы MPI компилируются с заданными настройками.

MPI_<lang>_COMPILER

Компилятор MPI для <lang>, если такая программа существует.

MPI_<lang>_COMPILE_OPTIONS

Параметры компиляции для программ MPI в <lang>, заданные как список.

MPI_<lang>_COMPILE_DEFINITIONS

Определения компиляции для программ MPI в <lang>, заданные как список.

MPI_<lang>_INCLUDE_DIRS

Путь(и) включения для заголовка MPI.

MPI_<lang>_LINK_FLAGS

Флаги компоновщика для программ MPI.

MPI_<lang>_LIBRARIES

Все библиотеки для компоновки программ MPI.

MPI::MPI_<lang>

Целевой объект для использования MPI из <lang>.

Будут определены следующие переменные, указывающие, какие связи присутствуют:

MPI_MPICXX_FOUND

Переменная, указывающая, присутствуют ли связи MPI-2 C++ (введены в MPI-2, удалены в MPI-3).

MPI_Fortran_HAVE_F77_HEADER

Истина, если заголовок Fortran 77 mpif.h доступен.

MPI_Fortran_HAVE_F90_MODULE

Истина, если модуль Fortran 90 mpi может использоваться для доступа к MPI (только MPI-2 и выше).

MPI_Fortran_HAVE_F08_MODULE

Истина, если Fortran 2008 mpi_f08 доступен для программ MPI (только 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.

Обратите внимание, что переменной для доступности связей C через mpi.h нет, поскольку стандарты MPI всегда требовали, чтобы эти связи работали как в коде C, так и в коде C++.

Для запуска программ MPI модуль устанавливает следующие переменные

MPIEXEC_EXECUTABLE

Исполняемый файл для запуска программ MPI, если таковой существует.

MPIEXEC_NUMPROC_FLAG

Флаг, передаваемый mpiexec перед передачей ему количества процессоров для выполнения.

MPIEXEC_MAX_NUMPROCS

Количество процессоров MPI для использования. По умолчанию равно количеству процессоров, обнаруженных на хост-системе.

MPIEXEC_PREFLAGS

Флаги, передаваемые mpiexec непосредственно перед исполняемым файлом для выполнения.

MPIEXEC_POSTFLAGS

Флаги, передаваемые mpiexec после других флагов.

Переменные для поиска MPI

Этот модуль выполняет поиск реализации MPI в четыре этапа:

1. Поиск MPIEXEC_EXECUTABLE и, если найден, использование его базового каталога.
2. Проверка наличия поддержки MPI в компиляторе. Это происходит, если пользователь передал обёртку компилятора как CMAKE_<LANG>_COMPILER или использует оболочки компилятора Cray.
3. Попытка найти обёртку компилятора MPI и определение информации о компиляторе из неё.
4. Попытка найти реализацию MPI, которая не поставляется с такой обёрткой, путем угадывания настроек. В настоящее время поддерживаются только Microsoft MPI и MPICH2 в Windows.

Для управления этапом 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

Если истинно, модуль предполагает, что сам компилятор не предоставляет реализацию MPI, и переходит к шагу 2.

MPI_SKIP_COMPILER_WRAPPER

Если истинно, оболочка компилятора не будет искаться.

MPI_SKIP_GUESSING

Если истинно, этап угадывания будет пропущен.

Кроме того, доступна следующая управляющая переменная для изменения поведения поиска:

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.

Обратная совместимость

Для обеспечения обратной совместимости со старыми версиями 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 вместо них.