summaryrefslogtreecommitdiffstats
path: root/src/H5F.c
blob: d6098fcbb3a03f797be6f34213d177717000e25d (plain)
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
/****************************************************************************
* 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$ */

/*LINTLIBRARY */
/*
   FILE
   hdf5file.c
   HDF5 file I/O routines

   EXPORTED ROUTINES
   H5Fcreate    -- Create an HDF5 file
   H5Fclose     -- Close an open HDF5 file

   LIBRARY-SCOPED ROUTINES

   LOCAL ROUTINES
   H5F_init_interface    -- initialize the H5F interface
 */

/* Packages needed by this file... */
#include <H5private.h>          /*library functions                       */
#include <H5Aprivate.h>         /*atoms                                   */
#include <H5ACprivate.h>        /*cache                                   */
#include <H5Cprivate.h>         /*templates                               */
#include <H5Eprivate.h>         /*error handling                  */
#include <H5Gprivate.h>         /*symbol tables                           */
#include <H5Mprivate.h>         /*meta data                               */
#include <H5MMprivate.h>        /*core memory management          */

#include <ctype.h>
#include <sys/types.h>
#include <sys/stat.h>

/*
 * Define the following if you want H5F_block_read() and H5F_block_write() to
 * keep track of the file position and attempt to minimize calls to the file
 * seek method.
 */
/* #define H5F_OPT_SEEK */

#define PABLO_MASK      H5F_mask

/*--------------------- Locally scoped variables -----------------------------*/

/*
 * Define the default file creation template.
 */
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                               */
    },
    4,                          /* Default offset size */
    4,                          /* Default length size */
    HDF5_BOOTBLOCK_VERSION,     /* Current Boot-Block version # */
    HDF5_SMALLOBJECT_VERSION,   /* Current Small-Object heap 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 # */
};

/* Interface initialization */
static intn             interface_initialize_g = FALSE;
#define INTERFACE_INIT H5F_init_interface
static herr_t           H5F_init_interface(void);
static void             H5F_term_interface(void);

/* PRIVATE PROTOTYPES */
static H5F_t           *H5F_new(H5F_file_t *shared);
static H5F_t           *H5F_dest(H5F_t *f);
static herr_t           H5F_flush(H5F_t *f, hbool_t invalidate);
static herr_t           H5F_locate_signature(H5F_low_t *f_handle, haddr_t *addr /*out */ );


/*--------------------------------------------------------------------------
NAME
   H5F_init_interface -- Initialize interface-specific information
USAGE
    herr_t H5F_init_interface()
   
RETURNS
   SUCCEED/FAIL
DESCRIPTION
    Initializes any interface-specific data or routines.

ERRORS

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.

--------------------------------------------------------------------------*/
static herr_t 
H5F_init_interface(void)
{
    herr_t                  ret_value = SUCCEED;
    FUNC_ENTER(H5F_init_interface, FAIL);

    /* Initialize the atom group for the file IDs */
    if ((ret_value = H5A_init_group(H5_FILE, H5A_FILEID_HASHSIZE, 0,
				    (herr_t (*)(void*))H5Fclose)) != FAIL)
        ret_value = H5_add_exit(&H5F_term_interface);

    FUNC_LEAVE(ret_value);
}                               /* H5F_init_interface */


/*--------------------------------------------------------------------------
 NAME
    H5F_term_interface
 PURPOSE
    Terminate various H5F objects
 USAGE
    void H5F_term_interface()
 RETURNS
    SUCCEED/FAIL
 DESCRIPTION
    Release the atom group and any other resources allocated.
 GLOBAL VARIABLES
 COMMENTS, BUGS, ASSUMPTIONS
     Can't report errors...
 EXAMPLES
 REVISION LOG
--------------------------------------------------------------------------*/
static void
H5F_term_interface(void)
{
    H5A_destroy_group(H5_FILE);
}


/*--------------------------------------------------------------------------
 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 **p;               IN: pointer to buffer pointer to encode length in
       uint8 *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 **p, uint8 *l)
{
    intn                    i = H5F_SIZEOF_SIZE(f);

#ifdef WORDS_BIGENDIAN
    /*
     * For non-little-endian platforms, encode each byte in memory backwards.
     */
    for (; i >= 0; i--, (*p)++)
        *(*p) = *(l + i);
#else
    /* platform has little-endian integers */
    for (; i >= 0; i--, (*p)++)
        *(*p) = *l;
#endif

#ifdef LATER
  done:
    if (ret_value == FALSE) {   /* Error condition cleanup */

    }                           /* end if */
#endif                       /* LATER */

    /* Normal function cleanup */

}                               /* H5F_encode_length_unusual */


/*--------------------------------------------------------------------------
 NAME
    H5Fget_create_template

 PURPOSE
    Get an atom for a copy of the file-creation template for this file

 USAGE
    hid_t H5Fget_create_template(fid)
        hid_t fid;    IN: File ID

 ERRORS
    ATOM      BADATOM       Can't get file struct. 
    FUNC      CANTCREATE    Can't create template. 
    FUNC      CANTINIT      Can't init template. 

 RETURNS
    Returns template ID on success, FAIL on failure

 DESCRIPTION
        This function returns an atom with a copy of the template parameters
    used to create a file.
--------------------------------------------------------------------------*/
hid_t
H5Fget_create_template(hid_t fid)
{
    H5F_t                  *file = NULL;
    hid_t                   ret_value = FAIL;
    H5F_create_t           *tmpl = NULL;

    FUNC_ENTER(H5Fget_create_template, FAIL);

    /* check args */
    if (H5_FILE != H5A_group(fid)) {
        HRETURN_ERROR(H5E_ATOM, H5E_BADATOM, FAIL, "not a file");
    }
    if (NULL == (file = H5A_object(fid))) {
        HRETURN_ERROR(H5E_ATOM, H5E_BADATOM, FAIL, "can't get file struct");
    }
    /* Create the template object to return */
    tmpl = H5MM_xmalloc(sizeof(H5F_create_t));
    *tmpl = file->shared->create_parms;
    if ((ret_value = H5C_create(H5C_FILE_CREATE, tmpl)) < 0) {
        HRETURN_ERROR(H5E_ATOM, H5E_CANTREGISTER, FAIL,
                      "can't register template");
    }
    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(const 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);

    ret_value = (obj->shared->key.dev == key->dev &&
                 obj->shared->key.ino == key->ino);

    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, haddr_t *addr /*out */ )
{
    haddr_t                 max_addr;
    uint8                   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, addr, H5F_SIGNATURE_LEN, buf) < 0) {
            HRETURN_ERROR(H5E_IO, H5E_READERROR, FAIL, "can't read file");
        }
        if (!HDmemcmp(buf, H5F_SIGNATURE, H5F_SIGNATURE_LEN))
            break;
        H5F_addr_pow2(n++, addr);
    }

    FUNC_LEAVE(SUCCEED);
}


/*--------------------------------------------------------------------------
 NAME
    H5Fis_hdf5

 PURPOSE
    Check the file signature to detect an HDF5 file.

 USAGE
    hbool_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.
--------------------------------------------------------------------------*/
hbool_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;

    FUNC_ENTER(H5Fis_hdf5, FAIL);

    /* Check args and all the boring stuff. */
    if (filename == NULL)
        HGOTO_ERROR(H5E_ARGS, H5E_BADRANGE, FAIL, "no filename specified");

    /* Open the file */
    if (NULL == (f_handle = H5F_low_open(H5F_LOW_DFLT, filename, 0, NULL))) {
        HGOTO_ERROR(H5E_FILE, H5E_BADFILE, FAIL,
                    "low-level file open failure");
    }
    if (H5F_locate_signature(f_handle, &addr) >= 0) {
        ret_value = TRUE;
    }
  done:
    H5F_low_close(f_handle);    /* 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.
 *
 * 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)
{
    H5F_t                  *f = NULL;
    FUNC_ENTER(H5F_new, NULL);

    f = H5MM_xcalloc(1, sizeof(H5F_t));
    f->shared = shared;

    if (!f->shared) {
        f->shared = H5MM_xcalloc(1, sizeof(H5F_file_t));
        H5F_addr_undef(&(f->shared->boot_addr));
        H5F_addr_undef(&(f->shared->base_addr));
        H5F_addr_undef(&(f->shared->smallobj_addr));
        H5F_addr_undef(&(f->shared->freespace_addr));
        H5F_addr_undef(&(f->shared->hdf5_eof));

        /* Create a main cache */
        H5AC_create(f, H5AC_NSLOTS);
    }
    f->shared->nrefs++;

    FUNC_LEAVE(f);
}

/*-------------------------------------------------------------------------
 * Function:    H5F_dest
 *
 * Purpose:     Destroys a file structure.  This function does not flush
 *              the cache or anything else; it only frees memory associated
 *              with the file struct.  The shared info for the file is freed
 *              only when its reference count reaches zero.
 *
 * Errors:
 *
 * Return:      Success:        NULL
 *
 *              Failure:        NULL
 *
 * Programmer:  Robb Matzke
 *              matzke@llnl.gov
 *              Jul 18 1997
 *
 * Modifications:
 *
 *-------------------------------------------------------------------------
 */
static H5F_t           *
H5F_dest(H5F_t *f)
{
    FUNC_ENTER(H5F_dest, NULL);

    if (f) {
        if (0 == --(f->shared->nrefs)) {
            H5AC_dest(f);
            f->shared->root_ent = H5MM_xfree(f->shared->root_ent);
            f->shared = H5MM_xfree(f->shared);
        }
        f->name = H5MM_xfree(f->name);
        H5MM_xfree(f);
    }
    FUNC_LEAVE(NULL);
}

/*-------------------------------------------------------------------------
 * 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_WRITE:  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 TYPE argument determins the low-level type of file that
 *              is opened.  The special value H5F_LOW_DFLT uses the default
 *              method which is defined at compile time.
 *
 * 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.
 *
 *-------------------------------------------------------------------------
 */
H5F_t                  *
H5F_open(const H5F_low_class_t *type, const char *name, uintn flags,
         const H5F_create_t *create_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                   buf[256];   /*I/O buffer..                  */
    const uint8            *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 char             *s = name;

    FUNC_ENTER(H5F_open, NULL);

    assert(name && *name);

    /*
     * Does the name look like a family name?  A family name always has a
     * percent (not preceded by a percent) followed by an optional plus and/or
     * minus, followed by optional digits, followed by the letter `d', `u',
     * `x', or `X'. This is a printf() format for an integer.
     */
    while (*s) {
        if ('%' != *s++)
            continue;
        if ('%' == *s) {
            s++;
            continue;
        }
        while (*s && isdigit(*s))
            s++;
        if ('d' != *s && 'u' != *s && 'x' != *s && 'X' != *s)
            continue;
        break;
    }
    if (*s) {
#ifdef H5F_DEBUG
        if (type != H5F_LOW_FAM) {
            fprintf(stderr, "HDF5-DIAG: opening a file family\n");
        }
#endif
        type = H5F_LOW_FAM;
    } else if (type == H5F_LOW_FAM) {
        HRETURN_ERROR(H5E_FILE, H5E_CANTOPENFILE, NULL,
                      "invalid file family name");
    }
    /*
     * If the name ends with `.h5' and there's another file that ends with
     * `.raw' then open the file as a split file.
     */
    {
        if (H5F_LOW_SPLIT != type && (s = strstr(name, ".h5")) && !s[3]) {
            char                    fullname[4096];
            strncpy(fullname, name, s - name);
            strcpy(fullname + (s - name), ".raw");
            if (H5F_low_access(H5F_LOW_DFLT, fullname, F_OK, NULL)) {
#ifdef H5F_DEBUG
                fprintf(stderr, "HDF5-DIAG: opening a split file\n");
#endif
                fullname[s - name] = '\0';
                f = H5F_open(H5F_LOW_SPLIT, fullname, flags, create_parms);
                HRETURN(f);
            }
        }
    }

    /*
     * If no file creation parameters are supplied then use defaults.
     */
    if (!create_parms)
        create_parms = &H5F_create_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.
     */
    file_exists = H5F_low_access(type, name, 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, R_OK, NULL)) {
            HRETURN_ERROR(H5E_FILE, H5E_READERROR, NULL,
                          "file is not readable");
        }
        if ((flags & H5F_ACC_WRITE) &&
            !H5F_low_access(type, name, W_OK, NULL)) {
            HRETURN_ERROR(H5E_FILE, H5E_WRITEERROR, NULL,
                          "file is not writable");
        }
        if ((old = H5A_search(H5_FILE, 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_WRITE) &&
                0 == (old->shared->flags & H5F_ACC_WRITE)) {
                if (NULL == (fd = H5F_low_open(type, name, H5F_ACC_WRITE, NULL))) {
                    HRETURN_ERROR(H5E_FILE, H5E_CANTOPENFILE, NULL,
                               "file cannot be reopened with write access");
                }
                H5F_low_close(old->shared->lf);
                old->shared->lf = fd;
                old->shared->flags |= H5F_ACC_WRITE;
                fd = NULL;      /*so we don't close it during error */
            }
            f = H5F_new(old->shared);

        } else if (flags & H5F_ACC_TRUNC) {
            /* Truncate existing file */
            if (0 == (flags & H5F_ACC_WRITE)) {
                HRETURN_ERROR(H5E_FILE, H5E_BADVALUE, NULL,
                              "can't truncate without write intent");
            }
            fd = H5F_low_open(type, name, H5F_ACC_WRITE | H5F_ACC_TRUNC, NULL);
            if (!fd) {
                HRETURN_ERROR(H5E_FILE, H5E_CANTCREATE, NULL,
                              "can't truncate file");
            }
            f = H5F_new(NULL);
            f->shared->key = search;
            f->shared->flags = flags;
            f->shared->lf = fd;
            empty_file = TRUE;

        } else {
            fd = H5F_low_open(type, name, (flags & H5F_ACC_WRITE), NULL);
            if (!fd) {
                HRETURN_ERROR(H5E_FILE, H5E_CANTOPENFILE, NULL,
                              "cannot open existing file");
            }
            f = H5F_new(NULL);
            f->shared->key = search;
            f->shared->flags = flags;
            f->shared->lf = fd;
        }

    } else if (flags & H5F_ACC_CREAT) {
        if (0 == (flags & H5F_ACC_WRITE)) {
            HRETURN_ERROR(H5E_FILE, H5E_BADVALUE, NULL,
                          "can't create file without write intent");
        }
        fd = H5F_low_open(type, name,
                          H5F_ACC_WRITE | H5F_ACC_CREAT | H5F_ACC_EXCL,
                          &search);
        if (!fd) {
            HRETURN_ERROR(H5E_FILE, H5E_CANTCREATE, NULL,
                          "can't create file");
        }
        f = H5F_new(NULL);
        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);

    /*
     * Update the file creation parameters with default values if this is the
     * first time this file is opened.
     */
    if (1 == f->shared->nrefs) {
        f->shared->create_parms = *create_parms;
    }
    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, FALSE) < 0) {
            HGOTO_ERROR(H5E_FILE, H5E_CANTINIT, NULL,
                        "can't 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->boot_addr)) < 0) {
            HGOTO_ERROR(H5E_FILE, H5E_NOTHDF5, NULL, "can't find signature");
        }
        if (H5F_low_read(f->shared->lf, &(f->shared->boot_addr),
                         fixed_size, buf) < 0) {
            HGOTO_ERROR(H5E_IO, H5E_READERROR, NULL, "can't 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->smallobject_ver = *p++;
        if (cp->smallobject_ver != HDF5_SMALLOBJECT_VERSION) {
            HGOTO_ERROR(H5E_FILE, H5E_CANTOPENFILE, NULL,
                        "bad small object heap 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");
        }
        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(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 small obj heap */
            H5F_SIZEOF_ADDR(f) +        /*global free list addr */
            H5F_SIZEOF_ADDR(f) +        /*logical file size */
            H5G_SIZEOF_ENTRY(f);
        assert(variable_size <= sizeof buf);
        addr1 = f->shared->boot_addr;
        H5F_addr_inc(&addr1, fixed_size);
        if (H5F_low_read(f->shared->lf, &addr1, variable_size, buf) < 0) {
            HGOTO_ERROR(H5E_FILE, H5E_NOTHDF5, NULL,
                        "can't read boot block");
        }
        p = buf;
        H5F_addr_decode(f, &p, &(f->shared->base_addr));
        H5F_addr_decode(f, &p, &(f->shared->smallobj_addr));
        H5F_addr_decode(f, &p, &(f->shared->freespace_addr));
        H5F_addr_decode(f, &p, &(f->shared->hdf5_eof));
        if (H5G_ent_decode(f, &p, &root_ent) < 0) {
            HGOTO_ERROR(H5E_FILE, H5E_CANTOPENFILE, NULL,
                        "can't read root symbol entry");
        }
        if (H5F_addr_defined(&(root_ent.header))) {
            f->shared->root_ent = H5MM_xmalloc(sizeof(H5G_entry_t));
            *(f->shared->root_ent) = root_ent;
        }
        /*
         * 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
        fprintf(stderr, "HDF5-DIAG: resetting EOF from ");
        H5F_addr_print(stderr, &addr1);
        fprintf(stderr, " to ");
        H5F_addr_print(stderr, &addr2);
        fprintf(stderr, " (abs)\n");
#endif
        H5F_low_seteof(f->shared->lf, &addr2);
    }
    /* Success! */
    ret_value = f;

  done:
    if (!ret_value) {
        if (f)
            H5F_dest(f);
        H5F_low_close(fd);
    }
    FUNC_LEAVE(ret_value);
}


/*--------------------------------------------------------------------------
 NAME
    H5Fcreate

 PURPOSE
    Create a new HDF5 file.

 USAGE
    int32 H5Fcreate(filename, flags, create_temp, access_temp)
        const char *filename;   IN: Name of the file to create
        uintn flags;            IN: Flags to indicate various options.
        hid_t create_temp;    IN: File-creation template ID
        hid_t access_temp;    IN: File-access template ID

 ERRORS
    ARGS      BADVALUE      Invalid file name. 
    ARGS      BADVALUE      Invalid flags. 
    ATOM      BADATOM       Can't unatomize template. 
    ATOM      CANTREGISTER  Can't atomize file. 
    FILE      CANTOPENFILE  Can't create file. 

 RETURNS
    Returns file ID on success, FAIL on failure

 DESCRIPTION
        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 "||" (logical OR operator) to change the behavior
    of the file open call.
        The flags currently defined:
            H5ACC_OVERWRITE - Truncate file, if it already exists. The file
                will be truncated, erasing all data previously stored in the
                file.
        The more complex behaviors of a file's creation and access are
    controlled through the file-creation and file-access templates.  The value
    of 0 for a template value indicates that the library should use the default
    values for the appropriate template.  (Documented in the template module).
    [Access templates are currently unused in this routine, although they will
    be implemented in the future]

 MODIFICATIONS:
    Robb Matzke, 18 Jul 1997
    File struct creation and destruction is through H5F_new() 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.
--------------------------------------------------------------------------*/
hid_t 
H5Fcreate(const char *filename, uintn flags, hid_t create_temp,
          hid_t access_temp)
{
    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
                                                 */
    hid_t                   ret_value = FAIL;

    FUNC_ENTER(H5Fcreate, FAIL);

    /* Check/fix arguments */
    if (!filename || !*filename)
        HGOTO_ERROR(H5E_ARGS, H5E_BADVALUE, FAIL, "invalid file name");
    if (flags & ~H5ACC_OVERWRITE)
        HGOTO_ERROR(H5E_ARGS, H5E_BADVALUE, FAIL, "invalid flags");
    flags = (H5F_ACC_WRITE | H5F_ACC_CREAT) |
        (H5ACC_OVERWRITE == flags ? H5F_ACC_TRUNC : H5F_ACC_EXCL);

    if (create_temp <= 0) {
        create_parms = &H5F_create_dflt;
    } else if (NULL == (create_parms = H5A_object(create_temp))) {
        HGOTO_ERROR(H5E_ATOM, H5E_BADATOM, FAIL, "can't unatomize template");
    }
#ifdef LATER
    if (access_temp <= 0) {
        access_parms = &H5F_access_dflt;
    } else if (NULL == (access_parms = H5A_object(access_temp))) {
        HGOTO_ERROR(H5E_ATOM, H5E_BADATOM, FAIL);       /*can't unatomize template */
    }
#endif

    /*
     * Create a new file or truncate an existing file.
     */
    if (NULL == (new_file = H5F_open(H5F_LOW_DFLT, filename, flags,
                                     create_parms))) {
        HGOTO_ERROR(H5E_FILE, H5E_CANTOPENFILE, FAIL, "can't create file");
    }
    /* Get an atom for the file */
    if ((ret_value = H5A_register(H5_FILE, new_file)) < 0)
        HGOTO_ERROR(H5E_ATOM, H5E_CANTREGISTER, FAIL, "can't atomize file");

  done:
    if (ret_value < 0 && new_file) {
        /* Error condition cleanup */
        H5F_close(new_file);
    }
    /* Normal function cleanup */

    FUNC_LEAVE(ret_value);
}


/*--------------------------------------------------------------------------
 NAME
    H5Fopen

 PURPOSE
    Open an existing HDF5 file.

 USAGE
    hid_t H5Fopen(filename, flags, access_temp)
        const char *filename;   IN: Name of the file to create
        uintn flags;            IN: Flags to indicate various options.
        hid_t access_temp;    IN: File-access template

 ERRORS
    ARGS      BADRANGE      Invalid file name. 
    ATOM      BADATOM       Can't unatomize template. 
    ATOM      CANTREGISTER  Can't atomize file. 
    FILE      CANTOPENFILE  Cant open file. 

 RETURNS
    Returns file ID on success, FAIL on failure

 DESCRIPTION
        This is the primary function for accessing existing HDF5 files. The
    flags parameter determines whether writing to an existing file will be
    allowed or not.  All flags may be combined with the "||" (logical OR
    operator) to change the behavior of the file open call.
        The flags currently defined:
            H5ACC_WRITE - Allow writing to the file.
        The more complex behaviors of a file's access are controlled through
    the file-access template.

 MODIFICATIONS:
    Robb Matzke, 18 Jul 1997
    File struct creation and destruction is through H5F_new() 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.
--------------------------------------------------------------------------*/
hid_t 
H5Fopen(const char *filename, uintn flags, hid_t access_temp)
{
    H5F_t                  *new_file = NULL;    /* file struct for new file */
    hid_t                   ret_value = FAIL;

    FUNC_ENTER(H5Fopen, FAIL);

    /* Check/fix arguments. */
    if (!filename || !*filename)
        HGOTO_ERROR(H5E_ARGS, H5E_BADRANGE, FAIL, "invalid file name");
    flags = flags & H5ACC_WRITE ? H5F_ACC_WRITE : 0;

#ifdef LATER
    if (access_temp <= 0)
        access_temp = H5CPget_default_atom(H5_TEMPLATE);
    if (NULL == (f_access_parms = H5A_object(access_temp)))
        HGOTO_ERROR(H5E_ATOM, H5E_BADATOM, FAIL);       /*can't unatomize template */
#endif

    /* Open the file */
    if (NULL == (new_file = H5F_open(H5F_LOW_DFLT, filename, flags, NULL))) {
        HGOTO_ERROR(H5E_FILE, H5E_CANTOPENFILE, FAIL, "cant open file");
    }
    /* Get an atom for the file */
    if ((ret_value = H5A_register(H5_FILE, new_file)) < 0)
        HGOTO_ERROR(H5E_ATOM, H5E_CANTREGISTER, FAIL, "can't atomize file");

  done:
    if (ret_value < 0 && new_file) {
        H5F_close(new_file);
    }
    /* Normal function cleanup */

    FUNC_LEAVE(ret_value);
}

/*-------------------------------------------------------------------------
 * Function:    H5F_flush
 *
 * Purpose:     Flushes (and optionally invalidates) cached data plus the
 *              file boot block.  If the logical file size field is zero
 *              then it is updated to be the length of the boot block.
 *
 * Errors:
 *              CACHE     CANTFLUSH     Can't flush cache. 
 *              IO        WRITEERROR    Can't write header. 
 *
 * Return:      Success:        SUCCEED
 *
 *              Failure:        FAIL
 *
 * Programmer:  Robb Matzke
 *              matzke@llnl.gov
 *              Aug 29 1997
 *
 * Modifications:
 *
 *-------------------------------------------------------------------------
 */
static herr_t
H5F_flush(H5F_t *f, hbool_t invalidate)
{
    uint8                   buf[2048], *p = buf;

    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_WRITE & f->shared->flags))
        HRETURN(SUCCEED);

    /* flush (and invalidate) the entire cache */
    if (H5AC_flush(f, NULL, 0, invalidate) < 0) {
        HRETURN_ERROR(H5E_CACHE, H5E_CANTFLUSH, FAIL, "can't flush 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.smallobject_ver;
    *p++ = f->shared->create_parms.freespace_ver;
    *p++ = f->shared->create_parms.objectdir_ver;
    *p++ = f->shared->create_parms.sharedheader_ver;
    *p++ = H5F_SIZEOF_ADDR(f);
    *p++ = 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->smallobj_addr));
    H5F_addr_encode(f, &p, &(f->shared->freespace_addr));
    H5F_addr_encode(f, &p, &(f->shared->hdf5_eof));
    H5G_ent_encode(f, &p, f->shared->root_ent);

    /* update file length if necessary */
    if (!H5F_addr_defined(&(f->shared->hdf5_eof))) {
        H5F_addr_reset(&(f->shared->hdf5_eof));
        H5F_addr_inc(&(f->shared->hdf5_eof), p - buf);
        H5F_low_seteof(f->shared->lf, &(f->shared->hdf5_eof));
    }
    /* write the boot block to disk */
    if (H5F_low_write(f->shared->lf, &(f->shared->boot_addr), p - buf, buf) < 0) {
        HRETURN_ERROR(H5E_IO, H5E_WRITEERROR, FAIL, "can't write header");
    }
    /* Flush file buffers to disk */
    if (H5F_low_flush(f->shared->lf) < 0) {
        HRETURN_ERROR(H5E_IO, H5E_WRITEERROR, FAIL, "low level flush failed");
    }
    FUNC_LEAVE(SUCCEED);
}

/*-------------------------------------------------------------------------
 * Function:    H5F_close
 *
 * Purpose:     Closes an open HDF5 file.
 *
 * Return:      Success:        SUCCEED
 *
 *              Failure:        FAIL
 *
 * Programmer:  Robb Matzke
 *              Tuesday, September 23, 1997
 *
 * Modifications:
 *
 *-------------------------------------------------------------------------
 */
herr_t
H5F_close(H5F_t *f)
{
    FUNC_ENTER(H5F_close, FAIL);

    /* Close all current working groups */
    while (H5G_pop(f) >= 0)     /*void */
        ;

    /* Flush the boot block and caches */
    if (H5F_flush(f, TRUE) < 0) {
        HRETURN_ERROR(H5E_CACHE, H5E_CANTFLUSH, FAIL, "can't flush cache");
    }
    /*
     * If object headers are still open then delay deletion of resources until
     * they have all been closed.  The file is in a consistent state now, so
     * forgetting to close everything is not a major problem.
     */
    if (f->nopen > 0) {
#ifndef NDEBUG
        fprintf(stderr, "HDF5-DIAG: H5F_close: %d object header%s still "
                "open (file close will complete when %s closed)\n",
                f->nopen,
                1 == f->nopen ? " is" : "s are",
                1 == f->nopen ? "that header is" : "those headers are");
#endif
        f->close_pending = TRUE;
        HRETURN(SUCCEED);
    } else if (f->close_pending) {
#ifndef NDEBUG
        fprintf(stderr, "HDF5-DIAG: H5F_close: operation completed\n");
#endif
    }
    /* Dump debugging info */
    if (f->intent & H5F_ACC_DEBUG)
        H5AC_debug(f);

    /* Close files and release resources */
    H5F_low_close(f->shared->lf);
    f = H5F_dest(f);

    FUNC_LEAVE(SUCCEED);
}


/*--------------------------------------------------------------------------
 NAME
    H5Fclose

 PURPOSE
    Close an open HDF5 file.

 USAGE
    int32 H5Fclose(fid)
        int32 fid;      IN: File ID of file to close

 ERRORS
    ARGS      BADTYPE       Not a file atom. 
    ATOM      BADATOM       Can't remove atom. 
    ATOM      BADATOM       Can't unatomize file. 
    CACHE     CANTFLUSH     Can't flush cache. 

 RETURNS
    SUCCEED/FAIL

 DESCRIPTION
        This function terminates access to an HDF5 file.  If this is the last
    file ID open for a file and if access IDs are still in use, this function
    will fail.

 MODIFICATIONS:
    Robb Matzke, 18 Jul 1997
    File struct destruction is through H5F_dest().

    Robb Matzke, 29 Aug 1997
    The file boot block is flushed to disk since it's contents may have
    changed.
--------------------------------------------------------------------------*/
herr_t 
H5Fclose(hid_t fid)
{
    H5F_t                  *file = NULL;        /* file struct for file to close */
    herr_t                  ret_value = SUCCEED;

    FUNC_ENTER(H5Fclose, FAIL);

    /* Check/fix arguments. */
    if (H5_FILE != H5A_group(fid))
        HGOTO_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL, "not a file atom");
    if (NULL == (file = H5A_object(fid)))
        HGOTO_ERROR(H5E_ATOM, H5E_BADATOM, FAIL, "can't unatomize file");

    /* Close the file */
    ret_value = H5F_close(file);

    /* Remove the file atom */
    if (NULL == H5A_remove(fid)) {
        HGOTO_ERROR(H5E_ATOM, H5E_BADATOM, FAIL, "can't remove atom");
    }
  done:
    FUNC_LEAVE(ret_value < 0 ? FAIL : SUCCEED);
}

/*-------------------------------------------------------------------------
 * 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:      Success:        SUCCEED
 *
 *              Failure:        FAIL
 *
 * Programmer:  Robb Matzke
 *              matzke@llnl.gov
 *              Jul 10 1997
 *
 * Modifications:
 *
 *-------------------------------------------------------------------------
 */
herr_t
H5F_block_read(H5F_t *f, const haddr_t *addr, size_t size, void *buf)
{
    haddr_t                 abs_addr;

    FUNC_ENTER(H5F_block_read, FAIL);

    if (0 == size)
        return 0;

    /* 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, &abs_addr, 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:      Success:        SUCCEED
 *
 *              Failure:        FAIL
 *
 * Programmer:  Robb Matzke
 *              matzke@llnl.gov
 *              Jul 10 1997
 *
 * Modifications:
 *
 *-------------------------------------------------------------------------
 */
herr_t
H5F_block_write(H5F_t *f, const haddr_t *addr, size_t size, const void *buf)
{
    haddr_t                 abs_addr;

    FUNC_ENTER(H5F_block_write, FAIL);

    if (0 == size)
        return 0;

    if (0 == (f->intent & H5F_ACC_WRITE)) {
        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, &abs_addr, 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:      Success:        SUCCEED
 *
 *              Failure:        FAIL
 *
 * Programmer:  Robb Matzke
 *              matzke@llnl.gov
 *              Aug  1 1997
 *
 * Modifications:
 *
 *-------------------------------------------------------------------------
 */
herr_t
H5F_debug(H5F_t *f, const haddr_t *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,
            "Small object heap address:");
    H5F_addr_print(stream, &(f->shared->smallobj_addr));
    fprintf(stream, " (rel)\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,
            "Small object heap version number:",
            (unsigned) (f->shared->create_parms.smallobject_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 symbol table entry:",
            f->shared->root_ent ? "" : "(none)");
    if (f->shared->root_ent) {
        H5G_ent_debug(f, f->shared->root_ent, stream,
                      indent + 3, MAX(0, fwidth - 3));
    }
    FUNC_LEAVE(SUCCEED);
}