style cleanup for mempool
[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 totelem, 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         /* allocate the pool structure */
92         if (flag & BLI_MEMPOOL_SYSMALLOC) {
93                 pool = malloc(sizeof(BLI_mempool));
94         }
95         else {
96                 pool = MEM_mallocN(sizeof(BLI_mempool), "memory pool");
97         }
98
99         /* set the elem size */
100         if (esize < MEMPOOL_ELEM_SIZE_MIN) {
101                 esize = MEMPOOL_ELEM_SIZE_MIN;
102         }
103
104         if (flag & BLI_MEMPOOL_ALLOW_ITER) {
105                 pool->esize = MAX2(esize, sizeof(BLI_freenode));
106         }
107         else {
108                 pool->esize = esize;
109         }
110
111         pool->flag = flag;
112         pool->pchunk = pchunk;
113         pool->csize = esize * pchunk;
114         pool->chunks.first = pool->chunks.last = NULL;
115         pool->totused = 0;
116         
117         maxchunks = totelem / pchunk + 1;
118         if (maxchunks == 0) {
119                 maxchunks = 1;
120         }
121
122         /* allocate the actual chunks */
123         for (i = 0; i < maxchunks; i++) {
124                 BLI_mempool_chunk *mpchunk;
125
126                 if (flag & BLI_MEMPOOL_SYSMALLOC) {
127                         mpchunk       = malloc(sizeof(BLI_mempool_chunk));
128                         mpchunk->data = malloc(pool->csize);
129                 }
130                 else {
131                         mpchunk       = MEM_mallocN(sizeof(BLI_mempool_chunk), "BLI_Mempool Chunk");
132                         mpchunk->data = MEM_mallocN(pool->csize, "BLI Mempool Chunk Data");
133                 }
134
135                 mpchunk->next = mpchunk->prev = NULL;
136                 BLI_addtail(&(pool->chunks), mpchunk);
137                 
138                 if (i == 0) {
139                         pool->free = mpchunk->data; /* start of the list */
140                         if (pool->flag & BLI_MEMPOOL_ALLOW_ITER) {
141                                 pool->free->freeword = FREEWORD;
142                         }
143                 }
144
145                 /* loop through the allocated data, building the pointer structures */
146                 for (addr = mpchunk->data, j = 0; j < pool->pchunk; j++) {
147                         curnode = ((BLI_freenode *)addr);
148                         addr += pool->esize;
149                         curnode->next = (BLI_freenode *)addr;
150                         if (pool->flag & BLI_MEMPOOL_ALLOW_ITER) {
151                                 if (j != pool->pchunk - 1)
152                                         curnode->next->freeword = FREEWORD;
153                                 curnode->freeword = FREEWORD;
154                         }
155                 }
156                 /* final pointer in the previously allocated chunk is wrong */
157                 if (lasttail) {
158                         lasttail->next = mpchunk->data;
159                         if (pool->flag & BLI_MEMPOOL_ALLOW_ITER) {
160                                 lasttail->freeword = FREEWORD;
161                         }
162                 }
163
164                 /* set the end of this chunks memoryy to the new tail for next iteration */
165                 lasttail = curnode;
166
167                 pool->totalloc += pool->pchunk;
168         }
169         /* terminate the list */
170         curnode->next = NULL;
171         return pool;
172 }
173
174 void *BLI_mempool_alloc(BLI_mempool *pool)
175 {
176         void *retval = NULL;
177
178         pool->totused++;
179
180         if (!(pool->free)) {
181                 BLI_freenode *curnode = NULL;
182                 char *addr;
183                 int j;
184
185                 /* need to allocate a new chunk */
186                 BLI_mempool_chunk *mpchunk;
187
188                 if (pool->flag & BLI_MEMPOOL_SYSMALLOC) {
189                         mpchunk       = malloc(sizeof(BLI_mempool_chunk));
190                         mpchunk->data = malloc(pool->csize);
191                 }
192                 else {
193                         mpchunk       = MEM_mallocN(sizeof(BLI_mempool_chunk), "BLI_Mempool Chunk");
194                         mpchunk->data = MEM_mallocN(pool->csize, "BLI_Mempool Chunk Data");
195                 }
196
197                 mpchunk->next = mpchunk->prev = NULL;
198                 BLI_addtail(&(pool->chunks), mpchunk);
199
200                 pool->free = mpchunk->data; /* start of the list */
201
202                 if (pool->flag & BLI_MEMPOOL_ALLOW_ITER) {
203                         pool->free->freeword = FREEWORD;
204                 }
205
206                 for (addr = mpchunk->data, j = 0; j < pool->pchunk; j++) {
207                         curnode = ((BLI_freenode *)addr);
208                         addr += pool->esize;
209                         curnode->next = (BLI_freenode *)addr;
210
211                         if (pool->flag & BLI_MEMPOOL_ALLOW_ITER) {
212                                 curnode->freeword = FREEWORD;
213                                 if (j != pool->pchunk - 1)
214                                         curnode->next->freeword = FREEWORD;
215                         }
216                 }
217                 curnode->next = NULL; /* terminate the list */
218
219                 pool->totalloc += pool->pchunk;
220         }
221
222         retval = pool->free;
223
224         if (pool->flag & BLI_MEMPOOL_ALLOW_ITER) {
225                 pool->free->freeword = 0x7FFFFFFF;
226         }
227
228         pool->free = pool->free->next;
229         //memset(retval, 0, pool->esize);
230         return retval;
231 }
232
233 void *BLI_mempool_calloc(BLI_mempool *pool)
234 {
235         void *retval = BLI_mempool_alloc(pool);
236         memset(retval, 0, pool->esize);
237         return retval;
238 }
239
240 /* doesnt protect against double frees, dont be stupid! */
241 void BLI_mempool_free(BLI_mempool *pool, void *addr)
242 {
243         BLI_freenode *newhead = addr;
244
245         if (pool->flag & BLI_MEMPOOL_ALLOW_ITER) {
246                 newhead->freeword = FREEWORD;
247         }
248
249         newhead->next = pool->free;
250         pool->free = newhead;
251
252         pool->totused--;
253
254         /* nothing is in use; free all the chunks except the first */
255         if (pool->totused == 0) {
256                 BLI_freenode *curnode = NULL;
257                 char *tmpaddr = NULL;
258                 int i;
259
260                 BLI_mempool_chunk *mpchunk = NULL;
261                 BLI_mempool_chunk *first = pool->chunks.first;
262
263                 BLI_remlink(&pool->chunks, first);
264
265                 if (pool->flag & BLI_MEMPOOL_SYSMALLOC) {
266                         for (mpchunk = pool->chunks.first; mpchunk; mpchunk = mpchunk->next) {
267                                 free(mpchunk->data);
268                         }
269                         BLI_freelist(&(pool->chunks));
270                 }
271                 else {
272                         for (mpchunk = pool->chunks.first; mpchunk; mpchunk = mpchunk->next) {
273                                 MEM_freeN(mpchunk->data);
274                         }
275                         BLI_freelistN(&(pool->chunks));
276                 }
277
278                 BLI_addtail(&pool->chunks, first);
279                 pool->totalloc = pool->pchunk;
280
281                 pool->free = first->data; /* start of the list */
282                 for (tmpaddr = first->data, i = 0; i < pool->pchunk; i++) {
283                         curnode = ((BLI_freenode *)tmpaddr);
284                         tmpaddr += pool->esize;
285                         curnode->next = (BLI_freenode *)tmpaddr;
286                 }
287                 curnode->next = NULL; /* terminate the list */
288         }
289 }
290
291 int BLI_mempool_count(BLI_mempool *pool)
292 {
293         return pool->totused;
294 }
295
296 void *BLI_mempool_findelem(BLI_mempool *pool, int index)
297 {
298         if (!(pool->flag & BLI_MEMPOOL_ALLOW_ITER)) {
299                 fprintf(stderr, "%s: Error! you can't iterate over this mempool!\n", __func__);
300                 return NULL;
301         }
302         else if ((index >= 0) && (index < pool->totused)) {
303                 /* we could have some faster mem chunk stepping code inline */
304                 BLI_mempool_iter iter;
305                 void *elem;
306                 BLI_mempool_iternew(pool, &iter);
307                 for (elem = BLI_mempool_iterstep(&iter); index-- != 0; elem = BLI_mempool_iterstep(&iter)) { };
308                 return elem;
309         }
310
311         return NULL;
312 }
313
314 void BLI_mempool_iternew(BLI_mempool *pool, BLI_mempool_iter *iter)
315 {
316         if (!(pool->flag & BLI_MEMPOOL_ALLOW_ITER)) {
317                 fprintf(stderr, "%s: Error! you can't iterate over this mempool!\n", __func__);
318                 iter->curchunk = NULL;
319                 iter->curindex = 0;
320                 
321                 return;
322         }
323         
324         iter->pool = pool;
325         iter->curchunk = pool->chunks.first;
326         iter->curindex = 0;
327 }
328
329 #if 0
330 /* unoptimized, more readable */
331
332 static void *bli_mempool_iternext(BLI_mempool_iter *iter)
333 {
334         void *ret = NULL;
335         
336         if (!iter->curchunk || !iter->pool->totused) return NULL;
337         
338         ret = ((char *)iter->curchunk->data) + iter->pool->esize * iter->curindex;
339         
340         iter->curindex++;
341         
342         if (iter->curindex >= iter->pool->pchunk) {
343                 iter->curchunk = iter->curchunk->next;
344                 iter->curindex = 0;
345         }
346         
347         return ret;
348 }
349
350 void *BLI_mempool_iterstep(BLI_mempool_iter *iter)
351 {
352         BLI_freenode *ret;
353         
354         do {
355                 ret = bli_mempool_iternext(iter);
356         } while (ret && ret->freeword == FREEWORD);
357         
358         return ret;
359 }
360
361 #else
362
363 /* optimized version of code above */
364
365 void *BLI_mempool_iterstep(BLI_mempool_iter *iter)
366 {
367         BLI_freenode *ret;
368
369         if (UNLIKELY(iter->pool->totused == 0)) {
370                 return NULL;
371         }
372
373         do {
374                 if (LIKELY(iter->curchunk)) {
375                         ret = (BLI_freenode *)(((char *)iter->curchunk->data) + iter->pool->esize * iter->curindex);
376                 }
377                 else {
378                         return NULL;
379                 }
380
381                 if (UNLIKELY(++iter->curindex >= iter->pool->pchunk)) {
382                         iter->curindex = 0;
383                         iter->curchunk = iter->curchunk->next;
384                 }
385         } while (ret->freeword == FREEWORD);
386         
387         return ret;
388 }
389
390 #endif
391
392 void BLI_mempool_destroy(BLI_mempool *pool)
393 {
394         BLI_mempool_chunk *mpchunk = NULL;
395
396         if (pool->flag & BLI_MEMPOOL_SYSMALLOC) {
397                 for (mpchunk = pool->chunks.first; mpchunk; mpchunk = mpchunk->next) {
398                         free(mpchunk->data);
399                 }
400                 BLI_freelist(&(pool->chunks));
401                 free(pool);
402         }
403         else {
404                 for (mpchunk = pool->chunks.first; mpchunk; mpchunk = mpchunk->next) {
405                         MEM_freeN(mpchunk->data);
406                 }
407                 BLI_freelistN(&(pool->chunks));
408                 MEM_freeN(pool);
409         }
410 }