summaryrefslogtreecommitdiffstats
path: root/src/H5Olayout.c
blob: a3d66d64d0165240032f7c19b980cd0579d8b07c (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
/*
 * Copyright (C) 1997 NCSA
 *                    All rights reserved.
 *
 * Programmer:  Robb Matzke <matzke@llnl.gov>
 *              Wednesday, October  8, 1997
 *
 * Purpose:     Messages related to data layout.
 */
#include <H5private.h>
#include <H5Dprivate.h>
#include <H5Eprivate.h>
#include <H5MMprivate.h>
#include <H5Oprivate.h>

/* PRIVATE PROTOTYPES */
static void            *H5O_layout_decode(H5F_t *f, size_t raw_size, const uint8 *p);
static herr_t           H5O_layout_encode(H5F_t *f, size_t size, uint8 *p,
                                          const void *_mesg);
static void            *H5O_layout_copy(const void *_mesg, void *_dest);
static size_t           H5O_layout_size(H5F_t *f, const void *_mesg);
static herr_t           H5O_layout_debug(H5F_t *f, const void *_mesg, FILE * stream,
                                         intn indent, intn fwidth);

/* This message derives from H5O */
const H5O_class_t       H5O_LAYOUT[1] =
{
    {
        H5O_LAYOUT_ID,          /*message id number             */
        "layout",               /*message name for debugging    */
        sizeof(H5O_layout_t),   /*native message size           */
        H5O_layout_decode,      /*decode message                */
        H5O_layout_encode,      /*encode message                */
        H5O_layout_copy,        /*copy the native value         */
        H5O_layout_size,        /*size of message on disk       */
        NULL,                   /*reset method                  */
        H5O_layout_debug,       /*debug the message             */
    }};

/* Interface initialization */
#define PABLO_MASK      H5O_layout_mask
static hbool_t          interface_initialize_g = FALSE;
#define INTERFACE_INIT  NULL

/*-------------------------------------------------------------------------
 * Function:    H5O_layout_decode
 *
 * Purpose:     Decode an data layout message and return a pointer to a
 *              new one created with malloc().
 *
 * Return:      Success:        Ptr to new message in native order.
 *
 *              Failure:        NULL
 *
 * Programmer:  Robb Matzke
 *              Wednesday, October  8, 1997
 *
 * Modifications:
 *
 *-------------------------------------------------------------------------
 */
static void            *
H5O_layout_decode(H5F_t *f, size_t raw_size, const uint8 *p)
{
    H5O_layout_t           *mesg = NULL;
    intn                    i;

    FUNC_ENTER(H5O_layout_decode, NULL);

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

    /* decode */
    mesg = H5MM_xcalloc(1, sizeof(H5O_layout_t));
    H5F_addr_decode(f, &p, &(mesg->addr));
    mesg->ndims = *p++;
    assert(raw_size == H5O_layout_size(f, mesg));

    /* Layout class */
    mesg->type = *p++;
    assert(H5D_CONTIGUOUS == mesg->type || H5D_CHUNKED == mesg->type);

    /* Reserved bytes */
    p += 6;

    /* Read the size */
    for (i = 0; i < mesg->ndims; i++) {
        UINT32DECODE(p, mesg->dim[i]);
    }

    FUNC_LEAVE(mesg);
}

/*-------------------------------------------------------------------------
 * Function:    H5O_layout_encode
 *
 * Purpose:     Encodes a message.
 *
 * Return:      Success:        SUCCEED
 *
 *              Failure:        FAIL
 *
 * Programmer:  Robb Matzke
 *              Wednesday, October  8, 1997
 *
 * Modifications:
 *
 *-------------------------------------------------------------------------
 */
static herr_t
H5O_layout_encode(H5F_t *f, size_t raw_size, uint8 *p, const void *_mesg)
{
    const H5O_layout_t     *mesg = (const H5O_layout_t *) _mesg;
    int                     i;

    FUNC_ENTER(H5O_layout_encode, FAIL);

    /* check args */
    assert(f);
    assert(mesg);
    assert(mesg->ndims > 0 && mesg->ndims <= H5O_LAYOUT_NDIMS);
    assert(raw_size == H5O_layout_size(f, _mesg));
    assert(p);

    /* data or B-tree address */
    H5F_addr_encode(f, &p, &(mesg->addr));

    /* number of dimensions */
    *p++ = mesg->ndims;

    /* layout class */
    *p++ = mesg->type;

    /* reserved bytes should be zero */
    for (i = 0; i < 6; i++)
        *p++ = 0;

    /* dimension size */
    for (i = 0; i < mesg->ndims; i++) {
        UINT32ENCODE(p, mesg->dim[i]);
    }

    FUNC_LEAVE(SUCCEED);
}

/*-------------------------------------------------------------------------
 * Function:    H5O_layout_copy
 *
 * Purpose:     Copies a message from _MESG to _DEST, allocating _DEST if
 *              necessary.
 *
 * Return:      Success:        Ptr to _DEST
 *
 *              Failure:        NULL
 *
 * Programmer:  Robb Matzke
 *              Wednesday, October  8, 1997
 *
 * Modifications:
 *
 *-------------------------------------------------------------------------
 */
static void            *
H5O_layout_copy(const void *_mesg, void *_dest)
{
    const H5O_layout_t     *mesg = (const H5O_layout_t *) _mesg;
    H5O_layout_t           *dest = (H5O_layout_t *) _dest;

    FUNC_ENTER(H5O_layout_copy, NULL);

    /* check args */
    assert(mesg);
    if (!dest)
        dest = H5MM_xcalloc(1, sizeof(H5O_layout_t));

    /* copy */
    *dest = *mesg;

    FUNC_LEAVE((void *) dest);
}

/*-------------------------------------------------------------------------
 * Function:    H5O_layout_size
 *
 * Purpose:     Returns the size of the raw message in bytes not counting the
 *              message type or size fields, but only the data fields.  This
 *              function doesn't take into account message alignment.
 *
 * Return:      Success:        Message data size in bytes
 *
 *              Failure:        FAIL
 *
 * Programmer:  Robb Matzke
 *              Wednesday, October  8, 1997
 *
 * Modifications:
 *
 *-------------------------------------------------------------------------
 */
static size_t
H5O_layout_size(H5F_t *f, const void *_mesg)
{
    const H5O_layout_t     *mesg = (const H5O_layout_t *) _mesg;
    size_t                  ret_value = FAIL;

    FUNC_ENTER(H5O_layout_size, FAIL);

    /* check args */
    assert(f);
    assert(mesg);
    assert(mesg->ndims > 0 && mesg->ndims <= H5O_LAYOUT_NDIMS);

    ret_value = H5F_SIZEOF_ADDR(f) +    /* B-tree address       */
        1 +                     /* max dimension index  */
        1 +                     /* layout class number  */
        6 +                     /* reserved bytes       */
        mesg->ndims * 4;        /* alignment            */

    FUNC_LEAVE(ret_value);
}

/*-------------------------------------------------------------------------
 * Function:    H5O_layout_debug
 *
 * Purpose:     Prints debugging info for a message.
 *
 * Return:      Success:        SUCCEED
 *
 *              Failure:        FAIL
 *
 * Programmer:  Robb Matzke
 *              Wednesday, October  8, 1997
 *
 * Modifications:
 *
 *-------------------------------------------------------------------------
 */
static herr_t
H5O_layout_debug(H5F_t *f, const void *_mesg, FILE * stream, intn indent,
                 intn fwidth)
{
    const H5O_layout_t     *mesg = (const H5O_layout_t *) _mesg;
    intn                    i;

    FUNC_ENTER(H5O_layout_debug, FAIL);

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

    fprintf(stream, "%*s%-*s ", indent, "", fwidth,
            H5D_CHUNKED == mesg->type ? "B-tree address:" : "Data address:");
    H5F_addr_print(stream, &(mesg->addr));
    fprintf(stream, "\n");

    fprintf(stream, "%*s%-*s %lu\n", indent, "", fwidth,
            "Number of dimensions:",
            (unsigned long) (mesg->ndims));

    /* Size */
    fprintf(stream, "%*s%-*s {", indent, "", fwidth,
            "Size:");
    for (i = 0; i < mesg->ndims; i++) {
        fprintf(stream, "%s%lu", i ? ", " : "",
                (unsigned long) (mesg->dim[i]));
    }
    fprintf(stream, "}\n");

    FUNC_LEAVE(SUCCEED);
}