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
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
|
/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
* Copyright by The HDF Group. *
* 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 files COPYING and Copyright.html. COPYING can be found at the root *
* of the source code distribution tree; Copyright.html can be found at the *
* root level of an installed copy of the electronic HDF5 document set and *
* is linked from the top-level documents page. It can also be found at *
* http://hdfgroup.org/HDF5/doc/Copyright.html. If you do not have *
* access to either file, you may request a copy from help@hdfgroup.org. *
* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
/*
* Programmer: Mohamad Chaarawi <chaarawi@hdfgroup.org>
* August, 2013
*
* Purpose: Transaction APIs to support Exascale FastForward
* functionality.
*
*/
/****************/
/* Module Setup */
/****************/
/* Interface initialization */
#define H5_INTERFACE_INIT_FUNC H5TR_init_interface
/***********/
/* Headers */
/***********/
#include "H5private.h" /* Generic Functions */
#include "H5Eprivate.h" /* Error handling */
#include "H5TRprivate.h" /* Transactions */
#include "H5Iprivate.h" /* IDs */
#include "H5MMprivate.h" /* Memory management */
#include "H5VLprivate.h" /* VOL plugins */
/****************/
/* Local Macros */
/****************/
/******************/
/* Local Typedefs */
/******************/
/********************/
/* Local Prototypes */
/********************/
/*********************/
/* Package Variables */
/*********************/
/*****************************/
/* Library Private Variables */
/*****************************/
/*******************/
/* Local Variables */
/*******************/
/* Declare a free list to manage the H5TR_t struct */
H5FL_DEFINE(H5TR_t);
/* Dataspace ID class */
static const H5I_class_t H5I_TR_CLS[1] = {{
H5I_TR, /* ID class value */
0, /* Class flags */
64, /* Minimum hash size for class */
2, /* # of reserved IDs for class */
NULL, /* Callback routine for closing objects of this class */
(H5I_free2_t)H5TR_close /* Callback routine for closing auxilary objects of this class */
}};
/*-------------------------------------------------------------------------
* Function: H5TR_init
*
* Purpose: Initialize the interface from some other package.
*
* Return: Success: non-negative
* Failure: negative
*
* Programmer: Mohamad Chaarawi
* August 2013
*
*-------------------------------------------------------------------------
*/
herr_t
H5TR_init(void)
{
herr_t ret_value = SUCCEED; /* Return value */
FUNC_ENTER_NOAPI(FAIL)
/* FUNC_ENTER() does all the work */
done:
FUNC_LEAVE_NOAPI(ret_value)
} /* end H5TR_init() */
/*--------------------------------------------------------------------------
NAME
H5TR_init_interface -- Initialize interface-specific information
USAGE
herr_t H5TR_init_interface()
RETURNS
Non-negative on success/Negative on failure
DESCRIPTION
Initializes any interface-specific data or routines.
--------------------------------------------------------------------------*/
static herr_t
H5TR_init_interface(void)
{
herr_t ret_value = SUCCEED; /* Return value */
FUNC_ENTER_NOAPI_NOINIT
/* Initialize the atom group for the TR IDs */
if(H5I_register_type(H5I_TR_CLS) < 0)
HGOTO_ERROR(H5E_DATASPACE, H5E_CANTINIT, FAIL, "unable to initialize interface")
done:
FUNC_LEAVE_NOAPI(ret_value)
} /* end H5TR_init_interface() */
/*--------------------------------------------------------------------------
NAME
H5TR_term_interface
PURPOSE
Terminate various H5TR objects
USAGE
void H5TR_term_interface()
RETURNS
Non-negative on success/Negative on failure
DESCRIPTION
Release the atom group and any other resources allocated.
GLOBAL VARIABLES
COMMENTS, BUGS, ASSUMPTIONS
Can't report errors...
EXAMPLES
REVISION LOG
--------------------------------------------------------------------------*/
int
H5TR_term_interface(void)
{
int n = 0;
FUNC_ENTER_NOAPI_NOINIT_NOERR
if(H5_interface_initialize_g) {
if((n = H5I_nmembers(H5I_TR))) {
H5I_clear_type(H5I_TR, FALSE, FALSE);
} /* end if */
else {
/* Free data types */
H5I_dec_type_ref(H5I_TR);
/* Shut down interface */
H5_interface_initialize_g = 0;
n = 1; /*H5I*/
} /* end else */
} /* end if */
FUNC_LEAVE_NOAPI(n)
} /* end H5TR_term_interface() */
/*-------------------------------------------------------------------------
* Function: H5Pset_trspl_num_peers
*
* Purpose: Set the number of peers that will call H5TRstart for a
* transaction. If num_peers=0, the application has appointed a
* transaction leader to signal the start and finish of the
* transaction, and to coordinate with processes participating in the
* transaction regarding when they can begin updating and when their
* updates are done. When this is the case, only one process (the
* transaction leader) can call H5TRstart and H5TRfinish for the given
* transaction_num. This mode of operation is typical for
* tightly-coupled applications. If num_peers>0, the I/O stack (in
* particular, IOD) will track the status of the transaction. All
* num_peers processes participating in the transaction must call
* H5TRstart with the same values for num_peers and transaction_num.
* As each participating process is done with their updates in the
* transaction, they individually call H5TRfinish for this
* transaction_num. When all num_peers processes have called
* H5TRfinish for this transaction_num, the I/O stack detects that the
* transaction is finished and updates appear atomically when all
* lower-numbered transactions are finished, aborted, or skipped.
* This mode of operation is typical for loosely-coupled applications.
*
* Return: Non-negative on success/Negative on failure
*
* Programmer: Mohamad Chaarawi
* August 2013
*
*-------------------------------------------------------------------------
*/
herr_t
H5Pset_trspl_num_peers(hid_t trspl_id, unsigned num_peers)
{
H5P_genplist_t *plist; /* Property list pointer */
herr_t ret_value = SUCCEED; /* return value */
FUNC_ENTER_API(FAIL)
H5TRACE2("e", "iIu", trspl_id, num_peers);
/* Get the plist structure */
if(NULL == (plist = H5P_object_verify(trspl_id, H5P_TR_START)))
HGOTO_ERROR(H5E_ATOM, H5E_BADATOM, FAIL, "can't find object for ID");
/* Set property */
if(H5P_set(plist, H5TR_START_NUM_PEERS_NAME, &num_peers) < 0)
HGOTO_ERROR(H5E_PLIST, H5E_CANTSET,FAIL, "can't set num peers in transaction");
done:
FUNC_LEAVE_API(ret_value)
} /* end H5Pset_trspl_num_peers() */
/*-------------------------------------------------------------------------
* Function: H5TRcreate
*
* Purpose: Wraps an hid_t around a transaction number, a file ID,
* and a read context ID on that file that operations using
* the created transaction will read from.
*
* Return: Success: The ID for a new transaction.
* Failure: FAIL
*
* Programmer: Mohamad Chaarawi
* August 2013
*
*-------------------------------------------------------------------------
*/
hid_t
H5TRcreate(hid_t file_id, hid_t rc_id, uint64_t trans_num)
{
void *file = NULL;
H5VL_t *vol_plugin = NULL;
H5TR_t *tr = NULL;
hid_t ret_value;
FUNC_ENTER_API(FAIL)
/* get the file object */
if(NULL == (file = (void *)H5I_object_verify(file_id, H5I_FILE)))
HGOTO_ERROR(H5E_ARGS, H5E_BADVALUE, FAIL, "not a file ID")
/* get the plugin pointer */
if (NULL == (vol_plugin = (H5VL_t *)H5I_get_aux(file_id)))
HGOTO_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL, "ID does not contain VOL information")
/* get the Read Context object */
if(NULL == (rc = (H5RC_t *)H5I_object_verify(rc_id, H5I_RC)))
HGOTO_ERROR(H5E_ARGS, H5E_BADVALUE, FAIL, "not a read context ID")
/* create a new transaction object */
if(NULL == (tr = H5TR_create(file, rc, trans_num)))
HGOTO_ERROR(H5E_SYM, H5E_CANTCREATE, FAIL, "unable to create transaction object")
/* Get an atom for the event queue with the VOL information as the auxilary struct*/
if((ret_value = H5I_register2(H5I_TR, tr, vol_plugin, TRUE)) < 0)
HGOTO_ERROR(H5E_ATOM, H5E_CANTREGISTER, FAIL, "unable to atomize transaction handle")
done:
FUNC_LEAVE_API(ret_value)
} /* end H5TRcreate() */
/*-------------------------------------------------------------------------
* Function: H5TR_create
*
* Purpose: Private version for H5TRcreate.
*
* Return: Success: Transaction struct.
* Failure: NULL
*
* Programmer: Mohamad Chaarawi
* August 2013
*
*-------------------------------------------------------------------------
*/
H5TR_t *
H5TR_create(void *file, H5RC_t *rc, uint64_t trans_num)
{
void *file = NULL;
H5VL_t *vol_plugin = NULL;
H5TR_t *tr = NULL;
H5TR_t *ret_value = NULL; /* Return value */
FUNC_ENTER_NOAPI_NOINIT
/* allocate transaction struct */
if(NULL == (tr = H5FL_CALLOC(H5TR_t)))
HGOTO_ERROR(H5E_SYM, H5E_NOSPACE, NULL, "can't allocate top transaction structure")
tr->file = file;
tr->c_version = rc->c_version;
tr->trans_num = trans_num;
/* set return value */
ret_value = tr;
done:
if(!ret_value && tr)
tr = H5FL_FREE(H5TR_t, tr);
FUNC_LEAVE_API(ret_value)
} /* end H5TR_create() */
/*-------------------------------------------------------------------------
* Function: H5TRstart
*
* Purpose: Starts a transaction that has been created with H5TRcreate.
*
* Return: Success: Non-Negative.
* Failure: Negative
*
* Programmer: Mohamad Chaarawi
* August 2013
*
*-------------------------------------------------------------------------
*/
herr_t
H5TRstart(hid_t tr_id, hid_t trspl_id, hid_t eq_id)
{
H5TR_t *tr = NULL;
H5_priv_request_t *request = NULL; /* private request struct inserted in event queue */
void **req = NULL; /* pointer to plugin generate requests (Stays NULL if plugin does not support async */
herr_t ret_value;
FUNC_ENTER_API(FAIL)
H5TRACE3("e", "iii", tr_id, trspl_id, eq_id);
/* get the TR object */
if(NULL == (tr = (H5TR_t *)H5I_object_verify(tr_id, H5I_TR)))
HGOTO_ERROR(H5E_ARGS, H5E_BADVALUE, FAIL, "not a Transaction ID")
/* Get correct property list */
if(H5P_DEFAULT == trspl_id)
trspl_id = H5P_TR_START_DEFAULT;
else
if(TRUE != H5P_isa_class(trspl_id, H5P_TR_START))
HGOTO_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL, "not transaction start property list")
if(eq_id != H5_EVENT_QUEUE_NULL) {
/* create the private request */
if(NULL == (request = (H5_priv_request_t *)H5MM_calloc(sizeof(H5_priv_request_t))))
HGOTO_ERROR(H5E_RESOURCE, H5E_NOSPACE, FAIL, "memory allocation failed");
request->req = NULL;
req = &request->req;
request->next = NULL;
request->vol_plugin = vol_plugin;
}
if(H5VL_iod_tr_start(tr, trspl_id, req) < 0)
HGOTO_ERROR(H5E_FILE, H5E_CANTINIT, FAIL, "failed to request a transaction start");
if(request && *req) {
if(H5EQinsert(eq_id, request) < 0)
HGOTO_ERROR(H5E_VOL, H5E_CANTINIT, FAIL, "failed to insert request in event queue");
}
done:
FUNC_LEAVE_API(ret_value)
} /* end H5TRstart()*/
/*-------------------------------------------------------------------------
* Function: H5TRfinish
*
* Purpose: Finishes/Commits a transaction.
*
* Return: Success: Non-Negative.
* Failure: Negative
*
* Programmer: Mohamad Chaarawi
* August 2013
*
*-------------------------------------------------------------------------
*/
herr_t
H5TRfinish(hid_t trans_id, hid_t trfpl_id, hid_t eq_id)
{
H5TR_t *tr = NULL;
H5_priv_request_t *request = NULL; /* private request struct inserted in event queue */
void **req = NULL; /* pointer to plugin generate requests (Stays NULL if plugin does not support async */
herr_t ret_value;
FUNC_ENTER_API(FAIL)
H5TRACE3("e", "iii", trans_id, trfpl_id, eq_id);
/* get the TR object */
if(NULL == (tr = (H5TR_t *)H5I_object_verify(tr_id, H5I_TR)))
HGOTO_ERROR(H5E_ARGS, H5E_BADVALUE, FAIL, "not a Transaction ID")
/* Get correct property list */
if(H5P_DEFAULT == trfpl_id)
trfpl_id = H5P_TR_FINISH_DEFAULT;
else
if(TRUE != H5P_isa_class(trfpl_id, H5P_TR_FINISH))
HGOTO_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL, "not transaction finish property list")
if(eq_id != H5_EVENT_QUEUE_NULL) {
/* create the private request */
if(NULL == (request = (H5_priv_request_t *)H5MM_calloc(sizeof(H5_priv_request_t))))
HGOTO_ERROR(H5E_RESOURCE, H5E_NOSPACE, FAIL, "memory allocation failed");
request->req = NULL;
req = &request->req;
request->next = NULL;
request->vol_plugin = vol_plugin;
}
if(H5VL_iod_tr_finish(tr, trfpl_id, req) < 0)
HGOTO_ERROR(H5E_FILE, H5E_CANTINIT, FAIL, "failed to request a transaction finish");
if(request && *req) {
if(H5EQinsert(eq_id, request) < 0)
HGOTO_ERROR(H5E_VOL, H5E_CANTINIT, FAIL, "failed to insert request in event queue");
}
done:
FUNC_LEAVE_API(ret_value)
} /* end H5TRfinish()*/
/*-------------------------------------------------------------------------
* Function: H5TRfinish
*
* Purpose: Set a depedency between two transactions. Transaction
* associated with trans_id is declaring a dependency on transaction
* numbered trans_num. trans_num must be < the transaction number
* trans_id is associated with.
*
* Return: Success: Non-Negative.
* Failure: Negative
*
* Programmer: Mohamad Chaarawi
* August 2013
*
*-------------------------------------------------------------------------
*/
herr_t
H5TRset_dependency(hid_t trans_id, uint64_t trans_num, hid_t eq_id)
{
H5TR_t *tr = NULL;
H5_priv_request_t *request = NULL; /* private request struct inserted in event queue */
void **req = NULL; /* pointer to plugin generate requests (Stays NULL if plugin does not support async */
herr_t ret_value;
FUNC_ENTER_API(FAIL)
/* get the TR object */
if(NULL == (tr = (H5TR_t *)H5I_object_verify(tr_id, H5I_TR)))
HGOTO_ERROR(H5E_ARGS, H5E_BADVALUE, FAIL, "not a Transaction ID")
if(tr->trans_num <= trans_num)
HGOTO_ERROR(H5E_ARGS, H5E_BADVALUE, FAIL, "The dependent transaction must be higher than the one it depends on")
if(eq_id != H5_EVENT_QUEUE_NULL) {
/* create the private request */
if(NULL == (request = (H5_priv_request_t *)H5MM_calloc(sizeof(H5_priv_request_t))))
HGOTO_ERROR(H5E_RESOURCE, H5E_NOSPACE, FAIL, "memory allocation failed");
request->req = NULL;
req = &request->req;
request->next = NULL;
request->vol_plugin = vol_plugin;
}
if(H5VL_iod_tr_set_dependency(tr, trans_num, req) < 0)
HGOTO_ERROR(H5E_FILE, H5E_CANTINIT, FAIL, "failed to request a transaction set_dependency");
if(request && *req) {
if(H5EQinsert(eq_id, request) < 0)
HGOTO_ERROR(H5E_VOL, H5E_CANTINIT, FAIL, "failed to insert request in event queue");
}
done:
FUNC_LEAVE_API(ret_value)
} /* end H5TRset_dependency()*/
/*-------------------------------------------------------------------------
* Function: H5TRabort
*
* Purpose: Aborts a transaction
*
* Return: Success: Non-Negative.
* Failure: Negative
*
* Programmer: Mohamad Chaarawi
* August 2013
*
*-------------------------------------------------------------------------
*/
herr_t
H5TRabort(hid_t trans_id, hid_t eq_id)
{
H5TR_t *tr = NULL;
H5_priv_request_t *request = NULL; /* private request struct inserted in event queue */
void **req = NULL; /* pointer to plugin generate requests (Stays NULL if plugin does not support async */
herr_t ret_value;
FUNC_ENTER_API(FAIL)
H5TRACE2("e", "ii", trans_id, eq_id);
/* get the TR object */
if(NULL == (tr = (H5TR_t *)H5I_object_verify(tr_id, H5I_TR)))
HGOTO_ERROR(H5E_ARGS, H5E_BADVALUE, FAIL, "not a Transaction ID")
if(eq_id != H5_EVENT_QUEUE_NULL) {
/* create the private request */
if(NULL == (request = (H5_priv_request_t *)H5MM_calloc(sizeof(H5_priv_request_t))))
HGOTO_ERROR(H5E_RESOURCE, H5E_NOSPACE, FAIL, "memory allocation failed");
request->req = NULL;
req = &request->req;
request->next = NULL;
request->vol_plugin = vol_plugin;
}
if(H5VL_iod_tr_abort(tr, req) < 0)
HGOTO_ERROR(H5E_FILE, H5E_CANTINIT, FAIL, "failed to request a transaction abort");
if(request && *req) {
if(H5EQinsert(eq_id, request) < 0)
HGOTO_ERROR(H5E_VOL, H5E_CANTINIT, FAIL, "failed to insert request in event queue");
}
done:
FUNC_LEAVE_API(ret_value)
} /* end H5TRabort()*/
/*-------------------------------------------------------------------------
* Function: H5TRclose
*
* Purpose: Closes the specified transaction ID. The ID will no longer be
* valid for accessing the transaction.
*
* Return: Non-negative on success/Negative on failure
*
* Programmer: Mohamad Chaarawi
* August 2013
*
*-------------------------------------------------------------------------
*/
herr_t
H5TRclose(hid_t tr_id)
{
herr_t ret_value = SUCCEED; /* Return value */
FUNC_ENTER_API(FAIL)
H5TRACE1("e", "i", tr_id);
/* Check args */
if(NULL == H5I_object_verify(tr_id,H5I_TR))
HGOTO_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL, "not an transaction ID")
if(H5I_dec_app_ref(tr_id) < 0)
HGOTO_ERROR(H5E_SYM, H5E_CANTRELEASE, FAIL, "unable to close transaction")
done:
FUNC_LEAVE_API(ret_value)
} /* end H5TRclose() */
/*-------------------------------------------------------------------------
* Function: H5TR_close
*
* Purpose: Closes the specified transaction ID. The ID will no longer be
* valid for accessing the transaction.
*
* Return: Non-negative on success/Negative on failure
*
* Programmer: Mohamad Chaarawi
* August 2013
*
*-------------------------------------------------------------------------
*/
herr_t
H5TR_close(H5TR_t *tr)
{
herr_t ret_value = SUCCEED; /* Return value */
FUNC_ENTER_API(FAIL)
tr = H5FL_FREE(H5TR_t, tr);
done:
FUNC_LEAVE_API(ret_value)
} /* end H5TR_close() */
|