Synopsis
int MPI_Raccumulate(const void *origin_addr, int origin_count,
MPI_Datatype origin_datatype, int target_rank,
MPI_Aint target_disp, int target_count,
MPI_Datatype target_datatype, MPI_Op op, MPI_Win win,
MPI_Request *request)
int MPI_Raccumulate_c(const void *origin_addr, MPI_Count origin_count,
MPI_Datatype origin_datatype, int target_rank,
MPI_Aint target_disp, MPI_Count target_count,
MPI_Datatype target_datatype, MPI_Op op, MPI_Win win,
MPI_Request *request)
Input Parameters
- origin_addr
-
initial address of buffer (choice)
- origin_count
-
number of entries in buffer (non-negative integer)
- origin_datatype
-
datatype of each entry in origin buffer (handle)
- target_rank
-
rank of target (non-negative integer)
- target_disp
-
displacement from start of window to beginning of target buffer (non-negative integer)
- target_count
-
number of entries in target buffer (non-negative integer)
- target_datatype
-
datatype of each entry in target buffer (handle)
- op
-
reduce operation (handle)
- win
-
window object (handle)
Output Parameters
- request
-
RMA request (handle)
Description
MPI_Raccumulate is a nonblocking RMA operation that accumulates data from the origin buffer to the target window using a specified reduction operator and allocates a communication request object associated with the request handle. Request-based RMA operations are only valid within a passive target epoch and are not persistent. Completion of the operation at the origin via MPI_TEST or MPI_WAIT indicates the origin buffer is free to be updated, but does not indicate the operation has completed at the target window. Each datatype argument must be a predefined datatype or a derived datatype where all basic components are of the same predefined type, and both datatype arguments must be constructed from the same predefined datatype. The target_datatype may not specify overlapping entries, and the target buffer must fit in the target window. Any predefined operator for MPI_REDUCE or MPI_REPLACE may be specified as op; MPI_NO_OP cannot be used. MPI_PROC_NULL is a valid target_rank, resulting in no operation.
It is erroneous to call MPI_REQUEST_FREE or MPI_CANCEL for a request associated with an RMA operation.
Notes
The basic components of both the origin and target datatype must be the same
predefined datatype (e.g., all MPI_INT or all MPI_DOUBLE_PRECISION).
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_COUNT - Invalid count argument. Count arguments must be non-negative; a count of zero is often valid.
-
MPI_ERR_DISP - Invalid displacement argument
-
MPI_ERR_RANK - Invalid source or destination rank. Ranks must be between zero and the size of the communicator minus one; ranks in a receive ('MPI_Recv', 'MPI_Irecv', 'MPI_Sendrecv', etc.) may also be 'MPI_ANY_SOURCE'.
-
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_WIN - Invalid MPI window object
-
MPI_ERR_OTHER - Other error; use 'MPI_Error_string' to get more information about this error code.