|
Packit Service |
c5cf8c |
.TH MPI_Win_lock_all 3 "11/12/2019" " " "MPI"
|
|
Packit Service |
c5cf8c |
.SH NAME
|
|
Packit Service |
c5cf8c |
MPI_Win_lock_all \- Begin an RMA access epoch at all processes on the given window.
|
|
Packit Service |
c5cf8c |
.SH SYNOPSIS
|
|
Packit Service |
c5cf8c |
.nf
|
|
Packit Service |
c5cf8c |
int MPI_Win_lock_all(int assert, MPI_Win win)
|
|
Packit Service |
c5cf8c |
.fi
|
|
Packit Service |
c5cf8c |
|
|
Packit Service |
c5cf8c |
Starts an RMA access epoch to all processes in win, with a lock type of
|
|
Packit Service |
c5cf8c |
.I MPI_Lock_shared
|
|
Packit Service |
c5cf8c |
\&.
|
|
Packit Service |
c5cf8c |
During the epoch, the calling process can access the window
|
|
Packit Service |
c5cf8c |
memory on all processes in win by using RMA operations. A window locked with
|
|
Packit Service |
c5cf8c |
.I MPI_Win_lock_all
|
|
Packit Service |
c5cf8c |
must be unlocked with
|
|
Packit Service |
c5cf8c |
.I MPI_Win_unlock_all
|
|
Packit Service |
c5cf8c |
\&.
|
|
Packit Service |
c5cf8c |
This routine is not
|
|
Packit Service |
c5cf8c |
collective -- the ALL refers to a lock on all members of the group of the
|
|
Packit Service |
c5cf8c |
window.
|
|
Packit Service |
c5cf8c |
|
|
Packit Service |
c5cf8c |
.SH INPUT PARAMETERS
|
|
Packit Service |
c5cf8c |
.PD 0
|
|
Packit Service |
c5cf8c |
.TP
|
|
Packit Service |
c5cf8c |
.B assert
|
|
Packit Service |
c5cf8c |
- Used to optimize this call; zero may be used as a default.
|
|
Packit Service |
c5cf8c |
See notes. (integer)
|
|
Packit Service |
c5cf8c |
.PD 1
|
|
Packit Service |
c5cf8c |
.PD 0
|
|
Packit Service |
c5cf8c |
.TP
|
|
Packit Service |
c5cf8c |
.B win
|
|
Packit Service |
c5cf8c |
- window object (handle)
|
|
Packit Service |
c5cf8c |
.PD 1
|
|
Packit Service |
c5cf8c |
|
|
Packit Service |
c5cf8c |
.SH NOTES
|
|
Packit Service |
c5cf8c |
|
|
Packit Service |
c5cf8c |
This call is not collective.
|
|
Packit Service |
c5cf8c |
|
|
Packit Service |
c5cf8c |
The
|
|
Packit Service |
c5cf8c |
.I assert
|
|
Packit Service |
c5cf8c |
argument is used to indicate special conditions for the fence that
|
|
Packit Service |
c5cf8c |
an implementation may use to optimize the
|
|
Packit Service |
c5cf8c |
.I MPI_Win_lock_all
|
|
Packit Service |
c5cf8c |
operation. The
|
|
Packit Service |
c5cf8c |
value zero is always correct. Other assertion values may be or'ed together.
|
|
Packit Service |
c5cf8c |
Assertions that are valid for
|
|
Packit Service |
c5cf8c |
.I MPI_Win_lock_all
|
|
Packit Service |
c5cf8c |
are:
|
|
Packit Service |
c5cf8c |
|
|
Packit Service |
c5cf8c |
.PD 0
|
|
Packit Service |
c5cf8c |
.TP
|
|
Packit Service |
c5cf8c |
.B
|
|
Packit Service |
c5cf8c |
.I MPI_MODE_NOCHECK
|
|
Packit Service |
c5cf8c |
|
|
Packit Service |
c5cf8c |
- No other process holds, or will attempt to acquire a
|
|
Packit Service |
c5cf8c |
conflicting lock, while the caller holds the window lock. This is useful
|
|
Packit Service |
c5cf8c |
when mutual exclusion is achieved by other means, but the coherence
|
|
Packit Service |
c5cf8c |
operations that may be attached to the lock and unlock calls are still
|
|
Packit Service |
c5cf8c |
required.
|
|
Packit Service |
c5cf8c |
.PD 1
|
|
Packit Service |
c5cf8c |
|
|
Packit Service |
c5cf8c |
There may be additional overheads associated with using
|
|
Packit Service |
c5cf8c |
.I MPI_Win_lock
|
|
Packit Service |
c5cf8c |
and
|
|
Packit Service |
c5cf8c |
.I MPI_Win_lock_all
|
|
Packit Service |
c5cf8c |
concurrently on the same window. These overheads could be
|
|
Packit Service |
c5cf8c |
avoided by specifying the assertion
|
|
Packit Service |
c5cf8c |
.I MPI_MODE_NOCHECK
|
|
Packit Service |
c5cf8c |
when possible
|
|
Packit Service |
c5cf8c |
|
|
Packit Service |
c5cf8c |
.SH THREAD AND INTERRUPT SAFETY
|
|
Packit Service |
c5cf8c |
|
|
Packit Service |
c5cf8c |
This routine is thread-safe. This means that this routine may be
|
|
Packit Service |
c5cf8c |
safely used by multiple threads without the need for any user-provided
|
|
Packit Service |
c5cf8c |
thread locks. However, the routine is not interrupt safe. Typically,
|
|
Packit Service |
c5cf8c |
this is due to the use of memory allocation routines such as
|
|
Packit Service |
c5cf8c |
.I malloc
|
|
Packit Service |
c5cf8c |
or other non-MPICH runtime routines that are themselves not interrupt-safe.
|
|
Packit Service |
c5cf8c |
|
|
Packit Service |
c5cf8c |
.SH NOTES FOR FORTRAN
|
|
Packit Service |
c5cf8c |
All MPI routines in Fortran (except for
|
|
Packit Service |
c5cf8c |
.I MPI_WTIME
|
|
Packit Service |
c5cf8c |
and
|
|
Packit Service |
c5cf8c |
.I MPI_WTICK
|
|
Packit Service |
c5cf8c |
) have
|
|
Packit Service |
c5cf8c |
an additional argument
|
|
Packit Service |
c5cf8c |
.I ierr
|
|
Packit Service |
c5cf8c |
at the end of the argument list.
|
|
Packit Service |
c5cf8c |
.I ierr
|
|
Packit Service |
c5cf8c |
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 |
.I call
|
|
Packit Service |
c5cf8c |
statement.
|
|
Packit Service |
c5cf8c |
|
|
Packit Service |
c5cf8c |
All MPI objects (e.g.,
|
|
Packit Service |
c5cf8c |
.I MPI_Datatype
|
|
Packit Service |
c5cf8c |
,
|
|
Packit Service |
c5cf8c |
.I MPI_Comm
|
|
Packit Service |
c5cf8c |
) are of type
|
|
Packit Service |
c5cf8c |
.I INTEGER
|
|
Packit Service |
c5cf8c |
in Fortran.
|
|
Packit Service |
c5cf8c |
|
|
Packit Service |
c5cf8c |
.SH ERRORS
|
|
Packit Service |
c5cf8c |
|
|
Packit Service |
c5cf8c |
All MPI routines (except
|
|
Packit Service |
c5cf8c |
.I MPI_Wtime
|
|
Packit Service |
c5cf8c |
and
|
|
Packit Service |
c5cf8c |
.I MPI_Wtick
|
|
Packit Service |
c5cf8c |
) 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
|
|
Packit Service |
c5cf8c |
.I MPI_Comm_set_errhandler
|
|
Packit Service |
c5cf8c |
(for communicators),
|
|
Packit Service |
c5cf8c |
.I MPI_File_set_errhandler
|
|
Packit Service |
c5cf8c |
(for files), and
|
|
Packit Service |
c5cf8c |
.I MPI_Win_set_errhandler
|
|
Packit Service |
c5cf8c |
(for
|
|
Packit Service |
c5cf8c |
RMA windows). The MPI-1 routine
|
|
Packit Service |
c5cf8c |
.I MPI_Errhandler_set
|
|
Packit Service |
c5cf8c |
may be used but
|
|
Packit Service |
c5cf8c |
its use is deprecated. The predefined error handler
|
|
Packit Service |
c5cf8c |
.I MPI_ERRORS_RETURN
|
|
Packit Service |
c5cf8c |
may be used to cause error values to be returned.
|
|
Packit Service |
c5cf8c |
Note that MPI does
|
|
Packit Service |
c5cf8c |
.B not
|
|
Packit Service |
c5cf8c |
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 |
.PD 0
|
|
Packit Service |
c5cf8c |
.TP
|
|
Packit Service |
c5cf8c |
.B MPI_SUCCESS
|
|
Packit Service |
c5cf8c |
- No error; MPI routine completed successfully.
|
|
Packit Service |
c5cf8c |
.PD 1
|
|
Packit Service |
c5cf8c |
.PD 0
|
|
Packit Service |
c5cf8c |
.TP
|
|
Packit Service |
c5cf8c |
.B MPI_ERR_RANK
|
|
Packit Service |
c5cf8c |
- 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 |
(
|
|
Packit Service |
c5cf8c |
.I MPI_Recv
|
|
Packit Service |
c5cf8c |
,
|
|
Packit Service |
c5cf8c |
.I MPI_Irecv
|
|
Packit Service |
c5cf8c |
,
|
|
Packit Service |
c5cf8c |
.I MPI_Sendrecv
|
|
Packit Service |
c5cf8c |
, etc.) may also be
|
|
Packit Service |
c5cf8c |
.I MPI_ANY_SOURCE
|
|
Packit Service |
c5cf8c |
\&.
|
|
Packit Service |
c5cf8c |
|
|
Packit Service |
c5cf8c |
.PD 1
|
|
Packit Service |
c5cf8c |
.PD 0
|
|
Packit Service |
c5cf8c |
.TP
|
|
Packit Service |
c5cf8c |
.B MPI_ERR_WIN
|
|
Packit Service |
c5cf8c |
- Invalid MPI window object
|
|
Packit Service |
c5cf8c |
.PD 1
|
|
Packit Service |
c5cf8c |
.PD 0
|
|
Packit Service |
c5cf8c |
.TP
|
|
Packit Service |
c5cf8c |
.B MPI_ERR_OTHER
|
|
Packit Service |
c5cf8c |
- Other error; use
|
|
Packit Service |
c5cf8c |
.I MPI_Error_string
|
|
Packit Service |
c5cf8c |
to get more information
|
|
Packit Service |
c5cf8c |
about this error code.
|
|
Packit Service |
c5cf8c |
.PD 1
|
|
Packit Service |
c5cf8c |
|
|
Packit Service |
c5cf8c |
.SH SEE ALSO
|
|
Packit Service |
c5cf8c |
MPI_Win_unlock_all
|
|
Packit Service |
c5cf8c |
.br
|