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
|
/*
* Copyright (C) 1998-2001 NCSA
* All rights reserved.
*
* Programmer: Quincey Koziol <koziol@ncsa.uiuc.ued>
* Friday, May 29, 1998
*
* Purpose: Dataspace functions.
*/
#define H5S_PACKAGE /*suppress error about including H5Spkg */
#include "H5private.h" /* Generic Functions */
#include "H5Dprivate.h" /* Datasets (for their properties) */
#include "H5Eprivate.h" /* Error handling */
#include "H5FLprivate.h" /* Free Lists */
#include "H5Iprivate.h" /* ID Functions */
#include "H5Spkg.h" /* Dataspace functions */
#include "H5Vprivate.h" /* Vector functions */
/* Interface initialization */
#define PABLO_MASK H5Sselect_mask
#define INTERFACE_INIT NULL
static int interface_initialize_g = 0;
static hssize_t H5S_get_select_hyper_nblocks(H5S_t *space);
static hssize_t H5S_get_select_elem_npoints(H5S_t *space);
static herr_t H5S_get_select_hyper_blocklist(H5S_t *space, hsize_t startblock, hsize_t numblocks, hsize_t *buf);
static herr_t H5S_get_select_elem_pointlist(H5S_t *space, hsize_t startpoint, hsize_t numpoints, hsize_t *buf);
static herr_t H5S_get_select_bounds(H5S_t *space, hsize_t *start, hsize_t *end);
/* Declare external the free list for hssize_t arrays */
H5FL_ARR_EXTERN(hssize_t);
/* Declare a free list to manage arrays of size_t */
H5FL_ARR_DEFINE_STATIC(size_t,-1);
/* Declare a free list to manage arrays of hsize_t */
H5FL_ARR_DEFINE_STATIC(hsize_t,-1);
/* Declare a free list to manage the H5S_sel_iter_t struct */
H5FL_DEFINE_STATIC(H5S_sel_iter_t);
/* Declare a free list to manage blocks of single datatype element data */
H5FL_BLK_EXTERN(type_elem);
/*--------------------------------------------------------------------------
NAME
H5S_select_copy
PURPOSE
Copy a selection from one dataspace to another
USAGE
herr_t H5S_select_copy(dst, src)
H5S_t *dst; OUT: Pointer to the destination dataspace
H5S_t *src; IN: Pointer to the source dataspace
RETURNS
Non-negative on success/Negative on failure
DESCRIPTION
Copies all the selection information (include offset) from the source
dataspace to the destination dataspace.
GLOBAL VARIABLES
COMMENTS, BUGS, ASSUMPTIONS
EXAMPLES
REVISION LOG
--------------------------------------------------------------------------*/
herr_t
H5S_select_copy (H5S_t *dst, const H5S_t *src)
{
herr_t ret_value=SUCCEED; /* return value */
FUNC_ENTER_NOAPI(H5S_select_copy, FAIL);
/* Check args */
assert(dst);
assert(src);
/* Copy regular fields */
dst->select=src->select;
/* Need to copy order information still */
/* Copy offset information */
if (NULL==(dst->select.offset = H5FL_ARR_ALLOC(hssize_t,src->extent.u.simple.rank,1))) {
HRETURN_ERROR (H5E_RESOURCE, H5E_NOSPACE, FAIL,
"memory allocation failed");
}
if(src->select.offset!=NULL)
HDmemcpy(dst->select.offset,src->select.offset,(src->extent.u.simple.rank*sizeof(hssize_t)));
/* Perform correct type of copy based on the type of selection */
switch (src->extent.type) {
case H5S_SCALAR:
/*nothing needed */
break;
case H5S_SIMPLE:
/* Deep copy extra stuff */
switch(src->select.type) {
case H5S_SEL_NONE:
case H5S_SEL_ALL:
/*nothing needed */
break;
case H5S_SEL_POINTS:
ret_value=H5S_point_copy(dst,src);
break;
case H5S_SEL_HYPERSLABS:
ret_value=H5S_hyper_copy(dst,src);
break;
default:
assert("unknown selection type" && 0);
break;
} /* end switch */
break;
case H5S_COMPLEX:
/*void */
break;
default:
assert("unknown data space type" && 0);
break;
}
FUNC_LEAVE (ret_value);
} /* H5S_select_copy() */
/*--------------------------------------------------------------------------
NAME
H5S_select_release
PURPOSE
Release selection information for a dataspace
USAGE
herr_t H5S_select_release(space)
H5S_t *space; IN: Pointer to dataspace
RETURNS
Non-negative on success/Negative on failure
DESCRIPTION
Releases all selection information for a dataspace
GLOBAL VARIABLES
COMMENTS, BUGS, ASSUMPTIONS
EXAMPLES
REVISION LOG
--------------------------------------------------------------------------*/
herr_t
H5S_select_release (H5S_t *space)
{
herr_t ret_value=SUCCEED; /* return value */
FUNC_ENTER_NOAPI(H5S_select_release, FAIL);
/* Check args */
assert (space);
switch(space->select.type) {
case H5S_SEL_POINTS: /* Sequence of points selected */
ret_value=H5S_point_release(space);
break;
case H5S_SEL_HYPERSLABS: /* Hyperslab selection defined */
ret_value=H5S_hyper_release(space);
break;
case H5S_SEL_ALL: /* Entire extent selected */
ret_value=H5S_all_release(space);
break;
case H5S_SEL_NONE: /* Nothing selected */
break;
case H5S_SEL_ERROR:
case H5S_SEL_N:
break;
}
/* Reset type of selection to "all" */
space->select.type=H5S_SEL_ALL;
FUNC_LEAVE (ret_value);
} /* H5S_select_release() */
/*--------------------------------------------------------------------------
NAME
H5Sget_select_npoints
PURPOSE
Get the number of elements in current selection
USAGE
hssize_t H5Sget_select_npoints(dsid)
hid_t dsid; IN: Dataspace ID of selection to query
RETURNS
The number of elements in selection on success, 0 on failure
DESCRIPTION
Returns the number of elements in current selection for dataspace.
GLOBAL VARIABLES
COMMENTS, BUGS, ASSUMPTIONS
EXAMPLES
REVISION LOG
--------------------------------------------------------------------------*/
hssize_t
H5Sget_select_npoints(hid_t spaceid)
{
H5S_t *space = NULL; /* Dataspace to modify selection of */
hssize_t ret_value=FAIL; /* return value */
FUNC_ENTER_API(H5Sget_select_npoints, 0);
H5TRACE1("Hs","i",spaceid);
/* Check args */
if (H5I_DATASPACE != H5I_get_type(spaceid) ||
NULL == (space=H5I_object(spaceid))) {
HRETURN_ERROR(H5E_ARGS, H5E_BADTYPE, 0, "not a data space");
}
ret_value = H5S_get_select_npoints(space);
FUNC_LEAVE (ret_value);
} /* H5Sget_select_npoints() */
/*--------------------------------------------------------------------------
NAME
H5S_get_select_npoints
PURPOSE
Get the number of elements in current selection
USAGE
herr_t H5S_get_select_npoints(ds)
H5S_t *ds; IN: Dataspace pointer
RETURNS
The number of elements in selection on success, 0 on failure
DESCRIPTION
Returns the number of elements in current selection for dataspace.
GLOBAL VARIABLES
COMMENTS, BUGS, ASSUMPTIONS
EXAMPLES
REVISION LOG
--------------------------------------------------------------------------*/
hssize_t
H5S_get_select_npoints (const H5S_t *space)
{
hssize_t ret_value=FAIL; /* return value */
FUNC_ENTER_NOAPI(H5S_get_select_npoints, FAIL);
assert(space);
switch(space->select.type) {
case H5S_SEL_POINTS: /* Sequence of points selected */
ret_value=H5S_point_npoints(space);
break;
case H5S_SEL_HYPERSLABS: /* Hyperslab selection defined */
ret_value=H5S_hyper_npoints(space);
break;
case H5S_SEL_ALL: /* Entire extent selected */
ret_value=H5S_all_npoints(space);
break;
case H5S_SEL_NONE: /* Nothing selected */
ret_value=0;
break;
case H5S_SEL_ERROR:
case H5S_SEL_N:
break;
}
FUNC_LEAVE (ret_value);
} /* H5S_get_select_npoints() */
/*--------------------------------------------------------------------------
NAME
H5S_sel_iter_release
PURPOSE
Release selection iterator information for a dataspace
USAGE
herr_t H5S_sel_iter_release(sel_iter)
const H5S_t *space; IN: Pointer to dataspace iterator is for
H5S_sel_iter_t *sel_iter; IN: Pointer to selection iterator
RETURNS
Non-negative on success/Negative on failure
DESCRIPTION
Releases all information for a dataspace selection iterator
GLOBAL VARIABLES
COMMENTS, BUGS, ASSUMPTIONS
EXAMPLES
REVISION LOG
--------------------------------------------------------------------------*/
herr_t
H5S_sel_iter_release (const H5S_t *space, H5S_sel_iter_t *sel_iter)
{
herr_t ret_value=SUCCEED; /* Return value */
FUNC_ENTER_NOAPI(H5S_sel_iter_release, FAIL);
/* Check args */
assert (sel_iter);
switch(space->select.type) {
case H5S_SEL_POINTS: /* Sequence of points selected */
case H5S_SEL_ALL: /* Entire extent selected */
/* no action needed */
ret_value=SUCCEED;
break;
case H5S_SEL_HYPERSLABS: /* Hyperslab selection defined */
ret_value=H5S_hyper_sel_iter_release(sel_iter);
break;
case H5S_SEL_NONE: /* Nothing selected */
break;
case H5S_SEL_ERROR:
case H5S_SEL_N:
break;
}
FUNC_LEAVE (ret_value);
} /* H5S_sel_iter_release() */
/*--------------------------------------------------------------------------
NAME
H5Sselect_valid
PURPOSE
Check whether the selection fits within the extent, with the current
offset defined.
USAGE
htri_t H5Sselect_void(dsid)
hid_t dsid; IN: Dataspace ID to query
RETURNS
TRUE if the selection fits within the extent, FALSE if it does not and
Negative on an error.
DESCRIPTION
Determines if the current selection at the current offet fits within the
extent for the dataspace.
GLOBAL VARIABLES
COMMENTS, BUGS, ASSUMPTIONS
EXAMPLES
REVISION LOG
--------------------------------------------------------------------------*/
htri_t
H5Sselect_valid(hid_t spaceid)
{
H5S_t *space = NULL; /* Dataspace to modify selection of */
htri_t ret_value=FAIL; /* return value */
FUNC_ENTER_API(H5Sselect_valid, 0);
H5TRACE1("b","i",spaceid);
/* Check args */
if (H5I_DATASPACE != H5I_get_type(spaceid) ||
NULL == (space=H5I_object(spaceid))) {
HRETURN_ERROR(H5E_ARGS, H5E_BADTYPE, 0, "not a data space");
}
ret_value = H5S_select_valid(space);
FUNC_LEAVE (ret_value);
} /* H5Sselect_valid() */
/*--------------------------------------------------------------------------
NAME
H5S_select_valid
PURPOSE
Check whether the selection fits within the extent, with the current
offset defined.
USAGE
htri_t H5Sselect_void(space)
H5S_t *space; IN: Dataspace pointer to query
RETURNS
TRUE if the selection fits within the extent, FALSE if it does not and
Negative on an error.
DESCRIPTION
Determines if the current selection at the current offet fits within the
extent for the dataspace.
GLOBAL VARIABLES
COMMENTS, BUGS, ASSUMPTIONS
EXAMPLES
REVISION LOG
--------------------------------------------------------------------------*/
htri_t
H5S_select_valid (const H5S_t *space)
{
htri_t ret_value=FAIL; /* return value */
FUNC_ENTER_NOAPI(H5S_select_valid, FAIL);
assert(space);
switch(space->select.type) {
case H5S_SEL_POINTS: /* Sequence of points selected */
ret_value=H5S_point_select_valid(space);
break;
case H5S_SEL_HYPERSLABS: /* Hyperslab selection defined */
ret_value=H5S_hyper_select_valid(space);
break;
case H5S_SEL_ALL: /* Entire extent selected */
case H5S_SEL_NONE: /* Nothing selected */
ret_value=TRUE;
break;
case H5S_SEL_ERROR:
case H5S_SEL_N:
break;
}
FUNC_LEAVE (ret_value);
} /* H5S_select_valid() */
/*--------------------------------------------------------------------------
NAME
H5S_select_serial_size
PURPOSE
Determine the number of bytes needed to serialize the current selection
offset defined.
USAGE
hssize_t H5S_select_serial_size(space)
H5S_t *space; IN: Dataspace pointer to query
RETURNS
The number of bytes required on success, negative on an error.
DESCRIPTION
Determines the number of bytes required to serialize the current selection
information for storage on disk. This routine just hands off to the
appropriate routine for each type of selection.
GLOBAL VARIABLES
COMMENTS, BUGS, ASSUMPTIONS
EXAMPLES
REVISION LOG
--------------------------------------------------------------------------*/
hssize_t
H5S_select_serial_size (const H5S_t *space)
{
hssize_t ret_value=FAIL; /* return value */
FUNC_ENTER_NOAPI(H5S_select_serial_size, FAIL);
assert(space);
switch(space->select.type) {
case H5S_SEL_POINTS: /* Sequence of points selected */
ret_value=H5S_point_select_serial_size(space);
break;
case H5S_SEL_HYPERSLABS: /* Hyperslab selection defined */
ret_value=H5S_hyper_select_serial_size(space);
break;
case H5S_SEL_ALL: /* Entire extent selected */
case H5S_SEL_NONE: /* Nothing selected */
ret_value=16; /* replace with real function call at some point */
break;
case H5S_SEL_ERROR:
case H5S_SEL_N:
break;
}
FUNC_LEAVE (ret_value);
} /* H5S_select_serial_size() */
/*--------------------------------------------------------------------------
NAME
H5S_select_serialize
PURPOSE
Serialize the current selection into a user-provided buffer.
USAGE
herr_t H5S_select_serialize(space, buf)
H5S_t *space; IN: Dataspace pointer of selection to serialize
uint8 *buf; OUT: Buffer to put serialized selection into
RETURNS
Non-negative on success/Negative on failure
DESCRIPTION
Serializes the current selection into a buffer. (Primarily for storing
on disk). This routine just hands off to the appropriate routine for each
type of selection.
The serialized information for all types of selections follows this format:
<type of selection> = uint32
<version #> = uint32
<padding, not-used> = 4 bytes
<length of selection specific information> = uint32
<selection specific information> = ? bytes (depends on selection type)
GLOBAL VARIABLES
COMMENTS, BUGS, ASSUMPTIONS
EXAMPLES
REVISION LOG
--------------------------------------------------------------------------*/
herr_t
H5S_select_serialize (const H5S_t *space, uint8_t *buf)
{
herr_t ret_value=FAIL; /* return value */
FUNC_ENTER_NOAPI(H5S_select_serialize, FAIL);
assert(space);
switch(space->select.type) {
case H5S_SEL_POINTS: /* Sequence of points selected */
ret_value=H5S_point_select_serialize(space,buf);
break;
case H5S_SEL_HYPERSLABS: /* Hyperslab selection defined */
ret_value=H5S_hyper_select_serialize(space,buf);
break;
case H5S_SEL_ALL: /* Entire extent selected */
ret_value=H5S_all_select_serialize(space,buf);
break;
case H5S_SEL_NONE: /* Nothing selected */
ret_value=H5S_none_select_serialize(space,buf);
break;
case H5S_SEL_ERROR:
case H5S_SEL_N:
break;
}
FUNC_LEAVE (ret_value);
} /* H5S_select_serialize() */
/*--------------------------------------------------------------------------
NAME
H5S_select_deserialize
PURPOSE
Deserialize the current selection from a user-provided buffer into a real
selection in the dataspace.
USAGE
herr_t H5S_select_deserialize(space, buf)
H5S_t *space; IN/OUT: Dataspace pointer to place selection into
uint8 *buf; IN: Buffer to retrieve serialized selection from
RETURNS
Non-negative on success/Negative on failure
DESCRIPTION
Deserializes the current selection into a buffer. (Primarily for retrieving
from disk). This routine just hands off to the appropriate routine for each
type of selection. The format of the serialized information is shown in
the H5S_select_serialize() header.
GLOBAL VARIABLES
COMMENTS, BUGS, ASSUMPTIONS
EXAMPLES
REVISION LOG
--------------------------------------------------------------------------*/
herr_t
H5S_select_deserialize (H5S_t *space, const uint8_t *buf)
{
const uint8_t *tbuf; /* Temporary pointer to the selection type */
uint32_t sel_type; /* Pointer to the selection type */
herr_t ret_value=FAIL; /* return value */
FUNC_ENTER_NOAPI(H5S_select_deserialize, FAIL);
assert(space);
tbuf=buf;
UINT32DECODE(tbuf, sel_type);
switch(sel_type) {
case H5S_SEL_POINTS: /* Sequence of points selected */
ret_value=H5S_point_select_deserialize(space,buf);
break;
case H5S_SEL_HYPERSLABS: /* Hyperslab selection defined */
ret_value=H5S_hyper_select_deserialize(space,buf);
break;
case H5S_SEL_ALL: /* Entire extent selected */
ret_value=H5S_all_select_deserialize(space,buf);
break;
case H5S_SEL_NONE: /* Nothing selected */
ret_value=H5S_none_select_deserialize(space,buf);
break;
default:
break;
}
FUNC_LEAVE (ret_value);
} /* H5S_select_deserialize() */
/*--------------------------------------------------------------------------
NAME
H5S_get_select_hyper_nblocks
PURPOSE
Get the number of hyperslab blocks in current hyperslab selection
USAGE
hssize_t H5S_get_select_hyper_nblocks(space)
H5S_t *space; IN: Dataspace ptr of selection to query
RETURNS
The number of hyperslab blocks in selection on success, negative on failure
DESCRIPTION
Returns the number of hyperslab blocks in current selection for dataspace.
GLOBAL VARIABLES
COMMENTS, BUGS, ASSUMPTIONS
EXAMPLES
REVISION LOG
--------------------------------------------------------------------------*/
static hssize_t
H5S_get_select_hyper_nblocks(H5S_t *space)
{
hssize_t ret_value=FAIL; /* return value */
unsigned u; /* Counter */
FUNC_ENTER_NOINIT(H5S_get_select_hyper_nblocks);
assert(space);
/* Check for a "regular" hyperslab selection */
if(space->select.sel_info.hslab.diminfo != NULL) {
/* Check each dimension */
for(ret_value=1,u=0; u<space->extent.u.simple.rank; u++)
ret_value*=space->select.sel_info.hslab.app_diminfo[u].count;
} /* end if */
else
ret_value = H5S_hyper_span_nblocks(space->select.sel_info.hslab.span_lst);
FUNC_LEAVE (ret_value);
} /* H5S_get_select_hyper_nblocks() */
/*--------------------------------------------------------------------------
NAME
H5Sget_select_hyper_nblocks
PURPOSE
Get the number of hyperslab blocks in current hyperslab selection
USAGE
hssize_t H5Sget_select_hyper_nblocks(dsid)
hid_t dsid; IN: Dataspace ID of selection to query
RETURNS
The number of hyperslab blocks in selection on success, negative on failure
DESCRIPTION
Returns the number of hyperslab blocks in current selection for dataspace.
GLOBAL VARIABLES
COMMENTS, BUGS, ASSUMPTIONS
EXAMPLES
REVISION LOG
--------------------------------------------------------------------------*/
hssize_t
H5Sget_select_hyper_nblocks(hid_t spaceid)
{
H5S_t *space = NULL; /* Dataspace to modify selection of */
hssize_t ret_value=FAIL; /* return value */
FUNC_ENTER_API(H5Sget_select_hyper_nblocks, FAIL);
H5TRACE1("Hs","i",spaceid);
/* Check args */
if (H5I_DATASPACE != H5I_get_type(spaceid) ||
NULL == (space=H5I_object(spaceid))) {
HRETURN_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL, "not a data space");
}
if(space->select.type!=H5S_SEL_HYPERSLABS)
HRETURN_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL, "not a hyperslab selection");
ret_value = H5S_get_select_hyper_nblocks(space);
FUNC_LEAVE (ret_value);
} /* H5Sget_select_hyper_nblocks() */
/*--------------------------------------------------------------------------
NAME
H5S_get_select_elem_npoints
PURPOSE
Get the number of points in current element selection
USAGE
hssize_t H5S_get_select_elem_npoints(space)
H5S_t *space; IN: Dataspace ptr of selection to query
RETURNS
The number of element points in selection on success, negative on failure
DESCRIPTION
Returns the number of element points in current selection for dataspace.
GLOBAL VARIABLES
COMMENTS, BUGS, ASSUMPTIONS
EXAMPLES
REVISION LOG
--------------------------------------------------------------------------*/
static hssize_t
H5S_get_select_elem_npoints(H5S_t *space)
{
hssize_t ret_value=FAIL; /* return value */
FUNC_ENTER_NOINIT(H5S_get_select_elem_npoints);
assert(space);
ret_value = space->select.num_elem;
FUNC_LEAVE (ret_value);
} /* H5Sget_select_elem_npoints() */
/*--------------------------------------------------------------------------
NAME
H5Sget_select_elem_npoints
PURPOSE
Get the number of points in current element selection
USAGE
hssize_t H5Sget_select_elem_npoints(dsid)
hid_t dsid; IN: Dataspace ID of selection to query
RETURNS
The number of element points in selection on success, negative on failure
DESCRIPTION
Returns the number of element points in current selection for dataspace.
GLOBAL VARIABLES
COMMENTS, BUGS, ASSUMPTIONS
EXAMPLES
REVISION LOG
--------------------------------------------------------------------------*/
hssize_t
H5Sget_select_elem_npoints(hid_t spaceid)
{
H5S_t *space = NULL; /* Dataspace to modify selection of */
hssize_t ret_value=FAIL; /* return value */
FUNC_ENTER_API(H5Sget_select_elem_npoints, FAIL);
H5TRACE1("Hs","i",spaceid);
/* Check args */
if (H5I_DATASPACE != H5I_get_type(spaceid) ||
NULL == (space=H5I_object(spaceid))) {
HRETURN_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL, "not a data space");
}
if(space->select.type!=H5S_SEL_POINTS)
HRETURN_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL, "not an element selection");
ret_value = H5S_get_select_elem_npoints(space);
FUNC_LEAVE (ret_value);
} /* H5Sget_select_elem_npoints() */
/*--------------------------------------------------------------------------
NAME
H5S_get_select_hyper_blocklist
PURPOSE
Get the list of hyperslab blocks currently selected
USAGE
herr_t H5S_get_select_hyper_blocklist(space, startblock, numblocks, buf)
H5S_t *space; IN: Dataspace pointer of selection to query
hsize_t startblock; IN: Hyperslab block to start with
hsize_t numblocks; IN: Number of hyperslab blocks to get
hsize_t *buf; OUT: List of hyperslab blocks selected
RETURNS
Non-negative on success, negative on failure
DESCRIPTION
Puts a list of the hyperslab blocks into the user's buffer. The blocks
start with the 'startblock'th block in the list of blocks and put
'numblocks' number of blocks into the user's buffer (or until the end of
the list of blocks, whichever happens first)
The block coordinates have the same dimensionality (rank) as the
dataspace they are located within. The list of blocks is formatted as
follows: <"start" coordinate> immediately followed by <"opposite" corner
coordinate>, followed by the next "start" and "opposite" coordinate, etc.
until all the block information requested has been put into the user's
buffer.
No guarantee of any order of the blocks is implied.
GLOBAL VARIABLES
COMMENTS, BUGS, ASSUMPTIONS
EXAMPLES
REVISION LOG
--------------------------------------------------------------------------*/
static herr_t
H5S_get_select_hyper_blocklist(H5S_t *space, hsize_t startblock, hsize_t numblocks, hsize_t *buf)
{
H5S_hyper_dim_t *diminfo; /* Alias for dataspace's diminfo information */
hsize_t tmp_count[H5O_LAYOUT_NDIMS]; /* Temporary hyperslab counts */
hssize_t offset[H5O_LAYOUT_NDIMS]; /* Offset of element in dataspace */
hssize_t start[H5O_LAYOUT_NDIMS]; /* Location of start of hyperslab */
hssize_t end[H5O_LAYOUT_NDIMS]; /* Location of end of hyperslab */
hssize_t temp_off; /* Offset in a given dimension */
int i; /* Counter */
int fast_dim; /* Rank of the fastest changing dimension for the dataspace */
int temp_dim; /* Temporary rank holder */
int ndims; /* Rank of the dataspace */
int done; /* Whether we are done with the iteration */
herr_t ret_value=SUCCEED; /* return value */
FUNC_ENTER_NOINIT(H5S_get_select_hyper_blocklist);
assert(space);
assert(buf);
/* Check for a "regular" hyperslab selection */
if(space->select.sel_info.hslab.diminfo != NULL) {
/* Set some convienence values */
ndims=space->extent.u.simple.rank;
fast_dim=ndims-1;
/*
* Use the "application dimension information" to pass back to the user
* the blocks they set, not the optimized, internal information.
*/
diminfo=space->select.sel_info.hslab.app_diminfo;
/* Build the tables of count sizes as well as the initial offset */
for(i=0; i<ndims; i++) {
tmp_count[i]=diminfo[i].count;
offset[i]=diminfo[i].start;
} /* end for */
/* We're not done with the iteration */
done=0;
/* Go iterate over the hyperslabs */
while(done==0 && numblocks>0) {
/* Iterate over the blocks in the fastest dimension */
while(tmp_count[fast_dim]>0 && numblocks>0) {
/* Check if we should copy this block information */
if(startblock==0) {
/* Copy the starting location */
HDmemcpy(buf,offset,sizeof(hsize_t)*ndims);
buf+=ndims;
/* Compute the ending location */
HDmemcpy(buf,offset,sizeof(hsize_t)*ndims);
for(i=0; i<ndims; i++)
buf[i]+=(diminfo[i].block-1);
buf+=ndims;
/* Decrement the number of blocks to retrieve */
numblocks--;
} /* end if */
else
startblock--;
/* Move the offset to the next sequence to start */
offset[fast_dim]+=diminfo[fast_dim].stride;
/* Decrement the block count */
tmp_count[fast_dim]--;
} /* end while */
/* Work on other dimensions if necessary */
if(fast_dim>0 && numblocks>0) {
/* Reset the block counts */
tmp_count[fast_dim]=diminfo[fast_dim].count;
/* Bubble up the decrement to the slower changing dimensions */
temp_dim=fast_dim-1;
while(temp_dim>=0 && done==0) {
/* Decrement the block count */
tmp_count[temp_dim]--;
/* Check if we have more blocks left */
if(tmp_count[temp_dim]>0)
break;
/* Check for getting out of iterator */
if(temp_dim==0)
done=1;
/* Reset the block count in this dimension */
tmp_count[temp_dim]=diminfo[temp_dim].count;
/* Wrapped a dimension, go up to next dimension */
temp_dim--;
} /* end while */
} /* end if */
/* Re-compute offset array */
for(i=0; i<ndims; i++) {
temp_off=diminfo[i].start+diminfo[i].stride*(diminfo[i].count-tmp_count[i]);
offset[i]=temp_off;
} /* end for */
} /* end while */
} /* end if */
else {
ret_value=H5S_hyper_span_blocklist(space->select.sel_info.hslab.span_lst,start,end,(hsize_t)0,&startblock,&numblocks,&buf);
} /* end else */
FUNC_LEAVE (ret_value);
} /* H5S_get_select_hyper_blocklist() */
/*--------------------------------------------------------------------------
NAME
H5Sget_select_hyper_blocklist
PURPOSE
Get the list of hyperslab blocks currently selected
USAGE
herr_t H5Sget_select_hyper_blocklist(dsid, startblock, numblocks, buf)
hid_t dsid; IN: Dataspace ID of selection to query
hsize_t startblock; IN: Hyperslab block to start with
hsize_t numblocks; IN: Number of hyperslab blocks to get
hsize_t *buf; OUT: List of hyperslab blocks selected
RETURNS
Non-negative on success, negative on failure
DESCRIPTION
Puts a list of the hyperslab blocks into the user's buffer. The blocks
start with the 'startblock'th block in the list of blocks and put
'numblocks' number of blocks into the user's buffer (or until the end of
the list of blocks, whichever happen first)
The block coordinates have the same dimensionality (rank) as the
dataspace they are located within. The list of blocks is formatted as
follows: <"start" coordinate> immediately followed by <"opposite" corner
coordinate>, followed by the next "start" and "opposite" coordinate, etc.
until all the block information requested has been put into the user's
buffer.
No guarantee of any order of the blocks is implied.
GLOBAL VARIABLES
COMMENTS, BUGS, ASSUMPTIONS
EXAMPLES
REVISION LOG
--------------------------------------------------------------------------*/
herr_t
H5Sget_select_hyper_blocklist(hid_t spaceid, hsize_t startblock, hsize_t numblocks, hsize_t *buf)
{
H5S_t *space = NULL; /* Dataspace to modify selection of */
herr_t ret_value=FAIL; /* return value */
FUNC_ENTER_API(H5Sget_select_hyper_blocklist, FAIL);
H5TRACE4("e","ihh*h",spaceid,startblock,numblocks,buf);
/* Check args */
if(buf==NULL)
HRETURN_ERROR(H5E_ARGS, H5E_BADVALUE, FAIL, "invalid pointer");
if (H5I_DATASPACE != H5I_get_type(spaceid) ||
NULL == (space=H5I_object(spaceid))) {
HRETURN_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL, "not a data space");
}
if(space->select.type!=H5S_SEL_HYPERSLABS)
HRETURN_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL, "not a hyperslab selection");
/* Go get the correct number of blocks */
if(numblocks>0)
ret_value = H5S_get_select_hyper_blocklist(space,startblock,numblocks,buf);
else
ret_value=SUCCEED; /* Successfully got 0 blocks... */
FUNC_LEAVE (ret_value);
} /* H5Sget_select_hyper_blocklist() */
/*--------------------------------------------------------------------------
NAME
H5S_get_select_elem_pointlist
PURPOSE
Get the list of element points currently selected
USAGE
herr_t H5S_get_select_elem_pointlist(space, hsize_t *buf)
H5S_t *space; IN: Dataspace pointer of selection to query
hsize_t startpoint; IN: Element point to start with
hsize_t numpoints; IN: Number of element points to get
hsize_t *buf; OUT: List of element points selected
RETURNS
Non-negative on success, negative on failure
DESCRIPTION
Puts a list of the element points into the user's buffer. The points
start with the 'startpoint'th block in the list of points and put
'numpoints' number of points into the user's buffer (or until the end of
the list of points, whichever happen first)
The point coordinates have the same dimensionality (rank) as the
dataspace they are located within. The list of points is formatted as
follows: <coordinate> followed by the next coordinate, etc. until all the
point information in the selection have been put into the user's buffer.
The points are returned in the order they will be interated through
when a selection is read/written from/to disk.
GLOBAL VARIABLES
COMMENTS, BUGS, ASSUMPTIONS
EXAMPLES
REVISION LOG
--------------------------------------------------------------------------*/
static herr_t
H5S_get_select_elem_pointlist(H5S_t *space, hsize_t startpoint, hsize_t numpoints, hsize_t *buf)
{
H5S_pnt_node_t *node; /* Point node */
int rank; /* Dataspace rank */
herr_t ret_value=SUCCEED; /* return value */
FUNC_ENTER_NOINIT(H5S_get_select_elem_pointlist);
assert(space);
assert(buf);
/* Get the dataspace extent rank */
rank=space->extent.u.simple.rank;
/* Get the head of the point list */
node=space->select.sel_info.pnt_lst->head;
/* Iterate to the first point to return */
while(node!=NULL && startpoint>0) {
startpoint--;
node=node->next;
} /* end while */
/* Iterate through the node, copying each hyperslab's information */
while(node!=NULL && numpoints>0) {
HDmemcpy(buf,node->pnt,sizeof(hsize_t)*rank);
buf+=rank;
numpoints--;
node=node->next;
} /* end while */
FUNC_LEAVE (ret_value);
} /* H5Sget_select_elem_pointlist() */
/*--------------------------------------------------------------------------
NAME
H5Sget_select_elem_pointlist
PURPOSE
Get the list of element points currently selected
USAGE
herr_t H5Sget_select_elem_pointlist(dsid, hsize_t *buf)
hid_t dsid; IN: Dataspace ID of selection to query
hsize_t startpoint; IN: Element point to start with
hsize_t numpoints; IN: Number of element points to get
hsize_t *buf; OUT: List of element points selected
RETURNS
Non-negative on success, negative on failure
DESCRIPTION
Puts a list of the element points into the user's buffer. The points
start with the 'startpoint'th block in the list of points and put
'numpoints' number of points into the user's buffer (or until the end of
the list of points, whichever happen first)
The point coordinates have the same dimensionality (rank) as the
dataspace they are located within. The list of points is formatted as
follows: <coordinate> followed by the next coordinate, etc. until all the
point information in the selection have been put into the user's buffer.
The points are returned in the order they will be interated through
when a selection is read/written from/to disk.
GLOBAL VARIABLES
COMMENTS, BUGS, ASSUMPTIONS
EXAMPLES
REVISION LOG
--------------------------------------------------------------------------*/
herr_t
H5Sget_select_elem_pointlist(hid_t spaceid, hsize_t startpoint, hsize_t numpoints, hsize_t *buf)
{
H5S_t *space = NULL; /* Dataspace to modify selection of */
herr_t ret_value=FAIL; /* return value */
FUNC_ENTER_API(H5Sget_select_elem_pointlist, FAIL);
H5TRACE4("e","ihh*h",spaceid,startpoint,numpoints,buf);
/* Check args */
if(buf==NULL)
HRETURN_ERROR(H5E_ARGS, H5E_BADVALUE, FAIL, "invalid pointer");
if (H5I_DATASPACE != H5I_get_type(spaceid) ||
NULL == (space=H5I_object(spaceid))) {
HRETURN_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL, "not a data space");
}
if(space->select.type!=H5S_SEL_POINTS)
HRETURN_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL, "not a point selection");
ret_value = H5S_get_select_elem_pointlist(space,startpoint,numpoints,buf);
FUNC_LEAVE (ret_value);
} /* H5Sget_select_elem_pointlist() */
/*--------------------------------------------------------------------------
NAME
H5S_get_select_bounds
PURPOSE
Gets the bounding box containing the selection.
USAGE
herr_t H5S_get_select_bounds(space, hsize_t *start, hsize_t *end)
H5S_t *space; IN: Dataspace pointer of selection to query
hsize_t *start; OUT: Starting coordinate of bounding box
hsize_t *end; OUT: Opposite coordinate of bounding box
RETURNS
Non-negative on success, negative on failure
DESCRIPTION
Retrieves the bounding box containing the current selection and places
it into the user's buffers. The start and end buffers must be large
enough to hold the dataspace rank number of coordinates. The bounding box
exactly contains the selection, ie. if a 2-D element selection is currently
defined with the following points: (4,5), (6,8) (10,7), the bounding box
with be (4, 5), (10, 8). Calling this function on a "none" selection
returns fail.
The bounding box calculations _does_ include the current offset of the
selection within the dataspace extent.
GLOBAL VARIABLES
COMMENTS, BUGS, ASSUMPTIONS
EXAMPLES
REVISION LOG
--------------------------------------------------------------------------*/
static herr_t
H5S_get_select_bounds(H5S_t *space, hsize_t *start, hsize_t *end)
{
int rank; /* Dataspace rank */
int i; /* index variable */
herr_t ret_value=FAIL; /* return value */
FUNC_ENTER_NOINIT(H5S_get_select_bounds);
assert(space);
assert(start);
assert(end);
/* Set the start and end arrays up */
rank=space->extent.u.simple.rank;
for(i=0; i<rank; i++) {
start[i]=UINT_MAX;
end[i]=0;
} /* end for */
switch(space->select.type) {
case H5S_SEL_POINTS: /* Sequence of points selected */
ret_value=H5S_point_bounds(space,start,end);
break;
case H5S_SEL_HYPERSLABS: /* Hyperslab selection defined */
ret_value=H5S_hyper_bounds(space,start,end);
break;
case H5S_SEL_ALL: /* Entire extent selected */
ret_value=H5S_all_bounds(space,start,end);
break;
case H5S_SEL_NONE: /* Nothing selected */
case H5S_SEL_ERROR:
case H5S_SEL_N:
break;
}
FUNC_LEAVE (ret_value);
} /* H5S_get_select_bounds() */
/*--------------------------------------------------------------------------
NAME
H5Sget_select_bounds
PURPOSE
Gets the bounding box containing the selection.
USAGE
herr_t H5S_get_select_bounds(space, start, end)
hid_t dsid; IN: Dataspace ID of selection to query
hsize_t *start; OUT: Starting coordinate of bounding box
hsize_t *end; OUT: Opposite coordinate of bounding box
RETURNS
Non-negative on success, negative on failure
DESCRIPTION
Retrieves the bounding box containing the current selection and places
it into the user's buffers. The start and end buffers must be large
enough to hold the dataspace rank number of coordinates. The bounding box
exactly contains the selection, ie. if a 2-D element selection is currently
defined with the following points: (4,5), (6,8) (10,7), the bounding box
with be (4, 5), (10, 8). Calling this function on a "none" selection
returns fail.
The bounding box calculations _does_ include the current offset of the
selection within the dataspace extent.
GLOBAL VARIABLES
COMMENTS, BUGS, ASSUMPTIONS
EXAMPLES
REVISION LOG
--------------------------------------------------------------------------*/
herr_t
H5Sget_select_bounds(hid_t spaceid, hsize_t *start, hsize_t *end)
{
H5S_t *space = NULL; /* Dataspace to modify selection of */
herr_t ret_value=FAIL; /* return value */
FUNC_ENTER_API(H5Sget_select_bounds, FAIL);
H5TRACE3("e","i*h*h",spaceid,start,end);
/* Check args */
if(start==NULL || end==NULL)
HRETURN_ERROR(H5E_ARGS, H5E_BADVALUE, FAIL, "invalid pointer");
if (H5I_DATASPACE != H5I_get_type(spaceid) ||
NULL == (space=H5I_object(spaceid))) {
HRETURN_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL, "not a data space");
}
ret_value = H5S_get_select_bounds(space,start,end);
FUNC_LEAVE (ret_value);
} /* H5Sget_select_bounds() */
/*--------------------------------------------------------------------------
NAME
H5S_select_contiguous
PURPOSE
Check if the selection is contiguous within the dataspace extent.
USAGE
htri_t H5S_select_contiguous(space)
H5S_t *space; IN: Dataspace pointer to check
RETURNS
TRUE/FALSE/FAIL
DESCRIPTION
Checks to see if the current selection in the dataspace is contiguous.
This is primarily used for reading the entire selection in one swoop.
GLOBAL VARIABLES
COMMENTS, BUGS, ASSUMPTIONS
EXAMPLES
REVISION LOG
--------------------------------------------------------------------------*/
htri_t
H5S_select_contiguous(const H5S_t *space)
{
htri_t ret_value=FAIL; /* return value */
FUNC_ENTER_NOAPI(H5S_select_contiguous, FAIL);
assert(space);
switch(space->select.type) {
case H5S_SEL_POINTS: /* Sequence of points selected */
ret_value=H5S_point_select_contiguous(space);
break;
case H5S_SEL_HYPERSLABS: /* Hyperslab selection defined */
ret_value=H5S_hyper_select_contiguous(space);
break;
case H5S_SEL_ALL: /* Entire extent selected */
ret_value=TRUE;
break;
case H5S_SEL_NONE: /* Nothing selected */
ret_value=FALSE;
break;
case H5S_SEL_ERROR:
case H5S_SEL_N:
break;
}
FUNC_LEAVE (ret_value);
} /* H5S_select_contiguous() */
/*--------------------------------------------------------------------------
NAME
H5S_select_iter_init
PURPOSE
Construct an iterator for a dataspace & selection
USAGE
herr_t H5S_select_iter_init(space, elmt_size, iter)
H5S_t *space; IN: Dataspace object containing selection to iterate over
size_t elmt_size; IN: Size of element in dataspace
H5S_sel_iter_t *iter; OUT: Iterator to initialize
RETURNS
Non-negative on success, negative on failure
DESCRIPTION
Genericly initializes an iterator, based on the type of selection in the
dataspace.
--------------------------------------------------------------------------*/
herr_t
H5S_select_iter_init(const H5S_t *space, size_t elmt_size, H5S_sel_iter_t *iter)
{
herr_t ret_value=FAIL; /* return value */
FUNC_ENTER_NOINIT(H5S_select_iter_init);
assert(space);
assert(iter);
/* Initialize iterator */
switch(space->select.type) {
case H5S_SEL_POINTS: /* Sequence of points selected */
ret_value=H5S_point_init(space,elmt_size,iter);
break;
case H5S_SEL_HYPERSLABS: /* Hyperslab selection defined */
ret_value=H5S_hyper_init(space,elmt_size,iter);
break;
case H5S_SEL_ALL: /* Entire extent selected */
ret_value=H5S_all_init(space,elmt_size,iter);
break;
case H5S_SEL_NONE: /* Nothing selected */
ret_value=FALSE;
break;
case H5S_SEL_ERROR:
case H5S_SEL_N:
break;
}
FUNC_LEAVE (ret_value);
} /* end H5S_select_iter_init() */
/*--------------------------------------------------------------------------
NAME
H5S_select_iterate
PURPOSE
Iterate over the selected elements in a memory buffer.
USAGE
herr_t H5S_select_iterate(buf, type_id, space, operator, operator_data)
void *buf; IN/OUT: Buffer containing elements to iterate over
hid_t type_id; IN: Datatype ID of BUF array.
H5S_t *space; IN: Dataspace object containing selection to iterate over
H5D_operator_t op; IN: Function pointer to the routine to be
called for each element in BUF iterated over.
void *operator_data; IN/OUT: Pointer to any user-defined data
associated with the operation.
RETURNS
Returns the return value of the last operator if it was non-zero, or zero
if all elements were processed. Otherwise returns a negative value.
DESCRIPTION
Iterates over the selected elements in a memory buffer, calling the user's
callback function for each element. The selection in the dataspace is
modified so that any elements already iterated over are removed from the
selection if the iteration is interrupted (by the H5D_operator_t function
returning non-zero) in the "middle" of the iteration and may be re-started
by the user where it left off.
NOTE: Until "subtracting" elements from a selection is implemented,
the selection is not modified.
--------------------------------------------------------------------------*/
herr_t
H5S_select_iterate(void *buf, hid_t type_id, H5S_t *space, H5D_operator_t op,
void *operator_data)
{
H5T_t *dt; /* Datatype structure */
H5P_genplist_t *dx_plist; /* Dataset transfer property list */
H5S_sel_iter_t *iter=NULL; /* Selection iteration info */
uint8_t *loc; /* Current element location in buffer */
hssize_t coords[H5O_LAYOUT_NDIMS]; /* Coordinates of element in dataspace */
hssize_t nelmts; /* Number of elements in selection */
hsize_t space_size[H5O_LAYOUT_NDIMS]; /* Dataspace size */
hsize_t *off=NULL; /* Array to store sequence offsets */
hsize_t curr_off; /* Current offset within sequence */
hsize_t tmp_off; /* Temporary offset within sequence */
size_t *len=NULL; /* Array to store sequence lengths */
size_t curr_len; /* Length of bytes left to process in sequence */
size_t vector_size; /* Value for vector size */
size_t nseq; /* Number of sequences generated */
size_t curr_seq; /* Current sequnce being worked on */
size_t nbytes; /* Number of bytes used in sequences */
size_t max_bytes; /* Maximum number of bytes allowed in sequences */
size_t elmt_size; /* Datatype size */
int ndims; /* Number of dimensions in dataspace */
int i; /* Local Index variable */
herr_t user_ret=0; /* User's return value */
herr_t ret_value=SUCCEED; /* Return value */
FUNC_ENTER_NOAPI(H5S_select_iterate, FAIL);
/* Check args */
assert(buf);
assert(H5I_DATATYPE == H5I_get_type(type_id));
assert(space);
assert(op);
/* Get the hyperslab vector size */
/* (from the default data transfer property list, for now) */
dx_plist = H5I_object(H5P_DATASET_XFER_DEFAULT);
assert(dx_plist);
if (H5P_get(dx_plist,H5D_XFER_HYPER_VECTOR_SIZE_NAME,&vector_size)<0)
HGOTO_ERROR(H5E_PLIST, H5E_CANTGET, FAIL, "unable to get value");
/* Allocate the vector I/O arrays */
if((len = H5FL_ARR_ALLOC(size_t,vector_size,0))==NULL)
HGOTO_ERROR(H5E_RESOURCE, H5E_NOSPACE, FAIL, "can't allocate I/O length vector array");
if((off = H5FL_ARR_ALLOC(hsize_t,vector_size,0))==NULL)
HGOTO_ERROR(H5E_RESOURCE, H5E_NOSPACE, FAIL, "can't allocate I/O offset vector array");
/* Get the datatype size */
if (NULL==(dt=H5I_object(type_id)))
HGOTO_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL, "not an valid base datatype");
if((elmt_size=H5T_get_size(dt))==0)
HGOTO_ERROR(H5E_DATATYPE, H5E_BADSIZE, FAIL, "datatype size invalid");
/* Allocate iterator */
if((iter = H5FL_ALLOC(H5S_sel_iter_t,1))==NULL)
HGOTO_ERROR(H5E_RESOURCE, H5E_NOSPACE, FAIL, "can't allocate selection iterator");
/* Initialize iterator */
if (H5S_select_iter_init(space, elmt_size, iter)<0)
HGOTO_ERROR (H5E_DATASPACE, H5E_CANTINIT, FAIL, "unable to initialize selection iterator");
/* Get the number of elements in selection */
if((nelmts = H5S_get_select_npoints(space))<0)
HGOTO_ERROR (H5E_DATASPACE, H5E_CANTCOUNT, FAIL, "can't get number of elements selected");
/* Get the rank of the dataspace */
ndims=space->extent.u.simple.rank;
/* Copy the size of the space */
assert(space->extent.u.simple.size);
assert(ndims>0);
HDmemcpy(space_size, space->extent.u.simple.size, ndims*sizeof(hsize_t));
space_size[ndims]=elmt_size;
/* Compute the maximum number of bytes required */
H5_ASSIGN_OVERFLOW(max_bytes,nelmts*elmt_size,hsize_t,size_t);
/* Loop, while elements left in selection */
while(max_bytes>0 && user_ret==0) {
/* Get the sequences of bytes */
if(H5S_select_get_seq_list(0,space,iter,elmt_size,vector_size,max_bytes,&nseq,&nbytes,off,len)<0)
HGOTO_ERROR (H5E_INTERNAL, H5E_UNSUPPORTED, FAIL, "sequence length generation failed");
/* Loop, while sequences left to process */
for(curr_seq=0; curr_seq<nseq && user_ret==0; curr_seq++) {
/* Get the current offset */
curr_off=off[curr_seq];
/* Get the number of bytes in sequence */
curr_len=len[curr_seq];
/* Loop, while bytes left in sequence */
while(curr_len>0 && user_ret==0) {
/* Compute the coordinate from the offset */
for(i=ndims, tmp_off=curr_off; i>=0; i--) {
coords[i]=tmp_off%space_size[i];
tmp_off/=space_size[i];
} /* end for */
/* Get the location within the user's buffer */
loc=(unsigned char *)buf+curr_off;
/* Call user's callback routine */
user_ret=(*op)(loc,type_id,(hsize_t)ndims,coords,operator_data);
/* Increment offset in dataspace */
curr_off+=elmt_size;
/* Decrement number of bytes left in sequence */
curr_len-=elmt_size;
} /* end while */
} /* end for */
/* Decrement number of elements left to process */
assert((nbytes%elmt_size)==0);
max_bytes-=nbytes;
} /* end while */
/* Set return value */
ret_value=user_ret;
done:
/* Release selection iterator */
if(iter!=NULL) {
if (H5S_sel_iter_release(space, iter)<0)
HGOTO_ERROR (H5E_DATASPACE, H5E_CANTRELEASE, FAIL, "unable to release selection iterator");
H5FL_FREE(H5S_sel_iter_t,iter);
} /* end if */
/* Release length & offset vectors */
if(len!=NULL)
H5FL_ARR_FREE(size_t,len);
if(off!=NULL)
H5FL_ARR_FREE(hsize_t,off);
FUNC_LEAVE(ret_value);
} /* end H5S_select_iterate() */
/*--------------------------------------------------------------------------
NAME
H5Sget_select_type
PURPOSE
Retrieve the type of selection in a dataspace
USAGE
H5S_sel_type H5Sget_select_type(space_id)
hid_t space_id; IN: Dataspace object to reset
RETURNS
Non-negative on success/Negative on failure. Return value is from the
set of values in the H5S_sel_type enumerated type.
DESCRIPTION
This function retrieves the type of selection currently defined for
a dataspace.
--------------------------------------------------------------------------*/
H5S_sel_type
H5Sget_select_type(hid_t space_id)
{
H5S_t *space = NULL; /* dataspace to modify */
FUNC_ENTER_API(H5Sget_select_type, H5S_SEL_ERROR);
H5TRACE1("St","i",space_id);
/* Check args */
if (H5I_DATASPACE != H5I_get_type(space_id) || NULL == (space = H5I_object(space_id)))
HRETURN_ERROR(H5E_ATOM, H5E_BADATOM, H5S_SEL_ERROR, "not a data space");
FUNC_LEAVE(space->select.type);
} /* end H5Sget_select_type() */
/*--------------------------------------------------------------------------
NAME
H5S_select_single
PURPOSE
Check if the selection is a single block within the dataspace extent.
USAGE
htri_t H5S_select_single(space)
H5S_t *space; IN: Dataspace pointer to check
RETURNS
TRUE/FALSE/FAIL
DESCRIPTION
Checks to see if the current selection in the dataspace is a single block.
This is primarily used for reading the entire selection in one swoop.
GLOBAL VARIABLES
COMMENTS, BUGS, ASSUMPTIONS
EXAMPLES
REVISION LOG
--------------------------------------------------------------------------*/
htri_t
H5S_select_single(const H5S_t *space)
{
htri_t ret_value=FAIL; /* return value */
FUNC_ENTER_NOAPI(H5S_select_single, FAIL);
/* Check args */
assert(space);
switch(space->select.type) {
case H5S_SEL_POINTS: /* Sequence of points selected */
ret_value=H5S_point_select_single(space);
break;
case H5S_SEL_HYPERSLABS: /* Hyperslab selection defined */
ret_value=H5S_hyper_select_single(space);
break;
case H5S_SEL_ALL: /* Entire extent selected */
ret_value=TRUE;
break;
case H5S_SEL_NONE: /* Nothing selected */
ret_value=FALSE;
break;
case H5S_SEL_ERROR:
case H5S_SEL_N:
break;
}
FUNC_LEAVE (ret_value);
} /* H5S_select_single() */
/*--------------------------------------------------------------------------
NAME
H5S_select_shape_same
PURPOSE
Check if two selections are the same shape
USAGE
htri_t H5S_select_shape_same(space1, space2)
const H5S_t *space1; IN: 1st Dataspace pointer to compare
const H5S_t *space2; IN: 2nd Dataspace pointer to compare
RETURNS
TRUE/FALSE/FAIL
DESCRIPTION
Checks to see if the current selection in the dataspaces are the same
dimensionality and shape.
This is primarily used for reading the entire selection in one swoop.
GLOBAL VARIABLES
COMMENTS, BUGS, ASSUMPTIONS
Assumes that there is only a single "block" for hyperslab selections.
EXAMPLES
REVISION LOG
--------------------------------------------------------------------------*/
htri_t
H5S_select_shape_same(const H5S_t *space1, const H5S_t *space2)
{
H5S_hyper_span_t *span1=NULL,*span2=NULL; /* Hyperslab span node */
hsize_t elmts1,elmts2; /* Number of elements in each dimension of selection */
unsigned u; /* Index variable */
htri_t ret_value=TRUE; /* return value */
FUNC_ENTER_NOAPI(H5S_select_shape_same, FAIL);
/* Check args */
assert(space1);
assert(space2);
if (space1->extent.u.simple.rank!=space2->extent.u.simple.rank)
HGOTO_DONE(FALSE);
/* Get information about memory and file */
for (u=0; u<space1->extent.u.simple.rank; u++) {
switch(space1->select.type) {
case H5S_SEL_HYPERSLABS:
/* Check size hyperslab selection in this dimension */
if(space1->select.sel_info.hslab.diminfo != NULL) {
elmts1=space1->select.sel_info.hslab.diminfo[u].block;
} /* end if */
else {
/* Check for the first dimension */
if(span1==NULL)
span1=space1->select.sel_info.hslab.span_lst->head;
/* Get the number of elements in the span */
elmts1=(span1->high-span1->low)+1;
/* Advance to the next dimension */
span1=span1->down->head;
} /* end else */
break;
case H5S_SEL_ALL:
elmts1=space1->extent.u.simple.size[u];
break;
case H5S_SEL_POINTS:
elmts1=1;
break;
default:
assert(0 && "Invalid selection type!");
} /* end switch */
switch(space2->select.type) {
case H5S_SEL_HYPERSLABS:
/* Check size hyperslab selection in this dimension */
if(space2->select.sel_info.hslab.diminfo != NULL) {
elmts2=space2->select.sel_info.hslab.diminfo[u].block;
} /* end if */
else {
/* Check for the first dimension */
if(span2==NULL)
span2=space2->select.sel_info.hslab.span_lst->head;
/* Get the number of elements in the span */
elmts2=(span2->high-span2->low)+1;
/* Advance to the next dimension */
span2=span2->down->head;
} /* end else */
break;
case H5S_SEL_ALL:
elmts2=space2->extent.u.simple.size[u];
break;
case H5S_SEL_POINTS:
elmts2=1;
break;
default:
assert(0 && "Invalid selection type!");
} /* end switch */
/* Make certaint the selections have the same number of elements in this dimension */
if (elmts1!=elmts2)
HGOTO_DONE(FALSE);
} /* end for */
done:
FUNC_LEAVE (ret_value);
} /* H5S_select_shape_same() */
/*--------------------------------------------------------------------------
NAME
H5S_select_regular
PURPOSE
Check if a selection is "regular"
USAGE
htri_t H5S_select_regular(space)
const H5S_t *space; IN: Dataspace pointer to check
RETURNS
TRUE/FALSE/FAIL
DESCRIPTION
Checks to see if the current selection in a dataspace is the a regular
pattern.
This is primarily used for reading the entire selection in one swoop.
GLOBAL VARIABLES
COMMENTS, BUGS, ASSUMPTIONS
EXAMPLES
REVISION LOG
--------------------------------------------------------------------------*/
htri_t
H5S_select_regular(const H5S_t *space)
{
htri_t ret_value=FAIL; /* return value */
FUNC_ENTER_NOAPI(H5S_select_regular, FAIL);
/* Check args */
assert(space);
/* Check for a "regular" selection */
/* [Defer (mostly) to the selection routines] */
switch(space->select.type) {
case H5S_SEL_POINTS: /* Sequence of points selected */
ret_value=H5S_point_select_regular(space);
break;
case H5S_SEL_HYPERSLABS: /* Hyperslab selection defined */
ret_value=H5S_hyper_select_regular(space);
break;
case H5S_SEL_ALL: /* Entire extent selected */
ret_value=TRUE;
break;
case H5S_SEL_NONE: /* Nothing selected */
ret_value=FALSE;
break;
case H5S_SEL_ERROR:
case H5S_SEL_N:
break;
} /* end switch */
FUNC_LEAVE (ret_value);
} /* H5S_select_regular() */
/*--------------------------------------------------------------------------
NAME
H5S_select_fill
PURPOSE
Fill a selection in memory with a value
USAGE
herr_t H5S_select_fill(fill,fill_size,space,buf)
const void *fill; IN: Pointer to fill value to use
size_t fill_size; IN: Size of elements in memory buffer & size of
fill value
H5S_t *space; IN: Dataspace describing memory buffer &
containing selection to use.
void *buf; IN/OUT: Memory buffer to fill selection in
RETURNS
Non-negative on success/Negative on failure.
DESCRIPTION
Use the selection in the dataspace to fill elements in a memory buffer.
GLOBAL VARIABLES
COMMENTS, BUGS, ASSUMPTIONS
The memory buffer elements are assumed to have the same datatype as the
fill value being placed into them.
EXAMPLES
REVISION LOG
--------------------------------------------------------------------------*/
herr_t
H5S_select_fill(void *_fill, size_t fill_size, const H5S_t *space, void *_buf)
{
H5P_genplist_t *dx_plist; /* Dataset transfer property list */
H5S_sel_iter_t *iter=NULL; /* Selection iteration info */
uint8_t *buf; /* Current location in buffer */
void *fill=_fill; /* Alias for fill-value buffer */
hssize_t nelmts; /* Number of elements in selection */
hsize_t *off=NULL; /* Array to store sequence offsets */
size_t *len=NULL; /* Array to store sequence lengths */
size_t vector_size; /* Value for vector size */
size_t nseq; /* Number of sequences generated */
size_t curr_seq; /* Current sequnce being worked on */
size_t nbytes; /* Number of bytes used in sequences */
size_t max_bytes; /* Total number of bytes in selection */
herr_t ret_value=SUCCEED; /* return value */
FUNC_ENTER_NOAPI(H5S_select_fill, FAIL);
/* Check args */
assert(fill_size>0);
assert(space);
assert(buf);
/* Check if we need a temporary fill value buffer */
if(fill==NULL) {
if (NULL==(fill = H5FL_BLK_ALLOC(type_elem,fill_size,1)))
HGOTO_ERROR (H5E_RESOURCE, H5E_NOSPACE, FAIL, "fill value buffer allocation failed");
} /* end if */
/* Get the hyperslab vector size */
/* (from the default data transfer property list, for now) */
dx_plist = H5I_object(H5P_DATASET_XFER_DEFAULT);
assert(dx_plist);
if (H5P_get(dx_plist,H5D_XFER_HYPER_VECTOR_SIZE_NAME,&vector_size)<0)
HGOTO_ERROR(H5E_PLIST, H5E_CANTGET, FAIL, "unable to get value");
/* Allocate the vector I/O arrays */
if((len = H5FL_ARR_ALLOC(size_t,vector_size,0))==NULL)
HGOTO_ERROR(H5E_RESOURCE, H5E_NOSPACE, FAIL, "can't allocate I/O length vector array");
if((off = H5FL_ARR_ALLOC(hsize_t,vector_size,0))==NULL)
HGOTO_ERROR(H5E_RESOURCE, H5E_NOSPACE, FAIL, "can't allocate I/O offset vector array");
/* Allocate iterator */
if((iter = H5FL_ALLOC(H5S_sel_iter_t,1))==NULL)
HGOTO_ERROR(H5E_RESOURCE, H5E_NOSPACE, FAIL, "can't allocate selection iterator");
/* Initialize iterator */
if (H5S_select_iter_init(space, fill_size, iter)<0)
HGOTO_ERROR (H5E_DATASPACE, H5E_CANTINIT, FAIL, "unable to initialize selection iterator");
/* Get the number of elements in selection */
if((nelmts = H5S_get_select_npoints(space))<0)
HGOTO_ERROR (H5E_DATASPACE, H5E_CANTCOUNT, FAIL, "can't get number of elements selected");
/* Compute the number of bytes to process */
H5_CHECK_OVERFLOW(nelmts,hssize_t,size_t);
max_bytes=(size_t)nelmts*fill_size;
/* Loop, while elements left in selection */
while(max_bytes>0) {
/* Get the sequences of bytes */
if(H5S_select_get_seq_list(0,space,iter,fill_size,vector_size,max_bytes,&nseq,&nbytes,off,len)<0)
HGOTO_ERROR (H5E_INTERNAL, H5E_UNSUPPORTED, FAIL, "sequence length generation failed");
/* Loop over sequences */
for(curr_seq=0; curr_seq<nseq; curr_seq++) {
/* Get offset in memory buffer */
buf=(uint8_t *)_buf+off[curr_seq];
/* Fill each sequence in memory with fill value */
assert((len[curr_seq]%fill_size)==0);
H5V_array_fill(buf, fill, fill_size, (len[curr_seq]/fill_size));
} /* end for */
/* Decrement number of bytes left to process */
max_bytes-=nbytes;
} /* end while */
done:
/* Release selection iterator */
if(iter!=NULL) {
if (H5S_sel_iter_release(space, iter)<0)
HGOTO_ERROR (H5E_DATASPACE, H5E_CANTRELEASE, FAIL, "unable to release selection iterator");
H5FL_FREE(H5S_sel_iter_t,iter);
} /* end if */
/* Release length & offset vectors */
if(len!=NULL)
H5FL_ARR_FREE(size_t,len);
if(off!=NULL)
H5FL_ARR_FREE(hsize_t,off);
/* Release fill value, if allocated */
if(_fill==NULL && fill)
H5FL_BLK_FREE(type_elem,fill);
FUNC_LEAVE (ret_value);
} /* H5S_select_fill() */
/*--------------------------------------------------------------------------
NAME
H5S_select_get_seq_list
PURPOSE
Create a list of offsets & lengths for a selection
USAGE
herr_t H5S_select_get_file_list(flags,space,iter,flag,elem_size,maxseq,maxbytes,nseq,off,len)
unsigned flags; IN: Flags for extra information about operation
H5S_t *space; IN: Dataspace containing selection to use.
H5S_sel_iter_t *iter; IN/OUT: Selection iterator describing last
position of interest in selection.
unsigned flag; IN: Flag to indicate whether to update the
iterator or not.
size_t elem_size; IN: Size of an element
size_t maxseq; IN: Maximum number of sequences to generate
size_t maxbytes; IN: Maximum number of bytes to include in the
generated sequences
size_t *nseq; OUT: Actual number of sequences generated
hsize_t *off; OUT: Array of offsets
hsize_t *len; OUT: Array of lengths
RETURNS
Non-negative on success/Negative on failure.
DESCRIPTION
Use the selection in the dataspace to generate a list of byte offsets and
lengths for the region(s) selected. Start/Restart from the position in the
ITER parameter. Updating the iterator is controlled with the FLAG
parameter. The number of sequences generated is limited by the MAXSEQ
parameter and the number of sequences actually generated is stored in the
NSEQ parameter.
GLOBAL VARIABLES
COMMENTS, BUGS, ASSUMPTIONS
EXAMPLES
REVISION LOG
--------------------------------------------------------------------------*/
herr_t
H5S_select_get_seq_list(unsigned flags, const H5S_t *space,H5S_sel_iter_t *iter,
size_t elem_size, size_t maxseq, size_t maxbytes, size_t *nseq, size_t *nbytes,
hsize_t *off, size_t *len)
{
herr_t ret_value=SUCCEED; /* return value */
FUNC_ENTER_NOAPI (H5S_select_get_seq_list, FAIL);
/* Check args */
assert(space);
assert(iter);
assert(elem_size>0);
assert(maxseq>0);
assert(maxbytes>0);
assert(nseq);
assert(off);
assert(len);
/* Get the list of sequences for each type selection */
/* [Defer (mostly) to the selection routines] */
switch(space->select.type) {
case H5S_SEL_POINTS: /* Sequence of points selected */
ret_value=H5S_point_select_get_seq_list(flags,space,iter,elem_size,maxseq,maxbytes,nseq,nbytes,off,len);
break;
case H5S_SEL_HYPERSLABS: /* Hyperslab selection defined */
ret_value=H5S_hyper_select_get_seq_list(flags,space,iter,elem_size,maxseq,maxbytes,nseq,nbytes,off,len);
break;
case H5S_SEL_ALL: /* Entire extent selected */
ret_value=H5S_all_select_get_seq_list(flags,space,iter,elem_size,maxseq,maxbytes,nseq,nbytes,off,len);
break;
case H5S_SEL_NONE: /* Nothing selected */
*nseq=0; /* Set the number of sequences generated */
break;
case H5S_SEL_ERROR:
case H5S_SEL_N:
assert(0 && "Invalid selection type!");
break;
} /* end switch */
#ifdef LATER
done:
#endif /* LATER */
FUNC_LEAVE (ret_value);
} /* H5S_select_get_seq_list() */
/*-------------------------------------------------------------------------
* Function: H5S_select_favail
*
* Purpose: Figure out the optimal number of elements to transfer to/from
* the file.
*
* Return: non-negative number of elements on success, zero on
* failure.
*
* Programmer: Quincey Koziol
* Wednesday, July 24, 2002
*
* Modifications:
*
*-------------------------------------------------------------------------
*/
hsize_t
H5S_select_favail(const H5S_t *space, const H5S_sel_iter_t *iter, hsize_t max)
{
hsize_t ret_value=0; /* Return value */
FUNC_ENTER_NOAPI (H5S_select_favail, 0);
/* Check args */
assert(space);
assert(iter);
assert(max>0);
/* Get the number of elements to transfer for each type of selection */
/* [Defer (mostly) to the selection routines] */
switch(space->select.type) {
case H5S_SEL_POINTS: /* Sequence of points selected */
ret_value=H5S_point_favail(space,iter,max);
break;
case H5S_SEL_HYPERSLABS: /* Hyperslab selection defined */
ret_value=H5S_hyper_favail(space,iter,max);
break;
case H5S_SEL_ALL: /* Entire extent selected */
ret_value=H5S_all_favail(space,iter,max);
break;
case H5S_SEL_NONE: /* Nothing selected */
ret_value=0; /* Set the number of elements to transfer */
break;
case H5S_SEL_ERROR:
case H5S_SEL_N:
assert(0 && "Invalid selection type!");
break;
} /* end switch */
#ifdef LATER
done:
#endif /* LATER */
FUNC_LEAVE (ret_value);
} /* H5S_select_favail() */
/*-------------------------------------------------------------------------
* Function: H5S_select_fscat
*
* Purpose: Scatters dataset elements from the type conversion buffer BUF
* to the file F where the data points are arranged according to
* the file data space FILE_SPACE and stored according to
* LAYOUT and EFL. Each element is ELMT_SIZE bytes.
* The caller is requesting that NELMTS elements are copied.
*
* Return: Non-negative on success/Negative on failure
*
* Programmer: Quincey Koziol
* Thursday, June 20, 2002
*
* Modifications:
*
*-------------------------------------------------------------------------
*/
herr_t
H5S_select_fscat (H5F_t *f, const struct H5O_layout_t *layout,
H5P_genplist_t *dc_plist, size_t elmt_size,
const H5S_t *file_space, H5S_sel_iter_t *file_iter,
hsize_t nelmts, hid_t dxpl_id, const void *_buf)
{
const uint8_t *buf=_buf; /* Alias for pointer arithmetic */
hsize_t *off=NULL; /* Array to store sequence offsets */
size_t *len=NULL; /* Array to store sequence lengths */
size_t vector_size; /* Value for vector size */
size_t maxbytes; /* Number of bytes in the buffer */
size_t nseq; /* Number of sequences generated */
size_t nbytes; /* Number of bytes used in sequences */
H5P_genplist_t *dx_plist; /* Dataset transfer property list */
herr_t ret_value=SUCCEED; /* Return value */
FUNC_ENTER_NOAPI(H5S_select_fscat, FAIL);
/* Check args */
assert (f);
assert (layout);
assert (elmt_size>0);
assert (file_space);
assert (file_iter);
assert (nelmts>0);
assert (_buf);
/* Get the hyperslab vector size */
if(TRUE!=H5P_isa_class(dxpl_id,H5P_DATASET_XFER) || NULL == (dx_plist = H5I_object(dxpl_id)))
HGOTO_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL, "not a file access property list");
if (H5P_get(dx_plist,H5D_XFER_HYPER_VECTOR_SIZE_NAME,&vector_size)<0)
HGOTO_ERROR(H5E_PLIST, H5E_CANTGET, FAIL, "unable to get value");
/* Allocate the vector I/O arrays */
if((len = H5FL_ARR_ALLOC(size_t,vector_size,0))==NULL)
HGOTO_ERROR(H5E_RESOURCE, H5E_NOSPACE, FAIL, "can't allocate I/O length vector array");
if((off = H5FL_ARR_ALLOC(hsize_t,vector_size,0))==NULL)
HGOTO_ERROR(H5E_RESOURCE, H5E_NOSPACE, FAIL, "can't allocate I/O offset vector array");
/* Compute the number of bytes available in buffer */
H5_ASSIGN_OVERFLOW(maxbytes,nelmts*elmt_size,hsize_t,size_t);
/* Loop until all elements are written */
while(maxbytes>0) {
/* Get list of sequences for selection to write */
if(H5S_select_get_seq_list(H5S_GET_SEQ_LIST_SORTED,file_space,file_iter,elmt_size,vector_size,maxbytes,&nseq,&nbytes,off,len)<0)
HGOTO_ERROR (H5E_INTERNAL, H5E_UNSUPPORTED, FAIL, "sequence length generation failed");
/* Write sequence list out */
if (H5F_seq_writev(f, dxpl_id, layout, dc_plist, file_space, elmt_size, nseq, len, off, buf)<0)
HGOTO_ERROR(H5E_DATASPACE, H5E_WRITEERROR, FAIL, "write error");
/* Update buffer */
buf += nbytes;
/* Decrement number of elements left to process */
assert(nbytes%elmt_size==0);
maxbytes -= nbytes;
} /* end while */
done:
if(len!=NULL)
H5FL_ARR_FREE(size_t,len);
if(off!=NULL)
H5FL_ARR_FREE(hsize_t,off);
FUNC_LEAVE (ret_value);
} /* H5S_select_fscat() */
/*-------------------------------------------------------------------------
* Function: H5S_select_fgath
*
* Purpose: Gathers data points from file F and accumulates them in the
* type conversion buffer BUF. The LAYOUT argument describes
* how the data is stored on disk and EFL describes how the data
* is organized in external files. ELMT_SIZE is the size in
* bytes of a datum which this function treats as opaque.
* FILE_SPACE describes the data space of the dataset on disk
* and the elements that have been selected for reading (via
* hyperslab, etc). This function will copy at most NELMTS
* elements.
*
* Return: Success: Number of elements copied.
* Failure: 0
*
* Programmer: Quincey Koziol
* Monday, June 24, 2002
*
* Modifications:
*
*-------------------------------------------------------------------------
*/
hsize_t
H5S_select_fgath (H5F_t *f, const struct H5O_layout_t *layout,
H5P_genplist_t *dc_plist,
size_t elmt_size, const H5S_t *file_space,
H5S_sel_iter_t *file_iter, hsize_t nelmts, hid_t dxpl_id,
void *_buf/*out*/)
{
uint8_t *buf=_buf; /* Alias for pointer arithmetic */
hsize_t *off=NULL; /* Array to store sequence offsets */
size_t *len=NULL; /* Array to store sequence lengths */
size_t vector_size; /* Value for vector size */
size_t maxbytes; /* Number of bytes in the buffer */
size_t nseq; /* Number of sequences generated */
size_t nbytes; /* Number of bytes used in sequences */
H5P_genplist_t *dx_plist; /* Dataset transfer property list */
hsize_t ret_value=nelmts; /* Return value */
FUNC_ENTER_NOAPI(H5S_select_fgath, 0);
/* Check args */
assert (f);
assert (layout);
assert (elmt_size>0);
assert (file_space);
assert (file_iter);
assert (nelmts>0);
assert (_buf);
/* Get the hyperslab vector size */
if(TRUE!=H5P_isa_class(dxpl_id,H5P_DATASET_XFER) || NULL == (dx_plist = H5I_object(dxpl_id)))
HGOTO_ERROR(H5E_ARGS, H5E_BADTYPE, 0, "not a file access property list");
if (H5P_get(dx_plist,H5D_XFER_HYPER_VECTOR_SIZE_NAME,&vector_size)<0)
HGOTO_ERROR(H5E_PLIST, H5E_CANTGET, 0, "unable to get value");
/* Allocate the vector I/O arrays */
if((len = H5FL_ARR_ALLOC(size_t,vector_size,0))==NULL)
HGOTO_ERROR(H5E_RESOURCE, H5E_NOSPACE, 0, "can't allocate I/O length vector array");
if((off = H5FL_ARR_ALLOC(hsize_t,vector_size,0))==NULL)
HGOTO_ERROR(H5E_RESOURCE, H5E_NOSPACE, 0, "can't allocate I/O offset vector array");
/* Compute the number of bytes available in buffer */
H5_ASSIGN_OVERFLOW(maxbytes,nelmts*elmt_size,hsize_t,size_t);
/* Loop until all elements are written */
while(maxbytes>0) {
/* Get list of sequences for selection to write */
if(H5S_select_get_seq_list(H5S_GET_SEQ_LIST_SORTED,file_space,file_iter,elmt_size,vector_size,maxbytes,&nseq,&nbytes,off,len)<0)
HGOTO_ERROR (H5E_INTERNAL, H5E_UNSUPPORTED, 0, "sequence length generation failed");
/* Read sequence list in */
if (H5F_seq_readv(f, dxpl_id, layout, dc_plist, file_space, elmt_size, nseq, len, off, buf)<0)
HGOTO_ERROR(H5E_DATASPACE, H5E_READERROR, 0, "read error");
/* Update buffer */
buf += nbytes;
/* Decrement number of elements left to process */
assert(nbytes%elmt_size==0);
maxbytes -= nbytes;
} /* end while */
done:
if(len!=NULL)
H5FL_ARR_FREE(size_t,len);
if(off!=NULL)
H5FL_ARR_FREE(hsize_t,off);
FUNC_LEAVE (ret_value);
} /* H5S_select_fgath() */
/*-------------------------------------------------------------------------
* Function: H5S_select_mscat
*
* Purpose: Scatters NELMTS data points from the scatter buffer
* TSCAT_BUF to the application buffer BUF. Each element is
* ELMT_SIZE bytes and they are organized in application memory
* according to SPACE.
*
* Return: Non-negative on success/Negative on failure
*
* Programmer: Quincey Koziol
* Monday, July 8, 2002
*
* Modifications:
*
*-------------------------------------------------------------------------
*/
herr_t
H5S_select_mscat (const void *_tscat_buf, size_t elmt_size, const H5S_t *space,
H5S_sel_iter_t *iter, hsize_t nelmts, hid_t dxpl_id, void *_buf/*out*/)
{
H5P_genplist_t *dx_plist; /* Dataset transfer property list */
uint8_t *buf=(uint8_t *)_buf; /* Get local copies for address arithmetic */
const uint8_t *tscat_buf=(const uint8_t *)_tscat_buf;
hsize_t *off=NULL; /* Array to store sequence offsets */
size_t vector_size; /* Value for vector size */
size_t *len=NULL; /* Array to store sequence lengths */
size_t curr_len; /* Length of bytes left to process in sequence */
size_t maxbytes; /* Number of bytes in the buffer */
size_t nseq; /* Number of sequences generated */
size_t curr_seq; /* Current sequence being processed */
size_t nbytes; /* Number of bytes used in sequences */
herr_t ret_value=SUCCEED; /* Number of elements scattered */
FUNC_ENTER_NOAPI(H5S_select_mscat, FAIL);
/* Check args */
assert (tscat_buf);
assert (elmt_size>0);
assert (space);
assert (iter);
assert (nelmts>0);
assert (buf);
/* Get the hyperslab vector size */
if(TRUE!=H5P_isa_class(dxpl_id,H5P_DATASET_XFER) || NULL == (dx_plist = H5I_object(dxpl_id)))
HGOTO_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL, "not a dataset transfer property list");
if (H5P_get(dx_plist,H5D_XFER_HYPER_VECTOR_SIZE_NAME,&vector_size)<0)
HGOTO_ERROR(H5E_PLIST, H5E_CANTGET, FAIL, "unable to get value");
/* Allocate the vector I/O arrays */
if((len = H5FL_ARR_ALLOC(size_t,vector_size,0))==NULL)
HGOTO_ERROR(H5E_RESOURCE, H5E_NOSPACE, FAIL, "can't allocate I/O length vector array");
if((off = H5FL_ARR_ALLOC(hsize_t,vector_size,0))==NULL)
HGOTO_ERROR(H5E_RESOURCE, H5E_NOSPACE, FAIL, "can't allocate I/O offset vector array");
/* Compute the number of bytes available in buffer */
H5_ASSIGN_OVERFLOW(maxbytes,nelmts*elmt_size,hsize_t,size_t);
/* Loop until all elements are written */
while(maxbytes>0) {
/* Get list of sequences for selection to write */
if(H5S_select_get_seq_list(0,space,iter,elmt_size,vector_size,maxbytes,&nseq,&nbytes,off,len)<0)
HGOTO_ERROR (H5E_INTERNAL, H5E_UNSUPPORTED, 0, "sequence length generation failed");
/* Loop, while sequences left to process */
for(curr_seq=0; curr_seq<nseq; curr_seq++) {
/* Get the number of bytes in sequence */
curr_len=len[curr_seq];
HDmemcpy(buf+off[curr_seq],tscat_buf,curr_len);
/* Advance offset in destination buffer */
tscat_buf+=curr_len;
} /* end for */
/* Decrement number of elements left to process */
assert(nbytes%elmt_size==0);
maxbytes -= nbytes;
} /* end while */
done:
if(len!=NULL)
H5FL_ARR_FREE(size_t,len);
if(off!=NULL)
H5FL_ARR_FREE(hsize_t,off);
FUNC_LEAVE(ret_value);
} /* H5S_select_mscat() */
/*-------------------------------------------------------------------------
* Function: H5S_select_mgath
*
* Purpose: Gathers dataset elements from application memory BUF and
* copies them into the gather buffer TGATH_BUF.
* Each element is ELMT_SIZE bytes and arranged in application
* memory according to SPACE.
* The caller is requesting that at most NELMTS be gathered.
*
* Return: Success: Number of elements copied.
* Failure: 0
*
* Programmer: Quincey Koziol
* Monday, June 24, 2002
*
* Modifications:
*
*-------------------------------------------------------------------------
*/
hsize_t
H5S_select_mgath (const void *_buf, size_t elmt_size, const H5S_t *space,
H5S_sel_iter_t *iter, hsize_t nelmts, hid_t dxpl_id, void *_tgath_buf/*out*/)
{
H5P_genplist_t *dx_plist; /* Dataset transfer property list */
const uint8_t *buf=(const uint8_t *)_buf; /* Get local copies for address arithmetic */
uint8_t *tgath_buf=(uint8_t *)_tgath_buf;
hsize_t *off=NULL; /* Array to store sequence offsets */
size_t vector_size; /* Value for vector size */
size_t *len=NULL; /* Array to store sequence lengths */
size_t curr_len; /* Length of bytes left to process in sequence */
size_t maxbytes; /* Number of bytes in the buffer */
size_t nseq; /* Number of sequences generated */
size_t curr_seq; /* Current sequence being processed */
size_t nbytes; /* Number of bytes used in sequences */
hsize_t ret_value=nelmts; /* Number of elements gathered */
FUNC_ENTER_NOAPI(H5S_select_mgath, 0);
/* Check args */
assert (buf);
assert (elmt_size>0);
assert (space);
assert (iter);
assert (nelmts>0);
assert (tgath_buf);
/* Get the hyperslab vector size */
if(TRUE!=H5P_isa_class(dxpl_id,H5P_DATASET_XFER) || NULL == (dx_plist = H5I_object(dxpl_id)))
HGOTO_ERROR(H5E_ARGS, H5E_BADTYPE, 0, "not a dataset transfer property list");
if (H5P_get(dx_plist,H5D_XFER_HYPER_VECTOR_SIZE_NAME,&vector_size)<0)
HGOTO_ERROR(H5E_PLIST, H5E_CANTGET, 0, "unable to get value");
/* Allocate the vector I/O arrays */
if((len = H5FL_ARR_ALLOC(size_t,vector_size,0))==NULL)
HGOTO_ERROR(H5E_RESOURCE, H5E_NOSPACE, 0, "can't allocate I/O length vector array");
if((off = H5FL_ARR_ALLOC(hsize_t,vector_size,0))==NULL)
HGOTO_ERROR(H5E_RESOURCE, H5E_NOSPACE, 0, "can't allocate I/O offset vector array");
/* Compute the number of bytes available in buffer */
H5_ASSIGN_OVERFLOW(maxbytes,nelmts*elmt_size,hsize_t,size_t);
/* Loop until all elements are written */
while(maxbytes>0) {
/* Get list of sequences for selection to write */
if(H5S_select_get_seq_list(0,space,iter,elmt_size,vector_size,maxbytes,&nseq,&nbytes,off,len)<0)
HGOTO_ERROR (H5E_INTERNAL, H5E_UNSUPPORTED, 0, "sequence length generation failed");
/* Loop, while sequences left to process */
for(curr_seq=0; curr_seq<nseq; curr_seq++) {
/* Get the number of bytes in sequence */
curr_len=len[curr_seq];
HDmemcpy(tgath_buf,buf+off[curr_seq],curr_len);
/* Advance offset in gather buffer */
tgath_buf+=curr_len;
} /* end for */
/* Decrement number of elements left to process */
assert(nbytes%elmt_size==0);
maxbytes -= nbytes;
} /* end while */
done:
if(len!=NULL)
H5FL_ARR_FREE(size_t,len);
if(off!=NULL)
H5FL_ARR_FREE(hsize_t,off);
FUNC_LEAVE(ret_value);
} /* H5S_select_mgath() */
/*-------------------------------------------------------------------------
* Function: H5S_select_read
*
* Purpose: Reads directly from file into application memory.
*
* Return: Non-negative on success/Negative on failure
*
* Programmer: Quincey Koziol
* Tuesday, July 23, 2002
*
* Modifications:
*
*-------------------------------------------------------------------------
*/
herr_t
H5S_select_read(H5F_t *f, const H5O_layout_t *layout, H5P_genplist_t *dc_plist,
size_t elmt_size, const H5S_t *file_space,
const H5S_t *mem_space, hid_t dxpl_id, void *_buf/*out*/)
{
H5P_genplist_t *dx_plist; /* Dataset transfer property list */
H5S_sel_iter_t *mem_iter=NULL; /* Memory selection iteration info */
H5S_sel_iter_t *file_iter=NULL; /* File selection iteration info */
uint8_t *buf; /* Local buffer pointer, for address arithmetic */
hsize_t *mem_off=NULL; /* Array to store sequence offsets in memory */
hsize_t *file_off=NULL; /* Array to store sequence offsets in the file */
size_t vector_size; /* Value for vector size */
size_t *mem_len=NULL; /* Array to store sequence lengths in memory */
size_t *file_len=NULL; /* Array to store sequence lengths in the file */
size_t maxbytes; /* Number of bytes in selection */
size_t mem_nseq; /* Number of sequences generated in the file */
size_t file_nseq; /* Number of sequences generated in memory */
size_t mem_nbytes; /* Number of bytes used in memory sequences */
size_t file_nbytes; /* Number of bytes used in file sequences */
size_t curr_mem_seq; /* Current memory sequence to operate on */
size_t curr_file_seq; /* Current file sequence to operate on */
size_t tmp_file_len; /* Temporary number of bytes in file sequence */
unsigned partial_file; /* Whether a partial file sequence was accessed */
size_t orig_file_len; /* Original file sequence length for partial file access */
size_t orig_file_seq; /* Original file sequence to operate on */
size_t tot_file_seq; /* Number of file sequences to access */
herr_t ret_value=SUCCEED; /* Return value */
FUNC_ENTER_NOAPI(H5S_select_read, FAIL);
/* Get the hyperslab vector size */
if(TRUE!=H5P_isa_class(dxpl_id,H5P_DATASET_XFER) || NULL == (dx_plist = H5I_object(dxpl_id)))
HGOTO_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL, "not a dataset transfer property list");
if (H5P_get(dx_plist,H5D_XFER_HYPER_VECTOR_SIZE_NAME,&vector_size)<0)
HGOTO_ERROR(H5E_PLIST, H5E_CANTGET, FAIL, "unable to get value");
/* Allocate the vector I/O arrays */
if((mem_len = H5FL_ARR_ALLOC(size_t,vector_size,0))==NULL)
HGOTO_ERROR(H5E_RESOURCE, H5E_NOSPACE, FAIL, "can't allocate I/O length vector array");
if((mem_off = H5FL_ARR_ALLOC(hsize_t,vector_size,0))==NULL)
HGOTO_ERROR(H5E_RESOURCE, H5E_NOSPACE, FAIL, "can't allocate I/O offset vector array");
if((file_len = H5FL_ARR_ALLOC(size_t,vector_size,0))==NULL)
HGOTO_ERROR(H5E_RESOURCE, H5E_NOSPACE, FAIL, "can't allocate I/O length vector array");
if((file_off = H5FL_ARR_ALLOC(hsize_t,vector_size,0))==NULL)
HGOTO_ERROR(H5E_RESOURCE, H5E_NOSPACE, FAIL, "can't allocate I/O offset vector array");
/* Allocate file iterator */
if((file_iter = H5FL_ALLOC(H5S_sel_iter_t,1))==NULL)
HGOTO_ERROR(H5E_RESOURCE, H5E_NOSPACE, FAIL, "can't allocate selection iterator");
/* Initialize file iterator */
if (H5S_select_iter_init(file_space, elmt_size, file_iter)<0)
HGOTO_ERROR (H5E_DATASPACE, H5E_CANTINIT, FAIL, "unable to initialize selection iterator");
/* Allocate memory iterator */
if((mem_iter = H5FL_ALLOC(H5S_sel_iter_t,1))==NULL)
HGOTO_ERROR(H5E_RESOURCE, H5E_NOSPACE, FAIL, "can't allocate selection iterator");
/* Initialize memory iterator */
if (H5S_select_iter_init(mem_space, elmt_size, mem_iter)<0)
HGOTO_ERROR (H5E_DATASPACE, H5E_CANTINIT, FAIL, "unable to initialize selection iterator");
/* Get number of bytes in selection */
maxbytes=H5S_get_select_npoints(file_space)*elmt_size;
/* Initialize sequence counts */
curr_mem_seq=curr_file_seq=0;
mem_nseq=file_nseq=0;
/* Loop, until all bytes are processed */
while(maxbytes>0) {
/* Check if more file sequences are needed */
if(curr_file_seq>=file_nseq) {
/* Get sequences for file selection */
if(H5S_select_get_seq_list(H5S_GET_SEQ_LIST_SORTED,file_space,file_iter,elmt_size,vector_size,maxbytes,&file_nseq,&file_nbytes,file_off,file_len)<0)
HGOTO_ERROR (H5E_INTERNAL, H5E_UNSUPPORTED, FAIL, "sequence length generation failed");
/* Start at the beginning of the sequences again */
curr_file_seq=0;
} /* end if */
/* Check if more memory sequences are needed */
if(curr_mem_seq>=mem_nseq) {
/* Get sequences for memory selection */
if(H5S_select_get_seq_list(0,mem_space,mem_iter,elmt_size,vector_size,maxbytes,&mem_nseq,&mem_nbytes,mem_off,mem_len)<0)
HGOTO_ERROR (H5E_INTERNAL, H5E_UNSUPPORTED, FAIL, "sequence length generation failed");
/* Start at the beginning of the sequences again */
curr_mem_seq=0;
/* Set the buffer pointer using the first sequence */
H5_CHECK_OVERFLOW(mem_off[0],hsize_t,size_t);
buf=(uint8_t *)_buf+(size_t)mem_off[0];
} /* end if */
/* Check if current file sequence will fit into current memory sequence */
if(mem_len[curr_mem_seq]>=file_len[curr_file_seq]) {
/* Save the current number file sequence */
orig_file_seq=curr_file_seq;
/* Determine how many file sequences will fit into current memory sequence */
tmp_file_len=0;
tot_file_seq=0;
while((tmp_file_len+file_len[curr_file_seq])<=mem_len[curr_mem_seq] && curr_file_seq<file_nseq) {
tmp_file_len+=file_len[curr_file_seq];
curr_file_seq++;
tot_file_seq++;
} /* end while */
/* Check for partial file sequence */
if(tmp_file_len<mem_len[curr_mem_seq] && curr_file_seq<file_nseq) {
/* Get the original file sequence length */
orig_file_len=file_len[curr_file_seq];
/* Make the last file sequence a partial access */
file_len[curr_file_seq]=mem_len[curr_mem_seq]-tmp_file_len;
/* Increase the number of bytes to access */
tmp_file_len=mem_len[curr_mem_seq];
/* Indicate that there is an extra sequence to include in the file access */
tot_file_seq++;
/* Indicate a partial file sequence */
partial_file=1;
} /* end if */
else
partial_file=0;
/* Read file sequences into current memory sequence */
if (H5F_seq_readv(f, dxpl_id, layout, dc_plist, file_space, elmt_size, tot_file_seq, &file_len[orig_file_seq], &file_off[orig_file_seq], buf)<0)
HGOTO_ERROR(H5E_DATASPACE, H5E_READERROR, FAIL, "read error");
/* Update last file sequence, if it was partially accessed */
if(partial_file) {
file_off[curr_file_seq]+=orig_file_len-file_len[curr_file_seq];
file_len[curr_file_seq]=orig_file_len-file_len[curr_file_seq];
} /* end if */
/* Check if the current memory sequence was only partially accessed */
if(tmp_file_len<mem_len[curr_mem_seq]) {
/* Adjust current memory sequence */
mem_off[curr_mem_seq]+=tmp_file_len;
mem_len[curr_mem_seq]-=tmp_file_len;
/* Adjust memory buffer pointer */
buf+=tmp_file_len;
} /* end if */
else {
/* Must have used entire memory sequence, advance to next one */
curr_mem_seq++;
/* Check if it is valid to adjust buffer pointer */
if(curr_mem_seq<mem_nseq) {
H5_CHECK_OVERFLOW(mem_off[curr_mem_seq],hsize_t,size_t);
buf=(uint8_t *)_buf+(size_t)mem_off[curr_mem_seq];
} /* end if */
} /* end else */
/* Decrement number of bytes left to process */
maxbytes-=tmp_file_len;
} /* end if */
else {
/* Save number of bytes to access */
tmp_file_len=mem_len[curr_mem_seq];
/* Read part of current file sequence into current memory sequence */
if (H5F_seq_read(f, dxpl_id, layout, dc_plist, file_space, elmt_size, tmp_file_len, file_off[curr_file_seq], buf)<0)
HGOTO_ERROR(H5E_DATASPACE, H5E_READERROR, FAIL, "read error");
/* Update current file sequence information */
file_off[curr_file_seq]+=tmp_file_len;
file_len[curr_file_seq]-=tmp_file_len;
/* Increment memory sequence */
curr_mem_seq++;
/* Check if it is valid to adjust buffer pointer */
if(curr_mem_seq<mem_nseq) {
H5_CHECK_OVERFLOW(mem_off[curr_mem_seq],hsize_t,size_t);
buf=(uint8_t *)_buf+(size_t)mem_off[curr_mem_seq];
} /* end if */
/* Decrement number of bytes left to process */
maxbytes-=tmp_file_len;
} /* end else */
} /* end while */
done:
/* Release file selection iterator */
if(file_iter!=NULL) {
if (H5S_sel_iter_release(file_space, file_iter)<0)
HGOTO_ERROR (H5E_DATASPACE, H5E_CANTRELEASE, FAIL, "unable to release selection iterator");
H5FL_FREE(H5S_sel_iter_t,file_iter);
} /* end if */
/* Release memory selection iterator */
if(mem_iter!=NULL) {
if (H5S_sel_iter_release(mem_space, mem_iter)<0)
HGOTO_ERROR (H5E_DATASPACE, H5E_CANTRELEASE, FAIL, "unable to release selection iterator");
H5FL_FREE(H5S_sel_iter_t,mem_iter);
} /* end if */
/* Free vector arrays */
if(file_len!=NULL)
H5FL_ARR_FREE(size_t,file_len);
if(file_off!=NULL)
H5FL_ARR_FREE(hsize_t,file_off);
if(mem_len!=NULL)
H5FL_ARR_FREE(size_t,mem_len);
if(mem_off!=NULL)
H5FL_ARR_FREE(hsize_t,mem_off);
FUNC_LEAVE(ret_value);
} /* end H5S_select_read() */
/*-------------------------------------------------------------------------
* Function: H5S_select_write
*
* Purpose: Writes directly from application memory into a file
*
* Return: Non-negative on success/Negative on failure
*
* Programmer: Quincey Koziol
* Tuesday, July 23, 2002
*
* Modifications:
*
*-------------------------------------------------------------------------
*/
herr_t
H5S_select_write(H5F_t *f, const H5O_layout_t *layout, H5P_genplist_t *dc_plist,
size_t elmt_size, const H5S_t *file_space,
const H5S_t *mem_space, hid_t dxpl_id, const void *_buf/*out*/)
{
H5P_genplist_t *dx_plist; /* Dataset transfer property list */
H5S_sel_iter_t *mem_iter=NULL; /* Memory selection iteration info */
H5S_sel_iter_t *file_iter=NULL; /* File selection iteration info */
const uint8_t *buf; /* Local buffer pointer, for address arithmetic */
hsize_t *mem_off=NULL; /* Array to store sequence offsets in memory */
hsize_t *file_off=NULL; /* Array to store sequence offsets in the file */
size_t vector_size; /* Value for vector size */
size_t *mem_len=NULL; /* Array to store sequence lengths in memory */
size_t *file_len=NULL; /* Array to store sequence lengths in the file */
size_t maxbytes; /* Number of bytes in selection */
size_t mem_nseq; /* Number of sequences generated in the file */
size_t file_nseq; /* Number of sequences generated in memory */
size_t mem_nbytes; /* Number of bytes used in memory sequences */
size_t file_nbytes; /* Number of bytes used in file sequences */
size_t curr_mem_seq; /* Current memory sequence to operate on */
size_t curr_file_seq; /* Current file sequence to operate on */
size_t tmp_file_len; /* Temporary number of bytes in file sequence */
unsigned partial_file; /* Whether a partial file sequence was accessed */
size_t orig_file_len; /* Original file sequence length for partial file access */
size_t orig_file_seq; /* Original file sequence to operate on */
size_t tot_file_seq; /* Number of file sequences to access */
herr_t ret_value=SUCCEED; /* Return value */
FUNC_ENTER_NOAPI(H5S_select_write, FAIL);
/* Get the hyperslab vector size */
if(TRUE!=H5P_isa_class(dxpl_id,H5P_DATASET_XFER) || NULL == (dx_plist = H5I_object(dxpl_id)))
HGOTO_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL, "not a dataset transfer property list");
if (H5P_get(dx_plist,H5D_XFER_HYPER_VECTOR_SIZE_NAME,&vector_size)<0)
HGOTO_ERROR(H5E_PLIST, H5E_CANTGET, FAIL, "unable to get value");
/* Allocate the vector I/O arrays */
if((mem_len = H5FL_ARR_ALLOC(size_t,vector_size,0))==NULL)
HGOTO_ERROR(H5E_RESOURCE, H5E_NOSPACE, FAIL, "can't allocate I/O length vector array");
if((mem_off = H5FL_ARR_ALLOC(hsize_t,vector_size,0))==NULL)
HGOTO_ERROR(H5E_RESOURCE, H5E_NOSPACE, FAIL, "can't allocate I/O offset vector array");
if((file_len = H5FL_ARR_ALLOC(size_t,vector_size,0))==NULL)
HGOTO_ERROR(H5E_RESOURCE, H5E_NOSPACE, FAIL, "can't allocate I/O length vector array");
if((file_off = H5FL_ARR_ALLOC(hsize_t,vector_size,0))==NULL)
HGOTO_ERROR(H5E_RESOURCE, H5E_NOSPACE, FAIL, "can't allocate I/O offset vector array");
/* Allocate file iterator */
if((file_iter = H5FL_ALLOC(H5S_sel_iter_t,1))==NULL)
HGOTO_ERROR(H5E_RESOURCE, H5E_NOSPACE, FAIL, "can't allocate selection iterator");
/* Initialize file iterator */
if (H5S_select_iter_init(file_space, elmt_size, file_iter)<0)
HGOTO_ERROR (H5E_DATASPACE, H5E_CANTINIT, FAIL, "unable to initialize selection iterator");
/* Allocate memory iterator */
if((mem_iter = H5FL_ALLOC(H5S_sel_iter_t,1))==NULL)
HGOTO_ERROR(H5E_RESOURCE, H5E_NOSPACE, FAIL, "can't allocate selection iterator");
/* Initialize memory iterator */
if (H5S_select_iter_init(mem_space, elmt_size, mem_iter)<0)
HGOTO_ERROR (H5E_DATASPACE, H5E_CANTINIT, FAIL, "unable to initialize selection iterator");
/* Get number of bytes in selection */
maxbytes=H5S_get_select_npoints(file_space)*elmt_size;
/* Initialize sequence counts */
curr_mem_seq=curr_file_seq=0;
mem_nseq=file_nseq=0;
/* Loop, until all bytes are processed */
while(maxbytes>0) {
/* Check if more file sequences are needed */
if(curr_file_seq>=file_nseq) {
/* Get sequences for file selection */
if(H5S_select_get_seq_list(H5S_GET_SEQ_LIST_SORTED,file_space,file_iter,elmt_size,vector_size,maxbytes,&file_nseq,&file_nbytes,file_off,file_len)<0)
HGOTO_ERROR (H5E_INTERNAL, H5E_UNSUPPORTED, FAIL, "sequence length generation failed");
/* Start at the beginning of the sequences again */
curr_file_seq=0;
} /* end if */
/* Check if more memory sequences are needed */
if(curr_mem_seq>=mem_nseq) {
/* Get sequences for memory selection */
if(H5S_select_get_seq_list(0,mem_space,mem_iter,elmt_size,vector_size,maxbytes,&mem_nseq,&mem_nbytes,mem_off,mem_len)<0)
HGOTO_ERROR (H5E_INTERNAL, H5E_UNSUPPORTED, FAIL, "sequence length generation failed");
/* Start at the beginning of the sequences again */
curr_mem_seq=0;
/* Set the buffer pointer using the first sequence */
H5_CHECK_OVERFLOW(mem_off[0],hsize_t,size_t);
buf=(const uint8_t *)_buf+(size_t)mem_off[0];
} /* end if */
/* Check if current file sequence will fit into current memory sequence */
if(mem_len[curr_mem_seq]>=file_len[curr_file_seq]) {
/* Save the current number file sequence */
orig_file_seq=curr_file_seq;
/* Determine how many file sequences will fit into current memory sequence */
tmp_file_len=0;
tot_file_seq=0;
while((tmp_file_len+file_len[curr_file_seq])<=mem_len[curr_mem_seq] && curr_file_seq<file_nseq) {
tmp_file_len+=file_len[curr_file_seq];
curr_file_seq++;
tot_file_seq++;
} /* end while */
/* Check for partial file sequence */
if(tmp_file_len<mem_len[curr_mem_seq] && curr_file_seq<file_nseq) {
/* Get the original file sequence length */
orig_file_len=file_len[curr_file_seq];
/* Make the last file sequence a partial access */
file_len[curr_file_seq]=mem_len[curr_mem_seq]-tmp_file_len;
/* Increase the number of bytes to access */
tmp_file_len=mem_len[curr_mem_seq];
/* Indicate that there is an extra sequence to include in the file access */
tot_file_seq++;
/* Indicate a partial file sequence */
partial_file=1;
} /* end if */
else
partial_file=0;
/* Write current memory sequence into file sequences */
if (H5F_seq_writev(f, dxpl_id, layout, dc_plist, file_space, elmt_size, tot_file_seq, &file_len[orig_file_seq], &file_off[orig_file_seq], buf)<0)
HGOTO_ERROR(H5E_DATASPACE, H5E_WRITEERROR, FAIL, "write error");
/* Update last file sequence, if it was partially accessed */
if(partial_file) {
file_off[curr_file_seq]+=orig_file_len-file_len[curr_file_seq];
file_len[curr_file_seq]=orig_file_len-file_len[curr_file_seq];
} /* end if */
/* Check if the current memory sequence was only partially accessed */
if(tmp_file_len<mem_len[curr_mem_seq]) {
/* Adjust current memory sequence */
mem_off[curr_mem_seq]+=tmp_file_len;
mem_len[curr_mem_seq]-=tmp_file_len;
/* Adjust memory buffer pointer */
buf+=tmp_file_len;
} /* end if */
else {
/* Must have used entire memory sequence, advance to next one */
curr_mem_seq++;
/* Check if it is valid to adjust buffer pointer */
if(curr_mem_seq<mem_nseq) {
H5_CHECK_OVERFLOW(mem_off[curr_mem_seq],hsize_t,size_t);
buf=(const uint8_t *)_buf+(size_t)mem_off[curr_mem_seq];
} /* end if */
} /* end else */
/* Decrement number of bytes left to process */
maxbytes-=tmp_file_len;
} /* end if */
else {
/* Save number of bytes to access */
tmp_file_len=mem_len[curr_mem_seq];
/* Write part of current memory sequence to current file sequence */
if (H5F_seq_write(f, dxpl_id, layout, dc_plist, file_space, elmt_size, tmp_file_len, file_off[curr_file_seq], buf)<0)
HGOTO_ERROR(H5E_DATASPACE, H5E_WRITEERROR, FAIL, "write error");
/* Update current file sequence information */
file_off[curr_file_seq]+=tmp_file_len;
file_len[curr_file_seq]-=tmp_file_len;
/* Increment memory sequence */
curr_mem_seq++;
/* Check if it is valid to adjust buffer pointer */
if(curr_mem_seq<mem_nseq) {
H5_CHECK_OVERFLOW(mem_off[curr_mem_seq],hsize_t,size_t);
buf=(const uint8_t *)_buf+(size_t)mem_off[curr_mem_seq];
} /* end if */
/* Decrement number of bytes left to process */
maxbytes-=tmp_file_len;
} /* end else */
} /* end while */
done:
/* Release file selection iterator */
if(file_iter!=NULL) {
if (H5S_sel_iter_release(file_space, file_iter)<0)
HGOTO_ERROR (H5E_DATASPACE, H5E_CANTRELEASE, FAIL, "unable to release selection iterator");
H5FL_FREE(H5S_sel_iter_t,file_iter);
} /* end if */
/* Release memory selection iterator */
if(mem_iter!=NULL) {
if (H5S_sel_iter_release(mem_space, mem_iter)<0)
HGOTO_ERROR (H5E_DATASPACE, H5E_CANTRELEASE, FAIL, "unable to release selection iterator");
H5FL_FREE(H5S_sel_iter_t,mem_iter);
} /* end if */
/* Free vector arrays */
if(file_len!=NULL)
H5FL_ARR_FREE(size_t,file_len);
if(file_off!=NULL)
H5FL_ARR_FREE(hsize_t,file_off);
if(mem_len!=NULL)
H5FL_ARR_FREE(size_t,mem_len);
if(mem_off!=NULL)
H5FL_ARR_FREE(hsize_t,mem_off);
FUNC_LEAVE(ret_value);
} /* end H5S_select_write() */
|