migrated NDOF code from soc-2010-merwin, SpaceNavigator now works on Mac blender
[blender.git] / intern / memutil / MEM_CacheLimiter.h
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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18  *
19  * Contributor(s): Peter Schlaile <peter@schlaile.de> 2005
20  *
21  * ***** END GPL LICENSE BLOCK *****
22  */
23
24 /** \file memutil/MEM_CacheLimiter.h
25  *  \ingroup memutil
26  */
27
28
29 #ifndef MEM_CACHELIMITER_H
30 #define MEM_CACHELIMITER_H
31
32 /**
33  * @section MEM_CacheLimiter
34  * This class defines a generic memory cache management system
35  * to limit memory usage to a fixed global maximum.
36  * 
37  * Please use the C-API in MEM_CacheLimiterC-Api.h for code written in C.
38  *
39  * Usage example:
40  *
41  * class BigFatImage {
42  * public:
43  *       ~BigFatImage() { tell_everyone_we_are_gone(this); }
44  * };
45  * 
46  * void doit() {
47  *     MEM_Cache<BigFatImage> BigFatImages;
48  *
49  *     MEM_Cache_Handle<BigFatImage>* h = BigFatImages.insert(new BigFatImage);
50  * 
51  *     BigFatImages.enforce_limits();
52  *     h->ref();
53  *
54  *     work with image...
55  *
56  *     h->unref();
57  *
58  *     leave image in cache.
59  */
60
61 #include <list>
62 #include "MEM_Allocator.h"
63
64 template<class T>
65 class MEM_CacheLimiter;
66
67 #ifndef __MEM_cache_limiter_c_api_h_included__
68 extern "C" {
69         extern void MEM_CacheLimiter_set_maximum(intptr_t m);
70         extern intptr_t MEM_CacheLimiter_get_maximum();
71 };
72 #endif
73
74 template<class T>
75 class MEM_CacheLimiterHandle {
76 public:
77         explicit MEM_CacheLimiterHandle(T * data_, 
78                                          MEM_CacheLimiter<T> * parent_) 
79                 : data(data_), refcount(0), parent(parent_) { }
80
81         void ref() { 
82                 refcount++; 
83         }
84         void unref() { 
85                 refcount--; 
86         }
87         T * get() { 
88                 return data; 
89         }
90         const T * get() const { 
91                 return data; 
92         }
93         int get_refcount() const { 
94                 return refcount; 
95         }
96         bool can_destroy() const { 
97                 return !data || !refcount; 
98         }
99         bool destroy_if_possible() {
100                 if (can_destroy()) {
101                         delete data;
102                         data = 0;
103                         unmanage();
104                         return true;
105                 }
106                 return false;
107         }
108         void unmanage() {
109                 parent->unmanage(this);
110         }
111         void touch() {
112                 parent->touch(this);
113         }
114 private:
115         friend class MEM_CacheLimiter<T>;
116
117         T * data;
118         int refcount;
119         typename std::list<MEM_CacheLimiterHandle<T> *, 
120           MEM_Allocator<MEM_CacheLimiterHandle<T> *> >::iterator me;
121         MEM_CacheLimiter<T> * parent;
122 };
123
124 template<class T>
125 class MEM_CacheLimiter {
126 public:
127         typedef typename std::list<MEM_CacheLimiterHandle<T> *,
128           MEM_Allocator<MEM_CacheLimiterHandle<T> *> >::iterator iterator;
129         ~MEM_CacheLimiter() {
130                 for (iterator it = queue.begin(); it != queue.end(); it++) {
131                         delete *it;
132                 }
133         }
134         MEM_CacheLimiterHandle<T> * insert(T * elem) {
135                 queue.push_back(new MEM_CacheLimiterHandle<T>(elem, this));
136                 iterator it = queue.end();
137                 --it;
138                 queue.back()->me = it;
139                 return queue.back();
140         }
141         void unmanage(MEM_CacheLimiterHandle<T> * handle) {
142                 queue.erase(handle->me);
143                 delete handle;
144         }
145         void enforce_limits() {
146                 intptr_t max = MEM_CacheLimiter_get_maximum();
147                 intptr_t mem_in_use= MEM_get_memory_in_use();
148                 intptr_t mmap_in_use= MEM_get_mapped_memory_in_use();
149
150                 if (max == 0) {
151                         return;
152                 }
153                 for (iterator it = queue.begin(); 
154                      it != queue.end() && mem_in_use + mmap_in_use > max;) {
155                         iterator jt = it;
156                         ++it;
157                         (*jt)->destroy_if_possible();
158                 }
159         }
160         void touch(MEM_CacheLimiterHandle<T> * handle) {
161                 queue.push_back(handle);
162                 queue.erase(handle->me);
163                 iterator it = queue.end();
164                 --it;
165                 handle->me = it;
166         }
167 private:
168         std::list<MEM_CacheLimiterHandle<T>*,
169           MEM_Allocator<MEM_CacheLimiterHandle<T> *> > queue;
170 };
171
172 #endif // MEM_CACHELIMITER_H