summaryrefslogtreecommitdiffstats
path: root/src/H5Opline.c
blob: 29cd0fddcfcfa1fd09af16498b160b0da265b0a3 (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
/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
 * Copyright by the Board of Trustees of the University of Illinois.         *
 * All rights reserved.                                                      *
 *                                                                           *
 * This file is part of HDF5.  The full HDF5 copyright notice, including     *
 * terms governing use, modification, and redistribution, is contained in    *
 * the files COPYING and Copyright.html.  COPYING can be found at the root   *
 * of the source code distribution tree; Copyright.html can be found at the  *
 * root level of an installed copy of the electronic HDF5 document set and   *
 * is linked from the top-level documents page.  It can also be found at     *
 * http://hdf.ncsa.uiuc.edu/HDF5/doc/Copyright.html.  If you do not have     *
 * access to either file, you may request a copy from hdfhelp@ncsa.uiuc.edu. *
 * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */

/*
 * Programmer:	Robb Matzke <matzke@llnl.gov>
 *		Wednesday, April 15, 1998
 *
 * Purpose:	Data filter pipeline message.
 */

#define H5O_PACKAGE	/*suppress error about including H5Opkg	  */

#include "H5private.h"
#include "H5Eprivate.h"
#include "H5FLprivate.h"	/*Free Lists	  */
#include "H5MMprivate.h"
#include "H5Opkg.h"             /* Object header functions                  */


#define H5O_PLINE_VERSION	1

static herr_t H5O_pline_encode (H5F_t *f, uint8_t *p, const void *mesg);
static void *H5O_pline_decode (H5F_t *f, hid_t dxpl_id, const uint8_t *p);
static void *H5O_pline_copy (const void *_mesg, void *_dest, unsigned update_flags);
static size_t H5O_pline_size (const H5F_t *f, const void *_mesg);
static herr_t H5O_pline_reset (void *_mesg);
static herr_t H5O_pline_free (void *_mesg);
static herr_t H5O_pline_pre_copy_file(H5F_t *file_src, const H5O_msg_class_t *type,
    void *mesg_src, hbool_t *deleted, const H5O_copy_t *cpy_info, void *_udata);
static herr_t H5O_pline_debug (H5F_t *f, hid_t dxpl_id, const void *_mesg,
    FILE * stream, int indent, int fwidth);

/* This message derives from H5O message class */
const H5O_msg_class_t H5O_MSG_PLINE[1] = {{
    H5O_PLINE_ID,		/* message id number		*/
    "filter pipeline",		/* message name for debugging	*/
    sizeof(H5O_pline_t),	/* native message size		*/
    H5O_pline_decode,		/* decode message		*/
    H5O_pline_encode,		/* encode message		*/
    H5O_pline_copy,		/* copy the native value	*/
    H5O_pline_size,		/* size of raw message		*/
    H5O_pline_reset,		/* reset method			*/
    H5O_pline_free,		/* free method			*/
    NULL,		        /* file delete method		*/
    NULL,			/* link method			*/
    NULL,			/* get share method		*/
    NULL, 			/* set share method		*/
    H5O_pline_pre_copy_file,	/* pre copy native value to file */
    NULL,			/* copy native value to file    */
    NULL,			/* post copy native value to file    */
    H5O_pline_debug		/* debug the message		*/
}};


/* Declare a free list to manage the H5O_pline_t struct */
H5FL_DEFINE(H5O_pline_t);


/*-------------------------------------------------------------------------
 * Function:	H5O_pline_decode
 *
 * Purpose:	Decodes a filter pipeline message.
 *
 * Return:	Success:	Ptr to the native message.
 *
 *		Failure:	NULL
 *
 * Programmer:	Robb Matzke
 *              Wednesday, April 15, 1998
 *
 * Modifications:
 *
 *-------------------------------------------------------------------------
 */
static void *
H5O_pline_decode(H5F_t UNUSED *f, hid_t UNUSED dxpl_id, const uint8_t *p)
{
    H5O_pline_t		*pline = NULL;
    void		*ret_value;
    unsigned		version;
    size_t		i, j, n, name_length;

    FUNC_ENTER_NOAPI_NOINIT(H5O_pline_decode);

    /* check args */
    assert(p);

    /* Decode */
    if (NULL==(pline = H5FL_CALLOC(H5O_pline_t)))
	HGOTO_ERROR (H5E_RESOURCE, H5E_NOSPACE, NULL, "memory allocation failed");
    version = *p++;
    if (version!=H5O_PLINE_VERSION)
	HGOTO_ERROR(H5E_PLINE, H5E_CANTLOAD, NULL, "bad version number for filter pipeline message");
    pline->nused = *p++;
    if (pline->nused>H5Z_MAX_NFILTERS)
	HGOTO_ERROR(H5E_PLINE, H5E_CANTLOAD, NULL, "filter pipeline message has too many filters");
    p += 6;	/*reserved*/
    pline->nalloc = pline->nused;
    pline->filter = H5MM_calloc(pline->nalloc*sizeof(pline->filter[0]));
    if (NULL==pline->filter)
	HGOTO_ERROR(H5E_RESOURCE, H5E_NOSPACE, NULL, "memory allocation failed");
    for (i=0; i<pline->nused; i++) {
	UINT16DECODE(p, pline->filter[i].id);
	UINT16DECODE(p, name_length);
	if (name_length % 8)
	    HGOTO_ERROR(H5E_PLINE, H5E_CANTLOAD, NULL, "filter name length is not a multiple of eight");
	UINT16DECODE(p, pline->filter[i].flags);
	UINT16DECODE(p, pline->filter[i].cd_nelmts);
	if (name_length) {
	    /*
	     * Get the name, allocating an extra byte for an extra null
	     * terminator just in case there isn't one in the file (there
	     * should be, but to be safe...)
	     */
	    pline->filter[i].name = H5MM_malloc(name_length+1);
	    HDmemcpy(pline->filter[i].name, p, name_length);
	    pline->filter[i].name[name_length] = '\0';
	    p += name_length;
	}
	if ((n=pline->filter[i].cd_nelmts)) {
	    /*
	     * Read the client data values and the padding
	     */
	    pline->filter[i].cd_values = H5MM_malloc(n*sizeof(unsigned));
	    if (NULL==pline->filter[i].cd_values)
		HGOTO_ERROR(H5E_RESOURCE, H5E_NOSPACE, NULL, "memory allocation failed for client data");
	    for (j=0; j<pline->filter[i].cd_nelmts; j++)
		UINT32DECODE(p, pline->filter[i].cd_values[j]);
	    if (pline->filter[i].cd_nelmts % 2)
		p += 4; /*padding*/
	}
    }

    /* Set return value */
    ret_value = pline;

done:
    if (NULL==ret_value && pline) {
        if (pline->filter) {
            for (i=0; i<pline->nused; i++) {
                H5MM_xfree(pline->filter[i].name);
                H5MM_xfree(pline->filter[i].cd_values);
            }
            H5MM_xfree(pline->filter);
        }
        H5FL_FREE(H5O_pline_t,pline);
    }

    FUNC_LEAVE_NOAPI(ret_value);
}


/*-------------------------------------------------------------------------
 * Function:	H5O_pline_encode
 *
 * Purpose:	Encodes message MESG into buffer P.
 *
 * Return:	Non-negative on success/Negative on failure
 *
 * Programmer:	Robb Matzke
 *              Wednesday, April 15, 1998
 *
 * Modifications:
 *
 *-------------------------------------------------------------------------
 */
static herr_t
H5O_pline_encode (H5F_t UNUSED *f, uint8_t *p/*out*/, const void *mesg)
{
    const H5O_pline_t	*pline = (const H5O_pline_t*)mesg;
    size_t		i, j, name_length;
    const char		*name=NULL;
    H5Z_class_t		*cls=NULL;

    FUNC_ENTER_NOAPI_NOINIT_NOFUNC(H5O_pline_encode);

    /* Check args */
    assert (p);
    assert (mesg);

    *p++ = H5O_PLINE_VERSION;
    *p++ = (uint8_t)(pline->nused);
    *p++ = 0;	/*reserved 1*/
    *p++ = 0;	/*reserved 2*/
    *p++ = 0;	/*reserved 3*/
    *p++ = 0;	/*reserved 4*/
    *p++ = 0;	/*reserved 5*/
    *p++ = 0;	/*reserved 6*/

    for (i=0; i<pline->nused; i++) {
	/*
	 * Get the filter name.  If the pipeline message has a name in it then
	 * use that one.  Otherwise try to look up the filter and get the name
	 * as it was registered.
	 */
	if (NULL==(name=pline->filter[i].name) &&
                (cls=H5Z_find(pline->filter[i].id)))
	    name = cls->name;
	name_length = name ? HDstrlen(name)+1 : 0;

	/* Encode the filter */
	UINT16ENCODE(p, pline->filter[i].id);
	UINT16ENCODE(p, H5O_ALIGN(name_length));
	UINT16ENCODE(p, pline->filter[i].flags);
	UINT16ENCODE(p, pline->filter[i].cd_nelmts);
	if (name_length>0) {
	    HDmemcpy(p, name, name_length);
	    p += name_length;
	    while (name_length++ % 8)
                *p++ = 0;
	}
	for (j=0; j<pline->filter[i].cd_nelmts; j++)
	    UINT32ENCODE(p, pline->filter[i].cd_values[j]);
	if (pline->filter[i].cd_nelmts % 2)
	    UINT32ENCODE(p, 0);
    }

    FUNC_LEAVE_NOAPI(SUCCEED);
}


/*-------------------------------------------------------------------------
 * Function:	H5O_pline_copy
 *
 * Purpose:	Copies a filter pipeline message from SRC to DST allocating
 *		DST if necessary.  If DST is already allocated then we assume
 *		that it isn't initialized.
 *
 * Return:	Success:	Ptr to DST or allocated result.
 *
 *		Failure:	NULL
 *
 * Programmer:	Robb Matzke
 *              Wednesday, April 15, 1998
 *
 * Modifications:
 *
 *-------------------------------------------------------------------------
 */
static void *
H5O_pline_copy (const void *_src, void *_dst/*out*/, unsigned UNUSED update_flags)
{
    const H5O_pline_t	*src = (const H5O_pline_t *)_src;
    H5O_pline_t		*dst = (H5O_pline_t *)_dst;
    size_t		i;
    H5O_pline_t		*ret_value;

    FUNC_ENTER_NOAPI_NOINIT(H5O_pline_copy);

    if (!dst && NULL==(dst = H5FL_MALLOC (H5O_pline_t)))
	HGOTO_ERROR (H5E_RESOURCE, H5E_NOSPACE, NULL, "memory allocation failed");

    *dst = *src;
    dst->nalloc = dst->nused;
    if (dst->nalloc>0) {
	dst->filter = H5MM_calloc(dst->nalloc * sizeof(dst->filter[0]));
	if (NULL==dst->filter)
	    HGOTO_ERROR(H5E_RESOURCE, H5E_NOSPACE, NULL, "memory allocation failed");
    } else {
	dst->filter = NULL;
    }

    for (i=0; i<src->nused; i++) {
	dst->filter[i] = src->filter[i];
	if (src->filter[i].name) {
	    dst->filter[i].name = H5MM_xstrdup(src->filter[i].name);
	}
	if (src->filter[i].cd_nelmts>0) {
	    dst->filter[i].cd_values = H5MM_malloc(src->filter[i].cd_nelmts*
						   sizeof(unsigned));
	    if (NULL==dst->filter[i].cd_values)
		HGOTO_ERROR (H5E_RESOURCE, H5E_NOSPACE, NULL, "memory allocation failed");
	    HDmemcpy (dst->filter[i].cd_values, src->filter[i].cd_values,
		      src->filter[i].cd_nelmts * sizeof(unsigned));
	}
    }

    /* Set return value */
    ret_value = dst;

done:
    if (!ret_value && dst) {
	if (dst->filter) {
	    for (i=0; i<dst->nused; i++) {
		H5MM_xfree(dst->filter[i].name);
		H5MM_xfree(dst->filter[i].cd_values);
	    }
	    H5MM_xfree(dst->filter);
	}
	if (!_dst)
            H5FL_FREE(H5O_pline_t,dst);
    }

    FUNC_LEAVE_NOAPI(ret_value);
}


/*-------------------------------------------------------------------------
 * Function:	H5O_pline_size
 *
 * Purpose:	Determines the size of a raw filter pipeline message.
 *
 * Return:	Success:	Size of message.
 *
 *		Failure:	zero
 *
 * Programmer:	Robb Matzke
 *              Wednesday, April 15, 1998
 *
 * Modifications:
 *
 *-------------------------------------------------------------------------
 */
static size_t
H5O_pline_size (const H5F_t UNUSED *f, const void *mesg)
{
    const H5O_pline_t	*pline = (const H5O_pline_t*)mesg;
    size_t		i, name_len;
    const char		*name = NULL;
    H5Z_class_t		*cls = NULL;
    size_t ret_value;           /* Return value */

    FUNC_ENTER_NOAPI_NOINIT_NOFUNC(H5O_pline_size);

    /* Message header */
    ret_value = 1 +			/*version			*/
	   1 +				/*number of filters		*/
	   6;				/*reserved			*/

    for (i=0; i<pline->nused; i++) {
	/* Get the name of the filter, same as done with H5O_pline_encode() */
	if (NULL==(name=pline->filter[i].name) &&
                (cls=H5Z_find(pline->filter[i].id)))
	    name = cls->name;
	name_len = name ? HDstrlen(name)+1 : 0;


	ret_value += 2 +		/*filter identification number	*/
		2 +			/*name length			*/
		2 +			/*flags				*/
		2 +			/*number of client data values	*/
		H5O_ALIGN(name_len);	/*length of the filter name	*/

	ret_value += pline->filter[i].cd_nelmts * 4;
	if (pline->filter[i].cd_nelmts % 2)
            ret_value += 4;
    }

    FUNC_LEAVE_NOAPI(ret_value);
}


/*-------------------------------------------------------------------------
 * Function:	H5O_pline_reset
 *
 * Purpose:	Resets a filter pipeline message by clearing all filters.
 *		The MESG buffer is not freed.
 *
 * Return:	Non-negative on success/Negative on failure
 *
 * Programmer:	Robb Matzke
 *              Wednesday, April 15, 1998
 *
 * Modifications:
 *
 *-------------------------------------------------------------------------
 */
static herr_t
H5O_pline_reset (void *mesg)
{
    H5O_pline_t	*pline = (H5O_pline_t*)mesg;
    size_t	i;

    FUNC_ENTER_NOAPI_NOINIT_NOFUNC(H5O_pline_reset);

    assert (pline);

    for (i=0; i<pline->nused; i++) {
        H5MM_xfree(pline->filter[i].name);
        H5MM_xfree(pline->filter[i].cd_values);
    }
    if(pline->filter)
        H5MM_xfree(pline->filter);
    HDmemset(pline, 0, sizeof *pline);

    FUNC_LEAVE_NOAPI(SUCCEED);
}


/*-------------------------------------------------------------------------
 * Function:	H5O_pline_free
 *
 * Purpose:	Free's the message
 *
 * Return:	Non-negative on success/Negative on failure
 *
 * Programmer:	Quincey Koziol
 *              Saturday, March 11, 2000
 *
 * Modifications:
 *
 *-------------------------------------------------------------------------
 */
static herr_t
H5O_pline_free (void *mesg)
{
    FUNC_ENTER_NOAPI_NOINIT_NOFUNC(H5O_pline_free);

    assert (mesg);

    H5FL_FREE(H5O_pline_t,mesg);

    FUNC_LEAVE_NOAPI(SUCCEED);
}


/*-------------------------------------------------------------------------
 * Function:    H5O_pline_pre_copy_file
 *
 * Purpose:     Perform any necessary actions before copying message between
 *              files
 *
 * Return:      Success:        Non-negative
 *
 *              Failure:        Negative
 *
 * Programmer:  Peter Cao
 *              December 27, 2005
 *
 *-------------------------------------------------------------------------
 */
static herr_t
H5O_pline_pre_copy_file(H5F_t *file_src, const H5O_msg_class_t UNUSED *type,
    void *mesg_src, hbool_t UNUSED *deleted, const H5O_copy_t UNUSED *cpy_info,
    void *_udata)
{
    H5O_pline_t        *pline_src = (H5O_pline_t *)mesg_src;    /* Source datatype */
    H5D_copy_file_ud_t *udata = (H5D_copy_file_ud_t *)_udata;   /* Dataset copying user data */
    herr_t             ret_value = SUCCEED;                     /* Return value */

    FUNC_ENTER_NOAPI_NOINIT(H5O_pline_pre_copy_file)

    /* check args */
    HDassert(file_src);
    HDassert(pline_src);

    /* If the user data is non-NULL, assume we are copying a dataset
     * and make a copy of the filter pipeline for later in
     * the object copying process.
     */
    if(udata) {
        if(NULL == (udata->src_pline = H5O_copy(H5O_PLINE_ID, pline_src, udata->src_pline)))
            HGOTO_ERROR(H5E_PLINE, H5E_CANTINIT, FAIL, "unable to copy")
    } /* end if */

done:
    FUNC_LEAVE_NOAPI(ret_value)
} /* end H5O_pline_pre_copy_file() */



/*-------------------------------------------------------------------------
 * Function:	H5O_pline_debug
 *
 * Purpose:	Prints debugging information for filter pipeline message MESG
 *		on output stream STREAM.  Each line is indented INDENT
 *		characters and the field name takes up FWIDTH characters.
 *
 * Return:	Non-negative on success/Negative on failure
 *
 * Programmer:	Robb Matzke
 *              Wednesday, April 15, 1998
 *
 * Modifications:
 *
 *-------------------------------------------------------------------------
 */
static herr_t
H5O_pline_debug (H5F_t UNUSED *f, hid_t UNUSED dxpl_id, const void *mesg, FILE *stream,
		int indent, int fwidth)
{
    const H5O_pline_t	*pline = (const H5O_pline_t *)mesg;
    size_t		i, j;

    FUNC_ENTER_NOAPI_NOINIT_NOFUNC(H5O_pline_debug);

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

    fprintf(stream, "%*s%-*s %lu/%lu\n", indent, "", fwidth,
	    "Number of filters:",
	    (unsigned long)(pline->nused),
	    (unsigned long)(pline->nalloc));

    for (i=0; i<pline->nused; i++) {
	char		name[32];
	sprintf(name, "Filter at position %lu", (unsigned long)i);
	fprintf(stream, "%*s%-*s\n", indent, "", fwidth, name);
	fprintf(stream, "%*s%-*s 0x%04x\n", indent+3, "", MAX(0, fwidth-3),
		"Filter identification:",
		(unsigned)(pline->filter[i].id));
	if (pline->filter[i].name) {
	    fprintf(stream, "%*s%-*s \"%s\"\n", indent+3, "", MAX(0, fwidth-3),
		    "Filter name:",
		    pline->filter[i].name);
	} else {
	    fprintf(stream, "%*s%-*s NONE\n", indent+3, "", MAX(0, fwidth-3),
		    "Filter name:");
	}
	fprintf(stream, "%*s%-*s 0x%04x\n", indent+3, "", MAX(0, fwidth-3),
		"Flags:",
		(unsigned)(pline->filter[i].flags));
	fprintf(stream, "%*s%-*s %lu\n", indent+3, "", MAX(0, fwidth-3),
		"Num CD values:",
		(unsigned long)(pline->filter[i].cd_nelmts));
	for (j=0; j<pline->filter[i].cd_nelmts; j++) {
	    char	field_name[32];
	    sprintf(field_name, "CD value %lu", (unsigned long)j);
	    fprintf(stream, "%*s%-*s %lu\n", indent+6, "", MAX(0, fwidth-6),
		    field_name,
		    (unsigned long)(pline->filter[i].cd_values[j]));
	}
    }

    FUNC_LEAVE_NOAPI(SUCCEED);
}