.\" Man page generated from reStructuredText. . .TH "MPI_WIN_SHARED_QUERY" "3" "Jul 22, 2024" "" "Open MPI" . .nr rst2man-indent-level 0 . .de1 rstReportMargin \\$1 \\n[an-margin] level \\n[rst2man-indent-level] level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] - \\n[rst2man-indent0] \\n[rst2man-indent1] \\n[rst2man-indent2] .. .de1 INDENT .\" .rstReportMargin pre: . RS \\$1 . nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin] . nr rst2man-indent-level +1 .\" .rstReportMargin post: .. .de UNINDENT . RE .\" indent \\n[an-margin] .\" old: \\n[rst2man-indent\\n[rst2man-indent-level]] .nr rst2man-indent-level -1 .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .in \\n[rst2man-indent\\n[rst2man-indent-level]]u .. .sp \fI\%MPI_Win_shared_query\fP — Query a shared memory window .SH SYNTAX .SS C Syntax .INDENT 0.0 .INDENT 3.5 .sp .nf .ft C #include int MPI_Win_shared_query (MPI_Win win, int rank, MPI_Aint *size, int *disp_unit, void *baseptr) .ft P .fi .UNINDENT .UNINDENT .SS Fortran Syntax .INDENT 0.0 .INDENT 3.5 .sp .nf .ft C USE MPI ! or the older form: INCLUDE \(aqmpif.h\(aq MPI_WIN_SHARED_QUERY(WIN, RANK, SIZE, DISP_UNIT, BASEPTR, IERROR) INTEGER WIN, RANK, DISP_UNIT, IERROR INTEGER(KIND=MPI_ADDRESS_KIND) SIZE, BASEPTR .ft P .fi .UNINDENT .UNINDENT .SS Fortran 2008 Syntax .INDENT 0.0 .INDENT 3.5 .sp .nf .ft C USE mpi_f08 MPI_Win_shared_query(win, rank, size, disp_unit, baseptr, ierror) USE, INTRINSIC :: ISO_C_BINDING, ONLY : C_PTR TYPE(MPI_Win), INTENT(IN) :: win INTEGER, INTENT(IN) :: rank INTEGER(KIND=MPI_ADDRESS_KIND), INTENT(OUT) :: size INTEGER, INTENT(OUT) :: disp_unit TYPE(C_PTR), INTENT(OUT) :: baseptr INTEGER, OPTIONAL, INTENT(OUT) :: ierror .ft P .fi .UNINDENT .UNINDENT .SH INPUT PARAMETERS .INDENT 0.0 .IP \(bu 2 \fBwin\fP: Shared memory window object (handle). .IP \(bu 2 \fBrank\fP: Rank in the group of window \fIwin\fP (non\-negative integer) or \fBMPI_PROC_NULL\fP\&. .UNINDENT .SH OUTPUT PARAMETERS .INDENT 0.0 .IP \(bu 2 \fBsize\fP: Size of the window segment (non\-negative integer). .IP \(bu 2 \fBdisp_unit\fP: Local unit size for displacements, in bytes (positive integer). .IP \(bu 2 \fBbaseptr\fP: Address for load/store access to window segment (choice). .IP \(bu 2 \fBierror\fP: Fortran only: Error status (integer). .UNINDENT .SH DESCRIPTION .sp \fI\%MPI_Win_shared_query\fP queries the process\-local address for remote memory segments created with \fI\%MPI_Win_allocate_shared\fP\&. This function can return different process\-local addresses for the same physical memory on different processes. The returned memory can be used for load/store accesses subject to the constraints defined in MPI\-3.1 section 11.7. This function can only be called with windows of flavor MPI_WIN_FLAVOR_SHARED. If the passed window is not of flavor MPI_WIN_FLAVOR_SHARED, the error MPI_ERR_RMA_FLAVOR is raised. When rank is \fBMPI_PROC_NULL\fP, the \fIpointer\fP, \fIdisp_unit\fP, and \fIsize\fP returned are the pointer, disp_unit, and size of the memory segment belonging the lowest rank that specified \fIsize\fP > 0. If all processes in the group attached to the window specified \fIsize\fP = 0, then the call returns \fIsize\fP = 0 and a \fIbaseptr\fP as if \fI\%MPI_Alloc_mem\fP was called with \fIsize\fP = 0. .SH C NOTES .sp The parameter \fIbaseptr\fP is of type \fBvoid *\fP to allow passing any pointer object for this parameter. The provided argument should be a pointer to a pointer of arbitrary type (e.g. \fBvoid **\fP). .SH ERRORS .sp Almost all MPI routines return an error value; C routines as the return result of the function and Fortran routines in the last argument. .sp Before the error value is returned, the current MPI error handler associated with the communication object (e.g., communicator, window, file) is called. If no communication object is associated with the MPI call, then the call is considered attached to MPI_COMM_SELF and will call the associated MPI error handler. When MPI_COMM_SELF is not initialized (i.e., before \fI\%MPI_Init\fP/\fI\%MPI_Init_thread\fP, after \fI\%MPI_Finalize\fP, or when using the Sessions Model exclusively) the error raises the initial error handler. The initial error handler can be changed by calling \fI\%MPI_Comm_set_errhandler\fP on MPI_COMM_SELF when using the World model, or the mpi_initial_errhandler CLI argument to mpiexec or info key to \fI\%MPI_Comm_spawn\fP/\fI\%MPI_Comm_spawn_multiple\fP\&. If no other appropriate error handler has been set, then the MPI_ERRORS_RETURN error handler is called for MPI I/O functions and the MPI_ERRORS_ABORT error handler is called for all other MPI functions. .sp Open MPI includes three predefined error handlers that can be used: .INDENT 0.0 .IP \(bu 2 \fBMPI_ERRORS_ARE_FATAL\fP Causes the program to abort all connected MPI processes. .IP \(bu 2 \fBMPI_ERRORS_ABORT\fP An error handler that can be invoked on a communicator, window, file, or session. When called on a communicator, it acts as if \fI\%MPI_Abort\fP was called on that communicator. If called on a window or file, acts as if \fI\%MPI_Abort\fP was called on a communicator containing the group of processes in the corresponding window or file. If called on a session, aborts only the local process. .IP \(bu 2 \fBMPI_ERRORS_RETURN\fP Returns an error code to the application. .UNINDENT .sp MPI applications can also implement their own error handlers by calling: .INDENT 0.0 .IP \(bu 2 \fI\%MPI_Comm_create_errhandler\fP then \fI\%MPI_Comm_set_errhandler\fP .IP \(bu 2 \fI\%MPI_File_create_errhandler\fP then \fI\%MPI_File_set_errhandler\fP .IP \(bu 2 \fI\%MPI_Session_create_errhandler\fP then \fI\%MPI_Session_set_errhandler\fP or at \fI\%MPI_Session_init\fP .IP \(bu 2 \fI\%MPI_Win_create_errhandler\fP then \fI\%MPI_Win_set_errhandler\fP .UNINDENT .sp Note that MPI does not guarantee that an MPI program can continue past an error. .sp See the \fI\%MPI man page\fP for a full list of \fI\%MPI error codes\fP\&. .sp See the Error Handling section of the MPI\-3.1 standard for more information. .sp \fBSEE ALSO:\fP .INDENT 0.0 .INDENT 3.5 .INDENT 0.0 .IP \(bu 2 \fI\%MPI_Alloc_mem\fP .IP \(bu 2 \fI\%MPI_Win_allocate_shared\fP .UNINDENT .UNINDENT .UNINDENT .SH COPYRIGHT 2003-2024, The Open MPI Community .\" Generated by docutils manpage writer. .