17.2.199. MPI_Iallgatherv

MPI_Allgatherv, MPI_Iallgatherv, MPI_Allgatherv_init - 从所有进程收集数据并分发给所有进程。每个进程可以提供不同数量的数据。

17.2.199.1. 语法

17.2.199.1.1. C语法

#include <mpi.h>

int MPI_Allgatherv(const void *sendbuf, int sendcount,
     MPI_Datatype sendtype, void *recvbuf, const int recvcounts[],
     const int displs[], MPI_Datatype recvtype, MPI_Comm comm)

int MPI_Iallgatherv(const void *sendbuf, int sendcount,
     MPI_Datatype sendtype, void *recvbuf, const int recvcounts[],
     const int displs[], MPI_Datatype recvtype, MPI_Comm comm,
        MPI_Request *request)

int MPI_Allgatherv_init(const void *sendbuf, int sendcount,
     MPI_Datatype sendtype, void *recvbuf, const int recvcounts[],
     const int displs[], MPI_Datatype recvtype, MPI_Comm comm,
        MPI_Info info, MPI_Request *request)

17.2.199.1.2. Fortran语法

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

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

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

17.2.199.1.3. Fortran 2008 语法

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

MPI_Iallgatherv(sendbuf, sendcount, sendtype, recvbuf, recvcounts, displs,
             recvtype, comm, request, ierror)
     TYPE(*), DIMENSION(..), INTENT(IN), ASYNCHRONOUS :: sendbuf
     TYPE(*), DIMENSION(..), ASYNCHRONOUS :: recvbuf
     INTEGER, INTENT(IN) :: sendcount
     INTEGER, INTENT(IN), ASYNCHRONOUS :: recvcounts(*), displs(*)
     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_Allgatherv_init(sendbuf, sendcount, sendtype, recvbuf, recvcounts, displs,
                     recvtype, comm, info, request, ierror)
     TYPE(*), DIMENSION(..), INTENT(IN), ASYNCHRONOUS :: sendbuf
     TYPE(*), DIMENSION(..), ASYNCHRONOUS :: recvbuf
     INTEGER, INTENT(IN) :: sendcount
     INTEGER, INTENT(IN), ASYNCHRONOUS :: recvcounts(*), displs(*)
     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.199.2. 输入参数

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

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

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

• recvcount: 整数数组（长度为组大小），包含从每个进程接收的元素数量。

• displs: 整型数组（长度为组大小）。条目i指定从进程i接收数据的位移（相对于recvbuf）。

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

• comm: 通信器（句柄）。

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

17.2.199.3. 输出参数

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

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

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

17.2.199.4. 描述

MPI_Allgatherv 与 MPI_Allgather 类似，都是所有进程从其他所有进程收集数据，区别在于每个进程可以发送不同数量的数据。从第j个进程发送的数据块会被每个进程接收，并放置在缓冲区 recvbuf 的第j个块中。

进程j上与sendcount、sendtype关联的类型签名必须等于其他任何进程上与recvcounts[j]、recvtype关联的类型签名。

结果相当于所有进程都执行了对

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

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

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

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

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

MPI_Allgatherv ( MPI_IN_PLACE, 0, MPI_DATATYPE_NULL, recvbuf,
                 recvcounts, displs, recvtype, root, comm );

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

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

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

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

当通信器为跨通信器时，聚集操作分两个阶段进行。首先从第一组所有成员收集数据，拼接后由第二组所有成员接收；随后从第二组所有成员收集数据，拼接后由第一组所有成员接收。其中一组的发送缓冲区参数必须与另一组的接收缓冲区参数保持一致，反之亦然。该操作必须呈现对称的全双工行为。

17.2.199.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

• MPI_Allgather