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
|
/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
* Copyright by The HDF Group. *
* Copyright by the Board of Trustees of the University of Illinois. *
* All rights reserved. *
* *
* This file is part of HDF5. The full HDF5 copyright notice, including *
* terms governing use, modification, and redistribution, is contained in *
* the files COPYING and Copyright.html. COPYING can be found at the root *
* of the source code distribution tree; Copyright.html can be found at the *
* root level of an installed copy of the electronic HDF5 document set and *
* is linked from the top-level documents page. It can also be found at *
* http://hdfgroup.org/HDF5/doc/Copyright.html. If you do not have *
* access to either file, you may request a copy from help@hdfgroup.org. *
* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
/*-------------------------------------------------------------------------
*
* Created: H5Fquery.c
* Jan 10 2008
* Quincey Koziol <koziol@hdfgroup.org>
*
* Purpose: File structure query routines.
*
*-------------------------------------------------------------------------
*/
/****************/
/* Module Setup */
/****************/
#define H5F_PACKAGE /*suppress error about including H5Fpkg */
/***********/
/* Headers */
/***********/
#include "H5private.h" /* Generic Functions */
#include "H5Eprivate.h" /* Error handling */
#include "H5Fpkg.h" /* File access */
#include "H5FDprivate.h" /* File drivers */
/****************/
/* Local Macros */
/****************/
/******************/
/* Local Typedefs */
/******************/
/********************/
/* Package Typedefs */
/********************/
/********************/
/* Local Prototypes */
/********************/
/*********************/
/* Package Variables */
/*********************/
/*****************************/
/* Library Private Variables */
/*****************************/
/*******************/
/* Local Variables */
/*******************/
/*-------------------------------------------------------------------------
* Function: H5F_get_intent
*
* Purpose: Quick and dirty routine to retrieve the file's 'intent' flags
* (Mainly added to stop non-file routines from poking about in the
* H5F_t data structure)
*
* Return: 'intent' on success/abort on failure (shouldn't fail)
*
* Programmer: Quincey Koziol <koziol@ncsa.uiuc.edu>
* September 29, 2000
*
*-------------------------------------------------------------------------
*/
unsigned
H5F_get_intent(const H5F_t *f)
{
/* Use FUNC_ENTER_NOAPI_NOINIT_NOERR here to avoid performance issues */
FUNC_ENTER_NOAPI_NOINIT_NOERR
HDassert(f);
FUNC_LEAVE_NOAPI(f->intent)
} /* end H5F_get_intent() */
/*-------------------------------------------------------------------------
* Function: H5F_get_open_name
*
* Purpose: Retrieve the name used to open a file.
*
* Return: Success: The name of the file.
* Failure: ? (should not happen)
*
* Programmer: Neil Fortner
* December 15 2008
*
*-------------------------------------------------------------------------
*/
char *
H5F_get_open_name(const H5F_t *f)
{
/* Use FUNC_ENTER_NOAPI_NOINIT_NOERR here to avoid performance issues */
FUNC_ENTER_NOAPI_NOINIT_NOERR
HDassert(f);
HDassert(f->open_name);
FUNC_LEAVE_NOAPI(f->open_name)
} /* end H5F_get_open_name() */
/*-------------------------------------------------------------------------
* Function: H5F_get_actual_name
*
* Purpose: Retrieve the actual name of a file, after resolving symlinks, etc.
*
* Return: Success: The name of the file.
* Failure: ? (should not happen)
*
* Programmer: Quincey Koziol
* November 25 2009
*
*-------------------------------------------------------------------------
*/
char *
H5F_get_actual_name(const H5F_t *f)
{
/* Use FUNC_ENTER_NOAPI_NOINIT_NOERR here to avoid performance issues */
FUNC_ENTER_NOAPI_NOINIT_NOERR
HDassert(f);
HDassert(f->actual_name);
FUNC_LEAVE_NOAPI(f->actual_name)
} /* end H5F_get_actual_name() */
/*-------------------------------------------------------------------------
* Function: H5F_get_extpath
*
* Purpose: Retrieve the file's 'extpath' flags
* This is used by H5L_extern_traverse() to retrieve the main file's location
* when searching the target file.
*
* Return: 'extpath' on success/abort on failure (shouldn't fail)
*
* Programmer: Vailin Choi, April 2, 2008
*
*-------------------------------------------------------------------------
*/
char *
H5F_get_extpath(const H5F_t *f)
{
/* Use FUNC_ENTER_NOAPI_NOINIT_NOERR here to avoid performance issues */
FUNC_ENTER_NOAPI_NOINIT_NOERR
HDassert(f);
HDassert(f->extpath);
FUNC_LEAVE_NOAPI(f->extpath)
} /* end H5F_get_extpath() */
/*-------------------------------------------------------------------------
* Function: H5F_get_shared
*
* Purpose: Retrieve the file's 'shared' pointer
*
* Return: 'shared' on success/abort on failure (shouldn't fail)
*
* Programmer: Quincey Koziol, July 20, 2011
*
*-------------------------------------------------------------------------
*/
H5F_file_t *
H5F_get_shared(const H5F_t *f)
{
/* Use FUNC_ENTER_NOAPI_NOINIT_NOERR here to avoid performance issues */
FUNC_ENTER_NOAPI_NOINIT_NOERR
HDassert(f);
FUNC_LEAVE_NOAPI(f->shared)
} /* end H5F_get_shared() */
/*-------------------------------------------------------------------------
* Function: H5F_same_shared
*
* Purpose: Determine if two files have the same shared file pointer
*
* Return: TRUE/FALSE on success/abort on failure (shouldn't fail)
*
* Programmer: Quincey Koziol, July 19, 2011
*
*-------------------------------------------------------------------------
*/
hbool_t
H5F_same_shared(const H5F_t *f1, const H5F_t *f2)
{
/* Use FUNC_ENTER_NOAPI_NOINIT_NOERR here to avoid performance issues */
FUNC_ENTER_NOAPI_NOINIT_NOERR
HDassert(f1);
HDassert(f1->shared);
HDassert(f2);
HDassert(f2->shared);
FUNC_LEAVE_NOAPI(f1->shared == f2->shared)
} /* end H5F_same_shared() */
/*-------------------------------------------------------------------------
* Function: H5F_get_nopen_objs
*
* Purpose: Retrieve the file's 'nopen_objs' value
*
* Return: 'nopen_objs' on success/abort on failure (shouldn't fail)
*
* Programmer: Quincey Koziol, July 20, 2011
*
*-------------------------------------------------------------------------
*/
unsigned
H5F_get_nopen_objs(const H5F_t *f)
{
/* Use FUNC_ENTER_NOAPI_NOINIT_NOERR here to avoid performance issues */
FUNC_ENTER_NOAPI_NOINIT_NOERR
HDassert(f);
FUNC_LEAVE_NOAPI(f->nopen_objs)
} /* end H5F_get_nopen_objs() */
/*-------------------------------------------------------------------------
* Function: H5F_get_file_id
*
* Purpose: Retrieve the file's 'file_id' value
*
* Return: 'file_id' on success/abort on failure (shouldn't fail)
*
* Programmer: Quincey Koziol, July 20, 2011
*
*-------------------------------------------------------------------------
*/
hid_t
H5F_get_file_id(const H5F_t *f)
{
/* Use FUNC_ENTER_NOAPI_NOINIT_NOERR here to avoid performance issues */
FUNC_ENTER_NOAPI_NOINIT_NOERR
HDassert(f);
FUNC_LEAVE_NOAPI(f->file_id)
} /* end H5F_get_file_id() */
/*-------------------------------------------------------------------------
* Function: H5F_get_parent
*
* Purpose: Retrieve the file's 'parent' pointer
*
* Return: 'parent' on success/abort on failure (shouldn't fail)
*
* Programmer: Quincey Koziol, July 19, 2011
*
*-------------------------------------------------------------------------
*/
H5F_t *
H5F_get_parent(const H5F_t *f)
{
/* Use FUNC_ENTER_NOAPI_NOINIT_NOERR here to avoid performance issues */
FUNC_ENTER_NOAPI_NOINIT_NOERR
HDassert(f);
FUNC_LEAVE_NOAPI(f->parent)
} /* end H5F_get_parent() */
/*-------------------------------------------------------------------------
* Function: H5F_get_nmounts
*
* Purpose: Retrieve the file's 'nmounts' value
*
* Return: 'nmounts' on success/abort on failure (shouldn't fail)
*
* Programmer: Quincey Koziol, July 20, 2011
*
*-------------------------------------------------------------------------
*/
unsigned
H5F_get_nmounts(const H5F_t *f)
{
/* Use FUNC_ENTER_NOAPI_NOINIT_NOERR here to avoid performance issues */
FUNC_ENTER_NOAPI_NOINIT_NOERR
HDassert(f);
FUNC_LEAVE_NOAPI(f->nmounts)
} /* end H5F_get_nmounts() */
/*-------------------------------------------------------------------------
* Function: H5F_get_read_attempts
*
* Purpose: Retrieve the file's 'read_attempts' value
*
* Return: '# of read attempts' on success/abort on failure (shouldn't fail)
*
* Programmer: Vaili Choi; Sept 2013
*
*-------------------------------------------------------------------------
*/
unsigned
H5F_get_read_attempts(const H5F_t *f)
{
/* Use FUNC_ENTER_NOAPI_NOINIT_NOERR here to avoid performance issues */
FUNC_ENTER_NOAPI_NOINIT_NOERR
HDassert(f);
FUNC_LEAVE_NOAPI(f->read_attempts)
} /* end H5F_get_read_attempts() */
/*-------------------------------------------------------------------------
* Function: H5F_get_fcpl
*
* Purpose: Retrieve the value of a file's FCPL.
*
* Return: Success: The FCPL for the file.
*
* Failure: ? (should not happen)
*
* Programmer: Quincey Koziol
* koziol@ncsa.uiuc.edu
* May 25 2005
*
*-------------------------------------------------------------------------
*/
hid_t
H5F_get_fcpl(const H5F_t *f)
{
/* Use FUNC_ENTER_NOAPI_NOINIT_NOERR here to avoid performance issues */
FUNC_ENTER_NOAPI_NOINIT_NOERR
HDassert(f);
HDassert(f->shared);
FUNC_LEAVE_NOAPI(f->shared->fcpl_id)
} /* end H5F_get_fcpl() */
/*-------------------------------------------------------------------------
* Function: H5F_sizeof_addr
*
* Purpose: Quick and dirty routine to retrieve the size of the file's size_t
* (Mainly added to stop non-file routines from poking about in the
* H5F_t data structure)
*
* Return: 'sizeof_addr' on success/abort on failure (shouldn't fail)
*
* Programmer: Quincey Koziol <koziol@ncsa.uiuc.edu>
* September 29, 2000
*
*-------------------------------------------------------------------------
*/
uint8_t
H5F_sizeof_addr(const H5F_t *f)
{
/* Use FUNC_ENTER_NOAPI_NOINIT_NOERR here to avoid performance issues */
FUNC_ENTER_NOAPI_NOINIT_NOERR
HDassert(f);
HDassert(f->shared);
FUNC_LEAVE_NOAPI(f->shared->sizeof_addr)
} /* end H5F_sizeof_addr() */
/*-------------------------------------------------------------------------
* Function: H5F_sizeof_size
*
* Purpose: Quick and dirty routine to retrieve the size of the file's off_t
* (Mainly added to stop non-file routines from poking about in the
* H5F_t data structure)
*
* Return: 'sizeof_size' on success/abort on failure (shouldn't fail)
*
* Programmer: Quincey Koziol <koziol@ncsa.uiuc.edu>
* September 29, 2000
*
*-------------------------------------------------------------------------
*/
uint8_t
H5F_sizeof_size(const H5F_t *f)
{
/* Use FUNC_ENTER_NOAPI_NOINIT_NOERR here to avoid performance issues */
FUNC_ENTER_NOAPI_NOINIT_NOERR
HDassert(f);
HDassert(f->shared);
FUNC_LEAVE_NOAPI(f->shared->sizeof_size)
} /* H5F_sizeof_size() */
/*-------------------------------------------------------------------------
* Function: H5F_get_sohm_addr
*
* Purpose: Retrieve the file's 'sohm_addr' value
*
* Return: 'sohm_addr' on success/abort on failure (shouldn't fail)
*
* Programmer: Quincey Koziol, July 20, 2011
*
*-------------------------------------------------------------------------
*/
haddr_t
H5F_get_sohm_addr(const H5F_t *f)
{
/* Use FUNC_ENTER_NOAPI_NOINIT_NOERR here to avoid performance issues */
FUNC_ENTER_NOAPI_NOINIT_NOERR
HDassert(f);
HDassert(f->shared);
FUNC_LEAVE_NOAPI(f->shared->sohm_addr)
} /* end H5F_get_sohm_addr() */
/*-------------------------------------------------------------------------
* Function: H5F_get_sohm_vers
*
* Purpose: Retrieve the file's 'sohm_vers' value
*
* Return: 'sohm_vers' on success/abort on failure (shouldn't fail)
*
* Programmer: Quincey Koziol, July 20, 2011
*
*-------------------------------------------------------------------------
*/
unsigned
H5F_get_sohm_vers(const H5F_t *f)
{
/* Use FUNC_ENTER_NOAPI_NOINIT_NOERR here to avoid performance issues */
FUNC_ENTER_NOAPI_NOINIT_NOERR
HDassert(f);
HDassert(f->shared);
FUNC_LEAVE_NOAPI(f->shared->sohm_vers)
} /* end H5F_get_sohm_vers() */
/*-------------------------------------------------------------------------
* Function: H5F_get_sohm_nindexes
*
* Purpose: Retrieve the file's 'sohm_nindexes' value
*
* Return: 'sohm_nindexes' on success/abort on failure (shouldn't fail)
*
* Programmer: Quincey Koziol, July 20, 2011
*
*-------------------------------------------------------------------------
*/
unsigned
H5F_get_sohm_nindexes(const H5F_t *f)
{
/* Use FUNC_ENTER_NOAPI_NOINIT_NOERR here to avoid performance issues */
FUNC_ENTER_NOAPI_NOINIT_NOERR
HDassert(f);
HDassert(f->shared);
FUNC_LEAVE_NOAPI(f->shared->sohm_nindexes)
} /* end H5F_get_sohm_nindexes() */
/*-------------------------------------------------------------------------
* Function: H5F_sym_leaf_k
*
* Purpose: Replaced a macro to retrieve the symbol table leaf size,
* now that the generic properties are being used to store
* the values.
*
* Return: Success: Non-negative, and the symbol table leaf size is
* returned.
*
* Failure: Negative (should not happen)
*
* Programmer: Raymond Lu
* slu@ncsa.uiuc.edu
* Oct 14 2001
*
*-------------------------------------------------------------------------
*/
unsigned
H5F_sym_leaf_k(const H5F_t *f)
{
/* Use FUNC_ENTER_NOAPI_NOINIT_NOERR here to avoid performance issues */
FUNC_ENTER_NOAPI_NOINIT_NOERR
HDassert(f);
HDassert(f->shared);
HDassert(f->shared->sblock);
FUNC_LEAVE_NOAPI(f->shared->sblock->sym_leaf_k)
} /* end H5F_sym_leaf_k() */
/*-------------------------------------------------------------------------
* Function: H5F_Kvalue
*
* Purpose: Replaced a macro to retrieve a B-tree key value for a certain
* type, now that the generic properties are being used to store
* the B-tree values.
*
* Return: Success: Non-negative, and the B-tree key value is
* returned.
*
* Failure: Negative (should not happen)
*
* Programmer: Raymond Lu
* slu@ncsa.uiuc.edu
* Oct 14 2001
*
*-------------------------------------------------------------------------
*/
unsigned
H5F_Kvalue(const H5F_t *f, const H5B_class_t *type)
{
/* Use FUNC_ENTER_NOAPI_NOINIT_NOERR here to avoid performance issues */
FUNC_ENTER_NOAPI_NOINIT_NOERR
HDassert(f);
HDassert(f->shared);
HDassert(f->shared->sblock);
HDassert(type);
FUNC_LEAVE_NOAPI(f->shared->sblock->btree_k[type->id])
} /* end H5F_Kvalue() */
/*-------------------------------------------------------------------------
* Function: H5F_get_nrefs
*
* Purpose: Retrieve the file's 'nrefs' value
*
* Return: 'nrefs' on success/abort on failure (shouldn't fail)
*
* Programmer: Quincey Koziol, July 20, 2011
*
*-------------------------------------------------------------------------
*/
unsigned
H5F_get_nrefs(const H5F_t *f)
{
/* Use FUNC_ENTER_NOAPI_NOINIT_NOERR here to avoid performance issues */
FUNC_ENTER_NOAPI_NOINIT_NOERR
HDassert(f);
HDassert(f->shared);
FUNC_LEAVE_NOAPI(f->shared->nrefs)
} /* end H5F_get_nrefs() */
/*-------------------------------------------------------------------------
* Function: H5F_rdcc_nslots
*
* Purpose: Replaced a macro to retrieve the raw data cache number of slots,
* now that the generic properties are being used to store
* the values.
*
* Return: Success: Non-negative, and the raw data cache number of
* of slots is returned.
*
* Failure: Negative (should not happen)
*
* Programmer: Quincey Koziol
* koziol@ncsa.uiuc.edu
* Jun 1 2004
*
*-------------------------------------------------------------------------
*/
size_t
H5F_rdcc_nslots(const H5F_t *f)
{
/* Use FUNC_ENTER_NOAPI_NOINIT_NOERR here to avoid performance issues */
FUNC_ENTER_NOAPI_NOINIT_NOERR
HDassert(f);
HDassert(f->shared);
FUNC_LEAVE_NOAPI(f->shared->rdcc_nslots)
} /* end H5F_rdcc_nelmts() */
/*-------------------------------------------------------------------------
* Function: H5F_rdcc_nbytes
*
* Purpose: Replaced a macro to retrieve the raw data cache number of bytes,
* now that the generic properties are being used to store
* the values.
*
* Return: Success: Non-negative, and the raw data cache number of
* of bytes is returned.
*
* Failure: Negative (should not happen)
*
* Programmer: Quincey Koziol
* koziol@ncsa.uiuc.edu
* Jun 1 2004
*
*-------------------------------------------------------------------------
*/
size_t
H5F_rdcc_nbytes(const H5F_t *f)
{
/* Use FUNC_ENTER_NOAPI_NOINIT_NOERR here to avoid performance issues */
FUNC_ENTER_NOAPI_NOINIT_NOERR
HDassert(f);
HDassert(f->shared);
FUNC_LEAVE_NOAPI(f->shared->rdcc_nbytes)
} /* end H5F_rdcc_nbytes() */
/*-------------------------------------------------------------------------
* Function: H5F_rdcc_w0
*
* Purpose: Replaced a macro to retrieve the raw data cache 'w0' value
* now that the generic properties are being used to store
* the values.
*
* Return: Success: Non-negative, and the raw data cache 'w0' value
* is returned.
*
* Failure: Negative (should not happen)
*
* Programmer: Quincey Koziol
* koziol@ncsa.uiuc.edu
* Jun 2 2004
*
*-------------------------------------------------------------------------
*/
double
H5F_rdcc_w0(const H5F_t *f)
{
/* Use FUNC_ENTER_NOAPI_NOINIT_NOERR here to avoid performance issues */
FUNC_ENTER_NOAPI_NOINIT_NOERR
HDassert(f);
HDassert(f->shared);
FUNC_LEAVE_NOAPI(f->shared->rdcc_w0)
} /* end H5F_rdcc_w0() */
/*-------------------------------------------------------------------------
* Function: H5F_get_base_addr
*
* Purpose: Quick and dirty routine to retrieve the file's 'base_addr' value
* (Mainly added to stop non-file routines from poking about in the
* H5F_t data structure)
*
* Return: Non-negative on success/Negative on failure
*
* Programmer: Raymond Lu <slu@ncsa.uiuc.edu>
* December 20, 2002
*
*-------------------------------------------------------------------------
*/
haddr_t
H5F_get_base_addr(const H5F_t *f)
{
/* Use FUNC_ENTER_NOAPI_NOINIT_NOERR here to avoid performance issues */
FUNC_ENTER_NOAPI_NOINIT_NOERR
HDassert(f);
HDassert(f->shared);
HDassert(f->shared->sblock);
FUNC_LEAVE_NOAPI(f->shared->sblock->base_addr)
} /* end H5F_get_base_addr() */
/*-------------------------------------------------------------------------
* Function: H5F_grp_btree_shared
*
* Purpose: Replaced a macro to retrieve the shared B-tree node info
* now that the generic properties are being used to store
* the values.
*
* Return: Success: Non-void, and the shared B-tree node info
* is returned.
*
* Failure: void (should not happen)
*
* Programmer: Quincey Koziol
* koziol@ncsa.uiuc.edu
* Jul 5 2004
*
*-------------------------------------------------------------------------
*/
H5RC_t *
H5F_grp_btree_shared(const H5F_t *f)
{
/* Use FUNC_ENTER_NOAPI_NOINIT_NOERR here to avoid performance issues */
FUNC_ENTER_NOAPI_NOINIT_NOERR
HDassert(f);
HDassert(f->shared);
FUNC_LEAVE_NOAPI(f->shared->grp_btree_shared)
} /* end H5F_grp_btree_shared() */
/*-------------------------------------------------------------------------
* Function: H5F_sieve_buf_size
*
* Purpose: Replaced a macro to retrieve the dataset sieve buffer size
* now that the generic properties are being used to store
* the values.
*
* Return: Success: Non-void, and the dataset sieve buffer size
* is returned.
*
* Failure: void (should not happen)
*
* Programmer: Quincey Koziol
* koziol@ncsa.uiuc.edu
* Jul 8 2005
*
*-------------------------------------------------------------------------
*/
size_t
H5F_sieve_buf_size(const H5F_t *f)
{
/* Use FUNC_ENTER_NOAPI_NOINIT_NOERR here to avoid performance issues */
FUNC_ENTER_NOAPI_NOINIT_NOERR
HDassert(f);
HDassert(f->shared);
FUNC_LEAVE_NOAPI(f->shared->sieve_buf_size)
} /* end H5F_sieve_buf_size() */
/*-------------------------------------------------------------------------
* Function: H5F_gc_ref
*
* Purpose: Replaced a macro to retrieve the "garbage collect
* references flag" now that the generic properties are being used
* to store the values.
*
* Return: Success: The "garbage collect references flag"
* is returned.
*
* Failure: (should not happen)
*
* Programmer: Quincey Koziol
* koziol@ncsa.uiuc.edu
* Jul 8 2005
*
*-------------------------------------------------------------------------
*/
unsigned
H5F_gc_ref(const H5F_t *f)
{
/* Use FUNC_ENTER_NOAPI_NOINIT_NOERR here to avoid performance issues */
FUNC_ENTER_NOAPI_NOINIT_NOERR
HDassert(f);
HDassert(f->shared);
FUNC_LEAVE_NOAPI(f->shared->gc_ref)
} /* end H5F_gc_ref() */
/*-------------------------------------------------------------------------
* Function: H5F_use_latest_format
*
* Purpose: Retrieve the 'use the latest version of the format' flag for
* the file.
*
* Return: Success: Non-negative, the 'use the latest format' flag
*
* Failure: (can't happen)
*
* Programmer: Quincey Koziol
* koziol@hdfgroup.org
* Oct 2 2006
*
*-------------------------------------------------------------------------
*/
hbool_t
H5F_use_latest_format(const H5F_t *f)
{
/* Use FUNC_ENTER_NOAPI_NOINIT_NOERR here to avoid performance issues */
FUNC_ENTER_NOAPI_NOINIT_NOERR
HDassert(f);
HDassert(f->shared);
FUNC_LEAVE_NOAPI(f->shared->latest_format)
} /* end H5F_use_latest_format() */
/*-------------------------------------------------------------------------
* Function: H5F_get_fc_degree
*
* Purpose: Retrieve the 'file close degree' for the file.
*
* Return: Success: Non-negative, the 'file close degree'
*
* Failure: (can't happen)
*
* Programmer: Quincey Koziol
* koziol@hdfgroup.org
* Mar 5 2007
*
*-------------------------------------------------------------------------
*/
H5F_close_degree_t
H5F_get_fc_degree(const H5F_t *f)
{
/* Use FUNC_ENTER_NOAPI_NOINIT_NOERR here to avoid performance issues */
FUNC_ENTER_NOAPI_NOINIT_NOERR
HDassert(f);
HDassert(f->shared);
FUNC_LEAVE_NOAPI(f->shared->fc_degree)
} /* end H5F_get_fc_degree() */
/*-------------------------------------------------------------------------
* Function: H5F_store_msg_crt_idx
*
* Purpose: Retrieve the 'store message creation index' flag for the file.
*
* Return: Success: Non-negative, the 'store message creation index' flag
*
* Failure: (can't happen)
*
* Programmer: Quincey Koziol
* koziol@hdfgroup.org
* Mar 6 2007
*
*-------------------------------------------------------------------------
*/
hbool_t
H5F_store_msg_crt_idx(const H5F_t *f)
{
/* Use FUNC_ENTER_NOAPI_NOINIT_NOERR here to avoid performance issues */
FUNC_ENTER_NOAPI_NOINIT_NOERR
HDassert(f);
HDassert(f->shared);
FUNC_LEAVE_NOAPI(f->shared->store_msg_crt_idx)
} /* end H5F_store_msg_crt_idx() */
/*-------------------------------------------------------------------------
* Function: H5F_has_feature
*
* Purpose: Check if a file has a particular feature enabled
*
* Return: Success: Non-negative - TRUE or FALSE
* Failure: Negative (should not happen)
*
* Programmer: Quincey Koziol
* koziol@ncsa.uiuc.edu
* May 31 2004
*
*-------------------------------------------------------------------------
*/
hbool_t
H5F_has_feature(const H5F_t *f, unsigned feature)
{
/* Use FUNC_ENTER_NOAPI_NOINIT_NOERR here to avoid performance issues */
FUNC_ENTER_NOAPI_NOINIT_NOERR
HDassert(f);
HDassert(f->shared);
FUNC_LEAVE_NOAPI((hbool_t)(f->shared->lf->feature_flags&feature))
} /* end H5F_has_feature() */
/*-------------------------------------------------------------------------
* Function: H5F_get_driver_id
*
* Purpose: Quick and dirty routine to retrieve the file's 'driver_id' value
* (Mainly added to stop non-file routines from poking about in the
* H5F_t data structure)
*
* Return: 'driver_id' on success/abort on failure (shouldn't fail)
*
* Programmer: Quincey Koziol <koziol@ncsa.uiuc.edu>
* October 10, 2000
*
*-------------------------------------------------------------------------
*/
hid_t
H5F_get_driver_id(const H5F_t *f)
{
/* Use FUNC_ENTER_NOAPI_NOINIT_NOERR here to avoid performance issues */
FUNC_ENTER_NOAPI_NOINIT_NOERR
HDassert(f);
HDassert(f->shared);
HDassert(f->shared->lf);
FUNC_LEAVE_NOAPI(f->shared->lf->driver_id)
} /* end H5F_get_driver_id() */
/*-------------------------------------------------------------------------
* Function: H5F_get_fileno
*
* Purpose: Quick and dirty routine to retrieve the file's 'fileno' value
* (Mainly added to stop non-file routines from poking about in the
* H5F_t data structure)
*
* Return: Non-negative on success/Negative on failure
*
* Programmer: Quincey Koziol <koziol@ncsa.uiuc.edu>
* March 27, 2002
*
*-------------------------------------------------------------------------
*/
herr_t
H5F_get_fileno(const H5F_t *f, unsigned long *filenum)
{
herr_t ret_value = SUCCEED;
FUNC_ENTER_NOAPI(FAIL)
HDassert(f);
HDassert(f->shared);
HDassert(f->shared->lf);
HDassert(filenum);
/* Retrieve the file's serial number */
if(H5FD_get_fileno(f->shared->lf, filenum) < 0)
HGOTO_ERROR(H5E_FILE, H5E_BADRANGE, FAIL, "can't retrieve fileno")
done:
FUNC_LEAVE_NOAPI(ret_value)
} /* end H5F_get_fileno() */
/*-------------------------------------------------------------------------
* Function: H5F_get_eoa
*
* Purpose: Quick and dirty routine to retrieve the file's 'eoa' value
*
* Return: Non-negative on success/Negative on failure
*
* Programmer: Quincey Koziol <koziol@ncsa.uiuc.edu>
* June 1, 2004
*
*-------------------------------------------------------------------------
*/
haddr_t
H5F_get_eoa(const H5F_t *f, H5FD_mem_t type)
{
haddr_t ret_value;
FUNC_ENTER_NOAPI(HADDR_UNDEF)
HDassert(f);
HDassert(f->shared);
/* Dispatch to driver */
if(HADDR_UNDEF == (ret_value = H5FD_get_eoa(f->shared->lf, type)))
HGOTO_ERROR(H5E_VFL, H5E_CANTINIT, HADDR_UNDEF, "driver get_eoa request failed")
done:
FUNC_LEAVE_NOAPI(ret_value)
} /* end H5F_get_eoa() */
/*-------------------------------------------------------------------------
* Function: H5F_get_vfd_handle
*
* Purpose: Returns a pointer to the file handle of the low-level file
* driver. This is the private function for H5Fget_vfd_handle.
*
* Return: Success: Non-negative.
* Failure: negative.
*
* Programmer: Raymond Lu
* Sep. 16, 2002
*
*-------------------------------------------------------------------------
*/
herr_t
H5F_get_vfd_handle(const H5F_t *file, hid_t fapl, void **file_handle)
{
herr_t ret_value = SUCCEED; /* Return value */
FUNC_ENTER_NOAPI(FAIL)
/* Sanity check */
HDassert(file);
HDassert(file_handle);
/* Get the VFD handle */
if(H5FD_get_vfd_handle(file->shared->lf, fapl, file_handle) < 0)
HGOTO_ERROR(H5E_FILE, H5E_CANTGET, FAIL, "can't get file handle for file driver")
done:
FUNC_LEAVE_NOAPI(ret_value)
} /* end H5F_get_vfd_handle() */
/*-------------------------------------------------------------------------
* Function: H5F_is_tmp_addr
*
* Purpose: Quick and dirty routine to determine if an address is in
* the 'temporary' file space.
* (Mainly added to stop non-file routines from poking about in the
* H5F_t data structure)
*
* Return: TRUE/FALSE on success/abort on failure (shouldn't fail)
*
* Programmer: Quincey Koziol <koziol@hdfgroup.org>
* June 11, 2009
*
*-------------------------------------------------------------------------
*/
hbool_t
H5F_is_tmp_addr(const H5F_t *f, haddr_t addr)
{
/* Use FUNC_ENTER_NOAPI_NOINIT_NOERR here to avoid performance issues */
FUNC_ENTER_NOAPI_NOINIT_NOERR
HDassert(f);
HDassert(f->shared);
FUNC_LEAVE_NOAPI(H5F_addr_le(f->shared->tmp_addr, addr))
} /* end H5F_is_tmp_addr() */
/*-------------------------------------------------------------------------
* Function: H5F_use_tmp_space
*
* Purpose: Quick and dirty routine to determine if using temporary
* file space is allowed for this file.
* (Mainly added to stop non-file routines from poking about in the
* H5F_t data structure)
*
* Return: TRUE/FALSE on success/abort on failure (shouldn't fail)
*
* Programmer: Quincey Koziol <koziol@hdfgroup.org>
* July 1, 2009
*
*-------------------------------------------------------------------------
*/
hbool_t
H5F_use_tmp_space(const H5F_t *f)
{
/* Use FUNC_ENTER_NOAPI_NOINIT_NOERR here to avoid performance issues */
FUNC_ENTER_NOAPI_NOINIT_NOERR
HDassert(f);
HDassert(f->shared);
FUNC_LEAVE_NOAPI(f->shared->use_tmp_space)
} /* end H5F_use_tmp_space() */
|