summaryrefslogtreecommitdiffstats
path: root/src/H5P.c
blob: 197e673ec3f2c3070dae1345e60102c7d831f664 (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
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
/****************************************************************************
* 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 <H5private.h>          /* Generic Functions                      */
#include <H5Aprivate.h>         /* Atom Functions                 */
#include <H5Eprivate.h>         /* Error handling                 */
#include <H5MMprivate.h>        /* Memory Management functions            */
#include <H5Oprivate.h>         /*object headers                  */
#include <H5Pprivate.h>         /* Data-space functions                   */


/* Interface initialization */
#define PABLO_MASK      H5P_mask
#define INTERFACE_INIT  H5P_init_interface
static intn             interface_initialize_g = FALSE;
static herr_t           H5P_init_interface(void);
static void             H5P_term_interface(void);

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

--------------------------------------------------------------------------*/
static herr_t
H5P_init_interface(void)
{
    herr_t                  ret_value = SUCCEED;
    FUNC_ENTER(H5P_init_interface, FAIL);

    /* Initialize the atom group for the file IDs */
    if ((ret_value = H5A_init_group(H5_DATASPACE, H5A_DATASPACEID_HASHSIZE,
				    H5P_RESERVED_ATOMS,
				    (herr_t (*)(void *)) H5P_close)) != FAIL) {
        ret_value = H5_add_exit(&H5P_term_interface);
    }
    FUNC_LEAVE(ret_value);
}


/*--------------------------------------------------------------------------
 NAME
    H5P_term_interface
 PURPOSE
    Terminate various H5P objects
 USAGE
    void H5P_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
H5P_term_interface(void)
{
    H5A_destroy_group(H5_DATASPACE);
}

/*-------------------------------------------------------------------------
 * Function:    H5Pcreate_simple
 *
 * Purpose:     Creates a new simple data space object and opens it for access.
 *
 * Return:      Success:        The ID for the new simple data space object.
 *
 *              Failure:        FAIL
 *
 * Errors:
 *
 * Programmer:  Quincey Koziol
 *              Tuesday, January  27, 1998
 *
 * Modifications:
 *
 *-------------------------------------------------------------------------
 */
hid_t
H5Pcreate_simple(intn rank, size_t dims[])
{
    H5P_t                  *ds = NULL;
    hid_t                   ret_value = FAIL;

    FUNC_ENTER(H5Pcreate, FAIL);
    H5ECLEAR;

    ds = H5MM_xcalloc(1, sizeof(H5P_t));
    ds->type = H5P_SIMPLE;

    /* Initialize rank and dimensions */
    ds->u.simple.rank = rank;
    ds->u.simple.dim_flags = 0; /* max & perm information is not valid/useful */
    ds->u.simple.size = H5MM_xcalloc(1, rank*sizeof(size_t));
    HDmemcpy(ds->u.simple.size, dims, rank*sizeof(size_t));
    ds->u.simple.max = H5MM_xcalloc(1, rank*sizeof(size_t));
    ds->u.simple.perm = H5MM_xcalloc(1, rank*sizeof(intn));

    /* Register the new data space and get an ID for it */
    if ((ret_value = H5A_register(H5_DATASPACE, ds)) < 0) {
        HGOTO_ERROR(H5E_ATOM, H5E_CANTREGISTER, FAIL,
                    "unable to register data space for ID");
    }
  done:
    if (ret_value < 0) {
        H5MM_xfree(ds);
    }
    FUNC_LEAVE(ret_value);
}

#ifdef OLD_WAY
/*-------------------------------------------------------------------------
 * Function:    H5Pcreate
 *
 * Purpose:     Creates a new data space object and opens it for access.
 *
 * Return:      Success:        The ID for the new data space object.
 *
 *              Failure:        FAIL
 *
 * Errors:
 *
 * Programmer:  Robb Matzke
 *              Tuesday, December  9, 1997
 *
 * Modifications:
 *
 *-------------------------------------------------------------------------
 */
hid_t
H5Pcreate(H5P_class_t type)
{
    H5P_t                  *ds = NULL;
    hid_t                   ret_value = FAIL;

    FUNC_ENTER(H5Pcreate, FAIL);
    H5ECLEAR;

    ds = H5MM_xcalloc(1, sizeof(H5P_t));
    ds->type = type;

    switch (type) {
    case H5P_SCALAR:
        /*void */
        break;

    case H5P_SIMPLE:
        ds->u.simple.rank = 0;
        break;

    case H5P_COMPLEX:
        HGOTO_ERROR(H5E_DATASPACE, H5E_UNSUPPORTED, FAIL,
                    "complex types are not supported yet");

    default:
        HGOTO_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL,
                    "unknown data space type");
    }

    /* Register the new data space and get an ID for it */
    if ((ret_value = H5A_register(H5_DATASPACE, ds)) < 0) {
        HGOTO_ERROR(H5E_ATOM, H5E_CANTREGISTER, FAIL,
                    "unable to register data space for ID");
    }
  done:
    if (ret_value < 0) {
        H5MM_xfree(ds);
    }
    FUNC_LEAVE(ret_value);
}
#endif /* OLD_WAY */

/*-------------------------------------------------------------------------
 * Function:    H5Pclose
 *
 * Purpose:     Release access to a data space object.
 *
 * Return:      Success:        SUCCEED
 *
 *              Failure:        FAIL
 *
 * Errors:
 *
 * Programmer:  Robb Matzke
 *              Tuesday, December  9, 1997
 *
 * Modifications:
 *
 *-------------------------------------------------------------------------
 */
herr_t
H5Pclose(hid_t space_id)
{
    FUNC_ENTER(H5Pclose, FAIL);
    H5ECLEAR;

    /* check args */
    if (H5_DATASPACE != H5A_group(space_id) ||
        NULL == H5A_object(space_id)) {
        HRETURN_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL, "not a data space");
    }
    /* When the reference count reaches zero the resources are freed */
    if (H5A_dec_ref(space_id) < 0) {
        HRETURN_ERROR(H5E_ATOM, H5E_BADATOM, FAIL, "problem freeing id");
    }
    FUNC_LEAVE(SUCCEED);
}

/*-------------------------------------------------------------------------
 * Function:    H5P_close
 *
 * Purpose:     Releases all memory associated with a data space.
 *
 * Return:      Success:        SUCCEED
 *
 *              Failure:        FAIL
 *
 * Programmer:  Robb Matzke
 *              Tuesday, December  9, 1997
 *
 * Modifications:
 *
 *-------------------------------------------------------------------------
 */
herr_t
H5P_close(H5P_t *ds)
{
    FUNC_ENTER(H5P_close, FAIL);

    assert(ds);

    switch (ds->type) {
    case H5P_SCALAR:
        /*void */
        break;

    case H5P_SIMPLE:
        H5MM_xfree(ds->u.simple.size);
        H5MM_xfree(ds->u.simple.max);
        H5MM_xfree(ds->u.simple.perm);
        break;

    case H5P_COMPLEX:
        /* nothing */
        break;

    default:
        assert("unknown data space type" && 0);
        break;
    }
    H5MM_xfree(ds);

    FUNC_LEAVE(SUCCEED);
}

/*-------------------------------------------------------------------------
 * Function:    H5P_copy
 *
 * Purpose:     Copies a data space.
 *
 * Return:      Success:        A pointer to a new copy of SRC
 *
 *              Failure:        NULL
 *
 * Programmer:  Robb Matzke
 *              Thursday, December  4, 1997
 *
 * Modifications:
 *
 *-------------------------------------------------------------------------
 */
H5P_t                  *
H5P_copy(const H5P_t *src)
{
    H5P_t                  *dst = NULL;
    int                     i;

    FUNC_ENTER(H5P_copy, NULL);

    dst = H5MM_xmalloc(sizeof(H5P_t));
    *dst = *src;

    switch (dst->type) {
    case H5P_SCALAR:
        /*void */
        break;

    case H5P_SIMPLE:
        if (dst->u.simple.size) {
            dst->u.simple.size = H5MM_xmalloc(dst->u.simple.rank *
                                              sizeof(dst->u.simple.size[0]));
            for (i = 0; i < dst->u.simple.rank; i++) {
                dst->u.simple.size[i] = src->u.simple.size[i];
            }
        }
        if (dst->u.simple.max) {
            dst->u.simple.max = H5MM_xmalloc(dst->u.simple.rank *
                                             sizeof(dst->u.simple.max[0]));
            for (i = 0; i < dst->u.simple.rank; i++) {
                dst->u.simple.max[i] = src->u.simple.max[i];
            }
        }
        if (dst->u.simple.perm) {
            dst->u.simple.perm = H5MM_xmalloc(dst->u.simple.rank *
                                              sizeof(dst->u.simple.perm[0]));
            for (i = 0; i < dst->u.simple.rank; i++) {
                dst->u.simple.perm[i] = src->u.simple.perm[i];
            }
        }
        break;

    case H5P_COMPLEX:
        /*void */
        break;

    default:
        assert("unknown data space type" && 0);
        break;
    }

    FUNC_LEAVE(dst);
}

/*-------------------------------------------------------------------------
 * Function:    H5Pget_npoints
 *
 * Purpose:     Determines how many data points a data set has.
 *
 * Return:      Success:        Number of data points in the data set.
 *
 *              Failure:        0
 *
 * Programmer:  Robb Matzke
 *              Tuesday, December  9, 1997
 *
 * Modifications:
 *
 *-------------------------------------------------------------------------
 */
size_t
H5Pget_npoints(hid_t space_id)
{
    H5P_t                  *ds = NULL;
    size_t                  ret_value = 0;

    FUNC_ENTER(H5Pget_npoints, 0);
    H5ECLEAR;

    /* check args */
    if (H5_DATASPACE != H5A_group(space_id) ||
        NULL == (ds = H5A_object(space_id))) {
        HRETURN_ERROR(H5E_ARGS, H5E_BADTYPE, 0, "not a data space");
    }
    ret_value = H5P_get_npoints(ds);

    FUNC_LEAVE(ret_value);
}

/*-------------------------------------------------------------------------
 * Function:    H5P_get_npoints
 *
 * Purpose:     Determines how many data points a data set has.
 *
 * Return:      Success:        Number of data points in the data set.
 *
 *              Failure:        0
 *
 * Programmer:  Robb Matzke
 *              Tuesday, December  9, 1997
 *
 * Modifications:
 *
 *-------------------------------------------------------------------------
 */
size_t
H5P_get_npoints(const H5P_t *ds)
{
    size_t                  ret_value = 0;
    intn                    i;

    FUNC_ENTER(H5P_get_npoints, 0);

    /* check args */
    assert(ds);

    switch (ds->type) {
    case H5P_SCALAR:
        ret_value = 1;
        break;

    case H5P_SIMPLE:
        for (ret_value = 1, i = 0; i < ds->u.simple.rank; i++) {
            ret_value *= ds->u.simple.size[i];
        }
        break;

    case H5P_COMPLEX:
        HRETURN_ERROR(H5E_DATASPACE, H5E_UNSUPPORTED, 0,
                      "complex data spaces are not supported yet");

    default:
        assert("unknown data space class" && 0);
        HRETURN_ERROR(H5E_DATASPACE, H5E_UNSUPPORTED, 0,
                      "internal error (unknown data space class)");
    }

    FUNC_LEAVE(ret_value);
}

/*-------------------------------------------------------------------------
 * Function:    H5Pget_ndims
 *
 * Purpose:     Determines the dimensionality of a data space.
 *
 * Return:      Success:        The number of dimensions in a data space.
 *
 *              Failure:        FAIL
 *
 * Programmer:  Robb Matzke
 *              Thursday, December 11, 1997
 *
 * Modifications:
 *
 *-------------------------------------------------------------------------
 */
intn
H5Pget_ndims(hid_t space_id)
{
    H5P_t                  *ds = NULL;
    size_t                  ret_value = 0;

    FUNC_ENTER(H5Pget_ndims, FAIL);
    H5ECLEAR;

    /* check args */
    if (H5_DATASPACE != H5A_group(space_id) ||
        NULL == (ds = H5A_object(space_id))) {
        HRETURN_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL, "not a data space");
    }
    ret_value = H5P_get_ndims(ds);

    FUNC_LEAVE(ret_value);
}

/*-------------------------------------------------------------------------
 * Function:    H5P_get_ndims
 *
 * Purpose:     Returns the number of dimensions in a data space.
 *
 * Return:      Success:        Non-negative number of dimensions.  Zero
 *                              implies a scalar.
 *
 *              Failure:        FAIL
 *
 * Programmer:  Robb Matzke
 *              Thursday, December 11, 1997
 *
 * Modifications:
 *
 *-------------------------------------------------------------------------
 */
intn
H5P_get_ndims(const H5P_t *ds)
{
    intn                    ret_value = FAIL;

    FUNC_ENTER(H5P_get_ndims, FAIL);

    /* check args */
    assert(ds);

    switch (ds->type) {
    case H5P_SCALAR:
        ret_value = 0;
        break;

    case H5P_SIMPLE:
        ret_value = ds->u.simple.rank;
        break;

    case H5P_COMPLEX:
        HRETURN_ERROR(H5E_DATASPACE, H5E_UNSUPPORTED, FAIL,
                      "complex data spaces are not supported yet");

    default:
        assert("unknown data space class" && 0);
        HRETURN_ERROR(H5E_DATASPACE, H5E_UNSUPPORTED, FAIL,
                      "internal error (unknown data space class)");
    }

    FUNC_LEAVE(ret_value);
}

/*-------------------------------------------------------------------------
 * Function:    H5Pget_dims
 *
 * Purpose:     Returns the size in each dimension of a data space DS through
 *              the DIMS argument.
 *
 * Return:      Success:        Number of dimensions, the same value as
 *                              returned by H5Pget_ndims().
 *
 *              Failure:        FAIL
 *
 * Programmer:  Robb Matzke
 *              Thursday, December 11, 1997
 *
 * Modifications:
 *
 *-------------------------------------------------------------------------
 */
intn
H5Pget_dims(hid_t space_id, size_t dims[] /*out */ )
{

    H5P_t                  *ds = NULL;
    size_t                  ret_value = 0;

    FUNC_ENTER(H5Pget_dims, FAIL);
    H5ECLEAR;

    /* check args */
    if (H5_DATASPACE != H5A_group(space_id) ||
        NULL == (ds = H5A_object(space_id))) {
        HRETURN_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL, "not a data space");
    }
    if (!dims) {
        HRETURN_ERROR(H5E_ARGS, H5E_BADVALUE, FAIL, "no output buffer");
    }
    ret_value = H5P_get_dims(ds, dims);

    FUNC_LEAVE(ret_value);
}

/*-------------------------------------------------------------------------
 * Function:    H5P_get_dims
 *
 * Purpose:     Returns the size in each dimension of a data space.  This
 *              function may not be meaningful for all types of data spaces.
 *
 * Return:      Success:        Number of dimensions.  Zero implies scalar.
 *
 *              Failure:        FAIL
 *
 * Programmer:  Robb Matzke
 *              Thursday, December 11, 1997
 *
 * Modifications:
 *
 *-------------------------------------------------------------------------
 */
intn
H5P_get_dims(const H5P_t *ds, size_t dims[])
{
    intn                    ret_value = FAIL;
    intn                    i;

    FUNC_ENTER(H5P_get_dims, FAIL);

    /* check args */
    assert(ds);
    assert(dims);

    switch (ds->type) {
    case H5P_SCALAR:
        ret_value = 0;
        break;

    case H5P_SIMPLE:
        ret_value = ds->u.simple.rank;
        for (i = 0; i < ret_value; i++) {
            dims[i] = ds->u.simple.size[i];
        }
        break;

    case H5P_COMPLEX:
        HRETURN_ERROR(H5E_DATASPACE, H5E_UNSUPPORTED, FAIL,
                      "complex data spaces are not supported yet");

    default:
        assert("unknown data space class" && 0);
        HRETURN_ERROR(H5E_DATASPACE, H5E_UNSUPPORTED, FAIL,
                      "internal error (unknown data space class)");
    }

    FUNC_LEAVE(ret_value);
}

/*-------------------------------------------------------------------------
 * Function:    H5P_modify
 *
 * Purpose:     Updates a data space by writing a message to an object
 *              header.
 *
 * Return:      Success:        SUCCEED
 *
 *              Failure:        FAIL
 *
 * Programmer:  Robb Matzke
 *              Tuesday, December  9, 1997
 *
 * Modifications:
 *
 *-------------------------------------------------------------------------
 */
herr_t
H5P_modify(H5F_t *f, H5G_entry_t *ent, const H5P_t *ds)
{
    FUNC_ENTER(H5O_modify, FAIL);

    assert(f);
    assert(ent);
    assert(ds);

    switch (ds->type) {
    case H5P_SCALAR:
        HRETURN_ERROR(H5E_DATASPACE, H5E_UNSUPPORTED, FAIL,
                      "scalar data spaces are not implemented yet");

    case H5P_SIMPLE:
        if (H5O_modify(ent, H5O_SDSPACE, 0, 0, &(ds->u.simple)) < 0) {
            HRETURN_ERROR(H5E_DATASPACE, H5E_CANTINIT, FAIL,
                          "can't update simple data space message");
        }
        break;

    case H5P_COMPLEX:
        HRETURN_ERROR(H5E_DATASPACE, H5E_UNSUPPORTED, FAIL,
                      "complex data spaces are not implemented yet");

    default:
        assert("unknown data space class" && 0);
        break;
    }

    FUNC_LEAVE(SUCCEED);
}

/*-------------------------------------------------------------------------
 * Function:    H5P_read
 *
 * Purpose:     Reads the data space from an object header.
 *
 * Return:      Success:        Pointer to a new data space.
 *
 *              Failure:        NULL
 *
 * Programmer:  Robb Matzke
 *              Tuesday, December  9, 1997
 *
 * Modifications:
 *
 *-------------------------------------------------------------------------
 */
H5P_t                  *
H5P_read(H5F_t *f, H5G_entry_t *ent)
{
    H5P_t                  *ds = NULL;

    FUNC_ENTER(H5P_read, NULL);

    /* check args */
    assert(f);
    assert(ent);

    ds = H5MM_xcalloc(1, sizeof(H5P_t));

    if (H5O_read(ent, H5O_SDSPACE, 0, &(ds->u.simple))) {
        ds->type = H5P_SIMPLE;

    } else {
        ds->type = H5P_SCALAR;
    }

    FUNC_LEAVE(ds);
}

/*-------------------------------------------------------------------------
 * Function:    H5P_cmp
 *
 * Purpose:     Compares two data spaces.
 *
 * Return:      Success:        0 if DS1 and DS2 are the same.
 *                              <0 if DS1 is less than DS2.
 *                              >0 if DS1 is greater than DS2.
 *
 *              Failure:        0, never fails
 *
 * Programmer:  Robb Matzke
 *              Wednesday, December 10, 1997
 *
 * Modifications:
 *
 *-------------------------------------------------------------------------
 */
intn
H5P_cmp(const H5P_t *ds1, const H5P_t *ds2)
{
    intn                    i;

    FUNC_ENTER(H5P_cmp, 0);

    /* check args */
    assert(ds1);
    assert(ds2);

    /* compare */
    if (ds1->type < ds2->type)
        HRETURN(-1);
    if (ds1->type > ds2->type)
        HRETURN(1);

    switch (ds1->type) {
    case H5P_SIMPLE:
        if (ds1->u.simple.rank < ds2->u.simple.rank)
            HRETURN(-1);
        if (ds1->u.simple.rank > ds2->u.simple.rank)
            HRETURN(1);

        /* don't compare flags */

        for (i = 0; i < ds1->u.simple.rank; i++) {
            if (ds1->u.simple.size[i] < ds2->u.simple.size[i])
                HRETURN(-1);
            if (ds1->u.simple.size[i] > ds2->u.simple.size[i])
                HRETURN(1);
        }

        /* don't compare max dimensions */

        for (i = 0; i < ds1->u.simple.rank; i++) {
            if ((ds1->u.simple.perm ? ds1->u.simple.perm[i] : i) <
                (ds2->u.simple.perm ? ds2->u.simple.perm[i] : i))
                HRETURN(-1);
            if ((ds1->u.simple.perm ? ds2->u.simple.perm[i] : i) >
                (ds2->u.simple.perm ? ds2->u.simple.perm[i] : i))
                HRETURN(1);
        }

        break;

    default:
        assert("not implemented yet" && 0);
    }

    FUNC_LEAVE(0);
}


/*--------------------------------------------------------------------------
 NAME
    H5P_is_simple
 PURPOSE
    Check if a dataspace is simple (internal)
 USAGE
    hbool_t H5P_is_simple(sdim)
        H5P_t *sdim;            IN: Pointer to dataspace object to query
 RETURNS
    BTRUE/BFALSE/BFAIL
 DESCRIPTION
        This function determines the if a dataspace is "simple". ie. if it
    has orthogonal, evenly spaced dimensions.
--------------------------------------------------------------------------*/
hbool_t
H5P_is_simple(const H5P_t *sdim)
{
    hbool_t                 ret_value = BFAIL;

    FUNC_ENTER(H5P_is_simple, UFAIL);

    /* Clear errors and check args and all the boring stuff. */
    H5ECLEAR;

    assert(sdim);
    ret_value = sdim->type == H5P_SIMPLE ? BTRUE : BFALSE;      /* Currently all dataspaces are simple, but check anyway */

    FUNC_LEAVE(ret_value);
}


/*--------------------------------------------------------------------------
 NAME
    H5Pis_simple
 PURPOSE
    Check if a dataspace is simple
 USAGE
    hbool_t H5Pis_simple(sid)
        hid_t sid;            IN: ID of dataspace object to query
 RETURNS
    BTRUE/BFALSE/BFAIL
 DESCRIPTION
        This function determines the if a dataspace is "simple". ie. if it
    has orthogonal, evenly spaced dimensions.
--------------------------------------------------------------------------*/
hbool_t 
H5Pis_simple(hid_t sid)
{
    H5P_t                  *space = NULL;       /* dataspace to modify */
    hbool_t                 ret_value = BFAIL;

    FUNC_ENTER(H5Pis_simple, BFAIL);

    /* Clear errors and check args and all the boring stuff. */
    H5ECLEAR;

    if ((space = H5A_object(sid)) == NULL)
        HGOTO_ERROR(H5E_ATOM, H5E_BADATOM, FAIL, "not a data space");

    ret_value = H5P_is_simple(space);

  done:
    if (ret_value == BFAIL) {   /* Error condition cleanup */

    }                           /* end if */
    /* Normal function cleanup */
    FUNC_LEAVE(ret_value);
}


/*--------------------------------------------------------------------------
 NAME
    H5Pset_space
 PURPOSE
    Determine the size of a dataspace
 USAGE
    herr_t H5Pset_space(sid, rank, dims)
        hid_t sid;            IN: Dataspace object to query
        intn rank;            IN: # of dimensions for the dataspace
        const size_t *dims;   IN: Size of each dimension for the dataspace
 RETURNS
    SUCCEED/FAIL
 DESCRIPTION
        This function sets the number and size of each dimension in the
    dataspace.  Setting RANK to a value of zero allows scalar objects to be
    created.  Dimensions are specified from slowest to fastest changing in the
    DIMS array (i.e. 'C' order).  Setting the size of a dimension to zero
    indicates that the dimension is of unlimited size and should be allowed to
    expand.  Currently, only the first dimension in the array (the slowest) may
    be unlimited in size.
--------------------------------------------------------------------------*/
herr_t
H5Pset_space(hid_t sid, intn rank, const size_t *dims)
{
    H5P_t                  *space = NULL;       /* dataspace to modify */
    intn                    u;  /* local counting variable */
    herr_t                  ret_value = SUCCEED;

    FUNC_ENTER(H5Pset_space, FAIL);

    /* Clear errors and check args and all the boring stuff. */
    H5ECLEAR;

    /* Get the object */
    if ((space = H5A_object(sid)) == NULL)
        HGOTO_ERROR(H5E_ATOM, H5E_BADATOM, FAIL, "not a data space");
    if (rank > 0 && dims == NULL)
        HGOTO_ERROR(H5E_ARGS, H5E_BADVALUE, FAIL, "invalid rank");

    /* shift out of the previous state to a "simple" dataspace */
    switch (space->type) {
    case H5P_SIMPLE:
        /* do nothing */
        break;

    case H5P_COMPLEX:
        /*
         * eventually this will destroy whatever "complex" dataspace info
         * is retained, right now it's an error
         */
        /* Fall through to report error */

    default:
        HGOTO_ERROR(H5E_DATASPACE, H5E_BADVALUE, FAIL,
                    "unknown data space class");
    }                           /* end switch */
    space->type = H5P_SIMPLE;

    if (rank == 0) {            /* scalar variable */
        space->u.simple.rank = 0;       /* set to scalar rank */
        space->u.simple.dim_flags = 0;  /* no maximum dimensions or dimension permutations */
        if (space->u.simple.size != NULL)
            space->u.simple.size = H5MM_xfree(space->u.simple.size);
        if (space->u.simple.max != NULL)
            space->u.simple.max = H5MM_xfree(space->u.simple.max);
        if (space->u.simple.perm != NULL)
            space->u.simple.max = H5MM_xfree(space->u.simple.perm);
    }
    /* end if */ 
    else {
        /* Reset the dataspace flags */
        space->u.simple.dim_flags = 0;

        /* Free the old space for now */
        if (space->u.simple.size != NULL)
            space->u.simple.size = H5MM_xfree(space->u.simple.size);
        if (space->u.simple.max != NULL)
            space->u.simple.max = H5MM_xfree(space->u.simple.max);
        if (space->u.simple.perm != NULL)
            space->u.simple.perm = H5MM_xfree(space->u.simple.perm);

        /* Set the rank and copy the dims */
        space->u.simple.rank = rank;
        space->u.simple.size = H5MM_xcalloc(rank, sizeof(size_t));
        HDmemcpy(space->u.simple.size, dims, sizeof(size_t) * rank);

        /* check if there are unlimited dimensions and create the maximum dims array */
        for (u = 0; u < rank; u++)
            if (dims[u] == 0) {
                if (u > 0)
                    HGOTO_ERROR(H5E_DATASPACE, H5E_UNSUPPORTED, FAIL,
                                "unlimited dimensions not in the lowest "
                                "dimensionality");
                space->u.simple.max = H5MM_xcalloc(rank, sizeof(size_t));
                HDmemcpy(space->u.simple.max, dims, sizeof(size_t) * rank);
                space->u.simple.dim_flags |= H5P_VALID_MAX;
                break;
            }                   /* end if */
    }                           /* end else */

  done:
    if (ret_value == FAIL) {    /* Error condition cleanup */

    }                           /* end if */
    /* Normal function cleanup */
    FUNC_LEAVE(ret_value);
}


/*-------------------------------------------------------------------------
 * Function:	H5P_find
 *
 * Purpose:	Given two data spaces (MEM_SPACE and FILE_SPACE) this
 *		function locates the data space conversion functions and
 *		initializes CONV to point to them.  The CONV contains
 *		function pointers for converting in either direction.
 *
 * Return:	Success:	Pointer to a data space conversion callback
 *				list.
 *
 *		Failure:	NULL
 *
 * Programmer:	Robb Matzke
 *              Wednesday, January 21, 1998
 *
 * Modifications:
 *
 *-------------------------------------------------------------------------
 */
const H5P_conv_t *
H5P_find (const H5P_t *mem_space, const H5P_t *file_space)
{
    static H5P_conv_t		_conv;
    static const H5P_conv_t 	*conv = NULL;
    
    FUNC_ENTER (H5P_find, NULL);

    /* Check args */
    assert (mem_space && H5P_SIMPLE==mem_space->type);
    assert (file_space && H5P_SIMPLE==file_space->type);

    /*
     * We can't do conversion if the source and destination select a
     * different number of data points.
     */
    if (H5P_get_npoints (mem_space) != H5P_get_npoints (file_space)) {
	HRETURN_ERROR (H5E_DATASPACE, H5E_BADRANGE, NULL,
		       "memory and file data spaces are different sizes");
    }

    /*
     * Initialize pointers.  This will eventually be a table lookup based
     * on the source and destination data spaces, similar to H5T_find(), but
     * for now we only support simple data spaces.
     */
    if (!conv) {
	_conv.init = H5P_simp_init;
	_conv.fgath = H5P_simp_fgath;
	_conv.mscat = H5P_simp_mscat;
	_conv.mgath = H5P_simp_mgath;
	_conv.fscat = H5P_simp_fscat;
	conv = &_conv;
    }
    
    FUNC_LEAVE (conv);
}