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
|
/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
* 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://hdf.ncsa.uiuc.edu/HDF5/doc/Copyright.html. If you do not have *
* access to either file, you may request a copy from hdfhelp@ncsa.uiuc.edu. *
* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
#define H5P_PACKAGE /*suppress error about including H5Ppkg */
/* Private header files */
#include "H5private.h" /* Generic Functions */
#include "H5Eprivate.h" /* Error handling */
#include "H5Iprivate.h" /* IDs */
#include "H5Ppkg.h" /* Property lists */
/* Local datatypes */
/* Static function prototypes */
/*-------------------------------------------------------------------------
* Function: H5Pset_local_heap_size_hint
*
* Purpose: Set the "size hint" for creating local heaps for a group.
*
* Return: Non-negative on success/Negative on failure
*
* Programmer: Quincey Koziol
* August 29, 2005
*-------------------------------------------------------------------------
*/
herr_t
H5Pset_local_heap_size_hint(hid_t plist_id, size_t size_hint)
{
H5P_genplist_t *plist; /* Property list pointer */
H5O_ginfo_t ginfo; /* Group information structure */
herr_t ret_value = SUCCEED; /* Return value */
FUNC_ENTER_API(H5Pset_local_heap_size_hint, FAIL)
H5TRACE2("e","iz",plist_id,size_hint);
/* Get the plist structure */
if(NULL == (plist = H5P_object_verify(plist_id, H5P_GROUP_CREATE)))
HGOTO_ERROR(H5E_ATOM, H5E_BADATOM, FAIL, "can't find object for ID")
/* Get value */
if(H5P_get(plist, H5G_CRT_GROUP_INFO_NAME, &ginfo) < 0)
HGOTO_ERROR(H5E_PLIST, H5E_CANTGET, FAIL, "can't get group info")
/* Update field */
ginfo.lheap_size_hint = size_hint;
/* Set value */
if(H5P_set(plist, H5G_CRT_GROUP_INFO_NAME, &ginfo) < 0)
HGOTO_ERROR(H5E_PLIST, H5E_CANTSET, FAIL, "can't set group info")
done:
FUNC_LEAVE_API(ret_value)
} /* end H5Pset_local_heap_size_hint() */
/*-------------------------------------------------------------------------
* Function: H5Pget_local_heap_size_hint
*
* Purpose: Returns the local heap size hint, which is used for creating
* groups
*
* Return: Non-negative on success/Negative on failure
*
* Programmer: Quincey Koziol
* August 29, 2005
*-------------------------------------------------------------------------
*/
herr_t
H5Pget_local_heap_size_hint(hid_t plist_id, size_t *size_hint /*out*/)
{
herr_t ret_value = SUCCEED; /* return value */
FUNC_ENTER_API(H5Pget_local_heap_size_hint, FAIL)
H5TRACE2("e","ix",plist_id,size_hint);
if(size_hint) {
H5P_genplist_t *plist; /* Property list pointer */
H5O_ginfo_t ginfo; /* Group information structure */
/* Get the plist structure */
if(NULL == (plist = H5P_object_verify(plist_id, H5P_GROUP_CREATE)))
HGOTO_ERROR(H5E_ATOM, H5E_BADATOM, FAIL, "can't find object for ID")
/* Get value */
if(H5P_get(plist, H5G_CRT_GROUP_INFO_NAME, &ginfo) < 0)
HGOTO_ERROR(H5E_PLIST, H5E_CANTGET, FAIL, "can't get group info")
/* Update field */
*size_hint = ginfo.lheap_size_hint;
} /* end if */
done:
FUNC_LEAVE_API(ret_value)
} /* end H5Pget_local_heap_size_hint() */
/*-------------------------------------------------------------------------
* Function: H5Pset_link_phase_change
*
* Purpose: Set the maximum # of links to store "compactly" and the
* minimum # of links to store "densely". (These should
* overlap).
*
* Note: Currently both of these must be updated at the same time.
*
* Note: Come up with better name & description! -QAK
*
* Return: Non-negative on success/Negative on failure
*
* Programmer: Quincey Koziol
* August 29, 2005
*-------------------------------------------------------------------------
*/
herr_t
H5Pset_link_phase_change(hid_t plist_id, unsigned max_compact, unsigned min_dense)
{
H5P_genplist_t *plist; /* Property list pointer */
H5O_ginfo_t ginfo; /* Group information structure */
herr_t ret_value = SUCCEED; /* Return value */
FUNC_ENTER_API(H5Pset_link_phase_change, FAIL)
H5TRACE3("e","iIuIu",plist_id,max_compact,min_dense);
/* Get the plist structure */
if(NULL == (plist = H5P_object_verify(plist_id, H5P_GROUP_CREATE)))
HGOTO_ERROR(H5E_ATOM, H5E_BADATOM, FAIL, "can't find object for ID")
/* Get group info */
if(H5P_get(plist, H5G_CRT_GROUP_INFO_NAME, &ginfo) < 0)
HGOTO_ERROR(H5E_PLIST, H5E_CANTGET, FAIL, "can't get group info")
/* Update fields */
ginfo.max_compact = max_compact;
ginfo.min_dense = min_dense;
/* Set group info */
if(H5P_set(plist, H5G_CRT_GROUP_INFO_NAME, &ginfo) < 0)
HGOTO_ERROR(H5E_PLIST, H5E_CANTSET, FAIL, "can't set group info")
done:
FUNC_LEAVE_API(ret_value)
} /* end H5Pset_link_phase_change() */
/*-------------------------------------------------------------------------
* Function: H5Pget_link_phase_change
*
* Purpose: Returns the max. # of compact links & the min. # of dense
* links, which are used for storing groups
*
* Return: Non-negative on success/Negative on failure
*
* Programmer: Quincey Koziol
* August 29, 2005
*-------------------------------------------------------------------------
*/
herr_t
H5Pget_link_phase_change(hid_t plist_id, unsigned *max_compact /*out*/, unsigned *min_dense /*out*/)
{
herr_t ret_value = SUCCEED; /* return value */
FUNC_ENTER_API(H5Pget_link_phase_change, FAIL)
H5TRACE3("e","ixx",plist_id,max_compact,min_dense);
/* Get values */
if(max_compact || min_dense) {
H5P_genplist_t *plist; /* Property list pointer */
H5O_ginfo_t ginfo; /* Group information structure */
/* Get the plist structure */
if(NULL == (plist = H5P_object_verify(plist_id, H5P_GROUP_CREATE)))
HGOTO_ERROR(H5E_ATOM, H5E_BADATOM, FAIL, "can't find object for ID")
/* Get group info */
if(H5P_get(plist, H5G_CRT_GROUP_INFO_NAME, &ginfo) < 0)
HGOTO_ERROR(H5E_PLIST, H5E_CANTGET, FAIL, "can't get group info")
if(max_compact)
*max_compact = ginfo.max_compact;
if(min_dense)
*min_dense = ginfo.min_dense;
} /* end if */
done:
FUNC_LEAVE_API(ret_value)
} /* end H5Pget_link_phase_change() */
/*-------------------------------------------------------------------------
* Function: H5Pset_est_link_info
*
* Purpose: Set the estimates for the number of entries and length of each
* entry name in a group.
*
* Note: Currently both of these must be updated at the same time.
*
* Note: EST_NUM_ENTRIES applies only when the number of entries is less
* than the MAX_COMPACT # of entries (from H5Pset_link_phase_change).
*
* Note: Come up with better name & description? -QAK
*
* Return: Non-negative on success/Negative on failure
*
* Programmer: Quincey Koziol
* September 6, 2005
*-------------------------------------------------------------------------
*/
herr_t
H5Pset_est_link_info(hid_t plist_id, unsigned est_num_entries, unsigned est_name_len)
{
H5P_genplist_t *plist; /* Property list pointer */
H5O_ginfo_t ginfo; /* Group information structure */
herr_t ret_value = SUCCEED; /* Return value */
FUNC_ENTER_API(H5Pset_est_link_info, FAIL)
H5TRACE3("e","iIuIu",plist_id,est_num_entries,est_name_len);
/* Get the plist structure */
if(NULL == (plist = H5P_object_verify(plist_id, H5P_GROUP_CREATE)))
HGOTO_ERROR(H5E_ATOM, H5E_BADATOM, FAIL, "can't find object for ID")
/* Get group info */
if(H5P_get(plist, H5G_CRT_GROUP_INFO_NAME, &ginfo) < 0)
HGOTO_ERROR(H5E_PLIST, H5E_CANTGET, FAIL, "can't get group info")
/* Update fields */
ginfo.est_num_entries = est_num_entries;
ginfo.est_name_len = est_name_len;
/* Set group info */
if(H5P_set(plist, H5G_CRT_GROUP_INFO_NAME, &ginfo) < 0)
HGOTO_ERROR(H5E_PLIST, H5E_CANTSET, FAIL, "can't set group info")
done:
FUNC_LEAVE_API(ret_value)
} /* end H5Pset_est_link_info() */
/*-------------------------------------------------------------------------
* Function: H5Pget_est_link_info
*
* Purpose: Returns the est. # of links in a group & the est. length of
* the name of each link.
*
* Return: Non-negative on success/Negative on failure
*
* Programmer: Quincey Koziol
* September 6, 2005
*-------------------------------------------------------------------------
*/
herr_t
H5Pget_est_link_info(hid_t plist_id, unsigned *est_num_entries /*out*/, unsigned *est_name_len /*out*/)
{
herr_t ret_value = SUCCEED; /* return value */
FUNC_ENTER_API(H5Pget_est_link_info, FAIL)
H5TRACE3("e","ixx",plist_id,est_num_entries,est_name_len);
/* Get values */
if(est_num_entries || est_name_len) {
H5P_genplist_t *plist; /* Property list pointer */
H5O_ginfo_t ginfo; /* Group information structure */
/* Get the plist structure */
if(NULL == (plist = H5P_object_verify(plist_id, H5P_GROUP_CREATE)))
HGOTO_ERROR(H5E_ATOM, H5E_BADATOM, FAIL, "can't find object for ID")
/* Get group info */
if(H5P_get(plist, H5G_CRT_GROUP_INFO_NAME, &ginfo) < 0)
HGOTO_ERROR(H5E_PLIST, H5E_CANTGET, FAIL, "can't get group info")
if(est_num_entries)
*est_num_entries = ginfo.est_num_entries;
if(est_name_len)
*est_name_len = ginfo.est_name_len;
} /* end if */
done:
FUNC_LEAVE_API(ret_value)
} /* end H5Pget_est_link_info() */
/*-------------------------------------------------------------------------
* Function: H5Pset_creation_order_tracking
*
* Purpose: Set the flag to track creation order of links in a group
*
* Return: Non-negative on success/Negative on failure
*
* Programmer: Quincey Koziol
* September 12, 2006
*-------------------------------------------------------------------------
*/
herr_t
H5Pset_creation_order_tracking(hid_t plist_id, hbool_t track_corder)
{
H5P_genplist_t *plist; /* Property list pointer */
H5O_ginfo_t ginfo; /* Group information structure */
herr_t ret_value = SUCCEED; /* Return value */
FUNC_ENTER_API(H5Pset_creation_order_tracking, FAIL)
H5TRACE2("e","ib",plist_id,track_corder);
/* Get the plist structure */
if(NULL == (plist = H5P_object_verify(plist_id, H5P_GROUP_CREATE)))
HGOTO_ERROR(H5E_ATOM, H5E_BADATOM, FAIL, "can't find object for ID")
/* Get group info */
if(H5P_get(plist, H5G_CRT_GROUP_INFO_NAME, &ginfo) < 0)
HGOTO_ERROR(H5E_PLIST, H5E_CANTGET, FAIL, "can't get group info")
/* Update fields */
ginfo.track_corder = track_corder;
/* Set group info */
if(H5P_set(plist, H5G_CRT_GROUP_INFO_NAME, &ginfo) < 0)
HGOTO_ERROR(H5E_PLIST, H5E_CANTSET, FAIL, "can't set group info")
done:
FUNC_LEAVE_API(ret_value)
} /* end H5Pset_creation_order_tracking() */
/*-------------------------------------------------------------------------
* Function: H5Pget_creation_order_tracking
*
* Purpose: Returns the flag indicating that creation order is tracked
* for links in a group.
*
* Return: Non-negative on success/Negative on failure
*
* Programmer: Quincey Koziol
* September 12, 2006
*-------------------------------------------------------------------------
*/
herr_t
H5Pget_creation_order_tracking(hid_t plist_id, hbool_t *track_corder /*out*/)
{
herr_t ret_value = SUCCEED; /* return value */
FUNC_ENTER_API(H5Pget_creation_order_tracking, FAIL)
H5TRACE2("e","ix",plist_id,track_corder);
/* Get values */
if(track_corder) {
H5P_genplist_t *plist; /* Property list pointer */
H5O_ginfo_t ginfo; /* Group information structure */
/* Get the plist structure */
if(NULL == (plist = H5P_object_verify(plist_id, H5P_GROUP_CREATE)))
HGOTO_ERROR(H5E_ATOM, H5E_BADATOM, FAIL, "can't find object for ID")
/* Get group info */
if(H5P_get(plist, H5G_CRT_GROUP_INFO_NAME, &ginfo) < 0)
HGOTO_ERROR(H5E_PLIST, H5E_CANTGET, FAIL, "can't get group info")
*track_corder = ginfo.track_corder;
} /* end if */
done:
FUNC_LEAVE_API(ret_value)
} /* end H5Pget_creation_order_tracking() */
/*-------------------------------------------------------------------------
* Function: H5Pset_creation_order_index
*
* Purpose: Set the flag to index creation order of links in a group
*
* Return: Non-negative on success/Negative on failure
*
* Programmer: Quincey Koziol
* October 30, 2006
*-------------------------------------------------------------------------
*/
herr_t
H5Pset_creation_order_index(hid_t plist_id, hbool_t index_corder)
{
H5P_genplist_t *plist; /* Property list pointer */
H5O_linfo_t linfo; /* Link information structure */
herr_t ret_value = SUCCEED; /* Return value */
FUNC_ENTER_API(H5Pset_creation_order_index, FAIL)
H5TRACE2("e","ib",plist_id,index_corder);
/* Get the plist structure */
if(NULL == (plist = H5P_object_verify(plist_id, H5P_GROUP_CREATE)))
HGOTO_ERROR(H5E_ATOM, H5E_BADATOM, FAIL, "can't find object for ID")
/* Get link info */
if(H5P_get(plist, H5G_CRT_LINK_INFO_NAME, &linfo) < 0)
HGOTO_ERROR(H5E_PLIST, H5E_CANTGET, FAIL, "can't get link info")
/* Update fields */
linfo.index_corder = index_corder;
/* Set link info */
if(H5P_set(plist, H5G_CRT_LINK_INFO_NAME, &linfo) < 0)
HGOTO_ERROR(H5E_PLIST, H5E_CANTSET, FAIL, "can't set link info")
done:
FUNC_LEAVE_API(ret_value)
} /* end H5Pset_creation_order_index() */
/*-------------------------------------------------------------------------
* Function: H5Pget_creation_order_index
*
* Purpose: Returns the flag indicating that creation order is indexed
* for links in a group.
*
* Return: Non-negative on success/Negative on failure
*
* Programmer: Quincey Koziol
* October 30, 2006
*-------------------------------------------------------------------------
*/
herr_t
H5Pget_creation_order_index(hid_t plist_id, hbool_t *index_corder /*out*/)
{
herr_t ret_value = SUCCEED; /* return value */
FUNC_ENTER_API(H5Pget_creation_order_index, FAIL)
H5TRACE2("e","ix",plist_id,index_corder);
/* Get values */
if(index_corder) {
H5P_genplist_t *plist; /* Property list pointer */
H5O_linfo_t linfo; /* Link information structure */
/* Get the plist structure */
if(NULL == (plist = H5P_object_verify(plist_id, H5P_GROUP_CREATE)))
HGOTO_ERROR(H5E_ATOM, H5E_BADATOM, FAIL, "can't find object for ID")
/* Get link info */
if(H5P_get(plist, H5G_CRT_LINK_INFO_NAME, &linfo) < 0)
HGOTO_ERROR(H5E_PLIST, H5E_CANTGET, FAIL, "can't get link info")
*index_corder = linfo.index_corder;
} /* end if */
done:
FUNC_LEAVE_API(ret_value)
} /* end H5Pget_creation_order_index() */
|
