MPI_FILE_READ_AT_ALL_BEGIN(3)

💖 MPI_FILE_READ_AT_ALL_BEGIN 💖

okay bestie, welcome to the Open MPI manual, section 3, and today's main character is MPI_File_read_at_all_begin — she reads a file at explicitly specified offsets, and she's the beginning part of a split collective routine (nonblocking, so she's mysterious and doesn't finish what she starts, on purpose, slay).

---

✨ SYNTAX ✨

🫶 C Syntax

#include <mpi.h>

int MPI_File_read_at_all_begin(MPI_File fh, MPI_Offset
     offset, void *buf, int count, MPI_Datatype
     datatype)

🌸 Fortran Syntax

USE MPI
! or the older form: INCLUDE 'mpif.h'
MPI_FILE_READ_AT_ALL_BEGIN(FH, OFFSET, BUF,
     COUNT, DATATYPE, IERROR)
     <type>  BUF(*)
     INTEGER FH, COUNT, DATATYPE, IERROR
     INTEGER(KIND=MPI_OFFSET_KIND)   OFFSET

🦋 Fortran 2008 Syntax

USE mpi_f08
MPI_File_read_at_all_begin(fh, offset, buf, count, datatype, ierror)
     TYPE(MPI_File), INTENT(IN) :: fh
     INTEGER(KIND=MPI_OFFSET_KIND), INTENT(IN) :: offset
     TYPE(*), DIMENSION(..), ASYNCHRONOUS :: buf
     INTEGER, INTENT(IN) :: count
     TYPE(MPI_Datatype), INTENT(IN) :: datatype
     INTEGER, OPTIONAL, INTENT(OUT) :: ierror

---

📥 INPUT PARAMETERS

• fh — the file handle (a handle, bestie, that's the whole vibe).
• offset — file offset (integer).
• count — number of elements in the buffer (integer).
• datatype — data type of each buffer element.

📤 OUTPUT PARAMETERS

• buf — initial address of the buffer (choice).
• ierror — Fortran only: error status (integer).

---

💅 DESCRIPTION 💅

So MPI_File_read_at_all_begin is the beginning part of a split collective routine, and what she attempts to do is read from the file associated with fh — at the offset position — a total number of count data items having datatype type, straight into the user's buffer buf. 🎀

Now the important part, no cap: the offset is in etype units relative to the current view. That is, holes are not counted when locating an offset. The data is taken out of those parts of the file specified by the current view. Periodt. 👑

---

📝 NOTES 📝

All the nonblocking collective routines for data access are “split” into two routines, each with _begin or _end as a suffix. These split collective routines are subject to the semantic rules described in Section 9.4.5 of the MPI-2 standard.

---

💀 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. Like, she said what she said. 😭

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

---

and that's the whole page bestie 🫶 go read your files (the nonblocking way, obviously). this absolute icon of a manpage dropped on Sep 10, 2026, and yeah it's MPI_FILE_READ_AT_ALL_BEGIN(3) — iykyk ✨💖