1 | .\"Copyright 2006-2008 Sun Microsystems, Inc. |
---|
2 | .\" Copyright (c) 1996 Thinking Machines Corporation |
---|
3 | .TH MPI_Abort 3 "Dec 08, 2009" "1.4" "Open MPI" |
---|
4 | .SH NAME |
---|
5 | \fBMPI_Abort\fP \- Terminates MPI execution environment. |
---|
6 | |
---|
7 | .SH SYNTAX |
---|
8 | .ft R |
---|
9 | .SH C Syntax |
---|
10 | .nf |
---|
11 | #include <mpi.h> |
---|
12 | int MPI_Abort(MPI_Comm \fIcomm\fP, int\fI errorcode\fP) |
---|
13 | |
---|
14 | .SH Fortran Syntax |
---|
15 | .ft R |
---|
16 | .nf |
---|
17 | INCLUDE 'mpif.h' |
---|
18 | MPI_ABORT(\fICOMM\fP, \fIERRORCODE\fP, \fIIERROR\fP) |
---|
19 | INTEGER \fICOMM\fP,\fI ERRORCODE\fP,\fI IERROR |
---|
20 | |
---|
21 | .SH C++ Syntax |
---|
22 | .nf |
---|
23 | #include <mpi.h> |
---|
24 | void Comm::Abort(int \fIerrorcode\fP) |
---|
25 | |
---|
26 | .SH INPUT PARAMETERS |
---|
27 | .ft R |
---|
28 | .TP 1i |
---|
29 | comm |
---|
30 | Communicator of tasks to abort. |
---|
31 | .TP 1i |
---|
32 | errorcode |
---|
33 | Error code to return to invoking environment. |
---|
34 | |
---|
35 | .SH OUTPUT PARAMETER |
---|
36 | .ft R |
---|
37 | .TP 1i |
---|
38 | IERROR |
---|
39 | Fortran only: Error status (integer). |
---|
40 | |
---|
41 | .SH DESCRIPTION |
---|
42 | .ft R |
---|
43 | This routine makes a "best attempt" to abort all tasks in the group of |
---|
44 | comm. This function does not require that the invoking environment take any |
---|
45 | action with the error code. However, a UNIX or POSIX |
---|
46 | environment should handle this as a return errorcode from the main program |
---|
47 | or an abort (errorcode). |
---|
48 | .sp |
---|
49 | The Open MPI implementation terminates all processes in all tasks that contain a process in \fIcomm\fP, and the error code is not returned to the invoking environment. |
---|
50 | .sp |
---|
51 | Note: All associated processes are sent a SIGTERM. |
---|
52 | |
---|
53 | .SH ERRORS |
---|
54 | Almost all MPI routines return an error value; C routines as the value of the function and Fortran routines in the last argument. C++ functions do not return errors. If the default error handler is set to MPI::ERRORS_THROW_EXCEPTIONS, then on error the C++ exception mechanism will be used to throw an MPI:Exception object. |
---|
55 | .sp |
---|
56 | Before the error value is returned, the current MPI error handler is |
---|
57 | called. By default, this error handler aborts the MPI job, except for I/O function errors. The error handler |
---|
58 | may be changed with MPI_Comm_set_errhandler; 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. |
---|
59 | |
---|