1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
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
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
|
/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
* Copyright by The HDF Group. *
* Copyright by the Board of Trustees of the University of Illinois. *
* All rights reserved. *
* *
* This file is part of HDF5. The full HDF5 copyright notice, including *
* terms governing use, modification, and redistribution, is contained in *
* the COPYING file, which can be found at the root of the source code *
* distribution tree, or in https://www.hdfgroup.org/licenses. *
* If you do not have access to either file, you may request a copy from *
* help@hdfgroup.org. *
* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
/*-------------------------------------------------------------------------
*
* Created: H5Fmpi.c
* Jan 10 2008
* Quincey Koziol
*
* Purpose: MPI-related routines.
*
*-------------------------------------------------------------------------
*/
/****************/
/* Module Setup */
/****************/
#include "H5Fmodule.h" /* This source code file is part of the H5F module */
/***********/
/* Headers */
/***********/
#include "H5private.h" /* Generic Functions */
#include "H5CXprivate.h" /* API Contexts */
#include "H5Eprivate.h" /* Error handling */
#include "H5Fpkg.h" /* File access */
#include "H5FDprivate.h" /* File drivers */
#include "H5Iprivate.h" /* IDs */
#include "H5VLnative_private.h" /* Native VOL connector */
/****************/
/* Local Macros */
/****************/
/******************/
/* Local Typedefs */
/******************/
/********************/
/* Package Typedefs */
/********************/
/********************/
/* Local Prototypes */
/********************/
/*********************/
/* Package Variables */
/*********************/
/*****************************/
/* Library Private Variables */
/*****************************/
/*******************/
/* Local Variables */
/*******************/
#ifdef H5_HAVE_PARALLEL
/*-------------------------------------------------------------------------
* Function: H5F_mpi_get_rank
*
* Purpose: Retrieves the rank of an MPI process.
*
* Return: Success: The rank (non-negative)
*
* Failure: Negative
*
* Programmer: Quincey Koziol
* Friday, January 30, 2004
*
*-------------------------------------------------------------------------
*/
int
H5F_mpi_get_rank(const H5F_t *f)
{
int ret_value = -1;
FUNC_ENTER_NOAPI((-1))
HDassert(f && f->shared);
/* Dispatch to driver */
if ((ret_value = H5FD_mpi_get_rank(f->shared->lf)) < 0)
HGOTO_ERROR(H5E_FILE, H5E_CANTGET, (-1), "driver get_rank request failed")
done:
FUNC_LEAVE_NOAPI(ret_value)
} /* end H5F_mpi_get_rank() */
/*-------------------------------------------------------------------------
* Function: H5F_mpi_get_comm
*
* Purpose: Retrieves the file's communicator
*
* Return: Success: The communicator (non-negative)
*
* Failure: Negative
*
* Programmer: Quincey Koziol
* Friday, January 30, 2004
*
*-------------------------------------------------------------------------
*/
MPI_Comm
H5F_mpi_get_comm(const H5F_t *f)
{
MPI_Comm ret_value = MPI_COMM_NULL;
FUNC_ENTER_NOAPI(MPI_COMM_NULL)
HDassert(f && f->shared);
/* Dispatch to driver */
if ((ret_value = H5FD_mpi_get_comm(f->shared->lf)) == MPI_COMM_NULL)
HGOTO_ERROR(H5E_FILE, H5E_CANTGET, MPI_COMM_NULL, "driver get_comm request failed")
done:
FUNC_LEAVE_NOAPI(ret_value)
} /* end H5F_mpi_get_comm() */
/*-------------------------------------------------------------------------
* Function: H5F_shared_mpi_get_size
*
* Purpose: Retrieves the size of an MPI process.
*
* Return: Success: The size (positive)
*
* Failure: Negative
*
* Programmer: John Mainzer
* Friday, May 6, 2005
*
*-------------------------------------------------------------------------
*/
int
H5F_shared_mpi_get_size(const H5F_shared_t *f_sh)
{
int ret_value = -1;
FUNC_ENTER_NOAPI((-1))
HDassert(f_sh);
/* Dispatch to driver */
if ((ret_value = H5FD_mpi_get_size(f_sh->lf)) < 0)
HGOTO_ERROR(H5E_FILE, H5E_CANTGET, (-1), "driver get_size request failed")
done:
FUNC_LEAVE_NOAPI(ret_value)
} /* end H5F_shared_mpi_get_size() */
/*-------------------------------------------------------------------------
* Function: H5F_mpi_get_size
*
* Purpose: Retrieves the size of an MPI process.
*
* Return: Success: The size (positive)
*
* Failure: Negative
*
* Programmer: John Mainzer
* Friday, May 6, 2005
*
*-------------------------------------------------------------------------
*/
int
H5F_mpi_get_size(const H5F_t *f)
{
int ret_value = -1;
FUNC_ENTER_NOAPI((-1))
HDassert(f && f->shared);
/* Dispatch to driver */
if ((ret_value = H5FD_mpi_get_size(f->shared->lf)) < 0)
HGOTO_ERROR(H5E_FILE, H5E_CANTGET, (-1), "driver get_size request failed")
done:
FUNC_LEAVE_NOAPI(ret_value)
} /* end H5F_mpi_get_size() */
/*-------------------------------------------------------------------------
* Function: H5F_set_mpi_atomicity
*
* Purpose: Private call to set the atomicity mode
*
* Return: SUCCEED/FAIL
*
*-------------------------------------------------------------------------
*/
herr_t
H5F_set_mpi_atomicity(H5F_t *file, hbool_t flag)
{
herr_t ret_value = SUCCEED;
FUNC_ENTER_NOAPI(FAIL);
/* Check args */
HDassert(file);
/* Check VFD */
if (!H5F_HAS_FEATURE(file, H5FD_FEAT_HAS_MPI))
HGOTO_ERROR(H5E_FILE, H5E_BADVALUE, FAIL,
"incorrect VFL driver, does not support MPI atomicity mode");
/* Set atomicity value */
if (H5FD_set_mpio_atomicity(file->shared->lf, flag) < 0)
HGOTO_ERROR(H5E_FILE, H5E_CANTSET, FAIL, "can't set atomicity flag");
done:
FUNC_LEAVE_NOAPI(ret_value);
} /* end H5F_set_mpi_atomicity() */
/*-------------------------------------------------------------------------
* Function: H5Fset_mpi_atomicity
*
* Purpose: Sets the atomicity mode
*
* Return: Success: Non-negative
* Failure: Negative
*
* Programmer: Mohamad Chaarawi
* Feb 14, 2012
*
*-------------------------------------------------------------------------
*/
herr_t
H5Fset_mpi_atomicity(hid_t file_id, hbool_t flag)
{
H5VL_object_t *vol_obj = NULL;
int va_flag = (int)flag; /* C is grumpy about passing hbool_t via va_arg */
herr_t ret_value = SUCCEED;
FUNC_ENTER_API(FAIL);
H5TRACE2("e", "ib", file_id, flag);
/* Get the file object */
if (NULL == (vol_obj = (H5VL_object_t *)H5I_object_verify(file_id, H5I_FILE)))
HGOTO_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL, "invalid file identifier");
/* Set atomicity value */
if (H5VL_file_optional(vol_obj, H5VL_NATIVE_FILE_SET_MPI_ATOMICITY, H5P_DATASET_XFER_DEFAULT,
H5_REQUEST_NULL, va_flag) < 0)
HGOTO_ERROR(H5E_FILE, H5E_CANTSET, FAIL, "unable to set MPI atomicity");
done:
FUNC_LEAVE_API(ret_value);
} /* end H5Fset_mpi_atomicity() */
/*-------------------------------------------------------------------------
* Function: H5F_get_mpi_atomicity
*
* Purpose: Private call to get the atomicity mode
*
* Return: SUCCEED/FAIL
*
*-------------------------------------------------------------------------
*/
herr_t
H5F_get_mpi_atomicity(H5F_t *file, hbool_t *flag)
{
herr_t ret_value = SUCCEED;
FUNC_ENTER_NOAPI(FAIL);
/* Check args */
HDassert(file);
HDassert(flag);
/* Check VFD */
if (!H5F_HAS_FEATURE(file, H5FD_FEAT_HAS_MPI))
HGOTO_ERROR(H5E_FILE, H5E_BADVALUE, FAIL,
"incorrect VFL driver, does not support MPI atomicity mode");
/* Get atomicity value */
if (H5FD_get_mpio_atomicity(file->shared->lf, flag) < 0)
HGOTO_ERROR(H5E_FILE, H5E_CANTGET, FAIL, "can't get atomicity flag");
done:
FUNC_LEAVE_NOAPI(ret_value);
} /* end H5F_get_mpi_atomicity() */
/*-------------------------------------------------------------------------
* Function: H5Fget_mpi_atomicity
*
* Purpose: Returns the atomicity mode
*
* Return: Success: Non-negative
* Failure: Negative
*
* Programmer: Mohamad Chaarawi
* Feb 14, 2012
*
*-------------------------------------------------------------------------
*/
herr_t
H5Fget_mpi_atomicity(hid_t file_id, hbool_t *flag)
{
H5VL_object_t *vol_obj = NULL;
herr_t ret_value = SUCCEED;
FUNC_ENTER_API(FAIL);
H5TRACE2("e", "i*b", file_id, flag);
/* Get the file object */
if (NULL == (vol_obj = (H5VL_object_t *)H5I_object_verify(file_id, H5I_FILE)))
HGOTO_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL, "invalid file identifier");
/* Get atomicity value */
if (H5VL_file_optional(vol_obj, H5VL_NATIVE_FILE_GET_MPI_ATOMICITY, H5P_DATASET_XFER_DEFAULT,
H5_REQUEST_NULL, flag) < 0)
HGOTO_ERROR(H5E_FILE, H5E_CANTGET, FAIL, "unable to get MPI atomicity");
done:
FUNC_LEAVE_API(ret_value);
} /* end H5Fget_mpi_atomicity() */
/*-------------------------------------------------------------------------
* Function: H5F_mpi_retrieve_comm
*
* Purpose: Retrieves an MPI communicator from the file the location ID
* is in. If the loc_id is invalid, the fapl_id is used to
* retrieve the communicator.
*
* Return: Success: Non-negative
*
* Failure: Negative
*
* Programmer: Mohamad Chaarawi
* Feb 14, 2012
*
*-------------------------------------------------------------------------
*/
herr_t
H5F_mpi_retrieve_comm(hid_t loc_id, hid_t acspl_id, MPI_Comm *mpi_comm)
{
herr_t ret_value = SUCCEED;
FUNC_ENTER_NOAPI(FAIL)
/* Sanity check */
HDassert(mpi_comm);
/* Set value to return to invalid MPI comm */
*mpi_comm = MPI_COMM_NULL;
/* if the loc_id is valid, then get the comm from the file
attached to the loc_id */
if (H5I_INVALID_HID != loc_id) {
H5G_loc_t loc;
H5F_t * f = NULL;
/* Retrieve the file structure */
if (H5G_loc(loc_id, &loc) < 0)
HGOTO_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL, "not a location")
f = loc.oloc->file;
HDassert(f);
/* Check if MPIO driver is used */
if (H5F_HAS_FEATURE(f, H5FD_FEAT_HAS_MPI)) {
/* retrieve the file communicator */
if (MPI_COMM_NULL == (*mpi_comm = H5F_mpi_get_comm(f)))
HGOTO_ERROR(H5E_FILE, H5E_CANTGET, FAIL, "can't get MPI communicator")
}
}
/* otherwise, this is from H5Fopen or H5Fcreate and has to be collective */
else {
H5P_genplist_t *plist; /* Property list pointer */
if (NULL == (plist = H5P_object_verify(acspl_id, H5P_FILE_ACCESS)))
HGOTO_ERROR(H5E_FILE, H5E_BADTYPE, FAIL, "not a file access list")
if (H5FD_MPIO == H5P_peek_driver(plist))
if (H5P_peek(plist, H5F_ACS_MPI_PARAMS_COMM_NAME, mpi_comm) < 0)
HGOTO_ERROR(H5E_FILE, H5E_CANTGET, FAIL, "can't get MPI communicator")
}
done:
FUNC_LEAVE_NOAPI(ret_value)
} /* end H5F_mpi_retrieve_comm */
/*-------------------------------------------------------------------------
* Function: H5F_get_coll_metadata_reads
*
* Purpose: Determines whether collective metadata reads should be
* performed. This routine is meant to be the single source of
* truth for the collective metadata reads status, as it
* coordinates between the file-global flag and the flag set
* for the current operation in the current API context.
*
* Return: TRUE/FALSE (can't fail)
*
*-------------------------------------------------------------------------
*/
hbool_t
H5F_get_coll_metadata_reads(const H5F_t *file)
{
H5P_coll_md_read_flag_t file_flag = H5P_USER_FALSE;
hbool_t ret_value = FALSE;
FUNC_ENTER_NOAPI_NOINIT_NOERR
HDassert(file && file->shared);
/* Retrieve the file-global flag */
file_flag = H5F_COLL_MD_READ(file);
/* If file flag is set to H5P_FORCE_FALSE, exit early
* with FALSE, since collective metadata reads have
* been explicitly disabled somewhere in the library.
*/
if (H5P_FORCE_FALSE == file_flag)
ret_value = FALSE;
else {
/* If file flag is set to H5P_USER_TRUE, ignore
* any settings in the API context. A file-global
* setting of H5P_USER_TRUE for collective metadata
* reads should ignore any settings on an Access
* Property List for an individual operation.
*/
if (H5P_USER_TRUE == file_flag)
ret_value = TRUE;
else {
/* Get the collective metadata reads flag from
* the current API context.
*/
ret_value = H5CX_get_coll_metadata_read();
}
}
FUNC_LEAVE_NOAPI(ret_value)
} /* end H5F_get_coll_metadata_reads() */
/*-------------------------------------------------------------------------
* Function: H5F_set_coll_metadata_reads
*
* Purpose: Used to temporarily modify the collective metadata reads
* status. This is useful for cases where either:
*
* * Collective metadata reads are enabled, but need to be
* disabled for an operation about to occur that may trigger
* an independent metadata read (such as only rank 0 doing
* something)
*
* * Metadata reads are currently independent, but it is
* guaranteed that the application has maintained
* collectivity at the interface level (e.g., an operation
* that modifies metadata is being performed). In this case,
* it should be safe to enable collective metadata reads,
* barring any internal library issues that may occur
*
* After completion, the `file_flag` parameter will be set to
* the previous value of the file-global collective metadata
* reads flag. The `context_flag` parameter will be set to the
* previous value of the API context's collective metadata
* reads flag. Another call to this routine should be made to
* restore these values (see below warning).
*
* !! WARNING !!
* It is dangerous to modify the collective metadata reads
* status, as this can cause crashes, hangs and corruption in
* the HDF5 file when improperly done. Therefore, the
* `file_flag` and `context_flag` parameters are both
* mandatory, and it is assumed that the caller will guarantee
* these settings are restored with another call to this
* routine once the bracketed operation is complete.
* !! WARNING !!
*
* Return: Nothing
*
*-------------------------------------------------------------------------
*/
void
H5F_set_coll_metadata_reads(H5F_t *file, H5P_coll_md_read_flag_t *file_flag, hbool_t *context_flag)
{
H5P_coll_md_read_flag_t prev_file_flag = H5P_USER_FALSE;
hbool_t prev_context_flag = FALSE;
FUNC_ENTER_NOAPI_NOINIT_NOERR
HDassert(file && file->shared);
HDassert(file_flag);
HDassert(context_flag);
/* Save old state */
prev_file_flag = H5F_COLL_MD_READ(file);
prev_context_flag = H5CX_get_coll_metadata_read();
/* Set new desired state */
if (prev_file_flag != *file_flag) {
file->shared->coll_md_read = *file_flag;
*file_flag = prev_file_flag;
}
if (prev_context_flag != *context_flag) {
H5CX_set_coll_metadata_read(*context_flag);
*context_flag = prev_context_flag;
}
FUNC_LEAVE_NOAPI_VOID
} /* end H5F_set_coll_metadata_reads() */
#endif /* H5_HAVE_PARALLEL */
|