1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
2883
2884
2885
2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
2930
2931
2932
2933
2934
2935
2936
2937
2938
2939
2940
2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
2951
2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
3024
3025
3026
3027
3028
3029
3030
3031
3032
3033
3034
3035
3036
3037
3038
3039
3040
3041
3042
3043
3044
3045
3046
3047
3048
3049
3050
3051
3052
3053
3054
3055
3056
3057
3058
3059
3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
3076
3077
3078
3079
3080
3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
3097
3098
3099
3100
3101
3102
3103
3104
3105
3106
3107
3108
3109
3110
3111
3112
3113
3114
3115
3116
3117
3118
3119
3120
3121
3122
3123
3124
3125
3126
3127
3128
3129
3130
3131
3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
3146
3147
3148
3149
3150
3151
3152
3153
3154
3155
3156
3157
3158
3159
3160
3161
3162
3163
3164
3165
3166
3167
3168
3169
3170
3171
3172
3173
3174
3175
3176
3177
3178
3179
3180
3181
3182
3183
3184
3185
3186
3187
3188
3189
3190
3191
3192
3193
3194
3195
3196
3197
3198
3199
3200
3201
3202
3203
3204
3205
3206
3207
3208
3209
3210
3211
3212
3213
3214
3215
3216
3217
3218
3219
3220
3221
3222
3223
3224
3225
3226
3227
3228
3229
3230
3231
3232
3233
3234
3235
3236
3237
3238
3239
3240
3241
3242
3243
3244
3245
3246
3247
3248
3249
3250
3251
3252
3253
3254
3255
3256
3257
3258
3259
3260
3261
3262
3263
3264
3265
3266
3267
3268
3269
3270
3271
3272
3273
3274
3275
3276
3277
3278
3279
3280
3281
3282
3283
3284
3285
3286
3287
3288
3289
3290
3291
3292
3293
3294
3295
3296
3297
3298
3299
3300
3301
3302
3303
3304
3305
3306
3307
3308
3309
3310
3311
3312
3313
3314
3315
3316
3317
3318
3319
3320
3321
3322
3323
3324
3325
3326
3327
3328
3329
3330
3331
3332
3333
3334
3335
3336
3337
3338
3339
3340
3341
3342
3343
3344
3345
3346
3347
3348
3349
3350
3351
3352
3353
3354
3355
3356
3357
3358
3359
3360
3361
3362
3363
3364
3365
3366
3367
3368
3369
3370
3371
3372
3373
3374
3375
3376
3377
3378
3379
3380
3381
3382
3383
3384
3385
3386
3387
3388
3389
3390
3391
3392
3393
3394
3395
3396
3397
3398
3399
3400
3401
3402
3403
3404
3405
3406
3407
3408
3409
3410
3411
3412
3413
3414
3415
3416
3417
3418
3419
3420
3421
3422
3423
3424
3425
3426
3427
3428
3429
3430
3431
3432
3433
3434
3435
3436
3437
3438
3439
3440
3441
3442
3443
3444
3445
3446
3447
3448
3449
3450
3451
3452
3453
3454
3455
3456
3457
3458
3459
3460
3461
3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
3488
3489
3490
3491
3492
3493
3494
3495
3496
3497
3498
3499
3500
3501
3502
3503
3504
3505
3506
3507
3508
3509
3510
3511
3512
3513
3514
3515
3516
3517
3518
3519
3520
3521
3522
3523
3524
3525
3526
3527
3528
3529
3530
3531
3532
3533
3534
3535
3536
3537
3538
3539
3540
3541
3542
3543
3544
3545
3546
3547
3548
3549
3550
3551
3552
3553
3554
3555
3556
3557
3558
3559
3560
3561
3562
3563
3564
3565
3566
3567
3568
3569
3570
3571
3572
3573
3574
3575
3576
3577
3578
3579
3580
3581
3582
3583
3584
3585
3586
3587
3588
3589
3590
3591
3592
3593
3594
3595
3596
3597
3598
3599
3600
3601
3602
3603
3604
3605
3606
3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
3634
3635
3636
3637
3638
3639
3640
3641
3642
3643
3644
3645
3646
3647
3648
3649
3650
3651
3652
3653
3654
3655
3656
3657
3658
3659
3660
3661
3662
3663
3664
3665
3666
3667
3668
3669
3670
3671
3672
3673
3674
3675
3676
3677
3678
3679
3680
3681
3682
3683
3684
3685
3686
3687
3688
3689
3690
3691
3692
3693
3694
3695
3696
3697
3698
3699
3700
3701
3702
3703
3704
3705
3706
3707
3708
3709
3710
3711
3712
3713
3714
3715
3716
3717
3718
3719
3720
3721
3722
3723
3724
3725
3726
3727
3728
3729
3730
3731
3732
3733
3734
3735
3736
3737
3738
3739
3740
3741
3742
3743
3744
3745
3746
3747
3748
3749
3750
3751
3752
3753
3754
3755
3756
3757
3758
3759
3760
3761
3762
3763
3764
3765
3766
3767
3768
3769
3770
3771
3772
3773
3774
3775
3776
3777
3778
3779
3780
3781
3782
3783
3784
3785
3786
3787
3788
3789
3790
3791
3792
3793
3794
3795
3796
3797
3798
3799
3800
3801
3802
3803
3804
3805
3806
3807
3808
3809
3810
3811
3812
3813
3814
3815
3816
3817
3818
3819
3820
3821
3822
3823
3824
3825
3826
3827
3828
3829
3830
3831
3832
3833
3834
3835
3836
3837
3838
3839
3840
3841
3842
3843
3844
3845
3846
3847
3848
3849
3850
3851
3852
3853
3854
3855
3856
3857
3858
3859
3860
3861
3862
3863
3864
3865
3866
3867
3868
3869
3870
3871
3872
3873
3874
3875
3876
3877
3878
3879
3880
3881
3882
3883
3884
3885
3886
3887
3888
3889
3890
3891
3892
3893
3894
3895
3896
3897
3898
3899
3900
3901
3902
3903
3904
3905
3906
3907
3908
3909
3910
3911
3912
3913
3914
3915
3916
3917
3918
3919
3920
3921
3922
3923
3924
3925
3926
3927
3928
3929
3930
3931
3932
3933
3934
3935
3936
3937
3938
3939
3940
3941
3942
3943
3944
3945
3946
3947
3948
3949
3950
3951
3952
3953
3954
3955
3956
3957
3958
3959
3960
3961
3962
3963
3964
3965
3966
3967
3968
3969
3970
3971
3972
3973
3974
3975
3976
3977
3978
3979
3980
3981
3982
3983
3984
3985
3986
3987
3988
3989
3990
3991
3992
3993
3994
3995
3996
3997
3998
3999
4000
4001
4002
4003
4004
4005
4006
4007
4008
4009
4010
4011
4012
4013
4014
4015
4016
4017
4018
4019
4020
4021
4022
4023
4024
4025
4026
4027
4028
4029
4030
4031
4032
4033
4034
4035
4036
4037
4038
4039
4040
4041
4042
4043
4044
4045
4046
4047
4048
4049
4050
4051
4052
4053
4054
4055
4056
4057
4058
4059
4060
4061
4062
4063
4064
4065
4066
4067
4068
4069
4070
4071
4072
4073
4074
4075
4076
4077
4078
4079
4080
4081
4082
4083
4084
4085
4086
4087
4088
4089
4090
4091
4092
4093
4094
4095
4096
4097
4098
4099
4100
4101
4102
4103
4104
4105
4106
4107
4108
4109
4110
4111
4112
4113
4114
4115
4116
4117
4118
4119
4120
4121
4122
4123
4124
4125
4126
4127
4128
4129
4130
4131
4132
4133
4134
4135
4136
4137
4138
4139
4140
4141
4142
4143
4144
4145
4146
4147
4148
4149
4150
4151
4152
4153
4154
4155
4156
4157
4158
4159
4160
4161
4162
4163
4164
4165
4166
4167
4168
4169
4170
4171
4172
4173
4174
4175
4176
4177
4178
4179
4180
4181
4182
4183
4184
4185
4186
4187
4188
4189
4190
4191
4192
4193
4194
4195
4196
4197
4198
4199
4200
4201
4202
4203
4204
4205
4206
4207
4208
4209
4210
4211
4212
4213
4214
4215
4216
4217
4218
4219
4220
4221
4222
4223
4224
4225
4226
4227
4228
4229
4230
4231
4232
4233
4234
4235
4236
4237
4238
4239
4240
4241
4242
4243
4244
4245
4246
4247
4248
4249
4250
4251
4252
4253
4254
4255
4256
4257
4258
4259
4260
4261
4262
4263
4264
4265
4266
4267
4268
4269
4270
4271
4272
4273
4274
4275
4276
4277
4278
4279
4280
4281
4282
4283
4284
4285
4286
4287
4288
4289
4290
4291
4292
4293
4294
4295
4296
4297
4298
4299
4300
4301
4302
4303
4304
4305
4306
4307
4308
4309
4310
4311
4312
4313
4314
4315
4316
4317
4318
4319
4320
4321
4322
4323
4324
4325
4326
4327
4328
4329
4330
4331
4332
4333
4334
4335
4336
4337
4338
4339
4340
4341
4342
4343
4344
4345
4346
4347
4348
4349
4350
4351
4352
4353
4354
4355
4356
4357
4358
4359
4360
4361
4362
4363
4364
4365
4366
4367
4368
4369
4370
4371
4372
4373
4374
4375
4376
4377
4378
4379
4380
4381
4382
4383
4384
4385
4386
4387
4388
4389
4390
4391
4392
4393
4394
4395
4396
4397
4398
4399
4400
4401
4402
4403
4404
4405
4406
4407
4408
4409
4410
4411
4412
4413
4414
4415
4416
4417
4418
4419
4420
4421
4422
4423
4424
4425
4426
4427
4428
4429
4430
4431
4432
4433
4434
4435
4436
4437
4438
4439
4440
4441
4442
4443
4444
4445
4446
4447
4448
4449
4450
4451
4452
4453
4454
4455
4456
4457
4458
4459
4460
4461
4462
4463
4464
4465
4466
4467
4468
4469
4470
4471
4472
4473
4474
4475
4476
4477
4478
4479
4480
4481
4482
4483
4484
4485
4486
4487
4488
4489
4490
4491
4492
4493
4494
4495
4496
4497
4498
4499
4500
4501
4502
4503
4504
4505
4506
4507
4508
4509
4510
4511
4512
4513
4514
4515
4516
4517
4518
4519
4520
4521
4522
4523
4524
4525
4526
4527
4528
4529
4530
4531
4532
4533
4534
4535
4536
4537
4538
4539
4540
4541
4542
4543
4544
4545
4546
4547
4548
4549
4550
4551
4552
4553
4554
4555
4556
4557
4558
4559
4560
4561
4562
4563
4564
4565
4566
4567
4568
4569
4570
4571
4572
4573
4574
4575
4576
4577
4578
4579
4580
4581
4582
4583
4584
4585
4586
4587
4588
4589
4590
4591
4592
4593
4594
4595
4596
4597
4598
4599
4600
4601
4602
4603
4604
4605
4606
4607
4608
4609
4610
4611
4612
4613
4614
4615
4616
4617
4618
4619
4620
4621
4622
4623
4624
4625
4626
4627
4628
4629
4630
4631
4632
4633
4634
4635
4636
4637
4638
4639
4640
4641
4642
4643
4644
4645
4646
4647
4648
4649
4650
4651
4652
4653
4654
4655
4656
4657
4658
4659
4660
4661
4662
4663
4664
4665
4666
4667
4668
4669
4670
4671
4672
4673
4674
4675
4676
4677
4678
4679
4680
4681
4682
4683
4684
4685
4686
4687
4688
4689
4690
4691
4692
4693
4694
4695
4696
4697
4698
4699
4700
4701
4702
4703
4704
4705
4706
4707
4708
4709
4710
4711
4712
4713
4714
4715
4716
4717
4718
4719
4720
4721
4722
4723
4724
4725
4726
4727
4728
4729
4730
4731
4732
4733
4734
4735
4736
4737
4738
4739
4740
4741
4742
4743
4744
4745
4746
4747
4748
4749
4750
4751
4752
4753
4754
4755
4756
4757
4758
4759
4760
4761
4762
4763
4764
4765
4766
4767
4768
4769
4770
4771
4772
4773
4774
4775
4776
4777
4778
4779
4780
4781
4782
4783
4784
4785
4786
4787
4788
4789
4790
4791
4792
4793
4794
4795
4796
4797
4798
4799
4800
4801
4802
4803
4804
4805
4806
4807
4808
4809
4810
4811
4812
4813
4814
4815
4816
4817
4818
4819
4820
4821
4822
4823
4824
4825
4826
4827
4828
4829
4830
4831
4832
4833
4834
4835
4836
4837
4838
4839
4840
4841
4842
4843
4844
4845
4846
4847
4848
4849
4850
4851
4852
4853
4854
4855
4856
4857
4858
4859
4860
4861
4862
4863
4864
4865
4866
4867
4868
4869
4870
4871
4872
4873
4874
4875
4876
4877
4878
4879
4880
4881
4882
4883
4884
4885
4886
4887
4888
4889
4890
4891
4892
4893
4894
4895
4896
4897
4898
4899
4900
4901
4902
4903
4904
4905
4906
4907
4908
4909
4910
4911
4912
4913
4914
4915
4916
4917
4918
4919
4920
4921
4922
4923
4924
4925
4926
4927
4928
4929
4930
4931
4932
4933
4934
4935
4936
4937
4938
4939
4940
4941
4942
4943
4944
4945
4946
4947
4948
4949
4950
4951
4952
4953
4954
4955
4956
4957
4958
4959
4960
4961
4962
4963
4964
4965
4966
4967
4968
4969
4970
4971
4972
4973
4974
4975
4976
4977
4978
4979
4980
4981
4982
4983
4984
4985
4986
4987
4988
4989
4990
4991
4992
4993
4994
4995
4996
4997
4998
4999
5000
5001
5002
5003
5004
5005
5006
5007
5008
5009
5010
5011
5012
5013
5014
5015
5016
5017
5018
5019
5020
5021
5022
5023
5024
5025
5026
5027
5028
5029
5030
5031
5032
5033
5034
5035
5036
5037
5038
5039
5040
5041
5042
5043
5044
5045
5046
5047
5048
5049
5050
5051
5052
5053
5054
5055
5056
5057
5058
5059
5060
5061
5062
5063
5064
5065
5066
5067
5068
5069
5070
5071
5072
5073
5074
5075
5076
5077
5078
5079
5080
5081
5082
5083
5084
5085
5086
5087
5088
5089
5090
5091
5092
5093
5094
5095
5096
5097
5098
5099
5100
5101
5102
5103
5104
5105
5106
5107
5108
5109
5110
5111
5112
5113
5114
5115
5116
5117
5118
5119
5120
5121
5122
5123
5124
5125
5126
5127
5128
5129
5130
5131
5132
5133
5134
5135
5136
5137
5138
5139
5140
5141
5142
5143
5144
5145
5146
5147
5148
5149
5150
5151
5152
5153
5154
5155
5156
5157
5158
5159
5160
5161
5162
5163
5164
5165
5166
5167
5168
5169
5170
5171
5172
5173
5174
5175
5176
5177
5178
5179
5180
5181
5182
5183
5184
5185
5186
5187
5188
5189
5190
5191
5192
5193
5194
5195
5196
5197
5198
5199
5200
5201
5202
5203
5204
5205
5206
5207
5208
5209
5210
5211
5212
5213
5214
5215
5216
5217
5218
5219
5220
5221
5222
5223
5224
5225
5226
5227
5228
5229
5230
5231
5232
5233
5234
5235
5236
5237
5238
5239
5240
5241
5242
5243
5244
5245
5246
5247
5248
5249
5250
5251
5252
5253
5254
5255
5256
5257
5258
5259
5260
5261
5262
5263
5264
5265
5266
5267
5268
5269
5270
5271
5272
5273
5274
5275
5276
5277
5278
5279
5280
5281
5282
5283
5284
5285
5286
5287
5288
5289
5290
5291
5292
5293
5294
5295
5296
5297
5298
5299
5300
5301
5302
5303
5304
5305
5306
5307
5308
5309
5310
5311
5312
5313
5314
5315
5316
5317
5318
5319
5320
5321
5322
5323
5324
5325
5326
5327
5328
5329
5330
5331
5332
5333
5334
5335
5336
5337
5338
5339
5340
5341
5342
5343
5344
5345
5346
5347
5348
5349
5350
5351
5352
5353
5354
5355
5356
5357
5358
5359
5360
5361
5362
5363
5364
5365
5366
5367
5368
5369
5370
5371
5372
5373
5374
5375
5376
5377
5378
5379
5380
5381
5382
5383
5384
5385
5386
5387
5388
5389
5390
5391
5392
5393
5394
5395
5396
5397
5398
5399
5400
5401
5402
5403
5404
5405
5406
5407
5408
5409
5410
5411
5412
5413
5414
5415
5416
5417
5418
5419
5420
5421
5422
5423
5424
5425
5426
5427
5428
5429
5430
5431
5432
5433
5434
5435
5436
5437
5438
5439
5440
5441
5442
5443
5444
5445
5446
5447
5448
5449
5450
5451
5452
5453
5454
5455
5456
5457
5458
5459
5460
5461
5462
5463
5464
5465
5466
5467
5468
5469
5470
5471
5472
5473
5474
5475
5476
5477
5478
5479
5480
5481
5482
5483
5484
5485
5486
5487
5488
5489
5490
5491
5492
5493
5494
5495
5496
5497
5498
5499
5500
5501
5502
5503
5504
5505
5506
5507
5508
5509
5510
5511
5512
5513
5514
5515
5516
5517
5518
5519
5520
5521
5522
5523
5524
5525
5526
5527
5528
5529
5530
5531
5532
5533
5534
5535
5536
5537
5538
5539
5540
5541
5542
5543
5544
5545
5546
5547
5548
5549
5550
5551
5552
5553
5554
5555
5556
5557
5558
5559
5560
5561
5562
5563
5564
5565
5566
5567
5568
5569
5570
5571
5572
5573
5574
5575
5576
5577
5578
5579
5580
5581
5582
5583
5584
5585
5586
5587
5588
5589
5590
5591
5592
5593
5594
5595
5596
5597
5598
5599
5600
5601
5602
5603
5604
5605
5606
5607
5608
5609
5610
5611
5612
5613
5614
5615
5616
5617
5618
5619
5620
5621
5622
5623
5624
5625
5626
5627
5628
5629
5630
5631
5632
5633
5634
5635
5636
5637
5638
5639
5640
5641
5642
5643
5644
5645
5646
5647
5648
5649
5650
5651
5652
5653
5654
5655
5656
5657
5658
5659
5660
5661
5662
5663
5664
5665
5666
5667
5668
5669
5670
5671
5672
5673
5674
5675
5676
5677
5678
5679
5680
5681
5682
5683
5684
5685
5686
5687
5688
5689
5690
5691
5692
5693
5694
5695
5696
5697
5698
5699
5700
5701
5702
5703
5704
5705
5706
5707
5708
5709
5710
5711
5712
5713
5714
5715
5716
5717
5718
5719
5720
5721
5722
5723
5724
5725
5726
5727
5728
5729
5730
5731
5732
5733
5734
5735
5736
5737
5738
5739
5740
5741
5742
5743
5744
5745
5746
5747
5748
5749
5750
5751
5752
5753
5754
5755
5756
5757
5758
5759
5760
5761
5762
5763
5764
5765
5766
5767
5768
5769
5770
5771
5772
5773
5774
5775
5776
5777
5778
5779
5780
5781
5782
5783
5784
5785
5786
5787
5788
5789
5790
5791
5792
5793
5794
5795
5796
5797
5798
5799
5800
5801
5802
5803
5804
5805
5806
5807
5808
5809
5810
5811
5812
5813
5814
5815
5816
5817
5818
5819
5820
5821
5822
5823
5824
5825
5826
5827
5828
5829
5830
5831
5832
5833
5834
5835
5836
5837
5838
5839
5840
5841
5842
5843
5844
5845
5846
5847
5848
5849
5850
5851
5852
5853
5854
5855
5856
5857
5858
5859
5860
5861
5862
5863
5864
5865
5866
5867
5868
5869
5870
5871
5872
5873
5874
5875
5876
5877
5878
5879
5880
5881
5882
5883
5884
5885
5886
5887
5888
5889
5890
5891
5892
5893
5894
5895
5896
5897
5898
5899
5900
5901
5902
5903
5904
5905
5906
5907
5908
5909
5910
5911
5912
5913
5914
5915
5916
5917
5918
5919
5920
5921
5922
5923
5924
5925
5926
5927
5928
5929
5930
5931
5932
5933
5934
5935
5936
5937
5938
5939
5940
5941
5942
5943
5944
5945
5946
5947
5948
5949
5950
5951
5952
5953
5954
5955
5956
5957
5958
5959
5960
5961
5962
5963
5964
5965
5966
5967
5968
5969
5970
5971
5972
5973
5974
5975
5976
5977
5978
5979
5980
5981
5982
5983
5984
5985
5986
5987
5988
5989
5990
5991
5992
5993
5994
5995
5996
5997
5998
5999
6000
6001
6002
6003
6004
6005
6006
6007
6008
6009
6010
6011
6012
6013
6014
6015
6016
6017
6018
6019
6020
6021
6022
6023
6024
6025
6026
6027
6028
6029
6030
6031
6032
6033
6034
6035
6036
6037
6038
6039
6040
6041
6042
6043
6044
6045
6046
6047
6048
6049
6050
6051
6052
6053
6054
6055
6056
6057
6058
6059
6060
6061
6062
6063
6064
6065
6066
6067
6068
6069
6070
6071
6072
6073
6074
6075
6076
6077
6078
6079
6080
6081
6082
6083
6084
6085
6086
6087
6088
6089
6090
6091
6092
6093
6094
6095
6096
6097
6098
6099
6100
6101
6102
6103
6104
6105
6106
6107
6108
6109
6110
6111
6112
6113
6114
6115
6116
6117
6118
6119
6120
6121
6122
6123
6124
6125
6126
6127
6128
6129
6130
6131
6132
6133
6134
6135
6136
6137
6138
6139
6140
6141
6142
6143
6144
6145
6146
6147
6148
6149
6150
6151
6152
6153
6154
6155
6156
6157
6158
6159
6160
6161
6162
6163
6164
6165
6166
6167
6168
6169
6170
6171
6172
6173
6174
6175
6176
6177
6178
6179
6180
6181
6182
6183
6184
6185
6186
6187
6188
6189
6190
6191
6192
6193
6194
6195
6196
6197
6198
6199
6200
6201
6202
6203
6204
6205
6206
6207
6208
6209
6210
6211
6212
6213
6214
6215
6216
6217
6218
6219
6220
6221
6222
6223
6224
6225
6226
6227
6228
6229
6230
6231
6232
6233
6234
6235
6236
6237
6238
6239
6240
6241
6242
6243
6244
6245
6246
6247
6248
6249
6250
6251
6252
6253
6254
6255
6256
6257
6258
6259
6260
6261
6262
6263
6264
6265
6266
6267
6268
6269
6270
6271
6272
6273
6274
6275
6276
6277
6278
6279
6280
6281
6282
6283
6284
6285
6286
6287
6288
6289
6290
6291
6292
6293
6294
6295
6296
6297
6298
6299
6300
6301
6302
6303
6304
6305
6306
6307
6308
6309
6310
6311
6312
6313
6314
6315
6316
6317
6318
6319
6320
6321
6322
6323
6324
6325
6326
6327
6328
6329
6330
6331
6332
6333
6334
6335
6336
6337
6338
6339
6340
6341
6342
6343
6344
6345
6346
6347
6348
6349
6350
6351
6352
6353
6354
6355
6356
6357
6358
6359
6360
6361
6362
6363
6364
6365
6366
6367
6368
6369
6370
6371
6372
6373
6374
6375
6376
6377
6378
6379
6380
6381
6382
6383
6384
6385
6386
6387
6388
6389
6390
6391
6392
6393
6394
6395
6396
6397
6398
6399
6400
6401
6402
6403
6404
6405
6406
6407
6408
6409
6410
6411
6412
6413
6414
6415
6416
6417
6418
6419
6420
6421
6422
6423
6424
6425
6426
6427
6428
6429
6430
6431
6432
6433
6434
6435
6436
6437
6438
6439
6440
6441
6442
6443
6444
6445
6446
6447
6448
6449
6450
6451
6452
6453
6454
6455
6456
6457
6458
6459
6460
6461
6462
6463
6464
6465
6466
6467
6468
6469
6470
6471
6472
6473
6474
6475
6476
6477
6478
6479
6480
6481
6482
6483
6484
6485
6486
6487
6488
6489
6490
6491
6492
6493
6494
6495
6496
6497
6498
6499
6500
6501
6502
6503
6504
6505
6506
6507
6508
6509
6510
6511
6512
6513
6514
6515
6516
6517
6518
6519
6520
6521
6522
6523
6524
6525
6526
6527
6528
6529
6530
6531
6532
6533
6534
6535
6536
6537
6538
6539
6540
6541
6542
6543
6544
6545
6546
6547
6548
6549
6550
6551
6552
6553
6554
6555
6556
6557
6558
6559
6560
6561
6562
6563
6564
6565
6566
6567
6568
6569
6570
6571
6572
6573
6574
6575
6576
6577
6578
6579
6580
6581
6582
6583
6584
6585
6586
6587
6588
6589
6590
6591
6592
6593
6594
6595
6596
6597
6598
6599
6600
6601
6602
6603
6604
6605
6606
6607
6608
6609
6610
6611
6612
6613
6614
6615
6616
6617
6618
6619
6620
6621
6622
6623
6624
6625
6626
6627
6628
6629
6630
6631
6632
6633
6634
6635
6636
6637
6638
6639
6640
6641
6642
6643
6644
6645
6646
6647
6648
6649
6650
6651
6652
6653
6654
6655
6656
6657
6658
6659
6660
6661
6662
6663
6664
6665
6666
6667
6668
6669
6670
6671
6672
6673
6674
6675
6676
6677
6678
6679
6680
6681
6682
6683
6684
6685
6686
6687
6688
6689
6690
6691
6692
6693
6694
6695
6696
6697
6698
6699
6700
6701
6702
6703
6704
6705
6706
6707
6708
6709
6710
6711
6712
6713
6714
6715
6716
6717
6718
6719
6720
6721
6722
6723
6724
6725
6726
6727
6728
6729
6730
6731
6732
6733
6734
6735
6736
6737
6738
6739
6740
6741
6742
6743
6744
6745
6746
6747
6748
6749
6750
6751
6752
6753
6754
6755
6756
6757
6758
6759
6760
6761
6762
6763
6764
6765
6766
6767
6768
6769
6770
6771
6772
6773
6774
6775
6776
6777
6778
6779
6780
6781
6782
6783
6784
6785
6786
6787
6788
6789
6790
6791
6792
6793
6794
6795
6796
6797
6798
6799
6800
6801
6802
6803
6804
6805
6806
6807
6808
6809
6810
6811
6812
6813
6814
6815
6816
6817
6818
6819
6820
6821
6822
6823
6824
6825
6826
6827
6828
6829
6830
6831
6832
6833
6834
6835
6836
6837
6838
6839
6840
6841
6842
6843
6844
6845
6846
6847
6848
6849
6850
6851
6852
6853
6854
6855
6856
6857
6858
6859
6860
6861
6862
6863
6864
6865
6866
6867
6868
6869
6870
6871
6872
6873
6874
6875
6876
6877
6878
6879
6880
6881
6882
6883
6884
6885
6886
6887
6888
6889
6890
6891
6892
6893
6894
6895
6896
6897
6898
6899
6900
6901
6902
6903
6904
6905
6906
6907
6908
6909
6910
6911
6912
6913
6914
6915
6916
6917
6918
6919
6920
6921
6922
6923
6924
6925
6926
6927
6928
6929
6930
6931
6932
6933
6934
6935
6936
6937
6938
6939
6940
6941
6942
6943
6944
6945
6946
6947
6948
6949
6950
6951
6952
6953
6954
6955
6956
6957
6958
6959
6960
6961
6962
6963
6964
6965
6966
6967
6968
6969
6970
6971
6972
6973
6974
6975
6976
6977
6978
6979
6980
6981
6982
6983
6984
6985
6986
6987
6988
6989
6990
6991
6992
6993
6994
6995
6996
6997
6998
6999
7000
7001
7002
7003
7004
7005
7006
7007
7008
7009
7010
7011
7012
7013
7014
7015
7016
7017
7018
7019
7020
7021
7022
7023
7024
7025
7026
7027
7028
7029
7030
7031
7032
7033
7034
7035
7036
7037
7038
7039
7040
7041
7042
7043
7044
7045
7046
7047
7048
7049
7050
7051
7052
7053
7054
7055
7056
7057
7058
7059
7060
7061
7062
7063
7064
7065
7066
7067
7068
7069
7070
7071
7072
7073
7074
7075
7076
7077
7078
7079
7080
7081
7082
7083
7084
7085
7086
7087
7088
7089
7090
7091
7092
7093
7094
7095
7096
7097
7098
7099
7100
7101
7102
7103
7104
7105
7106
7107
7108
7109
7110
7111
7112
7113
7114
7115
7116
7117
7118
7119
7120
7121
7122
7123
7124
7125
7126
7127
7128
7129
7130
7131
7132
7133
7134
7135
7136
7137
7138
7139
7140
7141
7142
7143
7144
7145
7146
7147
7148
7149
7150
7151
7152
7153
7154
7155
7156
7157
7158
7159
7160
7161
7162
7163
7164
7165
7166
7167
7168
7169
7170
7171
7172
7173
7174
7175
7176
7177
7178
7179
7180
7181
7182
7183
7184
7185
7186
7187
7188
7189
7190
7191
7192
7193
7194
7195
7196
7197
7198
7199
7200
7201
7202
7203
7204
7205
7206
7207
7208
7209
7210
7211
7212
7213
7214
7215
7216
7217
7218
7219
7220
7221
7222
7223
7224
7225
7226
7227
7228
7229
7230
7231
7232
7233
7234
7235
7236
7237
7238
7239
7240
7241
7242
7243
7244
7245
7246
7247
7248
7249
7250
7251
7252
7253
7254
7255
7256
7257
7258
7259
7260
7261
7262
7263
7264
7265
7266
7267
7268
7269
7270
7271
7272
7273
7274
7275
7276
7277
7278
7279
7280
7281
7282
7283
7284
7285
7286
7287
7288
7289
7290
7291
7292
7293
7294
7295
7296
7297
7298
7299
7300
7301
7302
7303
7304
7305
7306
7307
7308
7309
7310
7311
7312
7313
7314
7315
7316
7317
7318
7319
7320
7321
7322
7323
7324
7325
7326
7327
7328
7329
7330
7331
7332
7333
7334
7335
7336
7337
7338
7339
7340
7341
7342
7343
|
/****************************************************************************
* 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. *
* *
****************************************************************************/
/* $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 "H5Fprivate.h" /* Files */
#include "H5FDprivate.h" /* File drivers */
#include "H5FLprivate.h" /* Free Lists */
#include "H5MMprivate.h" /* Memory management */
#include "H5Pprivate.h" /* Property lists */
/* Default file driver - see H5Pget_driver() */
#include "H5FDsec2.h" /* Posix unbuffered I/O file driver */
#ifdef WANT_H5_V1_2_COMPAT
/* Other predefined file drivers */
#include "H5FDcore.h" /* Files stored entirely in memory */
#include "H5FDfamily.h" /* File families */
#include "H5FDmpio.h" /* Parallel files using MPI-2 I/O */
#include "H5FDstdio.h" /* Standard C buffered I/O */
#include "H5FDsrb.h" /* Remote access using SRB */
#include "H5FDgass.h" /* Remote files using GASS I/O */
#include "H5FDstream.h" /* in-memory files streamed via sockets */
#include "H5FDmulti.h" /* Usage-partitioned file family */
#include "H5FDlog.h" /* sec2 driver with I/O logging (for debugging) */
#endif /* WANT_H5_V1_2_COMPAT */
#define PABLO_MASK H5P_mask
/* Is the interface initialized? */
static int interface_initialize_g = 0;
#define INTERFACE_INIT H5P_init_interface
static herr_t H5P_init_interface(void);
/*
* Predefined data types. These are initialized at runtime by
* H5P_init_interface() in this source file.
*/
hid_t H5P_NO_CLASS_g = FAIL;
hid_t H5P_FILE_CREATE_g = FAIL;
hid_t H5P_FILE_ACCESS_g = FAIL;
hid_t H5P_DATASET_CREATE_g = FAIL;
hid_t H5P_DATASET_XFER_g = FAIL;
hid_t H5P_MOUNT_g = FAIL;
/* Local static functions */
static H5P_genclass_t *H5P_create_class(H5P_genclass_t *par_class,
const char *name, unsigned hashsize, unsigned internal,
H5P_cls_create_func_t cls_create, void *create_data,
H5P_cls_close_func_t cls_close, void *close_data);
static herr_t H5P_close_list(void *_plist);
static herr_t H5P_close_class(void *_pclass);
/* Declare a free list to manage the H5P_t struct */
H5FL_DEFINE_STATIC(H5P_t);
/*-------------------------------------------------------------------------
* Function: H5P_init
*
* Purpose: Initialize the interface from some other layer.
*
* Return: Success: non-negative
*
* Failure: negative
*
* Programmer: Quincey Koziol
* Saturday, March 4, 2000
*
* Modifications:
*
*-------------------------------------------------------------------------
*/
herr_t
H5P_init(void)
{
FUNC_ENTER(H5P_init, FAIL);
/* FUNC_ENTER() does all the work */
FUNC_LEAVE(SUCCEED);
}
/*--------------------------------------------------------------------------
NAME
H5P_xor_name -- Generate an xor'ed value for a string
USAGE
unsigned H5P_xor_name(s)
const char *s; IN: String to operate over
RETURNS
Always returns valid value
DESCRIPTION
Generates an xor'ed value for a string
--------------------------------------------------------------------------*/
static unsigned
H5P_xor_name(const char *s)
{
unsigned ret=0;
unsigned char temp;
if(s!=NULL)
while(*s!='\0') {
temp=(ret>>24)&0xff;
ret <<= 8;
ret |= temp;
ret ^= *s++;
}
return(ret);
} /* end H5P_xor_name() */
/*--------------------------------------------------------------------------
NAME
H5P_hash_name -- Generate a hash value for a string
USAGE
unsigned H5P_hash_name(s, hashsize)
const char *s; IN: String to operate over
unsigned; IN: Size of hash table to clip against
RETURNS
Always returns valid value
DESCRIPTION
Generates a hash location based on an xor'ed value for a string
--------------------------------------------------------------------------*/
static unsigned
H5P_hash_name(const char *s, unsigned hashsize)
{
return(H5P_xor_name(s)%hashsize);
} /* end H5P_hash_name() */
/*--------------------------------------------------------------------------
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)
{
H5P_genclass_t *root_class; /* Pointer to root property list class created */
H5P_genclass_t *pclass; /* Pointer to property list class to create */
herr_t ret_value = SUCCEED;
int i;
herr_t status;
FUNC_ENTER(H5P_init_interface, FAIL);
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, (H5I_free_t)H5P_close);
if (status < 0)
ret_value = FAIL;
}
if (ret_value < 0) {
HRETURN_ERROR(H5E_ATOM, H5E_CANTINIT, FAIL,
"unable to initialize atom group");
}
/*
* Initialize the Generic Property class & object groups.
*/
if (H5I_init_group(H5I_GENPROP_CLS, H5I_GENPROPCLS_HASHSIZE, 0, (H5I_free_t)H5P_close_class) < 0)
HRETURN_ERROR(H5E_ATOM, H5E_CANTINIT, FAIL,
"unable to initialize atom group");
if (H5I_init_group(H5I_GENPROP_LST, H5I_GENPROPOBJ_HASHSIZE, 0, (H5I_free_t)H5P_close_list) < 0)
HRETURN_ERROR(H5E_ATOM, H5E_CANTINIT, FAIL,
"unable to initialize atom group");
/* Create root property list class */
/* Allocate the root class */
if (NULL==(root_class = H5P_create_class (NULL,"none",H5P_NO_CLASS_HASH_SIZE,1,NULL,NULL,NULL,NULL)))
HRETURN_ERROR (H5E_PLIST, H5E_CANTINIT, FAIL, "class initialization failed");
/* Register the root class */
if ((H5P_NO_CLASS_g = H5I_register (H5I_GENPROP_CLS, root_class))<0)
HRETURN_ERROR (H5E_PLIST, H5E_CANTREGISTER, FAIL, "can't register property list class");
/* Register the file creation and file access property classes */
/* Allocate the file creation class */
if (NULL==(pclass = H5P_create_class (root_class,"file create",H5P_FILE_CREATE_HASH_SIZE,1,NULL,NULL,NULL,NULL)))
HRETURN_ERROR (H5E_PLIST, H5E_CANTINIT, FAIL, "class initialization failed");
/* Register the dataset creation class */
if ((H5P_FILE_CREATE_g = H5I_register (H5I_GENPROP_CLS, pclass))<0)
HRETURN_ERROR (H5E_PLIST, H5E_CANTREGISTER, FAIL, "can't register property list class");
/* Allocate the file access class */
if (NULL==(pclass = H5P_create_class (root_class,"file access",H5P_FILE_ACCESS_HASH_SIZE,1,NULL,NULL,NULL,NULL)))
HRETURN_ERROR (H5E_PLIST, H5E_CANTINIT, FAIL, "class initialization failed");
/* Register the file access class */
if ((H5P_DATASET_XFER_g = H5I_register (H5I_GENPROP_CLS, pclass))<0)
HRETURN_ERROR (H5E_PLIST, H5E_CANTREGISTER, FAIL, "can't register property list class");
/* Register the dataset creation and data xfer property classes */
/* Allocate the dataset creation class */
if (NULL==(pclass = H5P_create_class (root_class,"dataset create",H5P_DATASET_CREATE_HASH_SIZE,1,NULL,NULL,NULL,NULL)))
HRETURN_ERROR (H5E_PLIST, H5E_CANTINIT, FAIL, "class initialization failed");
/* Register the dataset creation class */
if ((H5P_DATASET_CREATE_g = H5I_register (H5I_GENPROP_CLS, pclass))<0)
HRETURN_ERROR (H5E_PLIST, H5E_CANTREGISTER, FAIL, "can't register property list class");
/* Allocate the data xfer class */
if (NULL==(pclass = H5P_create_class (root_class,"data xfer",H5P_DATASET_XFER_HASH_SIZE,1,NULL,NULL,NULL,NULL)))
HRETURN_ERROR (H5E_PLIST, H5E_CANTINIT, FAIL, "class initialization failed");
/* Register the data xfer class */
if ((H5P_DATASET_XFER_g = H5I_register (H5I_GENPROP_CLS, pclass))<0)
HRETURN_ERROR (H5E_PLIST, H5E_CANTREGISTER, FAIL, "can't register property list class");
/* When do the "basic" properties for each of the library classes get added? */
/* Who adds them? */
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
--------------------------------------------------------------------------*/
int
H5P_term_interface(void)
{
int i, n=0;
if (interface_initialize_g) {
/* Destroy HDF5 library property classes */
for (i=0; i<H5P_NCLASSES; i++)
n += H5I_nmembers((H5I_type_t)(H5I_TEMPLATE_0+i));
n += H5I_nmembers(H5I_GENPROP_CLS);
n += H5I_nmembers(H5I_GENPROP_LST);
if (n) {
for (i=0; i<H5P_NCLASSES; i++)
H5I_clear_group((H5I_type_t)(H5I_TEMPLATE_0+i), FALSE);
H5I_clear_group(H5I_GENPROP_CLS, FALSE);
H5I_clear_group(H5I_GENPROP_LST, FALSE);
} else {
for (i=0; i<H5P_NCLASSES; i++) {
H5I_destroy_group((H5I_type_t)(H5I_TEMPLATE_0 + i));
n++; /*H5I*/
}
H5I_destroy_group(H5I_GENPROP_CLS);
n++; /*H5I*/
H5I_destroy_group(H5I_GENPROP_LST);
n++; /*H5I*/
interface_initialize_g = 0;
}
}
return n;
}
/*-------------------------------------------------------------------------
* Function: H5Pcreate
*
* Purpose: Creates a new property list by copying a default property
* list.
*
* Return: Success: A new copy of a default property list.
*
* Failure: NULL
*
* Programmer: Unknown
*
* Modifications:
* Robb Matzke, 1999-08-18
* Rewritten in terms of H5P_copy() to fix memory leaks.
*-------------------------------------------------------------------------
*/
hid_t
H5Pcreate(H5P_class_t type)
{
hid_t ret_value = FAIL;
const void *src = NULL;
H5P_t *new_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:
src = &H5F_create_dflt;
break;
case H5P_FILE_ACCESS:
src = &H5F_access_dflt;
break;
case H5P_DATASET_CREATE:
src = &H5D_create_dflt;
break;
case H5P_DATASET_XFER:
src = &H5D_xfer_dflt;
break;
case H5P_MOUNT:
src = &H5F_mount_dflt;
break;
default:
HRETURN_ERROR(H5E_ARGS, H5E_BADVALUE, FAIL,
"unknown property list class");
}
/* Copy the property list */
if (NULL==(new_plist=H5P_copy(type, src))) {
HRETURN_ERROR(H5E_PLIST, H5E_CANTINIT, FAIL,
"unable to copy default property list");
}
/* Atomize the new property list */
if ((ret_value = H5P_create(type, new_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, H5P_t *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);
}
/*-------------------------------------------------------------------------
* Function: H5Pclose
*
* Purpose: Release access to a property list object, PLIST_ID.
*
* Return: Success: non-negative
*
* Failure: negative
*
* Programmer: Unknown
*
* Modifications:
* Robb Matzke, 1999-08-03
* Attempting to close H5P_DEFAULT is no longer an error, but
* rather a no-op.
*-------------------------------------------------------------------------
*/
herr_t
H5Pclose(hid_t plist_id)
{
FUNC_ENTER(H5Pclose, FAIL);
H5TRACE1("e","i",plist_id);
/* Check arguments */
if (plist_id==H5P_DEFAULT)
HRETURN(SUCCEED);
if (H5P_get_class (plist_id)<0) {
HRETURN_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL, "not a property list");
}
/* When the reference count reaches zero the resources are freed */
if (H5I_dec_ref(plist_id) < 0)
HRETURN_ERROR(H5E_ATOM, H5E_BADATOM, FAIL, "problem freeing property list");
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:
* Robb Matzke, 1999-08-03
* Modified to work with the virtual file layer.
*-------------------------------------------------------------------------
*/
herr_t
H5P_close(void *_plist)
{
H5P_t *plist=(H5P_t *)_plist;
H5F_access_t *fa_list = &(plist->u.faccess);
H5D_xfer_t *dx_list = &(plist->u.dxfer);
H5D_create_t *dc_list = &(plist->u.dcreate);
FUNC_ENTER (H5P_close, FAIL);
/* Check args */
if (!plist)
HRETURN (SUCCEED);
/* Some property lists may need to do special things */
switch (plist->cls) {
case H5P_FILE_ACCESS:
if (fa_list->driver_id>=0) {
H5FD_fapl_free(fa_list->driver_id, fa_list->driver_info);
H5I_dec_ref(fa_list->driver_id);
fa_list->driver_info = NULL;
fa_list->driver_id = -1;
}
break;
case H5P_FILE_CREATE:
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:
if (dx_list->driver_id>=0) {
H5FD_dxpl_free(dx_list->driver_id, dx_list->driver_info);
H5I_dec_ref(dx_list->driver_id);
dx_list->driver_info = NULL;
dx_list->driver_id = -1;
}
break;
case H5P_MOUNT:
break;
default:
HRETURN_ERROR (H5E_ARGS, H5E_BADTYPE, FAIL,
"unknown property list class");
}
/* Return the property list to the free list */
H5FL_FREE(H5P_t,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 ||
group >= H5I_TEMPLATE_MAX ||
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 ||
group >= H5I_TEMPLATE_MAX ||
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: H5Pcopy
*
* Purpose: Deep-copies a property list PLIST_ID.
*
* Return: Success: The ID of the new copy of the property list.
* The ID will be different than the input ID
* since the new ID refers to a completely
* separate copy of the the structure that the
* original ID points to.
*
* Failure: Negative
*
* Programmer: Unknown
*
* Modifications:
* Robb Matzke, 1999-08-03
* If PLIST_ID is H5P_DEFAULT then we return H5P_DEFAULT.
*-------------------------------------------------------------------------
*/
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);
if (H5P_DEFAULT==plist_id)
HRETURN(H5P_DEFAULT);
/* 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:
* Robb Matzke, 1999-08-03
* Modified to use the virtual file layer.
*-------------------------------------------------------------------------
*/
void *
H5P_copy (H5P_class_t type, const void *src)
{
size_t size;
H5P_t *dst = NULL;
const H5D_create_t *dc_src = NULL;
H5D_create_t *dc_dst = NULL;
H5F_access_t *fa_dst = NULL;
H5D_xfer_t *dx_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 = H5FL_ALLOC(H5P_t,0))) {
HRETURN_ERROR (H5E_RESOURCE, H5E_NOSPACE, NULL,
"memory allocation failed");
}
/* Copy into new object */
HDmemcpy(dst, src, size);
/* Set the type of the property list */
dst->cls=type;
/* Deep-copy pointers */
switch (type) {
case H5P_FILE_CREATE:
break;
case H5P_FILE_ACCESS:
fa_dst = (H5F_access_t*)dst;
if (fa_dst->driver_id>=0) {
H5I_inc_ref(fa_dst->driver_id);
fa_dst->driver_info = H5FD_fapl_copy(fa_dst->driver_id,
fa_dst->driver_info);
}
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:
dx_dst = (H5D_xfer_t*)dst;
if (dx_dst->driver_id>=0) {
H5I_inc_ref(dx_dst->driver_id);
dx_dst->driver_info = H5FD_dxpl_copy(dx_dst->driver_id,
dx_dst->driver_info);
}
break;
case H5P_MOUNT:
/* Nothing to do */
break;
default:
HRETURN_ERROR(H5E_ARGS, H5E_BADRANGE, NULL,
"unknown property list class");
}
FUNC_LEAVE (dst);
}
/*-------------------------------------------------------------------------
* 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)
{
unsigned 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_sizes, 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) {
int 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: H5Pset_driver
*
* Purpose: Set the file driver (DRIVER_ID) for a file access or data
* transfer property list (PLIST_ID) and supply an optional
* struct containing the driver-specific properites
* (DRIVER_INFO). The driver properties will be copied into the
* property list and the reference count on the driver will be
* incremented, allowing the caller to close the driver ID but
* still use the property list.
*
* Return: Success: Non-negative
*
* Failure: Negative
*
* Programmer: Robb Matzke
* Tuesday, August 3, 1999
*
* Modifications:
*
*-------------------------------------------------------------------------
*/
herr_t
H5Pset_driver(hid_t plist_id, hid_t driver_id, const void *driver_info)
{
H5F_access_t *fapl=NULL;
H5D_xfer_t *dxpl=NULL;
FUNC_ENTER(H5Pset_driver, FAIL);
H5TRACE3("e","iix",plist_id,driver_id,driver_info);
if (H5I_VFL!=H5I_get_type(driver_id) ||
NULL==H5I_object(driver_id)) {
HRETURN_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL, "not a file driver ID");
}
if (H5P_FILE_ACCESS==H5P_get_class(plist_id)) {
if (NULL==(fapl=H5I_object(plist_id))) {
HRETURN_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL,
"not a file access property list");
}
/* Remove old driver */
assert(fapl->driver_id>=0);
H5FD_fapl_free(fapl->driver_id, fapl->driver_info);
H5I_dec_ref(fapl->driver_id);
/* Add new driver */
H5I_inc_ref(driver_id);
fapl->driver_id = driver_id;
fapl->driver_info = H5FD_fapl_copy(driver_id, driver_info);
} else if (H5P_DATASET_XFER==H5P_get_class(plist_id)) {
if (NULL==(dxpl=H5I_object(plist_id))) {
HRETURN_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL,
"not a file access property list");
}
/* Remove old driver */
assert(dxpl->driver_id>=0);
H5FD_dxpl_free(dxpl->driver_id, dxpl->driver_info);
H5I_dec_ref(dxpl->driver_id);
/* Add new driver */
H5I_inc_ref(driver_id);
dxpl->driver_id = driver_id;
dxpl->driver_info = H5FD_dxpl_copy(driver_id, driver_info);
} else {
HRETURN_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL,
"not a file access or data transfer property list");
}
FUNC_LEAVE(SUCCEED);
}
#ifdef WANT_H5_V1_2_COMPAT
/*-------------------------------------------------------------------------
* 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;
H5F_driver_t ret_value=H5F_LOW_ERROR;
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");
}
if(plist->driver_id==H5FD_SEC2 || plist->driver_id==H5P_DEFAULT)
ret_value=H5F_LOW_SEC2;
else if(plist->driver_id==H5FD_STDIO)
ret_value=H5F_LOW_STDIO;
else if(plist->driver_id==H5FD_MPIO)
ret_value=H5F_LOW_MPIO;
else if(plist->driver_id==H5FD_CORE)
ret_value=H5F_LOW_CORE;
else if(plist->driver_id==H5FD_FAMILY)
ret_value=H5F_LOW_FAMILY;
else if(plist->driver_id==H5FD_MULTI) { /* Need to check if it's a split or multi file */
H5FD_mem_t mt;
H5FD_mem_t memb_map[H5FD_MEM_NTYPES];
haddr_t memb_addr[H5FD_MEM_NTYPES];
unsigned multi=0;
/* Get the information from the multi file driver */
if (H5Pget_fapl_multi(plist_id,memb_map,NULL,NULL,memb_addr,NULL)<0) {
HRETURN_ERROR (H5E_PLIST, H5E_NOTFOUND, H5F_LOW_ERROR,
"can't get multi file information");
}
/* Check whether all of the meta data is in one file & the raw data in another */
for (mt=H5FD_MEM_DEFAULT; mt<H5FD_MEM_NTYPES; mt++) {
if(mt==H5FD_MEM_DRAW) {
if(memb_map[mt]!=H5FD_MEM_DRAW) {
multi=1;
break;
} /* end if */
} /* end if */
else {
if(memb_map[mt]!=H5FD_MEM_SUPER) {
multi=1;
break;
} /* end if */
} /* end else */
} /* end for */
/* Check further if things look like a split file currently */
if(!multi) {
if(memb_addr[H5FD_MEM_SUPER]!=0 || memb_addr[H5FD_MEM_DRAW] != HADDR_MAX/2)
multi=1;
} /* end if */
if(multi)
ret_value=H5F_LOW_ERROR; /* v1.2 didn't have multi-file driver */
else
ret_value=H5F_LOW_SPLIT;
} /* end if */
else
ret_value=H5F_LOW_ERROR; /* error, or driver unknown to v1.2 */
FUNC_LEAVE (ret_value);
}
#else /* WANT_H5_V1_2_COMPAT */
/*-------------------------------------------------------------------------
* Function: H5Pget_driver
*
* Purpose: Return the ID of the low-level file driver. PLIST_ID should
* be a file access property list or data transfer propert list.
*
* Return: Success: A low-level driver ID which is the same ID
* used when the driver was set for the property
* list. The driver ID is only valid as long as
* the file driver remains registered.
*
* Failure: Negative
*
* Programmer: Robb Matzke
* Thursday, February 26, 1998
*
* Modifications:
* Robb Matzke, 1999-08-03
* Rewritten to use the virtual file layer.
*
* Robb Matzke, 1999-08-05
* If the driver ID is H5FD_VFD_DEFAULT then substitute the current value of
* H5FD_SEC2.
*
* Quincey Koziol 2000-11-28
* Added internal function..
*-------------------------------------------------------------------------
*/
hid_t
H5Pget_driver(hid_t plist_id)
{
hid_t ret_value=-1;
FUNC_ENTER (H5Pget_driver, FAIL);
H5TRACE1("i","i",plist_id);
ret_value = H5P_get_driver(plist_id);
FUNC_LEAVE(ret_value);
}
#endif /* WANT_H5_V1_2_COMPAT */
/*-------------------------------------------------------------------------
* Function: H5P_get_driver
*
* Purpose: Return the ID of the low-level file driver. PLIST_ID should
* be a file access property list or data transfer propert list.
*
* Return: Success: A low-level driver ID which is the same ID
* used when the driver was set for the property
* list. The driver ID is only valid as long as
* the file driver remains registered.
*
* Failure: Negative
*
* Programmer: Robb Matzke
* Thursday, February 26, 1998
*
* Modifications:
* Robb Matzke, 1999-08-03
* Rewritten to use the virtual file layer.
*
* Robb Matzke, 1999-08-05
* If the driver ID is H5FD_VFD_DEFAULT then substitute the current value
* of H5FD_SEC2.
*
* Quincey Koziol 2000-11-28
* Added internal function..
*-------------------------------------------------------------------------
*/
hid_t
H5P_get_driver(hid_t plist_id)
{
H5F_access_t *fapl=NULL;
H5D_xfer_t *dxpl=NULL;
hid_t ret_value=-1;
FUNC_ENTER (H5P_get_driver, FAIL);
H5TRACE1("i","i",plist_id);
if (H5P_FILE_ACCESS==H5P_get_class(plist_id) &&
(fapl=H5I_object(plist_id))) {
ret_value = fapl->driver_id;
} else if (H5P_DATASET_XFER==H5P_get_class(plist_id) &&
(dxpl=H5I_object(plist_id))) {
ret_value = dxpl->driver_id;
} else {
HRETURN_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL,
"not a file access or data transfer property list");
}
if (H5FD_VFD_DEFAULT==ret_value)
ret_value = H5FD_SEC2;
FUNC_LEAVE(ret_value);
}
/*-------------------------------------------------------------------------
* Function: H5Pget_driver_info
*
* Purpose: Returns a pointer directly to the file driver-specific
* information of a file access or data transfer property list.
*
* Return: Success: Ptr to *uncopied* driver specific data
* structure if any.
*
* Failure: NULL. Null is also returned if the driver has
* not registered any driver-specific properties
* although no error is pushed on the stack in
* this case.
*
* Programmer: Robb Matzke
* Wednesday, August 4, 1999
*
* Modifications:
*
*-------------------------------------------------------------------------
*/
void *
H5Pget_driver_info(hid_t plist_id)
{
H5F_access_t *fapl=NULL;
H5D_xfer_t *dxpl=NULL;
void *ret_value=NULL;
FUNC_ENTER(H5Pget_driver_info, NULL);
if (H5P_FILE_ACCESS==H5P_get_class(plist_id) &&
(fapl=H5I_object(plist_id))) {
ret_value = fapl->driver_info;
} else if (H5P_DATASET_XFER==H5P_get_class(plist_id) &&
(dxpl=H5I_object(plist_id))) {
ret_value = dxpl->driver_info;
} else {
HRETURN_ERROR(H5E_ARGS, H5E_BADTYPE, NULL,
"not a file access or data transfer property list");
}
FUNC_LEAVE(ret_value);
}
#ifdef WANT_H5_V1_2_COMPAT
/*-------------------------------------------------------------------------
* 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)
{
FUNC_ENTER (H5Pset_stdio, FAIL);
H5TRACE1("e","i",plist_id);
/* Check arguments */
if (H5P_FILE_ACCESS != H5P_get_class(plist_id) ||
NULL == H5I_object(plist_id)) {
HRETURN_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL,
"not a file access property list");
}
FUNC_LEAVE(H5Pset_fapl_stdio(plist_id));
}
/*-------------------------------------------------------------------------
* 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)
{
herr_t ret_value=FAIL;
FUNC_ENTER (H5Pget_stdio, FAIL);
H5TRACE1("e","i",plist_id);
/* Check arguments and test driver */
if (H5P_FILE_ACCESS==H5P_get_class(plist_id) &&
(H5FD_STDIO == H5P_get_driver(plist_id))) {
ret_value=SUCCEED;
}
else {
HRETURN_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL,
"not a file access property list");
}
FUNC_LEAVE (ret_value);
}
/*-------------------------------------------------------------------------
* 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)
{
FUNC_ENTER (H5Pset_sec2, FAIL);
H5TRACE1("e","i",plist_id);
/* Check arguments */
if (H5P_FILE_ACCESS != H5P_get_class(plist_id) ||
NULL == H5I_object(plist_id)) {
HRETURN_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL,
"not a file access property list");
}
FUNC_LEAVE(H5Pset_fapl_sec2(plist_id));
}
/*-------------------------------------------------------------------------
* 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)
{
herr_t ret_value=FAIL;
FUNC_ENTER (H5Pget_sec2, FAIL);
H5TRACE1("e","i",plist_id);
/* Check arguments and test driver */
if (H5P_FILE_ACCESS==H5P_get_class(plist_id) &&
(H5FD_SEC2 == H5P_get_driver(plist_id))) {
ret_value=SUCCEED;
}
else {
HRETURN_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL,
"not a file access property list");
}
FUNC_LEAVE (ret_value);
}
/*-------------------------------------------------------------------------
* 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)
{
FUNC_ENTER (H5Pset_core, FAIL);
H5TRACE2("e","iz",plist_id,increment);
/* Check arguments */
if (H5P_FILE_ACCESS != H5P_get_class(plist_id) ||
NULL == 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");
}
FUNC_LEAVE(H5Pset_fapl_core(plist_id,increment,0));
}
/*-------------------------------------------------------------------------
* 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*/)
{
herr_t ret_value=FAIL;
FUNC_ENTER (H5Pget_core, FAIL);
H5TRACE2("e","ix",plist_id,increment);
/* Check arguments */
if (H5P_FILE_ACCESS==H5P_get_class(plist_id) &&
(H5FD_CORE == H5P_get_driver(plist_id)) &&
H5Pget_fapl_core(plist_id,increment,NULL)>=0) {
ret_value=SUCCEED;
}
else {
HRETURN_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL,
"not a file access property list");
}
FUNC_LEAVE (ret_value);
}
/*-------------------------------------------------------------------------
* 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)
{
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 == 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 == 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 == H5I_object(raw_plist_id))) {
HRETURN_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL,
"not a file access property list");
}
/* Set driver */
FUNC_LEAVE (H5Pset_fapl_split(plist_id,meta_ext,meta_plist_id,raw_ext,raw_plist_id));
}
/*-------------------------------------------------------------------------
* 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*/)
{
H5FD_mem_t mt;
H5FD_mem_t _memb_map[H5FD_MEM_NTYPES];
hid_t _memb_fapl[H5FD_MEM_NTYPES];
char _memb_name[H5FD_MEM_NTYPES][16];
char *_memb_name_ptrs[H5FD_MEM_NTYPES];
haddr_t _memb_addr[H5FD_MEM_NTYPES];
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 == H5I_object (plist_id)) {
HRETURN_ERROR (H5E_ARGS, H5E_BADTYPE, FAIL,
"not a file access property list");
}
if (H5FD_MULTI != H5P_get_driver(plist_id)) {
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;
/* Set up the member extention pointers */
for (mt=H5FD_MEM_DEFAULT; mt<H5FD_MEM_NTYPES; mt++)
_memb_name_ptrs[mt] = &_memb_name[mt][0];
/* Get the information from the multi file driver */
if (H5Pget_fapl_multi(plist_id,_memb_map,_memb_fapl,_memb_name_ptrs,_memb_addr,NULL)<0) {
HRETURN_ERROR (H5E_PLIST, H5E_NOTFOUND, FAIL,
"can't get split file information");
}
/* Output arguments */
if (meta_ext && meta_ext_size>0) {
if (_memb_name[H5FD_MEM_SUPER]) {
HDstrncpy (meta_ext, _memb_name[H5FD_MEM_SUPER], meta_ext_size);
} else {
HDstrncpy (meta_ext, ".meta", meta_ext_size);
}
}
if (raw_ext && raw_ext_size>0) {
if (_memb_name[H5FD_MEM_DRAW]) {
HDstrncpy (raw_ext, _memb_name[H5FD_MEM_DRAW], raw_ext_size);
} else {
HDstrncpy (raw_ext, ".raw", raw_ext_size);
}
}
if (meta_properties) {
*meta_properties = _memb_fapl[H5FD_MEM_SUPER];
}
if (raw_properties) {
*raw_properties = _memb_fapl[H5FD_MEM_DRAW];
}
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)
{
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 == 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 == H5I_object(memb_plist_id))) {
HRETURN_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL,
"not a file access property list");
}
/* Set driver */
FUNC_LEAVE(H5Pset_fapl_family(plist_id,memb_size,memb_plist_id));
}
/*-------------------------------------------------------------------------
* 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*/)
{
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 == H5I_object (plist_id)) {
HRETURN_ERROR (H5E_ARGS, H5E_BADTYPE, FAIL,
"not a file access property list");
}
if (H5FD_FAMILY == H5P_get_driver(plist_id)) {
HRETURN_ERROR (H5E_ARGS, H5E_BADVALUE, FAIL,
"the family driver is not set");
}
/* Retrieve args */
FUNC_LEAVE (H5Pget_fapl_family(plist_id,memb_size,memb_plist_id));
}
#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)
{
FUNC_ENTER(H5Pset_mpi, FAIL);
H5TRACE3("e","iMcMi",plist_id,comm,info);
/* Check arguments */
if (H5P_FILE_ACCESS != H5P_get_class(plist_id) ||
NULL == H5I_object(plist_id)) {
HRETURN_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL,
"not a file access property list");
}
/* Set driver */
FUNC_LEAVE(H5Pset_fapl_mpio(plist_id,comm,info));
}
/*-------------------------------------------------------------------------
* 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)
{
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 == H5I_object (plist_id)) {
HRETURN_ERROR (H5E_ARGS, H5E_BADTYPE, FAIL,
"not a file access property list");
}
if (H5FD_MPIO == H5P_get_driver(plist_id)) {
HRETURN_ERROR (H5E_ARGS, H5E_BADVALUE, FAIL,
"the mpi driver is not set");
}
/* Retrieve args */
FUNC_LEAVE (H5Pget_fapl_mpio(plist_id,comm,info));
}
/*-------------------------------------------------------------------------
* 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)
{
H5FD_mpio_xfer_t dx_xfer_mode;
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 == H5I_object(plist_id)) {
HRETURN_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL,
"not a dataset transfer property list");
}
switch (data_xfer_mode) {
case H5D_XFER_COLLECTIVE:
dx_xfer_mode = H5FD_MPIO_COLLECTIVE;
break;
case H5D_XFER_INDEPENDENT:
case H5D_XFER_DFLT:
dx_xfer_mode = H5FD_MPIO_INDEPENDENT;
break;
default:
HRETURN_ERROR (H5E_ARGS, H5E_BADVALUE, FAIL,
"invalid dataset transfer mode");
}
FUNC_LEAVE(H5Pset_dxpl_mpio(plist_id,dx_xfer_mode));
}
/*-------------------------------------------------------------------------
* 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)
{
H5FD_mpio_xfer_t dx_xfer_mode;
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 == H5I_object(plist_id)) {
HRETURN_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL,
"not a dataset transfer property list");
}
if(data_xfer_mode) {
if(H5Pget_dxpl_mpio(plist_id,&dx_xfer_mode)<0) {
HRETURN_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL,
"not a dataset transfer property list");
}
switch(dx_xfer_mode) {
H5FD_MPIO_INDEPENDENT:
*data_xfer_mode = H5D_XFER_INDEPENDENT;
break;
H5FD_MPIO_COLLECTIVE:
*data_xfer_mode = H5D_XFER_COLLECTIVE;
break;
default:
HRETURN_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL,
"unknown transfer mode");
} /* end switch */
} /* end if */
FUNC_LEAVE (SUCCEED);
}
#endif /* HAVE_PARALLEL */
#endif /* WANT_H5_V1_2_COMPAT */
/*-------------------------------------------------------------------------
* 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.
*
* 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, hsize_t size, void *tconv, void *bkg)
{
H5D_xfer_t *plist = NULL;
FUNC_ENTER (H5Pset_buffer, FAIL);
H5TRACE4("e","ihxx",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:
*
*-------------------------------------------------------------------------
*/
hsize_t
H5Pget_buffer(hid_t plist_id, void **tconv/*out*/, void **bkg/*out*/)
{
H5D_xfer_t *plist = NULL;
FUNC_ENTER (H5Pget_buffer, 0);
H5TRACE3("h","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);
}
/*-------------------------------------------------------------------------
* 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, FAIL);
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, FAIL,
"not a dataset transfer property list");
}
/* Return values */
if (cache)
*cache = plist->cache_hyper;
if (limit)
*limit = plist->block_limit;
FUNC_LEAVE (SUCCEED);
}
/*-------------------------------------------------------------------------
* 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 (H5Pget_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 & ~((unsigned)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((int)(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, H5Z_FILTER_ERROR);
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, H5Z_FILTER_ERROR,
"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, H5Z_FILTER_ERROR,
"not a dataset creation property list");
}
if (idx<0 || (size_t)idx>=plist->pline.nfilters) {
HRETURN_ERROR(H5E_ARGS, H5E_BADVALUE, H5Z_FILTER_ERROR,
"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, H5Z_FILTER_ERROR,
"probable uninitialized *cd_nelmts argument");
}
if (cd_nelmts && *cd_nelmts>0 && !cd_values) {
HRETURN_ERROR(H5E_ARGS, H5E_BADVALUE, H5Z_FILTER_ERROR,
"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, (hsize_t)1, 0, 0, buf, bkg, H5P_DEFAULT)<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);
}
/*-------------------------------------------------------------------------
* 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
* June, 1999
*
* 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_references
*
* Purpose: Returns the current setting for the garbage collection
* references property from a file access property list.
*
* Return: Non-negative on success/Negative on failure
*
* Programmer: Quincey Koziol
* June, 1999
*
* Modifications:
*
*-------------------------------------------------------------------------
*/
herr_t
H5Pget_gc_references(hid_t fapl_id, unsigned *gc_ref/*out*/)
{
H5F_access_t *fapl = NULL;
FUNC_ENTER(H5Pget_gc_references, 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);
}
/*-------------------------------------------------------------------------
* Function: H5Pset_vlen_mem_manager
*
* Purpose: Sets the memory allocate/free pair for VL datatypes. The
* allocation routine is called when data is read into a new
* array and the free routine is called when H5Dvlen_reclaim is
* called. The alloc_info and free_info are user parameters
* which are passed to the allocation and freeing functions
* respectively. To reset the allocate/free functions to the
* default setting of using the system's malloc/free functions,
* call this routine with alloc_func and free_func set to NULL.
*
* Return: Non-negative on success/Negative on failure
*
* Programmer: Quincey Koziol
* Thursday, July 1, 1999
*
* Modifications:
*
*-------------------------------------------------------------------------
*/
herr_t
H5Pset_vlen_mem_manager(hid_t plist_id, H5MM_allocate_t alloc_func,
void *alloc_info, H5MM_free_t free_func, void *free_info)
{
H5D_xfer_t *plist = NULL;
FUNC_ENTER(H5Pset_vlen_mem_manager, FAIL);
H5TRACE5("e","ixxxx",plist_id,alloc_func,alloc_info,free_func,free_info);
/* 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->vlen_alloc = alloc_func;
plist->alloc_info = alloc_info;
plist->vlen_free = free_func;
plist->free_info = free_info;
FUNC_LEAVE (SUCCEED);
}
/*-------------------------------------------------------------------------
* Function: H5Pget_vlen_mem_manager
*
* Purpose: The inverse of H5Pset_vlen_mem_manager()
*
* Return: Non-negative on success/Negative on failure
*
* Programmer: Quincey Koziol
* Thursday, July 1, 1999
*
* Modifications:
*
*-------------------------------------------------------------------------
*/
herr_t
H5Pget_vlen_mem_manager(hid_t plist_id, H5MM_allocate_t *alloc_func/*out*/,
void **alloc_info/*out*/,
H5MM_free_t *free_func/*out*/,
void **free_info/*out*/)
{
H5D_xfer_t *plist = NULL;
FUNC_ENTER(H5Pget_vlen_mem_manager, FAIL);
H5TRACE5("e","ixxxx",plist_id,alloc_func,alloc_info,free_func,free_info);
/* 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(alloc_func!=NULL)
*alloc_func= plist->vlen_alloc;
if(alloc_info!=NULL)
*alloc_info= plist->alloc_info;
if(free_func!=NULL)
*free_func= plist->vlen_free;
if(free_info!=NULL)
*free_info= plist->free_info;
FUNC_LEAVE (SUCCEED);
}
/*-------------------------------------------------------------------------
* Function: H5Pset_meta_block_size
*
* Purpose: Sets the minimum size of metadata block allocations when
* the H5FD_FEAT_AGGREGATE_METADATA is set by a VFL driver.
* Each "raw" metadata block is allocated to be this size and then
* specific pieces of metadata (object headers, local heaps, B-trees, etc)
* are sub-allocated from this block.
*
* The default value is set to 2048 (bytes), indicating that metadata
* will be attempted to be bunched together in (at least) 2K blocks in
* the file. Setting the value to 0 with this API function will
* turn off the metadata aggregation, even if the VFL driver attempts to
* use that strategy.
*
* Return: Non-negative on success/Negative on failure
*
* Programmer: Quincey Koziol
* Friday, August 25, 2000
*
* Modifications:
*
*-------------------------------------------------------------------------
*/
herr_t
H5Pset_meta_block_size(hid_t fapl_id, hsize_t size)
{
H5F_access_t *fapl = NULL;
FUNC_ENTER (H5Pset_meta_block_size, FAIL);
H5TRACE2("e","ih",fapl_id,size);
/* 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->meta_block_size = size;
FUNC_LEAVE (SUCCEED);
}
/*-------------------------------------------------------------------------
* Function: H5Pget_meta_block_size
*
* Purpose: Returns the current settings for the metadata block allocation
* property from a file access property list.
*
* Return: Non-negative on success/Negative on failure
*
* Programmer: Quincey Koziol
* Friday, August 29, 2000
*
* Modifications:
*
*-------------------------------------------------------------------------
*/
herr_t
H5Pget_meta_block_size(hid_t fapl_id, hsize_t *size/*out*/)
{
H5F_access_t *fapl = NULL;
FUNC_ENTER (H5Pget_meta_block_size, FAIL);
H5TRACE2("e","ix",fapl_id,size);
/* 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 (size)
*size = fapl->meta_block_size;
FUNC_LEAVE (SUCCEED);
}
/*-------------------------------------------------------------------------
* Function: H5Pset_sieve_buf_size
*
* Purpose: Sets the maximum size of the data seive buffer used for file
* drivers which are capable of using data sieving. The data sieve
* buffer is used when performing I/O on datasets in the file. Using a
* buffer which is large anough to hold several pieces of the dataset
* being read in for hyperslab selections boosts performance by quite a
* bit.
*
* The default value is set to 64KB, indicating that file I/O for raw data
* reads and writes will occur in at least 64KB blocks.
* Setting the value to 0 with this API function will turn off the
* data sieving, even if the VFL driver attempts to use that strategy.
*
* Return: Non-negative on success/Negative on failure
*
* Programmer: Quincey Koziol
* Thursday, September 21, 2000
*
* Modifications:
*
*-------------------------------------------------------------------------
*/
herr_t
H5Pset_sieve_buf_size(hid_t fapl_id, hsize_t size)
{
H5F_access_t *fapl = NULL;
FUNC_ENTER (H5Pset_sieve_buf_size, FAIL);
H5TRACE2("e","ih",fapl_id,size);
/* 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->sieve_buf_size = size;
FUNC_LEAVE (SUCCEED);
} /* end H5Pset_sieve_buf_size() */
/*-------------------------------------------------------------------------
* Function: H5Pget_sieve_buf_size
*
* Purpose: Returns the current settings for the data sieve buffer size
* property from a file access property list.
*
* Return: Non-negative on success/Negative on failure
*
* Programmer: Quincey Koziol
* Thursday, September 21, 2000
*
* Modifications:
*
*-------------------------------------------------------------------------
*/
herr_t
H5Pget_sieve_buf_size(hid_t fapl_id, hsize_t *size/*out*/)
{
H5F_access_t *fapl = NULL;
FUNC_ENTER (H5Pget_sieve_buf_size, FAIL);
H5TRACE2("e","ix",fapl_id,size);
/* 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 (size)
*size = fapl->sieve_buf_size;
FUNC_LEAVE (SUCCEED);
} /* end H5Pget_sieve_buf_size() */
/*--------------------------------------------------------------------------
NAME
H5P_copy_prop
PURPOSE
Internal routine to copy a property
USAGE
H5P_genprop_t *H5P_copy_prop(oprop)
H5P_genprop_t *oprop; IN: Pointer to property to copy
RETURNS
Returns a pointer to the newly created property on success,
NULL on failure.
DESCRIPTION
Allocates memory and copies property information into a new property object.
GLOBAL VARIABLES
COMMENTS, BUGS, ASSUMPTIONS
EXAMPLES
REVISION LOG
--------------------------------------------------------------------------*/
static H5P_genprop_t *
H5P_copy_prop(H5P_genprop_t *oprop)
{
H5P_genprop_t *prop=NULL; /* Pointer to new property copied */
H5P_genprop_t *ret_value=NULL; /* Return value */
FUNC_ENTER (H5P_copy_prop, NULL);
assert(oprop);
/* Allocate the new property */
if (NULL==(prop = H5MM_malloc (sizeof(H5P_genprop_t))))
HGOTO_ERROR (H5E_RESOURCE, H5E_NOSPACE, NULL, "memory allocation failed");
/* Copy basic property information */
HDmemcpy(prop,oprop,sizeof(H5P_genprop_t));
/* Duplicate name */
prop->name = HDstrdup(oprop->name);
/* Duplicate current value, if it exists */
if(oprop->value!=NULL) {
if (NULL==(prop->value = H5MM_malloc (prop->size)))
HGOTO_ERROR (H5E_RESOURCE, H5E_NOSPACE, NULL, "memory allocation failed");
HDmemcpy(prop->value,oprop->value,prop->size);
} /* end if */
/* Duplicate default value, if it exists */
if(oprop->def_value!=NULL) {
if (NULL==(prop->def_value = H5MM_malloc (prop->size)))
HGOTO_ERROR (H5E_RESOURCE, H5E_NOSPACE, NULL, "memory allocation failed");
HDmemcpy(prop->def_value,oprop->def_value,prop->size);
} /* end if */
/* Reset the link to the next property */
prop->next=NULL;
/* Set return value */
ret_value=prop;
done:
/* Free any resources allocated */
if(ret_value==NULL) {
if(prop!=NULL) {
if(prop->name!=NULL)
H5MM_xfree(prop->name);
if(prop->value!=NULL)
H5MM_xfree(prop->value);
if(prop->def_value!=NULL)
H5MM_xfree(prop->def_value);
H5MM_xfree(prop);
} /* end if */
} /* end if */
FUNC_LEAVE (ret_value);
} /* H5P_copy_prop() */
/*--------------------------------------------------------------------------
NAME
H5P_create_prop
PURPOSE
Internal routine to create a new property
USAGE
H5P_genprop_t *H5P_create_prop(name,size,def_value,prp_create,prp_set,
prp_get,prp_close)
const char *name; IN: Name of property to register
size_t size; IN: Size of property in bytes
void *def_value; IN: Pointer to buffer containing default value
for property in newly created property lists
H5P_prp_create_func_t prp_create; IN: Function pointer to property
creation callback
H5P_prp_set_func_t prp_set; IN: Function pointer to property set callback
H5P_prp_get_func_t prp_get; IN: Function pointer to property get callback
H5P_prp_close_func_t prp_close; IN: Function pointer to property close
callback
RETURNS
Returns a pointer to the newly created property on success,
NULL on failure.
DESCRIPTION
Allocates memory and copies property information into a new property object.
GLOBAL VARIABLES
COMMENTS, BUGS, ASSUMPTIONS
EXAMPLES
REVISION LOG
--------------------------------------------------------------------------*/
static H5P_genprop_t *
H5P_create_prop(const char *name, size_t size, void *def_value, void *value,
H5P_prp_create_func_t prp_create, H5P_prp_set_func_t prp_set,
H5P_prp_get_func_t prp_get, H5P_prp_close_func_t prp_close)
{
H5P_genprop_t *prop=NULL; /* Pointer to new property copied */
H5P_genprop_t *ret_value=NULL; /* Return value */
FUNC_ENTER (H5P_create_prop, NULL);
assert(name);
assert((size>0 && def_value!=NULL) || (size==0));
/* Allocate the new property */
if (NULL==(prop = H5MM_malloc (sizeof(H5P_genprop_t))))
HGOTO_ERROR (H5E_RESOURCE, H5E_NOSPACE, NULL, "memory allocation failed");
/* Set the property initial values */
prop->xor_val = H5P_xor_name(name); /* Generate the XOR'd value for the name */
prop->name = HDstrdup(name); /* Duplicate name */
prop->size=size;
/* Duplicate value, if it exists */
if(value!=NULL) {
if (NULL==(prop->value = H5MM_malloc (prop->size)))
HGOTO_ERROR (H5E_RESOURCE, H5E_NOSPACE, NULL, "memory allocation failed");
HDmemcpy(prop->value,value,prop->size);
} /* end if */
else
prop->value=NULL;
/* Duplicate default value, if it exists */
if(def_value!=NULL) {
if (NULL==(prop->def_value = H5MM_malloc (prop->size)))
HGOTO_ERROR (H5E_RESOURCE, H5E_NOSPACE, NULL, "memory allocation failed");
HDmemcpy(prop->def_value,def_value,prop->size);
} /* end if */
else
prop->def_value=NULL;
/* Set the function pointers */
prop->create=prp_create;
prop->set=prp_set;
prop->get=prp_get;
prop->close=prp_close;
/* Reset the link to the next property */
prop->next=NULL;
/* Set return value */
ret_value=prop;
done:
/* Free any resources allocated */
if(ret_value==NULL) {
if(prop!=NULL) {
if(prop->name!=NULL)
H5MM_xfree(prop->name);
if(prop->value!=NULL)
H5MM_xfree(prop->value);
if(prop->def_value!=NULL)
H5MM_xfree(prop->def_value);
H5MM_xfree(prop);
} /* end if */
} /* end if */
FUNC_LEAVE (ret_value);
} /* H5P_create_prop() */
/*--------------------------------------------------------------------------
NAME
H5P_add_prop
PURPOSE
Internal routine to insert a property into a property hash table
USAGE
herr_t H5P_add_prop(hash, hashsize, prop)
H5P_gen_prop_t *hash[]; IN/OUT: Pointer to array of properties for hash table
unsigned hashsize; IN: Size of hash table
H5P_genprop_t *prop; IN: Pointer to property to insert
RETURNS
Returns non-negative on success, negative on failure.
DESCRIPTION
Inserts a property into a hash table of properties, using the hashed
property name.
GLOBAL VARIABLES
COMMENTS, BUGS, ASSUMPTIONS
EXAMPLES
REVISION LOG
--------------------------------------------------------------------------*/
static herr_t
H5P_add_prop(H5P_genprop_t *hash[], unsigned hashsize, H5P_genprop_t *prop)
{
unsigned loc; /* Hash table location */
herr_t ret_value=SUCCEED; /* Return value */
FUNC_ENTER (H5P_add_prop, FAIL);
assert(hash);
assert(hashsize>0);
assert(prop);
/* Get correct hash table location */
loc=H5P_hash_name(prop->name,hashsize);
/* Insert property into hash table */
prop->next=hash[loc];
hash[loc]=prop;
#ifdef LATER
done:
#endif /* LATER */
FUNC_LEAVE (ret_value);
} /* H5P_add_prop() */
/*--------------------------------------------------------------------------
NAME
H5P_find_prop
PURPOSE
Internal routine to check for a property in a hash table
USAGE
H5P_genprop_t *H5P_find_prop(hash, hashsize, name)
H5P_genprop_t *hash[]; IN: Pointer to array of properties for hash table
unsigned hashsize; IN: Size of hash table
const char *name; IN: Name of property to check for
RETURNS
Returns pointer to property on success, NULL on failure.
DESCRIPTION
Checks for a property in a hash table of properties.
GLOBAL VARIABLES
COMMENTS, BUGS, ASSUMPTIONS
EXAMPLES
REVISION LOG
--------------------------------------------------------------------------*/
static H5P_genprop_t *
H5P_find_prop(H5P_genprop_t *hash[], unsigned hashsize, const char *name)
{
H5P_genprop_t *ret_value; /* Property pointer return value */
unsigned loc; /* Hash table location */
unsigned xor_val; /* XOR'ed value of the name to look for */
FUNC_ENTER (H5P_add_prop, NULL);
assert(hash);
assert(hashsize>0);
assert(name);
/* Get correct hash table location */
loc=H5P_hash_name(name,hashsize);
/* Get the XOR'ed value for the name to search for, to speed up comparisons */
xor_val=H5P_xor_name(name);
/* Locate property in list */
ret_value=hash[loc];
while(ret_value!=NULL) {
/* Check for name matching */
if(ret_value->xor_val==xor_val && HDstrcmp(ret_value->name,name)==0)
break;
} /* end while */
FUNC_LEAVE (ret_value);
} /* H5P_find_prop() */
/*--------------------------------------------------------------------------
NAME
H5P_free_prop
PURPOSE
Internal routine to destroy a property node
USAGE
herr_t H5P_free_prop(prop)
H5P_genprop_t *prop; IN: Pointer to property to destroy
RETURNS
Returns non-negative on success, negative on failure.
DESCRIPTION
Releases all the memory for a property list. Does _not_ call the
properties 'close' callback, that should already have been done.
GLOBAL VARIABLES
COMMENTS, BUGS, ASSUMPTIONS
EXAMPLES
REVISION LOG
--------------------------------------------------------------------------*/
static herr_t
H5P_free_prop(H5P_genprop_t *prop)
{
herr_t ret_value=SUCCEED; /* Return value */
FUNC_ENTER (H5P_free_prop, FAIL);
assert(prop);
/* Release the property value and default value if they exist */
if(prop->size>0) {
if(prop->value)
H5MM_xfree(prop->value);
if(prop->def_value)
H5MM_xfree(prop->def_value);
} /* end if */
H5MM_xfree(prop->name);
H5MM_xfree(prop);
#ifdef LATER
done:
#endif /* LATER */
FUNC_LEAVE (ret_value);
} /* H5P_free_prop() */
/*--------------------------------------------------------------------------
NAME
H5P_free_all_prop
PURPOSE
Internal routine to remove all properties from a property hash table
USAGE
herr_t H5P_free_all_prop(hash, hashsize, make_cb)
H5P_gen_prop_t *hash[]; IN/OUT: Pointer to array of properties for hash table
unsigned hashsize; IN: Size of hash table
unsigned make_cb; IN: Whether to make property callbacks or not
RETURNS
Returns non-negative on success, negative on failure.
DESCRIPTION
Remove all the properties from a property list. Calls the property
'close' callback for each property removed.
GLOBAL VARIABLES
COMMENTS, BUGS, ASSUMPTIONS
EXAMPLES
REVISION LOG
--------------------------------------------------------------------------*/
static herr_t
H5P_free_all_prop(H5P_genprop_t *hash[], unsigned hashsize, unsigned make_cb)
{
H5P_genprop_t *tprop, *next;/* Temporary pointer to properties */
unsigned u; /* Local index variable */
herr_t ret_value=SUCCEED; /* Return value */
FUNC_ENTER (H5P_free_all_prop, FAIL);
assert(hash);
assert(hashsize>0);
/* Work through all the properties... */
for(u=0; u<hashsize; u++) {
tprop=hash[u];
while(tprop!=NULL) {
/* Find next node right away, to avoid accessing the current node after it's been free'd */
next=tprop->next;
/* Call the close callback and ignore the return value, there's nothing we can do about it */
if(make_cb && tprop->close!=NULL)
(tprop->close)(tprop->name,&(tprop->value));
/* Free the property, ignoring return value, nothing we can do */
H5P_free_prop(tprop);
tprop=next;
} /* end while */
} /* end for */
#ifdef LATER
done:
#endif /* LATER */
FUNC_LEAVE (ret_value);
} /* H5P_free_all_prop() */
/*--------------------------------------------------------------------------
NAME
H5P_access_class
PURPOSE
Internal routine to increment or decrement list & class dependancies on a
property list class
USAGE
herr_t H5P_access_class(pclass,mod)
H5P_genclass_t *pclass; IN: Pointer to class to modify
H5P_class_mod_t mod; IN: Type of modification to class
RETURNS
Returns non-negative on success, negative on failure.
DESCRIPTION
Increment/Decrement the class or list dependancies for a given class.
This routine is the final arbiter on decisions about actually releasing a
class in memory, such action is only taken when the reference counts for
both dependent classes & lists reach zero.
GLOBAL VARIABLES
COMMENTS, BUGS, ASSUMPTIONS
EXAMPLES
REVISION LOG
--------------------------------------------------------------------------*/
static herr_t
H5P_access_class(H5P_genclass_t *pclass, H5P_class_mod_t mod)
{
herr_t ret_value=SUCCEED; /* Return value */
FUNC_ENTER (H5P_access_class, FAIL);
assert(pclass);
assert(mod>H5P_MOD_ERR && mod<H5P_MOD_MAX);
switch(mod) {
case H5P_MOD_INC_CLS: /* Increment the dependant class count*/
pclass->classes++;
break;
case H5P_MOD_DEC_CLS: /* Decrement the dependant class count*/
pclass->classes--;
break;
case H5P_MOD_INC_LST: /* Increment the dependant list count*/
pclass->plists++;
break;
case H5P_MOD_DEC_LST: /* Decrement the dependant list count*/
pclass->plists--;
break;
case H5P_MOD_INC_REF: /* Increment the ID reference count*/
pclass->ref_count++;
break;
case H5P_MOD_DEC_REF: /* Decrement the ID reference count*/
pclass->ref_count--;
break;
case H5P_MOD_CHECK: /* NOOP, just check if we can delete the class */
break;
case H5P_MOD_ERR:
case H5P_MOD_MAX:
assert(0 && "Invalid H5P class modification");
} /* end switch */
/* Check if we can release the class information now */
if(pclass->deleted && pclass->plists==0 && pclass->classes==0 ) {
assert(pclass->name);
H5MM_xfree(pclass->name);
/* Free the class properties without making callbacks */
H5P_free_all_prop(pclass->props,pclass->hashsize,0);
H5MM_xfree(pclass);
} /* end if */
#ifdef LATER
done:
#endif /* LATER */
FUNC_LEAVE (ret_value);
} /* H5P_access_class() */
/*--------------------------------------------------------------------------
NAME
H5P_create_class
PURPOSE
Internal routine to create a new property list class.
USAGE
H5P_genclass_t H5P_create_class(par_class, name, hashsize, internal,
cls_create, create_data, cls_close, close_data)
H5P_genclass_t *par_class; IN: Pointer to parent class
const char *name; IN: Name of class we are creating
unsigned hashsize; IN: Number of buckets in hash table
unsigned internal; IN: Whether this is an internal class or not
H5P_cls_create_func_t; IN: The callback function to call when each
property list in this class is created.
void *create_data; IN: Pointer to user data to pass along to class
creation callback.
H5P_cls_close_func_t; IN: The callback function to call when each
property list in this class is closed.
void *close_data; IN: Pointer to user data to pass along to class
close callback.
RETURNS
Returns a pointer to the newly created property list class on success,
NULL on failure.
DESCRIPTION
Allocates memory and attaches a class to the property list class hierarchy.
GLOBAL VARIABLES
COMMENTS, BUGS, ASSUMPTIONS
EXAMPLES
REVISION LOG
--------------------------------------------------------------------------*/
static H5P_genclass_t *
H5P_create_class(H5P_genclass_t *par_class, const char *name, unsigned hashsize, unsigned internal,
H5P_cls_create_func_t cls_create, void *create_data,
H5P_cls_close_func_t cls_close, void *close_data
)
{
H5P_genclass_t *pclass; /* Property list class created */
H5P_genclass_t *ret_value=NULL; /* return value */
FUNC_ENTER (H5P_create_class, NULL);
assert(name);
/* Allow internal classes to break some rules */
/* (This allows the root of the tree to be created with this routine -QAK) */
if(!internal) {
assert(par_class);
assert(hashsize>0);
}
/* Allocate room for the class & it's hash table of properties */
if (NULL==(pclass = H5MM_calloc (sizeof(H5P_genclass_t)+((hashsize-1)*sizeof(H5P_genprop_t *)))))
HGOTO_ERROR (H5E_RESOURCE, H5E_NOSPACE, NULL,"memory allocation failed");
/* Set class state */
pclass->parent = par_class;
pclass->name = HDstrdup(name);
pclass->nprops = 0; /* Classes are created without properties initially */
pclass->hashsize = hashsize;
pclass->plists = 0; /* No properties lists of this class yet */
pclass->classes = 0; /* No classes derived from this class yet */
pclass->ref_count = 1; /* This is the first reference to the new class */
pclass->internal = internal;
pclass->deleted = 0; /* Not deleted yet... :-) */
/* Set callback functions and pass-along data */
pclass->create_func = cls_create;
pclass->create_data = create_data;
pclass->close_func = cls_close;
pclass->close_data = close_data;
/* Increment parent class's derived class value */
if(par_class!=NULL)
if(H5P_access_class(par_class,H5P_MOD_INC_CLS)<0)
HGOTO_ERROR (H5E_PLIST, H5E_CANTINIT, NULL,"Can't increment parent class ref count");
/* Set return value */
ret_value=pclass;
done:
/* Free any resources allocated */
if(ret_value==NULL) {
if(pclass!=NULL)
H5MM_xfree(pclass);
}
FUNC_LEAVE (ret_value);
} /* H5P_create_class() */
/*--------------------------------------------------------------------------
NAME
H5Pcreate_class
PURPOSE
Create a new property list class.
USAGE
hid_t H5Pcreate_class(parent, name, hashsize, cls_create, create_data,
cls_close, close_data)
hid_t parent; IN: Property list class ID of parent class
const char *name; IN: Name of class we are creating
unsigned hashsize; IN: Number of buckets in hash table
H5P_cls_create_func_t cls_create; IN: The callback function to call
when each property list in this class is
created.
void *create_data; IN: Pointer to user data to pass along to class
creation callback.
H5P_cls_close_func_t cls_close; IN: The callback function to call
when each property list in this class is
closed.
void *close_data; IN: Pointer to user data to pass along to class
close callback.
RETURNS
Returns a valid property list class ID on success, NULL on failure.
DESCRIPTION
Allocates memory and attaches a class to the property list class hierarchy.
GLOBAL VARIABLES
COMMENTS, BUGS, ASSUMPTIONS
EXAMPLES
REVISION LOG
--------------------------------------------------------------------------*/
hid_t
H5Pcreate_class(hid_t parent, const char *name, unsigned hashsize,
H5P_cls_create_func_t cls_create, void *create_data,
H5P_cls_close_func_t cls_close, void *close_data
)
{
H5P_genclass_t *par_class = NULL; /* Pointer to the parent class */
H5P_genclass_t *pclass = NULL; /* Property list class created */
hid_t ret_value = FAIL; /* Return value */
FUNC_ENTER(H5Pcreate_class, FAIL);
/* Check arguments. */
if (H5P_DEFAULT!=parent && (H5I_GENPROP_CLS!=H5I_get_type(parent)))
HGOTO_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL, "not a property list class");
if (!name || !*name)
HGOTO_ERROR(H5E_ARGS, H5E_BADVALUE, FAIL, "invalid class name");
if (hashsize==0)
HGOTO_ERROR(H5E_ARGS, H5E_BADVALUE, FAIL, "hashsize too small");
if ((create_data!=NULL && cls_create==NULL) || (close_data!=NULL && cls_close==NULL))
HGOTO_ERROR(H5E_ARGS, H5E_BADVALUE, FAIL, "data specified, but no callback provided");
/* Get the pointer to the parent class */
if(parent==H5P_DEFAULT)
par_class=NULL;
else if (NULL == (par_class = H5I_object(parent)))
HGOTO_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL, "can't retrieve parent class");
/* Create the new property list class */
if (NULL==(pclass=H5P_create_class(par_class, name, hashsize, 0, cls_create, create_data, cls_close, close_data)))
HGOTO_ERROR(H5E_PLIST, H5E_CANTCREATE, FAIL, "unable to create property list class");
/* Get an atom for the class */
if ((ret_value = H5I_register(H5I_GENPROP_CLS, pclass))<0)
HGOTO_ERROR(H5E_PLIST, H5E_CANTREGISTER, FAIL, "unable to atomize property list class");
done:
if (ret_value<0 && pclass)
H5P_close_class(pclass);
FUNC_LEAVE(ret_value);
} /* H5Pcreate_class() */
/*--------------------------------------------------------------------------
NAME
H5P_create_list
PURPOSE
Internal routine to create a new property list of a property list class.
USAGE
H5P_genplist_t *H5P_create_list(class)
H5P_genclass_t *class; IN: Property list class create list from
RETURNS
Returns a pointer to the newly created property list on success,
NULL on failure.
DESCRIPTION
Creates a property list of a given class. If a 'create' callback
exists for the property list class, it is called before the
property list is passed back to the user.
GLOBAL VARIABLES
COMMENTS, BUGS, ASSUMPTIONS
If this routine is called from a library routine other than
H5Pcreate_list, the calling routine is responsible for getting an ID for
the property list and calling the class 'create' callback (if one exists)
and also setting the "class_init" flag.
EXAMPLES
REVISION LOG
--------------------------------------------------------------------------*/
static H5P_genplist_t *H5P_create_list(H5P_genclass_t *pclass)
{
H5P_genclass_t *tclass=NULL; /* Temporary class pointer */
H5P_genplist_t *plist=NULL; /* New property list created */
H5P_genplist_t *ret_value=NULL; /* return value */
H5P_genprop_t *tmp; /* Temporary pointer to parent class properties */
H5P_genprop_t *pcopy; /* Copy of property to insert into class */
unsigned u; /* Local index variable */
FUNC_ENTER (H5P_create_list, NULL);
assert(pclass);
/*
* Create new property list object
*/
/* Allocate room for the property list & it's hash table of properties */
if (NULL==(plist = H5MM_calloc (sizeof(H5P_genplist_t)+((pclass->hashsize-1)*sizeof(H5P_genprop_t *)))))
HGOTO_ERROR (H5E_RESOURCE, H5E_NOSPACE, NULL,"memory allocation failed");
/* Set class state */
plist->pclass = pclass;
plist->nprops = 0; /* Initially the plist has the same number of properties as the class */
plist->class_init = 0; /* Initially, wait until the class callback finishes to set */
/*
* Copy class properties (up through list of parent classes also),
* initialize each with default value & make property 'create' callback.
*/
tclass=pclass;
while(tclass!=NULL) {
if(tclass->nprops>0) {
/* Walk through the hash table */
for(u=0; u<tclass->hashsize; u++) {
tmp=tclass->props[u];
/* Walk through the list of properties at each hash location */
while(tmp!=NULL) {
/* Check for property already existing in list */
if(H5P_find_prop(plist->props,tclass->hashsize,tmp->name)==NULL) {
/* Make a copy of the class's property */
if((pcopy=H5P_copy_prop(tmp))==NULL)
HGOTO_ERROR (H5E_PLIST, H5E_CANTCOPY, NULL,"Can't copy property");
/* Create initial value from default value for non-zero sized properties */
if(pcopy->size>0) {
/* Properties from the class should have any values yet, but should have a default */
assert(pcopy->value==NULL);
assert(pcopy->def_value);
/* Allocate space for the property value & copy default value */
if (NULL==(pcopy->value = H5MM_malloc (pcopy->size)))
HGOTO_ERROR (H5E_RESOURCE, H5E_NOSPACE, NULL, "memory allocation failed");
HDmemcpy(pcopy->value,pcopy->def_value,pcopy->size);
} /* end if */
/* Call property creation callback, if it exists */
if(pcopy->create) {
if((pcopy->create)(pcopy->name,&(pcopy->value))<0) {
H5P_free_prop(pcopy);
HGOTO_ERROR (H5E_PLIST, H5E_CANTINIT, NULL,"Can't initialize property");
} /* end if */
} /* end if */
/* Insert the initialized property into the property list */
if(H5P_add_prop(plist->props,tclass->hashsize,pcopy)<0)
HGOTO_ERROR (H5E_PLIST, H5E_CANTINSERT, NULL,"Can't insert property into class");
} /* end if */
/* Go to next registered property in class */
tmp=tmp->next;
} /* end while */
} /* end for */
} /* end if */
/* Go up to parent class */
tclass=tclass->parent;
} /* end while */
/* Increment the number of property lists derived from class */
if(H5P_access_class(plist->pclass,H5P_MOD_INC_LST)<0)
HGOTO_ERROR (H5E_PLIST, H5E_CANTINIT, NULL,"Can't increment class ref count");
/* Set return value */
ret_value=plist;
done:
/* Release resources allocated on failure */
if(ret_value==NULL) {
if(plist!=NULL) {
/* Close & free all the properties */
H5P_free_all_prop(plist->props,pclass->hashsize,1);
/* Decrement the number of property lists derived from the class */
pclass->plists--;
} /* end if */
} /* end if */
FUNC_LEAVE (ret_value);
} /* H5P_create_list() */
/*--------------------------------------------------------------------------
NAME
H5Pcreate_list
PURPOSE
Routine to create a new property list of a property list class.
USAGE
hid_t H5Pcreate_list(cls_id)
hid_t cls_id; IN: Property list class create list from
RETURNS
Returns a valid property list ID on success, FAIL on failure.
DESCRIPTION
Creates a property list of a given class. If a 'create' callback
exists for the property list class, it is called before the
property list is passed back to the user. If 'create' callbacks exist for
any individual properties in the property list, they are called before the
class 'create' callback.
GLOBAL VARIABLES
COMMENTS, BUGS, ASSUMPTIONS
EXAMPLES
REVISION LOG
--------------------------------------------------------------------------*/
hid_t H5Pcreate_list(hid_t cls_id)
{
H5P_genclass_t *pclass; /* Property list class to modify */
H5P_genplist_t *plist=NULL; /* Property list created */
hid_t plist_id=FAIL; /* Property list ID */
hid_t ret_value=FAIL; /* return value */
FUNC_ENTER (H5Pcreate_list, FAIL);
/* Check arguments. */
if (H5I_GENPROP_CLS != H5I_get_type(cls_id) || NULL == (pclass = H5I_object(cls_id)))
HGOTO_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL, "not a property list class");
/* Create the new property list */
if ((plist=H5P_create_list(pclass))==NULL)
HGOTO_ERROR(H5E_PLIST, H5E_CANTCREATE, FAIL, "unable to create property list");
/* Get an atom for the property list */
if ((plist_id = H5I_register(H5I_GENPROP_LST, plist))<0)
HGOTO_ERROR(H5E_PLIST, H5E_CANTREGISTER, FAIL, "unable to atomize property list");
/* Call the class callback (if it exists) now that we have the property list ID */
if(plist->pclass->create_func!=NULL) {
if((plist->pclass->create_func)(plist_id,plist->pclass->create_data)<0) {
/* Delete ID, ignore return value */
H5I_remove(plist_id);
HGOTO_ERROR (H5E_PLIST, H5E_CANTINIT, FAIL,"Can't initialize property");
} /* end if */
} /* end if */
/* Set the class initialization flag */
plist->class_init=1;
/* Set the return value */
ret_value=plist_id;
done:
if (ret_value<0 && plist)
H5P_close_list(plist);
FUNC_LEAVE (ret_value);
} /* H5Pcreate_list() */
/*--------------------------------------------------------------------------
NAME
H5P_register
PURPOSE
Internal routine to register a new property in a property list class.
USAGE
herr_t H5P_register(class, name, size, default, prp_create, prp_set, prp_get, prp_close)
H5P_genclass_t *class; IN: Property list class to close
const char *name; IN: Name of property to register
size_t size; IN: Size of property in bytes
void *def_value; IN: Pointer to buffer containing default value
for property in newly created property lists
H5P_prp_create_func_t prp_create; IN: Function pointer to property
creation callback
H5P_prp_set_func_t prp_set; IN: Function pointer to property set callback
H5P_prp_get_func_t prp_get; IN: Function pointer to property get callback
H5P_prp_close_func_t prp_close; IN: Function pointer to property close
callback
RETURNS
Returns non-negative on success, negative on failure.
DESCRIPTION
Registers a new property with a property list class. The property will
exist in all property list objects of that class after this routine is
finished. The name of the property must not already exist. The default
property value must be provided and all new property lists created with this
property will have the property value set to the default provided. Any of
the callback routines may be set to NULL if they are not needed.
Zero-sized properties are allowed and do not store any data in the
property list. These may be used as flags to indicate the presence or
absence of a particular piece of information. The 'default' pointer for a
zero-sized property may be set to NULL. The property 'create' & 'close'
callbacks are called for zero-sized properties, but the 'set' and 'get'
callbacks are never called.
The 'create' callback is called when a new property list with this
property is being created. H5P_prp_create_func_t is defined as:
typedef herr_t (*H5P_prp_create_func_t)(hid_t prop_id, const char *name,
void **initial_value);
where the parameters to the callback function are:
hid_t prop_id; IN: The ID of the property list being created.
const char *name; IN: The name of the property being modified.
void **initial_value; IN/OUT: The initial value for the property being created.
(The 'default' value passed to H5Pregister)
The 'create' routine may modify the value to be set and those changes will
be stored as the initial value of the property. If the 'create' routine
returns a negative value, the new property value is not copied into the
property and the property list creation routine returns an error value.
The 'set' callback is called before a new value is copied into the
property. H5P_prp_set_func_t is defined as:
typedef herr_t (*H5P_prp_set_func_t)(hid_t prop_id, const char *name,
void **value);
where the parameters to the callback function are:
hid_t prop_id; IN: The ID of the property list being modified.
const char *name; IN: The name of the property being modified.
void *new_value; IN/OUT: The value being set for the property.
The 'set' routine may modify the value to be set and those changes will be
stored as the value of the property. If the 'set' routine returns a
negative value, the new property value is not copied into the property and
the property list set routine returns an error value.
The 'get' callback is called before a value is retrieved from the
property. H5P_prp_get_func_t is defined as:
typedef herr_t (*H5P_prp_get_func_t)(hid_t prop_id, const char *name,
void *value);
where the parameters to the callback function are:
hid_t prop_id; IN: The ID of the property list being queried.
const char *name; IN: The name of the property being queried.
void *value; IN/OUT: The value being retrieved for the property.
The 'get' routine may modify the value to be retrieved and those changes
will be returned to the calling function. If the 'get' routine returns a
negative value, the property value is returned and the property list get
routine returns an error value.
The 'close' callback is called when a property list with this
property is being destroyed. H5P_prp_close_func_t is defined as:
typedef herr_t (*H5P_prp_close_func_t)(const char *name, void *value);
where the parameters to the callback function are:
const char *name; IN: The name of the property being closed.
void *value; IN: The value of the property being closed.
The 'close' routine may modify the value passed in, but the value is not
used by the library when the 'close' routine returns. If the
'close' routine returns a negative value, the property list close
routine returns an error value but the property list is still closed.
GLOBAL VARIABLES
COMMENTS, BUGS, ASSUMPTIONS
The 'set' callback function may be useful to range check the value being
set for the property or may perform some tranformation/translation of the
value set. The 'get' callback would then [probably] reverse the
transformation, etc. A single 'get' or 'set' callback could handle
multiple properties by performing different actions based on the property
name or other properties in the property list.
I would like to say "the property list is not closed" when a 'close'
routine fails, but I don't think that's possible due to other properties in
the list being successfully closed & removed from the property list. I
suppose that it would be possible to just remove the properties which have
successful 'close' callbacks, but I'm not happy with the ramifications
of a mangled, un-closable property list hanging around... Any comments? -QAK
EXAMPLES
REVISION LOG
--------------------------------------------------------------------------*/
static herr_t H5P_register(H5P_genclass_t *pclass, const char *name, size_t size,
void *def_value, H5P_prp_create_func_t prp_create, H5P_prp_set_func_t prp_set,
H5P_prp_get_func_t prp_get, H5P_prp_close_func_t prp_close)
{
H5P_genclass_t *new_class; /* New class pointer */
H5P_genprop_t *tmp_prop; /* Temporary property pointer */
H5P_genprop_t *new_prop=NULL; /* Temporary property pointer */
H5P_genprop_t *pcopy; /* Property copy */
unsigned u; /* Local index variable */
herr_t ret_value=FAIL; /* return value */
FUNC_ENTER (H5P_register, FAIL);
assert(pclass);
assert(name);
assert((size>0 && def_value!=NULL) || (size==0));
/* Check for duplicate named properties */
if((tmp_prop=H5P_find_prop(pclass->props,pclass->hashsize,name))!=NULL)
HGOTO_ERROR(H5E_PLIST, H5E_EXISTS, FAIL, "property already exists");
/* Check if class needs to be split because property lists or classes have
* been created since the last modification was made to the class.
*/
if(pclass->plists>0 || pclass->classes>0) {
if((new_class=H5P_create_class(pclass->parent,pclass->name,pclass->hashsize,
(unsigned)pclass->internal,pclass->create_func,pclass->create_data,
pclass->close_func,pclass->close_data))==NULL)
HGOTO_ERROR(H5E_PLIST, H5E_CANTCOPY, FAIL, "can't copy class");
/* Walk through the hash table of the old class and copy properties */
for(u=0; u<pclass->hashsize; u++) {
tmp_prop=pclass->props[u];
while(tmp_prop!=NULL) {
/* Make a copy of the class's property */
if((pcopy=H5P_copy_prop(tmp_prop))==NULL)
HGOTO_ERROR (H5E_PLIST, H5E_CANTCOPY, FAIL,"Can't copy property");
/* Insert the property into the new property class */
if(H5P_add_prop(new_class->props,pclass->hashsize,pcopy)<0)
HGOTO_ERROR (H5E_PLIST, H5E_CANTINSERT, FAIL,"Can't insert property into class");
/* Go to next registered property in class */
tmp_prop=tmp_prop->next;
} /* end while */
} /* end for */
/* Use the new class instead of the old one */
pclass=new_class;
} /* end if */
/* Create property object from parameters */
if((new_prop=H5P_create_prop(name,size,def_value,NULL,prp_create,prp_set,prp_get,prp_close))==NULL)
HGOTO_ERROR (H5E_PLIST, H5E_CANTCREATE, FAIL,"Can't create property");
/* Insert property into property list class */
if(H5P_add_prop(pclass->props,pclass->hashsize,new_prop)<0)
HGOTO_ERROR (H5E_PLIST, H5E_CANTINSERT, FAIL,"Can't insert property into class");
/* Increment property count for class */
pclass->nprops++;
/* Set return value */
ret_value=SUCCEED;
done:
if(ret_value==FAIL) {
if(new_prop!=NULL) {
if(new_prop->name!=NULL)
H5MM_xfree(new_prop->name);
if(new_prop->value!=NULL)
H5MM_xfree(new_prop->value);
if(new_prop->def_value!=NULL)
H5MM_xfree(new_prop->def_value);
H5MM_xfree(new_prop);
} /* end if */
} /* end if */
FUNC_LEAVE (ret_value);
} /* H5P_register() */
/*--------------------------------------------------------------------------
NAME
H5Pregister
PURPOSE
Routine to register a new property in a property list class.
USAGE
herr_t H5Pregister(class, name, size, default, prp_create, prp_set, prp_get, prp_close)
hid_t class; IN: Property list class to close
const char *name; IN: Name of property to register
size_t size; IN: Size of property in bytes
void *def_value; IN: Pointer to buffer containing default value
for property in newly created property lists
H5P_prp_create_func_t prp_create; IN: Function pointer to property
creation callback
H5P_prp_set_func_t prp_set; IN: Function pointer to property set callback
H5P_prp_get_func_t prp_get; IN: Function pointer to property get callback
H5P_prp_close_func_t prp_close; IN: Function pointer to property close
callback
RETURNS
Returns non-negative on success, negative on failure.
DESCRIPTION
Registers a new property with a property list class. The property will
exist in all property list objects of that class after this routine is
finished. The name of the property must not already exist. The default
property value must be provided and all new property lists created with this
property will have the property value set to the default provided. Any of
the callback routines may be set to NULL if they are not needed.
Zero-sized properties are allowed and do not store any data in the
property list. These may be used as flags to indicate the presence or
absence of a particular piece of information. The 'default' pointer for a
zero-sized property may be set to NULL. The property 'create' & 'close'
callbacks are called for zero-sized properties, but the 'set' and 'get'
callbacks are never called.
The 'create' callback is called when a new property list with this
property is being created. H5P_prp_create_func_t is defined as:
typedef herr_t (*H5P_prp_create_func_t)(hid_t prop_id, const char *name,
void **initial_value);
where the parameters to the callback function are:
hid_t prop_id; IN: The ID of the property list being created.
const char *name; IN: The name of the property being modified.
void **initial_value; IN/OUT: The initial value for the property being created.
(The 'default' value passed to H5Pregister)
The 'create' routine may modify the value to be set and those changes will
be stored as the initial value of the property. If the 'create' routine
returns a negative value, the new property value is not copied into the
property and the property list creation routine returns an error value.
The 'set' callback is called before a new value is copied into the
property. H5P_prp_set_func_t is defined as:
typedef herr_t (*H5P_prp_set_func_t)(hid_t prop_id, const char *name,
void **value);
where the parameters to the callback function are:
hid_t prop_id; IN: The ID of the property list being modified.
const char *name; IN: The name of the property being modified.
void **new_value; IN/OUT: The value being set for the property.
The 'set' routine may modify the value to be set and those changes will be
stored as the value of the property. If the 'set' routine returns a
negative value, the new property value is not copied into the property and
the property list set routine returns an error value.
The 'get' callback is called before a value is retrieved from the
property. H5P_prp_get_func_t is defined as:
typedef herr_t (*H5P_prp_get_func_t)(hid_t prop_id, const char *name,
void *value);
where the parameters to the callback function are:
hid_t prop_id; IN: The ID of the property list being queried.
const char *name; IN: The name of the property being queried.
void **value; IN/OUT: The value being retrieved for the property.
The 'get' routine may modify the value to be retrieved and those changes
will be returned to the calling function. If the 'get' routine returns a
negative value, the property value is returned and the property list get
routine returns an error value.
The 'close' callback is called when a property list with this
property is being destroyed. H5P_prp_close_func_t is defined as:
typedef herr_t (*H5P_prp_close_func_t)(const char *name, void *value);
where the parameters to the callback function are:
const char *name; IN: The name of the property being closed.
void *value; IN: The value of the property being closed.
The 'close' routine may modify the value passed in, but the value is not
used by the library when the 'close' routine returns. If the
'close' routine returns a negative value, the property list close
routine returns an error value but the property list is still closed.
GLOBAL VARIABLES
COMMENTS, BUGS, ASSUMPTIONS
The 'set' callback function may be useful to range check the value being
set for the property or may perform some tranformation/translation of the
value set. The 'get' callback would then [probably] reverse the
transformation, etc. A single 'get' or 'set' callback could handle
multiple properties by performing different actions based on the property
name or other properties in the property list.
I would like to say "the property list is not closed" when a 'close'
routine fails, but I don't think that's possible due to other properties in
the list being successfully closed & removed from the property list. I
suppose that it would be possible to just remove the properties which have
successful 'close' callbacks, but I'm not happy with the ramifications
of a mangled, un-closable property list hanging around... Any comments? -QAK
EXAMPLES
REVISION LOG
--------------------------------------------------------------------------*/
herr_t H5Pregister(hid_t cls_id, const char *name, size_t size, void *def_value,
H5P_prp_create_func_t prp_create, H5P_prp_set_func_t prp_set,
H5P_prp_get_func_t prp_get, H5P_prp_close_func_t prp_close)
{
H5P_genclass_t *pclass; /* Property list class to modify */
herr_t ret_value=FAIL; /* return value */
FUNC_ENTER (H5Pregister, FAIL);
/* Check arguments. */
if (H5I_GENPROP_CLS != H5I_get_type(cls_id) || NULL == (pclass = H5I_object(cls_id)))
HGOTO_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL, "not a property list class");
if (!name || !*name)
HGOTO_ERROR(H5E_ARGS, H5E_BADVALUE, FAIL, "invalid class name");
if (size>0 && def_value==NULL)
HGOTO_ERROR(H5E_ARGS, H5E_BADVALUE, FAIL, "properties >0 size must have default");
/* Create the new property list class */
if ((ret_value=H5P_register(pclass,name,size,def_value,prp_create,prp_set,prp_get,prp_close))<0)
HGOTO_ERROR(H5E_PLIST, H5E_CANTREGISTER, FAIL, "unable to register property in class");
done:
FUNC_LEAVE (ret_value);
} /* H5Pregister() */
/*--------------------------------------------------------------------------
NAME
H5P_insert
PURPOSE
Internal routine to insert a new property in a property list.
USAGE
herr_t H5P_insert(plist, name, size, value, prp_set, prp_get, prp_close)
H5P_genplist_t *plist; IN: Property list to add property to
const char *name; IN: Name of property to add
size_t size; IN: Size of property in bytes
void *value; IN: Pointer to the value for the property
H5P_prp_set_func_t prp_set; IN: Function pointer to property set callback
H5P_prp_get_func_t prp_get; IN: Function pointer to property get callback
H5P_prp_close_func_t prp_close; IN: Function pointer to property close
callback
RETURNS
Returns non-negative on success, negative on failure.
DESCRIPTION
Inserts a temporary property into a property list. The property will
exist only in this property list object. The name of the property must not
already exist. The value must be provided unless the property is zero-
sized. Any of the callback routines may be set to NULL if they are not
needed.
Zero-sized properties are allowed and do not store any data in the
property list. These may be used as flags to indicate the presence or
absence of a particular piece of information. The 'value' pointer for a
zero-sized property may be set to NULL. The property 'close' callback is
called for zero-sized properties, but the 'set' and 'get' callbacks are
never called.
The 'set' callback is called before a new value is copied into the
property. H5P_prp_set_func_t is defined as:
typedef herr_t (*H5P_prp_set_func_t)(hid_t prop_id, const char *name,
void **value);
where the parameters to the callback function are:
hid_t prop_id; IN: The ID of the property list being modified.
const char *name; IN: The name of the property being modified.
void **new_value; IN/OUT: The value being set for the property.
The 'set' routine may modify the value to be set and those changes will be
stored as the value of the property. If the 'set' routine returns a
negative value, the new property value is not copied into the property and
the property list set routine returns an error value.
The 'get' callback is called before a value is retrieved from the
property. H5P_prp_get_func_t is defined as:
typedef herr_t (*H5P_prp_get_func_t)(hid_t prop_id, const char *name,
void *value);
where the parameters to the callback function are:
hid_t prop_id; IN: The ID of the property list being queried.
const char *name; IN: The name of the property being queried.
void **value; IN/OUT: The value being retrieved for the property.
The 'get' routine may modify the value to be retrieved and those changes
will be returned to the calling function. If the 'get' routine returns a
negative value, the property value is returned and the property list get
routine returns an error value.
The 'close' callback is called when a property list with this
property is being destroyed. H5P_prp_close_func_t is defined as:
typedef herr_t (*H5P_prp_close_func_t)(const char *name,
void *value);
where the parameters to the callback function are:
const char *name; IN: The name of the property being closed.
void *value; IN: The value of the property being closed.
The 'close' routine may modify the value passed in, but the value is not
used by the library when the 'close' routine returns. If the
'close' routine returns a negative value, the property list close
routine returns an error value but the property list is still closed.
GLOBAL VARIABLES
COMMENTS, BUGS, ASSUMPTIONS
The 'set' callback function may be useful to range check the value being
set for the property or may perform some tranformation/translation of the
value set. The 'get' callback would then [probably] reverse the
transformation, etc. A single 'get' or 'set' callback could handle
multiple properties by performing different actions based on the property
name or other properties in the property list.
There is no 'create' callback routine for temporary property list
objects, the initial value is assumed to have any necessary setup already
performed on it.
I would like to say "the property list is not closed" when a 'close'
routine fails, but I don't think that's possible due to other properties in
the list being successfully closed & removed from the property list. I
suppose that it would be possible to just remove the properties which have
successful 'close' callbacks, but I'm not happy with the ramifications
of a mangled, un-closable property list hanging around... Any comments? -QAK
EXAMPLES
REVISION LOG
--------------------------------------------------------------------------*/
static herr_t H5P_insert(H5P_genplist_t *plist, const char *name, size_t size,
void *value, H5P_prp_set_func_t prp_set, H5P_prp_get_func_t prp_get,
H5P_prp_close_func_t prp_close)
{
H5P_genprop_t *new_prop=NULL; /* Temporary property pointer */
herr_t ret_value=FAIL; /* return value */
FUNC_ENTER (H5P_insert, FAIL);
assert(plist);
assert(name);
assert((size>0 && value!=NULL) || (size==0));
/* Check for duplicate named properties */
if(H5P_find_prop(plist->props,plist->pclass->hashsize,name)!=NULL)
HGOTO_ERROR(H5E_PLIST, H5E_EXISTS, FAIL, "property already exists");
/* Create property object from parameters */
if((new_prop=H5P_create_prop(name,size,NULL,value,NULL,prp_set,prp_get,prp_close))==NULL)
HGOTO_ERROR (H5E_PLIST, H5E_CANTCREATE, FAIL,"Can't create property");
/* Insert property into property list class */
if(H5P_add_prop(plist->props,plist->pclass->hashsize,new_prop)<0)
HGOTO_ERROR (H5E_PLIST, H5E_CANTINSERT, FAIL,"Can't insert property into class");
/* Increment property count for class */
plist->nprops++;
/* Set return value */
ret_value=SUCCEED;
done:
if(ret_value==FAIL) {
if(new_prop!=NULL) {
if(new_prop->name!=NULL)
H5MM_xfree(new_prop->name);
if(new_prop->value!=NULL)
H5MM_xfree(new_prop->value);
if(new_prop->def_value!=NULL)
H5MM_xfree(new_prop->def_value);
H5MM_xfree(new_prop);
} /* end if */
} /* end if */
FUNC_LEAVE (ret_value);
} /* H5P_insert() */
/*--------------------------------------------------------------------------
NAME
H5Pinsert
PURPOSE
Routine to insert a new property in a property list.
USAGE
herr_t H5Pinsert(plist, name, size, value, prp_set, prp_get, prp_close)
hid_t plist; IN: Property list to add property to
const char *name; IN: Name of property to add
size_t size; IN: Size of property in bytes
void *value; IN: Pointer to the value for the property
H5P_prp_set_func_t prp_set; IN: Function pointer to property set callback
H5P_prp_get_func_t prp_get; IN: Function pointer to property get callback
H5P_prp_close_func_t prp_close; IN: Function pointer to property close
callback
RETURNS
Returns non-negative on success, negative on failure.
DESCRIPTION
Inserts a temporary property into a property list. The property will
exist only in this property list object. The name of the property must not
already exist. The value must be provided unless the property is zero-
sized. Any of the callback routines may be set to NULL if they are not
needed.
Zero-sized properties are allowed and do not store any data in the
property list. These may be used as flags to indicate the presence or
absence of a particular piece of information. The 'value' pointer for a
zero-sized property may be set to NULL. The property 'close' callback is
called for zero-sized properties, but the 'set' and 'get' callbacks are
never called.
The 'set' callback is called before a new value is copied into the
property. H5P_prp_set_func_t is defined as:
typedef herr_t (*H5P_prp_set_func_t)(hid_t prop_id, const char *name,
void **value);
where the parameters to the callback function are:
hid_t prop_id; IN: The ID of the property list being modified.
const char *name; IN: The name of the property being modified.
void **new_value; IN/OUT: The value being set for the property.
The 'set' routine may modify the value to be set and those changes will be
stored as the value of the property. If the 'set' routine returns a
negative value, the new property value is not copied into the property and
the property list set routine returns an error value.
The 'get' callback is called before a value is retrieved from the
property. H5P_prp_get_func_t is defined as:
typedef herr_t (*H5P_prp_get_func_t)(hid_t prop_id, const char *name,
void *value);
where the parameters to the callback function are:
hid_t prop_id; IN: The ID of the property list being queried.
const char *name; IN: The name of the property being queried.
void **value; IN/OUT: The value being retrieved for the property.
The 'get' routine may modify the value to be retrieved and those changes
will be returned to the calling function. If the 'get' routine returns a
negative value, the property value is returned and the property list get
routine returns an error value.
The 'close' callback is called when a property list with this
property is being destroyed. H5P_prp_close_func_t is defined as:
typedef herr_t (*H5P_prp_close_func_t)(const char *name, void *value);
where the parameters to the callback function are:
const char *name; IN: The name of the property being closed.
void *value; IN: The value of the property being closed.
The 'close' routine may modify the value passed in, but the value is not
used by the library when the 'close' routine returns. If the
'close' routine returns a negative value, the property list close
routine returns an error value but the property list is still closed.
GLOBAL VARIABLES
COMMENTS, BUGS, ASSUMPTIONS
The 'set' callback function may be useful to range check the value being
set for the property or may perform some tranformation/translation of the
value set. The 'get' callback would then [probably] reverse the
transformation, etc. A single 'get' or 'set' callback could handle
multiple properties by performing different actions based on the property
name or other properties in the property list.
There is no 'create' callback routine for temporary property list
objects, the initial value is assumed to have any necessary setup already
performed on it.
I would like to say "the property list is not closed" when a 'close'
routine fails, but I don't think that's possible due to other properties in
the list being successfully closed & removed from the property list. I
suppose that it would be possible to just remove the properties which have
successful 'close' callbacks, but I'm not happy with the ramifications
of a mangled, un-closable property list hanging around... Any comments? -QAK
EXAMPLES
REVISION LOG
--------------------------------------------------------------------------*/
herr_t H5Pinsert(hid_t plist_id, const char *name, size_t size, void *value,
H5P_prp_set_func_t prp_set, H5P_prp_get_func_t prp_get,
H5P_prp_close_func_t prp_close)
{
H5P_genplist_t *plist; /* Property list to modify */
herr_t ret_value=FAIL; /* return value */
FUNC_ENTER (H5Pinsert, FAIL);
/* Check arguments. */
if (H5I_GENPROP_LST != H5I_get_type(plist_id) || NULL == (plist = H5I_object(plist_id)))
HGOTO_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL, "not a property list");
if (!name || !*name)
HGOTO_ERROR(H5E_ARGS, H5E_BADVALUE, FAIL, "invalid property name");
if (size>0 && value==NULL)
HGOTO_ERROR(H5E_ARGS, H5E_BADVALUE, FAIL, "properties >0 size must have default");
/* Create the new property list class */
if ((ret_value=H5P_insert(plist,name,size,value,prp_set,prp_get,prp_close))<0)
HGOTO_ERROR(H5E_PLIST, H5E_CANTREGISTER, FAIL, "unable to register property in plist");
done:
FUNC_LEAVE (ret_value);
} /* H5Pinsert() */
/*--------------------------------------------------------------------------
NAME
H5P_set
PURPOSE
Internal routine to set a property's value in a property list.
USAGE
herr_t H5P_set(plist, name, value)
hid_t plist_id; IN: Property list to find property in
const char *name; IN: Name of property to set
void *value; IN: Pointer to the value for the property
RETURNS
Returns non-negative on success, negative on failure.
DESCRIPTION
Sets a new value for a property in a property list. The property name
must exist or this routine will fail. If there is a 'set' callback routine
registered for this property, the 'value' will be passed to that routine and
any changes to the 'value' will be used when setting the property value.
The information pointed at by the 'value' pointer (possibly modified by the
'set' callback) is copied into the property list value and may be changed
by the application making the H5Pset call without affecting the property
value.
If the 'set' callback routine returns an error, the property value will
not be modified. This routine may not be called for zero-sized properties
and will return an error in that case.
GLOBAL VARIABLES
COMMENTS, BUGS, ASSUMPTIONS
EXAMPLES
REVISION LOG
--------------------------------------------------------------------------*/
static herr_t H5P_set(hid_t plist_id, const char *name, void *value)
{
H5P_genplist_t *plist; /* Property list to modify */
H5P_genprop_t *prop; /* Temporary property pointer */
herr_t ret_value=FAIL; /* return value */
FUNC_ENTER (H5P_set, FAIL);
assert(name);
assert(value);
/* Argument checking */
if (H5I_GENPROP_LST != H5I_get_type(plist_id) || NULL == (plist = H5I_object(plist_id)))
HGOTO_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL, "not a property list");
/* Find property */
if((prop=H5P_find_prop(plist->props,plist->pclass->hashsize,name))==NULL)
HGOTO_ERROR(H5E_PLIST, H5E_NOTFOUND, FAIL, "property doesn't exist");
/* Check for property size >0 */
if(prop->size==0)
HGOTO_ERROR(H5E_PLIST, H5E_BADVALUE, FAIL, "property has zero size");
/* Make a copy of the value and pass to 'set' callback */
if(prop->set!=NULL) {
void *tmp_value; /* Temporary value for property */
/* Make a copy of the current value, in case the callback fails */
if (NULL==(tmp_value=H5MM_malloc(prop->size)))
HRETURN_ERROR(H5E_RESOURCE, H5E_NOSPACE, FAIL, "memory allocation failed temporary property value");
HDmemcpy(tmp_value,prop->value,prop->size);
/* Call user's callback */
if((*(prop->set))(plist_id,name,tmp_value)<0)
HRETURN_ERROR(H5E_PLIST, H5E_CANTINIT, FAIL, "can't set property value");
/* Copy new [possibly unchanged] value into property value */
HDmemcpy(prop->value,tmp_value,prop->size);
/* Free the temporary value buffer */
H5MM_xfree(tmp_value);
} /* end if */
/* No 'set' callback, just copy value */
else
HDmemcpy(prop->value,value,prop->size);
/* Set return value */
ret_value=SUCCEED;
done:
FUNC_LEAVE (ret_value);
} /* H5P_set() */
/*--------------------------------------------------------------------------
NAME
H5Pset
PURPOSE
Routine to set a property's value in a property list.
USAGE
herr_t H5P_set(plist_id, name, value)
hid_t plist_id; IN: Property list to find property in
const char *name; IN: Name of property to set
void *value; IN: Pointer to the value for the property
RETURNS
Returns non-negative on success, negative on failure.
DESCRIPTION
Sets a new value for a property in a property list. The property name
must exist or this routine will fail. If there is a 'set' callback routine
registered for this property, the 'value' will be passed to that routine and
any changes to the 'value' will be used when setting the property value.
The information pointed at by the 'value' pointer (possibly modified by the
'set' callback) is copied into the property list value and may be changed
by the application making the H5Pset call without affecting the property
value.
If the 'set' callback routine returns an error, the property value will
not be modified. This routine may not be called for zero-sized properties
and will return an error in that case.
GLOBAL VARIABLES
COMMENTS, BUGS, ASSUMPTIONS
EXAMPLES
REVISION LOG
--------------------------------------------------------------------------*/
herr_t H5Pset(hid_t plist_id, const char *name, void *value)
{
herr_t ret_value=FAIL; /* return value */
FUNC_ENTER (H5Pset, FAIL);
/* Check arguments. */
if (H5I_GENPROP_LST != H5I_get_type(plist_id))
HGOTO_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL, "not a property list");
if (!name || !*name)
HGOTO_ERROR(H5E_ARGS, H5E_BADVALUE, FAIL, "invalid property name");
if (value==NULL)
HGOTO_ERROR(H5E_ARGS, H5E_BADVALUE, FAIL, "invalied property value");
/* Create the new property list class */
if ((ret_value=H5P_set(plist_id,name,value))<0)
HGOTO_ERROR(H5E_PLIST, H5E_CANTREGISTER, FAIL, "unable to set value in plist");
done:
FUNC_LEAVE (ret_value);
} /* H5Pset() */
/*--------------------------------------------------------------------------
NAME
H5P_exist_plist
PURPOSE
Internal routine to query the existance of a property in a property list.
USAGE
herr_t H5P_exist_plist(plist, name)
H5P_genplist_t *plist; IN: Property list to check
const char *name; IN: Name of property to check for
RETURNS
Success: Positive if the property exists in the property list, zero
if the property does not exist.
Failure: negative value
DESCRIPTION
This routine checks if a property exists within a property list.
GLOBAL VARIABLES
COMMENTS, BUGS, ASSUMPTIONS
EXAMPLES
REVISION LOG
--------------------------------------------------------------------------*/
static htri_t H5P_exist_plist(H5P_genplist_t *plist, const char *name)
{
htri_t ret_value=FAIL; /* return value */
FUNC_ENTER (H5P_exist_plist, FAIL);
assert(plist);
assert(name);
/* Check for property in property list */
if(H5P_find_prop(plist->props,plist->pclass->hashsize,name)==NULL)
ret_value=0;
else
ret_value=1;
FUNC_LEAVE (ret_value);
} /* H5P_exist_plist() */
/*--------------------------------------------------------------------------
NAME
H5P_exist_pclass
PURPOSE
Internal routine to query the existance of a property in a property class.
USAGE
herr_t H5P_exist_pclass(pclass, name)
H5P_genclass_t *pclass; IN: Property class to check
const char *name; IN: Name of property to check for
RETURNS
Success: Positive if the property exists in the property list, zero
if the property does not exist.
Failure: negative value
DESCRIPTION
This routine checks if a property exists within a property list.
GLOBAL VARIABLES
COMMENTS, BUGS, ASSUMPTIONS
EXAMPLES
REVISION LOG
--------------------------------------------------------------------------*/
static htri_t H5P_exist_pclass(H5P_genclass_t *pclass, const char *name)
{
htri_t ret_value=FAIL; /* return value */
FUNC_ENTER (H5P_exist_pclass, FAIL);
assert(pclass);
assert(name);
/* Check for property in property list */
if(H5P_find_prop(pclass->props,pclass->hashsize,name)==NULL)
ret_value=0;
else
ret_value=1;
FUNC_LEAVE (ret_value);
} /* H5P_exist_pclass() */
/*--------------------------------------------------------------------------
NAME
H5Pexist
PURPOSE
Routine to query the existance of a property in a property object.
USAGE
htri_t H5P_exist(id, name)
hid_t id; IN: Property object ID to check
const char *name; IN: Name of property to check for
RETURNS
Success: Positive if the property exists in the property object, zero
if the property does not exist.
Failure: negative value
DESCRIPTION
This routine checks if a property exists within a property list or
class.
GLOBAL VARIABLES
COMMENTS, BUGS, ASSUMPTIONS
EXAMPLES
REVISION LOG
--------------------------------------------------------------------------*/
htri_t H5Pexist(hid_t id, const char *name)
{
H5P_genplist_t *plist; /* Property list to query */
H5P_genclass_t *pclass; /* Property class to query */
htri_t ret_value=FAIL; /* return value */
FUNC_ENTER (H5Pexist, FAIL);
/* Check arguments. */
if (H5I_GENPROP_LST != H5I_get_type(id) && H5I_GENPROP_CLS != H5I_get_type(id))
HGOTO_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL, "not a property object");
if (!name || !*name)
HGOTO_ERROR(H5E_ARGS, H5E_BADVALUE, FAIL, "invalid property name");
/* Check for the existance of the property in the list or class */
if(H5I_GENPROP_LST == H5I_get_type(id)) {
if (NULL == (plist = H5I_object(id)))
HGOTO_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL, "not a property list");
if ((ret_value=H5P_exist_plist(plist,name))<0)
HGOTO_ERROR(H5E_PLIST, H5E_CANTREGISTER, FAIL, "unable to existance of property in plist");
} /* end if */
else
if(H5I_GENPROP_CLS == H5I_get_type(id)) {
if (NULL == (pclass = H5I_object(id)))
HGOTO_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL, "not a property class");
if ((ret_value=H5P_exist_pclass(pclass,name))<0)
HGOTO_ERROR(H5E_PLIST, H5E_CANTREGISTER, FAIL, "unable to existance of property in pclass");
} /* end if */
else
HGOTO_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL, "not a property object");
done:
FUNC_LEAVE (ret_value);
} /* H5Pexist() */
/*--------------------------------------------------------------------------
NAME
H5P_get_size_plist
PURPOSE
Internal routine to query the size of a property in a property list.
USAGE
herr_t H5P_get_size_plist(plist, name)
H5P_genplist_t *plist; IN: Property list to check
const char *name; IN: Name of property to query
size_t *size; OUT: Size of property
RETURNS
Success: non-negative value
Failure: negative value
DESCRIPTION
This routine retrieves the size of a property's value in bytes. Zero-
sized properties are allowed and return a value of 0.
GLOBAL VARIABLES
COMMENTS, BUGS, ASSUMPTIONS
EXAMPLES
REVISION LOG
--------------------------------------------------------------------------*/
static herr_t H5P_get_size_plist(H5P_genplist_t *plist, const char *name, size_t *size)
{
H5P_genprop_t *prop; /* Temporary property pointer */
herr_t ret_value=SUCCEED; /* return value */
FUNC_ENTER (H5P_get_size_plist, FAIL);
assert(plist);
assert(name);
assert(size);
/* Find property */
if((prop=H5P_find_prop(plist->props,plist->pclass->hashsize,name))==NULL)
HGOTO_ERROR(H5E_PLIST, H5E_NOTFOUND, FAIL, "property doesn't exist");
/* Get property size */
*size=prop->size;
done:
FUNC_LEAVE (ret_value);
} /* H5P_get_size_plist() */
/*--------------------------------------------------------------------------
NAME
H5P_get_size_pclass
PURPOSE
Internal routine to query the size of a property in a property class.
USAGE
herr_t H5P_get_size_pclass(pclass, name)
H5P_genclass_t *pclass; IN: Property class to check
const char *name; IN: Name of property to query
size_t *size; OUT: Size of property
RETURNS
Success: non-negative value
Failure: negative value
DESCRIPTION
This routine retrieves the size of a property's value in bytes. Zero-
sized properties are allowed and return a value of 0.
GLOBAL VARIABLES
COMMENTS, BUGS, ASSUMPTIONS
EXAMPLES
REVISION LOG
--------------------------------------------------------------------------*/
static herr_t H5P_get_size_pclass(H5P_genclass_t *pclass, const char *name, size_t *size)
{
H5P_genprop_t *prop; /* Temporary property pointer */
herr_t ret_value=SUCCEED; /* return value */
FUNC_ENTER (H5P_get_size_pclass, FAIL);
assert(pclass);
assert(name);
assert(size);
/* Find property */
if((prop=H5P_find_prop(pclass->props,pclass->hashsize,name))==NULL)
HGOTO_ERROR(H5E_PLIST, H5E_NOTFOUND, FAIL, "property doesn't exist");
/* Get property size */
*size=prop->size;
done:
FUNC_LEAVE (ret_value);
} /* H5P_get_size_pclass() */
/*--------------------------------------------------------------------------
NAME
H5Pget_size
PURPOSE
Routine to query the size of a property in a property list or class.
USAGE
herr_t H5Pget_size(id, name)
hid_t id; IN: ID of property list or class to check
const char *name; IN: Name of property to query
size_t *size; OUT: Size of property
RETURNS
Success: non-negative value
Failure: negative value
DESCRIPTION
This routine retrieves the size of a property's value in bytes. Zero-
sized properties are allowed and return a value of 0. This function works
for both property lists and classes.
GLOBAL VARIABLES
COMMENTS, BUGS, ASSUMPTIONS
EXAMPLES
REVISION LOG
--------------------------------------------------------------------------*/
herr_t H5Pget_size(hid_t id, const char *name, size_t *size)
{
H5P_genclass_t *pclass; /* Property class to query */
H5P_genplist_t *plist; /* Property list to query */
herr_t ret_value=FAIL; /* return value */
FUNC_ENTER (H5Pget_size, FAIL);
/* Check arguments. */
if (H5I_GENPROP_LST != H5I_get_type(id) && H5I_GENPROP_CLS != H5I_get_type(id))
HGOTO_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL, "not a property object");
if (!name || !*name)
HGOTO_ERROR(H5E_ARGS, H5E_BADVALUE, FAIL, "invalid property name");
if (size==NULL)
HGOTO_ERROR(H5E_ARGS, H5E_BADVALUE, FAIL, "invalid property size");
if (H5I_GENPROP_LST == H5I_get_type(id)) {
if (NULL == (plist = H5I_object(id)))
HGOTO_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL, "not a property list");
/* Check the property size */
if ((ret_value=H5P_get_size_plist(plist,name,size))<0)
HGOTO_ERROR(H5E_PLIST, H5E_CANTREGISTER, FAIL, "unable to query size in plist");
} /* end if */
else
if (H5I_GENPROP_CLS == H5I_get_type(id)) {
if (NULL == (pclass = H5I_object(id)))
HGOTO_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL, "not a property list");
/* Check the property size */
if ((ret_value=H5P_get_size_pclass(pclass,name,size))<0)
HGOTO_ERROR(H5E_PLIST, H5E_CANTREGISTER, FAIL, "unable to query size in plist");
} /* end if */
else
HGOTO_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL, "not a property object");
done:
FUNC_LEAVE (ret_value);
} /* H5Pget_size() */
/*--------------------------------------------------------------------------
NAME
H5P_get_class
PURPOSE
Internal routine to query the class of a generic property list
USAGE
H5P_genclass_t *H5P_get_class(plist)
H5P_genplist_t *plist; IN: Property list to check
RETURNS
Success: Pointer to the class for a property list
Failure: NULL
DESCRIPTION
This routine retrieves a pointer to the class for a property list.
GLOBAL VARIABLES
COMMENTS, BUGS, ASSUMPTIONS
EXAMPLES
REVISION LOG
--------------------------------------------------------------------------*/
static H5P_genclass_t *H5P_get_class_new(H5P_genplist_t *plist)
{
H5P_genclass_t *ret_value=NULL; /* return value */
FUNC_ENTER (H5P_get_class, NULL);
assert(plist);
/* Get property size */
ret_value=plist->pclass;
FUNC_LEAVE (ret_value);
} /* H5P_get_class() */
/*--------------------------------------------------------------------------
NAME
H5Pget_class
PURPOSE
Routine to query the class of a generic property list
USAGE
hid_t H5Pget_class(plist_id)
hid_t plist_id; IN: Property list to query
RETURNS
Success: ID of class object
Failure: negative
DESCRIPTION
This routine retrieves the class of a property list.
GLOBAL VARIABLES
COMMENTS, BUGS, ASSUMPTIONS
Change the name of this function to H5Pget_class (and remove old H5Pget_class)
EXAMPLES
REVISION LOG
--------------------------------------------------------------------------*/
hid_t H5Pget_class_new(hid_t plist_id)
{
H5P_genplist_t *plist; /* Property list to query */
H5P_genclass_t *pclass=NULL; /* Property list class */
hid_t ret_value=FAIL; /* return value */
FUNC_ENTER (H5Pget_class, FAIL);
/* Check arguments. */
if (H5I_GENPROP_LST != H5I_get_type(plist_id) || NULL == (plist = H5I_object(plist_id)))
HGOTO_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL, "not a property list");
/* Retrieve the property list class */
if ((pclass=H5P_get_class_new(plist))==NULL)
HGOTO_ERROR(H5E_PLIST, H5E_NOTFOUND, FAIL, "unable to query class of property list");
/* Increment the outstanding references to the class object */
if(H5P_access_class(pclass,H5P_MOD_INC_REF)<0)
HGOTO_ERROR (H5E_PLIST, H5E_CANTINIT, FAIL,"Can't increment class ID ref count");
/* Get an atom for the class */
if ((ret_value = H5I_register(H5I_GENPROP_CLS, pclass))<0)
HGOTO_ERROR(H5E_PLIST, H5E_CANTREGISTER, FAIL, "unable to atomize property list class");
done:
if (ret_value<0 && pclass)
H5P_close_class(pclass);
FUNC_LEAVE (ret_value);
} /* H5Pget_class_name() */
/*--------------------------------------------------------------------------
NAME
H5P_get_nprops_plist
PURPOSE
Internal routine to query the number of properties in a property list
USAGE
herr_t H5P_get_nprops_plist(plist, nprops)
H5P_genplist_t *plist; IN: Property list to check
size_t *nprops; OUT: Number of properties in the property list
RETURNS
Success: non-negative value
Failure: negative value
DESCRIPTION
This routine retrieves the number of a properties in a property list.
GLOBAL VARIABLES
COMMENTS, BUGS, ASSUMPTIONS
EXAMPLES
REVISION LOG
--------------------------------------------------------------------------*/
static herr_t H5P_get_nprops_plist(H5P_genplist_t *plist, size_t *nprops)
{
herr_t ret_value=SUCCEED; /* return value */
FUNC_ENTER (H5P_get_nprops_plist, FAIL);
assert(plist);
assert(nprops);
/* Get property size */
*nprops=plist->nprops;
FUNC_LEAVE (ret_value);
} /* H5P_get_nprops_plist() */
/*--------------------------------------------------------------------------
NAME
H5P_get_nprops_pclass
PURPOSE
Internal routine to query the number of properties in a property class
USAGE
herr_t H5P_get_nprops_pclass(pclass, nprops)
H5P_genclass_t *pclass; IN: Property class to check
size_t *nprops; OUT: Number of properties in the property list
RETURNS
Success: non-negative value
Failure: negative value
DESCRIPTION
This routine retrieves the number of a properties in a property class.
GLOBAL VARIABLES
COMMENTS, BUGS, ASSUMPTIONS
EXAMPLES
REVISION LOG
--------------------------------------------------------------------------*/
static herr_t H5P_get_nprops_pclass(H5P_genclass_t *pclass, size_t *nprops)
{
herr_t ret_value=SUCCEED; /* return value */
FUNC_ENTER (H5P_get_nprops_pclass, FAIL);
assert(pclass);
assert(nprops);
/* Get property size */
*nprops=pclass->nprops;
FUNC_LEAVE (ret_value);
} /* H5P_get_nprops_pclass() */
/*--------------------------------------------------------------------------
NAME
H5Pget_nprops
PURPOSE
Routine to query the size of a property in a property list or class.
USAGE
herr_t H5Pget_nprops(id, nprops)
hid_t id; IN: ID of Property list or class to check
size_t *nprops; OUT: Number of properties in the property object
RETURNS
Success: non-negative value
Failure: negative value
DESCRIPTION
This routine retrieves the number of properties in a property list or
class. If a property class ID is given, the number of registered properties
in the class is returned in NPROPS. If a property list ID is given, the
current number of properties in the list is returned in NPROPS.
GLOBAL VARIABLES
COMMENTS, BUGS, ASSUMPTIONS
EXAMPLES
REVISION LOG
--------------------------------------------------------------------------*/
herr_t H5Pget_nprops(hid_t id, size_t *nprops)
{
H5P_genplist_t *plist; /* Property list to query */
H5P_genclass_t *pclass; /* Property class to query */
herr_t ret_value=FAIL; /* return value */
FUNC_ENTER (H5Pget_nprops, FAIL);
/* Check arguments. */
if (H5I_GENPROP_LST != H5I_get_type(id) && H5I_GENPROP_CLS != H5I_get_type(id))
HGOTO_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL, "not a property object");
if (nprops==NULL)
HGOTO_ERROR(H5E_ARGS, H5E_BADVALUE, FAIL, "invalid property nprops pointer");
if(H5I_GENPROP_LST == H5I_get_type(id)) {
if (NULL == (plist = H5I_object(id)))
HGOTO_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL, "not a property list");
if ((ret_value=H5P_get_nprops_plist(plist,nprops))<0)
HGOTO_ERROR(H5E_PLIST, H5E_CANTREGISTER, FAIL, "unable to query # of properties in plist");
} /* end if */
else
if(H5I_GENPROP_CLS == H5I_get_type(id)) {
if (NULL == (pclass = H5I_object(id)))
HGOTO_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL, "not a property class");
if ((ret_value=H5P_get_nprops_pclass(pclass,nprops))<0)
HGOTO_ERROR(H5E_PLIST, H5E_CANTREGISTER, FAIL, "unable to query # of properties in pclass");
} /* end if */
else
HGOTO_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL, "not a property object");
done:
FUNC_LEAVE (ret_value);
} /* H5Pget_nprops() */
/*--------------------------------------------------------------------------
NAME
H5P_cmp_prop
PURPOSE
Internal routine to compare two generic properties
USAGE
int H5P_cmp_prop(prop1, prop2)
H5P_genprop_t *prop1; IN: 1st property to compare
H5P_genprop_t *prop1; IN: 2nd property to compare
RETURNS
Success: negative if prop1 "less" than prop2, positive if prop1 "greater"
than prop2, zero if prop1 is "equal" to prop2
Failure: can't fail
DESCRIPTION
This function compares two generic properties together to see if
they are the same property.
GLOBAL VARIABLES
COMMENTS, BUGS, ASSUMPTIONS
EXAMPLES
REVISION LOG
--------------------------------------------------------------------------*/
static int H5P_cmp_prop(H5P_genprop_t *prop1, H5P_genprop_t *prop2)
{
int cmp_value; /* Value from comparison */
int ret_value=0; /* return value */
FUNC_ENTER (H5P_cmp_prop, FAIL);
assert(prop1);
assert(prop2);
/* Check the name */
if((cmp_value=HDstrcmp(prop1->name,prop2->name))!=0)
HGOTO_DONE(cmp_value);
/* Check the size of properties */
if(prop1->size < prop2->size) HGOTO_DONE(-1);
if(prop1->size > prop2->size) HGOTO_DONE(1);
/* Check if they both have values allocated (or not allocated) */
if(prop1->value==NULL && prop2->value!=NULL) HGOTO_DONE(-1);
if(prop1->value!=NULL && prop2->value==NULL) HGOTO_DONE(1);
if(prop1->value!=NULL)
if((cmp_value=HDmemcmp(prop1->value,prop2->value,prop1->size))!=0)
HGOTO_DONE(cmp_value);
/* Check if they both have default values allocated (or not allocated) */
if(prop1->def_value==NULL && prop2->def_value!=NULL) HGOTO_DONE(-1);
if(prop1->def_value!=NULL && prop2->def_value==NULL) HGOTO_DONE(1);
if(prop1->def_value!=NULL)
if((cmp_value=HDmemcmp(prop1->def_value,prop2->def_value,prop1->size))!=0)
HGOTO_DONE(cmp_value);
/* Check if they both have the same 'create' callback */
if(prop1->create==NULL && prop2->create!=NULL) HGOTO_DONE(-1);
if(prop1->create!=NULL && prop2->create==NULL) HGOTO_DONE(1);
if(prop1->create!=prop2->create) HGOTO_DONE(-1);
/* Check if they both have the same 'set' callback */
if(prop1->set==NULL && prop2->set!=NULL) HGOTO_DONE(-1);
if(prop1->set!=NULL && prop2->set==NULL) HGOTO_DONE(1);
if(prop1->set!=prop2->set) HGOTO_DONE(-1);
/* Check if they both have the same 'get' callback */
if(prop1->get==NULL && prop2->get!=NULL) HGOTO_DONE(-1);
if(prop1->get!=NULL && prop2->get==NULL) HGOTO_DONE(1);
if(prop1->get!=prop2->get) HGOTO_DONE(-1);
/* Check if they both have the same 'close' callback */
if(prop1->close==NULL && prop2->close!=NULL) HGOTO_DONE(-1);
if(prop1->close!=NULL && prop2->close==NULL) HGOTO_DONE(1);
if(prop1->close!=prop2->close) HGOTO_DONE(-1);
/* Don't check the 'next' field, they must be equal by now */
done:
FUNC_LEAVE (ret_value);
} /* H5P_cmp_prop() */
/*--------------------------------------------------------------------------
NAME
H5P_cmp_class
PURPOSE
Internal routine to compare two generic property classes
USAGE
int H5P_cmp_class(pclass1, pclass2)
H5P_genclass_t *pclass1; IN: 1st property class to compare
H5P_genclass_t *pclass2; IN: 2nd property class to compare
RETURNS
Success: negative if class1 "less" than class2, positive if class1 "greater"
than class2, zero if class1 is "equal" to class2
Failure: can't fail
DESCRIPTION
This function compares two generic property classes together to see if
they are the same class.
GLOBAL VARIABLES
COMMENTS, BUGS, ASSUMPTIONS
EXAMPLES
REVISION LOG
--------------------------------------------------------------------------*/
static int H5P_cmp_class(H5P_genclass_t *pclass1, H5P_genclass_t *pclass2)
{
H5P_genprop_t *tprop1, *tprop2;/* Temporary pointer to properties */
unsigned u; /* Local index variable */
int cmp_value; /* Value from comparison */
int ret_value=0; /* return value */
FUNC_ENTER (H5P_cmp_class, FAIL);
assert(pclass1);
assert(pclass2);
/* Check the name */
if((cmp_value=HDstrcmp(pclass1->name,pclass2->name))!=0)
HGOTO_DONE(cmp_value);
/* Check the number of properties */
if(pclass1->nprops < pclass2->nprops) HGOTO_DONE(-1);
if(pclass1->nprops > pclass2->nprops) HGOTO_DONE(1);
/* Check the hashsize */
if(pclass1->hashsize < pclass2->hashsize) HGOTO_DONE(-1);
if(pclass1->hashsize > pclass2->hashsize) HGOTO_DONE(1);
/* Check the number of property lists created from the class */
if(pclass1->plists < pclass2->plists) HGOTO_DONE(-1);
if(pclass1->plists > pclass2->plists) HGOTO_DONE(1);
/* Check the number of classes derived from the class */
if(pclass1->classes < pclass2->classes) HGOTO_DONE(-1);
if(pclass1->classes > pclass2->classes) HGOTO_DONE(1);
/* Check the number of ID references open on the class */
if(pclass1->ref_count < pclass2->ref_count) HGOTO_DONE(-1);
if(pclass1->ref_count > pclass2->ref_count) HGOTO_DONE(1);
/* Check whether they are internal or not */
if(pclass1->internal < pclass2->internal) HGOTO_DONE(-1);
if(pclass1->internal > pclass2->internal) HGOTO_DONE(1);
/* Check whether they are deleted or not */
if(pclass1->deleted < pclass2->deleted) HGOTO_DONE(-1);
if(pclass1->deleted > pclass2->deleted) HGOTO_DONE(1);
/* Check whether they have creation callback functions & data */
if(pclass1->create_func==NULL && pclass2->create_func!=NULL) HGOTO_DONE(-1);
if(pclass1->create_func!=NULL && pclass2->create_func==NULL) HGOTO_DONE(1);
if(pclass1->create_func!=pclass2->create_func) HGOTO_DONE(-1);
if(pclass1->create_data < pclass2->create_data) HGOTO_DONE(-1);
if(pclass1->create_data > pclass2->create_data) HGOTO_DONE(1);
/* Check whether they have close callback functions & data */
if(pclass1->close_func==NULL && pclass2->close_func!=NULL) HGOTO_DONE(-1);
if(pclass1->close_func!=NULL && pclass2->close_func==NULL) HGOTO_DONE(1);
if(pclass1->close_func!=pclass2->close_func) HGOTO_DONE(-1);
if(pclass1->close_data < pclass2->close_data) HGOTO_DONE(-1);
if(pclass1->close_data > pclass2->close_data) HGOTO_DONE(1);
/* Cycle through the properties and compare them also */
for(u=0; u<pclass1->hashsize; u++) {
tprop1=pclass1->props[u];
tprop2=pclass2->props[u];
/* Check if they both have properties in this hash location */
if(tprop1==NULL && tprop2!=NULL) HGOTO_DONE(-1);
if(tprop1!=NULL && tprop2==NULL) HGOTO_DONE(1);
/* Check the actual properties */
while(tprop1!=NULL && tprop2!=NULL) {
/* Compare the two properties */
if((cmp_value=H5P_cmp_prop(tprop1,tprop2))!=0)
HGOTO_DONE(cmp_value);
/* Advance the pointers */
tprop1=tprop1->next;
tprop2=tprop2->next;
/* Check if they both have properties in this location */
if(tprop1==NULL && tprop2!=NULL) HGOTO_DONE(-1);
if(tprop1!=NULL && tprop2==NULL) HGOTO_DONE(1);
} /* end while */
} /* end for */
done:
FUNC_LEAVE (ret_value);
} /* H5P_cmp_class() */
/*--------------------------------------------------------------------------
NAME
H5P_cmp_plist
PURPOSE
Internal routine to compare two generic property lists
USAGE
int H5P_cmp_plist(plist1, plist2)
H5P_genplist_t *plist1; IN: 1st property list to compare
H5P_genplist_t *plist2; IN: 2nd property list to compare
RETURNS
Success: negative if list1 "less" than list2, positive if list1 "greater"
than list2, zero if list1 is "equal" to list2
Failure: can't fail
DESCRIPTION
This function compares two generic property lists together to see if
they are the same list.
GLOBAL VARIABLES
COMMENTS, BUGS, ASSUMPTIONS
EXAMPLES
REVISION LOG
--------------------------------------------------------------------------*/
static int H5P_cmp_plist(H5P_genplist_t *plist1, H5P_genplist_t *plist2)
{
H5P_genprop_t *tprop1, *tprop2;/* Temporary pointer to properties */
unsigned u; /* Local index variable */
int cmp_value; /* Value from comparison */
int ret_value=0; /* return value */
FUNC_ENTER (H5P_cmp_plist, FAIL);
assert(plist1);
assert(plist2);
/* Check the parent class */
if(plist1->pclass < plist2->pclass) HGOTO_DONE(-1);
if(plist1->pclass > plist2->pclass) HGOTO_DONE(1);
/* Check the number of properties */
if(plist1->nprops < plist2->nprops) HGOTO_DONE(-1);
if(plist1->nprops > plist2->nprops) HGOTO_DONE(1);
/* Check whether they've been initialized */
if(plist1->class_init < plist2->class_init) HGOTO_DONE(-1);
if(plist1->class_init > plist2->class_init) HGOTO_DONE(1);
/* Cycle through the properties and compare them also */
for(u=0; u<plist1->pclass->hashsize; u++) {
tprop1=plist1->props[u];
tprop2=plist2->props[u];
/* Check if they both have properties in this hash location */
if(tprop1==NULL && tprop2!=NULL) HGOTO_DONE(-1);
if(tprop1!=NULL && tprop2==NULL) HGOTO_DONE(1);
/* Check the actual properties */
while(tprop1!=NULL && tprop2!=NULL) {
/* Compare the two properties */
if((cmp_value=H5P_cmp_prop(tprop1,tprop2))!=0)
HGOTO_DONE(cmp_value);
/* Advance the pointers */
tprop1=tprop1->next;
tprop2=tprop2->next;
/* Check if they both have properties in this location */
if(tprop1==NULL && tprop2!=NULL) HGOTO_DONE(-1);
if(tprop1!=NULL && tprop2==NULL) HGOTO_DONE(1);
} /* end while */
} /* end for */
done:
FUNC_LEAVE (ret_value);
} /* H5P_cmp_plist() */
/*--------------------------------------------------------------------------
NAME
H5Pequal
PURPOSE
Routine to query whether two property lists or two property classes are equal
USAGE
htri_t H5Pequal(id1, id2)
hid_t id1; IN: Property list or class ID to compare
hid_t id2; IN: Property list or class ID to compare
RETURNS
Success: TRUE if equal, FALSE if unequal
Failure: negative
DESCRIPTION
Determines whether two property lists or two property classes are equal.
GLOBAL VARIABLES
COMMENTS, BUGS, ASSUMPTIONS
EXAMPLES
REVISION LOG
--------------------------------------------------------------------------*/
htri_t H5Pequal(hid_t id1, hid_t id2)
{
void *obj1, *obj2; /* Property objects to compare */
htri_t ret_value=FALSE; /* return value */
FUNC_ENTER (H5Pequal, FAIL);
/* Check arguments. */
if ((H5I_GENPROP_LST != H5I_get_type(id1) && H5I_GENPROP_CLS != H5I_get_type(id1))
|| (H5I_GENPROP_CLS != H5I_get_type(id2) && H5I_GENPROP_CLS != H5I_get_type(id2)))
HGOTO_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL, "not property objects");
if (H5I_get_type(id1) != H5I_get_type(id2))
HGOTO_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL, "not the same kind of property objects");
if(NULL == (obj1 = H5I_object(id1)) || NULL == (obj2 = H5I_object(id2)))
HGOTO_ERROR(H5E_PLIST, H5E_NOTFOUND, FAIL, "property object doesn't exist");
/* Compare property lists */
if(H5I_GENPROP_LST == H5I_get_type(id1)) {
if(H5P_cmp_plist(obj1,obj2)==0)
ret_value=TRUE;
} /* end if */
/* Must be property classes */
else {
if(H5P_cmp_class(obj1,obj2)==0)
ret_value=TRUE;
} /* end else */
done:
FUNC_LEAVE (ret_value);
} /* H5Pequal() */
/*--------------------------------------------------------------------------
NAME
H5P_iterate_props
PURPOSE
Internal routine to iterate over a hashtable of properties
USAGE
herr_t H5P_iterate_props(id, hash, hashsize, idx, iter_func, iter_data)
hid_t id; IN: ID of property object iterating over
H5P_gen_prop_t *hash[]; IN: Pointer to array of properties for hash table
unsigned hashsize; IN: Size of hash table
int *idx; IN/OUT: Index of the property to begin with
H5P_iterate_t iter_func; IN: Function pointer to function to be
called with each property iterated over.
void *iter_data; IN/OUT: Pointer to iteration data from user
RETURNS
Success: Returns the return value of the last call to ITER_FUNC if it was
non-zero, or zero if all properties have been processed.
Failure: negative value
DESCRIPTION
This routine iterates over the properties in the property object specified
with ID. For each property in the object, the ITER_DATA and some
additional information, specified below, are passed to the ITER_FUNC function.
The iteration begins with the IDX property in the object and the next element
to be processed by the operator is returned in IDX. If IDX is NULL, then the
iterator starts at the first property; since no stopping point is returned in
this case, the iterator cannot be restarted if one of the calls to its operator
returns non-zero.
The prototype for H5P_iterate_t is:
typedef herr_t (*H5P_iterate_t)(hid_t id, const char *name, void *iter_data);
The operation receives the property list or class identifier for the object
being iterated over, ID, the name of the current property within the object,
NAME, and the pointer to the operator data passed in to H5Piterate, ITER_DATA.
The return values from an operator are:
Zero causes the iterator to continue, returning zero when all properties
have been processed.
Positive causes the iterator to immediately return that positive value,
indicating short-circuit success. The iterator can be restarted at the
index of the next property.
Negative causes the iterator to immediately return that value, indicating
failure. The iterator can be restarted at the index of the next
property.
H5Piterate assumes that the properties in the object identified by ID remains
unchanged through the iteration. If the membership changes during the
iteration, the function's behavior is undefined.
GLOBAL VARIABLES
COMMENTS, BUGS, ASSUMPTIONS
EXAMPLES
REVISION LOG
--------------------------------------------------------------------------*/
static int H5P_iterate_props(hid_t id, H5P_genprop_t *hash[], unsigned hashsize, int *idx, H5P_iterate_t iter_func, void *iter_data)
{
H5P_genprop_t *prop; /* Temporary property pointer */
unsigned u; /* Local index variable */
int curr_idx=0; /* Current iteration index */
int ret_value=0; /* Return value */
FUNC_ENTER (H5P_iterate_props, FAIL);
assert(hash);
assert(hashsize>0);
assert(idx);
assert(iter_func);
/* Cycle through the properties and compare them also */
for(u=0; u<hashsize && ret_value==0; u++) {
prop=hash[u];
/* Check the actual properties */
while(prop!=NULL && ret_value==0) {
/* Check if we are at the object to start iterating over */
if(curr_idx>=*idx)
ret_value=(*iter_func)(id,prop->name,iter_data);
/* Increment the iteration index if iteration function succeeded */
if(ret_value==0)
curr_idx++;
/* Advance the pointer */
prop=prop->next;
} /* end while */
} /* end for */
/* Set the index we stopped at */
*idx=curr_idx;
FUNC_LEAVE (ret_value);
} /* H5P_iterate_props() */
/*--------------------------------------------------------------------------
NAME
H5P_iterate_plist
PURPOSE
Internal routine to iterate over the properties in a property list
USAGE
herr_t H5P_iterate_plist(plist_id, idx, iter_func, iter_data)
hid_t plist_id; IN: ID of property list to iterate over
int *idx; IN/OUT: Index of the property to begin with
H5P_iterate_t iter_func; IN: Function pointer to function to be
called with each property iterated over.
void *iter_data; IN/OUT: Pointer to iteration data from user
RETURNS
Success: Returns the return value of the last call to ITER_FUNC if it was
non-zero, or zero if all properties have been processed.
Failure: negative value
DESCRIPTION
This routine iterates over the properties in the property object specified
with PLIST_ID. For each property in the object, the ITER_DATA and some
additional information, specified below, are passed to the ITER_FUNC function.
The iteration begins with the IDX property in the object and the next element
to be processed by the operator is returned in IDX. If IDX is NULL, then the
iterator starts at the first property; since no stopping point is returned in
this case, the iterator cannot be restarted if one of the calls to its operator
returns non-zero.
The prototype for H5P_iterate_t is:
typedef herr_t (*H5P_iterate_t)(hid_t id, const char *name, void *iter_data);
The operation receives the property list or class identifier for the object
being iterated over, ID, the name of the current property within the object,
NAME, and the pointer to the operator data passed in to H5Piterate, ITER_DATA.
The return values from an operator are:
Zero causes the iterator to continue, returning zero when all properties
have been processed.
Positive causes the iterator to immediately return that positive value,
indicating short-circuit success. The iterator can be restarted at the
index of the next property.
Negative causes the iterator to immediately return that value, indicating
failure. The iterator can be restarted at the index of the next
property.
H5Piterate assumes that the properties in the object identified by ID remains
unchanged through the iteration. If the membership changes during the
iteration, the function's behavior is undefined.
GLOBAL VARIABLES
COMMENTS, BUGS, ASSUMPTIONS
EXAMPLES
REVISION LOG
--------------------------------------------------------------------------*/
static int H5P_iterate_plist(hid_t plist_id, int *idx, H5P_iterate_t iter_func, void *iter_data)
{
H5P_genplist_t *plist; /* Property list pointer */
int ret_value=0; /* Return value */
FUNC_ENTER (H5P_iterate_plist, FAIL);
assert(idx);
assert(iter_func);
/* Get the property list object */
if (H5I_GENPROP_LST != H5I_get_type(plist_id) || NULL == (plist = H5I_object(plist_id)))
HGOTO_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL, "not a property list");
/* Iterate through the properties in the property list */
ret_value=H5P_iterate_props(plist_id, plist->props, plist->pclass->hashsize, idx, iter_func, iter_data);
done:
FUNC_LEAVE (ret_value);
} /* H5P_iterate_plist() */
/*--------------------------------------------------------------------------
NAME
H5P_iterate_pclass
PURPOSE
Internal routine to iterate over the properties in a property class
USAGE
herr_t H5P_iterate_pclass(pclass_id, idx, iter_func, iter_data)
hid_t pclass_id; IN: ID of property class to iterate over
int *idx; IN/OUT: Index of the property to begin with
H5P_iterate_t iter_func; IN: Function pointer to function to be
called with each property iterated over.
void *iter_data; IN/OUT: Pointer to iteration data from user
RETURNS
Success: Returns the return value of the last call to ITER_FUNC if it was
non-zero, or zero if all properties have been processed.
Failure: negative value
DESCRIPTION
This routine iterates over the properties in the property object specified
with PCLASS_ID. For each property in the object, the ITER_DATA and some
additional information, specified below, are passed to the ITER_FUNC function.
The iteration begins with the IDX property in the object and the next element
to be processed by the operator is returned in IDX. If IDX is NULL, then the
iterator starts at the first property; since no stopping point is returned in
this case, the iterator cannot be restarted if one of the calls to its operator
returns non-zero.
The prototype for H5P_iterate_t is:
typedef herr_t (*H5P_iterate_t)(hid_t id, const char *name, void *iter_data);
The operation receives the property list or class identifier for the object
being iterated over, ID, the name of the current property within the object,
NAME, and the pointer to the operator data passed in to H5Piterate, ITER_DATA.
The return values from an operator are:
Zero causes the iterator to continue, returning zero when all properties
have been processed.
Positive causes the iterator to immediately return that positive value,
indicating short-circuit success. The iterator can be restarted at the
index of the next property.
Negative causes the iterator to immediately return that value, indicating
failure. The iterator can be restarted at the index of the next
property.
H5Piterate assumes that the properties in the object identified by ID remains
unchanged through the iteration. If the membership changes during the
iteration, the function's behavior is undefined.
GLOBAL VARIABLES
COMMENTS, BUGS, ASSUMPTIONS
EXAMPLES
REVISION LOG
--------------------------------------------------------------------------*/
static int H5P_iterate_pclass(hid_t pclass_id, int *idx, H5P_iterate_t iter_func, void *iter_data)
{
H5P_genclass_t *pclass; /* Property list pointer */
int ret_value=0; /* Return value */
FUNC_ENTER (H5P_iterate_pclass, FAIL);
assert(idx);
assert(iter_func);
/* Get the property list object */
if (H5I_GENPROP_CLS != H5I_get_type(pclass_id) || NULL == (pclass = H5I_object(pclass_id)))
HGOTO_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL, "not a property class");
/* Iterate through the properties in the property list */
ret_value=H5P_iterate_props(pclass_id, pclass->props, pclass->hashsize, idx, iter_func, iter_data);
done:
FUNC_LEAVE (ret_value);
} /* H5P_iterate_pclass() */
/*--------------------------------------------------------------------------
NAME
H5Piterate
PURPOSE
Routine to iterate over the properties in a property list or class
USAGE
int H5Piterate(pclass_id, idx, iter_func, iter_data)
hid_t id; IN: ID of property object to iterate over
int *idx; IN/OUT: Index of the property to begin with
H5P_iterate_t iter_func; IN: Function pointer to function to be
called with each property iterated over.
void *iter_data; IN/OUT: Pointer to iteration data from user
RETURNS
Success: Returns the return value of the last call to ITER_FUNC if it was
non-zero, or zero if all properties have been processed.
Failure: negative value
DESCRIPTION
This routine iterates over the properties in the property object specified
with ID. The properties in both property lists and classes may be iterated
over with this function. For each property in the object, the ITER_DATA and
some additional information, specified below, are passed to the ITER_FUNC
function. The iteration begins with the IDX property in the object and the
next element to be processed by the operator is returned in IDX. If IDX is
NULL, then the iterator starts at the first property; since no stopping point
is returned in this case, the iterator cannot be restarted if one of the calls
to its operator returns non-zero.
The prototype for H5P_iterate_t is:
typedef herr_t (*H5P_iterate_t)(hid_t id, const char *name, void *iter_data);
The operation receives the property list or class identifier for the object
being iterated over, ID, the name of the current property within the object,
NAME, and the pointer to the operator data passed in to H5Piterate, ITER_DATA.
The return values from an operator are:
Zero causes the iterator to continue, returning zero when all properties
have been processed.
Positive causes the iterator to immediately return that positive value,
indicating short-circuit success. The iterator can be restarted at the
index of the next property.
Negative causes the iterator to immediately return that value, indicating
failure. The iterator can be restarted at the index of the next
property.
H5Piterate assumes that the properties in the object identified by ID remains
unchanged through the iteration. If the membership changes during the
iteration, the function's behavior is undefined.
GLOBAL VARIABLES
COMMENTS, BUGS, ASSUMPTIONS
EXAMPLES
REVISION LOG
--------------------------------------------------------------------------*/
int H5Piterate(hid_t id, int *idx, H5P_iterate_t iter_func, void *iter_data)
{
int fake_idx=0; /* Index when user doesn't provide one */
int ret_value=FAIL; /* return value */
FUNC_ENTER (H5Piterate, FAIL);
/* Check arguments. */
if (H5I_GENPROP_LST != H5I_get_type(id) && H5I_GENPROP_CLS != H5I_get_type(id))
HGOTO_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL, "not a property object");
if (iter_func==NULL)
HGOTO_ERROR(H5E_ARGS, H5E_BADVALUE, FAIL, "invalid iteration callback");
if (H5I_GENPROP_LST == H5I_get_type(id)) {
/* Iterate over a property list */
if ((ret_value=H5P_iterate_plist(id,(idx ? idx : &fake_idx),iter_func,iter_data))<0)
HGOTO_ERROR(H5E_PLIST, H5E_CANTREGISTER, FAIL, "unable to iterate over list");
} /* end if */
else
if (H5I_GENPROP_CLS == H5I_get_type(id)) {
/* Iterate over a property class */
if ((ret_value=H5P_iterate_pclass(id,(idx ? idx : &fake_idx),iter_func,iter_data))<0)
HGOTO_ERROR(H5E_PLIST, H5E_CANTREGISTER, FAIL, "unable to iterate over class");
} /* end if */
else
HGOTO_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL, "not a property object");
done:
FUNC_LEAVE (ret_value);
} /* H5Piterate() */
/*--------------------------------------------------------------------------
NAME
H5P_get
PURPOSE
Internal routine to query the value of a property in a property list.
USAGE
herr_t H5P_get(plist, name, value)
H5P_genplist_t *plist; IN: Property list to check
const char *name; IN: Name of property to query
void *value; OUT: Pointer to the buffer for the property value
RETURNS
Returns non-negative on success, negative on failure.
DESCRIPTION
Retrieves a copy of the value for a property in a property list. The
property name must exist or this routine will fail. If there is a
'get' callback routine registered for this property, the copy of the
value of the property will first be passed to that routine and any changes
to the copy of the value will be used when returning the property value
from this routine.
If the 'get' callback routine returns an error, 'value' will not be
modified and this routine will return an error. This routine may not be
called for zero-sized properties.
GLOBAL VARIABLES
COMMENTS, BUGS, ASSUMPTIONS
EXAMPLES
REVISION LOG
--------------------------------------------------------------------------*/
static herr_t H5P_get(hid_t plist_id, const char *name, void *value)
{
H5P_genplist_t *plist; /* Property list pointer */
H5P_genprop_t *prop; /* Temporary property pointer */
herr_t ret_value=FAIL; /* return value */
FUNC_ENTER (H5P_get, FAIL);
assert(name);
assert(value);
/* Check arguments. */
if (H5I_GENPROP_LST != H5I_get_type(plist_id) || NULL == (plist = H5I_object(plist_id)))
HGOTO_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL, "not a property list");
/* Find property */
if((prop=H5P_find_prop(plist->props,plist->pclass->hashsize,name))==NULL)
HGOTO_ERROR(H5E_PLIST, H5E_NOTFOUND, FAIL, "property doesn't exist");
/* Check for property size >0 */
if(prop->size==0)
HGOTO_ERROR(H5E_PLIST, H5E_BADVALUE, FAIL, "property has zero size");
/* Make a copy of the value and pass to 'get' callback */
if(prop->get!=NULL) {
void *tmp_value; /* Temporary value for property */
/* Make a copy of the current value, in case the callback fails */
if (NULL==(tmp_value=H5MM_malloc(prop->size)))
HRETURN_ERROR(H5E_RESOURCE, H5E_NOSPACE, FAIL, "memory allocation failed temporary property value");
HDmemcpy(tmp_value,prop->value,prop->size);
/* Call user's callback */
if((*(prop->get))(plist_id,name,tmp_value)<0)
HRETURN_ERROR(H5E_PLIST, H5E_CANTINIT, FAIL, "can't get property value");
/* Copy new [possibly unchanged] value into return value */
HDmemcpy(value,tmp_value,prop->size);
/* Free the temporary value buffer */
H5MM_xfree(tmp_value);
} /* end if */
/* No 'get' callback, just copy value */
else
HDmemcpy(value,prop->value,prop->size);
/* Set return value */
ret_value=SUCCEED;
done:
FUNC_LEAVE (ret_value);
} /* H5P_get() */
/*--------------------------------------------------------------------------
NAME
H5Pget
PURPOSE
Routine to query the value of a property in a property list.
USAGE
herr_t H5Pget(plist_id, name, value)
hid_t plist_id; IN: Property list to check
const char *name; IN: Name of property to query
void *value; OUT: Pointer to the buffer for the property value
RETURNS
Returns non-negative on success, negative on failure.
DESCRIPTION
Retrieves a copy of the value for a property in a property list. The
property name must exist or this routine will fail. If there is a
'get' callback routine registered for this property, the copy of the
value of the property will first be passed to that routine and any changes
to the copy of the value will be used when returning the property value
from this routine.
If the 'get' callback routine returns an error, 'value' will not be
modified and this routine will return an error. This routine may not be
called for zero-sized properties.
GLOBAL VARIABLES
COMMENTS, BUGS, ASSUMPTIONS
EXAMPLES
REVISION LOG
--------------------------------------------------------------------------*/
herr_t H5Pget(hid_t plist_id, const char *name, void * value)
{
herr_t ret_value=FAIL; /* return value */
FUNC_ENTER (H5Pget, FAIL);
/* Check arguments. */
if (H5I_GENPROP_LST != H5I_get_type(plist_id))
HGOTO_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL, "not a property list");
if (!name || !*name)
HGOTO_ERROR(H5E_ARGS, H5E_BADVALUE, FAIL, "invalid property name");
if (value==NULL)
HGOTO_ERROR(H5E_ARGS, H5E_BADVALUE, FAIL, "invalied property value");
/* Create the new property list class */
if ((ret_value=H5P_get(plist_id,name,value))<0)
HGOTO_ERROR(H5E_PLIST, H5E_CANTREGISTER, FAIL, "unable to query property value");
done:
FUNC_LEAVE (ret_value);
} /* H5Pget() */
/*--------------------------------------------------------------------------
NAME
H5P_remove
PURPOSE
Internal routine to remove a property from a property list.
USAGE
herr_t H5P_remove(plist, name)
H5P_genplist_t *plist; IN: Property list to modify
const char *name; IN: Name of property to remove
RETURNS
Returns non-negative on success, negative on failure.
DESCRIPTION
Removes a property from a property list. Both properties which were
in existance when the property list was created (i.e. properties registered
with H5Pregister) and properties added to the list after it was created
(i.e. added with H5Pinsert) may be removed from a property list.
Properties do not need to be removed a property list before the list itself
is closed, they will be released automatically when H5Pclose is called.
The 'close' callback for this property is called before the property is
release, if the callback exists.
GLOBAL VARIABLES
COMMENTS, BUGS, ASSUMPTIONS
EXAMPLES
REVISION LOG
--------------------------------------------------------------------------*/
static herr_t H5P_remove(H5P_genplist_t *plist, const char *name)
{
H5P_genprop_t *prop; /* Temporary property pointer */
H5P_genprop_t *tprop, *prev;/* Temporary pointer to properties */
unsigned loc; /* Hash table location */
herr_t ret_value=FAIL; /* return value */
FUNC_ENTER (H5P_remove, FAIL);
assert(plist);
assert(name);
/* Find the property in the property list */
if((prop=H5P_find_prop(plist->props,plist->pclass->hashsize,name))==NULL)
HGOTO_ERROR(H5E_PLIST, H5E_NOTFOUND, FAIL, "property doesn't exist");
/* Pass value to 'close' callback, if it exists */
if(prop->close!=NULL) {
/* Call user's callback */
if((*(prop->close))(name,prop->value)<0)
HRETURN_ERROR(H5E_PLIST, H5E_CANTINIT, FAIL, "can't close property value");
} /* end if */
/* Get correct hash table location */
loc=H5P_hash_name(name,plist->pclass->hashsize);
/* Remove property from property list */
/* Check if the property being removed is at the head of the list for a hash location */
if(prop==plist->props[loc])
plist->props[loc]=prop->next;
else {
/* Set up initial pointers */
prev=tprop=plist->props[loc];
tprop=tprop->next;
while(tprop!=NULL) {
if(tprop==prop) {
/* Jump over the property we are deleting */
prev->next=prop->next;
/* Free the property, ignoring return value, nothing we can do */
H5P_free_prop(prop);
/* Break out of while loop */
break;
} /* end if */
/* Move to the next nodes */
prev=tprop;
tprop=tprop->next;
} /* end while */
} /* end else */
/* Decrement the number of properties in list */
plist->nprops--;
/* Set return value */
ret_value=SUCCEED;
done:
FUNC_LEAVE (ret_value);
} /* H5P_remove() */
/*--------------------------------------------------------------------------
NAME
H5Premove
PURPOSE
Routine to remove a property from a property list.
USAGE
herr_t H5Premove(plist_id, name)
hid_t plist_id; IN: Property list to modify
const char *name; IN: Name of property to remove
RETURNS
Returns non-negative on success, negative on failure.
DESCRIPTION
Removes a property from a property list. Both properties which were
in existance when the property list was created (i.e. properties registered
with H5Pregister) and properties added to the list after it was created
(i.e. added with H5Pinsert) may be removed from a property list.
Properties do not need to be removed a property list before the list itself
is closed, they will be released automatically when H5Pclose is called.
The 'close' callback for this property is called before the property is
release, if the callback exists.
GLOBAL VARIABLES
COMMENTS, BUGS, ASSUMPTIONS
EXAMPLES
REVISION LOG
--------------------------------------------------------------------------*/
herr_t H5Premove(hid_t plist_id, const char *name)
{
H5P_genplist_t *plist; /* Property list to modify */
herr_t ret_value=FAIL; /* return value */
FUNC_ENTER (H5Premove, FAIL);
/* Check arguments. */
if (H5I_GENPROP_LST != H5I_get_type(plist_id) || NULL == (plist = H5I_object(plist_id)))
HGOTO_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL, "not a property list");
if (!name || !*name)
HGOTO_ERROR(H5E_ARGS, H5E_BADVALUE, FAIL, "invalid property name");
/* Create the new property list class */
if ((ret_value=H5P_remove(plist,name))<0)
HGOTO_ERROR(H5E_PLIST, H5E_CANTREGISTER, FAIL, "unable to remove property");
done:
FUNC_LEAVE (ret_value);
} /* H5Premove() */
/*--------------------------------------------------------------------------
NAME
H5P_unregister
PURPOSE
Internal routine to remove a property from a property list class.
USAGE
herr_t H5P_unregister(pclass, name)
H5P_genclass_t *pclass; IN: Property list class to modify
const char *name; IN: Name of property to remove
RETURNS
Returns non-negative on success, negative on failure.
DESCRIPTION
Removes a property from a property list class. Future property lists
created of that class will not contain this property. Existing property
lists containing this property are not affected.
GLOBAL VARIABLES
COMMENTS, BUGS, ASSUMPTIONS
EXAMPLES
REVISION LOG
--------------------------------------------------------------------------*/
static herr_t H5P_unregister(H5P_genclass_t *pclass, const char *name)
{
H5P_genprop_t *prop; /* Temporary property pointer */
H5P_genprop_t *tprop, *prev;/* Temporary pointer to properties */
unsigned loc; /* Hash table location */
herr_t ret_value=FAIL; /* return value */
FUNC_ENTER (H5P_unregister, FAIL);
assert(pclass);
assert(name);
/* Find the property in the property list */
if((prop=H5P_find_prop(pclass->props,pclass->hashsize,name))==NULL)
HGOTO_ERROR(H5E_PLIST, H5E_NOTFOUND, FAIL, "property doesn't exist");
/* Get correct hash table location */
loc=H5P_hash_name(name,pclass->hashsize);
/* Remove property from property list */
/* Check if the property being removed is at the head of the list for a hash location */
if(prop==pclass->props[loc]) {
pclass->props[loc]=prop->next;
/* Free the property, ignoring return value, nothing we can do */
H5P_free_prop(prop);
} /* end if */
else {
/* Set up initial pointers */
prev=tprop=pclass->props[loc];
tprop=tprop->next;
while(tprop!=NULL) {
if(tprop==prop) {
/* Jump over the property we are deleting */
prev->next=prop->next;
/* Free the property, ignoring return value, nothing we can do */
H5P_free_prop(prop);
/* Break out of while loop */
break;
} /* end if */
/* Move to the next nodes */
prev=tprop;
tprop=tprop->next;
} /* end while */
} /* end else */
/* Decrement the number of registered properties in class */
pclass->nprops--;
/* Set return value */
ret_value=SUCCEED;
done:
FUNC_LEAVE (ret_value);
} /* H5P_unregister() */
/*--------------------------------------------------------------------------
NAME
H5Punregister
PURPOSE
Routine to remove a property from a property list class.
USAGE
herr_t H5Punregister(pclass_id, name)
hid_t pclass_id; IN: Property list class to modify
const char *name; IN: Name of property to remove
RETURNS
Returns non-negative on success, negative on failure.
DESCRIPTION
Removes a property from a property list class. Future property lists
created of that class will not contain this property. Existing property
lists containing this property are not affected.
GLOBAL VARIABLES
COMMENTS, BUGS, ASSUMPTIONS
EXAMPLES
REVISION LOG
--------------------------------------------------------------------------*/
herr_t H5Punregister(hid_t pclass_id, const char *name)
{
H5P_genclass_t *pclass; /* Property list class to modify */
herr_t ret_value=FAIL; /* return value */
FUNC_ENTER (H5Punregister, FAIL);
/* Check arguments. */
if (H5I_GENPROP_CLS != H5I_get_type(pclass_id) || NULL == (pclass = H5I_object(pclass_id)))
HGOTO_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL, "not a property list class");
if (!name || !*name)
HGOTO_ERROR(H5E_ARGS, H5E_BADVALUE, FAIL, "invalid property name");
/* Remove the property list from class */
if ((ret_value=H5P_unregister(pclass,name))<0)
HGOTO_ERROR(H5E_PLIST, H5E_CANTREGISTER, FAIL, "unable to remove property from class");
done:
FUNC_LEAVE (ret_value);
} /* H5Punregister() */
/*--------------------------------------------------------------------------
NAME
H5P_close_list
PURPOSE
Internal routine to close a property list.
USAGE
herr_t H5P_close_list(plist)
H5P_genplist_t *plist; IN: Property list to close
RETURNS
Returns non-negative on success, negative on failure.
DESCRIPTION
Closes a property list. If a 'close' callback exists for the property
list class, it is called before the property list is destroyed. If 'close'
callbacks exist for any individual properties in the property list, they are
called after the class 'close' callback.
GLOBAL VARIABLES
COMMENTS, BUGS, ASSUMPTIONS
The property list class 'close' callback routine is not called from
here, it must have been check for and called properly prior to this routine
being called
EXAMPLES
REVISION LOG
--------------------------------------------------------------------------*/
static herr_t H5P_close_list(void *_plist)
{
H5P_genplist_t *plist=(H5P_genplist_t *)_plist;
herr_t ret_value=FAIL; /* return value */
FUNC_ENTER (H5P_close_list, FAIL);
assert(plist);
/* Make calls to any property close callbacks which exist */
H5P_free_all_prop(plist->props,plist->pclass->hashsize,1);
/* Decrement class's dependant property list value! */
if(H5P_access_class(plist->pclass,H5P_MOD_DEC_LST)<0)
HGOTO_ERROR (H5E_PLIST, H5E_CANTINIT, FAIL, "Can't decrement class ref count");
/* Destroy property list object */
H5MM_xfree(plist);
ret_value=SUCCEED; /* return value */
done:
FUNC_LEAVE (ret_value);
} /* H5P_close_list() */
/*--------------------------------------------------------------------------
NAME
H5Pclose_list
PURPOSE
Routine to close a property list.
USAGE
herr_t H5Pclose_list(plist_id)
hid_t plist_id; IN: Property list to close
RETURNS
Returns non-negative on success, negative on failure.
DESCRIPTION
Closes a property list. If a 'close' callback exists for the property
list class, it is called before the property list is destroyed. If 'close'
callbacks exist for any individual properties in the property list, they are
called after the class 'close' callback.
GLOBAL VARIABLES
COMMENTS, BUGS, ASSUMPTIONS
EXAMPLES
REVISION LOG
--------------------------------------------------------------------------*/
herr_t H5Pclose_list(hid_t plist_id)
{
H5P_genplist_t *plist; /* Property list created */
herr_t ret_value=FAIL; /* return value */
FUNC_ENTER (H5Pclose_list, FAIL);
/* Check arguments. */
if (H5I_GENPROP_LST != H5I_get_type(plist_id) || NULL == (plist = H5I_remove(plist_id)))
HGOTO_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL, "not a property list");
/* Make call to property list class close callback, if needed */
if(plist->class_init!=0 && plist->pclass->close_func!=NULL) {
/* Call user's "close" callback function, ignoring return value */
(plist->pclass->close_func)(plist_id,plist->pclass->close_data);
} /* end if */
/* Close the property list */
if ((ret_value=H5P_close_list(plist)) < 0)
HGOTO_ERROR(H5E_PLIST, H5E_CANTFREE, FAIL, "can't close");
done:
FUNC_LEAVE (ret_value);
} /* H5Pclose_list() */
/*--------------------------------------------------------------------------
NAME
H5P_get_class_name
PURPOSE
Internal routine to query the name of a generic property list class
USAGE
char *H5P_get_class_name(pclass)
H5P_genpclass_t *pclass; IN: Property list to check
RETURNS
Success: Pointer to a malloc'ed string containing the class name
Failure: NULL
DESCRIPTION
This routine retrieves the name of a generic property list class.
The pointer to the name must be free'd by the user for successful calls.
GLOBAL VARIABLES
COMMENTS, BUGS, ASSUMPTIONS
EXAMPLES
REVISION LOG
--------------------------------------------------------------------------*/
static char *H5P_get_class_name(H5P_genclass_t *pclass)
{
char *ret_value=NULL; /* return value */
FUNC_ENTER (H5P_get_class_name, NULL);
assert(pclass);
/* Get property size */
ret_value=HDstrdup(pclass->name);
FUNC_LEAVE (ret_value);
} /* H5P_get_class_name() */
/*--------------------------------------------------------------------------
NAME
H5Pget_class_name
PURPOSE
Internal routine to query the name of a generic property list class
USAGE
char *H5Pget_class_name(pclass_id)
hid_t pclass_id; IN: Property class to query
RETURNS
Success: Pointer to a malloc'ed string containing the class name
Failure: NULL
DESCRIPTION
This routine retrieves the name of a generic property list class.
The pointer to the name must be free'd by the user for successful calls.
GLOBAL VARIABLES
COMMENTS, BUGS, ASSUMPTIONS
EXAMPLES
REVISION LOG
--------------------------------------------------------------------------*/
char *H5Pget_class_name(hid_t pclass_id)
{
H5P_genclass_t *pclass; /* Property class to query */
char *ret_value=NULL; /* return value */
FUNC_ENTER (H5Pget_class_name, NULL);
/* Check arguments. */
if (H5I_GENPROP_CLS != H5I_get_type(pclass_id) || NULL == (pclass = H5I_object(pclass_id)))
HGOTO_ERROR(H5E_ARGS, H5E_BADTYPE, NULL, "not a property class");
/* Create the new property list class */
if ((ret_value=H5P_get_class_name(pclass))==NULL)
HGOTO_ERROR(H5E_PLIST, H5E_NOTFOUND, NULL, "unable to query name of class");
done:
FUNC_LEAVE (ret_value);
} /* H5Pget_class_name() */
/*--------------------------------------------------------------------------
NAME
H5P_get_class_parent
PURPOSE
Internal routine to query the parent class of a generic property class
USAGE
H5P_genclass_t *H5P_get_class_parent(pclass)
H5P_genpclass_t *pclass; IN: Property class to check
RETURNS
Success: Pointer to the parent class of a property class
Failure: NULL
DESCRIPTION
This routine retrieves a pointer to the parent class for a property class.
GLOBAL VARIABLES
COMMENTS, BUGS, ASSUMPTIONS
EXAMPLES
REVISION LOG
--------------------------------------------------------------------------*/
static H5P_genclass_t *H5P_get_class_parent(H5P_genclass_t *pclass)
{
H5P_genclass_t *ret_value=NULL; /* return value */
FUNC_ENTER (H5P_get_class_parent, NULL);
assert(pclass);
/* Get property size */
ret_value=pclass->parent;
FUNC_LEAVE (ret_value);
} /* H5P_get_class_parent() */
/*--------------------------------------------------------------------------
NAME
H5Pget_class_parent
PURPOSE
routine to query the parent class of a generic property class
USAGE
hid_t H5Pget_class_parent(pclass_id)
hid_t pclass_id; IN: Property class to query
RETURNS
Success: ID of parent class object
Failure: NULL
DESCRIPTION
This routine retrieves an ID for the parent class of a property class.
GLOBAL VARIABLES
COMMENTS, BUGS, ASSUMPTIONS
EXAMPLES
REVISION LOG
--------------------------------------------------------------------------*/
hid_t H5Pget_class_parent(hid_t pclass_id)
{
H5P_genclass_t *pclass; /* Property class to query */
H5P_genclass_t *parent=NULL; /* Parent's property class */
hid_t ret_value=FAIL; /* return value */
FUNC_ENTER (H5Pget_class_parent, FAIL);
/* Check arguments. */
if (H5I_GENPROP_CLS != H5I_get_type(pclass_id) || NULL == (pclass = H5I_object(pclass_id)))
HGOTO_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL, "not a property class");
/* Retrieve the property class's parent */
if ((parent=H5P_get_class_parent(pclass))==NULL)
HGOTO_ERROR(H5E_PLIST, H5E_NOTFOUND, FAIL, "unable to query class of property list");
/* Increment the outstanding references to the class object */
if(H5P_access_class(parent,H5P_MOD_INC_REF)<0)
HGOTO_ERROR (H5E_PLIST, H5E_CANTINIT, FAIL,"Can't increment class ID ref count");
/* Get an atom for the class */
if ((ret_value = H5I_register(H5I_GENPROP_CLS, parent))<0)
HGOTO_ERROR(H5E_PLIST, H5E_CANTREGISTER, FAIL, "unable to atomize property list class");
done:
if (ret_value<0 && parent)
H5P_close_class(parent);
FUNC_LEAVE (ret_value);
} /* H5Pget_class_parent() */
/*--------------------------------------------------------------------------
NAME
H5P_close_class
PURPOSE
Internal routine to close a property list class.
USAGE
herr_t H5P_close_class(class)
H5P_genclass_t *class; IN: Property list class to close
RETURNS
Returns non-negative on success, negative on failure.
DESCRIPTION
Releases memory and de-attach a class from the property list class hierarchy.
GLOBAL VARIABLES
COMMENTS, BUGS, ASSUMPTIONS
EXAMPLES
REVISION LOG
--------------------------------------------------------------------------*/
static herr_t H5P_close_class(void *_pclass)
{
H5P_genclass_t *pclass=(H5P_genclass_t *)_pclass;
herr_t ret_value = FAIL; /* return value */
FUNC_ENTER (H5P_close_class, FAIL);
assert(pclass);
/* Decrement the reference count & check if the object should go away */
if(H5P_access_class(pclass,H5P_MOD_DEC_REF)<0)
HGOTO_ERROR (H5E_PLIST, H5E_NOTFOUND, FAIL, "Can't decrement ID ref count");
/* Check if the object should go away */
if(pclass->ref_count==0) {
/* Decrement parent class's dependant property class value! */
if(pclass->parent)
if (H5P_access_class(pclass->parent, H5P_MOD_DEC_CLS) < 0)
HGOTO_ERROR (H5E_PLIST, H5E_NOTFOUND, FAIL,"Can't decrement class ref count");
/* Mark class as deleted */
pclass->deleted = 1;
/* Check dependancies on this class, deleting it if allowed */
if (H5P_access_class(pclass, H5P_MOD_CHECK) < 0)
HGOTO_ERROR (H5E_PLIST, H5E_NOTFOUND, FAIL,"Can't check class ref count");
} /* end if */
/* Set return value */
ret_value = SUCCEED;
done:
FUNC_LEAVE (ret_value);
} /* H5P_close_class() */
/*--------------------------------------------------------------------------
NAME
H5Pclose_class
PURPOSE
Close a property list class.
USAGE
herr_t H5Pclose_class(cls_id)
hid_t cls_id; IN: Property list class ID to class
RETURNS
Returns non-negative on success, negative on failure.
DESCRIPTION
Releases memory and de-attach a class from the property list class hierarchy.
GLOBAL VARIABLES
COMMENTS, BUGS, ASSUMPTIONS
EXAMPLES
REVISION LOG
--------------------------------------------------------------------------*/
herr_t
H5Pclose_class(hid_t cls_id)
{
H5P_genclass_t *pclass; /* Property list class created */
hid_t ret_value = SUCCEED; /* Return value */
FUNC_ENTER(H5Pclose_class, FAIL);
H5TRACE1("e","i",cls_id);
/* Check arguments */
if (H5I_GENPROP_CLS != H5I_get_type(cls_id) || NULL == (pclass = H5I_remove(cls_id)))
HGOTO_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL, "not a property list class");
/* Delete the property list class */
if (H5P_close_class(pclass) < 0)
HGOTO_ERROR(H5E_PLIST, H5E_CANTFREE, FAIL, "can't close");
done:
FUNC_LEAVE(ret_value);
} /* H5Pclose_class() */
|