summaryrefslogtreecommitdiffstats
path: root/src/H5Odtype.c
blob: fe30d007a9972ce1025cb891aba96c71ff879fb8 (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
/****************************************************************************
* 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$ */

#define H5T_PACKAGE             /*prevent warning from including H5Tpkg.h */

#include <H5private.h>
#include <H5Eprivate.h>
#include <H5Gprivate.h>
#include <H5MMprivate.h>
#include <H5Oprivate.h>
#include <H5Tpkg.h>

#define PABLO_MASK      H5O_dtype_mask

/* PRIVATE PROTOTYPES */
static herr_t           H5O_dtype_encode(H5F_t *f, size_t raw_size, uint8 *p,
                                         const void *mesg);
static void            *H5O_dtype_decode(H5F_t *f, size_t raw_size, const uint8 *p);
static void            *H5O_dtype_copy(const void *_mesg, void *_dest);
static size_t           H5O_dtype_size(H5F_t *f, const void *_mesg);
static herr_t           H5O_dtype_reset(void *_mesg);
static herr_t           H5O_dtype_debug(H5F_t *f, const void *_mesg,
                                   FILE * stream, intn indent, intn fwidth);

/* This message derives from H5O */
const H5O_class_t       H5O_DTYPE[1] =
{
    {
        H5O_DTYPE_ID,           /* message id number            */
        "data_type",            /* message name for debugging   */
        sizeof(H5T_t),          /* native message size          */
        H5O_dtype_decode,       /* decode message               */
        H5O_dtype_encode,       /* encode message               */
        H5O_dtype_copy,         /* copy the native value        */
        H5O_dtype_size,         /* size of raw message          */
        H5O_dtype_reset,        /* reset method                 */
        H5O_dtype_debug,        /* debug the message            */
    }};

/* Interface initialization */
static hbool_t          interface_initialize_g = FALSE;
#define INTERFACE_INIT  NULL

/*-------------------------------------------------------------------------
 * Function:    H5O_dtype_decode_helper
 *
 * Purpose:     Decodes a data type
 *
 * Return:      Success:        SUCCEED
 *
 *              Failure:        FAIL
 *
 * Programmer:  Robb Matzke
 *              Monday, December  8, 1997
 *
 * Modifications:
 *
 *-------------------------------------------------------------------------
 */
static herr_t
H5O_dtype_decode_helper(const uint8 **pp, H5T_t *dt)
{
    uintn                   flags, perm_word;
    intn                    i, j;

    FUNC_ENTER(H5O_dtype_decode_helper, FAIL);

    /* check args */
    assert(pp && *pp);
    assert(dt);

    /* decode */
    UINT32DECODE(*pp, flags);
    dt->type = (H5T_class_t)(flags & 0xff);
    flags >>= 8;
    UINT32DECODE(*pp, dt->size);

    switch (dt->type) {
    case H5T_INTEGER:
        /*
         * Integer types...
         */
        dt->u.atomic.order = (flags & 0x1) ? H5T_ORDER_BE : H5T_ORDER_LE;
        dt->u.atomic.lsb_pad = (flags & 0x2) ? H5T_PAD_ONE : H5T_PAD_ZERO;
        dt->u.atomic.msb_pad = (flags & 0x4) ? H5T_PAD_ONE : H5T_PAD_ZERO;
        dt->u.atomic.u.i.sign = (flags & 0x8) ? H5T_SGN_2 : H5T_SGN_NONE;
        UINT16DECODE(*pp, dt->u.atomic.offset);
        UINT16DECODE(*pp, dt->u.atomic.prec);
        break;

    case H5T_STRING:
	/*
	 * Character string types...
	 */
	dt->u.atomic.order = H5T_ORDER_NONE;
	dt->u.atomic.prec = 8 * dt->size;
	dt->u.atomic.offset = 0;
	dt->u.atomic.lsb_pad = H5T_PAD_ZERO;
	dt->u.atomic.msb_pad = H5T_PAD_ZERO;
	dt->u.atomic.u.s.cset = H5T_CSET_ASCII;
	dt->u.atomic.u.s.pad = H5T_STR_NULL;
	break;

    case H5T_FLOAT:
        /*
         * Floating-point types...
         */
        dt->u.atomic.order = (flags & 0x1) ? H5T_ORDER_BE : H5T_ORDER_LE;
        dt->u.atomic.lsb_pad = (flags & 0x2) ? H5T_PAD_ONE : H5T_PAD_ZERO;
        dt->u.atomic.msb_pad = (flags & 0x4) ? H5T_PAD_ONE : H5T_PAD_ZERO;
        dt->u.atomic.u.f.pad = (flags & 0x8) ? H5T_PAD_ONE : H5T_PAD_ZERO;
        switch ((flags >> 4) & 0x03) {
        case 0:
            dt->u.atomic.u.f.norm = H5T_NORM_NONE;
            break;
        case 1:
            dt->u.atomic.u.f.norm = H5T_NORM_MSBSET;
            break;
        case 2:
            dt->u.atomic.u.f.norm = H5T_NORM_IMPLIED;
            break;
        default:
            HRETURN_ERROR(H5E_DATATYPE, H5E_UNSUPPORTED, FAIL,
                          "unknown floating-point normalization");
        }
        dt->u.atomic.u.f.sign = (flags >> 8) & 0xff;
        UINT16DECODE(*pp, dt->u.atomic.offset);
        UINT16DECODE(*pp, dt->u.atomic.prec);
        dt->u.atomic.u.f.epos = *(*pp)++;
        dt->u.atomic.u.f.esize = *(*pp)++;
        assert(dt->u.atomic.u.f.esize > 0);
        dt->u.atomic.u.f.mpos = *(*pp)++;
        dt->u.atomic.u.f.msize = *(*pp)++;
        assert(dt->u.atomic.u.f.msize > 0);
        UINT32DECODE(*pp, dt->u.atomic.u.f.ebias);
        break;

    case H5T_COMPOUND:
        /*
         * Compound data types...
         */
        dt->u.compnd.nmembs = flags & 0xffff;
        assert(dt->u.compnd.nmembs > 0);
        dt->u.compnd.nalloc = dt->u.compnd.nmembs;
        dt->u.compnd.memb = H5MM_xcalloc(dt->u.compnd.nalloc,
                                         sizeof(H5T_member_t));
        for (i = 0; i < dt->u.compnd.nmembs; i++) {
            dt->u.compnd.memb[i].name = H5MM_xstrdup((const char *)*pp);
            *pp += ((HDstrlen((const char *)*pp) + 8) / 8) * 8;         /*multiple of 8 w/ null terminator */
            UINT32DECODE(*pp, dt->u.compnd.memb[i].offset);
            dt->u.compnd.memb[i].ndims = *(*pp)++;
            assert(dt->u.compnd.memb[i].ndims <= 4);
            *pp += 3;           /*reserved bytes */
            for (j = 0; j < dt->u.compnd.memb[i].ndims; j++) {
                UINT32DECODE(*pp, dt->u.compnd.memb[i].dim[j]);
            }
            UINT32DECODE(*pp, perm_word);
            dt->u.compnd.memb[i].perm[0] = (perm_word >> 0) & 0xff;
            dt->u.compnd.memb[i].perm[1] = (perm_word >> 8) & 0xff;
            dt->u.compnd.memb[i].perm[2] = (perm_word >> 16) & 0xff;
            dt->u.compnd.memb[i].perm[3] = (perm_word >> 24) & 0xff;
	    dt->u.compnd.memb[i].type = H5MM_xcalloc (1, sizeof(H5T_t));
            if (H5O_dtype_decode_helper(pp, dt->u.compnd.memb[i].type) < 0 ||
                H5T_COMPOUND == dt->u.compnd.memb[i].type->type) {
                for (j = 0; j <= i; j++)
                    H5MM_xfree(dt->u.compnd.memb[i].name);
                H5MM_xfree(dt->u.compnd.memb);
                HRETURN_ERROR(H5E_DATATYPE, H5E_CANTDECODE, FAIL,
                              "can't decode member type");
            }
        }
        break;

    default:
        if (flags) {
            HRETURN_ERROR(H5E_DATATYPE, H5E_UNSUPPORTED, FAIL,
                          "class flags are non-zero");
        }
        break;
    }

    FUNC_LEAVE(SUCCEED);
}

/*-------------------------------------------------------------------------
 * Function:    H5O_dtype_encode_helper
 *
 * Purpose:     Encodes a data type.
 *
 * Return:      Success:        SUCCEED
 *
 *              Failure:        FAIL
 *
 * Programmer:  Robb Matzke
 *              Monday, December  8, 1997
 *
 * Modifications:
 *
 *-------------------------------------------------------------------------
 */
static herr_t
H5O_dtype_encode_helper(uint8 **pp, const H5T_t *dt)
{
    uintn               flags = 0;
    uintn               perm_word;
    char                *hdr = (char *)*pp;
    intn                i, j;
    size_t		n, z;

    FUNC_ENTER(H5O_dtype_encode_helper, FAIL);

    /* check args */
    assert(pp && *pp);
    assert(dt);

    /* skip the type and class bit field for now */
    *pp += 4;
    UINT32ENCODE(*pp, dt->size);

    switch (dt->type) {
    case H5T_INTEGER:
        /*
         * Integer data types...
         */
        switch (dt->u.atomic.order) {
        case H5T_ORDER_LE:
            break;              /*nothing */
        case H5T_ORDER_BE:
            flags |= 0x01;
            break;
        default:
            HRETURN_ERROR(H5E_DATATYPE, H5E_UNSUPPORTED, FAIL,
                          "byte order is not supported in file format yet");
        }

        switch (dt->u.atomic.lsb_pad) {
        case H5T_PAD_ZERO:
            break;              /*nothing */
        case H5T_PAD_ONE:
            flags |= 0x02;
            break;
        default:
            HRETURN_ERROR(H5E_DATATYPE, H5E_UNSUPPORTED, FAIL,
                          "bit padding is not supported in file format yet");
        }

        switch (dt->u.atomic.msb_pad) {
        case H5T_PAD_ZERO:
            break;              /*nothing */
        case H5T_PAD_ONE:
            flags |= 0x04;
            break;
        default:
            HRETURN_ERROR(H5E_DATATYPE, H5E_UNSUPPORTED, FAIL,
                          "bit padding is not supported in file format yet");
        }

        switch (dt->u.atomic.u.i.sign) {
        case H5T_SGN_NONE:
            break;              /*nothing */
        case H5T_SGN_2:
            flags |= 0x08;
            break;
        default:
            HRETURN_ERROR(H5E_DATATYPE, H5E_UNSUPPORTED, FAIL,
                          "sign scheme is not supported in file format yet");
        }

        UINT16ENCODE(*pp, dt->u.atomic.offset);
        UINT16ENCODE(*pp, dt->u.atomic.prec);
        break;

    case H5T_STRING:
	/*
	 * Character string types... (not fully implemented)
	 */
	assert (dt->u.atomic.order == H5T_ORDER_NONE);
	assert (dt->u.atomic.prec == 8 * dt->size);
	assert (dt->u.atomic.offset == 0);
	assert (dt->u.atomic.lsb_pad == H5T_PAD_ZERO);
	assert (dt->u.atomic.msb_pad == H5T_PAD_ZERO);
	assert (dt->u.atomic.u.s.cset == H5T_CSET_ASCII);
	assert (dt->u.atomic.u.s.pad == H5T_STR_NULL);
	break;

    case H5T_FLOAT:
        /*
         * Floating-point types...
         */
        switch (dt->u.atomic.order) {
        case H5T_ORDER_LE:
            break;              /*nothing */
        case H5T_ORDER_BE:
            flags |= 0x01;
            break;
        default:
            HRETURN_ERROR(H5E_DATATYPE, H5E_UNSUPPORTED, FAIL,
                          "byte order is not supported in file format yet");
        }

        switch (dt->u.atomic.lsb_pad) {
        case H5T_PAD_ZERO:
            break;              /*nothing */
        case H5T_PAD_ONE:
            flags |= 0x02;
            break;
        default:
            HRETURN_ERROR(H5E_DATATYPE, H5E_UNSUPPORTED, FAIL,
                          "bit padding is not supported in file format yet");
        }

        switch (dt->u.atomic.msb_pad) {
        case H5T_PAD_ZERO:
            break;              /*nothing */
        case H5T_PAD_ONE:
            flags |= 0x04;
            break;
        default:
            HRETURN_ERROR(H5E_DATATYPE, H5E_UNSUPPORTED, FAIL,
                          "bit padding is not supported in file format yet");
        }

        switch (dt->u.atomic.u.f.pad) {
        case H5T_PAD_ZERO:
            break;              /*nothing */
        case H5T_PAD_ONE:
            flags |= 0x08;
            break;
        default:
            HRETURN_ERROR(H5E_DATATYPE, H5E_UNSUPPORTED, FAIL,
                          "bit padding is not supported in file format yet");
        }

        switch (dt->u.atomic.u.f.norm) {
        case H5T_NORM_NONE:
            break;              /*nothing */
        case H5T_NORM_MSBSET:
            flags |= 0x10;
            break;
        case H5T_NORM_IMPLIED:
            flags |= 0x20;
            break;
        default:
            HRETURN_ERROR(H5E_DATATYPE, H5E_UNSUPPORTED, FAIL,
                          "normalization scheme is not supported in file "
                          "format yet");
        }

        flags |= (dt->u.atomic.u.f.sign << 8) & 0xff00;
        UINT16ENCODE(*pp, dt->u.atomic.offset);
        UINT16ENCODE(*pp, dt->u.atomic.prec);
	assert (dt->u.atomic.u.f.epos<=255);
        *(*pp)++ = (uint8)(dt->u.atomic.u.f.epos);
	assert (dt->u.atomic.u.f.esize<=255);
        *(*pp)++ = (uint8)(dt->u.atomic.u.f.esize);
	assert (dt->u.atomic.u.f.mpos<=255);
        *(*pp)++ = (uint8)(dt->u.atomic.u.f.mpos);
	assert (dt->u.atomic.u.f.msize<=255);
        *(*pp)++ = (uint8)(dt->u.atomic.u.f.msize);
        UINT32ENCODE(*pp, dt->u.atomic.u.f.ebias);
        break;

    case H5T_COMPOUND:
        /*
         * Compound data types...
         */
        flags = dt->u.compnd.nmembs & 0xffff;
        for (i = 0; i < dt->u.compnd.nmembs; i++) {
	    HDstrcpy ((char*)(*pp), dt->u.compnd.memb[i].name);
            n = strlen(dt->u.compnd.memb[i].name);
	    for (z=n+1; z%8; z++) (*pp)[z] = '\0';
	    *pp += z;
            UINT32ENCODE(*pp, dt->u.compnd.memb[i].offset);
            *(*pp)++ = dt->u.compnd.memb[i].ndims;
            assert(dt->u.compnd.memb[i].ndims <= 4);
            *(*pp)++ = '\0';
            *(*pp)++ = '\0';
            *(*pp)++ = '\0';
            for (j = 0; j < dt->u.compnd.memb[i].ndims; j++) {
                UINT32ENCODE(*pp, dt->u.compnd.memb[i].dim[j]);
            }
            for (j = 0, perm_word = 0; j < dt->u.compnd.memb[i].ndims; j++) {
                perm_word |= dt->u.compnd.memb[i].perm[j] << (8 * j);
            }
            UINT32ENCODE(*pp, perm_word);
            if (H5O_dtype_encode_helper(pp, dt->u.compnd.memb[i].type)<0) {
                HRETURN_ERROR(H5E_DATATYPE, H5E_CANTENCODE, FAIL,
                              "can't encode member type");
            }
        }
        break;

    default:
        /*nothing */
        break;
    }

    *hdr++ = dt->type;
    *hdr++ = (flags >> 0) & 0xff;
    *hdr++ = (flags >> 8) & 0xff;
    *hdr++ = (flags >> 16) & 0xff;

    FUNC_LEAVE(SUCCEED);
}

/*--------------------------------------------------------------------------
 NAME
    H5O_dtype_decode
 PURPOSE
    Decode a datatype message and return a pointer to a memory struct
        with the decoded information
 USAGE
    void *H5O_dtype_decode(f, raw_size, p)
        H5F_t *f;               IN: pointer to the HDF5 file struct
        size_t raw_size;        IN: size of the raw information buffer
        const uint8 *p;         IN: the raw information buffer
 RETURNS
    Pointer to the new message in native order on success, NULL on failure
 DESCRIPTION
        This function decodes the "raw" disk form of a simple datatype message
    into a struct in memory native format.  The struct is allocated within this
    function using malloc() and is returned to the caller.
--------------------------------------------------------------------------*/
static void            *
H5O_dtype_decode(H5F_t *f, size_t raw_size, const uint8 *p)
{
    H5T_t                  *dt = NULL;

    FUNC_ENTER(H5O_dtype_decode, NULL);

    /* check args */
    assert(f);
    assert(raw_size > 0);
    assert(p);

    dt = H5MM_xcalloc(1, sizeof(H5T_t));

    if (H5O_dtype_decode_helper(&p, dt) < 0) {
        H5MM_xfree(dt);
        HRETURN_ERROR(H5E_DATATYPE, H5E_CANTDECODE, NULL,
                      "can't decode type");
    }
    assert(raw_size == H5O_ALIGN (H5O_dtype_size(f, (void *) dt)));

    FUNC_LEAVE(dt);
}

/*--------------------------------------------------------------------------
 NAME
    H5O_dtype_encode
 PURPOSE
    Encode a simple datatype message 
 USAGE
    herr_t H5O_dtype_encode(f, raw_size, p, mesg)
        H5F_t *f;         IN: pointer to the HDF5 file struct
        size_t raw_size;        IN: size of the raw information buffer
        const uint8 *p;         IN: the raw information buffer
        const void *mesg;       IN: Pointer to the simple datatype struct
 RETURNS
    SUCCEED/FAIL
 DESCRIPTION
        This function encodes the native memory form of the simple datatype
    message in the "raw" disk form.
--------------------------------------------------------------------------*/
static herr_t
H5O_dtype_encode(H5F_t *f, size_t raw_size, uint8 *p, const void *mesg)
{
    const H5T_t            *dt = (const H5T_t *) mesg;

    FUNC_ENTER(H5O_dtype_encode, FAIL);

    /* check args */
    assert(f);
    assert(raw_size == H5O_ALIGN (H5O_dtype_size(f, mesg)));
    assert(p);
    assert(dt);

    /* encode */
    if (H5O_dtype_encode_helper(&p, dt) < 0) {
        HRETURN_ERROR(H5E_DATATYPE, H5E_CANTENCODE, FAIL,
                      "can't encode type");
    }
    FUNC_LEAVE(SUCCEED);
}

/*--------------------------------------------------------------------------
 NAME
    H5O_dtype_copy
 PURPOSE
    Copies a message from MESG to DEST, allocating DEST if necessary.
 USAGE
    void *H5O_dtype_copy(mesg, dest)
        const void *mesg;       IN: Pointer to the source simple datatype
                                    struct 
        const void *dest;       IN: Pointer to the destination simple
                                    datatype struct 
 RETURNS
    Pointer to DEST on success, NULL on failure
 DESCRIPTION
        This function copies a native (memory) simple datatype message,
    allocating the destination structure if necessary.
--------------------------------------------------------------------------*/
static void            *
H5O_dtype_copy(const void *_src, void *_dst)
{
    const H5T_t            *src = (const H5T_t *) _src;
    H5T_t                  *dst = NULL;

    FUNC_ENTER(H5O_dtype_copy, NULL);

    /* check args */
    assert(src);

    /* copy */
    if (NULL == (dst = H5T_copy(src))) {
        HRETURN_ERROR(H5E_DATATYPE, H5E_CANTINIT, NULL, "can't copy type");
    }
    /* was result already allocated? */
    if (_dst) {
        *((H5T_t *) _dst) = *dst;
        H5MM_xfree(dst);
        dst = (H5T_t *) _dst;
    }
    FUNC_LEAVE((void *) dst);
}

/*--------------------------------------------------------------------------
 NAME
    H5O_dtype_size
 PURPOSE
    Return the raw message size in bytes
 USAGE
    void *H5O_dtype_size(f, mesg)
        H5F_t *f;         IN: pointer to the HDF5 file struct
        const void *mesg;     IN: Pointer to the source simple datatype struct
 RETURNS
    Size of message on success, 0 on failure
 DESCRIPTION
        This function returns the size of the raw simple datatype message on
    success.  (Not counting the message type or size fields, only the data
    portion of the message).  It doesn't take into account alignment.
--------------------------------------------------------------------------*/
static size_t
H5O_dtype_size(H5F_t *f, const void *mesg)
{
    intn                    i;
    size_t                  ret_value = 8;
    const H5T_t            *dt = (const H5T_t *) mesg;

    FUNC_ENTER(H5O_dtype_size, 0);

    assert(mesg);

    switch (dt->type) {
    case H5T_INTEGER:
        ret_value += 4;
        break;

    case H5T_FLOAT:
        ret_value += 12;
        break;

    case H5T_COMPOUND:
        for (i = 0; i < dt->u.compnd.nmembs; i++) {
            ret_value += ((HDstrlen(dt->u.compnd.memb[i].name) + 8) / 8) * 8;
            ret_value += 12 + dt->u.compnd.memb[i].ndims * 4;
            ret_value += H5O_dtype_size(f, dt->u.compnd.memb[i].type);
        }
        break;

    default:
        /*no properties */
        break;
    }

    FUNC_LEAVE(ret_value);
}

/*-------------------------------------------------------------------------
 * Function:    H5O_dtype_reset
 *
 * Purpose:     Frees resources within a data type message, but doesn't free
 *              the message itself.
 *
 * Return:      Success:        SUCCEED
 *
 *              Failure:        FAIL
 *
 * Programmer:  Robb Matzke
 *              Tuesday, December  9, 1997
 *
 * Modifications:
 *
 *-------------------------------------------------------------------------
 */
static herr_t
H5O_dtype_reset(void *_mesg)
{
    H5T_t                  *dt = (H5T_t *) _mesg;
    H5T_t                  *tmp = NULL;

    FUNC_ENTER(H5O_dtype_reset, FAIL);

    if (dt) {
        tmp = H5MM_xmalloc(sizeof(H5T_t));
        *tmp = *dt;
        H5T_close(tmp);
        HDmemset(dt, 0, sizeof(H5T_t));
    }
    FUNC_LEAVE(SUCCEED);
}

/*--------------------------------------------------------------------------
 NAME
    H5O_dtype_debug
 PURPOSE
    Prints debugging information for a data type message
 USAGE
    void *H5O_dtype_debug(f, mesg, stream, indent, fwidth)
        H5F_t *f;               IN: pointer to the HDF5 file struct
        const void *mesg;       IN: Pointer to the source simple datatype
                                    struct
        FILE *stream;           IN: Pointer to the stream for output data
        intn indent;            IN: Amount to indent information by
        intn fwidth;            IN: Field width (?)
 RETURNS
    SUCCEED/FAIL
 DESCRIPTION
        This function prints debugging output to the stream passed as a 
    parameter.
--------------------------------------------------------------------------*/
static herr_t
H5O_dtype_debug(H5F_t *f, const void *mesg, FILE * stream,
                intn indent, intn fwidth)
{
    const H5T_t            *dt = (const H5T_t *) mesg;
    const char             *s;
    char                    buf[256];
    intn                    i, j;

    FUNC_ENTER(H5O_dtype_debug, FAIL);

    /* check args */
    assert(f);
    assert(dt);
    assert(stream);
    assert(indent >= 0);
    assert(fwidth >= 0);

    switch (dt->type) {
    case H5T_INTEGER:
        s = "integer";
        break;
    case H5T_FLOAT:
        s = "floating-point";
        break;
    case H5T_TIME:
        s = "date and time";
        break;
    case H5T_STRING:
        s = "text string";
        break;
    case H5T_BITFIELD:
        s = "bit field";
        break;
    case H5T_OPAQUE:
        s = "opaque";
        break;
    case H5T_COMPOUND:
        s = "compound";
        break;
    default:
        sprintf(buf, "H5T_CLASS_%d", (int) (dt->type));
        s = buf;
        break;
    }
    fprintf(stream, "%*s%-*s %s\n", indent, "", fwidth,
            "Type class:",
            s);

    fprintf(stream, "%*s%-*s %lu byte%s\n", indent, "", fwidth,
            "Size:",
            (unsigned long) (dt->size), 1 == dt->size ? "" : "s");

    if (H5T_COMPOUND == dt->type) {
        fprintf(stream, "%*s%-*s %d\n", indent, "", fwidth,
                "Number of members:",
                dt->u.compnd.nmembs);
        for (i = 0; i < dt->u.compnd.nmembs; i++) {
            sprintf(buf, "Member %d:", i);
            fprintf(stream, "%*s%-*s %s\n", indent, "", fwidth,
                    buf,
                    dt->u.compnd.memb[i].name);
            fprintf(stream, "%*s%-*s %lu\n", indent + 3, "", MAX(0, fwidth-3),
                    "Byte offset:",
                    (unsigned long) (dt->u.compnd.memb[i].offset));
            fprintf(stream, "%*s%-*s %d%s\n", indent + 3, "", MAX(0, fwidth-3),
                    "Dimensionality:",
                    dt->u.compnd.memb[i].ndims,
                    0 == dt->u.compnd.memb[i].ndims ? " (scalar)" : "");
            if (dt->u.compnd.memb[i].ndims > 0) {
                fprintf(stream, "%*s%-*s {", indent + 3, "", MAX(0, fwidth-3),
                        "Size:");
                for (j = 0; j < dt->u.compnd.memb[i].ndims; j++) {
                    fprintf(stream, "%s%lu", j ? ", " : "",
                            (unsigned long) (dt->u.compnd.memb[i].dim[j]));
                }
                fprintf(stream, "}\n");
                fprintf(stream, "%*s%-*s {", indent + 3, "", MAX(0, fwidth-3),
                        "Permutation:");
                for (j = 0; j < dt->u.compnd.memb[i].ndims; j++) {
                    fprintf(stream, "%s%lu", j ? ", " : "",
                            (unsigned long) (dt->u.compnd.memb[i].perm[j]));
                }
                fprintf(stream, "}\n");
            }
            H5O_dtype_debug(f, dt->u.compnd.memb[i].type, stream,
                            indent + 3, MAX(0, fwidth - 3));
        }
    } else {
        switch (dt->u.atomic.order) {
        case H5T_ORDER_LE:
            s = "little endian";
            break;
        case H5T_ORDER_BE:
            s = "big endian";
            break;
        case H5T_ORDER_VAX:
            s = "VAX";
            break;
        case H5T_ORDER_NONE:
            s = "none";
            break;
        default:
            sprintf(buf, "H5T_ORDER_%d", dt->u.atomic.order);
            s = buf;
            break;
        }
        fprintf(stream, "%*s%-*s %s\n", indent, "", fwidth,
                "Byte order:",
                s);

        fprintf(stream, "%*s%-*s %lu bit%s\n", indent, "", fwidth,
                "Precision:",
                (unsigned long) (dt->u.atomic.prec),
                1 == dt->u.atomic.prec ? "" : "s");

        fprintf(stream, "%*s%-*s %lu bit%s\n", indent, "", fwidth,
                "Offset:",
                (unsigned long) (dt->u.atomic.offset),
                1 == dt->u.atomic.offset ? "" : "s");

        switch (dt->u.atomic.lsb_pad) {
        case H5T_PAD_ZERO:
            s = "zero";
            break;
        case H5T_PAD_ONE:
            s = "one";
            break;
        default:
            s = "pad?";
            break;
        }
        fprintf(stream, "%*s%-*s %s\n", indent, "", fwidth,
                "Low pad type:", s);

        switch (dt->u.atomic.msb_pad) {
        case H5T_PAD_ZERO:
            s = "zero";
            break;
        case H5T_PAD_ONE:
            s = "one";
            break;
        default:
            s = "pad?";
            break;
        }
        fprintf(stream, "%*s%-*s %s\n", indent, "", fwidth,
                "High pad type:", s);

        if (H5T_FLOAT == dt->type) {
            switch (dt->u.atomic.u.f.pad) {
            case H5T_PAD_ZERO:
                s = "zero";
                break;
            case H5T_PAD_ONE:
                s = "one";
                break;
            default:
                if (dt->u.atomic.u.f.pad < 0) {
                    sprintf(buf, "H5T_PAD_%d", -(dt->u.atomic.u.f.pad));
                } else {
                    sprintf(buf, "bit-%d", dt->u.atomic.u.f.pad);
                }
                s = buf;
                break;
            }
            fprintf(stream, "%*s%-*s %s\n", indent, "", fwidth,
                    "Internal pad type:", s);

            switch (dt->u.atomic.u.f.norm) {
            case H5T_NORM_IMPLIED:
                s = "implied";
                break;
            case H5T_NORM_MSBSET:
                s = "msb set";
                break;
            case H5T_NORM_NONE:
                s = "none";
                break;
            default:
                sprintf(buf, "H5T_NORM_%d", (int) (dt->u.atomic.u.f.norm));
                s = buf;
            }
            fprintf(stream, "%*s%-*s %s\n", indent, "", fwidth,
                    "Normalization:", s);

            fprintf(stream, "%*s%-*s %lu\n", indent, "", fwidth,
                    "Sign bit location:",
                    (unsigned long) (dt->u.atomic.u.f.sign));

            fprintf(stream, "%*s%-*s %lu\n", indent, "", fwidth,
                    "Exponent location:",
                    (unsigned long) (dt->u.atomic.u.f.epos));

            fprintf(stream, "%*s%-*s 0x%08lx\n", indent, "", fwidth,
                    "Exponent bias:",
                    (unsigned long) (dt->u.atomic.u.f.ebias));

            fprintf(stream, "%*s%-*s %lu\n", indent, "", fwidth,
                    "Exponent size:",
                    (unsigned long) (dt->u.atomic.u.f.esize));

            fprintf(stream, "%*s%-*s %lu\n", indent, "", fwidth,
                    "Mantissa location:",
                    (unsigned long) (dt->u.atomic.u.f.mpos));

            fprintf(stream, "%*s%-*s %lu\n", indent, "", fwidth,
                    "Mantissa size:",
                    (unsigned long) (dt->u.atomic.u.f.msize));

        } else if (H5T_INTEGER == dt->type) {
            switch (dt->u.atomic.u.i.sign) {
            case H5T_SGN_NONE:
                s = "none";
                break;
            case H5T_SGN_2:
                s = "2's comp";
                break;
            default:
                sprintf(buf, "H5T_SGN_%d", (int) (dt->u.atomic.u.i.sign));
                s = buf;
                break;
            }
            fprintf(stream, "%*s%-*s %s\n", indent, "", fwidth,
                    "Sign scheme:", s);

        }
    }

    FUNC_LEAVE(SUCCEED);
}