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
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
|
/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
* 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 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. *
* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
/*
* Purpose: Index routines.
*/
/****************/
/* Module Setup */
/****************/
#define H5X_PACKAGE /* Suppress error about including H5Xpkg */
/* Interface initialization */
#define H5_INTERFACE_INIT_FUNC H5X_init_interface
/***********/
/* Headers */
/***********/
#include "H5private.h" /* Generic Functions */
#include "H5Eprivate.h" /* Error handling */
#include "H5Iprivate.h" /* IDs */
#include "H5MMprivate.h" /* Memory management */
#include "H5Pprivate.h" /* Property lists */
#include "H5VLprivate.h" /* VOL plugins */
#include "H5ESprivate.h"
#include "H5FFprivate.h" /* FF */
#include "H5Xpkg.h" /* Index plugins */
#ifdef H5_HAVE_INDEXING
/****************/
/* Local Macros */
/****************/
/******************/
/* Local Typedefs */
/******************/
/********************/
/* Local Prototypes */
/********************/
/*********************/
/* Package Variables */
/*********************/
/*****************************/
/* Library Private Variables */
/*****************************/
/*******************/
/* Local Variables */
/*******************/
static size_t H5X_table_alloc_g = 0;
static size_t H5X_table_used_g = 0;
static H5X_class_t *H5X_table_g = NULL;
static H5_inline hbool_t
H5X__registered(unsigned plugin_id, size_t *index)
{
size_t plugin_index;
hbool_t registered = FALSE;
/* Is the filter already registered? */
for (plugin_index = 0; plugin_index < H5X_table_used_g; plugin_index++) {
if (H5X_table_g[plugin_index].id == plugin_id) {
registered = TRUE;
if (index) *index = plugin_index;
break;
}
}
return registered;
}
/*-------------------------------------------------------------------------
* Function: H5X_init
*
* Purpose: Initialize the interface from some other package.
*
* Return: Success: non-negative
* Failure: negative
*
*-------------------------------------------------------------------------
*/
herr_t
H5X_init(void)
{
herr_t ret_value = SUCCEED; /* Return value */
FUNC_ENTER_NOAPI(FAIL)
/* FUNC_ENTER() does all the work */
done:
FUNC_LEAVE_NOAPI(ret_value)
} /* end H5X_init() */
/*--------------------------------------------------------------------------
NAME
H5X_init_interface -- Initialize interface-specific information
USAGE
herr_t H5X_init_interface()
RETURNS
Non-negative on success/Negative on failure
DESCRIPTION
Initializes any interface-specific data or routines.
--------------------------------------------------------------------------*/
static herr_t
H5X_init_interface(void)
{
herr_t ret_value = SUCCEED; /* Return value */
FUNC_ENTER_NOAPI_NOINIT
//#ifdef H5_HAVE_INDEX_PLUGIN_DUMMY
if (H5X_register(H5X_DUMMY) < 0)
HGOTO_ERROR (H5E_PLINE, H5E_CANTINIT, FAIL, "unable to register dummy index plugin")
//#endif /* H5_HAVE_INDEX_PLUGIN_DUMMY */
done:
FUNC_LEAVE_NOAPI(ret_value)
} /* end H5X_init_interface() */
/*--------------------------------------------------------------------------
NAME
H5X_term_interface
PURPOSE
Terminate various H5X objects
USAGE
void H5X_term_interface()
RETURNS
Non-negative on success/Negative on failure
DESCRIPTION
Release the atom group and any other resources allocated.
GLOBAL VARIABLES
COMMENTS, BUGS, ASSUMPTIONS
Can't report errors...
EXAMPLES
REVISION LOG
--------------------------------------------------------------------------*/
int
H5X_term_interface(void)
{
int n = 0;
FUNC_ENTER_NOAPI_NOINIT_NOERR
if (H5_interface_initialize_g) {
/* Free the table of filters */
H5X_table_g = (H5X_class_t *) H5MM_xfree(H5X_table_g);
H5X_table_used_g = H5X_table_alloc_g = 0;
/* Shut down interface */
H5_interface_initialize_g = 0;
} /* end if */
FUNC_LEAVE_NOAPI(n)
} /* end H5X_term_interface() */
/*-------------------------------------------------------------------------
* Function: H5X_registered
*
* Purpose: Get registered plugin index class from plugin ID.
*
* Return: Success: pointer to registered index class
* Failure: NULL
*
*-------------------------------------------------------------------------
*/
H5X_class_t *
H5X_registered(unsigned plugin_id)
{
H5X_class_t *ret_value = NULL;
size_t plugin_index;
FUNC_ENTER_NOAPI_NOINIT
if (H5X__registered(plugin_id, &plugin_index)) {
ret_value = &H5X_table_g[plugin_index];
}
done:
FUNC_LEAVE_NOAPI(ret_value)
}
/*-------------------------------------------------------------------------
* Function: H5Xregister
*
* Purpose: This function registers new index classes.
*
* Return: Non-negative on success/Negative on failure
*
*-------------------------------------------------------------------------
*/
herr_t
H5Xregister(const H5X_class_t *index_class)
{
herr_t ret_value = SUCCEED; /* Return value */
FUNC_ENTER_API(FAIL)
/* Check args */
if (!index_class)
HGOTO_ERROR (H5E_ARGS, H5E_BADVALUE, FAIL, "invalid index plugin class");
if (index_class->version != H5X_CLASS_T_VERS)
HGOTO_ERROR (H5E_ARGS, H5E_BADVALUE, FAIL, "invalid index plugin version number");
if ((index_class->id < 0) || (index_class->id > H5X_PLUGIN_MAX))
HGOTO_ERROR (H5E_ARGS, H5E_BADVALUE, FAIL, "invalid index plugin identification number");
if (index_class->id < H5X_PLUGIN_RESERVED)
HGOTO_ERROR (H5E_ARGS, H5E_BADVALUE, FAIL, "unable to modify predefined index plugins");
/* Do or do not. There is no try. */
if (H5X_register(index_class) < 0)
HGOTO_ERROR (H5E_PLINE, H5E_CANTINIT, FAIL, "unable to register index")
done:
FUNC_LEAVE_API(ret_value)
} /* end H5Xregister() */
/*-------------------------------------------------------------------------
* Function: H5X_register
*
* Purpose: Same as the public version except this one allows plugins
* to be set for predefined method numbers < H5X_INDEX_RESERVED
*
* Return: Non-negative on success/Negative on failure
*
*-------------------------------------------------------------------------
*/
herr_t
H5X_register(const H5X_class_t *index_class)
{
size_t i;
herr_t ret_value = SUCCEED; /* Return value */
FUNC_ENTER_NOAPI_NOINIT
HDassert(index_class);
HDassert(index_class->id >= 0 && index_class->id <= H5X_PLUGIN_MAX);
/* Is the index class already registered? */
for (i = 0; i < H5X_table_used_g; i++)
if (H5X_table_g[i].id == index_class->id)
break;
/* Filter not already registered */
if (i >= H5X_table_used_g) {
if (H5X_table_used_g >= H5X_table_alloc_g) {
size_t n = MAX(H5X_MAX_NPLUGINS, 2 * H5X_table_alloc_g);
H5X_class_t *table = (H5X_class_t *) H5MM_realloc(H5X_table_g,
n * sizeof(H5X_class_t));
if(!table)
HGOTO_ERROR(H5E_RESOURCE, H5E_NOSPACE, FAIL, "unable to extend index plugin table");
H5X_table_g = table;
H5X_table_alloc_g = n;
} /* end if */
/* Initialize */
i = H5X_table_used_g++;
HDmemcpy(H5X_table_g + i, index_class, sizeof(H5X_class_t));
} /* end if */
else { /* Filter already registered */
/* Replace old contents */
HDmemcpy(H5X_table_g + i, index_class, sizeof(H5X_class_t));
} /* end else */
done:
FUNC_LEAVE_NOAPI(ret_value)
} /* end H5X_register() */
/*-------------------------------------------------------------------------
* Function: H5Xunregister
*
* Purpose: This function unregisters an index class.
*
* Return: Non-negative on success/Negative on failure
*
*-------------------------------------------------------------------------
*/
herr_t
H5Xunregister(unsigned plugin_id)
{
herr_t ret_value = SUCCEED; /* Return value */
FUNC_ENTER_API(FAIL)
H5TRACE1("e", "Iu", plugin_id);
/* Check args */
if ((plugin_id < 0) || (plugin_id > H5X_PLUGIN_MAX))
HGOTO_ERROR(H5E_ARGS, H5E_BADVALUE, FAIL, "invalid filter identification number");
if (plugin_id < H5X_PLUGIN_RESERVED)
HGOTO_ERROR(H5E_ARGS, H5E_BADVALUE, FAIL, "unable to modify predefined index plugins");
/* Do it */
if (H5X_unregister(plugin_id) < 0)
HGOTO_ERROR(H5E_PLINE, H5E_CANTINIT, FAIL, "unable to unregister index plugin");
done:
FUNC_LEAVE_API(ret_value)
} /* end H5Xunregister() */
/*-------------------------------------------------------------------------
* Function: H5X_unregister
*
* Purpose: Same as the public version except this one allows plugins
* to be unset for predefined method numbers < H5X_PLUGIN_RESERVED
*
* Return: Non-negative on success/Negative on failure
*
*-------------------------------------------------------------------------
*/
herr_t
H5X_unregister(unsigned plugin_id)
{
size_t plugin_index; /* Local index variable for filter */
// H5X_object_t object;
herr_t ret_value = SUCCEED; /* Return value */
FUNC_ENTER_NOAPI_NOINIT
HDassert((plugin_id >= 0) && (plugin_id <= H5X_PLUGIN_MAX));
/* Is the plugin already registered? */
if (FALSE == H5X__registered(plugin_id, &plugin_index))
HGOTO_ERROR(H5E_PLINE, H5E_NOTFOUND, FAIL, "plugin is not registered")
/* Initialize the structure object for iteration */
// object.plugin_id = plugin_id;
// object.found = FALSE;
/* Iterate through all opened datasets, returns a failure if any of them uses the filter */
// if(H5I_iterate(H5I_DATASET, H5Z__check_unregister_dset_cb, &object, FALSE) < 0)
// HGOTO_ERROR(H5E_FILE, H5E_BADITER, FAIL, "iteration failed")
// if(object.found)
// HGOTO_ERROR(H5E_PLINE, H5E_CANTRELEASE, FAIL, "can't unregister plugin because a dataset is still using it")
/* Iterate through all opened groups, returns a failure if any of them uses the filter */
// if(H5I_iterate(H5I_GROUP, H5Z__check_unregister_group_cb, &object, FALSE) < 0)
// HGOTO_ERROR(H5E_FILE, H5E_BADITER, FAIL, "iteration failed")
// if(object.found)
// HGOTO_ERROR(H5E_PLINE, H5E_CANTRELEASE, FAIL, "can't unregister plugin because a group is still using it")
/* Iterate through all opened files and flush them */
// if(H5I_iterate(H5I_FILE, H5Z__flush_file_cb, NULL, FALSE) < 0)
// HGOTO_ERROR(H5E_FILE, H5E_BADITER, FAIL, "iteration failed")
/* Remove filter from table */
/* Don't worry about shrinking table size (for now) */
HDmemmove(&H5X_table_g[plugin_index], &H5X_table_g[plugin_index + 1],
sizeof(H5X_class_t) * ((H5X_table_used_g - 1) - plugin_index));
H5X_table_used_g--;
done:
FUNC_LEAVE_NOAPI(ret_value)
} /* end H5X_unregister() */
/*-------------------------------------------------------------------------
* Function: H5Xcreate
*
* Purpose: Create a new index in a container.
*
* Return: Non-negative on success/Negative on failure
*
*-------------------------------------------------------------------------
*/
herr_t
H5Xcreate(hid_t file_id, unsigned plugin_id, hid_t scope_id, hid_t xcpl_id)
{
void *file = NULL, *obj = NULL;
H5VL_t *vol_plugin = NULL; /* VOL plugin information */
herr_t ret_value = SUCCEED; /* Return value */
FUNC_ENTER_API(FAIL)
H5TRACE4("e", "iIuii", file_id, plugin_id, scope_id, xcpl_id);
/* Check args */
if ((plugin_id < 0) || (plugin_id > H5X_PLUGIN_MAX))
HGOTO_ERROR(H5E_ARGS, H5E_BADVALUE, FAIL, "invalid plugin identification number");
if (NULL == (file = (void *)H5I_object_verify(file_id, H5I_FILE)))
HGOTO_ERROR(H5E_ARGS, H5E_BADVALUE, FAIL, "not a file ID");
if (NULL == (obj = (void *) H5VL_get_object(scope_id)))
HGOTO_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL, "invalid object/file identifier");
if (NULL == (vol_plugin = (H5VL_t *)H5I_get_aux(file_id)))
HGOTO_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL, "ID does not contain VOL information");
/* TODO */
/* Call H5VL layer */
done:
FUNC_LEAVE_API(ret_value)
} /* end H5Xcreate() */
/*-------------------------------------------------------------------------
* Function: H5Xcreate_ff
*
* Purpose: Create a new index in a container.
*
* Return: Non-negative on success/Negative on failure
*
*-------------------------------------------------------------------------
*/
herr_t
H5Xcreate_ff(hid_t file_id, unsigned plugin_id, hid_t scope_id, hid_t xcpl_id,
hid_t trans_id, hid_t estack_id)
{
H5_priv_request_t *request = NULL; /* private request struct inserted in event queue */
void **req = NULL; /* pointer to plugin generate requests (NULL if VOL plugin does not support async) */
void *idx_handle = NULL; /* pointer to index object created */
void *file = NULL, *dset = NULL;
H5VL_t *vol_plugin = NULL; /* VOL plugin information */
size_t plugin_index;
H5P_genplist_t *plist;
hid_t dataset_id = scope_id; /* TODO for now */
hid_t xapl_id = H5P_INDEX_ACCESS_DEFAULT; /* TODO for now */
size_t metadata_size; /* size of metadata created by plugin */
void *metadata; /* metadata created by plugin that needs to be stored */
herr_t ret_value = SUCCEED; /* Return value */
FUNC_ENTER_API(FAIL)
H5TRACE6("e", "iIuiiii", file_id, plugin_id, scope_id, xcpl_id, trans_id,
estack_id);
/* Check args */
if ((plugin_id < 0) || (plugin_id > H5X_PLUGIN_MAX))
HGOTO_ERROR(H5E_ARGS, H5E_BADVALUE, FAIL, "invalid plugin identification number");
if (NULL == (file = (void *) H5I_object_verify(file_id, H5I_FILE)))
HGOTO_ERROR(H5E_ARGS, H5E_BADVALUE, FAIL, "not a file ID");
if (NULL == H5I_object_verify(scope_id, H5I_DATASET))
HGOTO_ERROR(H5E_ARGS, H5E_BADVALUE, FAIL, "scope_id is restricted to dataset ID");
if (NULL == (dset = (void *) H5VL_get_object(scope_id)))
HGOTO_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL, "invalid object/file identifier");
if (NULL == (vol_plugin = (H5VL_t *) H5I_get_aux(file_id)))
HGOTO_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL, "ID does not contain VOL information");
/* Is the plugin already registered */
if (FALSE == H5X__registered(plugin_id, &plugin_index))
HGOTO_ERROR(H5E_INDEX, H5E_BADVALUE, FAIL, "plugin is not registered");
/* Get correct property list */
if (H5P_DEFAULT == xcpl_id)
xcpl_id = H5P_INDEX_CREATE_DEFAULT;
else
if (TRUE != H5P_isa_class(xcpl_id, H5P_INDEX_CREATE))
HGOTO_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL, "not index creation property list");
if (estack_id != H5_EVENT_STACK_NULL) {
/* create the private request */
if (NULL == (request = (H5_priv_request_t *) H5MM_calloc(sizeof(H5_priv_request_t))))
HGOTO_ERROR(H5E_RESOURCE, H5E_NOSPACE, FAIL, "memory allocation failed")
request->req = NULL;
req = &request->req;
request->next = NULL;
request->vol_plugin = vol_plugin;
vol_plugin->nrefs ++;
}
/* Store the transaction ID in the xapl_id */
if (NULL == (plist = (H5P_genplist_t *)H5I_object(xapl_id)))
HGOTO_ERROR(H5E_ATOM, H5E_BADATOM, FAIL, "can't find object for ID")
if (H5P_set(plist, H5VL_TRANS_ID, &trans_id) < 0)
HGOTO_ERROR(H5E_PLIST, H5E_CANTGET, FAIL, "can't set property value for trans_id")
/* Call create of the plugin */
if (NULL == (idx_handle = H5X_table_g[plugin_index].create(
file_id, dataset_id, xcpl_id, xapl_id, &metadata_size, &metadata)))
HGOTO_ERROR(H5E_INDEX, H5E_CANTCREATE, FAIL, "cannot create new plugin index");
/* Add idx_handle to dataset */
if (FAIL == H5VL_iod_dataset_set_index(dset, idx_handle))
HGOTO_ERROR(H5E_INDEX, H5E_CANTSET, FAIL, "cannot set index to dataset");
if (FAIL == H5VL_iod_dataset_set_index_info(dset, plugin_id,
metadata_size, metadata, trans_id, req))
HGOTO_ERROR(H5E_INDEX, H5E_CANTSET, FAIL, "cannot set index info to dataset");
if (request && *req) {
if(H5ES_insert(estack_id, request) < 0)
HGOTO_ERROR(H5E_SYM, H5E_CANTINIT, FAIL, "failed to insert request in event stack")
}
done:
FUNC_LEAVE_API(ret_value)
} /* end H5Xcreate_ff() */
/*-------------------------------------------------------------------------
* Function: H5Xremove
*
* Purpose: Remove an index from objects in a container.
*
* Return: Non-negative on success/Negative on failure
*
*-------------------------------------------------------------------------
*/
herr_t
H5Xremove(hid_t file_id, unsigned plugin_id, hid_t scope_id)
{
void *file = NULL, *obj = NULL;
H5VL_t *vol_plugin = NULL; /* VOL plugin information */
herr_t ret_value = SUCCEED; /* Return value */
FUNC_ENTER_API(FAIL)
H5TRACE3("e", "iIui", file_id, plugin_id, scope_id);
/* Check args */
if ((plugin_id < 0) || (plugin_id > H5X_PLUGIN_MAX))
HGOTO_ERROR(H5E_ARGS, H5E_BADVALUE, FAIL, "invalid plugin identification number");
if (NULL == (file = (void *)H5I_object_verify(file_id, H5I_FILE)))
HGOTO_ERROR(H5E_ARGS, H5E_BADVALUE, FAIL, "not a file ID");
if (NULL == (obj = (void *) H5VL_get_object(scope_id)))
HGOTO_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL, "invalid object/file identifier");
if (NULL == (vol_plugin = (H5VL_t *)H5I_get_aux(file_id)))
HGOTO_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL, "ID does not contain VOL information");
/* Call H5VL layer */
done:
FUNC_LEAVE_API(ret_value)
} /* end H5Xremove() */
/*-------------------------------------------------------------------------
* Function: H5Xremove_ff
*
* Purpose: Remove an index from objects in a container.
*
* Return: Non-negative on success/Negative on failure
*
*-------------------------------------------------------------------------
*/
herr_t
H5Xremove_ff(hid_t file_id, unsigned plugin_id, hid_t scope_id, hid_t trans_id,
hid_t estack_id)
{
H5_priv_request_t *request = NULL; /* private request struct inserted in event queue */
void **req = NULL; /* pointer to plugin generate requests (NULL if VOL plugin does not support async) */
void *file = NULL, *dset = NULL;
H5VL_t *vol_plugin = NULL; /* VOL plugin information */
size_t plugin_index;
H5P_genplist_t *plist;
hid_t dataset_id = scope_id; /* TODO for now */
hid_t xapl_id = H5P_INDEX_ACCESS_DEFAULT; /* TODO for now */
size_t metadata_size; /* size of metadata created by plugin */
void *metadata; /* metadata created by plugin that needs to be stored */
herr_t ret_value = SUCCEED; /* Return value */
FUNC_ENTER_API(FAIL)
H5TRACE5("e", "iIuiii", file_id, plugin_id, scope_id, trans_id, estack_id);
/* Check args */
if ((plugin_id < 0) || (plugin_id > H5X_PLUGIN_MAX))
HGOTO_ERROR(H5E_ARGS, H5E_BADVALUE, FAIL, "invalid plugin identification number");
if (NULL == (file = (void *) H5I_object_verify(file_id, H5I_FILE)))
HGOTO_ERROR(H5E_ARGS, H5E_BADVALUE, FAIL, "not a file ID");
if (NULL == H5I_object_verify(scope_id, H5I_DATASET))
HGOTO_ERROR(H5E_ARGS, H5E_BADVALUE, FAIL, "scope_id is restricted to dataset ID");
if (NULL == (dset = (void *) H5VL_get_object(scope_id)))
HGOTO_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL, "invalid object/file identifier");
if (NULL == (vol_plugin = (H5VL_t *) H5I_get_aux(file_id)))
HGOTO_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL, "ID does not contain VOL information");
/* Is the plugin already registered */
if (FALSE == H5X__registered(plugin_id, &plugin_index))
HGOTO_ERROR(H5E_INDEX, H5E_BADVALUE, FAIL, "plugin is not registered");
if (estack_id != H5_EVENT_STACK_NULL) {
/* create the private request */
if (NULL == (request = (H5_priv_request_t *) H5MM_calloc(sizeof(H5_priv_request_t))))
HGOTO_ERROR(H5E_RESOURCE, H5E_NOSPACE, FAIL, "memory allocation failed")
request->req = NULL;
req = &request->req;
request->next = NULL;
request->vol_plugin = vol_plugin;
vol_plugin->nrefs ++;
}
/* Store the transaction ID in the xapl_id */
if (NULL == (plist = (H5P_genplist_t *)H5I_object(xapl_id)))
HGOTO_ERROR(H5E_ATOM, H5E_BADATOM, FAIL, "can't find object for ID")
if (H5P_set(plist, H5VL_TRANS_ID, &trans_id) < 0)
HGOTO_ERROR(H5E_PLIST, H5E_CANTGET, FAIL, "can't set property value for trans_id")
/* Call remove of the plugin */
if (FAIL == H5X_table_g[plugin_index].remove(file_id, dataset_id,
metadata_size, metadata))
HGOTO_ERROR(H5E_INDEX, H5E_CANTCREATE, FAIL, "cannot remove index");
/* Remove idx_handle from dataset */
if (FAIL == H5VL_iod_dataset_set_index(dset, NULL))
HGOTO_ERROR(H5E_INDEX, H5E_CANTSET, FAIL, "cannot reset index handle");
if (FAIL == H5VL_iod_dataset_remove_index_info(dset, trans_id, req))
HGOTO_ERROR(H5E_INDEX, H5E_CANTSET, FAIL, "cannot remove index from dataset");
if (request && *req) {
if(H5ES_insert(estack_id, request) < 0)
HGOTO_ERROR(H5E_SYM, H5E_CANTINIT, FAIL, "failed to insert request in event stack")
}
done:
FUNC_LEAVE_API(ret_value)
} /* end H5Xremove_ff() */
/*-------------------------------------------------------------------------
* Function: H5Xget_count
*
* Purpose: Determine the number of index objects on an object.
*
* Return: Non-negative on success/Negative on failure
*
*-------------------------------------------------------------------------
*/
herr_t
H5Xget_count(hid_t scope_id, hsize_t *idx_count)
{
herr_t ret_value = SUCCEED; /* Return value */
FUNC_ENTER_API(FAIL)
H5TRACE2("e", "i*h", scope_id, idx_count);
/* TODO if necessary */
done:
FUNC_LEAVE_API(ret_value)
} /* end H5Xget_count() */
/*-------------------------------------------------------------------------
* Function: H5Xget_count_ff
*
* Purpose: Determine the number of index objects on an object.
*
* Return: Non-negative on success/Negative on failure
*
*-------------------------------------------------------------------------
*/
herr_t
H5Xget_count_ff(hid_t scope_id, hsize_t *idx_count, hid_t rcxt_id,
hid_t estack_id)
{
H5_priv_request_t *request = NULL; /* private request struct inserted in event queue */
void **req = NULL; /* pointer to plugin generate requests (NULL if VOL plugin does not support async) */
void *dset;
H5VL_t *vol_plugin = NULL; /* VOL plugin information */
herr_t ret_value = SUCCEED; /* Return value */
FUNC_ENTER_API(FAIL)
H5TRACE4("e", "i*hii", scope_id, idx_count, rcxt_id, estack_id);
if (NULL == H5I_object_verify(scope_id, H5I_DATASET))
HGOTO_ERROR(H5E_ARGS, H5E_BADVALUE, FAIL, "scope_id is restricted to dataset ID");
if (NULL == (dset = (void *) H5VL_get_object(scope_id)))
HGOTO_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL, "invalid object/file identifier");
if (!idx_count)
HGOTO_ERROR(H5E_ARGS, H5E_BADVALUE, FAIL, "idx_count is NULL");
if (estack_id != H5_EVENT_STACK_NULL) {
/* create the private request */
if (NULL == (request = (H5_priv_request_t *) H5MM_calloc(sizeof(H5_priv_request_t))))
HGOTO_ERROR(H5E_RESOURCE, H5E_NOSPACE, FAIL, "memory allocation failed")
request->req = NULL;
req = &request->req;
request->next = NULL;
request->vol_plugin = vol_plugin;
vol_plugin->nrefs ++;
}
/* TODO for now idx_count is flag exist */
if (FAIL == H5VL_iod_dataset_get_index_info(dset, idx_count, NULL, NULL,
rcxt_id, req))
HGOTO_ERROR(H5E_INDEX, H5E_CANTSET, FAIL, "cannot get indexing info from dataset");
if (request && *req) {
if(H5ES_insert(estack_id, request) < 0)
HGOTO_ERROR(H5E_SYM, H5E_CANTINIT, FAIL, "failed to insert request in event stack")
}
done:
FUNC_LEAVE_API(ret_value)
} /* end H5Xget_count_ff() */
#endif /* H5_HAVE_INDEXING */
|