2011-02-25 12:47:18 +01:00
|
|
|
/*
|
2008-04-17 00:40:48 +02:00
|
|
|
* ***** BEGIN GPL LICENSE BLOCK *****
|
2006-02-05 19:56:30 +01:00
|
|
|
*
|
|
|
|
* This program is free software; you can redistribute it and/or
|
|
|
|
* modify it under the terms of the GNU General Public License
|
|
|
|
* as published by the Free Software Foundation; either version 2
|
2008-04-17 00:40:48 +02:00
|
|
|
* of the License, or (at your option) any later version.
|
2006-02-05 19:56:30 +01:00
|
|
|
*
|
|
|
|
* This program is distributed in the hope that it will be useful,
|
|
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
|
|
* GNU General Public License for more details.
|
|
|
|
*
|
|
|
|
* You should have received a copy of the GNU General Public License
|
|
|
|
* along with this program; if not, write to the Free Software Foundation,
|
2010-02-12 14:34:04 +01:00
|
|
|
* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
|
2006-02-05 19:56:30 +01:00
|
|
|
*
|
|
|
|
* Contributor(s): Peter Schlaile <peter@schlaile.de> 2005
|
|
|
|
*
|
2008-04-17 00:40:48 +02:00
|
|
|
* ***** END GPL LICENSE BLOCK *****
|
2006-02-05 19:56:30 +01:00
|
|
|
*/
|
|
|
|
|
2011-02-25 12:47:18 +01:00
|
|
|
/** \file memutil/MEM_CacheLimiter.h
|
|
|
|
* \ingroup memutil
|
|
|
|
*/
|
|
|
|
|
|
|
|
|
2012-02-17 19:59:41 +01:00
|
|
|
#ifndef __MEM_CACHELIMITER_H__
|
|
|
|
#define __MEM_CACHELIMITER_H__
|
2006-02-05 19:56:30 +01:00
|
|
|
|
|
|
|
/**
|
|
|
|
* @section MEM_CacheLimiter
|
|
|
|
* This class defines a generic memory cache management system
|
|
|
|
* to limit memory usage to a fixed global maximum.
|
2012-07-10 16:43:50 +02:00
|
|
|
*
|
2006-02-05 19:56:30 +01:00
|
|
|
* Please use the C-API in MEM_CacheLimiterC-Api.h for code written in C.
|
|
|
|
*
|
|
|
|
* Usage example:
|
|
|
|
*
|
|
|
|
* class BigFatImage {
|
|
|
|
* public:
|
|
|
|
* ~BigFatImage() { tell_everyone_we_are_gone(this); }
|
|
|
|
* };
|
2012-07-10 16:43:50 +02:00
|
|
|
*
|
2006-02-05 19:56:30 +01:00
|
|
|
* void doit() {
|
|
|
|
* MEM_Cache<BigFatImage> BigFatImages;
|
|
|
|
*
|
|
|
|
* MEM_Cache_Handle<BigFatImage>* h = BigFatImages.insert(new BigFatImage);
|
2012-07-10 16:43:50 +02:00
|
|
|
*
|
2006-02-05 19:56:30 +01:00
|
|
|
* BigFatImages.enforce_limits();
|
|
|
|
* h->ref();
|
|
|
|
*
|
|
|
|
* work with image...
|
|
|
|
*
|
|
|
|
* h->unref();
|
|
|
|
*
|
|
|
|
* leave image in cache.
|
|
|
|
*/
|
|
|
|
|
|
|
|
#include <list>
|
2012-07-10 16:43:50 +02:00
|
|
|
#include <queue>
|
|
|
|
#include <vector>
|
2006-02-05 19:56:30 +01:00
|
|
|
#include "MEM_Allocator.h"
|
|
|
|
|
|
|
|
template<class T>
|
|
|
|
class MEM_CacheLimiter;
|
|
|
|
|
2012-02-17 19:59:41 +01:00
|
|
|
#ifndef __MEM_CACHELIMITERC_API_H__
|
2006-02-05 19:56:30 +01:00
|
|
|
extern "C" {
|
2012-07-10 16:43:50 +02:00
|
|
|
void MEM_CacheLimiter_set_maximum(size_t m);
|
|
|
|
size_t MEM_CacheLimiter_get_maximum();
|
2006-02-05 19:56:30 +01:00
|
|
|
};
|
|
|
|
#endif
|
|
|
|
|
|
|
|
template<class T>
|
|
|
|
class MEM_CacheLimiterHandle {
|
|
|
|
public:
|
2012-07-10 16:43:50 +02:00
|
|
|
explicit MEM_CacheLimiterHandle(T * data_,MEM_CacheLimiter<T> *parent_) :
|
|
|
|
data(data_),
|
|
|
|
refcount(0),
|
|
|
|
parent(parent_)
|
|
|
|
{ }
|
2006-02-05 19:56:30 +01:00
|
|
|
|
2012-07-10 16:43:50 +02:00
|
|
|
void ref() {
|
|
|
|
refcount++;
|
2006-02-05 19:56:30 +01:00
|
|
|
}
|
2012-07-10 16:43:50 +02:00
|
|
|
|
|
|
|
void unref() {
|
|
|
|
refcount--;
|
2006-02-05 19:56:30 +01:00
|
|
|
}
|
2012-07-10 16:43:50 +02:00
|
|
|
|
|
|
|
T *get() {
|
|
|
|
return data;
|
2006-02-05 19:56:30 +01:00
|
|
|
}
|
2012-07-10 16:43:50 +02:00
|
|
|
|
|
|
|
const T *get() const {
|
|
|
|
return data;
|
2006-02-05 19:56:30 +01:00
|
|
|
}
|
2012-07-10 16:43:50 +02:00
|
|
|
|
|
|
|
int get_refcount() const {
|
|
|
|
return refcount;
|
2006-02-05 19:56:30 +01:00
|
|
|
}
|
2012-07-10 16:43:50 +02:00
|
|
|
|
|
|
|
bool can_destroy() const {
|
|
|
|
return !data || !refcount;
|
2006-02-05 19:56:30 +01:00
|
|
|
}
|
2012-07-10 16:43:50 +02:00
|
|
|
|
2006-02-05 19:56:30 +01:00
|
|
|
bool destroy_if_possible() {
|
|
|
|
if (can_destroy()) {
|
|
|
|
delete data;
|
2013-03-08 07:32:00 +01:00
|
|
|
data = NULL;
|
2006-02-05 19:56:30 +01:00
|
|
|
unmanage();
|
|
|
|
return true;
|
|
|
|
}
|
|
|
|
return false;
|
|
|
|
}
|
2012-07-10 16:43:50 +02:00
|
|
|
|
2006-02-05 19:56:30 +01:00
|
|
|
void unmanage() {
|
|
|
|
parent->unmanage(this);
|
|
|
|
}
|
2012-07-10 16:43:50 +02:00
|
|
|
|
2006-02-05 19:56:30 +01:00
|
|
|
void touch() {
|
|
|
|
parent->touch(this);
|
|
|
|
}
|
2012-07-10 16:43:50 +02:00
|
|
|
|
2006-02-05 19:56:30 +01:00
|
|
|
private:
|
|
|
|
friend class MEM_CacheLimiter<T>;
|
|
|
|
|
|
|
|
T * data;
|
|
|
|
int refcount;
|
2012-07-10 16:43:50 +02:00
|
|
|
typename std::list<MEM_CacheLimiterHandle<T> *, MEM_Allocator<MEM_CacheLimiterHandle<T> *> >::iterator me;
|
2006-02-05 19:56:30 +01:00
|
|
|
MEM_CacheLimiter<T> * parent;
|
|
|
|
};
|
|
|
|
|
|
|
|
template<class T>
|
|
|
|
class MEM_CacheLimiter {
|
|
|
|
public:
|
2012-01-31 12:11:56 +01:00
|
|
|
typedef size_t (*MEM_CacheLimiter_DataSize_Func) (void *data);
|
2012-07-10 16:43:50 +02:00
|
|
|
typedef int (*MEM_CacheLimiter_ItemPriority_Func) (void *item, int default_priority);
|
|
|
|
|
2011-10-23 19:52:20 +02:00
|
|
|
MEM_CacheLimiter(MEM_CacheLimiter_DataSize_Func getDataSize_)
|
|
|
|
: getDataSize(getDataSize_) {
|
|
|
|
}
|
2012-07-10 16:43:50 +02:00
|
|
|
|
2006-02-05 19:56:30 +01:00
|
|
|
~MEM_CacheLimiter() {
|
|
|
|
for (iterator it = queue.begin(); it != queue.end(); it++) {
|
|
|
|
delete *it;
|
|
|
|
}
|
|
|
|
}
|
2012-07-10 16:43:50 +02:00
|
|
|
|
|
|
|
MEM_CacheLimiterHandle<T> *insert(T * elem) {
|
2006-02-05 19:56:30 +01:00
|
|
|
queue.push_back(new MEM_CacheLimiterHandle<T>(elem, this));
|
|
|
|
iterator it = queue.end();
|
|
|
|
--it;
|
|
|
|
queue.back()->me = it;
|
|
|
|
return queue.back();
|
|
|
|
}
|
2012-07-10 16:43:50 +02:00
|
|
|
|
|
|
|
void unmanage(MEM_CacheLimiterHandle<T> *handle) {
|
2006-02-05 19:56:30 +01:00
|
|
|
queue.erase(handle->me);
|
|
|
|
delete handle;
|
|
|
|
}
|
2012-07-10 16:43:50 +02:00
|
|
|
|
2006-02-05 19:56:30 +01:00
|
|
|
void enforce_limits() {
|
2012-01-31 12:11:56 +01:00
|
|
|
size_t max = MEM_CacheLimiter_get_maximum();
|
|
|
|
size_t mem_in_use, cur_size;
|
Merge of first part of changes from the apricot branch, especially
the features that are needed to run the game. Compile tested with
scons, make, but not cmake, that seems to have an issue not related
to these changes. The changes include:
* GLSL support in the viewport and game engine, enable in the game
menu in textured draw mode.
* Synced and merged part of the duplicated blender and gameengine/
gameplayer drawing code.
* Further refactoring of game engine drawing code, especially mesh
storage changed a lot.
* Optimizations in game engine armatures to avoid recomputations.
* A python function to get the framerate estimate in game.
* An option take object color into account in materials.
* An option to restrict shadow casters to a lamp's layers.
* Increase from 10 to 18 texture slots for materials, lamps, word.
An extra texture slot shows up once the last slot is used.
* Memory limit for undo, not enabled by default yet because it
needs the .B.blend to be changed.
* Multiple undo for image painting.
* An offset for dupligroups, so not all objects in a group have to
be at the origin.
2008-09-04 22:51:28 +02:00
|
|
|
|
2006-02-05 19:56:30 +01:00
|
|
|
if (max == 0) {
|
|
|
|
return;
|
|
|
|
}
|
2011-10-23 19:52:20 +02:00
|
|
|
|
2012-09-18 00:34:42 +02:00
|
|
|
if (getDataSize) {
|
2011-10-23 19:52:20 +02:00
|
|
|
mem_in_use = total_size();
|
2012-09-18 00:34:42 +02:00
|
|
|
}
|
|
|
|
else {
|
2011-10-23 19:52:20 +02:00
|
|
|
mem_in_use = MEM_get_memory_in_use();
|
|
|
|
}
|
|
|
|
|
2012-07-10 16:43:50 +02:00
|
|
|
if (mem_in_use <= max) {
|
|
|
|
return;
|
|
|
|
}
|
2011-10-23 19:52:20 +02:00
|
|
|
|
2012-09-20 14:59:16 +02:00
|
|
|
while (!queue.empty() && mem_in_use > max) {
|
|
|
|
MEM_CacheElementPtr elem = get_least_priority_destroyable_element();
|
2012-07-10 16:43:50 +02:00
|
|
|
|
2012-09-20 14:59:16 +02:00
|
|
|
if (!elem)
|
|
|
|
break;
|
2011-10-23 19:52:20 +02:00
|
|
|
|
2012-09-18 00:34:42 +02:00
|
|
|
if (getDataSize) {
|
2012-07-10 16:43:50 +02:00
|
|
|
cur_size = getDataSize(elem->get()->get_data());
|
2012-09-18 00:34:42 +02:00
|
|
|
}
|
|
|
|
else {
|
2012-07-10 16:43:50 +02:00
|
|
|
cur_size = mem_in_use;
|
|
|
|
}
|
|
|
|
|
|
|
|
if (elem->destroy_if_possible()) {
|
|
|
|
if (getDataSize) {
|
|
|
|
mem_in_use -= cur_size;
|
2012-09-18 00:34:42 +02:00
|
|
|
}
|
|
|
|
else {
|
2012-07-10 16:43:50 +02:00
|
|
|
mem_in_use -= cur_size - MEM_get_memory_in_use();
|
|
|
|
}
|
2011-10-23 19:52:20 +02:00
|
|
|
}
|
2006-02-05 19:56:30 +01:00
|
|
|
}
|
|
|
|
}
|
2012-07-10 16:43:50 +02:00
|
|
|
|
2006-02-05 19:56:30 +01:00
|
|
|
void touch(MEM_CacheLimiterHandle<T> * handle) {
|
|
|
|
queue.push_back(handle);
|
|
|
|
queue.erase(handle->me);
|
|
|
|
iterator it = queue.end();
|
|
|
|
--it;
|
|
|
|
handle->me = it;
|
|
|
|
}
|
2012-07-10 16:43:50 +02:00
|
|
|
|
|
|
|
void set_item_priority_func(MEM_CacheLimiter_ItemPriority_Func item_priority_func) {
|
|
|
|
getItemPriority = item_priority_func;
|
|
|
|
}
|
|
|
|
|
2006-02-05 19:56:30 +01:00
|
|
|
private:
|
2012-07-10 16:43:50 +02:00
|
|
|
typedef MEM_CacheLimiterHandle<T> *MEM_CacheElementPtr;
|
|
|
|
typedef std::list<MEM_CacheElementPtr, MEM_Allocator<MEM_CacheElementPtr> > MEM_CacheQueue;
|
|
|
|
typedef typename MEM_CacheQueue::iterator iterator;
|
|
|
|
|
2012-01-31 12:11:56 +01:00
|
|
|
size_t total_size() {
|
|
|
|
size_t size = 0;
|
2011-10-23 19:52:20 +02:00
|
|
|
for (iterator it = queue.begin(); it != queue.end(); it++) {
|
|
|
|
size+= getDataSize((*it)->get()->get_data());
|
|
|
|
}
|
|
|
|
return size;
|
|
|
|
}
|
|
|
|
|
2012-09-20 14:59:16 +02:00
|
|
|
MEM_CacheElementPtr get_least_priority_destroyable_element(void) {
|
|
|
|
if (queue.empty())
|
|
|
|
return NULL;
|
|
|
|
|
|
|
|
if (!getItemPriority)
|
|
|
|
return *queue.begin();
|
|
|
|
|
|
|
|
MEM_CacheElementPtr best_match_elem = NULL;
|
|
|
|
int best_match_priority = 0;
|
2012-07-10 16:43:50 +02:00
|
|
|
iterator it;
|
|
|
|
int i;
|
|
|
|
|
|
|
|
for (it = queue.begin(), i = 0; it != queue.end(); it++, i++) {
|
|
|
|
MEM_CacheElementPtr elem = *it;
|
2012-09-20 14:59:16 +02:00
|
|
|
|
|
|
|
if (!elem->can_destroy())
|
|
|
|
continue;
|
2012-07-10 16:43:50 +02:00
|
|
|
|
2012-11-23 16:12:13 +01:00
|
|
|
/* by default 0 means highest priority element */
|
|
|
|
/* casting a size type to int is questionable,
|
|
|
|
but unlikely to cause problems */
|
|
|
|
int priority = -((int)(queue.size()) - i - 1);
|
2012-09-20 14:59:16 +02:00
|
|
|
priority = getItemPriority(elem->get()->get_data(), priority);
|
2012-07-10 16:43:50 +02:00
|
|
|
|
2012-09-20 14:59:16 +02:00
|
|
|
if (priority < best_match_priority || best_match_elem == NULL) {
|
|
|
|
best_match_priority = priority;
|
|
|
|
best_match_elem = elem;
|
2012-07-10 16:43:50 +02:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2012-09-20 14:59:16 +02:00
|
|
|
return best_match_elem;
|
2012-07-10 16:43:50 +02:00
|
|
|
}
|
|
|
|
|
|
|
|
MEM_CacheQueue queue;
|
2011-10-23 19:52:20 +02:00
|
|
|
MEM_CacheLimiter_DataSize_Func getDataSize;
|
2012-07-10 16:43:50 +02:00
|
|
|
MEM_CacheLimiter_ItemPriority_Func getItemPriority;
|
2006-02-05 19:56:30 +01:00
|
|
|
};
|
|
|
|
|
2012-02-17 19:59:41 +01:00
|
|
|
#endif // __MEM_CACHELIMITER_H__
|