1MPI_Iprobe(3) LAM/MPI MPI_Iprobe(3)
2
6 MPI_Iprobe - Nonblocking test for a message
7
9 #include <mpi.h>
10 int MPI_Iprobe(int src, int tag, MPI_Comm comm,
11 int *flag, MPI_Status *stat)
12
14 src - source rank, or MPI_ANY_SOURCE (integer)
15 tag - tag value or MPI_ANY_TAG (integer)
16 comm - communicator (handle)
17
20 flag - 1 if the message is ready to be received, 0 if it is not (log‐
21 ical)
22 stat - status object (Status), which may be the MPI constant MPI_STA‐
23 TUS_IGNORE
24
28 This function does not actually receive a message; it only indicates
29 that a message matching the signature specified is ready to be
30 received.
31
34 All MPI routines in Fortran (except for MPI_WTIME and MPI_WTICK ) have
35 an additional argument ierr at the end of the argument list. ierr is
36 an integer and has the same meaning as the return value of the routine
37 in C. In Fortran, MPI routines are subroutines, and are invoked with
38 the call statement.
39 All MPI objects (e.g., MPI_Datatype , MPI_Comm ) are of type INTEGER in
41 Fortran.
42
45 If an error occurs in an MPI function, the current MPI error handler is
46 called to handle it. By default, this error handler aborts the MPI
47 job. The error handler may be changed with MPI_Errhandler_set ; the
48 predefined error handler MPI_ERRORS_RETURN may be used to cause error
49 values to be returned (in C and Fortran; this error handler is less
50 useful in with the C++ MPI bindings. The predefined error handler
51 MPI::ERRORS_THROW_EXCEPTIONS should be used in C++ if the error value
52 needs to be recovered). Note that MPI does not guarantee that an MPI
53 program can continue past an error.
54 All MPI routines (except MPI_Wtime and MPI_Wtick ) return an error
56 value; C routines as the value of the function and Fortran routines in
57 the last argument. The C++ bindings for MPI do not return error val‐
58 ues; instead, error values are communicated by throwing exceptions of
59 type MPI::Exception (but not by default). Exceptions are only thrown
60 if the error value is not MPI::SUCCESS .
61 Note that if the MPI::ERRORS_RETURN handler is set in C++, while MPI
64 functions will return upon an error, there will be no way to recover
65 what the actual error value was.
66 MPI_SUCCESS
67 - No error; MPI routine completed successfully.
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 MPI_ERR_COMM
73 - Invalid communicator. A common error is to use a null commu‐
74 nicator in a call (not even allowed in MPI_Comm_rank ).
75 MPI_ERR_TAG
76 - Invalid tag argument. Tags must be non-negative; tags in a
77 receive ( MPI_Recv , MPI_Irecv , MPI_Sendrecv , etc.) may also
78 be MPI_ANY_TAG . The largest tag value is available through the
79 the attribute MPI_TAG_UB .
80 MPI_ERR_RANK
82 - Invalid source or destination rank. Ranks must be between
83 zero and the size of the communicator minus one; ranks in a
84 receive ( MPI_Recv , MPI_Irecv , MPI_Sendrecv , etc.) may also
85 be MPI_ANY_SOURCE .
86
90 For more information, please see the official MPI Forum web site, which
91 contains the text of both the MPI-1 and MPI-2 standards. These docu‐
92 ments contain detailed information about each MPI function (most of
93 which is not duplicated in these man pages).
94 http://www.mpi-forum.org/
96
100 The LAM Team would like the thank the MPICH Team for the handy program
101 to generate man pages ("doctext" from ftp://ftp.mcs.anl.gov/pub/sow‐
102 ing/sowing.tar.gz ), the initial formatting, and some initial text for
103 most of the MPI-1 man pages.
104
106 iprobe.c
107LAM/MPI 7.1.2 2/23/2006 MPI_Iprobe(3)