Blame www/www3/MPI_Ssend_init.html

Packit 0848f5
Packit 0848f5
<HTML>
Packit 0848f5
<HEAD>
Packit 0848f5
<META NAME="GENERATOR" CONTENT="DOCTEXT">
Packit 0848f5
<TITLE>MPI_Ssend_init</TITLE>
Packit 0848f5
</HEAD>
Packit 0848f5
<BODY BGCOLOR="FFFFFF">
Packit 0848f5

MPI_Ssend_init

Packit 0848f5
Creates a persistent request for a synchronous send 
Packit 0848f5

Synopsis

Packit 0848f5
Packit 0848f5
int MPI_Ssend_init(const void *buf, int count, MPI_Datatype datatype, int dest,
Packit 0848f5
                  int tag, MPI_Comm comm, MPI_Request *request)
Packit 0848f5
Packit 0848f5

Input Parameters

Packit 0848f5
Packit 0848f5
buf
initial address of send buffer (choice)
Packit 0848f5
Packit 0848f5
count
number of elements sent (integer)
Packit 0848f5
Packit 0848f5
datatype
type of each element (handle)
Packit 0848f5
Packit 0848f5
dest
rank of destination (integer)
Packit 0848f5
Packit 0848f5
tag
message tag (integer)
Packit 0848f5
Packit 0848f5
comm
communicator (handle)
Packit 0848f5
Packit 0848f5

Packit 0848f5

Output Parameters

Packit 0848f5
request
communication request (handle)
Packit 0848f5
Packit 0848f5

Packit 0848f5

Thread and Interrupt Safety

Packit 0848f5

Packit 0848f5
This routine is thread-safe.  This means that this routine may be
Packit 0848f5
safely used by multiple threads without the need for any user-provided
Packit 0848f5
thread locks.  However, the routine is not interrupt safe.  Typically,
Packit 0848f5
this is due to the use of memory allocation routines such as <tt>malloc
Packit 0848f5
</tt>or other non-MPICH runtime routines that are themselves not interrupt-safe.
Packit 0848f5

Packit 0848f5

Notes for Fortran

Packit 0848f5
All MPI routines in Fortran (except for <tt>MPI_WTIME</tt> and <tt>MPI_WTICK</tt>) have
Packit 0848f5
an additional argument <tt>ierr</tt> at the end of the argument list.  <tt>ierr
Packit 0848f5
</tt>is an integer and has the same meaning as the return value of the routine
Packit 0848f5
in C.  In Fortran, MPI routines are subroutines, and are invoked with the
Packit 0848f5
<tt>call</tt> statement.
Packit 0848f5

Packit 0848f5
All MPI objects (e.g., <tt>MPI_Datatype</tt>, <tt>MPI_Comm</tt>) are of type <tt>INTEGER
Packit 0848f5
</tt>in Fortran.
Packit 0848f5

Packit 0848f5

Errors

Packit 0848f5

Packit 0848f5
All MPI routines (except <tt>MPI_Wtime</tt> and <tt>MPI_Wtick</tt>) return an error value;
Packit 0848f5
C routines as the value of the function and Fortran routines in the last
Packit 0848f5
argument.  Before the value is returned, the current MPI error handler is
Packit 0848f5
called.  By default, this error handler aborts the MPI job.  The error handler
Packit 0848f5
may be changed with <tt>MPI_Comm_set_errhandler</tt> (for communicators),
Packit 0848f5
<tt>MPI_File_set_errhandler</tt> (for files), and <tt>MPI_Win_set_errhandler</tt> (for
Packit 0848f5
RMA windows).  The MPI-1 routine <tt>MPI_Errhandler_set</tt> may be used but
Packit 0848f5
its use is deprecated.  The predefined error handler
Packit 0848f5
<tt>MPI_ERRORS_RETURN</tt> may be used to cause error values to be returned.
Packit 0848f5
Note that MPI does not guarentee that an MPI program can continue past
Packit 0848f5
an error; however, MPI implementations will attempt to continue whenever
Packit 0848f5
possible.
Packit 0848f5

Packit 0848f5
MPI_SUCCESS
No error; MPI routine completed successfully.
Packit 0848f5
Packit 0848f5
MPI_ERR_COMM
Invalid communicator. A common error is to use a null
Packit 0848f5
communicator in a call (not even allowed in <tt>MPI_Comm_rank</tt>).
Packit 0848f5
Packit 0848f5
MPI_ERR_COUNT
Invalid count argument. Count arguments must be
Packit 0848f5
non-negative; a count of zero is often valid.
Packit 0848f5
Packit 0848f5
MPI_ERR_TYPE
Invalid datatype argument. Additionally, this error can
Packit 0848f5
occur if an uncommitted MPI_Datatype (see <tt>MPI_Type_commit</tt>) is used
Packit 0848f5
in a communication call.
Packit 0848f5
Packit 0848f5
MPI_ERR_TAG
Invalid tag argument. Tags must be non-negative; tags
Packit 0848f5
in a receive (<tt>MPI_Recv</tt>, <tt>MPI_Irecv</tt>, <tt>MPI_Sendrecv</tt>, etc.) may
Packit 0848f5
also be <tt>MPI_ANY_TAG</tt>.  The largest tag value is available through the 
Packit 0848f5
the attribute <tt>MPI_TAG_UB</tt>.
Packit 0848f5
Packit 0848f5
MPI_ERR_RANK
Invalid source or destination rank. Ranks must be between
Packit 0848f5
zero and the size of the communicator minus one; ranks in a receive
Packit 0848f5
(<tt>MPI_Recv</tt>, <tt>MPI_Irecv</tt>, <tt>MPI_Sendrecv</tt>, etc.) may also be <tt>MPI_ANY_SOURCE</tt>.
Packit 0848f5
Packit 0848f5
</BODY></HTML>