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