1 /*! \file btGenericPoolAllocator.h
2 \author Francisco Leon Najera. email projectileman@yahoo.com
3 
4 General purpose allocator class
5 */
6 /*
7 Bullet Continuous Collision Detection and Physics Library
8 Copyright (c) 2003-2006 Erwin Coumans  http://continuousphysics.com/Bullet/
9 
10 This software is provided 'as-is', without any express or implied warranty.
11 In no event will the authors be held liable for any damages arising from the use of this software.
12 Permission is granted to anyone to use this software for any purpose,
13 including commercial applications, and to alter it and redistribute it freely,
14 subject to the following restrictions:
15 
16 1. The origin of this software must not be misrepresented; you must not claim that you wrote the original software. If you use this software in a product, an acknowledgment in the product documentation would be appreciated but is not required.
17 2. Altered source versions must be plainly marked as such, and must not be misrepresented as being the original software.
18 3. This notice may not be removed or altered from any source distribution.
19 */
20 
21 #ifndef BT_GENERIC_POOL_ALLOCATOR_H
22 #define BT_GENERIC_POOL_ALLOCATOR_H
23 
24 #include <limits.h>
25 #include <stdio.h>
26 #include <string.h>
27 #include "LinearMath/btAlignedAllocator.h"
28 
29 #define BT_UINT_MAX UINT_MAX
30 #define BT_DEFAULT_MAX_POOLS 16
31 
32 //! Generic Pool class
33 class btGenericMemoryPool
34 {
35 public:
36 	unsigned char *m_pool;      //[m_element_size*m_max_element_count];
37 	size_t *m_free_nodes;       //[m_max_element_count];//! free nodes
38 	size_t *m_allocated_sizes;  //[m_max_element_count];//! Number of elements allocated per node
39 	size_t m_allocated_count;
40 	size_t m_free_nodes_count;
41 
42 protected:
43 	size_t m_element_size;
44 	size_t m_max_element_count;
45 
46 	size_t allocate_from_free_nodes(size_t num_elements);
47 	size_t allocate_from_pool(size_t num_elements);
48 
49 public:
50 	void init_pool(size_t element_size, size_t element_count);
51 
52 	void end_pool();
53 
btGenericMemoryPool(size_t element_size,size_t element_count)54 	btGenericMemoryPool(size_t element_size, size_t element_count)
55 	{
56 		init_pool(element_size, element_count);
57 	}
58 
~btGenericMemoryPool()59 	~btGenericMemoryPool()
60 	{
61 		end_pool();
62 	}
63 
get_pool_capacity()64 	inline size_t get_pool_capacity()
65 	{
66 		return m_element_size * m_max_element_count;
67 	}
68 
gem_element_size()69 	inline size_t gem_element_size()
70 	{
71 		return m_element_size;
72 	}
73 
get_max_element_count()74 	inline size_t get_max_element_count()
75 	{
76 		return m_max_element_count;
77 	}
78 
get_allocated_count()79 	inline size_t get_allocated_count()
80 	{
81 		return m_allocated_count;
82 	}
83 
get_free_positions_count()84 	inline size_t get_free_positions_count()
85 	{
86 		return m_free_nodes_count;
87 	}
88 
get_element_data(size_t element_index)89 	inline void *get_element_data(size_t element_index)
90 	{
91 		return &m_pool[element_index * m_element_size];
92 	}
93 
94 	//! Allocates memory in pool
95 	/*!
96 	\param size_bytes size in bytes of the buffer
97 	*/
98 	void *allocate(size_t size_bytes);
99 
100 	bool freeMemory(void *pointer);
101 };
102 
103 //! Generic Allocator with pools
104 /*!
105 General purpose Allocator which can create Memory Pools dynamiacally as needed.
106 */
107 class btGenericPoolAllocator
108 {
109 protected:
110 	size_t m_pool_element_size;
111 	size_t m_pool_element_count;
112 
113 public:
114 	btGenericMemoryPool *m_pools[BT_DEFAULT_MAX_POOLS];
115 	size_t m_pool_count;
116 
get_pool_capacity()117 	inline size_t get_pool_capacity()
118 	{
119 		return m_pool_element_size * m_pool_element_count;
120 	}
121 
122 protected:
123 	// creates a pool
124 	btGenericMemoryPool *push_new_pool();
125 
126 	void *failback_alloc(size_t size_bytes);
127 
128 	bool failback_free(void *pointer);
129 
130 public:
btGenericPoolAllocator(size_t pool_element_size,size_t pool_element_count)131 	btGenericPoolAllocator(size_t pool_element_size, size_t pool_element_count)
132 	{
133 		m_pool_count = 0;
134 		m_pool_element_size = pool_element_size;
135 		m_pool_element_count = pool_element_count;
136 	}
137 
138 	virtual ~btGenericPoolAllocator();
139 
140 	//! Allocates memory in pool
141 	/*!
142 	\param size_bytes size in bytes of the buffer
143 	*/
144 	void *allocate(size_t size_bytes);
145 
146 	bool freeMemory(void *pointer);
147 };
148 
149 void *btPoolAlloc(size_t size);
150 void *btPoolRealloc(void *ptr, size_t oldsize, size_t newsize);
151 void btPoolFree(void *ptr);
152 
153 #endif
154