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.

Кроме того, определены следующие IMPORTED целевые объекты:

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

Для управления вторым этапом могут быть установлены следующие переменные:

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 может вызвать дополнительные проблемы, например, уведомление о брандмауэре на некоторых системах. Вы должны включить эти проверки только в том случае, если вам абсолютно необходима эта информация.

Если следующие переменные установлены в значение «истина», будет выполнено соответствующее исследование:

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