Synopsis
int MPI_Abort(MPI_Comm comm, int errorcode)
Input Parameters
- comm
-
communicator of tasks to abort (handle)
- errorcode
-
error code to return to invoking environment (integer)
Description
MPI_Abort makes a best attempt to abort all MPI processes in the group of comm. It may not be possible for an MPI implementation to abort only a subset of processes; in this case, the implementation attempts to abort all connected processes but not unconnected processes. When using the World Process Model with no spawned, accepted, or connected processes, this aborts all processes associated with MPI_COMM_WORLD. In the Sessions Process Model, if an MPI process has instantiated multiple sessions, the union of the process sets in those sessions are considered connected processes. Invoking MPI_Abort on a communicator derived from one session aborts all MPI processes in this union.
Whether errorcode is returned from the executable or from the MPI process startup mechanism is an aspect of quality of the MPI library and is not mandatory.
Notes
Terminates all MPI processes associated with the communicator comm; in
most systems (all to date), terminates all processes.
NotThreadSafe
Because the MPI_Abort routine is intended to ensure that an MPI
process (and possibly an entire job), it cannot wait for a thread to
release a lock or other mechanism for atomic access.
Notes for Fortran
All MPI routines in Fortran (except for 'MPI_WTIME' and 'MPI_WTICK') have an additional argument 'ierr' at the end of the argument list. 'ierr' is an integer and has the same meaning as the return value of the routine in C. In Fortran, MPI routines are subroutines, and are invoked with the 'call' statement.
All MPI objects (e.g., 'MPI_Datatype', 'MPI_Comm') are of type 'INTEGER' in Fortran.
Errors
All MPI routines (except 'MPI_Wtime' and 'MPI_Wtick') return an error value;
C routines as the value of the function and Fortran routines in the last
argument. Before the value is returned, the current MPI error handler is
called. By default, this error handler aborts the MPI job. The error handler
may be changed with 'MPI_Comm_set_errhandler' (for communicators),
'MPI_File_set_errhandler' (for files), and 'MPI_Win_set_errhandler' (for
RMA windows). The MPI-1 routine 'MPI_Errhandler_set' may be used but
its use is deprecated. The predefined error handler
'MPI_ERRORS_RETURN' may be used to cause error values to be returned.
Note that MPI does not guarantee that an MPI program can continue past
an error; however, MPI implementations will attempt to continue whenever
possible.
-
MPI_SUCCESS - No error; MPI routine completed successfully.
-
MPI_ERR_COMM - Invalid communicator. A common error is to use a null communicator in a call (not even allowed in 'MPI_Comm_rank').
-
MPI_ERR_OTHER - Other error; use 'MPI_Error_string' to get more information about this error code.