1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
|
/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
* 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. *
* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
/*
* Programmer: Mohamad Chaarawi <chaarawi@hdfgroup.gov>
* January, 2012
*
* Purpose: The Virtual Object Layer as described in documentation.
* The pupose is to provide an abstraction on how to access the
* underlying HDF5 container, whether in a local file with
* a specific file format, or remotely on other machines, etc...
*/
/****************/
/* Module Setup */
/****************/
#define H5VL_PACKAGE /*suppress error about including H5VLpkg */
/* Interface initialization */
#define H5_INTERFACE_INIT_FUNC H5VL_init_interface
/***********/
/* Headers */
/***********/
#include "H5private.h" /* Generic Functions */
#include "H5Eprivate.h" /* Error handling */
#include "H5Iprivate.h" /* IDs */
#include "H5MMprivate.h" /* Memory management */
#include "H5VLpkg.h" /* VOL package header */
#include "H5VLprivate.h" /* VOL */
/********************/
/* Local Prototypes */
/********************/
static herr_t H5VL_free_cls(H5VL_class_t *cls);
/*-------------------------------------------------------------------------
* Function: H5VL_init
*
* Purpose: Initialize the interface from some other package.
*
* Return: Success: non-negative
* Failure: negative
*
* Programmer: Mohamad Chaarawi
* January, 2012
*
*-------------------------------------------------------------------------
*/
herr_t
H5VL_init(void)
{
herr_t ret_value = SUCCEED; /* Return value */
FUNC_ENTER_NOAPI(FAIL)
/* FUNC_ENTER() does all the work */
done:
FUNC_LEAVE_NOAPI(ret_value)
} /* end H5VL_init() */
/*-------------------------------------------------------------------------
* Function: H5VL_init_interface
*
* Purpose: Initialize the virtual object layer.
*
* Return: Success: Non-negative
*
* Failure: Negative
*
* Programmer: Mohamad Chaarawi
* January, 2012
*
* Modifications:
*
*-------------------------------------------------------------------------
*/
static herr_t
H5VL_init_interface(void)
{
herr_t ret_value = SUCCEED; /* Return value */
FUNC_ENTER_NOAPI_NOINIT
/* register VOL ID type */
if(H5I_register_type(H5I_VOL, (size_t)H5I_VOL_HASHSIZE, 0,
(H5I_free_t)H5VL_free_cls, NULL)<H5I_FILE)
HGOTO_ERROR(H5E_VOL, H5E_CANTINIT, FAIL, "unable to initialize interface")
done:
FUNC_LEAVE_NOAPI(ret_value)
} /* end H5VL_init_interface() */
/*-------------------------------------------------------------------------
* Function: H5VL_term_interface
*
* Purpose: Terminate this interface: free all memory and reset global
* variables to their initial values. Release all ID groups
* associated with this interface.
*
* Return: Success: Positive if anything was done that might
* have affected other interfaces; zero
* otherwise.
*
* Failure: Never fails.
*
* Programmer: Mohamad Chaarawi
* January, 2012
*
* Modifications:
*
*-------------------------------------------------------------------------
*/
int
H5VL_term_interface(void)
{
int n = 0, n1 = 0;
hbool_t term = TRUE;
FUNC_ENTER_NOAPI_NOINIT_NOERR
if(H5_interface_initialize_g) {
if((n1=H5I_nmembers(H5I_VOL))!=0) {
H5I_clear_type(H5I_VOL, FALSE, FALSE);
term = FALSE;
} else {
H5I_dec_type_ref(H5I_VOL);
}
if (term) {
H5_interface_initialize_g = 0;
n = 1;
}
else {
n = n1;
}
}
FUNC_LEAVE_NOAPI(n)
}
/*-------------------------------------------------------------------------
* Function: H5VL_free_cls
*
* Purpose: Frees a file vol class struct and returns an indication of
* success. This function is used as the free callback for the
* virtual object layer object identifiers (cf H5VL_init_interface).
*
* Return: Success: Non-negative
*
* Failure: Negative
*
* Programmer: Mohamad Chaarawi
* January, 2012
*
* Modifications:
*
*-------------------------------------------------------------------------
*/
static herr_t
H5VL_free_cls(H5VL_class_t *cls)
{
herr_t ret_value = SUCCEED;
FUNC_ENTER_NOAPI_NOINIT
/* Sanity check */
HDassert(cls);
if(cls->terminate && cls->terminate() < 0)
HGOTO_ERROR(H5E_VOL, H5E_CANTCLOSEOBJ, FAIL, "vol plugin '%s' did not terminate cleanly", cls->name)
H5MM_free(cls);
done:
FUNC_LEAVE_NOAPI(ret_value)
} /* end H5VL_free_cls() */
/*-------------------------------------------------------------------------
* Function: H5VLregister
*
* Purpose: Registers a new vol plugin as a member of the virtual object
* layer class.
*
* Return: Success: A vol plugin ID which is good until the
* library is closed or the plugin is
* unregistered.
*
* Failure: A negative value.
*
* Programmer: Mohamad Chaarawi
* January, 2012
*
*-------------------------------------------------------------------------
*/
hid_t
H5VLregister(const H5VL_class_t *cls)
{
hid_t ret_value;
FUNC_ENTER_API(FAIL)
H5TRACE1("i", "*x", cls);
/* Check arguments */
if(!cls)
HGOTO_ERROR(H5E_ARGS, H5E_UNINITIALIZED, FAIL, "null class pointer is disallowed")
/* MSC - check if required callback are defined */
/* Create the new class ID */
if((ret_value=H5VL_register(cls, sizeof(H5VL_class_t), TRUE)) < 0)
HGOTO_ERROR(H5E_ATOM, H5E_CANTREGISTER, FAIL, "unable to register vol plugin ID")
done:
FUNC_LEAVE_API(ret_value)
} /* end H5VLregister() */
/*-------------------------------------------------------------------------
* Function: H5VLunregister
*
* Purpose: Removes a vol plugin ID from the library. This in no way affects
* file access property lists which have been defined to use
* this vol plugin or files which are already opened under with
* this plugin.
*
* Return: Success: Non-negative
*
* Failure: Negative
*
* Programmer: Mohamad Chaarawi
* January, 2012
*
*-------------------------------------------------------------------------
*/
herr_t
H5VLunregister(hid_t vol_id)
{
herr_t ret_value = SUCCEED; /* Return value */
FUNC_ENTER_API(FAIL)
H5TRACE1("e", "i", vol_id);
/* Check arguments */
if(NULL == H5I_object_verify(vol_id, H5I_VOL))
HGOTO_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL, "not a vol plugin")
/* The H5VL_class_t struct will be freed by this function */
if(H5I_dec_app_ref(vol_id) < 0)
HGOTO_ERROR(H5E_VOL, H5E_CANTDEC, FAIL, "unable to unregister vol plugin")
done:
FUNC_LEAVE_API(ret_value)
} /* end H5VLunregister() */
/*-------------------------------------------------------------------------
* Function: H5VLis_registered
*
* Purpose: Tests whether a VOL class has been registered or not
*
* Return: Positive if the VOL class has been registered
* Zero if it is unregistered
* Negative on error (if the class is not a valid class ID)
*
* Programmer: Mohamad Chaarawi
* June 2012
*
*-------------------------------------------------------------------------
*/
htri_t
H5VLis_registered(hid_t id)
{
htri_t ret_value = FALSE; /* Return value */
FUNC_ENTER_API(FAIL)
H5TRACE1("t", "Ll", id);
/* Check arguments */
if(NULL != H5I_object_verify(id, H5I_VOL))
ret_value = TRUE;
done:
FUNC_LEAVE_API(ret_value)
} /* end H5VLis_registered() */
/*-------------------------------------------------------------------------
* Function: H5VLget_plugin_name
*
* Purpose: Returns the plugin name for the VOL associated with the
* object or file ID
*
* Return: Success: The length of the plugin name
* Failure: Negative
*
* Programmer: Mohamad Chaarawi
* June, 2012
*
*-------------------------------------------------------------------------
*/
ssize_t
H5VLget_plugin_name(hid_t id, char *name/*out*/, size_t size)
{
ssize_t ret_value;
FUNC_ENTER_API(FAIL)
H5TRACE3("i", "*x", id, name, size);
if((ret_value = H5VL_get_plugin_name(id, name, size)) < 0)
HGOTO_ERROR(H5E_VOL, H5E_CANTGET, FAIL, "Can't get plugin name")
done:
FUNC_LEAVE_API(ret_value)
} /* end H5VLget_plugin_name() */
/*---------------------------------------------------------------------------
* Function: H5VLregister_object
*
* Purpose: utility routine to register the native VOL plugin to an ID
*
* Returns: Non-negative on success or negative on failure
*
* Programmer: Mohamad Chaarawi
* June, 2012
*
*---------------------------------------------------------------------------
*/
hid_t
H5VLregister_object(void *obj, H5I_type_t obj_type, const H5VL_class_t *cls)
{
H5VL_t *vol_plugin; /* VOL plugin information */
hid_t ret_value = FAIL;
FUNC_ENTER_API(FAIL)
/* Get an atom for the object */
if((ret_value = H5I_register(obj_type, obj, TRUE)) < 0)
HGOTO_ERROR(H5E_ATOM, H5E_CANTREGISTER, FAIL, "unable to atomize object")
/* Build the vol plugin struct */
if(NULL == (vol_plugin = (H5VL_t *)H5MM_calloc(sizeof(H5VL_t))))
HGOTO_ERROR(H5E_RESOURCE, H5E_NOSPACE, FAIL, "memory allocation failed")
vol_plugin->cls = cls;
vol_plugin->nrefs = 1;
switch(obj_type) {
case H5I_FILE:
if (H5I_register_aux(ret_value, vol_plugin, (H5I_free2_t)H5F_close_file) < 0)
HGOTO_ERROR(H5E_VOL, H5E_CANTINIT, FAIL, "can't attach vol info to ID")
break;
case H5I_GROUP:
if (H5I_register_aux(ret_value, vol_plugin, (H5I_free2_t)H5G_close_group) < 0)
HGOTO_ERROR(H5E_VOL, H5E_CANTINIT, FAIL, "can't attach vol info to ID")
break;
case H5I_DATATYPE:
if (H5I_register_aux(ret_value, vol_plugin, (H5I_free2_t)H5T_close_datatype) < 0)
HGOTO_ERROR(H5E_VOL, H5E_CANTINIT, FAIL, "can't attach vol info to ID")
break;
case H5I_DATASET:
if (H5I_register_aux(ret_value, vol_plugin, (H5I_free2_t)H5D_close_dataset) < 0)
HGOTO_ERROR(H5E_VOL, H5E_CANTINIT, FAIL, "can't attach vol info to ID")
break;
case H5I_ATTR:
if (H5I_register_aux(ret_value, vol_plugin, (H5I_free2_t)H5A_close_attr) < 0)
HGOTO_ERROR(H5E_VOL, H5E_CANTINIT, FAIL, "can't attach vol info to ID")
break;
case H5I_UNINIT:
case H5I_BADID:
case H5I_DATASPACE:
case H5I_REFERENCE:
case H5I_VFL:
case H5I_VOL:
case H5I_GENPROP_CLS:
case H5I_GENPROP_LST:
case H5I_ERROR_CLASS:
case H5I_ERROR_MSG:
case H5I_ERROR_STACK:
case H5I_NTYPES:
default:
HGOTO_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL, "not a file or file object")
} /* end switch */
done:
FUNC_LEAVE_API(ret_value)
} /* H5VLregister_object */
/*-------------------------------------------------------------------------
* Function: H5VLattr_create
*
* Purpose: Creates an attribute through the VOL
*
* Return: Success: pointer to the new attr.
*
* Failure: NULL
*
* Programmer: Mohamad Chaarawi
* April, 2012
*
*-------------------------------------------------------------------------
*/
void *
H5VLattr_create(void *obj, H5VL_loc_params_t loc_params, H5VL_t *vol_plugin, const char *name,
hid_t acpl_id, hid_t aapl_id, hid_t req)
{
void *ret_value = NULL; /* Return value */
FUNC_ENTER_API(NULL)
if (NULL == obj || NULL == vol_plugin || NULL == vol_plugin->cls)
HGOTO_ERROR(H5E_ARGS, H5E_BADVALUE, NULL, "invalid object/VOL class pointer")
if(NULL == (ret_value = H5VL_attr_create(obj, loc_params, vol_plugin, name, acpl_id, aapl_id, req)))
HGOTO_ERROR(H5E_VOL, H5E_CANTINIT, NULL, "unable to create attribute")
done:
FUNC_LEAVE_API(ret_value)
} /* end H5VLattr_create() */
/*-------------------------------------------------------------------------
* Function: H5VLattr_open
*
* Purpose: Opens an attribute through the VOL
*
* Return: Success: pointer to the new attr.
*
* Failure: NULL
*
* Programmer: Mohamad Chaarawi
* March, 2012
*
*-------------------------------------------------------------------------
*/
void *
H5VLattr_open(void *obj, H5VL_loc_params_t loc_params, H5VL_t *vol_plugin, const char *name,
hid_t aapl_id, hid_t req)
{
void *ret_value; /* Return value */
FUNC_ENTER_API(NULL)
if (NULL == obj || NULL == vol_plugin || NULL == vol_plugin->cls)
HGOTO_ERROR(H5E_ARGS, H5E_BADVALUE, NULL, "invalid object/VOL class pointer")
if(NULL == (ret_value = H5VL_attr_open(obj, loc_params, vol_plugin, name, aapl_id, req)))
HGOTO_ERROR(H5E_VOL, H5E_CANTINIT, NULL, "unable to open attribute")
done:
FUNC_LEAVE_API(ret_value)
} /* end H5VLattr_open() */
/*-------------------------------------------------------------------------
* Function: H5VLattr_read
*
* Purpose: Reads data from attr through the VOL
*
* Return: Success: Non Negative
*
* Failure: Negative
*
* Programmer: Mohamad Chaarawi
* March, 2012
*
*-------------------------------------------------------------------------
*/
herr_t H5VLattr_read(void *attr, H5VL_t *vol_plugin, hid_t mem_type_id, void *buf, hid_t req)
{
herr_t ret_value = SUCCEED;
FUNC_ENTER_API(FAIL)
if (NULL == attr || NULL == vol_plugin || NULL == vol_plugin->cls)
HGOTO_ERROR(H5E_ARGS, H5E_BADVALUE, FAIL, "invalid object/VOL class pointer")
if((ret_value = H5VL_attr_read(attr, vol_plugin, mem_type_id, buf, req)) < 0)
HGOTO_ERROR(H5E_VOL, H5E_CANTINIT, FAIL, "unable to read attribute")
done:
FUNC_LEAVE_API(ret_value)
} /* end H5VLattr_read() */
/*-------------------------------------------------------------------------
* Function: H5VLattr_write
*
* Purpose: Writes data to attr through the VOL
*
* Return: Success: Non Negative
*
* Failure: Negative
*
* Programmer: Mohamad Chaarawi
* March, 2012
*
*-------------------------------------------------------------------------
*/
herr_t H5VLattr_write(void *attr, H5VL_t *vol_plugin, hid_t mem_type_id, const void *buf, hid_t req)
{
herr_t ret_value = SUCCEED;
FUNC_ENTER_API(FAIL)
if (NULL == attr || NULL == vol_plugin || NULL == vol_plugin->cls)
HGOTO_ERROR(H5E_ARGS, H5E_BADVALUE, FAIL, "invalid object/VOL class pointer")
if((ret_value = H5VL_attr_write(attr, vol_plugin, mem_type_id, buf, req)) < 0)
HGOTO_ERROR(H5E_VOL, H5E_CANTINIT, FAIL, "unable to write attribute")
done:
FUNC_LEAVE_API(ret_value)
} /* end H5VLattr_write() */
/*-------------------------------------------------------------------------
* Function: H5VLattr_get
*
* Purpose: Get specific information about the attribute through the VOL
*
* Return: Success: non negative
*
* Failure: negative
*
* Programmer: Mohamad Chaarawi
* March, 2012
*
*-------------------------------------------------------------------------
*/
herr_t
H5VLattr_get(void *obj, H5VL_t *vol_plugin, H5VL_attr_get_t get_type, hid_t req, ...)
{
herr_t ret_value = SUCCEED;
FUNC_ENTER_API(FAIL)
if (NULL == obj || NULL == vol_plugin || NULL == vol_plugin->cls)
HGOTO_ERROR(H5E_ARGS, H5E_BADVALUE, FAIL, "invalid object/VOL class pointer")
if((ret_value = H5VL_attr_get(obj, vol_plugin, get_type, req)) < 0)
HGOTO_ERROR(H5E_VOL, H5E_CANTINIT, FAIL, "unable to get attribute information")
done:
FUNC_LEAVE_API(ret_value)
} /* end H5VLattr_get() */
/*-------------------------------------------------------------------------
* Function: H5VLattr_remove
*
* Purpose: Removes an attribute through the VOL
*
* Return: Success: Non Negative
*
* Failure: Negative
*
* Programmer: Mohamad Chaarawi
* March, 2012
*
*-------------------------------------------------------------------------
*/
herr_t
H5VLattr_remove(void *obj, H5VL_loc_params_t loc_params, H5VL_t *vol_plugin,
const char *attr_name, hid_t req)
{
herr_t ret_value = SUCCEED;
FUNC_ENTER_API(FAIL)
if (NULL == obj || NULL == vol_plugin || NULL == vol_plugin->cls)
HGOTO_ERROR(H5E_ARGS, H5E_BADVALUE, FAIL, "invalid object/VOL class pointer")
if((ret_value = H5VL_attr_remove(obj, loc_params, vol_plugin, attr_name, req)) < 0)
HGOTO_ERROR(H5E_VOL, H5E_CANTINIT, FAIL, "unable to remove attribute")
done:
FUNC_LEAVE_API(ret_value)
} /* end H5VLattr_remove() */
/*-------------------------------------------------------------------------
* Function: H5VLattr_close
*
* Purpose: Closes an attribute through the VOL
*
* Return: Success: Non Negative
*
* Failure: Negative
*
* Programmer: Mohamad Chaarawi
* March, 2012
*
*-------------------------------------------------------------------------
*/
herr_t
H5VLattr_close(void *attr, H5VL_t *vol_plugin, hid_t req)
{
herr_t ret_value = SUCCEED;
FUNC_ENTER_API(FAIL)
if (NULL == attr || NULL == vol_plugin || NULL == vol_plugin->cls)
HGOTO_ERROR(H5E_ARGS, H5E_BADVALUE, FAIL, "invalid object/VOL class pointer")
if((ret_value = H5VL_attr_close(attr, vol_plugin, req)) < 0)
HGOTO_ERROR(H5E_VOL, H5E_CANTRELEASE, FAIL, "unable to close attribute")
done:
FUNC_LEAVE_API(ret_value)
} /* end H5VLattr_close() */
/*-------------------------------------------------------------------------
* Function: H5VLdatatype_commit
*
* Purpose: Commits a datatype to the file through the VOL
*
* Return: Success: Positive
*
* Failure: Negative
*
* Programmer: Mohamad Chaarawi
* March, 2012
*
*-------------------------------------------------------------------------
*/
void *
H5VLdatatype_commit(void *obj, H5VL_loc_params_t loc_params, H5VL_t *vol_plugin, const char *name,
hid_t type_id, hid_t lcpl_id, hid_t tcpl_id, hid_t tapl_id, hid_t req)
{
void *ret_value = NULL; /* Return value */
FUNC_ENTER_API(NULL)
if (NULL == obj || NULL == vol_plugin || NULL == vol_plugin->cls)
HGOTO_ERROR(H5E_ARGS, H5E_BADVALUE, NULL, "invalid object/VOL class pointer")
if(NULL == (ret_value = H5VL_datatype_commit(obj, loc_params, vol_plugin, name, type_id,
lcpl_id, tcpl_id, tapl_id, req)))
HGOTO_ERROR(H5E_VOL, H5E_CANTINIT, NULL, "unable to commit datatype")
done:
FUNC_LEAVE_API(ret_value)
} /* end H5VLdatatype_commit() */
/*-------------------------------------------------------------------------
* Function: H5VLdatatype_open
*
* Purpose: Opens a named datatype through the VOL
*
* Return: Success: User ID of the datatype.
*
* Failure: NULL
*
* Programmer: Mohamad Chaarawi
* March, 2012
*
*-------------------------------------------------------------------------
*/
void *
H5VLdatatype_open(void *obj, H5VL_loc_params_t loc_params, H5VL_t *vol_plugin, const char *name,
hid_t tapl_id, hid_t req)
{
void *ret_value = NULL; /* Return value */
FUNC_ENTER_API(NULL)
if (NULL == obj || NULL == vol_plugin || NULL == vol_plugin->cls)
HGOTO_ERROR(H5E_ARGS, H5E_BADVALUE, NULL, "invalid object/VOL class pointer")
if(NULL == (ret_value = H5VL_datatype_open(obj, loc_params, vol_plugin, name, tapl_id, req)))
HGOTO_ERROR(H5E_VOL, H5E_CANTINIT, NULL, "unable to open datatype")
done:
FUNC_LEAVE_API(ret_value)
} /* end H5VLdatatype_open() */
/*-------------------------------------------------------------------------
* Function: H5VLdatatype_get_binary
*
* Purpose: gets required size to serialize datatype description
*
* Return: Success: size needed
*
* Failure: negative
*
* Programmer: Mohamad Chaarawi
* March, 2012
*
*-------------------------------------------------------------------------
*/
ssize_t
H5VLdatatype_get_binary(void *obj, H5VL_t *vol_plugin, unsigned char *buf, size_t size, hid_t req)
{
ssize_t ret_value = FAIL;
FUNC_ENTER_API(FAIL)
if (NULL == obj || NULL == vol_plugin || NULL == vol_plugin->cls)
HGOTO_ERROR(H5E_ARGS, H5E_BADVALUE, FAIL, "invalid object/VOL class pointer")
if((ret_value = H5VL_datatype_get_binary(obj, vol_plugin, buf, size, req)))
HGOTO_ERROR(H5E_VOL, H5E_CANTINIT, FAIL, "unable to encode datatype")
done:
FUNC_LEAVE_API(ret_value)
} /* end H5VLdatatype_get_binary() */
/*-------------------------------------------------------------------------
* Function: H5VLdatatype_close
*
* Purpose: Closes a datatype through the VOL
*
* Return: Success: Positive
* Failure: Negative
*
* Programmer: Mohamad Chaarawi
* May, 2012
*
*-------------------------------------------------------------------------
*/
herr_t
H5VLdatatype_close(void *dt, H5VL_t *vol_plugin, hid_t req)
{
herr_t ret_value = SUCCEED; /* Return value */
FUNC_ENTER_API(FAIL)
if (NULL == dt || NULL == vol_plugin || NULL == vol_plugin->cls)
HGOTO_ERROR(H5E_ARGS, H5E_BADVALUE, FAIL, "invalid object/VOL class pointer")
if((ret_value = H5VL_datatype_close(dt, vol_plugin, req)) < 0)
HGOTO_ERROR(H5E_VOL, H5E_CANTRELEASE, FAIL, "unable to close datatype")
done:
FUNC_LEAVE_API(ret_value)
} /* end H5VLdatatype_close() */
/*-------------------------------------------------------------------------
* Function: H5VLdataset_create
*
* Purpose: Creates a dataset through the VOL
*
* Return: Success: pointer to dataset
*
* Failure: NULL
*
* Programmer: Mohamad Chaarawi
* March, 2012
*
*-------------------------------------------------------------------------
*/
void *
H5VLdataset_create(void *obj, H5VL_loc_params_t loc_params, H5VL_t *vol_plugin, const char *name,
hid_t dcpl_id, hid_t dapl_id, hid_t req)
{
void *ret_value; /* Return value */
FUNC_ENTER_API(NULL)
if (NULL == obj || NULL == vol_plugin || NULL == vol_plugin->cls)
HGOTO_ERROR(H5E_ARGS, H5E_BADVALUE, NULL, "invalid object/VOL class pointer")
if(NULL == (ret_value = H5VL_dataset_create(obj, loc_params, vol_plugin, name,
dcpl_id, dapl_id, req)))
HGOTO_ERROR(H5E_VOL, H5E_CANTINIT, NULL, "unable to create dataset")
done:
FUNC_LEAVE_API(ret_value)
} /* end H5VLdataset_create() */
/*-------------------------------------------------------------------------
* Function: H5VLdataset_open
*
* Purpose: Opens a dataset through the VOL
*
* Return: Success: pointer to dataset
*
* Failure: NULL
*
* Programmer: Mohamad Chaarawi
* March, 2012
*
*-------------------------------------------------------------------------
*/
void *
H5VLdataset_open(void *obj, H5VL_loc_params_t loc_params, H5VL_t *vol_plugin, const char *name,
hid_t dapl_id, hid_t req)
{
void *ret_value; /* Return value */
FUNC_ENTER_API(NULL)
if (NULL == obj || NULL == vol_plugin || NULL == vol_plugin->cls)
HGOTO_ERROR(H5E_ARGS, H5E_BADVALUE, NULL, "invalid object/VOL class pointer")
if(NULL == (ret_value = H5VL_dataset_open(obj, loc_params, vol_plugin, name, dapl_id, req)))
HGOTO_ERROR(H5E_VOL, H5E_CANTINIT, NULL, "unable to open dataset")
done:
FUNC_LEAVE_API(ret_value)
} /* end H5VLdataset_open() */
/*-------------------------------------------------------------------------
* Function: H5VLdataset_read
*
* Purpose: Reads data from dataset through the VOL
*
* Return: Success: Non Negative
*
* Failure: Negative
*
* Programmer: Mohamad Chaarawi
* March, 2012
*
*-------------------------------------------------------------------------
*/
herr_t
H5VLdataset_read(void *dset, H5VL_t *vol_plugin, hid_t mem_type_id, hid_t mem_space_id,
hid_t file_space_id, hid_t plist_id, void *buf, hid_t req)
{
herr_t ret_value = SUCCEED;
FUNC_ENTER_API(FAIL)
if (NULL == dset || NULL == vol_plugin || NULL == vol_plugin->cls)
HGOTO_ERROR(H5E_ARGS, H5E_BADVALUE, FAIL, "invalid object/VOL class pointer")
if((ret_value = H5VL_dataset_read(dset, vol_plugin, mem_type_id, mem_space_id, file_space_id,
plist_id, buf, req)) < 0)
HGOTO_ERROR(H5E_VOL, H5E_CANTINIT, FAIL, "unable to read dataset")
done:
FUNC_LEAVE_API(ret_value)
} /* end H5VLdataset_read() */
/*-------------------------------------------------------------------------
* Function: H5VLdataset_write
*
* Purpose: Writes data from dataset through the VOL
*
* Return: Success: Non Negative
*
* Failure: Negative
*
* Programmer: Mohamad Chaarawi
* March, 2012
*
*-------------------------------------------------------------------------
*/
herr_t
H5VLdataset_write(void *dset, H5VL_t *vol_plugin, hid_t mem_type_id, hid_t mem_space_id,
hid_t file_space_id, hid_t plist_id, const void *buf, hid_t req)
{
herr_t ret_value = SUCCEED;
FUNC_ENTER_API(FAIL)
if (NULL == dset || NULL == vol_plugin || NULL == vol_plugin->cls)
HGOTO_ERROR(H5E_ARGS, H5E_BADVALUE, FAIL, "invalid object/VOL class pointer")
if((ret_value = H5VL_dataset_write(dset, vol_plugin, mem_type_id, mem_space_id, file_space_id,
plist_id, buf, req)) < 0)
HGOTO_ERROR(H5E_VOL, H5E_CANTINIT, FAIL, "unable to write dataset")
done:
FUNC_LEAVE_API(ret_value)
} /* end H5VLdataset_write() */
/*-------------------------------------------------------------------------
* Function: H5VLdataset_set_extent
*
* Purpose: Modifies the dimensions of a dataset
*
* Return: Success: Non Negative
*
* Failure: Negative
*
* Programmer: Mohamad Chaarawi
* March, 2012
*
*-------------------------------------------------------------------------
*/
herr_t
H5VLdataset_set_extent(void *dset, H5VL_t *vol_plugin, const hsize_t size[], hid_t req)
{
herr_t ret_value = SUCCEED;
FUNC_ENTER_API(FAIL)
if (NULL == dset || NULL == vol_plugin || NULL == vol_plugin->cls)
HGOTO_ERROR(H5E_ARGS, H5E_BADVALUE, FAIL, "invalid object/VOL class pointer")
if((ret_value = H5VL_dataset_set_extent(dset, vol_plugin, size, req)) < 0)
HGOTO_ERROR(H5E_VOL, H5E_CANTINIT, FAIL, "unable to set extent of dataset")
done:
FUNC_LEAVE_API(ret_value)
} /* end H5VLdataset_set_extent() */
/*-------------------------------------------------------------------------
* Function: H5VLdataset_get
*
* Purpose: Get specific information about the dataset through the VOL
*
* Return: Success: non negative
*
* Failure: negative
*
* Programmer: Mohamad Chaarawi
* March, 2012
*
*-------------------------------------------------------------------------
*/
herr_t
H5VLdataset_get(void *dset, H5VL_t *vol_plugin, H5VL_dataset_get_t get_type, hid_t req, ...)
{
herr_t ret_value = SUCCEED;
FUNC_ENTER_API(FAIL)
if (NULL == dset || NULL == vol_plugin || NULL == vol_plugin->cls)
HGOTO_ERROR(H5E_ARGS, H5E_BADVALUE, FAIL, "invalid object/VOL class pointer")
if((ret_value = H5VL_dataset_get(dset, vol_plugin, get_type, req)) < 0)
HGOTO_ERROR(H5E_VOL, H5E_CANTINIT, FAIL, "unable to get dataset information")
done:
FUNC_LEAVE_API(ret_value)
} /* end H5VLdataset_get() */
/*-------------------------------------------------------------------------
* Function: H5VLdataset_close
*
* Purpose: Closes a dataset through the VOL
*
* Return: Success: Non Negative
*
* Failure: Negative
*
* Programmer: Mohamad Chaarawi
* March, 2012
*
*-------------------------------------------------------------------------
*/
herr_t
H5VLdataset_close(void *dset, H5VL_t *vol_plugin, hid_t req)
{
herr_t ret_value = SUCCEED;
FUNC_ENTER_API(FAIL)
if (NULL == dset || NULL == vol_plugin || NULL == vol_plugin->cls)
HGOTO_ERROR(H5E_ARGS, H5E_BADVALUE, FAIL, "invalid object/VOL class pointer")
if((ret_value = H5VL_dataset_close(dset, vol_plugin, req)) < 0)
HGOTO_ERROR(H5E_VOL, H5E_CANTRELEASE, FAIL, "unable to close dataset")
done:
FUNC_LEAVE_API(ret_value)
} /* end H5VLdataset_close() */
/*-------------------------------------------------------------------------
* Function: H5VLfile_create
*
* Purpose: Creates a file through the VOL
*
* Return: Success: pointer to file.
*
* Failure: NULL
*
* Programmer: Mohamad Chaarawi
* January, 2012
*
*-------------------------------------------------------------------------
*/
void *
H5VLfile_create(H5VL_t **vol_plugin, const char *name, unsigned flags, hid_t fcpl_id,
hid_t fapl_id, hid_t req)
{
void *ret_value; /* Return value */
FUNC_ENTER_API(NULL)
if(NULL == (ret_value = H5VL_file_create(vol_plugin, name, flags, fcpl_id, fapl_id, req)))
HGOTO_ERROR(H5E_VOL, H5E_CANTINIT, NULL, "unable to create file")
done:
FUNC_LEAVE_API(ret_value)
} /* end H5VLfile_create() */
/*-------------------------------------------------------------------------
* Function: H5VLfile_open
*
* Purpose: Opens a file through the VOL.
*
* Return: Success: pointer to file.
*
* Failure: NULL
*
* Programmer: Mohamad Chaarawi
* January, 2012
*
*-------------------------------------------------------------------------
*/
void *
H5VLfile_open(H5VL_t **vol_plugin, const char *name, unsigned flags, hid_t fapl_id, hid_t req)
{
void *ret_value; /* Return value */
FUNC_ENTER_API(NULL)
if(NULL == (ret_value = H5VL_file_open(vol_plugin, name, flags, fapl_id, req)))
HGOTO_ERROR(H5E_VOL, H5E_CANTINIT, NULL, "unable to create file")
done:
FUNC_LEAVE_API(ret_value)
} /* end H5VLfile_open() */
/*-------------------------------------------------------------------------
* Function: H5VLfile_flush
*
* Purpose: Flushes a file through the VOL
*
* Return: Success: Non Negative
*
* Failure: Negative
*
* Programmer: Mohamad Chaarawi
* February, 2012
*
*-------------------------------------------------------------------------
*/
herr_t
H5VLfile_flush(void *obj, H5VL_loc_params_t loc_params, H5VL_t *vol_plugin,
H5F_scope_t scope, hid_t req)
{
herr_t ret_value = SUCCEED;
FUNC_ENTER_API(FAIL)
if (NULL == obj || NULL == vol_plugin || NULL == vol_plugin->cls)
HGOTO_ERROR(H5E_ARGS, H5E_BADVALUE, FAIL, "invalid object/VOL class pointer")
if((ret_value = H5VL_file_flush(obj, loc_params, vol_plugin, scope, req)) < 0)
HGOTO_ERROR(H5E_VOL, H5E_CANTINIT, FAIL, "unable to flush file")
done:
FUNC_LEAVE_API(ret_value)
} /* end H5VLfile_flush() */
/*-------------------------------------------------------------------------
* Function: H5VLfile_get
*
* Purpose: Get specific information about the file through the VOL
*
* Return: Success: non negative
*
* Failure: negative
*
* Programmer: Mohamad Chaarawi
* February, 2012
*
*-------------------------------------------------------------------------
*/
herr_t
H5VLfile_get(void *file, H5VL_t *vol_plugin, H5VL_file_get_t get_type, hid_t req, ...)
{
va_list arguments; /* argument list passed from the API call */
herr_t ret_value = SUCCEED;
FUNC_ENTER_API(FAIL)
if(NULL == file || NULL == vol_plugin || NULL == vol_plugin->cls)
HGOTO_ERROR(H5E_ARGS, H5E_BADVALUE, FAIL, "invalid object/VOL class pointer")
if((ret_value = H5VL_file_get(file, vol_plugin, get_type, req)) < 0)
HGOTO_ERROR(H5E_VOL, H5E_CANTINIT, FAIL, "unable to get file information")
done:
FUNC_LEAVE_API(ret_value)
} /* end H5VLfile_get() */
/*-------------------------------------------------------------------------
* Function: H5VLfile_misc
*
* Purpose: perform a specified operation through the VOL
*
* Return: Success: non negative
* Failure: negative
*
* Programmer: Mohamad Chaarawi
* April, 2012
*
*-------------------------------------------------------------------------
*/
herr_t
H5VLfile_misc(void *file, H5VL_t *vol_plugin, H5VL_file_misc_t misc_type, hid_t req, ...)
{
va_list arguments; /* argument list passed from the API call */
herr_t ret_value = SUCCEED;
FUNC_ENTER_API(FAIL)
if(NULL == file || NULL == vol_plugin || NULL == vol_plugin->cls)
HGOTO_ERROR(H5E_ARGS, H5E_BADVALUE, FAIL, "invalid object/VOL class pointer")
if((ret_value = H5VL_file_misc(file, vol_plugin, misc_type, req)) < 0)
HGOTO_ERROR(H5E_VOL, H5E_CANTINIT, FAIL, "unable to operate on the file")
done:
FUNC_LEAVE_API(ret_value)
} /* end H5VLfile_misc() */
/*-------------------------------------------------------------------------
* Function: H5VLfile_optional
*
* Purpose: perform a plugin specific operation
*
* Return: Success: non negative
* Failure: negative
*
* Programmer: Mohamad Chaarawi
* April, 2012
*
*-------------------------------------------------------------------------
*/
herr_t
H5VLfile_optional(void *file, H5VL_t *vol_plugin, H5VL_file_optional_t optional_type, hid_t req, ...)
{
va_list arguments; /* argument list passed from the API call */
herr_t ret_value = SUCCEED;
FUNC_ENTER_API(FAIL)
if(NULL == file || NULL == vol_plugin || NULL == vol_plugin->cls)
HGOTO_ERROR(H5E_ARGS, H5E_BADVALUE, FAIL, "invalid object/VOL class pointer")
if((ret_value = H5VL_file_optional(file, vol_plugin, optional_type, req)) < 0)
HGOTO_ERROR(H5E_VOL, H5E_CANTINIT, FAIL, "unable to operate on the file")
done:
FUNC_LEAVE_API(ret_value)
} /* end H5VLfile_optional() */
/*-------------------------------------------------------------------------
* Function: H5VLfile_close
*
* Purpose: Closes a file through the VOL
*
* Return: Success: Non Negative
*
* Failure: Negative
*
* Programmer: Mohamad Chaarawi
* January, 2012
*
*-------------------------------------------------------------------------
*/
herr_t
H5VLfile_close(void *file, H5VL_t *vol_plugin, hid_t req)
{
herr_t ret_value = SUCCEED;
FUNC_ENTER_API(FAIL)
if(NULL == file || NULL == vol_plugin || NULL == vol_plugin->cls)
HGOTO_ERROR(H5E_ARGS, H5E_BADVALUE, FAIL, "invalid object/VOL class pointer")
if((ret_value = H5VL_file_close(file, vol_plugin, req)) < 0)
HGOTO_ERROR(H5E_VOL, H5E_CANTRELEASE, FAIL, "unable to close file")
done:
FUNC_LEAVE_API(ret_value)
} /* end H5VLfile_close() */
/*-------------------------------------------------------------------------
* Function: H5VLgroup_create
*
* Purpose: Creates a group through the VOL
*
* Return: Success: pointer to new group.
*
* Failure: NULL
*
* Programmer: Mohamad Chaarawi
* March, 2012
*
*-------------------------------------------------------------------------
*/
void *
H5VLgroup_create(void *obj, H5VL_loc_params_t loc_params, H5VL_t *vol_plugin, const char *name,
hid_t gcpl_id, hid_t gapl_id, hid_t req)
{
void *ret_value = NULL; /* Return value */
FUNC_ENTER_API(NULL)
if (NULL == obj || NULL == vol_plugin || NULL == vol_plugin->cls)
HGOTO_ERROR(H5E_ARGS, H5E_BADVALUE, NULL, "invalid object/VOL class pointer")
if(NULL == (ret_value = H5VL_group_create(obj, loc_params, vol_plugin, name,
gcpl_id, gapl_id, req)))
HGOTO_ERROR(H5E_VOL, H5E_CANTINIT, NULL, "unable to create group")
done:
FUNC_LEAVE_API(ret_value)
} /* end H5VLgroup_create() */
/*-------------------------------------------------------------------------
* Function: H5VLgroup_open
*
* Purpose: Opens a group through the VOL
*
* Return: Success: pointer to new group.
*
* Failure: NULL
*
* Programmer: Mohamad Chaarawi
* March, 2012
*
*-------------------------------------------------------------------------
*/
void *
H5VLgroup_open(void *obj, H5VL_loc_params_t loc_params, H5VL_t *vol_plugin, const char *name,
hid_t gapl_id, hid_t req)
{
void *ret_value; /* Return value */
FUNC_ENTER_API(NULL)
if (NULL == obj || NULL == vol_plugin || NULL == vol_plugin->cls)
HGOTO_ERROR(H5E_ARGS, H5E_BADVALUE, NULL, "invalid object/VOL class pointer")
if(NULL == (ret_value = H5VL_group_open(obj, loc_params, vol_plugin, name,
gapl_id, req)))
HGOTO_ERROR(H5E_VOL, H5E_CANTINIT, NULL, "unable to open group")
done:
FUNC_LEAVE_API(ret_value)
} /* end H5VLgroup_open() */
/*-------------------------------------------------------------------------
* Function: H5VLgroup_get
*
* Purpose: Get specific information about the group through the VOL
*
* Return: Success: non negative
*
* Failure: negative
*
* Programmer: Mohamad Chaarawi
* February, 2012
*
*-------------------------------------------------------------------------
*/
herr_t
H5VLgroup_get(void *obj, H5VL_t *vol_plugin, H5VL_group_get_t get_type, hid_t req, ...)
{
herr_t ret_value = SUCCEED;
FUNC_ENTER_API(FAIL)
if(NULL == obj || NULL == vol_plugin || NULL == vol_plugin->cls)
HGOTO_ERROR(H5E_ARGS, H5E_BADVALUE, FAIL, "invalid object/VOL class pointer")
if((ret_value = H5VL_group_get(obj, vol_plugin, get_type, req)) < 0)
HGOTO_ERROR(H5E_VOL, H5E_CANTINIT, FAIL, "unable to get group information")
done:
FUNC_LEAVE_API(ret_value)
} /* end H5VLgroup_get() */
/*-------------------------------------------------------------------------
* Function: H5VLgroup_close
*
* Purpose: Closes a group through the VOL
*
* Return: Success: Non Negative
*
* Failure: Negative
*
* Programmer: Mohamad Chaarawi
* March, 2012
*
*-------------------------------------------------------------------------
*/
herr_t
H5VLgroup_close(void *grp, H5VL_t *vol_plugin, hid_t req)
{
herr_t ret_value = SUCCEED;
FUNC_ENTER_API(FAIL)
if(NULL == grp || NULL == vol_plugin || NULL == vol_plugin->cls)
HGOTO_ERROR(H5E_ARGS, H5E_BADVALUE, FAIL, "invalid object/VOL class pointer")
if((ret_value = H5VL_group_close(grp, vol_plugin, req)) < 0)
HGOTO_ERROR(H5E_VOL, H5E_CANTRELEASE, FAIL, "unable to close group")
done:
FUNC_LEAVE_API(ret_value)
} /* end H5VLgroup_close() */
/*-------------------------------------------------------------------------
* Function: H5VLlink_create
*
* Purpose: Creates a hard link through the VOL
*
* Return: Non-negative on success/Negative on failure
*
* Programmer: Mohamad Chaarawi
* April, 2012
*
*-------------------------------------------------------------------------
*/
herr_t
H5VLlink_create(H5VL_link_create_type_t create_type, void *obj, H5VL_loc_params_t loc_params,
H5VL_t *vol_plugin, hid_t lcpl_id, hid_t lapl_id, hid_t req)
{
herr_t ret_value = SUCCEED; /* Return value */
FUNC_ENTER_API(FAIL)
if(NULL == obj || NULL == vol_plugin || NULL == vol_plugin->cls)
HGOTO_ERROR(H5E_ARGS, H5E_BADVALUE, FAIL, "invalid object/VOL class pointer")
if((ret_value = H5VL_link_create(create_type, obj, loc_params, vol_plugin, lcpl_id, lapl_id, req)) < 0)
HGOTO_ERROR(H5E_VOL, H5E_CANTINIT, FAIL, "unable to create link")
done:
FUNC_LEAVE_API(ret_value)
} /* end H5VLlink_create() */
/*-------------------------------------------------------------------------
* Function: H5VLlink_move
*
* Purpose: Copy or move a link from src to dst.
*
* Return: Non-negative on success/Negative on failure
*
* Programmer: Mohamad Chaarawi
* April, 2012
*
*-------------------------------------------------------------------------
*/
H5_DLL herr_t H5VLlink_move(void *src_obj, H5VL_loc_params_t loc_params1, void *dst_obj,
H5VL_loc_params_t loc_params2, H5VL_t *vol_plugin,
hbool_t copy_flag, hid_t lcpl_id, hid_t lapl_id, hid_t req)
{
herr_t ret_value = SUCCEED; /* Return value */
FUNC_ENTER_API(FAIL)
if(NULL == src_obj || NULL == dst_obj || NULL == vol_plugin || NULL == vol_plugin->cls)
HGOTO_ERROR(H5E_ARGS, H5E_BADVALUE, FAIL, "invalid object/VOL class pointer")
if((ret_value = H5VL_link_move(src_obj, loc_params1, dst_obj, loc_params2, vol_plugin,
copy_flag, lcpl_id, lapl_id, req)) < 0)
HGOTO_ERROR(H5E_VOL, H5E_CANTINIT, FAIL, "unable to move object")
done:
FUNC_LEAVE_API(ret_value)
} /* end H5VLlink_move() */
/*-------------------------------------------------------------------------
* Function: H5VLlink_iterate
*
* Purpose: Iterate over links in a group
*
* Return: Success: non negative
* Failure: negative
*
* Programmer: Mohamad Chaarawi
* May, 2012
*
*-------------------------------------------------------------------------
*/
herr_t H5VLlink_iterate(void *obj, H5VL_loc_params_t loc_params, H5VL_t *vol_plugin,
hbool_t recursive, H5_index_t idx_type, H5_iter_order_t order, hsize_t *idx,
H5L_iterate_t op, void *op_data, hid_t req)
{
herr_t ret_value = SUCCEED;
FUNC_ENTER_API(FAIL)
if(NULL == obj || NULL == vol_plugin || NULL == vol_plugin->cls)
HGOTO_ERROR(H5E_ARGS, H5E_BADVALUE, FAIL, "invalid object/VOL class pointer")
if((ret_value = H5VL_link_iterate(obj, loc_params, vol_plugin, recursive, idx_type, order, idx,
op, op_data, req)) < 0)
HGOTO_ERROR(H5E_VOL, H5E_CANTINIT, FAIL, "Link iteration failed")
done:
FUNC_LEAVE_API(ret_value)
} /* end H5VLlink_iterate() */
/*-------------------------------------------------------------------------
* Function: H5VLlink_get
*
* Purpose: Get specific information about the link through the VOL
*
* Return: Success: non negative
*
* Failure: negative
*
* Programmer: Mohamad Chaarawi
* April, 2012
*
*-------------------------------------------------------------------------
*/
herr_t
H5VLlink_get(void *obj, H5VL_loc_params_t loc_params, H5VL_t *vol_plugin, H5VL_link_get_t get_type,
hid_t req, ...)
{
va_list arguments; /* argument list passed from the API call */
herr_t ret_value = SUCCEED;
FUNC_ENTER_API(FAIL)
if(NULL == obj || NULL == vol_plugin || NULL == vol_plugin->cls)
HGOTO_ERROR(H5E_ARGS, H5E_BADVALUE, FAIL, "invalid object/VOL class pointer")
if((ret_value = H5VL_link_get(obj, loc_params, vol_plugin, get_type, req)) < 0)
HGOTO_ERROR(H5E_VOL, H5E_CANTINIT, FAIL, "unable to get link information")
done:
FUNC_LEAVE_API(ret_value)
} /* end H5VLlink_get() */
/*-------------------------------------------------------------------------
* Function: H5VLlink_remove
*
* Purpose: Removes a link through the VOL.
*
* Return: Non-negative on success/Negative on failure
*
* Programmer: Mohamad Chaarawi
* April, 2012
*
*-------------------------------------------------------------------------
*/
H5_DLL herr_t H5VLlink_remove(void *obj, H5VL_loc_params_t loc_params, H5VL_t *vol_plugin, hid_t req)
{
herr_t ret_value = SUCCEED; /* Return value */
FUNC_ENTER_API(FAIL)
if(NULL == obj || NULL == vol_plugin || NULL == vol_plugin->cls)
HGOTO_ERROR(H5E_ARGS, H5E_BADVALUE, FAIL, "invalid object/VOL class pointer")
if((ret_value = H5VL_link_remove(obj, loc_params, vol_plugin, req)) < 0)
HGOTO_ERROR(H5E_VOL, H5E_CANTINIT, FAIL, "unable to remove link")
done:
FUNC_LEAVE_API(ret_value)
} /* end H5VLlink_remove() */
/*-------------------------------------------------------------------------
* Function: H5VLobject_open
*
* Purpose: Opens a object through the VOL
*
* Return: Success: User ID of the new object.
*
* Failure: NULL
*
* Programmer: Mohamad Chaarawi
* March, 2012
*
*-------------------------------------------------------------------------
*/
void *
H5VLobject_open(void *obj, H5VL_loc_params_t params, H5VL_t *vol_plugin, H5I_type_t *opened_type,
hid_t req)
{
void *ret_value; /* Return value */
FUNC_ENTER_API(NULL)
if (NULL == obj || NULL == vol_plugin || NULL == vol_plugin->cls)
HGOTO_ERROR(H5E_ARGS, H5E_BADVALUE, NULL, "invalid object/VOL class pointer")
if(NULL == (ret_value = H5VL_object_open(obj, params, vol_plugin, opened_type, req)))
HGOTO_ERROR(H5E_VOL, H5E_CANTINIT, NULL, "unable to create group")
done:
FUNC_LEAVE_API(ret_value)
} /* end H5VLobject_open() */
/*-------------------------------------------------------------------------
* Function: H5VLobject_copy
*
* Purpose: Copies an object to another destination through the VOL
*
* Return: Success: Non Negative
* Failure: Negative
*
* Programmer: Mohamad Chaarawi
* April, 2012
*
*-------------------------------------------------------------------------
*/
herr_t
H5VLobject_copy(void *src_obj, H5VL_loc_params_t loc_params1, H5VL_t *vol_plugin1, const char *src_name,
void *dst_obj, H5VL_loc_params_t loc_params2, H5VL_t *vol_plugin2, const char *dst_name,
hid_t ocpypl_id, hid_t lcpl_id, hid_t req)
{
herr_t ret_value = SUCCEED;
FUNC_ENTER_API(FAIL)
if(NULL == src_obj || NULL == dst_obj || NULL == vol_plugin1 ||
NULL == vol_plugin2 || NULL == vol_plugin1->cls || NULL == vol_plugin2->cls)
HGOTO_ERROR(H5E_ARGS, H5E_BADVALUE, FAIL, "invalid object/VOL class pointer")
if((ret_value = H5VL_object_copy(src_obj, loc_params1, vol_plugin1, src_name,
dst_obj, loc_params2, vol_plugin2, dst_name,
ocpypl_id, lcpl_id, req)) < 0)
HGOTO_ERROR(H5E_VOL, H5E_CANTINIT, FAIL, "unable to move object")
done:
FUNC_LEAVE_API(ret_value)
} /* end H5VLobject_copy() */
/*-------------------------------------------------------------------------
* Function: H5VLobject_visit
*
* Purpose: Iterate over links in a group
*
* Return: Success: non negative
* Failure: negative
*
* Programmer: Mohamad Chaarawi
* May, 2012
*
*-------------------------------------------------------------------------
*/
herr_t H5VLobject_visit(void *obj, H5VL_loc_params_t loc_params, H5VL_t *vol_plugin, H5_index_t idx_type,
H5_iter_order_t order, H5O_iterate_t op, void *op_data, hid_t req)
{
herr_t ret_value = SUCCEED;
FUNC_ENTER_API(FAIL)
if(NULL == obj || NULL == vol_plugin || NULL == vol_plugin->cls)
HGOTO_ERROR(H5E_ARGS, H5E_BADVALUE, FAIL, "invalid object/VOL class pointer")
if((ret_value = H5VL_object_visit(obj, loc_params, vol_plugin, idx_type, order,
op, op_data, req)) < 0)
HGOTO_ERROR(H5E_VOL, H5E_CANTINIT, FAIL, "Object Visit Failed")
done:
FUNC_LEAVE_API(ret_value)
} /* end H5VLobject_visit() */
/*-------------------------------------------------------------------------
* Function: H5VLobject_get
*
* Purpose: Get specific information about the object through the VOL
*
* Return: Success: non negative
*
* Failure: negative
*
* Programmer: Mohamad Chaarawi
* February, 2012
*
*-------------------------------------------------------------------------
*/
herr_t
H5VLobject_get(void *obj, H5VL_loc_params_t loc_params, H5VL_t *vol_plugin, H5VL_object_get_t get_type,
hid_t req, ...)
{
va_list arguments; /* argument list passed from the API call */
herr_t ret_value = SUCCEED;
FUNC_ENTER_API(FAIL)
if(NULL == obj || NULL == vol_plugin || NULL == vol_plugin->cls)
HGOTO_ERROR(H5E_ARGS, H5E_BADVALUE, FAIL, "invalid object/VOL class pointer")
if((ret_value = H5VL_object_get(obj, loc_params, vol_plugin, get_type, req)) < 0)
HGOTO_ERROR(H5E_VOL, H5E_CANTINIT, FAIL, "Object Visit Failed")
done:
FUNC_LEAVE_API(ret_value)
} /* end H5VLobject_get() */
/*-------------------------------------------------------------------------
* Function: H5VLobject_misc
*
* Purpose: perform a plugin specific operation
*
* Return: Success: non negative
* Failure: negative
*
* Programmer: Mohamad Chaarawi
* April, 2012
*
*-------------------------------------------------------------------------
*/
herr_t
H5VLobject_misc(void *obj, H5VL_loc_params_t loc_params, H5VL_t *vol_plugin, H5VL_object_misc_t misc_type,
hid_t req, ...)
{
herr_t ret_value = SUCCEED;
FUNC_ENTER_API(FAIL)
if(NULL == obj || NULL == vol_plugin || NULL == vol_plugin->cls)
HGOTO_ERROR(H5E_ARGS, H5E_BADVALUE, FAIL, "invalid object/VOL class pointer")
if((ret_value = H5VL_object_misc(obj, loc_params, vol_plugin, misc_type, req)) < 0)
HGOTO_ERROR(H5E_VOL, H5E_CANTINIT, FAIL, "Object Visit Failed")
done:
FUNC_LEAVE_API(ret_value)
} /* end H5VLobject_misc() */
/*-------------------------------------------------------------------------
* Function: H5VLobject_close
*
* Purpose: Closes a object through the VOL
*
* Return: Success: Non Negative
*
* Failure: Negative
*
* Programmer: Mohamad Chaarawi
* March, 2012
*
*-------------------------------------------------------------------------
*/
herr_t
H5VLobject_close(void *obj, H5VL_loc_params_t loc_params, H5VL_t *vol_plugin, hid_t req)
{
herr_t ret_value = SUCCEED;
FUNC_ENTER_API(FAIL)
if(NULL == obj || NULL == vol_plugin || NULL == vol_plugin->cls)
HGOTO_ERROR(H5E_ARGS, H5E_BADVALUE, FAIL, "invalid object/VOL class pointer")
if((ret_value = H5VL_object_close(obj, loc_params, vol_plugin, req)) < 0)
HGOTO_ERROR(H5E_VOL, H5E_CANTRELEASE, FAIL, "unable to close object")
done:
FUNC_LEAVE_API(ret_value)
} /* end H5VLobject_close() */
|