/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *

 * Copyright by The HDF Group.                                               *

 * 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 LICENSE file, which can be found at the root of the source code       *

 * distribution tree, or in https://www.hdfgroup.org/licenses.               *

 * If you do not have access to either file, you may request a copy from     *

 * help@hdfgroup.org.                                                        *

 * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */

/*-------------------------------------------------------------------------

 *

 * Created:     H5HLint.c

 *

 * Purpose:     Local heap internal routines.

 *

 *-------------------------------------------------------------------------

 */

/****************/

/* Module Setup */

/****************/

#include "H5HLmodule.h" /* This source code file is part of the H5HL module */

/***********/

/* Headers */

/***********/

#include "H5private.h"   /* Generic Functions            */

#include "H5Eprivate.h"  /* Error handling               */

#include "H5FLprivate.h" /* Free lists                   */

#include "H5HLpkg.h"     /* Local Heaps                  */

/****************/

/* Local Macros */

/****************/

/******************/

/* Local Typedefs */

/******************/

/********************/

/* Package Typedefs */

/********************/

/********************/

/* Local Prototypes */

/********************/

/*********************/

/* Package Variables */

/*********************/

/*****************************/

/* Library Private Variables */

/*****************************/

/*******************/

/* Local Variables */

/*******************/

/* Declare a free list to manage the H5HL_t struct */

H5FL_DEFINE_STATIC(H5HL_t);

/*-------------------------------------------------------------------------

 * Function:    H5HL__new

 *

 * Purpose:     Create a new local heap object

 *

 * Return:      Success:    non-NULL pointer to new local heap

 *              Failure:    NULL

 *

 *-------------------------------------------------------------------------

 */

H5HL_t *

H5HL__new(size_t sizeof_size, size_t sizeof_addr, size_t prfx_size)

{

    H5HL_t *heap      = NULL; /* New local heap */

    H5HL_t *ret_value = NULL;

    FUNC_ENTER_PACKAGE

    /* check arguments */

    assert(sizeof_size > 0);

    assert(sizeof_addr > 0);

    assert(prfx_size > 0);

    /* Allocate new local heap structure */

    if (NULL == (heap = H5FL_CALLOC(H5HL_t)))

        HGOTO_ERROR(H5E_HEAP, H5E_CANTALLOC, NULL, "memory allocation failed");

    /* Initialize non-zero fields */

    heap->sizeof_size = sizeof_size;

    heap->sizeof_addr = sizeof_addr;

    heap->prfx_size   = prfx_size;

    /* Set the return value */

    ret_value = heap;

done:

    if (!ret_value && heap != NULL)

        if (NULL == (heap = H5FL_FREE(H5HL_t, heap)))

            HDONE_ERROR(H5E_HEAP, H5E_CANTFREE, NULL, "can't free heap memory");

    FUNC_LEAVE_NOAPI(ret_value)

} /* end H5HL__new() */

/*-------------------------------------------------------------------------

 * Function:  H5HL__inc_rc

 *

 * Purpose:     Increment ref. count on heap

 *

 * Return:      SUCCEED (Can't fail)

 *

 *-------------------------------------------------------------------------

 */

herr_t

H5HL__inc_rc(H5HL_t *heap)

{

    FUNC_ENTER_PACKAGE_NOERR

    /* check arguments */

    assert(heap);

    /* Increment heap's ref. count */

    heap->rc++;

    FUNC_LEAVE_NOAPI(SUCCEED)

} /* end H5HL__inc_rc() */

/*-------------------------------------------------------------------------

 * Function:  H5HL__dec_rc

 *

 * Purpose:     Decrement ref. count on heap

 *

 * Return:      SUCCEED/FAIL

 *

 *-------------------------------------------------------------------------

 */

herr_t

H5HL__dec_rc(H5HL_t *heap)

{

    herr_t ret_value = SUCCEED;

    FUNC_ENTER_PACKAGE

    /* check arguments */

    assert(heap);

    /* Decrement heap's ref. count */

    heap->rc--;

    /* Check if we should destroy the heap */

    if (heap->rc == 0 && FAIL == H5HL__dest(heap))

        HGOTO_ERROR(H5E_HEAP, H5E_CANTFREE, FAIL, "unable to destroy local heap");

done:

    FUNC_LEAVE_NOAPI(ret_value)

} /* end H5HL__dec_rc() */

/*-------------------------------------------------------------------------

 * Function:    H5HL__dest

 *

 * Purpose:     Destroys a heap in memory.

 *

 * Return:      SUCCEED/FAIL

 *

 *-------------------------------------------------------------------------

 */

herr_t

H5HL__dest(H5HL_t *heap)

{

    herr_t ret_value = SUCCEED;

    FUNC_ENTER_PACKAGE

    /* check arguments */

    assert(heap);

    /* Verify that node is unused */

    assert(heap->prots == 0);

    assert(heap->rc == 0);

    assert(heap->prfx == NULL);

    assert(heap->dblk == NULL);

    /* Use DONE errors here to try to free as much as possible */

    if (heap->dblk_image)

        if (NULL != (heap->dblk_image = H5FL_BLK_FREE(lheap_chunk, heap->dblk_image)))

            HDONE_ERROR(H5E_HEAP, H5E_CANTFREE, FAIL, "unable to free local heap data block image");

    while (heap->freelist) {

        H5HL_free_t *fl;

        fl             = heap->freelist;

        heap->freelist = fl->next;

        if (NULL != (fl = H5FL_FREE(H5HL_free_t, fl)))

            HDONE_ERROR(H5E_HEAP, H5E_CANTFREE, FAIL, "unable to free local heap free list");

    }

    if (NULL != (heap = H5FL_FREE(H5HL_t, heap)))

        HDONE_ERROR(H5E_HEAP, H5E_CANTFREE, FAIL, "unable to free local heap");

    FUNC_LEAVE_NOAPI(ret_value)

} /* end H5HL__dest() */