Added a new notifyer, NC_SPACE_CHANGED, to signal an editor that
[blender.git] / source / blender / blenlib / intern / BLI_mempool.c
1 /**
2  *
3  * ***** BEGIN GPL LICENSE BLOCK *****
4  *
5  * This program is free software; you can redistribute it and/or
6  * modify it under the terms of the GNU General Public License
7  * as published by the Free Software Foundation; either version 2
8  * of the License, or (at your option) any later version.
9  *
10  * This program is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13  * GNU General Public License for more details.
14  *
15  * You should have received a copy of the GNU General Public License
16  * along with this program; if not, write to the Free Software Foundation,
17  * Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
18  *
19  * The Original Code is Copyright (C) 2008 by Blender Foundation.
20  * All rights reserved.
21  *
22  * The Original Code is: all of this file.
23  *
24  * Contributor(s): none yet.
25  *
26  * ***** END GPL LICENSE BLOCK *****
27  */
28
29 /*
30         Simple, fast memory allocator for allocating many elements of the same size.
31 */
32
33 #include "MEM_guardedalloc.h"
34 #include "BLI_blenlib.h"
35 #include "DNA_listBase.h"
36 #include "BLI_linklist.h"
37 #include <string.h> 
38
39 typedef struct BLI_freenode{
40         struct BLI_freenode *next;
41 }BLI_freenode;
42
43 typedef struct BLI_mempool_chunk{
44         struct BLI_mempool_chunk *next, *prev;
45         void *data;
46 }BLI_mempool_chunk;
47
48 typedef struct BLI_mempool{
49         struct ListBase chunks;
50         int esize, csize, pchunk;               /*size of elements and chunks in bytes and number of elements per chunk*/
51         struct BLI_freenode     *free;          /*free element list. Interleaved into chunk datas.*/
52         int totalloc, totused; /*total number of elements allocated in total, and currently in use*/
53         int use_sysmalloc;
54 }BLI_mempool;
55
56 BLI_mempool *BLI_mempool_create(int esize, int tote, int pchunk, int use_sysmalloc)
57 {       BLI_mempool  *pool = NULL;
58         BLI_freenode *lasttail = NULL, *curnode = NULL;
59         int i,j, maxchunks;
60         char *addr;
61         
62         if (esize < sizeof(void*))
63                 esize = sizeof(void*);
64         
65         /*allocate the pool structure*/
66         pool = use_sysmalloc ? malloc(sizeof(BLI_mempool)) : MEM_mallocN(sizeof(BLI_mempool), "memory pool");
67         pool->esize = esize;
68         pool->use_sysmalloc = use_sysmalloc;
69         pool->pchunk = pchunk;  
70         pool->csize = esize * pchunk;
71         pool->chunks.first = pool->chunks.last = NULL;
72         
73         maxchunks = tote / pchunk + 1;
74         
75         /*allocate the actual chunks*/
76         for(i=0; i < maxchunks; i++){
77                 BLI_mempool_chunk *mpchunk = use_sysmalloc ? malloc(sizeof(BLI_mempool_chunk)) : MEM_mallocN(sizeof(BLI_mempool_chunk), "BLI_Mempool Chunk");
78                 mpchunk->next = mpchunk->prev = NULL;
79                 mpchunk->data = use_sysmalloc ? malloc(pool->csize) : MEM_mallocN(pool->csize, "BLI Mempool Chunk Data");
80                 BLI_addtail(&(pool->chunks), mpchunk);
81                 
82                 if(i==0) pool->free = mpchunk->data; /*start of the list*/
83                 /*loop through the allocated data, building the pointer structures*/
84                 for(addr = mpchunk->data, j=0; j < pool->pchunk; j++){
85                         curnode = ((BLI_freenode*)addr);
86                         addr += pool->esize;
87                         curnode->next = (BLI_freenode*)addr;
88                 }
89                 /*final pointer in the previously allocated chunk is wrong.*/
90                 if(lasttail) lasttail->next = mpchunk->data;
91                 /*set the end of this chunks memoryy to the new tail for next iteration*/
92                 lasttail = curnode;
93
94                 pool->totalloc += pool->pchunk;
95         }
96         /*terminate the list*/
97         curnode->next = NULL;
98         return pool;
99 }
100 void *BLI_mempool_alloc(BLI_mempool *pool){
101         void *retval=NULL;
102         BLI_freenode *curnode=NULL;
103         char *addr=NULL;
104         int j;
105
106         pool->totused++;
107
108         if(!(pool->free)){
109                 /*need to allocate a new chunk*/
110                 BLI_mempool_chunk *mpchunk = pool->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 = pool->use_sysmalloc ? malloc(pool->csize) : MEM_mallocN(pool->csize, "BLI_Mempool Chunk Data");
113                 BLI_addtail(&(pool->chunks), mpchunk);
114
115                 pool->free = mpchunk->data; /*start of the list*/
116                 for(addr = mpchunk->data, j=0; j < pool->pchunk; j++){
117                         curnode = ((BLI_freenode*)addr);
118                         addr += pool->esize;
119                         curnode->next = (BLI_freenode*)addr;
120                 }
121                 curnode->next = NULL; /*terminate the list*/
122
123                 pool->totalloc += pool->pchunk;
124         }
125
126         retval = pool->free;
127         pool->free = pool->free->next;
128         //memset(retval, 0, pool->esize);
129         return retval;
130 }
131
132 void *BLI_mempool_calloc(BLI_mempool *pool){
133         void *retval=NULL;
134         retval = BLI_mempool_alloc(pool);
135         memset(retval, 0, pool->esize);
136         return retval;
137 }
138
139
140 void BLI_mempool_free(BLI_mempool *pool, void *addr){ //doesnt protect against double frees, dont be stupid!
141         BLI_freenode *newhead = addr;
142         BLI_freenode *curnode=NULL;
143         char *tmpaddr=NULL;
144         int i;
145
146         newhead->next = pool->free;
147         pool->free = newhead;
148
149         pool->totused--;
150
151         /*nothing is in use; free all the chunks except the first*/
152         if (pool->totused == 0) {
153                 BLI_mempool_chunk *mpchunk=NULL, *first;
154
155                 first = pool->chunks.first;
156                 BLI_remlink(&pool->chunks, first);
157
158                 for(mpchunk = pool->chunks.first; mpchunk; mpchunk = mpchunk->next) 
159                         pool->use_sysmalloc ? free(mpchunk->data) : MEM_freeN(mpchunk->data);
160                 
161                 pool->use_sysmalloc ? BLI_freelist(&(pool->chunks)) : BLI_freelistN(&(pool->chunks));
162                 
163                 BLI_addtail(&pool->chunks, first);
164                 pool->totalloc = pool->pchunk;
165
166                 pool->free = first->data; /*start of the list*/
167                 for(tmpaddr = first->data, i=0; i < pool->pchunk; i++){
168                         curnode = ((BLI_freenode*)tmpaddr);
169                         tmpaddr += pool->esize;
170                         curnode->next = (BLI_freenode*)tmpaddr;
171                 }
172                 curnode->next = NULL; /*terminate the list*/
173         }
174 }
175
176 void BLI_mempool_destroy(BLI_mempool *pool)
177 {
178         BLI_mempool_chunk *mpchunk=NULL;
179         for(mpchunk = pool->chunks.first; mpchunk; mpchunk = mpchunk->next)
180                 pool->use_sysmalloc ? free(mpchunk->data) : MEM_freeN(mpchunk->data);
181         
182         pool->use_sysmalloc ? BLI_freelist(&(pool->chunks)) : BLI_freelistN(&(pool->chunks));   
183         pool->use_sysmalloc ? free(pool) : MEM_freeN(pool);
184 }