|
Packit |
0848f5 |
|
|
Packit |
0848f5 |
<HTML>
|
|
Packit |
0848f5 |
<HEAD>
|
|
Packit |
0848f5 |
<META NAME="GENERATOR" CONTENT="DOCTEXT">
|
|
Packit |
0848f5 |
<TITLE>MPI_Testall</TITLE>
|
|
Packit |
0848f5 |
</HEAD>
|
|
Packit |
0848f5 |
<BODY BGCOLOR="FFFFFF">
|
|
Packit |
0848f5 |
MPI_Testall
|
|
Packit |
0848f5 |
Tests for the completion of all previously initiated requests
|
|
Packit |
0848f5 |
Synopsis
|
|
Packit |
0848f5 |
|
|
Packit |
0848f5 |
int MPI_Testall(int count, MPI_Request array_of_requests[], int *flag,
|
|
Packit |
0848f5 |
MPI_Status array_of_statuses[])
|
|
Packit |
0848f5 |
|
|
Packit |
0848f5 |
Input Parameters
|
|
Packit |
0848f5 |
|
|
Packit |
0848f5 |
count lists length (integer)
|
|
Packit |
0848f5 |
|
|
Packit |
0848f5 |
array_of_requests array of requests (array of handles)
|
|
Packit |
0848f5 |
|
|
Packit |
0848f5 |
|
|
Packit |
0848f5 |
Output Parameters
|
|
Packit |
0848f5 |
|
|
Packit |
0848f5 |
flag True if all requests have completed; false otherwise (logical)
|
|
Packit |
0848f5 |
|
|
Packit |
0848f5 |
array_of_statuses array of status objects (array of Status). May be
|
|
Packit |
0848f5 |
<tt>MPI_STATUSES_IGNORE</tt>.
|
|
Packit |
0848f5 |
|
|
Packit |
0848f5 |
|
|
Packit |
0848f5 |
Notes
|
|
Packit |
0848f5 |
<tt>flag</tt> is true only if all requests have completed. Otherwise, flag is
|
|
Packit |
0848f5 |
false and neither the <tt>array_of_requests</tt> nor the <tt>array_of_statuses</tt> is
|
|
Packit |
0848f5 |
modified.
|
|
Packit |
0848f5 |
|
|
Packit |
0848f5 |
If one or more of the requests completes with an error, <tt>MPI_ERR_IN_STATUS</tt> is
|
|
Packit |
0848f5 |
returned. An error value will be present is elements of <tt>array_of_status
|
|
Packit |
0848f5 |
</tt>associated with the requests. Likewise, the <tt>MPI_ERROR</tt> field in the status
|
|
Packit |
0848f5 |
elements associated with requests that have successfully completed will be
|
|
Packit |
0848f5 |
<tt>MPI_SUCCESS</tt>. Finally, those requests that have not completed will have a
|
|
Packit |
0848f5 |
value of <tt>MPI_ERR_PENDING</tt>.
|
|
Packit |
0848f5 |
|
|
Packit |
0848f5 |
While it is possible to list a request handle more than once in the
|
|
Packit |
0848f5 |
<tt>array_of_requests</tt>, such an action is considered erroneous and may cause the
|
|
Packit |
0848f5 |
program to unexecpectedly terminate or produce incorrect results.
|
|
Packit |
0848f5 |
|
|
Packit |
0848f5 |
Thread and Interrupt Safety
|
|
Packit |
0848f5 |
|
|
Packit |
0848f5 |
This routine is thread-safe. This means that this routine may be
|
|
Packit |
0848f5 |
safely used by multiple threads without the need for any user-provided
|
|
Packit |
0848f5 |
thread locks. However, the routine is not interrupt safe. Typically,
|
|
Packit |
0848f5 |
this is due to the use of memory allocation routines such as <tt>malloc
|
|
Packit |
0848f5 |
</tt>or other non-MPICH runtime routines that are themselves not interrupt-safe.
|
|
Packit |
0848f5 |
|
|
Packit |
0848f5 |
Notes on the MPI_Status argument
|
|
Packit |
0848f5 |
|
|
Packit |
0848f5 |
The <tt>MPI_ERROR</tt> field of the status return is only set if
|
|
Packit |
0848f5 |
the return from the MPI routine is <tt>MPI_ERR_IN_STATUS</tt>. That error class
|
|
Packit |
0848f5 |
is only returned by the routines that take an array of status arguments
|
|
Packit |
0848f5 |
(<tt>MPI_Testall</tt>, <tt>MPI_Testsome</tt>, <tt>MPI_Waitall</tt>, and <tt>MPI_Waitsome</tt>). In
|
|
Packit |
0848f5 |
all other cases, the value of the <tt>MPI_ERROR</tt> field in the status is
|
|
Packit |
0848f5 |
unchanged. See section 3.2.5 in the MPI-1.1 specification for the
|
|
Packit |
0848f5 |
exact text.
|
|
Packit |
0848f5 |
|
|
Packit |
0848f5 |
For send operations, the only use of status is for <tt>MPI_Test_cancelled</tt> or
|
|
Packit |
0848f5 |
in the case that there is an error in one of the four routines that
|
|
Packit |
0848f5 |
may return the error class <tt>MPI_ERR_IN_STATUS</tt>, in which case the
|
|
Packit |
0848f5 |
<tt>MPI_ERROR</tt> field of status will be set. In that case, the value
|
|
Packit |
0848f5 |
will be set to <tt>MPI_SUCCESS</tt> for any send or receive operation that completed
|
|
Packit |
0848f5 |
successfully, or <tt>MPI_ERR_PENDING</tt> for any operation which has neither
|
|
Packit |
0848f5 |
failed nor completed.
|
|
Packit |
0848f5 |
|
|
Packit |
0848f5 |
Notes for Fortran
|
|
Packit |
0848f5 |
All MPI routines in Fortran (except for <tt>MPI_WTIME</tt> and <tt>MPI_WTICK</tt>) have
|
|
Packit |
0848f5 |
an additional argument <tt>ierr</tt> at the end of the argument list. <tt>ierr
|
|
Packit |
0848f5 |
</tt>is an integer and has the same meaning as the return value of the routine
|
|
Packit |
0848f5 |
in C. In Fortran, MPI routines are subroutines, and are invoked with the
|
|
Packit |
0848f5 |
<tt>call</tt> statement.
|
|
Packit |
0848f5 |
|
|
Packit |
0848f5 |
All MPI objects (e.g., <tt>MPI_Datatype</tt>, <tt>MPI_Comm</tt>) are of type <tt>INTEGER
|
|
Packit |
0848f5 |
</tt>in Fortran.
|
|
Packit |
0848f5 |
|
|
Packit |
0848f5 |
Errors
|
|
Packit |
0848f5 |
|
|
Packit |
0848f5 |
All MPI routines (except <tt>MPI_Wtime</tt> and <tt>MPI_Wtick</tt>) return an error value;
|
|
Packit |
0848f5 |
C routines as the value of the function and Fortran routines in the last
|
|
Packit |
0848f5 |
argument. Before the value is returned, the current MPI error handler is
|
|
Packit |
0848f5 |
called. By default, this error handler aborts the MPI job. The error handler
|
|
Packit |
0848f5 |
may be changed with <tt>MPI_Comm_set_errhandler</tt> (for communicators),
|
|
Packit |
0848f5 |
<tt>MPI_File_set_errhandler</tt> (for files), and <tt>MPI_Win_set_errhandler</tt> (for
|
|
Packit |
0848f5 |
RMA windows). The MPI-1 routine <tt>MPI_Errhandler_set</tt> may be used but
|
|
Packit |
0848f5 |
its use is deprecated. The predefined error handler
|
|
Packit |
0848f5 |
<tt>MPI_ERRORS_RETURN</tt> may be used to cause error values to be returned.
|
|
Packit |
0848f5 |
Note that MPI does not guarentee that an MPI program can continue past
|
|
Packit |
0848f5 |
an error; however, MPI implementations will attempt to continue whenever
|
|
Packit |
0848f5 |
possible.
|
|
Packit |
0848f5 |
|
|
Packit |
0848f5 |
- MPI_SUCCESS
- No error; MPI routine completed successfully.
|
|
Packit |
0848f5 |
|
|
Packit |
0848f5 |
- MPI_ERR_IN_STATUS
- The actual error value is in the <tt>MPI_Status</tt> argument.
|
|
Packit |
0848f5 |
This error class is returned only from the multiple-completion routines
|
|
Packit |
0848f5 |
(<tt>MPI_Testall</tt>, <tt>MPI_Testany</tt>, <tt>MPI_Testsome</tt>, <tt>MPI_Waitall</tt>, <tt>MPI_Waitany</tt>,
|
|
Packit |
0848f5 |
and <tt>MPI_Waitsome</tt>). The field <tt>MPI_ERROR</tt> in the status argument
|
|
Packit |
0848f5 |
contains the error value or <tt>MPI_SUCCESS</tt> (no error and complete) or
|
|
Packit |
0848f5 |
<tt>MPI_ERR_PENDING</tt> to indicate that the request has not completed.
|
|
Packit |
0848f5 |
|
|
Packit |
0848f5 |
The MPI Standard does not specify what the result of the multiple
|
|
Packit |
0848f5 |
completion routines is when an error occurs. For example, in an
|
|
Packit |
0848f5 |
<tt>MPI_WAITALL</tt>, does the routine wait for all requests to either fail or
|
|
Packit |
0848f5 |
complete, or does it return immediately (with the MPI definition of
|
|
Packit |
0848f5 |
immediately, which means independent of actions of other MPI processes)?
|
|
Packit |
0848f5 |
MPICH has chosen to make the return immediate (alternately, local in MPI
|
|
Packit |
0848f5 |
terms), and to use the error class <tt>MPI_ERR_PENDING</tt> (introduced in MPI 1.1)
|
|
Packit |
0848f5 |
to indicate which requests have not completed. In most cases, only
|
|
Packit |
0848f5 |
one request with an error will be detected in each call to an MPI routine
|
|
Packit |
0848f5 |
that tests multiple requests. The requests that have not been processed
|
|
Packit |
0848f5 |
(because an error occured in one of the requests) will have their
|
|
Packit |
0848f5 |
<tt>MPI_ERROR</tt> field marked with <tt>MPI_ERR_PENDING</tt>.
|
|
Packit |
0848f5 |
- MPI_ERR_REQUEST
- Invalid <tt>MPI_Request</tt>. Either null or, in the case of a
|
|
Packit |
0848f5 |
<tt>MPI_Start</tt> or <tt>MPI_Startall</tt>, not a persistent request.
|
|
Packit |
0848f5 |
|
|
Packit |
0848f5 |
- MPI_ERR_ARG
- Invalid argument. Some argument is invalid and is not
|
|
Packit |
0848f5 |
identified by a specific error class (e.g., <tt>MPI_ERR_RANK</tt>).
|
|
Packit |
0848f5 |
|
|
Packit |
0848f5 |
</BODY></HTML>
|