Synopsis

int MPI_Win_allocate(MPI_Aint size, int disp_unit, MPI_Info info, MPI_Comm comm,
                     void *baseptr, MPI_Win *win)
int MPI_Win_allocate_c(MPI_Aint size, MPI_Aint disp_unit, MPI_Info info,
                       MPI_Comm comm, void *baseptr, MPI_Win *win)

Input Parameters

size

size of window in bytes (non-negative integer)

disp_unit

local unit size for displacements, in bytes (positive integer)

info

info argument (handle)

comm

intra-communicator (handle)

Output Parameters

baseptr

initial address of window (choice)

win

window object returned by call (handle)

Description

MPI_Win_allocate is a collective operation over the group of comm that allocates memory and creates a window for remote memory access operations. On each process, the call allocates at least size bytes and returns a pointer in baseptr along with a window handle usable by all processes in the group. The size argument may differ at each process and size = 0 is valid. A library may allocate and expose more memory to create a fast, globally symmetric allocation. The disp_unit argument facilitates address arithmetic in RMA operations by scaling target displacement arguments. The info argument provides optimization hints similar to MPI_WIN_CREATE and MPI_ALLOC_MEM. Implementations may make allocated memory available for load/store accesses by processes in the same shared memory domain. Default memory alignment requirements apply to all processes with nonzero size argument.

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 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 'call' statement.

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 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 '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_COMM - Invalid communicator. A common error is to use a null communicator in a call (not even allowed in 'MPI_Comm_rank').

  • MPI_ERR_DISP - Invalid displacement argument

  • MPI_ERR_INFO - Invalid Info

  • MPI_ERR_SIZE - Invalid size argument

  • MPI_ERR_OTHER - Other error; use 'MPI_Error_string' to get more information about this error code.

See also