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
|
/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
* 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 H5F_PACKAGE /*suppress error about including H5Fpkg */
#define H5VL_PACKAGE /*suppress error about including H5FDpkg */
/* Interface initialization */
#define H5_INTERFACE_INIT_FUNC H5VL_init_interface
/***********/
/* Headers */
/***********/
#include "H5private.h" /* Generic Functions */
#include "H5Dprivate.h" /* Datasets */
#include "H5Eprivate.h" /* Error handling */
#include "H5VLpkg.h" /* VOL package header */
#include "H5VLprivate.h" /* VOL */
#include "H5Fpkg.h" /* File access */
#include "H5Iprivate.h" /* IDs */
#include "H5MMprivate.h" /* Memory management */
#include "H5Pprivate.h" /* Property lists */
/********************/
/* 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(H5VL_init, 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(H5VL_init_interface)
if(H5I_register_type(H5I_VOL, (size_t)H5I_VOL_HASHSIZE, 0, (H5I_free_t)H5VL_free_cls)<H5I_FILE)
HGOTO_ERROR(H5E_VFL, 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;
FUNC_ENTER_NOAPI_NOINIT_NOFUNC(H5VL_term_interface)
if(H5_interface_initialize_g) {
if((n=H5I_nmembers(H5I_VOL))!=0) {
H5I_clear_type(H5I_VOL, FALSE, FALSE);
} else {
H5I_dec_type_ref(H5I_VFL);
H5_interface_initialize_g = 0;
n = 1; /*H5I*/
}
}
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(H5VL_free_cls)
/* 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_xfree(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(H5VLregister, 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: H5VL_register
*
* 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 driver is
* unregistered.
*
* Failure: A negative value.
*
* Programmer: Mohamad Chaarawi
* January, 2012
*-------------------------------------------------------------------------
*/
hid_t
H5VL_register(const void *_cls, size_t size, hbool_t app_ref)
{
const H5VL_class_t *cls = (const H5VL_class_t *)_cls;
H5VL_class_t *saved = NULL;
hid_t ret_value;
FUNC_ENTER_NOAPI(H5VL_register, FAIL)
/* Check arguments */
HDassert(cls);
/*MSC - check required funciton pointers */
/* Copy the class structure so the caller can reuse or free it */
if(NULL == (saved = (H5VL_class_t *)H5MM_malloc(size)))
HGOTO_ERROR(H5E_RESOURCE, H5E_NOSPACE, FAIL,
"memory allocation failed for vol plugin class struct")
HDmemcpy(saved, cls, size);
/* Create the new class ID */
if((ret_value = H5I_register(H5I_VFL, saved, app_ref)) < 0)
HGOTO_ERROR(H5E_ATOM, H5E_CANTREGISTER, FAIL, "unable to register vol plugin ID")
done:
if(ret_value < 0)
if(saved)
H5MM_xfree(saved);
FUNC_LEAVE_NOAPI(ret_value)
} /* end H5VL_register() */
/*-------------------------------------------------------------------------
* 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(H5VLunregister, FAIL)
H5TRACE1("e", "i", vol_id);
/* Check arguments */
if(NULL == H5I_object_verify(vol_id, H5I_VFL))
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_VFL, H5E_CANTDEC, FAIL, "unable to unregister vol plugin")
done:
FUNC_LEAVE_API(ret_value)
} /* end H5VLunregister() */
/*-------------------------------------------------------------------------
* Function: H5VL_get_class
*
* Purpose: Obtains a pointer to the vol plugin struct containing all the
* callback pointers, etc. The PLIST_ID argument can be a file
* access property list or a vol plugin identifier.
*
* Return: Success: Ptr to the vol plugin information. The pointer is
* only valid as long as the vol plugin remains
* registered or some file or property list
* exists which references the vol plugin.
*
* Failure: NULL
*
* Programmer: Mohamad Chaarawi
* January, 2012
*
*-------------------------------------------------------------------------
*/
H5VL_class_t *
H5VL_get_class(hid_t id)
{
H5VL_class_t *ret_value = NULL;
FUNC_ENTER_NOAPI(H5VL_get_class, NULL)
if(H5I_VFL == H5I_get_type(id))
ret_value = (H5VL_class_t *)H5I_object(id);
else {
H5P_genplist_t *plist; /* Property list pointer */
hid_t vol_id = -1;
/* Get the plist structure */
if(NULL == (plist = (H5P_genplist_t *)H5I_object(id)))
HGOTO_ERROR(H5E_ATOM, H5E_BADATOM, NULL, "can't find object for ID")
if(TRUE == H5P_isa_class(id, H5P_FILE_ACCESS)) {
if(H5P_get(plist, H5F_ACS_VOL_ID_NAME, &vol_id) < 0)
HGOTO_ERROR(H5E_PLIST, H5E_CANTGET, NULL, "can't get vol ID")
ret_value = H5VL_get_class(vol_id);
} else {
HGOTO_ERROR(H5E_ARGS, H5E_BADTYPE, NULL, "not a vol plugin id, file access property list")
}
} /* end if */
done:
FUNC_LEAVE_NOAPI(ret_value)
} /* end H5VL_get_class() */
#if 0 /* MSC not needed */
/*-------------------------------------------------------------------------
* Function: H5VL_sb_size
*
* Purpose: Obtains the number of bytes required to store the vol plugin
* file access data in the HDF5 superblock.
*
* Return: Success: Number of bytes required.
*
* Failure: 0 if an error occurs or if the vol plugin has no
* data to store in the superblock.
*
* Programmer: Mohamad Chaarawi
* January, 2012
*
* Modifications:
*
*-------------------------------------------------------------------------
*/
hsize_t
H5VL_sb_size(H5F_t *file)
{
hsize_t ret_value=0;
FUNC_ENTER_NOAPI(H5VL_sb_size, 0)
assert(file && file->cls);
if(file->cls->sb_size)
ret_value = (file->cls->sb_size)(file);
done:
FUNC_LEAVE_NOAPI(ret_value)
}
#endif
/*-------------------------------------------------------------------------
* Function: H5VL_fapl_open
*
* Purpose: Mark a vol as used by a file access property list
*
* Return: Success: non-negative
*
* Failure: negative
*
* Programmer: Mohamad Chaarawi
* January, 2012
*
* Modifications:
*
*-------------------------------------------------------------------------
*/
herr_t
H5VL_fapl_open(H5P_genplist_t *plist, hid_t vol_id, const void *vol_info)
{
void *copied_vol_info = NULL; /* Temporary VFL vol info */
herr_t ret_value = SUCCEED; /* Return value */
FUNC_ENTER_NOAPI(H5VL_fapl_open, FAIL)
/* Increment the reference count on vol and copy vol info */
if(H5I_inc_ref(vol_id, FALSE) < 0)
HGOTO_ERROR(H5E_FILE, H5E_CANTINC, FAIL, "unable to increment ref count on vol plugin")
if(H5VL_fapl_copy(vol_id, vol_info, &copied_vol_info) < 0)
HGOTO_ERROR(H5E_FILE, H5E_CANTCOPY, FAIL, "can't copy vol info")
/* Set the vol properties for the list */
if(H5P_set(plist, H5F_ACS_VOL_ID_NAME, &vol_id) < 0)
HGOTO_ERROR(H5E_FILE, H5E_CANTSET, FAIL, "can't set vol ID")
if(H5P_set(plist, H5F_ACS_VOL_INFO_NAME, &copied_vol_info) < 0)
HGOTO_ERROR(H5E_FILE, H5E_CANTSET, FAIL, "can't set vol info")
copied_vol_info = NULL;
done:
if(ret_value < 0)
if(copied_vol_info && H5VL_fapl_close(vol_id, copied_vol_info) < 0)
HDONE_ERROR(H5E_FILE, H5E_CANTCLOSEOBJ, FAIL, "can't close copy of vol info")
FUNC_LEAVE_NOAPI(ret_value)
} /* end H5VL_fapl_open() */
/*-------------------------------------------------------------------------
* Function: H5VL_fapl_copy
*
* Purpose: Copies the vol-specific part of the file access property
* list.
*
* Return: Success: non-negative
*
* Failure: negative
*
* Programmer: Mohamad Chaarawi
* January, 2012
*
* Modifications:
*
*-------------------------------------------------------------------------
*/
herr_t
H5VL_fapl_copy(hid_t vol_id, const void *old_fapl, void **copied_fapl)
{
H5VL_class_t *vol;
void *new_pl = NULL; /* Copy of property list */
herr_t ret_value = SUCCEED; /* Return value */
FUNC_ENTER_NOAPI(H5VL_fapl_copy, FAIL)
/* Check args */
if(NULL == (vol = (H5VL_class_t *)H5I_object(vol_id)))
HGOTO_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL, "not a vol ID")
/* Copy the file access property list */
if(old_fapl) {
if(vol->fapl_copy) {
new_pl = (vol->fapl_copy)(old_fapl);
if(new_pl==NULL)
HGOTO_ERROR(H5E_VOL, H5E_NOSPACE, FAIL, "property list copy failed")
}
else if(vol->fapl_size > 0) {
if((new_pl = H5MM_malloc(vol->fapl_size))==NULL)
HGOTO_ERROR(H5E_VOL, H5E_NOSPACE, FAIL, "property list allocation failed")
HDmemcpy(new_pl, old_fapl, vol->fapl_size);
} else
HGOTO_ERROR(H5E_VOL, H5E_UNSUPPORTED, FAIL, "no way to copy vol property list")
} /* end if */
/* Set copied value */
*copied_fapl=new_pl;
done:
FUNC_LEAVE_NOAPI(ret_value)
}
/*-------------------------------------------------------------------------
* Function: H5VL_fapl_close
*
* Purpose: Closes a vol for a property list
*
* Return: Success: non-negative
* Failure: negative
*
* Programmer: Mohamad Chaarawi
* January, 2012
*
* Modifications:
*
*-------------------------------------------------------------------------
*/
herr_t
H5VL_fapl_close(hid_t vol_id, void *fapl)
{
H5VL_class_t *vol = NULL;
herr_t ret_value = SUCCEED; /* Return value */
FUNC_ENTER_NOAPI(H5VL_fapl_close, FAIL)
/* Check args */
if(vol_id > 0) {
if(NULL == (vol = (H5VL_class_t *)H5I_object(vol_id)))
HGOTO_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL, "not a vol ID")
/* Allow driver to free or do it ourselves */
if(fapl && vol->fapl_free) {
if((vol->fapl_free)(fapl) < 0)
HGOTO_ERROR(H5E_VOL, H5E_CANTINIT, FAIL, "driver free request failed")
} /* end if */
else
H5MM_xfree(fapl);
/* Decrement reference count for driver */
if(H5I_dec_ref(vol_id) < 0)
HGOTO_ERROR(H5E_VOL, H5E_CANTDEC, FAIL, "can't decrement reference count for vol plugin")
} /* end if */
done:
FUNC_LEAVE_NOAPI(ret_value)
} /* end H5VL_fapl_close() */
/*-------------------------------------------------------------------------
* Function: H5VL_open
*
* Purpose: Private version of H5VLopen()
*
* Return: Success: Pointer to a new file struct
*
* Failure: NULL
*
* Programmer: Mohamad Chaarawi
* January, 2012
*
*-------------------------------------------------------------------------
*/
H5F_t *
H5VL_open(const char *name, unsigned flags, hid_t fapl_id)
{
H5VL_class_t *vol_plugin; /* VOL for file */
H5F_t *file = NULL; /* VOL file struct */
hid_t plugin_id = -1; /* VOL ID */
H5P_genplist_t *plist; /* Property list pointer */
H5F_t *ret_value; /* Return value */
FUNC_ENTER_NOAPI(H5VL_open, NULL)
if(NULL == (plist = (H5P_genplist_t *)H5I_object(fapl_id)))
HGOTO_ERROR(H5E_ARGS, H5E_BADTYPE, NULL, "not a file access property list")
if(H5P_get(plist, H5F_ACS_VOL_ID_NAME, &plugin_id) < 0)
HGOTO_ERROR(H5E_PLIST, H5E_CANTGET, NULL, "can't get vol plugin ID")
if(NULL == (vol_plugin = (H5VL_class_t *)H5I_object(plugin_id)))
HGOTO_ERROR(H5E_VOL, H5E_BADVALUE, NULL, "invalid vol plugin ID in file access property list")
if(NULL == vol_plugin->file_cls.open)
HGOTO_ERROR(H5E_VOL, H5E_UNSUPPORTED, NULL, "vol plugin has no `file open' method")
if(NULL == (file = (vol_plugin->file_cls.open)(name, flags, fapl_id)))
HGOTO_ERROR(H5E_VOL, H5E_CANTINIT, NULL, "open failed")
/*
* Fill in public fields. We must increment the reference count on the
* vol plugin ID to prevent it from being freed while this file is open.
*/
file->vol_id = plugin_id;
if(H5I_inc_ref(file->vol_id, FALSE) < 0)
HGOTO_ERROR(H5E_VOL, H5E_CANTINC, NULL, "unable to increment ref count on VOL plugin")
//file->vol_cls = vol_plugin;
/* Set return value */
ret_value = file;
done:
FUNC_LEAVE_NOAPI(ret_value)
} /* end H5VL_open() */
/*-------------------------------------------------------------------------
* Function: H5VL_create
*
* Purpose: Private version of H5VLcreate()
*
* Return: Success: Pointer to a new file struct
*
* Failure: NULL
*
* Programmer: Mohamad Chaarawi
* January, 2012
*
*-------------------------------------------------------------------------
*/
H5F_t *
H5VL_create(const char *name, unsigned flags, hid_t fcpl_id, hid_t fapl_id)
{
H5VL_class_t *vol_plugin; /* VOL for file */
H5F_t *file = NULL; /* VOL file struct */
hid_t plugin_id = -1; /* VOL ID */
H5P_genplist_t *plist; /* Property list pointer */
H5F_t *ret_value; /* Return value */
FUNC_ENTER_NOAPI(H5VL_create, NULL)
if(NULL == (plist = (H5P_genplist_t *)H5I_object(fapl_id)))
HGOTO_ERROR(H5E_ARGS, H5E_BADTYPE, NULL, "not a file access property list")
if(H5P_get(plist, H5F_ACS_VOL_ID_NAME, &plugin_id) < 0)
HGOTO_ERROR(H5E_PLIST, H5E_CANTGET, NULL, "can't get vol plugin ID")
if(NULL == (vol_plugin = (H5VL_class_t *)H5I_object(plugin_id)))
HGOTO_ERROR(H5E_VOL, H5E_BADVALUE, NULL, "invalid vol plugin ID in file access property list")
if(NULL == vol_plugin->file_cls.create)
HGOTO_ERROR(H5E_VOL, H5E_UNSUPPORTED, NULL, "vol plugin has no `file create' method")
if(NULL == (file = (vol_plugin->file_cls.create)(name, flags, fcpl_id, fapl_id)))
HGOTO_ERROR(H5E_VOL, H5E_CANTINIT, NULL, "create failed")
/*
* Fill in public fields. We must increment the reference count on the
* vol plugin ID to prevent it from being freed while this file is open.
*/
file->vol_id = plugin_id;
//file->vol_cls = vol_plugin;
if(H5I_inc_ref(file->vol_id, FALSE) < 0)
HGOTO_ERROR(H5E_VOL, H5E_CANTINC, NULL, "unable to increment ref count on VOL plugin")
/* Set return value */
ret_value = file;
done:
FUNC_LEAVE_NOAPI(ret_value)
} /* end H5VL_create() */
/*-------------------------------------------------------------------------
* Function: H5VL_close
*
* Purpose: Private version of H5VLclose()
*
* Return: Success: Pointer to a new file struct
*
* Failure: NULL
*
* Programmer: Mohamad Chaarawi
* January, 2012
*
*-------------------------------------------------------------------------
*/
herr_t
H5VL_close(H5F_t *file)
{
H5VL_class_t *vol_plugin; /* VOL for file */
H5P_genplist_t *plist; /* Property list pointer */
herr_t ret_value = SUCCEED;
FUNC_ENTER_NOAPI(H5VL_close, FAIL)
/* check args */
HDassert(file);
/* Prepare to close file by clearing all public fields */
if(NULL == (vol_plugin = (H5VL_class_t *)H5I_object(file->vol_id)))
HGOTO_ERROR(H5E_VOL, H5E_BADVALUE, FAIL, "invalid vol plugin ID in file")
if(H5I_dec_ref(file->vol_id) < 0)
HGOTO_ERROR(H5E_VFL, H5E_CANTDEC, FAIL, "can't close plugin ID")
/*
* Dispatch to the driver for actual close. If the driver fails to
* close the file then the file will be in an unusable state.
*/
if(NULL == vol_plugin->file_cls.close)
HGOTO_ERROR(H5E_VOL, H5E_UNSUPPORTED, FAIL, "vol plugin has no `file close' method")
if((vol_plugin->file_cls.close)(file) < 0)
HGOTO_ERROR(H5E_VOL, H5E_CANTCLOSEFILE, FAIL, "close failed")
done:
FUNC_LEAVE_NOAPI(ret_value)
} /* end H5VL_close() */
|