17.2.287. MPI_Put

MPI_Put, MPI_Rput - 将数据从源内存复制到目标内存。

17.2.287.1. 语法

17.2.287.1.1. C语法

#include <mpi.h>

MPI_Put(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_Win win)

MPI_Rput(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_Win win,
      MPI_Request *request)

17.2.287.1.2. Fortran语法

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

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

17.2.287.1.3. Fortran 2008 语法

USE mpi_f08
MPI_Put(origin_addr, origin_count, origin_datatype, target_rank,
             target_disp, target_count, target_datatype, 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_Win), INTENT(IN) :: win
     INTEGER, OPTIONAL, INTENT(OUT) :: ierror

MPI_Rput(origin_addr, origin_count, origin_datatype, target_rank,
     target_disp, target_count, target_datatype, 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_Win), INTENT(IN) :: win
     TYPE(MPI_Request), INTENT(OUT) :: request
     INTEGER, OPTIONAL, INTENT(OUT) :: ierror

17.2.287.2. 输入参数

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

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

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

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

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

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

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

  • win: 用于通信的窗口对象（句柄）。

17.2.287.3. 输出参数

  • request: MPI_Rput: RMA请求

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

17.2.287.4. 描述

MPI_Put 将origin_count个连续的指定类型数据（由origin_datatype定义），从源节点地址origin_addr开始传输到目标节点（由win和target_rank指定）

数据被写入目标缓冲区的地址为 target_addr ^ window_base + target_disp x disp_unit，其中 window_base 和 disp_unit 是由目标进程在窗口初始化时指定的基地址和窗口位移单位。

目标缓冲区由参数target_count和target_datatype指定。

数据传输的过程等同于：当源进程执行发送操作（参数为origin_addr、origin_count、origin_datatype、target_rank、tag、comm），同时目标进程执行接收操作（参数为target_addr、target_count、target_datatype、source、tag、comm）时发生的数据交换。其中target_addr是按上述方式计算得到的目标缓冲区地址，而comm是win所属进程组的通信器。

通信必须满足与类似消息传递通信相同的约束条件。target_datatype不得指定目标缓冲区中的重叠条目。发送的消息必须完整地放入目标缓冲区，不能截断。此外，目标缓冲区必须能放入目标窗口中。另外，只有同一缓冲区内的进程才能访问目标窗口。

target_datatype参数是源进程中定义的数据类型对象的句柄。然而，该对象会在目标进程中被解释：其效果等同于目标数据类型对象是通过与源进程相同的调用序列在目标进程中定义的。目标数据类型必须仅包含相对位移，而非绝对地址。这一规则同样适用于get和accumulate操作。

MPI_Rput 与 MPI_Put 类似，不同之处在于它会分配一个通信请求对象并将其与请求句柄（参数 request）关联。MPI_Rput 操作的完成（即在相应的测试或等待之后）表示发送方现在可以自由更新 origin_addr 缓冲区中的位置。这并不表示数据已到达目标窗口。如果需要远程完成，可以使用 MPI_Win_flush、MPI_Win_flush_all、MPI_Win_unlock 或 MPI_Win_unlock_all。

17.2.287.5. 注意事项

target_datatype参数是一个数据类型对象的句柄，该对象在源进程中定义，尽管它定义了目标进程内存中的数据布局。只要使用可移植的数据类型（可移植数据类型在MPI-2标准的第2.4节中定义），这在同构或异构环境中都不会引起问题。

在某些系统中，放置传输的性能可能受到窗口位置选择以及源缓冲区和目标缓冲区的形状和位置的显著影响：在共享内存系统上，传输到由MPI_Alloc_mem分配的内存中的目标窗口可能会快得多；在大多数（如果不是全部）系统上，从连续缓冲区传输会更快；通信缓冲区的对齐方式也可能影响性能。

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

另请参阅