Synopsis
int MPI_Reduce_scatter_block(const void *sendbuf, void *recvbuf, int recvcount,
MPI_Datatype datatype, MPI_Op op, MPI_Comm comm)
int MPI_Reduce_scatter_block_c(const void *sendbuf, void *recvbuf,
MPI_Count recvcount, MPI_Datatype datatype,
MPI_Op op, MPI_Comm comm)
Input Parameters
- sendbuf
-
starting address of send buffer (choice)
- recvcount
-
element count per block (non-negative integer)
- datatype
-
data type of elements of send and receive buffers (handle)
- op
-
operation (handle)
- comm
-
communicator (handle)
Output Parameters
- recvbuf
-
starting address of receive buffer (choice)
Description
MPI_Reduce_scatter_block is a collective All-To-All operation that combines a global element-wise reduction with a scatter of equal-sized blocks to all processes.
If comm is an intra-communicator, the function first performs a global reduction on vectors of n*recvcount elements using op, where n is the number of processes in the group. The resulting vector is divided into n consecutive blocks of recvcount elements each, and the i-th block is sent to process i. All group members must call the routine using the same arguments for recvcount, datatype, op, and comm. The in-place option for intra-communicators is specified by passing MPI_IN_PLACE in sendbuf on all processes, in which case input data is taken from the receive buffer. If comm is an inter-communicator, the result of the reduction of data provided by processes in one group is scattered among processes in the other group and vice versa, and the number of elements must be the same for the two groups. Collective operations 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.
Notes on collective operations
The reduction functions ('MPI_Op') do not return an error value. As a result, if the functions detect an error, all they can do is either call 'MPI_Abort' or silently skip the problem. Thus, 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.
The reason for this is the performance problems in ensuring that all collective routines return the same error value.
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_OP - Invalid operation. MPI operations (objects of type 'MPI_Op') must either be one of the predefined operations (e.g., 'MPI_SUM') or created with 'MPI_Op_create'.
-
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.