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 вместо этого.