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