mpi_win_free(3openmpi) [osx man page]

MPI_Win_free(3OpenMPI)													    MPI_Win_free(3OpenMPI)

NAME

       MPI_Win_free - Frees the window object and returns a null handle.

SYNTAX

C Syntax
       #include <mpi.h>
       int MPI_Win_free(MPI_Win *win)

Fortran Syntax
       INCLUDE 'mpif.h'
       MPI_WIN_FREE(WIN, IERROR)
	    INTEGER WIN, IERROR

C++ Syntax
       #include <mpi.h>
       void MPI::Win::Free()

INPUT
/OUTPUT PARAMETER
       win	 Window object (handle).

OUTPUT PARAMETER

       IERROR	 Fortran only: Error status (integer).

DESCRIPTION

       MPI_Win_free  frees  the  window object win and returns a null handle (equal to MPI_WIN_NULL). This collective call is executed by all pro-
       cesses in the group associated with win. It can be invoked by a process only after it has completed its involvement in  RMA  communications
       on  window  win, that is, the process has called MPI_Win_fence, or called MPI_Win_unlock to match a previous call to MPI_Win_lock. When the
       call returns, the window memory can be freed.

ERRORS

       Almost all MPI routines return an error value; C routines as the value of the function and Fortran routines in the last argument. C++ func-
       tions  do not return errors. If the default error handler is set to MPI::ERRORS_THROW_EXCEPTIONS, then on error the C++ exception mechanism
       will be used to throw an MPI:Exception object.

       Before the error value is returned, the current MPI error handler is called. By default, this error handler aborts the MPI job, except  for
       I/O  function  errors. The error handler may be changed with MPI_Comm_set_errhandler; 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.

SEE ALSO

       MPI_Win_create MPI_Win_fence MPI_Win_unlock

Open MPI 1.2							    March 2006						    MPI_Win_free(3OpenMPI)

MPI_Win_unlock(3OpenMPI)												  MPI_Win_unlock(3OpenMPI)

NAME

       MPI_Win_unlock - Completes an RMA access epoch started by a call to MPI_Win_lock.

SYNTAX

C Syntax
       #include <mpi.h>
       int MPI_Win_unlock(int rank, MPI_Win win)

Fortran Syntax
       INCLUDE 'mpif.h'
       MPI_WIN_UNLOCK(RANK, WIN, IERROR)
	    INTEGER RANK, WIN, IERROR

C++ Syntax
       #include <mpi.h>
       void MPI::Win::Unlock(int rank) const

INPUT PARAMETERS

       rank	 Rank of window (nonnegative integer).

       win	 Window object (handle).

OUTPUT PARAMETER

       IERROR	 Fortran only: Error status (integer).

DESCRIPTION

       MPI_Win_unlock  completes  an  RMA  access epoch started by a call to MPI_Win_lock. RMA operations issued during this period will have com-
       pleted both at the origin and at the target when the call returns.

       Locks are used to protect accesses to the locked target window effected by RMA calls issued between the lock and unlock call, and  to  pro-
       tect local load/store accesses to a locked local window executed between the lock and unlock call. Accesses that are protected by an exclu-
       sive lock will not be concurrent at the window site with other accesses to the same window that are lock protected. Accesses that are  pro-
       tected by a shared lock will not be concurrent at the window site with accesses protected by an exclusive lock to the same window.

ERRORS

       Almost all MPI routines return an error value; C routines as the value of the function and Fortran routines in the last argument. C++ func-
       tions do not return errors. If the default error handler is set to MPI::ERRORS_THROW_EXCEPTIONS, then on error the C++ exception  mechanism
       will be used to throw an MPI:Exception object.

       Before  the error value is returned, the current MPI error handler is called. By default, this error handler aborts the MPI job, except for
       I/O function errors. The error handler may be changed with MPI_Comm_set_errhandler; 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.

SEE ALSO

       MPI_Win_lock

Open MPI 1.2							    March 2007						  MPI_Win_unlock(3OpenMPI)