17.2.438. MPI_Win_flush

MPI_Win_flush, MPI_Win_flush_all - Complete all outstanding RMA operations at both the origin and the target

17.2.438.1. SYNTAX

17.2.438.1.1. C Syntax

#include <mpi.h>

int MPI_Win_flush (int rank, MPI_Win win)

int MPI_Win_flush_all (MPI_Win win)

17.2.438.1.2. Fortran Syntax

USE MPI
! or the older form: INCLUDE 'mpif.h'
MPI_WIN_FLUSH(RANK, WIN, IERROR)
     INTEGER RANK, WIN, IERROR

MPI_WIN_FLUSH_ALL(WIN, IERROR)
     INTEGER WIN, IERROR

17.2.438.1.3. Fortran 2008 Syntax

USE mpi_f08
MPI_Win_flush(rank, win, ierror)
     INTEGER, INTENT(IN) :: rank
     TYPE(MPI_Win), INTENT(IN) :: win
     INTEGER, OPTIONAL, INTENT(OUT) :: ierror

MPI_Win_flush_all(win, ierror)
     TYPE(MPI_Win), INTENT(IN) :: win
     INTEGER, OPTIONAL, INTENT(OUT) :: ierror

17.2.438.2. INPUT PARAMETERS

  • rank: Rank of window (nonnegative integer).

  • win: Window object (handle).

17.2.438.3. OUTPUT PARAMETER

  • IERROR: Fortran only: Error status (integer).

17.2.438.4. DESCRIPTION

MPI_Win_flush completes all outstanding RMA operations initiated by the calling process to the target rank on the specified window. The operations are completed both at the origin and at the target. MPI_Win_flush_all completes all outstanding RMA operations to all targets.

Can only be called from within a passive target epoch.

17.2.438.5. ERRORS

Almost all MPI routines return an error value; C routines as the value of the function and Fortran routines in the last argument.

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.