Files
rathena/src/common/mempool.h
brianluau a2bdc47daf - Undid r16968: SVN Replaced with source:/trunk/src/@16966 (tid:74924).
[16969:16991/trunk/src/] will be re-committed in the next 24 hours.

git-svn-id: https://svn.code.sf.net/p/rathena/svn/trunk@16992 54d463be-8e91-2dee-dedb-b68131a5f0ec
2012-12-05 02:53:33 +00:00

101 lines
2.3 KiB
C

#ifndef _rA_MEMPOOL_H_
#define _rA_MEMPOOL_H_
#include "../common/cbasetypes.h"
typedef struct mempool *mempool;
typedef void (*memPoolOnNodeAllocationProc)(void *ptr);
typedef void (*memPoolOnNodeDeallocationProc)(void *ptr);
typedef struct mempool_stats{
int64 num_nodes_total;
int64 num_nodes_free;
int64 num_nodes_used;
int64 num_segments;
int64 num_realloc_events;
int64 peak_nodes_used;
int64 num_bytes_total;
} mempool_stats;
//
void mempool_init();
void mempool_final();
/**
* Creates a new Mempool
*
* @param name - Name of the pool (used for debug / error messages)
* @param elem_size - size of each element
* @param initial_count - preallocation count
* @param realloc_count - #no of nodes being allocated when pool is running empty.
* @param onNodeAlloc - Node Allocation callback (see @note!)
* @param onNodeDealloc - Node Deallocation callback (see @note!)
*
* @note:
* The onNode(De)alloc callbacks are only called once during segment allocation
* (pool initialization / rallocation )
* you can use this callbacks for example to initlaize a mutex or somethingelse
* you definitly need during runtime
*
* @return not NULL
*/
mempool mempool_create(const char *name,
uint64 elem_size,
uint64 initial_count,
uint64 realloc_count,
memPoolOnNodeAllocationProc onNodeAlloc,
memPoolOnNodeDeallocationProc onNodeDealloc);
/**
* Destroys a Mempool
*
* @param pool - the mempool to destroy
*
* @note:
* Everything gets deallocated, regardless if everything was freed properly!
* So you have to ensure that all references are cleared properly!
*/
void mempool_destroy(mempool pool);
/**
* Gets a new / empty node from the given mempool.
*
* @param pool - the pool to get an empty node from.
*
* @return Address of empty Node
*/
void *mempool_node_get(mempool pool);
/**
* Returns the given node to the given mempool
*
* @param pool - the pool to put the node, to
* @param node - the node to return
*/
void mempool_node_put(mempool pool, void *node);
/**
* Returns Statistics for the given mempool
*
* @param pool - the pool to get thats for
*
* @note: i dont like pushing masses of values over the stack, too - but its lazy and okay for stats. (blacksirius)
*
* @return stats struct
*/
mempool_stats mempool_get_stats(mempool pool);
#endif