|
Packit Service |
c5cf8c |
|
|
Packit Service |
c5cf8c |
<HTML>
|
|
Packit Service |
c5cf8c |
<HEAD>
|
|
Packit Service |
c5cf8c |
<META NAME="GENERATOR" CONTENT="DOCTEXT">
|
|
Packit Service |
c5cf8c |
<TITLE>MPI_Compare_and_swap</TITLE>
|
|
Packit Service |
c5cf8c |
</HEAD>
|
|
Packit Service |
c5cf8c |
<BODY BGCOLOR="FFFFFF">
|
|
Packit Service |
c5cf8c |
MPI_Compare_and_swap
|
|
Packit Service |
c5cf8c |
Perform one-sided atomic compare-and-swap.
|
|
Packit Service |
c5cf8c |
Synopsis
|
|
Packit Service |
c5cf8c |
|
|
Packit Service |
c5cf8c |
int MPI_Compare_and_swap(const void *origin_addr, const void *compare_addr,
|
|
Packit Service |
c5cf8c |
void *result_addr, MPI_Datatype datatype, int target_rank,
|
|
Packit Service |
c5cf8c |
MPI_Aint target_disp, MPI_Win win)
|
|
Packit Service |
c5cf8c |
|
|
Packit Service |
c5cf8c |
|
|
Packit Service |
c5cf8c |
This function compares one element of type datatype in the compare buffer
|
|
Packit Service |
c5cf8c |
compare_addr with the buffer at offset target_disp in the target window
|
|
Packit Service |
c5cf8c |
specified by target_rank and win and replaces the value at the target with the
|
|
Packit Service |
c5cf8c |
value in the origin buffer origin_addr if the compare buffer and the target
|
|
Packit Service |
c5cf8c |
buffer are identical. The original value at the target is returned in the
|
|
Packit Service |
c5cf8c |
buffer result_addr.
|
|
Packit Service |
c5cf8c |
|
|
Packit Service |
c5cf8c |
Input Parameters
|
|
Packit Service |
c5cf8c |
|
|
Packit Service |
c5cf8c |
origin_addr initial address of buffer (choice)
|
|
Packit Service |
c5cf8c |
|
|
Packit Service |
c5cf8c |
compare_addr initial address of compare buffer (choice)
|
|
Packit Service |
c5cf8c |
|
|
Packit Service |
c5cf8c |
result_addr initial address of result buffer (choice)
|
|
Packit Service |
c5cf8c |
|
|
Packit Service |
c5cf8c |
datatype datatype of the entry in origin, result, and target buffers (handle)
|
|
Packit Service |
c5cf8c |
|
|
Packit Service |
c5cf8c |
target_rank rank of target (nonnegative integer)
|
|
Packit Service |
c5cf8c |
|
|
Packit Service |
c5cf8c |
target_disp displacement from start of window to beginning of target buffer (non-negative integer)
|
|
Packit Service |
c5cf8c |
|
|
Packit Service |
c5cf8c |
win window object (handle)
|
|
Packit Service |
c5cf8c |
|
|
Packit Service |
c5cf8c |
|
|
Packit Service |
c5cf8c |
Notes
|
|
Packit Service |
c5cf8c |
This operation is atomic with respect to other "accumulate" operations.
|
|
Packit Service |
c5cf8c |
|
|
Packit Service |
c5cf8c |
The parameter datatype must belong to one of the following categories of
|
|
Packit Service |
c5cf8c |
predefined datatypes: C integer, Fortran integer, Logical, Multi-language
|
|
Packit Service |
c5cf8c |
types, or Byte as specified in Section 5.9.2 on page 176. The origin and result
|
|
Packit Service |
c5cf8c |
buffers (origin_addr and result_addr) must be disjoint.
|
|
Packit Service |
c5cf8c |
|
|
Packit Service |
c5cf8c |
Notes for Fortran
|
|
Packit Service |
c5cf8c |
All MPI routines in Fortran (except for <tt>MPI_WTIME</tt> and <tt>MPI_WTICK</tt>) have
|
|
Packit Service |
c5cf8c |
an additional argument <tt>ierr</tt> at the end of the argument list. <tt>ierr
|
|
Packit Service |
c5cf8c |
</tt>is an integer and has the same meaning as the return value of the routine
|
|
Packit Service |
c5cf8c |
in C. In Fortran, MPI routines are subroutines, and are invoked with the
|
|
Packit Service |
c5cf8c |
<tt>call</tt> statement.
|
|
Packit Service |
c5cf8c |
|
|
Packit Service |
c5cf8c |
All MPI objects (e.g., <tt>MPI_Datatype</tt>, <tt>MPI_Comm</tt>) are of type <tt>INTEGER
|
|
Packit Service |
c5cf8c |
</tt>in Fortran.
|
|
Packit Service |
c5cf8c |
|
|
Packit Service |
c5cf8c |
Errors
|
|
Packit Service |
c5cf8c |
|
|
Packit Service |
c5cf8c |
All MPI routines (except <tt>MPI_Wtime</tt> and <tt>MPI_Wtick</tt>) return an error value;
|
|
Packit Service |
c5cf8c |
C routines as the value of the function and Fortran routines in the last
|
|
Packit Service |
c5cf8c |
argument. Before the value is returned, the current MPI error handler is
|
|
Packit Service |
c5cf8c |
called. By default, this error handler aborts the MPI job. The error handler
|
|
Packit Service |
c5cf8c |
may be changed with <tt>MPI_Comm_set_errhandler</tt> (for communicators),
|
|
Packit Service |
c5cf8c |
<tt>MPI_File_set_errhandler</tt> (for files), and <tt>MPI_Win_set_errhandler</tt> (for
|
|
Packit Service |
c5cf8c |
RMA windows). The MPI-1 routine <tt>MPI_Errhandler_set</tt> may be used but
|
|
Packit Service |
c5cf8c |
its use is deprecated. The predefined error handler
|
|
Packit Service |
c5cf8c |
<tt>MPI_ERRORS_RETURN</tt> may be used to cause error values to be returned.
|
|
Packit Service |
c5cf8c |
Note that MPI does not guarentee that an MPI program can continue past
|
|
Packit Service |
c5cf8c |
an error; however, MPI implementations will attempt to continue whenever
|
|
Packit Service |
c5cf8c |
possible.
|
|
Packit Service |
c5cf8c |
|
|
Packit Service |
c5cf8c |
|
|
Packit Service |
c5cf8c |
MPI_SUCCESS No error; MPI routine completed successfully.
|
|
Packit Service |
c5cf8c |
|
|
Packit Service |
c5cf8c |
|
|
Packit Service |
c5cf8c |
MPI_ERR_ARG Invalid argument. Some argument is invalid and is not
|
|
Packit Service |
c5cf8c |
identified by a specific error class (e.g., <tt>MPI_ERR_RANK</tt>).
|
|
Packit Service |
c5cf8c |
|
|
Packit Service |
c5cf8c |
|
|
Packit Service |
c5cf8c |
MPI_ERR_COUNT Invalid count argument. Count arguments must be
|
|
Packit Service |
c5cf8c |
non-negative; a count of zero is often valid.
|
|
Packit Service |
c5cf8c |
|
|
Packit Service |
c5cf8c |
|
|
Packit Service |
c5cf8c |
MPI_ERR_OP Invalid operation. MPI operations (objects of type <tt>MPI_Op</tt>)
|
|
Packit Service |
c5cf8c |
must either be one of the predefined operations (e.g., <tt>MPI_SUM</tt>) or
|
|
Packit Service |
c5cf8c |
created with <tt>MPI_Op_create</tt>.
|
|
Packit Service |
c5cf8c |
|
|
Packit Service |
c5cf8c |
|
|
Packit Service |
c5cf8c |
MPI_ERR_RANK Invalid source or destination rank. Ranks must be between
|
|
Packit Service |
c5cf8c |
zero and the size of the communicator minus one; ranks in a receive
|
|
Packit Service |
c5cf8c |
(<tt>MPI_Recv</tt>, <tt>MPI_Irecv</tt>, <tt>MPI_Sendrecv</tt>, etc.) may also be <tt>MPI_ANY_SOURCE</tt>.
|
|
Packit Service |
c5cf8c |
|
|
Packit Service |
c5cf8c |
|
|
Packit Service |
c5cf8c |
MPI_ERR_TYPE Invalid datatype argument. Additionally, this error can
|
|
Packit Service |
c5cf8c |
occur if an uncommitted MPI_Datatype (see <tt>MPI_Type_commit</tt>) is used
|
|
Packit Service |
c5cf8c |
in a communication call.
|
|
Packit Service |
c5cf8c |
|
|
Packit Service |
c5cf8c |
|
|
Packit Service |
c5cf8c |
MPI_ERR_WIN Invalid MPI window object
|
|
Packit Service |
c5cf8c |
|
|
Packit Service |
c5cf8c |
</BODY></HTML>
|