MPI_IREDUCE_SCATTER_BLOCK(3)

📦

version 5.0.10 · 4 versions

💅 MPI_IREDUCE_SCATTER_BLOCK — Open MPI man page, bestie edition ✨

okay so hi, welcome to MPI_IREDUCE_SCATTER_BLOCK(3) from the Open MPI manual, and no this is not boring I promise, because this little function is out here combining values and scattering the results in blocks and honestly? slay. 🎀

The whole squad is:

MPI_Reduce_scatter_block
MPI_Ireduce_scatter_block
MPI_Reduce_scatter_block_init

🦋 SYNTAX 🦋

C Syntax

#include <mpi.h>

int MPI_Reduce_scatter_block(const void *sendbuf, void *recvbuf, int recvcount,
     MPI_Datatype datatype, MPI_Op op, MPI_Comm comm)

int MPI_Ireduce_scatter_block(const void *sendbuf, void *recvbuf, int recvcount,
     MPI_Datatype datatype, MPI_Op op, MPI_Comm comm, MPI_Request *request)

int MPI_Reduce_scatter_block_init(const void *sendbuf, void *recvbuf, int recvcount,
     MPI_Datatype datatype, MPI_Op op, MPI_Comm comm, MPI_Info info, MPI_Request *request)

Fortran Syntax

USE MPI
! or the older form: INCLUDE 'mpif.h'
MPI_REDUCE_SCATTER_BLOCK(SENDBUF, RECVBUF, RECVCOUNT, DATATYPE, OP,
             COMM, IERROR)
     <type>  SENDBUF(*), RECVBUF(*)
     INTEGER RECVCOUNT, DATATYPE, OP, COMM, IERROR

MPI_IREDUCE_SCATTER_BLOCK(SENDBUF, RECVBUF, RECVCOUNT, DATATYPE, OP,
             COMM, REQUEST, IERROR)
     <type>  SENDBUF(*), RECVBUF(*)
     INTEGER RECVCOUNT, DATATYPE, OP, COMM, REQUEST, IERROR

MPI_REDUCE_SCATTER_BLOCK_INOT(SENDBUF, RECVBUF, RECVCOUNT, DATATYPE, OP,
             COMM, INFO, REQUEST, IERROR)
     <type>  SENDBUF(*), RECVBUF(*)
     INTEGER RECVCOUNT, DATATYPE, OP, COMM, INFO, REQUEST, IERROR

yes bestie, MPI_REDUCE_SCATTER_BLOCK_INOT is written exactly like that in the original. i am simply the messenger 💌

Fortran 2008 Syntax

USE mpi_f08
MPI_Ireduce_scatter_block(sendbuf, recvbuf, recvcount, datatype, op, comm,
             ierror)
     TYPE(*), DIMENSION(..), INTENT(IN), ASYNCHRONOUS :: sendbuf
     TYPE(*), DIMENSION(..), ASYNCHRONOUS :: recvbuf
     INTEGER, INTENT(IN) :: recvcount
     TYPE(MPI_Datatype), INTENT(IN) :: datatype
     TYPE(MPI_Op), INTENT(IN) :: op
     TYPE(MPI_Comm), INTENT(IN) :: comm
     INTEGER, OPTIONAL, INTENT(OUT) :: ierror

MPI_Ireduce_scatter_block(sendbuf, recvbuf, recvcount, datatype, op, comm,
             request, ierror)
     TYPE(*), DIMENSION(..), INTENT(IN), ASYNCHRONOUS :: sendbuf
     TYPE(*), DIMENSION(..), ASYNCHRONOUS :: recvbuf
     INTEGER, INTENT(IN) :: recvcount
     TYPE(MPI_Datatype), INTENT(IN) :: datatype
     TYPE(MPI_Op), INTENT(IN) :: op
     TYPE(MPI_Comm), INTENT(IN) :: comm
     TYPE(MPI_Request), INTENT(OUT) :: request
     INTEGER, OPTIONAL, INTENT(OUT) :: ierror

MPI_Reduce_scatter_block_init(sendbuf, recvbuf, recvcount, datatype, op, comm,
             info, request, ierror)
     TYPE(*), DIMENSION(..), INTENT(IN), ASYNCHRONOUS :: sendbuf
     TYPE(*), DIMENSION(..), ASYNCHRONOUS :: recvbuf
     INTEGER, INTENT(IN) :: recvcount
     TYPE(MPI_Datatype), INTENT(IN) :: datatype
     TYPE(MPI_Op), INTENT(IN) :: op
     TYPE(MPI_Comm), INTENT(IN) :: comm
     TYPE(MPI_Info), INTENT(IN) :: info
     TYPE(MPI_Request), INTENT(OUT) :: request
     INTEGER, OPTIONAL, INTENT(OUT) :: ierror

🌸 INPUT PARAMETERS 🌸

sendbuf — the starting address of the send buffer, it's a choice bestie. 🫶
recvcount — element count per block, and it has to be a non-negative integer. no negatives, we don't do that here. 🙈
datatype — datatype of the elements in the input buffer. it's a handle. 💜
op — the operation. also a handle. 🔥
comm — the communicator. handle again, we love a handle. 👑
info — the info. a handle, and it's persistent only. ✨

💖 OUTPUT PARAMETERS 💖

recvbuf — starting address of the receive buffer (choice). 🎀
request — the request (handle, non-blocking only).
ierror — Fortran only: error status (integer). 😭

🌈 DESCRIPTION 🌈

So here's the vibe. MPI_Reduce_scatter_block starts off by doing an element-wise reduction on a vector of count = n * recvcount elements in the send buffer, and that send buffer is defined by sendbuf, count, and datatype, using the operation op — where n is the number of processes in the group of comm. 🧚

Then, next up, that resulting vector of results gets split into n disjoint segments, where n is the number of processes in the group. Every one of those segments contains recvcount elements. The ith segment gets sent to process i and stored in the receive buffer, which is defined by recvbuf, recvcount, and datatype. iconic behaviour, honestly. 💅

🍓 USE OF IN-PLACE OPTION 🍓

When the communicator is an intracommunicator, you can do a reduce-scatter operation in-place, meaning the output buffer is used as the input buffer. 🫶

To do it, use the variable MPI_IN_PLACE as the value of the sendbuf. In this case, the input data is taken from the top of the receive buffer. And heads up: the area occupied by the input data may be either longer or shorter than the data filled by the output data. ⭐

🦄 WHEN COMMUNICATOR IS AN INTER-COMMUNICATOR 🦄

When the communicator is an inter-communicator, the reduce-scatter operation happens in two phases, bestie, buckle up:

First, the result of the reduction performed on the data provided by the processes in the first group is scattered among the processes in the second group.
Then the reverse occurs: the reduction performed on the data provided by the processes in the second group is scattered among the processes in the first group.

For each group, all processes provide the same recvcounts argument, and the sum of the recvcounts values should be the same for both groups. no cap. 🔥

👑 NOTES ON COLLECTIVE OPERATIONS 👑

Okay so this part is lowkey important. The reduction functions (MPI_Op) do not return an error value. So if these functions detect an error, all they can do is either call MPI_Abort or silently skip the problem. 😭

So if you change the error handler from MPI_ERRORS_ARE_FATAL to something else — for example, MPI_ERRORS_RETURN — then no error may be indicated. yes fr, it'll just be quiet about it. 💀

And why? The reason for this is the performance problems in ensuring that all collective routines return the same error value. that's it, that's the tea. 🫖

✨ 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. periodt. 💅

Before that error value is returned, the current MPI error handler associated with the communication object (e.g., communicator, window, file) gets 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. That 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 if MPI_Abort was called on that communicator. If called on a window or file, it acts as if MPI_Abort was called on a communicator containing the group of processes in the corresponding window or file. If called on a session, 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_errhandler then MPI_Comm_set_errhandler
MPI_File_create_errhandler then MPI_File_set_errhandler
MPI_Session_create_errhandler then MPI_Session_set_errhandler or at MPI_Session_init
MPI_Win_create_errhandler then MPI_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

2003-2026, The Open MPI Community

and that's the whole page bestie, mwah 💋 — this was the MPI_IREDUCE_SCATTER_BLOCK(3) page from the Open MPI manual, dated Sep 10, 2026, copyright 2003-2026, The Open MPI Community. go forth and reduce-scatter, 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 2026-11-03: a language model's rewrite of the original, under its terms