MPI_Abort(3)

NAME
MPI_Abort - Abort and return an exit code

SYNOPSIS
#include <mpi.h>
int MPI_Abort(MPI_Comm comm, int errcode);

#include <pmpi.h>
int PMPI_Abort(MPI_Comm comm, int errcode);

#include <mpi.h>
void Comm::Abort(int errcode) const;

INCLUDE 'mpif.h'
MPI_ABORT(errcode, ierr)
INTEGER errcode

INPUT PARAMETERS
comm
    - communicator (unused) (handle)
errcode
    - error code to return to operating system (integer)

DESCRIPTION
The MPI_Abort() function is used to abort from a program. No clean shutdown is performed. The error code errcode is returned to the operating system by the root rank of MPI_COMM_WORLD. Even though a communicator, comm is specified as a parameter to this function, it is unused. However, using MPI_COMM_NULL will return an error as required by the MPI specification. PMPI_Abort() is the profiling version of this function.

ERRORS
All MPI routines except for MPI_Wtime and MPI_Wtick return an error code. The the current MPI error handler is invoked if the return value is not MPI_SUCCESS. The default error handler aborts, but this may be changed with by using the MPI_Errhandler_set() function. The predefined error handler MPI_ERRORS_RETURN may be used to cause error values to be returned instead. Note that MPI does not guarentee that an MPI program can continue past an error. In this implementation, all errors except MPI_ERR_INTERN or MPI_ERR_OTHER should always be recoverable. In C, the error code is passed as the return value. In FORTRAN, all functions have an parameter ierr which returns the error code. MPI C++ functions do not directly return an error code. However, C++ users may want to use the MPI::ERRORS_THROW_EXCEPTIONS handler. This will throw an MPI::Exception with the corresponding error code. To prevent exceptions from being raised from within C and Fortran code, they will see all error return values as MPI_ERR_PENDING when this handler is chosen. In this implementation, call MPI::throw_exception() to throw the correct exception if this occurs.
MPI_SUCCESS
    - No error;
MPI_ERR_PENDING
    - Pending exception;
MPI_ERR_COMM
    - Invalid communicator.

SEE ALSO
MPI_Init(3), MPI_Initialized(3), MPI_Finalized(3), MPI_Finalize(3)