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
|
/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
* 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 "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)<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)
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: 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() */
|
