Intel® MPI Library Developer Reference for Linux* OS

Download PDF
ID 768732
Date 11/07/2023
Public

A newer version of this document is available. Customers should click here to go to the newest version.

Document Table of Contents
Document Table of Contents x
Intel® MPI Library Developer Reference for Linux* OS
Intel® MPI Library Developer Reference for Linux* OS x
Introduction Command Reference Environment Variable Reference Miscellaneous Notices and Disclaimers
Introduction x
Introducing Intel® MPI Library What's New Intel® MPI Library 2021.11 (Intel® oneAPI 2024.0) Intel® MPI Library 2021.10 (Intel® oneAPI 2023.2) Intel® MPI Library 2021.9 (Intel® oneAPI 2023.1) Intel® MPI Library 2021.8 (Intel® oneAPI 2023.0) Intel® MPI Library 2021.7.1 (Intel® oneAPI 2022.4) Intel® MPI Library 2021.7 (Intel® oneAPI 2022.3) Intel® MPI Library 2021.6 (Intel® oneAPI 2022.2) Intel® oneAPI 2021.5 Intel® oneAPI 2021.2 Intel® oneAPI Gold Notational Conventions Related Information
Command Reference x
Compiler Commands mpirun mpiexec.hydra cpuinfo impi_info mpitune_fast
Compiler Commands x
Compilation Command Options
mpiexec.hydra x
Global Hydra Options Local Hydra Options gtool Options
Environment Variable Reference x
Compilation Environment Variables Hydra Environment Variables I_MPI_ADJUST Family Environment Variables Tuning Environment Variables Process Pinning GPU Support Environment Variables for Fabrics Control Environment Variables for Memory Policy Control Environment Variables for Asynchronous Progress Control Environment Variables for Multi-EP Other Environment Variables
Tuning Environment Variables x
Autotuning
Autotuning x
I_MPI_TUNING_AUTO Family Environment Variables
Process Pinning x
Environment Variables for Process Pinning Interoperability with OpenMP* API
GPU Support x
GPU Pinning GPU Buffers Support
Environment Variables for Fabrics Control x
Communication Fabrics Control Shared Memory Control OFI*-capable Network Fabrics Control
Miscellaneous x
Java* Bindings for MPI-2 Routines
Intel® MPI Library Developer Reference for Linux* OS

What's New

This page lists some important changes to the product that are reflected in the documentation. For a list of all changes, refer to the Intel® MPI Library Release Notes or Intel® MPI Library Release Notes for Linux* OS .

Intel® MPI Library 2021.11 (Intel® oneAPI 2024.0)

  • Added new environment variables to GPU Buffers Support page: I_MPI_OFFLOAD_COLL_PIPELINE, I_MPI_OFFLOAD_COLL_PIPELINE_ALLREDUCE_SEGMENTS_SIZE, and I_MPI_OFFLOAD_ONESIDED_DEVICE_INITIATED.
  • Added new environment variable to GPU Support page targeting CUDA* support: I_MPI_OFFLOAD_CUDA_LIBRARY and I_MPI_OFFLOAD_MODE.
  • Added new environment variable to GPU Pinning page: I_MPI_OFFLOAD_PRINT_TOPOLOGY.
  • Added new environment variables to Other Environment Variables page: I_MPI_FILESYSTEM, I_MPI_FILESYSTEM_FORCE, I_MPI_FILESYSTEM_CB_NODES, I_MPI_FILESYSTEM_CB_CONFIG_LIST, I_MPI_FILESYSTEM_NFS_DIRECT, and I_MPI_FILESYSTEM_GPFS_DIRECT.
  • Deprecated environment variables: I_MPI_EXTRA_FILESYSTEM and I_MPI_EXTRA_FILESYSTEM_FORCE.
  • Deprecated environment variable: I_MPI_EXTRA_FILESYSTEM_NFS_DIRECT.

Intel® MPI Library 2021.10 (Intel® oneAPI 2023.2)

  • Added new environment variable _MPI_OFI_MATCH_COMPLETE to the OFI*-capable Network Fabrics Control page.
  • Added the compiler-specific MPI wrappers: mpiicpx and mpiicx to the Compiler Commands page.
  • Added new environment variable I_MPI_OFFLOAD_PIN to the GPU Pinning page.
  • Added the I_MPI_OFI_NIC_LIST CVAR to the Other Environment Variables page.
  • Added new Cray's PALS PMIx feature to the Job Schedulers Support.

Additionally, minor updates have been made to fix inaccuracies in the document and improve user experience.

Intel® MPI Library 2021.9 (Intel® oneAPI 2023.1)

  • Added new environment variable I_MPI_EXTRA_FILESYSTEM_NFS_DIRECT to Other Environment Variables page.
  • Added the following CVARs:I_MPI_OFFLOAD_COPY_COLL_MAX_SIZE, I_MPI_OFFLOAD_FAST_MEMCPY_COLL, I_MPI_OFFLOAD_FAST_MEMCPY_COLL_MAX_SIZE to GPU Buffers Support page.

Intel® MPI Library 2021.8 (Intel® oneAPI 2023.0)

  • Added I_MPI_SPAWN function.
  • Added the following CVARs: I_MPI_OFFLOAD_SYMMETRIC, I_MPI_OFFLOAD_RDMA, I_MPI_OFFLOAD_FAST_MEMCPY, I_MPI_OFFLOAD_IPC.
  • Changed default value of I_MPI_OFFLOAD_PIPELINE_THRESHOLD variable.

Intel® MPI Library 2021.7.1 (Intel® oneAPI 2022.4)

  • No documentation changes.

Intel® MPI Library 2021.7 (Intel® oneAPI 2022.3)

  • No documentation changes.

Intel® MPI Library 2021.6 (Intel® oneAPI 2022.2)

  • I_MPI_OFFLOAD enables all GPU features including Intel MPI GPU pinning
  • Multi-rail support: I_MPI_MULTIRAIL enables multi-rail capability and is used to identify NICs serviced by the provider and to pick one on the same NUMA.

Intel® oneAPI 2021.5

  • Converged release and release_mt libraries. All features previously available in release_mt only are available in release library.
  • Added hcoll argument for I_MPI_COLL_EXTERNAL.
  • Added -prepend-timestamp option to Global Options topic.
  • Added I_MPI_COLL_DIRECT variable to I_MPI_ADJUST Family Environment Variables topic.
  • Changed the I_MPI_STARTUP_MODE default value to pmi_shm_netmod.
  • Changed the default pinning order to bunch.
  • Added new value for the I_MPI_SHM variable (icx).

Intel® oneAPI 2021.2

Additionally, minor updates have been made to fix inaccuracies in the document and improve user experience.

  • No documentation changes.

Intel® oneAPI Gold

  • Removed all content specific to Intel® Parallel Studio XE (see notice on title page).
  • Added Intel® Ethernet 800 Series support.
  • Added MPI + OpenMP offload examples.
  • Added new algorithm for MPI_Sendrecv_replace (I_MPI_ADJUST_SENDRECV_REPLACE=2).
  • Added I_MPI OFFLOAD variable to GPU Support topic.
  • Reworked directory layout:
    • Removed intel64/.
    • Mpivars.[c]sh and mpi modulefile moved to env/.
    • Mpivars.[c]sh renamed to vars.[c]sh.
  • Removed deprecated symbolic links.
  • Removed static libraries for debug configurations.
Parent topic: Introduction
Level Two Title