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