svn merge -r39433:39493 https://svn.blender.org/svnroot/bf-blender/trunk/blender
[blender.git] / source / blender / blenlib / BLI_mempool.h
1 /*
2  * $Id$
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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18  *
19  * The Original Code is Copyright (C) 2008 Blender Foundation.
20  * All rights reserved.
21  *
22  * The Original Code is: all of this file.
23  *
24  * Contributor(s): Geoffrey Bantle.
25  *
26  * ***** END GPL LICENSE BLOCK *****
27  */
28  
29 #ifndef BLI_MEMPOOL_H
30 #define BLI_MEMPOOL_H
31
32 /** \file BLI_mempool.h
33  *  \ingroup bli
34  *  \author Geoffrey Bantle
35  *  \brief Simple fast memory allocator.
36  */
37
38 #ifdef __cplusplus
39 extern "C"
40 {
41 #endif
42
43 struct BLI_mempool;
44
45 #include "BKE_utildefines.h"
46 #include "BLI_listbase.h"
47 #include "BLI_blenlib.h"
48 #include <string.h>
49
50 typedef struct BLI_freenode{
51         struct BLI_freenode *next;
52         int freeword; /*used to identify this as a freed node*/
53 }BLI_freenode;
54
55 typedef struct BLI_mempool_chunk{
56         struct BLI_mempool_chunk *next, *prev;
57         void *data;
58 }BLI_mempool_chunk;
59
60 typedef struct BLI_mempool{
61         struct ListBase chunks;
62         int esize, csize, pchunk;               /*size of elements and chunks in bytes and number of elements per chunk*/
63         BLI_freenode *free;             /*free element list. Interleaved into chunk datas.*/
64         int totalloc, totused; /*total number of elements allocated in total, and currently in use*/
65         int use_sysmalloc, allow_iter;
66 }BLI_mempool;
67
68 /*allow_iter allows iteration on this mempool.  note: this requires that the
69   first four bytes of the elements never contain the character string
70   'free'.  use with care.*/
71
72 BLI_mempool *BLI_mempool_create(int esize, int tote, int pchunk,
73                                                                 int use_sysmalloc, int allow_iter);
74 //void *BLI_mempool_alloc(BLI_mempool *pool);
75 void *BLI_mempool_calloc(BLI_mempool *pool);
76 void BLI_mempool_free(BLI_mempool *pool, void *addr);
77 void BLI_mempool_destroy(BLI_mempool *pool);
78 int BLI_mempool_count(BLI_mempool *pool);
79
80 /** iteration stuff.  note: this may easy to produce bugs with **/
81 /*private structure*/
82 typedef struct BLI_mempool_iter {
83         BLI_mempool *pool;
84         struct BLI_mempool_chunk *curchunk;
85         int curindex;
86 } BLI_mempool_iter;
87
88 /*allow iteration on this mempool.  note: this requires that the
89   first four bytes of the elements never contain the character string
90   'free'.  use with care.*/
91 void BLI_mempool_allow_iter(BLI_mempool *pool);
92 void BLI_mempool_iternew(BLI_mempool *pool, BLI_mempool_iter *iter);
93 void *BLI_mempool_iterstep(BLI_mempool_iter *iter);
94
95 /************ inlined stuff ***********/
96 #define FREEWORD MAKE_ID('f', 'r', 'e', 'e')
97 #include "MEM_guardedalloc.h"
98
99 BM_INLINE void *BLI_mempool_alloc(BLI_mempool *pool) {
100         void *retval=NULL;
101         BLI_freenode *curnode=NULL;
102         char *addr=NULL;
103         int j;
104         
105         if (!pool) return NULL;
106         
107         pool->totused++;
108
109         if(!(pool->free)){
110                 /*need to allocate a new chunk*/
111                 BLI_mempool_chunk *mpchunk = pool->use_sysmalloc ? (BLI_mempool_chunk*)malloc(sizeof(BLI_mempool_chunk)) :  (BLI_mempool_chunk*)MEM_mallocN(sizeof(BLI_mempool_chunk), "BLI_Mempool Chunk");
112                 mpchunk->next = mpchunk->prev = NULL;
113                 mpchunk->data = pool->use_sysmalloc ? malloc(pool->csize) : MEM_mallocN(pool->csize, "BLI_Mempool Chunk Data");
114                 BLI_addtail(&(pool->chunks), mpchunk);
115
116                 pool->free = (BLI_freenode*)mpchunk->data; /*start of the list*/
117                 if (pool->allow_iter)
118                         pool->free->freeword = FREEWORD;
119                 for(addr = (char*)mpchunk->data, j=0; j < pool->pchunk; j++){
120                         curnode = ((BLI_freenode*)addr);
121                         addr += pool->esize;
122                         curnode->next = (BLI_freenode*)addr;
123
124                         if (pool->allow_iter) {
125                                 curnode->freeword = FREEWORD;
126                                 if (j != pool->pchunk-1)
127                                         curnode->next->freeword = FREEWORD;
128                         }
129                 }
130                 curnode->next = NULL; /*terminate the list*/
131
132                 pool->totalloc += pool->pchunk;
133         }
134
135         retval = pool->free;
136         if (pool->allow_iter)
137                 pool->free->freeword = 0x7FFFFFFF;
138
139         pool->free = pool->free->next;
140         //memset(retval, 0, pool->esize);
141         return retval;
142 }
143
144 #ifdef __cplusplus
145 }
146 #endif
147
148 #endif