Lockless Inc

NAME

MPI_Barrier - Conduct a barrier synchronization operation on a communicator

SYNOPSIS

#include <mpi.h> int MPI_Barrier(MPI_Comm *comm );

#include <pmpi.h> int PMPI_Barrier(MPI_Comm *comm );

#include <mpi.h> void MPI::Comm::Barrier(void) const;

INCLUDE 'mpif.h' MPI_BARRIER(comm , ierr ) INTEGER comm , ierr

INPUT PARAMETER

comm - communicator to synchronize (handle)

DESCRIPTION

The MPI_Barrier() function is used to wait until all processes that are members of the communicator, comm to call this function. Once they do, all are woken up and they continue beyond the barrier.

The communicator must be a valid one (not MPI_COMM_NULL). PMPI_Barrier() is the profiling version of this function.

ERRORS

All MPI routines except for MPI_Wtime and MPI_Wtick return an error code. The the current MPI error handler is invoked if the return value is not MPI_SUCCESS. The default error handler aborts, but this may be changed with by using the MPI_Errhandler_set() function. The predefined error handler MPI_ERRORS_RETURN may be used to cause error values to be returned instead. Note that MPI does not guarentee that an MPI program can continue past an error. In this implementation, all errors except MPI_ERR_INTERN or MPI_ERR_OTHER should always be recoverable.

In C, the error code is passed as the return value. In FORTRAN, all functions have an parameter ierr which returns the error code. MPI C++ functions do not directly return an error code. However, C++ users may want to use the MPI::ERRORS_THROW_EXCEPTIONS handler. This will throw an MPI::Exception with the corresponding error code. To prevent exceptions from being raised from within C and Fortran code, they will see all error return values as MPI_ERR_PENDING when this handler is chosen. In this implementation, call MPI::throw_exception() to throw the correct exception if this occurs.

MPI_SUCCESS - No error;

MPI_ERR_PENDING - Pending exception;

MPI_ERR_COMM - Invalid communicator;

MPI_ERR_INTERN - Out of Memory. This may be fatal.

SEE ALSO

MPI_Bcast (3) MPI_Gather (3) MPI_Scatter (3) MPI_Alltoall (3)

About Us Returns Policy Privacy Policy Send us Feedback
Company Info | Product Index | Category Index | Help | Terms of Use
Copyright © Lockless Inc All Rights Reserved.