MPI_FILE_IREAD_ALL(3)

πŸ’« MPI_FILE_IREAD_ALL(3) β€” Open MPI πŸ’«

okay so bestie, welcome to MPI_File_iread_all πŸ’– this is the one from the Open MPI manual, and she is nonblocking and collective, and she reads a file starting at the location specified by the individual file pointer. main character energy fr fr ✨


🌸 NAME 🌸

MPI_File_iread_all β€” Reads a file starting at the location specified by the individual file pointer (nonblocking, collective). πŸ¦‹


✨ SYNTAX ✨

πŸ’… C Syntax

#include <mpi.h>

int MPI_File_iread_all(MPI_File fh, void  *buf, int  count,
     MPI_Datatype  datatype, MPI_Request  *request)

πŸ’… Fortran Syntax

USE MPI
! or the older form: INCLUDE 'mpif.h'
MPI_FILE_IREAD_ALL(FH, BUF, COUNT, DATATYPE, REQUEST, IERROR)
     <type>  BUF(*)
     INTEGER FH, COUNT, DATATYPE, REQUEST, IERROR

πŸ’… Fortran 2008 Syntax

USE mpi_f08
MPI_File_iread_all(fh, buf, count, datatype, request, ierror)
     TYPE(MPI_File), INTENT(IN) :: fh
     TYPE(*), DIMENSION(..) :: buf
     INTEGER, INTENT(IN) :: count
     TYPE(MPI_Datatype), INTENT(IN) :: datatype
     TYPE(MPI_Request), INTENT(OUT) :: request
     INTEGER, OPTIONAL, INTENT(OUT) :: ierror

🫢 INPUT/OUTPUT PARAMETER 🫢

  • fh β€” File handle (handle). literally the file's whole identity bestie πŸŽ€

πŸ’œ INPUT PARAMETERS πŸ’œ

  • count β€” Number of elements in the buffer (integer). that's how many she's reading, no cap ✨
  • datatype β€” Data type of each buffer element (handle). 🧚

🌈 OUTPUT PARAMETERS 🌈

  • buf β€” Initial address of buffer (choice). the cozy little landing spot for your data πŸ“
  • request β€” Request object (handle). your ticket to come back and check on her later πŸ’…
  • ierror β€” Fortran only: Error status (integer). πŸ™ˆ

πŸ‘‘ DESCRIPTION πŸ‘‘

okay so MPI_File_iread_all is the nonblocking version of MPI_File_read_all. she attempts to read from the file associated with fh β€” at the current individual file pointer position maintained by the system β€” and in which a total number of count data items having datatype type are read into the user's buffer buf. πŸ“–βœ¨

the data is taken out of those parts of the file specified by the current view. so like, the view is the vibe check for where the data lives, iykyk 🌸

MPI_File_iread_all stores the number of data-type elements actually read in status. all other fields of status are undefined. ⭐

🚨 real talk bestie: it is erroneous to call this function if MPI_MODE_SEQUENTIAL mode was specified when the file was opened. don't do it. fr fr πŸ’€

πŸ’€ 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. she might just not recover bestie 🫢

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!! 🌟 written by the Open MPI girlies, Sep 11, 2026, for MPI_FILE_IREAD_ALL(3) β€” now go read that file collectively and nonblockingly, periodt πŸ’…βœ¨πŸ¦‹

πŸ“¦ where this page comes from