Synopsis
int MPI_Win_free(MPI_Win *win)
Input/Output Parameters
- win
-
window object (handle)
Description
MPI_Win_free frees a window object and returns a null handle equal to MPI_WIN_NULL.
This procedure is collective over the group associated with win. MPI_Win_free may be invoked by a process only after it has completed its involvement in RMA communications on the window, such as calling MPI_WIN_FENCE, MPI_WIN_WAIT to match a previous MPI_WIN_POST, MPI_WIN_COMPLETE to match a previous MPI_WIN_START, or MPI_WIN_UNLOCK to match a previous MPI_WIN_LOCK. For windows created with MPI_WIN_CREATE, the associated memory may be freed after the call returns. For windows created with MPI_WIN_ALLOCATE or MPI_WIN_ALLOCATE_SHARED, MPI_Win_free will free the memory that was allocated in those calls. Freeing a window created with MPI_WIN_CREATE_DYNAMIC detaches all associated memory. MPI_Win_free is required to delay its return until all accesses to the local window using passive target synchronization have completed, making it synchronizing unless the window was created with the no_locks info key set to true.
Notes
If successfully freed, win is set to MPI_WIN_NULL.
If the user attribute free function returns an error, then do not free the window
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_WIN - Invalid MPI window object
-
MPI_ERR_OTHER - Other error; use 'MPI_Error_string' to get more information about this error code.