1MPI_Win_wait(3) LAM/MPI MPI_Win_wait(3)
2
3
4
6 MPI_Win_wait - Completes an RMA exposure epoch
7
9 #include <mpi.h>
10 int MPI_Win_wait(MPI_Win win)
11
13 win - window object (handle)
14
15
17 Completes an RMA exposure epoch started by a call to MPI_WIN_POST on
18 win. This call matches calls to MPI_WIN_COMPLETE(win) issued by each of
19 the origin processes that were granted access to the window during this
20 epoch. The call to MPI_WIN_WAIT will block until all matching calls to
21 MPI_WIN_COMPLETE have occurred. This guarantees that all these origin
22 processes have completed their RMA accesses to the local window. When
23 the call returns, all these RMA accesses will have completed at the
24 target window.
25
26
28 All MPI routines in Fortran (except for MPI_WTIME and MPI_WTICK ) have
29 an additional argument ierr at the end of the argument list. ierr is
30 an integer and has the same meaning as the return value of the routine
31 in C. In Fortran, MPI routines are subroutines, and are invoked with
32 the call statement.
33
34 All MPI objects (e.g., MPI_Datatype , MPI_Comm ) are of type INTEGER in
35 Fortran.
36
38 The IMPI standard only supports MPI-1 functions. Hence, this function
39 is currently not designed to operate within an IMPI job.
40
41
43 If an error occurs in an MPI function, the current MPI error handler is
44 called to handle it. By default, this error handler aborts the MPI
45 job. The error handler may be changed with MPI_Errhandler_set ; the
46 predefined error handler MPI_ERRORS_RETURN may be used to cause error
47 values to be returned (in C and Fortran; this error handler is less
48 useful in with the C++ MPI bindings. The predefined error handler
49 MPI::ERRORS_THROW_EXCEPTIONS should be used in C++ if the error value
50 needs to be recovered). Note that MPI does not guarantee that an MPI
51 program can continue past an error.
52
53 All MPI routines (except MPI_Wtime and MPI_Wtick ) return an error
54 value; C routines as the value of the function and Fortran routines in
55 the last argument. The C++ bindings for MPI do not return error val‐
56 ues; instead, error values are communicated by throwing exceptions of
57 type MPI::Exception (but not by default). Exceptions are only thrown
58 if the error value is not MPI::SUCCESS .
59
60
61 Note that if the MPI::ERRORS_RETURN handler is set in C++, while MPI
62 functions will return upon an error, there will be no way to recover
63 what the actual error value was.
64 MPI_SUCCESS
65 - No error; MPI routine completed successfully.
66 MPI_ERR_WIN
67 - Invalid window. A common error is to use a null window in a
68 call.
69 MPI_ERR_EPOCH
70 - This error indicates than an operation has been attempted on a
71 "closed" window. Certain one-sided operations can only be per‐
72 formed on windows whose epoch has been started with
73 MPI_Win_start.
74
75
77 MPI_Put(3), MPI_Get(3), MPI_Win_create(3), MPI_Win_start(3),
78 MPI_Win_complete(3), MPI_Win_fence(3), MPI_Win_free(3),
79 MPI_Win_get_group(3), MPI_Win_get_group(3), MPI_Accumulate(3)
80
81
83 For more information, please see the official MPI Forum web site, which
84 contains the text of both the MPI-1 and MPI-2 standards. These docu‐
85 ments contain detailed information about each MPI function (most of
86 which is not duplicated in these man pages).
87
88 http://www.mpi-forum.org/
89
91 wwait.c
92
93
94
95LAM/MPI 7.1.2 2/23/2006 MPI_Win_wait(3)