Open MPI logo

MPI_Abort(3) man page (version 1.8)

  |   Home   |   Support   |   FAQ   |  

« Return to documentation listing

Table of Contents

Name

MPI_Abort - Terminates MPI execution environment.

Syntax

C Syntax


#include <mpi.h>
int MPI_Abort(MPI_Comm comm, int errorcode)

Fortran Syntax


INCLUDE ’mpif.h’
MPI_ABORT(COMM, ERRORCODE, IERROR)            
    INTEGER        COMM, ERRORCODE, IERROR

C++ Syntax


#include <mpi.h>
void Comm::Abort(int errorcode)

Java Syntax


import mpi.*;
void MPI.Abort(int errorcode)

Input Parameters

comm
Communicator of tasks to abort.
errorcode
Error code to return to invoking environment.

Output Parameter

IERROR
Fortran only: Error status (integer).

Description

This routine makes a "best attempt" to abort all tasks in the group of comm. This function does not require that the invoking environment take any action with the error code. However, a UNIX or POSIX environment should handle this as a return errorcode from the main program or an abort (errorcode).

The long-term goal of the Open MPI implementation is to terminate all processes in all tasks that contain a process in comm, and the error code is not returned to the invoking environment. At the moment, this isn’t fully implemented and MPI_Abort will terminate the entire job. The Java implementation currently does not allow specification of a communicator and aborts the entire job - this will be updated to support the long-term implementation at a later date.

Note: All associated processes are sent a SIGTERM.

Errors

Almost all MPI routines return an error value; C routines as the value of the function and Fortran routines in the last argument. C++ and Java 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 - similar behavior is followed by Java.

Before the error value is returned, the current MPI error handler is called. By default, this error handler aborts the MPI job, except for I/O function errors. The error handler 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.


Table of Contents

« Return to documentation listing