118 lines
4.3 KiB
HTML
118 lines
4.3 KiB
HTML
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML3.2 EN">
|
|
<HTML>
|
|
<HEAD>
|
|
<META NAME="GENERATOR" CONTENT="DOCTEXT">
|
|
<TITLE>MPI_Get</TITLE>
|
|
</HEAD>
|
|
<BODY BGCOLOR="FFFFFF">
|
|
<H1 id="MPI_Get">MPI_Get</H1>
|
|
Get data from a memory window on a remote process
|
|
<H2>Synopsis</H2>
|
|
<PRE>
|
|
</PRE>
|
|
<PRE>
|
|
int MPI_Get(void *origin_addr, int origin_count, MPI_Datatype origin_datatype,
|
|
int target_rank, MPI_Aint target_disp, int target_count,
|
|
MPI_Datatype target_datatype, MPI_Win win)
|
|
</PRE>
|
|
|
|
<PRE>
|
|
int MPI_Get_c(void *origin_addr, MPI_Count origin_count,
|
|
MPI_Datatype origin_datatype, int target_rank,
|
|
MPI_Aint target_disp, MPI_Count target_count,
|
|
MPI_Datatype target_datatype, MPI_Win win)
|
|
</PRE>
|
|
|
|
<P>
|
|
<H2>Input Parameters</H2>
|
|
<DL>
|
|
<DT><B>origin_count </B> <DD> number of entries in origin buffer (non-negative integer)
|
|
|
|
<DT><B>origin_datatype </B> <DD> datatype of each entry in origin buffer (handle)
|
|
|
|
<DT><B>target_rank </B> <DD> rank of target (non-negative integer)
|
|
|
|
<DT><B>target_disp </B> <DD> displacement from window start to the beginning of the target buffer (non-negative integer)
|
|
|
|
<DT><B>target_count </B> <DD> number of entries in target buffer (non-negative integer)
|
|
|
|
<DT><B>target_datatype </B> <DD> datatype of each entry in target buffer (handle)
|
|
|
|
<DT><B>win </B> <DD> window object used for communication (handle)
|
|
</DL>
|
|
<P>
|
|
<H2>Output Parameters</H2>
|
|
<DL>
|
|
<DT><B>origin_addr </B> <DD> initial address of origin buffer (choice)
|
|
</DL>
|
|
<P>
|
|
<H2>Thread and Interrupt Safety</H2>
|
|
<P>
|
|
This routine is thread-safe. This means that this routine may be
|
|
safely used by multiple threads without the need for any user-provided
|
|
thread locks. However, the routine is not interrupt safe. Typically,
|
|
this is due to the use of memory allocation routines such as <tt>malloc
|
|
</tt>or other non-MPICH runtime routines that are themselves not interrupt-safe.
|
|
<P>
|
|
<H2>Notes for Fortran</H2>
|
|
All MPI routines in Fortran (except for <tt>MPI_WTIME</tt> and <tt>MPI_WTICK</tt>) have
|
|
an additional argument <tt>ierr</tt> at the end of the argument list. <tt>ierr
|
|
</tt>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
|
|
<tt>call</tt> statement.
|
|
<P>
|
|
All MPI objects (e.g., <tt>MPI_Datatype</tt>, <tt>MPI_Comm</tt>) are of type <tt>INTEGER
|
|
</tt>in Fortran.
|
|
<P>
|
|
<H2>Errors</H2>
|
|
<P>
|
|
All MPI routines (except <tt>MPI_Wtime</tt> and <tt>MPI_Wtick</tt>) 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 <tt>MPI_Comm_set_errhandler</tt> (for communicators),
|
|
<tt>MPI_File_set_errhandler</tt> (for files), and <tt>MPI_Win_set_errhandler</tt> (for
|
|
RMA windows). The MPI-1 routine <tt>MPI_Errhandler_set</tt> may be used but
|
|
its use is deprecated. The predefined error handler
|
|
<tt>MPI_ERRORS_RETURN</tt> may be used to cause error values to be returned.
|
|
Note that MPI does <em>not</em> guarantee that an MPI program can continue past
|
|
an error; however, MPI implementations will attempt to continue whenever
|
|
possible.
|
|
<P>
|
|
<DL>
|
|
<DT><B>MPI_SUCCESS </B> <DD> No error; MPI routine completed successfully.
|
|
</DL>
|
|
<DL>
|
|
<DT><B>MPI_ERR_BUFFER </B> <DD> Invalid buffer pointer. Usually a null buffer where
|
|
one is not valid.
|
|
</DL>
|
|
<DL>
|
|
<DT><B>MPI_ERR_COUNT </B> <DD> Invalid count argument. Count arguments must be
|
|
non-negative; a count of zero is often valid.
|
|
</DL>
|
|
<DL>
|
|
<DT><B>MPI_ERR_DISP </B> <DD>
|
|
</DL>
|
|
<DL>
|
|
<DT><B>MPI_ERR_RANK </B> <DD> Invalid source or destination rank. Ranks must be between
|
|
zero and the size of the communicator minus one; ranks in a receive
|
|
(<tt>MPI_Recv</tt>, <tt>MPI_Irecv</tt>, <tt>MPI_Sendrecv</tt>, etc.) may also be <tt>MPI_ANY_SOURCE</tt>.
|
|
</DL>
|
|
<DL>
|
|
<DT><B>MPI_ERR_TYPE </B> <DD> Invalid datatype argument. Additionally, this error can
|
|
occur if an uncommitted MPI_Datatype (see <tt>MPI_Type_commit</tt>) is used
|
|
in a communication call.
|
|
</DL>
|
|
<DL>
|
|
<DT><B>MPI_ERR_WIN </B> <DD> Invalid MPI window object
|
|
</DL>
|
|
<DL>
|
|
<DT><B>MPI_ERR_OTHER </B> <DD> Other error; use <tt>MPI_Error_string</tt> to get more information
|
|
about this error code.
|
|
</DL>
|
|
<P>
|
|
<H2>See Also</H2>
|
|
MPI_Rget
|
|
<br>
|
|
</BODY></HTML>
|