1MPI_Put(3) LAM/MPI MPI_Put(3)
2
6 MPI_Put - One Sided data placement operation
7
9 #include <mpi.h>
10 int
11 MPI_Put(void *orgaddr, int orgcnt, MPI_Datatype orgtype, int rank,
12 MPI_Aint targdisp, int targcnt, MPI_Datatype targtype, MPI_Win win)
13
15 orgaddr
16 - initial address of origin buffer (choice)
17 orgcnt - number of entries in origin buffer (nonnegative integer)
18 orgtype
19 - datatype of each entry in origin buffer (handle)
20 rank - rank of target (nonnegative integer)
21 targdisp
22 - displacement from start of window to target buffer (nonnega‐
23 tive integer)
24 targcnt
25 - number of entries in target buffer (nonnegative integer)
26 targtype
27 - datatype of each entry in target buffer (handle)
28 win - window object used for communication (handle)
29
32 The target_datatype argument is a handle to a datatype object that is
33 defined at the origin process, even though it defines a data layout in
34 the target process memory.
35
38 All MPI routines in Fortran (except for MPI_WTIME and MPI_WTICK ) have
39 an additional argument ierr at the end of the argument list. ierr is
40 an integer and has the same meaning as the return value of the routine
41 in C. In Fortran, MPI routines are subroutines, and are invoked with
42 the call statement.
43 All MPI objects (e.g., MPI_Datatype , MPI_Comm ) are of type INTEGER in
45 Fortran.
46
48 The IMPI standard only supports MPI-1 functions. Hence, this function
49 is currently not designed to operate within an IMPI job.
50
53 If an error occurs in an MPI function, the current MPI error handler is
54 called to handle it. By default, this error handler aborts the MPI
55 job. The error handler may be changed with MPI_Errhandler_set ; the
56 predefined error handler MPI_ERRORS_RETURN may be used to cause error
57 values to be returned (in C and Fortran; this error handler is less
58 useful in with the C++ MPI bindings. The predefined error handler
59 MPI::ERRORS_THROW_EXCEPTIONS should be used in C++ if the error value
60 needs to be recovered). Note that MPI does not guarantee that an MPI
61 program can continue past an error.
62 All MPI routines (except MPI_Wtime and MPI_Wtick ) return an error
64 value; C routines as the value of the function and Fortran routines in
65 the last argument. The C++ bindings for MPI do not return error val‐
66 ues; instead, error values are communicated by throwing exceptions of
67 type MPI::Exception (but not by default). Exceptions are only thrown
68 if the error value is not MPI::SUCCESS .
69 Note that if the MPI::ERRORS_RETURN handler is set in C++, while MPI
72 functions will return upon an error, there will be no way to recover
73 what the actual error value was.
74 MPI_SUCCESS
75 - No error; MPI routine completed successfully.
76 MPI_ERR_WIN
77 - Invalid window. A common error is to use a null window in a
78 call.
79 MPI_ERR_RANK
80 - Invalid source or destination rank. Ranks must be between
81 zero and the size of the communicator minus one; ranks in a
82 receive ( MPI_Recv , MPI_Irecv , MPI_Sendrecv , etc.) may also
83 be MPI_ANY_SOURCE .
84 MPI_ERR_OTHER
86 - Other error; use MPI_Error_string to get more information
87 about this error code.
88 MPI_ERR_EPOCH
89 - This error indicates than an operation has been attempted on a
90 "closed" window. Certain one-sided operations can only be per‐
91 formed on windows whose epoch has been started with
92 MPI_Win_start.
93 MPI_ERR_INTERN
94 - An internal error has been detected. This is fatal. Please
95 send a bug report to the LAM mailing list (see http://www.lam-
96 mpi.org/contact.php ).
97 MPI_ERR_TYPENOTSUP
98 - Type not supported for this operation. This typically applies
99 to either reduction operations (for which only a limited combi‐
100 nation of datatypes and operations are defined, see MPI-1, sec‐
101 tion 4.9.2) or one-sided operations where the actions on spe‐
102 cific datatpyes have not been implemented yet.
103
106 MPI_Accumulate(3), MPI_Get(3), MPI_Win_create(3), MPI_Win_start(3),
107 MPI_Win_complete(3), MPI_Win_fence(3), MPI_Win_free(3),
108 MPI_Win_get_group(3), MPI_Win_get_group(3), MPI_Win_wait(3)
109
112 For more information, please see the official MPI Forum web site, which
113 contains the text of both the MPI-1 and MPI-2 standards. These docu‐
114 ments contain detailed information about each MPI function (most of
115 which is not duplicated in these man pages).
116 http://www.mpi-forum.org/
118
120 put.c
121LAM/MPI 7.1.2 2/23/2006 MPI_Put(3)