1
/* $Id: pool_alt.h 3553 2011-05-05 06:14:19Z nanang $ */
3
* Copyright (C) 2008-2011 Teluu Inc. (http://www.teluu.com)
4
* Copyright (C) 2003-2008 Benny Prijono <benny@prijono.org>
6
* This program is free software; you can redistribute it and/or modify
7
* it under the terms of the GNU General Public License as published by
8
* the Free Software Foundation; either version 2 of the License, or
9
* (at your option) any later version.
11
* This program is distributed in the hope that it will be useful,
12
* but WITHOUT ANY WARRANTY; without even the implied warranty of
13
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14
* GNU General Public License for more details.
16
* You should have received a copy of the GNU General Public License
17
* along with this program; if not, write to the Free Software
18
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
20
#ifndef __PJ_POOL_ALT_H__
21
#define __PJ_POOL_ALT_H__
27
* The type for function to receive callback from the pool when it is unable
28
* to allocate memory. The elegant way to handle this condition is to throw
29
* exception, and this is what is expected by most of this library
32
typedef void pj_pool_callback(pj_pool_t *pool, pj_size_t size);
36
struct pj_pool_mem *next;
38
/* data follows immediately */
44
struct pj_pool_mem *first_mem;
45
pj_pool_factory *factory;
52
#define PJ_POOL_SIZE (sizeof(struct pj_pool_t))
55
* This constant denotes the exception number that will be thrown by default
56
* memory factory policy when memory allocation fails.
58
extern int PJ_NO_MEMORY_EXCEPTION;
63
* Declare all pool API as macro that calls the implementation
66
#define pj_pool_create(fc,nm,init,inc,cb) \
67
pj_pool_create_imp(__FILE__, __LINE__, fc, nm, init, inc, cb)
69
#define pj_pool_release(pool) pj_pool_release_imp(pool)
70
#define pj_pool_getobjname(pool) pj_pool_getobjname_imp(pool)
71
#define pj_pool_reset(pool) pj_pool_reset_imp(pool)
72
#define pj_pool_get_capacity(pool) pj_pool_get_capacity_imp(pool)
73
#define pj_pool_get_used_size(pool) pj_pool_get_used_size_imp(pool)
74
#define pj_pool_alloc(pool,sz) \
75
pj_pool_alloc_imp(__FILE__, __LINE__, pool, sz)
77
#define pj_pool_calloc(pool,cnt,elem) \
78
pj_pool_calloc_imp(__FILE__, __LINE__, pool, cnt, elem)
80
#define pj_pool_zalloc(pool,sz) \
81
pj_pool_zalloc_imp(__FILE__, __LINE__, pool, sz)
86
* Declare prototypes for pool implementation API.
90
PJ_DECL(pj_pool_t*) pj_pool_create_imp(const char *file, int line,
93
pj_size_t initial_size,
94
pj_size_t increment_size,
95
pj_pool_callback *callback);
98
PJ_DECL(void) pj_pool_release_imp(pj_pool_t *pool);
101
PJ_DECL(const char*) pj_pool_getobjname_imp(pj_pool_t *pool);
104
PJ_DECL(void) pj_pool_reset_imp(pj_pool_t *pool);
107
PJ_DECL(pj_size_t) pj_pool_get_capacity_imp(pj_pool_t *pool);
109
/* Get total used size */
110
PJ_DECL(pj_size_t) pj_pool_get_used_size_imp(pj_pool_t *pool);
112
/* Allocate memory from the pool */
113
PJ_DECL(void*) pj_pool_alloc_imp(const char *file, int line,
114
pj_pool_t *pool, pj_size_t sz);
116
/* Allocate memory from the pool and zero the memory */
117
PJ_DECL(void*) pj_pool_calloc_imp(const char *file, int line,
118
pj_pool_t *pool, unsigned cnt,
121
/* Allocate memory from the pool and zero the memory */
122
PJ_DECL(void*) pj_pool_zalloc_imp(const char *file, int line,
123
pj_pool_t *pool, pj_size_t sz);
126
#define PJ_POOL_ZALLOC_T(pool,type) \
127
((type*)pj_pool_zalloc(pool, sizeof(type)))
128
#define PJ_POOL_ALLOC_T(pool,type) \
129
((type*)pj_pool_alloc(pool, sizeof(type)))
130
#ifndef PJ_POOL_ALIGNMENT
131
# define PJ_POOL_ALIGNMENT 4
135
* This structure declares pool factory interface.
137
typedef struct pj_pool_factory_policy
140
* Allocate memory block (for use by pool). This function is called
141
* by memory pool to allocate memory block.
143
* @param factory Pool factory.
144
* @param size The size of memory block to allocate.
146
* @return Memory block.
148
void* (*block_alloc)(pj_pool_factory *factory, pj_size_t size);
153
* @param factory Pool factory.
154
* @param mem Memory block previously allocated by block_alloc().
155
* @param size The size of memory block.
157
void (*block_free)(pj_pool_factory *factory, void *mem, pj_size_t size);
160
* Default callback to be called when memory allocation fails.
162
pj_pool_callback *callback;
169
} pj_pool_factory_policy;
171
struct pj_pool_factory
173
pj_pool_factory_policy policy;
177
struct pj_caching_pool
179
pj_pool_factory factory;
181
/* just to make it compilable */
184
unsigned peak_used_size;
187
/* just to make it compilable */
188
typedef struct pj_pool_block
193
#define pj_caching_pool_init( cp, pol, mac)
194
#define pj_caching_pool_destroy(cp)
195
#define pj_pool_factory_dump(pf, detail)
197
#endif /* __PJ_POOL_ALT_H__ */