summaryrefslogtreecommitdiffstats
path: root/src/H5C.c
blob: dde84116d1a9f85c234ecc449c6e86137d8ac5c5 (plain)
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
/****************************************************************************
* NCSA HDF                                                                 *
* Software Development Group                                               *
* National Center for Supercomputing Applications                          *
* University of Illinois at Urbana-Champaign                               *
* 605 E. Springfield, Champaign IL 61820                                   *
*                                                                          *
* For conditions of distribution and use, see the accompanying             *
* hdf/COPYING file.                                                        *
*                                                                          *
****************************************************************************/

#ifdef RCSID
static char             RcsId[] = "@(#)$Revision$";
#endif

/* $Id$ */

#include <stdarg.h>

/* Private header files */
#include <H5private.h>          /* Generic Functions                      */
#include <H5Aprivate.h>         /* Atoms                          */
#include <H5Bprivate.h>         /* B-tree subclass names          */
#include <H5Cprivate.h>         /* Template information           */
#include <H5Dprivate.h>         /* Datasets                               */
#include <H5Eprivate.h>         /* Error handling                 */
#include <H5MMprivate.h>        /* Memory management                      */

#define PABLO_MASK      H5C_mask

/* Is the interface initialized? */
static hbool_t          interface_initialize_g = FALSE;
#define INTERFACE_INIT H5C_init_interface
static herr_t           H5C_init_interface(void);

/* PRIVATE PROTOTYPES */
static void             H5C_term_interface(void);

/*--------------------------------------------------------------------------
NAME
   H5C_init_interface -- Initialize interface-specific information
USAGE
    herr_t H5C_init_interface()
   
RETURNS
   SUCCEED/FAIL
DESCRIPTION
    Initializes any interface-specific data or routines.

--------------------------------------------------------------------------*/
static herr_t
H5C_init_interface(void)
{
    herr_t                  ret_value = SUCCEED;
    intn                    i;
    herr_t                  status;

    FUNC_ENTER(H5C_init_interface, FAIL);

    assert(H5C_NCLASSES <= H5_TEMPLATE_MAX - H5_TEMPLATE_0);

    /*
     * Initialize the mappings between template classes and atom groups. We
     * keep the two separate because template classes are publicly visible but
     * atom groups aren't.
     */
    for (i = 0; i < H5C_NCLASSES; i++) {
        status = H5A_init_group((group_t)(H5_TEMPLATE_0 +i), H5A_TEMPID_HASHSIZE, 0, NULL);
        if (status < 0)
            ret_value = FAIL;
    }
    if (ret_value < 0) {
        HRETURN_ERROR(H5E_ATOM, H5E_CANTINIT, FAIL,
                      "unable to initialize atom group");
    }
    /*
     * Register cleanup function.
     */
    if (H5_add_exit(H5C_term_interface) < 0) {
        HRETURN_ERROR(H5E_INTERNAL, H5E_CANTINIT, FAIL,
                      "unable to install atexit function");
    }
    FUNC_LEAVE(ret_value);
}

/*--------------------------------------------------------------------------
 NAME
    H5C_term_interface
 PURPOSE
    Terminate various H5C objects
 USAGE
    void H5C_term_interface()
 RETURNS
    SUCCEED/FAIL
 DESCRIPTION
    Release the atom group and any other resources allocated.
 GLOBAL VARIABLES
 COMMENTS, BUGS, ASSUMPTIONS
     Can't report errors...
 EXAMPLES
 REVISION LOG
--------------------------------------------------------------------------*/
static void
H5C_term_interface(void)
{
    intn                    i;

    for (i = 0; i < H5C_NCLASSES; i++) {
        H5A_destroy_group((group_t)(H5_TEMPLATE_0 + i));
    }
}

/*--------------------------------------------------------------------------
 NAME
    H5Ccreate
 PURPOSE
    Returns a copy of the default template for some class of templates.
 USAGE
    herr_t H5Ccreate (type)
        H5C_class_t type;       IN: Template class whose default is desired.
 RETURNS
    Template ID or FAIL
 
 ERRORS
    ARGS      BADVALUE      Unknown template class. 
    ATOM      CANTINIT      Can't register template. 
    INTERNAL  UNSUPPORTED   Not implemented yet. 

 DESCRIPTION
    Returns a copy of the default template for some class of templates.
--------------------------------------------------------------------------*/
hid_t
H5Ccreate(H5C_class_t type)
{
    hid_t                   ret_value = FAIL;
    void                   *tmpl = NULL;

    FUNC_ENTER(H5Ccreate, FAIL);

    /* Allocate a new template and initialize it with default values */
    switch (type) {
    case H5C_FILE_CREATE:
        tmpl = H5MM_xmalloc(sizeof(H5F_create_t));
        memcpy(tmpl, &H5F_create_dflt, sizeof(H5F_create_t));
        break;

    case H5C_FILE_ACCESS:
        HRETURN_ERROR(H5E_INTERNAL, H5E_UNSUPPORTED, FAIL,
                      "not implemented yet");

    case H5C_DATASET_CREATE:
        tmpl = H5MM_xmalloc(sizeof(H5D_create_t));
        memcpy(tmpl, &H5D_create_dflt, sizeof(H5D_create_t));
        break;

    case H5C_DATASET_XFER:
        tmpl = H5MM_xmalloc(sizeof(H5D_xfer_t));
        memcpy(tmpl, &H5D_xfer_dflt, sizeof(H5D_xfer_t));
        break;

    default:
        HRETURN_ERROR(H5E_ARGS, H5E_BADVALUE, FAIL,
                      "unknown template class");
    }

    /* Atomize the new template */
    if ((ret_value = H5C_create(type, tmpl)) < 0) {
        HRETURN_ERROR(H5E_ATOM, H5E_CANTINIT, FAIL,
                      "can't register template");
    }
    FUNC_LEAVE(ret_value);
}

/*-------------------------------------------------------------------------
 * Function:    H5C_create
 *
 * Purpose:     Given a pointer to some template struct, atomize the template
 *              and return its ID. The template memory is not copied, so the
 *              caller should not free it; it will be freed by H5C_release().
 *
 * Return:      Success:        A new template ID.
 *
 *              Failure:        FAIL
 *
 * Programmer:  Robb Matzke
 *              Wednesday, December  3, 1997
 *
 * Modifications:
 *
 *-------------------------------------------------------------------------
 */
hid_t
H5C_create(H5C_class_t type, void *tmpl)
{
    hid_t                   ret_value = FAIL;

    FUNC_ENTER(H5C_create, FAIL);

    /* check args */
    assert(type >= 0 && type < H5C_NCLASSES);
    assert(tmpl);

    /* Atomize the new template */
    if ((ret_value = H5A_register((group_t)(H5_TEMPLATE_0 + type), tmpl)) < 0) {
        HRETURN_ERROR(H5E_ATOM, H5E_CANTINIT, FAIL,
                      "can't register template");
    }
    FUNC_LEAVE(ret_value);
}

/*--------------------------------------------------------------------------
 NAME
    H5Cclose
 PURPOSE
    Release access to a template object.
 USAGE
    herr_t H5Cclose(oid)
        hid_t oid;       IN: Template object to release access to
 RETURNS
    SUCCEED/FAIL
 DESCRIPTION
        This function releases access to a template object
--------------------------------------------------------------------------*/
herr_t
H5Cclose(hid_t tid)
{
    void                   *tmpl = NULL;

    FUNC_ENTER(H5Cclose, FAIL);

    /* Chuck the object! :-) */
    if (NULL == (tmpl = H5A_remove(tid))) {
        HRETURN_ERROR(H5E_ATOM, H5E_BADATOM, FAIL, "unable to remove atom");
    }
    H5MM_xfree(tmpl);

    FUNC_LEAVE(SUCCEED);
}

/*-------------------------------------------------------------------------
 * Function:    H5Cget_class
 *
 * Purpose:     Returns the class identifier for a template.
 *
 * Return:      Success:        A template class
 *
 *              Failure:        H5C_NO_CLASS (-1)
 *
 * Programmer:  Robb Matzke
 *              Wednesday, December  3, 1997
 *
 * Modifications:
 *
 *-------------------------------------------------------------------------
 */
H5C_class_t
H5Cget_class(hid_t tid)
{
    group_t                 group;
    H5C_class_t             ret_value = H5C_NO_CLASS;

    FUNC_ENTER(H5Cget_class, H5C_NO_CLASS);

    if ((group = H5A_group(tid)) < 0 ||
#ifndef NDEBUG
        group >= H5_TEMPLATE_MAX ||
#endif
        group < H5_TEMPLATE_0) {
        HRETURN_ERROR(H5E_ATOM, H5E_BADATOM, H5C_NO_CLASS, "not a template");
    }
    ret_value = (H5C_class_t)(group - H5_TEMPLATE_0);
    FUNC_LEAVE(ret_value);
}

/*-------------------------------------------------------------------------
 * Function:    H5Cget_version
 *
 * Purpose:     Retrieves version information for various parts of a file.
 *
 *              BOOT:           The file boot block.
 *              HEAP:           The global heap.
 *              FREELIST:       The global free list.
 *              STAB:           The root symbol table entry.
 *              SHHDR:          Shared object headers.
 *
 *              Any (or even all) of the output arguments can be null
 *              pointers.
 *
 * Return:      Success:        SUCCEED, version information is returned
 *                              through the arguments.
 *
 *              Failure:        FAIL
 *
 * Programmer:  Robb Matzke
 *              Wednesday, January  7, 1998
 *
 * Modifications:
 *
 *-------------------------------------------------------------------------
 */
herr_t
H5Cget_version(hid_t tid, int *boot /*out */ , int *heap /*out */ ,
         int *freelist /*out */ , int *stab /*out */ , int *shhdr /*out */ )
{
    H5F_create_t           *tmpl = NULL;

    FUNC_ENTER(H5Cget_version, FAIL);

    /* Check arguments */
    if (H5C_FILE_CREATE != H5Cget_class(tid) ||
        NULL == (tmpl = H5A_object(tid))) {
        HRETURN_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL,
                      "not a file creation template");
    }
    /* Get values */
    if (boot)
        *boot = tmpl->bootblock_ver;
    if (heap)
        *heap = tmpl->smallobject_ver;
    if (freelist)
        *freelist = tmpl->freespace_ver;
    if (stab)
        *stab = tmpl->objectdir_ver;
    if (shhdr)
        *shhdr = tmpl->sharedheader_ver;

    FUNC_LEAVE(SUCCEED);
}

/*-------------------------------------------------------------------------
 * Function:    H5Cset_userblock
 *
 * Purpose:     Sets the userblock size field of a file creation template.
 *
 * Return:      Success:        SUCCEED
 *
 *              Failure:        FAIL
 *
 * Programmer:  Robb Matzke
 *              Tuesday, January  6, 1998
 *
 * Modifications:
 *
 *-------------------------------------------------------------------------
 */
herr_t
H5Cset_userblock(hid_t tid, size_t size)
{
    intn                    i;
    H5F_create_t           *tmpl = NULL;

    FUNC_ENTER(H5Cset_userblock, FAIL);

    /* Check arguments */
    if (H5C_FILE_CREATE != H5Cget_class(tid) ||
        NULL == (tmpl = H5A_object(tid))) {
        HRETURN_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL,
                      "not a file creation template");
    }
    for (i = 8; i < 8 * sizeof(int); i++) {
        uintn                   p2 = 8 == i ? 0 : 1 << i;
        if (size == p2)
            break;
    }
    if (i >= 8 * sizeof(int)) {
        HRETURN_ERROR(H5E_ARGS, H5E_BADVALUE, FAIL,
                      "userblock size is not valid");
    }
    /* Set value */
    tmpl->userblock_size = size;

    FUNC_LEAVE(SUCCEED);
}

/*-------------------------------------------------------------------------
 * Function:    H5Cget_userblock
 *
 * Purpose:     Queries the size of a user block in a file creation template.
 *
 * Return:      Success:        SUCCEED, size returned through SIZE argument.
 *
 *              Failure:        FAIL
 *
 * Programmer:  Robb Matzke
 *              Wednesday, January  7, 1998
 *
 * Modifications:
 *
 *-------------------------------------------------------------------------
 */
herr_t
H5Cget_userblock(hid_t tid, size_t *size)
{
    H5F_create_t           *tmpl = NULL;

    FUNC_ENTER(H5Cget_userblock, FAIL);

    /* Check args */
    if (H5C_FILE_CREATE != H5Cget_class(tid) ||
        NULL == (tmpl = H5A_object(tid))) {
        HRETURN_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL,
                      "not a file creation template");
    }
    /* Get value */
    if (size)
        *size = tmpl->userblock_size;

    FUNC_LEAVE(SUCCEED);
}

/*-------------------------------------------------------------------------
 * Function:    H5Cset_sizes
 *
 * Purpose:     Sets file size-of addresses and sizes.  TEMPLATE
 *              should be a file creation template.  A value of zero causes
 *              the property to not change.
 *
 * Return:      Success:        SUCCEED
 *
 *              Failure:        FAIL
 *
 * Programmer:  Robb Matzke
 *              Tuesday, January  6, 1998
 *
 * Modifications:
 *
 *-------------------------------------------------------------------------
 */
herr_t
H5Cset_sizes(hid_t tid, size_t sizeof_addr, size_t sizeof_size)
{
    H5F_create_t           *tmpl = NULL;

    FUNC_ENTER(H5Cset_sizeof_addr, FAIL);

    /* Check arguments */
    if (H5C_FILE_CREATE != H5Cget_class(tid) ||
        NULL == (tmpl = H5A_object(tid))) {
        HRETURN_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL,
                      "not a file creation template");
    }
    if (sizeof_addr) {
        if (sizeof_addr != 2 && sizeof_addr != 4 &&
            sizeof_addr != 8 && sizeof_addr != 16) {
            HRETURN_ERROR(H5E_ARGS, H5E_BADVALUE, FAIL,
                          "file haddr_t size is not valid");
        }
    }
    if (sizeof_size) {
        if (sizeof_size != 2 && sizeof_size != 4 &&
            sizeof_size != 8 && sizeof_size != 16) {
            HRETURN_ERROR(H5E_ARGS, H5E_BADVALUE, FAIL,
                          "file size_t size is not valid");
        }
    }
    /* Set value */
    if (sizeof_addr)
        tmpl->sizeof_addr = sizeof_addr;
    if (sizeof_size)
        tmpl->sizeof_size = sizeof_size;

    FUNC_LEAVE(SUCCEED);
}

/*-------------------------------------------------------------------------
 * Function:    H5Cget_sizes
 *
 * Purpose:     Returns the size of address and size quantities stored in a
 *              file according to a file creation template.  Either (or even
 *              both) SIZEOF_ADDR and SIZEOF_SIZE may be null pointers.
 *
 * Return:      Success:        SUCCEED, sizes returned through arguments.
 *
 *              Failure:        FAIL
 *
 * Programmer:  Robb Matzke
 *              Wednesday, January  7, 1998
 *
 * Modifications:
 *
 *-------------------------------------------------------------------------
 */
herr_t
H5Cget_sizes(hid_t tid,
             size_t *sizeof_addr /*out */ , size_t *sizeof_size /*out */ )
{
    H5F_create_t           *tmpl = NULL;

    FUNC_ENTER(H5Cget_sizes, FAIL);

    /* Check args */
    if (H5C_FILE_CREATE != H5Cget_class(tid) ||
        NULL == (tmpl = H5A_object(tid))) {
        HRETURN_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL,
                      "not a file creation template");
    }
    /* Get values */
    if (sizeof_addr)
        *sizeof_addr = tmpl->sizeof_addr;
    if (sizeof_size)
        *sizeof_size = tmpl->sizeof_size;

    FUNC_LEAVE(SUCCEED);
}

/*-------------------------------------------------------------------------
 * Function:    H5Cset_sym_k
 *
 * Purpose:     IK is one half the rank of a tree that stores a symbol
 *              table for a group.  Internal nodes of the symbol table are on
 *              average 75% full.  That is, the average rank of the tree is
 *              1.5 times the value of IK.
 *
 *              LK is one half of the number of symbols that can be stored in
 *              a symbol table node.  A symbol table node is the leaf of a
 *              symbol table tree which is used to store a group.  When
 *              symbols are inserted randomly into a group, the group's
 *              symbol table nodes are 75% full on average.  That is, they
 *              contain 1.5 times the number of symbols specified by LK.
 *
 *              Either (or even both) of IK and LK can be zero in which case
 *              that value is left unchanged.
 *
 * Return:      Success:        SUCCEED
 *
 *              Failure:        FAIL
 *
 * Programmer:  Robb Matzke
 *              Tuesday, January  6, 1998
 *
 * Modifications:
 *
 *-------------------------------------------------------------------------
 */
herr_t
H5Cset_sym_k(hid_t tid, int ik, int lk)
{
    H5F_create_t           *tmpl = NULL;

    FUNC_ENTER(H5Cset_sym_k, FAIL);

    /* Check arguments */
    if (H5C_FILE_CREATE != H5Cget_class(tid) ||
        NULL == (tmpl = H5A_object(tid))) {
        HRETURN_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL,
                      "not a file creation template");
    }
    /* Set values */
    if (ik > 0) {
        tmpl->btree_k[H5B_SNODE_ID] = ik;
    }
    if (lk > 0) {
        tmpl->sym_leaf_k = lk;
    }
    FUNC_LEAVE(SUCCEED);
}

/*-------------------------------------------------------------------------
 * Function:    H5Cget_sym_k
 *
 * Purpose:     Retrieves the symbol table B-tree 1/2 rank (IK) and the
 *              symbol table leaf node 1/2 size (LK).  See H5Cset_sym_k() for
 *              details. Either (or even both) IK and LK may be null
 *              pointers.
 *
 * Return:      Success:        SUCCEED
 *
 *              Failure:        FAIL
 *
 * Programmer:  Robb Matzke
 *              Wednesday, January  7, 1998
 *
 * Modifications:
 *
 *-------------------------------------------------------------------------
 */
herr_t
H5Cget_sym_k(hid_t tid, int *ik /*out */ , int *lk /*out */ )
{
    H5F_create_t           *tmpl = NULL;

    FUNC_ENTER(H5Cget_sym_k, FAIL);

    /* Check arguments */
    if (H5C_FILE_CREATE != H5Cget_class(tid) ||
        NULL == (tmpl = H5A_object(tid))) {
        HRETURN_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL,
                      "not a file creation template");
    }
    /* Get values */
    if (ik)
        *ik = tmpl->btree_k[H5B_SNODE_ID];
    if (lk)
        *lk = tmpl->sym_leaf_k;

    FUNC_LEAVE(SUCCEED);
}

/*-------------------------------------------------------------------------
 * Function:    H5Cset_istore_k
 *
 * Purpose:     IK is one half the rank of a tree that stores chunked raw
 *              data.  On average, such a tree will be 75% full, or have an
 *              average rank of 1.5 times the value of IK.
 *
 * Return:      Success:        SUCCEED
 *
 *              Failure:        FAIL
 *
 * Programmer:  Robb Matzke
 *              Tuesday, January  6, 1998
 *
 * Modifications:
 *
 *-------------------------------------------------------------------------
 */
herr_t
H5Cset_istore_k(hid_t tid, int ik)
{
    H5F_create_t           *tmpl = NULL;

    FUNC_ENTER(H5Cset_istore_k, FAIL);

    /* Check arguments */
    if (H5C_FILE_CREATE != H5Cget_class(tid) ||
        NULL == (tmpl = H5A_object(tid))) {
        HRETURN_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL,
                      "not a file creation template");
    }
    if (ik <= 0) {
        HRETURN_ERROR(H5E_ARGS, H5E_BADVALUE, FAIL,
                      "istore IK value must be positive");
    }
    /* Set value */
    tmpl->btree_k[H5B_ISTORE_ID] = ik;

    FUNC_LEAVE(SUCCEED);
}

/*-------------------------------------------------------------------------
 * Function:    H5Cget_istore_k
 *
 * Purpose:     Queries the 1/2 rank of an indexed storage B-tree.  See
 *              H5Cset_istore_k() for details.  The argument IK may be the
 *              null pointer.
 *
 * Return:      Success:        SUCCEED, size returned through IK
 *
 *              Failure:        
 *
 * Programmer:  Robb Matzke
 *              Wednesday, January  7, 1998
 *
 * Modifications:
 *
 *-------------------------------------------------------------------------
 */
herr_t
H5Cget_istore_k(hid_t tid, int *ik /*out */ )
{
    H5F_create_t           *tmpl = NULL;

    FUNC_ENTER(H5Cget_istore_k, FAIL);

    /* Check arguments */
    if (H5C_FILE_CREATE != H5Cget_class(tid) ||
        NULL == (tmpl = H5A_object(tid))) {
        HRETURN_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL,
                      "not a file creation template");
    }
    /* Get value */
    if (ik)
        *ik = tmpl->btree_k[H5B_ISTORE_ID];

    FUNC_LEAVE(SUCCEED);
}

/*-------------------------------------------------------------------------
 * Function:    H5Cset_layout
 *
 * Purpose:     Sets the layout of raw data in the file.
 *
 * Return:      Success:        SUCCEED
 *
 *              Failure:        FAIL
 *
 * Programmer:  Robb Matzke
 *              Tuesday, January  6, 1998
 *
 * Modifications:
 *
 *-------------------------------------------------------------------------
 */
herr_t
H5Cset_layout(hid_t tid, H5D_layout_t layout)
{
    H5D_create_t           *tmpl = NULL;

    FUNC_ENTER(H5Cset_layout, FAIL);

    /* Check arguments */
    if (H5C_DATASET_CREATE != H5Cget_class(tid) ||
        NULL == (tmpl = H5A_object(tid))) {
        HRETURN_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL,
                      "not a dataset creation template");
    }
    if (layout < 0 || layout >= H5D_NLAYOUTS) {
        HRETURN_ERROR(H5E_ARGS, H5E_BADRANGE, FAIL,
                      "raw data layout method is not valid");
    }
    /* Set value */
    tmpl->layout = layout;

    FUNC_LEAVE(SUCCEED);
}

/*-------------------------------------------------------------------------
 * Function:    H5Cget_layout
 *
 * Purpose:     Retrieves layout type of a dataset creation template.
 *
 * Return:      Success:        The layout type
 *
 *              Failure:        H5D_LAYOUT_ERROR (-1, same as FAIL)
 *
 * Programmer:  Robb Matzke
 *              Wednesday, January  7, 1998
 *
 * Modifications:
 *
 *-------------------------------------------------------------------------
 */
H5D_layout_t
H5Cget_layout(hid_t tid)
{
    H5D_create_t           *tmpl = NULL;

    FUNC_ENTER(H5Cget_layout, H5D_LAYOUT_ERROR);

    /* Check arguments */
    if (H5C_DATASET_CREATE != H5Cget_class(tid) ||
        NULL == (tmpl = H5A_object(tid))) {
        HRETURN_ERROR(H5E_ARGS, H5E_BADTYPE, H5D_LAYOUT_ERROR,
                      "not a dataset creation template");
    }
    FUNC_LEAVE(tmpl->layout);
}

/*-------------------------------------------------------------------------
 * Function:    H5Cset_chunk
 *
 * Purpose:     Sets the number of dimensions and the size of each chunk to
 *              the values specified.  The dimensionality of the chunk should
 *              match the dimensionality of the data space.
 *
 *              As a side effect, the layout method is changed to
 *              H5D_CHUNKED.
 *
 * Return:      Success:        SUCCEED
 *
 *              Failure:        FAIL
 *
 * Programmer:  Robb Matzke
 *              Tuesday, January  6, 1998
 *
 * Modifications:
 *
 *-------------------------------------------------------------------------
 */
herr_t
H5Cset_chunk(hid_t tid, int ndims, const size_t dim[])
{
    int                     i;
    H5D_create_t           *tmpl = NULL;

    FUNC_ENTER(H5Cset_chunk, FAIL);

    /* Check arguments */
    if (H5C_DATASET_CREATE != H5Cget_class(tid) ||
        NULL == (tmpl = H5A_object(tid))) {
        HRETURN_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL,
                      "not a dataset creation template");
    }
    if (ndims <= 0) {
        HRETURN_ERROR(H5E_ARGS, H5E_BADRANGE, FAIL,
                      "chunk dimensionality must be positive");
    }
    if (ndims > NELMTS(tmpl->chunk_size)) {
        HRETURN_ERROR(H5E_ARGS, H5E_BADRANGE, FAIL,
                      "chunk dimensionality is too large");
    }
    if (!dim) {
        HRETURN_ERROR(H5E_ARGS, H5E_BADVALUE, FAIL,
                      "no chunk dimensions specified");
    }
    for (i = 0; i < ndims; i++) {
        if (dim[i] <= 0) {
            HRETURN_ERROR(H5E_ARGS, H5E_BADRANGE, FAIL,
                          "all chunk dimensions must be positive");
        }
    }

    /* Set value */
    tmpl->layout = H5D_CHUNKED;
    tmpl->chunk_ndims = ndims;
    for (i = 0; i < ndims; i++)
        tmpl->chunk_size[i] = dim[i];

    FUNC_LEAVE(SUCCEED);
}

/*-------------------------------------------------------------------------
 * Function:    H5Cget_chunk
 *
 * Purpose:     Retrieves the chunk size of chunked layout.  The chunk
 *              dimensionality is returned and the chunk size in each
 *              dimension is returned through the DIM argument.  At most
 *              MAX_NDIMS elements of DIM will be initialized.
 *
 * Return:      Success:        Positive Chunk dimensionality.
 *
 *              Failure:        FAIL
 *
 * Programmer:  Robb Matzke
 *              Wednesday, January  7, 1998
 *
 * Modifications:
 *
 *-------------------------------------------------------------------------
 */
int
H5Cget_chunk(hid_t tid, int max_ndims, size_t dim[] /*out */ )
{
    int                     i;
    H5D_create_t           *tmpl = NULL;

    FUNC_ENTER(H5Cget_chunk, FAIL);

    /* Check arguments */
    if (H5C_DATASET_CREATE != H5Cget_class(tid) ||
        NULL == (tmpl = H5A_object(tid))) {
        HRETURN_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL,
                      "not a dataset creation template");
    }
    if (H5D_CHUNKED != tmpl->layout) {
        HRETURN_ERROR(H5E_ARGS, H5E_BADVALUE, FAIL,
                      "not a chunked storage layout");
    }
    for (i = 0; i < tmpl->chunk_ndims && i < max_ndims && dim; i++) {
        dim[i] = tmpl->chunk_size[i];
    }

    FUNC_LEAVE(tmpl->chunk_ndims);
}

/*--------------------------------------------------------------------------
 NAME
    H5Ccopy
 PURPOSE
    Copy a template
 USAGE
    hid_t H5C_copy(tid)
        hid_t tid;        IN: Template object to copy
 RETURNS
    Returns template ID (atom) on success, FAIL on failure

 ERRORS
    ARGS      BADRANGE      Unknown template class. 
    ATOM      BADATOM       Can't unatomize template. 
    ATOM      CANTREGISTER  Register the atom for the new template. 
    INTERNAL  UNSUPPORTED   Dataset transfer properties are not implemented
                            yet. 
    INTERNAL  UNSUPPORTED   File access properties are not implemented yet. 

 DESCRIPTION
    This function creates a new copy of a template with all the same parameter
    settings.
--------------------------------------------------------------------------*/
hid_t
H5Ccopy(hid_t tid)
{
    const void             *tmpl = NULL;
    void                   *new_tmpl = NULL;
    H5C_class_t             type;
    size_t                  size;
    hid_t                   ret_value = FAIL;
    group_t                 group;

    FUNC_ENTER(H5Ccopy, FAIL);

    /* Check args */
    if (NULL == (tmpl = H5A_object(tid)) ||
        (type = H5Cget_class(tid)) < 0 ||
        (group = H5A_group(tid)) < 0) {
        HRETURN_ERROR(H5E_ATOM, H5E_BADATOM, FAIL,
                      "can't unatomize template");
    }
    /* How big is the template */
    switch (type) {
    case H5C_FILE_CREATE:
        size = sizeof(H5F_create_t);
        break;

    case H5C_FILE_ACCESS:
        HRETURN_ERROR(H5E_INTERNAL, H5E_UNSUPPORTED, FAIL,
                      "file access properties are not implemented yet");

    case H5C_DATASET_CREATE:
        size = sizeof(H5D_create_t);
        break;

    case H5C_DATASET_XFER:
        size = sizeof(H5D_xfer_t);
        break;

    default:
        HRETURN_ERROR(H5E_ARGS, H5E_BADRANGE, FAIL,
                      "unknown template class");
    }

    /* Create the new template */
    new_tmpl = H5MM_xmalloc(size);
    HDmemcpy(new_tmpl, tmpl, size);

    /* Register the atom for the new template */
    if ((ret_value = H5A_register(group, new_tmpl)) < 0) {
        HRETURN_ERROR(H5E_ATOM, H5E_CANTREGISTER, FAIL,
                      "unable to atomize template pointer");
    }
    FUNC_LEAVE(ret_value);
}