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