1MPI_Wait(3) LAM/MPI MPI_Wait(3)
2
6 MPI_Wait - Waits for an MPI send or receive to complete
7
9 #include <mpi.h>
10 int MPI_Wait(MPI_Request *preq, MPI_Status *stat)
11
13 preq - request (handle)
14
17 stat - status object (Status), which may be the MPI constant MPI_STA‐
18 TUS_IGNORE
19
23 For send operations, the only use of status is for MPI_Test_cancelled
24 in the case that there is an error, in which case the MPI_ERROR field
25 of status will be set.
26
29 All MPI routines in Fortran (except for MPI_WTIME and MPI_WTICK ) have
30 an additional argument ierr at the end of the argument list. ierr is
31 an integer and has the same meaning as the return value of the routine
32 in C. In Fortran, MPI routines are subroutines, and are invoked with
33 the call statement.
34 All MPI objects (e.g., MPI_Datatype , MPI_Comm ) are of type INTEGER in
36 Fortran.
37
40 If an error occurs in an MPI function, the current MPI error handler is
41 called to handle it. By default, this error handler aborts the MPI
42 job. The error handler may be changed with MPI_Errhandler_set ; the
43 predefined error handler MPI_ERRORS_RETURN may be used to cause error
44 values to be returned (in C and Fortran; this error handler is less
45 useful in with the C++ MPI bindings. The predefined error handler
46 MPI::ERRORS_THROW_EXCEPTIONS should be used in C++ if the error value
47 needs to be recovered). Note that MPI does not guarantee that an MPI
48 program can continue past an error.
49 All MPI routines (except MPI_Wtime and MPI_Wtick ) return an error
51 value; C routines as the value of the function and Fortran routines in
52 the last argument. The C++ bindings for MPI do not return error val‐
53 ues; instead, error values are communicated by throwing exceptions of
54 type MPI::Exception (but not by default). Exceptions are only thrown
55 if the error value is not MPI::SUCCESS .
56 Note that if the MPI::ERRORS_RETURN handler is set in C++, while MPI
59 functions will return upon an error, there will be no way to recover
60 what the actual error value was.
61 MPI_SUCCESS
62 - No error; MPI routine completed successfully.
63 MPI_ERR_REQUEST
64 - Invalid MPI_Request ; either null or, MPI_REQUEST_NULL , in
65 the case of a MPI_Start or MPI_Startall , not a persistent
66 request.
67 MPI_ERR_ARG
68 - Invalid argument. Some argument is invalid and is not identi‐
69 fied by a specific error class. This is typically a NULL
70 pointer or other such error.
71
74 For more information, please see the official MPI Forum web site, which
75 contains the text of both the MPI-1 and MPI-2 standards. These docu‐
76 ments contain detailed information about each MPI function (most of
77 which is not duplicated in these man pages).
78 http://www.mpi-forum.org/
80
84 The LAM Team would like the thank the MPICH Team for the handy program
85 to generate man pages ("doctext" from ftp://ftp.mcs.anl.gov/pub/sow‐
86 ing/sowing.tar.gz ), the initial formatting, and some initial text for
87 most of the MPI-1 man pages.
88
90 wait.c
91LAM/MPI 7.1.2 2/23/2006 MPI_Wait(3)