17.2.162. MPI_Gather

MPI_Gather, MPI_Igather, MPI_Gather_init - 从一组进程中收集值。

17.2.162.1. 概要

17.2.162.1.1. C语法

#include <mpi.h>

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

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

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

17.2.162.1.2. Fortran 语法

USE MPI
! or the older form: INCLUDE 'mpif.h'

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

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

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

17.2.162.1.3. Fortran 2008 语法

USE mpi_f08

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

MPI_Igather(sendbuf, sendcount, sendtype, recvbuf, recvcount, recvtype,
        root, comm, request, ierror)
    TYPE(*), DIMENSION(..), INTENT(IN), ASYNCHRONOUS :: sendbuf
    TYPE(*), DIMENSION(..), ASYNCHRONOUS :: recvbuf
    INTEGER, INTENT(IN) :: sendcount, recvcount, root
    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_Gather_init(sendbuf, sendcount, sendtype, recvbuf, recvcount, recvtype,
        root, comm, info, request, ierror)
    TYPE(*), DIMENSION(..), INTENT(IN), ASYNCHRONOUS :: sendbuf
    TYPE(*), DIMENSION(..), ASYNCHRONOUS :: recvbuf
    INTEGER, INTENT(IN) :: sendcount, recvcount, root
    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.162.2. 输入参数

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

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

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

• recvcount : 每个接收操作的元素数量（整数，仅在根节点有效）。

• recvtype : 接收缓冲区元素的数据类型（句柄，仅在根节点有效）。

• root : 接收进程的等级（整数）。

• comm : 通信器（句柄）。

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

17.2.162.3. 输出参数

• recvbuf接收缓冲区地址（仅在根节点有效）

  根节点。

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

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

17.2.162.4. 描述

每个进程（包括根进程）将其发送缓冲区的内容发送给根进程。根进程接收这些消息并按进程等级顺序存储。结果相当于组内的n个进程（包括根进程）都执行了对

MPI_Send(sendbuf, sendcount, sendtype, root, ...)

并且根节点已经执行了n次调用

MPI_Recv(recfbuf + i * recvcount * extent(recvtype), recvcount,
         recvtype, i, ...)

其中extent(recvtype)是通过调用MPI_Type_extent获得的类型范围。

另一种描述是，组内各进程发送的n条消息按等级顺序连接起来，最终的消息由根进程接收，就像通过调用MPI_Recv(recvbuf, recvcount * n, recvtype, ... )一样。

对于所有非根进程，接收缓冲区将被忽略。

对于发送类型(sendtype)和接收类型(recvtype)，允许使用通用的派生数据类型。每个进程i上的发送计数(sendcount)和发送类型(sendtype)的类型签名必须与根进程上的接收计数(recvcount)和接收类型(recvtype)的类型签名相匹配。这意味着每个进程与根进程之间发送和接收的数据量必须成对相等。发送方和接收方之间仍然允许使用不同的类型映射。

该函数的所有参数在进程根节点上都是有效的，而在其他进程上，只有参数 sendbuf、sendcount、sendtype、root 和 comm 是有效的。参数 root 和 comm 在所有进程上必须具有相同的值。

计数和类型的指定不应导致根位置被多次写入。这样的调用是错误的。请注意，根节点上的recvcount参数表示它从每个进程接收的项目数量，而不是它接收的项目总数。

示例1：将组内每个进程的100个整数收集到根进程。

MPI_Comm comm;
int gsize, sendarray[100];
int root, *rbuf;
...

MPI_Comm_size( comm, &gsize);
rbuf = (int*)malloc(gsize* 100*sizeof(int));

MPI_Gather( sendarray, 100, MPI_INT, rbuf, 100, MPI_INT, root, comm);

示例2：修改后的前一个例子——只有根节点为接收缓冲区分配内存。

MPI_Comm comm;
int gsize, sendarray[100];
int root, myrank, *rbuf;
...

MPI_Comm_rank( comm, myrank);
if ( myrank == root) {
  MPI_Comm_size( comm, &gsize);
  rbuf = (int *)malloc(gsize * 100*sizeof(int));
}
MPI_Gather( sendarray, 100, MPI_INT, rbuf, 100, MPI_INT, root, comm);

示例3：执行与前一示例相同的操作，但使用派生数据类型。请注意，该类型不能是整个gsize * 100整数集合，因为在gather操作中类型匹配是根进程与每个参与进程之间成对定义的。

MPI_Comm comm;
int gsize, sendarray[100];
int root, *rbuf;
MPI_Datatype rtype;
...

MPI_Comm_size( comm, &gsize);
MPI_Type_contiguous( 100, MPI_INT, &rtype);
MPI_Type_commit( &rtype );
rbuf = (int*)malloc(gsize* 100*sizeof(int));
MPI_Gather( sendarray, 100, MPI_INT, rbuf, 1, rtype, root, comm);

17.2.162.5. 就地选项的使用

当通信器为内部通信器时，可以执行原地聚集操作（输出缓冲区同时用作输入缓冲区）。将变量MPI_IN_PLACE作为根进程sendbuf的值。此时，sendcount和sendtype参数将被忽略，且假定根进程对聚集向量的贡献已正确存放在接收缓冲区的对应位置。请注意MPI_IN_PLACE是一种特殊值，其使用限制与MPI_BOTTOM相同。由于原地操作会将接收缓冲区转换为发送-接收缓冲区，包含INTENT声明的Fortran绑定必须将其标记为INOUT而非OUT。

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

当通信器为跨通信器时，第一组中的根进程会从第二组的所有进程中收集数据。第一组定义了根进程。该进程在其根参数中使用MPI_ROOT作为值。其余进程使用MPI_PROC_NULL作为其根参数的值。第二组中的所有进程使用第一组中该根进程的秩作为其根参数的值。第一组中进程的发送缓冲区参数必须与第二组中根进程的接收缓冲区参数保持一致。

17.2.162.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_Gatherv