summaryrefslogtreecommitdiffstats
path: root/src/H5HGcache.c
blob: 4b45c1b99972c661151fc892dc3ff37fe088e75f (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
/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
 * Copyright by The HDF Group.                                               *
 * 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://hdfgroup.org/HDF5/doc/Copyright.html.  If you do not have          *
 * access to either file, you may request a copy from help@hdfgroup.org.     *
 * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */

/*-------------------------------------------------------------------------
 *
 * Created:		H5HGcache.c
 *			October 6, 2008
 *                      Mike McGreevy <mamcgree@hdfgroup.org>
 *
 * Purpose:		Implement gloabl heap metadata cache methods.
 *
 *-------------------------------------------------------------------------
 */

/****************/
/* Module Setup */
/****************/

#define H5F_PACKAGE		/*suppress error about including H5Fpkg	  */
#define H5HG_PACKAGE		/*suppress error about including H5HGpkg  */

/***********/
/* Headers */
/***********/

#include "H5private.h"		/* Generic Functions			*/
#include "H5Eprivate.h"		/* Error handling		  	*/
#include "H5Fpkg.h"             /* File access				*/
#include "H5FLprivate.h"	/* Free lists                           */
#include "H5HGpkg.h"		/* Global heaps				*/
#include "H5MMprivate.h"	/* Memory management			*/

/****************/
/* Local Macros */
/****************/

/******************/
/* Local Typedefs */
/******************/

/********************/
/* Package Typedefs */
/********************/

/********************/
/* Local Prototypes */
/********************/

/* Metadata cache callbacks */
static void *H5HG_deserialize(haddr_t addr, size_t len, const void *image, 
    void *udata, hbool_t *dirty);
static herr_t H5HG_image_len(const void *thing, size_t *image_len_ptr);
static herr_t H5HG_serialize(const H5F_t *f, hid_t dxpl_id, haddr_t addr, size_t len,
    void *image, void *thing, unsigned *flags, haddr_t *new_addr,
    size_t *new_len, void **new_image);
static herr_t H5HG_free_icr(haddr_t addr, size_t len, void *thing);

/*********************/
/* Package Variables */
/*********************/

/*
 * H5HG inherits cache-like properties from H5AC2
 */
const H5AC2_class_t H5AC2_GHEAP[1] = {{
    H5AC2_GHEAP_ID,
    "global heap",
    H5FD_MEM_GHEAP,
    H5HG_deserialize,
    H5HG_image_len,
    H5HG_serialize,
    H5HG_free_icr,
    NULL,
}};

/*****************************/
/* Library Private Variables */
/*****************************/

/*******************/
/* Local Variables */
/*******************/


/*-------------------------------------------------------------------------
 * Function:	H5HG_deserialize
 *
 * Purpose:	Deserialize the data structure from disk.
 *
 * Return:	Success:	SUCCESS
 *		Failure:	FAIL
 *
 * Programmer:	Robb Matzke
 *              Friday, March 27, 1998
 *
 * Modifications:
 *		Robb Matzke, 1999-07-28
 *		The ADDR argument is passed by value.
 *
 *	Quincey Koziol, 2002-7-180
 *	Added dxpl parameter to allow more control over I/O from metadata
 *      cache.
 *
 *              Mike McGreevy
 *              mcgreevy@hdfgroup.org
 *              July 28, 2008
 *              Converted from H5HG_load 
 * 
 *-------------------------------------------------------------------------
 */
static void *
H5HG_deserialize(haddr_t addr, size_t UNUSED len, const void *image,
    void *_udata, hbool_t UNUSED *dirty)
{

    H5HG_heap_t	*heap = NULL;
    H5F_t *f = (H5F_t *)_udata;
    uint8_t	*p;
    size_t	nalloc, need;
    size_t      max_idx=0;              /* The maximum index seen */
    int	i;
    H5HG_heap_t	*ret_value;             /* Return value */

    FUNC_ENTER_NOAPI(H5HG_deserialize, NULL);

    /* check arguments */
    HDassert(image);

    /* Allocate space for heap */
    if(NULL == (heap = H5FL_CALLOC (H5HG_heap_t)))
	HGOTO_ERROR (H5E_RESOURCE, H5E_NOSPACE, NULL, "memory allocation failed");
    heap->addr = addr;
    heap->shared = f->shared;

    p = image;

    /* Magic number */
    if(HDmemcmp(p, H5HG_MAGIC, (size_t)H5HG_SIZEOF_MAGIC))
	HGOTO_ERROR (H5E_HEAP, H5E_CANTLOAD, NULL, "bad global heap collection signature");
    p += H5HG_SIZEOF_MAGIC;

    /* Version */
    if (H5HG_VERSION!=*p++)
	HGOTO_ERROR (H5E_HEAP, H5E_CANTLOAD, NULL, "wrong version number in global heap");

    /* Reserved */
    p += 3;

    /* Size */
    H5F_DECODE_LENGTH (f, p, heap->size);
    assert (heap->size>=H5HG_MINSIZE);

    /* if heap->size is more than the allocated image size, then we need to do nothing and wait for correctly sized image to come in */
    if (heap->size <= len) {

        /* Allocate space for the heap->chunk */
        if(NULL == (heap->chunk = H5FL_BLK_MALLOC(heap_chunk, (size_t)heap->size)))
    	    HGOTO_ERROR (H5E_RESOURCE, H5E_NOSPACE, NULL, "memory allocation failed");
        
        /* Copy image into chunk */
        HDmemcpy(heap->chunk, image, heap->size);

        /* Decode each object */
        p = heap->chunk + H5HG_SIZEOF_HDR(f);
        nalloc = H5HG_NOBJS (f, heap->size);
        if (NULL==(heap->obj = H5FL_SEQ_MALLOC (H5HG_obj_t,nalloc)))
    	    HGOTO_ERROR (H5E_RESOURCE, H5E_NOSPACE, NULL, "memory allocation failed");
        heap->obj[0].size=heap->obj[0].nrefs=0;
        heap->obj[0].begin=NULL;
        heap->nalloc = nalloc;
        while (p<heap->chunk+heap->size) {
	    if (p+H5HG_SIZEOF_OBJHDR(f)>heap->chunk+heap->size) {
	        /*
	         * The last bit of space is too tiny for an object header, so we
	         * assume that it's free space.
	         */
	        assert (NULL==heap->obj[0].begin);
	        heap->obj[0].size = ((const uint8_t *)heap->chunk+heap->size) - p;
	        heap->obj[0].begin = p;
	        p += heap->obj[0].size;
	    } else {
	        unsigned idx;
	        uint8_t *begin = p;

	        UINT16DECODE (p, idx);

                /* Check if we need more room to store heap objects */
                if(idx>=heap->nalloc) {
                    size_t new_alloc;       /* New allocation number */
                    H5HG_obj_t *new_obj;	/* New array of object descriptions */

                    /* Determine the new number of objects to index */
                    new_alloc=MAX(heap->nalloc*2,(idx+1));

                    /* Reallocate array of objects */
                    if (NULL==(new_obj = H5FL_SEQ_REALLOC (H5HG_obj_t, heap->obj, new_alloc)))
                        HGOTO_ERROR (H5E_RESOURCE, H5E_NOSPACE, NULL, "memory allocation failed");

                    /* Update heap information */
                    heap->nalloc=new_alloc;
                    heap->obj=new_obj;
                } /* end if */

	        UINT16DECODE (p, heap->obj[idx].nrefs);
	        p += 4; /*reserved*/
	        H5F_DECODE_LENGTH (f, p, heap->obj[idx].size);
	        heap->obj[idx].begin = begin;
	        /*
	         * The total storage size includes the size of the object header
	         * and is zero padded so the next object header is properly
	         * aligned. The last bit of space is the free space object whose
	         * size is never padded and already includes the object header.
	         */
	        if (idx>0) {
		    need = H5HG_SIZEOF_OBJHDR(f) + H5HG_ALIGN(heap->obj[idx].size);

                    /* Check for "gap" in index numbers (caused by deletions) and fill in heap object values */
                    if(idx>(max_idx+1))
                        HDmemset(&heap->obj[max_idx+1],0,sizeof(H5HG_obj_t)*(idx-(max_idx+1)));
                    max_idx=idx;
	        } else {
		    need = heap->obj[idx].size;
	        }
	        p = begin + need;
	    }
        }
        assert(p==heap->chunk+heap->size);
        assert(H5HG_ISALIGNED(heap->obj[0].size));


        /* Set the next index value to use */
        if(max_idx>0)
            heap->nused=max_idx+1;
        else
            heap->nused=1;

        /*
         * Add the new heap to the CWFS list, removing some other entry if
         * necessary to make room. We remove the right-most entry that has less
         * free space than this heap.
         */
        if (!f->shared->cwfs) {
            f->shared->cwfs = H5MM_malloc (H5HG_NCWFS*sizeof(H5HG_heap_t*));
            if (NULL==f->shared->cwfs)
                HGOTO_ERROR (H5E_RESOURCE, H5E_NOSPACE, NULL, "memory allocation failed");
            f->shared->ncwfs = 1;
            f->shared->cwfs[0] = heap;
        } else if (H5HG_NCWFS==f->shared->ncwfs) {
            for (i=H5HG_NCWFS-1; i>=0; --i) {
                if (f->shared->cwfs[i]->obj[0].size < heap->obj[0].size) {
                    HDmemmove (f->shared->cwfs+1, f->shared->cwfs, i * sizeof(H5HG_heap_t*));
                    f->shared->cwfs[0] = heap;
                    break;
                }
            }
        } else {
            HDmemmove (f->shared->cwfs+1, f->shared->cwfs, f->shared->ncwfs*sizeof(H5HG_heap_t*));
            f->shared->ncwfs += 1;
            f->shared->cwfs[0] = heap;
        }

        /* Sanity check */    
        HDassert((size_t)((const uint8_t *)p - (const uint8_t *)heap->chunk) <= len);

    } /* end if heap->size <= len */

    ret_value = heap;

done:
    if (!ret_value && heap) {
        if(H5HG_dest(heap)<0)
	    HDONE_ERROR(H5E_HEAP, H5E_CANTFREE, NULL, "unable to destroy global heap collection");
    }
    FUNC_LEAVE_NOAPI(ret_value);
}


/*-------------------------------------------------------------------------
 * Function:	H5HG_serialize
 *
 * Purpose:	Serialize the data structure for writing to disk.
 *
 * Return:	Success:        SUCCESS
 *              Failure:        FAIL
 *
 * Programmer:	Robb Matzke
 *              Friday, March 27, 1998
 *
 * Modifications:
 *		Robb Matzke, 1999-07-28
 *		The ADDR argument is passed by value.
 *
 *	Quincey Koziol, 2002-7-180
 *	Added dxpl parameter to allow more control over I/O from metadata
 *      cache.
 *
 *      JRM -- 8/21/06
 *      Added the flags_ptr parameter.  This parameter exists to
 *      allow the flush routine to report to the cache if the
 *      entry is resized or renamed as a result of the flush.
 *      *flags_ptr is set to H5C_CALLBACK__NO_FLAGS_SET on entry.
 *
 *      Mike McGreevy
 *      mcgreevy@hdfgroup.org
 *      July 28, 2008
 *      Converted from H5HG_flush
 *
 *-------------------------------------------------------------------------
 */
static herr_t
H5HG_serialize (const H5F_t *f, hid_t dxpl_id, haddr_t UNUSED addr, size_t UNUSED len,
    void *image, void *_thing, unsigned *flags, haddr_t UNUSED *new_addr,
    size_t UNUSED *new_len, void UNUSED **new_image)
{
    herr_t      ret_value=SUCCEED;       /* Return value */
    H5HG_heap_t *heap = (H5HG_heap_t *)_thing;

    FUNC_ENTER_NOAPI(H5HG_serialize, FAIL);

    /* Check arguments */
    assert (f);
    assert (H5F_addr_defined (addr));
    assert (H5F_addr_eq (addr, heap->addr));
    assert (heap);


    /* Need to increase image size if we need to copy a bigger thing into it */
    if (heap->size > len) {
        /* free old image buffer */
        H5MM_free(image);
    
        /* allocate new image buffer */
        *new_image = H5MM_malloc(heap->size);
        if (*new_image == NULL)
            HGOTO_ERROR(H5E_RESOURCE, H5E_NOSPACE, NULL, "new image null after H5MM_realloc()\n");

        /* copy the heap->chunk into the new image buffer */
        HDmemcpy(*new_image, heap->chunk, heap->size);

        /* set new length of image */
        *new_len = heap->size;

        /* specify in flags that image has been resized */
        *flags = H5C2__SERIALIZE_RESIZED_FLAG;

    } else {

        /* copy the heap->chunk into the image buffer */
        HDmemcpy(image, heap->chunk, heap->size);

        /* Reset the cache flags for this operation */
        *flags = 0;

    }

done:
    FUNC_LEAVE_NOAPI(ret_value);
}


/*-------------------------------------------------------------------------
 * Function:    H5HG_image_len
 *
 * Purpose:     Tell the metadata cache about the actual size 
 *              of the global heap
 *
 * Return:      Non-negative on success/Negative on failure
 *
 * Programmer:  Mike McGreevy
 *              mcgreevy@hdfgroup.org
 *              July 28, 2008
 *
 *-------------------------------------------------------------------------
 */
static herr_t
H5HG_image_len(const void *thing, size_t *image_len_ptr)
{

    const H5HG_heap_t    *heap = (const H5HG_heap_t *)thing;    /* Global heap */
    
    FUNC_ENTER_NOAPI_NOINIT_NOFUNC(H5HG_image_len)

    /* Check arguments */
    HDassert(heap);
    HDassert(image_len_ptr);
    
    /* Report the global heap's total size */
    *image_len_ptr = heap->size;

    FUNC_LEAVE_NOAPI(SUCCEED)

} /* end H5HG_image_len() */


/*-------------------------------------------------------------------------
 * Function:	H5HG_free_icr
 *
 * Purpose:	Destroy/release an "in core representation" of a data structure
 *
 * Return:	Success:        SUCCEED
 *              Failure:        FAIL
 *
 * Programmer:	Mike McGreevy
 *		mcgreevy@hdfgroup.org
 *		July 28, 2008
 *
 *-------------------------------------------------------------------------
 */
static herr_t
H5HG_free_icr(haddr_t UNUSED addr, size_t UNUSED len, void *thing)
{
    FUNC_ENTER_NOAPI_NOINIT_NOFUNC(H5HG_free_icr)

    /* Check arguments */
    HDassert(thing);

    /* Destroy B-tree node */
    H5HG_dest(thing);

    FUNC_LEAVE_NOAPI(SUCCEED)
} /* end H5HG_free_icr() */