1MPI_Ssend(3) LAM/MPI MPI_Ssend(3)
2
6 MPI_Ssend - Basic synchronous send
7
9 #include <mpi.h>
10 int MPI_Ssend(void *buf, int count, MPI_Datatype dtype,
11 int dest, int tag, MPI_Comm comm)
12
14 buf - initial address of send buffer (choice)
15 count - number of elements in send buffer (nonnegative integer)
16 dtype - datatype of each send buffer element (handle)
17 dest - rank of destination (integer)
18 tag - message tag (integer)
19 comm - communicator (handle)
20
23 This function will not complete until the destination rank starts to
24 receive the message. Note that this is different than saying that the
25 message has been received by the destination rank.
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_COMM
64 - Invalid communicator. A common error is to use a null commu‐
65 nicator in a call (not even allowed in MPI_Comm_rank ).
66 MPI_ERR_COUNT
67 - Invalid count argument. Count arguments must be non-negative;
68 a count of zero is often valid.
69 MPI_ERR_TYPE
70 - Invalid datatype argument. May be an uncommitted MPI_Datatype
71 (see MPI_Type_commit ).
72 MPI_ERR_TAG
73 - Invalid tag argument. Tags must be non-negative; tags in a
74 receive ( MPI_Recv , MPI_Irecv , MPI_Sendrecv , etc.) may also
75 be MPI_ANY_TAG . The largest tag value is available through the
76 the attribute MPI_TAG_UB .
77 MPI_ERR_RANK
79 - Invalid source or destination rank. Ranks must be between
80 zero and the size of the communicator minus one; ranks in a
81 receive ( MPI_Recv , MPI_Irecv , MPI_Sendrecv , etc.) may also
82 be MPI_ANY_SOURCE .
83
87 For more information, please see the official MPI Forum web site, which
88 contains the text of both the MPI-1 and MPI-2 standards. These docu‐
89 ments contain detailed information about each MPI function (most of
90 which is not duplicated in these man pages).
91 http://www.mpi-forum.org/
93
97 The LAM Team would like the thank the MPICH Team for the handy program
98 to generate man pages ("doctext" from ftp://ftp.mcs.anl.gov/pub/sow‐
99 ing/sowing.tar.gz ), the initial formatting, and some initial text for
100 most of the MPI-1 man pages.
101
103 ssend.c
104LAM/MPI 7.1.2 2/23/2006 MPI_Ssend(3)