| 1 | .\"Copyright 2006-2008 Sun Microsystems, Inc. |
|---|
| 2 | .\" Copyright (c) 1996 Thinking Machines Corporation |
|---|
| 3 | .TH MPI_Testall 3 "Dec 08, 2009" "1.4" "Open MPI" |
|---|
| 4 | .SH NAME |
|---|
| 5 | \fBMPI_Testall\fP \- Tests for the completion of all previously initiated communications in a list. |
|---|
| 6 | |
|---|
| 7 | .SH SYNTAX |
|---|
| 8 | .ft R |
|---|
| 9 | .SH C Syntax |
|---|
| 10 | .nf |
|---|
| 11 | #include <mpi.h> |
|---|
| 12 | int MPI_Testall(int \fIcount\fP, MPI_Request\fI *array_of_requests\fP, |
|---|
| 13 | int\fI *flag\fP, MPI_Status\fI *array_of_statuses\fP) |
|---|
| 14 | |
|---|
| 15 | .SH Fortran Syntax |
|---|
| 16 | .nf |
|---|
| 17 | INCLUDE 'mpif.h' |
|---|
| 18 | MPI_TESTALL(\fICOUNT, ARRAY_OF_REQUESTS, FLAG, ARRAY_OF_STATUSES, |
|---|
| 19 | IERROR\fP) |
|---|
| 20 | LOGICAL \fIFLAG\fP |
|---|
| 21 | INTEGER \fICOUNT, ARRAY_OF_REQUESTS(*)\fP |
|---|
| 22 | INTEGER \fIARRAY_OF_STATUSES(MPI_STATUS_SIZE,*), IERROR\fP |
|---|
| 23 | |
|---|
| 24 | .SH C++ Syntax |
|---|
| 25 | .nf |
|---|
| 26 | #include <mpi.h> |
|---|
| 27 | static bool Request::Testall(int \fIcount\fP, Request |
|---|
| 28 | \fIarray_of_requests\fP[], Status \fIarray_of_statuses\fP[]) |
|---|
| 29 | |
|---|
| 30 | static bool Request::Testall(int \fIcount\fP, Request \fIarray_of_requests\fP[]) |
|---|
| 31 | |
|---|
| 32 | .SH INPUT PARAMETERS |
|---|
| 33 | .ft R |
|---|
| 34 | .TP 1i |
|---|
| 35 | count |
|---|
| 36 | Lists length (integer). |
|---|
| 37 | .TP 1i |
|---|
| 38 | array_of_requests |
|---|
| 39 | Array of requests (array of handles). |
|---|
| 40 | |
|---|
| 41 | .SH OUTPUT PARAMETERS |
|---|
| 42 | .ft R |
|---|
| 43 | .TP 1i |
|---|
| 44 | flag |
|---|
| 45 | True if previously initiated communications are complete (logical.) |
|---|
| 46 | .TP 1i |
|---|
| 47 | array_of_statuses |
|---|
| 48 | Array of status objects (array of status). |
|---|
| 49 | .ft R |
|---|
| 50 | .TP 1i |
|---|
| 51 | IERROR |
|---|
| 52 | Fortran only: Error status (integer). |
|---|
| 53 | |
|---|
| 54 | .SH DESCRIPTION |
|---|
| 55 | .ft R |
|---|
| 56 | Returns \fIflag\fP = true if all communications associated with active handles in the array have completed (this includes the case where no handle in the list is active). In this case, each status entry that corresponds to an active handle request is set to the status of the corresponding communication; if the request was allocated by a nonblocking communication call then it is deallocated, and the handle is set to MPI_REQUEST_NULL. Each status entry that corresponds to a null or inactive handle is set to empty. |
|---|
| 57 | .sp |
|---|
| 58 | Otherwise, \fIflag\fP = false is returned, no request is modified and the values of the status entries are undefined. This is a local operation. |
|---|
| 59 | .sp |
|---|
| 60 | If your application does not need to examine the \fIarray_of_statuses\fP field, you can save resources by using the predefined constant MPI_STATUSES_IGNORE can be used as a special value for the \fIarray_of_statuses\fP argument. |
|---|
| 61 | .sp |
|---|
| 62 | Errors that occurred during the execution of MPI_Testall are handled in the same manner as errors in MPI_Waitall. |
|---|
| 63 | |
|---|
| 64 | .SH NOTE |
|---|
| 65 | .ft R |
|---|
| 66 | \fIflag\fP is true only if all requests have completed. Otherwise, \fIflag\fP is false, |
|---|
| 67 | and neither \fIarray_of_requests\fP nor \fIarray_of_statuses\fP is modified. |
|---|
| 68 | |
|---|
| 69 | .SH ERRORS |
|---|
| 70 | For each invocation of MPI_Testall, if one or more requests generate |
|---|
| 71 | an MPI exception, only the \fIfirst\fP MPI request that caused an |
|---|
| 72 | exception will be passed to its corresponding error handler. No other |
|---|
| 73 | error handlers will be invoked (even if multiple requests generated |
|---|
| 74 | exceptions). However, \fIall\fP requests that generate an exception |
|---|
| 75 | will have a relevant error code set in the corresponding |
|---|
| 76 | status.MPI_ERROR field (unless MPI_IGNORE_STATUSES was used). |
|---|
| 77 | .sp |
|---|
| 78 | The default error handler aborts the MPI job, except for I/O function |
|---|
| 79 | errors. The error handler may be changed with MPI_Comm_set_errhandler, |
|---|
| 80 | MPI_File_set_errhandler, or MPI_Win_set_errhandler (depending on the |
|---|
| 81 | type of MPI handle that generated the MPI request); the predefined |
|---|
| 82 | error handler MPI_ERRORS_RETURN may be used to cause error values to |
|---|
| 83 | be returned. Note that MPI does not guarantee that an MPI program can |
|---|
| 84 | continue past an error. |
|---|
| 85 | .sp |
|---|
| 86 | If the invoked error handler allows MPI_Testall to return to the |
|---|
| 87 | caller, the value MPI_ERR_IN_STATUS will be returned in the C and |
|---|
| 88 | Fortran bindings. In C++, if the predefined error handler |
|---|
| 89 | MPI::ERRORS_THROW_EXCEPTIONS is used, the value MPI::ERR_IN_STATUS |
|---|
| 90 | will be contained in the MPI::Exception object. The MPI_ERROR field |
|---|
| 91 | can then be examined in the array of returned statuses to determine |
|---|
| 92 | exactly which request(s) generated an exception. |
|---|
| 93 | |
|---|
| 94 | .SH SEE ALSO |
|---|
| 95 | .ft R |
|---|
| 96 | .sp |
|---|
| 97 | MPI_Comm_set_errhandler |
|---|
| 98 | .br |
|---|
| 99 | MPI_File_set_errhandler |
|---|
| 100 | .br |
|---|
| 101 | MPI_Test |
|---|
| 102 | .br |
|---|
| 103 | MPI_Testany |
|---|
| 104 | .br |
|---|
| 105 | MPI_Testsome |
|---|
| 106 | .br |
|---|
| 107 | MPI_Wait |
|---|
| 108 | .br |
|---|
| 109 | MPI_Waitall |
|---|
| 110 | .br |
|---|
| 111 | MPI_Waitany |
|---|
| 112 | .br |
|---|
| 113 | MPI_Waitsome |
|---|
| 114 | .br |
|---|
| 115 | MPI_Win_set_errhandler |
|---|
| 116 | .br |
|---|
| 117 | |
|---|
![(please configure the [header_logo] section in trac.ini)](/trac/PP2009/chrome/site/your_project_logo.png){kind=logo}
