MPI_Abort
Terminates MPI execution environment
Synopsis
int MPI_Abort(MPI_Comm comm, int errorcode)
Input Parameters
- comm
- communicator of tasks to abort
- errorcode
- error code to return to invoking environment
Notes
Terminates all MPI processes associated with the communicator comm; in
most systems (all to date), terminates all processes.
Thread and Interrupt Safety
The user is responsible for ensuring that multiple threads do not try to
update the same MPI object from different threads. This routine should
not be used from within a signal handler.
The MPI standard defined a thread-safe interface but this does not
mean that all routines may be called without any thread locks. For
example, two threads must not attempt to change the contents of the
same MPI_Info object concurrently. The user is responsible in this
case for using some mechanism, such as thread locks, to ensure that
only one thread at a time makes use of this routine.
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 guarentee 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.
Location:abort.c