Synopsis
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)
int MPI_Reduce_scatter_block_init_c(const void *sendbuf, void *recvbuf,
MPI_Count recvcount, MPI_Datatype datatype,
MPI_Op op, MPI_Comm comm, MPI_Info info,
MPI_Request *request)
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)
- info
-
info argument (handle)
Output Parameters
- recvbuf
-
starting address of receive buffer (choice)
- request
-
communication request (handle)
Description
MPI_Reduce_scatter_block_init creates a persistent collective communication request for the reduce-scatter operation with equal-sized blocks, an All-To-All collective that performs a global element-wise reduction and scatters the result in equal blocks to all processes.
This initialization call is nonlocal and all processes in the group must call collective routines in the same order. The returned request is initially inactive and may be started zero or more times using MPI_START or MPI_STARTALL. Once initialized, persistent collective operations may be started in any order across processes in the communicator. For inter-communicators, the result of the reduction of data provided by processes in one group is scattered among processes in the other group, and vice versa. The MPI_IN_PLACE option for intra-communicators is specified by passing MPI_IN_PLACE as sendbuf at all processes. Persistent collective operations cannot be matched with blocking or nonblocking collective operations, and it is erroneous to use MPI_CANCEL on a persistent collective request. In multithreaded implementations, the same communicator is not to be used concurrently by two different collective communication initialization calls at the same process.
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_ARG - Invalid argument. Some argument is invalid and is not identified by a specific error class (e.g., 'MPI_ERR_RANK').
-
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_INFO - Invalid Info
-
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.