MPI_BCAST_INIT(3)
π MPI_BCAST_INIT(3) β the Open MPI glow-up π
okay bestie, welcome to the Open MPI manual, section 3. This page is filed under MPI_BCAST_INIT(3) but the actual stars of the show are MPI_Bcast and MPI_Ibcast, and they're about one thing and one thing only: broadcasting a message from the process with rank root to all the other processes in the group. iconic behaviour, honestly.
β¨ SYNTAX β¨
π©· C Syntax
#include <mpi.h>
int MPI_Bcast(void *buffer, int count, MPI_Datatype datatype,
int root, MPI_Comm comm)
int MPI_Ibcast(void *buffer, int count, MPI_Datatype datatype,
int root, MPI_Comm comm, MPI_Request *request)
π©· Fortran Syntax
USE MPI
! or the older form: INCLUDE 'mpif.h'
MPI_BCAST(BUFFER, COUNT, DATATYPE, ROOT, COMM, IERROR)
<type> BUFFER(*)
INTEGER COUNT, DATATYPE, ROOT, COMM, IERROR
MPI_IBCAST(BUFFER, COUNT, DATATYPE, ROOT, COMM, REQUEST, IERROR)
<type> BUFFER(*)
INTEGER COUNT, DATATYPE, ROOT, COMM, REQUEST, IERROR
π©· Fortran 2008 Syntax
USE mpi_f08
MPI_Bcast(buffer, count, datatype, root, comm, ierror)
TYPE(*), DIMENSION(..) :: buffer
INTEGER, INTENT(IN) :: count, root
TYPE(MPI_Datatype), INTENT(IN) :: datatype
TYPE(MPI_Comm), INTENT(IN) :: comm
INTEGER, OPTIONAL, INTENT(OUT) :: ierror
MPI_Ibcast(buffer, count, datatype, root, comm, request, ierror)
TYPE(*), DIMENSION(..), ASYNCHRONOUS :: buffer
INTEGER, INTENT(IN) :: count, root
TYPE(MPI_Datatype), INTENT(IN) :: datatype
TYPE(MPI_Comm), INTENT(IN) :: comm
TYPE(MPI_Request), INTENT(OUT) :: request
INTEGER, OPTIONAL, INTENT(OUT) :: ierror
πΈ INPUT/OUTPUT PARAMETERS πΈ
bufferβ starting address of the buffer (a choice, so it can be whatever type you're moving π ).countβ number of entries inbuffer(an integer).datatypeβ data type ofbuffer(a handle).rootβ rank of the broadcast root (an integer). the main character of this whole operation tbh π.commβ communicator (a handle).
π OUTPUT PARAMETERS π
requestβ request (a handle, non-blocking only β so this one's just forMPI_Ibcast, bestie).ierrorβ Fortran only: error status (an integer).
π DESCRIPTION π
MPI_Bcast broadcasts a message from the process with rank root to all processes of the group β itself included, because obviously she's part of the group too πββοΈ. Every member of the group calls it, using the same arguments for comm and root. When it returns, the contents of root's communication buffer have been copied to all processes. that's the whole vibe. periodt.
General, derived datatypes are allowed for datatype. The type signature of count, datatype on any process must be equal to the type signature of count, datatype at the root. This implies that the amount of data sent must be equal to the amount received, pairwise between each process and the root. MPI_Bcast and all other data-movement collective routines make this restriction. Distinct type maps between sender and receiver are still allowed, so you're not fully boxed in π.
Example: broadcast 100 ints from process 0 to every process in the group.
MPI_Comm comm;
int array[100];
int root=0;
//...
MPI_Bcast( array, 100, MPI_INT, root, comm);
As in many of our sample code fragments, we assume that some of the variables (such as comm in the example above) have been assigned appropriate values.
π¦ WHEN COMMUNICATOR IS AN INTER-COMMUNICATOR π¦
When the communicator is an inter-communicator, the root process in the first group broadcasts data to all the processes in the second group. The first group defines the root process.
- That root process uses
MPI_ROOTas the value of itsrootargument. - The remaining processes use
MPI_PROC_NULLas the value of theirrootargument. - All processes in the second group use the rank of that root process in the first group as the value of their
rootargument.
The receive buffer arguments of the processes in the second group must be consistent with the send buffer argument of the root process in the first group. no cap. π«Ά
π NOTES π
heads up bestie: this function does not support the in-place option. at all. don't try it.
π ERRORS π
Almost all MPI routines return an error value; C routines as the return result of the function, and Fortran routines in the last argument.
Before the error value is returned, the current MPI error handler associated with the communication object (e.g., communicator, window, file) is called. If no communication object is associated with the MPI call, then the call is considered attached to MPI_COMM_SELF and will call the associated MPI error handler. When MPI_COMM_SELF is not initialized (i.e., before MPI_Init/MPI_Init_thread, after MPI_Finalize, or when using the Sessions Model exclusively) the error raises the initial error handler. The initial error handler can be changed by calling MPI_Comm_set_errhandler on MPI_COMM_SELF when using the World model, or the mpi_initial_errhandler CLI argument to mpiexec or info key to MPI_Comm_spawn/MPI_Comm_spawn_multiple. If no other appropriate error handler has been set, then the MPI_ERRORS_RETURN error handler is called for MPI I/O functions and the MPI_ERRORS_ABORT error handler is called for all other MPI functions.
Open MPI includes three predefined error handlers that can be used:
MPI_ERRORS_ARE_FATALβ causes the program to abort all connected MPI processes. πMPI_ERRORS_ABORTβ an error handler that can be invoked on a communicator, window, file, or session. When called on a communicator, it acts as ifMPI_Abortwas called on that communicator. If called on a window or file, it acts as ifMPI_Abortwas called on a communicator containing the group of processes in the corresponding window or file. If called on a session, it aborts only the local process.MPI_ERRORS_RETURNβ returns an error code to the application.
MPI applications can also implement their own error handlers by calling:
MPI_Comm_create_errhandlerthenMPI_Comm_set_errhandlerMPI_File_create_errhandlerthenMPI_File_set_errhandlerMPI_Session_create_errhandlerthenMPI_Session_set_errhandleror atMPI_Session_initMPI_Win_create_errhandlerthenMPI_Win_set_errhandler
Note that MPI does not guarantee that an MPI program can continue past an error. π
See the MPI man page for a full list of MPI error codes.
See the Error Handling section of the MPI-3.1 standard for more information.
π COPYRIGHT π
Copyright 2003-2026, The Open MPI Community
and that's the whole page, bestie π this was the MPI_BCAST_INIT(3) page from the Open MPI manual, dated Sep 10, 2026, brought to you by the Open MPI Community (copyright 2003-2026) π go forth and broadcast, you absolute icon β¨π¦π
π¦ where this page comes from
- ubuntu stonking: openmpi-doc 5.0.10-6 Β· other
- π girlified by deepseek-ai/DeepSeek-V4.1-Flash on : a language model's rewrite of the original, under its terms