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
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
|
/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
* 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. *
* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
/*-------------------------------------------------------------------------
*
* Purpose: Deprecated functions from the H5L interface. These
* functions are here for compatibility purposes and may be
* removed in the future. Applications should switch to the
* newer APIs.
*
*-------------------------------------------------------------------------
*/
/****************/
/* Module Setup */
/****************/
#include "H5Lmodule.h" /* This source code file is part of the H5L module */
/***********/
/* Headers */
/***********/
#include "H5private.h" /* Generic Functions */
#include "H5CXprivate.h" /* API Contexts */
#include "H5Eprivate.h" /* Error handling */
#include "H5Iprivate.h" /* IDs */
#include "H5Lpkg.h" /* Links */
#include "H5VLnative_private.h"
#ifndef H5_NO_DEPRECATED_SYMBOLS
/****************/
/* Local Macros */
/****************/
/******************/
/* Local Typedefs */
/******************/
/* Shim data for using native H5Literate/visit callbacks with the VOL */
typedef struct H5L_shim_data_t {
H5L_iterate1_t real_op;
void *real_op_data;
} H5L_shim_data_t;
/********************/
/* Package Typedefs */
/********************/
/********************/
/* Local Prototypes */
/********************/
/*********************/
/* Package Variables */
/*********************/
/*****************************/
/* Library Private Variables */
/*****************************/
/*******************/
/* Local Variables */
/*******************/
/*-------------------------------------------------------------------------
* Function: H5L__iterate2_shim
*
* Purpose: Shim function for translating between H5L_info2_t and
* H5L_info1_t structures, as used by H5Literate2/H5Lvisit2
* and H5Literate1/H5Lvisit1, respectively.
*
* Return: Success: H5_ITER_CONT or H5_ITER_STOP
* Failure: H5_ITER_ERROR
*
*-------------------------------------------------------------------------
*/
static herr_t
H5L__iterate2_shim(hid_t group_id, const char *name, const H5L_info2_t *linfo2, void *op_data)
{
H5L_shim_data_t *shim_data = (H5L_shim_data_t *)op_data;
H5L_info1_t linfo;
herr_t ret_value = H5_ITER_CONT;
FUNC_ENTER_PACKAGE
/* Copy the new-style members into the old-style struct */
if (linfo2) {
linfo.type = linfo2->type;
linfo.corder_valid = linfo2->corder_valid;
linfo.corder = linfo2->corder;
linfo.cset = linfo2->cset;
if (H5L_TYPE_HARD == linfo2->type) {
if (H5VLnative_token_to_addr(group_id, linfo2->u.token, &linfo.u.address) < 0)
HGOTO_ERROR(H5E_LINK, H5E_CANTUNSERIALIZE, H5_ITER_ERROR,
"can't deserialize object token into address")
}
else
linfo.u.val_size = linfo2->u.val_size;
}
/* Invoke the real callback */
ret_value = shim_data->real_op(group_id, name, &linfo, shim_data->real_op_data);
done:
FUNC_LEAVE_NOAPI(ret_value)
} /* end H5L__iterate2_shim() */
/*-------------------------------------------------------------------------
* Function: H5Literate1
*
* Purpose: Iterates over links in a group, with user callback routine,
* according to the order within an index.
*
* Same pattern of behavior as H5Giterate.
*
* Note: Deprecated in favor of H5Literate2
*
* Return: Success: The return value of the first operator that
* returns non-zero, or zero if all members were
* processed with no operator returning non-zero.
*
* Failure: Negative if something goes wrong within the
* library, or the negative value returned by one
* of the operators.
*
*-------------------------------------------------------------------------
*/
herr_t
H5Literate1(hid_t group_id, H5_index_t idx_type, H5_iter_order_t order, hsize_t *idx_p, H5L_iterate1_t op,
void *op_data)
{
H5VL_object_t *vol_obj = NULL; /* Object of loc_id */
H5VL_link_specific_args_t vol_cb_args; /* Arguments to VOL callback */
H5VL_loc_params_t loc_params;
H5I_type_t id_type; /* Type of ID */
H5L_shim_data_t shim_data;
hbool_t is_native_vol_obj;
herr_t ret_value; /* Return value */
FUNC_ENTER_API(FAIL)
H5TRACE6("e", "iIiIo*hLi*x", group_id, idx_type, order, idx_p, op, op_data);
/* Check arguments */
id_type = H5I_get_type(group_id);
if (!(H5I_GROUP == id_type || H5I_FILE == id_type))
HGOTO_ERROR(H5E_ARGS, H5E_BADVALUE, FAIL, "invalid argument")
if (idx_type <= H5_INDEX_UNKNOWN || idx_type >= H5_INDEX_N)
HGOTO_ERROR(H5E_ARGS, H5E_BADVALUE, FAIL, "invalid index type specified")
if (order <= H5_ITER_UNKNOWN || order >= H5_ITER_N)
HGOTO_ERROR(H5E_ARGS, H5E_BADVALUE, FAIL, "invalid iteration order specified")
if (!op)
HGOTO_ERROR(H5E_ARGS, H5E_BADVALUE, FAIL, "no operator specified")
/* Get the location object */
if (NULL == (vol_obj = (H5VL_object_t *)H5I_object(group_id)))
HGOTO_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL, "invalid location identifier")
/* Check if the VOL object is a native VOL connector object */
if (H5VL_object_is_native(vol_obj, &is_native_vol_obj) < 0)
HGOTO_ERROR(H5E_LINK, H5E_CANTGET, FAIL, "can't determine if VOL object is native connector object")
if (!is_native_vol_obj)
HGOTO_ERROR(H5E_LINK, H5E_BADVALUE, FAIL,
"H5Literate1 is only meant to be used with the native VOL connector")
/* Set location struct fields */
loc_params.type = H5VL_OBJECT_BY_SELF;
loc_params.obj_type = H5I_get_type(group_id);
/* Set up shim */
shim_data.real_op = op;
shim_data.real_op_data = op_data;
/* Set up VOL callback arguments */
vol_cb_args.op_type = H5VL_LINK_ITER;
vol_cb_args.args.iterate.recursive = FALSE;
vol_cb_args.args.iterate.idx_type = idx_type;
vol_cb_args.args.iterate.order = order;
vol_cb_args.args.iterate.idx_p = idx_p;
vol_cb_args.args.iterate.op = H5L__iterate2_shim;
vol_cb_args.args.iterate.op_data = &shim_data;
/* Iterate over the links */
if ((ret_value = H5VL_link_specific(vol_obj, &loc_params, &vol_cb_args, H5P_DATASET_XFER_DEFAULT,
H5_REQUEST_NULL)) < 0)
HGOTO_ERROR(H5E_LINK, H5E_BADITER, FAIL, "link iteration failed")
done:
FUNC_LEAVE_API(ret_value)
} /* end H5Literate1() */
/*-------------------------------------------------------------------------
* Function: H5Literate_by_name1
*
* Purpose: Iterates over links in a group, with user callback routine,
* according to the order within an index.
*
* Same pattern of behavior as H5Giterate.
*
* Note: Deprecated in favor of H5Literate_by_name2
*
* Return: Success: The return value of the first operator that
* returns non-zero, or zero if all members were
* processed with no operator returning non-zero.
*
* Failure: Negative if something goes wrong within the
* library, or the negative value returned by one
* of the operators.
*
*-------------------------------------------------------------------------
*/
herr_t
H5Literate_by_name1(hid_t loc_id, const char *group_name, H5_index_t idx_type, H5_iter_order_t order,
hsize_t *idx_p, H5L_iterate1_t op, void *op_data, hid_t lapl_id)
{
H5VL_object_t *vol_obj = NULL; /* Object of loc_id */
H5VL_link_specific_args_t vol_cb_args; /* Arguments to VOL callback */
H5VL_loc_params_t loc_params;
H5L_shim_data_t shim_data;
hbool_t is_native_vol_obj;
herr_t ret_value; /* Return value */
FUNC_ENTER_API(FAIL)
H5TRACE8("e", "i*sIiIo*hLi*xi", loc_id, group_name, idx_type, order, idx_p, op, op_data, lapl_id);
/* Check arguments */
if (!group_name)
HGOTO_ERROR(H5E_ARGS, H5E_BADVALUE, FAIL, "group_name parameter cannot be NULL")
if (!*group_name)
HGOTO_ERROR(H5E_ARGS, H5E_BADVALUE, FAIL, "group_name parameter cannot be an empty string")
if (idx_type <= H5_INDEX_UNKNOWN || idx_type >= H5_INDEX_N)
HGOTO_ERROR(H5E_ARGS, H5E_BADVALUE, FAIL, "invalid index type specified")
if (order <= H5_ITER_UNKNOWN || order >= H5_ITER_N)
HGOTO_ERROR(H5E_ARGS, H5E_BADVALUE, FAIL, "invalid iteration order specified")
if (!op)
HGOTO_ERROR(H5E_ARGS, H5E_BADVALUE, FAIL, "no operator specified")
/* Verify access property list and set up collective metadata if appropriate */
if (H5CX_set_apl(&lapl_id, H5P_CLS_LACC, loc_id, FALSE) < 0)
HGOTO_ERROR(H5E_LINK, H5E_CANTSET, FAIL, "can't set access property list info")
/* Get the location object */
if (NULL == (vol_obj = (H5VL_object_t *)H5I_object(loc_id)))
HGOTO_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL, "invalid location identifier")
/* Check if the VOL object is a native VOL connector object */
if (H5VL_object_is_native(vol_obj, &is_native_vol_obj) < 0)
HGOTO_ERROR(H5E_LINK, H5E_CANTGET, FAIL, "can't determine if VOL object is native connector object")
if (!is_native_vol_obj)
HGOTO_ERROR(H5E_LINK, H5E_BADVALUE, FAIL,
"H5Literate_by_name1 is only meant to be used with the native VOL connector")
/* Set location struct fields */
loc_params.type = H5VL_OBJECT_BY_NAME;
loc_params.obj_type = H5I_get_type(loc_id);
loc_params.loc_data.loc_by_name.name = group_name;
loc_params.loc_data.loc_by_name.lapl_id = lapl_id;
/* Set up shim */
shim_data.real_op = op;
shim_data.real_op_data = op_data;
/* Set up VOL callback arguments */
vol_cb_args.op_type = H5VL_LINK_ITER;
vol_cb_args.args.iterate.recursive = FALSE;
vol_cb_args.args.iterate.idx_type = idx_type;
vol_cb_args.args.iterate.order = order;
vol_cb_args.args.iterate.idx_p = idx_p;
vol_cb_args.args.iterate.op = H5L__iterate2_shim;
vol_cb_args.args.iterate.op_data = &shim_data;
/* Iterate over the links */
if ((ret_value = H5VL_link_specific(vol_obj, &loc_params, &vol_cb_args, H5P_DATASET_XFER_DEFAULT,
H5_REQUEST_NULL)) < 0)
HGOTO_ERROR(H5E_LINK, H5E_BADITER, FAIL, "link iteration failed")
done:
FUNC_LEAVE_API(ret_value)
} /* end H5Literate_by_name1() */
/*-------------------------------------------------------------------------
* Function: H5Lget_info1
*
* Purpose: Gets metadata for a link.
*
* Note: Deprecated in favor of H5Lget_info2
*
* Return: Success: Non-negative with information in LINFO
* Failure: Negative
*
*-------------------------------------------------------------------------
*/
herr_t
H5Lget_info1(hid_t loc_id, const char *name, H5L_info1_t *linfo /*out*/, hid_t lapl_id)
{
H5VL_object_t *vol_obj = NULL; /* object of loc_id */
H5VL_link_get_args_t vol_cb_args; /* Arguments to VOL callback */
H5VL_loc_params_t loc_params;
H5L_info2_t linfo2; /* New-style link info */
hbool_t is_native_vol_obj;
herr_t ret_value = SUCCEED; /* Return value */
FUNC_ENTER_API(FAIL)
H5TRACE4("e", "i*sxi", loc_id, name, linfo, lapl_id);
/* Check arguments */
if (!name || !*name)
HGOTO_ERROR(H5E_ARGS, H5E_BADVALUE, FAIL, "no name specified")
/* Verify access property list and set up collective metadata if appropriate */
if (H5CX_set_apl(&lapl_id, H5P_CLS_LACC, loc_id, TRUE) < 0)
HGOTO_ERROR(H5E_LINK, H5E_CANTSET, FAIL, "can't set access property list info")
/* Set up location struct */
loc_params.type = H5VL_OBJECT_BY_NAME;
loc_params.obj_type = H5I_get_type(loc_id);
loc_params.loc_data.loc_by_name.name = name;
loc_params.loc_data.loc_by_name.lapl_id = lapl_id;
/* Get the location object */
if (NULL == (vol_obj = (H5VL_object_t *)H5I_object(loc_id)))
HGOTO_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL, "invalid location identifier")
/* Check if the VOL object is a native VOL connector object */
if (H5VL_object_is_native(vol_obj, &is_native_vol_obj) < 0)
HGOTO_ERROR(H5E_LINK, H5E_CANTGET, FAIL, "can't determine if VOL object is native connector object")
if (!is_native_vol_obj)
HGOTO_ERROR(H5E_LINK, H5E_BADVALUE, FAIL,
"H5Lget_info1 is only meant to be used with the native VOL connector")
/* Set up VOL callback arguments */
vol_cb_args.op_type = H5VL_LINK_GET_INFO;
vol_cb_args.args.get_info.linfo = &linfo2;
/* Get the link information */
if (H5VL_link_get(vol_obj, &loc_params, &vol_cb_args, H5P_DATASET_XFER_DEFAULT, H5_REQUEST_NULL) < 0)
HGOTO_ERROR(H5E_LINK, H5E_CANTGET, FAIL, "unable to get link info")
/* Copy the new-style members into the old-style struct */
if (linfo) {
linfo->type = linfo2.type;
linfo->corder_valid = linfo2.corder_valid;
linfo->corder = linfo2.corder;
linfo->cset = linfo2.cset;
if (H5L_TYPE_HARD == linfo2.type) {
void *vol_obj_data;
if (NULL == (vol_obj_data = H5VL_object_data(vol_obj)))
HGOTO_ERROR(H5E_LINK, H5E_CANTGET, FAIL, "can't get underlying VOL object")
if (H5VL_native_token_to_addr(vol_obj_data, loc_params.obj_type, linfo2.u.token,
&linfo->u.address) < 0)
HGOTO_ERROR(H5E_LINK, H5E_CANTUNSERIALIZE, FAIL,
"can't deserialize object token into address")
} /* end if */
else
linfo->u.val_size = linfo2.u.val_size;
} /* end if */
done:
FUNC_LEAVE_API(ret_value)
} /* end H5Lget_info1() */
/*-------------------------------------------------------------------------
* Function: H5Lget_info_by_idx1
*
* Purpose: Gets metadata for a link, according to the order within an
* index.
*
* Note: Deprecated in favor of H5Lget_info_by_idx2
*
* Return: Success: Non-negative with information in LINFO
* Failure: Negative
*
*-------------------------------------------------------------------------
*/
herr_t
H5Lget_info_by_idx1(hid_t loc_id, const char *group_name, H5_index_t idx_type, H5_iter_order_t order,
hsize_t n, H5L_info1_t *linfo /*out*/, hid_t lapl_id)
{
H5VL_object_t *vol_obj = NULL; /* object of loc_id */
H5VL_link_get_args_t vol_cb_args; /* Arguments to VOL callback */
H5VL_loc_params_t loc_params;
H5L_info2_t linfo2; /* New-style link info */
hbool_t is_native_vol_obj;
herr_t ret_value = SUCCEED; /* Return value */
FUNC_ENTER_API(FAIL)
H5TRACE7("e", "i*sIiIohxi", loc_id, group_name, idx_type, order, n, linfo, lapl_id);
/* Check arguments */
if (!group_name || !*group_name)
HGOTO_ERROR(H5E_ARGS, H5E_BADVALUE, FAIL, "no name specified")
if (idx_type <= H5_INDEX_UNKNOWN || idx_type >= H5_INDEX_N)
HGOTO_ERROR(H5E_ARGS, H5E_BADVALUE, FAIL, "invalid index type specified")
if (order <= H5_ITER_UNKNOWN || order >= H5_ITER_N)
HGOTO_ERROR(H5E_ARGS, H5E_BADVALUE, FAIL, "invalid iteration order specified")
/* Verify access property list and set up collective metadata if appropriate */
if (H5CX_set_apl(&lapl_id, H5P_CLS_LACC, loc_id, FALSE) < 0)
HGOTO_ERROR(H5E_LINK, H5E_CANTSET, FAIL, "can't set access property list info")
/* Set up location struct */
loc_params.type = H5VL_OBJECT_BY_IDX;
loc_params.loc_data.loc_by_idx.name = group_name;
loc_params.loc_data.loc_by_idx.idx_type = idx_type;
loc_params.loc_data.loc_by_idx.order = order;
loc_params.loc_data.loc_by_idx.n = n;
loc_params.loc_data.loc_by_idx.lapl_id = lapl_id;
loc_params.obj_type = H5I_get_type(loc_id);
/* Get the location object */
if (NULL == (vol_obj = (H5VL_object_t *)H5I_object(loc_id)))
HGOTO_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL, "invalid location identifier")
/* Check if the VOL object is a native VOL connector object */
if (H5VL_object_is_native(vol_obj, &is_native_vol_obj) < 0)
HGOTO_ERROR(H5E_LINK, H5E_CANTGET, FAIL, "can't determine if VOL object is native connector object")
if (!is_native_vol_obj)
HGOTO_ERROR(H5E_LINK, H5E_BADVALUE, FAIL,
"H5Lget_info_by_idx1 is only meant to be used with the native VOL connector")
/* Set up VOL callback arguments */
vol_cb_args.op_type = H5VL_LINK_GET_INFO;
vol_cb_args.args.get_info.linfo = &linfo2;
/* Get the link information */
if (H5VL_link_get(vol_obj, &loc_params, &vol_cb_args, H5P_DATASET_XFER_DEFAULT, H5_REQUEST_NULL) < 0)
HGOTO_ERROR(H5E_LINK, H5E_CANTGET, FAIL, "unable to get link info")
/* Copy the new-style members into the old-style struct */
if (linfo) {
linfo->type = linfo2.type;
linfo->corder_valid = linfo2.corder_valid;
linfo->corder = linfo2.corder;
linfo->cset = linfo2.cset;
if (H5L_TYPE_HARD == linfo2.type) {
void *vol_obj_data;
if (NULL == (vol_obj_data = H5VL_object_data(vol_obj)))
HGOTO_ERROR(H5E_LINK, H5E_CANTGET, FAIL, "can't get underlying VOL object")
if (H5VL_native_token_to_addr(vol_obj_data, loc_params.obj_type, linfo2.u.token,
&linfo->u.address) < 0)
HGOTO_ERROR(H5E_LINK, H5E_CANTUNSERIALIZE, FAIL,
"can't deserialize object token into address")
} /* end if */
else
linfo->u.val_size = linfo2.u.val_size;
} /* end if */
done:
FUNC_LEAVE_API(ret_value)
} /* end H5Lget_info_by_idx1() */
/*-------------------------------------------------------------------------
* Function: H5Lvisit1
*
* Purpose: Recursively visit all the links in a group and all
* the groups that are linked to from that group. Links within
* each group are visited according to the order within the
* specified index (unless the specified index does not exist for
* a particular group, then the "name" index is used).
*
* NOTE: Each _link_ reachable from the initial group will only be
* visited once. However, because an object may be reached from
* more than one link, the visitation may call the application's
* callback with more than one link that points to a particular
* _object_.
*
* Note: Deprecated in favor of H5Lvisit2
*
* Return: Success: The return value of the first operator that
* returns non-zero, or zero if all members were
* processed with no operator returning non-zero.
*
* Failure: Negative if something goes wrong within the
* library, or the negative value returned by one
* of the operators.
*
*-------------------------------------------------------------------------
*/
herr_t
H5Lvisit1(hid_t group_id, H5_index_t idx_type, H5_iter_order_t order, H5L_iterate1_t op, void *op_data)
{
H5VL_object_t *vol_obj = NULL; /* Object of loc_id */
H5VL_link_specific_args_t vol_cb_args; /* Arguments to VOL callback */
H5VL_loc_params_t loc_params;
H5I_type_t id_type; /* Type of ID */
H5L_shim_data_t shim_data;
hbool_t is_native_vol_obj;
herr_t ret_value; /* Return value */
FUNC_ENTER_API(FAIL)
H5TRACE5("e", "iIiIoLi*x", group_id, idx_type, order, op, op_data);
/* Check args */
id_type = H5I_get_type(group_id);
if (!(H5I_GROUP == id_type || H5I_FILE == id_type))
HGOTO_ERROR(H5E_ARGS, H5E_BADVALUE, FAIL, "invalid argument")
if (idx_type <= H5_INDEX_UNKNOWN || idx_type >= H5_INDEX_N)
HGOTO_ERROR(H5E_ARGS, H5E_BADVALUE, FAIL, "invalid index type specified")
if (order <= H5_ITER_UNKNOWN || order >= H5_ITER_N)
HGOTO_ERROR(H5E_ARGS, H5E_BADVALUE, FAIL, "invalid iteration order specified")
if (!op)
HGOTO_ERROR(H5E_ARGS, H5E_BADVALUE, FAIL, "no callback operator specified")
/* Set location struct fields */
loc_params.type = H5VL_OBJECT_BY_SELF;
loc_params.obj_type = H5I_get_type(group_id);
/* Get the location object */
if (NULL == (vol_obj = (H5VL_object_t *)H5I_object(group_id)))
HGOTO_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL, "invalid location identifier")
/* Check if the VOL object is a native VOL connector object */
if (H5VL_object_is_native(vol_obj, &is_native_vol_obj) < 0)
HGOTO_ERROR(H5E_LINK, H5E_CANTGET, FAIL, "can't determine if VOL object is native connector object")
if (!is_native_vol_obj)
HGOTO_ERROR(H5E_LINK, H5E_BADVALUE, FAIL,
"H5Lvisit1 is only meant to be used with the native VOL connector")
/* Set up shim */
shim_data.real_op = op;
shim_data.real_op_data = op_data;
/* Set up VOL callback arguments */
vol_cb_args.op_type = H5VL_LINK_ITER;
vol_cb_args.args.iterate.recursive = TRUE;
vol_cb_args.args.iterate.idx_type = idx_type;
vol_cb_args.args.iterate.order = order;
vol_cb_args.args.iterate.idx_p = NULL;
vol_cb_args.args.iterate.op = H5L__iterate2_shim;
vol_cb_args.args.iterate.op_data = &shim_data;
/* Iterate over the links */
if ((ret_value = H5VL_link_specific(vol_obj, &loc_params, &vol_cb_args, H5P_DATASET_XFER_DEFAULT,
H5_REQUEST_NULL)) < 0)
HGOTO_ERROR(H5E_LINK, H5E_BADITER, FAIL, "link visitation failed")
done:
FUNC_LEAVE_API(ret_value)
} /* end H5Lvisit1() */
/*-------------------------------------------------------------------------
* Function: H5Lvisit_by_name1
*
* Purpose: Recursively visit all the links in a group and all
* the groups that are linked to from that group. Links within
* each group are visited according to the order within the
* specified index (unless the specified index does not exist for
* a particular group, then the "name" index is used).
*
* NOTE: Each _link_ reachable from the initial group will only be
* visited once. However, because an object may be reached from
* more than one link, the visitation may call the application's
* callback with more than one link that points to a particular
* _object_.
*
* Note: Deprecated in favor of H5Lvisit_by_name2
*
* Return: Success: The return value of the first operator that
* returns non-zero, or zero if all members were
* processed with no operator returning non-zero.
*
* Failure: Negative if something goes wrong within the
* library, or the negative value returned by one
* of the operators.
*
*-------------------------------------------------------------------------
*/
herr_t
H5Lvisit_by_name1(hid_t loc_id, const char *group_name, H5_index_t idx_type, H5_iter_order_t order,
H5L_iterate1_t op, void *op_data, hid_t lapl_id)
{
H5VL_object_t *vol_obj = NULL; /* Object of loc_id */
H5VL_link_specific_args_t vol_cb_args; /* Arguments to VOL callback */
H5VL_loc_params_t loc_params;
H5L_shim_data_t shim_data;
hbool_t is_native_vol_obj;
herr_t ret_value; /* Return value */
FUNC_ENTER_API(FAIL)
H5TRACE7("e", "i*sIiIoLi*xi", loc_id, group_name, idx_type, order, op, op_data, lapl_id);
/* Check args */
if (!group_name)
HGOTO_ERROR(H5E_ARGS, H5E_BADVALUE, FAIL, "group_name parameter cannot be NULL")
if (!*group_name)
HGOTO_ERROR(H5E_ARGS, H5E_BADVALUE, FAIL, "group_name parameter cannot be an empty string")
if (idx_type <= H5_INDEX_UNKNOWN || idx_type >= H5_INDEX_N)
HGOTO_ERROR(H5E_ARGS, H5E_BADVALUE, FAIL, "invalid index type specified")
if (order <= H5_ITER_UNKNOWN || order >= H5_ITER_N)
HGOTO_ERROR(H5E_ARGS, H5E_BADVALUE, FAIL, "invalid iteration order specified")
if (!op)
HGOTO_ERROR(H5E_ARGS, H5E_BADVALUE, FAIL, "no callback operator specified")
/* Verify access property list and set up collective metadata if appropriate */
if (H5CX_set_apl(&lapl_id, H5P_CLS_LACC, loc_id, FALSE) < 0)
HGOTO_ERROR(H5E_LINK, H5E_CANTSET, FAIL, "can't set access property list info")
/* get the location object */
if (NULL == (vol_obj = (H5VL_object_t *)H5I_object(loc_id)))
HGOTO_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL, "invalid location identifier")
/* Check if the VOL object is a native VOL connector object */
if (H5VL_object_is_native(vol_obj, &is_native_vol_obj) < 0)
HGOTO_ERROR(H5E_LINK, H5E_CANTGET, FAIL, "can't determine if VOL object is native connector object")
if (!is_native_vol_obj)
HGOTO_ERROR(H5E_LINK, H5E_BADVALUE, FAIL,
"H5Lvisit_by_name1 is only meant to be used with the native VOL connector")
/* Set location struct fields */
loc_params.type = H5VL_OBJECT_BY_NAME;
loc_params.obj_type = H5I_get_type(loc_id);
loc_params.loc_data.loc_by_name.name = group_name;
loc_params.loc_data.loc_by_name.lapl_id = lapl_id;
/* Set up shim */
shim_data.real_op = op;
shim_data.real_op_data = op_data;
/* Set up VOL callback arguments */
vol_cb_args.op_type = H5VL_LINK_ITER;
vol_cb_args.args.iterate.recursive = TRUE;
vol_cb_args.args.iterate.idx_type = idx_type;
vol_cb_args.args.iterate.order = order;
vol_cb_args.args.iterate.idx_p = NULL;
vol_cb_args.args.iterate.op = H5L__iterate2_shim;
vol_cb_args.args.iterate.op_data = &shim_data;
/* Visit the links */
if ((ret_value = H5VL_link_specific(vol_obj, &loc_params, &vol_cb_args, H5P_DATASET_XFER_DEFAULT,
H5_REQUEST_NULL)) < 0)
HGOTO_ERROR(H5E_LINK, H5E_BADITER, FAIL, "link visitation failed")
done:
FUNC_LEAVE_API(ret_value)
} /* end H5Lvisit_by_name1() */
#endif /* H5_NO_DEPRECATED_SYMBOLS */
|
