Synopsis
int MPI_Bcast(void *buffer, int count, MPI_Datatype datatype, int root,
MPI_Comm comm)
int MPI_Bcast_c(void *buffer, MPI_Count count, MPI_Datatype datatype, int root,
MPI_Comm comm)
Input Parameters
- count
-
number of entries in buffer (non-negative integer)
- datatype
-
data type of buffer (handle)
- root
-
rank of broadcast root (integer)
- comm
-
communicator (handle)
Input/Output Parameters
- buffer
-
starting address of buffer (choice)
Description
MPI_Bcast broadcasts a message from the process with rank root to all processes of the group, including itself.
If comm is an intra-communicator, all members of the group call the routine using the same arguments for comm and root, and on return, the content of the root’s buffer is copied to all other processes. If comm is an inter-communicator, all processes in the inter-communicator participate, with one group defining the root; processes in the other group pass the rank of the root in their root argument, the root passes MPI_ROOT, and all other processes in the root’s group pass MPI_PROC_NULL. The type signature of count and datatype on any process must be equal to the type signature at the root. Distinct type maps between sender and receiver are allowed. MPI_Bcast is a collective operation that may or may not have the effect of synchronizing all participating processes; programs are recommended to avoid relying on synchronization side-effects for correctness, while allowing for the fact that a collective call may be synchronizing.
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_BUFFER - Invalid buffer pointer. Usually a null buffer where one is not valid.
-
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_COUNT - Invalid count argument. Count arguments must be non-negative; a count of zero is often valid.
-
MPI_ERR_TYPE - Invalid datatype argument. Additionally, this error can occur if an uncommitted MPI_Datatype (see 'MPI_Type_commit') is used in a communication call.
-
MPI_ERR_OTHER - Other error; use 'MPI_Error_string' to get more information about this error code.