MPI_FILE_WRITE_ORDERED(3)

๐Ÿ’– MPI_File_write_ordered ๐Ÿ’–

okay bestie, welcome to the Open MPI manual, section 3 โ€” this is the MPI_File_write_ordered page and it's literally about writing to a file at a location that the shared file pointer picks out. Blocking. Collective. Very demure, very mindful. โœจ

MPI_File_write_ordered โ€” Writes a file at a location specified by a shared file pointer (blocking, collective).


๐ŸŒธ SYNTAX ๐ŸŒธ

โœจ C Syntax

#include <mpi.h>

int MPI_File_write_ordered(MPI_File fh, const void *buf,
    int count, MPI_Datatype datatype,
    MPI_Status *status)

โœจ Fortran Syntax

USE MPI
! or the older form: INCLUDE 'mpif.h'

MPI_FILE_WRITE_ORDERED(FH, BUF, COUNT, DATATYPE,
    STATUS, IERROR)
    <type>  BUF(*)
    INTEGER FH, COUNT, DATATYPE, STATUS(MPI_STATUS_SIZE), IERROR

โœจ Fortran 2008 Syntax

USE mpi_f08

MPI_File_write_ordered(fh, buf, count, datatype, status, ierror)
    TYPE(MPI_File), INTENT(IN) :: fh
    TYPE(*), DIMENSION(..), INTENT(IN) :: buf
    INTEGER, INTENT(IN) :: count
    TYPE(MPI_Datatype), INTENT(IN) :: datatype
    TYPE(MPI_Status) :: status
    INTEGER, OPTIONAL, INTENT(OUT) :: ierror

๐ŸŽ€ INPUT PARAMETERS ๐ŸŽ€

  • fh โ€” the File handle (a handle, bestie). ๐Ÿ—‚๏ธ
  • buf โ€” initial address of the buffer (a choice, iykyk). ๐Ÿ“ฎ
  • count โ€” how many elements are chillin' in that buffer (an integer). ๐Ÿ”ข
  • datatype โ€” the data type of each buffer element (a handle). ๐Ÿท๏ธ

๐Ÿฆ‹ OUTPUT PARAMETERS ๐Ÿฆ‹

  • status โ€” Status object (a Status, iconic). ๐Ÿ“‹
  • ierror โ€” Fortran only: error status (an integer). ๐Ÿšจ

๐ŸŒˆ DESCRIPTION ๐ŸŒˆ

okay so MPI_File_write_ordered is a collective routine, no cap. That means every single process in the communicator group associated with the file handle fh has to call it. Everyone. Together. Group chat rules. ๐Ÿ’…

Each process is allowed to pass different argument values for the datatype and count arguments โ€” so like, nobody has to match, it's giving individuality. โœจ

Every process attempts to write, into the file associated with fh, a total number of count data items having datatype type contained in the user's buffer buf. ๐Ÿซถ

For each process, the location in the file where the data gets written is the position at which the shared file pointer would be after all processes whose ranks within the group are less than that of this process had written their data. Yeah. Rank order = write order. Main character energy, in line. ๐Ÿ‘‘

MPI_File_write_ordered returns the number of datatype elements written in status. ๐Ÿ“Š

And the shared file pointer gets updated by the amounts of data requested by all processes of the group. Everyone pitched in, everyone moves the pointer. periodt. ๐ŸŒŸ


๐Ÿ’€ ERRORS ๐Ÿ’€

ngl bestie, basically 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 ships with three predefined error handlers you can use:

  • 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. like, it might just be over. ๐Ÿ™ˆ

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! ๐ŸŽ€ this little manual entry dropped on Sep 10, 2026, straight from the Open MPI girlies, and it's filed under MPI_FILE_WRITE_ORDERED(3) in section 3. slay, go write something ordered. ๐Ÿ’œ๐ŸŒธ

๐Ÿ“ฆ where this page comes from