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