MPI_WIN_FLUSH_LOCAL_ALL(3)

πŸ’… Open MPI: MPI_Win_flush_local / MPI_Win_flush_local_all πŸ’…

okay bestie, you're reading the Open MPI manual page for MPI_WIN_FLUSH_LOCAL_ALL(3), and it's giving local flush excellence. Two routines, one very specific job: getting your outstanding RMA ops locally completed at the origin. Let's get into it. ✨


🌸 NAME 🌸

MPI_Win_flush_local, MPI_Win_flush_local_all β€” Complete all outstanding RMA operations at both the origin


πŸ› οΈ SYNTAX πŸ› οΈ

πŸ’» C Syntax πŸ’»

#include <mpi.h>

int MPI_Win_flush_local (int rank, MPI_Win win)

int MPI_Win_flush_local_all (MPI_Win win)

🧑 Fortran Syntax 🧑

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

MPI_WIN_FLUSH_LOCAL_ALL(WIN, IERROR)
     INTEGER WIN, IERROR

πŸ¦‹ Fortran 2008 Syntax πŸ¦‹

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

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

🧾 INPUT PARAMETERS 🧾

  • rank β€” Rank of window (nonnegative integer).
  • win β€” Window object (handle).

πŸ“€ OUTPUT PARAMETER πŸ“€

  • ierror β€” Fortran only: Error status (integer).

πŸ’– DESCRIPTION πŸ’–

So, MPI_Win_flush_local locally completes at the origin all outstanding RMA operations initiated by the calling process to the target process specified by rank on the specified window. For example, after this routine completes, the user may reuse any buffers provided to put, get, or accumulate operations. MPI_Win_flush_local_all locally completes at the origin all outstanding RMA operations to all targets.

🚨 Important vibe check: it can only be called from within a passive target epoch. That's the rule, bestie. No cap. 🚨

😭 ERRORS 😭

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

Before the error value is returned, the current MPI error handler associated with the communication object (e.g., communicator, window, file) is called. If no communication object is associated with the MPI call, then the call is considered attached to MPI_COMM_SELF and will call the associated MPI error handler. When MPI_COMM_SELF is not initialized (i.e., before MPI_Init/MPI_Init_thread, after MPI_Finalize, or when using the Sessions Model exclusively) the error raises the initial error handler. The initial error handler can be changed by calling MPI_Comm_set_errhandler on MPI_COMM_SELF when using the World model, or the mpi_initial_errhandler CLI argument to mpiexec or info key to MPI_Comm_spawn/MPI_Comm_spawn_multiple. If no other appropriate error handler has been set, then the MPI_ERRORS_RETURN error handler is called for MPI I/O functions and the MPI_ERRORS_ABORT error handler is called for all other MPI functions.

Open MPI includes three predefined error handlers that can be used:

  • MPI_ERRORS_ARE_FATAL β€” Causes the program to abort all connected MPI processes.
  • MPI_ERRORS_ABORT β€” An error handler that can be invoked on a communicator, window, file, or session. When called on a communicator, it acts as if MPI_Abort was called on that communicator. If called on a window or file, acts as if MPI_Abort was called on a communicator containing the group of processes in the corresponding window or file. If called on a session, aborts only the local process.
  • MPI_ERRORS_RETURN β€” Returns an error code to the application.

MPI applications can also implement their own error handlers by calling:

  • MPI_Comm_create_errhandler then MPI_Comm_set_errhandler
  • MPI_File_create_errhandler then MPI_File_set_errhandler
  • MPI_Session_create_errhandler then MPI_Session_set_errhandler or at MPI_Session_init
  • MPI_Win_create_errhandler then MPI_Win_set_errhandler

Note that MPI does not guarantee that an MPI program can continue past an error.

See the MPI man page for a full list of MPI error codes.

See the Error Handling section of the MPI-3.1 standard for more information.


πŸ‘€ SEE ALSO πŸ‘€

  • MPI_Win_flush
  • MPI_Win_lock
  • MPI_Win_lock_all

2003-2026, The Open MPI Community


xoxo, this iconic manual page is brought to you by Open MPI β€” copyright 2003-2026, The Open MPI Community β€” and the footer stamp says Sep 11, 2026, serving MPI_WIN_FLUSH_LOCAL_ALL(3) realness. byeee πŸ’œβœ¨

πŸ“¦ where this page comes from