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
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
|
/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
* Copyright by The HDF Group. *
* 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://hdfgroup.org/HDF5/doc/Copyright.html. If you do not have *
* access to either file, you may request a copy from help@hdfgroup.org. *
* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
#include <stdlib.h>
#include "H5PTprivate.h"
#include "H5TBprivate.h"
/* Packet Table private data */
typedef struct
{
hid_t dset_id; /* The ID of the dataset containing this table */
hid_t type_id; /* The ID of the packet table's native datatype */
hsize_t current_index; /* The index of the packet that get_next_packet will read next */
hsize_t size; /* The number of packets currently contained in this table */
} htbl_t;
static hsize_t H5PT_ptable_count = 0;
static H5I_type_t H5PT_ptable_id_type = H5I_UNINIT;
#define H5PT_HASH_TABLE_SIZE 64
/* Packet Table private functions */
static herr_t H5PT_free_id(void *id);
static herr_t H5PT_close( htbl_t* table );
static herr_t H5PT_create_index(htbl_t *table_id);
static herr_t H5PT_set_index(htbl_t *table_id, hsize_t pt_index);
static herr_t H5PT_get_index(htbl_t *table_id, hsize_t *pt_index);
/*-------------------------------------------------------------------------
*
* Create/Open/Close functions
*
*-------------------------------------------------------------------------
*/
/*-------------------------------------------------------------------------
* Function: H5PTcreate
*
* Purpose: Creates a dataset containing a table and returns the Identifier
* of the table. (Copied mostly from H5PTcreate_fl)
*
* Return: Success: table ID, Failure: FAIL
*
* Programmer: Nat Furrer, nfurrer@ncsa.uiuc.edu (Author of H5PTcreate_fl)
* James Laird, jlaird@ncsa.uiuc.edu (Author of H5PTcreate_fl)
*
* Date: March 12, 2004
*
* Comments: This function does not handle fill data
* currently. Fill data is not necessary because the
* table is initially of size 0.
*
* Modifications:
* Mar 1, 2016
* This function is added to replace H5PTcreate_fl and it differs
* from H5PTcreate_fl only because its last argument is plist_id
* instead of compression; this is to allow flexible compression.
* -BMR
*
*-------------------------------------------------------------------------
*/
hid_t H5PTcreate(hid_t loc_id,
const char *dset_name,
hid_t dtype_id,
hsize_t chunk_size,
hid_t plist_id)
{
htbl_t * table = NULL;
hid_t dset_id = H5I_INVALID_HID;
hid_t space_id = H5I_INVALID_HID;
hid_t plistcopy_id = H5I_INVALID_HID;
hsize_t dims[1];
hsize_t dims_chunk[1];
hsize_t maxdims[1];
hid_t ret_value = H5I_INVALID_HID;
/* check the arguments */
if (dset_name == NULL) {
goto error;
}
/* Register the packet table ID type if this is the first table created */
if(H5PT_ptable_id_type < 0)
if((H5PT_ptable_id_type = H5Iregister_type((size_t)H5PT_HASH_TABLE_SIZE, 0, (H5I_free_t)H5PT_free_id)) < 0)
goto error;
/* Get memory for the table identifier */
table = (htbl_t *)HDmalloc(sizeof(htbl_t));
if ( table == NULL ) {
goto error;
}
table->dset_id = H5I_INVALID_HID;
table->type_id = H5I_INVALID_HID;
/* Create a simple data space with unlimited size */
dims[0] = 0;
dims_chunk[0] = chunk_size;
maxdims[0] = H5S_UNLIMITED;
if((space_id = H5Screate_simple(1, dims, maxdims)) < 0)
goto error;
/* Modify dataset creation properties to enable chunking */
if (plist_id == H5P_DEFAULT) {
plistcopy_id = H5Pcreate(H5P_DATASET_CREATE);
}
else {
plistcopy_id = H5Pcopy(plist_id);
}
if (chunk_size > 0)
{
if(H5Pset_chunk(plistcopy_id, 1, dims_chunk) < 0)
goto error;
}
/* Create the dataset. */
if((dset_id = H5Dcreate2(loc_id, dset_name, dtype_id, space_id, H5P_DEFAULT, plistcopy_id, H5P_DEFAULT)) < 0)
goto error;
/* Create the table identifier */
table->dset_id = dset_id;
/* Terminate access to the data space. */
if(H5Sclose(space_id) < 0)
goto error;
/* End access to the property list */
if(H5Pclose(plistcopy_id) < 0)
goto error;
if((table->type_id = H5Tget_native_type(dtype_id, H5T_DIR_DEFAULT)) < 0)
goto error;
H5PT_create_index(table);
table->size = 0;
/* Get an ID for this table */
ret_value = H5Iregister(H5PT_ptable_id_type, table);
if(ret_value != H5I_INVALID_HID)
H5PT_ptable_count++;
else
H5PT_close(table);
return ret_value;
error:
if (space_id != H5I_INVALID_HID)
H5Sclose(space_id);
if (plistcopy_id != H5I_INVALID_HID)
H5Pclose(plistcopy_id);
if (dset_id != H5I_INVALID_HID)
H5Dclose(dset_id);
if (table)
{
if (table->type_id != H5I_INVALID_HID)
H5Tclose(table->type_id);
HDfree(table);
}
return ret_value;
} /* H5PTcreate */
/*-------------------------------------------------------------------------
* Function: H5PTcreate_fl
*
* Purpose: Creates a dataset containing a table and returns the Identifier
* of the table.
*
* Return: Success: table ID, Failure: Negative
*
* Programmer: Nat Furrer, nfurrer@ncsa.uiuc.edu
* James Laird, jlaird@ncsa.uiuc.edu
*
* Date: March 12, 2004
*
* Comments: This function does not handle fill data
* currently. Fill data is not necessary because the
* table is initially of size 0.
*
* Modifications:
*
*-------------------------------------------------------------------------
*/
hid_t H5PTcreate_fl ( hid_t loc_id,
const char *dset_name,
hid_t dtype_id,
hsize_t chunk_size,
int compression )
{
htbl_t * table = NULL;
hid_t dset_id = H5I_INVALID_HID;
hid_t space_id = H5I_INVALID_HID;
hid_t plist_id = H5I_INVALID_HID;
hsize_t dims[1];
hsize_t dims_chunk[1];
hsize_t maxdims[1];
hid_t ret_value = H5I_INVALID_HID;
/* check the arguments */
if (dset_name == NULL) {
goto error;
}
/* Register the packet table ID type if this is the first table created */
if(H5PT_ptable_id_type < 0)
if((H5PT_ptable_id_type = H5Iregister_type((size_t)H5PT_HASH_TABLE_SIZE, 0, (H5I_free_t)H5PT_free_id)) < 0)
goto error;
/* Get memory for the table identifier */
table = (htbl_t *)HDmalloc(sizeof(htbl_t));
if ( table == NULL ) {
goto error;
}
table->dset_id = H5I_INVALID_HID;
table->type_id = H5I_INVALID_HID;
/* Create a simple data space with unlimited size */
dims[0] = 0;
dims_chunk[0] = chunk_size;
maxdims[0] = H5S_UNLIMITED;
if((space_id = H5Screate_simple(1, dims, maxdims)) < 0)
goto error;
/* Modify dataset creation properties to enable chunking */
plist_id = H5Pcreate(H5P_DATASET_CREATE);
if(H5Pset_chunk(plist_id, 1, dims_chunk) < 0)
goto error;
if(compression >= 0 && compression <= 9)
if(H5Pset_deflate(plist_id, (unsigned)compression) < 0)
goto error;
/* Create the dataset. */
if((dset_id = H5Dcreate2(loc_id, dset_name, dtype_id, space_id, H5P_DEFAULT, plist_id, H5P_DEFAULT)) < 0)
goto error;
/* Create the table identifier */
table->dset_id = dset_id;
/* Terminate access to the data space. */
if(H5Sclose(space_id) < 0)
goto error;
/* End access to the property list */
if(H5Pclose(plist_id) < 0)
goto error;
if((table->type_id = H5Tget_native_type(dtype_id, H5T_DIR_DEFAULT)) < 0)
goto error;
H5PT_create_index(table);
table->size = 0;
/* Get an ID for this table */
ret_value = H5Iregister(H5PT_ptable_id_type, table);
if(ret_value != H5I_INVALID_HID)
H5PT_ptable_count++;
else
H5PT_close(table);
return ret_value;
error:
if (space_id != H5I_INVALID_HID)
H5Sclose(space_id);
if (plist_id != H5I_INVALID_HID)
H5Pclose(plist_id);
if (dset_id != H5I_INVALID_HID)
H5Dclose(dset_id);
if (table)
{
if (table->type_id != H5I_INVALID_HID)
H5Tclose(table->type_id);
HDfree(table);
}
return ret_value;
} /* H5PTcreate_fl */
/*-------------------------------------------------------------------------
* Function: H5PTopen
*
* Purpose: Opens a dataset containing a table and returns the Identifier
* of the table.
*
* Return: Success: table ID, Failure: Negative
*
* Programmer: Nat Furrer, nfurrer@ncsa.uiuc.edu
* James Laird, jlaird@ncsa.uiuc.edu
*
* Date: March 10, 2004
*
* Comments:
*
* Modifications:
*
* John Mainzer -- 4/23/08
* Added error check on malloc of table, initialized fields
* in table to keep lower level code from choking on bogus
* data in error cases.
*
*-------------------------------------------------------------------------
*/
hid_t H5PTopen( hid_t loc_id,
const char *dset_name )
{
hid_t type_id=H5I_INVALID_HID;
hid_t space_id=H5I_INVALID_HID;
htbl_t * table = NULL;
hsize_t dims[1];
hid_t ret_value = H5I_INVALID_HID;
/* check the arguments */
if (dset_name == NULL) {
goto error;
}
/* Register the packet table ID type if this is the first table created */
if( H5PT_ptable_id_type < 0)
if((H5PT_ptable_id_type = H5Iregister_type((size_t)H5PT_HASH_TABLE_SIZE, 0, (H5I_free_t)H5PT_free_id)) < 0)
goto error;
table = (htbl_t *)HDmalloc(sizeof(htbl_t));
if ( table == NULL ) {
goto error;
}
table->dset_id = H5I_INVALID_HID;
table->type_id = H5I_INVALID_HID;
/* Open the dataset */
if((table->dset_id = H5Dopen2(loc_id, dset_name, H5P_DEFAULT)) < 0)
goto error;
/* Get the dataset's disk datatype */
if((type_id = H5Dget_type(table->dset_id)) < 0)
goto error;
/* Get the table's native datatype */
if((table->type_id = H5Tget_native_type(type_id, H5T_DIR_ASCEND)) < 0)
goto error;
/* Close the disk datatype */
if(H5Tclose(type_id) < 0)
goto error;
type_id = H5I_INVALID_HID;
/* Initialize the current record pointer */
if((H5PT_create_index(table)) < 0)
goto error;
/* Get number of records in table */
if((space_id=H5Dget_space(table->dset_id)) < 0)
goto error;
if(H5Sget_simple_extent_dims(space_id, dims, NULL) < 0)
goto error;
if(H5Sclose(space_id) < 0)
goto error;
space_id = H5I_INVALID_HID;
table->size = dims[0];
/* Get an ID for this table */
ret_value = H5Iregister(H5PT_ptable_id_type, table);
if(ret_value != H5I_INVALID_HID)
H5PT_ptable_count++;
else
H5PT_close(table);
return ret_value;
error:
if (type_id != H5I_INVALID_HID)
H5Dclose(type_id);
if (space_id != H5I_INVALID_HID)
H5Sclose(space_id);
if(table)
{
if (table->type_id != H5I_INVALID_HID)
H5Tclose(table->type_id);
if (table->dset_id != H5I_INVALID_HID)
H5Dclose(table->dset_id);
HDfree(table);
}
return ret_value;
} /* H5PTopen */
/*-------------------------------------------------------------------------
* Function: H5PT_free_id
*
* Purpose: Free an id. Callback for H5Iregister_type.
*
* Return: Success: SUCCEED, Failure: N/A
*-------------------------------------------------------------------------
*/
static herr_t
H5PT_free_id(void *id)
{
HDfree(id);
return SUCCEED;
}
/*-------------------------------------------------------------------------
* Function: H5PT_close
*
* Purpose: Closes a table (i.e. cleans up all open resources used by a
* table).
*
* Return: Success: SUCCEED, Failure: FAIL
*
* Programmer: Nat Furrer, nfurrer@ncsa.uiuc.edu
* James Laird, jlaird@ncsa.uiuc.edu
*
* Date: March 10, 2004
*
* Comments:
*
* Modifications:
*
*-------------------------------------------------------------------------
*/
static herr_t
H5PT_close( htbl_t* table)
{
if(table == NULL)
goto error;
/* Close the dataset */
if(H5Dclose(table->dset_id) < 0)
goto error;
/* Close the memory datatype */
if(H5Tclose(table->type_id) < 0)
goto error;
HDfree(table);
return SUCCEED;
error:
if(table)
{
H5E_BEGIN_TRY
H5Dclose(table->dset_id);
H5Tclose(table->type_id);
H5E_END_TRY
HDfree(table);
}
return FAIL;
}
/*-------------------------------------------------------------------------
* Function: H5PTclose
*
* Purpose: Closes a table (i.e. cleans up all open resources used by a
* table).
*
* Return: Success: SUCCEED, Failure: FAIL
*
* Programmer: Nat Furrer, nfurrer@ncsa.uiuc.edu
* James Laird, jlaird@ncsa.uiuc.edu
*
* Date: April 21, 2004
*
* Comments:
*
* Modifications:
*
*-------------------------------------------------------------------------
*/
herr_t H5PTclose( hid_t table_id )
{
htbl_t * table;
/* Remove the ID from the library */
if((table = (htbl_t *)H5Iremove_verify(table_id, H5PT_ptable_id_type)) ==NULL)
goto error;
/* If the library found the table, remove it */
if( H5PT_close(table) < 0)
goto error;
/* One less packet table open */
H5PT_ptable_count--;
/* Remove the packet table type ID if no more packet */
/* tables are open */
if(H5PT_ptable_count == 0)
{
H5Idestroy_type(H5PT_ptable_id_type);
H5PT_ptable_id_type = H5I_UNINIT;
}
return SUCCEED;
error:
return FAIL;
}
/*-------------------------------------------------------------------------
*
* Write functions
*
*-------------------------------------------------------------------------
*/
/*-------------------------------------------------------------------------
* Function: H5PTappend
*
* Purpose: Appends packets to the end of a packet table
*
* Return: Success: SUCCEED, Failure: FAIL
*
* Programmer: Nat Furrer, nfurrer@ncsa.uiuc.edu
* James Laird, jlaird@ncsa.uiuc.edu
*
* Date: March 12, 2004
*
* Comments:
*
* Modifications:
*
*-------------------------------------------------------------------------
*/
herr_t H5PTappend( hid_t table_id,
size_t nrecords,
const void * data )
{
htbl_t * table;
/* Find the table struct from its ID */
if((table = (htbl_t *) H5Iobject_verify(table_id, H5PT_ptable_id_type)) == NULL)
goto error;
/* If we are asked to write 0 records, just do nothing */
if(nrecords == 0)
return SUCCEED;
if((H5TB_common_append_records(table->dset_id, table->type_id,
nrecords, table->size, data)) < 0)
goto error;
/* Update table size */
table->size += nrecords;
return SUCCEED;
error:
return FAIL;
}
/*-------------------------------------------------------------------------
*
* Read functions
*
*-------------------------------------------------------------------------
*/
/*-------------------------------------------------------------------------
* Function: H5PTget_next
*
* Purpose: Reads packets starting at the current index and updates
* that index
*
* Return: Success: SUCCEED, Failure: FAIL
*
* Programmer: Nat Furrer, nfurrer@ncsa.uiuc.edu
* James Laird, jlaird@ncsa.uiuc.edu
*
* Date: March 10, 2004
*
* Comments:
*
* Modifications:
*
*
*-------------------------------------------------------------------------
*/
herr_t H5PTget_next( hid_t table_id,
size_t nrecords,
void * data)
{
htbl_t * table;
/* Find the table struct from its ID */
if((table = (htbl_t *) H5Iobject_verify(table_id, H5PT_ptable_id_type)) == NULL)
goto error;
/* If nrecords == 0, do nothing */
if(nrecords == 0)
return SUCCEED;
if((H5TB_common_read_records(table->dset_id, table->type_id,
table->current_index, nrecords, table->size, data)) < 0)
goto error;
/* Update the current index */
table->current_index += nrecords;
return SUCCEED;
error:
return FAIL;
}
/*-------------------------------------------------------------------------
* Function: H5PTread_packets
*
* Purpose: Reads packets from anywhere in a packet table
*
* Return: Success: SUCCEED, Failure: FAIL
*
* Programmer: Nat Furrer, nfurrer@ncsa.uiuc.edu
* James Laird, jlaird@ncsa.uiuc.edu
*
* Date: March 12, 2004
*
* Comments:
*
* Modifications:
*
*
*-------------------------------------------------------------------------
*/
herr_t H5PTread_packets( hid_t table_id,
hsize_t start,
size_t nrecords,
void *data)
{
htbl_t * table;
/* find the table struct from its ID */
table = (htbl_t *) H5Iobject_verify(table_id, H5PT_ptable_id_type);
if(table == NULL)
goto error;
/* If nrecords == 0, do nothing */
if(nrecords == 0)
return SUCCEED;
if( H5TB_common_read_records(table->dset_id, table->type_id,
start, nrecords, table->size, data) < 0)
goto error;
return SUCCEED;
error:
return FAIL;
}
/*-------------------------------------------------------------------------
*
* Table attribute functions
*
*-------------------------------------------------------------------------
*/
/*-------------------------------------------------------------------------
* Function: H5PT_create_index, H5PT_set_index, H5PT_get_index
*
* Purpose: Resets, sets, and gets the current record index for a packet table
*
* Return: Success: SUCCEED, Failure: FAIL
*
* Programmer: Nat Furrer, nfurrer@ncsa.uiuc.edu
* James Laird, jlaird@ncsa.uiuc.edu
*
* Date: March 12, 2004
*
* Comments:
*
* Modifications:
*
*-------------------------------------------------------------------------
*/
static herr_t
H5PT_create_index(htbl_t *table)
{
if( table != NULL)
{
table->current_index = 0;
return SUCCEED;
}
return FAIL;
}
static herr_t
H5PT_set_index(htbl_t *table, hsize_t pt_index)
{
/* Ensure index is valid */
if( table != NULL )
{
if( pt_index < table->size )
{
table->current_index = pt_index;
return SUCCEED;
}
}
return FAIL;
}
static herr_t
H5PT_get_index(htbl_t *table, hsize_t *pt_index)
{
/* Ensure index is valid */
if( table != NULL )
{
if(pt_index)
*pt_index = table->current_index;
return SUCCEED;
}
return FAIL;
}
/*-------------------------------------------------------------------------
* Function: H5PTcreate_index, H5PTset_index, H5PTget_index
*
* Purpose: Resets, sets, and gets the current record index for a packet table
*
* Return: Success: SUCCEED, Failure: FAIL
*
* Programmer: Nat Furrer, nfurrer@ncsa.uiuc.edu
* James Laird, jlaird@ncsa.uiuc.edu
*
* Date: April 23, 2004
*
* Comments:
*
* Modifications:
*
*-------------------------------------------------------------------------
*/
herr_t H5PTcreate_index(hid_t table_id)
{
htbl_t * table;
/* find the table struct from its ID */
if((table = (htbl_t *) (htbl_t *) H5Iobject_verify(table_id, H5PT_ptable_id_type)) == NULL)
return FAIL;
return H5PT_create_index(table);
}
herr_t H5PTset_index(hid_t table_id, hsize_t pt_index)
{
htbl_t * table;
/* find the table struct from its ID */
if((table = (htbl_t *) H5Iobject_verify(table_id, H5PT_ptable_id_type)) == NULL)
return FAIL;
return H5PT_set_index(table, pt_index);
}
herr_t H5PTget_index(hid_t table_id, hsize_t *pt_index)
{
htbl_t * table;
/* find the table struct from its ID */
if((table = (htbl_t *) H5Iobject_verify(table_id, H5PT_ptable_id_type)) == NULL)
return FAIL;
return H5PT_get_index(table, pt_index);
}
/*-------------------------------------------------------------------------
*
* Inquiry functions
*
*-------------------------------------------------------------------------
*/
/*-------------------------------------------------------------------------
* Function: H5PTget_num_packets
*
* Purpose: Returns by reference the number of packets in the packet table
*
* Return: Success: SUCCEED, Failure: FAIL
*
* Programmer: Nat Furrer, nfurrer@ncsa.uiuc.edu
* James Laird, jlaird@ncsa.uiuc.edu
*
* Date: March 12, 2004
*
* Comments:
*
* Modifications:
*
*
*-------------------------------------------------------------------------
*/
herr_t H5PTget_num_packets( hid_t table_id, hsize_t *nrecords)
{
htbl_t * table;
/* find the table struct from its ID */
if((table = (htbl_t *) H5Iobject_verify(table_id, H5PT_ptable_id_type)) == NULL)
goto error;
if(nrecords)
*nrecords = table->size;
return SUCCEED;
error:
return FAIL;
}
/*-------------------------------------------------------------------------
* Function: H5PTis_valid
*
* Purpose: Validates a table identifier
*
* Return: Success: SUCCEED, Failure: FAIL
*
* Programmer: Nat Furrer, nfurrer@ncsa.uiuc.edu
* James Laird, jlaird@ncsa.uiuc.edu
*
* Date: March 12, 2004
*
* Comments:
*
* Modifications:
*
*
*-------------------------------------------------------------------------
*/
herr_t H5PTis_valid(hid_t table_id)
{
/* find the table struct from its ID */
if(H5Iobject_verify(table_id, H5PT_ptable_id_type) ==NULL)
return FAIL;
return SUCCEED;
}
/*-------------------------------------------------------------------------
* Function: H5PTis_varlen
*
* Purpose: Returns 1 if a table_id corresponds to a packet table of variable-
* length records or 0 for fixed-length records.
*
* Return: True: 1, False: 0, Failure: FAIL
*
* Programmer: Nat Furrer, nfurrer@ncsa.uiuc.edu
* James Laird, jlaird@ncsa.uiuc.edu
*
* Date: April 14, 2004
*
* Comments:
*
* Modifications:
*
*
*-------------------------------------------------------------------------
*/
herr_t H5PTis_varlen(hid_t table_id)
{
H5T_class_t type;
htbl_t * table;
/* find the table struct from its ID */
if((table = (htbl_t *) H5Iobject_verify(table_id, H5PT_ptable_id_type)) == NULL)
goto error;
if((type = H5Tget_class( table->type_id )) == H5T_NO_CLASS)
goto error;
if( type == H5T_VLEN )
return 1;
else
return 0;
error:
return FAIL;
}
/*-------------------------------------------------------------------------
*
* Memory Management functions
*
*-------------------------------------------------------------------------
*/
/*-------------------------------------------------------------------------
* Function: H5PTfree_vlen_buff
*
* Purpose: Frees memory used when reading from a variable length packet
* table.
*
* Return: Success: SUCCEED, Failure: FAIL
* -2 if memory was reclaimed but another error occurred
*
* Programmer: Nat Furrer, nfurrer@ncsa.uiuc.edu
* James Laird, jlaird@ncsa.uiuc.edu
*
* Date: April 12, 2004
*
* Comments:
*
* Modifications:
*
*
*-------------------------------------------------------------------------
*/
herr_t H5PTfree_vlen_buff( hid_t table_id,
size_t _bufflen,
void * buff )
{
hid_t space_id = H5I_INVALID_HID;
htbl_t * table;
hsize_t bufflen = _bufflen;
herr_t ret_value;
/* find the table struct from its ID */
if((table = (htbl_t *) H5Iobject_verify(table_id, H5PT_ptable_id_type)) == NULL)
goto error;
if((space_id = H5Screate_simple(1, &bufflen, NULL)) < 0)
goto error;
/* Free the memory. If this succeeds, ret_value should be 0. */
if((ret_value = H5Dvlen_reclaim(table->type_id, space_id, H5P_DEFAULT, buff)) < 0)
goto error;
/* If the dataspace cannot be closed, return -2 to indicate that memory */
/* was freed successfully but an error still occurred. */
if(H5Sclose(space_id) < 0)
return -2;
return ret_value;
error:
H5E_BEGIN_TRY
H5Sclose(space_id);
H5E_END_TRY
return FAIL;
} /* H5PTfree_vlen_buff */
/*-------------------------------------------------------------------------
*
* Accessor functions
*
*-------------------------------------------------------------------------
*/
/*-------------------------------------------------------------------------
* Function: H5PTget_dataset
*
* Purpose: Returns the backend dataset of this packet table
*
* Return: Success: SUCCEED, Failure: FAIL
*
* Programmer: User's patch 0003, HDFFV-8623. -BMR
*
* Date: Feb 10, 2016
*
* Comments:
*
* Modifications:
*
*
*-------------------------------------------------------------------------
*/
hid_t H5PTget_dataset(hid_t table_id)
{
htbl_t * table;
hid_t ret_value = H5I_INVALID_HID;
/* find the table struct from its ID */
if((table = (htbl_t *) H5Iobject_verify(table_id, H5PT_ptable_id_type)) == NULL)
goto error;
ret_value = table->dset_id;
error:
return ret_value;
}
/*-------------------------------------------------------------------------
* Function: H5PTget_type
*
* Purpose: Returns the backend type of this packet table
*
* Return: Success: datatype ID, Failure: H5I_INVALID_HID
*
* Programmer: User's patch 0003, HDFFV-8623. -BMR
*
* Date: Feb 10, 2016
*
* Comments:
*
* Modifications:
*
*
*-------------------------------------------------------------------------
*/
hid_t H5PTget_type( hid_t table_id)
{
htbl_t * table;
hid_t ret_value = H5I_INVALID_HID;
/* find the table struct from its ID */
if((table = (htbl_t *) H5Iobject_verify(table_id, H5PT_ptable_id_type)) == NULL)
goto error;
ret_value = table->type_id;
error:
return ret_value;
}
|