17.2.49. MPI_Comm_create_errhandler

MPI_Comm_create_errhandler — 创建一个可附加到通信器的错误处理程序。

17.2.49.1. 语法

17.2.49.1.1. C语法

#include <mpi.h>

int MPI_Comm_create_errhandler(MPI_Comm_errhandler_function *function,
    MPI_Errhandler *errhandler)

17.2.49.1.2. Fortran 语法

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

MPI_COMM_CREATE_ERRHANDLER(FUNCTION, ERRHANDLER, IERROR)
    EXTERNAL    FUNCTION
    INTEGER ERRHANDLER, IERROR

17.2.49.1.3. Fortran 2008 语法

USE mpi_f08

MPI_Comm_create_errhandler(comm_errhandler_fn, errhandler, ierror)
    PROCEDURE(MPI_Comm_errhandler_function) :: comm_errhandler_fn
    TYPE(MPI_Errhandler), INTENT(OUT) :: errhandler
    INTEGER, OPTIONAL, INTENT(OUT) :: ierror

17.2.49.2. 已弃用的类型名称说明

MPI-2.2 弃用了 MPI_Comm_errhandler_fn 类型，转而推荐使用 MPI_Comm_errhandler_function。 Open MPI 同时支持这两种命名方式（实际上，_fn 名称是 _function 名称的类型定义）。

17.2.49.3. 输入参数

function : 用户自定义的错误处理过程（函数）。

17.2.49.4. 输出参数

errhandler : MPI错误处理程序（句柄）。
ierror : 仅限Fortran：错误状态（整数）。

17.2.49.5. 描述

MPI_Comm_create_errhandler 创建一个可附加到通信器的错误处理器。该function与MPI_Errhandler_create功能相同（后者已弃用）。在C语言中，用户例程应为MPI_Comm_errhandler_function类型的function，其定义为

typedef void MPI_Comm_errhandler_function(MPI_Comm *, int *, ...);

第一个参数是当前使用的通信器。第二个参数是由引发错误的MPI例程返回的错误代码。该typedef替代了MPI_Handler_function，后者的使用已被弃用。在Fortran中，用户例程应采用以下形式：

SUBROUTINE COMM_ERRHANDLER_FUNCTION(COMM, ERROR_CODE, ...)
   INTEGER COMM, ERROR_CODE

17.2.49.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_Comm_create_errhandler 然后 MPI_Comm_set_errhandler
MPI_File_create_errhandler 然后 MPI_File_set_errhandler
MPI_Session_create_errhandler 然后 MPI_Session_set_errhandler 或在 MPI_Session_init
MPI_Win_create_errhandler 然后 MPI_Win_set_errhandler

请注意，MPI不保证MPI程序在出现错误后能够继续运行。

查看MPI手册页获取完整的MPI错误代码列表。

有关更多信息，请参阅MPI-3.1标准中的错误处理部分。