waitall.c 12.3 KB
Newer Older
1
/* -*- Mode: C; c-basic-offset:4 ; indent-tabs-mode:nil ; -*- */
2
3
4
5
6
7
8
9
10
/*
 *
 *  (C) 2001 by Argonne National Laboratory.
 *      See COPYRIGHT in top-level directory.
 */

#include "mpiimpl.h"

#if !defined(MPID_REQUEST_PTR_ARRAY_SIZE)
11
12
/* use a larger default size of 64 in order to enhance SQMR performance */
#define MPID_REQUEST_PTR_ARRAY_SIZE 64
13
14
15
16
17
18
19
20
21
#endif

/* -- Begin Profiling Symbol Block for routine MPI_Waitall */
#if defined(HAVE_PRAGMA_WEAK)
#pragma weak MPI_Waitall = PMPI_Waitall
#elif defined(HAVE_PRAGMA_HP_SEC_DEF)
#pragma _HP_SECONDARY_DEF PMPI_Waitall  MPI_Waitall
#elif defined(HAVE_PRAGMA_CRI_DUP)
#pragma _CRI duplicate MPI_Waitall as PMPI_Waitall
22
23
#elif defined(HAVE_WEAK_ATTRIBUTE)
int MPI_Waitall(int count, MPI_Request array_of_requests[], MPI_Status array_of_statuses[]) __attribute__((weak,alias("PMPI_Waitall")));
24
25
26
27
28
29
30
31
32
33
#endif
/* -- End Profiling Symbol Block */

/* Define MPICH_MPI_FROM_PMPI if weak symbols are not supported to build
   the MPI routines */
#ifndef MPICH_MPI_FROM_PMPI
#undef MPI_Waitall
#define MPI_Waitall PMPI_Waitall

#undef FUNCNAME
34
35
36
37
38
#define FUNCNAME MPIR_Waitall_impl
#undef FCNAME
#define FCNAME MPIU_QUOTE(FUNCNAME)
int MPIR_Waitall_impl(int count, MPI_Request array_of_requests[],
                      MPI_Status array_of_statuses[])
39
{
40
    int mpi_errno = MPI_SUCCESS;
41
42
43
44
    MPID_Request * request_ptr_array[MPID_REQUEST_PTR_ARRAY_SIZE];
    MPID_Request ** request_ptrs = request_ptr_array;
    MPI_Status * status_ptr;
    MPID_Progress_state progress_state;
45
46
    int i, j;
    int n_completed;
47
48
    int active_flag;
    int rc;
49
    int n_greqs;
50
    int proc_failure = FALSE;
51
    int disabled_anysource = FALSE;
52
    const int ignoring_statuses = (array_of_statuses == MPI_STATUSES_IGNORE);
53
    int optimize = ignoring_statuses; /* see NOTE-O1 */
54
    MPIU_CHKLMEM_DECL(1);
55

56
57
58
59
60
61
    /* Convert MPI request handles to a request object pointers */
    if (count > MPID_REQUEST_PTR_ARRAY_SIZE)
    {
	MPIU_CHKLMEM_MALLOC(request_ptrs, MPID_Request **, count * sizeof(MPID_Request *), mpi_errno, "request pointers");
    }

62
    n_greqs = 0;
63
64
65
66
67
68
69
70
71
72
73
74
    n_completed = 0;
    for (i = 0; i < count; i++)
    {
	if (array_of_requests[i] != MPI_REQUEST_NULL)
	{
	    MPID_Request_get_ptr(array_of_requests[i], request_ptrs[i]);
	    /* Validate object pointers if error checking is enabled */
#           ifdef HAVE_ERROR_CHECKING
	    {
		MPID_BEGIN_ERROR_CHECKS;
		{
		    MPID_Request_valid_ptr( request_ptrs[i], mpi_errno );
75
                    if (mpi_errno) MPIU_ERR_POP(mpi_errno);
76
                    MPIU_ERR_CHKANDJUMP1((request_ptrs[i]->kind == MPID_REQUEST_MPROBE),
77
                                         mpi_errno, MPI_ERR_ARG, "**msgnotreq", "**msgnotreq %d", i);
78
79
80
		}
		MPID_END_ERROR_CHECKS;
	    }
81
#           endif
82
83
84
85
86
87
            if (request_ptrs[i]->kind != MPID_REQUEST_RECV &&
                request_ptrs[i]->kind != MPID_REQUEST_SEND)
            {
                optimize = FALSE;
            }

88
89
            if (request_ptrs[i]->kind == MPID_UREQUEST)
                ++n_greqs;
90
91
92
93
94
95
96
97
98
99

            /* If one of the requests is an anysource on a communicator that's
             * disabled such communication, convert this operation to a testall
             * instead to prevent getting stuck in the progress engine. */
            if (unlikely(MPIR_CVAR_ENABLE_FT &&
                        MPI_ANY_SOURCE == request_ptrs[i]->dev.match.parts.rank &&
                        !MPID_Request_is_complete(request_ptrs[i]) &&
                        !MPIDI_CH3I_Comm_AS_enabled(request_ptrs[i]->comm))) {
                disabled_anysource = TRUE;
            }
100
101
102
103
104
105
106
	}
	else
	{
	    status_ptr = (array_of_statuses != MPI_STATUSES_IGNORE) ? &array_of_statuses[i] : MPI_STATUS_IGNORE;
	    MPIR_Status_set_empty(status_ptr);
	    request_ptrs[i] = NULL;
	    n_completed += 1;
107
            optimize = FALSE;
108
109
110
111
112
113
114
115
	}
    }
    
    if (n_completed == count)
    {
	goto fn_exit;
    }

116
117
118
119
120
    if (unlikely(disabled_anysource)) {
        mpi_errno = MPI_Testall(count, array_of_requests, &disabled_anysource, array_of_statuses);
        goto fn_exit;
    }

121
122
123
124
125
126
127
    /* NOTE-O1: high-message-rate optimization.  For simple send and recv
     * operations and MPI_STATUSES_IGNORE we use a fastpath approach that strips
     * out as many unnecessary jumps and error handling as possible.
     *
     * Possible variation: permit request_ptrs[i]==NULL at the cost of an
     * additional branch inside the for-loop below. */
    if (optimize) {
128
        MPID_Progress_start(&progress_state);
129
130
131
132
133
134
135
        for (i = 0; i < count; ++i) {
            while (!MPID_Request_is_complete(request_ptrs[i])) {
                mpi_errno = MPID_Progress_wait(&progress_state);
                /* must check and handle the error, can't guard with HAVE_ERROR_CHECKING, but it's
                 * OK for the error case to be slower */
                if (unlikely(mpi_errno)) {
                    /* --BEGIN ERROR HANDLING-- */
136
137
138
139
140
141
                    if (unlikely(MPIR_CVAR_ENABLE_FT &&
                                MPI_ANY_SOURCE == request_ptrs[i]->dev.match.parts.rank &&
                                !MPID_Request_is_complete(request_ptrs[i]) &&
                                !MPIDI_CH3I_Comm_AS_enabled(request_ptrs[i]->comm))) {
                        MPIU_ERR_SET(mpi_errno, MPI_ERR_IN_STATUS, "**instatus");
                    }
142
143
144
145
146
147
148
149
150
                    MPID_Progress_end(&progress_state);
                    MPIU_ERR_POP(mpi_errno);
                    /* --END ERROR HANDLING-- */
                }
            }
            mpi_errno = MPIR_Request_complete_fastpath(&array_of_requests[i], request_ptrs[i]);
            if (mpi_errno) MPIU_ERR_POP(mpi_errno);
        }

151
152
        MPID_Progress_end(&progress_state);

153
154
155
156
157
        goto fn_exit;
    }

    /* ------ "slow" code path below ------ */

158
159
    /* Grequest_waitall may run the progress engine - thus, we don't 
       invoke progress_start until after running Grequest_waitall */
160
161
162
    /* first, complete any generalized requests */
    if (n_greqs)
    {
163
        mpi_errno = MPIR_Grequest_waitall(count, request_ptrs);
164
        if (mpi_errno) MPIU_ERR_POP(mpi_errno);
165
166
    }
    
167
168
    MPID_Progress_start(&progress_state);

169
    for (i = 0; i < count; i++)
170
    {
171
172
173
174
175
176
177
        if (request_ptrs[i] == NULL)
        {
            if (!ignoring_statuses)
                array_of_statuses[i].MPI_ERROR = MPI_SUCCESS;
            continue;
        }
        
178
        /* wait for ith request to complete */
179
        while (!MPID_Request_is_complete(request_ptrs[i]))
180
181
182
183
184
        {
            /* generalized requests should already be finished */
            MPIU_Assert(request_ptrs[i]->kind != MPID_UREQUEST);
            
            mpi_errno = MPID_Progress_wait(&progress_state);
185
            if (mpi_errno != MPI_SUCCESS) {
186
187
                /* --BEGIN ERROR HANDLING-- */
                MPID_Progress_end(&progress_state);
188
                MPIU_ERR_POP(mpi_errno);
189
                /* --END ERROR HANDLING-- */
190
191
192
193
194
195
196
197
198
199
200
            } else if (unlikely(MPIR_CVAR_ENABLE_FT &&
                        MPI_ANY_SOURCE == request_ptrs[i]->dev.match.parts.rank &&
                        !MPID_Request_is_complete(request_ptrs[i]) &&
                        !MPIDI_CH3I_Comm_AS_enabled(request_ptrs[i]->comm))) {
                /* Check for pending failures */
                MPID_Progress_end(&progress_state);
                MPIU_ERR_SET(rc, MPIX_ERR_PROC_FAILED_PENDING, "**failure_pending");
                status_ptr = (ignoring_statuses) ? MPI_STATUS_IGNORE : &array_of_statuses[i];
                if (status_ptr != MPI_STATUS_IGNORE) status_ptr->MPI_ERROR = mpi_errno;
                proc_failure = TRUE;
                break;
201
202
203
            }
        }

204
205
206
207
        if (MPID_Request_is_complete(request_ptrs[i])) {
            /* complete the request and check the status */
            status_ptr = (ignoring_statuses) ? MPI_STATUS_IGNORE : &array_of_statuses[i];
            rc = MPIR_Request_complete(&array_of_requests[i], request_ptrs[i], status_ptr, &active_flag);
208
209
        }

210
211
        if (rc == MPI_SUCCESS)
        {
212
            request_ptrs[i] = NULL;
213
214
            if (!ignoring_statuses)
                status_ptr->MPI_ERROR = MPI_SUCCESS;
215
216
217
218
        }
        else
        {
            /* req completed with an error */
219
            MPIU_ERR_SET(mpi_errno, MPI_ERR_IN_STATUS, "**instatus");
220
221
222

            if (!proc_failure) {
                if (MPIX_ERR_PROC_FAILED == MPIR_ERR_GET_CLASS(rc))
223
                    proc_failure = TRUE;
224
225
            }

226
            if (!ignoring_statuses)
227
228
229
230
231
232
233
            {
                /* set the error code for this request */
                status_ptr->MPI_ERROR = rc;

                /* set the error codes for the rest of the uncompleted requests to PENDING */
                for (j = i+1; j < count; ++j)
                {
234
235
236
237
238
239
240
241
242
                    if (!ignoring_statuses)
                    {
                        if (request_ptrs[j] == NULL)
                        {
                            /* either the user specified MPI_REQUEST_NULL, or this is a completed greq */
                            array_of_statuses[j].MPI_ERROR = MPI_SUCCESS;
                        }
                        else
                        {
243
244
245
246
                            if (!proc_failure)
                                array_of_statuses[j].MPI_ERROR = MPI_ERR_PENDING;
                            else
                                array_of_statuses[j].MPI_ERROR = MPIX_ERR_PROC_FAILED_PENDING;
247
                        }
248
                    }
249
250
251
                }
            }
            break;
252
        }
253
254
    }
    MPID_Progress_end(&progress_state);
255
        
256
 fn_exit:
257
258
     if (count > MPID_REQUEST_PTR_ARRAY_SIZE)
    {
259
260
261
	MPIU_CHKLMEM_FREEALL();
    }

262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
   return mpi_errno;
 fn_fail:
    goto fn_exit;
}

#endif

#undef FUNCNAME
#define FUNCNAME MPI_Waitall
#undef FCNAME
#define FCNAME MPIU_QUOTE(FUNCNAME)
/*@
    MPI_Waitall - Waits for all given MPI Requests to complete

Input Parameters:
+ count - list length (integer) 
- array_of_requests - array of request handles (array of handles)

280
Output Parameters:
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
. array_of_statuses - array of status objects (array of Statuses).  May be
  'MPI_STATUSES_IGNORE'.

Notes:

If one or more of the requests completes with an error, 'MPI_ERR_IN_STATUS' is
returned.  An error value will be present is elements of 'array_of_status'
associated with the requests.  Likewise, the 'MPI_ERROR' field in the status
elements associated with requests that have successfully completed will be
'MPI_SUCCESS'.  Finally, those requests that have not completed will have a 
value of 'MPI_ERR_PENDING'.

While it is possible to list a request handle more than once in the
array_of_requests, such an action is considered erroneous and may cause the
program to unexecpectedly terminate or produce incorrect results.

.N waitstatus

.N ThreadSafe

.N Fortran

.N Errors
.N MPI_SUCCESS
.N MPI_ERR_REQUEST
.N MPI_ERR_ARG
.N MPI_ERR_IN_STATUS
@*/
int MPI_Waitall(int count, MPI_Request array_of_requests[], 
		MPI_Status array_of_statuses[])
{
    int mpi_errno = MPI_SUCCESS;
    MPID_MPI_STATE_DECL(MPID_STATE_MPI_WAITALL);

    MPIR_ERRTEST_INITIALIZED_ORDIE();
    
    MPIU_THREAD_CS_ENTER(ALLFUNC,);
    MPID_MPI_PT2PT_FUNC_ENTER(MPID_STATE_MPI_WAITALL);

    /* Check the arguments */
#   ifdef HAVE_ERROR_CHECKING
    {
        MPID_BEGIN_ERROR_CHECKS;
        {
325
            int i;
326
327
328
329
330
331
332
333
334
	    MPIR_ERRTEST_COUNT(count, mpi_errno);

	    if (count != 0) {
		MPIR_ERRTEST_ARGNULL(array_of_requests, "array_of_requests", mpi_errno);
		/* NOTE: MPI_STATUSES_IGNORE != NULL */
	    
		MPIR_ERRTEST_ARGNULL(array_of_statuses, "array_of_statuses", mpi_errno);
	    }

335
336
	    for (i = 0; i < count; i++) {
		MPIR_ERRTEST_ARRAYREQUEST_OR_NULL(array_of_requests[i], i, mpi_errno);
337
338
339
340
341
342
343
344
345
346
347
348
349
350
	    }
	}
        MPID_END_ERROR_CHECKS;
    }
#   endif /* HAVE_ERROR_CHECKING */
    
    /* ... body of routine ...  */

    mpi_errno = MPIR_Waitall_impl(count, array_of_requests, array_of_statuses);
    if (mpi_errno) goto fn_fail;

    /* ... end of body of routine ... */
    
 fn_exit:
351
    MPID_MPI_PT2PT_FUNC_EXIT(MPID_STATE_MPI_WAITALL);
352
    MPIU_THREAD_CS_EXIT(ALLFUNC,);
353
354
    return mpi_errno;

355
 fn_fail:
356
357
    /* --BEGIN ERROR HANDLING-- */
#ifdef HAVE_ERROR_CHECKING
358
    mpi_errno = MPIR_Err_create_code(mpi_errno, MPIR_ERR_RECOVERABLE,
359
				     FCNAME, __LINE__, MPI_ERR_OTHER,
360
361
362
				     "**mpi_waitall",
				     "**mpi_waitall %d %p %p",
				     count, array_of_requests,
363
364
365
366
367
368
				     array_of_statuses);
#endif
    mpi_errno = MPIR_Err_return_comm(NULL, FCNAME, mpi_errno);
    goto fn_exit;
    /* --END ERROR HANDLING-- */
}