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
|
/****************************************************************************
* NCSA HDF *
* Software Development Group *
* National Center for Supercomputing Applications *
* University of Illinois at Urbana-Champaign *
* 605 E. Springfield, Champaign IL 61820 *
* *
* For conditions of distribution and use, see the accompanying *
* hdf/COPYING file. *
* *
****************************************************************************/
#ifdef RCSID
static char RcsId[] = "@(#)$Revision$";
#endif
/* $Id$ */
/*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
*/
#include <assert.h>
#define HDF5_FILE_MASTER
#include "hdf5.h"
#undef HDF5_FILE_MASTER
/* Packages needed by this file... */
#include "H5private.h" /*library functions */
#include "H5ACprivate.h" /*cache */
#include "H5Gprivate.h" /*symbol tables */
#include "H5MMprivate.h" /*core memory management */
#define PABLO_MASK H5F_mask
/*--------------------- Locally scoped variables -----------------------------*/
/* Whether we've installed the library termination function yet for this interface */
static intn interface_initialize_g = FALSE;
/*--------------------- Local function prototypes ----------------------------*/
static herr_t H5F_init_interface(void);
static hdf5_file_t *H5F_new (void);
static hdf5_file_t *H5F_dest (hdf5_file_t *f);
/*--------------------------------------------------------------------------
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.
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, NULL, FAIL);
/* Initialize the atom group for the file IDs */
ret_value=H5Ainit_group(H5_FILE,HDF5_FILEID_HASHSIZE,0);
FUNC_LEAVE(ret_value);
} /* H5F_init_interface */
#ifdef LATER
/*--------------------------------------------------------------------------
NAME
H5F_encode_length_unusual -- encode an unusual length size
USAGE
void H5F_encode_length_unusual(f, p, l)
const hdf5_file_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
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 hdf5_file_t *f, uint8 **p, uint8 *l)
{
intn i = H5F_SIZEOF_SIZE (f);
/* For non-little-endian platforms, encode each byte in memory backwards */
#if ((DF_MT&0xFFF0)!=0x4440)
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
H5F_encode_offset_unusual -- encode an unusual offset size
USAGE
void H5F_encode_offset_unusual(f, p, o)
const hdf5_file_t *f; IN: pointer to the file record
uint8 **p; IN: pointer to buffer pointer to encode offset in
uint8 *o; IN: pointer to offset to encode
RETURNS
none
DESCRIPTION
Encode non-standard (i.e. not 2, 4 or 8-byte) offsets in file meta-data.
--------------------------------------------------------------------------*/
void H5F_encode_offset_unusual(const hdf5_file_t *f, uint8 **p, uint8 *o)
{
intn i = H5F_SIZEOF_OFFSET(f);
/* For non-little-endian platforms, encode each byte in memory backwards */
#if ((DF_MT&0xFFF0)!=0x4440)
for(; i>=0; i--,(*p)++)
*(*p)=*(o+i);
#else /* platform has little-endian integers */
for(; i>=0; i--,(*p)++)
*(*p)=*o;
#endif
#ifdef LATER
done:
if(ret_value == FALSE)
{ /* Error condition cleanup */
} /* end if */
#endif /* LATER */
/* Normal function cleanup */
} /* H5F_encode_offset_unusual */
#endif /* LATER */
/*--------------------------------------------------------------------------
NAME
H5F_compare_filename -- compare file objects for the atom API
USAGE
intn HPcompare_filename(obj, key)
const VOIDP obj; IN: pointer to the file record
const VOIDP key; IN: pointer to the name of file
RETURNS
TRUE if the key matches the obj, FALSE otherwise
DESCRIPTION
Look inside the file record for the atom API and compare the the
filenames.
--------------------------------------------------------------------------*/
intn
H5F_compare_filename (const VOIDP _obj, const VOIDP _key)
{
const hdf5_file_t *obj = (const hdf5_file_t *)_obj;
const char *key = (const char *)_key;
int ret_value = FALSE;
FUNC_ENTER (H5F_compare_filename, NULL, FALSE);
ret_value = !HDstrcmp (obj->filename, key);
FUNC_LEAVE (ret_value);
} /* H5F_compare_filename */
/*--------------------------------------------------------------------------
NAME
H5Fget_create_template
PURPOSE
Get an atom for a copy of the file-creation template for this file
USAGE
hatom_t H5Fget_create_template(fid)
hatom_t fid; IN: File ID
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.
--------------------------------------------------------------------------*/
hatom_t H5Fget_create_template(hatom_t fid)
{
hdf5_file_t *file=NULL; /* file struct for file to close */
hatom_t ret_value = FAIL;
FUNC_ENTER(H5Fget_create_template, H5F_init_interface, FAIL);
/* Clear errors and check args and all the boring stuff. */
H5ECLEAR;
/* Get the file structure */
if((file=H5Aatom_object(fid))==NULL)
HGOTO_ERROR(H5E_ATOM, H5E_BADATOM, FAIL);
/* Create the template object to return */
if((ret_value=H5Mcreate(fid,H5_TEMPLATE,NULL))==FAIL)
HGOTO_ERROR(H5E_FUNC, H5E_CANTCREATE, FAIL);
if(H5C_init(ret_value,&(file->file_create_parms))==FAIL)
HGOTO_ERROR(H5E_FUNC, H5E_CANTINIT, FAIL);
done:
if(ret_value == FAIL)
{ /* Error condition cleanup */
} /* end if */
/* Normal function cleanup */
FUNC_LEAVE(ret_value);
} /* end H5Fget_create_template() */
/*--------------------------------------------------------------------------
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
RETURNS
TRUE/FALSE/FAIL
DESCRIPTION
This function determines if a file is an HDF5 format file.
--------------------------------------------------------------------------*/
hbool_t H5Fis_hdf5(const char *filename)
{
hdf_file_t f_handle=H5F_INVALID_FILE; /* file handle */
uint8 temp_buf[HDF5_FILE_SIGNATURE_LEN]; /* temporary buffer for checking file signature */
haddr_t curr_off=0; /* The current offset to check in the file */
size_t file_len=0; /* The length of the file we are checking */
hbool_t ret_value = BFALSE;
FUNC_ENTER(H5Fis_hdf5, H5F_init_interface, BFAIL);
/* Clear errors and check args and all the boring stuff. */
H5ECLEAR;
if(filename==NULL)
HGOTO_ERROR(H5E_ARGS, H5E_BADRANGE, BFAIL);
/* Open the file */
f_handle=H5F_OPEN(filename,0);
if(H5F_OPENERR(f_handle))
HGOTO_ERROR(H5E_FILE, H5E_BADFILE, BFAIL);
/* Get the length of the file */
if(H5F_SEEKEND(f_handle)==FAIL)
HGOTO_ERROR(H5E_IO, H5E_SEEKERROR, BFAIL);
file_len=H5F_TELL(f_handle);
/* Check the offsets where the file signature is possible */
while(curr_off<file_len)
{
if(H5F_SEEK(f_handle,curr_off)==FAIL)
HGOTO_ERROR(H5E_IO, H5E_READERROR, BFAIL);
if(H5F_READ(f_handle,temp_buf, HDF5_FILE_SIGNATURE_LEN)==FAIL)
HGOTO_ERROR(H5E_IO, H5E_READERROR, BFAIL);
if(HDmemcmp(temp_buf,HDF5_FILE_SIGNATURE,HDF5_FILE_SIGNATURE_LEN)==0)
{
ret_value=BTRUE;
break;
} /* end if */
if(curr_off==0)
curr_off=512;
else
curr_off*=2;
} /* end while */
H5F_CLOSE(f_handle); /* close the file we opened */
done:
if(ret_value == BFAIL)
{ /* Error condition cleanup */
/* Check if we left a dangling file handle */
if(f_handle!=H5F_INVALID_FILE)
H5F_CLOSE(f_handle); /* close the file we opened */
} /* end if */
/* Normal function cleanup */
FUNC_LEAVE(ret_value);
} /* end H5Fis_hdf5() */
/*-------------------------------------------------------------------------
* Function: H5F_new
*
* Purpose: Creates a new file object and initializes it. The
* H5Fopen and H5Fcreate functions then fill in various
* fields.
*
* Return: Success: Ptr to a new file struct.
*
* Failure: NULL
*
* Programmer: Robb Matzke
* matzke@llnl.gov
* Jul 18 1997
*
* Modifications:
*
*-------------------------------------------------------------------------
*/
static hdf5_file_t *
H5F_new (void)
{
hdf5_file_t *f = H5MM_xcalloc (1, sizeof(hdf5_file_t));
/* Create a cache */
H5AC_new (f);
/* Create a root symbol slot */
f->root_sym = H5MM_xcalloc (1, sizeof (H5G_entry_t));
f->root_sym->type = H5G_NOTHING_CACHED;
return 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.
*
* Return: Success: NULL
*
* Failure: NULL
*
* Programmer: Robb Matzke
* matzke@llnl.gov
* Jul 18 1997
*
* Modifications:
*
*-------------------------------------------------------------------------
*/
static hdf5_file_t *
H5F_dest (hdf5_file_t *f)
{
if (f) {
H5AC_dest (f);
f->dir = H5MM_xfree (f->dir);
f->filename = H5MM_xfree (f->filename);
f->root_sym = H5MM_xfree (f->root_sym);
H5MM_xfree (f);
}
return NULL;
}
/*--------------------------------------------------------------------------
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.
hatom_t create_temp; IN: File-creation template ID
hatom_t access_temp; IN: File-access template ID
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]
ERRORS
H5E_ARGS - H5E_BADVALUE - Argument checking
H5E_FILE - H5E_FILEOPEN - File already open
- H5E_FILEEXISTS - File exists and no overwrite permission is given
- H5E_CANTCREATE - Can't create new file
H5E_RESOURCE - H5E_NOSPACE - Can't allocate space
H5E_ATOM - H5E_BADATOM - Can't get the object for an atom
- H5E_CANTREGISTER - Can't register the new file atom
H5E_IO - H5E_SEEKERROR - Can't seek to correct offset for boot-block
- H5E_WRITEERROR - Can't write data to file
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().
--------------------------------------------------------------------------*/
hatom_t H5Fcreate(const char *filename, uintn flags, hatom_t create_temp, hatom_t access_temp)
{
hdf5_file_t *new_file=NULL; /* file struct for new file */
hdf_file_t f_handle=H5F_INVALID_FILE; /* file handle */
const file_create_temp_t *f_create_parms; /* pointer to the parameters to use when creating the file */
uint8 temp_buf[H5F_BOOTBLOCK_SIZE], *p; /* temporary buffer for encoding header */
intn file_exists=0; /* flag to indicate that file exists already */
hatom_t ret_value = FAIL;
FUNC_ENTER(H5Fcreate, H5F_init_interface, FAIL);
/* Clear errors and check args and all the boring stuff. */
H5ECLEAR;
if(filename==NULL) /* check for valid filename */
HGOTO_ERROR(H5E_ARGS, H5E_BADVALUE, FAIL);
if(flags&(~H5ACC_OVERWRITE)!=0) /* check for valid flags */
HGOTO_ERROR(H5E_ARGS, H5E_BADVALUE, FAIL);
/* See if this file is already open */
if(H5Asearch_atom(H5_FILE,H5F_compare_filename,(const VOIDP)filename)!=NULL)
HGOTO_ERROR(H5E_FILE, H5E_FILEOPEN, FAIL);
/* Check if the file already exists */
f_handle=H5F_OPEN(filename,0);
if(!H5F_OPENERR(f_handle))
{
file_exists=1; /* set the flag to indicate that the file already exists */
H5F_CLOSE(f_handle); /* close the file we opened */
f_handle=H5F_INVALID_FILE;
} /* end if */
/* throw an error if the file exists and we aren't allowed to overwrite it */
if((flags&H5ACC_OVERWRITE)==0 && file_exists)
HGOTO_ERROR(H5E_FILE, H5E_FILEEXISTS, FAIL);
/* OK to create/overwrite the file */
f_handle=H5F_CREATE(filename);
if(H5F_OPENERR(f_handle))
HGOTO_ERROR(H5E_FILE, H5E_CANTCREATE, FAIL);
/* Create the file node */
if (NULL==(new_file=H5F_new()))
HGOTO_ERROR(H5E_RESOURCE, H5E_NOSPACE, FAIL);
/* Set the non-zero elements of the file structure */
new_file->dir=HDgetcwd(NULL,0); /* get the directory we just created the file within */
new_file->filename=HDstrdup(filename); /* make a copy of the filename */
new_file->acc_perm=H5ACC_WRITE; /* all new files we create have write permission */
new_file->file_handle=f_handle; /* keep the file handle we just opened */
new_file->ref_count=1; /* only 1 fid handed out so far */
new_file->consist_flags=0x03; /* Set file-consistency flags: write-access and "file is consistent" */
new_file->smallobj_off=0; /* Set the offset of the small-object heap */
new_file->freespace_off=0; /* Set the offset of the free-space info */
/* Get the file-creation template & record it */
if(create_temp==0)
create_temp=H5C_get_default_atom(H5_TEMPLATE);
if((f_create_parms=H5Aatom_object(create_temp))==NULL)
HGOTO_ERROR(H5E_ATOM, H5E_BADATOM, FAIL);
HDmemcpy(&new_file->file_create_parms,f_create_parms,sizeof(file_create_temp_t));
#ifdef LATER
/* Get the file-access template & record it */
if(access_temp==0)
access_temp=H5CPget_default_atom(H5_TEMPLATE);
if((f_access_parms=H5Aatom_object(access_temp))==NULL)
HGOTO_ERROR(H5E_ATOM, H5E_BADATOM, FAIL);
HDmemcpy(&new_file->file_access_parms,f_access_parms,sizeof(file_access_temp_t));
#endif /* LATER */
/* Create the basic skeleton of the file */
/* Seek to the correct offset to write out the file signature & boot-block */
if(new_file->file_create_parms.userblock_size>0)
if(H5F_SEEK(new_file->file_handle,new_file->file_create_parms.userblock_size)==FAIL)
HGOTO_ERROR(H5E_IO, H5E_SEEKERROR, FAIL);
/* Write out the file-signature */
if(H5F_WRITE(new_file->file_handle,HDF5_FILE_SIGNATURE,HDF5_FILE_SIGNATURE_LEN)==FAIL)
HGOTO_ERROR(H5E_IO, H5E_WRITEERROR, FAIL);
/* Encode the boot block */
p=temp_buf;
*p++=f_create_parms->bootblock_ver; /* Encode Boot-block version # */
*p++=f_create_parms->smallobject_ver; /* Encode Small-Object Heap version # */
*p++=f_create_parms->freespace_ver; /* Encode Free-Space Info version # */
*p++=f_create_parms->objectdir_ver; /* Encode Object Directory Format version # */
*p++=f_create_parms->sharedheader_ver; /* Encode Shared-Header Info version # */
*p++=f_create_parms->offset_size; /* Encode the number of bytes for the offset */
*p++=f_create_parms->length_size; /* Encode the number of bytes for the length */
*p++=0; /* Encode the reserved byte :-) */
UINT32ENCODE(p,f_create_parms->btree_page_size); /* Encode the B-Tree page size */
UINT32ENCODE(p,new_file->consist_flags); /* Encode File-Consistancy flags */
H5F_encode_offset(new_file,p,new_file->smallobj_off); /* Encode offset of global small-object heap */
H5F_encode_offset(new_file,p,new_file->freespace_off); /* Encode offset of global free-space heap */
/* Predict the header length and encode it: */
H5F_encode_length(new_file,p,((p-temp_buf) +
H5F_SIZEOF_SIZE(new_file) +
H5G_SIZEOF_ENTRY(new_file)));
/* Encode the uninitialized root symbol-table entry, by adding it to the boot block */
if (H5G_encode (new_file, &p, new_file->root_sym)<0)
HGOTO_ERROR (H5E_IO, H5E_WRITEERROR, FAIL);
/* Write out the boot block */
if(H5F_WRITE(new_file->file_handle,temp_buf,(size_t)(p-temp_buf))==FAIL)
HGOTO_ERROR(H5E_IO, H5E_WRITEERROR, FAIL);
new_file->logical_len = p - temp_buf;
/* Get an atom for the file */
if((ret_value=H5Aregister_atom(H5_FILE, new_file))==FAIL)
HGOTO_ERROR(H5E_ATOM, H5E_CANTREGISTER, FAIL);
done:
if(ret_value == FAIL)
{ /* Error condition cleanup */
/* Check if we left a dangling file handle */
if(f_handle!=H5F_INVALID_FILE)
H5F_CLOSE(f_handle); /* close the file we opened */
/* Check if we left a dangling file struct */
if (new_file)
H5F_dest (new_file);
}
/* Normal function cleanup */
FUNC_LEAVE(ret_value);
} /* end H5Fcreate() */
/*--------------------------------------------------------------------------
NAME
H5Fopen
PURPOSE
Open an existing HDF5 file.
USAGE
hatom_t H5Fopen(filename, flags, access_temp)
const char *filename; IN: Name of the file to create
uintn flags; IN: Flags to indicate various options.
hatom_t access_temp; IN: File-access template
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().
--------------------------------------------------------------------------*/
hatom_t H5Fopen(const char *filename, uintn flags, hatom_t access_temp)
{
hdf5_file_t *new_file=NULL; /* file struct for new file */
hdf_file_t f_handle=H5F_INVALID_FILE; /* file handle */
hatom_t create_temp; /* file-creation template ID */
const file_create_temp_t *f_create_parms; /* pointer to the parameters to use when creating the file */
uint8 temp_buf[2048], *p; /* temporary buffer for encoding header */
haddr_t curr_off=0; /* The current offset to check in the file */
size_t file_len=0; /* The length of the file we are checking */
hatom_t ret_value = FAIL;
size_t variable_size; /*size of the variable part of the bb */
FUNC_ENTER(H5Fopen, H5F_init_interface, FAIL);
/* Clear errors and check args and all the boring stuff. */
H5ECLEAR;
if(filename==NULL)
HGOTO_ERROR(H5E_ARGS, H5E_BADRANGE, FAIL);
/* See if this file is already open */
new_file=H5Asearch_atom(H5_FILE,H5F_compare_filename,(const VOIDP)filename);
/* If the file is already open, check the access permissions and go ahead with it */
if(new_file!=NULL && new_file->acc_perm==flags)
{
/* Get an atom for the file */
new_file->ref_count++; /* increment the reference count for the file */
if((ret_value=H5Aregister_atom(H5_FILE, new_file))==FAIL)
HGOTO_ERROR(H5E_ATOM, H5E_CANTREGISTER, FAIL);
HGOTO_DONE(ret_value);
} /* end if */
/*
* If the file exists but has different permissions or if it's a new file,
* start a new file handle for it, etc.
*/
if(H5Fis_hdf5(filename)==BFALSE)
HGOTO_ERROR(H5E_FILE, H5E_NOTHDF5, FAIL);
/* Check if the file already exists */
f_handle=H5F_OPEN(filename,flags);
if(H5F_OPENERR(f_handle))
HGOTO_ERROR(H5E_FILE, H5E_CANTOPEN, FAIL);
/* Create the file node */
if (NULL==(new_file=H5F_new()))
HGOTO_ERROR(H5E_RESOURCE, H5E_NOSPACE, FAIL);
/* Set the non-zero elements of the file structure */
new_file->dir=HDgetcwd(NULL,0); /* get the directory we just created the file within */
new_file->filename=HDstrdup(filename); /* make a copy of the filename */
new_file->acc_perm=flags; /* set the access permissions */
new_file->file_handle=f_handle; /* keep the file handle we just opened */
new_file->ref_count=1; /* only 1 fid handed out so far */
create_temp=H5C_get_default_atom(H5_TEMPLATE);
if((f_create_parms=H5Aatom_object(create_temp))==NULL)
HGOTO_ERROR(H5E_ATOM, H5E_BADATOM, FAIL);
HDmemcpy(&new_file->file_create_parms,f_create_parms,sizeof(file_create_temp_t));
#ifdef LATER
if(access_temp<=0)
access_temp=H5CPget_default_atom(H5_TEMPLATE);
if((f_access_parms=H5Aatom_object(access_temp))==NULL)
HGOTO_ERROR(H5E_ATOM, H5E_BADATOM, FAIL);
HDmemcpy(&new_file->file_access_parms,f_access_parms,sizeof(file_access_temp_t));
#endif /* LATER */
/* Read the basic skeleton of the file */
/* Seek to the correct offset to read in the file signature & boot-block */
/* Get the length of the file */
if(H5F_SEEKEND(new_file->file_handle)==FAIL)
HGOTO_ERROR(H5E_IO, H5E_SEEKERROR, BFAIL);
file_len=H5F_TELL(new_file->file_handle);
/* Check the offsets where the file signature is possible */
while(curr_off<file_len)
{
if(H5F_SEEK(new_file->file_handle,curr_off)==FAIL)
HGOTO_ERROR(H5E_IO, H5E_READERROR, BFAIL);
if(H5F_READ(new_file->file_handle,temp_buf, HDF5_FILE_SIGNATURE_LEN)==FAIL)
HGOTO_ERROR(H5E_IO, H5E_READERROR, BFAIL);
if(HDmemcmp(temp_buf,HDF5_FILE_SIGNATURE,HDF5_FILE_SIGNATURE_LEN)==0)
{
new_file->file_create_parms.userblock_size=curr_off;
break;
} /* end if */
if(curr_off==0)
curr_off=512;
else
curr_off*=2;
} /* end while */
if(curr_off>file_len)
HGOTO_ERROR(H5E_FILE, H5E_NOTHDF5, FAIL);
/* Read in the fixed-size part of the boot-block */
if(H5F_READ(new_file->file_handle,temp_buf,16)==FAIL)
HGOTO_ERROR(H5E_IO, H5E_READERROR, FAIL);
/* Decode fixed-size part of the boot block */
p=temp_buf;
new_file->file_create_parms.bootblock_ver=*p++; /* Decode Boot-block version # */
new_file->file_create_parms.smallobject_ver=*p++; /* Decode Small-Object Heap version # */
new_file->file_create_parms.freespace_ver=*p++; /* Decode Free-Space Info version # */
new_file->file_create_parms.objectdir_ver=*p++; /* Decode Object Directory Format version # */
new_file->file_create_parms.sharedheader_ver=*p++; /* Decode Shared-Header Info version # */
new_file->file_create_parms.offset_size=*p++; /* Decode the number of bytes for the offset */
new_file->file_create_parms.length_size=*p++; /* Decode the number of bytes for the length */
p++; /* Decode the reserved byte :-) */
UINT32DECODE(p,new_file->file_create_parms.btree_page_size); /* Decode the B-Tree page size */
UINT32DECODE(p,new_file->consist_flags); /* Decode File-Consistancy flags */
/* Read the variable-size part of the boot-block */
variable_size = H5F_SIZEOF_OFFSET(new_file) + /*offset of global small-object heap*/
H5F_SIZEOF_OFFSET(new_file) + /*offset of global free list*/
H5F_SIZEOF_SIZE(new_file) + /*logical size of HDF5 file*/
H5G_SIZEOF_ENTRY(new_file); /*root symbol table entry*/
if (H5F_READ(new_file->file_handle, temp_buf, variable_size)<0)
HGOTO_ERROR (H5E_IO, H5E_READERROR, FAIL);
/* Decode the variable-size part of the boot block */
p = temp_buf;
H5F_decode_offset(new_file,p,new_file->smallobj_off); /* Decode offset of global small-object heap */
H5F_decode_offset(new_file,p,new_file->freespace_off); /* Decode offset of global free-space heap */
H5F_decode_length(new_file,p,new_file->logical_len); /* Decode logical length of file */
/* Decode the root symbol table entry */
if (H5G_decode (new_file, &p, new_file->root_sym)<0) {
HGOTO_ERROR (H5E_IO, H5E_READERROR, FAIL);
}
/* Get an atom for the file */
if((ret_value=H5Aregister_atom(H5_FILE, new_file))==FAIL)
HGOTO_ERROR(H5E_ATOM, H5E_CANTREGISTER, FAIL);
done:
if(ret_value == FAIL)
{ /* Error condition cleanup */
/* Check if we left a dangling file handle */
if(f_handle!=H5F_INVALID_FILE)
H5F_CLOSE(f_handle); /* close the file we opened */
/* Check if we left a dangling file struct */
if(new_file) HDfree(new_file);
}
/* Normal function cleanup */
FUNC_LEAVE(ret_value);
} /* end H5Fopen() */
/*--------------------------------------------------------------------------
NAME
H5Fclose
PURPOSE
Close an open HDF5 file.
USAGE
int32 H5Fclose(fid)
int32 fid; IN: File ID of file to close
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().
--------------------------------------------------------------------------*/
herr_t H5Fclose(hatom_t fid)
{
hdf5_file_t *file=NULL; /* file struct for file to close */
herr_t ret_value = SUCCEED;
FUNC_ENTER(H5Fclose, H5F_init_interface, FAIL);
/* Clear errors and check args and all the boring stuff. */
H5ECLEAR;
if(H5Aatom_group(fid)!=H5_FILE)
HGOTO_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL);
/* Get the file handle to close */
if((file=H5Aatom_object(fid))==NULL)
HGOTO_ERROR(H5E_ATOM, H5E_BADATOM, FAIL);
/* Decrement the ref. count and recycle the file structure */
if((--file->ref_count)==0)
{
H5AC_flush (file, NULL, 0, TRUE);
if(file->file_handle!=H5F_INVALID_FILE) {
H5F_CLOSE(file->file_handle);
}
H5F_dest (file);
if(H5Aremove_atom(fid)==NULL) {
HGOTO_ERROR(H5E_ATOM, H5E_BADATOM, FAIL);
}
} /* end if */
done:
if(ret_value == FAIL)
{ /* Error condition cleanup */
} /* end if */
/* Normal function cleanup */
FUNC_LEAVE(ret_value);
} /* end H5Fclose() */
/*-------------------------------------------------------------------------
* Function: H5F_block_read
*
* Purpose: Reads some data from a file/server/etc into a buffer.
* The data is contiguous.
*
* Return: Success: SUCCEED
*
* Failure: FAIL
*
* Programmer: Robb Matzke
* matzke@llnl.gov
* Jul 10 1997
*
* Modifications:
*
*-------------------------------------------------------------------------
*/
herr_t
H5F_block_read (hdf5_file_t *f, haddr_t addr, size_t size, void *buf)
{
FUNC_ENTER (H5F_block_read, H5F_init_interface, FAIL);
if (0==size) return 0;
addr += f->file_create_parms.userblock_size;
if (H5F_SEEK (f->file_handle, addr)<0) {
HRETURN_ERROR (H5E_IO, H5E_SEEKERROR, FAIL);
}
if (H5F_READ (f->file_handle, buf, size)<0) {
HRETURN_ERROR (H5E_IO, H5E_READERROR, FAIL);
}
FUNC_LEAVE (SUCCEED);
}
/*-------------------------------------------------------------------------
* Function: H5F_block_write
*
* Purpose: Writes some data from memory to a file/server/etc. The
* data is contiguous.
*
* Return: Success: SUCCEED
*
* Failure: FAIL
*
* Programmer: Robb Matzke
* matzke@llnl.gov
* Jul 10 1997
*
* Modifications:
*
*-------------------------------------------------------------------------
*/
herr_t
H5F_block_write (hdf5_file_t *f, haddr_t addr, size_t size, void *buf)
{
FUNC_ENTER (H5F_block_write, H5F_init_interface, FAIL);
if (0==size) return 0;
addr += f->file_create_parms.userblock_size;
if (H5F_SEEK (f->file_handle, addr)<0) {
HRETURN_ERROR (H5E_IO, H5E_SEEKERROR, FAIL);
}
if (H5F_WRITE (f->file_handle, buf, size)<0) {
HRETURN_ERROR (H5E_IO, H5E_WRITEERROR, FAIL);
}
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.
*
* Return: Success: SUCCEED
*
* Failure: FAIL
*
* Programmer: Robb Matzke
* matzke@llnl.gov
* Aug 1 1997
*
* Modifications:
*
*-------------------------------------------------------------------------
*/
herr_t
H5F_debug (hdf5_file_t *f, haddr_t addr, FILE *stream, intn indent,
intn fwidth)
{
FUNC_ENTER (H5F_debug, H5F_init_interface, FAIL);
/* check args */
assert (f);
assert (addr>=0);
assert (stream);
assert (indent>=0);
assert (fwidth>=0);
/* debug */
fprintf (stream, "%*sFile Boot Block...\n", indent, "");
fprintf (stream, "%*s%-*s %s\n", indent, "", fwidth,
"Directory:",
f->dir);
fprintf (stream, "%*s%-*s %s\n", indent, "", fwidth,
"File name:",
f->filename);
fprintf (stream, "%*s%-*s 0x%08x\n", indent, "", fwidth,
"Permissions",
(unsigned)(f->acc_perm));
fprintf (stream, "%*s%-*s %u\n", indent, "", fwidth,
"Reference count:",
(unsigned)(f->ref_count));
fprintf (stream, "%*s%-*s 0x%08lx\n", indent, "", fwidth,
"Consistency flags:",
(unsigned long)(f->consist_flags));
fprintf (stream, "%*s%-*s %ld\n", indent, "", fwidth,
"Small object heap address:",
(long)(f->smallobj_off));
fprintf (stream, "%*s%-*s %ld\n", indent, "", fwidth,
"Free list address:",
(long)(f->freespace_off));
fprintf (stream, "%*s%-*s %lu\n", indent, "", fwidth,
"Logical file length:",
(unsigned long)(f->logical_len));
fprintf (stream, "%*s%-*s %lu\n", indent, "", fwidth,
"Size of user block:",
(unsigned long)(f->file_create_parms.userblock_size));
fprintf (stream, "%*s%-*s %u\n", indent, "", fwidth,
"Size of file size_t type:",
(unsigned)(f->file_create_parms.offset_size));
fprintf (stream, "%*s%-*s %u\n", indent, "", fwidth,
"Size of file off_t type:",
(unsigned)(f->file_create_parms.length_size));
fprintf (stream, "%*s%-*s %u\n", indent, "", fwidth,
"Bytes per B-tree page:",
(unsigned)(f->file_create_parms.btree_page_size));
fprintf (stream, "%*s%-*s %u\n", indent, "", fwidth,
"Boot block version number:",
(unsigned)(f->file_create_parms.bootblock_ver));
fprintf (stream, "%*s%-*s %u\n", indent, "", fwidth,
"Small object heap version number:",
(unsigned)(f->file_create_parms.smallobject_ver));
fprintf (stream, "%*s%-*s %u\n", indent, "", fwidth,
"Free list version number:",
(unsigned)(f->file_create_parms.freespace_ver));
fprintf (stream, "%*s%-*s %u\n", indent, "", fwidth,
"Object directory version number:",
(unsigned)(f->file_create_parms.objectdir_ver));
fprintf (stream, "%*s%-*s %u\n", indent, "", fwidth,
"Shared header version number:",
(unsigned)(f->file_create_parms.sharedheader_ver));
FUNC_LEAVE (SUCCEED);
}
|