Blame www/www3/MPI_Win_fence.html

Packit Service c5cf8c
Packit Service c5cf8c
<HTML>
Packit Service c5cf8c
<HEAD>
Packit Service c5cf8c
<META NAME="GENERATOR" CONTENT="DOCTEXT">
Packit Service c5cf8c
<TITLE>MPI_Win_fence</TITLE>
Packit Service c5cf8c
</HEAD>
Packit Service c5cf8c
<BODY BGCOLOR="FFFFFF">
Packit Service c5cf8c

MPI_Win_fence

Packit Service c5cf8c
Perform an MPI fence synchronization on a MPI window 
Packit Service c5cf8c

Synopsis

Packit Service c5cf8c
Packit Service c5cf8c
int MPI_Win_fence(int assert, MPI_Win win)
Packit Service c5cf8c
Packit Service c5cf8c

Input Parameters

Packit Service c5cf8c
Packit Service c5cf8c
assert
program assertion (integer)
Packit Service c5cf8c
Packit Service c5cf8c
win
window object (handle)
Packit Service c5cf8c
Packit Service c5cf8c

Packit Service c5cf8c

Notes

Packit Service c5cf8c
The <tt>assert</tt> argument is used to indicate special conditions for the
Packit Service c5cf8c
fence that an implementation may use to optimize the <tt>MPI_Win_fence
Packit Service c5cf8c
</tt>operation.  The value zero is always correct.  Other assertion values
Packit Service c5cf8c
may be or'ed together.  Assertions that are valid for <tt>MPI_Win_fence</tt> are:
Packit Service c5cf8c

Packit Service c5cf8c
Packit Service c5cf8c
MPI_MODE_NOSTORE
the local window was not updated by local stores
Packit Service c5cf8c
(or local get or receive calls) since last synchronization.
Packit Service c5cf8c
Packit Service c5cf8c
MPI_MODE_NOPUT
the local window will not be updated by put or accumulate
Packit Service c5cf8c
calls after the fence call, until the ensuing (fence) synchronization.
Packit Service c5cf8c
Packit Service c5cf8c
MPI_MODE_NOPRECEDE
the fence does not complete any sequence of locally
Packit Service c5cf8c
issued RMA calls. If this assertion is given by any process in the window
Packit Service c5cf8c
group, then it must be given by all processes in the group.
Packit Service c5cf8c
Packit Service c5cf8c
MPI_MODE_NOSUCCEED
the fence does not start any sequence of locally
Packit Service c5cf8c
issued RMA calls. If the assertion is given by any process in the window
Packit Service c5cf8c
group, then it must be given by all processes in the group.
Packit Service c5cf8c
Packit Service c5cf8c

Packit Service c5cf8c

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 <tt>malloc
Packit Service c5cf8c
</tt>or other non-MPICH runtime routines that are themselves not interrupt-safe.
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_OTHER
Other error; use <tt>MPI_Error_string</tt> to get more information
Packit Service c5cf8c
about this error code. 
Packit Service c5cf8c
Packit Service c5cf8c
Packit Service c5cf8c
MPI_ERR_WIN
Invalid MPI window object
Packit Service c5cf8c
Packit Service c5cf8c
</BODY></HTML>