Skip site navigation (1)Skip section navigation (2)

  
 
  

home | help
MPI_Win_shared_query(3) 	       MPI		 MPI_Win_shared_query(3)

NAME
     MPI_Win_shared_query  -   Query  the size and base pointer for a patch of a
     shared memory window

SYNOPSIS
     int MPI_Win_shared_query(MPI_Win win, int rank, MPI_Aint *size, int *disp_unit,
     void *baseptr)

     int MPI_Win_shared_query_c(MPI_Win win, int rank, MPI_Aint *size,
     MPI_Aint *disp_unit, void *baseptr)

INPUT PARAMETERS
     win    - shared memory window object (handle)
     rank   - rank in the group of window win or MPI_PROC_NULL (non-negative in-
	    teger)

OUTPUT PARAMETERS
     size   - size of the window segment (non-negative integer)
     disp_unit
	    - local unit size for displacements, in bytes (positive integer)
     baseptr
	    - address for load/store access to window segment (choice)

NOTES
     The returned baseptr points to the calling process  address  space  of  the
     shared segment belonging to the target rank.

THREAD AND INTERRUPT SAFETY
     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 malloc or other non-MPICH
     runtime routines that are themselves not interrupt-safe.

NOTES FOR FORTRAN
     All MPI routines in Fortran (except for MPI_WTIME and MPI_WTICK )	have  an
     additional argument ierr at the end of the argument list.	ierr is an inte-
     ger  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 call state-
     ment.

     All MPI objects (e.g., MPI_Datatype , MPI_Comm ) are  of  type  INTEGER  in
     Fortran.

ERRORS
     All MPI routines (except MPI_Wtime and MPI_Wtick ) return an error value; C
     routines  as the value of the function and Fortran routines in the last ar-
     gument.  Before the value is returned, the current  MPI  error  handler  is
     called.  By default, this error handler aborts the MPI job.  The error han-
     dler  may	be  changed  with  MPI_Comm_set_errhandler  (for communicators),
     MPI_File_set_errhandler (for files), and  MPI_Win_set_errhandler  (for  RMA
     windows).	 The MPI-1 routine MPI_Errhandler_set may be used but its use is
     deprecated.  The predefined error handler MPI_ERRORS_RETURN may be used  to
     cause  error  values to be returned.  Note that MPI does not guarantee that
     an MPI program can continue past an  error;  however,  MPI  implementations
     will attempt to continue whenever possible.

     MPI_SUCCESS
	    - No error; MPI routine completed successfully.
     MPI_ERR_ARG
	    -  Invalid argument.  Some argument is invalid and is not identified
	    by a specific error class (e.g., MPI_ERR_RANK ).
     MPI_ERR_RANK
	    - Invalid source or destination rank.  Ranks must  be  between  zero
	    and  the  size  of	the communicator minus one; ranks in a receive (
	    MPI_Recv  ,  MPI_Irecv  ,  MPI_Sendrecv  ,	 etc.)	 may   also   be
	    MPI_ANY_SOURCE .
     MPI_ERR_WIN
	    - Invalid MPI window object
     MPI_ERR_OTHER
	    -  Other  error;  use MPI_Error_string to get more information about
	    this error code.

SEE ALSO
     MPI_Win_allocate_shared

				    4/10/2026		 MPI_Win_shared_query(3)

Want to link to this manual page? Use this URL:
<https://man.freebsd.org/cgi/man.cgi?query=MPI_Win_shared_query_c&sektion=3&manpath=FreeBSD+Ports+15.1.quarterly>

home | help