Synopsis

int MPI_File_read_all_begin(MPI_File fh, void *buf, int count,
                            MPI_Datatype datatype)
int MPI_File_read_all_begin_c(MPI_File fh, void *buf, MPI_Count count,
                              MPI_Datatype datatype)

Input Parameters

fh

file handle (handle)

count

number of elements in buffer (integer)

datatype

datatype of each buffer element (handle)

Output Parameters

buf

initial address of buffer (choice)

Description

MPI_File_read_all_begin begins a split collective read operation using the individual file pointer. This is the begin routine of a split collective pair that, when completed with MPI_FILE_READ_ALL_END, produces results equivalent to MPI_FILE_READ_ALL. Begin calls are collective over the group of processes that participated in the collective open and follow the ordering rules for collective calls. The begin routine is a nonlocal, incomplete procedure that may or may not return before it is called in all MPI processes of the group. After the begin call is initiated, the individual file pointer is updated to point to the next etype after the last one that will be accessed.

Each file handle may have at most one active split collective operation at any time. In a multithreaded implementation, the split collective begin and end operations called by a process must be called from the same thread. It is erroneous to access the buf passed to a begin routine or to perform any collective I/O operation on the file handle between the begin and end calls. Split collective operations do not match regular collective operations. It is erroneous to call this routine if MPI_MODE_SEQUENTIAL was specified when the file was opened.

Thread and Interrupt Safety

This routine is thread-safe. This means that this routine may be safely used by multiple threads without the need for any user-provided thread locks. However, the routine is not interrupt safe. Typically, this is due to the use of memory allocation routines such as 'malloc' or other non-MPICH runtime routines that are themselves not interrupt-safe.

Notes for Fortran

All MPI routines in Fortran (except for 'MPI_WTIME' and 'MPI_WTICK') have an additional argument 'ierr' at the end of the argument list. 'ierr' is an integer and has the same meaning as the return value of the routine in C. In Fortran, MPI routines are subroutines, and are invoked with the 'call' statement.

All MPI objects (e.g., 'MPI_Datatype', 'MPI_Comm') are of type 'INTEGER' in Fortran.

Errors

All MPI routines (except 'MPI_Wtime' and 'MPI_Wtick') return an error value; C routines as the value of the function and Fortran routines in the last argument. Before the value is returned, the current MPI error handler is called. By default, this error handler aborts the MPI job. The error handler may be changed with 'MPI_Comm_set_errhandler' (for communicators), 'MPI_File_set_errhandler' (for files), and 'MPI_Win_set_errhandler' (for RMA windows). The MPI-1 routine 'MPI_Errhandler_set' may be used but its use is deprecated. The predefined error handler 'MPI_ERRORS_RETURN' may be used to cause error values to be returned. Note that MPI does not guarantee that an MPI program can continue past an error; however, MPI implementations will attempt to continue whenever possible.

  • MPI_SUCCESS - No error; MPI routine completed successfully.

  • MPI_ERR_BUFFER - Invalid buffer pointer. Usually a null buffer where one is not valid.

  • MPI_ERR_COUNT - Invalid count argument. Count arguments must be non-negative; a count of zero is often valid.

  • MPI_ERR_TYPE - Invalid datatype argument. Additionally, this error can occur if an uncommitted MPI_Datatype (see 'MPI_Type_commit') is used in a communication call.

  • MPI_ERR_OTHER - Other error; use 'MPI_Error_string' to get more information about this error code.