17.2.167. MPI_Get_accumulate

MPI_Get_accumulate, MPI_Rget_accumulate - 将源缓冲区的数据与目标缓冲区的内容进行组合，并返回目标缓冲区的值。

17.2.167.1. 语法

17.2.167.1.1. C语法

#include <mpi.h>

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

int MPI_Rget_accumulate(const void *origin_addr, int origin_count,
    MPI_Datatype origin_datatype, void *result_addr,
    int result_count, MPI_Datatype result_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.167.1.2. Fortran语法

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

MPI_GET_ACCUMULATE(ORIGIN_ADDR, ORIGIN_COUNT, ORIGIN_DATATYPE, RESULT_ADDR,
        RESULT_COUNT, RESULT_DATATYPE, TARGET_RANK, TARGET_DISP, TARGET_COUNT,
        TARGET_DATATYPE, OP, WIN, IERROR)
    <type> ORIGIN_ADDR, RESULT_ADDR(*)
    INTEGER(KIND=MPI_ADDRESS_KIND) TARGET_DISP
    INTEGER ORIGIN_COUNT, ORIGIN_DATATYPE, TARGET_COUNT, TARGET_DATATYPE,
        TARGET_RANK, TARGET_COUNT, TARGET_DATATYPE, OP, WIN, IERROR

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

17.2.167.1.3. Fortran 2008 语法

USE mpi_f08

MPI_Get_accumulate(origin_addr, origin_count, origin_datatype, result_addr,
        result_count, result_datatype, target_rank, target_disp,
        target_count, target_datatype, op, win, ierror)
    TYPE(*), DIMENSION(..), INTENT(IN) :: origin_addr
    TYPE(*), DIMENSION(..) :: result_addr
    INTEGER, INTENT(IN) :: origin_count, result_count, target_rank, target_count
    TYPE(MPI_Datatype), INTENT(IN) :: origin_datatype, target_datatype, result_datatype
    INTEGER(KIND=MPI_ADDRESS_KIND), INTENT(IN) :: target_dist
    TYPE(MPI_Op), INTENT(IN) :: op
    TYPE(MPI_Win), INTENT(IN) :: win
    INTEGER, OPTIONAL, INTENT(OUT) :: ierror

MPI_Rget_accumulate(origin_addr, origin_count, origin_datatype,
        result_addr, result_count, result_datatype, target_rank,
        target_disp, target_count, target_datatype, op, win, request,
        ierror)
    TYPE(*), DIMENSION(..), INTENT(IN) :: origin_addr
    TYPE(*), DIMENSION(..) :: result_addr
    INTEGER, INTENT(IN) :: origin_count, result_count, target_rank, target_count
    TYPE(MPI_Datatype), INTENT(IN) :: origin_datatype, target_datatype, result_datatype
    INTEGER(KIND=MPI_ADDRESS_KIND), INTENT(IN) :: target_dist
    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.167.2. 输入参数

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

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

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

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

  • result_count结果缓冲区中的条目数（非负

    整数）。

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

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

  • target_disp从窗口起始位置到目标缓冲区的位移量

    （非负整数）。

  • target_count目标缓冲区中的条目数（非负

    整数）。

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

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

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

17.2.167.3. 输出参数

17.2.167.4. 描述

MPI_Get_accumulate 是一个用于单边MPI通信的函数，它将源缓冲区（由origin_addr、origin_count和origin_datatype定义）的内容通过操作op添加到目标缓冲区中。目标缓冲区由参数target_count和target_datatype指定，位于目标窗口（由target_rank和win指定）的target_disp偏移处。MPI_Get_accumulate 会在结果缓冲区result_addr中返回累加操作前目标缓冲区的内容。

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

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

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

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

MPI_Rget_accumulate 与 MPI_Get_accumulate 类似，不同之处在于它会分配一个通信请求对象，并将其与可用于等待或测试完成情况的请求句柄（参数 request）关联起来。MPI_Rget_accumulate 操作的完成表示数据已存在于结果缓冲区中，且原始缓冲区可自由更新。但这并不表示该操作已在目标窗口处完成。

17.2.167.5. 注意事项

MPI_Get_accumulate的通用功能可能会限制某些特殊硬件操作支持的获取-递增或获取-添加调用的性能。因此，MPI_Fetch_and_op允许快速实现MPI_Get_accumulate功能中一个常用子集。

MPI_Get 是 MPI_Get_accumulate 的一个特例，使用 MPI_NO_OP 操作。但请注意，MPI_Get 和 MPI_Get_accumulate 对并发更新有不同的约束条件。

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

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

另请参阅

MPI_Put MPI_Reduce