3026e827c3f2e2721d0e619df676e7411dcf7eca
[blender-staging.git] / intern / memutil / MEM_CacheLimiter.h
1 /**
2  *
3  * ***** BEGIN GPL/BL DUAL 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. The Blender
9  * Foundation also sells licenses for use in proprietary software under
10  * the Blender License.  See http://www.blender.org/BL/ for information
11  * about this.
12  *
13  * This program is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16  * GNU General Public License for more details.
17  *
18  * You should have received a copy of the GNU General Public License
19  * along with this program; if not, write to the Free Software Foundation,
20  * Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
21  *
22  * Contributor(s): Peter Schlaile <peter@schlaile.de> 2005
23  *
24  * ***** END GPL/BL DUAL LICENSE BLOCK *****
25  */
26
27 #ifndef __MEM_cache_limiter_h_included__
28 #define __MEM_cache_limiter_h_included__ 1
29
30 /**
31  * @section MEM_CacheLimiter
32  * This class defines a generic memory cache management system
33  * to limit memory usage to a fixed global maximum.
34  * 
35  * Please use the C-API in MEM_CacheLimiterC-Api.h for code written in C.
36  *
37  * Usage example:
38  *
39  * class BigFatImage {
40  * public:
41  *       ~BigFatImage() { tell_everyone_we_are_gone(this); }
42  * };
43  * 
44  * void doit() {
45  *     MEM_Cache<BigFatImage> BigFatImages;
46  *
47  *     MEM_Cache_Handle<BigFatImage>* h = BigFatImages.insert(new BigFatImage);
48  * 
49  *     BigFatImages.enforce_limits();
50  *     h->ref();
51  *
52  *     work with image...
53  *
54  *     h->unref();
55  *
56  *     leave image in cache.
57  */
58
59 #include <list>
60 #include "MEM_Allocator.h"
61
62 template<class T>
63 class MEM_CacheLimiter;
64
65 #ifndef __MEM_cache_limiter_c_api_h_included__
66 extern "C" {
67         extern void MEM_CacheLimiter_set_maximum(int m);
68         extern int MEM_CacheLimiter_get_maximum();
69 };
70 #endif
71
72 template<class T>
73 class MEM_CacheLimiterHandle {
74 public:
75         explicit MEM_CacheLimiterHandle(T * data_, 
76                                          MEM_CacheLimiter<T> * parent_) 
77                 : data(data_), refcount(0), parent(parent_) { }
78
79         void ref() { 
80                 refcount++; 
81         }
82         void unref() { 
83                 refcount--; 
84         }
85         T * get() { 
86                 return data; 
87         }
88         const T * get() const { 
89                 return data; 
90         }
91         int get_refcount() const { 
92                 return refcount; 
93         }
94         bool can_destroy() const { 
95                 return !data || !refcount; 
96         }
97         bool destroy_if_possible() {
98                 if (can_destroy()) {
99                         delete data;
100                         data = 0;
101                         unmanage();
102                         return true;
103                 }
104                 return false;
105         }
106         void unmanage() {
107                 parent->unmanage(this);
108         }
109         void touch() {
110                 parent->touch(this);
111         }
112 private:
113         friend class MEM_CacheLimiter<T>;
114
115         T * data;
116         int refcount;
117         typename std::list<MEM_CacheLimiterHandle<T> *, 
118           MEM_Allocator<MEM_CacheLimiterHandle<T> *> >::iterator me;
119         MEM_CacheLimiter<T> * parent;
120 };
121
122 template<class T>
123 class MEM_CacheLimiter {
124 public:
125         typedef typename std::list<MEM_CacheLimiterHandle<T> *,
126           MEM_Allocator<MEM_CacheLimiterHandle<T> *> >::iterator iterator;
127         ~MEM_CacheLimiter() {
128                 for (iterator it = queue.begin(); it != queue.end(); it++) {
129                         delete *it;
130                 }
131         }
132         MEM_CacheLimiterHandle<T> * insert(T * elem) {
133                 queue.push_back(new MEM_CacheLimiterHandle<T>(elem, this));
134                 iterator it = queue.end();
135                 --it;
136                 queue.back()->me = it;
137                 return queue.back();
138         }
139         void unmanage(MEM_CacheLimiterHandle<T> * handle) {
140                 queue.erase(handle->me);
141                 delete handle;
142         }
143         void enforce_limits() {
144                 // this is rather _ugly_!
145                 extern int mem_in_use;
146
147                 int max = MEM_CacheLimiter_get_maximum();
148                 if (max == 0) {
149                         return;
150                 }
151                 for (iterator it = queue.begin(); 
152                      it != queue.end() && mem_in_use > max;) {
153                         iterator jt = it;
154                         ++it;
155                         (*jt)->destroy_if_possible();
156                 }
157         }
158         void touch(MEM_CacheLimiterHandle<T> * handle) {
159                 queue.push_back(handle);
160                 queue.erase(handle->me);
161                 iterator it = queue.end();
162                 --it;
163                 handle->me = it;
164         }
165 private:
166         std::list<MEM_CacheLimiterHandle<T>*,
167           MEM_Allocator<MEM_CacheLimiterHandle<T> *> > queue;
168 };
169
170 #endif