1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
|
.. _mpi_win_free:
MPI_Win_free
============
.. include_body
:ref:`MPI_Win_free` |mdash| Frees the window object and returns a null handle.
SYNTAX
------
C Syntax
^^^^^^^^
.. code-block:: c
#include <mpi.h>
int MPI_Win_free(MPI_Win *win)
Fortran Syntax
^^^^^^^^^^^^^^
.. code-block:: fortran
USE MPI
! or the older form: INCLUDE 'mpif.h'
MPI_WIN_FREE(WIN, IERROR)
INTEGER WIN, IERROR
Fortran 2008 Syntax
^^^^^^^^^^^^^^^^^^^
.. code-block:: fortran
USE mpi_f08
MPI_Win_free(win, ierror)
TYPE(MPI_Win), INTENT(INOUT) :: win
INTEGER, OPTIONAL, INTENT(OUT) :: ierror
INPUT/OUTPUT PARAMETER
----------------------
* ``win``: Window object (handle).
OUTPUT PARAMETER
----------------
* ``ierror``: Fortran only: Error status (integer).
DESCRIPTION
-----------
:ref:`MPI_Win_free` frees the window object *win* and returns a null handle
(equal to MPI_WIN_NULL). This collective call is executed by all
processes in the group associated with *win*. It can be invoked by a
process only after it has completed its involvement in RMA
communications on window *win*, that is, the process has called
:ref:`MPI_Win_fence`, or called :ref:`MPI_Win_unlock` to match a previous call to
:ref:`MPI_Win_lock`. When the call returns, the window memory can be freed.
NOTES
-----
If the window was created through :ref:`MPI_Win_allocate` or
:ref:`MPI_Win_allocate_shared` then the memory buffer allocated in that
call will be freed when calling :ref:`MPI_Win_free`.
ERRORS
------
.. include:: ./ERRORS.rst
.. seealso::
* :ref:`MPI_Win_create`
* :ref:`MPI_Win_allocate`
* :ref:`MPI_Win_allocate_shared`
|
