focal (3) MPI_Win_flush_all.openmpi.3.gz

NAME

       MPI_Win_flush -  Complete all outstanding RMA operations at the given target.

SYNOPSIS

       int MPI_Win_flush(int rank, MPI_Win win)

       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.

INPUT PARAMETERS

       rank   - rank of window (nonnegative integer)
       win    - window object (handle)

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 guarentee 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_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_flush_all MPI_Win_flush_local MPI_Win_flush_local_all MPI_Win_lock MPI_Win_lock_all

                                                   11/12/2019                                   MPI_Win_flush(3)