17.2.259. MPI_Neighbor_allgather_init

MPI_Neighbor_allgather, MPI_Ineighbor_allgather, MPI_Neighbor_allgather — 从所有邻居节点收集数据并向所有邻居节点分发数据

17.2.259.1. 语法

17.2.259.1.1. C语法

#include <mpi.h>

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

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

int MPI_Neighbor_allgather_init(const void *sendbuf, int  sendcount,
     MPI_Datatype sendtype, void *recvbuf, int recvcount,
      MPI_Datatype recvtype, MPI_Comm comm, MPI_Infoinfo, MPI_Request req)

17.2.259.1.2. Fortran 语法

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

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

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

17.2.259.1.3. Fortran 2008 语法

USE mpi_f08
MPI_Neighbor_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_Ineighbor_allgather(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_Neighbor_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.259.2. 输入参数

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

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

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

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

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

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

• comm: 通信器（句柄）。

17.2.259.3. 输出参数

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

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

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

17.2.259.4. 描述

MPI_Neighbor_allgather 与 MPI_Allgather 类似，区别在于只有相邻进程会接收结果，而非所有进程。邻居关系和缓冲区布局由 comm 的拓扑结构决定。

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

17.2.259.5. 邻居排序

对于使用MPI_Dist_graph_create创建的分布式图拓扑结构，每个进程中发送和接收缓冲区内的邻居序列分别定义为MPI_Dist_graph_neighbors返回的目标节点和源节点序列。对于使用MPI_Graph_create创建的一般图拓扑结构，发送和接收缓冲区中的邻居顺序定义为MPI_Graph_neighbors返回的邻居序列。需要注意的是，通常应该用分布式图拓扑结构来替代一般图拓扑结构。

对于通过MPI_Cart_create创建的笛卡尔拓扑结构，每个进程中发送和接收缓冲区的邻居顺序由维度顺序定义：首先是负方向的邻居，然后是位移为1的正方向邻居。通信例程中的源和目标数量为2*ndims，其中ndims在MPI_Cart_create中定义。如果某个邻居不存在（例如在非周期性虚拟网格维度的笛卡尔拓扑边界处，即periods[…]==false时），则该邻居被定义为MPI_PROC_NULL。

如果在任何函数中的邻居是MPI_PROC_NULL，那么 该方向的邻域集合通信行为将类似于与MPI_PROC_NULL的点对点 通信。也就是说，缓冲区仍然是邻居序列的一部分，但既不会 进行通信也不会被更新。

17.2.259.6. 注意事项

对于此操作，sendbuf的MPI_IN_PLACE选项没有实际意义。

17.2.259.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_Neighbor_allgatherv

• MPI_Cart_create

• MPI_Garph_create

• MPI_Dist_graph_create

• MPI_Gather