forked from enlightenment/efl
227 lines
6.0 KiB
C
227 lines
6.0 KiB
C
/* EINA - EFL data type library
|
|
* Copyright (C) 2007-2008 Jorge Luis Zapata Muga
|
|
*
|
|
* This library is free software; you can redistribute it and/or
|
|
* modify it under the terms of the GNU Lesser General Public
|
|
* License as published by the Free Software Foundation; either
|
|
* version 2.1 of the License, or (at your option) any later version.
|
|
*
|
|
* This library is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|
* Lesser General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU Lesser General Public
|
|
* License along with this library;
|
|
* if not, see <http://www.gnu.org/licenses/>.
|
|
*/
|
|
|
|
#ifndef EINA_MEMPOOL_H_
|
|
#define EINA_MEMPOOL_H_
|
|
|
|
#include "eina_types.h"
|
|
#include "eina_error.h"
|
|
#include "eina_module.h"
|
|
|
|
|
|
/**
|
|
* @addtogroup Eina_Memory_Pool_Group Memory Pool
|
|
*
|
|
* @brief These functions provide memory pool management.
|
|
*
|
|
* Several mempool are available:
|
|
*
|
|
* @li @c chained_pool: It is the default one. It allocates a big
|
|
* chunk of memory with malloc() and split the result in chunks of the
|
|
* requested size that are pushed inside a stack. When requested, it
|
|
* takes this pointer from the stack to give them to whoever wants
|
|
* them.
|
|
* @li @c pass_through: it just call malloc() and free(). It may be
|
|
* faster on some computers than using our own allocators (like having
|
|
* a huge L2 cache, over 4MB).
|
|
* @li @c one_big: It calls just one time malloc for the requested number
|
|
* of items. Useful when you know in advance how many objects of some
|
|
* type will live during the life of the mempool.
|
|
*/
|
|
|
|
/**
|
|
* @addtogroup Eina_Tools_Group Tools
|
|
*
|
|
* @{
|
|
*/
|
|
|
|
/**
|
|
* @defgroup Eina_Memory_Pool_Group Memory Pool
|
|
*
|
|
* @{
|
|
*/
|
|
|
|
/**
|
|
* @typedef Eina_Mempool
|
|
* Mempool type.
|
|
*/
|
|
typedef struct _Eina_Mempool Eina_Mempool;
|
|
|
|
/**
|
|
* @typedef Eina_Mempool_Backend
|
|
* Mempool backend type.
|
|
*/
|
|
typedef struct _Eina_Mempool_Backend Eina_Mempool_Backend;
|
|
|
|
|
|
/**
|
|
* @typedef Eina_Mempool_Repack_Cb
|
|
* Type for a callback who need to unreference an old object from a mempool
|
|
* and reference the new one instead. Memcpy is taken care by the mempool.
|
|
*/
|
|
typedef void (*Eina_Mempool_Repack_Cb)(void *dst, void *src, void *data);
|
|
|
|
EAPI extern Eina_Error EINA_ERROR_NOT_MEMPOOL_MODULE;
|
|
|
|
/**
|
|
*
|
|
* @brief TODO
|
|
*
|
|
* @param module
|
|
* @param context
|
|
* @param options
|
|
* @return Newly allocated mempool instance, NULL otherwise.
|
|
*
|
|
*/
|
|
EAPI Eina_Mempool *eina_mempool_add(const char *module, const char *context, const char *options, ...) EINA_MALLOC EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1);
|
|
|
|
/**
|
|
*
|
|
* @brief TODO
|
|
*
|
|
* @param mp The mempools
|
|
*
|
|
*/
|
|
EAPI void eina_mempool_del(Eina_Mempool *mp) EINA_ARG_NONNULL(1);
|
|
|
|
/**
|
|
* @brief Re-allocate an amount memory by the given mempool.
|
|
*
|
|
* @param mp The mempool.
|
|
* @param element The element to re-allocate.
|
|
* @param size The size in bytes to re-allocate.
|
|
* @return The newly re-allocated data.
|
|
*
|
|
* This function re-allocates and returns @p element with @p size bytes using the
|
|
* mempool @p mp. If not used anymore, the data must be freed with eina_mempool_free().
|
|
* @warning No checks are done for @p mp.
|
|
*/
|
|
static inline void *eina_mempool_realloc(Eina_Mempool *mp, void *element, unsigned int size) EINA_ARG_NONNULL(1) EINA_WARN_UNUSED_RESULT;
|
|
|
|
/**
|
|
* @brief Allocate memory using the given mempool.
|
|
*
|
|
* @param mp The mempool.
|
|
* @param size The size in bytes to allocate.
|
|
* @return The newly allocated data.
|
|
*
|
|
* This function allocates and returns @p size bytes using the mempool @p mp.
|
|
* If not used anymore, the data must be freed with eina_mempool_free().
|
|
* @warning No checks are done for @p mp.
|
|
*/
|
|
static inline void *eina_mempool_malloc(Eina_Mempool *mp, unsigned int size) EINA_MALLOC EINA_ARG_NONNULL(1) EINA_WARN_UNUSED_RESULT;
|
|
|
|
/**
|
|
* @brief Allocate and zero memory using the given mempool.
|
|
*
|
|
* @param mp The mempool.
|
|
* @param size The size in bytes to allocate.
|
|
* @return The newly allocated data.
|
|
*
|
|
* This function allocates, zeroes, and returns @p size bytes using the mempool @p mp.
|
|
* If not used anymore, the data must be freed with eina_mempool_free().
|
|
* @warning No checks are done for @p mp.
|
|
* @since 1.2
|
|
*/
|
|
static inline void *eina_mempool_calloc(Eina_Mempool *mp, unsigned int size) EINA_MALLOC EINA_ARG_NONNULL(1) EINA_WARN_UNUSED_RESULT;
|
|
|
|
/**
|
|
* @brief Free resources previously allocated by the given mempool.
|
|
*
|
|
* @param mp The mempool.
|
|
* @param element The data to free.
|
|
*
|
|
* This function frees @p element allocated by @p mp. @p element must
|
|
* have been obtained from eina_mempool_malloc(), eina_mempool_calloc(), or
|
|
* eina_mempool_realloc().
|
|
* @warning No checks are done for @p mp.
|
|
*/
|
|
static inline void eina_mempool_free(Eina_Mempool *mp, void *element) EINA_ARG_NONNULL(1);
|
|
|
|
/**
|
|
*
|
|
* @brief TODO
|
|
*
|
|
* @param mp The mempool
|
|
* @param cb The after repack callback
|
|
* @param data The data
|
|
*
|
|
*/
|
|
EAPI void eina_mempool_repack(Eina_Mempool *mp, Eina_Mempool_Repack_Cb cb, void *data) EINA_ARG_NONNULL(1, 2);
|
|
|
|
/**
|
|
*
|
|
* @brief TODO (garbage collect)
|
|
*
|
|
* @param mp The mempool
|
|
*
|
|
*/
|
|
EAPI void eina_mempool_gc(Eina_Mempool *mp) EINA_ARG_NONNULL(1);
|
|
|
|
/**
|
|
*
|
|
* @brief TODO
|
|
*
|
|
* @param mp The mempool
|
|
*
|
|
*/
|
|
EAPI void eina_mempool_statistics(Eina_Mempool *mp) EINA_ARG_NONNULL(1);
|
|
|
|
/**
|
|
*
|
|
* @brief TODO
|
|
*
|
|
* @param be The backend
|
|
* @return #EINA_TRUE if backend has been correctly registered, #EINA_FALSE
|
|
* otherwise.
|
|
*
|
|
*/
|
|
EAPI Eina_Bool eina_mempool_register(Eina_Mempool_Backend *be) EINA_ARG_NONNULL(1);
|
|
|
|
/**
|
|
*
|
|
* @brief TODO
|
|
*
|
|
* @param be The backend
|
|
*
|
|
*/
|
|
EAPI void eina_mempool_unregister(Eina_Mempool_Backend *be) EINA_ARG_NONNULL(1);
|
|
|
|
/**
|
|
*
|
|
* @brief TODO
|
|
*
|
|
* @param size
|
|
* @return #EINA_TRUE if backend has been correctly registered, #EINA_FALSE
|
|
* otherwise.
|
|
*
|
|
*/
|
|
static inline unsigned int eina_mempool_alignof(unsigned int size);
|
|
|
|
#include "eina_inline_mempool.x"
|
|
|
|
/**
|
|
* @}
|
|
*/
|
|
|
|
/**
|
|
* @}
|
|
*/
|
|
|
|
#endif /* EINA_MEMPOOL_H_ */
|