1MPI_Testany(3) LAM/MPI MPI_Testany(3)
2
6 MPI_Testany - Tests for completion of any previdously initiated com‐
7 munication
8
10 #include <mpi.h>
11 int MPI_Testany(int count, MPI_Request *reqs,
12 int *index, int *flag, MPI_Status *stat)
13
15 count - list length (integer)
16 reqs - array of requests (array of handles)
17
20 index - index of operation that completed, or MPI_UNDEFINED if none
21 completed (integer)
22 flag - true if one of the operations is complete (logical)
23 stat - status object (Status), which may be the MPI constant MPI_STA‐
24 TUS_IGNORE
25
29 For send operations, the only use of status is for MPI_Test_cancelled
30 in the case that there is an error, in which case the MPI_ERROR field
31 of status will be set.
32
35 All MPI routines in Fortran (except for MPI_WTIME and MPI_WTICK ) have
36 an additional argument ierr at the end of the argument list. ierr is
37 an integer and has the same meaning as the return value of the routine
38 in C. In Fortran, MPI routines are subroutines, and are invoked with
39 the call statement.
40 All MPI objects (e.g., MPI_Datatype , MPI_Comm ) are of type INTEGER in
42 Fortran.
43
46 If an error occurs in an MPI function, the current MPI error handler is
47 called to handle it. By default, this error handler aborts the MPI
48 job. The error handler may be changed with MPI_Errhandler_set ; the
49 predefined error handler MPI_ERRORS_RETURN may be used to cause error
50 values to be returned (in C and Fortran; this error handler is less
51 useful in with the C++ MPI bindings. The predefined error handler
52 MPI::ERRORS_THROW_EXCEPTIONS should be used in C++ if the error value
53 needs to be recovered). Note that MPI does not guarantee that an MPI
54 program can continue past an error.
55 All MPI routines (except MPI_Wtime and MPI_Wtick ) return an error
57 value; C routines as the value of the function and Fortran routines in
58 the last argument. The C++ bindings for MPI do not return error val‐
59 ues; instead, error values are communicated by throwing exceptions of
60 type MPI::Exception (but not by default). Exceptions are only thrown
61 if the error value is not MPI::SUCCESS .
62 Note that if the MPI::ERRORS_RETURN handler is set in C++, while MPI
65 functions will return upon an error, there will be no way to recover
66 what the actual error value was.
67 MPI_SUCCESS
68 - No error; MPI routine completed successfully.
69 MPI_ERR_COUNT
70 - Invalid count argument. Count arguments must be non-negative;
71 a count of zero is often valid.
72 MPI_ERR_REQUEST
73 - Invalid MPI_Request ; either null or, MPI_REQUEST_NULL , in
74 the case of a MPI_Start or MPI_Startall , not a persistent
75 request.
76 MPI_ERR_ARG
77 - Invalid argument. Some argument is invalid and is not identi‐
78 fied by a specific error class. This is typically a NULL
79 pointer or other such error.
80
83 For more information, please see the official MPI Forum web site, which
84 contains the text of both the MPI-1 and MPI-2 standards. These docu‐
85 ments contain detailed information about each MPI function (most of
86 which is not duplicated in these man pages).
87 http://www.mpi-forum.org/
89
93 The LAM Team would like the thank the MPICH Team for the handy program
94 to generate man pages ("doctext" from ftp://ftp.mcs.anl.gov/pub/sow‐
95 ing/sowing.tar.gz ), the initial formatting, and some initial text for
96 most of the MPI-1 man pages.
97
99 testany.c
100LAM/MPI 7.1.2 2/23/2006 MPI_Testany(3)