17.2.97. MPI_Fetch_and_op

MPI_Fetch_and_op — 将源缓冲区的内容与目标缓冲区的内容进行组合,并返回目标缓冲区的值。

17.2.97.1. 语法

17.2.97.1.1. C语法

#include <mpi.h>

int MPI_Fetch_and_op(const void *origin_addr, void *result_addr,
     MPI_Datatype datatype, int target_rank, MPI_Aint target_disp,
     MPI_Op op, MPI_Win win)

17.2.97.1.2. Fortran 语法

USE MPI
! or the older form: INCLUDE 'mpif.h'
MPI_FETCH_AND_OP(ORIGIN_ADDR, RESULT_ADDR, DATATYPE, TARGET_RANK,
                 TARGET_DISP, OP, WIN, IERROR)
     <type> ORIGIN_ADDR, RESULT_ADDR(*)
     INTEGER(KIND=MPI_ADDRESS_KIND) TARGET_DISP
     INTEGER DATATYPE, TARGET_RANK, OP, WIN, IERROR

17.2.97.1.3. Fortran 2008 语法

USE mpi_f08
MPI_Fetch_and_op(origin_addr, result_addr, datatype, target_rank,
             target_disp, op, win, ierror)
     TYPE(*), DIMENSION(..), INTENT(IN) :: origin_addr
     TYPE(*), DIMENSION(..) :: result_addr
     TYPE(MPI_Datatype), INTENT(IN) :: datatype
     INTEGER, INTENT(IN) :: target_rank
     INTEGER(KIND=MPI_ADDRESS_KIND), INTENT(IN) :: target_disp
     TYPE(MPI_Op), INTENET(IN) :: op
     TYPE(MPI_Win), INTENT(IN) :: win
     INTEGER, OPTIONAL, INTENT(OUT) :: ierror

17.2.97.2. 输入参数

  • origin_addr: 缓冲区的初始地址(可选)。

  • result_addr: 结果缓冲区的初始地址(可选)。

  • datatype: 源缓冲区、结果缓冲区和目标缓冲区中条目的数据类型(句柄)。

  • target_rank: 目标排名(非负整数)。

  • target_disp: 从窗口起始位置到目标缓冲区开始处的位移量(非负整数)。

  • op: 归约操作(句柄)。

  • win: 窗口对象(句柄)。

17.2.97.3. 输出参数

  • ierror: 仅限Fortran:错误状态(整数)。

17.2.97.4. 描述

从源缓冲区(origin_addr)累加一个datatype类型的元素到目标窗口(由target_rankwin指定)中偏移量为target_disp的缓冲区,使用操作op,并在结果缓冲区result_addr中返回累加前目标缓冲区的内容。

源缓冲区和结果缓冲区(origin_addrresult_addr)必须是不重叠的。可以指定任何MPI_Rreduce预定义操作,以及MPI_NO_OP或MPI_REPLACE作为op;不能使用用户自定义函数。datatype参数必须是预定义的数据类型。该操作以原子方式执行。

定义了一个新的预定义操作MPI_REPLACE,它对应于关联函数f(a, b) = b;也就是说,目标内存中的当前值将被源节点提供的值所替换。

定义了一个新的预定义操作MPI_NO_OP。它对应的关联函数是f(a, b) = a;也就是说,目标内存中的当前值会在结果缓冲区中返回到原点,并且不对目标缓冲区执行任何操作。

17.2.97.5. 注意事项

用户有责任确保在使用累加函数时,目标位移参数能够根据调用MPI_Fetch_and_op函数时的数据类型参数正确对齐窗口访问。

17.2.97.6. 错误

几乎所有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不保证MPI程序在出现错误后能够继续运行。

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

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