File: H5Vol_def.h

package info (click to toggle)
adios2 2.10.2%2Bdfsg1-2
  • links: PTS, VCS
  • area: main
  • in suites: trixie
  • size: 33,764 kB
  • sloc: cpp: 175,964; ansic: 160,510; f90: 14,630; yacc: 12,668; python: 7,275; perl: 7,126; sh: 2,825; lisp: 1,106; xml: 1,049; makefile: 579; lex: 557
file content (253 lines) | stat: -rw-r--r-- 9,159 bytes parent folder | download | duplicates (3)
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
#ifndef __H5VOL_DEFS
#define __H5VOL_DEFS

#include <hdf5.h>

#include "H5VolError.h"
#include "H5VolUtil.h"
#include <adios2_c.h>

#include <assert.h>
#include <stdio.h>
#include <stdlib.h>
#include <string.h>

#define H5_ATTR_UNUSED /**/

// Define the values for the first entries of
// VOL struct H5VL_class_t
#define H5VL_ADIOS2_NAME "ADIOS2_VOL"
#define H5VL_ADIOS2_VALUE 511 /* VOL connector ID */
#define H5VL_ADIOS2_VERSION 0
#define H5VL_ADIOS2_CAP_FLAGS                                                                      \
    (H5VL_CAP_FLAG_FILE_BASIC | H5VL_CAP_FLAG_GROUP_BASIC | H5VL_CAP_FLAG_DATASET_BASIC |          \
     H5VL_CAP_FLAG_ATTR_BASIC | H5VL_CAP_FLAG_OBJECT_BASIC)

typedef struct H5VL_ADIOS2_t
{
    adios2_engine *m_Engine;
    adios2_io *m_IO;
} H5VL_FileDef_t;

typedef struct H5VL_VARDef_t
{
    char *m_Name;
    hid_t m_ShapeID;
    hid_t m_TypeID;
    hid_t m_MemSpaceID;
    hid_t m_HyperSlabID;
    hid_t m_PropertyID;
    void *m_Data; // used for both write & read so not going to be const
    adios2_engine *m_Engine;
    adios2_variable *m_Variable; // mainly for read reuse
    size_t m_DimCount;
} H5VL_VarDef_t;

typedef struct H5VL_ATTRDef_t
{
    char *m_Name;
    hid_t m_SpaceID;
    hid_t m_TypeID;
    const void *m_Data;
    bool m_IsScalar;
    size_t m_Size;                 // num of elements
    adios2_attribute *m_Attribute; // for read reuse
} H5VL_AttrDef_t;

typedef struct H5VL_GROUPDef_t
{
    char *m_Name;
} H5VL_GroupDef_t;

//
// if (m_Parent == NULL)  => FILE
// otherwise type is the non null pointer
//
// m_Parent is of type < H5VL_ObjDef_t >
//
enum H5VL_PTR_TYPES
{
    ROOT = 3,
    GROUP = 2,
    VAR = 1,
    ATTR = 0
};

typedef struct H5VL_ObjDef
{
    void *m_ObjPtr;
    void *m_Parent;
    char *m_Path; // NULL if is ROOT.
    enum H5VL_PTR_TYPES m_ObjType;

    size_t m_NumVars;
    adios2_variable **m_Vars;

    size_t m_NumAttrs;
    adios2_attribute **m_Attrs;

    size_t m_NumSubGroups;
    char **m_SubGroupNames;

    adios2_io *m_FileIO;
} H5VL_ObjDef_t;

#ifdef __cplusplus
extern "C" {
#endif
//
// file functions
//
extern void *H5VL_adios2_file_create(const char *name, unsigned flags, hid_t fcpl_id, hid_t fapl_id,
                                     hid_t dxpl_id, void **req);

extern void *H5VL_adios2_file_open(const char *name, unsigned flags, hid_t fapl_id, hid_t dxpl_id,
                                   void **req);

extern herr_t H5VL_adios2_file_specific(void *file, H5VL_file_specific_args_t *args, hid_t dxpl_id,
                                        void **req);

extern herr_t H5VL_adios2_file_close(void *file, hid_t dxpl_id, void **req);

//
// attr functions
//
extern void *H5VL_adios2_attr_create(void *obj, const H5VL_loc_params_t *loc_params,
                                     const char *name, hid_t type_id, hid_t space_id, hid_t acpl_id,
                                     hid_t aapl_id, hid_t dxpl_id, void **req);

extern void *H5VL_adios2_attr_open(void *obj, const H5VL_loc_params_t *loc_params, const char *name,
                                   hid_t aapl_id, hid_t dxpl_id, void **req);

extern herr_t H5VL_adios2_attr_read(void *attrObj, hid_t mem_type_id, void *buf, hid_t dxpl_id,
                                    void **req);

extern herr_t H5VL_adios2_attr_write(void *attr, hid_t mem_type_id, const void *buf, hid_t dxpl_id,
                                     void **req);

extern herr_t H5VL_adios2_attr_get(void *obj, H5VL_attr_get_args_t *args, hid_t dxpl_id,
                                   void **req);

extern herr_t H5VL_adios2_attr_close(void *attr, hid_t dxpl_id, void **req);

extern herr_t H5VL_adios2_attr_specific(void *obj, const H5VL_loc_params_t *loc_params,
                                        H5VL_attr_specific_args_t *args, hid_t dxpl_id, void **req);

//
// object functions:
//
extern void *H5VL_adios2_object_open(void *obj, const H5VL_loc_params_t *loc_params,
                                     H5I_type_t *opened_type, hid_t H5_ATTR_UNUSED dxpl_id,
                                     void H5_ATTR_UNUSED **req);

extern herr_t H5VL_adios2_object_get(void *obj, const H5VL_loc_params_t *loc_params,
                                     H5VL_object_get_args_t *args, hid_t H5_ATTR_UNUSED dxpl_id,
                                     void H5_ATTR_UNUSED **req);

// dataset functions:
extern void *H5VL_adios2_dataset_create(void *obj, const H5VL_loc_params_t *loc_params,
                                        const char *name, hid_t lcpl_id, hid_t type_id,
                                        hid_t space_id, hid_t dcpl_id, hid_t dapl_id, hid_t dxpl_id,
                                        void **req);

extern void *H5VL_adios2_dataset_open(void *obj, const H5VL_loc_params_t *loc_params,
                                      const char *name, hid_t dapl_id, hid_t dxpl_id, void **req);

extern herr_t H5VL_adios2_dataset_read(size_t count, void *dset[], hid_t mem_type_id[],
                                       hid_t mem_space_id[], hid_t file_space_id[], hid_t dxpl_id,
                                       void *buf[], void **req);

extern herr_t H5VL_adios2_dataset_get(void *dset, H5VL_dataset_get_args_t *args, hid_t dxpl_id,
                                      void **req);

extern herr_t H5VL_adios2_dataset_write(size_t count, void *dset[], hid_t mem_type_id[],
                                        hid_t mem_space_id[], hid_t file_space_id[], hid_t dxpl_id,
                                        const void *buf[], void **req);

extern herr_t H5VL_adios2_dataset_close(void *dset, hid_t dxpl_id, void **req);

//
// link functions:
//
extern herr_t H5VL_adios2_link_specific(void *obj, const H5VL_loc_params_t *loc_params,
                                        H5VL_link_specific_args_t *args,
                                        hid_t H5_ATTR_UNUSED dxpl_id, void H5_ATTR_UNUSED **req);

extern herr_t H5VL_adios2_link_get(void *obj, const H5VL_loc_params_t *loc_params,
                                   H5VL_link_get_args_t *args, hid_t H5_ATTR_UNUSED dxpl_id,
                                   void H5_ATTR_UNUSED **req);

//
// group functions:
//
extern void *H5VL_adios2_group_create(void *obj, const H5VL_loc_params_t *loc_params,
                                      const char *name, hid_t lcpl_id, hid_t gcpl_id, hid_t gapl_id,
                                      hid_t dxpl_id, void **req);

extern herr_t H5VL_adios2_group_close(void *obj, hid_t dxpl_id, void **req);

extern void *H5VL_adios2_group_open(void *obj, const H5VL_loc_params_t *loc_params,
                                    const char *name, hid_t gapl_id, hid_t dxpl_id, void **req);

extern herr_t H5VL_adios2_group_get(void *obj, H5VL_group_get_args_t *args,
                                    hid_t H5_ATTR_UNUSED dxpl_id, void H5_ATTR_UNUSED **req);

//
// general definitions:
//
extern void *gAttrToVolObj(H5VL_AttrDef_t *attr, H5VL_ObjDef_t *parent);

extern void *gFileToVolObj(H5VL_FileDef_t *f);

extern void *gGroupToVolObj(H5VL_GroupDef_t *group, H5VL_ObjDef_t *parent);

extern void *gVarToVolObj(H5VL_VarDef_t *var, H5VL_ObjDef_t *parent);

extern void gFreeVol(H5VL_ObjDef_t *vol);

extern adios2_attribute *gLocateAttrFrom(H5VL_ObjDef_t *owner, const char *name);
extern htri_t gExistsUnderGrp(H5VL_ObjDef_t *owner, const char *obj_name);
extern bool gRemoveUnderGrp(H5VL_ObjDef_t *owner, const char *obj_name);

extern void gLoadAttrDef(H5VL_AttrDef_t *attrDef);
extern void gLoadContent(H5VL_ObjDef_t *obj);
extern void gLoadSubGroups(H5VL_ObjDef_t *obj);

extern size_t gGetNameOfNthAttr(H5VL_ObjDef_t *obj, uint32_t idx, char *name);
extern size_t gGetNameOfNthItem(H5VL_ObjDef_t *obj, uint32_t idx, char *name);

extern H5VL_ObjDef_t *gGetVarObjDef(const char *fullPath, H5VL_ObjDef_t *vol);
extern H5VL_VarDef_t *gCreateVarDef(const char *name, adios2_engine *engine, adios2_variable *var,
                                    hid_t space_id, hid_t type_id);

extern H5VL_AttrDef_t *gCreateAttrDef(const char *name, hid_t type_id, hid_t space_id);
extern H5VL_GroupDef_t *gCreateGroupDef(const char *name);

extern void gGenerateFullPath(char *fullPath, const char *parentPath, const char *name);

/*
 */

extern void gInitADIOS2(hid_t acc_tpl);
extern void gExitADIOS2();

// extern adios2_attribute *gADIOS2CreateAttr(H5VL_AttrDef_t *input);
extern adios2_attribute *gADIOS2CreateAttr(adios2_io *io, H5VL_AttrDef_t *input,
                                           const char *fullPath);
extern adios2_attribute *gADIOS2InqAttr(adios2_io *io, const char *name);
extern bool gADIOS2RemoveAttr(adios2_io *io, const char *name);

extern H5VL_FileDef_t *gADIOS2CreateFile(const char *name);
extern H5VL_FileDef_t *gADIOS2OpenFile(const char *name);
extern void gADIOS2CloseFile(H5VL_FileDef_t *handle);

extern adios2_variable *gADIOS2CreateVar(adios2_io *io, H5VL_VarDef_t *var);
extern adios2_variable *gADIOS2DefineVar(adios2_io *io, H5VL_VarDef_t *varDef);
extern adios2_variable *gADIOS2InqVar(adios2_io *io, const char *name);
extern herr_t gADIOS2ReadVar(H5VL_VarDef_t *var);

#ifdef __cplusplus
}
#endif

#endif