2 * Bacula memory pool routines.
4 * The idea behind these routines is that there will be
5 * pools of memory that are pre-allocated for quick
6 * access. The pools will have a fixed memory size on allocation
7 * but if need be, the size can be increased. This is
8 * particularly useful for filename
9 * buffers where 256 bytes should be sufficient in 99.99%
10 * of the cases, but when it isn't we want to be able to
13 * A major advantage of the pool memory aside from the speed
14 * is that the buffer carrys around its size, so to ensure that
15 * there is enough memory, simply call the check_pool_memory_size()
16 * with the desired size and it will adjust only if necessary.
24 Copyright (C) 2000, 2001, 2002 Kern Sibbald and John Walker
26 This program is free software; you can redistribute it and/or
27 modify it under the terms of the GNU General Public License as
28 published by the Free Software Foundation; either version 2 of
29 the License, or (at your option) any later version.
31 This program is distributed in the hope that it will be useful,
32 but WITHOUT ANY WARRANTY; without even the implied warranty of
33 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
34 General Public License for more details.
36 You should have received a copy of the GNU General Public
37 License along with this program; if not, write to the Free
38 Software Foundation, Inc., 59 Temple Place - Suite 330, Boston,
46 size_t size; /* default size */
47 size_t max_size; /* max allocated */
48 size_t max_used; /* max buffers used */
49 size_t in_use; /* number in use */
50 struct abufhead *free_buf; /* pointer to free buffers */
53 static struct s_pool_ctl pool_ctl[] = {
54 { 256, 256, 0, 0, NULL }, /* PM_NOPOOL no pooling */
55 { 256, 256, 0, 0, NULL }, /* PM_FNAME filename buffers */
56 { 512, 512, 0, 0, NULL }, /* PM_MESSAGE message buffer */
57 { 1024, 1024, 0, 0, NULL } /* PM_EMSG error message buffer */
60 /* Memory allocation control structures and storage. */
62 size_t ablen; /* Buffer length in bytes */
63 int32_t pool; /* pool */
64 struct abufhead *next; /* pointer to next free buffer */
67 static pthread_mutex_t mutex = PTHREAD_MUTEX_INITIALIZER;
72 #define HEAD_SIZE BALIGN(sizeof(struct abufhead))
74 extern POOLMEM *sm_malloc(char *fname, int lineno, int nbytes);
76 POOLMEM *sm_get_pool_memory(char *fname, int lineno, int pool)
80 sm_check(fname, lineno, True);
82 Emsg2(M_ABORT, 0, "MemPool index %d larger than max %d\n", pool, PM_MAX);
85 if (pool_ctl[pool].free_buf) {
86 buf = pool_ctl[pool].free_buf;
87 pool_ctl[pool].free_buf = buf->next;
88 pool_ctl[pool].in_use++;
89 if (pool_ctl[pool].in_use > pool_ctl[pool].max_used) {
90 pool_ctl[pool].max_used = pool_ctl[pool].in_use;
93 Dmsg3(150, "sm_get_pool_memory reuse %x to %s:%d\n", buf, fname, lineno);
94 sm_new_owner(fname, lineno, (char *)buf);
95 return (POOLMEM *)((char *)buf+HEAD_SIZE);
98 if ((buf = (struct abufhead *) sm_malloc(fname, lineno, pool_ctl[pool].size+HEAD_SIZE)) == NULL) {
100 Emsg1(M_ABORT, 0, "Out of memory requesting %d bytes\n", pool_ctl[pool].size);
102 buf->ablen = pool_ctl[pool].size;
104 pool_ctl[pool].in_use++;
105 if (pool_ctl[pool].in_use > pool_ctl[pool].max_used) {
106 pool_ctl[pool].max_used = pool_ctl[pool].in_use;
109 Dmsg3(150, "sm_get_pool_memory give %x to %s:%d\n", buf, fname, lineno);
110 return (POOLMEM *)((char *)buf+HEAD_SIZE);
113 /* Get nonpool memory of size requested */
114 POOLMEM *sm_get_memory(char *fname, int lineno, size_t size)
116 struct abufhead *buf;
119 sm_check(fname, lineno, True);
120 if ((buf = (struct abufhead *) sm_malloc(fname, lineno, size+HEAD_SIZE)) == NULL) {
121 Emsg1(M_ABORT, 0, "Out of memory requesting %d bytes\n", size);
126 pool_ctl[pool].in_use++;
127 if (pool_ctl[pool].in_use > pool_ctl[pool].max_used)
128 pool_ctl[pool].max_used = pool_ctl[pool].in_use;
129 return (POOLMEM *)(((char *)buf)+HEAD_SIZE);
134 POOLMEM *get_pool_memory(int pool)
136 struct abufhead *buf;
139 if (pool_ctl[pool].free_buf) {
140 buf = pool_ctl[pool].free_buf;
141 pool_ctl[pool].free_buf = buf->next;
143 return (POOLMEM *)((char *)buf+HEAD_SIZE);
146 if ((buf=malloc(pool_ctl[pool].size+HEAD_SIZE)) == NULL) {
148 Emsg1(M_ABORT, 0, "Out of memory requesting %d bytes\n", pool_ctl[pool].size);
150 buf->ablen = pool_ctl[pool].size;
153 pool_ctl[pool].in_use++;
154 if (pool_ctl[pool].in_use > pool_ctl[pool].max_used) {
155 pool_ctl[pool].max_used = pool_ctl[pool].in_use;
158 return (POOLMEM *)(((char *)buf)+HEAD_SIZE);
161 /* Get nonpool memory of size requested */
162 POOLMEM *get_memory(size_t size)
164 struct abufhead *buf;
167 if ((buf=malloc(size+HEAD_SIZE)) == NULL) {
168 Emsg1(M_ABORT, 0, "Out of memory requesting %d bytes\n", size);
173 pool_ctl[pool].in_use++;
174 if (pool_ctl[pool].in_use > pool_ctl[pool].max_used) {
175 pool_ctl[pool].max_used = pool_ctl[pool].in_use;
177 return (POOLMEM *)(((char *)buf)+HEAD_SIZE);
179 #endif /* SMARTALLOC */
183 /* Free a memory buffer */
184 void free_pool_memory(POOLMEM *obuf)
186 struct abufhead *buf;
189 sm_check(__FILE__, __LINE__, False);
192 buf = (struct abufhead *)((char *)obuf - HEAD_SIZE);
194 pool_ctl[pool].in_use--;
196 free((char *)buf); /* free nonpooled memory */
197 } else { /* otherwise link it to the free pool chain */
199 struct abufhead *next;
200 /* Don't let him free the same buffer twice */
201 for (next=pool_ctl[pool].free_buf; next; next=next->next) {
202 ASSERT(next != buf); /* attempt to free twice */
205 buf->next = pool_ctl[pool].free_buf;
206 pool_ctl[pool].free_buf = buf;
208 Dmsg2(150, "free_pool_memory %x pool=%d\n", buf, pool);
213 /* Return the size of a memory buffer */
214 size_t sizeof_pool_memory(POOLMEM *obuf)
216 char *cp = (char *)obuf;
218 sm_check(__FILE__, __LINE__, False);
221 return ((struct abufhead *)cp)->ablen;
224 /* Realloc pool memory buffer */
225 POOLMEM *realloc_pool_memory(POOLMEM *obuf, size_t size)
227 char *cp = (char *)obuf;
231 sm_check(__FILE__, __LINE__, False);
235 buf = realloc(cp, size+HEAD_SIZE);
238 Emsg1(M_ABORT, 0, "Out of memory requesting %d bytes\n", size);
240 ((struct abufhead *)buf)->ablen = size;
241 pool = ((struct abufhead *)buf)->pool;
242 if (size > pool_ctl[pool].max_size) {
243 pool_ctl[pool].max_size = size;
246 sm_check(__FILE__, __LINE__, False);
247 return (POOLMEM *)(((char *)buf)+HEAD_SIZE);
250 POOLMEM *check_pool_memory_size(POOLMEM *obuf, size_t size)
252 sm_check(__FILE__, __LINE__, False);
254 if (size <= sizeof_pool_memory(obuf)) {
257 return realloc_pool_memory(obuf, size);
260 /* Release all pooled memory */
261 void close_memory_pool()
263 struct abufhead *buf, *next;
266 sm_check(__FILE__, __LINE__, False);
268 for (i=1; i<=PM_MAX; i++) {
269 buf = pool_ctl[i].free_buf;
275 pool_ctl[i].free_buf = NULL;
282 static char *pool_name(int pool)
284 static char *name[] = {"NoPool", "FNAME ", "MSG ", "EMSG "};
287 if (pool >= 0 && pool <= PM_MAX) {
290 sprintf(buf, "%-6d", pool);
294 /* Print staticstics on memory pool usage
296 void print_memory_pool_stats()
300 Dmsg0(-1, "Pool Maxsize Maxused Inuse\n");
301 for (i=0; i<=PM_MAX; i++)
302 Dmsg4(-1, "%5s %7d %7d %5d\n", pool_name(i), pool_ctl[i].max_size,
303 pool_ctl[i].max_used, pool_ctl[i].in_use);
309 void print_memory_pool_stats() {}