17.2.341. MPI_Status_set_cancelled

MPI_Status_set_cancelled — 将status设置为指示请求已被取消。

17.2.341.1. 语法

17.2.341.1.1. C语法

#include <mpi.h>

int MPI_Status_set_cancelled(MPI_Status *status, int flag)

17.2.341.1.2. Fortran语法

USE MPI
! or the older form: INCLUDE 'mpif.h'
MPI_STATUS_SET_CANCELLED(STATUS, FLAG, IERROR)
     INTEGER STATUS(MPI_STATUS_SIZE), IERROR
     LOGICAL FLAG

17.2.341.1.3. Fortran 2008 语法

USE mpi_f08
MPI_Status_set_cancelled(status, flag, ierror)
     TYPE(MPI_Status), INTENT(INOUT) :: status
     LOGICAL, INTENT(OUT) :: flag
     INTEGER, OPTIONAL, INTENT(OUT) :: ierror

17.2.341.2. 输入/输出参数

  • status: 用于关联取消标志的状态值(status)。

17.2.341.3. 输入参数

  • flag: 如果为true，表示请求已被取消（逻辑值）。

17.2.341.4. 输出参数

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

17.2.341.5. 描述

如果flag设置为true，那么后续调用MPI_Test_cancelled(status, flag*)也会返回flag = true；否则将返回false。

17.2.341.6. 注意事项

建议用户不要将状态字段用于其设计用途之外的其他值。这样做在使用状态对象时可能导致意外结果。例如，如果值超出范围，调用MPI_Get_elements可能会引发错误，或者可能无法检测到此类错误。通用请求提供的extra_state参数可用于返回逻辑上不属于status的信息。此外，修改MPI内部设置的状态值（如MPI_Recv）可能导致不可预测的结果，强烈不建议这样做。

17.2.341.7. 错误

几乎所有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标准中的错误处理部分。