17.2.198. MPI_Iallgather

MPI_Allgather, MPI_Iallgather, MPI_Allgather_init - 从所有进程收集数据并将其分发到所有进程

17.2.198.1. 语法

17.2.198.1.1. C语法

#include <mpi.h>

int MPI_Allgather(const void *sendbuf, int  sendcount,
      MPI_Datatype sendtype, void *recvbuf, int recvcount,
      MPI_Datatype recvtype, MPI_Comm comm)

int MPI_Iallgather(const void *sendbuf, int  sendcount,
      MPI_Datatype sendtype, void *recvbuf, int recvcount,
      MPI_Datatype recvtype, MPI_Comm comm, MPI_Request *request)

int MPI_Allgather_init(const void *sendbuf, int  sendcount,
      MPI_Datatype sendtype, void *recvbuf, int recvcount,
      MPI_Datatype recvtype, MPI_Comm comm, MPI_Info info, MPI_Request *request)

17.2.198.1.2. Fortran语法

USE MPI
! or the older form: INCLUDE 'mpif.h'
MPI_ALLGATHER(SENDBUF, SENDCOUNT, SENDTYPE, RECVBUF, RECVCOUNT,
             RECVTYPE, COMM, IERROR)
     <type>  SENDBUF (*), RECVBUF (*)
     INTEGER SENDCOUNT, SENDTYPE, RECVCOUNT, RECVTYPE, COMM,
     INTEGER IERROR

MPI_IALLGATHER(SENDBUF, SENDCOUNT, SENDTYPE, RECVBUF, RECVCOUNT,
             RECVTYPE, COMM, REQUEST, IERROR)
     <type>  SENDBUF(*), RECVBUF (*)
     INTEGER SENDCOUNT, SENDTYPE, RECVCOUNT, RECVTYPE, COMM
     INTEGER REQUEST, IERROR

MPI_ALLGATHER_INIT(SENDBUF, SENDCOUNT, SENDTYPE, RECVBUF, RECVCOUNT,
                     RECVTYPE, COMM, INFO, REQUEST, IERROR)
     <type>  SENDBUF(*), RECVBUF (*)
     INTEGER SENDCOUNT, SENDTYPE, RECVCOUNT, RECVTYPE, COMM
     INTEGER INFO, REQUEST, IERROR

17.2.198.1.3. Fortran 2008 语法

USE mpi_f08
MPI_Allgather(sendbuf, sendcount, sendtype, recvbuf, recvcount, recvtype,
             comm, ierror)
     TYPE(*), DIMENSION(..), INTENT(IN) :: sendbuf
     TYPE(*), DIMENSION(..) :: recvbuf
     INTEGER, INTENT(IN) :: sendcount, recvcount
     TYPE(MPI_Datatype), INTENT(IN) :: sendtype, recvtype
     TYPE(MPI_Comm), INTENT(IN) :: comm
     INTEGER, OPTIONAL, INTENT(OUT) :: ierror

MPI_Iallgather(sendbuf, sendcount, sendtype, recvbuf, recvcount, recvtype,
             comm, request, ierror)
     TYPE(*), DIMENSION(..), INTENT(IN), ASYNCHRONOUS :: sendbuf
     TYPE(*), DIMENSION(..), ASYNCHRONOUS :: recvbuf
     INTEGER, INTENT(IN) :: sendcount, recvcount
     TYPE(MPI_Datatype), INTENT(IN) :: sendtype, recvtype
     TYPE(MPI_Comm), INTENT(IN) :: comm
     TYPE(MPI_Request), INTENT(OUT) :: request
     INTEGER, OPTIONAL, INTENT(OUT) :: ierror

MPI_Allgather_init(sendbuf, sendcount, sendtype, recvbuf, recvcount, recvtype,
                     comm, info, request, ierror)
     TYPE(*), DIMENSION(..), INTENT(IN), ASYNCHRONOUS :: sendbuf
     TYPE(*), DIMENSION(..), ASYNCHRONOUS :: recvbuf
     INTEGER, INTENT(IN) :: sendcount, recvcount
     TYPE(MPI_Datatype), INTENT(IN) :: sendtype, recvtype
     TYPE(MPI_Comm), INTENT(IN) :: comm
     TYPE(MPI_Info), INTENT(IN) :: info
     TYPE(MPI_Request), INTENT(OUT) :: request
     INTEGER, OPTIONAL, INTENT(OUT) :: ierror

17.2.198.2. 输入参数

• sendbuf: 发送缓冲区的起始地址（选项）。

• sendcount: 发送缓冲区中的元素数量（整数）。

• sendtype: 发送缓冲区元素的数据类型（句柄）。

• recvbuf: 接收缓冲区的起始地址（选项）。

• recvcount: 从任意进程接收的元素数量（整数）。

• recvtype: 接收缓冲区元素的数据类型（句柄）。

• comm: 通信器（句柄）。

• info: 信息（句柄，仅持久化）。

17.2.198.3. 输出参数

• recvbuf: 接收缓冲区的地址（选项）。

• request: 请求（句柄，仅限非阻塞模式）。

• ierror: 仅限Fortran：错误状态（整数）。

17.2.198.4. 描述

MPI_Allgather 类似于 MPI_Gather，区别在于所有进程都会接收结果，而不仅仅是根进程。换句话说，所有进程都会贡献结果，并且所有进程都会接收结果。

一个进程中与sendcount、sendtype关联的类型签名必须与其他任何进程中与recvcount、recvtype关联的类型签名相同。

调用MPI_Allgather的结果相当于所有进程都执行了n次

MPI_Gather(sendbuf, sendcount, sendtype, recvbuf, recvcount,
           recvtype, root, comm);

// for root = 0 , ..., n-1.

正确使用MPI_Allgather的规则可以很容易地从MPI_Gather的相应规则中找到。

示例： MPI_Gather中示例1的全收集版本。使用 MPI_Allgather，我们将从组中的每个进程收集100个整数到所有进程。

MPI_Comm comm;
int gsize,sendarray[100];
int *rbuf;
...
MPI_Comm_size( comm, &gsize);
rbuf = (int *)malloc(gsize*100*sizeof(int));
MPI_Allgather( sendarray, 100, MPI_INT, rbuf, 100, MPI_INT, comm);

调用后，每个进程都拥有组内数据集的全局级联。

17.2.198.5. 使用原地(IN-PLACE)选项

当通信器为内部通信器时，您可以执行原地全收集操作（输出缓冲区同时用作输入缓冲区）。将变量MPI_IN_PLACE作为sendbuf的值。在这种情况下，sendcount和sendtype将被忽略。假定每个进程的输入数据位于该进程在接收缓冲区中存放自身贡献的位置。具体来说，使用原地选项调用MPI_Allgather的结果，与所有进程执行n次调用的情形完全相同。

MPI_Allgather( MPI_IN_PLACE, 0, MPI_DATATYPE_NULL, recvbuf,
               recvcount, recvtype, root, comm )

// for root =0, ... , n-1.

请注意，MPI_IN_PLACE是一种特殊类型的值；其使用限制与MPI_BOTTOM相同。

由于原地(in-place)选项将接收缓冲区转换为发送-接收缓冲区，包含INTENT的Fortran绑定必须将其标记为INOUT，而非OUT。

17.2.198.6. 当通信器为跨通信器时

当通信器为跨通信器时，聚集操作分两个阶段进行。首先从第一组所有成员收集数据，并由第二组所有成员接收。随后从第二组所有成员收集数据，再由第一组所有成员接收。但该操作无需对称——第一组进程发送的数据项数量不必等于第二组进程发送的数量。通过将反向通信的sendcount参数设为0，可实现单向数据传输。

17.2.198.7. 错误

几乎所有MPI例程都会返回一个错误值；C语言例程通过函数返回值返回，Fortran例程则通过最后一个参数返回。

在返回错误值之前，会调用与通信对象（如通信器、窗口、文件）关联的当前MPI错误处理程序。如果MPI调用未关联任何通信对象，则该调用被视为附加到MPI_COMM_SELF，并将调用关联的MPI错误处理程序。当MPI_COMM_SELF未初始化时（即在MPI_Init/MPI_Init_thread之前、MPI_Finalize之后，或仅使用会话模型时），错误会触发初始错误处理程序。初始错误处理程序可通过在使用世界模型时调用MPI_Comm_set_errhandler来修改MPI_COMM_SELF，或通过mpiexec的mpi_initial_errhandler命令行参数，或MPI_Comm_spawn/MPI_Comm_spawn_multiple的info键来设置。如果未设置其他适当的错误处理程序，则MPI I/O函数将调用MPI_ERRORS_RETURN错误处理程序，而其他所有MPI函数将调用MPI_ERRORS_ABORT错误处理程序。

Open MPI 包含三个可使用的预定义错误处理器：

• MPI_ERRORS_ARE_FATAL 导致程序中止所有连接的MPI进程。

• MPI_ERRORS_ABORT 一个可在通信器、窗口、文件或会话上调用的错误处理程序。当在通信器上调用时，其行为类似于在该通信器上调用MPI_Abort。如果在窗口或文件上调用，则行为类似于在包含对应窗口或文件中进程组的通信器上调用MPI_Abort。如果在会话上调用，则仅中止本地进程。

• MPI_ERRORS_RETURN 向应用程序返回一个错误代码。

MPI应用程序也可以通过调用以下方式实现自己的错误处理程序：

• MPI_Comm_create_errhandler 然后 MPI_Comm_set_errhandler

• MPI_File_create_errhandler 然后 MPI_File_set_errhandler

• MPI_Session_create_errhandler 然后 MPI_Session_set_errhandler 或在 MPI_Session_init

• MPI_Win_create_errhandler 然后 MPI_Win_set_errhandler

请注意，MPI不保证MPI程序在出现错误后能够继续运行。

查看MPI手册页获取完整的MPI错误代码列表。

有关更多信息，请参阅MPI-3.1标准中的错误处理部分。

另请参阅

• MPI_Allgatherv

• MPI_Gather