Code Cleanup: update to mempool, use flag rather then bool args.
[blender.git] / source / blender / blenlib / intern / BLI_mempool.c
1 /*
2  * ***** BEGIN GPL LICENSE BLOCK *****
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU General Public License
6  * as published by the Free Software Foundation; either version 2
7  * of the License, or (at your option) any later version.
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software Foundation,
16  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
17  *
18  * The Original Code is Copyright (C) 2008 by Blender Foundation.
19  * All rights reserved.
20  *
21  * The Original Code is: all of this file.
22  *
23  * Contributor(s): Geoffery Bantle
24  *
25  * ***** END GPL LICENSE BLOCK *****
26  */
27
28 /** \file blender/blenlib/intern/BLI_mempool.c
29  *  \ingroup bli
30  */
31
32 /*
33  * Simple, fast memory allocator for allocating many elements of the same size.
34  */
35
36 #include "BLI_utildefines.h"
37 #include "BLI_listbase.h"
38
39 #include "BLI_mempool.h" /* own include */
40
41 #include "DNA_listBase.h"
42
43 #include "MEM_guardedalloc.h"
44
45 #include <string.h>
46 #include <stdlib.h>
47
48 /* note: copied from BKE_utildefines.h, dont use here because we're in BLI */
49 #ifdef __BIG_ENDIAN__
50 /* Big Endian */
51 #  define MAKE_ID(a,b,c,d) ( (int)(a)<<24 | (int)(b)<<16 | (c)<<8 | (d) )
52 #else
53 /* Little Endian */
54 #  define MAKE_ID(a,b,c,d) ( (int)(d)<<24 | (int)(c)<<16 | (b)<<8 | (a) )
55 #endif
56
57 #define FREEWORD MAKE_ID('f', 'r', 'e', 'e')
58
59 typedef struct BLI_freenode {
60         struct BLI_freenode *next;
61         int freeword; /* used to identify this as a freed node */
62 } BLI_freenode;
63
64 typedef struct BLI_mempool_chunk {
65         struct BLI_mempool_chunk *next, *prev;
66         void *data;
67 } BLI_mempool_chunk;
68
69 struct BLI_mempool {
70         struct ListBase chunks;
71         int esize;         /* element size in bytes */
72         int csize;         /* chunk size in bytes */
73         int pchunk;        /* number of elements per chunk */
74         int flag;
75         /* keeps aligned to 16 bits */
76
77         BLI_freenode *free;                  /* free element list. Interleaved into chunk datas.*/
78         int totalloc, totused;           /* total number of elements allocated in total,
79                                           * and currently in use*/
80 };
81
82 #define MEMPOOL_ELEM_SIZE_MIN (sizeof(void *) * 2)
83
84 BLI_mempool *BLI_mempool_create(int esize, int tote, int pchunk, int flag)
85 {
86         BLI_mempool  *pool = NULL;
87         BLI_freenode *lasttail = NULL, *curnode = NULL;
88         int i,j, maxchunks;
89         char *addr;
90
91         if (esize < MEMPOOL_ELEM_SIZE_MIN)
92                 esize = MEMPOOL_ELEM_SIZE_MIN;
93
94         /*allocate the pool structure*/
95         pool = (flag & BLI_MEMPOOL_SYSMALLOC) ? malloc(sizeof(BLI_mempool)) : MEM_mallocN(sizeof(BLI_mempool), "memory pool");
96         pool->esize = (flag & BLI_MEMPOOL_ALLOW_ITER) ? MAX2(esize, sizeof(BLI_freenode)) : esize;
97         pool->flag = flag;
98         pool->pchunk = pchunk;
99         pool->csize = esize * pchunk;
100         pool->chunks.first = pool->chunks.last = NULL;
101         pool->totused= 0;
102         
103         maxchunks = tote / pchunk + 1;
104         if (maxchunks==0) maxchunks = 1;
105
106         /* allocate the actual chunks */
107         for (i = 0; i < maxchunks; i++) {
108                 BLI_mempool_chunk *mpchunk;
109
110                 if (flag & BLI_MEMPOOL_SYSMALLOC) {
111                         mpchunk       = malloc(sizeof(BLI_mempool_chunk));
112                         mpchunk->data = malloc(pool->csize);
113                 }
114                 else {
115                         mpchunk       = MEM_mallocN(sizeof(BLI_mempool_chunk), "BLI_Mempool Chunk");
116                         mpchunk->data = MEM_mallocN(pool->csize, "BLI Mempool Chunk Data");
117                 }
118
119                 mpchunk->next = mpchunk->prev = NULL;
120                 BLI_addtail(&(pool->chunks), mpchunk);
121                 
122                 if (i==0) {
123                         pool->free = mpchunk->data; /*start of the list*/
124                         if (pool->flag & BLI_MEMPOOL_ALLOW_ITER) {
125                                 pool->free->freeword = FREEWORD;
126                         }
127                 }
128
129                 /*loop through the allocated data, building the pointer structures*/
130                 for (addr = mpchunk->data, j=0; j < pool->pchunk; j++) {
131                         curnode = ((BLI_freenode*)addr);
132                         addr += pool->esize;
133                         curnode->next = (BLI_freenode*)addr;
134                         if (pool->flag & BLI_MEMPOOL_ALLOW_ITER) {
135                                 if (j != pool->pchunk-1)
136                                         curnode->next->freeword = FREEWORD;
137                                 curnode->freeword = FREEWORD;
138                         }
139                 }
140                 /*final pointer in the previously allocated chunk is wrong.*/
141                 if (lasttail) {
142                         lasttail->next = mpchunk->data;
143                         if (pool->flag & BLI_MEMPOOL_ALLOW_ITER) {
144                                 lasttail->freeword = FREEWORD;
145                         }
146                 }
147
148                 /*set the end of this chunks memoryy to the new tail for next iteration*/
149                 lasttail = curnode;
150
151                 pool->totalloc += pool->pchunk;
152         }
153         /*terminate the list*/
154         curnode->next = NULL;
155         return pool;
156 }
157
158 void *BLI_mempool_alloc(BLI_mempool *pool)
159 {
160         void *retval=NULL;
161
162         pool->totused++;
163
164         if (!(pool->free)) {
165                 BLI_freenode *curnode=NULL;
166                 char *addr;
167                 int j;
168
169                 /*need to allocate a new chunk*/
170                 BLI_mempool_chunk *mpchunk;
171
172                 if (pool->flag & BLI_MEMPOOL_SYSMALLOC) {
173                         mpchunk       = malloc(sizeof(BLI_mempool_chunk));
174                         mpchunk->data = malloc(pool->csize);
175                 }
176                 else {
177                         mpchunk       = MEM_mallocN(sizeof(BLI_mempool_chunk), "BLI_Mempool Chunk");
178                         mpchunk->data = MEM_mallocN(pool->csize, "BLI_Mempool Chunk Data");
179                 }
180
181                 mpchunk->next = mpchunk->prev = NULL;
182                 BLI_addtail(&(pool->chunks), mpchunk);
183
184                 pool->free = mpchunk->data; /* start of the list */
185
186                 if (pool->flag & BLI_MEMPOOL_ALLOW_ITER) {
187                         pool->free->freeword = FREEWORD;
188                 }
189
190                 for(addr = mpchunk->data, j=0; j < pool->pchunk; j++) {
191                         curnode = ((BLI_freenode*)addr);
192                         addr += pool->esize;
193                         curnode->next = (BLI_freenode*)addr;
194
195                         if (pool->flag & BLI_MEMPOOL_ALLOW_ITER) {
196                                 curnode->freeword = FREEWORD;
197                                 if (j != pool->pchunk-1)
198                                         curnode->next->freeword = FREEWORD;
199                         }
200                 }
201                 curnode->next = NULL; /*terminate the list*/
202
203                 pool->totalloc += pool->pchunk;
204         }
205
206         retval = pool->free;
207
208         if (pool->flag & BLI_MEMPOOL_ALLOW_ITER) {
209                 pool->free->freeword = 0x7FFFFFFF;
210         }
211
212         pool->free = pool->free->next;
213         //memset(retval, 0, pool->esize);
214         return retval;
215 }
216
217 void *BLI_mempool_calloc(BLI_mempool *pool)
218 {
219         void *retval= BLI_mempool_alloc(pool);
220         memset(retval, 0, pool->esize);
221         return retval;
222 }
223
224 /* doesnt protect against double frees, dont be stupid! */
225 void BLI_mempool_free(BLI_mempool *pool, void *addr)
226 {
227         BLI_freenode *newhead = addr;
228
229         if (pool->flag & BLI_MEMPOOL_ALLOW_ITER) {
230                 newhead->freeword = FREEWORD;
231         }
232
233         newhead->next = pool->free;
234         pool->free = newhead;
235
236         pool->totused--;
237
238         /*nothing is in use; free all the chunks except the first*/
239         if (pool->totused == 0) {
240                 BLI_freenode *curnode=NULL;
241                 char *tmpaddr=NULL;
242                 int i;
243
244                 BLI_mempool_chunk *mpchunk=NULL;
245                 BLI_mempool_chunk *first= pool->chunks.first;
246
247                 BLI_remlink(&pool->chunks, first);
248
249                 if (pool->flag & BLI_MEMPOOL_SYSMALLOC) {
250                         for (mpchunk = pool->chunks.first; mpchunk; mpchunk = mpchunk->next) {
251                                 free(mpchunk->data);
252                         }
253                         BLI_freelist(&(pool->chunks));
254                 }
255                 else {
256                         for (mpchunk = pool->chunks.first; mpchunk; mpchunk = mpchunk->next) {
257                                 MEM_freeN(mpchunk->data);
258                         }
259                         BLI_freelistN(&(pool->chunks));
260                 }
261
262                 BLI_addtail(&pool->chunks, first);
263                 pool->totalloc = pool->pchunk;
264
265                 pool->free = first->data; /*start of the list*/
266                 for (tmpaddr = first->data, i=0; i < pool->pchunk; i++) {
267                         curnode = ((BLI_freenode*)tmpaddr);
268                         tmpaddr += pool->esize;
269                         curnode->next = (BLI_freenode*)tmpaddr;
270                 }
271                 curnode->next = NULL; /*terminate the list*/
272         }
273 }
274
275 int BLI_mempool_count(BLI_mempool *pool)
276 {
277         return pool->totused;
278 }
279
280 void *BLI_mempool_findelem(BLI_mempool *pool, int index)
281 {
282         if (!(pool->flag & BLI_MEMPOOL_ALLOW_ITER)) {
283                 fprintf(stderr, "%s: Error! you can't iterate over this mempool!\n", __func__);
284                 return NULL;
285         }
286         else if ((index >= 0) && (index < pool->totused)) {
287                 /* we could have some faster mem chunk stepping code inline */
288                 BLI_mempool_iter iter;
289                 void *elem;
290                 BLI_mempool_iternew(pool, &iter);
291                 for (elem= BLI_mempool_iterstep(&iter); index-- != 0; elem= BLI_mempool_iterstep(&iter)) { };
292                 return elem;
293         }
294
295         return NULL;
296 }
297
298 void BLI_mempool_iternew(BLI_mempool *pool, BLI_mempool_iter *iter)
299 {
300         if (!(pool->flag & BLI_MEMPOOL_ALLOW_ITER)) {
301                 fprintf(stderr, "%s: Error! you can't iterate over this mempool!\n", __func__);
302                 iter->curchunk = NULL;
303                 iter->curindex = 0;
304                 
305                 return;
306         }
307         
308         iter->pool = pool;
309         iter->curchunk = pool->chunks.first;
310         iter->curindex = 0;
311 }
312
313 #if 0
314 /* unoptimized, more readable */
315
316 static void *bli_mempool_iternext(BLI_mempool_iter *iter)
317 {
318         void *ret = NULL;
319         
320         if (!iter->curchunk || !iter->pool->totused) return NULL;
321         
322         ret = ((char*)iter->curchunk->data) + iter->pool->esize*iter->curindex;
323         
324         iter->curindex++;
325         
326         if (iter->curindex >= iter->pool->pchunk) {
327                 iter->curchunk = iter->curchunk->next;
328                 iter->curindex = 0;
329         }
330         
331         return ret;
332 }
333
334 void *BLI_mempool_iterstep(BLI_mempool_iter *iter)
335 {
336         BLI_freenode *ret;
337         
338         do {
339                 ret = bli_mempool_iternext(iter);
340         } while (ret && ret->freeword == FREEWORD);
341         
342         return ret;
343 }
344
345 #else
346
347 /* optimized version of code above */
348
349 void *BLI_mempool_iterstep(BLI_mempool_iter *iter)
350 {
351         BLI_freenode *ret;
352
353         if (UNLIKELY(iter->pool->totused == 0)) {
354                 return NULL;
355         }
356
357         do {
358                 if (LIKELY(iter->curchunk)) {
359                         ret = (BLI_freenode *)(((char*)iter->curchunk->data) + iter->pool->esize*iter->curindex);
360                 }
361                 else {
362                         return NULL;
363                 }
364
365                 if (UNLIKELY(++iter->curindex >= iter->pool->pchunk)) {
366                         iter->curindex = 0;
367                         iter->curchunk = iter->curchunk->next;
368                 }
369         } while (ret->freeword == FREEWORD);
370         
371         return ret;
372 }
373
374 #endif
375
376 void BLI_mempool_destroy(BLI_mempool *pool)
377 {
378         BLI_mempool_chunk *mpchunk=NULL;
379
380         if (pool->flag & BLI_MEMPOOL_SYSMALLOC) {
381                 for (mpchunk = pool->chunks.first; mpchunk; mpchunk = mpchunk->next) {
382                         free(mpchunk->data);
383                 }
384                 BLI_freelist(&(pool->chunks));
385                 free(pool);
386         }
387         else {
388                 for (mpchunk = pool->chunks.first; mpchunk; mpchunk = mpchunk->next) {
389                         MEM_freeN(mpchunk->data);
390                 }
391                 BLI_freelistN(&(pool->chunks));
392                 MEM_freeN(pool);
393         }
394 }