3 #include <msp/debug/demangle.h>
4 #include <msp/strings/format.h>
5 #include <msp/time/utils.h>
6 #include "resourcemanager.h"
8 #include "resourceobserver.h"
15 resource_load_error::resource_load_error(const string &name, const string &err):
16 runtime_error(format("%s: %s", name, err))
19 resource_load_error::resource_load_error(const string &name, const exception &exc):
20 runtime_error(format("%s: %s: %s", name, Debug::demangle(typeid(exc).name()), exc.what()))
24 ResourceManager::ResourceManager():
25 policy(LOAD_ON_DEMAND),
30 min_retain_frames(30),
35 ResourceManager::~ResourceManager()
39 while(!resources.empty())
40 resources.begin()->second.resource->set_manager(0);
43 void ResourceManager::set_loading_policy(LoadingPolicy p)
48 void ResourceManager::set_async_loads(bool a)
53 void ResourceManager::set_size_limit(UInt64 s)
58 void ResourceManager::set_min_retain_frames(unsigned f)
60 min_retain_frames = f;
63 void ResourceManager::set_max_retain_frames(unsigned f)
65 max_retain_frames = f;
68 void ResourceManager::add_resource(Resource &r)
70 MutexLock lock(map_mutex);
71 insert_unique(resources, &r, ManagedResource(r));
74 const ResourceManager::ManagedResource &ResourceManager::get_managed_resource(const Resource &r) const
76 MutexLock lock(map_mutex);
77 return get_item(resources, &r);
80 ResourceManager::ManagedResource &ResourceManager::get_managed_resource(const Resource &r)
82 MutexLock lock(map_mutex);
83 return get_item(resources, &r);
86 void ResourceManager::set_resource_location(Resource &r, DataFile::Collection &c, const string &n)
88 set_resource_location(r, ResourceLocation(c, n));
91 void ResourceManager::set_resource_location(Resource &r, const ResourceLocation &l)
94 MutexLock lock(map_mutex);
95 ManagedResource &managed = get_item(resources, &r);
99 if(policy==LOAD_IMMEDIATELY)
103 const ResourceManager::ResourceLocation *ResourceManager::get_resource_location(const Resource &r) const
105 const ManagedResource &managed = get_managed_resource(r);
106 return managed.location.collection ? &managed.location : 0;
109 void ResourceManager::load_resource(Resource &r)
111 ManagedResource &managed = get_managed_resource(r);
112 if(!managed.location.collection)
113 throw runtime_error("no location");
115 if(managed.state!=ManagedResource::NOT_LOADED)
120 managed.state = ManagedResource::LOAD_QUEUED;
121 LoadQueue::iterator i;
122 for(i=queue.begin(); (i!=queue.end() && (*i)->load_priority>=managed.load_priority); ++i) ;
123 queue.insert(i, &managed);
127 managed.start_loading();
128 while(!managed.loader->process()) ;
129 managed.finish_loading(true);
130 total_data_size += managed.data_size;
134 bool ResourceManager::is_resource_loaded(const Resource &r) const
136 ManagedResource *managed = reinterpret_cast<ManagedResource *>(r.get_manager_data());
137 return managed ? managed->state==ManagedResource::LOADED : false;
140 void ResourceManager::resource_used(const Resource &r)
142 ManagedResource *managed = reinterpret_cast<ManagedResource *>(r.get_manager_data());
145 if(managed->state==ManagedResource::NOT_LOADED && policy!=LOAD_MANUALLY)
146 load_resource(*managed->resource);
148 managed->last_used = frame;
149 if(max_retain_frames && !next_unload)
150 next_unload = frame+max_retain_frames+1;
153 void ResourceManager::remove_resource(Resource &r)
155 ManagedResource &managed = get_managed_resource(r);
156 ManagedResource::State state = managed.state;
157 if(state==ManagedResource::LOAD_QUEUED)
159 LoadQueue::iterator i = find(queue.begin(), queue.end(), &managed);
163 else if(state>ManagedResource::LOAD_QUEUED && state<ManagedResource::LOADED)
164 thread.remove_resource(managed);
166 for(vector<ResourceObserver *>::const_iterator i=managed.observers.begin(); i!=managed.observers.end(); ++i)
167 (*i)->resource_removed(r);
169 MutexLock lock(map_mutex);
170 remove_existing(resources, &r);
173 void ResourceManager::observe_resource(const Resource &r, ResourceObserver &w)
175 get_managed_resource(r).add_observer(w);
178 void ResourceManager::unobserve_resource(const Resource &r, ResourceObserver &w)
180 get_managed_resource(r).remove_observer(w);
183 void ResourceManager::tick()
187 bool do_unload = (frame>=next_unload);
190 total_data_size += thread.get_and_reset_loaded_data_size();
194 if(thread.needs_work() && !queue.empty())
199 MutexLock lock(map_mutex);
200 if(max_retain_frames && frame>=next_unload)
205 for(ResourceMap::iterator i=resources.begin(); i!=resources.end(); ++i)
206 if(i->second.state==ManagedResource::LOADED)
207 next_unload = min(next_unload, i->second.last_used);
208 next_unload = (next_unload<frame ? next_unload+max_retain_frames : 0);
216 void ResourceManager::dispatch_work()
218 queue.sort(age_order);
220 if(queue.front()->last_used+min_retain_frames<frame)
222 for(LoadQueue::iterator i=queue.begin(); i!=queue.end(); ++i)
223 (*i)->state = ManagedResource::NOT_LOADED;
228 while(thread.needs_work() && !queue.empty())
230 ManagedResource *managed = queue.front();
232 thread.add_resource(*managed);
236 void ResourceManager::unload_by_age()
238 unsigned unload_limit = frame-max_retain_frames;
240 for(ResourceMap::iterator i=resources.begin(); i!=resources.end(); ++i)
241 if(i->second.state==ManagedResource::LOADED && i->second.last_used<unload_limit)
244 total_data_size -= i->second.data_size;
248 void ResourceManager::unload_by_size()
250 unsigned unload_limit = frame-min_retain_frames;
252 while(total_data_size>size_limit)
254 ManagedResource *best = 0;
255 UInt64 best_impact = 0;
256 for(ResourceMap::iterator i=resources.begin(); i!=resources.end(); ++i)
257 if(i->second.state==ManagedResource::LOADED && i->second.last_used<unload_limit)
259 UInt64 impact = i->second.data_size*(frame-i->second.last_used);
260 if(!best || impact>best_impact)
263 best_impact = impact;
271 total_data_size -= best->data_size;
275 bool ResourceManager::age_order(ManagedResource *mr1, ManagedResource *mr2)
277 return mr1->last_used>mr2->last_used;
281 ResourceManager::ResourceLocation::ResourceLocation():
285 ResourceManager::ResourceLocation::ResourceLocation(DataFile::Collection &c, const string &n):
291 ResourceManager::ManagedResource::ManagedResource(Resource &r):
293 load_priority(r.get_load_priority()),
301 void ResourceManager::ManagedResource::start_loading()
303 io = location.collection->open_raw(location.name);
305 throw resource_load_error(location.name, "open failed");
307 const Resources *res = dynamic_cast<Resources *>(location.collection);
308 loader = resource->load(*io, res);
313 throw logic_error("no loader created");
318 bool ResourceManager::ManagedResource::process(bool sync)
320 while(state!=LOAD_FINISHED && loader->needs_sync()==sync)
321 if(loader->process())
322 state = LOAD_FINISHED;
324 return state==LOAD_FINISHED;
327 void ResourceManager::ManagedResource::finish_loading(bool successful)
337 data_size = resource->get_data_size();
339 for(vector<ResourceObserver *>::const_iterator i=observers.begin(); i!=observers.end(); ++i)
340 (*i)->resource_loaded(*resource);
349 void ResourceManager::ManagedResource::finish_loading()
351 finish_loading(state==LOAD_FINISHED);
354 void ResourceManager::ManagedResource::unload()
359 for(vector<ResourceObserver *>::const_iterator i=observers.begin(); i!=observers.end(); ++i)
360 (*i)->resource_unloaded(*resource);
363 void ResourceManager::ManagedResource::add_observer(ResourceObserver &w)
365 if(find(observers.begin(), observers.end(), &w)==observers.end())
366 observers.push_back(&w);
369 void ResourceManager::ManagedResource::remove_observer(ResourceObserver &w)
371 vector<ResourceObserver *>::iterator end = remove(observers.begin(), observers.end(), &w);
372 if(end!=observers.end())
373 observers.erase(end, observers.end());
377 ResourceManager::LoadingThread::LoadingThread():
378 Thread("ResourceManager"),
388 void ResourceManager::LoadingThread::main()
390 bool wait_for_work = false;
396 if(ManagedResource *managed = front(async_queue))
400 managed->process(false);
402 catch(const exception &e)
404 MutexLock lock(queue_mutex);
405 error_queue.push_back(resource_load_error(managed->location.name, e));
406 managed->state = ManagedResource::LOAD_ERROR;
409 MutexLock lock(queue_mutex);
410 sync_queue.splice(sync_queue.end(), async_queue, async_queue.begin());
411 wait_for_work = async_queue.empty();
414 wait_for_work = true;
418 ResourceManager::ManagedResource *ResourceManager::LoadingThread::front(LoadQueue &que)
420 MutexLock lock(queue_mutex);
427 void ResourceManager::LoadingThread::add_resource(ManagedResource &r)
431 MutexLock lock(queue_mutex);
432 if(r.loader->needs_sync())
433 sync_queue.push_back(&r);
436 bool was_empty = async_queue.empty();
437 async_queue.push_back(&r);
445 void ResourceManager::LoadingThread::remove_resource(ManagedResource &r)
447 while(!try_remove_resource(r))
448 Time::sleep(Time::msec);
451 if(r.state==ManagedResource::LOADED)
453 MutexLock lock(data_size_mutex);
454 loaded_data_size += r.data_size;
458 bool ResourceManager::LoadingThread::try_remove_resource(ManagedResource &r)
460 MutexLock lock(queue_mutex);
462 LoadQueue::iterator i = find(async_queue.begin(), async_queue.end(), &r);
463 if(i==async_queue.end())
465 i = find(sync_queue.begin(), sync_queue.end(), &r);
466 if(i!=sync_queue.end())
472 else if(i==async_queue.begin())
476 async_queue.erase(i);
483 bool ResourceManager::LoadingThread::sync()
486 MutexLock lock(queue_mutex);
488 if(!error_queue.empty())
490 resource_load_error err = error_queue.front();
491 error_queue.pop_front();
495 unsigned async_size = async_queue.size();
496 if(async_size==0 && size==capacity)
498 else if(async_size>2 && capacity>2)
502 bool any_finished = false;
503 while(ManagedResource *managed = front(sync_queue))
505 if(managed->state==ManagedResource::LOAD_ERROR || managed->process(true))
507 managed->finish_loading();
508 if(managed->state==ManagedResource::LOADED)
510 MutexLock lock(data_size_mutex);
511 loaded_data_size += managed->data_size;
516 MutexLock lock(queue_mutex);
517 sync_queue.pop_front();
521 MutexLock lock(queue_mutex);
522 bool was_empty = async_queue.empty();
523 async_queue.splice(async_queue.end(), sync_queue, sync_queue.begin());
532 UInt64 ResourceManager::LoadingThread::get_and_reset_loaded_data_size()
534 MutexLock lock(data_size_mutex);
535 UInt64 result = loaded_data_size;
536 loaded_data_size = 0;
540 void ResourceManager::LoadingThread::terminate()