MPI_FILE_SYNC(3)

💖 MPI_File_sync 💖

Open MPI manual, page MPI_FILE_SYNC(3), section 3 — welcome to the file-handle corner of the group chat, bestie. 🫶

---

🌸 NAME 🌸

MPI_File_sync — Makes semantics consistent for data-access operations (collective). periodt. 💅

✨ SYNTAX ✨

🌟 C Syntax 🌟

#include <mpi.h>

int MPI_File_sync(MPI_File fh)

🦋 Fortran Syntax 🦋

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

🎀 Fortran 2008 Syntax 🎀

USE mpi_f08
MPI_File_sync(fh, ierror)
     TYPE(MPI_File), INTENT(IN) :: fh
     INTEGER, OPTIONAL, INTENT(OUT) :: ierror

---

💕 INPUT PARAMETER 💕

• fh — file handle (handle). That's the whole vibe. 🎀

💫 OUTPUT PARAMETER 💫

• ierror — Fortran only: error status (integer). 💅

🔥 DESCRIPTION 🔥

Okay so calling MPI_File_sync with fh causes all previous writes to fh by the calling process to be written to permanent storage. If other processes have made updates to permanent storage, then all such updates become visible to subsequent reads of fh by the calling process. The way that permanent-storage visibility just happens? Obsessed. ✨

MPI_File_sync is a collective operation. The user is responsible for ensuring that all nonblocking requests on fh have been completed before calling MPI_File_sync. Otherwise, the call to MPI_File_sync is erroneous. 🚨

🚨 Collective alert, bestie: all nonblocking requests on fh need to be done before you call MPI_File_sync. Not done = erroneous. 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.

👑 COPYRIGHT 👑

2003-2026, The Open MPI Community — that's the copyright line, bestie, keep it cute and keep it exact. 🫶

---

Cute sign-off: this was Open MPI, page MPI_FILE_SYNC(3), dated Sep 11, 2026 — bestie out 💜✨