1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192
|
.TH MPI_Bsend 3 "1/6/1997" " " "MPI"
.SH NAME
MPI_Bsend \- Basic send with user-specified buffering
.SH SYNOPSIS
.nf
#include "mpi.h"
int MPI_Bsend( buf, count, datatype, dest, tag, comm )
void *buf;
int count, dest, tag;
MPI_Datatype datatype;
MPI_Comm comm;
.fi
.SH INPUT PARAMETERS
.PD 0
.TP
.B buf
- initial address of send buffer (choice)
.PD 1
.PD 0
.TP
.B count
- number of elements in send buffer (nonnegative integer)
.PD 1
.PD 0
.TP
.B datatype
- datatype of each send buffer element (handle)
.PD 1
.PD 0
.TP
.B dest
- rank of destination (integer)
.PD 1
.PD 0
.TP
.B tag
- message tag (integer)
.PD 1
.PD 0
.TP
.B comm
- communicator (handle)
.PD 1
.SH NOTES
This send is provided as a convenience function; it allows the user to
send messages without worring about where they are buffered (because the
user
.B must
have provided buffer space with
.I MPI_Buffer_attach
).
In deciding how much buffer space to allocate, remember that the buffer space
is not available for reuse by subsequent
.I MPI_Bsend
s unless you are certain
that the message
has been received (not just that it should have been received). For example,
this code does not allocate enough buffer space
.nf
MPI_Buffer_attach( b, n*sizeof(double) + MPI_BSEND_OVERHEAD );
for (i=0; i<m; i++) {
MPI_Bsend( buf, n, MPI_DOUBLE, ... );
}
.fi
because only enough buffer space is provided for a single send, and the
loop may start a second
.I MPI_Bsend
before the first is done making use of the
buffer.
In C, you can
force the messages to be delivered by
.nf
MPI_Buffer_detach( &b, &n );
MPI_Buffer_attach( b, n );
.fi
(The
.I MPI_Buffer_detach
will not complete until all buffered messages are
delivered.)
.SH NOTES FOR FORTRAN
All MPI routines in Fortran (except for
.I MPI_WTIME
and
.I MPI_WTICK
) have
an additional argument
.I ierr
at the end of the argument list.
.I ierr
is an integer and has the same meaning as the return value of the routine
in C. In Fortran, MPI routines are subroutines, and are invoked with the
.I call
statement.
All MPI objects (e.g.,
.I MPI_Datatype
,
.I MPI_Comm
) are of type
.I INTEGER
in Fortran.
.SH ERRORS
All MPI routines (except
.I MPI_Wtime
and
.I MPI_Wtick
) return an error value;
C routines as the value of the function and Fortran routines in the last
argument. Before the value is returned, the current MPI error handler is
called. By default, this error handler aborts the MPI job. The error handler
may be changed with
.I MPI_Errhandler_set
; the predefined error handler
.I MPI_ERRORS_RETURN
may be used to cause error values to be returned.
Note that MPI does
.B not
guarentee that an MPI program can continue past
an error.
.PD 0
.TP
.B MPI_SUCCESS
- No error; MPI routine completed successfully.
.PD 1
.PD 0
.TP
.B MPI_ERR_COMM
- Invalid communicator. A common error is to use a null
communicator in a call (not even allowed in
.I MPI_Comm_rank
).
.PD 1
.PD 0
.TP
.B MPI_ERR_COUNT
- Invalid count argument. Count arguments must be
non-negative; a count of zero is often valid.
.PD 1
.PD 0
.TP
.B MPI_ERR_TYPE
- Invalid datatype argument. May be an uncommitted
.PD 1
MPI_Datatype (see
.I MPI_Type_commit
).
.PD 0
.TP
.B MPI_ERR_RANK
- Invalid source or destination rank. Ranks must be between
zero and the size of the communicator minus one; ranks in a receive
(
.I MPI_Recv
,
.I MPI_Irecv
,
.I MPI_Sendrecv
, etc.) may also be
.I MPI_ANY_SOURCE
.
.PD 1
.PD 0
.TP
.B MPI_ERR_TAG
- Invalid tag argument. Tags must be non-negative; tags
in a receive (
.I MPI_Recv
,
.I MPI_Irecv
,
.I MPI_Sendrecv
, etc.) may
also be
.I MPI_ANY_TAG
. The largest tag value is available through the
the attribute
.I MPI_TAG_UB
.
.PD 1
.SH SEE ALSO
MPI_Buffer_attach, MPI_Ibsend, MPI_Bsend_init
.br
.SH LOCATION
bsend.c
|