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
|
/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
* 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.org>
* January 23, 2012
*/
#ifndef _H5VLpublic_H
#define _H5VLpublic_H
#include "stdarg.h"
#include "H5public.h"
#include "H5Fpublic.h"
#include "H5Lpublic.h"
#include "H5Opublic.h"
/* Dataset creation property names */
#define H5VL_DSET_TYPE_ID "dataset_type_id"
#define H5VL_DSET_SPACE_ID "dataset_space_id"
#define H5VL_DSET_LCPL_ID "dataset_lcpl_id"
/* Attribute creation property names */
#define H5VL_ATTR_TYPE_ID "attr_type_id"
#define H5VL_ATTR_SPACE_ID "attr_space_id"
#define H5VL_ATTR_LOCATION "attr_location"
/* Link creation property names */
#define H5VL_LINK_TARGET_ID "target location id"
#define H5VL_LINK_TARGET_NAME "target name"
#define H5VL_LINK_TYPE "link type"
#define H5VL_LINK_UDATA "udata"
#define H5VL_LINK_UDATA_SIZE "udata size"
/* Group creation property names */
#define H5VL_GRP_LCPL_ID "group_lcpl_id"
/* types for all attr get API routines */
typedef enum H5VL_attr_get_t {
H5VL_ATTR_EXISTS = 0, /* H5Aexists */
H5VL_ATTR_GET_SPACE = 1, /* dataspace */
H5VL_ATTR_GET_TYPE = 2, /* datatype */
H5VL_ATTR_GET_ACPL = 3, /* creation property list */
H5VL_ATTR_GET_NAME = 4, /* access property list */
H5VL_ATTR_GET_STORAGE_SIZE = 5, /* storage size */
H5VL_ATTR_GET_INFO = 6 /* offset */
} H5VL_attr_get_t;
/* types for all dataset get API routines */
typedef enum H5VL_dataset_get_t {
H5VL_DATASET_GET_SPACE = 0, /* dataspace */
H5VL_DATASET_GET_SPACE_STATUS = 1, /* space status */
H5VL_DATASET_GET_TYPE = 2, /* datatype */
H5VL_DATASET_GET_DCPL = 3, /* creation property list */
H5VL_DATASET_GET_DAPL = 4, /* access property list */
H5VL_DATASET_GET_STORAGE_SIZE = 5, /* storage size */
H5VL_DATASET_GET_OFFSET = 6 /* offset */
} H5VL_dataset_get_t;
/* types for all file get API routines */
typedef enum H5VL_file_get_t {
H5VL_FILE_GET_FAPL = 0, /*file access property list */
H5VL_FILE_GET_FCPL = 1, /*file creation property list */
H5VL_FILE_GET_INTENT = 2, /*file intent */
H5VL_FILE_GET_NAME = 3, /*file name */
H5VL_FILE_GET_OBJ_COUNT = 4, /*object count in file */
H5VL_FILE_GET_OBJ_IDS = 5, /*object ids in file */
} H5VL_file_get_t;
/* types for all file misc operations */
typedef enum H5VL_file_misc_t {
H5VL_FILE_IS_HDF5 = 0, /* is HDF5? */
H5VL_FILE_MOUNT = 1,
H5VL_FILE_UNMOUNT = 2
} H5VL_file_misc_t;
/* types for all file optional operations */
typedef enum H5VL_file_optional_t {
H5VL_FILE_CLEAR_ELINK_CACHE = 0,
H5VL_FILE_GET_FILE_IMAGE = 1, /*file image */
H5VL_FILE_GET_FREE_SECTIONS = 2, /*file free selections */
H5VL_FILE_GET_FREE_SPACE = 3, /*file freespace */
H5VL_FILE_GET_INFO = 4, /*file info */
H5VL_FILE_GET_MDC_CONF = 5, /*file metadata cache configuration */
H5VL_FILE_GET_MDC_HR = 6, /*file metadata cache hit rate */
H5VL_FILE_GET_MDC_SIZE = 7, /*file metadata cache size */
H5VL_FILE_GET_SIZE = 8, /*file size */
H5VL_FILE_GET_VFD_HANDLE = 9, /*file VFD handle */
H5VL_FILE_REOPEN = 10,
H5VL_FILE_RESET_MDC_HIT_RATE = 11,
H5VL_FILE_SET_MDC_CONFIG = 12
} H5VL_file_optional_t;
/* types for all group get API routines */
typedef enum H5VL_group_get_t {
H5VL_GROUP_GET_GCPL = 0, /*group creation property list */
H5VL_GROUP_GET_INFO = 1 /*group info */
} H5VL_group_get_t;
/* link create types for VOL */
typedef enum H5VL_link_create_type_t {
H5VL_LINK_CREATE_HARD = 0,
H5VL_LINK_CREATE_SOFT = 1,
H5VL_LINK_CREATE_UD = 2
} H5VL_link_create_type_t;
/* types for all link get API routines */
typedef enum H5VL_link_get_t {
H5VL_LINK_EXISTS = 0, /*link existence */
H5VL_LINK_GET_INFO = 1, /*link info */
H5VL_LINK_GET_NAME = 2, /*link name */
H5VL_LINK_GET_VAL = 3 /*link value */
} H5VL_link_get_t;
/* types for all object general operations */
typedef enum H5VL_object_misc_t {
H5VL_ATTR_DELETE_BY_IDX = 0, /* H5Adelete_by_idx */
H5VL_ATTR_OPEN_BY_IDX = 1, /* H5Aopen_by_idx */
H5VL_ATTR_RENAME = 2, /* H5Arename */
H5VL_OBJECT_CHANGE_REF_COUNT = 3, /* H5Oincr/decr_refcount */
H5VL_OBJECT_SET_COMMENT = 4, /* H5Oset_comment(_by_name) */
H5VL_REF_CREATE = 5 /* H5Rcreate */
} H5VL_object_misc_t;
/* types for all object general operations */
typedef enum H5VL_object_optional_t {
H5VL_OPTIONAL = 0
} H5VL_object_optional_t;
/* types for all object get API routines */
typedef enum H5VL_object_get_t {
H5VL_OBJECT_EXISTS = 0, /* H5Oexists_by_name) */
H5VL_OBJECT_GET_INFO = 1, /*object info */
H5VL_OBJECT_GET_COMMENT = 2, /*object comment */
H5VL_REF_GET_REGION = 3, /*dataspace of region */
H5VL_REF_GET_TYPE = 4, /*type of object */
H5VL_REF_GET_NAME = 5 /*object name */
} H5VL_object_get_t;
/* types for all object lookup API routines */
typedef enum H5VL_object_lookup_t {
H5VL_OBJECT_LOOKUP_BY_ID = 0,
H5VL_OBJECT_LOOKUP_BY_NAME = 1,
H5VL_OBJECT_LOOKUP_BY_IDX = 2,
H5VL_OBJECT_LOOKUP_BY_ADDR = 3,
H5VL_OBJECT_LOOKUP_BY_REF = 4
} H5VL_object_lookup_t;
#define H5VL_VOL_DEFAULT 0 /* Default VOL plugin value */
/* H5A routines */
typedef struct H5VL_attr_class_t {
hid_t (*create)(hid_t loc_id, const char *attr_name, hid_t acpl_id, hid_t aapl_id, hid_t req);
hid_t (*open) (hid_t loc_id, void *location, const char *attr_name, hid_t aapl_id, hid_t req);
herr_t (*read) (hid_t attr_id, hid_t mem_type_id, void *buf, hid_t req);
herr_t (*write) (hid_t attr_id, hid_t mem_type_id, const void *buf, hid_t req);
herr_t (*get) (hid_t loc_id, H5VL_attr_get_t get_type, hid_t req, va_list arguments);
herr_t (*remove)(hid_t loc_id, void *location, const char *attr_name, hid_t req);
herr_t (*close) (hid_t attr_id, hid_t req);
} H5VL_attr_class_t;
/* H5T routines*/
typedef struct H5VL_datatype_class_t {
herr_t (*commit)(hid_t loc_id, const char *name, hid_t type_id,
hid_t lcpl_id, hid_t tcpl_id, hid_t tapl_id, hid_t req);
hid_t (*open) (hid_t loc_id, const char * name, hid_t tapl_id, hid_t req);
herr_t (*close) (hid_t type_id, hid_t req);
}H5VL_datatype_class_t;
/* H5D routines */
typedef struct H5VL_dataset_class_t {
hid_t (*create)(hid_t loc_id, const char *name, hid_t dcpl_id, hid_t dapl_id, hid_t req);
hid_t (*open) (hid_t loc_id, const char *name, hid_t dapl_id, hid_t req);
herr_t (*read) (hid_t dataset_id, hid_t mem_type_id, hid_t mem_space_id, hid_t file_space_id,
hid_t xfer_plist_id, void * buf, hid_t req);
herr_t (*write) (hid_t dataset_id, hid_t mem_type_id, hid_t mem_space_id, hid_t file_space_id,
hid_t xfer_plist_id, const void * buf, hid_t req);
herr_t (*set_extent) (hid_t loc_id, const hsize_t size[], hid_t req);
herr_t (*get) (hid_t file_id, H5VL_dataset_get_t get_type, hid_t req, va_list arguments);
herr_t (*close) (hid_t dataset_id, hid_t req);
} H5VL_dataset_class_t;
/* H5F routines */
typedef struct H5VL_file_class_t {
hid_t (*create)(const char *name, unsigned flags, hid_t fcpl_id, hid_t fapl_id, hid_t req);
hid_t (*open) (const char *name, unsigned flags, hid_t fapl_id, hid_t req);
herr_t (*flush) (hid_t file_id, H5F_scope_t scope, hid_t req);
herr_t (*get) (hid_t file_id, H5VL_file_get_t get_type, hid_t req, va_list arguments);
herr_t (*misc)(hid_t loc_id, H5VL_file_misc_t misc_type, hid_t req, va_list arguments);
herr_t (*optional)(hid_t id, H5VL_file_optional_t op_type, hid_t req, va_list arguments);
herr_t (*close) (hid_t file_id, hid_t req);
} H5VL_file_class_t;
/* H5G routines */
typedef struct H5VL_group_class_t {
hid_t (*create)(hid_t loc_id, const char *name, hid_t gcpl_id, hid_t gapl_id, hid_t req);
hid_t (*open) (hid_t loc_id, const char *name, hid_t gapl_id, hid_t req);
herr_t (*get) (hid_t file_id, H5VL_group_get_t get_type, hid_t req, va_list arguments);
herr_t (*close) (hid_t group_id, hid_t req);
} H5VL_group_class_t;
/* H5L routines */
typedef struct H5VL_link_class_t {
herr_t (*create)(H5VL_link_create_type_t create_type, hid_t link_loc_id, const char *link_name,
hid_t lcpl_id, hid_t lapl_id, hid_t req);
herr_t (*move) (hid_t src_loc_id, const char *src_name, hid_t dst_loc_id,
const char *dest_name, hbool_t copy_flag, hid_t lcpl, hid_t lapl, hid_t req);
herr_t (*iterate) (hid_t loc_id, const char *name, 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 lapl_id);
herr_t (*get) (hid_t loc_id, H5VL_link_get_t get_type, hid_t req, va_list arguments);
herr_t (*remove)(hid_t loc_id, const char *name, void *udata, hid_t lapl_id, hid_t req);
} H5VL_link_class_t;
/* H5O routines */
typedef struct H5VL_object_class_t {
hid_t (*open) (void *obj_loc, hid_t lapl_id, hid_t req);
herr_t (*copy) (hid_t src_loc_id, const char *src_name, hid_t dst_loc_id, const char *dst_name,
hid_t ocpypl_id, hid_t lcpl_id, hid_t req);
herr_t (*visit) (hid_t loc_id, const char *obj_name, H5_index_t idx_type, H5_iter_order_t order,
H5O_iterate_t op, void *op_data, hid_t lapl_id);
herr_t (*lookup)(hid_t loc_id, H5VL_object_lookup_t lookup_type, void **location, hid_t req, va_list arguments);
herr_t (*free_loc)(void *location, hid_t req);
herr_t (*get) (hid_t loc_id, H5VL_object_get_t get_type, hid_t req, va_list arguments);
herr_t (*misc) (hid_t id, H5VL_object_misc_t misc_type, hid_t req, va_list arguments);
herr_t (*optional)(hid_t id, H5VL_object_optional_t op_type, hid_t req, va_list arguments);
herr_t (*close) (hid_t obj_id, hid_t req);
} H5VL_object_class_t;
/* Class information for each VOL driver */
typedef struct H5VL_class_t {
const char *name;
unsigned nrefs; /* Ref count for times struct is pointed to */
herr_t (*initialize)(void);
herr_t (*terminate)(void);
H5VL_attr_class_t attr_cls;
H5VL_datatype_class_t datatype_cls;
H5VL_dataset_class_t dataset_cls;
H5VL_file_class_t file_cls;
H5VL_group_class_t group_cls;
H5VL_link_class_t link_cls;
H5VL_object_class_t object_cls;
} H5VL_class_t;
#ifdef __cplusplus
extern "C" {
#endif
/* Function prototypes */
H5_DLL hid_t H5VLregister(const H5VL_class_t *cls);
H5_DLL herr_t H5VLunregister(hid_t driver_id);
H5_DLL ssize_t H5VLget_plugin_name(hid_t id, char *name/*out*/, size_t size);
#ifdef __cplusplus
}
#endif
#endif /* _H5VLpublic_H */
|
