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
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
|
/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
* 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 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. *
* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
#define H5F_FRIEND /*suppress error about including H5Fpkg */
#include "hdf5.h"
#include "H5Fpkg.h"
#include "H5HGprivate.h"
#include "H5VLprivate.h"
#include "testhdf5.h"
#include "vfd_swmr_common.h"
#ifndef H5_HAVE_WIN32_API
#define READER_WAIT_TICKS 3
typedef struct {
hid_t file, filetype, one_by_one_sid;
char filename[PATH_MAX];
char progname[PATH_MAX];
unsigned int asteps;
unsigned int csteps;
unsigned int nsteps;
unsigned int update_interval;
bool use_vfd_swmr;
bool use_named_pipes;
} state_t;
#define ALL_HID_INITIALIZER \
(state_t) \
{ \
.file = H5I_INVALID_HID, .one_by_one_sid = H5I_INVALID_HID, .filename = "", \
.filetype = H5T_NATIVE_UINT32, .asteps = 10, .csteps = 10, .nsteps = 100, .update_interval = READER_WAIT_TICKS, \
.use_vfd_swmr = true, \
.use_named_pipes = true \
}
static void
usage(const char *progname)
{
fprintf(stderr, "usage: %s [-S] [-a steps] [-b] [-c]\n"
" [-n iterations] [-N] [-q] [-u numb_ticks]\n"
"\n"
"-S: do not use VFD SWMR\n"
"-a steps: `steps` between adding attributes\n"
"-b: write data in big-endian byte order\n"
"-c steps: `steps` between communication between the writer and reader\n"
"-n ngroups: the number of groups\n"
"-N: do not use named pipes, mainly for running the writer and reader seperately\n"
"-u numb_tcks: `numb_ticks` for the reader to wait before verification\n"
"-q: silence printouts, few messages\n"
"\n",
progname);
exit(EXIT_FAILURE);
}
static bool
state_init(state_t *s, int argc, char **argv)
{
unsigned long tmp;
int ch;
const hsize_t dims = 1;
char *tfile = NULL;
char * end;
*s = ALL_HID_INITIALIZER;
if (H5_basename(argv[0], &tfile) < 0) {
H5_FAILED(); AT();
printf("H5_basename failed\n");
goto error;
}
esnprintf(s->progname, sizeof(s->progname), "%s", tfile);
if (tfile)
HDfree(tfile);
while ((ch = getopt(argc, argv, "Sa:bc:n:Nqu:")) != -1) {
switch (ch) {
case 'S':
s->use_vfd_swmr = false;
break;
case 'a':
case 'c':
case 'n':
case 'u':
errno = 0;
tmp = strtoul(optarg, &end, 0);
if (end == optarg || *end != '\0') {
H5_FAILED(); AT();
printf("couldn't parse `-%c` argument `%s`\n", ch, optarg);
goto error;
} else if (errno != 0) {
H5_FAILED(); AT();
printf("couldn't parse `-%c` argument `%s`\n", ch, optarg);
goto error;
} else if (tmp > UINT_MAX) {
H5_FAILED(); AT();
printf("`-%c` argument `%lu` too large\n", ch, tmp);
goto error;
}
if (ch == 'a')
s->asteps = (unsigned)tmp;
else if (ch == 'c')
s->csteps = (unsigned)tmp;
else if (ch == 'n')
s->nsteps = (unsigned)tmp;
else if (ch == 'u')
s->update_interval = (unsigned)tmp;
break;
case 'b':
s->filetype = H5T_STD_U32BE;
break;
case 'N':
s->use_named_pipes = false;
break;
case 'q':
verbosity = 0;
break;
case '?':
default:
usage(s->progname);
break;
}
}
argc -= optind;
argv += optind;
/* space for attributes */
if ((s->one_by_one_sid = H5Screate_simple(1, &dims, &dims)) < 0) {
H5_FAILED(); AT();
printf("H5Screate_simple failed\n");
goto error;
}
if( s->csteps < 1 || s->csteps > s->nsteps) {
H5_FAILED(); AT();
printf("communication interval is out of bounds\n");
goto error;
}
if( s->asteps < 1 || s->asteps > s->nsteps) {
H5_FAILED(); AT();
printf("attribute interval is out of bounds\n");
goto error;
}
if (argc > 0) {
H5_FAILED(); AT();
printf("unexpected command-line arguments\n");
goto error;
}
esnprintf(s->filename, sizeof(s->filename), "vfd_swmr_group.h5");
return true;
error:
if (tfile)
HDfree(tfile);
return false;
}
static bool
add_group_attribute(const state_t *s, hid_t g, hid_t sid, unsigned int which)
{
hid_t aid;
char name[sizeof("attr-9999999999")];
esnprintf(name, sizeof(name), "attr-%u", which);
dbgf(1, "setting attribute %s on group %u to %u\n", name, which, which);
if ((aid = H5Acreate2(g, name, s->filetype, sid, H5P_DEFAULT,
H5P_DEFAULT)) < 0) {
H5_FAILED(); AT();
printf("H5Acreate2 failed\n");
goto error;
}
if (H5Awrite(aid, H5T_NATIVE_UINT, &which) < 0) {
H5_FAILED(); AT();
printf("H5Awrite failed\n");
goto error;
}
if (H5Aclose(aid) < 0) {
H5_FAILED(); AT();
printf("H5Aclose failed\n");
goto error;
}
return true;
error:
H5E_BEGIN_TRY {
H5Aclose(aid);
} H5E_END_TRY;
return false;
}
static bool
write_group(state_t *s, unsigned int which)
{
char name[sizeof("/group-9999999999")];
hid_t g = H5I_INVALID_HID;
bool result = true;
if (which >= s->nsteps) {
H5_FAILED(); AT();
printf("group order is out of bounds\n");
goto error;
}
esnprintf(name, sizeof(name), "/group-%d", which);
if ((g = H5Gcreate2(s->file, name, H5P_DEFAULT, H5P_DEFAULT, H5P_DEFAULT)) < 0) {
H5_FAILED(); AT();
printf("H5Gcreate2 failed\n");
goto error;
}
if (s->asteps != 0 && which % s->asteps == 0)
result = add_group_attribute(s, g, s->one_by_one_sid, which);
if (H5Gclose(g) < 0) {
H5_FAILED(); AT();
printf("H5Gclose failed\n");
goto error;
}
return result;
error:
H5E_BEGIN_TRY {
H5Gclose(g);
} H5E_END_TRY;
return false;
}
static bool
verify_group_attribute(hid_t g, unsigned int which)
{
unsigned int read_which;
hid_t aid;
char name[sizeof("attr-9999999999")];
esnprintf(name, sizeof(name), "attr-%u", which);
dbgf(1, "verifying attribute %s on group %u equals %u\n", name, which, which);
if ((aid = H5Aopen(g, name, H5P_DEFAULT)) < 0) {
H5_FAILED(); AT();
printf("H5Aopen failed\n");
goto error;
}
if (H5Aread(aid, H5T_NATIVE_UINT, &read_which) < 0) {
H5_FAILED(); AT();
printf("H5Aread failed\n");
goto error;
}
if (read_which != which) {
H5_FAILED(); AT();
printf("H5Aread wrong value\n");
goto error;
}
if (H5Aclose(aid) < 0) {
H5_FAILED(); AT();
printf("H5Aread failed\n");
goto error;
}
return true;
error:
H5E_BEGIN_TRY {
H5Aclose(aid);
} H5E_END_TRY;
return false;
}
static bool
verify_group(state_t *s, unsigned int which)
{
char name[sizeof("/group-9999999999")];
hid_t g = H5I_INVALID_HID;
bool result = true;
if (which >= s->nsteps) {
H5_FAILED(); AT();
printf("Group order is out of bounds\n");
goto error;
}
esnprintf(name, sizeof(name), "/group-%d", which);
if ((g = H5Gopen(s->file, name, H5P_DEFAULT)) < 0) {
H5_FAILED(); AT();
printf("H5Gopen failed\n");
goto error;
}
if (s->asteps != 0 && which % s->asteps == 0)
result = verify_group_attribute(g, which);
else
result = true;
if (H5Gclose(g) < 0) {
H5_FAILED(); AT();
printf("H5Gclose failed\n");
goto error;
}
return result;
error:
H5E_BEGIN_TRY {
H5Gclose(g);
} H5E_END_TRY;
return false;
}
int
main(int argc, char **argv)
{
hid_t fapl = H5I_INVALID_HID, fcpl = H5I_INVALID_HID;
unsigned step;
bool writer = false;
state_t s;
const char *personality;
H5F_vfd_swmr_config_t config;
const char *fifo_writer_to_reader = "./fifo_group_writer_to_reader";
const char *fifo_reader_to_writer = "./fifo_group_reader_to_writer";
int fd_writer_to_reader = -1, fd_reader_to_writer = -1;
int notify = 0, verify = 0;
unsigned int i;
if (!state_init(&s, argc, argv)) {
H5_FAILED(); AT();
printf("state_init failed\n");
goto error;
}
personality = strstr(s.progname, "vfd_swmr_group_");
if (personality != NULL && strcmp(personality, "vfd_swmr_group_writer") == 0)
writer = true;
else if (personality != NULL && strcmp(personality, "vfd_swmr_group_reader") == 0)
writer = false;
else {
H5_FAILED(); AT();
printf("unknown personality, expected vfd_swmr_group_{reader,writer}\n");
goto error;
}
/* config, tick_len, max_lag, writer, flush_raw_data, md_pages_reserved, md_file_path */
init_vfd_swmr_config(&config, 4, 7, writer, FALSE, 128, "./group-shadow");
/* use_latest_format, use_vfd_swmr, only_meta_page, config */
if ((fapl = vfd_swmr_create_fapl(true, s.use_vfd_swmr, true, &config)) < 0) {
H5_FAILED(); AT();
printf("vfd_swmr_create_fapl failed\n");
goto error;
}
if ((fcpl = H5Pcreate(H5P_FILE_CREATE)) < 0) {
H5_FAILED(); AT();
printf("H5Pcreate failed\n");
goto error;
}
if (H5Pset_file_space_strategy(fcpl, H5F_FSPACE_STRATEGY_PAGE, false, 1) < 0) {
H5_FAILED(); AT();
printf("H5Pset_file_space_strategy failed\n");
goto error;
}
if (writer)
s.file = H5Fcreate(s.filename, H5F_ACC_TRUNC, fcpl, fapl);
else
s.file = H5Fopen(s.filename, H5F_ACC_RDONLY, fapl);
if (s.file < 0) {
H5_FAILED(); AT();
printf("H5Fcreate/open failed\n");
goto error;
}
/* Use two named pipes(FIFO) to coordinate the writer and reader for
* two-way communication so that the two sides can move forward together.
* One is for the writer to write to the reader.
* The other one is for the reader to signal the writer. */
if (s.use_named_pipes && writer) {
/* Writer creates two named pipes(FIFO) */
if (HDmkfifo(fifo_writer_to_reader, 0600) < 0) {
H5_FAILED(); AT();
printf("HDmkfifo failed\n");
goto error;
}
if (HDmkfifo(fifo_reader_to_writer, 0600) < 0) {
H5_FAILED(); AT();
printf("HDmkfifo failed\n");
goto error;
}
}
/* Both the writer and reader open the pipes */
if (s.use_named_pipes && (fd_writer_to_reader = HDopen(fifo_writer_to_reader, O_RDWR)) < 0) {
H5_FAILED(); AT();
printf("HDopen failed\n");
goto error;
}
if (s.use_named_pipes && (fd_reader_to_writer = HDopen(fifo_reader_to_writer, O_RDWR)) < 0) {
H5_FAILED(); AT();
printf("HDopen failed\n");
goto error;
}
if (writer) {
for (step = 0; step < s.nsteps; step++) {
dbgf(2, "writer: step %d\n", step);
if (!write_group(&s, step)) {
H5_FAILED(); AT();
printf("write_group failed\n");
/* At communication interval, notifies the reader about the failture and quit */
if (s.use_named_pipes && (step % s.csteps == 0)) {
notify = -1;
HDwrite(fd_writer_to_reader, ¬ify, sizeof(int));
}
goto error;
} else {
/* At communication interval, notifies the reader and waits for its response */
if (s.use_named_pipes && (step % s.csteps == 0)) {
/* Bump up the value of notify to notice the reader to start to read */
notify++;
if (HDwrite(fd_writer_to_reader, ¬ify, sizeof(int)) < 0) {
H5_FAILED(); AT();
printf("HDwrite failed\n");
goto error;
}
/* During the wait, writer makes repeated HDF5 API calls
* to trigger EOT at approximately the correct time */
for(i = 0; i < config.max_lag + 1; i++) {
decisleep(config.tick_len);
H5E_BEGIN_TRY {
H5Aexists(s.file, "nonexistent");
} H5E_END_TRY;
}
/* Receive the same value from the reader and verify it before
* going to the next step */
verify++;
if (HDread(fd_reader_to_writer, ¬ify, sizeof(int)) < 0) {
H5_FAILED(); AT();
printf("HDread failed\n");
goto error;
}
if (notify == -1) {
H5_FAILED(); AT();
printf("reader failed to verify group\n");
goto error;
}
if (notify != verify) {
H5_FAILED(); AT();
printf("received message %d, expecting %d\n", notify, verify);
goto error;
}
}
}
}
}
else {
for (step = 0; step < s.nsteps; step++) {
dbgf(2, "reader: step %d\n", step);
/* At communication interval, waits for the writer to finish creation before starting verification
*/
if (s.use_named_pipes && (step % s.csteps == 0)) {
/* The writer should have bumped up the value of notify.
* Do the same with verify and confirm it */
verify++;
/* Receive the notify that the writer bumped up the value */
if (HDread(fd_writer_to_reader, ¬ify, sizeof(int)) < 0) {
H5_FAILED(); AT();
printf("HDread failed\n");
goto error;
}
if (notify == -1) {
H5_FAILED(); AT();
printf("writer failed to create group\n");
goto error;
}
if (notify != verify) {
H5_FAILED(); AT();
printf("received message %d, expecting %d\n", notify, verify);
goto error;
}
}
/* Wait for a few ticks for the update to happen */
if (s.use_named_pipes)
decisleep(config.tick_len * s.update_interval);
/* Start to verify group */
if (!verify_group(&s, step)) {
H5_FAILED(); AT();
printf("verify_group failed\n");
/* At communication interval, tell the writer about the failure and exit */
if (s.use_named_pipes && (step % s.csteps == 0)) {
notify = -1;
HDwrite(fd_reader_to_writer, ¬ify, sizeof(int));
}
goto error;
} else {
if (s.use_named_pipes && (step % s.csteps == 0)) {
/* Send back the same nofity value for acknowledgement to tell the writer
* move to the next step */
if (HDwrite(fd_reader_to_writer, ¬ify, sizeof(int)) < 0) {
H5_FAILED(); AT();
printf("HDwrite failed\n");
goto error;
}
}
}
}
}
if (H5Pclose(fapl) < 0) {
H5_FAILED(); AT();
printf("H5Pclose failed\n");
goto error;
}
if (H5Pclose(fcpl) < 0) {
H5_FAILED(); AT();
printf("H5Pclose failed\n");
goto error;
}
if (H5Fclose(s.file) < 0) {
H5_FAILED(); AT();
printf("H5Fclose failed\n");
goto error;
}
/* Both the writer and reader close the named pipes */
if (s.use_named_pipes && HDclose(fd_writer_to_reader) < 0) {
H5_FAILED(); AT();
printf("HDclose failed\n");
goto error;
}
if (s.use_named_pipes && HDclose(fd_reader_to_writer) < 0) {
H5_FAILED(); AT();
printf("HDclose failed\n");
goto error;
}
/* Reader finishes last and deletes the named pipes */
if(s.use_named_pipes && !writer) {
if(HDremove(fifo_writer_to_reader) != 0) {
H5_FAILED(); AT();
printf("HDremove failed\n");
goto error;
}
if(HDremove(fifo_reader_to_writer) != 0) {
H5_FAILED(); AT();
printf("HDremove failed\n");
goto error;
}
}
return EXIT_SUCCESS;
error:
H5E_BEGIN_TRY {
H5Pclose(fapl);
H5Pclose(fcpl);
H5Fclose(s.file);
} H5E_END_TRY;
if (s.use_named_pipes && fd_writer_to_reader >= 0)
HDclose(fd_writer_to_reader);
if (s.use_named_pipes && fd_reader_to_writer >= 0)
HDclose(fd_reader_to_writer);
if(s.use_named_pipes && !writer) {
HDremove(fifo_writer_to_reader);
HDremove(fifo_reader_to_writer);
}
return EXIT_FAILURE;
}
#else /* H5_HAVE_WIN32_API */
int
main(void)
{
HDfprintf(stderr, "Non-POSIX platform. Skipping.\n");
return EXIT_SUCCESS;
} /* end main() */
#endif /* H5_HAVE_WIN32_API */
|