afw_pool.h

Go to the documentation of this file.

// See the 'COPYING' file in the project root for licensing information.
/*
 * Adaptive Framework memory pool support header.
 *
 * Copyright (c) 2010-2023 Clemson University
 *
 */
 
#ifndef __AFW_POOL_H__
#define __AFW_POOL_H__
 
#include "afw_interface.h"
 
AFW_BEGIN_DECLARES
 
typedef struct afw_pool_cleanup_s afw_pool_cleanup_t;
 
 
struct afw_pool_cleanup_s {
 
    /* *** next_cleanup MUST BE FIRST *** */
    afw_pool_cleanup_t *next_cleanup;
 
    /* @brief Cleanup function. */
    afw_pool_cleanup_function_p_t cleanup;
 
    /* @brief Parameter data passed to function. */
    void *data;
 
    /* @brief Parameter data2 passed to function. */
    void *data2;
};
 
 
 
AFW_DECLARE(const afw_pool_t *)
afw_pool_create(const afw_pool_t *parent, afw_xctx_t *xctx);
 
 
AFW_DECLARE(const afw_pool_t *)
afw_pool_create_debug(const afw_pool_t *parent,
    afw_xctx_t *xctx, const afw_utf8_z_t *source_z);
 
 
#ifdef AFW_POOL_DEBUG
#define afw_pool_create(parent,xctx) \
    afw_pool_create_debug(parent, xctx, AFW__FILE_LINE__)
#endif
 
 
AFW_DECLARE(const afw_pool_t *)
afw_pool_create_multithreaded(const afw_pool_t *parent, afw_xctx_t *xctx);
 
 
AFW_DECLARE(const afw_pool_t *)
afw_pool_create_multithreaded_debug(const afw_pool_t *parent,
    afw_xctx_t *xctx, const afw_utf8_z_t *source_z);
 
 
#ifdef AFW_POOL_DEBUG
#define afw_pool_create_multithreaded(parent,xctx) \
    afw_pool_create_multithreaded_debug(parent, xctx, AFW__FILE_LINE__)
#endif
 
 
 
#define afw_pool_calloc_type(instance, type, xctx) \
    (type *) afw_pool_calloc(instance, sizeof(type), xctx)
 
 
#define afw_pool_malloc_type(instance, type, xctx) \
    (type *) afw_pool_malloc(instance, sizeof(type), xctx)
 
 
#ifdef AFW_POOL_DEBUG
 
#undef afw_pool_release
#define afw_pool_release(instance,xctx) \
    afw_pool_release_debug(instance, xctx, AFW__FILE_LINE__)
 
#undef afw_pool_destroy
#define afw_pool_destroy(instance,xctx) \
    afw_pool_destroy_debug(instance, xctx, AFW__FILE_LINE__)
 
#undef afw_pool_add_reference
#define afw_pool_add_reference(instance,xctx) \
    afw_pool_add_reference_debug(instance, xctx, AFW__FILE_LINE__)
 
#undef afw_pool_calloc
#define afw_pool_calloc(instance,size,xctx) \
    afw_pool_calloc_debug(instance, size, xctx, AFW__FILE_LINE__)
 
#undef afw_pool_malloc
#define afw_pool_malloc(instance,size,xctx) \
    afw_pool_malloc_debug(instance, size, xctx, AFW__FILE_LINE__)
 
#undef afw_pool_free
#define afw_pool_free(instance,size,xctx) \
    afw_pool_free_debug(instance, size, xctx, AFW__FILE_LINE__)
 
#undef afw_pool_register_cleanup_before
#define afw_pool_register_cleanup_before(instance,data,data2,cleanup,xctx) \
    afw_pool_register_cleanup_before_debug(instance, data, data2, cleanup, \
        xctx, AFW__FILE_LINE__)
 
#undef afw_pool_deregister_cleanup
#define afw_pool_deregister_cleanup(instance,data,data2,cleanup,xctx) \
    afw_pool_deregister_cleanup_debug(instance, data, data2, cleanup, \
        xctx, AFW__FILE_LINE__)
 
#endif
 
 
AFW_END_DECLARES
 
#endif /* __AFW_POOL_H__ */