|
Packit Service |
c5cf8c |
|
|
Packit Service |
c5cf8c |
<HTML>
|
|
Packit Service |
c5cf8c |
<HEAD>
|
|
Packit Service |
c5cf8c |
<META NAME="GENERATOR" CONTENT="DOCTEXT">
|
|
Packit Service |
c5cf8c |
<TITLE>MPI_Win_shared_query</TITLE>
|
|
Packit Service |
c5cf8c |
</HEAD>
|
|
Packit Service |
c5cf8c |
<BODY BGCOLOR="FFFFFF">
|
|
Packit Service |
c5cf8c |
MPI_Win_shared_query
|
|
Packit Service |
c5cf8c |
Query the size and base pointer for a patch of a shared memory window.
|
|
Packit Service |
c5cf8c |
Synopsis
|
|
Packit Service |
c5cf8c |
|
|
Packit Service |
c5cf8c |
int MPI_Win_shared_query(MPI_Win win, int rank, MPI_Aint * size, int *disp_unit, void *baseptr)
|
|
Packit Service |
c5cf8c |
|
|
Packit Service |
c5cf8c |
|
|
Packit Service |
c5cf8c |
This function queries the process-local address for remote memory segments
|
|
Packit Service |
c5cf8c |
created with <tt>MPI_Win_allocate_shared</tt>. This function can return different
|
|
Packit Service |
c5cf8c |
process-local addresses for the same physical memory on different processes.
|
|
Packit Service |
c5cf8c |
|
|
Packit Service |
c5cf8c |
The returned memory can be used for load/store accesses subject to the
|
|
Packit Service |
c5cf8c |
constraints defined in MPI 3.0, Section 11.7. This function can only be called
|
|
Packit Service |
c5cf8c |
with windows of type <tt>MPI_Win_flavor_shared</tt>. If the passed window is not of
|
|
Packit Service |
c5cf8c |
flavor <tt>MPI_Win_flavor_shared</tt>, the error <tt>MPI_ERR_RMA_FLAVOR</tt> is raised. When rank
|
|
Packit Service |
c5cf8c |
is <tt>MPI_PROC_NULL</tt>, the pointer, disp_unit, and size returned are the pointer,
|
|
Packit Service |
c5cf8c |
disp_unit, and size of the memory segment belonging the lowest rank that
|
|
Packit Service |
c5cf8c |
specified size > 0. If all processes in the group attached to the window
|
|
Packit Service |
c5cf8c |
specified size = 0, then the call returns size = 0 and a baseptr as if
|
|
Packit Service |
c5cf8c |
<tt>MPI_Alloc_mem</tt> was called with size = 0.
|
|
Packit Service |
c5cf8c |
|
|
Packit Service |
c5cf8c |
Input Parameters
|
|
Packit Service |
c5cf8c |
|
|
Packit Service |
c5cf8c |
win window object used for communication (handle)
|
|
Packit Service |
c5cf8c |
|
|
Packit Service |
c5cf8c |
rank target rank
|
|
Packit Service |
c5cf8c |
|
|
Packit Service |
c5cf8c |
|
|
Packit Service |
c5cf8c |
Output Parameters
|
|
Packit Service |
c5cf8c |
|
|
Packit Service |
c5cf8c |
size size of the segment at the given rank
|
|
Packit Service |
c5cf8c |
|
|
Packit Service |
c5cf8c |
disp_unit local unit size for displacements, in bytes (positive integer)
|
|
Packit Service |
c5cf8c |
|
|
Packit Service |
c5cf8c |
baseptr base pointer in the calling process' address space of the shared
|
|
Packit Service |
c5cf8c |
segment belonging to the target rank.
|
|
Packit Service |
c5cf8c |
|
|
Packit Service |
c5cf8c |
|
|
Packit Service |
c5cf8c |
Thread and Interrupt Safety
|
|
Packit Service |
c5cf8c |
|
|
Packit Service |
c5cf8c |
This routine is thread-safe. This means that this routine may be
|
|
Packit Service |
c5cf8c |
safely used by multiple threads without the need for any user-provided
|
|
Packit Service |
c5cf8c |
thread locks. However, the routine is not interrupt safe. Typically,
|
|
Packit Service |
c5cf8c |
this is due to the use of memory allocation routines such as <tt>malloc
|
|
Packit Service |
c5cf8c |
</tt>or other non-MPICH runtime routines that are themselves not interrupt-safe.
|
|
Packit Service |
c5cf8c |
|
|
Packit Service |
c5cf8c |
Notes for Fortran
|
|
Packit Service |
c5cf8c |
All MPI routines in Fortran (except for <tt>MPI_WTIME</tt> and <tt>MPI_WTICK</tt>) have
|
|
Packit Service |
c5cf8c |
an additional argument <tt>ierr</tt> at the end of the argument list. <tt>ierr
|
|
Packit Service |
c5cf8c |
</tt>is an integer and has the same meaning as the return value of the routine
|
|
Packit Service |
c5cf8c |
in C. In Fortran, MPI routines are subroutines, and are invoked with the
|
|
Packit Service |
c5cf8c |
<tt>call</tt> statement.
|
|
Packit Service |
c5cf8c |
|
|
Packit Service |
c5cf8c |
All MPI objects (e.g., <tt>MPI_Datatype</tt>, <tt>MPI_Comm</tt>) are of type <tt>INTEGER
|
|
Packit Service |
c5cf8c |
</tt>in Fortran.
|
|
Packit Service |
c5cf8c |
|
|
Packit Service |
c5cf8c |
Errors
|
|
Packit Service |
c5cf8c |
|
|
Packit Service |
c5cf8c |
All MPI routines (except <tt>MPI_Wtime</tt> and <tt>MPI_Wtick</tt>) return an error value;
|
|
Packit Service |
c5cf8c |
C routines as the value of the function and Fortran routines in the last
|
|
Packit Service |
c5cf8c |
argument. Before the value is returned, the current MPI error handler is
|
|
Packit Service |
c5cf8c |
called. By default, this error handler aborts the MPI job. The error handler
|
|
Packit Service |
c5cf8c |
may be changed with <tt>MPI_Comm_set_errhandler</tt> (for communicators),
|
|
Packit Service |
c5cf8c |
<tt>MPI_File_set_errhandler</tt> (for files), and <tt>MPI_Win_set_errhandler</tt> (for
|
|
Packit Service |
c5cf8c |
RMA windows). The MPI-1 routine <tt>MPI_Errhandler_set</tt> may be used but
|
|
Packit Service |
c5cf8c |
its use is deprecated. The predefined error handler
|
|
Packit Service |
c5cf8c |
<tt>MPI_ERRORS_RETURN</tt> may be used to cause error values to be returned.
|
|
Packit Service |
c5cf8c |
Note that MPI does not guarentee that an MPI program can continue past
|
|
Packit Service |
c5cf8c |
an error; however, MPI implementations will attempt to continue whenever
|
|
Packit Service |
c5cf8c |
possible.
|
|
Packit Service |
c5cf8c |
|
|
Packit Service |
c5cf8c |
|
|
Packit Service |
c5cf8c |
MPI_SUCCESS No error; MPI routine completed successfully.
|
|
Packit Service |
c5cf8c |
|
|
Packit Service |
c5cf8c |
|
|
Packit Service |
c5cf8c |
MPI_ERR_ARG Invalid argument. Some argument is invalid and is not
|
|
Packit Service |
c5cf8c |
identified by a specific error class (e.g., <tt>MPI_ERR_RANK</tt>).
|
|
Packit Service |
c5cf8c |
|
|
Packit Service |
c5cf8c |
|
|
Packit Service |
c5cf8c |
MPI_ERR_RANK Invalid source or destination rank. Ranks must be between
|
|
Packit Service |
c5cf8c |
zero and the size of the communicator minus one; ranks in a receive
|
|
Packit Service |
c5cf8c |
(<tt>MPI_Recv</tt>, <tt>MPI_Irecv</tt>, <tt>MPI_Sendrecv</tt>, etc.) may also be <tt>MPI_ANY_SOURCE</tt>.
|
|
Packit Service |
c5cf8c |
|
|
Packit Service |
c5cf8c |
|
|
Packit Service |
c5cf8c |
MPI_ERR_WIN Invalid MPI window object
|
|
Packit Service |
c5cf8c |
|
|
Packit Service |
c5cf8c |
|
|
Packit Service |
c5cf8c |
See Also
|
|
Packit Service |
c5cf8c |
MPI_Win_allocate_shared
|
|
Packit Service |
c5cf8c |
|
|
Packit Service |
c5cf8c |
</BODY></HTML>
|