17.2.82. MPI_Compare_and_swap

MPI_Compare_and_swap — 执行远程内存访问的比较交换操作

17.2.82.1. 语法

17.2.82.1.1. C语法

#include <mpi.h>

int MPI_Compare_and_swap(const void *origin_addr, const void *compare_addr,
     void *result_addr, MPI_Datatype datatype, int target_rank,
     MPI_Aint target_disp, MPI_Win win)

17.2.82.1.2. Fortran语法

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

17.2.82.1.3. Fortran 2008 语法

USE mpi_f08
MPI_Compare_and_swap(origin_addr, compare_addr, result_addr, datatype,
             target_rank, target_disp, win, ierror)
     TYPE(*), DIMENSION(..), INTENT(IN) :: origin_addr, compare_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_Win), INTENT(IN) :: win
     INTEGER, OPTIONAL, INTENT(OUT) :: ierror

17.2.82.2. 输入参数

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

  • compare_addr: 比较缓冲区的初始地址（可选）。

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

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

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

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

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

17.2.82.3. 输出参数

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

17.2.82.4. 描述

该函数将比较缓冲区compare_addr中类型为datatype的一个元素与由target_rank和win指定的目标窗口中偏移量为target_disp处的缓冲区进行比较，如果比较缓冲区与目标缓冲区内容相同，则用原始缓冲区origin_addr中的值替换目标处的值。目标的原始值将通过缓冲区result_addr返回。参数datatype必须属于以下预定义数据类型类别之一：C整数、Fortran整数、逻辑型、多语言类型或MPI-3第176页5.9.2节中规定的字节类型。

源缓冲区和结果缓冲区（origin_addr 和 result_addr）必须是分离的。

17.2.82.5. 注意事项

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

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