Patch from GSR that a) fixes a whole bunch of GPL/BL license
[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., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
18  *
19  * Contributor(s): Peter Schlaile <peter@schlaile.de> 2005
20  *
21  * ***** END GPL LICENSE BLOCK *****
22  */
23
24 #ifndef __MEM_cache_limiter_h_included__
25 #define __MEM_cache_limiter_h_included__ 1
26
27 /**
28  * @section MEM_CacheLimiter
29  * This class defines a generic memory cache management system
30  * to limit memory usage to a fixed global maximum.
31  * 
32  * Please use the C-API in MEM_CacheLimiterC-Api.h for code written in C.
33  *
34  * Usage example:
35  *
36  * class BigFatImage {
37  * public:
38  *       ~BigFatImage() { tell_everyone_we_are_gone(this); }
39  * };
40  * 
41  * void doit() {
42  *     MEM_Cache<BigFatImage> BigFatImages;
43  *
44  *     MEM_Cache_Handle<BigFatImage>* h = BigFatImages.insert(new BigFatImage);
45  * 
46  *     BigFatImages.enforce_limits();
47  *     h->ref();
48  *
49  *     work with image...
50  *
51  *     h->unref();
52  *
53  *     leave image in cache.
54  */
55
56 #include <list>
57 #include "MEM_Allocator.h"
58
59 template<class T>
60 class MEM_CacheLimiter;
61
62 #ifndef __MEM_cache_limiter_c_api_h_included__
63 extern "C" {
64         extern void MEM_CacheLimiter_set_maximum(int m);
65         extern int MEM_CacheLimiter_get_maximum();
66         // this is rather _ugly_!
67         extern int mem_in_use;
68         extern int mmap_in_use;
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                 int max = MEM_CacheLimiter_get_maximum();
145                 if (max == 0) {
146                         return;
147                 }
148                 for (iterator it = queue.begin(); 
149                      it != queue.end() && mem_in_use + mmap_in_use > max;) {
150                         iterator jt = it;
151                         ++it;
152                         (*jt)->destroy_if_possible();
153                 }
154         }
155         void touch(MEM_CacheLimiterHandle<T> * handle) {
156                 queue.push_back(handle);
157                 queue.erase(handle->me);
158                 iterator it = queue.end();
159                 --it;
160                 handle->me = it;
161         }
162 private:
163         std::list<MEM_CacheLimiterHandle<T>*,
164           MEM_Allocator<MEM_CacheLimiterHandle<T> *> > queue;
165 };
166
167 #endif