summaryrefslogtreecommitdiffstats
path: root/src/H5MVsection.c
blob: 81f1a0033719a7e90c0d35e513393d7f2c7e3d76 (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
/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
 * 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 COPYING file, which can be found at the root of the source code       *
 * distribution tree, or in https://support.hdfgroup.org/ftp/HDF5/releases.  *
 * If you do not have access to either file, you may request a copy from     *
 * help@hdfgroup.org.                                                        *
 * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */

/*
 * Programmer:	Quincey Koziol <koziol@hdfgroup.org>
 *              Tuesday, January  8, 2008
 *
 * Purpose:	Free space section callbacks for file.
 *
 */

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

#define H5F_FRIEND		/*suppress error about including H5Fpkg	  */
#include "H5MVmodule.h"         /* This source code file is part of the H5MF module */


/***********/
/* Headers */
/***********/
#include "H5private.h"		/* Generic Functions			*/
#include "H5Eprivate.h"		/* Error handling		  	*/
#include "H5Fpkg.h"             /* File access				*/
#include "H5MVpkg.h"		/* File memory management		*/


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


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


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


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

/* 'simple' section callbacks */
static htri_t H5MV__sect_can_merge(const H5FS_section_info_t *sect1,
    const H5FS_section_info_t *sect2, void *udata);
static herr_t H5MV__sect_merge(H5FS_section_info_t **sect1,
    H5FS_section_info_t *sect2, void *udata);
static herr_t H5MV__sect_valid(const H5FS_section_class_t *cls,
    const H5FS_section_info_t *sect);
static H5FS_section_info_t *H5MV__sect_split(H5FS_section_info_t *sect,
    hsize_t frag_size);



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

/* Class info for "simple" free space sections */
H5FS_section_class_t H5MV_FSPACE_SECT_CLS_SIMPLE[1] = {{
    /* Class variables */
    H5MV_FSPACE_SECT_SIMPLE,	    /* Section type                 */
    0,					            /* Extra serialized size        */
    H5FS_CLS_MERGE_SYM | H5FS_CLS_ADJUST_OK | H5FS_CLS_GHOST_OBJ,   /* Class flags                  */
    NULL,				            /* Class private info           */

    /* Class methods */
    NULL,				            /* Initialize section class     */
    NULL,				            /* Terminate section class      */

    /* Object methods */
    NULL,				            /* Add section                  */
    NULL,				            /* Serialize section            */
    NULL,		                    /* Deserialize section          */
    H5MV__sect_can_merge,	        /* Can sections merge?          */
    H5MV__sect_merge,		        /* Merge sections               */
    H5MV__sect_can_shrink,	        /* Can section shrink container?*/
    H5MV__sect_shrink,		        /* Shrink container w/section   */
    H5MV__sect_free,			    /* Free section                 */
    H5MV__sect_valid,			    /* Check validity of section    */
    H5MV__sect_split,			    /* Split section node for alignment */
    NULL,				            /* Dump debugging for section   */
}};


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


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

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

/* 
 * "simple" section callbacks
 */


/*-------------------------------------------------------------------------
 * Function:	H5MV__sect_new
 *
 * Purpose:	    Create a new section and return it to the caller
 *
 * Return:	    Pointer to new section on success/NULL on failure
 *
 *-------------------------------------------------------------------------
 */
H5MV_free_section_t *
H5MV__sect_new(haddr_t sect_off, hsize_t sect_size)
{
    H5MV_free_section_t *sect;          /* 'Simple' free space section to add */
    H5MV_free_section_t *ret_value = NULL;      /* Return value */

    FUNC_ENTER_PACKAGE

    /* Check arguments.  */
    HDassert(sect_size);

    /* Create free space section node */
    if(NULL == (sect = H5FL_MALLOC(H5MV_free_section_t)))
        HGOTO_ERROR(H5E_RESOURCE, H5E_NOSPACE, NULL, "memory allocation failed for free section node")

    /* Set the information passed in */
    sect->sect_info.addr = sect_off;
    sect->sect_info.size = sect_size;

    /* Set the section's class & state */
    sect->sect_info.type = H5MV_FSPACE_SECT_SIMPLE;
    sect->sect_info.state = H5FS_SECT_LIVE;

    /* Set return value */
    ret_value = sect;

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


/*-------------------------------------------------------------------------
 * Function:	H5MV__sect_free
 *
 * Purpose:	    Free a 'simple' section node
 *
 * Return:	    Success:	non-negative
 *		        Failure:	negative
 *
 *-------------------------------------------------------------------------
 */
herr_t
H5MV__sect_free(H5FS_section_info_t *_sect)
{
    H5MV_free_section_t *sect = (H5MV_free_section_t *)_sect;   /* File free section */

    FUNC_ENTER_PACKAGE_NOERR

    /* Check arguments. */
    HDassert(sect);

    /* Release the section */
    sect = H5FL_FREE(H5MV_free_section_t, sect);

    FUNC_LEAVE_NOAPI(SUCCEED)
}   /* H5MV__sect_free() */



/*-------------------------------------------------------------------------
 * Function:	H5MV__sect_can_merge
 *
 * Purpose:	    Can two sections of this type merge?
 *
 * Note:        Second section must be "after" first section
 *
 * Return:	    Success:	non-negative (TRUE/FALSE)
 *		        Failure:	negative
 *
 *-------------------------------------------------------------------------
 */
static htri_t
H5MV__sect_can_merge(const H5FS_section_info_t *_sect1,
    const H5FS_section_info_t *_sect2, void H5_ATTR_UNUSED *_udata)
{
    const H5MV_free_section_t *sect1 = (const H5MV_free_section_t *)_sect1;   /* File free section */
    const H5MV_free_section_t *sect2 = (const H5MV_free_section_t *)_sect2;   /* File free section */
    htri_t ret_value = FAIL;            /* Return value */

    FUNC_ENTER_STATIC_NOERR

    /* Check arguments. */
    HDassert(sect1);
    HDassert(sect2);
    HDassert(sect1->sect_info.type == sect2->sect_info.type);   /* Checks "MERGE_SYM" flag */
    HDassert(H5F_addr_lt(sect1->sect_info.addr, sect2->sect_info.addr));

    /* Check if second section adjoins first section */
    ret_value = H5F_addr_eq(sect1->sect_info.addr + sect1->sect_info.size, sect2->sect_info.addr);

    FUNC_LEAVE_NOAPI(ret_value)
} /* H5MV__sect_can_merge() */


/*-------------------------------------------------------------------------
 * Function:	H5MV__sect_merge
 *
 * Purpose:	    Merge two sections of this type
 *
 * Note:        Second section always merges into first node
 *
 * Return:	    Success:	non-negative
 *		        Failure:	negative
 *
 *-------------------------------------------------------------------------
 */
static herr_t
H5MV__sect_merge(H5FS_section_info_t **_sect1, H5FS_section_info_t *_sect2,
    void H5_ATTR_UNUSED *_udata)
{
    H5MV_free_section_t **sect1 = (H5MV_free_section_t **)_sect1;   /* File free section */
    H5MV_free_section_t *sect2 = (H5MV_free_section_t *)_sect2;   /* File free section */
    herr_t ret_value = SUCCEED;         /* Return value */

    FUNC_ENTER_STATIC

    /* Check arguments. */
    HDassert(sect1);
    HDassert((*sect1)->sect_info.type == H5MV_FSPACE_SECT_SIMPLE);
    HDassert(sect2);
    HDassert(sect2->sect_info.type == H5MV_FSPACE_SECT_SIMPLE);
    HDassert(H5F_addr_eq((*sect1)->sect_info.addr + (*sect1)->sect_info.size, sect2->sect_info.addr));

    /* Add second section's size to first section */
    (*sect1)->sect_info.size += sect2->sect_info.size;

    /* Get rid of second section */
    if(H5MV__sect_free((H5FS_section_info_t *)sect2) < 0)
        HGOTO_ERROR(H5E_RESOURCE, H5E_CANTRELEASE, FAIL, "can't free section node")

done:
    FUNC_LEAVE_NOAPI(ret_value)
} /* H5MV__sect_merge() */


/*-------------------------------------------------------------------------
 * Function:	H5MV__sect_can_shrink
 *
 * Purpose:	    Can this section shrink the container?
 *
 * Return:	    Success:	non-negative (TRUE/FALSE)
 *		        Failure:	negative
 *
 *-------------------------------------------------------------------------
 */
htri_t
H5MV__sect_can_shrink(const H5FS_section_info_t *_sect, void *_udata)
{
    const H5MV_free_section_t *sect = (const H5MV_free_section_t *)_sect;   /* File free section */
    H5F_t *f = (H5F_t *)_udata;
    H5F_shared_t *shared = f->shared;
    haddr_t eoa;                /* End of address space in the file */
    haddr_t end;                /* End of section to extend */
    htri_t ret_value = FALSE;   /* Return value */

    FUNC_ENTER_STATIC

    /* Check arguments. */
    HDassert(sect);

    /* Retrieve the end oa the file's address space */
    if(HADDR_UNDEF == (eoa = H5MV_get_vfd_swmr_md_eoa(shared)))
        HGOTO_ERROR(H5E_RESOURCE, H5E_CANTGET, FAIL, "get_eoa request for VFD SWMR metadata file failed")

    /* Compute address of end of section to check */
    end = sect->sect_info.addr + sect->sect_info.size;

    /* Check if the section is exactly at the end of the allocated space in the file */
    if(H5F_addr_eq(end, eoa))
        /* Indicate shrinking can occur */
        ret_value = TRUE;

done:
    FUNC_LEAVE_NOAPI(ret_value)
} /* H5MV__sect_can_shrink() */


/*-------------------------------------------------------------------------
 * Function:	H5MV__sect_shrink
 *
 * Purpose:	    Shrink container with section
 *
 * Return:	    Success:	non-negative
 *		        Failure:	negative
 *
 *-------------------------------------------------------------------------
 */
herr_t
H5MV__sect_shrink(H5FS_section_info_t **_sect, void *_udata)
{
    H5F_t *f = (H5F_t *)_udata;
    H5F_shared_t *shared = f->shared;
    H5MV_free_section_t **sect = (H5MV_free_section_t **)_sect;   /* File free section */
    herr_t ret_value = SUCCEED;         /* Return value */

    FUNC_ENTER_STATIC

    /* Check arguments. */
    HDassert(sect);
    HDassert(H5F_SHARED_INTENT(shared) & H5F_ACC_RDWR);

    /* Release section's space at EOA */
    if(H5MV__free_md(shared, (*sect)->sect_info.addr, (*sect)->sect_info.size) < 0)
        HGOTO_ERROR(H5E_RESOURCE, H5E_CANTFREE, FAIL, "free request for VFD SWMR metadata file failed")

    /* Free the section */
    if(H5MV__sect_free(&(*sect)->sect_info) < 0)
        HGOTO_ERROR(H5E_RESOURCE, H5E_CANTRELEASE, FAIL, "can't free simple section node")

   /* Mark section as freed, for free space manager */
   *sect = NULL;

done:
    FUNC_LEAVE_NOAPI(ret_value)
} /* H5MV__sect_shrink() */


/*-------------------------------------------------------------------------
 * Function:	H5MV__sect_valid
 *
 * Purpose:	    Check the validity of a section
 *
 * Return:	    Success:	non-negative
 *              Failure:	negative
 *
 *-------------------------------------------------------------------------
 */
static herr_t
H5MV__sect_valid(const H5FS_section_class_t H5_ATTR_UNUSED *cls, const H5FS_section_info_t *_sect)
{
    const H5MV_free_section_t *sect = (const H5MV_free_section_t *)_sect;   /* File free section */

    FUNC_ENTER_STATIC_NOERR

    /* Check arguments. */
    HDassert(sect);

    FUNC_LEAVE_NOAPI(SUCCEED)
}   /* H5MV__sect_valid() */

/*-------------------------------------------------------------------------
 * Function:    H5MV__sect_split
 *
 * Purpose: Split SECT into 2 sections: fragment for alignment & the aligned section
 *          SECT's addr and size are updated to point to the aligned section
 *
 * Return:  Success:    the fragment for aligning sect
 *          Failure:    null
 *
 *-------------------------------------------------------------------------
 */
static H5FS_section_info_t *
H5MV__sect_split(H5FS_section_info_t *sect, hsize_t frag_size)
{
    H5MV_free_section_t *ret_value = NULL;      /* Return value */

    FUNC_ENTER_STATIC

    /* Allocate space for new section */
    if(NULL == (ret_value = H5MV__sect_new(sect->addr, frag_size)))
       HGOTO_ERROR(H5E_RESOURCE, H5E_CANTALLOC, NULL, "can't initialize free space section")

    /* Set new section's info */
    sect->addr += frag_size;
    sect->size -= frag_size;

done:
    FUNC_LEAVE_NOAPI((H5FS_section_info_t *)ret_value)
} /* end H5MV__sect_split() */