105 lines
2.5 KiB
Groff
105 lines
2.5 KiB
Groff
.TH MPI_Abort 3 "6/5/2019" " " "MPI"
|
|
.SH NAME
|
|
MPI_Abort \- Terminates MPI execution environment
|
|
.SH SYNOPSIS
|
|
.nf
|
|
int MPI_Abort(MPI_Comm comm, int errorcode)
|
|
.fi
|
|
.SH INPUT PARAMETERS
|
|
.PD 0
|
|
.TP
|
|
.B comm
|
|
- communicator of tasks to abort
|
|
.PD 1
|
|
.PD 0
|
|
.TP
|
|
.B errorcode
|
|
- error code to return to invoking environment
|
|
.PD 1
|
|
|
|
.SH NOTES
|
|
Terminates all MPI processes associated with the communicator
|
|
.I comm
|
|
; in
|
|
most systems (all to date), terminates
|
|
.B all
|
|
processes.
|
|
|
|
.SH 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
|
|
.I 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
|
|
.I 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.
|
|
|
|
.SH NOTES FOR FORTRAN
|
|
All MPI routines in Fortran (except for
|
|
.I MPI_WTIME
|
|
and
|
|
.I MPI_WTICK
|
|
) have
|
|
an additional argument
|
|
.I ierr
|
|
at the end of the argument list.
|
|
.I 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
|
|
.I call
|
|
statement.
|
|
|
|
All MPI objects (e.g.,
|
|
.I MPI_Datatype
|
|
,
|
|
.I MPI_Comm
|
|
) are of type
|
|
.I INTEGER
|
|
in Fortran.
|
|
|
|
.SH ERRORS
|
|
|
|
All MPI routines (except
|
|
.I MPI_Wtime
|
|
and
|
|
.I 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
|
|
.I MPI_Comm_set_errhandler
|
|
(for communicators),
|
|
.I MPI_File_set_errhandler
|
|
(for files), and
|
|
.I MPI_Win_set_errhandler
|
|
(for
|
|
RMA windows). The MPI-1 routine
|
|
.I MPI_Errhandler_set
|
|
may be used but
|
|
its use is deprecated. The predefined error handler
|
|
.I MPI_ERRORS_RETURN
|
|
may be used to cause error values to be returned.
|
|
Note that MPI does
|
|
.B not
|
|
guarentee that an MPI program can continue past
|
|
an error; however, MPI implementations will attempt to continue whenever
|
|
possible.
|
|
|
|
.PD 0
|
|
.TP
|
|
.B MPI_SUCCESS
|
|
- No error; MPI routine completed successfully.
|
|
.PD 1
|