Branch | Commit message | Author | Age |
architecture_docs | Update README.md | Gerd Heber | 18 months |
develop | Fix an issue where the Subfiling VFD's context cache grows too large (#4159) | jhendersonHDF | 5 months |
develop-readme | Update Linux workflows (#3173) | Dana Robinson | 14 months |
feature/1_12_recursive_ts_rw_lock | Updates BRANCH.md file | Dana Robinson | 2 years |
feature/alignment | Per discussion, use HD and add comments. | David Young | 2 years |
feature/async2 | Update pr-check.yml | Les Kurz | 4 years |
feature/ccio | Correcting H5FD__mpio_custom_<read,write> syntax to have two _ characters. | Rick | 5 years |
feature/coding_standards | Merge branch 'develop' into feature/coding_standards | Dana Robinson | 2 years |
feature/de-hd | Try to turn off auto-formatting on this branch. | David Young | 2 years |
feature/h5detect | Committing clang-format changes | github-actions | 2 years |
feature/h5f_get_obj_rework | Replace internal API calls | Matthew Larson | 6 months |
feature/indexing | Removed redundant text | Richard Warren | 5 years |
feature/new_datatypes | Merge branch 'develop' into feature/new_datatypes | Dana Robinson | 5 months |
feature/onion_vfd | Sync with develop (#1863) | Dana Robinson | 2 years |
feature/parallel_h5repack | Sync branch with develop (#1616) | Scot Breitenfeld | 2 years |
feature/refactor-h5t-cmp | Merge branch 'feature/refactor-h5t-cmp' of github.com:HDFGroup/hdf5 into feat... | David Young | 3 years |
feature/select_io_chunk_cache | Committing clang-format changes | github-actions | 8 months |
feature/select_io_tconv | Merge pull request #2876 from vchoi-hdfgroup/2my_feature_select_io_tconv | Neil Fortner | 15 months |
feature/vfd_swmr | VFD SWMR: Warning fixes and minor cleanup (#1847) | Dana Robinson | 2 years |
feature/vfd_swmr_beta_2 | Update VFD SWMR UG | Dana Robinson | 2 years |
feature/vol_cap_flags | Convert unsigned cap flag field to uint64_t and add flags (#2050) | Dana Robinson | 2 years |
feature/vol_tools_tests | Move changes from external repo to main repo (#3718) | Glenn Song | 10 months |
feature/werror-restrict | Merge branch 'develop' into feature/werror-restrict | Dana Robinson | 2 years |
gh-pages | deploy: 2908dd1d12f82b3ad559e98ae639fac2c238bcdd | lrknox | 5 months |
hdf5_1_10 | Added RELEASE.txt from HDF5 1.10.11 release to HISTORY-1_10.txt. (#3611) | Larry Knox | 11 months |
hdf5_1_10_10 | Update release date. (#2655) | Larry Knox | 17 months |
hdf5_1_10_11 | Create 11011 tarball (#3596) | Larry Knox | 11 months |
hdf5_1_10_9 | Remove duplicate line from README.md. | Larry Knox | 2 years |
hdf5_1_12 | Adjust some CMake settings (#3828) | Allen Byrne | 10 months |
hdf5_1_12_2 | HDF5 1.12.2 release created April 19, 2022. | Larry Knox | 2 years |
hdf5_1_12_3 | Hdf5 1 12 3 release (#3833) | Larry Knox | 10 months |
hdf5_1_13_2 | Update READMERE.md and RELEASE.txt with release date. | Larry Knox | 2 years |
hdf5_1_13_3 | Hdf5 1 13 3 - RELEASE.txt updates (#2203) | Larry Knox | 22 months |
hdf5_1_14 | Fix typo/stray character in cmake-ctest.yml (#4128) | Larry Knox | 6 months |
hdf5_1_14_0 | Commit release date. | Larry Knox | 20 months |
hdf5_1_14_1 | Hdf5 1 14 1-2 release for autoconf 2.71 generated files (#2945) | Larry Knox | 16 months |
hdf5_1_14_2 | Update release - fix bug and update date (#3380) | Larry Knox | 13 months |
hdf5_1_14_3 | Release updates (#3792) | Larry Knox | 10 months |
hdf5_1_6 | Merge pull request #1730 in HDFFV/hdf5 from ~BRTNFLD/hdf5_msb:hdf5_1_6 to hdf... | Scot Breitenfeld | 5 years |
hdf5_1_8 | Correct script for 3.12 and update HPC process (#2435) | Allen Byrne | 19 months |
hdf5_1_8_23 | Update release date in RELEASE.txt (#2440) | Larry Knox | 19 months |
inactive/110_HDFFV-10808-h5pset_file_space_strategy | Merge pull request #1795 in HDFFV/hdf5 from ~BYRN/hdf5_adb:hdf5_1_10 to hdf5_... | Allen Byrne | 5 years |
inactive/H5Ocompare | [svn-r22275] Clear up examples vs applications instances and add minimum file. | Allen Byrne | 12 years |
inactive/NPOESS | [svn-r17496] Fixed obvious error : changed talign.c to talign on TEST_PROG as... | Allen Byrne | 15 years |
inactive/aio_vfd | [svn-r22505] Comment out create file that fail with the new/PGI compiler unti... | Larry Knox | 12 years |
inactive/avoid_truncate | [svn-r28002] merge from trunk. | Mohamad Chaarawi | 9 years |
inactive/cu_dev | Merge branch 'develop' into cu_dev | John Ravi | 4 years |
inactive/develop_subfiling | Added skeletal version of H5FDsubfiling.c and H5FDsubfiling.h. | mainzer | 4 years |
inactive/develop_subfiling_v1 | Changed the usleep parameters based on whether the MPI rank hosts an IO Conce... | Richard Warren | 4 years |
inactive/direct_io_2 | [svn-r26017] Added BRANCH.txt. | Dana Robinson | 10 years |
inactive/h5ocompare | [svn-r19890] Add initial implementation for H5Ocompare and usage in h5diff. ... | Neil Fortner | 14 years |
inactive/hdf5_daosm | Fix uninitialized return value bugs. | Neil Fortner | 7 years |
inactive/hdf5_ff | added *ff* files dependency | Scot Breitenfeld | 8 years |
inactive/hdf5_ff_compactor | [svn-r24100] minor fix while creating a memory datatype for native writes | Vishwanath Venkatesan | 11 years |
inactive/hdf5_rados | Merge pull request #1585 in HDFFV/hdf5 from ~DEROBINS/hdf5_der:hdf5_rados to ... | Dana Robinson | 6 years |
inactive/jpeg_converter | [svn-r15458] Purpose: Modify the library to take the proper action when files... | Neil Fortner | 16 years |
inactive/json_vol | Merge pull request #1633 in HDFFV/hdf5 from ~DEROBINS/hdf5_der:feature/json_v... | Dana Robinson | 5 years |
inactive/json_vol_old | cleanup, commenting | Frank Willmore | 7 years |
inactive/mdc_sl_opt | Minor copy edits to comments -- no code changes. | mainzer | 4 years |
inactive/mds | [svn-r23487] use the core driver at the server side for the metadata file | Mohamad Chaarawi | 11 years |
inactive/merge_metadata_journaling | [svn-r24779] Description: | Quincey Koziol | 10 years |
inactive/metadata_journaling | [svn-r22480] Description: | Quincey Koziol | 12 years |
inactive/modify_dtype_filter | [svn-r15820] Added a design document describing the design details for the fi... | Raymond Lu | 16 years |
inactive/multi_rd_wd_coll_io | [svn-r29709] another merge from trunk. | Mohamad Chaarawi | 8 years |
inactive/multi_rd_wd_coll_io_merge | Merge pull request #837 in HDFFV/hdf5 from ~LRKNOX/hdf5_lrk:multi_rd_wd_coll_... | Larry Knox | 7 years |
inactive/null_vfd | [svn-r22705] Updated the failure behavior of inner driver calls. Expanded the... | Jacob Gruber | 12 years |
inactive/parallel_vds | Some fixes from Neil plus changes talked about in our last code review | Richard Warren | 6 years |
inactive/parallel_vds_develop | Merge branch 'develop' into parallel_vds_develop | M. Scot Breitenfeld | 5 years |
inactive/parallel_vds_testing | Add two(2) new parallel VDS tests, the VDS merge code for Neil, and a few edi... | Richard Warren | 7 years |
inactive/phdf5_metadata_opt | [svn-r29080] merge from trunk. | Mohamad Chaarawi | 9 years |
inactive/post_open_fix | Added a BRANCH.md file | Dana Robinson | 2 years |
inactive/rados_vol | Merge pull request #1641 in HDFFV/hdf5 from ~DEROBINS/hdf5_der:feature/rados_... | Dana Robinson | 5 years |
inactive/selection_io | Merge pull request #1531 from fortnern/selection_io | Neil Fortner | 2 years |
inactive/selection_io_with_subfiling_vfd | spelling corrections (#1382) | Scot Breitenfeld | 3 years |
inactive/trunk_merge_coverity | [svn-r23698] Description: | Quincey Koziol | 11 years |
loricooperhdf-patch-1 | Updated help desk URL | Lori Cooper | 9 months |
metadata_cache_macro_cleanup | remove obsolete SZIP find module (#2901) | Allen Byrne | 16 months |
ossf-scorecard | Create scorecard.yml | Dana Robinson | 12 months |
pr_484 | Committing clang-format changes | github-actions | 3 years |
reduce-h5f-duplication | Instead of duplicating H5F_shared_block_write() and _read() wholesale in | David Young | 4 years |
sel_io_chunk_cache | Committing clang-format changes | github-actions | 8 months |
shell_script | Remove unneeded/duplicated files | Jordan Henderson | 11 months |
zzz-gitlab-ci | Run test without submitting to CDash. | Larry Knox | 4 years |
|
08
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
/****************************************************************************
* NCSA HDF *
* Software Development Group *
* National Center for Supercomputing Applications *
* University of Illinois at Urbana-Champaign *
* 605 E. Springfield, Champaign IL 61820 *
* *
* For conditions of distribution and use, see the accompanying *
* hdf/COPYING file. *
*
* MODIFICATIONS
* Robb Matzke, 30 Aug 1997
* Added `ERRORS' fields to function prologues.
* *
****************************************************************************/
#ifdef RCSID
static char RcsId[] = "@(#)$Revision$";
#endif
/* $Id$ */
/* Packages needed by this file... */
#include <H5private.h> /*library functions */
#include <H5Aprivate.h> /*attributes */
#include <H5Dprivate.h> /*datasets */
#include <H5Iprivate.h> /*object IDs */
#include <H5ACprivate.h> /*cache */
#include <H5Eprivate.h> /*error handling */
#include <H5Fprivate.h> /*file access */
#include <H5Gprivate.h> /*symbol tables */
#include <H5MMprivate.h> /*core memory management */
#include <H5Pprivate.h> /*property lists */
#include <H5Tprivate.h> /*data types */
#define PABLO_MASK H5F_mask
/*
* Define the default file creation property list.
*/
const H5F_create_t H5F_create_dflt = {
0, /* Default user-block size */
4, /* Default 1/2 rank for symtab leaf nodes */
{ /* Default 1/2 rank for btree intern nodes */
16, /* Symbol table internal nodes */
32, /* Indexed storage internal nodes */
0, /* unused */
0, /* unused */
0, /* unused */
0, /* unused */
0, /* unused */
0, /* unused */
},
sizeof(hsize_t), /* Default offset size */
sizeof(hsize_t), /* Default length size */
HDF5_BOOTBLOCK_VERSION, /* Current Boot-Block version # */
HDF5_FREESPACE_VERSION, /* Current Free-Space info version # */
HDF5_OBJECTDIR_VERSION, /* Current Object Directory info version # */
HDF5_SHAREDHEADER_VERSION, /* Current Shared-Header format version # */
};
/*
* Define the default file access property list. The template is initialized
* by H5F_init_interface().
*/
H5F_access_t H5F_access_dflt;
/* Default data transfer property list */
const H5F_xfer_t H5F_xfer_dflt = {
1024*1024, /* Temporary buffer size */
NULL, /* Type conversion buffer or NULL */
NULL, /* Background buffer or NULL */
H5T_BKG_NO, /* Type of background buffer needed */
{0.1, 0.5, 0.9}, /* B-tree node splitting ratios */
#ifndef HAVE_PARALLEL
1, /* Cache the hyperslab blocks by default*/
#else
0, /*
* Don't cache the hyperslab blocks by
* default (for parallel)
*/
#endif /* HAVE_PARALLEL */
0, /*
* Default to no upper limit on hyperslab
* block size to cache
*/
H5D_XFER_DFLT, /* Independent data transfer */
};
/*
* Define the default mount property list.
*/
const H5F_mprop_t H5F_mount_dflt = {
FALSE, /* Absolute symlinks are wrt mount root */
};
/* Interface initialization */
static intn interface_initialize_g = 0;
#define INTERFACE_INIT H5F_init_interface
static herr_t H5F_init_interface(void);
/* PRIVATE PROTOTYPES */
static H5F_t *H5F_new(H5F_file_t *shared, const H5F_create_t *fcpl,
const H5F_access_t *fapl);
static herr_t H5F_dest(H5F_t *f);
static herr_t H5F_flush(H5F_t *f, H5F_scope_t scope, hbool_t invalidate);
static herr_t H5F_locate_signature(H5F_low_t *f_handle,
const H5F_access_t *access_parms,
haddr_t *addr/*out*/);
static intn H5F_flush_all_cb(H5F_t *f, const void *_invalidate);
/*-------------------------------------------------------------------------
* Function: H5F_init
*
* Purpose: Initialize the interface from some other layer.
*
* Return: Success: non-negative
*
* Failure: negative
*
* Programmer: Robb Matzke
* Wednesday, December 16, 1998
*
* Modifications:
*
*-------------------------------------------------------------------------
*/
herr_t
H5F_init(void)
{
FUNC_ENTER(H5F_init, FAIL);
/* FUNC_ENTER() does all the work */
FUNC_LEAVE(SUCCEED);
}
/*-------------------------------------------------------------------------
* Function: H5F_init_interface
*
* Purpose: Initialize interface-specific information.
*
* Return: Success: non-negative
*
* Failure: negative
*
* Programmer: Robb Matzke
* Friday, November 20, 1998
*
* Modifications:
* Robb Matzke, 4 Aug 1997
* Changed pablo mask from H5_mask to H5F_mask for the FUNC_LEAVE call.
* It was already H5F_mask for the PABLO_TRACE_ON call.
*
* Kim Yates, 1998-08-16
* Added .disp, .btype, .ftype to H5F_access_t.
*
* Robb Matzke, 1999-02-19
* Added initialization for the H5I_FILE_CLOSING ID group.
*-------------------------------------------------------------------------
*/
static herr_t
H5F_init_interface(void)
{
herr_t ret_value = SUCCEED;
FUNC_ENTER(H5F_init_interface, FAIL);
#ifdef HAVE_PARALLEL
{
/* Allow MPI buf-and-file-type optimizations? */
const char *s = HDgetenv ("HDF5_MPI_1_METAWRITE");
if (s && HDisdigit(*s)) {
H5_mpi_1_metawrite_g = (int)HDstrtol (s, NULL, 0);
}
}
#endif
/*
* Initialize the atom group for the file IDs. There are two groups:
* the H5I_FILE group contains all the ID's for files which are currently
* open at the public API level while the H5I_FILE_CLOSING group contains
* ID's for files for which the application has called H5Fclose() but
* which are pending completion because there are object headers still
* open within the file.
*/
if (H5I_init_group(H5I_FILE, H5I_FILEID_HASHSIZE, 0,
(H5I_free_t)H5F_close)<0 ||
H5I_init_group(H5I_FILE_CLOSING, H5I_FILEID_HASHSIZE, 0,
(H5I_free_t)H5F_close)<0) {
HRETURN_ERROR (H5E_FILE, H5E_CANTINIT, FAIL,
"unable to initialize interface");
}
/* Initialize the default file access property list */
H5F_access_dflt.mdc_nelmts = H5AC_NSLOTS;
H5F_access_dflt.rdcc_nelmts = 521;
H5F_access_dflt.rdcc_nbytes = 1024*1024; /*1MB*/
H5F_access_dflt.rdcc_w0 = 0.75; /*preempt fully read chunks*/
H5F_access_dflt.threshold = 1; /*alignment applies to everything*/
H5F_access_dflt.alignment = 1; /*no alignment*/
H5F_access_dflt.gc_ref = 0; /* Don't garbage-collect references unless user chooses to */
H5F_access_dflt.driver = H5F_LOW_DFLT;
#if (H5F_LOW_DFLT == H5F_LOW_SEC2)
/* Nothing to initialize */
#elif (H5F_LOW_DFLT == H5F_LOW_STDIO)
/* Nothing to initialize */
#elif (H5F_LOW_DFLT == H5F_LOW_CORE)
H5F_access_dflt.u.core.increment = 10*1024;
#elif (H5F_LOW_DFLT == H5F_LOW_MPIO)
H5F_access_dflt.u.mpio.comm = MPI_COMM_SELF;
H5F_access_dflt.u.mpio.info = MPI_INFO_NULL;
H5F_access_dflt.u.mpio.btype = MPI_DATATYPE_NULL;
H5F_access_dflt.u.mpio.ftype = MPI_DATATYPE_NULL;
H5F_addr_reset( &(H5F_access_dflt.u.mpio.disp) );
H5F_access_dflt.u.mpio.use_types = 0;
H5F_access_dflt.u.mpio.old_use_types = 0;
#elif (H5F_LOW_DFLT == H5F_LOW_SPLIT)
# error "H5F_LOW_SPLIT cannot be a default file driver"
#elif (H5F_LOW_DFLT == H5F_LOW_FAMILY)
# error "H5F_LOW_FAMILY cannot be a default file driver"
#else
# error "Unknown default file driver"
#endif
FUNC_LEAVE(ret_value);
}
/*-------------------------------------------------------------------------
* Function: H5F_term_interface
*
* Purpose: Terminate this interface: free all memory and reset global
* variables to their initial values. Release all ID groups
* associated with this interface.
*
* Return: Success: Positive if anything was done that might
* have affected other interfaces; zero
* otherwise.
*
* Failure: Never fails.
*
* Programmer: Robb Matzke
* Friday, February 19, 1999
*
* Modifications:
*
*-------------------------------------------------------------------------
*/
intn
H5F_term_interface(void)
{
intn n = 0;
if (interface_initialize_g) {
if ((n=H5I_nmembers(H5I_FILE))) {
H5F_close_all();
} else if (0==(n=H5I_nmembers(H5I_FILE_CLOSING))) {
H5I_destroy_group(H5I_FILE);
H5I_destroy_group(H5I_FILE_CLOSING);
interface_initialize_g = 0;
n = 1; /*H5I*/
}
}
return n;
}
/*-------------------------------------------------------------------------
* Function: H5F_flush_all_cb
*
* Purpose: Callback function for H5F_flush_all().
*
* Return: Always returns zero.
*
* Programmer: Robb Matzke
* Friday, February 19, 1999
*
* Modifications:
*
*-------------------------------------------------------------------------
*/
static intn
H5F_flush_all_cb(H5F_t *f, const void *_invalidate)
{
hbool_t invalidate = *((const hbool_t*)_invalidate);
H5F_flush(f, H5F_SCOPE_LOCAL, invalidate);
return 0;
}
/*-------------------------------------------------------------------------
* Function: H5F_flush_all
*
* Purpose: Flush all open files. If INVALIDATE is true then also remove
* everything from the cache.
*
* Return: Success: Non-negative
*
* Failure: Negative
*
* Programmer: Robb Matzke
* Thursday, February 18, 1999
*
* Modifications:
*
*-------------------------------------------------------------------------
*/
herr_t
H5F_flush_all(hbool_t invalidate)
{
FUNC_ENTER(H5F_flush_all, FAIL);
H5I_search(H5I_FILE, (H5I_search_func_t)H5F_flush_all_cb,
(void*)&invalidate);
FUNC_LEAVE(SUCCEED);
}
/*-------------------------------------------------------------------------
* Function: H5F_close_all
*
* Purpose: Close all open files. Any file which has open object headers
* will be moved from the H5I_FILE group to the H5I_FILE_CLOSING
* group.
*
* Return: Success: Non-negative
*
* Failure: Negative
*
* Programmer: Robb Matzke
* Friday, February 19, 1999
*
* Modifications:
*
*-------------------------------------------------------------------------
*/
herr_t
H5F_close_all(void)
{
FUNC_ENTER(H5F_close_all, FAIL);
if (H5I_clear_group(H5I_FILE, FALSE)<0) {
HRETURN_ERROR(H5E_FILE, H5E_CLOSEERROR, FAIL,
"unable to close one or more files");
}
FUNC_LEAVE(SUCCEED);
}
/*--------------------------------------------------------------------------
NAME
H5F_encode_length_unusual -- encode an unusual length size
USAGE
void H5F_encode_length_unusual(f, p, l)
const H5F_t *f; IN: pointer to the file record
uint8_t **p; IN: pointer to buffer pointer to encode length in
uint8_t *l; IN: pointer to length to encode
ERRORS
RETURNS
none
DESCRIPTION
Encode non-standard (i.e. not 2, 4 or 8-byte) lengths in file meta-data.
--------------------------------------------------------------------------*/
void
H5F_encode_length_unusual(const H5F_t *f, uint8_t **p, uint8_t *l)
{
intn i = (intn)H5F_SIZEOF_SIZE(f)-1;
#ifdef WORDS_BIGENDIAN
/*
* For non-little-endian platforms, encode each byte in memory backwards.
*/
for (/*void*/; i>=0; i--, (*p)++)*(*p) = *(l+i);
#else
/* platform has little-endian integers */
HDmemcpy(*p,l,(size_t)(i+1));
*p+=(i+1);
#endif
}
/*-------------------------------------------------------------------------
* Function: H5Fget_create_plist
*
* Purpose: Get an atom for a copy of the file-creation property list for
* this file. This function returns an atom with a copy of the
* properties used to create a file.
*
* Return: Success: template ID
*
* Failure: FAIL
*
* Programmer: Unknown
*
* Modifications:
*
* Robb Matzke, 18 Feb 1998
* Calls H5P_copy() to copy the property list and H5P_close() to free
* that property list if an error occurs.
*
*-------------------------------------------------------------------------
*/
hid_t
H5Fget_create_plist(hid_t file_id)
{
H5F_t *file = NULL;
hid_t ret_value = FAIL;
H5F_create_t *plist = NULL;
FUNC_ENTER(H5Fget_create_plist, FAIL);
H5TRACE1("i","i",file_id);
/* check args */
if (H5I_FILE!=H5I_get_type(file_id) || NULL==(file=H5I_object(file_id))) {
HRETURN_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL, "not a file");
}
/* Create the property list object to return */
if (NULL==(plist=H5P_copy(H5P_FILE_CREATE, file->shared->create_parms))) {
HRETURN_ERROR(H5E_INTERNAL, H5E_CANTINIT, FAIL,
"unable to copy file creation properties");
}
/* Create an atom */
if ((ret_value = H5P_create(H5P_FILE_CREATE, plist)) < 0) {
H5P_close(H5P_FILE_CREATE, plist);
HRETURN_ERROR(H5E_ATOM, H5E_CANTREGISTER, FAIL,
"unable to register property list");
}
FUNC_LEAVE(ret_value);
}
/*-------------------------------------------------------------------------
* Function: H5Fget_access_plist
*
* Purpose: Returns a copy of the file access property list of the
* specified file.
*
* Return: Success: Object ID for a copy of the file access
* property list.
*
* Failure: FAIL
*
* Programmer: Robb Matzke
* Wednesday, February 18, 1998
*
* Modifications:
*
*-------------------------------------------------------------------------
*/
hid_t
H5Fget_access_plist(hid_t file_id)
{
H5F_t *f = NULL;
H5F_access_t *plist = NULL;
hid_t ret_value = FAIL;
FUNC_ENTER(H5Fget_access_plist, FAIL);
H5TRACE1("i","i",file_id);
/* Check args */
if (H5I_FILE!=H5I_get_type(file_id) || NULL==(f=H5I_object(file_id))) {
HRETURN_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL, "not a file");
}
/* Create the property list object to return */
if (NULL==(plist=H5P_copy(H5P_FILE_ACCESS, f->shared->access_parms))) {
HRETURN_ERROR(H5E_INTERNAL, H5E_CANTINIT, FAIL,
"unable to copy file access properties");
}
/* Create an atom */
if ((ret_value = H5P_create(H5P_FILE_ACCESS, plist))<0) {
H5P_close(H5P_FILE_ACCESS, plist);
HRETURN_ERROR(H5E_ATOM, H5E_CANTREGISTER, FAIL,
"unable to register property list");
}
FUNC_LEAVE(ret_value);
}
/*--------------------------------------------------------------------------
NAME
H5F_compare_files -- compare file objects for the atom API
USAGE
intn HPcompare_filename(obj, key)
const void * obj; IN: pointer to the file record
const void * key; IN: pointer to the search key
ERRORS
RETURNS
TRUE if the key matches the obj, FALSE otherwise
DESCRIPTION
Look inside the file record for the atom API and compare the the
keys.
--------------------------------------------------------------------------*/
static intn
H5F_compare_files(void * _obj, const void * _key)
{
const H5F_t *obj = (const H5F_t *) _obj;
const H5F_search_t *key = (const H5F_search_t *) _key;
int ret_value = FALSE;
FUNC_ENTER(H5F_compare_files, FALSE);
#if WIN32
ret_value = (obj->shared->key.dev == key->dev &&
obj->shared->key.fileindexhi == key->fileindexhi &&
obj->shared->key.fileindexlo == key->fileindexlo);
#else
ret_value = (obj->shared->key.dev == key->dev &&
obj->shared->key.ino == key->ino);
#endif
FUNC_LEAVE(ret_value);
}
/*-------------------------------------------------------------------------
* Function: H5F_locate_signature
*
* Purpose: Finds the HDF5 boot block signature in a file. The signature
* can appear at address 0, or any power of two beginning with
* 512.
*
* Return: Success: SUCCEED. The address of the signature is
* returned through the ADDR argument.
*
* Failure: FAIL
*
* Programmer: Robb Matzke
* Friday, November 7, 1997
*
* Modifications:
*
*-------------------------------------------------------------------------
*/
static herr_t
H5F_locate_signature(H5F_low_t *f_handle, const H5F_access_t *access_parms,
haddr_t *addr/*out*/)
{
herr_t ret_value=FAIL;
haddr_t max_addr;
uint8_t buf[H5F_SIGNATURE_LEN];
uintn n = 9;
FUNC_ENTER(H5F_locate_signature, FAIL);
H5F_low_size(f_handle, &max_addr);
H5F_addr_reset(addr);
while (H5F_addr_lt(addr, &max_addr)) {
if (H5F_low_read(f_handle, access_parms, &H5F_xfer_dflt, addr,
H5F_SIGNATURE_LEN, buf) < 0) {
HRETURN_ERROR(H5E_IO, H5E_READERROR, FAIL, "unable to read file");
}
if (!HDmemcmp(buf, H5F_SIGNATURE, H5F_SIGNATURE_LEN)) {
ret_value=SUCCEED;
break;
}
H5F_addr_pow2(n++, addr);
}
FUNC_LEAVE(ret_value);
}
/*--------------------------------------------------------------------------
NAME
H5Fis_hdf5
PURPOSE
Check the file signature to detect an HDF5 file.
USAGE
htri_t H5Fis_hdf5(filename)
const char *filename; IN: Name of the file to check
ERRORS
ARGS BADRANGE No filename specified.
FILE BADFILE Low-level file open failure.
IO READERROR Read error.
IO READERROR Seek error.
IO SEEKERROR Unable to determine length of file due to seek
failure.
RETURNS
TRUE/FALSE/FAIL
DESCRIPTION
This function determines if a file is an HDF5 format file.
--------------------------------------------------------------------------*/
htri_t
H5Fis_hdf5(const char *filename)
{
H5F_low_t *f_handle = NULL; /* file handle */
haddr_t addr; /* Address of file signature & header */
hbool_t ret_value = FALSE;
const H5F_low_class_t *type = NULL;
FUNC_ENTER(H5Fis_hdf5, FAIL);
H5TRACE1("b","s",filename);
/* Check args and all the boring stuff. */
if (filename == NULL) {
HGOTO_ERROR(H5E_ARGS, H5E_BADRANGE, FAIL, "no filename specified");
}
/* Open the file at the low level driver */
type = H5F_low_class (H5F_access_dflt.driver);
assert (type);
if (NULL == (f_handle = H5F_low_open(type, filename, &H5F_access_dflt,
0, NULL))) {
HGOTO_ERROR(H5E_FILE, H5E_BADFILE, FAIL,
"low-level file open failure");
}
if (H5F_locate_signature(f_handle, &H5F_access_dflt, &addr) >= 0) {
ret_value = TRUE;
}
done:
if (f_handle) {
H5F_low_close(f_handle, &H5F_access_dflt); /*close the file we opened*/
}
FUNC_LEAVE(ret_value);
}
/*-------------------------------------------------------------------------
* Function: H5F_new
*
* Purpose: Creates a new file object and initializes it. The
* H5Fopen and H5Fcreate functions then fill in various
* fields. If SHARED is a non-null pointer then the shared info
* to which it points has the reference count incremented.
* Otherwise a new, empty shared info struct is created and
* initialized with the specified file access property list.
*
* Errors:
*
* Return: Success: Ptr to a new file struct.
*
* Failure: NULL
*
* Programmer: Robb Matzke
* matzke@llnl.gov
* Jul 18 1997
*
* Modifications:
*
*-------------------------------------------------------------------------
*/
static H5F_t *
H5F_new(H5F_file_t *shared, const H5F_create_t *fcpl, const H5F_access_t *fapl)
{
H5F_t *f=NULL, *ret_value=NULL;
intn n;
FUNC_ENTER(H5F_new, NULL);
if (NULL==(f = H5MM_calloc(sizeof(H5F_t)))) {
HGOTO_ERROR (H5E_RESOURCE, H5E_NOSPACE, NULL,
"memory allocation failed");
}
if (shared) {
f->shared = shared;
} else {
f->shared = H5MM_calloc(sizeof(H5F_file_t));
H5F_addr_undef(&(f->shared->boot_addr));
H5F_addr_undef(&(f->shared->base_addr));
H5F_addr_undef(&(f->shared->freespace_addr));
H5F_addr_undef(&(f->shared->hdf5_eof));
/*
* Deep-copy the file creation and file access property lists into the
* new file handle. We do this early because some values might need
* to change as the file is being opened.
*/
if (NULL==(f->shared->create_parms=H5P_copy(H5P_FILE_CREATE, fcpl))) {
HRETURN_ERROR (H5E_FILE, H5E_CANTINIT, NULL,
"unable to copy file creation property list");
}
if (NULL==(f->shared->access_parms=H5P_copy(H5P_FILE_ACCESS, fapl))) {
HRETURN_ERROR (H5E_FILE, H5E_CANTINIT, NULL,
"unable to copy file access property list");
}
#ifdef HAVE_PARALLEL
/*
* Disable cache if file is open using MPIO driver. Parallel
* does not permit caching. (maybe able to relax it for
* read only open.)
*/
if (f->shared->access_parms->driver==H5F_LOW_MPIO){
f->shared->access_parms->rdcc_nbytes = 0;
f->shared->access_parms->mdc_nelmts = 0;
}
#endif
/*
* Create a meta data cache with the specified number of elements.
* The cache might be created with a different number of elements and
* the access property list should be updated to reflect that.
*/
if ((n=H5AC_create(f, f->shared->access_parms->mdc_nelmts))<0) {
HRETURN_ERROR (H5E_FILE, H5E_CANTINIT, NULL,
"unable to create meta data cache");
}
f->shared->access_parms->mdc_nelmts = n;
/* Create the chunk cache */
H5F_istore_init (f);
}
f->shared->nrefs++;
f->nrefs = 1;
ret_value = f;
done:
if (!ret_value && f) {
if (!shared) H5MM_xfree (f->shared);
H5MM_xfree (f);
}
FUNC_LEAVE(ret_value);
}
/*-------------------------------------------------------------------------
* Function: H5F_dest
*
* Purpose: Destroys a file structure. This function flushes the cache
* but doesn't do any other cleanup other than freeing memory
* for the file struct. The shared info for the file is freed
* only when its reference count reaches zero.
*
* Return: Non-negative on success/Negative on failure
*
* Programmer: Robb Matzke
* matzke@llnl.gov
* Jul 18 1997
*
* Modifications:
*
* Robb Matzke, 1998-10-14
* Nothing happens unless the reference count for the H5F_t goes to
* zero. The reference counts are decremented here.
*
* Robb Matzke, 1999-02-19
* More careful about decrementing reference counts so they don't go
* negative or wrap around to some huge value. Nothing happens if a
* reference count is already zero.
*
*-------------------------------------------------------------------------
*/
static herr_t
H5F_dest(H5F_t *f)
{
herr_t ret_value = SUCCEED;
FUNC_ENTER(H5F_dest, FAIL);
if (f && 1==f->nrefs) {
if (1==f->shared->nrefs) {
/*
* Do not close the root group since we didn't count it, but free
* the memory associated with it.
*/
H5MM_xfree (f->shared->root_grp);
f->shared->root_grp=NULL;
if (H5AC_dest(f)) {
HERROR (H5E_FILE, H5E_CANTINIT, "problems closing file");
ret_value = FAIL; /*but keep going*/
}
if (H5F_istore_dest (f)<0) {
HERROR (H5E_FILE, H5E_CANTINIT, "problems closing file");
ret_value = FAIL; /*but keep going*/
}
f->shared->cwfs = H5MM_xfree (f->shared->cwfs);
H5P_close (H5P_FILE_CREATE, f->shared->create_parms);
H5P_close (H5P_FILE_ACCESS, f->shared->access_parms);
f->shared = H5MM_xfree(f->shared);
} else if (f->shared->nrefs>0) {
/*
* There are other references to the shared part of the file.
* Only decrement the reference count.
*/
--f->shared->nrefs;
}
/* Free the non-shared part of the file */
f->name = H5MM_xfree(f->name);
f->mtab.child = H5MM_xfree(f->mtab.child);
f->mtab.nalloc = 0;
H5MM_xfree(f);
} else if (f->nrefs>0) {
/*
* There are other references to this file. Only decrement the
* reference count.
*/
--f->nrefs;
}
FUNC_LEAVE(ret_value);
}
/*-------------------------------------------------------------------------
* Function: H5F_open
*
* Purpose: Opens (or creates) a file. This function understands the
* following flags which are similar in nature to the Posix
* open(2) flags.
*
* H5F_ACC_RDWR: Open with read/write access. If the file is
* currently open for read-only access then it
* will be reopened. Absence of this flag
* implies read-only access.
*
* H5F_ACC_CREAT: Create a new file if it doesn't exist yet.
* The permissions are 0666 bit-wise AND with
* the current umask. H5F_ACC_WRITE must also
* be specified.
*
* H5F_ACC_EXCL: This flag causes H5F_open() to fail if the
* file already exists.
*
* H5F_ACC_TRUNC: The file is truncated and a new HDF5 boot
* block is written. This operation will fail
* if the file is already open.
*
* Unlinking the file name from the group directed graph while
* the file is opened causes the file to continue to exist but
* one will not be able to upgrade the file from read-only
* access to read-write access by reopening it. Disk resources
* for the file are released when all handles to the file are
* closed. NOTE: This paragraph probably only applies to Unix;
* deleting the file name in other OS's has undefined results.
*
* The CREATE_PARMS argument is optional. A null pointer will
* cause the default file creation parameters to be used.
*
* The ACCESS_PARMS argument is optional. A null pointer will
* cause the default file access parameters to be used.
*
* Errors:
* ATOM BADATOM Can't unatomize default template
* id.
* FILE BADVALUE Can't create file without write
* intent.
* FILE BADVALUE Can't truncate without write intent.
* FILE CANTCREATE Can't create file.
* FILE CANTCREATE Can't truncate file.
* FILE CANTINIT Can't get default file create template
* id.
* FILE CANTINIT Can't write file boot block.
* FILE CANTOPENFILE Bad address size.
* FILE CANTOPENFILE Bad boot block version number.
* FILE CANTOPENFILE Bad free space version number.
* FILE CANTOPENFILE Bad length size.
* FILE CANTOPENFILE Bad object dir version number.
* FILE CANTOPENFILE Bad shared header version number.
* FILE CANTOPENFILE Bad small object heap version number.
* FILE CANTOPENFILE Bad symbol table internal node 1/2
* rank.
* FILE CANTOPENFILE Bad symbol table leaf node 1/2 rank.
* FILE CANTOPENFILE Can't read root symbol entry.
* FILE CANTOPENFILE Cannot open existing file.
* FILE CANTOPENFILE File cannot be reopened with write
* access.
* FILE CANTOPENFILE File does not exist.
* FILE CANTOPENFILE Invalid file family name.
* FILE FILEEXISTS File already exists - CREAT EXCL
* failed.
* FILE FILEOPEN File already open - TRUNC failed.
* FILE NOTHDF5 Can't find signature.
* FILE NOTHDF5 Can't read boot block.
* FILE READERROR File is not readable.
* FILE TRUNCATED Truncated file?
* FILE WRITEERROR File is not writable.
* IO READERROR Can't read boot block.
*
* Return: Success: Ptr to the file pointer.
*
* Failure: NULL
*
* Programmer: Robb Matzke
* Tuesday, September 23, 1997
*
* Modifications:
*
* Robb Matzke, 11 Nov 1997
* If the name contains the pattern /[^%]%\d*[duxX]/ then the file is
* assumed to be a family of files. The TYPE argument is ignored and
* H5F_LOW_FAM is used instead.
*
* Albert Cheng, 5 Feb 1998
* Added the access_parms argument to pass down access template
* information.
*
* Robb Matzke, 18 Feb 1998
* The H5F_access_t changed to allow more generality. The low level
* driver is part of the file access template so the TYPE argument has
* been removed.
*
*-------------------------------------------------------------------------
*/
H5F_t *
H5F_open(const char *name, uintn flags,
const H5F_create_t *create_parms, const H5F_access_t *access_parms)
{
H5F_t *f = NULL; /*return value */
H5F_t *ret_value = NULL; /*a copy of `f' */
H5F_t *old = NULL; /*a file already opened */
H5F_search_t search; /*file search key */
H5F_low_t *fd = NULL; /*low level file desc */
hbool_t empty_file = FALSE; /*is file empty? */
hbool_t file_exists = FALSE; /*file already exists */
uint8_t buf[256]; /*I/O buffer.. */
const uint8_t *p = NULL; /* ..and pointer into it */
size_t fixed_size = 24; /*size of fixed part of boot blk*/
size_t variable_size; /*variable part of boot block */
H5F_create_t *cp = NULL; /*file creation parameters */
haddr_t addr1, addr2; /*temporary address */
H5G_entry_t root_ent; /*root symbol table entry */
const H5F_low_class_t *type = NULL; /*low-level file driver */
haddr_t reserved_addr; /*reserved address */
FUNC_ENTER(H5F_open, NULL);
assert(name && *name);
/*
* If no file creation parameters or file access parameters are supplied
* then use defaults.
*/
if (!create_parms) create_parms = &H5F_create_dflt;
if (!access_parms) access_parms = &H5F_access_dflt;
/*
* Does the file exist? If so, get the device and i-node values so we can
* compare them with other files already open. On Unix (and other systems
* with hard or soft links) it doesn't work to compare files based only on
* their full path name.
*/
type = H5F_low_class (access_parms->driver);
assert (type);
file_exists = H5F_low_access(type, name, access_parms, F_OK, &search);
/*
* Open the low-level file (if necessary) and create an H5F_t struct that
* points to an H5F_file_t struct.
*/
if (file_exists) {
if (flags & H5F_ACC_EXCL) {
HRETURN_ERROR(H5E_FILE, H5E_FILEEXISTS, NULL,
"file already exists - CREAT EXCL failed");
}
if (!H5F_low_access(type, name, access_parms, R_OK, NULL)) {
HRETURN_ERROR(H5E_FILE, H5E_READERROR, NULL,
"file is not readable");
}
if ((flags & H5F_ACC_RDWR) &&
!H5F_low_access(type, name, access_parms, W_OK, NULL)) {
HRETURN_ERROR(H5E_FILE, H5E_WRITEERROR, NULL,
"file is not writable");
}
if ((old = H5I_search(H5I_FILE, H5F_compare_files, &search)) ||
(old = H5I_search(H5I_FILE_CLOSING, H5F_compare_files, &search))) {
if (flags & H5F_ACC_TRUNC) {
HRETURN_ERROR(H5E_FILE, H5E_FILEOPEN, NULL,
"file already open - TRUNC failed");
}
if ((flags & H5F_ACC_RDWR) &&
0 == (old->shared->flags & H5F_ACC_RDWR)) {
if (NULL==(fd=H5F_low_open(type, name, access_parms,
H5F_ACC_RDWR, NULL))) {
HRETURN_ERROR(H5E_FILE, H5E_CANTOPENFILE, NULL,
"file cannot be reopened with write access");
}
H5F_low_close(old->shared->lf, access_parms);
old->shared->lf = fd;
old->shared->flags |= H5F_ACC_RDWR;
fd = NULL; /*so we don't close it during error */
}
f = H5F_new(old->shared, NULL, NULL);
} else if (flags & H5F_ACC_TRUNC) {
/* Truncate existing file */
if (0 == (flags & H5F_ACC_RDWR)) {
HRETURN_ERROR(H5E_FILE, H5E_BADVALUE, NULL,
"unable to truncate without write intent");
}
fd = H5F_low_open(type, name, access_parms,
H5F_ACC_RDWR | H5F_ACC_TRUNC, NULL);
if (!fd) {
HRETURN_ERROR(H5E_FILE, H5E_CANTCREATE, NULL,
"unable to truncate file");
}
f = H5F_new(NULL, create_parms, access_parms);
f->shared->key = search;
f->shared->flags = flags;
f->shared->lf = fd;
empty_file = TRUE;
} else {
fd = H5F_low_open(type, name, access_parms,
(flags & H5F_ACC_RDWR), NULL);
if (!fd) {
HRETURN_ERROR(H5E_FILE, H5E_CANTOPENFILE, NULL,
"cannot open existing file");
}
f = H5F_new(NULL, create_parms, access_parms);
f->shared->key = search;
f->shared->flags = flags;
f->shared->lf = fd;
}
} else if (flags & H5F_ACC_CREAT) {
if (0 == (flags & H5F_ACC_RDWR)) {
HRETURN_ERROR(H5E_FILE, H5E_BADVALUE, NULL,
"unable to create file without write intent");
}
#ifdef HAVE_PARALLEL
/*
* ROMIO cannot handle file-open with EXCL Create due to racing
* problem. The first process creates the file which then fails all
* other processes. Turn on TRUNC bit here. It does not matter since
* the file does not exist at this point.
*/
fd = H5F_low_open(type, name, access_parms,
H5F_ACC_RDWR | H5F_ACC_CREAT |
(flags & H5F_ACC_TRUNC),
&search);
#else
fd = H5F_low_open(type, name, access_parms,
H5F_ACC_RDWR | H5F_ACC_CREAT |
(flags & H5F_ACC_EXCL) | (flags & H5F_ACC_TRUNC),
&search);
#endif /*HAVE_PARALLEL*/
if (!fd) {
HRETURN_ERROR(H5E_FILE, H5E_CANTCREATE, NULL,
"unable to create file");
}
f = H5F_new(NULL, create_parms, access_parms);
f->shared->key = search;
f->shared->flags = flags;
f->shared->lf = fd;
empty_file = TRUE;
} else {
HRETURN_ERROR(H5E_FILE, H5E_CANTOPENFILE, NULL,
"file does not exist");
}
assert(f);
/*
* The intent at the top level file struct are not necessarily the same as
* the flags at the bottom. The top level describes how the file can be
* accessed through the HDF5 library. The bottom level describes how the
* file can be accessed through the C library.
*/
f->intent = flags;
f->name = H5MM_xstrdup(name);
/*
* Some of the properties may need to be updated. We would like to
* eventually get rid of this step by not having redundant data!
*/
if (1 == f->shared->nrefs) {
if (H5F_LOW_FAMILY==f->shared->access_parms->driver) {
haddr_t x = f->shared->lf->u.fam.memb_size;
f->shared->access_parms->u.fam.memb_size = x;
}
}
cp = f->shared->create_parms;
/*
* Read or write the file boot block.
*/
if (empty_file) {
/*
* For new files we must write the boot block. The boot block starts
* immediately after the user-defined header, which we have already
* insured is a proper size. The base address is set to the same thing
* as the boot block.
*/
H5F_addr_reset(&(f->shared->boot_addr));
H5F_addr_inc(&(f->shared->boot_addr),
f->shared->create_parms->userblock_size);
f->shared->base_addr = f->shared->boot_addr;
f->shared->consist_flags = 0x03;
if (H5F_flush(f, H5F_SCOPE_LOCAL, FALSE) < 0) {
HGOTO_ERROR(H5E_FILE, H5E_CANTINIT, NULL,
"unable to write file boot block");
}
} else if (1 == f->shared->nrefs) {
/* For existing files we must read the boot block. */
if (H5F_locate_signature(f->shared->lf,
f->shared->access_parms,
&(f->shared->boot_addr)) < 0) {
HGOTO_ERROR(H5E_FILE, H5E_NOTHDF5, NULL,
"unable to find signature");
}
if (H5F_low_read(f->shared->lf, access_parms, &H5F_xfer_dflt,
&(f->shared->boot_addr), fixed_size, buf) < 0) {
HGOTO_ERROR(H5E_IO, H5E_READERROR, NULL,
"unable to read boot block");
}
/*
* Decode the fixed size part of the boot block. For each of the
* version parameters, check that the library is able to handle that
* version.
*/
p = buf + H5F_SIGNATURE_LEN; /*already checked */
cp->bootblock_ver = *p++;
if (cp->bootblock_ver != HDF5_BOOTBLOCK_VERSION) {
HGOTO_ERROR(H5E_FILE, H5E_CANTOPENFILE, NULL,
"bad boot block version number");
}
cp->freespace_ver = *p++;
if (cp->freespace_ver != HDF5_FREESPACE_VERSION) {
HGOTO_ERROR(H5E_FILE, H5E_CANTOPENFILE, NULL,
"bad free space version number");
}
cp->objectdir_ver = *p++;
if (cp->objectdir_ver != HDF5_OBJECTDIR_VERSION) {
HGOTO_ERROR(H5E_FILE, H5E_CANTOPENFILE, NULL,
"bad object dir version number");
}
p++; /*reserved*/
cp->sharedheader_ver = *p++;
if (cp->sharedheader_ver != HDF5_SHAREDHEADER_VERSION) {
HGOTO_ERROR(H5E_FILE, H5E_CANTOPENFILE, NULL,
"bad shared header version number");
}
cp->sizeof_addr = *p++;
if (cp->sizeof_addr != 2 &&
cp->sizeof_addr != 4 &&
cp->sizeof_addr != 8 &&
cp->sizeof_addr != 16 &&
cp->sizeof_addr != 32) {
HGOTO_ERROR(H5E_FILE, H5E_CANTOPENFILE, NULL,
"bad address size");
}
cp->sizeof_size = *p++;
if (cp->sizeof_size != 2 &&
cp->sizeof_size != 4 &&
cp->sizeof_size != 8 &&
cp->sizeof_size != 16 &&
cp->sizeof_size != 32) {
HGOTO_ERROR(H5E_FILE, H5E_CANTOPENFILE, NULL,
"bad length size");
}
/* Reserved byte */
p++;
UINT16DECODE(p, cp->sym_leaf_k);
if (cp->sym_leaf_k < 1) {
HGOTO_ERROR(H5E_FILE, H5E_CANTOPENFILE, NULL,
"bad symbol table leaf node 1/2 rank");
}
UINT16DECODE(p, cp->btree_k[H5B_SNODE_ID]);
if (cp->btree_k[H5B_SNODE_ID] < 1) {
HGOTO_ERROR(H5E_FILE, H5E_CANTOPENFILE, NULL,
"bad symbol table internal node 1/2 rank");
}
UINT32DECODE(p, f->shared->consist_flags);
/* nothing to check for consistency flags */
assert((size_t)(p-buf) == fixed_size);
/* Read the variable length part of the boot block... */
variable_size = H5F_SIZEOF_ADDR(f) + /*base address */
H5F_SIZEOF_ADDR(f) + /*global free list addr */
H5F_SIZEOF_ADDR(f) + /*logical file size */
H5F_SIZEOF_ADDR(f) + /*reserved address*/
H5G_SIZEOF_ENTRY(f);
assert(variable_size <= sizeof buf);
addr1 = f->shared->boot_addr;
H5F_addr_inc(&addr1, (hsize_t)fixed_size);
if (H5F_low_read(f->shared->lf, access_parms, &H5F_xfer_dflt,
&addr1, variable_size, buf) < 0) {
HGOTO_ERROR(H5E_FILE, H5E_NOTHDF5, NULL,
"unable to read boot block");
}
p = buf;
H5F_addr_decode(f, &p, &(f->shared->base_addr));
H5F_addr_decode(f, &p, &(f->shared->freespace_addr));
H5F_addr_decode(f, &p, &(f->shared->hdf5_eof));
H5F_addr_decode(f, &p, &reserved_addr);
if (H5G_ent_decode(f, &p, &root_ent) < 0) {
HGOTO_ERROR(H5E_FILE, H5E_CANTOPENFILE, NULL,
"unable to read root symbol entry");
}
if (H5G_mkroot (f, &root_ent)<0) {
HGOTO_ERROR (H5E_FILE, H5E_CANTOPENFILE, NULL,
"unable to read root group");
}
/*
* The userdefined data is the area of the file before the base
* address.
*/
f->shared->create_parms->userblock_size = f->shared->base_addr.offset;
}
/*
* What is the current size of the file? The max_addr field is a relative
* address while H5F_low_size() returns an absolute address.
*/
H5F_low_size(f->shared->lf, &addr1);
addr2 = f->shared->hdf5_eof;
H5F_addr_add(&addr2, &(f->shared->base_addr));
if (H5F_addr_lt(&addr1, &addr2)) {
/*
* Truncated file? This might happen if one tries to open the first
* member of a file family.
*/
HGOTO_ERROR(H5E_FILE, H5E_TRUNCATED, NULL, "truncated file");
} else if (H5F_addr_gt(&addr1, &addr2)) {
/*
* The file is larger than the hdf5 data. It either has extra junk at
* the end, or a wrapper. In either case, make the file think it's
* shorter so when we allocate memory from the file for hdf5 it's
* allocated immediately after the end of the previous hdf5 data. This
* will cause internal wrappers to be overwritten if they follow the
* hdf5 data.
*/
#ifdef H5F_DEBUG
if (H5DEBUG(F)) {
HDfprintf(H5DEBUG(F), "H5F: resetting EOF from %a to %a (abs)\n",
&addr1, &addr2);
}
#endif
H5F_low_seteof(f->shared->lf, &addr2);
}
/* Create and/or open the root group if we haven't already done so */
if (H5G_mkroot (f, NULL)<0) {
HGOTO_ERROR (H5E_FILE, H5E_CANTINIT, NULL,
"unable to create/open root group");
}
/* Success! */
ret_value = f;
done:
if (!ret_value) {
if (f) H5F_dest(f);
H5F_low_close(fd, access_parms);
}
FUNC_LEAVE(ret_value);
}
/*-------------------------------------------------------------------------
* Function: H5Fcreate
*
* Purpose: This is the primary function for creating HDF5 files . The
* flags parameter determines whether an existing file will be
* overwritten or not. All newly created files are opened for
* both reading and writing. All flags may be combined with the
* bit-wise OR operator (`|') to change the behavior of the file
* create call.
*
* The more complex behaviors of a file's creation and access
* are controlled through the file-creation and file-access
* property lists. The value of H5P_DEFAULT for a template
* value indicates that the library should use the default
* values for the appropriate template.
*
* See also: H5Fpublic.h for the list of supported flags. H5Ppublic.h for
* the list of file creation and file access properties.
*
* Return: Success: A file ID
*
* Failure: FAIL
*
* Programmer: Unknown
*
* Modifications:
*
* Robb Matzke, 18 Jul 1997
* File struct creation and destruction is through H5F_new() and
* H5F_dest(). Writing the root symbol table entry is done with
* H5G_encode().
*
* Robb Matzke, 29 Aug 1997
* Moved creation of the boot block to H5F_flush().
*
* Robb Matzke, 23 Sep 1997
* Most of the work is now done by H5F_open() since H5Fcreate() and
* H5Fopen() originally contained almost identical code.
*
* Robb Matzke, 18 Feb 1998
* Better error checking for the creation and access property lists. It
* used to be possible to swap the two and core the library. Also, zero
* is no longer valid as a default property list; one must use
* H5P_DEFAULT instead.
*
*-------------------------------------------------------------------------
*/
hid_t
H5Fcreate(const char *filename, unsigned flags, hid_t create_id,
hid_t access_id)
{
H5F_t *new_file = NULL; /* file struct for new file */
const H5F_create_t *create_parms; /* pointer to the parameters to
* use when creating the file
*/
const H5F_access_t *access_parms; /* pointer to the file access
* parameters to use when
* creating the file
*/
hid_t ret_value = FAIL;
FUNC_ENTER(H5Fcreate, FAIL);
H5TRACE4("i","sIuii",filename,flags,create_id,access_id);
/* Check/fix arguments */
if (!filename || !*filename) {
HGOTO_ERROR(H5E_ARGS, H5E_BADVALUE, FAIL, "invalid file name");
}
if (flags & ~(H5F_ACC_EXCL|H5F_ACC_TRUNC|H5F_ACC_DEBUG)) {
HGOTO_ERROR(H5E_ARGS, H5E_BADVALUE, FAIL, "invalid flags");
}
if ((flags & H5F_ACC_EXCL) && (flags & H5F_ACC_TRUNC)) {
HGOTO_ERROR (H5E_ARGS, H5E_BADVALUE, FAIL,
"mutually exclusive flags for file creation");
}
if (H5P_DEFAULT==create_id) {
create_parms = &H5F_create_dflt;
} else if (H5P_FILE_CREATE!=H5P_get_class (create_id) ||
NULL == (create_parms = H5I_object(create_id))) {
HGOTO_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL,
"not a file creation property list");
}
if (H5P_DEFAULT==access_id) {
access_parms = &H5F_access_dflt;
} else if (H5P_FILE_ACCESS!=H5P_get_class (access_id) ||
NULL == (access_parms = H5I_object(access_id))) {
HGOTO_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL,
"not a file access property list");
}
/*
* Adjust bit flags by turning on the creation bit and making sure that
* the EXCL or TRUNC bit is set. All newly-created files are opened for
* reading and writing.
*/
if (0==(flags & (H5F_ACC_EXCL|H5F_ACC_TRUNC))) {
flags |= H5F_ACC_EXCL; /*default*/
}
flags |= H5F_ACC_RDWR | H5F_ACC_CREAT;
/*
* Create a new file or truncate an existing file.
*/
if (NULL == (new_file = H5F_open(filename, flags, create_parms,
access_parms))) {
HGOTO_ERROR(H5E_FILE, H5E_CANTOPENFILE, FAIL, "unable to create file");
}
/* Get an atom for the file */
if ((ret_value = H5I_register(H5I_FILE, new_file)) < 0) {
HGOTO_ERROR(H5E_ATOM, H5E_CANTREGISTER, FAIL,
"unable to atomize file");
}
done:
if (ret_value < 0 && new_file) {
/* Error condition cleanup */
H5F_close(new_file);
}
FUNC_LEAVE(ret_value);
}
/*-------------------------------------------------------------------------
* Function: H5Fopen
*
* Purpose: This is the primary function for accessing existing HDF5
* files. The FLAGS argument determines whether writing to an
* existing file will be allowed or not. All flags may be
* combined with the bit-wise OR operator (`|') to change the
* behavior of the file open call. The more complex behaviors
* of a file's access are controlled through the file-access
* property list.
*
* See Also: H5Fpublic.h for a list of possible values for FLAGS.
*
* Return: Success: A file ID
*
* Failure: FAIL
*
* Programmer: Unknown
*
* Modifications:
*
* Robb Matzke, 18 Jul 1997
* File struct creation and destruction is through H5F_new() and
* H5F_dest(). Reading the root symbol table entry is done with
* H5G_decode().
*
* Robb Matzke, 23 Sep 1997
* Most of the work is now done by H5F_open() since H5Fcreate() and
* H5Fopen() originally contained almost identical code.
*
* Robb Matzke, 18 Feb 1998
* Added better error checking for the flags and the file access
* property list. It used to be possible to make the library dump core
* by passing an object ID that was not a file access property list.
*
*-------------------------------------------------------------------------
*/
hid_t
H5Fopen(const char *filename, unsigned flags, hid_t access_id)
{
H5F_t *new_file = NULL; /* file struct for new file */
const H5F_access_t *access_parms; /* pointer to the file access
* parameters to use when
* creating the file
*/
hid_t ret_value = FAIL;
FUNC_ENTER(H5Fopen, FAIL);
H5TRACE3("i","sIui",filename,flags,access_id);
/* Check/fix arguments. */
if (!filename || !*filename) {
HGOTO_ERROR(H5E_ARGS, H5E_BADVALUE, FAIL, "invalid file name");
}
if ((flags & ~H5F_ACC_PUBLIC_FLAGS) ||
(flags & H5F_ACC_TRUNC) || (flags & H5F_ACC_EXCL)) {
HGOTO_ERROR (H5E_ARGS, H5E_BADVALUE, FAIL, "invalid file open flags");
}
if (H5P_DEFAULT==access_id) {
access_parms = &H5F_access_dflt;
} else if (H5P_FILE_ACCESS!=H5P_get_class (access_id) ||
NULL == (access_parms = H5I_object(access_id))) {
HGOTO_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL,
"not a file access property list");
}
/* Open the file */
if (NULL==(new_file=H5F_open(filename, flags, NULL, access_parms))) {
HGOTO_ERROR(H5E_FILE, H5E_CANTOPENFILE, FAIL, "unable to open file");
}
/* Get an atom for the file */
if ((ret_value = H5I_register(H5I_FILE, new_file)) < 0) {
HGOTO_ERROR(H5E_ATOM, H5E_CANTREGISTER, FAIL,
"unable to atomize file handle");
}
done:
if (ret_value < 0 && new_file) {
H5F_close(new_file);
}
/* Normal function cleanup */
FUNC_LEAVE(ret_value);
}
/*-------------------------------------------------------------------------
* Function: H5Fflush
*
* Purpose: Flushes all outstanding buffers of a file to disk but does
* not remove them from the cache. The OBJECT_ID can be a file,
* dataset, group, attribute, or named data type.
*
* Return: Non-negative on success/Negative on failure
*
* Programmer: Robb Matzke
* Thursday, August 6, 1998
*
* Modifications:
*
* Robb Matzke, 1998-10-16
* Added the `scope' argument.
*
*-------------------------------------------------------------------------
*/
herr_t
H5Fflush(hid_t object_id, H5F_scope_t scope)
{
H5F_t *f = NULL;
H5G_t *grp = NULL;
H5T_t *type = NULL;
H5D_t *dset = NULL;
H5A_t *attr = NULL;
H5G_entry_t *ent = NULL;
FUNC_ENTER(H5Fflush, FAIL);
H5TRACE2("e","iFs",object_id,scope);
switch (H5I_get_type(object_id)) {
case H5I_FILE:
if (NULL==(f=H5I_object(object_id))) {
HRETURN_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL,
"invalid file identifier");
}
break;
case H5I_GROUP:
if (NULL==(grp=H5I_object(object_id))) {
HRETURN_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL,
"invalid group identifier");
}
ent = H5G_entof(grp);
break;
case H5I_DATATYPE:
if (NULL==(type=H5I_object(object_id))) {
HRETURN_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL,
"invalid type identifier");
}
ent = H5T_entof(type);
break;
case H5I_DATASET:
if (NULL==(dset=H5I_object(object_id))) {
HRETURN_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL,
"invalid dataset identifier");
}
ent = H5D_entof(dset);
break;
case H5I_ATTR:
if (NULL==(attr=H5I_object(object_id))) {
HRETURN_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL,
"invalid attribute identifier");
}
ent = H5A_entof(attr);
break;
default:
HRETURN_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL,
"not a file or file object");
}
if (!f) {
if (!ent) {
HRETURN_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL,
"object is not assocated with a file");
}
f = ent->file;
}
if (!f) {
HRETURN_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL,
"object is not associated with a file");
}
/* Flush the file */
if (H5F_flush(f, scope, FALSE)<0) {
HRETURN_ERROR(H5E_FILE, H5E_CANTINIT, FAIL,
"flush failed");
}
FUNC_LEAVE(SUCCEED);
}
/*-------------------------------------------------------------------------
* Function: H5F_flush
*
* Purpose: Flushes (and optionally invalidates) cached data plus the
* file boot block. If the logical file size field is zero
* then it is updated to be the length of the boot block.
*
* Errors:
* CACHE CANTFLUSH Can't flush cache.
* IO WRITEERROR Can't write header.
*
* Return: Non-negative on success/Negative on failure
*
* Programmer: Robb Matzke
* matzke@llnl.gov
* Aug 29 1997
*
* Modifications:
* rky 980828 Only p0 writes metadata to disk.
*
* Robb Matzke, 1998-10-16
* Added the `scope' argument to indicate what should be
* flushed. If the value is H5F_SCOPE_GLOBAL then the entire
* virtual file is flushed; a value of H5F_SCOPE_LOCAL means
* that only the specified file is flushed. A value of
* H5F_SCOPE_DOWN means flush the specified file and all
* children.
*
*-------------------------------------------------------------------------
*/
static herr_t
H5F_flush(H5F_t *f, H5F_scope_t scope, hbool_t invalidate)
{
uint8_t buf[2048], *p = buf;
haddr_t reserved_addr;
uintn firsttime_bootblock=0;
uintn nerrors=0, i;
FUNC_ENTER(H5F_flush, FAIL);
/*
* Nothing to do if the file is read only. This determination is made at
* the shared open(2) flags level, implying that opening a file twice,
* once for read-only and once for read-write, and then calling
* H5F_flush() with the read-only handle, still causes data to be flushed.
*/
if (0 == (H5F_ACC_RDWR & f->shared->flags)) {
HRETURN(SUCCEED);
}
/* Flush other stuff depending on scope */
if (H5F_SCOPE_GLOBAL==scope) {
while (f->mtab.parent) f = f->mtab.parent;
scope = H5F_SCOPE_DOWN;
}
if (H5F_SCOPE_DOWN==scope) {
for (i=0; i<f->mtab.nmounts; i++) {
if (H5F_flush(f->mtab.child[i].file, scope, invalidate)<0) {
nerrors++;
}
}
}
/* flush the entire raw data cache */
if (H5F_istore_flush (f, invalidate)<0) {
HRETURN_ERROR(H5E_CACHE, H5E_CANTFLUSH, FAIL,
"unable to flush raw data cache");
}
/* flush (and invalidate) the entire meta data cache */
if (H5AC_flush(f, NULL, 0, invalidate) < 0) {
HRETURN_ERROR(H5E_CACHE, H5E_CANTFLUSH, FAIL,
"unable to flush meta data cache");
}
/* encode the file boot block */
HDmemcpy(p, H5F_SIGNATURE, H5F_SIGNATURE_LEN);
p += H5F_SIGNATURE_LEN;
*p++ = f->shared->create_parms->bootblock_ver;
*p++ = f->shared->create_parms->freespace_ver;
*p++ = f->shared->create_parms->objectdir_ver;
*p++ = 0; /*reserved*/
*p++ = f->shared->create_parms->sharedheader_ver;
assert (H5F_SIZEOF_ADDR(f)<=255);
*p++ = (uint8_t)H5F_SIZEOF_ADDR(f);
assert (H5F_SIZEOF_SIZE(f)<=255);
*p++ = (uint8_t)H5F_SIZEOF_SIZE(f);
*p++ = 0; /*reserved */
UINT16ENCODE(p, f->shared->create_parms->sym_leaf_k);
UINT16ENCODE(p, f->shared->create_parms->btree_k[H5B_SNODE_ID]);
UINT32ENCODE(p, f->shared->consist_flags);
H5F_addr_encode(f, &p, &(f->shared->base_addr));
H5F_addr_encode(f, &p, &(f->shared->freespace_addr));
H5F_addr_encode(f, &p, &(f->shared->hdf5_eof));
H5F_addr_undef(&reserved_addr);
H5F_addr_encode(f, &p, &reserved_addr);
H5G_ent_encode(f, &p, H5G_entof(f->shared->root_grp));
/* update file length if necessary */
if (!H5F_addr_defined(&(f->shared->hdf5_eof))) {
haddr_t t_addr; /*temporary address */
/* Set the HDF5 file size */
H5F_addr_reset(&(f->shared->hdf5_eof));
H5F_addr_inc(&(f->shared->hdf5_eof), (hsize_t)(p-buf));
/* Set the logical file size, including the userblock data */
t_addr = f->shared->hdf5_eof;
H5F_addr_add(&t_addr, &(f->shared->base_addr));
H5F_low_seteof(f->shared->lf, &t_addr);
/* Indicate that the boot block needs to be flushed out */
firsttime_bootblock=1;
}
/* write the boot block to disk */
if(!firsttime_bootblock) {
#ifdef HAVE_PARALLEL
H5F_mpio_tas_allsame(f->shared->lf, TRUE); /* only p0 will write */
#endif
if (H5F_low_write(f->shared->lf, f->shared->access_parms, &H5F_xfer_dflt,
&(f->shared->boot_addr), (size_t)(p-buf), buf)<0) {
HRETURN_ERROR(H5E_IO, H5E_WRITEERROR, FAIL, "unable to write header");
}
/* Flush file buffers to disk */
if (H5F_low_flush(f->shared->lf, f->shared->access_parms) < 0) {
HRETURN_ERROR(H5E_IO, H5E_WRITEERROR, FAIL, "low level flush failed");
}
}
/* Check flush errors for children - errors are already on the stack */
if (nerrors) HRETURN(FAIL);
FUNC_LEAVE(SUCCEED);
}
/*-------------------------------------------------------------------------
* Function: H5F_close
*
* Purpose: Closes a file or causes the close operation to be pended.
* This function is called two ways: from the API it gets called
* by H5Fclose->H5I_dec_ref->H5F_close when H5I_dec_ref()
* decrements the file ID reference count to zero. The file ID
* is removed from the H5I_FILE group by H5I_dec_ref() just
* before H5F_close() is called. If there are open object
* headers then the close is pended by moving the file to the
* H5I_FILE_CLOSING ID group (the f->closing contains the ID
* assigned to file).
*
* This function is also called directly from H5O_close() when
* the last object header is closed for the file and the file
* has a pending close.
*
* Return: Non-negative on success/Negative on failure
*
* Programmer: Robb Matzke
* Tuesday, September 23, 1997
*
* Modifications:
*
* Robb Matzke, 1998-10-14
* Nothing happens unless the H5F_t reference count is one (the
* file is flushed anyway). The reference count is decremented by
* H5F_dest().
*
*-------------------------------------------------------------------------
*/
herr_t
H5F_close(H5F_t *f)
{
uintn i;
FUNC_ENTER(H5F_close, FAIL);
assert(f->nrefs>0);
/*
* If this file is referenced more than once then just decrement the
* count, flush the file, and return.
*/
if (f->nrefs>1) {
if (H5F_flush(f, H5F_SCOPE_LOCAL, FALSE)<0) {
HRETURN_ERROR(H5E_CACHE, H5E_CANTFLUSH, FAIL,
"unable to flush cache");
}
H5F_dest(f); /*decrement reference counts*/
HRETURN(SUCCEED);
}
/*
* Unmount and close each child before closing the current file.
*/
assert(NULL==f->mtab.parent);
for (i=0; i<f->mtab.nmounts; i++) {
f->mtab.child[i].file->mtab.parent = NULL;
H5G_close(f->mtab.child[i].group);
H5F_close(f->mtab.child[i].file);
}
f->mtab.nmounts = 0;
/*
* If object headers are still open then delay deletion of resources until
* they have all been closed. Flush all caches and update the object
* header anyway so that failing to close all objects isn't a major
* problem. If the file is on the H5I_FILE list then move it to the
* H5I_FILE_CLOSING list instead.
*/
if (f->nopen_objs>0) {
if (H5F_flush(f, H5F_SCOPE_LOCAL, FALSE)<0) {
HRETURN_ERROR(H5E_CACHE, H5E_CANTFLUSH, FAIL,
"unable to flush cache");
}
#ifdef H5F_DEBUG
if (H5DEBUG(F)) {
fprintf(H5DEBUG(F), "H5F: H5F_close(%s): %u object header%s still "
"open (file close will complete when %s closed)\n",
f->name,
f->nopen_objs,
1 == f->nopen_objs?" is":"s are",
1 == f->nopen_objs?"that header is":"those headers are");
}
#endif
if (!f->closing) {
f->closing = H5I_register(H5I_FILE_CLOSING, f);
}
HRETURN(SUCCEED);
} else if (f->closing) {
#ifdef H5F_DEBUG
if (H5DEBUG(F)) {
fprintf(H5DEBUG(F), "H5F: H5F_close: operation completing\n");
}
#endif
}
/*
* If this is the last reference to the shared part of the file then
* close it also.
*/
assert(1==f->nrefs);
if (1==f->shared->nrefs) {
/* Flush and destroy all caches */
if (H5F_flush(f, H5F_SCOPE_LOCAL, TRUE)<0) {
HRETURN_ERROR(H5E_CACHE, H5E_CANTFLUSH, FAIL,
"unable to flush cache");
}
/* Dump debugging info */
H5AC_debug(f);
H5F_istore_stats(f, FALSE);
/* Close files and release resources */
H5F_low_close(f->shared->lf, f->shared->access_parms);
} else {
/*
* Flush all caches but do not destroy. As long as all handles for
* this file are closed the flush isn't really necessary, but lets
* just be safe.
*/
if (H5F_flush(f, H5F_SCOPE_LOCAL, TRUE)<0) {
HRETURN_ERROR(H5E_CACHE, H5E_CANTFLUSH, FAIL,
"unable to flush cache");
}
}
/*
* Destroy the H5F_t struct and decrement the reference count for the
* shared H5F_file_t struct. If the reference count for the H5F_file_t
* struct reaches zero then destroy it also.
*/
if (H5F_dest(f)<0) {
HRETURN_ERROR (H5E_FILE, H5E_CANTINIT, FAIL,
"problems closing file");
}
FUNC_LEAVE(SUCCEED);
}
/*-------------------------------------------------------------------------
* Function: H5Fclose
*
* Purpose: This function closes the file specified by FILE_ID by
* flushing all data to storage, and terminating access to the
* file through FILE_ID. If objects (e.g., datasets, groups,
* etc.) are open in the file then the underlying storage is not
* closed until those objects are closed; however, all data for
* the file and the open objects is flushed.
*
* Return: Success: Non-negative
*
* Failure: Negative
*
* Programmer: Robb Matzke
* Saturday, February 20, 1999
*
* Modifications:
*
*-------------------------------------------------------------------------
*/
herr_t
H5Fclose(hid_t file_id)
{
herr_t ret_value = SUCCEED;
FUNC_ENTER(H5Fclose, FAIL);
H5TRACE1("e","i",file_id);
/* Check/fix arguments. */
if (H5I_FILE != H5I_get_type(file_id)) {
HGOTO_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL, "not a file atom");
}
if (NULL == H5I_object(file_id)) {
HGOTO_ERROR(H5E_ATOM, H5E_BADATOM, FAIL, "unable to unatomize file");
}
/*
* Decrement reference count on atom. When it reaches zero the file will
* be closed.
*/
if (H5I_dec_ref (file_id)<0) {
HGOTO_ERROR (H5E_ATOM, H5E_CANTINIT, FAIL, "problems closing file");
}
done:
FUNC_LEAVE(ret_value < 0 ? FAIL : SUCCEED);
}
/*-------------------------------------------------------------------------
* Function: H5F_mount
*
* Purpose: Mount file CHILD onto the group specified by LOC and NAME,
* using mount properties in PLIST. CHILD must not already be
* mouted and must not be a mount ancestor of the mount-point.
*
* Return: Non-negative on success/Negative on failure
*
* Programmer: Robb Matzke
* Tuesday, October 6, 1998
*
* Modifications:
*
* Robb Matzke, 1998-10-14
* The reference count for the mounted H5F_t is incremented.
*
*-------------------------------------------------------------------------
*/
static herr_t
H5F_mount(H5G_entry_t *loc, const char *name, H5F_t *child,
const H5F_mprop_t UNUSED *plist)
{
H5G_t *mount_point = NULL; /*mount point group */
H5G_entry_t *mp_ent = NULL; /*mount point symbol table entry*/
H5F_t *ancestor = NULL; /*ancestor files */
H5F_t *parent = NULL; /*file containing mount point */
intn lt, rt, md, cmp; /*binary search indices */
H5G_entry_t *ent = NULL; /*temporary symbol table entry */
herr_t ret_value = FAIL; /*return value */
FUNC_ENTER(H5F_mount, FAIL);
assert(loc);
assert(name && *name);
assert(child);
assert(plist);
/*
* Check that the child isn't mounted, that the mount point exists, and
* that the mount wouldn't introduce a cycle in the mount tree.
*/
if (child->mtab.parent) {
HGOTO_ERROR(H5E_FILE, H5E_MOUNT, FAIL, "file is already mounted");
}
if (NULL==(mount_point=H5G_open(loc, name))) {
HGOTO_ERROR(H5E_FILE, H5E_MOUNT, FAIL, "mount point not found");
}
parent = H5G_fileof(mount_point);
mp_ent = H5G_entof(mount_point);
for (ancestor=parent; ancestor; ancestor=ancestor->mtab.parent) {
if (ancestor==child) {
HGOTO_ERROR(H5E_FILE, H5E_MOUNT, FAIL,
"mount would introduce a cycle");
}
}
/*
* Use a binary search to locate the position that the child should be
* inserted into the parent mount table. At the end of this paragraph
* `md' will be the index where the child should be inserted.
*/
lt = md = 0;
rt = parent->mtab.nmounts;
cmp = -1;
while (lt<rt && cmp) {
md = (lt+rt)/2;
ent = H5G_entof(parent->mtab.child[md].group);
cmp = H5F_addr_cmp(&(mp_ent->header), &(ent->header));
if (cmp<0) {
rt = md;
} else if (cmp>0) {
lt = md+1;
}
}
if (cmp>0) md++;
if (!cmp) {
HGOTO_ERROR(H5E_FILE, H5E_MOUNT, FAIL,
"mount point is already in use");
}
/* Make room in the table */
if (parent->mtab.nmounts>=parent->mtab.nalloc) {
uintn n = MAX(16, 2*parent->mtab.nalloc);
H5F_mount_t *x = H5MM_realloc(parent->mtab.child,
n*sizeof(parent->mtab.child[0]));
if (!x) {
HGOTO_ERROR(H5E_RESOURCE, H5E_NOSPACE, FAIL,
"memory allocation failed for mount table");
}
parent->mtab.child = x;
parent->mtab.nalloc = n;
}
/* Insert into table */
HDmemmove(parent->mtab.child+md+1,
parent->mtab.child+md,
(parent->mtab.nmounts-md)*sizeof(parent->mtab.child[0]));
parent->mtab.nmounts++;
parent->mtab.child[md].group = mount_point;
parent->mtab.child[md].file = child;
child->mtab.parent = parent;
child->nrefs++;
ret_value = SUCCEED;
done:
if (ret_value<0 && mount_point) {
H5G_close(mount_point);
}
FUNC_LEAVE(ret_value);
}
/*-------------------------------------------------------------------------
* Function: H5F_unmount
*
* Purpose: Unmount the child which is mounted at the group specified by
* LOC and NAME or fail if nothing is mounted there. Neither
* file is closed.
*
* Because the mount point is specified by name and opened as a
* group, the H5G_namei() will resolve it to the root of the
* mounted file, not the group where the file is mounted.
*
* Return: Non-negative on success/Negative on failure
*
* Programmer: Robb Matzke
* Tuesday, October 6, 1998
*
* Modifications:
*
* Robb Matzke, 1998-10-14
* The ref count for the child is decremented by calling H5F_close().
*
*-------------------------------------------------------------------------
*/
static herr_t
H5F_unmount(H5G_entry_t *loc, const char *name)
{
H5G_t *mounted = NULL; /*mount point group */
H5G_entry_t *mnt_ent = NULL; /*mounted symbol table entry */
H5F_t *child = NULL; /*mounted file */
H5F_t *parent = NULL; /*file where mounted */
H5G_entry_t *ent = NULL; /*temporary symbol table entry */
herr_t ret_value = FAIL; /*return value */
uintn i; /*coutners */
intn lt, rt, md=(-1), cmp; /*binary search indices */
FUNC_ENTER(H5F_unmount, FAIL);
assert(loc);
assert(name && *name);
/*
* Get the mount point, or more precisely the root of the mounted file.
* If we get the root group and the file has a parent in the mount tree,
* then we must have found the mount point.
*/
if (NULL==(mounted=H5G_open(loc, name))) {
HGOTO_ERROR(H5E_FILE, H5E_MOUNT, FAIL, "mount point not found");
}
child = H5G_fileof(mounted);
mnt_ent = H5G_entof(mounted);
ent = H5G_entof(child->shared->root_grp);
if (child->mtab.parent &&
H5F_addr_eq(&(mnt_ent->header), &(ent->header))) {
/*
* We've been given the root group of the child. We do a reverse
* lookup in the parent's mount table to find the correct entry.
*/
parent = child->mtab.parent;
for (i=0; i<parent->mtab.nmounts; i++) {
if (parent->mtab.child[i].file==child) {
/* Unmount the child */
parent->mtab.nmounts -= 1;
H5G_close(parent->mtab.child[i].group);
child->mtab.parent = NULL;
H5F_close(child);
HDmemmove(parent->mtab.child+i,
parent->mtab.child+i+1,
((parent->mtab.nmounts-i)*
sizeof(parent->mtab.child[0])));
ret_value = SUCCEED;
}
}
assert(ret_value>=0);
} else {
/*
* We've been given the mount point in the parent. We use a binary
* search in the parent to locate the mounted file, if any.
*/
parent = child; /*we guessed wrong*/
lt = 0;
rt = parent->mtab.nmounts;
cmp = -1;
while (lt<rt && cmp) {
md = (lt+rt)/2;
ent = H5G_entof(parent->mtab.child[md].group);
cmp = H5F_addr_cmp(&(mnt_ent->header), &(ent->header));
if (cmp<0) {
rt = md;
} else {
lt = md+1;
}
}
if (cmp) {
HGOTO_ERROR(H5E_FILE, H5E_MOUNT, FAIL, "not a mount point");
}
/* Unmount the child */
parent->mtab.nmounts -= 1;
H5G_close(parent->mtab.child[md].group);
parent->mtab.child[md].file->mtab.parent = NULL;
H5F_close(parent->mtab.child[md].file);
HDmemmove(parent->mtab.child+md,
parent->mtab.child+md+1,
(parent->mtab.nmounts-md)*sizeof(parent->mtab.child[0]));
ret_value = SUCCEED;
}
done:
if (mounted) H5G_close(mounted);
FUNC_LEAVE(ret_value);
}
/*-------------------------------------------------------------------------
* Function: H5F_mountpoint
*
* Purpose: If ENT is a mount point then copy the entry for the root
* group of the mounted file into ENT.
*
* Return: Non-negative on success/Negative on failure
*
* Programmer: Robb Matzke
* Tuesday, October 6, 1998
*
* Modifications:
*
*-------------------------------------------------------------------------
*/
herr_t
H5F_mountpoint(H5G_entry_t *find/*in,out*/)
{
H5F_t *parent = find->file;
intn lt, rt, md=(-1), cmp;
H5G_entry_t *ent = NULL;
FUNC_ENTER(H5F_mountpoint, FAIL);
assert(find);
/*
* The loop is necessary because we might have file1 mounted at the root
* of file2, which is mounted somewhere in file3.
*/
do {
/*
* Use a binary search to find the potential mount point in the mount
* table for the parent
*/
lt = 0;
rt = parent->mtab.nmounts;
cmp = -1;
while (lt<rt && cmp) {
md = (lt+rt)/2;
ent = H5G_entof(parent->mtab.child[md].group);
cmp = H5F_addr_cmp(&(find->header), &(ent->header));
if (cmp<0) {
rt = md;
} else {
lt = md+1;
}
}
/* Copy root info over to ENT */
if (0==cmp) {
ent = H5G_entof(parent->mtab.child[md].file->shared->root_grp);
*find = *ent;
parent = ent->file;
}
} while (!cmp);
FUNC_LEAVE(SUCCEED);
}
/*-------------------------------------------------------------------------
* Function: H5Fmount
*
* Purpose: Mount file CHILD_ID onto the group specified by LOC_ID and
* NAME using mount properties PLIST_ID.
*
* Return: Non-negative on success/Negative on failure
*
* Programmer: Robb Matzke
* Tuesday, October 6, 1998
*
* Modifications:
*
*-------------------------------------------------------------------------
*/
herr_t
H5Fmount(hid_t loc_id, const char *name, hid_t child_id, hid_t plist_id)
{
H5G_entry_t *loc = NULL;
const H5F_mprop_t *plist = NULL;
H5F_t *child = NULL;
FUNC_ENTER(H5Fmount, FAIL);
H5TRACE4("e","isii",loc_id,name,child_id,plist_id);
/* Check arguments */
if (NULL==(loc=H5G_loc(loc_id))) {
HRETURN_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL, "not a location");
}
if (!name || !*name) {
HRETURN_ERROR(H5E_ARGS, H5E_BADVALUE, FAIL, "no name");
}
if (H5I_FILE!=H5I_get_type(child_id) ||
NULL==(child=H5I_object(child_id))) {
HRETURN_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL, "not a file");
}
if (H5P_DEFAULT==plist_id) {
plist = &H5F_mount_dflt;
} else if (H5P_MOUNT!=H5P_get_class(plist_id) ||
NULL==(plist=H5I_object(plist_id))) {
HRETURN_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL,
"not a mount property list");
}
/* Do the mount */
if (H5F_mount(loc, name, child, plist)<0) {
HRETURN_ERROR(H5E_FILE, H5E_MOUNT, FAIL,
"unable to mount file");
}
FUNC_LEAVE(SUCCEED);
}
/*-------------------------------------------------------------------------
* Function: H5Funmount
*
* Purpose: Given a mount point, dissassociate the mount point's file
* from the file mounted there. Do not close either file.
*
* The mount point can either be the group in the parent or the
* root group of the mounted file (both groups have the same
* name). If the mount point was opened before the mount then
* it's the group in the parent, but if it was opened after the
* mount then it's the root group of the child.
*
* Return: Non-negative on success/Negative on failure
*
* Programmer: Robb Matzke
* Tuesday, October 6, 1998
*
* Modifications:
*
*-------------------------------------------------------------------------
*/
herr_t
H5Funmount(hid_t loc_id, const char *name)
{
H5G_entry_t *loc = NULL;
FUNC_ENTER(H5Funmount, FAIL);
H5TRACE2("e","is",loc_id,name);
/* Check args */
if (NULL==(loc=H5G_loc(loc_id))) {
HRETURN_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL, "not a location");
}
if (!name || !*name) {
HRETURN_ERROR(H5E_ARGS, H5E_BADVALUE, FAIL, "no name");
}
/* Unmount */
if (H5F_unmount(loc, name)<0) {
HRETURN_ERROR(H5E_FILE, H5E_MOUNT, FAIL,
"unable to unmount file");
}
FUNC_LEAVE(SUCCEED);
}
/*-------------------------------------------------------------------------
* Function: H5Freopen
*
* Purpose: Reopen a file. The new file handle which is returned points
* to the same file as the specified file handle. Both handles
* share caches and other information. The only difference
* between the handles is that the new handle is not mounted
* anywhere and no files are mounted on it.
*
* Return: Success: New file ID
*
* Failure: FAIL
*
* Programmer: Robb Matzke
* Friday, October 16, 1998
*
* Modifications:
*
*-------------------------------------------------------------------------
*/
hid_t
H5Freopen(hid_t file_id)
{
H5F_t *old_file=NULL;
H5F_t *new_file=NULL;
hid_t ret_value = -1;
FUNC_ENTER(H5Freopen, FAIL);
H5TRACE1("i","i",file_id);
if (H5I_FILE!=H5I_get_type(file_id) ||
NULL==(old_file=H5I_object(file_id))) {
HGOTO_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL, "not a file");
}
if (NULL==(new_file=H5F_new(old_file->shared, NULL, NULL))) {
HGOTO_ERROR(H5E_FILE, H5E_CANTINIT, FAIL, "unable to reopen file");
}
if ((ret_value=H5I_register(H5I_FILE, new_file))<0) {
HGOTO_ERROR(H5E_ATOM, H5E_CANTREGISTER, FAIL,
"unable to atomize file handle");
}
done:
if (ret_value<0 && new_file) {
H5F_close(new_file);
}
FUNC_LEAVE(ret_value);
}
/*-------------------------------------------------------------------------
* Function: H5F_block_read
*
* Purpose: Reads some data from a file/server/etc into a buffer.
* The data is contiguous. The address is relative to the base
* address for the file.
*
* Errors:
* IO READERROR Low-level read failed.
*
* Return: Non-negative on success/Negative on failure
*
* Programmer: Robb Matzke
* matzke@llnl.gov
* Jul 10 1997
*
* Modifications:
* June 2, 1998 Albert Cheng
* Added xfer_mode argument
*
*-------------------------------------------------------------------------
*/
herr_t
H5F_block_read(H5F_t *f, const haddr_t *addr, hsize_t size,
const H5F_xfer_t *xfer_parms, void *buf)
{
haddr_t abs_addr;
FUNC_ENTER(H5F_block_read, FAIL);
assert (size < SIZET_MAX);
/* convert the relative address to an absolute address */
abs_addr = f->shared->base_addr;
H5F_addr_add(&abs_addr, addr);
/* Read the data */
if (H5F_low_read(f->shared->lf, f->shared->access_parms, xfer_parms,
&abs_addr, (size_t)size, buf) < 0) {
HRETURN_ERROR(H5E_IO, H5E_READERROR, FAIL, "low-level read failed");
}
FUNC_LEAVE(SUCCEED);
}
/*-------------------------------------------------------------------------
* Function: H5F_block_write
*
* Purpose: Writes some data from memory to a file/server/etc. The
* data is contiguous. The address is relative to the base
* address.
*
* Errors:
* IO WRITEERROR Low-level write failed.
* IO WRITEERROR No write intent.
*
* Return: Non-negative on success/Negative on failure
*
* Programmer: Robb Matzke
* matzke@llnl.gov
* Jul 10 1997
*
* Modifications:
* June 2, 1998 Albert Cheng
* Added xfer_mode argument
*
*-------------------------------------------------------------------------
*/
herr_t
H5F_block_write(H5F_t *f, const haddr_t *addr, hsize_t size,
const H5F_xfer_t *xfer_parms, const void *buf)
{
haddr_t abs_addr;
FUNC_ENTER(H5F_block_write, FAIL);
assert (size < SIZET_MAX);
if (0 == (f->intent & H5F_ACC_RDWR)) {
HRETURN_ERROR(H5E_IO, H5E_WRITEERROR, FAIL, "no write intent");
}
/* Convert the relative address to an absolute address */
abs_addr = f->shared->base_addr;
H5F_addr_add(&abs_addr, addr);
/* Write the data */
if (H5F_low_write(f->shared->lf, f->shared->access_parms, xfer_parms,
&abs_addr, (size_t)size, buf)) {
HRETURN_ERROR(H5E_IO, H5E_WRITEERROR, FAIL, "low-level write failed");
}
FUNC_LEAVE(SUCCEED);
}
/*-------------------------------------------------------------------------
* Function: H5F_debug
*
* Purpose: Prints a file header to the specified stream. Each line
* is indented and the field name occupies the specified width
* number of characters.
*
* Errors:
*
* Return: Non-negative on success/Negative on failure
*
* Programmer: Robb Matzke
* matzke@llnl.gov
* Aug 1 1997
*
* Modifications:
*
*-------------------------------------------------------------------------
*/
herr_t
H5F_debug(H5F_t *f, const haddr_t UNUSED *addr, FILE * stream,
intn indent, intn fwidth)
{
FUNC_ENTER(H5F_debug, FAIL);
/* check args */
assert(f);
assert(addr && H5F_addr_defined(addr));
assert(stream);
assert(indent >= 0);
assert(fwidth >= 0);
/* debug */
fprintf(stream, "%*sFile Boot Block...\n", indent, "");
fprintf(stream, "%*s%-*s %s\n", indent, "", fwidth,
"File name:",
f->name);
fprintf(stream, "%*s%-*s 0x%08x\n", indent, "", fwidth,
"Flags",
(unsigned) (f->shared->flags));
fprintf(stream, "%*s%-*s %u\n", indent, "", fwidth,
"Reference count:",
(unsigned) (f->shared->nrefs));
fprintf(stream, "%*s%-*s 0x%08lx\n", indent, "", fwidth,
"Consistency flags:",
(unsigned long) (f->shared->consist_flags));
fprintf(stream, "%*s%-*s ", indent, "", fwidth,
"Address of boot block:");
H5F_addr_print(stream, &(f->shared->boot_addr));
fprintf(stream, " (abs)\n");
fprintf(stream, "%*s%-*s ", indent, "", fwidth,
"Base address:");
H5F_addr_print(stream, &(f->shared->base_addr));
fprintf(stream, " (abs)\n");
fprintf(stream, "%*s%-*s ", indent, "", fwidth,
"Free list address:");
H5F_addr_print(stream, &(f->shared->freespace_addr));
fprintf(stream, " (rel)\n");
fprintf(stream, "%*s%-*s ", indent, "", fwidth,
"Total size of hdf5 data:");
H5F_addr_print(stream, &(f->shared->hdf5_eof));
fprintf(stream, " bytes\n");
fprintf(stream, "%*s%-*s %lu bytes\n", indent, "", fwidth,
"Size of user block:",
(unsigned long) (f->shared->create_parms->userblock_size));
fprintf(stream, "%*s%-*s %u bytes\n", indent, "", fwidth,
"Size of file size_t type:",
(unsigned) (f->shared->create_parms->sizeof_size));
fprintf(stream, "%*s%-*s %u bytes\n", indent, "", fwidth,
"Size of file haddr_t type:",
(unsigned) (f->shared->create_parms->sizeof_addr));
fprintf(stream, "%*s%-*s %u\n", indent, "", fwidth,
"Symbol table leaf node 1/2 rank:",
(unsigned) (f->shared->create_parms->sym_leaf_k));
fprintf(stream, "%*s%-*s %u\n", indent, "", fwidth,
"Symbol table internal node 1/2 rank:",
(unsigned) (f->shared->create_parms->btree_k[H5B_SNODE_ID]));
fprintf(stream, "%*s%-*s %u\n", indent, "", fwidth,
"Boot block version number:",
(unsigned) (f->shared->create_parms->bootblock_ver));
fprintf(stream, "%*s%-*s %u\n", indent, "", fwidth,
"Free list version number:",
(unsigned) (f->shared->create_parms->freespace_ver));
fprintf(stream, "%*s%-*s %u\n", indent, "", fwidth,
"Object directory version number:",
(unsigned) (f->shared->create_parms->objectdir_ver));
fprintf(stream, "%*s%-*s %u\n", indent, "", fwidth,
"Shared header version number:",
(unsigned) (f->shared->create_parms->sharedheader_ver));
fprintf(stream, "%*s%-*s %s\n", indent, "", fwidth,
"Root group symbol table entry:",
f->shared->root_grp ? "" : "(none)");
if (f->shared->root_grp) {
H5G_ent_debug(f, H5G_entof (f->shared->root_grp), stream,
indent+3, MAX(0, fwidth-3), NULL);
}
FUNC_LEAVE(SUCCEED);
}
|