MPI_WIN_SYNC(3)

πŸ’– MPI_WIN_SYNC(3) πŸ’–

okay so this is the Open MPI manual page for MPI_Win_sync, bestie β€” welcome to the group chat 🫢


✨ NAME ✨

MPI_Win_sync β€” sync up the private and public copies of the window. literally just making them agree on the vibes πŸ’…


πŸ¦‹ SYNTAX πŸ¦‹

🌸 C Syntax

#include <mpi.h>

int MPI_Win_sync (MPI_Win win)

🌸 Fortran Syntax

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

🌸 Fortran 2008 Syntax

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

πŸŽ€ INPUT PARAMETERS πŸŽ€

  • win β€” the window object (handle). that's your window bestie, hand it over πŸ’–

⭐ OUTPUT PARAMETER ⭐

  • ierror β€” Fortran only: the error status (an integer). C girlies get theirs as the return value instead, iykyk ✨

πŸ”₯ DESCRIPTION πŸ”₯

MPI_Win_sync synchronizes the private and public window copies of win. the way it does this? for the purposes of syncing the private and public window, MPI_Win_sync has the effect of ending and reopening an access and exposure epoch on the window. icon behavior honestly πŸ‘‘

⚠️ but no cap β€” it does not actually end an epoch, and it does not complete any pending MPI RMA operations. it just gives that effect. don't come for me if you assumed otherwise πŸ™ˆ

πŸ’€ ERRORS πŸ’€

Almost all MPI routines return an error value. C routines give it to you as the return result of the function, and Fortran routines put it in the last argument. periodt πŸ’…

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. yeah. all of them. 😭
  • 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. the gentle option fr fr 🌸

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. so like… be careful out there πŸ’€

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.


2003-2026, The Open MPI Community πŸ’œ


and that's the whole page bestie, you ate that πŸ“ kudos to the Open MPI girlies β€” this one's from the Open MPI crew, dated Sep 11, 2026, and it's the MPI_WIN_SYNC(3) page, mwah πŸ’‹πŸŒˆ

πŸ“¦ where this page comes from