18.2.100. MPI_File_create_errhandler

MPI_File_create_errhandler - Creates an MPI-style error handler that can be attached to a file.

18.2.100.1. SYNTAX

18.2.100.1.1. C Syntax

#include <mpi.h>

int MPI_File_create_errhandler(MPI_File_errhandler_function *function,
     MPI_Errhandler *errhandler)

18.2.100.1.2. Fortran Syntax

USE MPI
! or the older form: INCLUDE 'mpif.h'
MPI_FILE_CREATE_ERRHANDLER(FUNCTION, ERRHANDLER, IERROR)
     EXTERNAL        FUNCTION
     INTEGER ERRHANDLER, IERROR

18.2.100.1.3. Fortran 2008 Syntax

USE mpi_f08
MPI_File_create_errhandler(file_errhandler_fn, errhandler, ierror)
     PROCEDURE(MPI_File_errhandler_function) :: file_errhandler_fn
     TYPE(MPI_Errhandler), INTENT(OUT) :: errhandler
     INTEGER, OPTIONAL, INTENT(OUT) :: ierror

18.2.100.2. DEPRECATED TYPE NAME NOTE

MPI-2.2 deprecated the MPI_File_errhandler_fn and MPI::file::Errhandler_fn types in favor of MPI_File_errhandler_function and MPI::File::Errhandler_function, respectively. Open MPI supports both names (indeed, the _fn names are typedefs to the _function names).

18.2.100.3. INPUT PARAMETER

  • function: User-defined error handling procedure (function).

18.2.100.4. OUTPUT PARAMETERS

  • errhandler: MPI error handler (handle).

  • IERROR: Fortran only: Error status (integer).

18.2.100.5. DESCRIPTION

Registers the user routine function for use as an MPI error handler. Returns in errhandler a handle to the registered error handler.

In the C language, the user routine function should be a C function of type MPI_File_errhandler_function, which is defined as

typedef void (MPI_File_errhandler_function)(MPI_File *, int *,
...);

The first argument to function is the file in use. The second is the error code to be returned by the MPI routine that raised the error.

In the Fortran language, the user routine should be of the form:

SUBROUTINE FILE_ERRHANDLER_FUNCTION(FILE, ERROR_CODE, ...)
    INTEGER FILE, ERROR_CODE

18.2.100.6. ERRORS

Almost all MPI routines return an error value; C routines as the return result of the function and Fortran routines in the last argument.

Before the error value is returned, the current MPI error handler associated with the communication object (e.g., communicator, window, file) is called. If no communication object is associated with the MPI call, then the call is considered attached to MPI_COMM_SELF and will call the associated MPI error handler. When MPI_COMM_SELF is not initialized (i.e., before MPI_INIT / MPI_INIT_THREAD, after MPI_FINALIZE, or when using the Sessions Model exclusively) the error raises the initial error handler. The initial error handler can be changed by calling MPI_COMM_SET_ERRHANDLER on MPI_COMM_SELF when using the World model, or the mpi_initial_errhandler CLI argument to mpiexec or info key to MPI_COMM_SPAWN[_MULTIPLE]. If no other appropriate error handler has been set, then the MPI_ERRORS_RETURN error handler is called for MPI I/O functions and the MPI_ERRORS_ABORT error handler is called for all other MPI functions.

In the sessions model, the error handler can be set during MPI_Session_init.

Open MPI includes three predefined error handlers that can be used:

MPI_ERRORS_ARE_FATAL: Causes the program to abort all connected MPI processes.
MPI_ERRORS_ABORT:     An error handler that can be invoked on a communicator,
                      window, file, or session. When called on a communicator, it
                      acts as if MPI_ABORT was called on that communicator. If
                      called on a window or file, acts as if MPI_ABORT was called
                      on a communicator containing the group of processes in the
                      corresponding window or file. If called on a session,
                      aborts only the local process.
MPI_ERRORS_RETURN:    Returns an error code to the application.

MPI applications can also implement their own error handlers.

Custom MPI error handlers can be created by calling: MPI_Comm_create_errhandler(3) MPI_File_create_errhandler(3) MPI_Session_create_errhandler(3) MPI_Win_create_errhandler(3)

Predefined and custom error handlers can be set by calling: MPI_Comm_set_errhandler(3) MPI_File_set_errhandler(3) MPI_Session_set_errhandler(3) MPI_Win_set_errhandler(3)

Note that MPI does not guarantee that an MPI program can continue past an error.

See the MPI man page for a full list of MPI error codes.

See the Error Handling section of the MPI-3 standard for more information.