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
|
/****************************************************************************
* 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. *
* *
****************************************************************************/
#ifdef RCSID
static char RcsId[] = "@(#)$Revision$";
#endif
/* $Id$ */
/* Private header files */
#include <H5private.h> /* Generic Functions */
#include <H5Iprivate.h> /* IDs */
#include <H5Bprivate.h> /* B-tree subclass names */
#include <H5Dprivate.h> /* Datasets */
#include <H5Eprivate.h> /* Error handling */
#include <H5MMprivate.h> /* Memory management */
#include <H5Pprivate.h> /* Property lists */
#define PABLO_MASK H5P_mask
/* Is the interface initialized? */
static intn interface_initialize_g = 0;
#define INTERFACE_INIT H5P_init_interface
static herr_t H5P_init_interface(void);
/*--------------------------------------------------------------------------
NAME
H5P_init_interface -- Initialize interface-specific information
USAGE
herr_t H5P_init_interface()
RETURNS
Non-negative on success/Negative on failure
DESCRIPTION
Initializes any interface-specific data or routines.
--------------------------------------------------------------------------*/
static herr_t
H5P_init_interface(void)
{
herr_t ret_value = SUCCEED;
intn i;
herr_t status;
FUNC_ENTER(H5P_init_interface, FAIL);
/*
* Make sure the file creation and file access default property lists are
* initialized since this might be done at run-time instead of compile
* time.
*/
if (H5F_init()<0) {
HRETURN_ERROR (H5E_INTERNAL, H5E_CANTINIT, FAIL,
"unable to initialize H5F and H5P interfaces");
}
assert(H5P_NCLASSES <= H5I_TEMPLATE_MAX - H5I_TEMPLATE_0);
/*
* Initialize the mappings between property list classes and atom
* groups. We keep the two separate because property list classes are
* publicly visible but atom groups aren't.
*/
for (i = 0; i < H5P_NCLASSES; i++) {
status = H5I_init_group((H5I_type_t)(H5I_TEMPLATE_0 +i),
H5I_TEMPID_HASHSIZE, 0, NULL);
if (status < 0) ret_value = FAIL;
}
if (ret_value < 0) {
HRETURN_ERROR(H5E_ATOM, H5E_CANTINIT, FAIL,
"unable to initialize atom group");
}
FUNC_LEAVE(ret_value);
}
/*--------------------------------------------------------------------------
NAME
H5P_term_interface
PURPOSE
Terminate various H5P objects
USAGE
void H5P_term_interface()
RETURNS
Non-negative on success/Negative on failure
DESCRIPTION
Release the atom group and any other resources allocated.
GLOBAL VARIABLES
COMMENTS, BUGS, ASSUMPTIONS
Can't report errors...
EXAMPLES
REVISION LOG
--------------------------------------------------------------------------*/
void
H5P_term_interface(intn status)
{
intn i;
if (interface_initialize_g>0) {
for (i = 0; i < H5P_NCLASSES; i++) {
H5I_destroy_group((H5I_type_t)(H5I_TEMPLATE_0 + i));
}
}
interface_initialize_g = status;
}
/*--------------------------------------------------------------------------
NAME
H5Pcreate
PURPOSE
Returns a copy of the default property list for some class of property
* lists.
USAGE
herr_t H5Pcreate (type)
H5P_class_t type; IN: Property list class whose default is
* desired.
RETURNS
Property list ID or Negative
ERRORS
ARGS BADVALUE Unknown property list class.
ATOM CANTINIT Can't register property list.
INTERNAL UNSUPPORTED Not implemented yet.
DESCRIPTION
Returns a copy of the default property list for some class of property
* lists.
--------------------------------------------------------------------------*/
hid_t
H5Pcreate(H5P_class_t type)
{
hid_t ret_value = FAIL;
void *plist = NULL;
FUNC_ENTER(H5Pcreate, FAIL);
H5TRACE1("i","p",type);
/* Allocate a new property list and initialize it with default values */
switch (type) {
case H5P_FILE_CREATE:
if (NULL==(plist = H5MM_malloc(sizeof(H5F_create_t)))) {
HRETURN_ERROR (H5E_RESOURCE, H5E_NOSPACE, FAIL,
"memory allocation failed");
}
HDmemcpy(plist, &H5F_create_dflt, sizeof(H5F_create_t));
break;
case H5P_FILE_ACCESS:
if (NULL==(plist = H5MM_malloc(sizeof(H5F_access_t)))) {
HRETURN_ERROR (H5E_RESOURCE, H5E_NOSPACE, FAIL,
"memory allocation failed");
}
HDmemcpy(plist, &H5F_access_dflt, sizeof(H5F_access_t));
break;
case H5P_DATASET_CREATE:
if (NULL==(plist = H5MM_malloc(sizeof(H5D_create_t)))) {
HRETURN_ERROR (H5E_RESOURCE, H5E_NOSPACE, FAIL,
"memory allocation failed");
}
HDmemcpy(plist, &H5D_create_dflt, sizeof(H5D_create_t));
break;
case H5P_DATASET_XFER:
if (NULL==(plist = H5MM_malloc(sizeof(H5D_xfer_t)))) {
HRETURN_ERROR (H5E_RESOURCE, H5E_NOSPACE, FAIL,
"memory allocation failed");
}
HDmemcpy(plist, &H5D_xfer_dflt, sizeof(H5D_xfer_t));
break;
case H5P_MOUNT:
if (NULL==(plist = H5MM_malloc(sizeof(H5F_mprop_t)))) {
HRETURN_ERROR(H5E_RESOURCE, H5E_NOSPACE, FAIL,
"memory allocation failed");
}
HDmemcpy(plist, &H5F_mount_dflt, sizeof(H5F_mprop_t));
break;
default:
HRETURN_ERROR(H5E_ARGS, H5E_BADVALUE, FAIL,
"unknown property list class");
}
/* Atomize the new property list */
if ((ret_value = H5P_create(type, plist)) < 0) {
HRETURN_ERROR(H5E_ATOM, H5E_CANTINIT, FAIL,
"unable to register property list");
}
FUNC_LEAVE(ret_value);
}
/*-------------------------------------------------------------------------
* Function: H5P_create
*
* Purpose: Given a pointer to some property list struct, atomize the
* property list and return its ID. The property list memory is
* not copied, so the caller should not free it; it will be
* freed by H5P_release().
*
* Return: Success: A new property list ID.
*
* Failure: Negative
*
* Programmer: Robb Matzke
* Wednesday, December 3, 1997
*
* Modifications:
*
*-------------------------------------------------------------------------
*/
hid_t
H5P_create(H5P_class_t type, void *plist)
{
hid_t ret_value = FAIL;
FUNC_ENTER(H5P_create, FAIL);
/* check args */
assert(type >= 0 && type < H5P_NCLASSES);
assert(plist);
/* Atomize the new property list */
if ((ret_value=H5I_register((H5I_type_t)(H5I_TEMPLATE_0+type), plist))<0) {
HRETURN_ERROR(H5E_ATOM, H5E_CANTINIT, FAIL,
"unable to register property list");
}
FUNC_LEAVE(ret_value);
}
/*--------------------------------------------------------------------------
NAME
H5Pclose
PURPOSE
Release access to a property list object.
USAGE
herr_t H5Pclose(oid)
hid_t oid; IN: property list object to release access to
RETURNS
Non-negative on success/Negative on failure
DESCRIPTION
This function releases access to a property list object
--------------------------------------------------------------------------*/
herr_t
H5Pclose(hid_t plist_id)
{
H5P_class_t type;
void *plist = NULL;
FUNC_ENTER(H5Pclose, FAIL);
H5TRACE1("e","i",plist_id);
/* Check arguments */
if ((type=H5P_get_class (plist_id))<0 ||
NULL==(plist=H5I_object (plist_id))) {
HRETURN_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL, "not a property list");
}
/*
* Chuck the object! When the reference count reaches zero then
* H5I_dec_ref() removes it from the group and we should free it. The
* free function is not registered as part of the group because it takes
* an extra argument.
*/
if (0==H5I_dec_ref(plist_id)) H5P_close (type, plist);
FUNC_LEAVE (SUCCEED);
}
/*-------------------------------------------------------------------------
* Function: H5P_close
*
* Purpose: Closes a property list and frees the memory associated with
* the property list.
*
* Return: Non-negative on success/Negative on failure
*
* Programmer: Robb Matzke
* Wednesday, February 18, 1998
*
* Modifications:
*
*-------------------------------------------------------------------------
*/
herr_t
H5P_close(H5P_class_t type, void *plist)
{
H5F_access_t *fa_list = (H5F_access_t*)plist;
H5D_create_t *dc_list = (H5D_create_t*)plist;
FUNC_ENTER (H5P_close, FAIL);
/* Check args */
if (!plist) HRETURN (SUCCEED);
/* Some property lists may need to do special things */
switch (type) {
case H5P_FILE_ACCESS:
switch (fa_list->driver) {
case H5F_LOW_ERROR:
case H5F_LOW_SEC2:
case H5F_LOW_STDIO:
case H5F_LOW_CORE:
/* Nothing to do */
break;
case H5F_LOW_MPIO:
#ifdef LATER
/* Need to free the COMM and INFO objects too. */
#endif
break;
case H5F_LOW_SPLIT:
/* Free member info */
fa_list->driver = H5F_LOW_ERROR; /*prevent cycles*/
H5P_close (H5P_FILE_ACCESS, fa_list->u.split.meta_access);
H5P_close (H5P_FILE_ACCESS, fa_list->u.split.raw_access);
H5MM_xfree (fa_list->u.split.meta_ext);
H5MM_xfree (fa_list->u.split.raw_ext);
break;
case H5F_LOW_FAMILY:
/* Free member info */
H5P_close (H5P_FILE_ACCESS, fa_list->u.fam.memb_access);
break;
}
break;
case H5P_FILE_CREATE:
/*nothing to do*/
break;
case H5P_DATASET_CREATE:
H5O_reset(H5O_FILL, &(dc_list->fill));
H5O_reset(H5O_EFL, &(dc_list->efl));
H5O_reset(H5O_PLINE, &(dc_list->pline));
break;
case H5P_DATASET_XFER:
/*nothing to do*/
break;
case H5P_MOUNT:
/*nothing to do*/
break;
default:
HRETURN_ERROR (H5E_ARGS, H5E_BADTYPE, FAIL,
"unknown property list class");
}
/* Free the property list struct and return */
H5MM_xfree(plist);
FUNC_LEAVE(SUCCEED);
}
/*-------------------------------------------------------------------------
* Function: H5Pget_class
*
* Purpose: Returns the class identifier for a property list.
*
* Return: Success: A property list class
*
* Failure: H5P_NO_CLASS (-1)
*
* Programmer: Robb Matzke
* Wednesday, December 3, 1997
*
* Modifications:
*
*-------------------------------------------------------------------------
*/
H5P_class_t
H5Pget_class(hid_t plist_id)
{
H5I_type_t group;
H5P_class_t ret_value = H5P_NO_CLASS;
FUNC_ENTER(H5Pget_class, H5P_NO_CLASS);
H5TRACE1("p","i",plist_id);
if ((group = H5I_get_type(plist_id)) < 0 ||
#ifndef NDEBUG
group >= H5I_TEMPLATE_MAX ||
#endif
group < H5I_TEMPLATE_0) {
HRETURN_ERROR(H5E_ATOM, H5E_BADATOM, H5P_NO_CLASS,
"not a property list");
}
ret_value = (H5P_class_t)(group - H5I_TEMPLATE_0);
FUNC_LEAVE(ret_value);
}
/*-------------------------------------------------------------------------
* Function: H5P_get_class
*
* Purpose: Internal function for getting the property list class.
*
* Return: Success: A property list class
*
* Failure: H5P_NO_CLASS (-1)
*
* Programmer: Robb Matzke
* Tuesday, July 7, 1998
*
* Modifications:
*
*-------------------------------------------------------------------------
*/
H5P_class_t
H5P_get_class(hid_t plist_id)
{
H5I_type_t group;
H5P_class_t ret_value = H5P_NO_CLASS;
FUNC_ENTER(H5P_get_class, H5P_NO_CLASS);
if ((group = H5I_get_type(plist_id)) < 0 ||
#ifndef NDEBUG
group >= H5I_TEMPLATE_MAX ||
#endif
group < H5I_TEMPLATE_0) {
HRETURN_ERROR(H5E_ATOM, H5E_BADATOM, H5P_NO_CLASS,
"not a property list");
}
ret_value = (H5P_class_t)(group - H5I_TEMPLATE_0);
FUNC_LEAVE(ret_value);
}
/*-------------------------------------------------------------------------
* Function: H5Pget_version
*
* Purpose: Retrieves version information for various parts of a file.
*
* BOOT: The file boot block.
* HEAP: The global heap.
* FREELIST: The global free list.
* STAB: The root symbol table entry.
* SHHDR: Shared object headers.
*
* Any (or even all) of the output arguments can be null
* pointers.
*
* Return: Success: Non-negative, version information is returned
* through the arguments.
*
* Failure: Negative
*
* Programmer: Robb Matzke
* Wednesday, January 7, 1998
*
* Modifications:
*
*-------------------------------------------------------------------------
*/
herr_t
H5Pget_version(hid_t plist_id, int *boot/*out*/, int *freelist/*out*/,
int *stab/*out*/, int *shhdr/*out*/)
{
H5F_create_t *plist = NULL;
FUNC_ENTER(H5Pget_version, FAIL);
H5TRACE5("e","ixxxx",plist_id,boot,freelist,stab,shhdr);
/* Check arguments */
if (H5P_FILE_CREATE != H5P_get_class(plist_id) ||
NULL == (plist = H5I_object(plist_id))) {
HRETURN_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL,
"not a file creation property list");
}
/* Get values */
if (boot) *boot = plist->bootblock_ver;
if (freelist) *freelist = plist->freespace_ver;
if (stab) *stab = plist->objectdir_ver;
if (shhdr) *shhdr = plist->sharedheader_ver;
FUNC_LEAVE(SUCCEED);
}
/*-------------------------------------------------------------------------
* Function: H5Pset_userblock
*
* Purpose: Sets the userblock size field of a file creation property
* list.
*
* Return: Non-negative on success/Negative on failure
*
* Programmer: Robb Matzke
* Tuesday, January 6, 1998
*
* Modifications:
*
*-------------------------------------------------------------------------
*/
herr_t
H5Pset_userblock(hid_t plist_id, hsize_t size)
{
uintn i;
H5F_create_t *plist = NULL;
FUNC_ENTER(H5Pset_userblock, FAIL);
H5TRACE2("e","ih",plist_id,size);
/* Check arguments */
if (H5P_FILE_CREATE != H5P_get_class(plist_id) ||
NULL == (plist = H5I_object(plist_id))) {
HRETURN_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL,
"not a file creation property list");
}
for (i=8; i<8*sizeof(hsize_t); i++) {
hsize_t p2 = 8==i ? 0 : ((hsize_t)1<<i);
if (size == p2) break;
}
if (i>=8*sizeof(hsize_t)) {
HRETURN_ERROR(H5E_ARGS, H5E_BADVALUE, FAIL,
"userblock size is not valid");
}
/* Set value */
plist->userblock_size = size;
FUNC_LEAVE(SUCCEED);
}
/*-------------------------------------------------------------------------
* Function: H5Pget_userblock
*
* Purpose: Queries the size of a user block in a file creation property
* list.
*
* Return: Success: Non-negative, size returned through SIZE argument.
*
* Failure: Negative
*
* Programmer: Robb Matzke
* Wednesday, January 7, 1998
*
* Modifications:
*
*-------------------------------------------------------------------------
*/
herr_t
H5Pget_userblock(hid_t plist_id, hsize_t *size)
{
H5F_create_t *plist = NULL;
FUNC_ENTER(H5Pget_userblock, FAIL);
H5TRACE2("e","i*h",plist_id,size);
/* Check args */
if (H5P_FILE_CREATE != H5P_get_class(plist_id) ||
NULL == (plist = H5I_object(plist_id))) {
HRETURN_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL,
"not a file creation property list");
}
/* Get value */
if (size) *size = plist->userblock_size;
FUNC_LEAVE(SUCCEED);
}
/*-------------------------------------------------------------------------
* Function: H5Pset_alignment
*
* Purpose: Sets the alignment properties of a file access property list
* so that any file object >= THRESHOLD bytes will be aligned on
* an address which is a multiple of ALIGNMENT. The addresses
* are relative to the end of the user block; the alignment is
* calculated by subtracting the user block size from the
* absolute file address and then adjusting the address to be a
* multiple of ALIGNMENT.
*
* Default values for THRESHOLD and ALIGNMENT are one, implying
* no alignment. Generally the default values will result in
* the best performance for single-process access to the file.
* For MPI-IO and other parallel systems, choose an alignment
* which is a multiple of the disk block size.
*
* Return: Non-negative on success/Negative on failure
*
* Programmer: Robb Matzke
* Tuesday, June 9, 1998
*
* Modifications:
*
*-------------------------------------------------------------------------
*/
herr_t
H5Pset_alignment(hid_t fapl_id, hsize_t threshold, hsize_t alignment)
{
H5F_access_t *fapl = NULL;
FUNC_ENTER (H5Pset_alignment, FAIL);
H5TRACE3("e","ihh",fapl_id,threshold,alignment);
/* Check args */
if (H5P_FILE_ACCESS != H5P_get_class (fapl_id) ||
NULL == (fapl = H5I_object (fapl_id))) {
HRETURN_ERROR (H5E_ARGS, H5E_BADTYPE, FAIL,
"not a file access property list");
}
if (alignment<1) {
HRETURN_ERROR (H5E_ARGS, H5E_BADVALUE, FAIL,
"alignment must be positive");
}
/* Set values */
fapl->threshold = threshold;
fapl->alignment = alignment;
FUNC_LEAVE (SUCCEED);
}
/*-------------------------------------------------------------------------
* Function: H5Pget_alignment
*
* Purpose: Returns the current settings for alignment properties from a
* file access property list. The THRESHOLD and/or ALIGNMENT
* pointers may be null pointers.
*
* Return: Non-negative on success/Negative on failure
*
* Programmer: Robb Matzke
* Tuesday, June 9, 1998
*
* Modifications:
*
*-------------------------------------------------------------------------
*/
herr_t
H5Pget_alignment(hid_t fapl_id, hsize_t *threshold/*out*/,
hsize_t *alignment/*out*/)
{
H5F_access_t *fapl = NULL;
FUNC_ENTER (H5Pget_alignment, FAIL);
H5TRACE3("e","ixx",fapl_id,threshold,alignment);
/* Check args */
if (H5P_FILE_ACCESS != H5P_get_class (fapl_id) ||
NULL == (fapl = H5I_object (fapl_id))) {
HRETURN_ERROR (H5E_ARGS, H5E_BADTYPE, FAIL,
"not a file access property list");
}
/* Get values */
if (threshold) *threshold = fapl->threshold;
if (alignment) *alignment = fapl->alignment;
FUNC_LEAVE (SUCCEED);
}
/*-------------------------------------------------------------------------
* Function: H5Pset_sizes
*
* Purpose: Sets file size-of addresses and sizes. PLIST_ID should be a
* file creation property list. A value of zero causes the
* property to not change.
*
* Return: Non-negative on success/Negative on failure
*
* Programmer: Robb Matzke
* Tuesday, January 6, 1998
*
* Modifications:
*
*-------------------------------------------------------------------------
*/
herr_t
H5Pset_sizes(hid_t plist_id, size_t sizeof_addr, size_t sizeof_size)
{
H5F_create_t *plist = NULL;
FUNC_ENTER(H5Pset_sizeof_addr, FAIL);
H5TRACE3("e","izz",plist_id,sizeof_addr,sizeof_size);
/* Check arguments */
if (H5P_FILE_CREATE != H5P_get_class(plist_id) ||
NULL == (plist = H5I_object(plist_id))) {
HRETURN_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL,
"not a file creation property list");
}
if (sizeof_addr) {
if (sizeof_addr != 2 && sizeof_addr != 4 &&
sizeof_addr != 8 && sizeof_addr != 16) {
HRETURN_ERROR(H5E_ARGS, H5E_BADVALUE, FAIL,
"file haddr_t size is not valid");
}
}
if (sizeof_size) {
if (sizeof_size != 2 && sizeof_size != 4 &&
sizeof_size != 8 && sizeof_size != 16) {
HRETURN_ERROR(H5E_ARGS, H5E_BADVALUE, FAIL,
"file size_t size is not valid");
}
}
/* Set value */
if (sizeof_addr)
plist->sizeof_addr = sizeof_addr;
if (sizeof_size)
plist->sizeof_size = sizeof_size;
FUNC_LEAVE(SUCCEED);
}
/*-------------------------------------------------------------------------
* Function: H5Pget_sizes
*
* Purpose: Returns the size of address and size quantities stored in a
* file according to a file creation property list. Either (or
* even both) SIZEOF_ADDR and SIZEOF_SIZE may be null pointers.
*
* Return: Success: Non-negative, sizes returned through arguments.
*
* Failure: Negative
*
* Programmer: Robb Matzke
* Wednesday, January 7, 1998
*
* Modifications:
*
*-------------------------------------------------------------------------
*/
herr_t
H5Pget_sizes(hid_t plist_id,
size_t *sizeof_addr /*out */ , size_t *sizeof_size /*out */ )
{
H5F_create_t *plist = NULL;
FUNC_ENTER(H5Pget_sizes, FAIL);
H5TRACE3("e","ixx",plist_id,sizeof_addr,sizeof_size);
/* Check args */
if (H5P_FILE_CREATE != H5P_get_class(plist_id) ||
NULL == (plist = H5I_object(plist_id))) {
HRETURN_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL,
"not a file creation property list");
}
/* Get values */
if (sizeof_addr)
*sizeof_addr = plist->sizeof_addr;
if (sizeof_size)
*sizeof_size = plist->sizeof_size;
FUNC_LEAVE(SUCCEED);
}
/*-------------------------------------------------------------------------
* Function: H5Pset_sym_k
*
* Purpose: IK is one half the rank of a tree that stores a symbol
* table for a group. Internal nodes of the symbol table are on
* average 75% full. That is, the average rank of the tree is
* 1.5 times the value of IK.
*
* LK is one half of the number of symbols that can be stored in
* a symbol table node. A symbol table node is the leaf of a
* symbol table tree which is used to store a group. When
* symbols are inserted randomly into a group, the group's
* symbol table nodes are 75% full on average. That is, they
* contain 1.5 times the number of symbols specified by LK.
*
* Either (or even both) of IK and LK can be zero in which case
* that value is left unchanged.
*
* Return: Non-negative on success/Negative on failure
*
* Programmer: Robb Matzke
* Tuesday, January 6, 1998
*
* Modifications:
*
*-------------------------------------------------------------------------
*/
herr_t
H5Pset_sym_k(hid_t plist_id, int ik, int lk)
{
H5F_create_t *plist = NULL;
FUNC_ENTER(H5Pset_sym_k, FAIL);
H5TRACE3("e","iIsIs",plist_id,ik,lk);
/* Check arguments */
if (H5P_FILE_CREATE != H5P_get_class(plist_id) ||
NULL == (plist = H5I_object(plist_id))) {
HRETURN_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL,
"not a file creation property list");
}
/* Set values */
if (ik > 0) {
plist->btree_k[H5B_SNODE_ID] = ik;
}
if (lk > 0) {
plist->sym_leaf_k = lk;
}
FUNC_LEAVE(SUCCEED);
}
/*-------------------------------------------------------------------------
* Function: H5Pget_sym_k
*
* Purpose: Retrieves the symbol table B-tree 1/2 rank (IK) and the
* symbol table leaf node 1/2 size (LK). See H5Pset_sym_k() for
* details. Either (or even both) IK and LK may be null
* pointers.
*
* Return: Non-negative on success/Negative on failure
*
* Programmer: Robb Matzke
* Wednesday, January 7, 1998
*
* Modifications:
*
*-------------------------------------------------------------------------
*/
herr_t
H5Pget_sym_k(hid_t plist_id, int *ik /*out */ , int *lk /*out */ )
{
H5F_create_t *plist = NULL;
FUNC_ENTER(H5Pget_sym_k, FAIL);
H5TRACE3("e","ixx",plist_id,ik,lk);
/* Check arguments */
if (H5P_FILE_CREATE != H5P_get_class(plist_id) ||
NULL == (plist = H5I_object(plist_id))) {
HRETURN_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL,
"not a file creation property list");
}
/* Get values */
if (ik)
*ik = plist->btree_k[H5B_SNODE_ID];
if (lk)
*lk = plist->sym_leaf_k;
FUNC_LEAVE(SUCCEED);
}
/*-------------------------------------------------------------------------
* Function: H5Pset_istore_k
*
* Purpose: IK is one half the rank of a tree that stores chunked raw
* data. On average, such a tree will be 75% full, or have an
* average rank of 1.5 times the value of IK.
*
* Return: Non-negative on success/Negative on failure
*
* Programmer: Robb Matzke
* Tuesday, January 6, 1998
*
* Modifications:
*
*-------------------------------------------------------------------------
*/
herr_t
H5Pset_istore_k(hid_t plist_id, int ik)
{
H5F_create_t *plist = NULL;
FUNC_ENTER(H5Pset_istore_k, FAIL);
H5TRACE2("e","iIs",plist_id,ik);
/* Check arguments */
if (H5P_FILE_CREATE != H5P_get_class(plist_id) ||
NULL == (plist = H5I_object(plist_id))) {
HRETURN_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL,
"not a file creation property list");
}
if (ik <= 0) {
HRETURN_ERROR(H5E_ARGS, H5E_BADVALUE, FAIL,
"istore IK value must be positive");
}
/* Set value */
plist->btree_k[H5B_ISTORE_ID] = ik;
FUNC_LEAVE(SUCCEED);
}
/*-------------------------------------------------------------------------
* Function: H5Pget_istore_k
*
* Purpose: Queries the 1/2 rank of an indexed storage B-tree. See
* H5Pset_istore_k() for details. The argument IK may be the
* null pointer.
*
* Return: Success: Non-negative, size returned through IK
*
* Failure: Negative
*
* Programmer: Robb Matzke
* Wednesday, January 7, 1998
*
* Modifications:
*
*-------------------------------------------------------------------------
*/
herr_t
H5Pget_istore_k(hid_t plist_id, int *ik /*out */ )
{
H5F_create_t *plist = NULL;
FUNC_ENTER(H5Pget_istore_k, FAIL);
H5TRACE2("e","ix",plist_id,ik);
/* Check arguments */
if (H5P_FILE_CREATE != H5P_get_class(plist_id) ||
NULL == (plist = H5I_object(plist_id))) {
HRETURN_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL,
"not a file creation property list");
}
/* Get value */
if (ik)
*ik = plist->btree_k[H5B_ISTORE_ID];
FUNC_LEAVE(SUCCEED);
}
/*-------------------------------------------------------------------------
* Function: H5Pset_layout
*
* Purpose: Sets the layout of raw data in the file.
*
* Return: Non-negative on success/Negative on failure
*
* Programmer: Robb Matzke
* Tuesday, January 6, 1998
*
* Modifications:
*
*-------------------------------------------------------------------------
*/
herr_t
H5Pset_layout(hid_t plist_id, H5D_layout_t layout)
{
H5D_create_t *plist = NULL;
FUNC_ENTER(H5Pset_layout, FAIL);
H5TRACE2("e","iDl",plist_id,layout);
/* Check arguments */
if (H5P_DATASET_CREATE != H5P_get_class(plist_id) ||
NULL == (plist = H5I_object(plist_id))) {
HRETURN_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL,
"not a dataset creation property list");
}
if (layout < 0 || layout >= H5D_NLAYOUTS) {
HRETURN_ERROR(H5E_ARGS, H5E_BADRANGE, FAIL,
"raw data layout method is not valid");
}
/* Set value */
plist->layout = layout;
FUNC_LEAVE(SUCCEED);
}
/*-------------------------------------------------------------------------
* Function: H5Pget_layout
*
* Purpose: Retrieves layout type of a dataset creation property list.
*
* Return: Success: The layout type
*
* Failure: H5D_LAYOUT_ERROR (negative)
*
* Programmer: Robb Matzke
* Wednesday, January 7, 1998
*
* Modifications:
*
*-------------------------------------------------------------------------
*/
H5D_layout_t
H5Pget_layout(hid_t plist_id)
{
H5D_create_t *plist = NULL;
FUNC_ENTER(H5Pget_layout, H5D_LAYOUT_ERROR);
H5TRACE1("Dl","i",plist_id);
/* Check arguments */
if (H5P_DATASET_CREATE != H5P_get_class(plist_id) ||
NULL == (plist = H5I_object(plist_id))) {
HRETURN_ERROR(H5E_ARGS, H5E_BADTYPE, H5D_LAYOUT_ERROR,
"not a dataset creation property list");
}
FUNC_LEAVE(plist->layout);
}
/*-------------------------------------------------------------------------
* Function: H5Pset_chunk
*
* Purpose: Sets the number of dimensions and the size of each chunk to
* the values specified. The dimensionality of the chunk should
* match the dimensionality of the data space.
*
* As a side effect, the layout method is changed to
* H5D_CHUNKED.
*
* Return: Non-negative on success/Negative on failure
*
* Programmer: Robb Matzke
* Tuesday, January 6, 1998
*
* Modifications:
*
*-------------------------------------------------------------------------
*/
herr_t
H5Pset_chunk(hid_t plist_id, int ndims, const hsize_t dim[/*ndims*/])
{
int i;
H5D_create_t *plist = NULL;
FUNC_ENTER(H5Pset_chunk, FAIL);
H5TRACE3("e","iIs*[a1]h",plist_id,ndims,dim);
/* Check arguments */
if (H5P_DATASET_CREATE != H5P_get_class(plist_id) ||
NULL == (plist = H5I_object(plist_id))) {
HRETURN_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL,
"not a dataset creation property list");
}
if (ndims <= 0) {
HRETURN_ERROR(H5E_ARGS, H5E_BADRANGE, FAIL,
"chunk dimensionality must be positive");
}
if (ndims > H5S_MAX_RANK) {
HRETURN_ERROR(H5E_ARGS, H5E_BADRANGE, FAIL,
"chunk dimensionality is too large");
}
if (!dim) {
HRETURN_ERROR(H5E_ARGS, H5E_BADVALUE, FAIL,
"no chunk dimensions specified");
}
for (i=0; i<ndims; i++) {
if (dim[i] <= 0) {
HRETURN_ERROR(H5E_ARGS, H5E_BADRANGE, FAIL,
"all chunk dimensions must be positive");
}
}
/* Set value */
plist->layout = H5D_CHUNKED;
plist->chunk_ndims = ndims;
for (i = 0; i < ndims; i++) {
plist->chunk_size[i] = dim[i];
}
FUNC_LEAVE(SUCCEED);
}
/*-------------------------------------------------------------------------
* Function: H5Pget_chunk
*
* Purpose: Retrieves the chunk size of chunked layout. The chunk
* dimensionality is returned and the chunk size in each
* dimension is returned through the DIM argument. At most
* MAX_NDIMS elements of DIM will be initialized.
*
* Return: Success: Positive Chunk dimensionality.
*
* Failure: Negative
*
* Programmer: Robb Matzke
* Wednesday, January 7, 1998
*
* Modifications:
*
*-------------------------------------------------------------------------
*/
int
H5Pget_chunk(hid_t plist_id, int max_ndims, hsize_t dim[]/*out*/)
{
int i;
H5D_create_t *plist = NULL;
FUNC_ENTER(H5Pget_chunk, FAIL);
H5TRACE3("Is","iIsx",plist_id,max_ndims,dim);
/* Check arguments */
if (H5P_DATASET_CREATE != H5P_get_class(plist_id) ||
NULL == (plist = H5I_object(plist_id))) {
HRETURN_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL,
"not a dataset creation property list");
}
if (H5D_CHUNKED != plist->layout) {
HRETURN_ERROR(H5E_ARGS, H5E_BADVALUE, FAIL,
"not a chunked storage layout");
}
for (i=0; i<plist->chunk_ndims && i<max_ndims && dim; i++) {
dim[i] = plist->chunk_size[i];
}
FUNC_LEAVE(plist->chunk_ndims);
}
/*-------------------------------------------------------------------------
* Function: H5Pset_external
*
* Purpose: Adds an external file to the list of external files. PLIST_ID
* should be an object ID for a dataset creation property list.
* NAME is the name of an external file, OFFSET is the location
* where the data starts in that file, and SIZE is the number of
* bytes reserved in the file for the data.
*
* If a dataset is split across multiple files then the files
* should be defined in order. The total size of the dataset is
* the sum of the SIZE arguments for all the external files. If
* the total size is larger than the size of a dataset then the
* dataset can be extended (provided the data space also allows
* the extending).
*
* Return: Non-negative on success/Negative on failure
*
* Programmer: Robb Matzke
* Tuesday, March 3, 1998
*
* Modifications:
*
*-------------------------------------------------------------------------
*/
herr_t
H5Pset_external(hid_t plist_id, const char *name, off_t offset, hsize_t size)
{
int idx;
size_t total, tmp;
H5D_create_t *plist = NULL;
FUNC_ENTER(H5Pset_external, FAIL);
H5TRACE4("e","isoh",plist_id,name,offset,size);
/* Check arguments */
if (H5P_DATASET_CREATE != H5P_get_class(plist_id) ||
NULL == (plist = H5I_object(plist_id))) {
HRETURN_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL,
"not a dataset creation property list");
}
if (!name || !*name) {
HRETURN_ERROR (H5E_ARGS, H5E_BADVALUE, FAIL,
"no name given");
}
if (offset<0) {
HRETURN_ERROR (H5E_ARGS, H5E_BADVALUE, FAIL,
"negative external file offset");
}
if (size<=0) {
HRETURN_ERROR (H5E_ARGS, H5E_BADVALUE, FAIL,
"zero size");
}
if (plist->efl.nused>0 &&
H5O_EFL_UNLIMITED==plist->efl.slot[plist->efl.nused-1].size) {
HRETURN_ERROR (H5E_ARGS, H5E_BADVALUE, FAIL,
"previous file size is unlimited");
}
if (H5O_EFL_UNLIMITED!=size) {
for (idx=0, total=size; idx<plist->efl.nused; idx++, total=tmp) {
tmp = total + plist->efl.slot[idx].size;
if (tmp <= total) {
HRETURN_ERROR (H5E_EFL, H5E_OVERFLOW, FAIL,
"total external data size overflowed");
}
}
}
/* Add to the list */
if (plist->efl.nused>=plist->efl.nalloc) {
intn na = plist->efl.nalloc + H5O_EFL_ALLOC;
H5O_efl_entry_t *x = H5MM_realloc (plist->efl.slot,
na*sizeof(H5O_efl_entry_t));
if (!x) {
HRETURN_ERROR (H5E_RESOURCE, H5E_NOSPACE, FAIL,
"memory allocation failed");
}
plist->efl.nalloc = na;
plist->efl.slot = x;
}
idx = plist->efl.nused;
plist->efl.slot[idx].name_offset = 0; /*not entered into heap yet*/
plist->efl.slot[idx].name = H5MM_xstrdup (name);
plist->efl.slot[idx].offset = offset;
plist->efl.slot[idx].size = size;
plist->efl.nused++;
FUNC_LEAVE(SUCCEED);
}
/*-------------------------------------------------------------------------
* Function: H5Pget_external_count
*
* Purpose: Returns the number of external files for this dataset.
*
* Return: Success: Number of external files
*
* Failure: Negative
*
* Programmer: Robb Matzke
* Tuesday, March 3, 1998
*
* Modifications:
*
*-------------------------------------------------------------------------
*/
int
H5Pget_external_count(hid_t plist_id)
{
H5D_create_t *plist = NULL;
FUNC_ENTER (H5Pget_external_count, FAIL);
H5TRACE1("Is","i",plist_id);
/* Check arguments */
if (H5P_DATASET_CREATE != H5P_get_class(plist_id) ||
NULL == (plist = H5I_object(plist_id))) {
HRETURN_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL,
"not a dataset creation property list");
}
/* Return */
FUNC_LEAVE (plist->efl.nused);
}
/*-------------------------------------------------------------------------
* Function: H5Pget_external
*
* Purpose: Returns information about an external file. External files
* are numbered from zero to N-1 where N is the value returned
* by H5Pget_external_count(). At most NAME_SIZE characters are
* copied into the NAME array. If the external file name is
* longer than NAME_SIZE with the null terminator, then the
* return value is not null terminated (similar to strncpy()).
*
* If NAME_SIZE is zero or NAME is the null pointer then the
* external file name is not returned. If OFFSET or SIZE are
* null pointers then the corresponding information is not
* returned.
*
* See Also: H5Pset_external()
*
* Return: Non-negative on success/Negative on failure
*
* Programmer: Robb Matzke
* Tuesday, March 3, 1998
*
* Modifications:
*
*-------------------------------------------------------------------------
*/
herr_t
H5Pget_external(hid_t plist_id, int idx, size_t name_size, char *name/*out*/,
off_t *offset/*out*/, hsize_t *size/*out*/)
{
H5D_create_t *plist = NULL;
FUNC_ENTER (H5Pget_external, FAIL);
H5TRACE6("e","iIszxxx",plist_id,idx,name_size,name,offset,size);
/* Check arguments */
if (H5P_DATASET_CREATE != H5P_get_class(plist_id) ||
NULL == (plist = H5I_object(plist_id))) {
HRETURN_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL,
"not a dataset creation property list");
}
if (idx<0 || idx>=plist->efl.nused) {
HRETURN_ERROR (H5E_ARGS, H5E_BADRANGE, FAIL,
"external file index is out of range");
}
/* Return values */
if (name_size>0 && name) {
HDstrncpy (name, plist->efl.slot[idx].name, name_size);
}
if (offset) *offset = plist->efl.slot[idx].offset;
if (size) *size = plist->efl.slot[idx].size;
FUNC_LEAVE (SUCCEED);
}
/*-------------------------------------------------------------------------
* Function: H5Pget_driver
*
* Purpose: Return the ID of the low-level file driver. PLIST_ID should
* be a file access property list.
*
* Return: Success: A low-level driver ID
*
* Failure: H5F_LOW_ERROR (a negative value)
*
* Programmer: Robb Matzke
* Thursday, February 26, 1998
*
* Modifications:
*
*-------------------------------------------------------------------------
*/
H5F_driver_t
H5Pget_driver(hid_t plist_id)
{
H5F_access_t *plist = NULL;
FUNC_ENTER (H5Pget_driver, H5F_LOW_ERROR);
H5TRACE1("Fd","i",plist_id);
/* Check arguments */
if (H5P_FILE_ACCESS != H5P_get_class (plist_id) ||
NULL == (plist = H5I_object (plist_id))) {
HRETURN_ERROR (H5E_ARGS, H5E_BADTYPE, H5F_LOW_ERROR,
"not a file access property list");
}
FUNC_LEAVE (plist->driver);
}
/*-------------------------------------------------------------------------
* Function: H5Pset_stdio
*
* Purpose: Set the low level file driver to use the functions declared
* in the stdio.h file: fopen(), fseek() or fseek64(), fread(),
* fwrite(), and fclose().
*
* Return: Non-negative on success/Negative on failure
*
* Programmer: Robb Matzke
* Thursday, February 19, 1998
*
* Modifications:
*
*-------------------------------------------------------------------------
*/
herr_t
H5Pset_stdio(hid_t plist_id)
{
H5F_access_t *plist = NULL;
FUNC_ENTER (H5Pset_stdio, FAIL);
H5TRACE1("e","i",plist_id);
/* Check arguments */
if (H5P_FILE_ACCESS != H5P_get_class(plist_id) ||
NULL == (plist = H5I_object(plist_id))) {
HRETURN_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL,
"not a file access property list");
}
/* Set driver */
plist->driver = H5F_LOW_STDIO;
FUNC_LEAVE (SUCCEED);
}
/*-------------------------------------------------------------------------
* Function: H5Pget_stdio
*
* Purpose: If the file access property list is set to the stdio driver
* then this function returns zero; otherwise it returns a
* negative value. In the future, additional arguments may be
* added to this function to match those added to H5Pset_stdio().
*
* Return: Non-negative on success/Negative on failure
*
* Programmer: Robb Matzke
* Thursday, February 26, 1998
*
* Modifications:
*
*-------------------------------------------------------------------------
*/
herr_t
H5Pget_stdio(hid_t plist_id)
{
H5F_access_t *plist = NULL;
FUNC_ENTER (H5Pget_stdio, FAIL);
H5TRACE1("e","i",plist_id);
/* Check arguments */
if (H5P_FILE_ACCESS != H5P_get_class (plist_id) ||
NULL == (plist = H5I_object (plist_id))) {
HRETURN_ERROR (H5E_ARGS, H5E_BADTYPE, FAIL,
"not a file access property list");
}
if (H5F_LOW_STDIO != plist->driver) {
HRETURN_ERROR (H5E_ARGS, H5E_BADVALUE, FAIL,
"the stdio driver is not set");
}
FUNC_LEAVE (SUCCEED);
}
/*-------------------------------------------------------------------------
* Function: H5Pset_sec2
*
* Purpose: Set the low-level file driver to use the functions declared
* in the unistd.h file: open(), lseek() or lseek64(), read(),
* write(), and close().
*
* Return: Non-negative on success/Negative on failure
*
* Programmer: Robb Matzke
* Thursday, February 19, 1998
*
* Modifications:
*
*-------------------------------------------------------------------------
*/
herr_t
H5Pset_sec2(hid_t plist_id)
{
H5F_access_t *plist = NULL;
FUNC_ENTER (H5Pset_sec2, FAIL);
H5TRACE1("e","i",plist_id);
/* Check arguments */
if (H5P_FILE_ACCESS != H5P_get_class(plist_id) ||
NULL == (plist = H5I_object(plist_id))) {
HRETURN_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL,
"not a file access property list");
}
/* Set driver */
plist->driver = H5F_LOW_SEC2;
FUNC_LEAVE (SUCCEED);
}
/*-------------------------------------------------------------------------
* Function: H5Pget_sec2
*
* Purpose: If the file access property list is set to the sec2 driver
* then this function returns zero; otherwise it returns a
* negative value. In the future, additional arguments may be
* added to this function to match those added to H5Pset_sec2().
*
* Return: Non-negative on success/Negative on failure
*
* Programmer: Robb Matzke
* Thursday, February 26, 1998
*
* Modifications:
*
*-------------------------------------------------------------------------
*/
herr_t
H5Pget_sec2(hid_t plist_id)
{
H5F_access_t *plist = NULL;
FUNC_ENTER (H5Pget_sec2, FAIL);
H5TRACE1("e","i",plist_id);
/* Check arguments */
if (H5P_FILE_ACCESS != H5P_get_class (plist_id) ||
NULL == (plist = H5I_object (plist_id))) {
HRETURN_ERROR (H5E_ARGS, H5E_BADTYPE, FAIL,
"not a file access property list");
}
if (H5F_LOW_SEC2 != plist->driver) {
HRETURN_ERROR (H5E_ARGS, H5E_BADVALUE, FAIL,
"the sec2 driver is not set");
}
FUNC_LEAVE (SUCCEED);
}
/*-------------------------------------------------------------------------
* Function: H5Pset_core
*
* Purpose: Set the low-level file driver to use malloc() and free().
* This driver is restricted to temporary files which are not
* larger than the amount of virtual memory available. The
* INCREMENT argument determines the file block size and memory
* will be allocated in multiples of INCREMENT bytes. A liberal
* INCREMENT results in fewer calls to realloc() and probably
* less memory fragmentation.
*
* Return: Non-negative on success/Negative on failure
*
* Programmer: Robb Matzke
* Thursday, February 19, 1998
*
* Modifications:
*
*-------------------------------------------------------------------------
*/
herr_t
H5Pset_core(hid_t plist_id, size_t increment)
{
H5F_access_t *plist = NULL;
FUNC_ENTER (H5Pset_core, FAIL);
H5TRACE2("e","iz",plist_id,increment);
/* Check arguments */
if (H5P_FILE_ACCESS != H5P_get_class(plist_id) ||
NULL == (plist = H5I_object(plist_id))) {
HRETURN_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL,
"not a file access property list");
}
if (increment<1) {
HRETURN_ERROR (H5E_ARGS, H5E_BADVALUE, FAIL,
"increment must be positive");
}
/* Set driver */
plist->driver = H5F_LOW_CORE;
plist->u.core.increment = increment;
FUNC_LEAVE (SUCCEED);
}
/*-------------------------------------------------------------------------
* Function: H5Pget_core
*
* Purpose: If the file access property list is set to the core driver
* then this function returns zero; otherwise it returns a
* negative value. On success, the block size is returned
* through the INCREMENT argument if it isn't the null pointer.
* In the future, additional arguments may be added to this
* function to match those added to H5Pset_core().
*
* Return: Non-negative on success/Negative on failure
*
* Programmer: Robb Matzke
* Thursday, February 26, 1998
*
* Modifications:
*
*-------------------------------------------------------------------------
*/
herr_t
H5Pget_core(hid_t plist_id, size_t *increment/*out*/)
{
H5F_access_t *plist = NULL;
FUNC_ENTER (H5Pget_core, FAIL);
H5TRACE2("e","ix",plist_id,increment);
/* Check arguments */
if (H5P_FILE_ACCESS != H5P_get_class (plist_id) ||
NULL == (plist = H5I_object (plist_id))) {
HRETURN_ERROR (H5E_ARGS, H5E_BADTYPE, FAIL,
"not a file access property list");
}
if (H5F_LOW_CORE != plist->driver) {
HRETURN_ERROR (H5E_ARGS, H5E_BADVALUE, FAIL,
"the core driver is not set");
}
/* Return values */
if (increment) {
*increment = plist->u.core.increment;
}
FUNC_LEAVE (SUCCEED);
}
/*-------------------------------------------------------------------------
* Function: H5Pset_split
*
* Purpose: Set the low-level driver to split meta data from raw data,
* storing meta data in one file and raw data in another file.
*
* Return: Non-negative on success/Negative on failure
*
* Programmer: Robb Matzke
* Thursday, February 19, 1998
*
* Modifications:
*
*-------------------------------------------------------------------------
*/
herr_t
H5Pset_split(hid_t plist_id, const char *meta_ext, hid_t meta_plist_id,
const char *raw_ext, hid_t raw_plist_id)
{
H5F_access_t *plist = NULL;
H5F_access_t *meta_plist = &H5F_access_dflt;
H5F_access_t *raw_plist = &H5F_access_dflt;
FUNC_ENTER (H5Pset_split, FAIL);
H5TRACE5("e","isisi",plist_id,meta_ext,meta_plist_id,raw_ext,raw_plist_id);
/* Check arguments */
if (H5P_FILE_ACCESS != H5P_get_class(plist_id) ||
NULL == (plist = H5I_object(plist_id))) {
HRETURN_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL,
"not a file access property list");
}
if (H5P_DEFAULT!=meta_plist_id &&
(H5P_FILE_ACCESS != H5P_get_class(meta_plist_id) ||
NULL == (meta_plist = H5I_object(meta_plist_id)))) {
HRETURN_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL,
"not a file access property list");
}
if (H5P_DEFAULT!=raw_plist_id &&
(H5P_FILE_ACCESS != H5P_get_class(raw_plist_id) ||
NULL == (raw_plist = H5I_object(raw_plist_id)))) {
HRETURN_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL,
"not a file access property list");
}
/* Set driver */
plist->driver = H5F_LOW_SPLIT;
plist->u.split.meta_access = H5P_copy (H5P_FILE_ACCESS, meta_plist);
plist->u.split.raw_access = H5P_copy (H5P_FILE_ACCESS, raw_plist);
plist->u.split.meta_ext = H5MM_xstrdup (meta_ext);
plist->u.split.raw_ext = H5MM_xstrdup (raw_ext);
FUNC_LEAVE (SUCCEED);
}
/*-------------------------------------------------------------------------
* Function: H5Pget_split
*
* Purpose: If the file access property list is set to the sec2 driver
* then this function returns zero; otherwise it returns a
* negative value. On success, at most META_EXT_SIZE characters
* are copied to the META_EXT buffer if non-null and at most
* RAW_EXT_SIZE characters are copied to the RAW_EXT buffer if
* non-null. If the actual extension is larger than the number
* of characters requested then the buffer will not be null
* terminated (that is, behavior like strncpy()). In addition,
* if META_PROPERTIES and/or RAW_PROPERTIES are non-null then
* the file access property list of the meta file and/or raw
* file is copied and its OID returned through these arguments.
* In the future, additional arguments may be added to this
* function to match those added to H5Pset_sec2().
*
* Return: Non-negative on success/Negative on failure
*
* Programmer: Robb Matzke
* Thursday, February 26, 1998
*
* Modifications:
*
*-------------------------------------------------------------------------
*/
herr_t
H5Pget_split(hid_t plist_id, size_t meta_ext_size, char *meta_ext/*out*/,
hid_t *meta_properties/*out*/, size_t raw_ext_size,
char *raw_ext/*out*/, hid_t *raw_properties/*out*/)
{
H5F_access_t *plist = NULL;
FUNC_ENTER (H5Pget_split, FAIL);
H5TRACE7("e","izxxzxx",plist_id,meta_ext_size,meta_ext,meta_properties,
raw_ext_size,raw_ext,raw_properties);
/* Check arguments */
if (H5P_FILE_ACCESS != H5P_get_class (plist_id) ||
NULL == (plist = H5I_object (plist_id))) {
HRETURN_ERROR (H5E_ARGS, H5E_BADTYPE, FAIL,
"not a file access property list");
}
if (H5F_LOW_SPLIT != plist->driver) {
HRETURN_ERROR (H5E_ARGS, H5E_BADVALUE, FAIL,
"the split driver is not set");
}
/* Reset output args for error handling */
if (meta_ext && meta_ext_size>0) *meta_ext = '\0';
if (raw_ext && raw_ext_size>0) *raw_ext = '\0';
if (meta_properties) *meta_properties = FAIL;
if (raw_properties) *raw_properties = FAIL;
/* Output arguments */
if (meta_ext && meta_ext_size>0) {
if (plist->u.split.meta_ext) {
HDstrncpy (meta_ext, plist->u.split.meta_ext, meta_ext_size);
} else {
HDstrncpy (meta_ext, ".meta", meta_ext_size);
}
}
if (raw_ext && raw_ext_size>0) {
if (plist->u.split.raw_ext) {
HDstrncpy (raw_ext, plist->u.split.raw_ext, raw_ext_size);
} else {
HDstrncpy (raw_ext, ".raw", raw_ext_size);
}
}
if (meta_properties) {
assert (plist->u.split.meta_access);
*meta_properties = H5P_create (H5P_FILE_ACCESS,
H5P_copy (H5P_FILE_ACCESS,
plist->u.split.meta_access));
}
if (raw_properties) {
assert (plist->u.split.raw_access);
*raw_properties = H5P_create (H5P_FILE_ACCESS,
H5P_copy (H5P_FILE_ACCESS,
plist->u.split.raw_access));
}
FUNC_LEAVE (SUCCEED);
}
/*-------------------------------------------------------------------------
* Function: H5Pset_family
*
* Purpose: Sets the low-level driver to stripe the hdf5 address space
* across a family of files. The MEMB_SIZE argument indicates
* the size in bytes of each family member and is only
* meaningful when creating new files or opening families that
* have only one member.
*
* Return: Non-negative on success/Negative on failure
*
* Programmer: Robb Matzke
* Thursday, February 19, 1998
*
* Modifications:
*
*-------------------------------------------------------------------------
*/
herr_t
H5Pset_family(hid_t plist_id, hsize_t memb_size, hid_t memb_plist_id)
{
H5F_access_t *plist = NULL;
H5F_access_t *memb_plist = &H5F_access_dflt;
FUNC_ENTER (H5Pset_family, FAIL);
H5TRACE3("e","ihi",plist_id,memb_size,memb_plist_id);
/* Check arguments */
if (H5P_FILE_ACCESS != H5P_get_class(plist_id) ||
NULL == (plist = H5I_object(plist_id))) {
HRETURN_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL,
"not a file access property list");
}
if (memb_size && memb_size<1024) {
HRETURN_ERROR (H5E_ARGS, H5E_BADRANGE, FAIL,
"family member size is too small");
}
if (H5P_DEFAULT!=memb_plist_id &&
(H5P_FILE_ACCESS != H5P_get_class(memb_plist_id) ||
NULL == (plist = H5I_object(memb_plist_id)))) {
HRETURN_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL,
"not a file access property list");
}
/* Set driver */
plist->driver = H5F_LOW_FAMILY;
H5F_addr_reset (&(plist->u.fam.memb_size));
H5F_addr_inc (&(plist->u.fam.memb_size), memb_size);
plist->u.fam.memb_access = H5P_copy (H5P_FILE_ACCESS, memb_plist);
FUNC_LEAVE (SUCCEED);
}
/*-------------------------------------------------------------------------
* Function: H5Pget_family
*
* Purpose: If the file access property list is set to the family driver
* then this function returns zero; otherwise it returns a
* negative value. On success, if MEMB_PLIST_ID is a non-null
* pointer it will be initialized with the id of an open
* property list: the file access property list for the family
* members. In the future, additional arguments may be added to
* this function to match those added to H5Pset_family().
*
* Return: Non-negative on success/Negative on failure
*
* Programmer: Robb Matzke
* Thursday, February 26, 1998
*
* Modifications:
*
*-------------------------------------------------------------------------
*/
herr_t
H5Pget_family(hid_t plist_id, hsize_t *memb_size/*out*/,
hid_t *memb_plist_id/*out*/)
{
H5F_access_t *plist = NULL;
FUNC_ENTER (H5Pget_family, FAIL);
H5TRACE3("e","ixx",plist_id,memb_size,memb_plist_id);
/* Check arguments */
if (H5P_FILE_ACCESS != H5P_get_class (plist_id) ||
NULL == (plist = H5I_object (plist_id))) {
HRETURN_ERROR (H5E_ARGS, H5E_BADTYPE, FAIL,
"not a file access property list");
}
if (H5F_LOW_FAMILY != plist->driver) {
HRETURN_ERROR (H5E_ARGS, H5E_BADVALUE, FAIL,
"the family driver is not set");
}
/* Output args */
if (memb_size) {
*memb_size = plist->u.fam.memb_size.offset;
}
if (memb_plist_id) {
assert (plist->u.fam.memb_access);
*memb_plist_id = H5P_create (H5P_FILE_ACCESS,
H5P_copy (H5P_FILE_ACCESS,
plist->u.fam.memb_access));
}
FUNC_LEAVE (SUCCEED);
}
/*-------------------------------------------------------------------------
* Function: H5Pset_cache
*
* Purpose: Set the number of objects in the meta data cache and the
* maximum number of chunks and bytes in the raw data chunk
* cache.
*
* The RDCC_W0 value should be between 0 and 1 inclusive and
* indicates how much chunks that have been fully read or fully
* written are favored for preemption. A value of zero means
* fully read or written chunks are treated no differently than
* other chunks (the preemption is strictly LRU) while a value
* of one means fully read chunks are always preempted before
* other chunks.
*
* Return: Non-negative on success/Negative on failure
*
* Programmer: Robb Matzke
* Tuesday, May 19, 1998
*
* Modifications:
*
*-------------------------------------------------------------------------
*/
herr_t
H5Pset_cache(hid_t plist_id, int mdc_nelmts,
int rdcc_nelmts, size_t rdcc_nbytes, double rdcc_w0)
{
H5F_access_t *fapl = NULL;
FUNC_ENTER (H5Pset_cache, FAIL);
H5TRACE5("e","iIsIszd",plist_id,mdc_nelmts,rdcc_nelmts,rdcc_nbytes,
rdcc_w0);
/* Check arguments */
if (H5P_FILE_ACCESS!=H5P_get_class (plist_id) ||
NULL==(fapl=H5I_object (plist_id))) {
HRETURN_ERROR (H5E_ARGS, H5E_BADTYPE, FAIL,
"not a file access property list");
}
if (mdc_nelmts<0) {
HRETURN_ERROR (H5E_ARGS, H5E_BADVALUE, FAIL,
"meta data cache size must be non-negative");
}
if (rdcc_nelmts<0) {
HRETURN_ERROR(H5E_ARGS, H5E_BADVALUE, FAIL,
"raw data chunk cache nelmts must be non-negative");
}
if (rdcc_w0<0.0 || rdcc_w0>1.0) {
HRETURN_ERROR (H5E_ARGS, H5E_BADVALUE, FAIL,
"raw data cache w0 value must be between 0.0 and 1.0 "
"inclusive");
}
/* Set sizes */
fapl->mdc_nelmts = mdc_nelmts;
fapl->rdcc_nelmts = rdcc_nelmts;
fapl->rdcc_nbytes = rdcc_nbytes;
fapl->rdcc_w0 = rdcc_w0;
FUNC_LEAVE (SUCCEED);
}
/*-------------------------------------------------------------------------
* Function: H5Pget_cache
*
* Purpose: Retrieves the maximum possible number of elements in the meta
* data cache and the maximum possible number of elements and
* bytes and the RDCC_W0 value in the raw data chunk cache. Any
* (or all) arguments may be null pointers in which case the
* corresponding datum is not returned.
*
* Return: Non-negative on success/Negative on failure
*
* Programmer: Robb Matzke
* Tuesday, May 19, 1998
*
* Modifications:
*
*-------------------------------------------------------------------------
*/
herr_t
H5Pget_cache(hid_t plist_id, int *mdc_nelmts,
int *rdcc_nelmts, size_t *rdcc_nbytes, double *rdcc_w0)
{
H5F_access_t *fapl = NULL;
FUNC_ENTER (H5Pget_cache, FAIL);
H5TRACE5("e","i*Is*Is*z*d",plist_id,mdc_nelmts,rdcc_nelmts,rdcc_nbytes,
rdcc_w0);
/* Check arguments */
if (H5P_FILE_ACCESS!=H5P_get_class (plist_id) ||
NULL==(fapl=H5I_object (plist_id))) {
HRETURN_ERROR (H5E_ARGS, H5E_BADTYPE, FAIL,
"not a file access property list");
}
/* Get sizes */
if (mdc_nelmts) *mdc_nelmts = fapl->mdc_nelmts;
if (rdcc_nelmts) *rdcc_nelmts = fapl->rdcc_nelmts;
if (rdcc_nbytes) *rdcc_nbytes = fapl->rdcc_nbytes;
if (rdcc_w0) *rdcc_w0 = fapl->rdcc_w0;
FUNC_LEAVE (SUCCEED);
}
/*-------------------------------------------------------------------------
* Function: H5Pset_buffer
*
* Purpose: Given a dataset transfer property list, set the maximum size
* for the type conversion buffer and background buffer and
* optionally supply pointers to application-allocated buffers.
* If the buffer size is smaller than the entire amount of data
* being transfered between application and file, and a type
* conversion buffer or background buffer is required then
* strip mining will be used. However, certain restrictions
* apply for the size of buffer which can be used for strip
* mining. For instance, when strip mining a 100x200x300
* hyperslab of a simple data space the buffer must be large
* enough to hold a 1x200x300 slab.
*
* If TCONV and/or BKG are null pointers then buffers will be
* allocated and freed during the data transfer.
*
* Return: Non-negative on success/Negative on failure
*
* Programmer: Robb Matzke
* Monday, March 16, 1998
*
* Modifications:
*
*-------------------------------------------------------------------------
*/
herr_t
H5Pset_buffer(hid_t plist_id, size_t size, void *tconv, void *bkg)
{
H5D_xfer_t *plist = NULL;
FUNC_ENTER (H5Pset_buffer, FAIL);
H5TRACE4("e","izxx",plist_id,size,tconv,bkg);
/* Check arguments */
if (H5P_DATASET_XFER != H5P_get_class (plist_id) ||
NULL == (plist = H5I_object (plist_id))) {
HRETURN_ERROR (H5E_ARGS, H5E_BADTYPE, FAIL,
"not a dataset transfer property list");
}
if (size<=0) {
HRETURN_ERROR (H5E_ARGS, H5E_BADVALUE, FAIL,
"buffer size must not be zero");
}
/* Update property list */
plist->buf_size = size;
plist->tconv_buf = tconv;
plist->bkg_buf = bkg;
FUNC_LEAVE (SUCCEED);
}
/*-------------------------------------------------------------------------
* Function: H5Pget_buffer
*
* Purpose: Reads values previously set with H5Pset_buffer().
*
* Return: Success: Buffer size.
*
* Failure: 0
*
* Programmer: Robb Matzke
* Monday, March 16, 1998
*
* Modifications:
*
*-------------------------------------------------------------------------
*/
size_t
H5Pget_buffer(hid_t plist_id, void **tconv/*out*/, void **bkg/*out*/)
{
H5D_xfer_t *plist = NULL;
FUNC_ENTER (H5Pget_buffer, 0);
H5TRACE3("z","ixx",plist_id,tconv,bkg);
/* Check arguments */
if (H5P_DATASET_XFER != H5P_get_class (plist_id) ||
NULL == (plist = H5I_object (plist_id))) {
HRETURN_ERROR (H5E_ARGS, H5E_BADTYPE, 0,
"not a dataset transfer property list");
}
/* Return values */
if (tconv) *tconv = plist->tconv_buf;
if (bkg) *bkg = plist->bkg_buf;
FUNC_LEAVE (plist->buf_size);
}
/*-------------------------------------------------------------------------
* Function: H5Pset_hyper_cache
*
* Purpose: Given a dataset transfer property list, indicate whether to
* cache the hyperslab blocks during the I/O (which speeds
* things up) and the maximum size of the hyperslab block to
* cache. If a block is smaller than to limit, it may still not
* be cached if no memory is available. Setting the limit to 0
* indicates no limitation on the size of block to attempt to
* cache.
*
* The default is to cache blocks with no limit on block size
* for serial I/O and to not cache blocks for parallel I/O
*
* Return: Non-negative on success/Negative on failure
*
* Programmer: Quincey Koziol
* Monday, September 21, 1998
*
* Modifications:
*
*-------------------------------------------------------------------------
*/
herr_t
H5Pset_hyper_cache(hid_t plist_id, unsigned cache, unsigned limit)
{
H5D_xfer_t *plist = NULL;
FUNC_ENTER (H5Pset_hyper_cache, FAIL);
H5TRACE3("e","iIuIu",plist_id,cache,limit);
/* Check arguments */
if (H5P_DATASET_XFER != H5P_get_class (plist_id) ||
NULL == (plist = H5I_object (plist_id))) {
HRETURN_ERROR (H5E_ARGS, H5E_BADTYPE, FAIL,
"not a dataset transfer property list");
}
/* Update property list */
plist->cache_hyper = (cache>0) ? 1 : 0;
plist->block_limit = limit;
FUNC_LEAVE (SUCCEED);
} /* end H5P_set_hyper_cache() */
/*-------------------------------------------------------------------------
* Function: H5Pget_hyper_cache
*
* Purpose: Reads values previously set with H5Pset_hyper_cache().
*
* Return: Non-negative on success/Negative on failure
*
* Programmer: Quincey Koziol
* Monday, September 21, 1998
*
* Modifications:
*
*-------------------------------------------------------------------------
*/
herr_t
H5Pget_hyper_cache(hid_t plist_id, unsigned *cache/*out*/,
unsigned *limit/*out*/)
{
H5D_xfer_t *plist = NULL;
FUNC_ENTER (H5Pget_hyper_cache, 0);
H5TRACE3("e","ixx",plist_id,cache,limit);
/* Check arguments */
if (H5P_DATASET_XFER != H5P_get_class (plist_id) ||
NULL == (plist = H5I_object (plist_id))) {
HRETURN_ERROR (H5E_ARGS, H5E_BADTYPE, 0,
"not a dataset transfer property list");
}
/* Return values */
if (cache) *cache = plist->cache_hyper;
if (limit) *limit = plist->block_limit;
FUNC_LEAVE (SUCCEED);
} /* end H5Pget_hyper_cache() */
/*-------------------------------------------------------------------------
* Function: H5Pset_preserve
*
* Purpose: When reading or writing compound data types and the
* destination is partially initialized and the read/write is
* intended to initialize the other members, one must set this
* property to TRUE. Otherwise the I/O pipeline treats the
* destination datapoints as completely uninitialized.
*
* Return: Non-negative on success/Negative on failure
*
* Programmer: Robb Matzke
* Tuesday, March 17, 1998
*
* Modifications:
*
*-------------------------------------------------------------------------
*/
herr_t
H5Pset_preserve(hid_t plist_id, hbool_t status)
{
H5D_xfer_t *plist = NULL;
FUNC_ENTER (H5Pset_preserve, FAIL);
H5TRACE2("e","ib",plist_id,status);
/* Check arguments */
if (H5P_DATASET_XFER != H5P_get_class (plist_id) ||
NULL == (plist = H5I_object (plist_id))) {
HRETURN_ERROR (H5E_ARGS, H5E_BADTYPE, FAIL,
"not a dataset transfer property list");
}
/* Update property list */
plist->need_bkg = status ? H5T_BKG_YES : H5T_BKG_NO;
FUNC_LEAVE (SUCCEED);
}
/*-------------------------------------------------------------------------
* Function: H5Pget_preserve
*
* Purpose: The inverse of H5Pset_preserve()
*
* Return: Success: TRUE or FALSE
*
* Failure: Negative
*
* Programmer: Robb Matzke
* Tuesday, March 17, 1998
*
* Modifications:
*
*-------------------------------------------------------------------------
*/
int
H5Pget_preserve(hid_t plist_id)
{
H5D_xfer_t *plist = NULL;
FUNC_ENTER (H5Pset_preserve, FAIL);
H5TRACE1("Is","i",plist_id);
/* Check arguments */
if (H5P_DATASET_XFER != H5P_get_class (plist_id) ||
NULL == (plist = H5I_object (plist_id))) {
HRETURN_ERROR (H5E_ARGS, H5E_BADTYPE, FAIL,
"not a dataset transfer property list");
}
FUNC_LEAVE (plist->need_bkg?TRUE:FALSE);
}
/*-------------------------------------------------------------------------
* Function: H5Pset_filter
*
* Purpose: Adds the specified FILTER and corresponding properties to the
* end of the transient or permanent output filter pipeline
* depending on whether PLIST is a dataset creation or dataset
* transfer property list. The FLAGS argument specifies certain
* general properties of the filter and is documented below.
* The CD_VALUES is an array of CD_NELMTS integers which are
* auxiliary data for the filter. The integer vlues will be
* stored in the dataset object header as part of the filter
* information.
*
* The FLAGS argument is a bit vector of the following fields:
*
* H5Z_FLAG_OPTIONAL(0x0001)
* If this bit is set then the filter is optional. If the
* filter fails during an H5Dwrite() operation then the filter
* is just excluded from the pipeline for the chunk for which it
* failed; the filter will not participate in the pipeline
* during an H5Dread() of the chunk. If this bit is clear and
* the filter fails then the entire I/O operation fails.
*
* Note: This function currently supports only the permanent filter
* pipeline. That is, PLIST_ID must be a dataset creation
* property list.
*
* Return: Non-negative on success/Negative on failure
*
* Programmer: Robb Matzke
* Wednesday, April 15, 1998
*
* Modifications:
*
*-------------------------------------------------------------------------
*/
herr_t
H5Pset_filter(hid_t plist_id, H5Z_filter_t filter, unsigned int flags,
size_t cd_nelmts, const unsigned int cd_values[/*cd_nelmts*/])
{
H5D_create_t *plist = NULL;
FUNC_ENTER (H5Pset_filter, FAIL);
H5TRACE5("e","iZfIuz*[a3]Iu",plist_id,filter,flags,cd_nelmts,cd_values);
/* Check arguments */
if (H5P_DATASET_XFER==H5P_get_class(plist_id)) {
HRETURN_ERROR(H5E_PLINE, H5E_UNSUPPORTED, FAIL,
"transient pipelines are not supported yet");
}
if (H5P_DATASET_CREATE!=H5P_get_class (plist_id) ||
NULL==(plist=H5I_object (plist_id))) {
HRETURN_ERROR (H5E_ARGS, H5E_BADTYPE, FAIL,
"not a dataset creation property list");
}
if (filter<0 || filter>H5Z_FILTER_MAX) {
HRETURN_ERROR (H5E_ARGS, H5E_BADVALUE, FAIL,
"invalid filter identifier");
}
if (flags & ~H5Z_FLAG_DEFMASK) {
HRETURN_ERROR(H5E_ARGS, H5E_BADVALUE, FAIL,
"invalid flags");
}
if (cd_nelmts>0 && !cd_values) {
HRETURN_ERROR(H5E_ARGS, H5E_BADVALUE, FAIL,
"no client data values supplied");
}
/* Do it */
if (H5Z_append(&(plist->pline), filter, flags, cd_nelmts, cd_values)<0) {
HRETURN_ERROR(H5E_PLINE, H5E_CANTINIT, FAIL,
"unable to add filter to pipeline");
}
FUNC_LEAVE (SUCCEED);
}
/*-------------------------------------------------------------------------
* Function: H5Pget_nfilters
*
* Purpose: Returns the number of filters in the permanent or transient
* pipeline depending on whether PLIST_ID is a dataset creation
* or dataset transfer property list. In each pipeline the
* filters are numbered from zero through N-1 where N is the
* value returned by this function. During output to the file
* the filters of a pipeline are applied in increasing order
* (the inverse is true for input).
*
* Note: Only permanent filters are supported at this time.
*
* Return: Success: Number of filters or zero if there are none.
*
* Failure: Negative
*
* Programmer: Robb Matzke
* Tuesday, August 4, 1998
*
* Modifications:
*
*-------------------------------------------------------------------------
*/
int
H5Pget_nfilters(hid_t plist_id)
{
H5D_create_t *plist = NULL;
FUNC_ENTER(H5Pget_nfilters, FAIL);
H5TRACE1("Is","i",plist_id);
if (H5P_DATASET_XFER==H5P_get_class(plist_id)) {
HRETURN_ERROR(H5E_PLINE, H5E_UNSUPPORTED, FAIL,
"transient pipelines are not supported yet");
}
if (H5P_DATASET_CREATE!=H5P_get_class(plist_id) ||
NULL==(plist=H5I_object(plist_id))) {
HRETURN_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL,
"not a dataset creation property list");
}
FUNC_LEAVE(plist->pline.nfilters);
}
/*-------------------------------------------------------------------------
* Function: H5Pget_filter
*
* Purpose: This is the query counterpart of H5Pset_filter() and returns
* information about a particular filter number in a permanent
* or transient pipeline depending on whether PLIST_ID is a
* dataset creation or transfer property list. On input,
* CD_NELMTS indicates the number of entries in the CD_VALUES
* array allocated by the caller while on exit it contains the
* number of values defined by the filter. The IDX should be a
* value between zero and N-1 as described for H5Pget_nfilters()
* and the function will return failure if the filter number is
* out or range.
*
* Return: Success: Filter identification number.
*
* Failure: H5Z_FILTER_ERROR (Negative)
*
* Programmer: Robb Matzke
* Wednesday, April 15, 1998
*
* Modifications:
*
*-------------------------------------------------------------------------
*/
H5Z_filter_t
H5Pget_filter(hid_t plist_id, int idx, unsigned int *flags/*out*/,
size_t *cd_nelmts/*in_out*/, unsigned cd_values[]/*out*/,
size_t namelen, char name[]/*out*/)
{
H5D_create_t *plist = NULL;
size_t i;
FUNC_ENTER (H5Pget_filter, FAIL);
H5TRACE7("Zf","iIsx*zxzx",plist_id,idx,flags,cd_nelmts,cd_values,namelen,
name);
/* Check arguments */
if (H5P_DATASET_XFER==H5P_get_class(plist_id)) {
HRETURN_ERROR(H5E_PLINE, H5E_UNSUPPORTED, FAIL,
"transient filters are not supported yet");
}
if (H5P_DATASET_CREATE!=H5P_get_class (plist_id) ||
NULL==(plist=H5I_object (plist_id))) {
HRETURN_ERROR (H5E_ARGS, H5E_BADTYPE, FAIL,
"not a dataset creation property list");
}
if (idx<0 || (size_t)idx>=plist->pline.nfilters) {
HRETURN_ERROR(H5E_ARGS, H5E_BADVALUE, FAIL,
"filter number is invalid");
}
if (cd_nelmts || cd_values) {
if (cd_nelmts && *cd_nelmts>256) {
/*
* It's likely that users forget to initialize this on input, so
* we'll check that it has a reasonable value. The actual number
* is unimportant because the H5O layer will detect when a message
* is too large.
*/
HRETURN_ERROR(H5E_ARGS, H5E_BADVALUE, FAIL,
"probable uninitialized *cd_nelmts argument");
}
if (cd_nelmts && *cd_nelmts>0 && !cd_values) {
HRETURN_ERROR(H5E_ARGS, H5E_BADVALUE, FAIL,
"client data values not supplied");
}
/*
* If cd_nelmts is null but cd_values is non-null then just ignore
* cd_values
*/
if (!cd_nelmts) cd_values = NULL;
}
/* Output values */
if (flags) *flags = plist->pline.filter[idx].flags;
if (cd_values) {
for (i=0; i<plist->pline.filter[idx].cd_nelmts && i<*cd_nelmts; i++) {
cd_values[i] = plist->pline.filter[idx].cd_values[i];
}
}
if (cd_nelmts) *cd_nelmts = plist->pline.filter[idx].cd_nelmts;
if (namelen>0 && name) {
const char *s = plist->pline.filter[idx].name;
if (!s) {
H5Z_class_t *cls = H5Z_find(plist->pline.filter[idx].id);
if (cls) s = cls->name;
}
if (s) HDstrncpy(name, s, namelen);
else name[0] = '\0';
}
FUNC_LEAVE (plist->pline.filter[idx].id);
}
/*-------------------------------------------------------------------------
* Function: H5Pset_deflate
*
* Purpose: Sets the compression method for a permanent or transient
* filter pipeline (depending on whether PLIST_ID is a dataset
* creation or transfer property list) to H5Z_FILTER_DEFLATE
* and the compression level to LEVEL which should be a value
* between zero and nine, inclusive. Lower compression levels
* are faster but result in less compression. This is the same
* algorithm as used by the GNU gzip program.
*
* Return: Non-negative on success/Negative on failure
*
* Programmer: Robb Matzke
* Wednesday, April 15, 1998
*
* Modifications:
*
*-------------------------------------------------------------------------
*/
herr_t
H5Pset_deflate(hid_t plist_id, unsigned level)
{
H5D_create_t *plist = NULL;
FUNC_ENTER (H5Pset_deflate, FAIL);
H5TRACE2("e","iIu",plist_id,level);
/* Check arguments */
if (H5P_DATASET_XFER==H5P_get_class(plist_id)) {
HRETURN_ERROR(H5E_PLINE, H5E_UNSUPPORTED, FAIL,
"transient filter pipelines are not supported yet");
}
if (H5P_DATASET_CREATE!=H5P_get_class (plist_id) ||
NULL==(plist=H5I_object (plist_id))) {
HRETURN_ERROR (H5E_ARGS, H5E_BADTYPE, FAIL,
"not a dataset creation property list");
}
if (level>9) {
HRETURN_ERROR (H5E_ARGS, H5E_BADVALUE, FAIL,
"invalid deflate level");
}
/* Add the filter */
if (H5Z_append(&(plist->pline), H5Z_FILTER_DEFLATE, H5Z_FLAG_OPTIONAL,
1, &level)<0) {
HRETURN_ERROR(H5E_PLINE, H5E_CANTINIT, FAIL,
"unable to add deflate filter to pipeline");
}
FUNC_LEAVE (SUCCEED);
}
/*-------------------------------------------------------------------------
* Function: H5Pget_btree_ratios
*
* Purpose: Queries B-tree split ratios. See H5Pset_btree_ratios().
*
* Return: Success: Non-negative with split ratios returned through
* the non-null arguments.
*
* Failure: Negative
*
* Programmer: Robb Matzke
* Monday, September 28, 1998
*
* Modifications:
*
*-------------------------------------------------------------------------
*/
herr_t
H5Pget_btree_ratios(hid_t plist_id, double *left/*out*/, double *middle/*out*/,
double *right/*out*/)
{
H5D_xfer_t *plist = NULL;
FUNC_ENTER(H5Pget_btree_ratios, FAIL);
H5TRACE4("e","ixxx",plist_id,left,middle,right);
/* Check arguments */
if (H5P_DATASET_XFER!=H5P_get_class(plist_id) ||
NULL==(plist=H5I_object(plist_id))) {
HRETURN_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL,
"not a dataset transfer property list");
}
/* Get values */
if (left) *left = plist->split_ratios[0];
if (middle) *middle = plist->split_ratios[1];
if (right) *right = plist->split_ratios[2];
FUNC_LEAVE(SUCCEED);
}
/*-------------------------------------------------------------------------
* Function: H5Pset_btree_ratios
*
* Purpose: Sets B-tree split ratios for a dataset transfer property
* list. The split ratios determine what percent of children go
* in the first node when a node splits. The LEFT ratio is
* used when the splitting node is the left-most node at its
* level in the tree; the RIGHT ratio is when the splitting node
* is the right-most node at its level; and the MIDDLE ratio for
* all other cases. A node which is the only node at its level
* in the tree uses the RIGHT ratio when it splits. All ratios
* are real numbers between 0 and 1, inclusive.
*
* Return: Non-negative on success/Negative on failure
*
* Programmer: Robb Matzke
* Monday, September 28, 1998
*
* Modifications:
*
*-------------------------------------------------------------------------
*/
herr_t
H5Pset_btree_ratios(hid_t plist_id, double left, double middle,
double right)
{
H5D_xfer_t *plist = NULL;
FUNC_ENTER(H5Pget_btree_ratios, FAIL);
H5TRACE4("e","iddd",plist_id,left,middle,right);
/* Check arguments */
if (H5P_DATASET_XFER!=H5P_get_class(plist_id) ||
NULL==(plist=H5I_object(plist_id))) {
HRETURN_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL,
"not a dataset transfer property list");
}
if (left<0.0 || left>1.0 || middle<0.0 || middle>1.0 ||
right<0.0 || right>1.0) {
HRETURN_ERROR(H5E_ARGS, H5E_BADVALUE, FAIL,
"split ratio must satisfy 0.0<=X<=1.0");
}
/* Set values */
plist->split_ratios[0] = left;
plist->split_ratios[1] = middle;
plist->split_ratios[2] = right;
FUNC_LEAVE(SUCCEED);
}
/*-------------------------------------------------------------------------
* Function: H5Pset_fill_value
*
* Purpose: Set the fill value for a dataset creation property list. The
* VALUE is interpretted as being of type TYPE, which need not
* be the same type as the dataset but the library must be able
* to convert VALUE to the dataset type when the dataset is
* created.
*
* Return: Non-negative on success/Negative on failure
*
* Programmer: Robb Matzke
* Thursday, October 1, 1998
*
* Modifications:
*
*-------------------------------------------------------------------------
*/
herr_t
H5Pset_fill_value(hid_t plist_id, hid_t type_id, const void *value)
{
H5D_create_t *plist = NULL;
H5T_t *type = NULL;
FUNC_ENTER(H5Pset_fill_value, FAIL);
H5TRACE3("e","iix",plist_id,type_id,value);
/* Check arguments */
if (H5P_DATASET_CREATE!=H5P_get_class(plist_id) ||
NULL==(plist=H5I_object(plist_id))) {
HRETURN_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL,
"not a dataset creation property list");
}
if (H5I_DATATYPE!=H5I_get_type(type_id) ||
NULL==(type=H5I_object(type_id))) {
HRETURN_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL, "not a data type");
}
if (!value) {
HRETURN_ERROR(H5E_ARGS, H5E_BADVALUE, FAIL, "no fill value specified");
}
/* Set the fill value */
H5O_reset(H5O_FILL, &(plist->fill));
if (NULL==(plist->fill.type=H5T_copy(type, H5T_COPY_TRANSIENT))) {
HRETURN_ERROR(H5E_DATATYPE, H5E_CANTINIT, FAIL,
"unable to copy data type");
}
plist->fill.size = H5T_get_size(type);
if (NULL==(plist->fill.buf=H5MM_malloc(plist->fill.size))) {
HRETURN_ERROR(H5E_RESOURCE, H5E_CANTINIT, FAIL,
"memory allocation failed for fill value");
}
HDmemcpy(plist->fill.buf, value, plist->fill.size);
FUNC_LEAVE(SUCCEED);
}
/*-------------------------------------------------------------------------
* Function: H5Pget_fill_value
*
* Purpose: Queries the fill value property of a dataset creation
* property list. The fill value is returned through the VALUE
* pointer and the memory is allocated by the caller. The fill
* value will be converted from its current data type to the
* specified TYPE.
*
* Return: Non-negative on success/Negative on failure
*
* Programmer: Robb Matzke
* Thursday, October 1, 1998
*
* Modifications:
*
*-------------------------------------------------------------------------
*/
herr_t
H5Pget_fill_value(hid_t plist_id, hid_t type_id, void *value/*out*/)
{
H5D_create_t *plist = NULL; /*property list */
H5T_t *type = NULL; /*data type */
H5T_path_t *tpath = NULL; /*type conversion info */
void *buf = NULL; /*conversion buffer */
void *bkg = NULL; /*conversion buffer */
hid_t src_id = -1; /*source data type id */
herr_t ret_value = FAIL; /*return value */
FUNC_ENTER(H5Pget_fill_value, FAIL);
H5TRACE3("e","iix",plist_id,type_id,value);
/* Check arguments */
if (H5P_DATASET_CREATE!=H5P_get_class(plist_id) ||
NULL==(plist=H5I_object(plist_id))) {
HGOTO_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL,
"not a dataset creation proprety list");
}
if (H5I_DATATYPE!=H5I_get_type(type_id) ||
NULL==(type=H5I_object(type_id))) {
HGOTO_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL, "not a data type");
}
if (!value) {
HGOTO_ERROR(H5E_ARGS, H5E_BADVALUE, FAIL,
"no fill value output buffer");
}
/*
* If no fill value is defined then return an error. We can't even
* return zero because we don't know the data type of the dataset and
* data type conversion might not have resulted in zero.
*/
if (NULL==plist->fill.buf) {
HGOTO_ERROR(H5E_PLIST, H5E_NOTFOUND, FAIL, "no fill value defined");
}
/*
* Can we convert between the source and destination data types?
*/
if (NULL==(tpath=H5T_path_find(plist->fill.type, type, NULL, NULL))) {
HGOTO_ERROR(H5E_DATATYPE, H5E_CANTINIT, FAIL,
"unable to convert between src and dst data types");
}
src_id = H5I_register(H5I_DATATYPE,
H5T_copy (plist->fill.type, H5T_COPY_TRANSIENT));
if (src_id<0) {
HGOTO_ERROR(H5E_DATATYPE, H5E_CANTINIT, FAIL,
"unable to copy/register data type");
}
/*
* Data type conversions are always done in place, so we need a buffer
* other than the fill value buffer that is large enough for both source
* and destination. The app-supplied buffer might do okay.
*/
if (H5T_get_size(type)>=H5T_get_size(plist->fill.type)) {
buf = value;
if (tpath->cdata.need_bkg>=H5T_BKG_TEMP &&
NULL==(bkg=H5MM_malloc(H5T_get_size(type)))) {
HGOTO_ERROR(H5E_RESOURCE, H5E_NOSPACE, FAIL,
"memory allocation failed for type conversion");
}
} else {
if (NULL==(buf=H5MM_malloc(H5T_get_size(plist->fill.type)))) {
HGOTO_ERROR(H5E_RESOURCE, H5E_NOSPACE, FAIL,
"memory allocation failed for type conversion");
}
if (tpath->cdata.need_bkg>=H5T_BKG_TEMP) bkg = value;
}
HDmemcpy(buf, plist->fill.buf, H5T_get_size(plist->fill.type));
/* Do the conversion */
if (H5T_convert(tpath, src_id, type_id, 1, buf, bkg)<0) {
HGOTO_ERROR(H5E_DATATYPE, H5E_CANTINIT, FAIL,
"data type conversion failed");
}
if (buf!=value) HDmemcpy(value, buf, H5T_get_size(type));
ret_value = SUCCEED;
done:
if (buf!=value) H5MM_xfree(buf);
if (bkg!=value) H5MM_xfree(bkg);
if (src_id>=0) H5I_dec_ref(src_id);
FUNC_LEAVE(ret_value);
}
#ifdef HAVE_PARALLEL
/*-------------------------------------------------------------------------
* Function: H5Pset_mpi
*
* Signature: herr_t H5Pset_mpi(hid_t plist_id, MPI_Comm comm, MPI_Info info)
*
* Purpose: Store the access mode for MPIO call and the user supplied
* communicator and info in the access property list which can
* then be used to open file. This function is available only
* in the parallel HDF5 library and is not a collective
* function.
*
* Parameters:
* hid_t plist_id
* ID of property list to modify
* MPI_Comm comm
* MPI communicator to be used for file open as defined in
* MPI_FILE_OPEN of MPI-2. This function does not make a
* duplicated communicator. Any modification to comm after
* this function call returns may have undetermined effect
* to the access property list. Users should call this
* function again to setup the property list.
* MPI_Info info
* MPI info object to be used for file open as defined in
* MPI_FILE_OPEN of MPI-2. This function does not make a
* duplicated info. Any modification to info after
* this function call returns may have undetermined effect
* to the access property list. Users should call this
* function again to setup the property list.
*
* Return: Non-negative on success/Negative on failure
*
* Programmer: Albert Cheng
* Feb 3, 1998
*
* Modifications:
*
* Robb Matzke, 18 Feb 1998
* Check all arguments before the property list is updated so we don't
* leave the property list in a bad state if something goes wrong. Also,
* the property list data type changed to allow more generality so all
* the mpi-related stuff is in the `u.mpi' member. The `access_mode'
* will contain only mpi-related flags defined in H5Fpublic.h.
*
* Albert Cheng, Apr 16, 1998
* Removed the access_mode argument. The access_mode is changed
* to be controlled by data transfer property list during data
* read/write calls.
*
*-------------------------------------------------------------------------
*/
herr_t
H5Pset_mpi(hid_t plist_id, MPI_Comm comm, MPI_Info info)
{
H5F_access_t *plist = NULL;
FUNC_ENTER(H5Pset_mpi, FAIL);
H5TRACE3("e","iMcMi",plist_id,comm,info);
/* Check arguments */
if (H5P_FILE_ACCESS != H5P_get_class(plist_id) ||
NULL == (plist = H5I_object(plist_id))) {
HRETURN_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL,
"not a file access property list");
}
#ifdef LATER
/*
* Need to verify comm and info contain sensible information.
*/
#endif
plist->driver = H5F_LOW_MPIO;
plist->u.mpio.comm = comm;
plist->u.mpio.info = info;
FUNC_LEAVE(SUCCEED);
}
#endif /*HAVE_PARALLEL*/
#ifdef HAVE_PARALLEL
/*-------------------------------------------------------------------------
* Function: H5Pget_mpi
*
* Purpose: If the file access property list is set to the mpi driver
* then this function returns zero; otherwise it returns a
* negative value. In the future, additional arguments may be
* added to this function to match those added to H5Pset_mpi().
*
* Return: Non-negative on success/Negative on failure
*
* Programmer: Robb Matzke
* Thursday, February 26, 1998
*
* Modifications:
*
* Albert Cheng, Apr 16, 1998
* Removed the access_mode argument. The access_mode is changed
* to be controlled by data transfer property list during data
* read/write calls.
*
*-------------------------------------------------------------------------
*/
herr_t
H5Pget_mpi(hid_t plist_id, MPI_Comm *comm, MPI_Info *info)
{
H5F_access_t *plist = NULL;
FUNC_ENTER (H5Pget_mpi, FAIL);
H5TRACE3("e","i*Mc*Mi",plist_id,comm,info);
/* Check arguments */
if (H5P_FILE_ACCESS != H5P_get_class (plist_id) ||
NULL == (plist = H5I_object (plist_id))) {
HRETURN_ERROR (H5E_ARGS, H5E_BADTYPE, FAIL,
"not a file access property list");
}
if (H5F_LOW_MPIO != plist->driver) {
HRETURN_ERROR (H5E_ARGS, H5E_BADVALUE, FAIL,
"the mpi driver is not set");
}
*comm = plist->u.mpio.comm;
*info = plist->u.mpio.info;
FUNC_LEAVE (SUCCEED);
}
#endif /*HAVE_PARALLEL*/
#ifdef HAVE_PARALLEL
/*-------------------------------------------------------------------------
* Function: H5Pset_xfer
*
* Signature: herr_t H5Pset_xfer(hid_t plist_id,
* H5D_transfer_t data_xfer_mode)
*
* Purpose: Set the transfer mode of the dataset transfer property list.
* The list can then be used to control the I/O transfer mode
* during dataset accesses. This function is available only
* in the parallel HDF5 library and is not a collective function.
*
* Parameters:
* hid_t plist_id
* ID of a dataset transfer property list
* H5D_transfer_t data_xfer_mode
* Data transfer modes:
* H5D_XFER_INDEPENDENT
* Use independent I/O access.
* H5D_XFER_COLLECTIVE
* Use MPI collective I/O access.
* H5D_XFER_DFLT
* Use default I/O access. Currently,
* independent is the default mode.
*
*
* Return: Non-negative on success/Negative on failure
*
* Programmer: Albert Cheng
* April 2, 1998
*
* Modifications:
*
*-------------------------------------------------------------------------
*/
herr_t
H5Pset_xfer(hid_t plist_id, H5D_transfer_t data_xfer_mode)
{
H5D_xfer_t *plist = NULL;
FUNC_ENTER(H5Pset_xfer, FAIL);
H5TRACE2("e","iDt",plist_id,data_xfer_mode);
/* Check arguments */
if (H5P_DATASET_XFER != H5P_get_class(plist_id) ||
NULL == (plist = H5I_object(plist_id))) {
HRETURN_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL,
"not a dataset transfer property list");
}
switch (data_xfer_mode){
case H5D_XFER_INDEPENDENT:
case H5D_XFER_COLLECTIVE:
case H5D_XFER_DFLT:
plist->xfer_mode = data_xfer_mode;
break;
default:
HRETURN_ERROR (H5E_ARGS, H5E_BADVALUE, FAIL,
"invalid dataset transfer mode");
}
FUNC_LEAVE(SUCCEED);
}
#endif /*HAVE_PARALLEL*/
#ifdef HAVE_PARALLEL
/*-------------------------------------------------------------------------
* Function: H5Pget_xfer
*
* Purpose: Reads the transfer mode current set in the property list.
* This function is available only in the parallel HDF5 library
* and is not a collective function.
*
* Return: Non-negative on success/Negative on failure
*
* Programmer: Albert Cheng
* April 2, 1998
*
* Modifications:
*
*-------------------------------------------------------------------------
*/
herr_t
H5Pget_xfer(hid_t plist_id, H5D_transfer_t *data_xfer_mode)
{
H5D_xfer_t *plist = NULL;
FUNC_ENTER (H5Pget_xfer, FAIL);
H5TRACE2("e","i*Dt",plist_id,data_xfer_mode);
/* Check arguments */
if (H5P_DATASET_XFER != H5P_get_class(plist_id) ||
NULL == (plist = H5I_object(plist_id))) {
HRETURN_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL,
"not a dataset transfer property list");
}
*data_xfer_mode = plist->xfer_mode;
FUNC_LEAVE (SUCCEED);
}
#endif /*HAVE_PARALLEL*/
/*-------------------------------------------------------------------------
* Function: H5Pset_gc_references
*
* Purpose: Sets the flag for garbage collecting references for the file.
* Dataset region references (and other reference types probably) use
* space in the file heap. If garbage collection is on and the user
* passes in an uninitialized value in a reference structure, the heap
* might get corrupted. When garbage collection is off however and the
* user re-uses a reference, the previous heap block will be orphaned and
* not returned to the free heap space. When garbage collection is on,
* the user must initialize the reference structures to 0 or risk heap
* corruption.
*
* Default value for garbage collecting references is off, just to be
* on the safe side.
*
* Return: Non-negative on success/Negative on failure
*
* Programmer: Quincey Koziol
* Friday, November 13, 1998
*
* Modifications:
*
*-------------------------------------------------------------------------
*/
herr_t
H5Pset_gc_references(hid_t fapl_id, unsigned gc_ref)
{
H5F_access_t *fapl = NULL;
FUNC_ENTER (H5Pset_gc_references, FAIL);
H5TRACE2("e","iIu",fapl_id,gc_ref);
/* Check args */
if (H5P_FILE_ACCESS != H5P_get_class (fapl_id) || NULL == (fapl = H5I_object (fapl_id))) {
HRETURN_ERROR (H5E_ARGS, H5E_BADTYPE, FAIL, "not a file access property list");
}
/* Set values */
fapl->gc_ref = (gc_ref!=0);
FUNC_LEAVE (SUCCEED);
}
/*-------------------------------------------------------------------------
* Function: H5Pget_gc_refernces
*
* Purpose: Returns the current setting for the garbage collection refernces
* property from a file access property list.
*
* Return: Non-negative on success/Negative on failure
*
* Programmer: Robb Matzke
* Tuesday, June 9, 1998
*
* Modifications:
*
*-------------------------------------------------------------------------
*/
herr_t
H5Pget_gc_reference(hid_t fapl_id, unsigned *gc_ref/*out*/)
{
H5F_access_t *fapl = NULL;
FUNC_ENTER (H5Pget_alignment, FAIL);
H5TRACE2("e","ix",fapl_id,gc_ref);
/* Check args */
if (H5P_FILE_ACCESS != H5P_get_class (fapl_id) || NULL == (fapl = H5I_object (fapl_id))) {
HRETURN_ERROR (H5E_ARGS, H5E_BADTYPE, FAIL, "not a file access property list");
}
/* Get values */
if (gc_ref) *gc_ref = fapl->gc_ref;
FUNC_LEAVE (SUCCEED);
}
/*--------------------------------------------------------------------------
NAME
H5Pcopy
PURPOSE
Copy a property list
USAGE
hid_t H5P_copy(plist_id)
hid_t plist_id; IN: property list object to copy
RETURNS
Returns property list ID (atom) on success, Negative on failure
ERRORS
ARGS BADRANGE Unknown property list class.
ATOM BADATOM Can't unatomize property list.
ATOM CANTREGISTER Register the atom for the new property list.
INTERNAL UNSUPPORTED Dataset transfer properties are not implemented
yet.
INTERNAL UNSUPPORTED File access properties are not implemented yet.
DESCRIPTION
* This function creates a new copy of a property list with all the same
* parameter settings.
--------------------------------------------------------------------------*/
hid_t
H5Pcopy(hid_t plist_id)
{
const void *plist = NULL;
void *new_plist = NULL;
H5P_class_t type;
hid_t ret_value = FAIL;
H5I_type_t group;
FUNC_ENTER(H5Pcopy, FAIL);
H5TRACE1("i","i",plist_id);
/* Check args */
if (NULL == (plist = H5I_object(plist_id)) ||
(type = H5P_get_class(plist_id)) < 0 ||
(group = H5I_get_type(plist_id)) < 0) {
HRETURN_ERROR(H5E_ATOM, H5E_BADATOM, FAIL,
"unable to unatomize property list");
}
/* Copy it */
if (NULL==(new_plist=H5P_copy (type, plist))) {
HRETURN_ERROR (H5E_INTERNAL, H5E_CANTINIT, FAIL,
"unable to copy property list");
}
/* Register the atom for the new property list */
if ((ret_value = H5I_register(group, new_plist)) < 0) {
HRETURN_ERROR(H5E_ATOM, H5E_CANTREGISTER, FAIL,
"unable to atomize property list pointer");
}
FUNC_LEAVE(ret_value);
}
/*-------------------------------------------------------------------------
* Function: H5P_copy
*
* Purpose: Creates a new property list and initializes it with some
* other property list.
*
* Return: Success: Ptr to new property list
*
* Failure: NULL
*
* Programmer: Robb Matzke
* Tuesday, February 3, 1998
*
* Modifications:
*
*-------------------------------------------------------------------------
*/
void *
H5P_copy (H5P_class_t type, const void *src)
{
size_t size;
void *dst = NULL;
const H5D_create_t *dc_src = NULL;
H5D_create_t *dc_dst = NULL;
const H5F_access_t *fa_src = NULL;
H5F_access_t *fa_dst = NULL;
FUNC_ENTER (H5P_copy, NULL);
/* How big is the property list */
switch (type) {
case H5P_FILE_CREATE:
size = sizeof(H5F_create_t);
break;
case H5P_FILE_ACCESS:
size = sizeof(H5F_access_t);
break;
case H5P_DATASET_CREATE:
size = sizeof(H5D_create_t);
break;
case H5P_DATASET_XFER:
size = sizeof(H5D_xfer_t);
break;
case H5P_MOUNT:
size = sizeof(H5F_mprop_t);
break;
default:
HRETURN_ERROR(H5E_ARGS, H5E_BADRANGE, NULL,
"unknown property list class");
}
/* Create the new property list */
if (NULL==(dst = H5MM_malloc(size))) {
HRETURN_ERROR (H5E_RESOURCE, H5E_NOSPACE, NULL,
"memory allocation failed");
}
HDmemcpy(dst, src, size);
/* Deep-copy pointers */
switch (type) {
case H5P_FILE_CREATE:
break;
case H5P_FILE_ACCESS:
fa_src = (const H5F_access_t*)src;
fa_dst = (H5F_access_t*)dst;
switch (fa_src->driver) {
case H5F_LOW_ERROR:
case H5F_LOW_SEC2:
case H5F_LOW_STDIO:
case H5F_LOW_CORE:
case H5F_LOW_MPIO:
/* Nothing to do */
break;
case H5F_LOW_FAMILY:
fa_dst->u.fam.memb_access = H5P_copy (H5P_FILE_ACCESS,
fa_src->u.fam.memb_access);
break;
case H5F_LOW_SPLIT:
fa_dst->u.split.meta_access=H5P_copy (H5P_FILE_ACCESS,
fa_src->u.split.meta_access);
fa_dst->u.split.raw_access = H5P_copy (H5P_FILE_ACCESS,
fa_src->u.split.raw_access);
break;
}
break;
case H5P_DATASET_CREATE:
dc_src = (const H5D_create_t*)src;
dc_dst = (H5D_create_t*)dst;
/* Copy the fill value */
if (NULL==H5O_copy(H5O_FILL, &(dc_src->fill), &(dc_dst->fill))) {
HRETURN_ERROR(H5E_PLIST, H5E_CANTINIT, NULL,
"unabe to copy fill value message");
}
/* Copy the external file list */
HDmemset(&(dc_dst->efl), 0, sizeof(dc_dst->efl));
if (NULL==H5O_copy(H5O_EFL, &(dc_src->efl), &(dc_dst->efl))) {
HRETURN_ERROR(H5E_PLIST, H5E_CANTINIT, NULL,
"unable to copy external file list message");
}
/* Copy the filter pipeline */
if (NULL==H5O_copy(H5O_PLINE, &(dc_src->pline), &(dc_dst->pline))) {
HRETURN_ERROR(H5E_PLIST, H5E_CANTINIT, NULL,
"unable to copy filter pipeline message");
}
break;
case H5P_DATASET_XFER:
/* Nothing to do */
break;
case H5P_MOUNT:
/* Nothing to do */
break;
default:
HRETURN_ERROR(H5E_ARGS, H5E_BADRANGE, NULL,
"unknown property list class");
}
FUNC_LEAVE (dst);
}
|