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