1MPI_Send_init(3) LAM/MPI MPI_Send_init(3)
2
6 MPI_Send_init - Builds a handle for a standard send
7
9 #include <mpi.h>
10 int MPI_Send_init(void *buf, int count, MPI_Datatype dtype,
11 int dest, int tag, MPI_Comm comm,
12 MPI_Request *req)
13
15 buf - initial address of send buffer (choice)
16 count - number of elements sent (integer)
17 dtype - type of each element (handle)
18 dest - rank of destination (integer)
19 tag - message tag (integer)
20 comm - communicator (handle)
21
24 req - communication request (handle)
25
28 The communication initialized by this function will not be started
29 until req is given to MPI_Start or MPI_Startall .
30 The communication is then not guaranteed to progress or complete until
33 req has been given to one of the test or wait functions ( MPI_Test ,
34 MPI_Testall , MPI_Testany , MPI_Testsome , MPI_Wait , MPI_Waitall ,
35 MPI_Waitany , MPI_Waitsome ).
36 Once any of the test or wait functions indicate that the communication
38 has finished, the communication cycle can be started again with
39 MPI_Start or MPI_Startall .
40 However, once the communication has finished and it is no longer going
43 to be used, req should be freed with MPI_Request_free .
44
48 All MPI routines in Fortran (except for MPI_WTIME and MPI_WTICK ) have
49 an additional argument ierr at the end of the argument list. ierr is
50 an integer and has the same meaning as the return value of the routine
51 in C. In Fortran, MPI routines are subroutines, and are invoked with
52 the call statement.
53 All MPI objects (e.g., MPI_Datatype , MPI_Comm ) are of type INTEGER in
55 Fortran.
56
59 If an error occurs in an MPI function, the current MPI error handler is
60 called to handle it. By default, this error handler aborts the MPI
61 job. The error handler may be changed with MPI_Errhandler_set ; the
62 predefined error handler MPI_ERRORS_RETURN may be used to cause error
63 values to be returned (in C and Fortran; this error handler is less
64 useful in with the C++ MPI bindings. The predefined error handler
65 MPI::ERRORS_THROW_EXCEPTIONS should be used in C++ if the error value
66 needs to be recovered). Note that MPI does not guarantee that an MPI
67 program can continue past an error.
68 All MPI routines (except MPI_Wtime and MPI_Wtick ) return an error
70 value; C routines as the value of the function and Fortran routines in
71 the last argument. The C++ bindings for MPI do not return error val‐
72 ues; instead, error values are communicated by throwing exceptions of
73 type MPI::Exception (but not by default). Exceptions are only thrown
74 if the error value is not MPI::SUCCESS .
75 Note that if the MPI::ERRORS_RETURN handler is set in C++, while MPI
78 functions will return upon an error, there will be no way to recover
79 what the actual error value was.
80 MPI_SUCCESS
81 - No error; MPI routine completed successfully.
82 MPI_ERR_COUNT
83 - Invalid count argument. Count arguments must be non-negative;
84 a count of zero is often valid.
85 MPI_ERR_TYPE
86 - Invalid datatype argument. May be an uncommitted MPI_Datatype
87 (see MPI_Type_commit ).
88 MPI_ERR_RANK
89 - Invalid source or destination rank. Ranks must be between
90 zero and the size of the communicator minus one; ranks in a
91 receive ( MPI_Recv , MPI_Irecv , MPI_Sendrecv , etc.) may also
92 be MPI_ANY_SOURCE .
93 MPI_ERR_TAG
95 - Invalid tag argument. Tags must be non-negative; tags in a
96 receive ( MPI_Recv , MPI_Irecv , MPI_Sendrecv , etc.) may also
97 be MPI_ANY_TAG . The largest tag value is available through the
98 the attribute MPI_TAG_UB .
99 MPI_ERR_COMM
101 - Invalid communicator. A common error is to use a null commu‐
102 nicator in a call (not even allowed in MPI_Comm_rank ).
103 MPI_ERR_OTHER
104 - This error is returned when some part of the LAM/MPI implemen‐
105 tation is unable to acquire memory.
106
109 MPI_Send, MPI_Start, MPI_Startall, MPI_Test, MPI_Testall, MPI_Testany,
110 MPI_Testsome, MPI_Wait, MPI_Waitall, MPI_Waitany, MPI_Waitsome
111
114 For more information, please see the official MPI Forum web site, which
115 contains the text of both the MPI-1 and MPI-2 standards. These docu‐
116 ments contain detailed information about each MPI function (most of
117 which is not duplicated in these man pages).
118 http://www.mpi-forum.org/
120
124 The LAM Team would like the thank the MPICH Team for the handy program
125 to generate man pages ("doctext" from ftp://ftp.mcs.anl.gov/pub/sow‐
126 ing/sowing.tar.gz ), the initial formatting, and some initial text for
127 most of the MPI-1 man pages.
128
130 sendinit.c
131LAM/MPI 7.1.2 2/23/2006 MPI_Send_init(3)