MPI_Waitall function

Article
09/14/2018

Completes multiple outstanding operations.

Syntax

int MPIAPI MPI_Waitall(
   int                              count,
   _Inout_count_(count) MPI_Request *array_of_requests,
   _Out_cap_(count) MPI_Status      *array_of_statuses
);

Parameters

count
The number of entries in the array_of_requests parameter.
array_of_requests
An array of MPI_Request handles of outstanding operations.
array_of_statuses
An array of MPI_Status objects that describe the completed operations. It might be MPI_STATUSES_IGNORE if no status information is requested.

Return value

Returns MPI_SUCCESS on success. Otherwise, the return value is an error code.

Returns MPI_ERR_IN_STATUS if one or more operations are completed in error. The status of failed operations is returned in the corresponding entry in the array_of_statuses parameter.

In Fortran the return value is stored in the IERROR parameter.

Fortran

    MPI_WAITALL(COUNT, ARRAY_OF_REQUESTS, INDEX, STATUS, IERROR)
        INTEGER COUNT, ARRAY_OF_REQUESTS, INDEX, STATUS(MPI_STATUS_SIZE), IERROR

Remarks

This function is a non-local operation, successful completion might depend on matching operations at other processes.

A call to MPI_Waitall returns when all of the operations that are associated with active requests in the array_of_requests array are completed. Any entries that are associated with persistent communication operations result in the persistent request are marked as inactive. Other operations are deallocated, and their corresponding entries in array_of_requests are set to MPI_REQUEST_NULL.

Entries in the array_of_requests parameter can be MPI_REQUEST_NULL or a handle to an inactive persistent communication request. If the count parameter is zero, or all entries in array_of_requests are MPI_REQUEST_NULL or inactive persistent communication requests, then the function returns immediately with the index parameter set to MPI_UNDEFINED and an empty status.

Requirements

Product	HPC Pack 2012 MS-MPI Redistributable Package, HPC Pack 2008 R2 MS-MPI Redistributable Package, HPC Pack 2008 MS-MPI Redistributable Package or HPC Pack 2008 Client Utilities
Header	Mpi.h; Mpif.h
Library	Msmpi.lib
DLL	Msmpi.dll