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
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
2883
2884
2885
2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
2930
2931
2932
2933
2934
2935
2936
2937
2938
2939
2940
2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
2951
2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
3024
3025
3026
3027
3028
3029
3030
3031
3032
3033
3034
3035
3036
3037
3038
3039
3040
3041
3042
3043
3044
3045
3046
3047
3048
3049
3050
3051
3052
3053
3054
3055
3056
3057
3058
3059
3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
3076
3077
3078
3079
3080
3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
3097
3098
3099
3100
3101
3102
3103
3104
3105
3106
3107
3108
3109
3110
3111
3112
3113
3114
3115
3116
3117
3118
3119
3120
3121
3122
3123
3124
3125
3126
3127
3128
3129
3130
3131
3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
3146
3147
3148
3149
3150
3151
3152
3153
3154
3155
3156
3157
3158
3159
3160
3161
3162
3163
3164
3165
3166
3167
3168
3169
3170
3171
3172
3173
3174
3175
3176
3177
3178
3179
3180
3181
3182
3183
3184
3185
3186
3187
3188
3189
3190
3191
3192
3193
3194
3195
3196
3197
3198
3199
3200
3201
3202
3203
3204
3205
3206
3207
3208
3209
3210
3211
3212
3213
3214
3215
3216
3217
3218
3219
3220
3221
3222
3223
3224
3225
3226
3227
3228
3229
3230
3231
3232
3233
3234
3235
3236
3237
3238
3239
3240
3241
3242
3243
3244
3245
3246
3247
3248
3249
3250
3251
3252
3253
3254
3255
3256
3257
3258
3259
3260
3261
3262
3263
3264
3265
3266
3267
3268
3269
3270
3271
3272
3273
3274
3275
3276
3277
3278
3279
3280
3281
3282
3283
3284
3285
3286
3287
3288
3289
3290
3291
3292
3293
3294
3295
3296
3297
3298
3299
3300
3301
3302
3303
3304
3305
3306
3307
3308
3309
3310
3311
3312
3313
3314
3315
3316
3317
3318
3319
3320
3321
3322
3323
3324
3325
3326
3327
3328
3329
3330
3331
3332
3333
3334
3335
3336
3337
3338
3339
3340
3341
3342
3343
3344
3345
3346
3347
3348
3349
3350
3351
3352
3353
3354
3355
3356
3357
3358
3359
3360
3361
3362
3363
3364
3365
3366
3367
3368
3369
3370
3371
3372
3373
3374
3375
3376
3377
3378
3379
3380
3381
3382
3383
3384
3385
3386
3387
3388
3389
3390
3391
3392
3393
3394
3395
3396
3397
3398
3399
3400
3401
3402
3403
3404
3405
3406
3407
3408
3409
3410
3411
3412
3413
3414
3415
3416
3417
3418
3419
3420
3421
3422
3423
3424
3425
3426
3427
3428
3429
3430
3431
3432
3433
3434
3435
3436
3437
3438
3439
3440
3441
3442
3443
3444
3445
3446
3447
3448
3449
3450
3451
3452
3453
3454
3455
3456
3457
3458
3459
3460
3461
3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
3488
3489
3490
3491
3492
3493
3494
3495
3496
3497
3498
3499
3500
3501
3502
3503
3504
3505
3506
3507
3508
3509
3510
3511
3512
3513
3514
3515
3516
3517
3518
3519
3520
3521
3522
3523
3524
3525
3526
3527
3528
3529
3530
3531
3532
3533
3534
3535
3536
3537
3538
3539
3540
3541
3542
3543
3544
3545
3546
3547
3548
3549
3550
3551
3552
3553
3554
3555
3556
3557
3558
3559
3560
3561
3562
3563
3564
3565
3566
3567
3568
3569
3570
3571
3572
3573
3574
3575
3576
3577
3578
3579
3580
3581
3582
3583
3584
3585
3586
3587
3588
3589
3590
3591
3592
3593
3594
3595
3596
3597
3598
3599
3600
3601
3602
3603
3604
3605
3606
3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
3634
3635
3636
3637
3638
3639
3640
3641
3642
3643
3644
3645
3646
3647
3648
3649
3650
3651
3652
3653
3654
3655
3656
3657
3658
3659
3660
3661
3662
3663
3664
3665
3666
3667
3668
3669
3670
3671
3672
3673
3674
3675
3676
3677
3678
3679
3680
3681
3682
3683
3684
3685
3686
3687
3688
3689
3690
3691
3692
3693
3694
3695
3696
3697
3698
3699
3700
3701
3702
3703
3704
3705
3706
3707
3708
3709
3710
3711
3712
3713
3714
3715
3716
3717
3718
3719
3720
3721
3722
3723
3724
3725
3726
3727
3728
3729
3730
3731
3732
3733
3734
3735
3736
3737
3738
3739
3740
3741
3742
3743
3744
3745
3746
3747
3748
3749
3750
3751
3752
3753
3754
3755
3756
3757
3758
3759
3760
3761
3762
3763
3764
3765
3766
3767
3768
3769
3770
3771
3772
3773
3774
3775
3776
3777
3778
3779
3780
3781
3782
3783
3784
3785
3786
3787
3788
3789
3790
3791
3792
3793
3794
3795
3796
3797
3798
3799
3800
3801
3802
3803
3804
3805
3806
3807
3808
3809
3810
3811
3812
3813
3814
3815
3816
3817
3818
3819
3820
3821
3822
3823
3824
3825
3826
3827
3828
3829
3830
3831
3832
3833
3834
3835
3836
3837
3838
3839
3840
3841
3842
3843
3844
3845
3846
3847
3848
3849
3850
3851
3852
3853
3854
3855
3856
3857
3858
3859
3860
3861
3862
3863
3864
3865
3866
3867
3868
3869
3870
3871
3872
3873
3874
3875
3876
3877
3878
3879
3880
3881
3882
3883
3884
3885
3886
3887
3888
3889
3890
3891
3892
|
/****************************************************************************
* NCSA HDF *
* Software Development Group *
* National Center for Supercomputing Applications *
* University of Illinois at Urbana-Champaign *
* 605 E. Springfield, Champaign IL 61820 *
* *
* For conditions of distribution and use, see the accompanying *
* hdf/COPYING file. *
* *
* MODIFICATIONS *
* Robb Matzke, 30 Aug 1997 *
* Added `ERRORS' fields to function prologues. *
* *
****************************************************************************/
/* $Id$ */
#define H5F_PACKAGE /*suppress error about including H5Fpkg */
/* Predefined file drivers */
#include "H5FDcore.h" /*temporary in-memory files */
#include "H5FDfamily.h" /*family of files */
#include "H5FDgass.h" /*GASS I/O */
#include "H5FDlog.h" /* sec2 driver with logging, for debugging */
#include "H5FDmpio.h" /*MPI-2 I/O */
#include "H5FDmpiposix.h" /*MPI-2 & posix I/O */
#include "H5FDmulti.h" /*multiple files partitioned by mem usage */
#include "H5FDsec2.h" /*Posix unbuffered I/O */
#include "H5FDsrb.h" /*SRB I/O */
#include "H5FDstdio.h" /* Standard C buffered I/O */
#include "H5FDstream.h" /*in-memory files streamed via sockets */
/* Packages needed by this file... */
#include "H5private.h" /*library functions */
#include "H5Aprivate.h" /*attributes */
#include "H5ACprivate.h" /*cache */
#include "H5Dprivate.h" /*datasets */
#include "H5Eprivate.h" /*error handling */
#include "H5Fpkg.h" /*file access */
#include "H5FDprivate.h" /*file driver */
#include "H5FLprivate.h" /*Free Lists */
#include "H5Iprivate.h" /*object IDs */
#include "H5Gprivate.h" /*symbol tables */
#include "H5MMprivate.h" /*core memory management */
#include "H5Pprivate.h" /*property lists */
#include "H5Tprivate.h" /*data types */
#define PABLO_MASK H5F_mask
/* Interface initialization */
static int interface_initialize_g = 0;
#define INTERFACE_INIT H5F_init_interface
static herr_t H5F_init_interface(void);
/* Struct only used by functions H5F_get_objects and H5F_get_objects_cb */
typedef struct H5F_olist_t {
H5I_type_t obj_type;
hid_t *obj_id_list;
unsigned *obj_id_count;
H5F_file_t *shared;
unsigned list_index;
} H5F_olist_t;
/* PRIVATE PROTOTYPES */
static H5F_t *H5F_new(H5F_file_t *shared, hid_t fcpl_id, hid_t fapl_id);
static herr_t H5F_dest(H5F_t *f);
static herr_t H5F_flush(H5F_t *f, H5F_scope_t scope, hbool_t invalidate,
hbool_t alloc_only, hbool_t closing);
static haddr_t H5F_locate_signature(H5FD_t *file);
static int H5F_flush_all_cb(H5F_t *f, hid_t fid, const void *_invalidate);
static herr_t H5F_get_objects(H5F_t *f, unsigned types, hid_t *obj_id_list,
unsigned *obj_id_count);
static herr_t H5F_get_objects_cb(void *obj_ptr, hid_t obj_id, void *key);
/* Declare a free list to manage the H5F_t struct */
H5FL_DEFINE_STATIC(H5F_t);
/* Declare a free list to manage the H5F_file_t struct */
H5FL_DEFINE_STATIC(H5F_file_t);
/* Declare the external free list for the H5G_t struct */
H5FL_EXTERN(H5G_t);
/* Declare the external PQ free list for the sieve buffer information */
H5FL_BLK_EXTERN(sieve_buf);
/*-------------------------------------------------------------------------
* Function: H5F_init
*
* Purpose: Initialize the interface from some other layer.
*
* Return: Success: non-negative
*
* Failure: negative
*
* Programmer: Robb Matzke
* Wednesday, December 16, 1998
*
* Modifications:
*
*-------------------------------------------------------------------------
*/
herr_t
H5F_init(void)
{
herr_t ret_value=SUCCEED; /* Return value */
FUNC_ENTER_NOAPI(H5F_init, FAIL);
/* FUNC_ENTER() does all the work */
done:
FUNC_LEAVE(ret_value);
}
/*-------------------------------------------------------------------------
* Function: H5F_init_interface
*
* Purpose: Initialize interface-specific information.
*
* Return: Success: non-negative
*
* Failure: negative
*
* Programmer: Robb Matzke
* Friday, November 20, 1998
*
* Modifications:
* Robb Matzke, 4 Aug 1997
* Changed pablo mask from H5_mask to H5F_mask for the FUNC_LEAVE call.
* It was already H5F_mask for the PABLO_TRACE_ON call.
*
* Kim Yates, 1998-08-16
* Added .disp, .btype, .ftype to H5F_access_t.
*
* Robb Matzke, 1999-02-19
* Added initialization for the H5I_FILE_CLOSING ID group.
*
* Raymond Lu, April 10, 2000
* Put SRB into the 'Register predefined file drivers' list.
*
* Thomas Radke, 2000-09-12
* Put Stream VFD into the 'Register predefined file drivers' list.
*
* Raymond Lu, 2001-10-14
* Change File creation property list to generic property list mechanism.
*-------------------------------------------------------------------------
*/
static herr_t
H5F_init_interface(void)
{
size_t nprops; /* Number of properties */
herr_t ret_value = SUCCEED;
herr_t status;
/* File creation property class variables. In sequence, they are
* - File create property list class to modify
* - Default value for size of file user block
* - Default value for 1/2 rank for symbol table leaf nodes
* - Default value for 1/2 rank for btree internal nodes
* - Default value for byte number in an address
* - Default value for byte number for object size
* - Default value for version number of bootblock
* - Default value for free-space version number
* - Default value for object directory version number
* - Default value for share-header format version
*/
H5P_genclass_t *crt_pclass;
hsize_t userblock_size = H5F_CRT_USER_BLOCK_DEF;
unsigned sym_leaf_k = H5F_CRT_SYM_LEAF_DEF;
int btree_k[H5B_NUM_BTREE_ID] = H5F_CRT_BTREE_RANK_DEF;
size_t sizeof_addr = H5F_CRT_ADDR_BYTE_NUM_DEF;
size_t sizeof_size = H5F_CRT_OBJ_BYTE_NUM_DEF;
int bootblock_ver = H5F_CRT_BOOT_VERS_DEF;
int freespace_ver = H5F_CRT_FREESPACE_VERS_DEF;
int objectdir_ver = H5F_CRT_OBJ_DIR_VERS_DEF;
int sharedheader_ver = H5F_CRT_SHARE_HEAD_VERS_DEF;
/* File access property class variables. In sequence, they are
* - File access property class to modify
* - Size of meta data cache(elements)
* - Size of raw data chunk cache(elements)
* - Size of raw data chunk cache(bytes)
* - Preemption for reading chunks
* - Threshold for alignment
* - Alignment
* - Minimum metadata allocation block size
* - Maximum sieve buffer size
* - Garbage-collect reference
* - File driver ID
* - File driver info
*/
H5P_genclass_t *acs_pclass;
int mdc_nelmts = H5F_ACS_META_CACHE_SIZE_DEF;
size_t rdcc_nelmts = H5F_ACS_DATA_CACHE_ELMT_SIZE_DEF;
size_t rdcc_nbytes = H5F_ACS_DATA_CACHE_BYTE_SIZE_DEF;
double rdcc_w0 = H5F_ACS_PREEMPT_READ_CHUNKS_DEF;
hsize_t threshold = H5F_ACS_ALIGN_THRHD_DEF;
hsize_t alignment = H5F_ACS_ALIGN_DEF;
hsize_t meta_block_size = H5F_ACS_META_BLOCK_SIZE_DEF;
size_t sieve_buf_size = H5F_ACS_SIEVE_BUF_SIZE_DEF;
hsize_t sdata_block_size = H5F_ACS_SDATA_BLOCK_SIZE_DEF;
unsigned gc_ref = H5F_ACS_GARBG_COLCT_REF_DEF;
hid_t driver_id = H5F_ACS_FILE_DRV_ID_DEF;
void *driver_info = H5F_ACS_FILE_DRV_INFO_DEF;
H5F_close_degree_t close_degree = H5F_CLOSE_DEGREE_DEF;
hsize_t family_offset = H5F_ACS_FAMILY_OFFSET_DEF;
H5FD_mem_t mem_type = H5F_ACS_MULTI_TYPE_DEF;
/* File mount property class variable.
* - Mount property class to modify
* - whether absolute symlinks is local to file
*/
H5P_genclass_t *mnt_pclass;
hbool_t local = H5F_MNT_SYM_LOCAL_DEF;
FUNC_ENTER_NOINIT(H5F_init_interface);
#ifdef H5_HAVE_PARALLEL
{
/* Allow MPI buf-and-file-type optimizations? */
const char *s = HDgetenv ("HDF5_MPI_1_METAWRITE");
if (s && HDisdigit(*s)) {
H5_mpiposix_1_metawrite_g = H5_mpi_1_metawrite_g = (int)HDstrtol (s, NULL, 0);
}
}
#endif /* H5_HAVE_PARALLEL */
/*
* Initialize the atom group for the file IDs. There are two groups:
* the H5I_FILE group contains all the ID's for files which are currently
* open at the public API level while the H5I_FILE_CLOSING group contains
* ID's for files for which the application has called H5Fclose() but
* which are pending completion because there are object headers still
* open within the file.
*/
if (H5I_init_group(H5I_FILE, H5I_FILEID_HASHSIZE, 0, (H5I_free_t)H5F_close)<0 ||
H5I_init_group(H5I_FILE_CLOSING, H5I_FILEID_HASHSIZE, 0, (H5I_free_t)H5F_close)<0)
HGOTO_ERROR (H5E_FILE, H5E_CANTINIT, FAIL, "unable to initialize interface");
/* ========== File Creation Property Class Initialization ============*/
assert(H5P_CLS_FILE_CREATE_g!=-1);
/* Get the pointer to file creation class */
if(NULL == (crt_pclass = H5I_object_verify(H5P_CLS_FILE_CREATE_g, H5I_GENPROP_CLS)))
HGOTO_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL, "not a property list class");
/* Get the number of properties in the class */
if(H5P_get_nprops_pclass(crt_pclass,&nprops)<0)
HGOTO_ERROR(H5E_ARGS, H5E_BADVALUE, FAIL, "can't query number of properties");
/* Assume that if there are properties in the class, they are the default ones */
if(nprops==0) {
/* Register the user block size */
if(H5P_register(crt_pclass,H5F_CRT_USER_BLOCK_NAME,H5F_CRT_USER_BLOCK_SIZE, &userblock_size,NULL,NULL,NULL,NULL,NULL,NULL)<0)
HGOTO_ERROR(H5E_PLIST, H5E_CANTINSERT, FAIL, "can't insert property into class");
/* Register the 1/2 rank for symbol table leaf nodes */
if(H5P_register(crt_pclass,H5F_CRT_SYM_LEAF_NAME,H5F_CRT_SYM_LEAF_SIZE, &sym_leaf_k,NULL,NULL,NULL,NULL,NULL,NULL)<0)
HGOTO_ERROR(H5E_PLIST, H5E_CANTINSERT, FAIL, "can't insert property into class");
/* Register the 1/2 rank for btree internal nodes */
if(H5P_register(crt_pclass,H5F_CRT_BTREE_RANK_NAME,H5F_CRT_BTREE_RANK_SIZE, btree_k,NULL,NULL,NULL,NULL,NULL,NULL)<0)
HGOTO_ERROR(H5E_PLIST, H5E_CANTINSERT, FAIL, "can't insert property into class");
/* Register the byte number for an address */
if(H5P_register(crt_pclass,H5F_CRT_ADDR_BYTE_NUM_NAME, H5F_CRT_ADDR_BYTE_NUM_SIZE, &sizeof_addr,NULL,NULL,NULL,NULL,NULL, NULL)<0)
HGOTO_ERROR(H5E_PLIST, H5E_CANTINSERT, FAIL, "can't insert property into class");
/* Register the byte number for object size */
if(H5P_register(crt_pclass,H5F_CRT_OBJ_BYTE_NUM_NAME, H5F_CRT_OBJ_BYTE_NUM_SIZE,&sizeof_size,NULL,NULL,NULL,NULL,NULL, NULL)<0)
HGOTO_ERROR(H5E_PLIST, H5E_CANTINSERT, FAIL, "can't insert property into class");
/* Register the bootblock version number */
if(H5P_register(crt_pclass,H5F_CRT_BOOT_VERS_NAME,H5F_CRT_BOOT_VERS_SIZE, &bootblock_ver,NULL,NULL,NULL,NULL,NULL,NULL)<0)
HGOTO_ERROR(H5E_PLIST, H5E_CANTINSERT, FAIL, "can't insert property into class");
/* Register the free-space version number */
if(H5P_register(crt_pclass,H5F_CRT_FREESPACE_VERS_NAME, H5F_CRT_FREESPACE_VERS_SIZE,&freespace_ver,NULL,NULL,NULL,NULL,NULL, NULL)<0)
HGOTO_ERROR(H5E_PLIST, H5E_CANTINSERT, FAIL, "can't insert property into class");
/* Register the object directory version number */
if(H5P_register(crt_pclass,H5F_CRT_OBJ_DIR_VERS_NAME, H5F_CRT_OBJ_DIR_VERS_SIZE,&objectdir_ver,NULL,NULL,NULL,NULL,NULL, NULL)<0)
HGOTO_ERROR(H5E_PLIST, H5E_CANTINSERT, FAIL, "can't insert property into class");
/* Register the shared-header version number */
if(H5P_register(crt_pclass,H5F_CRT_SHARE_HEAD_VERS_NAME, H5F_CRT_SHARE_HEAD_VERS_SIZE, &sharedheader_ver,NULL,NULL,NULL,NULL, NULL,NULL)<0)
HGOTO_ERROR(H5E_PLIST, H5E_CANTINSERT, FAIL, "can't insert property into class");
} /* end if */
/* Only register the default property list if it hasn't been created yet */
if(H5P_LST_FILE_CREATE_g==(-1)) {
/* Register the default file creation property list */
if((H5P_LST_FILE_CREATE_g = H5P_create_id(crt_pclass))<0)
HGOTO_ERROR(H5E_PLIST, H5E_CANTREGISTER, FAIL, "can't insert property into class");
} /* end if */
/* Register predefined file drivers */
H5E_BEGIN_TRY {
if ((status=H5FD_SEC2)<0) goto end_registration;
if ((status=H5FD_STDIO)<0) goto end_registration;
if ((status=H5FD_FAMILY)<0) goto end_registration;
#ifdef H5_HAVE_GASS
if ((status=H5FD_GASS)<0) goto end_registration;
#endif
#ifdef H5_HAVE_SRB
if ((status=H5FD_SRB)<0) goto end_registration;
#endif
if ((status=H5FD_CORE)<0) goto end_registration;
if ((status=H5FD_MULTI)<0) goto end_registration;
#ifdef H5_HAVE_PARALLEL
if ((status=H5FD_MPIO)<0) goto end_registration;
if ((status=H5FD_MPIPOSIX)<0) goto end_registration;
#endif /* H5_HAVE_PARALLEL */
#ifdef H5_HAVE_STREAM
if ((status=H5FD_STREAM)<0) goto end_registration;
#endif
end_registration: ;
} H5E_END_TRY;
if (status<0)
HGOTO_ERROR(H5E_FILE, H5E_CANTINIT, FAIL, "file driver registration failed");
/* ========== File Access Property Class Initialization ============*/
assert(H5P_CLS_FILE_ACCESS_g!=-1);
/* Get the pointer to file creation class */
if(NULL == (acs_pclass = H5I_object_verify(H5P_CLS_FILE_ACCESS_g, H5I_GENPROP_CLS)))
HGOTO_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL, "not a property list class");
/* Get the number of properties in the class */
if(H5P_get_nprops_pclass(acs_pclass,&nprops)<0)
HGOTO_ERROR(H5E_ARGS, H5E_BADVALUE, FAIL, "can't query number of properties");
/* Assume that if there are properties in the class, they are the default ones */
if(nprops==0) {
/* Register the size of meta data cache(elements) */
if(H5P_register(acs_pclass,H5F_ACS_META_CACHE_SIZE_NAME,H5F_ACS_META_CACHE_SIZE_SIZE, &mdc_nelmts,NULL,NULL,NULL,NULL,NULL,NULL)<0)
HGOTO_ERROR(H5E_PLIST, H5E_CANTINSERT, FAIL, "can't insert property into class");
/* Register the size of raw data chunk cache (elements) */
if(H5P_register(acs_pclass,H5F_ACS_DATA_CACHE_ELMT_SIZE_NAME,H5F_ACS_DATA_CACHE_ELMT_SIZE_SIZE, &rdcc_nelmts,NULL,NULL,NULL,NULL,NULL,NULL)<0)
HGOTO_ERROR(H5E_PLIST, H5E_CANTINSERT, FAIL, "can't insert property into class");
/* Register the size of raw data chunk cache(bytes) */
if(H5P_register(acs_pclass,H5F_ACS_DATA_CACHE_BYTE_SIZE_NAME,H5F_ACS_DATA_CACHE_BYTE_SIZE_SIZE, &rdcc_nbytes,NULL,NULL,NULL,NULL,NULL,NULL)<0)
HGOTO_ERROR(H5E_PLIST, H5E_CANTINSERT, FAIL, "can't insert property into class");
/* Register the preemption for reading chunks */
if(H5P_register(acs_pclass,H5F_ACS_PREEMPT_READ_CHUNKS_NAME,H5F_ACS_PREEMPT_READ_CHUNKS_SIZE, &rdcc_w0,NULL,NULL,NULL,NULL,NULL,NULL)<0)
HGOTO_ERROR(H5E_PLIST, H5E_CANTINSERT, FAIL, "can't insert property into class");
/* Register the threshold for alignment */
if(H5P_register(acs_pclass,H5F_ACS_ALIGN_THRHD_NAME,H5F_ACS_ALIGN_THRHD_SIZE, &threshold,NULL,NULL,NULL,NULL,NULL,NULL)<0)
HGOTO_ERROR(H5E_PLIST, H5E_CANTINSERT, FAIL, "can't insert property into class");
/* Register the alignment */
if(H5P_register(acs_pclass,H5F_ACS_ALIGN_NAME,H5F_ACS_ALIGN_SIZE, &alignment,NULL,NULL,NULL,NULL,NULL,NULL)<0)
HGOTO_ERROR(H5E_PLIST, H5E_CANTINSERT, FAIL, "can't insert property into class");
/* Register the minimum metadata allocation block size */
if(H5P_register(acs_pclass,H5F_ACS_META_BLOCK_SIZE_NAME,H5F_ACS_META_BLOCK_SIZE_SIZE, &meta_block_size,NULL,NULL,NULL,NULL,NULL,NULL)<0)
HGOTO_ERROR(H5E_PLIST, H5E_CANTINSERT, FAIL, "can't insert property into class");
/* Register the maximum sieve buffer size */
if(H5P_register(acs_pclass,H5F_ACS_SIEVE_BUF_SIZE_NAME,H5F_ACS_SIEVE_BUF_SIZE_SIZE, &sieve_buf_size,NULL,NULL,NULL,NULL,NULL,NULL)<0)
HGOTO_ERROR(H5E_PLIST, H5E_CANTINSERT, FAIL, "can't insert property into class");
/* Register the minimum "small data" allocation block size */
if(H5P_register(acs_pclass,H5F_ACS_SDATA_BLOCK_SIZE_NAME,H5F_ACS_SDATA_BLOCK_SIZE_SIZE, &sdata_block_size,NULL,NULL,NULL,NULL,NULL,NULL)<0)
HGOTO_ERROR(H5E_PLIST, H5E_CANTINSERT, FAIL, "can't insert property into class");
/* Register the garbage collection reference */
if(H5P_register(acs_pclass,H5F_ACS_GARBG_COLCT_REF_NAME,H5F_ACS_GARBG_COLCT_REF_SIZE, &gc_ref,NULL,NULL,NULL,NULL,NULL,NULL)<0)
HGOTO_ERROR(H5E_PLIST, H5E_CANTINSERT, FAIL, "can't insert property into class");
/* Register the file driver ID */
if(H5P_register(acs_pclass,H5F_ACS_FILE_DRV_ID_NAME,H5F_ACS_FILE_DRV_ID_SIZE, &driver_id,NULL,NULL,NULL,NULL,NULL,NULL)<0)
HGOTO_ERROR(H5E_PLIST, H5E_CANTINSERT, FAIL, "can't insert property into class");
/* Register the file driver info */
if(H5P_register(acs_pclass,H5F_ACS_FILE_DRV_INFO_NAME,H5F_ACS_FILE_DRV_INFO_SIZE, &driver_info,NULL,NULL,NULL,NULL,NULL,NULL)<0)
HGOTO_ERROR(H5E_PLIST, H5E_CANTINSERT, FAIL, "can't insert property into class");
/* Register the file close degree */
if(H5P_register(acs_pclass,H5F_CLOSE_DEGREE_NAME,H5F_CLOSE_DEGREE_SIZE, &close_degree,NULL,NULL,NULL,NULL,NULL,NULL)<0)
HGOTO_ERROR(H5E_PLIST, H5E_CANTINSERT, FAIL, "can't insert property into class");
/* Register the offset of family driver info */
if(H5P_register(acs_pclass,H5F_ACS_FAMILY_OFFSET_NAME,H5F_ACS_FAMILY_OFFSET_SIZE, &family_offset,NULL,NULL,NULL,NULL,NULL,NULL)<0)
HGOTO_ERROR(H5E_PLIST, H5E_CANTINSERT, FAIL, "can't insert property into class");
/* Register the data type of multi driver info */
if(H5P_register(acs_pclass,H5F_ACS_MULTI_TYPE_NAME,H5F_ACS_MULTI_TYPE_SIZE, &mem_type,NULL,NULL,NULL,NULL,NULL,NULL)<0)
HGOTO_ERROR(H5E_PLIST, H5E_CANTINSERT, FAIL, "can't insert property into class");
} /* end if */
/* Only register the default property list if it hasn't been created yet */
if(H5P_LST_FILE_ACCESS_g==(-1)) {
/* Register the default file access property list */
if((H5P_LST_FILE_ACCESS_g = H5P_create_id(acs_pclass))<0)
HGOTO_ERROR(H5E_PLIST, H5E_CANTREGISTER, FAIL, "can't insert property into class");
} /* end if */
/* ================ Mount Porperty Class Initialization ==============*/
assert(H5P_CLS_MOUNT_g!=-1);
/* Get the pointer to file mount class */
if(NULL == (mnt_pclass = H5I_object_verify(H5P_CLS_MOUNT_g, H5I_GENPROP_CLS)))
HGOTO_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL, "not a property list class");
/* Get the number of properties in the class */
if(H5P_get_nprops_pclass(mnt_pclass,&nprops)<0)
HGOTO_ERROR(H5E_ARGS, H5E_BADVALUE, FAIL, "can't query number of properties");
/* Assume that if there are properties in the class, they are the default ones */
if(nprops==0) {
/* Register property of whether symlinks is local to file */
if(H5P_register(mnt_pclass,H5F_MNT_SYM_LOCAL_NAME,H5F_MNT_SYM_LOCAL_SIZE, &local,NULL,NULL,NULL,NULL,NULL,NULL)<0)
HGOTO_ERROR(H5E_PLIST, H5E_CANTINSERT, FAIL, "can't insert property into class");
} /* end if */
/* Only register the default property list if it hasn't been created yet */
if(H5P_LST_MOUNT_g==(-1)) {
/* Register the default file mount property list */
if((H5P_LST_MOUNT_g = H5P_create_id(mnt_pclass))<0)
HGOTO_ERROR(H5E_PLIST, H5E_CANTREGISTER, FAIL, "can't insert property into class");
} /* end if */
done:
FUNC_LEAVE(ret_value);
}
/*-------------------------------------------------------------------------
* Function: H5F_term_interface
*
* Purpose: Terminate this interface: free all memory and reset global
* variables to their initial values. Release all ID groups
* associated with this interface.
*
* Return: Success: Positive if anything was done that might
* have affected other interfaces; zero
* otherwise.
*
* Failure: Never fails.
*
* Programmer: Robb Matzke
* Friday, February 19, 1999
*
* Modifications:
*
*-------------------------------------------------------------------------
*/
int
H5F_term_interface(void)
{
int n = 0;
FUNC_ENTER_NOINIT(H5F_term_interface);
if (interface_initialize_g) {
if ((n=H5I_nmembers(H5I_FILE))) {
H5F_close_all();
} else if (0==(n=H5I_nmembers(H5I_FILE_CLOSING))) {
H5I_destroy_group(H5I_FILE);
H5I_destroy_group(H5I_FILE_CLOSING);
interface_initialize_g = 0;
n = 1; /*H5I*/
}
}
FUNC_LEAVE(n);
}
/*----------------------------------------------------------------------------
* Function: H5F_acs_create
*
* Purpose: Callback routine which is called whenever a file access
* property list is closed. This routine performs any generic
* initialization needed on the properties the library put into
* the list.
*
* Return: Success: Non-negative
* Failure: Negative
*
* Programmer: Raymond Lu
* Tuesday, Oct 23, 2001
*
* Modifications:
*
*----------------------------------------------------------------------------
*/
herr_t
H5F_acs_create(hid_t fapl_id, void UNUSED *copy_data)
{
hid_t driver_id;
void* driver_info;
H5P_genplist_t *plist; /* Property list */
herr_t ret_value = SUCCEED;
FUNC_ENTER_NOAPI(H5F_acs_create, FAIL);
/* Check argument */
if(NULL == (plist = H5P_object_verify(fapl_id,H5P_FILE_ACCESS)))
HGOTO_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL, "not a property list");
/* Retrieve properties */
if(H5P_get(plist, H5F_ACS_FILE_DRV_ID_NAME, &driver_id) < 0)
HGOTO_ERROR(H5E_PLIST, H5E_CANTGET, FAIL, "can't get drver ID");
if(H5P_get(plist, H5F_ACS_FILE_DRV_INFO_NAME, &driver_info) < 0)
HGOTO_ERROR(H5E_PLIST, H5E_CANTGET, FAIL, "can't get drver info");
if(driver_id > 0) {
/* Increment the reference count on driver and copy driver info */
H5I_inc_ref(driver_id);
driver_info = H5FD_fapl_copy(driver_id, driver_info);
/* Set the driver properties for the list */
if(H5P_set(plist, H5F_ACS_FILE_DRV_ID_NAME, &driver_id) < 0)
HGOTO_ERROR(H5E_PLIST, H5E_CANTSET, FAIL, "can't set drver ID");
if(H5P_set(plist, H5F_ACS_FILE_DRV_INFO_NAME, &driver_info) < 0)
HGOTO_ERROR(H5E_PLIST, H5E_CANTSET, FAIL, "can't set drver info");
} /* end if */
done:
FUNC_LEAVE(ret_value);
}
/*--------------------------------------------------------------------------
* Function: H5F_acs_close
*
* Purpose: Callback routine which is called whenever a file access
* property list is closed. This routine performs any generic
* cleanup needed on the properties.
*
* Return: Success: Non-negative
*
* Failure: Negative
*
* Programmer: Raymond Lu
* Tuesday, Oct 23, 2001
*
* Modifications:
*
*---------------------------------------------------------------------------
*/
herr_t
H5F_acs_close(hid_t fapl_id, void UNUSED *close_data)
{
hid_t driver_id;
void *driver_info;
H5P_genplist_t *plist; /* Property list */
herr_t ret_value = SUCCEED;
FUNC_ENTER_NOAPI(H5F_acs_close, FAIL);
/* Check argument */
if(NULL == (plist = H5P_object_verify(fapl_id,H5P_FILE_ACCESS)))
HGOTO_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL, "not a property list");
if(H5P_get(plist, H5F_ACS_FILE_DRV_ID_NAME, &driver_id) < 0)
HGOTO_DONE(FAIL); /* Can't return errors when library is shutting down */
if(H5P_get(plist, H5F_ACS_FILE_DRV_INFO_NAME, &driver_info) < 0)
HGOTO_DONE(FAIL); /* Can't return errors when library is shutting down */
if(driver_id > 0) {
/* Free memory for driver info and decrement reference count for driver */
H5FD_fapl_free(driver_id, driver_info);
H5I_dec_ref(driver_id);
driver_info = NULL;
driver_id = -1;
if(H5P_set(plist, H5F_ACS_FILE_DRV_ID_NAME, &driver_id) < 0)
HGOTO_DONE(FAIL); /* Can't return errors when library is shutting down */
if(H5P_set(plist, H5F_ACS_FILE_DRV_INFO_NAME, &driver_info) < 0)
HGOTO_DONE(FAIL); /* Can't return errors when library is shutting down */
}
done:
FUNC_LEAVE(ret_value);
}
/*--------------------------------------------------------------------------
* Function: H5F_acs_copy
*
* Purpose: Callback routine which is called whenever a file access
* property list is copied. This routine performs any generic
* copy needed on the properties.
*
* Return: Success: Non-negative
* Failure: Negative
* Programmer: Raymond Lu
* Tuesday, Oct 23, 2001
*
* Modifications:
*
*--------------------------------------------------------------------------
*/
herr_t
H5F_acs_copy(hid_t new_fapl_id, hid_t old_fapl_id, void UNUSED *copy_data)
{
hid_t driver_id;
void* driver_info;
H5P_genplist_t *new_plist; /* New property list */
H5P_genplist_t *old_plist; /* Old property list */
herr_t ret_value = SUCCEED;
FUNC_ENTER_NOAPI(H5F_acs_copy, FAIL);
if(NULL == (new_plist = H5I_object_verify(new_fapl_id, H5I_GENPROP_LST)))
HGOTO_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL, "can't get property list");
if(NULL == (old_plist = H5I_object_verify(old_fapl_id, H5I_GENPROP_LST)))
HGOTO_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL, "can't get property list");
/* Get values from old property list */
if(H5P_get(old_plist, H5F_ACS_FILE_DRV_ID_NAME, &driver_id) < 0)
HGOTO_ERROR(H5E_PLIST, H5E_CANTGET, FAIL, "can't get drver ID");
if(H5P_get(old_plist, H5F_ACS_FILE_DRV_INFO_NAME, &driver_info) < 0)
HGOTO_ERROR(H5E_PLIST, H5E_CANTGET, FAIL, "can't get drver info");
if(driver_id > 0) {
H5I_inc_ref(driver_id);
driver_info = H5FD_fapl_copy(driver_id, driver_info);
if(H5P_set(new_plist, H5F_ACS_FILE_DRV_ID_NAME, &driver_id) < 0)
HGOTO_ERROR(H5E_PLIST, H5E_CANTSET, FAIL, "can't set drver ID");
if(H5P_set(new_plist, H5F_ACS_FILE_DRV_INFO_NAME, &driver_info) < 0)
HGOTO_ERROR(H5E_PLIST, H5E_CANTSET, FAIL, "can't set drver info");
} /* end if */
done:
FUNC_LEAVE(ret_value);
}
/*-------------------------------------------------------------------------
* Function: H5F_flush_all_cb
*
* Purpose: Callback function for H5F_flush_all().
*
* Return: Always returns zero.
*
* Programmer: Robb Matzke
* Friday, February 19, 1999
*
* Modifications:
*
*-------------------------------------------------------------------------
*/
static int
H5F_flush_all_cb(H5F_t *f, hid_t UNUSED fid, const void *_invalidate)
{
hbool_t invalidate = *((const hbool_t*)_invalidate);
FUNC_ENTER_NOINIT(H5F_flush_all_cb);
H5F_flush(f, H5F_SCOPE_LOCAL, invalidate, FALSE, FALSE);
FUNC_LEAVE(0);
}
/*-------------------------------------------------------------------------
* Function: H5F_flush_all
*
* Purpose: Flush all open files. If INVALIDATE is true then also remove
* everything from the cache.
*
* Return: Success: Non-negative
*
* Failure: Negative
*
* Programmer: Robb Matzke
* Thursday, February 18, 1999
*
* Modifications:
*
*-------------------------------------------------------------------------
*/
herr_t
H5F_flush_all(hbool_t invalidate)
{
herr_t ret_value=SUCCEED; /* Return value */
FUNC_ENTER_NOAPI(H5F_flush_all, FAIL);
H5I_search(H5I_FILE,(H5I_search_func_t)H5F_flush_all_cb,(void*)&invalidate);
done:
FUNC_LEAVE(ret_value);
}
/*-------------------------------------------------------------------------
* Function: H5F_close_all
*
* Purpose: Close all open files. Any file which has open object headers
* will be moved from the H5I_FILE group to the H5I_FILE_CLOSING
* group.
*
* Return: Success: Non-negative
*
* Failure: Negative
*
* Programmer: Robb Matzke
* Friday, February 19, 1999
*
* Modifications:
*
*-------------------------------------------------------------------------
*/
herr_t
H5F_close_all(void)
{
herr_t ret_value=SUCCEED; /* Return value */
FUNC_ENTER_NOAPI(H5F_close_all, FAIL);
if (H5I_clear_group(H5I_FILE, FALSE)<0)
HGOTO_ERROR(H5E_FILE, H5E_CLOSEERROR, FAIL, "unable to close one or more files");
done:
FUNC_LEAVE(ret_value);
}
/*--------------------------------------------------------------------------
NAME
H5F_encode_length_unusual -- encode an unusual length size
USAGE
void H5F_encode_length_unusual(f, p, l)
const H5F_t *f; IN: pointer to the file record
uint8_t **p; IN: pointer to buffer pointer to encode length in
uint8_t *l; IN: pointer to length to encode
ERRORS
RETURNS
none
DESCRIPTION
Encode non-standard (i.e. not 2, 4 or 8-byte) lengths in file meta-data.
--------------------------------------------------------------------------*/
void
H5F_encode_length_unusual(const H5F_t *f, uint8_t **p, uint8_t *l)
{
int i = (int)H5F_SIZEOF_SIZE(f)-1;
#ifdef WORDS_BIGENDIAN
/*
* For non-little-endian platforms, encode each byte in memory backwards.
*/
for (/*void*/; i>=0; i--, (*p)++)*(*p) = *(l+i);
#else
/* platform has little-endian integers */
HDmemcpy(*p,l,(size_t)(i+1));
*p+=(i+1);
#endif
}
/*-------------------------------------------------------------------------
* Function: H5Fget_create_plist
*
* Purpose: Get an atom for a copy of the file-creation property list for
* this file. This function returns an atom with a copy of the
* properties used to create a file.
*
* Return: Success: template ID
*
* Failure: FAIL
*
* Programmer: Unknown
*
* Modifications:
*
* Robb Matzke, 18 Feb 1998
* Calls H5P_copy_plist() to copy the property list and H5P_close() to free
* that property list if an error occurs.
*
* Raymond Lu, Oct 14, 2001
* Changed to generic property list.
*
*-------------------------------------------------------------------------
*/
hid_t
H5Fget_create_plist(hid_t file_id)
{
H5F_t *file = NULL;
H5P_genplist_t *plist; /* Property list */
hid_t ret_value;
FUNC_ENTER_API(H5Fget_create_plist, FAIL);
H5TRACE1("i","i",file_id);
/* check args */
if (NULL==(file=H5I_object_verify(file_id, H5I_FILE)))
HGOTO_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL, "not a file");
if(NULL == (plist = H5I_object(file->shared->fcpl_id)))
HGOTO_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL, "not a property list");
/* Create the property list object to return */
if((ret_value=H5P_copy_plist(plist)) < 0)
HGOTO_ERROR(H5E_INTERNAL, H5E_CANTINIT, FAIL, "unable to copy file creation properties");
done:
FUNC_LEAVE(ret_value);
}
/*-------------------------------------------------------------------------
* Function: H5Fget_access_plist
*
* Purpose: Returns a copy of the file access property list of the
* specified file.
*
* Return: Success: Object ID for a copy of the file access
* property list.
*
* Failure: FAIL
*
* Programmer: Robb Matzke
* Wednesday, February 18, 1998
*
* Modifications:
* Raymond Lu, Oct 23, 2001
* Changed file access property list to the new generic
* property list.
*
*-------------------------------------------------------------------------
*/
hid_t
H5Fget_access_plist(hid_t file_id)
{
H5F_t *f = NULL;
H5P_genplist_t *new_plist; /* New property list */
H5P_genplist_t *old_plist; /* Old property list */
hid_t ret_value = SUCCEED;
void *driver_info=NULL;
FUNC_ENTER_API(H5Fget_access_plist, FAIL);
H5TRACE1("i","i",file_id);
/* Check args */
if (NULL==(f=H5I_object_verify(file_id, H5I_FILE)))
HGOTO_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL, "not a file");
/* Make a copy of the default file access property list */
if(NULL == (old_plist = H5I_object(H5P_LST_FILE_ACCESS_g)))
HGOTO_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL, "not a property list");
if((ret_value=H5P_copy_plist(old_plist)) < 0)
HGOTO_ERROR(H5E_INTERNAL, H5E_CANTINIT, FAIL, "can't copy file access property list");
if(NULL == (new_plist = H5I_object(ret_value)))
HGOTO_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL, "not a property list");
/* Copy properties of the file access property list */
if(H5P_set(new_plist, H5F_ACS_META_CACHE_SIZE_NAME, &(f->shared->mdc_nelmts)) < 0)
HGOTO_ERROR(H5E_PLIST, H5E_CANTSET, FAIL, "can't set meta data cache size");
if(H5P_set(new_plist, H5F_ACS_DATA_CACHE_ELMT_SIZE_NAME, &(f->shared->rdcc_nelmts)) < 0)
HGOTO_ERROR(H5E_PLIST, H5E_CANTSET, FAIL, "can't set data cache element size");
if(H5P_set(new_plist, H5F_ACS_DATA_CACHE_BYTE_SIZE_NAME, &(f->shared->rdcc_nbytes)) < 0)
HGOTO_ERROR(H5E_PLIST, H5E_CANTSET, FAIL, "can't set data cache byte size");
if(H5P_set(new_plist, H5F_ACS_PREEMPT_READ_CHUNKS_NAME, &(f->shared->rdcc_w0)) < 0)
HGOTO_ERROR(H5E_PLIST, H5E_CANTSET, FAIL, "can't set preempt read chunks");
if(H5P_set(new_plist, H5F_ACS_ALIGN_THRHD_NAME, &(f->shared->threshold)) < 0)
HGOTO_ERROR(H5E_PLIST, H5E_CANTSET, FAIL, "can't set alignment threshold");
if(H5P_set(new_plist, H5F_ACS_ALIGN_NAME, &(f->shared->alignment)) < 0)
HGOTO_ERROR(H5E_PLIST, H5E_CANTSET, FAIL, "can't set alignment");
if(H5P_set(new_plist, H5F_ACS_GARBG_COLCT_REF_NAME, &(f->shared->gc_ref)) < 0)
HGOTO_ERROR(H5E_PLIST, H5E_CANTSET, FAIL, "can't set garbage collect reference");
if(H5P_set(new_plist, H5F_ACS_META_BLOCK_SIZE_NAME, &(f->shared->lf->def_meta_block_size)) < 0)
HGOTO_ERROR(H5E_PLIST, H5E_CANTSET, FAIL, "can't set meta data cache size");
if(H5P_set(new_plist, H5F_ACS_SIEVE_BUF_SIZE_NAME, &(f->shared->sieve_buf_size)) < 0)
HGOTO_ERROR(H5E_PLIST, H5E_CANTSET, FAIL, "can't sieve buffer size");
if(H5P_set(new_plist, H5F_ACS_SDATA_BLOCK_SIZE_NAME, &(f->shared->lf->def_sdata_block_size)) < 0)
HGOTO_ERROR(H5E_PLIST, H5E_CANTSET, FAIL, "can't set 'small data' cache size");
if(H5P_set(new_plist, H5F_ACS_FILE_DRV_ID_NAME, &(f->shared->lf->driver_id)) < 0)
HGOTO_ERROR(H5E_PLIST, H5E_CANTSET, FAIL, "can't set file driver ID");
driver_info = H5FD_fapl_get(f->shared->lf);
if(driver_info != NULL && H5P_set(new_plist, H5F_ACS_FILE_DRV_INFO_NAME, driver_info) < 0)
HGOTO_ERROR(H5E_PLIST, H5E_CANTSET, FAIL, "can't set file driver info");
if(f->shared->fc_degree == H5F_CLOSE_DEFAULT && H5P_set(new_plist, H5F_CLOSE_DEGREE_NAME, &(f->shared->lf->cls->fc_degree)) < 0) {
HGOTO_ERROR(H5E_PLIST, H5E_CANTSET, FAIL, "can't set file close degree");
} else if(f->shared->fc_degree != H5F_CLOSE_DEFAULT && H5P_set(new_plist, H5F_CLOSE_DEGREE_NAME, &(f->shared->fc_degree)) < 0) {
HGOTO_ERROR(H5E_PLIST, H5E_CANTSET, FAIL, "can't set file close degree");
}
done:
FUNC_LEAVE(ret_value);
}
/*-------------------------------------------------------------------------
* Function: H5Fget_obj_count
*
* Purpose: Public function returning the number of opened object IDs
* (files, datasets, groups and datatypes) in the same file.
*
* Return: Non-negative on success; negative on failure.
*
* Programmer: Raymond Lu
* Wednesday, Dec 5, 2001
*
* Modification:
*
*-------------------------------------------------------------------------
*/
herr_t
H5Fget_obj_count(hid_t file_id, unsigned types, unsigned *obj_id_count)
{
H5F_t *f=NULL;
herr_t ret_value;
FUNC_ENTER_API(H5Fget_obj_counts, FAIL);
H5TRACE3("e","iIu*Iu",file_id,types,obj_id_count);
if( file_id != H5F_OBJ_ALL && (NULL==(f=H5I_object_verify(file_id,H5I_FILE))) )
HGOTO_ERROR(H5E_ARGS, H5E_BADVALUE, FAIL, "not a file id");
if( (types&H5F_OBJ_ALL)==0)
HGOTO_ERROR(H5E_ARGS, H5E_BADVALUE, FAIL, "not an object type");
assert(obj_id_count);
ret_value = H5F_get_obj_count(f, types, obj_id_count);
done:
FUNC_LEAVE(ret_value);
}
/*-------------------------------------------------------------------------
* Function: H5F_get_obj_count
*
* Purpose: Private function return the number of opened object IDs
* (files, datasets, groups, datatypes) in the same file.
*
* Return: Non-negative on success; negative on failure.
*
* Programmer: Raymond Lu
* Wednesday, Dec 5, 2001
*
* Modification:
*
*-------------------------------------------------------------------------
*/
herr_t
H5F_get_obj_count(H5F_t *f, unsigned types, unsigned *obj_id_count)
{
herr_t ret_value = SUCCEED;
FUNC_ENTER_NOINIT(H5F_get_obj_count);
*obj_id_count = 0;
if(H5F_get_objects(f, types, NULL, obj_id_count) < 0)
HGOTO_ERROR(H5E_FILE, H5E_CANTGET, FAIL, "can't get counts of opened file IDs and object IDs in the file");
done:
FUNC_LEAVE(ret_value);
}
/*-------------------------------------------------------------------------
* Function: H5Fget_object_ids
*
* Purpose: Public function to return a list of opened object IDs.
*
* Return: Non-negative on success; negative on failure.
*
* Programmer: Raymond Lu
* Wednesday, Dec 5, 2001
*
* Modification:
*
*-------------------------------------------------------------------------
*/
herr_t
H5Fget_obj_ids(hid_t file_id, unsigned types, hid_t *oid_list)
{
herr_t ret_value;
H5F_t *f=NULL;
FUNC_ENTER_API(H5Fget_obj_ids, FAIL);
H5TRACE3("e","iIu*i",file_id,types,oid_list);
if( file_id != H5F_OBJ_ALL && (NULL==(f=H5I_object_verify(file_id,H5I_FILE))) )
HGOTO_ERROR(H5E_ARGS, H5E_BADVALUE, FAIL, "not a file id");
if( (types&H5F_OBJ_ALL)==0)
HGOTO_ERROR(H5E_ARGS, H5E_BADVALUE, FAIL, "not an object type");
assert(oid_list);
ret_value = H5F_get_obj_ids(f, types, oid_list);
done:
FUNC_LEAVE(ret_value);
}
/*-------------------------------------------------------------------------
* Function: H5F_get_object_ids
*
* Purpose: Private function to return a list of opened object IDs.
*
* Return: Non-negative on success; negative on failure.
*
* Programmer: Raymond Lu
* Wednesday, Dec 5, 2001
*
* Modification:
*
*-------------------------------------------------------------------------
*/
herr_t
H5F_get_obj_ids(H5F_t *f, unsigned types, hid_t *oid_list)
{
herr_t ret_value = SUCCEED;
FUNC_ENTER_NOINIT(H5F_get_obj_ids);
if(H5F_get_objects(f, types, oid_list, NULL) < 0)
HGOTO_ERROR(H5E_FILE, H5E_CANTGET, FAIL, "can't get object IDs opened in the file");
done:
FUNC_LEAVE(ret_value);
}
/*---------------------------------------------------------------------------
* Function: H5F_get_objects
*
* Purpose: This function is called by H5F_get_obj_count or
* H5F_get_obj_ids to get either number of object IDs or a
* list of opened object IDs.
* Return: Non-negative on success; negative on failure.
*
* Programmer: Raymond Lu
* Wednesday, Dec 5, 2001
*
* Modification:
*
*---------------------------------------------------------------------------
*/
static herr_t
H5F_get_objects(H5F_t *f, unsigned types, hid_t *obj_id_list,
unsigned *obj_id_count)
{
herr_t ret_value = SUCCEED;
H5F_olist_t *olist = NULL;
FUNC_ENTER_NOINIT(H5F_get_object);
olist = H5MM_malloc(sizeof(H5F_olist_t));
olist->obj_id_list = obj_id_list;
olist->obj_id_count = obj_id_count;
olist->list_index = 0;
/* Shared file structure is used to verify if file IDs refer to the same
* file. */
if(f != NULL)
olist->shared = f->shared;
else
olist->shared = NULL;
/* Search through file IDs to count the number, and put their
* IDs on the object list */
if( (types & H5F_OBJ_FILE) && H5I_nmembers(H5I_FILE) > 0 ) {
olist->obj_type = H5I_FILE;
H5I_search(H5I_FILE, (H5I_search_func_t)H5F_get_objects_cb, olist);
}
/* Search through dataset IDs to count number of dataset, and put their
* IDs on the object list */
if( (types & H5F_OBJ_DATASET) && H5I_nmembers(H5I_DATASET) > 0 ) {
olist->obj_type = H5I_DATASET;
H5I_search(H5I_DATASET, (H5I_search_func_t)H5F_get_objects_cb, olist);
}
/* Search through group IDs to count number of group, and put their
* IDs on the object list */
if( (types & H5F_OBJ_GROUP) && H5I_nmembers(H5I_GROUP) > 0 ) {
olist->obj_type = H5I_GROUP;
H5I_search(H5I_GROUP, (H5I_search_func_t)H5F_get_objects_cb, olist);
}
/* Search through datatype IDs to count number of datatype, and put their
* IDs on the object list */
if( (types & H5F_OBJ_DATATYPE) && H5I_nmembers(H5I_DATATYPE) > 0 ) {
olist->obj_type = H5I_DATATYPE;
H5I_search(H5I_DATATYPE, (H5I_search_func_t)H5F_get_objects_cb, olist);
}
#ifdef LATER
done:
#endif /* LATER */
if(olist!=NULL)
H5MM_xfree(olist);
FUNC_LEAVE(ret_value);
}
/*-------------------------------------------------------------------------
* Function: H5F_get_objects_cb
*
* Purpose: H5F_get_objects' callback function. It verifies if an
* object is in the file, and either count it or put its ID
* on the list.
*
* Programmer: Raymond Lu
* Wednesday, Dec 5, 2001
*
* Modification:
*
*-------------------------------------------------------------------------
*/
static herr_t
H5F_get_objects_cb(void *obj_ptr, hid_t obj_id, void *key)
{
herr_t ret_value = SUCCEED;
H5F_olist_t *olist = key;
H5G_entry_t *ent = NULL;
FUNC_ENTER_NOINIT(H5F_get_objects_cb);
assert(obj_ptr);
assert(olist);
/* Count file IDs */
if(olist->obj_type == H5I_FILE) {
if( !olist->shared || (olist->shared && ((H5F_t*)obj_ptr)->shared ==
olist->shared) ) {
if(olist->obj_id_list) {
olist->obj_id_list[olist->list_index] = obj_id;
olist->list_index++;
}
if(olist->obj_id_count)
(*olist->obj_id_count)++;
}
} else { /* either count opened object IDs or put the IDs on the list */
switch(olist->obj_type) {
case H5I_GROUP:
ent = H5G_entof((H5G_t*)obj_ptr);
break;
case H5I_DATASET:
ent = H5D_entof((H5D_t*)obj_ptr);
break;
case H5I_DATATYPE:
ent = H5T_entof((H5T_t*)obj_ptr);
break;
default:
HGOTO_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL,
"unknown data object");
}
if( (!olist->shared && olist->obj_type==H5I_DATATYPE && H5T_is_immutable((H5T_t*)obj_ptr)==FALSE)
|| (!olist->shared && olist->obj_type!=H5I_DATATYPE)
|| (ent && ent->file->shared == olist->shared) ) {
if(olist->obj_id_list) {
olist->obj_id_list[olist->list_index] = obj_id;
olist->list_index++;
}
if(olist->obj_id_count)
(*olist->obj_id_count)++;
}
}
done:
FUNC_LEAVE(ret_value);
}
/*-------------------------------------------------------------------------
* Function: H5Fget_vfd_handle
*
* Purpose: Returns a pointer to the file handle of the low-level file
* driver.
*
* Return: Success: non-negative value.
*
* Failture: negative.
*
* Programmer: Raymond Lu
* Sep. 16, 2002
*
* Modification:
*
*-------------------------------------------------------------------------
*/
herr_t H5Fget_vfd_handle(hid_t file_id, hid_t fapl, void** file_handle)
{
H5F_t *file=NULL;
herr_t ret_value;
FUNC_ENTER_API(H5Fget_vfd_handle, NULL);
/* Check args */
assert(file_handle);
if(NULL==(file=H5I_object_verify(file_id, H5I_FILE)))
HGOTO_ERROR(H5E_ARGS, H5E_BADVALUE, FAIL, "not a file id");
ret_value=H5F_get_vfd_handle(file, fapl, file_handle);
done:
FUNC_LEAVE(ret_value);
}
/*-------------------------------------------------------------------------
* Function: H5F_get_vfd_handle
*
* Purpose: Returns a pointer to the file handle of the low-level file
* driver. This is the private function for H5Fget_vfd_handle.
*
* Return: Success: Non-negative.
*
* Failture: negative.
*
* Programmer: Raymond Lu
* Sep. 16, 2002
*
* Modification:
*
*-------------------------------------------------------------------------
*/
herr_t H5F_get_vfd_handle(H5F_t *file, hid_t fapl, void**file_handle)
{
herr_t ret_value;
FUNC_ENTER_NOINIT(H5F_get_vfd_handle);
assert(file_handle);
if((ret_value=H5FD_get_vfd_handle(file->shared->lf, fapl, file_handle)) < 0)
HGOTO_ERROR(H5E_FILE, H5E_CANTGET, FAIL, "can't get file handle for file driver");
done:
FUNC_LEAVE(ret_value);
}
/*-------------------------------------------------------------------------
* Function: H5F_equal
*
* Purpose: Compares NEEDLE to a file from the HAYSTACK.
*
* Return: Success: Returns positive if two files are equal,
* zero otherwise.
*
* Failure: Negative
*
* Programmer: Robb Matzke
* Monday, August 2, 1999
*
* Modifications:
*
*-------------------------------------------------------------------------
*/
static int
H5F_equal(void *_haystack, hid_t UNUSED id, const void *_needle)
{
H5F_t *haystack = (H5F_t*)_haystack;
const H5FD_t *needle = (const H5FD_t*)_needle;
int retval;
FUNC_ENTER_NOINIT(H5F_equal);
retval = (0==H5FD_cmp(haystack->shared->lf, needle));
FUNC_LEAVE(retval);
}
/*-------------------------------------------------------------------------
* Function: H5F_locate_signature
*
* Purpose: Finds the HDF5 boot block signature in a file. The signature
* can appear at address 0, or any power of two beginning with
* 512.
*
* Return: Success: The absolute format address of the signature.
*
* Failure: HADDR_UNDEF
*
* Programmer: Robb Matzke
* Friday, November 7, 1997
*
* Modifications:
* Robb Matzke, 1999-08-02
* Rewritten to use the virtual file layer.
*-------------------------------------------------------------------------
*/
static haddr_t
H5F_locate_signature(H5FD_t *file)
{
haddr_t addr, eoa;
uint8_t buf[H5F_SIGNATURE_LEN];
unsigned n, maxpow;
haddr_t ret_value; /* Return value */
FUNC_ENTER_NOINIT(H5F_locate_signature);
/* Find the least N such that 2^N is larger than the file size */
if (HADDR_UNDEF==(addr=H5FD_get_eof(file)) ||
HADDR_UNDEF==(eoa=H5FD_get_eoa(file)))
HGOTO_ERROR(H5E_IO, H5E_CANTINIT, HADDR_UNDEF, "unable to obtain EOF/EOA value");
for (maxpow=0; addr; maxpow++)
addr>>=1;
maxpow = MAX(maxpow, 9);
/*
* Search for the file signature at format address zero followed by
* powers of two larger than 9.
*/
for (n=8; n<maxpow; n++) {
addr = (8==n) ? 0 : (haddr_t)1 << n;
if (H5FD_set_eoa(file, addr+H5F_SIGNATURE_LEN)<0)
HGOTO_ERROR(H5E_IO, H5E_CANTINIT, HADDR_UNDEF, "unable to set EOA value for file signature");
if (H5FD_read(file, H5FD_MEM_SUPER, H5P_DATASET_XFER_DEFAULT, addr, H5F_SIGNATURE_LEN, buf)<0)
HGOTO_ERROR(H5E_IO, H5E_CANTINIT, HADDR_UNDEF, "unable to read file signature");
if (!HDmemcmp(buf, H5F_SIGNATURE, H5F_SIGNATURE_LEN))
break;
}
/*
* If the signature was not found then reset the EOA value and return
* failure.
*/
if (n>=maxpow) {
H5FD_set_eoa(file, eoa);
HGOTO_ERROR(H5E_IO, H5E_CANTINIT, HADDR_UNDEF, "unable to find a valid file signature");
}
/* Set return value */
ret_value=addr;
done:
FUNC_LEAVE(ret_value);
}
/*-------------------------------------------------------------------------
* Function: H5Fis_hdf5
*
* Purpose: Check the file signature to detect an HDF5 file.
*
* Bugs: This function is not robust: it only uses the default file
* driver when attempting to open the file when in fact it
* should use all known file drivers.
*
* Return: Success: TRUE/FALSE
*
* Failure: Negative
*
* Programmer: Unknown
*
* Modifications:
* Robb Matzke, 1999-08-02
* Rewritten to use the virtual file layer.
*-------------------------------------------------------------------------
*/
htri_t
H5Fis_hdf5(const char *name)
{
H5FD_t *file = NULL;
htri_t ret_value;
FUNC_ENTER_API(H5Fis_hdf5, FAIL);
H5TRACE1("b","s",name);
/* Check args and all the boring stuff. */
if (!name || !*name)
HGOTO_ERROR(H5E_ARGS, H5E_BADRANGE, FAIL, "no file name specified");
/* Open the file at the virtual file layer */
if (NULL==(file=H5FD_open(name, H5F_ACC_RDONLY, H5P_DEFAULT, HADDR_UNDEF)))
HGOTO_ERROR(H5E_IO, H5E_CANTINIT, FAIL, "unable to open file");
/* The file is an hdf5 file if the hdf5 file signature can be found */
ret_value = (HADDR_UNDEF!=H5F_locate_signature(file));
done:
/* Close the file */
if (file)
if(H5FD_close(file)<0 && ret_value>=0)
HDONE_ERROR(H5E_IO, H5E_CANTCLOSEFILE, FAIL, "unable to close file");
FUNC_LEAVE(ret_value);
}
/*-------------------------------------------------------------------------
* Function: H5F_new
*
* Purpose: Creates a new file object and initializes it. The
* H5Fopen and H5Fcreate functions then fill in various
* fields. If SHARED is a non-null pointer then the shared info
* to which it points has the reference count incremented.
* Otherwise a new, empty shared info struct is created and
* initialized with the specified file access property list.
*
* Errors:
*
* Return: Success: Ptr to a new file struct.
*
* Failure: NULL
*
* Programmer: Robb Matzke
* matzke@llnl.gov
* Jul 18 1997
*
* Modifications:
*
* Raymond Lu, Oct 14, 2001
* Changed the file creation and access property list to the
* new generic property list.
*
*-------------------------------------------------------------------------
*/
static H5F_t *
H5F_new(H5F_file_t *shared, hid_t fcpl_id, hid_t fapl_id)
{
H5F_t *f=NULL, *ret_value;
int n;
H5P_genplist_t *plist; /* Property list */
FUNC_ENTER_NOINIT(H5F_new);
if (NULL==(f=H5FL_ALLOC(H5F_t,1)))
HGOTO_ERROR(H5E_RESOURCE, H5E_NOSPACE, NULL, "memory allocation failed");
if (shared) {
f->shared = shared;
} else {
f->shared = H5FL_ALLOC(H5F_file_t,1);
f->shared->boot_addr = HADDR_UNDEF;
f->shared->base_addr = HADDR_UNDEF;
f->shared->freespace_addr = HADDR_UNDEF;
f->shared->driver_addr = HADDR_UNDEF;
/*
* Copy the file creation and file access property lists into the
* new file handle. We do this early because some values might need
* to change as the file is being opened.
*/
if(H5P_DEFAULT == fcpl_id)
fcpl_id = H5P_FILE_CREATE_DEFAULT;
if(NULL == (plist = H5P_object_verify(fcpl_id,H5P_FILE_CREATE)))
HGOTO_ERROR(H5E_ARGS, H5E_BADTYPE, NULL, "not property list");
f->shared->fcpl_id = H5P_copy_plist(plist);
if(H5P_DEFAULT == fapl_id)
fapl_id = H5P_FILE_ACCESS_DEFAULT;
if(NULL == (plist = H5P_object_verify(fapl_id,H5P_FILE_ACCESS)))
HGOTO_ERROR(H5E_ARGS, H5E_BADTYPE, NULL, "not file access property list");
if(H5P_get(plist, H5F_ACS_META_CACHE_SIZE_NAME, &(f->shared->mdc_nelmts)) < 0)
HGOTO_ERROR(H5E_PLIST, H5E_CANTGET, NULL, "can't get meta data cache size");
if(H5P_get(plist, H5F_ACS_DATA_CACHE_ELMT_SIZE_NAME, &(f->shared->rdcc_nelmts)) < 0)
HGOTO_ERROR(H5E_PLIST, H5E_CANTGET, NULL, "can't get data cache element size");
if(H5P_get(plist, H5F_ACS_DATA_CACHE_BYTE_SIZE_NAME, &(f->shared->rdcc_nbytes)) < 0)
HGOTO_ERROR(H5E_PLIST, H5E_CANTGET, NULL, "can't get data cache cache size");
if(H5P_get(plist, H5F_ACS_PREEMPT_READ_CHUNKS_NAME, &(f->shared->rdcc_w0)) < 0)
HGOTO_ERROR(H5E_PLIST, H5E_CANTGET, NULL, "can't get preempt read chunk");
if(H5P_get(plist, H5F_ACS_ALIGN_THRHD_NAME, &(f->shared->threshold))<0)
HGOTO_ERROR(H5E_PLIST, H5E_CANTGET, NULL, "can't get alignment threshold");
if(H5P_get(plist, H5F_ACS_ALIGN_NAME, &(f->shared->alignment)) < 0)
HGOTO_ERROR(H5E_PLIST, H5E_CANTGET, NULL, "can't get alignment");
if(H5P_get(plist, H5F_ACS_GARBG_COLCT_REF_NAME,&(f->shared->gc_ref))<0)
HGOTO_ERROR(H5E_PLIST, H5E_CANTGET, NULL, "can't get garbage collect reference");
if(H5P_get(plist, H5F_ACS_SIEVE_BUF_SIZE_NAME, &(f->shared->sieve_buf_size)) < 0)
HGOTO_ERROR(H5E_PLIST, H5E_CANTGET, NULL, "can't get sieve buffer size");
/*
* Create a meta data cache with the specified number of elements.
* The cache might be created with a different number of elements and
* the access property list should be updated to reflect that.
*/
if ((n=H5AC_create(f, f->shared->mdc_nelmts))<0)
HGOTO_ERROR(H5E_FILE, H5E_CANTINIT, NULL, "unable to create meta data cache");
f->shared->mdc_nelmts = n;
/* Create the chunk cache */
H5F_istore_init(f);
} /* end else */
f->shared->nrefs++;
f->nrefs = 1;
/* Set return value */
ret_value = f;
done:
if (!ret_value && f) {
if (!shared)
H5FL_FREE(H5F_file_t,f->shared);
H5FL_FREE(H5F_t,f);
}
FUNC_LEAVE(ret_value);
}
/*-------------------------------------------------------------------------
* Function: H5F_dest
*
* Purpose: Destroys a file structure. This function flushes the cache
* but doesn't do any other cleanup other than freeing memory
* for the file struct. The shared info for the file is freed
* only when its reference count reaches zero.
*
* Return: Non-negative on success/Negative on failure
*
* Programmer: Robb Matzke
* matzke@llnl.gov
* Jul 18 1997
*
* Modifications:
*
* Robb Matzke, 1998-10-14
* Nothing happens unless the reference count for the H5F_t goes to
* zero. The reference counts are decremented here.
*
* Robb Matzke, 1999-02-19
* More careful about decrementing reference counts so they don't go
* negative or wrap around to some huge value. Nothing happens if a
* reference count is already zero.
*
* Robb Matzke, 2000-10-31
* H5FL_FREE() aborts if called with a null pointer (unlike the
* original H5MM_free()).
*
* Pedro Vicente, <pvn@ncsa.uiuc.edu> 18 Sep 2002
* Added `id to name' support.
*
*-------------------------------------------------------------------------
*/
static herr_t
H5F_dest(H5F_t *f)
{
herr_t ret_value = SUCCEED;
FUNC_ENTER_NOINIT(H5F_dest);
if (f && 1==f->nrefs) {
if (1==f->shared->nrefs) {
/*
* Do not close the root group since we didn't count it, but free
* the memory associated with it.
*/
if (f->shared->root_grp) {
/* Free the ID to name buffer */
H5G_free_grp_name(f->shared->root_grp);
/* Free the memory for the root group */
H5FL_FREE(H5G_t,f->shared->root_grp);
f->shared->root_grp=NULL;
}
if (H5AC_dest(f)) {
HERROR(H5E_FILE, H5E_CANTINIT, "problems closing file");
ret_value = FAIL; /*but keep going*/
}
if (H5F_istore_dest (f)<0) {
HERROR(H5E_FILE, H5E_CANTINIT, "problems closing file");
ret_value = FAIL; /*but keep going*/
}
f->shared->cwfs = H5MM_xfree (f->shared->cwfs);
/* Free the data sieve buffer, if it's been allocated */
if(f->shared->sieve_buf) {
assert(f->shared->sieve_dirty==0); /* The buffer had better be flushed... */
f->shared->sieve_buf = H5FL_BLK_FREE (sieve_buf,f->shared->sieve_buf);
} /* end if */
/* Destroy file creation properties */
if(H5I_GENPROP_LST != H5I_get_type(f->shared->fcpl_id))
HGOTO_ERROR(H5E_PLIST, H5E_BADTYPE, FAIL, "not a property list");
if((ret_value=H5I_dec_ref(f->shared->fcpl_id)) < 0)
HGOTO_ERROR(H5E_PLIST, H5E_CANTFREE, FAIL, "can't close property list");
/* Destroy shared file struct */
if (H5FD_close(f->shared->lf)<0) {
HERROR(H5E_FILE, H5E_CANTINIT, "problems closing file");
ret_value = FAIL; /*but keep going*/
}
f->shared = H5FL_FREE(H5F_file_t,f->shared);
} else if (f->shared->nrefs>0) {
/*
* There are other references to the shared part of the file.
* Only decrement the reference count.
*/
--f->shared->nrefs;
}
/* Free the non-shared part of the file */
f->name = H5MM_xfree(f->name);
f->mtab.child = H5MM_xfree(f->mtab.child);
f->mtab.nalloc = 0;
H5FL_FREE(H5F_t,f);
} else if (f && f->nrefs>0) {
/*
* There are other references to this file. Only decrement the
* reference count.
*/
--f->nrefs;
}
done:
FUNC_LEAVE(ret_value);
}
/*-------------------------------------------------------------------------
* Function: H5F_open
*
* Purpose: Opens (or creates) a file. This function understands the
* following flags which are similar in nature to the Posix
* open(2) flags.
*
* H5F_ACC_RDWR: Open with read/write access. If the file is
* currently open for read-only access then it
* will be reopened. Absence of this flag
* implies read-only access.
*
* H5F_ACC_CREAT: Create a new file if it doesn't exist yet.
* The permissions are 0666 bit-wise AND with
* the current umask. H5F_ACC_WRITE must also
* be specified.
*
* H5F_ACC_EXCL: This flag causes H5F_open() to fail if the
* file already exists.
*
* H5F_ACC_TRUNC: The file is truncated and a new HDF5 superblock
* is written. This operation will fail if the
* file is already open.
*
* Unlinking the file name from the group directed graph while
* the file is opened causes the file to continue to exist but
* one will not be able to upgrade the file from read-only
* access to read-write access by reopening it. Disk resources
* for the file are released when all handles to the file are
* closed. NOTE: This paragraph probably only applies to Unix;
* deleting the file name in other OS's has undefined results.
*
* The CREATE_PARMS argument is optional. A null pointer will
* cause the default file creation parameters to be used.
*
* The ACCESS_PARMS argument is optional. A null pointer will
* cause the default file access parameters to be used.
*
* Return: Success: A new file pointer.
*
* Failure: NULL
*
* Programmer: Robb Matzke
* Tuesday, September 23, 1997
*
* Modifications:
* Albert Cheng, 1998-02-05
* Added the access_parms argument to pass down access template
* information.
*
* Robb Matzke, 1998-02-18
* The H5F_access_t changed to allow more generality. The low
* level driver is part of the file access template so the TYPE
* argument has been removed.
*
* Robb Matzke, 1999-08-02
* Rewritten to use the virtual file layer.
*
* Robb Matzke, 1999-08-16
* Added decoding of file driver information block, which uses a
* formerly reserved address slot in the boot block in order to
* be compatible with previous versions of the file format.
*
* Robb Matzke, 1999-08-20
* Optimizations for opening a file. If the driver can't
* determine when two file handles refer to the same file then
* we open the file in one step. Otherwise if the first attempt
* to open the file fails then we skip the second attempt if the
* arguments would be the same.
*
* Raymond Lu, 2001-10-14
* Changed the file creation and access property lists to the
* new generic property list.
*
*-------------------------------------------------------------------------
*/
H5F_t *
H5F_open(const char *name, unsigned flags, hid_t fcpl_id, hid_t fapl_id)
{
H5F_t *file=NULL; /*the success return value */
H5F_t *ret_value; /*actual return value */
H5F_file_t *shared=NULL; /*shared part of `file' */
H5FD_t *lf=NULL; /*file driver part of `shared' */
uint8_t buf[256]; /*temporary I/O buffer */
const uint8_t *p; /*ptr into temp I/O buffer */
uint8_t *q; /*ptr into temp I/O buffer */
size_t fixed_size=24; /*fixed sizeof superblock */
size_t variable_size; /*variable sizeof superblock */
size_t driver_size; /*size of driver info block */
H5G_entry_t root_ent; /*root symbol table entry */
haddr_t eof; /*end of file address */
haddr_t stored_eoa; /*relative end-of-addr in file */
unsigned tent_flags; /*tentative flags */
char driver_name[9]; /*file driver name/version */
hbool_t driver_has_cmp; /*`cmp' callback defined? */
hsize_t userblock_size = 0;
int boot_vers;
int freespace_vers;
int obj_dir_vers;
int share_head_vers;
size_t sizeof_addr = 0;
size_t sizeof_size = 0;
unsigned sym_leaf_k = 0;
int btree_k[H5B_NUM_BTREE_ID];
H5P_genplist_t *c_plist;
H5P_genplist_t *a_plist; /* Property list */
H5F_close_degree_t fc_degree;
unsigned chksum; /* Checksum temporary variable */
unsigned i; /* Index variable */
FUNC_ENTER_NOAPI(H5F_open, NULL);
/*
* If the driver has a `cmp' method then the driver is capable of
* determining when two file handles refer to the same file and the
* library can insure that when the application opens a file twice that
* the two handles coordinate their operations appropriately. Otherwise
* it is the application's responsibility to never open the same file
* more than once at a time.
*/
driver_has_cmp = H5FD_has_cmp(fapl_id);
/*
* Opening a file is a two step process. First we try to open the file in
* a way which doesn't affect its state (like not truncating or creating
* it) so we can compare it with files that are already open. If that
* fails then we try again with the full set of flags (only if they're
* different than the original failed attempt). However, if the file
* driver can't distinquish between files then there's no reason to open
* the file tentatively because it's the application's responsibility to
* prevent this situation (there's no way for us to detect it here
* anyway).
*/
if (driver_has_cmp) {
tent_flags = flags & ~(H5F_ACC_CREAT|H5F_ACC_TRUNC|H5F_ACC_EXCL);
} else {
tent_flags = flags;
}
if (NULL==(lf=H5FD_open(name, tent_flags, fapl_id, HADDR_UNDEF))) {
if (tent_flags == flags)
HGOTO_ERROR(H5E_FILE, H5E_CANTOPENFILE, NULL, "unable to open file");
H5E_clear();
tent_flags = flags;
if (NULL==(lf=H5FD_open(name, tent_flags, fapl_id, HADDR_UNDEF)))
HGOTO_ERROR(H5E_FILE, H5E_CANTOPENFILE, NULL, "unable to open file");
} /* end if */
/* Is the file already open? */
if ((file=H5I_search(H5I_FILE, H5F_equal, lf)) ||
(file=H5I_search(H5I_FILE_CLOSING, H5F_equal, lf))) {
/*
* The file is already open, so use that one instead of the one we
* just opened. We only one one H5FD_t* per file so one doesn't
* confuse the other. But fail if this request was to truncate the
* file (since we can't do that while the file is open), or if the
* request was to create a non-existent file (since the file already
* exists), or if the new request adds write access (since the
* readers don't expect the file to change under them).
*/
H5FD_close(lf);
if (flags & H5F_ACC_TRUNC) {
file = NULL; /*to prevent destruction of wrong file*/
HGOTO_ERROR(H5E_FILE, H5E_CANTOPENFILE, NULL, "unable to truncate a file which is already open");
}
if (flags & H5F_ACC_EXCL) {
file = NULL; /*to prevent destruction of wrong file*/
HGOTO_ERROR(H5E_FILE, H5E_CANTOPENFILE, NULL, "file exists");
}
if ((flags & H5F_ACC_RDWR) && 0==(file->intent & H5F_ACC_RDWR)) {
file = NULL; /*to prevent destruction of wrong file*/
HGOTO_ERROR(H5E_FILE, H5E_CANTOPENFILE, NULL, "file is already open for read-only");
}
file = H5F_new(file->shared, fcpl_id, fapl_id);
lf = file->shared->lf;
} else if (flags!=tent_flags) {
/*
* This file is not yet open by the library and the flags we used to
* open it are different than the desired flags. Close the tentative
* file and open it for real.
*/
H5FD_close(lf);
if (NULL==(lf=H5FD_open(name, flags, fapl_id, HADDR_UNDEF))) {
file = NULL; /*to prevent destruction of wrong file*/
HGOTO_ERROR(H5E_FILE, H5E_CANTOPENFILE, NULL, "unable to open file");
}
if (NULL==(file = H5F_new(NULL, fcpl_id, fapl_id)))
HGOTO_ERROR(H5E_FILE, H5E_CANTOPENFILE, NULL, "unable to create new file object");
file->shared->flags = flags;
file->shared->lf = lf;
} else {
/*
* This file is not yet open by the library and our tentative opening
* above is good enough.
*/
if (NULL==(file = H5F_new(NULL, fcpl_id, fapl_id)))
HGOTO_ERROR(H5E_FILE, H5E_CANTOPENFILE, NULL, "unable to create new file object");
file->shared->flags = flags;
file->shared->lf = lf;
}
/* Short cuts */
shared = file->shared;
lf = shared->lf;
/*
* The intent at the top level file struct are not necessarily the same as
* the flags at the bottom. The top level describes how the file can be
* accessed through the HDF5 library. The bottom level describes how the
* file can be accessed through the C library.
*/
file->intent = flags;
file->name = H5MM_xstrdup(name);
/* Get the shared file creation property list */
if(NULL == (c_plist = H5I_object(shared->fcpl_id)))
HGOTO_ERROR(H5E_ARGS, H5E_BADTYPE, NULL, "can't get property list");
/*
* Read or write the file superblock, depending on whether the file is
* empty or not.
*/
if (0==H5FD_get_eof(lf) && (flags & H5F_ACC_RDWR)) {
/*
* The superblock starts immediately after the user-defined header,
* which we have already insured is a proper size. The base address
* is set to the same thing as the superblock for now.
*/
if(H5P_get(c_plist, H5F_CRT_USER_BLOCK_NAME, &userblock_size) < 0)
HGOTO_ERROR(H5E_FILE, H5E_CANTGET, NULL, "unable to get user block size");
shared->boot_addr = userblock_size;
shared->base_addr = shared->boot_addr;
shared->consist_flags = 0x03;
if (H5F_flush(file, H5F_SCOPE_LOCAL, FALSE, TRUE,FALSE)<0)
HGOTO_ERROR(H5E_FILE, H5E_CANTINIT, NULL, "unable to write file superblock");
/* Create and open the root group */
if (H5G_mkroot(file, NULL)<0)
HGOTO_ERROR(H5E_FILE, H5E_CANTINIT, NULL, "unable to create/open root group");
} else if (1==shared->nrefs) {
/* Read the superblock if it hasn't been read before. */
if (HADDR_UNDEF==(shared->boot_addr=H5F_locate_signature(lf)))
HGOTO_ERROR(H5E_FILE, H5E_NOTHDF5, NULL, "unable to find file signature");
if (H5FD_set_eoa(lf, shared->boot_addr+fixed_size)<0 ||
H5FD_read(lf, H5FD_MEM_SUPER, H5P_DATASET_XFER_DEFAULT, shared->boot_addr, fixed_size, buf)<0)
HGOTO_ERROR(H5E_FILE, H5E_READERROR, NULL, "unable to read superblock");
/* Signature, already checked */
p = buf + H5F_SIGNATURE_LEN;
/* Superblock version */
boot_vers = *p++;
if(HDF5_BOOTBLOCK_VERSION != boot_vers)
HGOTO_ERROR(H5E_FILE, H5E_BADVALUE, NULL, "bad superblock version number");
if(H5P_set(c_plist, H5F_CRT_BOOT_VERS_NAME, &boot_vers) < 0)
HGOTO_ERROR(H5E_PLIST, H5E_CANTSET, NULL, "unable to set boot version");
/* Freespace version */
freespace_vers = *p++;
if(HDF5_FREESPACE_VERSION != freespace_vers)
HGOTO_ERROR(H5E_FILE, H5E_BADVALUE, NULL, "bad free space version number");
if(H5P_set(c_plist, H5F_CRT_FREESPACE_VERS_NAME, &freespace_vers)<0)
HGOTO_ERROR(H5E_PLIST, H5E_CANTSET, NULL, "unable to free space version");
/* Root group version number */
obj_dir_vers = *p++;
if(HDF5_OBJECTDIR_VERSION != obj_dir_vers)
HGOTO_ERROR(H5E_FILE, H5E_BADVALUE, NULL, "bad object directory version number");
if(H5P_set(c_plist, H5F_CRT_OBJ_DIR_VERS_NAME, &obj_dir_vers) < 0)
HGOTO_ERROR(H5E_PLIST, H5E_CANTSET, NULL, "unable to set object directory version");
/* reserved */
p++;
/* Shared header version number */
share_head_vers = *p++;
if(HDF5_SHAREDHEADER_VERSION != share_head_vers)
HGOTO_ERROR(H5E_FILE, H5E_BADVALUE, NULL, "bad shared-header format version number");
if(H5P_set(c_plist, H5F_CRT_SHARE_HEAD_VERS_NAME, &share_head_vers) < 0)
HGOTO_ERROR(H5E_PLIST, H5E_CANTSET, NULL, "unable to set shared-header format version");
/* Size of file addresses */
sizeof_addr = *p++;
if (sizeof_addr != 2 && sizeof_addr != 4 &&
sizeof_addr != 8 && sizeof_addr != 16 && sizeof_addr != 32)
HGOTO_ERROR(H5E_FILE, H5E_BADVALUE, NULL, "bad byte number in an address");
if(H5P_set(c_plist, H5F_CRT_ADDR_BYTE_NUM_NAME,&sizeof_addr)<0)
HGOTO_ERROR(H5E_PLIST, H5E_CANTSET, NULL, "unable to set byte number in an address");
/* Size of file sizes */
sizeof_size = *p++;
if (sizeof_size != 2 && sizeof_size != 4 &&
sizeof_size != 8 && sizeof_size != 16 && sizeof_size != 32)
HGOTO_ERROR(H5E_FILE, H5E_BADVALUE, NULL, "bad byte number for object size");
if(H5P_set(c_plist, H5F_CRT_OBJ_BYTE_NUM_NAME, &sizeof_size)<0)
HGOTO_ERROR(H5E_PLIST, H5E_CANTSET, NULL, "unable to set byte number for object size");
/* Reserved byte */
p++;
/* Various B-tree sizes */
UINT16DECODE(p, sym_leaf_k);
if(sym_leaf_k < 1)
HGOTO_ERROR(H5E_FILE, H5E_BADRANGE, NULL, "bad symbol table leaf node 1/2 rank");
if(H5P_set(c_plist, H5F_CRT_SYM_LEAF_NAME, &sym_leaf_k)<0)
HGOTO_ERROR(H5E_PLIST, H5E_CANTSET, NULL, "unable to set rank for symbol table leaf nodes");
/* Need 'get' call to set other array values */
if(H5P_get(c_plist, H5F_CRT_BTREE_RANK_NAME, btree_k)<0)
HGOTO_ERROR(H5E_PLIST, H5E_CANTGET, NULL, "unable to get rank for btree internal nodes");
UINT16DECODE(p, btree_k[H5B_SNODE_ID]);
if(btree_k[H5B_SNODE_ID] < 1)
HGOTO_ERROR(H5E_FILE, H5E_BADRANGE, NULL, "bad 1/2 rank for btree internal nodes");
if(H5P_set(c_plist, H5F_CRT_BTREE_RANK_NAME, btree_k)<0)
HGOTO_ERROR(H5E_PLIST, H5E_CANTSET, NULL, "unable to set rank for btree internal nodes");
/* File consistency flags. Not really used yet */
UINT32DECODE(p, shared->consist_flags);
assert((hsize_t)(p-buf) == fixed_size);
/* Decode the variable-length part of the superblock... */
variable_size = H5F_SIZEOF_ADDR(file) + /*base addr*/
H5F_SIZEOF_ADDR(file) + /*global free list*/
H5F_SIZEOF_ADDR(file) + /*end-of-address*/
H5F_SIZEOF_ADDR(file) + /*reserved address*/
H5G_SIZEOF_ENTRY(file); /*root group ptr*/
assert(variable_size<=sizeof(buf));
if (H5FD_set_eoa(lf, shared->boot_addr+fixed_size+variable_size)<0 ||
H5FD_read(lf, H5FD_MEM_SUPER, H5P_DATASET_XFER_DEFAULT, shared->boot_addr+fixed_size, variable_size, &buf[fixed_size])<0)
HGOTO_ERROR(H5E_FILE, H5E_CANTOPENFILE, NULL, "unable to read superblock");
H5F_addr_decode(file, &p, &(shared->base_addr)/*out*/);
H5F_addr_decode(file, &p, &(shared->freespace_addr)/*out*/);
H5F_addr_decode(file, &p, &stored_eoa/*out*/);
H5F_addr_decode(file, &p, &(shared->driver_addr)/*out*/);
if (H5G_ent_decode(file, &p, &root_ent/*out*/)<0)
HGOTO_ERROR(H5E_FILE, H5E_CANTOPENFILE, NULL, "unable to read root symbol entry");
/* Compute boot block checksum */
assert(sizeof(chksum)==sizeof(shared->boot_chksum));
for(q=(uint8_t *)&chksum, chksum=0, i=0; i<(fixed_size+variable_size); i++)
q[i%sizeof(shared->boot_chksum)] ^= buf[i];
/* Set the boot block checksum */
shared->boot_chksum=chksum;
/* Decode the optional driver information block */
if (H5F_addr_defined(shared->driver_addr)) {
haddr_t drv_addr = shared->base_addr + shared->driver_addr;
if (H5FD_set_eoa(lf, drv_addr+16)<0 ||
H5FD_read(lf, H5FD_MEM_SUPER, H5P_DATASET_XFER_DEFAULT, drv_addr, 16, buf)<0)
HGOTO_ERROR(H5E_FILE, H5E_CANTOPENFILE, NULL, "unable to read driver information block");
p = buf;
/* Version number */
if (HDF5_DRIVERINFO_VERSION!=*p++)
HGOTO_ERROR(H5E_FILE, H5E_CANTOPENFILE, NULL, "bad driver information block version number");
/* Reserved */
p += 3;
/* Driver info size */
UINT32DECODE(p, driver_size);
/* Driver name and/or version */
HDstrncpy(driver_name, (const char *)p, 8);
driver_name[8] = '\0';
/* Read driver information and decode */
if (H5FD_set_eoa(lf, drv_addr+16+driver_size)<0 ||
H5FD_read(lf, H5FD_MEM_SUPER, H5P_DATASET_XFER_DEFAULT, drv_addr+16, driver_size, &buf[16])<0)
HGOTO_ERROR(H5E_FILE, H5E_CANTOPENFILE, NULL, "unable to read file driver information");
if (H5FD_sb_decode(lf, driver_name, &buf[16])<0)
HGOTO_ERROR(H5E_FILE, H5E_CANTOPENFILE, NULL, "unable to decode driver information");
/* Compute driver info block checksum */
assert(sizeof(chksum)==sizeof(shared->drvr_chksum));
for(q=(uint8_t *)&chksum, chksum=0, i=0; i<(driver_size+16); i++)
q[i%sizeof(shared->drvr_chksum)] ^= buf[i];
/* Set the driver info block checksum */
shared->drvr_chksum=chksum;
} /* end if */
/* Make sure we can open the root group */
if (H5G_mkroot(file, &root_ent)<0)
HGOTO_ERROR(H5E_FILE, H5E_CANTOPENFILE, NULL, "unable to read root group");
/*
* The user-defined data is the area of the file before the base
* address.
*/
if(H5P_set(c_plist, H5F_CRT_USER_BLOCK_NAME, &(shared->base_addr)) < 0)
HGOTO_ERROR(H5E_PLIST, H5E_CANTSET, NULL, "unable to set usr block size");
/*
* Make sure that the data is not truncated. One case where this is
* possible is if the first file of a family of files was opened
* individually.
*/
if (HADDR_UNDEF==(eof=H5FD_get_eof(lf)))
HGOTO_ERROR(H5E_FILE, H5E_CANTOPENFILE, NULL, "unable to determine file size");
if (eof<stored_eoa)
HGOTO_ERROR(H5E_FILE, H5E_TRUNCATED, NULL, "truncated file");
/*
* Tell the file driver how much address space has already been
* allocated so that it knows how to allocated additional memory.
*/
if (H5FD_set_eoa(lf, stored_eoa)<0)
HGOTO_ERROR(H5E_FILE, H5E_CANTOPENFILE, NULL, "unable to set end-of-address marker for file");
}
/* Decide the file close degree. If it's the first time to open the
* file, set the degree to access property list value; if it's the
* second time or later, verify the access property list value matches
* the degree in shared file structure.
*/
if(H5P_DEFAULT == fapl_id)
fapl_id = H5P_FILE_ACCESS_DEFAULT;
if(NULL == (a_plist = H5P_object_verify(fapl_id,H5P_FILE_ACCESS)))
HGOTO_ERROR(H5E_ARGS, H5E_BADTYPE, NULL, "not file access property list");
if(H5P_get(a_plist, H5F_CLOSE_DEGREE_NAME, &fc_degree) < 0)
HGOTO_ERROR(H5E_PLIST, H5E_CANTGET, NULL, "can't get file close degree");
if(shared->nrefs == 1) {
if(fc_degree == H5F_CLOSE_DEFAULT)
shared->fc_degree = H5F_CLOSE_DEFAULT;
else
shared->fc_degree = fc_degree;
} else if(shared->nrefs > 1) {
if(fc_degree==H5F_CLOSE_DEFAULT) {
if(shared->fc_degree != H5F_CLOSE_DEFAULT && shared->fc_degree!=shared->lf->cls->fc_degree)
HGOTO_ERROR(H5E_FILE, H5E_CANTINIT, NULL, "file close degree doesn't match");
} else {
if(fc_degree != shared->fc_degree)
HGOTO_ERROR(H5E_FILE, H5E_CANTINIT, NULL, "file close degree doesn't match");
}
}
/* Success */
ret_value = file;
done:
if (!ret_value && file)
H5F_dest(file); /* Don't indicate error here, to leave the error stack with the correct error */
FUNC_LEAVE(ret_value);
}
/*-------------------------------------------------------------------------
* Function: H5Fcreate
*
* Purpose: This is the primary function for creating HDF5 files . The
* flags parameter determines whether an existing file will be
* overwritten or not. All newly created files are opened for
* both reading and writing. All flags may be combined with the
* bit-wise OR operator (`|') to change the behavior of the file
* create call.
*
* The more complex behaviors of a file's creation and access
* are controlled through the file-creation and file-access
* property lists. The value of H5P_DEFAULT for a template
* value indicates that the library should use the default
* values for the appropriate template.
*
* See also: H5Fpublic.h for the list of supported flags. H5Ppublic.h for
* the list of file creation and file access properties.
*
* Return: Success: A file ID
*
* Failure: FAIL
*
* Programmer: Unknown
*
* Modifications:
* Robb Matzke, 1997-07-18
* File struct creation and destruction is through H5F_new() and
* H5F_dest(). Writing the root symbol table entry is done with
* H5G_encode().
*
* Robb Matzke, 1997-08-29
* Moved creation of the boot block to H5F_flush().
*
* Robb Matzke, 1997-09-23
* Most of the work is now done by H5F_open() since H5Fcreate()
* and H5Fopen() originally contained almost identical code.
*
* Robb Matzke, 1998-02-18
* Better error checking for the creation and access property
* lists. It used to be possible to swap the two and core the
* library. Also, zero is no longer valid as a default property
* list; one must use H5P_DEFAULT instead.
*
* Robb Matzke, 1999-08-02
* The file creation and file access property lists are passed
* to the H5F_open() as object IDs.
*
* Raymond Lu, 2001-10-14
* Changed the file creation and access property list to the
* new generic property list.
*
*-------------------------------------------------------------------------
*/
hid_t
H5Fcreate(const char *filename, unsigned flags, hid_t fcpl_id,
hid_t fapl_id)
{
H5F_t *new_file = NULL; /*file struct for new file */
hid_t ret_value; /*return value */
FUNC_ENTER_API(H5Fcreate, FAIL);
H5TRACE4("i","sIuii",filename,flags,fcpl_id,fapl_id);
/* Check/fix arguments */
if (!filename || !*filename)
HGOTO_ERROR(H5E_ARGS, H5E_BADVALUE, FAIL, "invalid file name");
if (flags & ~(H5F_ACC_EXCL|H5F_ACC_TRUNC|H5F_ACC_DEBUG))
HGOTO_ERROR(H5E_ARGS, H5E_BADVALUE, FAIL, "invalid flags");
if ((flags & H5F_ACC_EXCL) && (flags & H5F_ACC_TRUNC))
HGOTO_ERROR (H5E_ARGS, H5E_BADVALUE, FAIL, "mutually exclusive flags for file creation");
/* Check file creation property list */
if(H5P_DEFAULT == fcpl_id)
fcpl_id = H5P_FILE_CREATE_DEFAULT;
if(TRUE != H5P_isa_class(fcpl_id, H5P_FILE_CREATE))
HGOTO_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL, "not file create property list");
/* Check the file access property list */
if(H5P_DEFAULT == fapl_id)
fapl_id = H5P_FILE_ACCESS_DEFAULT;
if(TRUE != H5P_isa_class(fapl_id, H5P_FILE_ACCESS))
HGOTO_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL, "not file access property list");
/*
* Adjust bit flags by turning on the creation bit and making sure that
* the EXCL or TRUNC bit is set. All newly-created files are opened for
* reading and writing.
*/
if (0==(flags & (H5F_ACC_EXCL|H5F_ACC_TRUNC)))
flags |= H5F_ACC_EXCL; /*default*/
flags |= H5F_ACC_RDWR | H5F_ACC_CREAT;
/*
* Create a new file or truncate an existing file.
*/
if (NULL==(new_file=H5F_open(filename, flags, fcpl_id, fapl_id)))
HGOTO_ERROR(H5E_FILE, H5E_CANTOPENFILE, FAIL, "unable to create file");
/* Get an atom for the file */
if ((ret_value = H5I_register(H5I_FILE, new_file))<0)
HGOTO_ERROR(H5E_ATOM, H5E_CANTREGISTER, FAIL, "unable to atomize file");
done:
if (ret_value<0 && new_file)
H5F_close(new_file);
FUNC_LEAVE(ret_value);
}
/*-------------------------------------------------------------------------
* Function: H5Fopen
*
* Purpose: This is the primary function for accessing existing HDF5
* files. The FLAGS argument determines whether writing to an
* existing file will be allowed or not. All flags may be
* combined with the bit-wise OR operator (`|') to change the
* behavior of the file open call. The more complex behaviors
* of a file's access are controlled through the file-access
* property list.
*
* See Also: H5Fpublic.h for a list of possible values for FLAGS.
*
* Return: Success: A file ID
*
* Failure: FAIL
*
* Programmer: Unknown
*
* Modifications:
* Robb Matzke, 1997-07-18
* File struct creation and destruction is through H5F_new() and
* H5F_dest(). Reading the root symbol table entry is done with
* H5G_decode().
*
* Robb Matzke, 1997-09-23
* Most of the work is now done by H5F_open() since H5Fcreate()
* and H5Fopen() originally contained almost identical code.
*
* Robb Matzke, 1998-02-18
* Added better error checking for the flags and the file access
* property list. It used to be possible to make the library
* dump core by passing an object ID that was not a file access
* property list.
*
* Robb Matzke, 1999-08-02
* The file access property list is passed to the H5F_open() as
* object IDs.
*-------------------------------------------------------------------------
*/
hid_t
H5Fopen(const char *filename, unsigned flags, hid_t fapl_id)
{
H5F_t *new_file = NULL; /*file struct for new file */
hid_t ret_value; /*return value */
FUNC_ENTER_API(H5Fopen, FAIL);
H5TRACE3("i","sIui",filename,flags,fapl_id);
/* Check/fix arguments. */
if (!filename || !*filename)
HGOTO_ERROR(H5E_ARGS, H5E_BADVALUE, FAIL, "invalid file name");
if ((flags & ~H5F_ACC_PUBLIC_FLAGS) ||
(flags & H5F_ACC_TRUNC) || (flags & H5F_ACC_EXCL))
HGOTO_ERROR (H5E_ARGS, H5E_BADVALUE, FAIL, "invalid file open flags");
if(H5P_DEFAULT == fapl_id)
fapl_id = H5P_FILE_ACCESS_DEFAULT;
if(TRUE != H5P_isa_class(fapl_id, H5P_FILE_ACCESS))
HGOTO_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL, "not file access property list");
/* Open the file */
if (NULL==(new_file=H5F_open(filename, flags, H5P_DEFAULT, fapl_id)))
HGOTO_ERROR(H5E_FILE, H5E_CANTOPENFILE, FAIL, "unable to open file");
/* Get an atom for the file */
if ((ret_value = H5I_register(H5I_FILE, new_file))<0)
HGOTO_ERROR(H5E_ATOM, H5E_CANTREGISTER, FAIL, "unable to atomize file handle");
done:
if (ret_value<0 && new_file)
H5F_close(new_file);
FUNC_LEAVE(ret_value);
}
/*-------------------------------------------------------------------------
* Function: H5Fflush
*
* Purpose: Flushes all outstanding buffers of a file to disk but does
* not remove them from the cache. The OBJECT_ID can be a file,
* dataset, group, attribute, or named data type.
*
* Return: Non-negative on success/Negative on failure
*
* Programmer: Robb Matzke
* Thursday, August 6, 1998
*
* Modifications:
*
* Robb Matzke, 1998-10-16
* Added the `scope' argument.
*
*-------------------------------------------------------------------------
*/
herr_t
H5Fflush(hid_t object_id, H5F_scope_t scope)
{
H5F_t *f = NULL;
H5G_t *grp = NULL;
H5T_t *type = NULL;
H5D_t *dset = NULL;
H5A_t *attr = NULL;
H5G_entry_t *ent = NULL;
herr_t ret_value=SUCCEED; /* Return value */
FUNC_ENTER_API(H5Fflush, FAIL);
H5TRACE2("e","iFs",object_id,scope);
switch (H5I_get_type(object_id)) {
case H5I_FILE:
if (NULL==(f=H5I_object(object_id)))
HGOTO_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL, "invalid file identifier");
break;
case H5I_GROUP:
if (NULL==(grp=H5I_object(object_id)))
HGOTO_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL, "invalid group identifier");
ent = H5G_entof(grp);
break;
case H5I_DATATYPE:
if (NULL==(type=H5I_object(object_id)))
HGOTO_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL, "invalid type identifier");
ent = H5T_entof(type);
break;
case H5I_DATASET:
if (NULL==(dset=H5I_object(object_id)))
HGOTO_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL, "invalid dataset identifier");
ent = H5D_entof(dset);
break;
case H5I_ATTR:
if (NULL==(attr=H5I_object(object_id)))
HGOTO_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL, "invalid attribute identifier");
ent = H5A_entof(attr);
break;
default:
HGOTO_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL, "not a file or file object");
}
if (!f) {
if (!ent)
HGOTO_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL, "object is not assocated with a file");
f = ent->file;
}
if (!f)
HGOTO_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL, "object is not associated with a file");
/* Flush the file */
if (H5F_flush(f, scope, FALSE, FALSE, FALSE)<0)
HGOTO_ERROR(H5E_FILE, H5E_CANTINIT, FAIL, "flush failed");
done:
FUNC_LEAVE(ret_value);
}
/*-------------------------------------------------------------------------
* Function: H5F_flush
*
* Purpose: Flushes (and optionally invalidates) cached data plus the
* file boot block. If the logical file size field is zero
* then it is updated to be the length of the boot block.
*
* Return: Non-negative on success/Negative on failure
*
* Programmer: Robb Matzke
* matzke@llnl.gov
* Aug 29 1997
*
* Modifications:
* rky 1998-08-28
* Only p0 writes metadata to disk.
*
* Robb Matzke, 1998-10-16
* Added the `scope' argument to indicate what should be
* flushed. If the value is H5F_SCOPE_GLOBAL then the entire
* virtual file is flushed; a value of H5F_SCOPE_LOCAL means
* that only the specified file is flushed. A value of
* H5F_SCOPE_DOWN means flush the specified file and all
* children.
*
* Robb Matzke, 1999-08-02
* If ALLOC_ONLY is non-zero then all this function does is
* allocate space for the userblock and superblock. Also
* rewritten to use the virtual file layer.
*
* Robb Matzke, 1999-08-16
* The driver information block is encoded and either allocated
* or written to disk.
*
* Raymond Lu, 2001-10-14
* Changed to new generic property list.
*
* Quincey Koziol, 2002-05-20
* Added 'closing' parameter
*
* Quincey Koziol, 2002-06-05
* Added boot block & driver info block checksumming, to avoid
* writing them out when they haven't changed.
*
* Quincey Koziol, 2002-06-06
* Return the remainders of the metadata & "small data" blocks to
* the free list of blocks for the file.
*
*-------------------------------------------------------------------------
*/
static herr_t
H5F_flush(H5F_t *f, H5F_scope_t scope, hbool_t invalidate,
hbool_t alloc_only, hbool_t closing)
{
uint8_t sbuf[1024]; /* Superblock encoding buffer */
uint8_t dbuf[1024]; /* Driver info block encoding buffer */
uint8_t *p=NULL; /* Temporary pointer into encoding buffers */
unsigned nerrors=0; /* Errors from nested flushes */
unsigned i; /* Index variable */
unsigned chksum; /* Checksum temporary variable */
size_t superblock_size;/* Size of superblock, in bytes */
size_t driver_size; /* Size of driver info block, in bytes */
char driver_name[9]; /* Name of driver, for driver info block */
int boot_vers; /* Boot block version */
int freespace_vers; /* Freespace info version */
int obj_dir_vers; /* Object header info version */
int share_head_vers;/* Shared header info version */
int btree_k[H5B_NUM_BTREE_ID]; /* B-tree size info */
unsigned sym_leaf_k; /* Number of symbols in B-tree leafs */
H5P_genplist_t *plist; /* Property list */
herr_t ret_value; /* Return value */
FUNC_ENTER_NOINIT(H5F_flush);
/*
* Nothing to do if the file is read only. This determination is made at
* the shared open(2) flags level, implying that opening a file twice,
* once for read-only and once for read-write, and then calling
* H5F_flush() with the read-only handle, still causes data to be flushed.
*/
if (0 == (H5F_ACC_RDWR & f->shared->flags))
HGOTO_DONE(SUCCEED);
/* Flush other stuff depending on scope */
if (H5F_SCOPE_GLOBAL==scope) {
while (f->mtab.parent)
f = f->mtab.parent;
scope = H5F_SCOPE_DOWN;
}
if (H5F_SCOPE_DOWN==scope) {
for (i=0; i<f->mtab.nmounts; i++) {
if (H5F_flush(f->mtab.child[i].file, scope, invalidate, FALSE, closing)<0)
nerrors++;
}
}
/* Avoid flushing buffers & caches when alloc_only set */
if(!alloc_only) {
/* flush any cached compact storage raw data */
if (H5D_flush(f)<0)
HGOTO_ERROR(H5E_CACHE, H5E_CANTFLUSH, FAIL, "unable to flush dataset cache");
/* If we are invalidating everything (which only happens just before
* the file closes), release the unused portion of the metadata and
* "small data" blocks back to the free lists in the file.
*/
if(invalidate) {
if(f->shared->lf->feature_flags&H5FD_FEAT_AGGREGATE_METADATA) {
/* Return the unused portion of the metadata block to a free list */
if(f->shared->lf->eoma!=0)
if(H5FD_free(f->shared->lf,H5FD_MEM_DEFAULT,f->shared->lf->eoma,f->shared->lf->cur_meta_block_size)<0)
HGOTO_ERROR(H5E_VFL, H5E_CANTFREE, FAIL, "can't free metadata block");
/* Reset metadata block information, just in case */
f->shared->lf->eoma=0;
f->shared->lf->cur_meta_block_size=0;
} /* end if */
if(f->shared->lf->feature_flags&H5FD_FEAT_AGGREGATE_SMALLDATA) {
/* Return the unused portion of the "small data" block to a free list */
if(f->shared->lf->eosda!=0)
if(H5FD_free(f->shared->lf,H5FD_MEM_DRAW,f->shared->lf->eosda,f->shared->lf->cur_sdata_block_size)<0)
HGOTO_ERROR(H5E_VFL, H5E_CANTFREE, FAIL, "can't free 'small data' block");
/* Reset "small data" block information, just in case */
f->shared->lf->eosda=0;
f->shared->lf->cur_sdata_block_size=0;
} /* end if */
} /* end if */
/* flush the data sieve buffer, if we have a dirty one */
if(f->shared->sieve_buf && f->shared->sieve_dirty) {
/* Write dirty data sieve buffer to file */
if (H5F_block_write(f, H5FD_MEM_DRAW, f->shared->sieve_loc, f->shared->sieve_size, H5P_DATASET_XFER_DEFAULT, f->shared->sieve_buf)<0)
HGOTO_ERROR(H5E_IO, H5E_WRITEERROR, FAIL, "block write failed");
/* Reset sieve buffer dirty flag */
f->shared->sieve_dirty=0;
} /* end if */
/* flush the entire raw data cache */
if (H5F_istore_flush (f, invalidate)<0)
HGOTO_ERROR(H5E_CACHE, H5E_CANTFLUSH, FAIL, "unable to flush raw data cache");
/* flush (and invalidate) the entire meta data cache */
if (H5AC_flush(f, NULL, HADDR_UNDEF, invalidate)<0)
HGOTO_ERROR(H5E_CACHE, H5E_CANTFLUSH, FAIL, "unable to flush meta data cache");
} /* end if */
/* Get the shared file creation property list */
if(NULL == (plist = H5I_object(f->shared->fcpl_id)))
HGOTO_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL, "not a property list");
if(H5P_get(plist, H5F_CRT_BOOT_VERS_NAME, &boot_vers) < 0)
HGOTO_ERROR(H5E_PLIST, H5E_CANTGET, FAIL, "unable to get boot block version");
if(H5P_get(plist, H5F_CRT_FREESPACE_VERS_NAME, &freespace_vers) < 0)
HGOTO_ERROR(H5E_PLIST, H5E_CANTGET, FAIL, "unable to get free space version");
if(H5P_get(plist, H5F_CRT_OBJ_DIR_VERS_NAME, &obj_dir_vers) < 0)
HGOTO_ERROR(H5E_PLIST, H5E_CANTGET, FAIL, "unable to get object directory version");
if(H5P_get(plist, H5F_CRT_SHARE_HEAD_VERS_NAME, &share_head_vers) < 0)
HGOTO_ERROR(H5E_PLIST, H5E_CANTGET, FAIL, "unable to get shared-header format version");
if(H5P_get(plist, H5F_CRT_SYM_LEAF_NAME, &sym_leaf_k) < 0)
HGOTO_ERROR(H5E_PLIST, H5E_CANTGET, FAIL, "unable to get rank for symbol table leaf nodes");
if(H5P_get(plist, H5F_CRT_BTREE_RANK_NAME, btree_k) < 0)
HGOTO_ERROR(H5E_PLIST, H5E_CANTGET, FAIL, "unable to get rank for btree internal nodes");
/* encode the file boot block */
p = sbuf;
HDmemcpy(p, H5F_SIGNATURE, H5F_SIGNATURE_LEN);
p += H5F_SIGNATURE_LEN;
*p++ = boot_vers;
*p++ = freespace_vers;
*p++ = obj_dir_vers;
*p++ = 0; /*reserved*/
*p++ = share_head_vers;
assert (H5F_SIZEOF_ADDR(f)<=255);
*p++ = (uint8_t)H5F_SIZEOF_ADDR(f);
assert (H5F_SIZEOF_SIZE(f)<=255);
*p++ = (uint8_t)H5F_SIZEOF_SIZE(f);
*p++ = 0; /*reserved */
UINT16ENCODE(p, sym_leaf_k);
UINT16ENCODE(p, btree_k[H5B_SNODE_ID]);
UINT32ENCODE(p, f->shared->consist_flags);
H5F_addr_encode(f, &p, f->shared->base_addr);
H5F_addr_encode(f, &p, f->shared->freespace_addr);
H5F_addr_encode(f, &p, H5FD_get_eoa(f->shared->lf));
H5F_addr_encode(f, &p, f->shared->driver_addr);
H5G_ent_encode(f, &p, H5G_entof(f->shared->root_grp));
superblock_size = p-sbuf;
/* Double check we didn't overrun the block (unlikely) */
assert(superblock_size<=sizeof(sbuf));
/*
* Encode the driver information block.
*/
H5_ASSIGN_OVERFLOW(driver_size,H5FD_sb_size(f->shared->lf),hsize_t,size_t);
if (driver_size>0) {
driver_size += 16; /*driver block header */
assert(driver_size<=sizeof(dbuf));
p = dbuf;
/* Version */
*p++ = HDF5_DRIVERINFO_VERSION;
/* Reserved*/
p += 3;
/* Driver info size, excluding header */
UINT32ENCODE(p, driver_size-16);
/* Encode driver-specific data */
if (H5FD_sb_encode(f->shared->lf, driver_name, dbuf+16)<0)
HGOTO_ERROR(H5E_FILE, H5E_CANTINIT, FAIL, "unable to encode driver information");
/* Driver name */
HDmemcpy(dbuf+8, driver_name, 8);
/* Double check we didn't overrun the block (unlikely) */
assert(driver_size<=sizeof(dbuf));
} /* end if */
if (alloc_only) {
haddr_t addr;
/*
* Allocate space for the userblock, superblock, and driver info
* block. We do it with one allocation request because the userblock
* and superblock need to be at the beginning of the file and only
* the first allocation request is required to return memory at
* format address zero.
*/
H5_CHECK_OVERFLOW(f->shared->base_addr,haddr_t,hsize_t);
addr = H5FD_alloc(f->shared->lf, H5FD_MEM_SUPER,
((hsize_t)f->shared->base_addr + superblock_size + driver_size));
if (HADDR_UNDEF==addr)
HGOTO_ERROR(H5E_FILE, H5E_CANTINIT, FAIL, "unable to allocate file space for userblock and/or superblock");
if (0!=addr)
HGOTO_ERROR(H5E_FILE, H5E_CANTINIT, FAIL, "file driver failed to allocate userblock and/or superblock at address zero");
/*
* The file driver information block begins immediately after the
* superblock.
*/
if (driver_size>0)
f->shared->driver_addr = superblock_size;
} else {
/* Compute boot block checksum */
assert(sizeof(chksum)==sizeof(f->shared->boot_chksum));
for(p=(uint8_t *)&chksum, chksum=0, i=0; i<superblock_size; i++)
p[i%sizeof(f->shared->boot_chksum)] ^= sbuf[i];
/* Compare with current checksums */
if(chksum!=f->shared->boot_chksum) {
/* Write superblock */
if (H5FD_write(f->shared->lf, H5FD_MEM_SUPER, H5P_DATASET_XFER_DEFAULT, f->shared->boot_addr, superblock_size, sbuf)<0)
HGOTO_ERROR(H5E_IO, H5E_WRITEERROR, FAIL, "unable to write superblock");
/* Update checksum information if different */
f->shared->boot_chksum=chksum;
} /* end if */
/* Check for driver info block */
if (HADDR_UNDEF!=f->shared->driver_addr) {
/* Compute driver info block checksum */
assert(sizeof(chksum)==sizeof(f->shared->drvr_chksum));
for(p=(uint8_t *)&chksum, chksum=0, i=0; i<driver_size; i++)
p[i%sizeof(f->shared->drvr_chksum)] ^= dbuf[i];
/* Compare with current checksums */
if(chksum!=f->shared->boot_chksum) {
/* Write driver information block */
if (H5FD_write(f->shared->lf, H5FD_MEM_SUPER, H5P_DATASET_XFER_DEFAULT, f->shared->base_addr+superblock_size, driver_size, dbuf)<0)
HGOTO_ERROR(H5E_IO, H5E_WRITEERROR, FAIL, "unable to write driver information block");
/* Update checksum information if different */
f->shared->drvr_chksum=chksum;
} /* end if */
} /* end if */
} /* end else */
/* Flush file buffers to disk */
if (!alloc_only && H5FD_flush(f->shared->lf,closing)<0)
HGOTO_ERROR(H5E_IO, H5E_WRITEERROR, FAIL, "low level flush failed");
/* Check flush errors for children - errors are already on the stack */
ret_value= (nerrors ? FAIL : SUCCEED);
done:
FUNC_LEAVE(ret_value);
} /* end H5F_flush() */
/*-------------------------------------------------------------------------
* Function: H5F_close
*
* Purpose: Closes a file or causes the close operation to be pended.
* This function is called two ways: from the API it gets called
* by H5Fclose->H5I_dec_ref->H5F_close when H5I_dec_ref()
* decrements the file ID reference count to zero. The file ID
* is removed from the H5I_FILE group by H5I_dec_ref() just
* before H5F_close() is called. If there are open object
* headers then the close is pended by moving the file to the
* H5I_FILE_CLOSING ID group (the f->closing contains the ID
* assigned to file).
*
* This function is also called directly from H5O_close() when
* the last object header is closed for the file and the file
* has a pending close.
*
* Return: Non-negative on success/Negative on failure
*
* Programmer: Robb Matzke
* Tuesday, September 23, 1997
*
* Modifications:
* Robb Matzke, 1998-10-14
* Nothing happens unless the H5F_t reference count is one (the
* file is flushed anyway). The reference count is decremented
* by H5F_dest().
*
* Robb Matzke, 1999-08-02
* Modified to use the virtual file layer.
*-------------------------------------------------------------------------
*/
herr_t
H5F_close(H5F_t *f)
{
H5F_close_degree_t fc_degree; /* What action to take when closing the last file ID for a file */
hid_t *oid_list; /* List of IDs still open */
unsigned i; /* Local index variable */
unsigned closing=0; /* Indicate that the file will be closed */
herr_t ret_value = SUCCEED; /* Return value */
FUNC_ENTER_NOAPI(H5F_close, FAIL);
assert(f->nrefs>0);
/*
* If this file is referenced more than once then just decrement the
* count and return.
*/
if (f->nrefs>1) {
/* Decrement reference counts */
if (H5F_dest(f)<0)
HGOTO_ERROR(H5E_FILE, H5E_CANTCLOSEFILE, FAIL, "problems closing file");
HGOTO_DONE(SUCCEED);
} /* end if */
/* Double-check that this file should be closed */
assert(1==f->nrefs);
/* Get the close degree from the file */
if(f->shared->fc_degree == H5F_CLOSE_DEFAULT)
fc_degree = f->shared->lf->cls->fc_degree;
else
fc_degree = f->shared->fc_degree;
/* if close degree if "semi" and there are objects left open and we are
* holding open the file with this file ID, fail now */
if(fc_degree==H5F_CLOSE_SEMI && f->nopen_objs>0 && f->shared->nrefs==1)
HGOTO_ERROR(H5E_FILE, H5E_CANTCLOSEFILE, FAIL, "can't close file, there are objects still open");
/*
* Unmount and close each child before closing the current file.
*/
assert(NULL==f->mtab.parent);
for (i=0; i<f->mtab.nmounts; i++) {
f->mtab.child[i].file->mtab.parent = NULL;
H5G_close(f->mtab.child[i].group);
H5F_close(f->mtab.child[i].file);
} /* end if */
f->mtab.nmounts = 0;
/* Close file according to close degree:
* H5F_CLOSE_WEAK: if there are still objects open, wait until
* they are all closed.
* H5F_CLOSE_SEMI: if there are still objects open, return fail;
* otherwise, close file.
* H5F_CLOSE_STRONG: if there are still objects open, close them
* first, then close file.
*/
switch(fc_degree) {
case H5F_CLOSE_WEAK:
/*
* If object headers are still open then delay deletion of
* resources until they have all been closed. Flush all
* caches and update the object eader anyway so that failing toi
* close all objects isn't a major problem. If the file is on
* the H5I_FILE list then move it to the H5I_FILE_CLOSING list
* instead.
*/
if (f->nopen_objs>0) {
#ifdef H5F_DEBUG
if (H5DEBUG(F)) {
fprintf(H5DEBUG(F), "H5F: H5F_close(%s): %u object header%s still "
"open (file close will complete when %s closed)\n",
f->name,
f->nopen_objs,
1 == f->nopen_objs?" is":"s are",
1 == f->nopen_objs?"that header is":"those headers are");
}
#endif
/* Register an ID for closing the file later */
if (!f->closing)
f->closing = H5I_register(H5I_FILE_CLOSING, f);
HGOTO_DONE(SUCCEED);
} else {
if (f->closing) {
#ifdef H5F_DEBUG
if (H5DEBUG(F))
fprintf(H5DEBUG(F), "H5F: H5F_close: operation completing\n");
#endif
} /* end if */
/* Indicate that the file will be closing */
closing=1;
} /* end else */
break;
case H5F_CLOSE_SEMI:
if (f->nopen_objs>0) {
#ifdef H5F_DEBUG
if (H5DEBUG(F)) {
fprintf(H5DEBUG(F), "H5F: H5F_close(%s): %u object header%s still "
"open (file close will complete when %s closed)\n",
f->name,
f->nopen_objs,
1 == f->nopen_objs?" is":"s are",
1 == f->nopen_objs?"that header is":"those headers are");
}
#endif
/* Register an ID for closing the file later */
if (!f->closing)
f->closing = H5I_register(H5I_FILE_CLOSING, f);
HGOTO_DONE(SUCCEED);
} else {
if (!f->closing && f->shared->nrefs>1)
HGOTO_ERROR(H5E_FILE, H5E_CANTCLOSEFILE, FAIL, "can't close file, there are objects still open");
/* Indicate that the file will be closing */
closing=1;
} /* end else */
break;
case H5F_CLOSE_STRONG:
/* Forcefully close all opened objects in file */
do {
/* Allocate space for the IDs of objects still currently open */
if((oid_list = H5MM_malloc(f->nopen_objs*sizeof(hid_t)))==NULL)
HGOTO_ERROR(H5E_RESOURCE, H5E_NOSPACE, FAIL, "memory allocation failed");
/* Get the list of IDs of open objects */
if(H5F_get_obj_ids(f, H5F_OBJ_DATASET|H5F_OBJ_GROUP|H5F_OBJ_DATATYPE, oid_list) < 0)
HGOTO_ERROR(H5E_FILE, H5E_CANTGET, FAIL, "can't get object list in file");
/* Try to close all the open objects */
for(i=0; i<f->nopen_objs; i++)
if(H5I_dec_ref(oid_list[i]) < 0)
HGOTO_ERROR(H5E_ATOM, H5E_CLOSEERROR, FAIL, "can't close object");
/* Free the ID list */
if(oid_list != NULL)
H5MM_xfree(oid_list);
} while(f->nopen_objs > 0);
/* Indicate that the file will be closing */
closing=1;
break;
default:
HGOTO_ERROR(H5E_FILE, H5E_CANTCLOSEFILE, FAIL, "can't close file, unknown file close degree");
} /* end switch */
/* Only flush at this point if the file will be closed */
if(closing) {
/* Dump debugging info */
H5AC_debug(f);
H5F_istore_stats(f, FALSE);
/* Flush and destroy all caches */
if (H5F_flush(f, H5F_SCOPE_LOCAL, TRUE, FALSE, TRUE)<0)
HGOTO_ERROR(H5E_CACHE, H5E_CANTFLUSH, FAIL, "unable to flush cache");
} /* end if */
/*
* Destroy the H5F_t struct and decrement the reference count for the
* shared H5F_file_t struct. If the reference count for the H5F_file_t
* struct reaches zero then destroy it also.
*/
if (H5F_dest(f)<0)
HGOTO_ERROR(H5E_FILE, H5E_CANTCLOSEFILE, FAIL, "problems closing file");
done:
FUNC_LEAVE(ret_value);
} /* end H5F_close() */
/*-------------------------------------------------------------------------
* Function: H5Fclose
*
* Purpose: This function closes the file specified by FILE_ID by
* flushing all data to storage, and terminating access to the
* file through FILE_ID. If objects (e.g., datasets, groups,
* etc.) are open in the file then the underlying storage is not
* closed until those objects are closed; however, all data for
* the file and the open objects is flushed.
*
* Return: Success: Non-negative
*
* Failure: Negative
*
* Programmer: Robb Matzke
* Saturday, February 20, 1999
*
* Modifications:
*
*-------------------------------------------------------------------------
*/
herr_t
H5Fclose(hid_t file_id)
{
herr_t ret_value = SUCCEED;
FUNC_ENTER_API(H5Fclose, FAIL);
H5TRACE1("e","i",file_id);
/* Check/fix arguments. */
if (NULL==H5I_object_verify(file_id,H5I_FILE))
HGOTO_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL, "not a file atom");
/*
* Decrement reference count on atom. When it reaches zero the file will
* be closed.
*/
if (H5I_dec_ref (file_id)<0)
HGOTO_ERROR (H5E_ATOM, H5E_CANTINIT, FAIL, "problems closing file");
done:
FUNC_LEAVE(ret_value);
}
/*-------------------------------------------------------------------------
* Function: H5F_mount
*
* Purpose: Mount file CHILD onto the group specified by LOC and NAME,
* using mount properties in PLIST. CHILD must not already be
* mouted and must not be a mount ancestor of the mount-point.
*
* Return: Non-negative on success/Negative on failure
*
* Programmer: Robb Matzke
* Tuesday, October 6, 1998
*
* Modifications:
*
* Robb Matzke, 1998-10-14
* The reference count for the mounted H5F_t is incremented.
*
* Pedro Vicente, <pvn@ncsa.uiuc.edu> 22 Aug 2002
* Added `id to name' support.
*
*-------------------------------------------------------------------------
*/
static herr_t
H5F_mount(H5G_entry_t *loc, const char *name, H5F_t *child,
const hid_t UNUSED plist_id)
{
H5G_t *mount_point = NULL; /*mount point group */
H5G_entry_t *mp_ent = NULL; /*mount point symbol table entry*/
H5F_t *ancestor = NULL; /*ancestor files */
H5F_t *parent = NULL; /*file containing mount point */
int lt, rt, md, cmp; /*binary search indices */
H5G_entry_t *ent = NULL; /*temporary symbol table entry */
herr_t ret_value = SUCCEED; /*return value */
FUNC_ENTER_NOINIT(H5F_mount);
assert(loc);
assert(name && *name);
assert(child);
assert(TRUE==H5P_isa_class(plist_id,H5P_MOUNT));
/*
* Check that the child isn't mounted, that the mount point exists, and
* that the mount wouldn't introduce a cycle in the mount tree.
*/
if (child->mtab.parent)
HGOTO_ERROR(H5E_FILE, H5E_MOUNT, FAIL, "file is already mounted");
if (NULL==(mount_point=H5G_open(loc, name)))
HGOTO_ERROR(H5E_FILE, H5E_MOUNT, FAIL, "mount point not found");
parent = H5G_fileof(mount_point);
mp_ent = H5G_entof(mount_point);
for (ancestor=parent; ancestor; ancestor=ancestor->mtab.parent) {
if (ancestor==child)
HGOTO_ERROR(H5E_FILE, H5E_MOUNT, FAIL, "mount would introduce a cycle");
}
/*
* Use a binary search to locate the position that the child should be
* inserted into the parent mount table. At the end of this paragraph
* `md' will be the index where the child should be inserted.
*/
lt = md = 0;
rt = parent->mtab.nmounts;
cmp = -1;
while (lt<rt && cmp) {
md = (lt+rt)/2;
ent = H5G_entof(parent->mtab.child[md].group);
cmp = H5F_addr_cmp(mp_ent->header, ent->header);
if (cmp<0) {
rt = md;
} else if (cmp>0) {
lt = md+1;
}
}
if (cmp>0)
md++;
if (!cmp)
HGOTO_ERROR(H5E_FILE, H5E_MOUNT, FAIL, "mount point is already in use");
/* Make room in the table */
if (parent->mtab.nmounts>=parent->mtab.nalloc) {
unsigned n = MAX(16, 2*parent->mtab.nalloc);
H5F_mount_t *x = H5MM_realloc(parent->mtab.child,
n*sizeof(parent->mtab.child[0]));
if (!x)
HGOTO_ERROR(H5E_RESOURCE, H5E_NOSPACE, FAIL, "memory allocation failed for mount table");
parent->mtab.child = x;
parent->mtab.nalloc = n;
}
/* Insert into table */
HDmemmove(parent->mtab.child+md+1,
parent->mtab.child+md,
(parent->mtab.nmounts-md)*sizeof(parent->mtab.child[0]));
parent->mtab.nmounts++;
parent->mtab.child[md].group = mount_point;
parent->mtab.child[md].file = child;
child->mtab.parent = parent;
child->nrefs++;
/* Search the open IDs and replace names for mount operation */
/* We pass H5G_UNKNOWN as object type; search all IDs */
if (H5G_replace_name( H5G_UNKNOWN, loc, name, NULL, OP_MOUNT )<0)
HGOTO_ERROR(H5E_FILE, H5E_MOUNT, FAIL, "unable to replace name");
done:
if (ret_value<0 && mount_point)
H5G_close(mount_point);
FUNC_LEAVE(ret_value);
}
/*-------------------------------------------------------------------------
* Function: H5F_unmount
*
* Purpose: Unmount the child which is mounted at the group specified by
* LOC and NAME or fail if nothing is mounted there. Neither
* file is closed.
*
* Because the mount point is specified by name and opened as a
* group, the H5G_namei() will resolve it to the root of the
* mounted file, not the group where the file is mounted.
*
* Return: Non-negative on success/Negative on failure
*
* Programmer: Robb Matzke
* Tuesday, October 6, 1998
*
* Modifications:
*
* Robb Matzke, 1998-10-14
* The ref count for the child is decremented by calling H5F_close().
*
* Pedro Vicente, <pvn@ncsa.uiuc.edu> 22 Aug 2002
* Added `id to name' support.
*
*-------------------------------------------------------------------------
*/
static herr_t
H5F_unmount(H5G_entry_t *loc, const char *name)
{
H5G_t *mounted = NULL; /*mount point group */
H5G_entry_t *mnt_ent = NULL; /*mounted symbol table entry */
H5F_t *child = NULL; /*mounted file */
H5F_t *parent = NULL; /*file where mounted */
H5G_entry_t *ent = NULL; /*temporary symbol table entry */
herr_t ret_value = FAIL; /*return value */
unsigned i; /*coutners */
int lt, rt, md=(-1), cmp; /*binary search indices */
FUNC_ENTER_NOINIT(H5F_unmount);
assert(loc);
assert(name && *name);
/*
* Get the mount point, or more precisely the root of the mounted file.
* If we get the root group and the file has a parent in the mount tree,
* then we must have found the mount point.
*/
if (NULL==(mounted=H5G_open(loc, name)))
HGOTO_ERROR(H5E_FILE, H5E_MOUNT, FAIL, "mount point not found");
child = H5G_fileof(mounted);
mnt_ent = H5G_entof(mounted);
ent = H5G_entof(child->shared->root_grp);
if (child->mtab.parent &&
H5F_addr_eq(mnt_ent->header, ent->header)) {
/*
* We've been given the root group of the child. We do a reverse
* lookup in the parent's mount table to find the correct entry.
*/
parent = child->mtab.parent;
for (i=0; i<parent->mtab.nmounts; i++) {
if (parent->mtab.child[i].file==child) {
/* Search the open IDs replace names to reflect unmount operation */
if (H5G_replace_name( H5G_UNKNOWN, loc, name, NULL, OP_UNMOUNT )<0)
HGOTO_ERROR(H5E_SYM, H5E_CANTINIT, FAIL, "unable to replace name ");
/* Unmount the child */
parent->mtab.nmounts -= 1;
H5G_close(parent->mtab.child[i].group);
child->mtab.parent = NULL;
H5F_close(child);
HDmemmove(parent->mtab.child+i,
parent->mtab.child+i+1,
((parent->mtab.nmounts-i)*
sizeof(parent->mtab.child[0])));
ret_value = SUCCEED;
}
}
assert(ret_value>=0);
} else {
/*
* We've been given the mount point in the parent. We use a binary
* search in the parent to locate the mounted file, if any.
*/
parent = child; /*we guessed wrong*/
lt = 0;
rt = parent->mtab.nmounts;
cmp = -1;
while (lt<rt && cmp) {
md = (lt+rt)/2;
ent = H5G_entof(parent->mtab.child[md].group);
cmp = H5F_addr_cmp(mnt_ent->header, ent->header);
if (cmp<0) {
rt = md;
} else {
lt = md+1;
}
}
if (cmp)
HGOTO_ERROR(H5E_FILE, H5E_MOUNT, FAIL, "not a mount point");
/* Unmount the child */
parent->mtab.nmounts -= 1;
H5G_close(parent->mtab.child[md].group);
parent->mtab.child[md].file->mtab.parent = NULL;
H5F_close(parent->mtab.child[md].file);
HDmemmove(parent->mtab.child+md,
parent->mtab.child+md+1,
(parent->mtab.nmounts-md)*sizeof(parent->mtab.child[0]));
ret_value = SUCCEED;
}
done:
if (mounted)
if(H5G_close(mounted)<0 && ret_value>=0)
HDONE_ERROR(H5E_FILE, H5E_MOUNT, FAIL, "can't close group");
FUNC_LEAVE(ret_value);
}
/*-------------------------------------------------------------------------
* Function: H5F_mountpoint
*
* Purpose: If ENT is a mount point then copy the entry for the root
* group of the mounted file into ENT.
*
* Return: Non-negative on success/Negative on failure
*
* Programmer: Robb Matzke
* Tuesday, October 6, 1998
*
* Modifications:
*
* Pedro Vicente, <pvn@ncsa.uiuc.edu> 22 Aug 2002
* Added `id to name' support.
*
*-------------------------------------------------------------------------
*/
herr_t
H5F_mountpoint(H5G_entry_t *find/*in,out*/)
{
H5F_t *parent = find->file;
int lt, rt, md=(-1), cmp;
H5G_entry_t *ent = NULL;
herr_t ret_value=SUCCEED; /* Return value */
FUNC_ENTER_NOAPI(H5F_mountpoint, FAIL);
assert(find);
/*
* The loop is necessary because we might have file1 mounted at the root
* of file2, which is mounted somewhere in file3.
*/
do {
/*
* Use a binary search to find the potential mount point in the mount
* table for the parent
*/
lt = 0;
rt = parent->mtab.nmounts;
cmp = -1;
while (lt<rt && cmp) {
md = (lt+rt)/2;
ent = H5G_entof(parent->mtab.child[md].group);
cmp = H5F_addr_cmp(find->header, ent->header);
if (cmp<0) {
rt = md;
} else {
lt = md+1;
}
}
/* Copy root info over to ENT */
if (0==cmp) {
char *tmp_name, *tmp_old_name; /* Temporary string pointers for entry's name and "old name"*/
/* Get the entry for the root group in the child's file */
ent = H5G_entof(parent->mtab.child[md].file->shared->root_grp);
/* Don't lose the name of the group when we copy the root group's entry */
tmp_name = find->name;
tmp_old_name = find->old_name;
*find = *ent;
find->name = tmp_name;
find->old_name = tmp_old_name;
/* Switch to child's file */
parent = ent->file;
}
} while (!cmp);
done:
FUNC_LEAVE(ret_value);
}
/*-------------------------------------------------------------------------
* Function: H5Fmount
*
* Purpose: Mount file CHILD_ID onto the group specified by LOC_ID and
* NAME using mount properties PLIST_ID.
*
* Return: Non-negative on success/Negative on failure
*
* Programmer: Robb Matzke
* Tuesday, October 6, 1998
*
* Modifications:
*
*-------------------------------------------------------------------------
*/
herr_t
H5Fmount(hid_t loc_id, const char *name, hid_t child_id, hid_t plist_id)
{
H5G_entry_t *loc = NULL;
H5F_t *child = NULL;
herr_t ret_value=SUCCEED; /* Return value */
FUNC_ENTER_API(H5Fmount, FAIL);
H5TRACE4("e","isii",loc_id,name,child_id,plist_id);
/* Check arguments */
if (NULL==(loc=H5G_loc(loc_id)))
HGOTO_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL, "not a location");
if (!name || !*name)
HGOTO_ERROR(H5E_ARGS, H5E_BADVALUE, FAIL, "no name");
if (NULL==(child=H5I_object_verify(child_id,H5I_FILE)))
HGOTO_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL, "not a file");
if(H5P_DEFAULT == plist_id)
plist_id = H5P_MOUNT_DEFAULT;
if(TRUE != H5P_isa_class(plist_id, H5P_MOUNT))
HGOTO_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL, "not property list");
/* Do the mount */
if (H5F_mount(loc, name, child, plist_id)<0)
HGOTO_ERROR(H5E_FILE, H5E_MOUNT, FAIL, "unable to mount file");
done:
FUNC_LEAVE(ret_value);
}
/*-------------------------------------------------------------------------
* Function: H5Funmount
*
* Purpose: Given a mount point, dissassociate the mount point's file
* from the file mounted there. Do not close either file.
*
* The mount point can either be the group in the parent or the
* root group of the mounted file (both groups have the same
* name). If the mount point was opened before the mount then
* it's the group in the parent, but if it was opened after the
* mount then it's the root group of the child.
*
* Return: Non-negative on success/Negative on failure
*
* Programmer: Robb Matzke
* Tuesday, October 6, 1998
*
* Modifications:
*
*-------------------------------------------------------------------------
*/
herr_t
H5Funmount(hid_t loc_id, const char *name)
{
H5G_entry_t *loc = NULL;
herr_t ret_value=SUCCEED; /* Return value */
FUNC_ENTER_API(H5Funmount, FAIL);
H5TRACE2("e","is",loc_id,name);
/* Check args */
if (NULL==(loc=H5G_loc(loc_id)))
HGOTO_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL, "not a location");
if (!name || !*name)
HGOTO_ERROR(H5E_ARGS, H5E_BADVALUE, FAIL, "no name");
/* Unmount */
if (H5F_unmount(loc, name)<0)
HGOTO_ERROR(H5E_FILE, H5E_MOUNT, FAIL, "unable to unmount file");
done:
FUNC_LEAVE(ret_value);
}
/*-------------------------------------------------------------------------
* Function: H5Freopen
*
* Purpose: Reopen a file. The new file handle which is returned points
* to the same file as the specified file handle. Both handles
* share caches and other information. The only difference
* between the handles is that the new handle is not mounted
* anywhere and no files are mounted on it.
*
* Return: Success: New file ID
*
* Failure: FAIL
*
* Programmer: Robb Matzke
* Friday, October 16, 1998
*
* Modifications:
* Quincey Koziol, May 14, 2002
* Keep old file's read/write intent in reopened file.
*
*-------------------------------------------------------------------------
*/
hid_t
H5Freopen(hid_t file_id)
{
H5F_t *old_file=NULL;
H5F_t *new_file=NULL;
hid_t ret_value;
FUNC_ENTER_API(H5Freopen, FAIL);
H5TRACE1("i","i",file_id);
if (NULL==(old_file=H5I_object_verify(file_id, H5I_FILE)))
HGOTO_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL, "not a file");
/* Get a new "top level" file struct, sharing the same "low level" file struct */
if (NULL==(new_file=H5F_new(old_file->shared, H5P_DEFAULT, H5P_DEFAULT)))
HGOTO_ERROR(H5E_FILE, H5E_CANTINIT, FAIL, "unable to reopen file");
/* Keep old file's read/write intent in new file */
new_file->intent=old_file->intent;
if ((ret_value=H5I_register(H5I_FILE, new_file))<0)
HGOTO_ERROR(H5E_ATOM, H5E_CANTREGISTER, FAIL, "unable to atomize file handle");
done:
if (ret_value<0 && new_file)
H5F_close(new_file);
FUNC_LEAVE(ret_value);
}
/*-------------------------------------------------------------------------
* Function: H5F_get_intent
*
* Purpose: Quick and dirty routine to retrieve the file's 'intent' flags
* (Mainly added to stop non-file routines from poking about in the
* H5F_t data structure)
*
* Return: 'intent' on success/abort on failure (shouldn't fail)
*
* Programmer: Quincey Koziol <koziol@ncsa.uiuc.edu>
* September 29, 2000
*
* Modifications:
*
*-------------------------------------------------------------------------
*/
unsigned
H5F_get_intent(const H5F_t *f)
{
/* Use FUNC_ENTER_NOINIT here to avoid performance issues */
FUNC_ENTER_NOINIT(H5F_get_intent);
assert(f);
FUNC_LEAVE(f->intent);
}
/*-------------------------------------------------------------------------
* Function: H5F_sizeof_addr
*
* Purpose: Quick and dirty routine to retrieve the size of the file's size_t
* (Mainly added to stop non-file routines from poking about in the
* H5F_t data structure)
*
* Return: 'sizeof_addr' on success/abort on failure (shouldn't fail)
*
* Programmer: Quincey Koziol <koziol@ncsa.uiuc.edu>
* September 29, 2000
*
* Modifications:
*
* Raymond Lu, Oct 14, 2001
* Changed to generic property list.
*
*-------------------------------------------------------------------------
*/
size_t
H5F_sizeof_addr(const H5F_t *f)
{
size_t sizeof_addr = 0;
H5P_genplist_t *plist; /* Property list */
size_t ret_value; /* Return value */
FUNC_ENTER_NOAPI(H5F_sizeof_addr, 0);
assert(f);
assert(f->shared);
/* Get property list */
if(NULL == (plist = H5I_object(f->shared->fcpl_id)))
HGOTO_ERROR(H5E_ARGS, H5E_BADTYPE, UFAIL, "not a property list");
if(H5P_get(plist, H5F_CRT_ADDR_BYTE_NUM_NAME, &sizeof_addr)<0)
HGOTO_ERROR(H5E_PLIST, H5E_CANTGET, UFAIL, "can't get byte number for address");
/* Set return value */
ret_value=sizeof_addr;
done:
FUNC_LEAVE(ret_value);
}
/*-------------------------------------------------------------------------
* Function: H5F_sizeof_size
*
* Purpose: Quick and dirty routine to retrieve the size of the file's off_t
* (Mainly added to stop non-file routines from poking about in the
* H5F_t data structure)
*
* Return: 'sizeof_size' on success/abort on failure (shouldn't fail)
*
* Programmer: Quincey Koziol <koziol@ncsa.uiuc.edu>
* September 29, 2000
*
* Modifications:
*
* Raymond Lu, Oct 14, 2001
* Changed to the new generic property list.
*
*-------------------------------------------------------------------------
*/
size_t
H5F_sizeof_size(const H5F_t *f)
{
size_t sizeof_size = 0;
H5P_genplist_t *plist; /* Property list */
size_t ret_value; /* Return value */
FUNC_ENTER_NOAPI(H5F_sizeof_size, 0);
assert(f);
assert(f->shared);
/* Get property list */
if(NULL == (plist = H5I_object(f->shared->fcpl_id)))
HGOTO_ERROR(H5E_ARGS, H5E_BADTYPE, UFAIL, "not a property list");
if(H5P_get(plist, H5F_CRT_OBJ_BYTE_NUM_NAME, &sizeof_size)<0)
HGOTO_ERROR(H5E_PLIST, H5E_CANTGET, UFAIL, "can't get byte number for object size");
/* Set return value */
ret_value=sizeof_size;
done:
FUNC_LEAVE(ret_value);
}
/*-------------------------------------------------------------------------
* Function: H5F_get_driver_id
*
* Purpose: Quick and dirty routine to retrieve the file's 'driver_id' value
* (Mainly added to stop non-file routines from poking about in the
* H5F_t data structure)
*
* Return: 'driver_id' on success/abort on failure (shouldn't fail)
*
* Programmer: Quincey Koziol <koziol@ncsa.uiuc.edu>
* October 10, 2000
*
* Modifications:
*
*-------------------------------------------------------------------------
*/
hid_t
H5F_get_driver_id(const H5F_t *f)
{
/* Use FUNC_ENTER_NOINIT here to avoid performance issues */
FUNC_ENTER_NOINIT(H5F_get_driver_id);
assert(f);
assert(f->shared);
assert(f->shared->lf);
FUNC_LEAVE(f->shared->lf->driver_id);
}
/*-------------------------------------------------------------------------
* Function: H5F_get_fileno
*
* Purpose: Quick and dirty routine to retrieve the file's 'fileno' value
* (Mainly added to stop non-file routines from poking about in the
* H5F_t data structure)
*
* Return: Non-negative on success/Negative on failure
*
* Programmer: Quincey Koziol <koziol@ncsa.uiuc.edu>
* March 27, 2002
*
* Modifications:
*
*-------------------------------------------------------------------------
*/
herr_t
H5F_get_fileno(const H5F_t *f, unsigned long *filenum)
{
herr_t ret_value = SUCCEED;
FUNC_ENTER_NOAPI(H5F_get_fileno, FAIL);
assert(f);
assert(f->shared);
assert(f->shared->lf);
assert(filenum);
/* Retrieve the file's serial number */
if(H5FD_get_fileno(f->shared->lf,filenum)<0)
HGOTO_ERROR(H5E_FILE, H5E_BADRANGE, FAIL, "can't retrieve fileno");
done:
FUNC_LEAVE(ret_value);
} /* end H5F_get_fileno() */
/*-------------------------------------------------------------------------
* Function: H5F_block_read
*
* Purpose: Reads some data from a file/server/etc into a buffer.
* The data is contiguous. The address is relative to the base
* address for the file.
*
* Errors:
* IO READERROR Low-level read failed.
*
* Return: Non-negative on success/Negative on failure
*
* Programmer: Robb Matzke
* matzke@llnl.gov
* Jul 10 1997
*
* Modifications:
* Albert Cheng, 1998-06-02
* Added XFER_MODE argument
*
* Robb Matzke, 1999-07-28
* The ADDR argument is passed by value.
*
* Robb Matzke, 1999-08-02
* Modified to use the virtual file layer. The data transfer
* property list is passed in by object ID since that's how the
* virtual file layer needs it.
*-------------------------------------------------------------------------
*/
herr_t
H5F_block_read(H5F_t *f, H5FD_mem_t type, haddr_t addr, size_t size, hid_t dxpl_id,
void *buf/*out*/)
{
haddr_t abs_addr;
herr_t ret_value=SUCCEED; /* Return value */
FUNC_ENTER_NOAPI(H5F_block_read, FAIL);
assert (f);
assert (f->shared);
assert(size<SIZET_MAX);
assert (buf);
/* convert the relative address to an absolute address */
abs_addr = f->shared->base_addr + addr;
/* Read the data */
if (H5FD_read(f->shared->lf, type, dxpl_id, abs_addr, size, buf)<0)
HGOTO_ERROR(H5E_IO, H5E_READERROR, FAIL, "file read failed");
done:
FUNC_LEAVE(ret_value);
}
/*-------------------------------------------------------------------------
* Function: H5F_block_write
*
* Purpose: Writes some data from memory to a file/server/etc. The
* data is contiguous. The address is relative to the base
* address.
*
* Errors:
* IO WRITEERROR Low-level write failed.
* IO WRITEERROR No write intent.
*
* Return: Non-negative on success/Negative on failure
*
* Programmer: Robb Matzke
* matzke@llnl.gov
* Jul 10 1997
*
* Modifications:
* Albert Cheng, 1998-06-02
* Added XFER_MODE argument
*
* Robb Matzke, 1999-07-28
* The ADDR argument is passed by value.
*
* Robb Matzke, 1999-08-02
* Modified to use the virtual file layer. The data transfer
* property list is passed in by object ID since that's how the
* virtual file layer needs it.
*-------------------------------------------------------------------------
*/
herr_t
H5F_block_write(H5F_t *f, H5FD_mem_t type, haddr_t addr, size_t size,
hid_t dxpl_id, const void *buf)
{
haddr_t abs_addr;
herr_t ret_value=SUCCEED; /* Return value */
FUNC_ENTER_NOAPI(H5F_block_write, FAIL);
assert (f);
assert (f->shared);
assert (size<SIZET_MAX);
assert (buf);
if (0==(f->intent & H5F_ACC_RDWR))
HGOTO_ERROR(H5E_IO, H5E_WRITEERROR, FAIL, "no write intent");
/* Convert the relative address to an absolute address */
abs_addr = f->shared->base_addr + addr;
/* Write the data */
if (H5FD_write(f->shared->lf, type, dxpl_id, abs_addr, size, buf))
HGOTO_ERROR(H5E_IO, H5E_WRITEERROR, FAIL, "file write failed");
done:
FUNC_LEAVE(ret_value);
}
/*-------------------------------------------------------------------------
* Function: H5F_addr_encode
*
* Purpose: Encodes an address into the buffer pointed to by *PP and
* then increments the pointer to the first byte after the
* address. An undefined value is stored as all 1's.
*
* Return: void
*
* Programmer: Robb Matzke
* Friday, November 7, 1997
*
* Modifications:
* Robb Matzke, 1999-07-28
* The ADDR argument is passed by value.
*-------------------------------------------------------------------------
*/
void
H5F_addr_encode(H5F_t *f, uint8_t **pp/*in,out*/, haddr_t addr)
{
unsigned i;
haddr_t tmp;
assert(f);
assert(pp && *pp);
if (H5F_addr_defined(addr)) {
tmp = addr;
for (i=0; i<H5F_SIZEOF_ADDR(f); i++) {
*(*pp)++ = (uint8_t)(tmp & 0xff);
tmp >>= 8;
}
assert("overflow" && 0 == tmp);
} else {
for (i=0; i<H5F_SIZEOF_ADDR(f); i++)
*(*pp)++ = 0xff;
}
}
/*-------------------------------------------------------------------------
* Function: H5F_addr_decode
*
* Purpose: Decodes an address from the buffer pointed to by *PP and
* updates the pointer to point to the next byte after the
* address.
*
* If the value read is all 1's then the address is returned
* with an undefined value.
*
* Return: void
*
* Programmer: Robb Matzke
* Friday, November 7, 1997
*
* Modifications:
*
*-------------------------------------------------------------------------
*/
void
H5F_addr_decode(H5F_t *f, const uint8_t **pp/*in,out*/, haddr_t *addr_p/*out*/)
{
unsigned i;
haddr_t tmp;
uint8_t c;
hbool_t all_zero = TRUE;
assert(f);
assert(pp && *pp);
assert(addr_p);
*addr_p = 0;
for (i=0; i<H5F_SIZEOF_ADDR(f); i++) {
c = *(*pp)++;
if (c != 0xff)
all_zero = FALSE;
if (i<sizeof(*addr_p)) {
tmp = c;
tmp <<= i * 8; /*use tmp to get casting right */
*addr_p |= tmp;
} else if (!all_zero) {
assert(0 == **pp); /*overflow */
}
}
if (all_zero)
*addr_p = HADDR_UNDEF;
}
/*-------------------------------------------------------------------------
* Function: H5F_addr_pack
*
* Purpose: Converts a long[2] array (usually returned from
* H5G_get_objinfo) back into a haddr_t
*
* Return: Non-negative on success/Negative on failure
*
* Programmer: Quincey Koziol
* Tuesday, October 23, 1998
*
* Modifications:
* Albert Cheng, 1999-02-18
* Changed objno to unsigned long type to be consistent with
* addr->offset and how it is being called.
*-------------------------------------------------------------------------
*/
herr_t
H5F_addr_pack(H5F_t UNUSED *f, haddr_t *addr_p/*out*/,
const unsigned long objno[2])
{
/* Use FUNC_ENTER_NOINIT here to avoid performance issues */
FUNC_ENTER_NOINIT(H5F_addr_pack);
assert(f);
assert(objno);
assert(addr_p);
*addr_p = objno[0];
#if H5_SIZEOF_LONG<H5_SIZEOF_UINT64_T
*addr_p |= ((uint64_t)objno[1]) << (8*sizeof(long));
#endif
FUNC_LEAVE(SUCCEED);
}
/*-------------------------------------------------------------------------
* Function: H5F_debug
*
* Purpose: Prints a file header to the specified stream. Each line
* is indented and the field name occupies the specified width
* number of characters.
*
* Errors:
*
* Return: Non-negative on success/Negative on failure
*
* Programmer: Robb Matzke
* matzke@llnl.gov
* Aug 1 1997
*
* Modifications:
* Robb Matzke, 1999-07-28
* The ADDR argument is passed by value.
*
* Raymond Lu, 2001-10-14
* Changed to the new generic property list.
*
*-------------------------------------------------------------------------
*/
herr_t
H5F_debug(H5F_t *f, haddr_t UNUSED addr, FILE * stream, int indent,
int fwidth)
{
hsize_t userblock_size;
int btree_k[H5B_NUM_BTREE_ID];
unsigned sym_leaf_k;
size_t sizeof_addr, sizeof_size;
int boot_vers, freespace_vers, obj_dir_vers, share_head_vers;
H5P_genplist_t *plist; /* Property list */
herr_t ret_value=SUCCEED; /* Return value */
FUNC_ENTER_NOAPI(H5F_debug, FAIL);
/* check args */
assert(f);
assert(H5F_addr_defined(addr));
assert(stream);
assert(indent >= 0);
assert(fwidth >= 0);
/* Get property list */
if(NULL == (plist = H5I_object(f->shared->fcpl_id)))
HGOTO_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL, "not a property list");
if(H5P_get(plist, H5F_CRT_USER_BLOCK_NAME, &userblock_size)<0)
HGOTO_ERROR(H5E_PLIST, H5E_CANTGET, FAIL, "can't get user block size");
if(H5P_get(plist, H5F_CRT_SYM_LEAF_NAME, &sym_leaf_k)<0)
HGOTO_ERROR(H5E_PLIST, H5E_CANTGET, FAIL, "can't get rank for symbol table leaf nodes");
if(H5P_get(plist, H5F_CRT_BTREE_RANK_NAME, btree_k)<0)
HGOTO_ERROR(H5E_PLIST, H5E_CANTGET, FAIL, "can't get rank for btree nodes");
if(H5P_get(plist, H5F_CRT_ADDR_BYTE_NUM_NAME, &sizeof_addr)<0)
HGOTO_ERROR(H5E_PLIST, H5E_CANTGET, FAIL, "can't get byte number for an address");
if(H5P_get(plist, H5F_CRT_OBJ_BYTE_NUM_NAME, &sizeof_size)<0)
HGOTO_ERROR(H5E_PLIST, H5E_CANTGET, FAIL, "can't get byte number for object size");
if(H5P_get(plist, H5F_CRT_BOOT_VERS_NAME, &boot_vers)<0)
HGOTO_ERROR(H5E_PLIST, H5E_CANTGET, FAIL, "can't get boot block version");
if(H5P_get(plist, H5F_CRT_FREESPACE_VERS_NAME, &freespace_vers)<0)
HGOTO_ERROR(H5E_PLIST, H5E_CANTGET, FAIL, "can't get boot block version");
if(H5P_get(plist, H5F_CRT_OBJ_DIR_VERS_NAME, &obj_dir_vers)<0)
HGOTO_ERROR(H5E_PLIST, H5E_CANTGET, FAIL, "can't get object directory version");
if(H5P_get(plist, H5F_CRT_SHARE_HEAD_VERS_NAME, &share_head_vers)<0)
HGOTO_ERROR(H5E_PLIST, H5E_CANTGET, FAIL, "can't get shared-header format version");
/* debug */
HDfprintf(stream, "%*sFile Boot Block...\n", indent, "");
HDfprintf(stream, "%*s%-*s %s\n", indent, "", fwidth,
"File name:",
f->name);
HDfprintf(stream, "%*s%-*s 0x%08x\n", indent, "", fwidth,
"Flags",
(unsigned) (f->shared->flags));
HDfprintf(stream, "%*s%-*s %u\n", indent, "", fwidth,
"Reference count:",
(unsigned) (f->shared->nrefs));
HDfprintf(stream, "%*s%-*s 0x%08lx\n", indent, "", fwidth,
"Consistency flags:",
(unsigned long) (f->shared->consist_flags));
HDfprintf(stream, "%*s%-*s %a (abs)\n", indent, "", fwidth,
"Address of boot block:", f->shared->boot_addr);
HDfprintf(stream, "%*s%-*s %a (abs)\n", indent, "", fwidth,
"Base address:", f->shared->base_addr);
HDfprintf(stream, "%*s%-*s %a (rel)\n", indent, "", fwidth,
"Free list address:", f->shared->freespace_addr);
HDfprintf(stream, "%*s%-*s %a (rel)\n", indent, "", fwidth,
"Driver information block:", f->shared->driver_addr);
HDfprintf(stream, "%*s%-*s %lu bytes\n", indent, "", fwidth,
"Size of user block:", (unsigned long) userblock_size);
HDfprintf(stream, "%*s%-*s %u bytes\n", indent, "", fwidth,
"Size of file size_t type:", (unsigned) sizeof_size);
HDfprintf(stream, "%*s%-*s %u bytes\n", indent, "", fwidth,
"Size of file haddr_t type:", (unsigned) sizeof_addr);
HDfprintf(stream, "%*s%-*s %u\n", indent, "", fwidth,
"Symbol table leaf node 1/2 rank:", sym_leaf_k);
HDfprintf(stream, "%*s%-*s %u\n", indent, "", fwidth,
"Symbol table internal node 1/2 rank:",
(unsigned) (btree_k[H5B_SNODE_ID]));
HDfprintf(stream, "%*s%-*s %u\n", indent, "", fwidth,
"Boot block version number:", (unsigned) boot_vers);
HDfprintf(stream, "%*s%-*s %u\n", indent, "", fwidth,
"Free list version number:", (unsigned) freespace_vers);
HDfprintf(stream, "%*s%-*s %u\n", indent, "", fwidth,
"Object directory version number:", (unsigned) obj_dir_vers);
HDfprintf(stream, "%*s%-*s %u\n", indent, "", fwidth,
"Shared header version number:", (unsigned) share_head_vers);
HDfprintf(stream, "%*s%-*s %s\n", indent, "", fwidth,
"Root group symbol table entry:",
f->shared->root_grp ? "" : "(none)");
if (f->shared->root_grp) {
H5G_ent_debug(f, H5G_entof(f->shared->root_grp), stream,
indent+3, MAX(0, fwidth-3), HADDR_UNDEF);
}
done:
FUNC_LEAVE(ret_value);
}
|