mempool utility function to get the element at an index BLI_mempool_findelem(), not...
[blender-staging.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         short use_sysmalloc, allow_iter;
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,
85                                 short use_sysmalloc, short allow_iter)
86 {
87         BLI_mempool  *pool = NULL;
88         BLI_freenode *lasttail = NULL, *curnode = NULL;
89         int i,j, maxchunks;
90         char *addr;
91
92         if (esize < MEMPOOL_ELEM_SIZE_MIN)
93                 esize = MEMPOOL_ELEM_SIZE_MIN;
94
95         /*allocate the pool structure*/
96         pool = use_sysmalloc ? malloc(sizeof(BLI_mempool)) : MEM_mallocN(sizeof(BLI_mempool), "memory pool");
97         pool->esize = allow_iter ? MAX2(esize, sizeof(BLI_freenode)) : esize;
98         pool->use_sysmalloc = use_sysmalloc;
99         pool->pchunk = pchunk;
100         pool->csize = esize * pchunk;
101         pool->chunks.first = pool->chunks.last = NULL;
102         pool->totused= 0;
103         pool->allow_iter= allow_iter;
104         
105         maxchunks = tote / pchunk + 1;
106         if (maxchunks==0) maxchunks = 1;
107
108         /*allocate the actual chunks*/
109         for (i=0; i < maxchunks; i++) {
110                 BLI_mempool_chunk *mpchunk = use_sysmalloc ? malloc(sizeof(BLI_mempool_chunk)) : MEM_mallocN(sizeof(BLI_mempool_chunk), "BLI_Mempool Chunk");
111                 mpchunk->next = mpchunk->prev = NULL;
112                 mpchunk->data = use_sysmalloc ? malloc(pool->csize) : MEM_mallocN(pool->csize, "BLI Mempool Chunk Data");
113                 BLI_addtail(&(pool->chunks), mpchunk);
114                 
115                 if (i==0) {
116                         pool->free = mpchunk->data; /*start of the list*/
117                         if (pool->allow_iter)
118                                 pool->free->freeword = FREEWORD;
119                 }
120
121                 /*loop through the allocated data, building the pointer structures*/
122                 for (addr = mpchunk->data, j=0; j < pool->pchunk; j++) {
123                         curnode = ((BLI_freenode*)addr);
124                         addr += pool->esize;
125                         curnode->next = (BLI_freenode*)addr;
126                         if (pool->allow_iter) {
127                                 if (j != pool->pchunk-1)
128                                         curnode->next->freeword = FREEWORD;
129                                 curnode->freeword = FREEWORD;
130                         }
131                 }
132                 /*final pointer in the previously allocated chunk is wrong.*/
133                 if (lasttail) {
134                         lasttail->next = mpchunk->data;
135                         if (pool->allow_iter)
136                                 lasttail->freeword = FREEWORD;
137                 }
138
139                 /*set the end of this chunks memoryy to the new tail for next iteration*/
140                 lasttail = curnode;
141
142                 pool->totalloc += pool->pchunk;
143         }
144         /*terminate the list*/
145         curnode->next = NULL;
146         return pool;
147 }
148
149 void *BLI_mempool_alloc(BLI_mempool *pool)
150 {
151         void *retval=NULL;
152
153         pool->totused++;
154
155         if (!(pool->free)) {
156                 BLI_freenode *curnode=NULL;
157                 char *addr;
158                 int j;
159
160                 /*need to allocate a new chunk*/
161                 BLI_mempool_chunk *mpchunk = pool->use_sysmalloc ? malloc(sizeof(BLI_mempool_chunk)) :  MEM_mallocN(sizeof(BLI_mempool_chunk), "BLI_Mempool Chunk");
162                 mpchunk->next = mpchunk->prev = NULL;
163                 mpchunk->data = pool->use_sysmalloc ? malloc(pool->csize) : MEM_mallocN(pool->csize, "BLI_Mempool Chunk Data");
164                 BLI_addtail(&(pool->chunks), mpchunk);
165
166                 pool->free = mpchunk->data; /*start of the list*/
167                 if (pool->allow_iter)
168                         pool->free->freeword = FREEWORD;
169                 for(addr = mpchunk->data, j=0; j < pool->pchunk; j++){
170                         curnode = ((BLI_freenode*)addr);
171                         addr += pool->esize;
172                         curnode->next = (BLI_freenode*)addr;
173
174                         if (pool->allow_iter) {
175                                 curnode->freeword = FREEWORD;
176                                 if (j != pool->pchunk-1)
177                                         curnode->next->freeword = FREEWORD;
178                         }
179                 }
180                 curnode->next = NULL; /*terminate the list*/
181
182                 pool->totalloc += pool->pchunk;
183         }
184
185         retval = pool->free;
186         if (pool->allow_iter)
187                 pool->free->freeword = 0x7FFFFFFF;
188
189         pool->free = pool->free->next;
190         //memset(retval, 0, pool->esize);
191         return retval;
192 }
193
194 void *BLI_mempool_calloc(BLI_mempool *pool)
195 {
196         void *retval= BLI_mempool_alloc(pool);
197         memset(retval, 0, pool->esize);
198         return retval;
199 }
200
201 /* doesnt protect against double frees, dont be stupid! */
202 void BLI_mempool_free(BLI_mempool *pool, void *addr)
203 {
204         BLI_freenode *newhead = addr;
205
206         if (pool->allow_iter)
207                 newhead->freeword = FREEWORD;
208         newhead->next = pool->free;
209         pool->free = newhead;
210
211         pool->totused--;
212
213         /*nothing is in use; free all the chunks except the first*/
214         if (pool->totused == 0) {
215                 BLI_freenode *curnode=NULL;
216                 char *tmpaddr=NULL;
217                 int i;
218
219                 BLI_mempool_chunk *mpchunk=NULL;
220                 BLI_mempool_chunk *first= pool->chunks.first;
221
222                 BLI_remlink(&pool->chunks, first);
223
224                 for (mpchunk = pool->chunks.first; mpchunk; mpchunk = mpchunk->next) {
225                         if (pool->use_sysmalloc) free(mpchunk->data);
226                         else                     MEM_freeN(mpchunk->data);
227                 }
228
229                 pool->use_sysmalloc ? BLI_freelist(&(pool->chunks)) : BLI_freelistN(&(pool->chunks));
230                 
231                 BLI_addtail(&pool->chunks, first);
232                 pool->totalloc = pool->pchunk;
233
234                 pool->free = first->data; /*start of the list*/
235                 for (tmpaddr = first->data, i=0; i < pool->pchunk; i++) {
236                         curnode = ((BLI_freenode*)tmpaddr);
237                         tmpaddr += pool->esize;
238                         curnode->next = (BLI_freenode*)tmpaddr;
239                 }
240                 curnode->next = NULL; /*terminate the list*/
241         }
242 }
243
244 void *BLI_mempool_findelem(BLI_mempool *pool, const int index)
245 {
246         if ((index >= 0) && (index < pool->totused)) {
247                 BLI_mempool_chunk *mpchunk;
248                 int i= 0;
249
250                 for (mpchunk = pool->chunks.first; mpchunk; mpchunk = mpchunk->next) {
251                         if (index < i + pool->pchunk) {
252                                 return ((char *)mpchunk->data) + (pool->esize * (index - i));
253                         }
254                         i += pool->pchunk;
255                 }
256         }
257
258         return NULL;
259 }
260
261 void BLI_mempool_iternew(BLI_mempool *pool, BLI_mempool_iter *iter)
262 {
263         if (!pool->allow_iter) {
264                 fprintf(stderr, "%s: Error! you can't iterate over this mempool!\n", __func__);
265                 iter->curchunk = NULL;
266                 iter->curindex = 0;
267                 
268                 return;
269         }
270         
271         iter->pool = pool;
272         iter->curchunk = pool->chunks.first;
273         iter->curindex = 0;
274 }
275
276 static void *bli_mempool_iternext(BLI_mempool_iter *iter)
277 {
278         void *ret = NULL;
279         
280         if (!iter->curchunk || !iter->pool->totused) return NULL;
281         
282         ret = ((char*)iter->curchunk->data) + iter->pool->esize*iter->curindex;
283         
284         iter->curindex++;
285         
286         if (iter->curindex >= iter->pool->pchunk) {
287                 iter->curchunk = iter->curchunk->next;
288                 iter->curindex = 0;
289         }
290         
291         return ret;
292 }
293
294 void *BLI_mempool_iterstep(BLI_mempool_iter *iter)
295 {
296         BLI_freenode *ret;
297         
298         do {
299                 ret = bli_mempool_iternext(iter);
300         } while (ret && ret->freeword == FREEWORD);
301         
302         return ret;
303 }
304
305 void BLI_mempool_destroy(BLI_mempool *pool)
306 {
307         BLI_mempool_chunk *mpchunk=NULL;
308
309         if (pool->use_sysmalloc) {
310                 for (mpchunk = pool->chunks.first; mpchunk; mpchunk = mpchunk->next) {
311                         free(mpchunk->data);
312                 }
313                 BLI_freelist(&(pool->chunks));
314                 free(pool);
315         }
316         else {
317                 for (mpchunk = pool->chunks.first; mpchunk; mpchunk = mpchunk->next) {
318                         MEM_freeN(mpchunk->data);
319                 }
320                 BLI_freelistN(&(pool->chunks));
321                 MEM_freeN(pool);
322         }
323 }