forked from HDFGroup/hdf5
-
Notifications
You must be signed in to change notification settings - Fork 1
/
dangle.c
677 lines (547 loc) · 18.2 KB
/
dangle.c
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
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
* 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 LICENSE 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 *
* [email protected]. *
* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
/*
* Purpose: Test dangling IDs
*/
#include "h5test.h"
static const char *FILENAME[] = {"dangle", NULL};
#define MAX_DANGLE 1000
#define DSETNAME "Dataset"
#define GROUPNAME "Group"
#define TYPENAME "Type"
#define ATTRNAME "Attribute"
/*-------------------------------------------------------------------------
* Function: test_dangle_dataset
*
* Purpose: Check for dangling dataset IDs causing problems on library
* shutdown
*
* Return: Success: zero
* Failure: non-zero
*
*-------------------------------------------------------------------------
*/
static int
test_dangle_dataset(H5F_close_degree_t degree)
{
char filename[1024];
hid_t fid; /* File ID */
hid_t fapl; /* File access property list */
hid_t dsid; /* Dataset ID */
hid_t sid; /* Dataspace ID */
unsigned u; /* Local index variable */
TESTING(" dangling dataset IDs");
if (H5open() < 0)
TEST_ERROR;
/* Create file access property list */
if ((fapl = H5Pcreate(H5P_FILE_ACCESS)) < 0)
TEST_ERROR;
/* Set file close degree */
if (H5Pset_fclose_degree(fapl, degree) < 0)
TEST_ERROR;
h5_fixname(FILENAME[0], H5P_DEFAULT, filename, sizeof filename);
if ((fid = H5Fcreate(filename, H5F_ACC_TRUNC, H5P_DEFAULT, fapl)) < 0)
TEST_ERROR;
if ((sid = H5Screate(H5S_SCALAR)) < 0)
TEST_ERROR;
if ((dsid = H5Dcreate2(fid, DSETNAME, H5T_NATIVE_INT, sid, H5P_DEFAULT, H5P_DEFAULT, H5P_DEFAULT)) < 0)
TEST_ERROR;
if (H5Dclose(dsid) < 0)
TEST_ERROR;
/* Try creating duplicate dataset */
H5E_BEGIN_TRY
{
if ((dsid = H5Dcreate2(fid, DSETNAME, H5T_NATIVE_INT, sid, H5P_DEFAULT, H5P_DEFAULT, H5P_DEFAULT)) >=
0)
TEST_ERROR;
}
H5E_END_TRY
if (H5Sclose(sid) < 0)
TEST_ERROR;
/* Leave open a _lot_ of objects */
for (u = 0; u < MAX_DANGLE; u++)
if ((dsid = H5Dopen2(fid, DSETNAME, H5P_DEFAULT)) < 0)
TEST_ERROR;
if (degree == H5F_CLOSE_SEMI) {
H5E_BEGIN_TRY
{
if (H5Fclose(fid) >= 0)
TEST_ERROR;
}
H5E_END_TRY
} /* end if */
else if (H5Fclose(fid) < 0)
TEST_ERROR;
if (h5_get_file_size(filename, fapl) < 0)
TEST_ERROR;
if (H5Pclose(fapl) < 0)
TEST_ERROR;
if (H5close() < 0)
TEST_ERROR;
/* Clean up temporary file */
HDremove(filename);
PASSED();
return 0;
error:
return 1;
}
/*-------------------------------------------------------------------------
* Function: test_dangle_group
*
* Purpose: Check for dangling group IDs causing problems on library
* shutdown
*
* Return: Success: zero
* Failure: non-zero
*
*-------------------------------------------------------------------------
*/
static int
test_dangle_group(H5F_close_degree_t degree)
{
char filename[1024];
hid_t fid; /* File ID */
hid_t fapl; /* File access property list */
hid_t gid; /* Group ID */
unsigned u; /* Local index variable */
TESTING(" dangling group IDs");
if (H5open() < 0)
TEST_ERROR;
/* Create file access property list */
if ((fapl = H5Pcreate(H5P_FILE_ACCESS)) < 0)
TEST_ERROR;
/* Set file close degree */
if (H5Pset_fclose_degree(fapl, degree) < 0)
TEST_ERROR;
h5_fixname(FILENAME[0], H5P_DEFAULT, filename, sizeof filename);
if ((fid = H5Fcreate(filename, H5F_ACC_TRUNC, H5P_DEFAULT, fapl)) < 0)
TEST_ERROR;
if ((gid = H5Gcreate2(fid, GROUPNAME, H5P_DEFAULT, H5P_DEFAULT, H5P_DEFAULT)) < 0)
FAIL_STACK_ERROR;
if (H5Gclose(gid) < 0)
TEST_ERROR;
/* Try creating duplicate group */
H5E_BEGIN_TRY
{
gid = H5Gcreate2(fid, GROUPNAME, H5P_DEFAULT, H5P_DEFAULT, H5P_DEFAULT);
}
H5E_END_TRY
if (gid >= 0)
TEST_ERROR;
/* Leave open a _lot_ of objects */
for (u = 0; u < MAX_DANGLE; u++)
if ((gid = H5Gopen2(fid, GROUPNAME, H5P_DEFAULT)) < 0)
FAIL_STACK_ERROR;
if ((gid = H5Gopen2(fid, GROUPNAME, H5P_DEFAULT)) < 0)
FAIL_STACK_ERROR;
if (degree == H5F_CLOSE_SEMI) {
H5E_BEGIN_TRY
{
if (H5Fclose(fid) >= 0)
TEST_ERROR;
}
H5E_END_TRY
} /* end if */
else if (H5Fclose(fid) < 0)
TEST_ERROR;
if (h5_get_file_size(filename, fapl) < 0)
TEST_ERROR;
if (H5Pclose(fapl) < 0)
TEST_ERROR;
if (H5close() < 0)
TEST_ERROR;
/* Clean up temporary file */
HDremove(filename);
PASSED();
return 0;
error:
return 1;
}
/*-------------------------------------------------------------------------
* Function: test_dangle_datatype1
*
* Purpose: Check for dangling datatype IDs causing problems on library
* shutdown
*
* Return: Success: zero
* Failure: non-zero
*
*-------------------------------------------------------------------------
*/
static int
test_dangle_datatype1(H5F_close_degree_t degree)
{
char filename[1024];
hid_t fid; /* File ID */
hid_t fapl; /* File access property list */
hid_t tid; /* Datatype ID */
unsigned u; /* Local index variable */
TESTING(" dangling named datatype IDs");
if (H5open() < 0)
TEST_ERROR;
/* Create file access property list */
if ((fapl = H5Pcreate(H5P_FILE_ACCESS)) < 0)
TEST_ERROR;
/* Set file close degree */
if (H5Pset_fclose_degree(fapl, degree) < 0)
TEST_ERROR;
h5_fixname(FILENAME[0], H5P_DEFAULT, filename, sizeof filename);
if ((fid = H5Fcreate(filename, H5F_ACC_TRUNC, H5P_DEFAULT, fapl)) < 0)
TEST_ERROR;
if ((tid = H5Tcopy(H5T_NATIVE_INT)) < 0)
TEST_ERROR;
if (H5Tcommit2(fid, TYPENAME, tid, H5P_DEFAULT, H5P_DEFAULT, H5P_DEFAULT) < 0)
TEST_ERROR;
if (H5Tclose(tid) < 0)
TEST_ERROR;
/* Try creating duplicate named datatype */
if ((tid = H5Tcopy(H5T_NATIVE_INT)) < 0)
TEST_ERROR;
H5E_BEGIN_TRY
{
if (H5Tcommit2(fid, TYPENAME, tid, H5P_DEFAULT, H5P_DEFAULT, H5P_DEFAULT) >= 0)
TEST_ERROR;
}
H5E_END_TRY
if (H5Tclose(tid) < 0)
TEST_ERROR;
/* Leave open a _lot_ of objects */
for (u = 0; u < MAX_DANGLE; u++)
if ((tid = H5Topen2(fid, TYPENAME, H5P_DEFAULT)) < 0)
FAIL_STACK_ERROR;
if (degree == H5F_CLOSE_SEMI) {
H5E_BEGIN_TRY
{
if (H5Fclose(fid) >= 0)
TEST_ERROR;
}
H5E_END_TRY
} /* end if */
else if (H5Fclose(fid) < 0)
TEST_ERROR;
if (h5_get_file_size(filename, fapl) < 0)
TEST_ERROR;
if (H5Pclose(fapl) < 0)
TEST_ERROR;
if (H5close() < 0)
TEST_ERROR;
/* Clean up temporary file */
HDremove(filename);
PASSED();
return 0;
error:
return 1;
}
/*-------------------------------------------------------------------------
* Function: test_dangle_datatype2
*
* Purpose: Check for dangling datatype IDs causing problems on library
* shutdown
*
* Return: Success: zero
* Failure: non-zero
*
*-------------------------------------------------------------------------
*/
static int
test_dangle_datatype2(H5F_close_degree_t degree)
{
char filename[1024];
hid_t fid; /* File ID */
hid_t fapl; /* File access property list */
hid_t did; /* Dataset ID */
hid_t sid; /* Dataspace ID */
hid_t tid; /* Datatype ID */
TESTING(" dangling named datatype ID used by dataset");
if (H5open() < 0)
TEST_ERROR;
/* Create file access property list */
if ((fapl = H5Pcreate(H5P_FILE_ACCESS)) < 0)
TEST_ERROR;
/* Set file close degree */
if (H5Pset_fclose_degree(fapl, degree) < 0)
TEST_ERROR;
h5_fixname(FILENAME[0], H5P_DEFAULT, filename, sizeof filename);
if ((fid = H5Fcreate(filename, H5F_ACC_TRUNC, H5P_DEFAULT, fapl)) < 0)
TEST_ERROR;
if ((tid = H5Tcopy(H5T_NATIVE_INT)) < 0)
TEST_ERROR;
if (H5Tcommit2(fid, TYPENAME, tid, H5P_DEFAULT, H5P_DEFAULT, H5P_DEFAULT) < 0)
TEST_ERROR;
/* Create a dataset that uses the named datatype & leave it open */
if ((sid = H5Screate(H5S_SCALAR)) < 0)
TEST_ERROR;
if ((did = H5Dcreate2(fid, DSETNAME, tid, sid, H5P_DEFAULT, H5P_DEFAULT, H5P_DEFAULT)) < 0)
TEST_ERROR;
if (H5Sclose(sid) < 0)
TEST_ERROR;
if (degree == H5F_CLOSE_SEMI) {
H5E_BEGIN_TRY
{
if (H5Fclose(fid) >= 0)
TEST_ERROR;
}
H5E_END_TRY
} /* end if */
else if (H5Fclose(fid) < 0)
TEST_ERROR;
if (h5_get_file_size(filename, fapl) < 0)
TEST_ERROR;
if (H5Pclose(fapl) < 0)
TEST_ERROR;
if (H5close() < 0)
TEST_ERROR;
/* Clean up temporary file */
HDremove(filename);
PASSED();
return 0;
error:
return 1;
}
/*-------------------------------------------------------------------------
* Function: test_dangle_attribute
*
* Purpose: Check for dangling attribute IDs causing problems on library
* shutdown
*
* Return: Success: zero
* Failure: non-zero
*
*-------------------------------------------------------------------------
*/
static int
test_dangle_attribute(H5F_close_degree_t degree)
{
char filename[1024];
hid_t fid; /* File ID */
hid_t fapl; /* File access property list */
hid_t dsid; /* Dataset ID */
hid_t sid; /* Dataspace ID */
hid_t aid; /* Attribute ID */
unsigned u; /* Local index variable */
TESTING(" dangling attribute IDs");
if (H5open() < 0)
TEST_ERROR;
/* Create file access property list */
if ((fapl = H5Pcreate(H5P_FILE_ACCESS)) < 0)
TEST_ERROR;
/* Set file close degree */
if (H5Pset_fclose_degree(fapl, degree) < 0)
TEST_ERROR;
h5_fixname(FILENAME[0], H5P_DEFAULT, filename, sizeof filename);
if ((fid = H5Fcreate(filename, H5F_ACC_TRUNC, H5P_DEFAULT, fapl)) < 0)
TEST_ERROR;
if ((sid = H5Screate(H5S_SCALAR)) < 0)
TEST_ERROR;
if ((dsid = H5Dcreate2(fid, DSETNAME, H5T_NATIVE_INT, sid, H5P_DEFAULT, H5P_DEFAULT, H5P_DEFAULT)) < 0)
TEST_ERROR;
/* Create an attribute on the dataset */
if ((aid = H5Acreate2(dsid, ATTRNAME, H5T_NATIVE_INT, sid, H5P_DEFAULT, H5P_DEFAULT)) < 0)
TEST_ERROR;
/* Don't worry about writing the attribute - it will have a fill value */
/* Close the attribute on the dataset */
if (H5Aclose(aid) < 0)
TEST_ERROR;
/* Try creating duplicate attribute */
H5E_BEGIN_TRY
{
if ((aid = H5Acreate2(dsid, ATTRNAME, H5T_NATIVE_INT, sid, H5P_DEFAULT, H5P_DEFAULT)) >= 0)
TEST_ERROR;
}
H5E_END_TRY
if (H5Sclose(sid) < 0)
TEST_ERROR;
/* Leave open a _lot_ of objects */
for (u = 0; u < MAX_DANGLE; u++)
if ((aid = H5Aopen(dsid, ATTRNAME, H5P_DEFAULT)) < 0)
TEST_ERROR;
if (H5Dclose(dsid) < 0)
TEST_ERROR;
if (degree == H5F_CLOSE_SEMI) {
H5E_BEGIN_TRY
{
if (H5Fclose(fid) >= 0)
TEST_ERROR;
}
H5E_END_TRY
} /* end if */
else if (H5Fclose(fid) < 0)
TEST_ERROR;
if (h5_get_file_size(filename, fapl) < 0)
TEST_ERROR;
if (H5Pclose(fapl) < 0)
TEST_ERROR;
if (H5close() < 0)
TEST_ERROR;
/* Clean up temporary file */
HDremove(filename);
PASSED();
return 0;
error:
return 1;
}
/*-------------------------------------------------------------------------
* Function: test_dangle_force
*
* Purpose: Shut down all danging IDs with generic file & ID routines,
* instead of letting library shut then down.
*
* Return: Success: zero
* Failure: non-zero
*
*-------------------------------------------------------------------------
*/
static int
test_dangle_force(void)
{
char filename[1024];
hid_t fid; /* File ID */
hid_t gid, gid2; /* Group IDs */
hid_t dsid, dsid2; /* Dataset IDs */
hid_t sid; /* Dataspace ID */
hid_t aid, aid2; /* Attribute IDs */
hid_t tid, tid2; /* Named datatype IDs */
ssize_t count; /* Count of open objects */
hid_t *objs = NULL; /* Pointer to list of open objects */
size_t u; /* Local index variable */
TESTING("force dangling IDs to close, from API routines");
h5_fixname(FILENAME[0], H5P_DEFAULT, filename, sizeof filename);
if ((fid = H5Fcreate(filename, H5F_ACC_TRUNC, H5P_DEFAULT, H5P_DEFAULT)) < 0)
FAIL_STACK_ERROR;
/* Create a dataspace for the dataset & attribute to use */
if ((sid = H5Screate(H5S_SCALAR)) < 0)
FAIL_STACK_ERROR;
/* Create a dataset */
if ((dsid = H5Dcreate2(fid, DSETNAME, H5T_NATIVE_INT, sid, H5P_DEFAULT, H5P_DEFAULT, H5P_DEFAULT)) < 0)
FAIL_STACK_ERROR;
/* Re-open the dataset */
if ((dsid2 = H5Dopen2(fid, DSETNAME, H5P_DEFAULT)) < 0)
FAIL_STACK_ERROR;
/* Create an attribute on the dataset */
if ((aid = H5Acreate2(dsid, ATTRNAME, H5T_NATIVE_INT, sid, H5P_DEFAULT, H5P_DEFAULT)) < 0)
FAIL_STACK_ERROR;
/* Re-open the attribute */
if ((aid2 = H5Aopen(dsid, ATTRNAME, H5P_DEFAULT)) < 0)
FAIL_STACK_ERROR;
/* Close the dataspace ID */
if (H5Sclose(sid) < 0)
FAIL_STACK_ERROR;
/* Open a group ID */
if ((gid = H5Gopen2(fid, "/", H5P_DEFAULT)) < 0)
FAIL_STACK_ERROR;
/* Open group again */
if ((gid2 = H5Gopen2(fid, "/", H5P_DEFAULT)) < 0)
FAIL_STACK_ERROR;
/* Create a named datatype */
if ((tid = H5Tcopy(H5T_NATIVE_INT)) < 0)
FAIL_STACK_ERROR;
if (H5Tcommit2(fid, TYPENAME, tid, H5P_DEFAULT, H5P_DEFAULT, H5P_DEFAULT) < 0)
FAIL_STACK_ERROR;
/* Re-open the named datatype */
if ((tid2 = H5Topen2(fid, TYPENAME, H5P_DEFAULT)) < 0)
FAIL_STACK_ERROR;
/* Increment the ref count on all the "second" objects */
if (H5Iinc_ref(dsid2) < 0)
FAIL_STACK_ERROR;
if (H5Iinc_ref(aid2) < 0)
FAIL_STACK_ERROR;
if (H5Iinc_ref(gid2) < 0)
FAIL_STACK_ERROR;
if (H5Iinc_ref(aid2) < 0)
FAIL_STACK_ERROR;
/* Get the number of open objects */
if ((count = H5Fget_obj_count((hid_t)H5F_OBJ_ALL, H5F_OBJ_ALL)) < 0)
FAIL_STACK_ERROR;
if (0 == count)
TEST_ERROR;
/* Allocate the array of object IDs */
if (NULL == (objs = (hid_t *)calloc((size_t)count, sizeof(hid_t))))
TEST_ERROR;
/* Get the list of open IDs */
if (H5Fget_obj_ids((hid_t)H5F_OBJ_ALL, H5F_OBJ_ALL, (size_t)count, objs) < 0)
FAIL_STACK_ERROR;
/* Close all open IDs */
for (u = 0; u < (size_t)count; u++)
while (H5Iget_type(objs[u]) != H5I_BADID && H5Iget_ref(objs[u]) > 0)
H5Idec_ref(objs[u]);
/* Get the number of open objects */
if ((count = H5Fget_obj_count((hid_t)H5F_OBJ_ALL, H5F_OBJ_ALL)) < 0)
FAIL_STACK_ERROR;
if (0 != count)
TEST_ERROR;
/* Clean up temporary file */
HDremove(filename);
/* Release object ID array */
free(objs);
PASSED();
return 0;
error:
if (objs)
free(objs);
return 1;
}
/*-------------------------------------------------------------------------
* Function: main
*
* Purpose: Executes dangling ID tests
*
* Return: Success: zero
* Failure: non-zero
*
*-------------------------------------------------------------------------
*/
int
main(void)
{
const char *driver_name; /* File Driver value from environment */
int nerrors = 0;
/* Get the VFD to use */
driver_name = h5_get_test_driver_name();
/* Don't run this test with the multi/split VFD. A bug in library shutdown
* ordering causes problems with the multi VFD when IDs are left dangling.
*/
if (!strcmp(driver_name, "multi") || !strcmp(driver_name, "split")) {
puts(" -- SKIPPED for incompatible VFD --");
return 0;
}
/* Run tests w/weak file close */
puts("Testing dangling objects with weak file close:");
nerrors += test_dangle_dataset(H5F_CLOSE_WEAK);
nerrors += test_dangle_group(H5F_CLOSE_WEAK);
nerrors += test_dangle_datatype1(H5F_CLOSE_WEAK);
nerrors += test_dangle_datatype2(H5F_CLOSE_WEAK);
nerrors += test_dangle_attribute(H5F_CLOSE_WEAK);
/* Run tests w/semi file close */
puts("Testing dangling objects with semi file close:");
nerrors += test_dangle_dataset(H5F_CLOSE_SEMI);
nerrors += test_dangle_group(H5F_CLOSE_SEMI);
nerrors += test_dangle_datatype1(H5F_CLOSE_SEMI);
nerrors += test_dangle_datatype2(H5F_CLOSE_SEMI);
nerrors += test_dangle_attribute(H5F_CLOSE_SEMI);
/* Run tests w/strong file close */
puts("Testing dangling objects with strong file close:");
nerrors += test_dangle_dataset(H5F_CLOSE_STRONG);
nerrors += test_dangle_group(H5F_CLOSE_STRONG);
nerrors += test_dangle_datatype1(H5F_CLOSE_STRONG);
nerrors += test_dangle_datatype2(H5F_CLOSE_STRONG);
nerrors += test_dangle_attribute(H5F_CLOSE_STRONG);
/* Close open IDs "the hard way" */
nerrors += test_dangle_force();
/* Check for errors */
if (nerrors)
goto error;
puts("All dangling ID tests passed.");
return 0;
error:
puts("***** DANGLING ID TESTS FAILED *****");
return 1;
}