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
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
|
.. _mpi_request_free:
MPI_Request_free
================
.. include_body
:ref:`MPI_Request_free` |mdash| Frees a communication request object.
SYNTAX
------
C Syntax
^^^^^^^^
.. code-block:: c
#include <mpi.h>
int MPI_Request_free(MPI_Request *request)
Fortran Syntax
^^^^^^^^^^^^^^
.. code-block:: fortran
USE MPI
! or the older form: INCLUDE 'mpif.h'
MPI_REQUEST_FREE(REQUEST, IERROR)
INTEGER REQUEST, IERROR
Fortran 2008 Syntax
^^^^^^^^^^^^^^^^^^^
.. code-block:: fortran
USE mpi_f08
MPI_Request_free(request, ierror)
TYPE(MPI_Request), INTENT(INOUT) :: request
INTEGER, OPTIONAL, INTENT(OUT) :: ierror
INPUT/OUTPUT PARAMETER
----------------------
* ``request``: Communication request (handle).
DESCRIPTION
-----------
This operation allows a request object to be deallocated without waiting
for the associated communication to complete.
:ref:`MPI_Request_free` marks the request object for deallocation and sets
request to MPI_REQUEST_NULL. Any ongoing communication that is
associated with the request will be allowed to complete. The request
will be deallocated only after its completion.
NOTES
-----
Once a request is freed by a call to :ref:`MPI_Request_free`, it is not
possible to check for the successful completion of the associated
communication with calls to :ref:`MPI_Wait` or :ref:`MPI_Test`. Also, if an error
occurs subsequently during the communication, an error code cannot be
returned to the user |mdash| such an error must be treated as fatal.
Questions arise as to how one knows when the operations have completed
when using :ref:`MPI_Request_free`. Depending on the program logic, there may
be other ways in which the program knows that certain operations have
completed and this makes usage of :ref:`MPI_Request_free` practical. For
example, an active send request could be freed when the logic of the
program is such that the receiver sends a reply to the message sent |mdash|
the arrival of the reply informs the sender that the send has completed
and the send buffer can be reused. An active receive request should
never be freed, as the receiver will have no way to verify that the
receive has completed and the receive buffer can be reused.
**Example:**
.. code-block:: fortran
CALL MPI_COMM_RANK(MPI_COMM_WORLD, rank)
IF(rank == 0) THEN
DO i=1, n
CALL MPI_ISEND(outval, 1, MPI_REAL, 1, 0, req, ierr)
CALL MPI_REQUEST_FREE(req, ierr)
CALL MPI_IRECV(inval, 1, MPI_REAL, 1, 0, req, ierr)
CALL MPI_WAIT(req, status, ierr)
END DO
ELSE IF (rank == 1) THEN
CALL MPI_IRECV(inval, 1, MPI_REAL, 0, 0, req, ierr)
CALL MPI_WAIT(req, status)
DO I=1, n-1
CALL MPI_ISEND(outval, 1, MPI_REAL, 0, 0, req, ierr)
CALL MPI_REQUEST_FREE(req, ierr)
CALL MPI_IRECV(inval, 1, MPI_REAL, 0, 0, req, ierr)
CALL MPI_WAIT(req, status, ierr)
END DO
CALL MPI_ISEND(outval, 1, MPI_REAL, 0, 0, req, ierr)
CALL MPI_WAIT(req, status)
END IF
This routine is normally used to free persistent requests created with
either :ref:`MPI_Recv_init` or :ref:`MPI_Send_init` and friends. However, it can
be used to free a request created with :ref:`MPI_Irecv` or :ref:`MPI_Isend` and
friends; in that case the use can not use the test/wait routines on the
request.
It **is** permitted to free an active request. However, once freed, you
can not use the request in a wait or test routine (e.g., :ref:`MPI_Wait` ).
ERRORS
------
.. include:: ./ERRORS.rst
.. seealso::
* :ref:`MPI_Isend`
* :ref:`MPI_Irecv`
* :ref:`MPI_Issend`
* :ref:`MPI_Ibsend`
* :ref:`MPI_Irsend`
* :ref:`MPI_Recv_init`
* :ref:`MPI_Send_init`
* :ref:`MPI_Ssend_init`
* :ref:`MPI_Rsend_init`
* :ref:`MPI_Test`
* :ref:`MPI_Wait`
* :ref:`MPI_Waitall`
* :ref:`MPI_Waitany`
* :ref:`MPI_Waitsome`
* :ref:`MPI_Testall`
* :ref:`MPI_Testany`
* :ref:`MPI_Testsome`
|
