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
|
/****************************************************************************
* 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$ */
#include <stdarg.h>
/* Private header files */
#include <H5private.h> /* Generic Functions */
#include <H5Aprivate.h> /* Atoms */
#include <H5Bprivate.h> /* B-tree subclass names */
#include <H5Pprivate.h> /* Template information */
#include <H5Dprivate.h> /* Datasets */
#include <H5Eprivate.h> /* Error handling */
#include <H5MMprivate.h> /* Memory management */
#define PABLO_MASK H5P_mask
/* Is the interface initialized? */
static hbool_t interface_initialize_g = FALSE;
#define INTERFACE_INIT H5P_init_interface
static herr_t H5P_init_interface(void);
/* PRIVATE PROTOTYPES */
static void H5P_term_interface(void);
/*--------------------------------------------------------------------------
NAME
H5P_init_interface -- Initialize interface-specific information
USAGE
herr_t H5P_init_interface()
RETURNS
SUCCEED/FAIL
DESCRIPTION
Initializes any interface-specific data or routines.
--------------------------------------------------------------------------*/
static herr_t
H5P_init_interface(void)
{
herr_t ret_value = SUCCEED;
intn i;
herr_t status;
FUNC_ENTER(H5P_init_interface, FAIL);
/*
* Make sure the file creation and file access default templates are
* initialized since this might be done at run-time instead of compile
* time.
*/
if (H5F_init_interface ()<0) {
HRETURN_ERROR (H5E_INTERNAL, H5E_CANTINIT, FAIL,
"unable to initialize H5F and H5P interfaces");
}
assert(H5P_NCLASSES <= H5_TEMPLATE_MAX - H5_TEMPLATE_0);
/*
* Initialize the mappings between template classes and atom groups. We
* keep the two separate because template classes are publicly visible but
* atom groups aren't.
*/
for (i = 0; i < H5P_NCLASSES; i++) {
status = H5A_init_group((group_t)(H5_TEMPLATE_0 +i),
H5A_TEMPID_HASHSIZE, 0, NULL);
if (status < 0) ret_value = FAIL;
}
if (ret_value < 0) {
HRETURN_ERROR(H5E_ATOM, H5E_CANTINIT, FAIL,
"unable to initialize atom group");
}
/*
* Register cleanup function.
*/
if (H5_add_exit(H5P_term_interface) < 0) {
HRETURN_ERROR(H5E_INTERNAL, H5E_CANTINIT, FAIL,
"unable to install atexit function");
}
FUNC_LEAVE(ret_value);
}
/*--------------------------------------------------------------------------
NAME
H5P_term_interface
PURPOSE
Terminate various H5P objects
USAGE
void H5P_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
H5P_term_interface(void)
{
intn i;
for (i = 0; i < H5P_NCLASSES; i++) {
H5A_destroy_group((group_t)(H5_TEMPLATE_0 + i));
}
}
/*--------------------------------------------------------------------------
NAME
H5Pcreate
PURPOSE
Returns a copy of the default template for some class of templates.
USAGE
herr_t H5Pcreate (type)
H5P_class_t type; IN: Template class whose default is desired.
RETURNS
Template ID or FAIL
ERRORS
ARGS BADVALUE Unknown template class.
ATOM CANTINIT Can't register template.
INTERNAL UNSUPPORTED Not implemented yet.
DESCRIPTION
Returns a copy of the default template for some class of templates.
--------------------------------------------------------------------------*/
hid_t
H5Pcreate(H5P_class_t type)
{
hid_t ret_value = FAIL;
void *tmpl = NULL;
FUNC_ENTER(H5Pcreate, FAIL);
/* Allocate a new template and initialize it with default values */
switch (type) {
case H5P_FILE_CREATE:
tmpl = H5MM_xmalloc(sizeof(H5F_create_t));
memcpy(tmpl, &H5F_create_dflt, sizeof(H5F_create_t));
break;
case H5P_FILE_ACCESS:
tmpl = H5MM_xmalloc(sizeof(H5F_access_t));
memcpy(tmpl, &H5F_access_dflt, sizeof(H5F_access_t));
break;
case H5P_DATASET_CREATE:
tmpl = H5MM_xmalloc(sizeof(H5D_create_t));
memcpy(tmpl, &H5D_create_dflt, sizeof(H5D_create_t));
break;
case H5P_DATASET_XFER:
tmpl = H5MM_xmalloc(sizeof(H5D_xfer_t));
memcpy(tmpl, &H5D_xfer_dflt, sizeof(H5D_xfer_t));
break;
default:
HRETURN_ERROR(H5E_ARGS, H5E_BADVALUE, FAIL,
"unknown template class");
}
/* Atomize the new template */
if ((ret_value = H5P_create(type, tmpl)) < 0) {
HRETURN_ERROR(H5E_ATOM, H5E_CANTINIT, FAIL,
"can't register template");
}
FUNC_LEAVE(ret_value);
}
/*-------------------------------------------------------------------------
* Function: H5P_create
*
* Purpose: Given a pointer to some template struct, atomize the template
* and return its ID. The template memory is not copied, so the
* caller should not free it; it will be freed by H5P_release().
*
* Return: Success: A new template ID.
*
* Failure: FAIL
*
* Programmer: Robb Matzke
* Wednesday, December 3, 1997
*
* Modifications:
*
*-------------------------------------------------------------------------
*/
hid_t
H5P_create(H5P_class_t type, void *tmpl)
{
hid_t ret_value = FAIL;
FUNC_ENTER(H5P_create, FAIL);
/* check args */
assert(type >= 0 && type < H5P_NCLASSES);
assert(tmpl);
/* Atomize the new template */
if ((ret_value=H5A_register((group_t)(H5_TEMPLATE_0+type), tmpl)) < 0) {
HRETURN_ERROR(H5E_ATOM, H5E_CANTINIT, FAIL,
"can't register template");
}
FUNC_LEAVE(ret_value);
}
/*--------------------------------------------------------------------------
NAME
H5Pclose
PURPOSE
Release access to a template object.
USAGE
herr_t H5Pclose(oid)
hid_t oid; IN: Template object to release access to
RETURNS
SUCCEED/FAIL
DESCRIPTION
This function releases access to a template object
--------------------------------------------------------------------------*/
herr_t
H5Pclose(hid_t tid)
{
H5P_class_t type;
void *tmpl = NULL;
FUNC_ENTER(H5Pclose, FAIL);
/* Check arguments */
if ((type=H5Pget_class (tid))<0 ||
NULL==(tmpl=H5A_object (tid))) {
HRETURN_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL, "not a property list");
}
/*
* Chuck the object! When the reference count reaches zero then
* H5A_dec_ref() removes it from the group and we should free it. The
* free function is not registered as part of the group because it takes
* an extra argument.
*/
if (0==H5A_dec_ref(tid)) H5P_close (type, tmpl);
FUNC_LEAVE (SUCCEED);
}
/*-------------------------------------------------------------------------
* Function: H5P_close
*
* Purpose: Closes a template and frees the memory associated with the
* template.
*
* Return: Success: SUCCEED
*
* Failure: FAIL
*
* Programmer: Robb Matzke
* Wednesday, February 18, 1998
*
* Modifications:
*
*-------------------------------------------------------------------------
*/
herr_t
H5P_close (H5P_class_t type, void *tmpl)
{
FUNC_ENTER (H5P_close, FAIL);
/* Check args */
assert (tmpl);
/* Some templates may need to do special things */
switch (type) {
case H5P_FILE_ACCESS:
#ifdef LATER
/* Need to free the COMM and INFO objects too. */
#endif
break;
case H5P_FILE_CREATE:
case H5P_DATASET_CREATE:
case H5P_DATASET_XFER:
/*nothing to do*/
break;
default:
HRETURN_ERROR (H5E_ARGS, H5E_BADTYPE, FAIL,
"unknown property list class");
}
/* Free the template struct and return */
H5MM_xfree(tmpl);
FUNC_LEAVE(SUCCEED);
}
/*-------------------------------------------------------------------------
* Function: H5Pget_class
*
* Purpose: Returns the class identifier for a template.
*
* Return: Success: A template class
*
* Failure: H5P_NO_CLASS (-1)
*
* Programmer: Robb Matzke
* Wednesday, December 3, 1997
*
* Modifications:
*
*-------------------------------------------------------------------------
*/
H5P_class_t
H5Pget_class(hid_t tid)
{
group_t group;
H5P_class_t ret_value = H5P_NO_CLASS;
FUNC_ENTER(H5Pget_class, H5P_NO_CLASS);
if ((group = H5A_group(tid)) < 0 ||
#ifndef NDEBUG
group >= H5_TEMPLATE_MAX ||
#endif
group < H5_TEMPLATE_0) {
HRETURN_ERROR(H5E_ATOM, H5E_BADATOM, H5P_NO_CLASS, "not a template");
}
ret_value = (H5P_class_t)(group - H5_TEMPLATE_0);
FUNC_LEAVE(ret_value);
}
/*-------------------------------------------------------------------------
* Function: H5Pget_version
*
* Purpose: Retrieves version information for various parts of a file.
*
* BOOT: The file boot block.
* HEAP: The global heap.
* FREELIST: The global free list.
* STAB: The root symbol table entry.
* SHHDR: Shared object headers.
*
* Any (or even all) of the output arguments can be null
* pointers.
*
* Return: Success: SUCCEED, version information is returned
* through the arguments.
*
* Failure: FAIL
*
* Programmer: Robb Matzke
* Wednesday, January 7, 1998
*
* Modifications:
*
*-------------------------------------------------------------------------
*/
herr_t
H5Pget_version(hid_t tid, int *boot /*out */ , int *heap /*out */ ,
int *freelist /*out */ , int *stab /*out */ , int *shhdr /*out */ )
{
H5F_create_t *tmpl = NULL;
FUNC_ENTER(H5Pget_version, FAIL);
/* Check arguments */
if (H5P_FILE_CREATE != H5Pget_class(tid) ||
NULL == (tmpl = H5A_object(tid))) {
HRETURN_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL,
"not a file creation template");
}
/* Get values */
if (boot)
*boot = tmpl->bootblock_ver;
if (heap)
*heap = tmpl->smallobject_ver;
if (freelist)
*freelist = tmpl->freespace_ver;
if (stab)
*stab = tmpl->objectdir_ver;
if (shhdr)
*shhdr = tmpl->sharedheader_ver;
FUNC_LEAVE(SUCCEED);
}
/*-------------------------------------------------------------------------
* Function: H5Pset_userblock
*
* Purpose: Sets the userblock size field of a file creation template.
*
* Return: Success: SUCCEED
*
* Failure: FAIL
*
* Programmer: Robb Matzke
* Tuesday, January 6, 1998
*
* Modifications:
*
*-------------------------------------------------------------------------
*/
herr_t
H5Pset_userblock(hid_t tid, size_t size)
{
intn i;
H5F_create_t *tmpl = NULL;
FUNC_ENTER(H5Pset_userblock, FAIL);
/* Check arguments */
if (H5P_FILE_CREATE != H5Pget_class(tid) ||
NULL == (tmpl = H5A_object(tid))) {
HRETURN_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL,
"not a file creation template");
}
for (i = 8; i < 8 * sizeof(int); i++) {
uintn p2 = 8 == i ? 0 : 1 << i;
if (size == p2)
break;
}
if (i >= 8 * sizeof(int)) {
HRETURN_ERROR(H5E_ARGS, H5E_BADVALUE, FAIL,
"userblock size is not valid");
}
/* Set value */
tmpl->userblock_size = size;
FUNC_LEAVE(SUCCEED);
}
/*-------------------------------------------------------------------------
* Function: H5Pget_userblock
*
* Purpose: Queries the size of a user block in a file creation template.
*
* Return: Success: SUCCEED, size returned through SIZE argument.
*
* Failure: FAIL
*
* Programmer: Robb Matzke
* Wednesday, January 7, 1998
*
* Modifications:
*
*-------------------------------------------------------------------------
*/
herr_t
H5Pget_userblock(hid_t tid, size_t *size)
{
H5F_create_t *tmpl = NULL;
FUNC_ENTER(H5Pget_userblock, FAIL);
/* Check args */
if (H5P_FILE_CREATE != H5Pget_class(tid) ||
NULL == (tmpl = H5A_object(tid))) {
HRETURN_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL,
"not a file creation template");
}
/* Get value */
if (size)
*size = tmpl->userblock_size;
FUNC_LEAVE(SUCCEED);
}
/*-------------------------------------------------------------------------
* Function: H5Pset_sizes
*
* Purpose: Sets file size-of addresses and sizes. TEMPLATE
* should be a file creation template. A value of zero causes
* the property to not change.
*
* Return: Success: SUCCEED
*
* Failure: FAIL
*
* Programmer: Robb Matzke
* Tuesday, January 6, 1998
*
* Modifications:
*
*-------------------------------------------------------------------------
*/
herr_t
H5Pset_sizes(hid_t tid, size_t sizeof_addr, size_t sizeof_size)
{
H5F_create_t *tmpl = NULL;
FUNC_ENTER(H5Pset_sizeof_addr, FAIL);
/* Check arguments */
if (H5P_FILE_CREATE != H5Pget_class(tid) ||
NULL == (tmpl = H5A_object(tid))) {
HRETURN_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL,
"not a file creation template");
}
if (sizeof_addr) {
if (sizeof_addr != 2 && sizeof_addr != 4 &&
sizeof_addr != 8 && sizeof_addr != 16) {
HRETURN_ERROR(H5E_ARGS, H5E_BADVALUE, FAIL,
"file haddr_t size is not valid");
}
}
if (sizeof_size) {
if (sizeof_size != 2 && sizeof_size != 4 &&
sizeof_size != 8 && sizeof_size != 16) {
HRETURN_ERROR(H5E_ARGS, H5E_BADVALUE, FAIL,
"file size_t size is not valid");
}
}
/* Set value */
if (sizeof_addr)
tmpl->sizeof_addr = sizeof_addr;
if (sizeof_size)
tmpl->sizeof_size = sizeof_size;
FUNC_LEAVE(SUCCEED);
}
/*-------------------------------------------------------------------------
* Function: H5Pget_sizes
*
* Purpose: Returns the size of address and size quantities stored in a
* file according to a file creation template. Either (or even
* both) SIZEOF_ADDR and SIZEOF_SIZE may be null pointers.
*
* Return: Success: SUCCEED, sizes returned through arguments.
*
* Failure: FAIL
*
* Programmer: Robb Matzke
* Wednesday, January 7, 1998
*
* Modifications:
*
*-------------------------------------------------------------------------
*/
herr_t
H5Pget_sizes(hid_t tid,
size_t *sizeof_addr /*out */ , size_t *sizeof_size /*out */ )
{
H5F_create_t *tmpl = NULL;
FUNC_ENTER(H5Pget_sizes, FAIL);
/* Check args */
if (H5P_FILE_CREATE != H5Pget_class(tid) ||
NULL == (tmpl = H5A_object(tid))) {
HRETURN_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL,
"not a file creation template");
}
/* Get values */
if (sizeof_addr)
*sizeof_addr = tmpl->sizeof_addr;
if (sizeof_size)
*sizeof_size = tmpl->sizeof_size;
FUNC_LEAVE(SUCCEED);
}
/*-------------------------------------------------------------------------
* Function: H5Pset_sym_k
*
* Purpose: IK is one half the rank of a tree that stores a symbol
* table for a group. Internal nodes of the symbol table are on
* average 75% full. That is, the average rank of the tree is
* 1.5 times the value of IK.
*
* LK is one half of the number of symbols that can be stored in
* a symbol table node. A symbol table node is the leaf of a
* symbol table tree which is used to store a group. When
* symbols are inserted randomly into a group, the group's
* symbol table nodes are 75% full on average. That is, they
* contain 1.5 times the number of symbols specified by LK.
*
* Either (or even both) of IK and LK can be zero in which case
* that value is left unchanged.
*
* Return: Success: SUCCEED
*
* Failure: FAIL
*
* Programmer: Robb Matzke
* Tuesday, January 6, 1998
*
* Modifications:
*
*-------------------------------------------------------------------------
*/
herr_t
H5Pset_sym_k(hid_t tid, int ik, int lk)
{
H5F_create_t *tmpl = NULL;
FUNC_ENTER(H5Pset_sym_k, FAIL);
/* Check arguments */
if (H5P_FILE_CREATE != H5Pget_class(tid) ||
NULL == (tmpl = H5A_object(tid))) {
HRETURN_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL,
"not a file creation template");
}
/* Set values */
if (ik > 0) {
tmpl->btree_k[H5B_SNODE_ID] = ik;
}
if (lk > 0) {
tmpl->sym_leaf_k = lk;
}
FUNC_LEAVE(SUCCEED);
}
/*-------------------------------------------------------------------------
* Function: H5Pget_sym_k
*
* Purpose: Retrieves the symbol table B-tree 1/2 rank (IK) and the
* symbol table leaf node 1/2 size (LK). See H5Pset_sym_k() for
* details. Either (or even both) IK and LK may be null
* pointers.
*
* Return: Success: SUCCEED
*
* Failure: FAIL
*
* Programmer: Robb Matzke
* Wednesday, January 7, 1998
*
* Modifications:
*
*-------------------------------------------------------------------------
*/
herr_t
H5Pget_sym_k(hid_t tid, int *ik /*out */ , int *lk /*out */ )
{
H5F_create_t *tmpl = NULL;
FUNC_ENTER(H5Pget_sym_k, FAIL);
/* Check arguments */
if (H5P_FILE_CREATE != H5Pget_class(tid) ||
NULL == (tmpl = H5A_object(tid))) {
HRETURN_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL,
"not a file creation template");
}
/* Get values */
if (ik)
*ik = tmpl->btree_k[H5B_SNODE_ID];
if (lk)
*lk = tmpl->sym_leaf_k;
FUNC_LEAVE(SUCCEED);
}
/*-------------------------------------------------------------------------
* Function: H5Pset_istore_k
*
* Purpose: IK is one half the rank of a tree that stores chunked raw
* data. On average, such a tree will be 75% full, or have an
* average rank of 1.5 times the value of IK.
*
* Return: Success: SUCCEED
*
* Failure: FAIL
*
* Programmer: Robb Matzke
* Tuesday, January 6, 1998
*
* Modifications:
*
*-------------------------------------------------------------------------
*/
herr_t
H5Pset_istore_k(hid_t tid, int ik)
{
H5F_create_t *tmpl = NULL;
FUNC_ENTER(H5Pset_istore_k, FAIL);
/* Check arguments */
if (H5P_FILE_CREATE != H5Pget_class(tid) ||
NULL == (tmpl = H5A_object(tid))) {
HRETURN_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL,
"not a file creation template");
}
if (ik <= 0) {
HRETURN_ERROR(H5E_ARGS, H5E_BADVALUE, FAIL,
"istore IK value must be positive");
}
/* Set value */
tmpl->btree_k[H5B_ISTORE_ID] = ik;
FUNC_LEAVE(SUCCEED);
}
/*-------------------------------------------------------------------------
* Function: H5Pget_istore_k
*
* Purpose: Queries the 1/2 rank of an indexed storage B-tree. See
* H5Pset_istore_k() for details. The argument IK may be the
* null pointer.
*
* Return: Success: SUCCEED, size returned through IK
*
* Failure:
*
* Programmer: Robb Matzke
* Wednesday, January 7, 1998
*
* Modifications:
*
*-------------------------------------------------------------------------
*/
herr_t
H5Pget_istore_k(hid_t tid, int *ik /*out */ )
{
H5F_create_t *tmpl = NULL;
FUNC_ENTER(H5Pget_istore_k, FAIL);
/* Check arguments */
if (H5P_FILE_CREATE != H5Pget_class(tid) ||
NULL == (tmpl = H5A_object(tid))) {
HRETURN_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL,
"not a file creation template");
}
/* Get value */
if (ik)
*ik = tmpl->btree_k[H5B_ISTORE_ID];
FUNC_LEAVE(SUCCEED);
}
/*-------------------------------------------------------------------------
* Function: H5Pset_layout
*
* Purpose: Sets the layout of raw data in the file.
*
* Return: Success: SUCCEED
*
* Failure: FAIL
*
* Programmer: Robb Matzke
* Tuesday, January 6, 1998
*
* Modifications:
*
*-------------------------------------------------------------------------
*/
herr_t
H5Pset_layout(hid_t tid, H5D_layout_t layout)
{
H5D_create_t *tmpl = NULL;
FUNC_ENTER(H5Pset_layout, FAIL);
/* Check arguments */
if (H5P_DATASET_CREATE != H5Pget_class(tid) ||
NULL == (tmpl = H5A_object(tid))) {
HRETURN_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL,
"not a dataset creation template");
}
if (layout < 0 || layout >= H5D_NLAYOUTS) {
HRETURN_ERROR(H5E_ARGS, H5E_BADRANGE, FAIL,
"raw data layout method is not valid");
}
/* Set value */
tmpl->layout = layout;
FUNC_LEAVE(SUCCEED);
}
/*-------------------------------------------------------------------------
* Function: H5Pget_layout
*
* Purpose: Retrieves layout type of a dataset creation template.
*
* Return: Success: The layout type
*
* Failure: H5D_LAYOUT_ERROR (-1, same as FAIL)
*
* Programmer: Robb Matzke
* Wednesday, January 7, 1998
*
* Modifications:
*
*-------------------------------------------------------------------------
*/
H5D_layout_t
H5Pget_layout(hid_t tid)
{
H5D_create_t *tmpl = NULL;
FUNC_ENTER(H5Pget_layout, H5D_LAYOUT_ERROR);
/* Check arguments */
if (H5P_DATASET_CREATE != H5Pget_class(tid) ||
NULL == (tmpl = H5A_object(tid))) {
HRETURN_ERROR(H5E_ARGS, H5E_BADTYPE, H5D_LAYOUT_ERROR,
"not a dataset creation template");
}
FUNC_LEAVE(tmpl->layout);
}
/*-------------------------------------------------------------------------
* Function: H5Pset_chunk
*
* Purpose: Sets the number of dimensions and the size of each chunk to
* the values specified. The dimensionality of the chunk should
* match the dimensionality of the data space.
*
* As a side effect, the layout method is changed to
* H5D_CHUNKED.
*
* Return: Success: SUCCEED
*
* Failure: FAIL
*
* Programmer: Robb Matzke
* Tuesday, January 6, 1998
*
* Modifications:
*
*-------------------------------------------------------------------------
*/
herr_t
H5Pset_chunk(hid_t tid, int ndims, const size_t dim[])
{
int i;
H5D_create_t *tmpl = NULL;
FUNC_ENTER(H5Pset_chunk, FAIL);
/* Check arguments */
if (H5P_DATASET_CREATE != H5Pget_class(tid) ||
NULL == (tmpl = H5A_object(tid))) {
HRETURN_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL,
"not a dataset creation template");
}
if (ndims <= 0) {
HRETURN_ERROR(H5E_ARGS, H5E_BADRANGE, FAIL,
"chunk dimensionality must be positive");
}
if (ndims > NELMTS(tmpl->chunk_size)) {
HRETURN_ERROR(H5E_ARGS, H5E_BADRANGE, FAIL,
"chunk dimensionality is too large");
}
if (!dim) {
HRETURN_ERROR(H5E_ARGS, H5E_BADVALUE, FAIL,
"no chunk dimensions specified");
}
for (i = 0; i < ndims; i++) {
if (dim[i] <= 0) {
HRETURN_ERROR(H5E_ARGS, H5E_BADRANGE, FAIL,
"all chunk dimensions must be positive");
}
}
/* Set value */
tmpl->layout = H5D_CHUNKED;
tmpl->chunk_ndims = ndims;
for (i = 0; i < ndims; i++)
tmpl->chunk_size[i] = dim[i];
FUNC_LEAVE(SUCCEED);
}
/*-------------------------------------------------------------------------
* Function: H5Pget_chunk
*
* Purpose: Retrieves the chunk size of chunked layout. The chunk
* dimensionality is returned and the chunk size in each
* dimension is returned through the DIM argument. At most
* MAX_NDIMS elements of DIM will be initialized.
*
* Return: Success: Positive Chunk dimensionality.
*
* Failure: FAIL
*
* Programmer: Robb Matzke
* Wednesday, January 7, 1998
*
* Modifications:
*
*-------------------------------------------------------------------------
*/
int
H5Pget_chunk(hid_t tid, int max_ndims, size_t dim[] /*out */ )
{
int i;
H5D_create_t *tmpl = NULL;
FUNC_ENTER(H5Pget_chunk, FAIL);
/* Check arguments */
if (H5P_DATASET_CREATE != H5Pget_class(tid) ||
NULL == (tmpl = H5A_object(tid))) {
HRETURN_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL,
"not a dataset creation template");
}
if (H5D_CHUNKED != tmpl->layout) {
HRETURN_ERROR(H5E_ARGS, H5E_BADVALUE, FAIL,
"not a chunked storage layout");
}
for (i = 0; i < tmpl->chunk_ndims && i < max_ndims && dim; i++) {
dim[i] = tmpl->chunk_size[i];
}
FUNC_LEAVE(tmpl->chunk_ndims);
}
/*-------------------------------------------------------------------------
* Function: H5Pset_stdio
*
* Purpose: Set the low level file driver to use the functions declared
* in the stdio.h file: fopen(), fseek() or fseek64(), fread(),
* fwrite(), and fclose().
*
* Return: Success: SUCCEED
*
* Failure: FAIL
*
* Programmer: Robb Matzke
* Thursday, February 19, 1998
*
* Modifications:
*
*-------------------------------------------------------------------------
*/
herr_t
H5Pset_stdio (hid_t tid)
{
H5F_access_t *tmpl = NULL;
FUNC_ENTER (H5Pset_stdio, FAIL);
/* Check arguments */
if (H5P_FILE_ACCESS != H5Pget_class(tid) ||
NULL == (tmpl = H5A_object(tid))) {
HRETURN_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL,
"not a file access template");
}
/* Set driver */
tmpl->driver = H5F_LOW_STDIO;
FUNC_LEAVE (SUCCEED);
}
/*-------------------------------------------------------------------------
* Function: H5Pset_sec2
*
* Purpose: Set the low-level file driver to use the functions declared
* in the unistd.h file: open(), lseek() or lseek64(), read(),
* write(), and close().
*
* Return: Success: SUCCEED
*
* Failure: FAIL
*
* Programmer: Robb Matzke
* Thursday, February 19, 1998
*
* Modifications:
*
*-------------------------------------------------------------------------
*/
herr_t
H5Pset_sec2 (hid_t tid)
{
H5F_access_t *tmpl = NULL;
FUNC_ENTER (H5Pset_sec2, FAIL);
/* Check arguments */
if (H5P_FILE_ACCESS != H5Pget_class(tid) ||
NULL == (tmpl = H5A_object(tid))) {
HRETURN_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL,
"not a file access template");
}
/* Set driver */
tmpl->driver = H5F_LOW_SEC2;
FUNC_LEAVE (SUCCEED);
}
/*-------------------------------------------------------------------------
* Function: H5Pset_core
*
* Purpose: Set the low-level file driver to use malloc() and free().
* This driver is restricted to temporary files which are not
* larger than the amount of virtual memory available. The
* INCREMENT argument determines the file block size and memory
* will be allocated in multiples of INCREMENT bytes. A liberal
* INCREMENT results in fewer calls to realloc() and probably
* less memory fragmentation.
*
* Return: Success: SUCCEED
*
* Failure: FAIL
*
* Programmer: Robb Matzke
* Thursday, February 19, 1998
*
* Modifications:
*
*-------------------------------------------------------------------------
*/
herr_t
H5Pset_core (hid_t tid, size_t increment)
{
H5F_access_t *tmpl = NULL;
FUNC_ENTER (H5Pset_core, FAIL);
/* Check arguments */
if (H5P_FILE_ACCESS != H5Pget_class(tid) ||
NULL == (tmpl = H5A_object(tid))) {
HRETURN_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL,
"not a file access template");
}
if (increment<1) {
HRETURN_ERROR (H5E_ARGS, H5E_BADVALUE, FAIL,
"increment must be positive");
}
/* Set driver */
tmpl->driver = H5F_LOW_CORE;
tmpl->u.core.increment = increment;
FUNC_LEAVE (SUCCEED);
}
/*-------------------------------------------------------------------------
* Function: H5Pset_split
*
* Purpose: Set the low-level driver to split meta data from raw data,
* storing meta data in one file and raw data in another file.
*
* Return: Success: SUCCEED
*
* Failure: FAIL
*
* Programmer: Robb Matzke
* Thursday, February 19, 1998
*
* Modifications:
*
*-------------------------------------------------------------------------
*/
herr_t
H5Pset_split (hid_t tid, hid_t meta_tid, hid_t raw_tid)
{
H5F_access_t *tmpl = NULL;
H5F_access_t *meta_tmpl = NULL;
H5F_access_t *raw_tmpl = NULL;
FUNC_ENTER (H5Pset_split, FAIL);
/* Check arguments */
if (H5P_FILE_ACCESS != H5Pget_class(tid) ||
NULL == (tmpl = H5A_object(tid))) {
HRETURN_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL,
"not a file access template");
}
if (H5P_DEFAULT!=meta_tid &&
(H5P_FILE_ACCESS != H5Pget_class(meta_tid) ||
NULL == (tmpl = H5A_object(meta_tid)))) {
HRETURN_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL,
"not a file access template");
}
if (H5P_DEFAULT!=raw_tid &&
(H5P_FILE_ACCESS != H5Pget_class(raw_tid) ||
NULL == (tmpl = H5A_object(raw_tid)))) {
HRETURN_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL,
"not a file access template");
}
/* Set driver */
tmpl->driver = H5F_LOW_SPLIT;
tmpl->u.split.meta_access = H5P_copy (H5P_FILE_ACCESS, meta_tmpl);
tmpl->u.split.raw_access = H5P_copy (H5P_FILE_ACCESS, raw_tmpl);
FUNC_LEAVE (SUCCEED);
}
/*-------------------------------------------------------------------------
* Function: H5Pset_family
*
* Purpose: Sets the low-level driver to stripe the hdf5 address space
* across a family of files.
*
* Return: Success: SUCCEED
*
* Failure: FAIL
*
* Programmer: Robb Matzke
* Thursday, February 19, 1998
*
* Modifications:
*
*-------------------------------------------------------------------------
*/
herr_t
H5Pset_family (hid_t tid, hid_t memb_tid)
{
H5F_access_t *tmpl = NULL;
H5F_access_t *memb_tmpl = NULL;
FUNC_ENTER (H5Pset_family, FAIL);
/* Check arguments */
if (H5P_FILE_ACCESS != H5Pget_class(tid) ||
NULL == (tmpl = H5A_object(tid))) {
HRETURN_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL,
"not a file access template");
}
if (H5P_DEFAULT!=memb_tid &&
(H5P_FILE_ACCESS != H5Pget_class(memb_tid) ||
NULL == (tmpl = H5A_object(memb_tid)))) {
HRETURN_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL,
"not a file access template");
}
/* Set driver */
tmpl->driver = H5F_LOW_FAMILY;
tmpl->u.fam.memb_access = H5P_copy (H5P_FILE_ACCESS, memb_tmpl);
FUNC_LEAVE (SUCCEED);
}
#ifdef HAVE_PARALLEL
/*-------------------------------------------------------------------------
* Function: H5Pset_mpi
*
* Signature: herr_t H5Pset_mpi(hid_t tid, MPI_Comm comm, MPI_Info info,
* uintn access_mode)
*
* Purpose: Store the access mode for MPIO call and the user supplied
* communicator and info in the access template which can then
* be used to open file. This function is available only in the
* parallel HDF5 library and is not a collective function.
*
* Parameters:
* hid_t tid
* ID of template to modify
* MPI_Comm comm
* MPI communicator to be used for file open as defined in
* MPI_FILE_OPEN of MPI-2. This function does not make a
* duplicated communicator. Any modification to comm after
* this function call returns may have undetermined effect
* to the access template. Users should call this function
* again to setup the template.
* MPI_Info info
* MPI info object to be used for file open as defined in
* MPI_FILE_OPEN of MPI-2. This function does not make a
* duplicated info. Any modification to info after
* this function call returns may have undetermined effect
* to the access template. Users should call this function
* again to setup the template.
* uintn access_mode
* File data access modes:
* H5ACC_INDEPENDENT
* Allow independent datasets access.
* H5ACC_COLLECTIVE
* Allow only collective datasets access.
*
* Return: Success: SUCCEED
*
* Failure: FAIL
*
* Programmer: Albert Cheng
* Feb 3, 1998
*
* Modifications:
*
* Robb Matzke, 18 Feb 1998
* Check all arguments before the template is updated so we don't leave
* the template in a bad state if something goes wrong. Also, the
* template data type changed to allow more generality so all the
* mpi-related stuff is in the `u.mpi' member. The `access_mode' will
* contain only mpi-related flags defined in H5Fpublic.h.
*
*-------------------------------------------------------------------------
*/
herr_t
H5Pset_mpi (hid_t tid, MPI_Comm comm, MPI_Info info, uintn access_mode)
{
H5F_access_t *tmpl = NULL;
MPI_Comm lcomm;
int mrc; /* MPI return code */
FUNC_ENTER(H5Pset_mpi, FAIL);
/* Check arguments */
if (H5P_FILE_ACCESS != H5Pget_class(tid) ||
NULL == (tmpl = H5A_object(tid))) {
HRETURN_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL,
"not a file access template");
}
switch (access_mode){
case H5ACC_INDEPENDENT:
case H5ACC_COLLECTIVE:
/* okay */
break;
default:
HRETURN_ERROR (H5E_ARGS, H5E_BADVALUE, FAIL,
"invalid mpio access mode");
}
#ifdef LATER
/*
* Need to verify comm and info contain sensible information.
*/
#endif
/*
* Everything looks good. Now go ahead and modify the access template.
*/
tmpl->driver = H5F_LOW_MPIO;
tmpl->u.mpio.access_mode = access_mode;
/*
* Store a duplicate copy of comm so that user may freely modify comm
* after this call.
*/
if ((mrc = MPI_Comm_dup(comm, &lcomm)) != MPI_SUCCESS) {
HRETURN_ERROR(H5E_ARGS, H5E_BADVALUE, FAIL,
"failure to duplicate communicator");
}
tmpl->u.mpio.comm = comm;
#ifdef LATER
/* Need to duplicate info too but don't know a quick way to do it now */
#endif
tmpl->u.mpio.info = info;
FUNC_LEAVE(SUCCEED);
}
#endif /*HAVE_PARALLEL*/
/*--------------------------------------------------------------------------
NAME
H5Pcopy
PURPOSE
Copy a template
USAGE
hid_t H5P_copy(tid)
hid_t tid; IN: Template object to copy
RETURNS
Returns template ID (atom) on success, FAIL on failure
ERRORS
ARGS BADRANGE Unknown template class.
ATOM BADATOM Can't unatomize template.
ATOM CANTREGISTER Register the atom for the new template.
INTERNAL UNSUPPORTED Dataset transfer properties are not implemented
yet.
INTERNAL UNSUPPORTED File access properties are not implemented yet.
DESCRIPTION
This function creates a new copy of a template with all the same parameter
settings.
--------------------------------------------------------------------------*/
hid_t
H5Pcopy(hid_t tid)
{
const void *tmpl = NULL;
void *new_tmpl = NULL;
H5P_class_t type;
hid_t ret_value = FAIL;
group_t group;
FUNC_ENTER(H5Pcopy, FAIL);
/* Check args */
if (NULL == (tmpl = H5A_object(tid)) ||
(type = H5Pget_class(tid)) < 0 ||
(group = H5A_group(tid)) < 0) {
HRETURN_ERROR(H5E_ATOM, H5E_BADATOM, FAIL,
"can't unatomize template");
}
/* Copy it */
if (NULL==(new_tmpl=H5P_copy (type, tmpl))) {
HRETURN_ERROR (H5E_INTERNAL, H5E_CANTINIT, FAIL,
"unable to copy template");
}
/* Register the atom for the new template */
if ((ret_value = H5A_register(group, new_tmpl)) < 0) {
HRETURN_ERROR(H5E_ATOM, H5E_CANTREGISTER, FAIL,
"unable to atomize template pointer");
}
FUNC_LEAVE(ret_value);
}
/*-------------------------------------------------------------------------
* Function: H5P_copy
*
* Purpose: Creates a new template and initializes it with some other
* template.
*
* Return: Success: Ptr to new template
*
* Failure: NULL
*
* Programmer: Robb Matzke
* Tuesday, February 3, 1998
*
* Modifications:
*
*-------------------------------------------------------------------------
*/
void *
H5P_copy (H5P_class_t type, const void *src)
{
size_t size;
void *dst = NULL;
FUNC_ENTER (H5P_copy, NULL);
/* How big is the template */
switch (type) {
case H5P_FILE_CREATE:
size = sizeof(H5F_create_t);
break;
case H5P_FILE_ACCESS:
size = sizeof(H5F_access_t);
break;
case H5P_DATASET_CREATE:
size = sizeof(H5D_create_t);
break;
case H5P_DATASET_XFER:
size = sizeof(H5D_xfer_t);
break;
default:
HRETURN_ERROR(H5E_ARGS, H5E_BADRANGE, NULL,
"unknown template class");
}
/* Create the new template */
dst = H5MM_xmalloc(size);
HDmemcpy(dst, src, size);
FUNC_LEAVE (dst);
}
|