1MPI_Win_free(3) LAM/MPI MPI_Win_free(3)
2
6 MPI_Win_free - Frees a window object
7
9 #include <mpi.h>
10 int
11 MPI_Win_free(MPI_Win *win)
12
14 win - window object (handle)
15
18 Frees the window object win and returns a null handle (equal to
19 MPI_WIN_NULL). This is a collective call executed by all processes in
20 the group associated with win. MPI_WIN_FREE(win) can be invoked by a
21 process only after it has completed its involvement in RMA communica‐
22 tions on window win: i.e., the process has called MPI_WIN_FENCE, or
23 called MPI_WIN_WAIT to match a previous call to MPI_WIN_POST or called
24 MPI_WIN_COMPLETE to match a previous call to MPI_WIN_START or called
25 MPI_WIN_UNLOCK to match a previous call to MPI_WIN_LOCK. When the call
26 returns, the window memory can be freed.
27
30 All MPI routines in Fortran (except for MPI_WTIME and MPI_WTICK ) have
31 an additional argument ierr at the end of the argument list. ierr is
32 an integer and has the same meaning as the return value of the routine
33 in C. In Fortran, MPI routines are subroutines, and are invoked with
34 the call statement.
35 All MPI objects (e.g., MPI_Datatype , MPI_Comm ) are of type INTEGER in
37 Fortran.
38
40 The IMPI standard only supports MPI-1 functions. Hence, this function
41 is currently not designed to operate within an IMPI job.
42
45 If an error occurs in an MPI function, the current MPI error handler is
46 called to handle it. By default, this error handler aborts the MPI
47 job. The error handler may be changed with MPI_Errhandler_set ; the
48 predefined error handler MPI_ERRORS_RETURN may be used to cause error
49 values to be returned (in C and Fortran; this error handler is less
50 useful in with the C++ MPI bindings. The predefined error handler
51 MPI::ERRORS_THROW_EXCEPTIONS should be used in C++ if the error value
52 needs to be recovered). Note that MPI does not guarantee that an MPI
53 program can continue past an error.
54 All MPI routines (except MPI_Wtime and MPI_Wtick ) return an error
56 value; C routines as the value of the function and Fortran routines in
57 the last argument. The C++ bindings for MPI do not return error val‐
58 ues; instead, error values are communicated by throwing exceptions of
59 type MPI::Exception (but not by default). Exceptions are only thrown
60 if the error value is not MPI::SUCCESS .
61 Note that if the MPI::ERRORS_RETURN handler is set in C++, while MPI
64 functions will return upon an error, there will be no way to recover
65 what the actual error value was.
66 MPI_SUCCESS
67 - No error; MPI routine completed successfully.
68 MPI_ERR_WIN
69 - Invalid window. A common error is to use a null window in a
70 call.
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),
80 MPI_Win_complete(3), MPI_Win_fence(3), MPI_Accumulate(3),
81 MPI_Win_get_group(3), 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
93 wfree.c
94LAM/MPI 7.1.2 2/23/2006 MPI_Win_free(3)