Synopsis

int MPI_Barrier(MPI_Comm comm)

Input Parameters

comm

communicator (handle)

Description

MPI_Barrier performs barrier synchronization across all members of a group. If comm is an intra-communicator, the call blocks the caller until all group members have called it, returning at any process only after all group members have entered the call. If comm is an inter-communicator, the call involves two groups and returns at processes in one group only after all members of the other group have entered the call, and vice versa. A process may return from the call before all processes in its own group have entered when using an inter-communicator. MPI_Barrier is classified as an All-To-All collective operation.

In multithreaded implementations, it is the user’s responsibility to ensure that the same communicator is not used concurrently by two different collective communication initialization calls at the same process. A collective communication may or may not have the effect of synchronizing all participating processes; programs are recommended to avoid relying on synchronization side-effects for correctness. Programs must allow for the fact that a collective call may be synchronizing.

Notes

Blocks the caller until all processes in the communicator have called it; that is, the call returns at any process only after all members of the communicator have entered the call.

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