17.2.33. MPI_Cancel
MPI_Cancel — 取消一个通信请求。
17.2.33.1. 语法
17.2.33.1.1. C语法
#include <mpi.h>
int MPI_Cancel(MPI_Request *request)
17.2.33.1.2. Fortran语法
USE MPI
! or the older form: INCLUDE 'mpif.h'
MPI_CANCEL(REQUEST, IERROR)
INTEGER REQUEST, IERROR
17.2.33.1.3. Fortran 2008 语法
USE mpi_f08
MPI_Cancel(request, ierror)
TYPE(MPI_Request), INTENT(IN) :: request
INTEGER, OPTIONAL, INTENT(OUT) :: ierror
17.2.33.2. 输入参数
request: 通信请求（句柄）。
17.2.33.3. 输出参数
ierror: 仅限Fortran：错误状态（整数）。
17.2.33.4. 描述
MPI_Cancel操作允许取消挂起的通信。这是清理所必需的。发起发送或接收会占用用户资源（发送或接收缓冲区），可能需要取消操作来优雅地释放这些资源。
调用MPI_Cancel会标记一个待处理的非阻塞通信操作(发送或接收)为取消状态。该取消调用是本地操作，会立即返回，可能在通信实际被取消之前就返回。对于已被标记取消的通信，仍然需要通过调用MPI_Request_free、MPI_Wait或MPI_Test(或任何派生操作)来完成。
如果某个通信被标记为取消，那么针对该通信的MPI_Wait调用将确保返回，无论其他进程的活动如何（即MPI_Wait表现为本地函数）；类似地，如果在繁忙等待循环中重复调用MPI_Test来检测已取消的通信，那么MPI_Test最终将成功返回。
MPI_Cancel 可用于取消使用持久请求的通信（参见MPI标准第3.9节"持久通信请求"），其使用方式与非持久请求相同。成功取消会终止活动通信，但不会删除请求本身。在调用MPI_Cancel及后续调用MPI_Wait或MPI_Test后，该请求将变为非活动状态，并可被重新激活用于新的通信。
成功取消缓冲发送将释放待处理消息占用的缓冲区空间。
取消操作或通信操作只能成功一个，不能同时成功。如果发送操作被标记为取消，那么必须满足以下两种情况之一：要么发送正常完成（此时消息会被目标进程接收），要么发送被成功取消（此时目标进程不会收到任何消息片段）。在这种情况下，任何匹配的接收操作都必须由另一个发送操作来满足。如果接收操作被标记为取消，那么必须满足以下两种情况之一：要么接收正常完成，要么接收被成功取消（此时接收缓冲区不会被修改任何部分）。在这种情况下，任何匹配的发送操作都必须由另一个接收操作来满足。
如果操作已被取消，那么完成通信的操作将在其状态参数中返回相关信息。
17.2.33.5. 注意事项
MPI_Cancel的主要预期用途是在多缓冲方案中，用于处理推测性的MPI_Irecv操作。当计算完成时，部分请求可能仍处于未完成状态；使用MPI_Cancel允许用户取消这些未满足的请求。
17.2.33.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-3.1标准中的错误处理部分。
另请参阅