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