17.2.289. MPI_Raccumulate

MPI_Accumulate, MPI_Raccumulate - 将源缓冲区的内容与目标缓冲区的内容进行合并。

17.2.289.1. 语法

17.2.289.1.1. C语法

#include <mpi.h>

int MPI_Accumulate(const void *origin_addr, int origin_count,
     MPI_Datatype origin_datatype, int target_rank,
     MPI_Aint target_disp, int target_count,
     MPI_Datatype target_datatype, MPI_Op op, MPI_Win win)

int MPI_Raccumulate(const void *origin_addr, int origin_count,
     MPI_Datatype origin_datatype, int target_rank,
     MPI_Aint target_disp, int target_count,
     MPI_Datatype target_datatype, MPI_Op op, MPI_Win win,
     MPI_Request *request)

17.2.289.1.2. Fortran语法

USE MPI
! or the older form: INCLUDE 'mpif.h'
MPI_ACCUMULATE(ORIGIN_ADDR, ORIGIN_COUNT, ORIGIN_DATATYPE, TARGET_RANK,
     TARGET_DISP, TARGET_COUNT, TARGET_DATATYPE, OP, WIN, IERROR)
     <type> ORIGIN_ADDR(*)
     INTEGER(KIND=MPI_ADDRESS_KIND) TARGET_DISP
     INTEGER ORIGIN_COUNT, ORIGIN_DATATYPE, TARGET_RANK, TARGET_COUNT,
     TARGET_DATATYPE, OP, WIN, IERROR

MPI_RACCUMULATE(ORIGIN_ADDR, ORIGIN_COUNT, ORIGIN_DATATYPE, TARGET_RANK,
     TARGET_DISP, TARGET_COUNT, TARGET_DATATYPE, OP, WIN, REQUEST, IERROR)
     <type> ORIGIN_ADDR(*)
     INTEGER(KIND=MPI_ADDRESS_KIND) TARGET_DISP
     INTEGER ORIGIN_COUNT, ORIGIN_DATATYPE, TARGET_RANK, TARGET_COUNT,
     TARGET_DATATYPE, OP, WIN, REQUEST, IERROR

17.2.289.1.3. Fortran 2008 语法

USE mpi_f08
MPI_Accumulate(origin_addr, origin_count, origin_datatype, target_rank,
             target_disp, target_count, target_datatype, op, win, ierror)
     TYPE(*), DIMENSION(..), INTENT(IN), ASYNCHRONOUS :: origin_addr
     INTEGER, INTENT(IN) :: origin_count, target_rank, target_count
     TYPE(MPI_Datatype), INTENT(IN) :: origin_datatype, target_datatype
     INTEGER(KIND=MPI_ADDRESS_KIND), INTENT(IN) :: target_disp
     TYPE(MPI_Op), INTENT(IN) :: op
     TYPE(MPI_Win), INTENT(IN) :: win
     INTEGER, OPTIONAL, INTENT(OUT) :: ierror

MPI_Raccumulate(origin_addr, origin_count, origin_datatype, target_rank,
     target_disp, target_count, target_datatype, op, win, request,
             ierror)
     TYPE(*), DIMENSION(..), INTENT(IN), ASYNCHRONOUS :: origin_addr
     INTEGER, INTENT(IN) :: origin_count, target_rank, target_count
     TYPE(MPI_Datatype), INTENT(IN) :: origin_datatype, target_datatype
     INTEGER(KIND=MPI_ADDRESS_KIND), INTENT(IN) :: target_disp
     TYPE(MPI_Op), INTENT(IN) :: op
     TYPE(MPI_Win), INTENT(IN) :: win
     TYPE(MPI_Request), INTENT(OUT) :: request
     INTEGER, OPTIONAL, INTENT(OUT) :: ierror

17.2.289.2. 输入参数

  • origin_addr: 缓冲区的初始地址（可选）。

  • origin_count: 缓冲区中的条目数（非负整数）。

  • origin_datatype: 每个缓冲区条目的数据类型（句柄）。

  • target_rank: 目标排名（非负整数）。

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

  • target_count: 目标缓冲区中的条目数（非负整数）。

  • target_datatype: 目标缓冲区中每个条目的数据类型（句柄）。

  • op: 归约操作（句柄）。

  • win: 窗口对象（句柄）。

17.2.289.3. 输出参数

  • MPI_Raccumulate: RMA请求

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

17.2.289.4. 描述

MPI_Accumulate 是一个用于单边MPI通信的函数，它将源缓冲区（由 origin_addr、origin_count 和 origin_datatype 定义）的内容添加到目标缓冲区中。目标缓冲区由参数 target_count 和 target_datatype 指定，位于由 target_rank 和 win 指定的目标窗口中偏移量 target_disp 处，并使用操作 op 进行组合。目标窗口只能由同一节点内的进程访问。这与 MPI_Put 类似，不同之处在于数据是组合到目标区域而不是覆盖它。

任何预定义的MPI_Reduce操作都可以使用。 用户自定义函数不可用。例如，如果op是MPI_SUM， 则源缓冲区中的每个元素将与目标缓冲区中的对应元素相加， 并替换目标缓冲区中的原值。

每个数据类型参数必须是一个预定义的数据类型或派生数据类型，其中所有基本组件都属于相同的预定义数据类型。两个数据类型参数必须基于相同的预定义数据类型构建。操作op应用于该预定义类型的元素。target_datatype参数不得指定重叠条目，且目标缓冲区必须适配目标窗口。

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

MPI_Raccumulate 与 MPI_Accumulate 类似，不同之处在于它会分配一个通信请求对象并将其与请求句柄（参数 request）关联，该句柄可用于等待或测试完成。MPI_Raccumulate 操作的完成表示 origin_addr 缓冲区可以自由更新。但这并不表示该操作已在目标窗口完成。

17.2.289.5. 注意事项

MPI_Put 是 MPI_Accumulate 的一个特例，使用 MPI_REPLACE 操作。但请注意，MPI_Put 和 MPI_Accumulate 在并发更新方面有不同的约束条件。

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

17.2.289.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标准中的错误处理部分。

另请参阅