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
|
/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
* Copyright by The HDF Group. *
* 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 COPYING file, which can be found at the root of the source code *
* distribution tree, or in https://www.hdfgroup.org/licenses. *
* If you do not have access to either file, you may request a copy from *
* help@hdfgroup.org. *
* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
/*
* Programmer: Robb Matzke
* Monday, August 2, 1999
*
* Purpose: The public header file for the "multi" driver.
*/
#ifndef H5FDmulti_H
#define H5FDmulti_H
#define H5FD_MULTI (H5FDperform_init(H5FD_multi_init))
#ifdef __cplusplus
extern "C" {
#endif
H5_DLL hid_t H5FD_multi_init(void);
/**
* \ingroup FAPL
*
* \brief Sets up use of the multi-file driver
*
* \fapl_id
* \param[in] memb_map Maps memory usage types to other memory usage types
* \param[in] memb_fapl Property list for each memory usage type
* \param[in] memb_name Name generator for names of member files
* \param[in] memb_addr The offsets within the virtual address space, from 0
* (zero) to #HADDR_MAX, at which each type of data storage begins
* \param[in] relax Allows read-only access to incomplete file sets when \c TRUE
* \returns \herr_t
*
* \details H5Pset_fapl_multi() sets the file access property list \p fapl_id to
* use the multi-file driver.
*
* The multi-file driver enables different types of HDF5 data and
* metadata to be written to separate files. These files are viewed by
* the HDF5 library and the application as a single virtual HDF5 file
* with a single HDF5 file address space. The types of data that can be
* broken out into separate files include raw data, the superblock,
* B-tree data, global heap data, local heap data, and object
* headers. At the programmer's discretion, two or more types of data
* can be written to the same file while other types of data are
* written to separate files.
*
* The array \p memb_map maps memory usage types to other memory usage
* types and is the mechanism that allows the caller to specify how
* many files are created. The array contains #H5FD_MEM_NTYPES entries,
* which are either the value #H5FD_MEM_DEFAULT or a memory usage
* type. The number of unique values determines the number of files
* that are opened.
*
* The array \p memb_fapl contains a property list for each memory
* usage type that will be associated with a file.
*
* The array \p memb_name should be a name generator (a
* \Code{printf}-style format with a \Code{%s} which will be replaced
* with the name passed to H5FDopen(), usually from H5Fcreate() or
* H5Fopen()).
*
* The array \p memb_addr specifies the offsets within the virtual
* address space, from 0 (zero) to #HADDR_MAX, at which each type of
* data storage begins.
*
* If \p relax is set to 1 (TRUE), then opening an existing file for
* read-only access will not fail if some file members are
* missing. This allows a file to be accessed in a limited sense if
* just the meta data is available.
*
* Default values for each of the optional arguments are as follows:
* <table>
* <tr>
* <td>\p memb_map</td>
* <td>The default member map contains the value #H5FD_MEM_DEFAULT for each element.</td>
* </tr>
* <tr>
* <td>
* \p memb_fapl
* </td>
* <td>
* The default value is #H5P_DEFAULT for each element.
* </td>
* </tr>
* <tr>
* <td>
* \p memb_name
* </td>
* <td>
* The default string is \Code{%s-X.h5} where \c X is one of the following letters:
* - \c s for #H5FD_MEM_SUPER
* - \c b for #H5FD_MEM_BTREE
* - \c r for #H5FD_MEM_DRAW
* - \c g for #H5FD_MEM_GHEAP
* - \c l for #H5FD_MEM_LHEAP
* - \c o for #H5FD_MEM_OHDR
* </td>
* </tr>
* <tr>
* <td>
* \p memb_addr
* </td>
* <td>
* The default setting is that the address space is equally divided
* among all of the elements:
* - #H5FD_MEM_SUPER \Code{-> 0 * (HADDR_MAX/6)}
* - #H5FD_MEM_BTREE \Code{-> 1 * (HADDR_MAX/6)}
* - #H5FD_MEM_DRAW \Code{-> 2 * (HADDR_MAX/6)}
* - #H5FD_MEM_GHEAP \Code{-> 3 * (HADDR_MAX/6)}
* - #H5FD_MEM_LHEAP \Code{-> 4 * (HADDR_MAX/6)}
* - #H5FD_MEM_OHDR \Code{-> 5 * (HADDR_MAX/6)}
* </td>
* </tr>
* </table>
*
* \par Example:
* The following code sample sets up a multi-file access property list that
* partitions data into meta and raw files, each being one-half of the address:\n
* \code
* H5FD_mem_t mt, memb_map[H5FD_MEM_NTYPES];
* hid_t memb_fapl[H5FD_MEM_NTYPES];
* const char *memb[H5FD_MEM_NTYPES];
* haddr_t memb_addr[H5FD_MEM_NTYPES];
*
* // The mapping...
* for (mt=0; mt<H5FD_MEM_NTYPES; mt++) {
* memb_map[mt] = H5FD_MEM_SUPER;
* }
* memb_map[H5FD_MEM_DRAW] = H5FD_MEM_DRAW;
*
* // Member information
* memb_fapl[H5FD_MEM_SUPER] = H5P_DEFAULT;
* memb_name[H5FD_MEM_SUPER] = "%s.meta";
* memb_addr[H5FD_MEM_SUPER] = 0;
*
* memb_fapl[H5FD_MEM_DRAW] = H5P_DEFAULT;
* memb_name[H5FD_MEM_DRAW] = "%s.raw";
* memb_addr[H5FD_MEM_DRAW] = HADDR_MAX/2;
*
* hid_t fapl = H5Pcreate(H5P_FILE_ACCESS);
* H5Pset_fapl_multi(fapl, memb_map, memb_fapl,
* memb_name, memb_addr, TRUE);
* \endcode
*
* \version 1.6.3 \p memb_name parameter type changed to \Code{const char* const*}.
* \since 1.4.0
*/
H5_DLL herr_t H5Pset_fapl_multi(hid_t fapl_id, const H5FD_mem_t *memb_map, const hid_t *memb_fapl,
const char *const *memb_name, const haddr_t *memb_addr, hbool_t relax);
/**
* \ingroup FAPL
*
* \brief Returns information about the multi-file access property list
*
* \fapl_id
* \param[out] memb_map Maps memory usage types to other memory usage types
* \param[out] memb_fapl Property list for each memory usage type
* \param[out] memb_name Name generator for names of member files
* \param[out] memb_addr The offsets within the virtual address space, from 0
* (zero) to #HADDR_MAX, at which each type of data storage begins
* \param[out] relax Allows read-only access to incomplete file sets when \c TRUE
* \returns \herr_t
*
* \details H5Pget_fapl_multi() returns information about the multi-file access
* property list.
*
* \since 1.4.0
*
*/
H5_DLL herr_t H5Pget_fapl_multi(hid_t fapl_id, H5FD_mem_t *memb_map /*out*/, hid_t *memb_fapl /*out*/,
char **memb_name /*out*/, haddr_t *memb_addr /*out*/, hbool_t *relax /*out*/);
/**
* \ingroup FAPL
*
* \brief Emulates the old split file driver
*
* \fapl_id{fapl}
* \param[in] meta_ext Metadata filename extension
* \param[in] meta_plist_id File access property list identifier for the metadata file
* \param[in] raw_ext Raw data filename extension
* \param[in] raw_plist_id
* \returns \herr_t
*
* \details H5Pset_fapl_split() is a compatibility function that enables the
* multi-file driver to emulate the split driver from HDF5 Releases 1.0
* and 1.2. The split file driver stored metadata and raw data in
* separate files but provided no mechanism for separating types of
* metadata.
*
* \p fapl is a file access property list identifier.
*
* \p meta_ext is the filename extension for the metadata file. The
* extension is appended to the name passed to H5FDopen(), usually from
* H5Fcreate() or H5Fopen(), to form the name of the metadata file. If
* the string \Code{%s} is used in the extension, it works like the
* name generator as in H5Pset_fapl_multi().
*
* \p meta_plist_id is the file access property list identifier for the
* metadata file.
*
* \p raw_ext is the filename extension for the raw data file. The
* extension is appended to the name passed to H5FDopen(), usually from
* H5Fcreate() or H5Fopen(), to form the name of the raw data file. If
* the string \Code{%s} is used in the extension, it works like the
* name generator as in H5Pset_fapl_multi().
*
* \p raw_plist_id is the file access property list identifier for the
* raw data file.
*
* If a user wishes to check to see whether this driver is in use, the
* user must call H5Pget_driver() and compare the returned value to the
* string #H5FD_MULTI. A positive match will confirm that the multi
* driver is in use; HDF5 provides no mechanism to determine whether it
* was called as the special case invoked by H5Pset_fapl_split().
*
* \par Example:
* \code
* // Example 1: Both metadata and raw data files are in the same
* // directory. Use Station1-m.h5 and Station1-r.h5 as
* // the metadata and raw data files.
* hid_t fapl, fid;
* fapl = H5Pcreate(H5P_FILE_ACCESS);
* H5Pset_fapl_split(fapl, "-m.h5", H5P_DEFAULT, "-r.h5", H5P_DEFAULT);
* fid=H5Fcreate("Station1",H5F_ACC_TRUNC,H5P_DEFAULT,fapl);
*
* // Example 2: metadata and raw data files are in different
* // directories. Use PointA-m.h5 and /pfs/PointA-r.h5 as
* // the metadata and raw data files.
* hid_t fapl, fid;
* fapl = H5Pcreate(H5P_FILE_ACCESS);
* H5Pset_fapl_split(fapl, "-m.h5", H5P_DEFAULT, "/pfs/%s-r.h5", H5P_DEFAULT);
* fid=H5Fcreate("PointA",H5F_ACC_TRUNC,H5P_DEFAULT,fapl);
* \endcode
*
* \since 1.4.0
*
*/
H5_DLL herr_t H5Pset_fapl_split(hid_t fapl, const char *meta_ext, hid_t meta_plist_id, const char *raw_ext,
hid_t raw_plist_id);
#ifdef __cplusplus
}
#endif
#endif
|
