Login or Register to Ask a Question and Join Our Community

Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

mpi_comm_set_errhandler(3) [redhat man page]

MPI_Comm_set_errhandler(3)                                              MPI                                             MPI_Comm_set_errhandler(3)

NAME

       MPI_Comm_set_errhandler -  Set the error handler for a communicator

SYNOPSIS

       int MPI_Comm_set_errhandler(MPI_Comm comm, MPI_Errhandler errhandler)

INPUT PARAMETERS

       comm   - communicator (handle)
       errhandler
              - new error handler for communicator (handle)

THREAD AND INTERRUPT SAFETY

       This  routine is thread and interrupt safe only if no MPI routine that updates or frees the same MPI object may be called concurrently with
       this routine.

       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.

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.
       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.

SEE ALSO

       MPI_Comm_get_errhandler, MPI_Comm_call_errhandler

LOCATION

       comm_set_errhandler.c

                                                                     8/3/2010                                           MPI_Comm_set_errhandler(3)

Check Out this Related Man Page

MPI_Comm_create_errhandler(3)						MPI					     MPI_Comm_create_errhandler(3)

NAME

       MPI_Comm_create_errhandler -  Create a communicator error handler

SYNOPSIS

       int MPI_Comm_create_errhandler(MPI_Comm_errhandler_function *function,
				      MPI_Errhandler *errhandler)

INPUT PARAMETER

       function
	      - user defined error handling procedure (function)

OUTPUT PARAMETER

       errhandler
	      - MPI error handler (handle)

THREAD AND INTERRUPT SAFETY

       This  routine  is  thread-safe.	This means that this routine may be safely used by multiple threads without the need for any user-provided
       thread locks.  However, the routine is not interrupt safe.  Typically, this is due to the use of memory allocation routines such as  malloc
       or other non-MPICH runtime routines that are themselves not interrupt-safe.

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.
       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.

LOCATION

       comm_create_errhandler.c

								     7/27/2010					     MPI_Comm_create_errhandler(3)
Man Page