Mercurial > hg > orthanc-webviewer
annotate Plugin/Cache/CacheScheduler.cpp @ 24:ed9acb0f938e
sync
author | Sebastien Jodogne <s.jodogne@gmail.com> |
---|---|
date | Mon, 01 Jun 2015 12:48:18 +0200 |
parents | fcbc8e77cf8f |
children | a6492d20b2a8 |
rev | line source |
---|---|
0 | 1 /** |
2 * Orthanc - A Lightweight, RESTful DICOM Store | |
3 * Copyright (C) 2012-2015 Sebastien Jodogne, Medical Physics | |
4 * Department, University Hospital of Liege, Belgium | |
5 * | |
6 * This program is free software: you can redistribute it and/or | |
7 * modify it under the terms of the GNU Affero General Public License | |
8 * as published by the Free Software Foundation, either version 3 of | |
9 * the License, or (at your option) any later version. | |
10 * | |
11 * This program is distributed in the hope that it will be useful, but | |
12 * WITHOUT ANY WARRANTY; without even the implied warranty of | |
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | |
14 * Affero General Public License for more details. | |
15 * | |
16 * You should have received a copy of the GNU Affero General Public License | |
17 * along with this program. If not, see <http://www.gnu.org/licenses/>. | |
18 **/ | |
19 | |
20 | |
21 #include "CacheScheduler.h" | |
22 | |
23 #include "CacheIndex.h" | |
24 | |
25 #include "../../Orthanc/OrthancException.h" | |
26 #include <stdio.h> | |
27 | |
28 namespace OrthancPlugins | |
29 { | |
30 class DynamicString : public Orthanc::IDynamicObject | |
31 { | |
32 private: | |
33 std::string value_; | |
34 | |
35 public: | |
36 DynamicString(const std::string& value) : value_(value) | |
37 { | |
38 } | |
39 | |
40 const std::string& GetValue() const | |
41 { | |
42 return value_; | |
43 } | |
44 }; | |
45 | |
46 | |
47 class CacheScheduler::PrefetchQueue : public boost::noncopyable | |
48 { | |
49 private: | |
50 boost::mutex mutex_; | |
51 Orthanc::SharedMessageQueue queue_; | |
52 std::set<std::string> content_; | |
53 | |
54 public: | |
55 PrefetchQueue(size_t maxSize) : queue_(maxSize) | |
56 { | |
57 queue_.SetLifoPolicy(); | |
58 } | |
59 | |
60 void Enqueue(const std::string& item) | |
61 { | |
62 boost::mutex::scoped_lock lock(mutex_); | |
63 | |
64 if (content_.find(item) != content_.end()) | |
65 { | |
66 // This cache index is already pending in the queue | |
67 return; | |
68 } | |
69 | |
70 content_.insert(item); | |
71 queue_.Enqueue(new DynamicString(item)); | |
72 } | |
73 | |
74 DynamicString* Dequeue(int32_t msTimeout) | |
75 { | |
76 std::auto_ptr<Orthanc::IDynamicObject> message(queue_.Dequeue(msTimeout)); | |
77 if (message.get() == NULL) | |
78 { | |
79 return NULL; | |
80 } | |
81 | |
82 const DynamicString& index = dynamic_cast<const DynamicString&>(*message); | |
83 | |
84 { | |
85 boost::mutex::scoped_lock lock(mutex_); | |
86 content_.erase(index.GetValue()); | |
87 } | |
88 | |
89 return dynamic_cast<DynamicString*>(message.release()); | |
90 } | |
91 }; | |
92 | |
93 | |
94 class CacheScheduler::Prefetcher : public boost::noncopyable | |
95 { | |
96 private: | |
97 int bundleIndex_; | |
98 ICacheFactory& factory_; | |
99 CacheManager& cache_; | |
100 boost::mutex& cacheMutex_; | |
101 PrefetchQueue& queue_; | |
102 | |
103 bool done_; | |
104 boost::thread thread_; | |
105 boost::mutex invalidatedMutex_; | |
106 bool invalidated_; | |
107 std::string prefetching_; | |
108 | |
109 static void Worker(Prefetcher* that) | |
110 { | |
111 while (!(that->done_)) | |
112 { | |
113 std::auto_ptr<DynamicString> prefetch(that->queue_.Dequeue(500)); | |
114 | |
115 if (prefetch.get() != NULL) | |
116 { | |
117 { | |
118 boost::mutex::scoped_lock lock(that->invalidatedMutex_); | |
119 that->invalidated_ = false; | |
120 that->prefetching_ = prefetch->GetValue(); | |
121 } | |
122 | |
123 { | |
124 boost::mutex::scoped_lock lock(that->cacheMutex_); | |
125 if (that->cache_.IsCached(that->bundleIndex_, prefetch->GetValue())) | |
126 { | |
127 // This item is already cached | |
128 continue; | |
129 } | |
130 } | |
131 | |
132 std::string content; | |
20 | 133 |
134 try | |
0 | 135 { |
20 | 136 if (!that->factory_.Create(content, prefetch->GetValue())) |
137 { | |
138 // The factory cannot generate this item | |
139 continue; | |
140 } | |
141 } | |
142 catch (...) | |
143 { | |
144 // Exception | |
0 | 145 continue; |
146 } | |
147 | |
148 { | |
149 boost::mutex::scoped_lock lock(that->invalidatedMutex_); | |
150 if (that->invalidated_) | |
151 { | |
152 // This item has been invalidated | |
153 continue; | |
154 } | |
155 | |
156 { | |
157 boost::mutex::scoped_lock lock2(that->cacheMutex_); | |
158 that->cache_.Store(that->bundleIndex_, prefetch->GetValue(), content); | |
159 } | |
160 } | |
161 } | |
162 } | |
163 } | |
164 | |
165 | |
166 public: | |
167 Prefetcher(int bundleIndex, | |
168 ICacheFactory& factory, | |
169 CacheManager& cache, | |
170 boost::mutex& cacheMutex, | |
171 PrefetchQueue& queue) : | |
172 bundleIndex_(bundleIndex), | |
173 factory_(factory), | |
174 cache_(cache), | |
175 cacheMutex_(cacheMutex), | |
176 queue_(queue) | |
177 { | |
178 done_ = false; | |
179 thread_ = boost::thread(Worker, this); | |
180 } | |
181 | |
182 ~Prefetcher() | |
183 { | |
184 done_ = true; | |
185 if (thread_.joinable()) | |
186 { | |
187 thread_.join(); | |
188 } | |
189 } | |
190 | |
191 void SignalInvalidated(const std::string& item) | |
192 { | |
193 boost::mutex::scoped_lock lock(invalidatedMutex_); | |
194 | |
195 if (prefetching_ == item) | |
196 { | |
197 invalidated_ = true; | |
198 } | |
199 } | |
200 }; | |
201 | |
202 | |
203 | |
204 class CacheScheduler::BundleScheduler | |
205 { | |
206 private: | |
207 std::auto_ptr<ICacheFactory> factory_; | |
208 PrefetchQueue queue_; | |
209 std::vector<Prefetcher*> prefetchers_; | |
210 | |
211 public: | |
212 BundleScheduler(int bundleIndex, | |
213 ICacheFactory* factory, | |
214 CacheManager& cache, | |
215 boost::mutex& cacheMutex, | |
216 size_t numThreads, | |
217 size_t queueSize) : | |
218 factory_(factory), | |
219 queue_(queueSize) | |
220 { | |
221 prefetchers_.resize(numThreads, NULL); | |
222 | |
223 for (size_t i = 0; i < numThreads; i++) | |
224 { | |
225 prefetchers_[i] = new Prefetcher(bundleIndex, *factory_, cache, cacheMutex, queue_); | |
226 } | |
227 } | |
228 | |
229 ~BundleScheduler() | |
230 { | |
231 for (size_t i = 0; i < prefetchers_.size(); i++) | |
232 { | |
233 if (prefetchers_[i] != NULL) | |
234 delete prefetchers_[i]; | |
235 } | |
236 } | |
237 | |
238 void Invalidate(const std::string& item) | |
239 { | |
240 for (size_t i = 0; i < prefetchers_.size(); i++) | |
241 { | |
242 prefetchers_[i]->SignalInvalidated(item); | |
243 } | |
244 } | |
245 | |
246 void Prefetch(const std::string& item) | |
247 { | |
248 queue_.Enqueue(item); | |
249 } | |
250 | |
251 bool CallFactory(std::string& content, | |
252 const std::string& item) | |
253 { | |
254 content.clear(); | |
255 return factory_->Create(content, item); | |
256 } | |
257 }; | |
258 | |
259 | |
260 | |
261 CacheScheduler::BundleScheduler& CacheScheduler::GetBundleScheduler(unsigned int bundleIndex) | |
262 { | |
263 boost::mutex::scoped_lock lock(factoryMutex_); | |
264 | |
265 BundleSchedulers::iterator it = bundles_.find(bundleIndex); | |
266 if (it == bundles_.end()) | |
267 { | |
268 throw Orthanc::OrthancException("No factory associated with this bundle"); | |
269 } | |
270 | |
271 return *(it->second); | |
272 } | |
273 | |
274 | |
275 | |
276 CacheScheduler::CacheScheduler(CacheManager& cache, | |
277 unsigned int maxPrefetchSize) : | |
278 maxPrefetchSize_(maxPrefetchSize), | |
279 cache_(cache), | |
280 policy_(NULL) | |
281 { | |
282 } | |
283 | |
284 | |
285 CacheScheduler::~CacheScheduler() | |
286 { | |
287 for (BundleSchedulers::iterator it = bundles_.begin(); | |
288 it != bundles_.end(); it++) | |
289 { | |
290 delete it->second; | |
291 } | |
292 } | |
293 | |
294 | |
295 void CacheScheduler::Register(int bundle, | |
296 ICacheFactory* factory /* takes ownership */, | |
297 size_t numThreads) | |
298 { | |
299 boost::mutex::scoped_lock lock(factoryMutex_); | |
300 | |
301 BundleSchedulers::iterator it = bundles_.find(bundle); | |
302 if (it != bundles_.end()) | |
303 { | |
304 // This bundle is already registered | |
305 throw Orthanc::OrthancException(Orthanc::ErrorCode_BadSequenceOfCalls); | |
306 } | |
307 | |
308 bundles_[bundle] = new BundleScheduler(bundle, factory, cache_, cacheMutex_, numThreads, maxPrefetchSize_); | |
309 } | |
310 | |
311 | |
4
ecefd45026bf
configuration of the cache
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
312 void CacheScheduler::SetQuota(int bundle, |
ecefd45026bf
configuration of the cache
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
313 uint32_t maxCount, |
ecefd45026bf
configuration of the cache
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
314 uint64_t maxSpace) |
ecefd45026bf
configuration of the cache
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
315 { |
ecefd45026bf
configuration of the cache
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
316 boost::mutex::scoped_lock lock(cacheMutex_); |
ecefd45026bf
configuration of the cache
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
317 cache_.SetBundleQuota(bundle, maxCount, maxSpace); |
ecefd45026bf
configuration of the cache
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
318 } |
ecefd45026bf
configuration of the cache
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
319 |
ecefd45026bf
configuration of the cache
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
320 |
0 | 321 void CacheScheduler::Invalidate(int bundle, |
322 const std::string& item) | |
323 { | |
324 { | |
325 boost::mutex::scoped_lock lock(cacheMutex_); | |
326 cache_.Invalidate(bundle, item); | |
327 } | |
328 | |
329 GetBundleScheduler(bundle).Invalidate(item); | |
330 } | |
331 | |
332 | |
333 void CacheScheduler::ApplyPrefetchPolicy(int bundle, | |
334 const std::string& item, | |
335 const std::string& content) | |
336 { | |
337 boost::recursive_mutex::scoped_lock lock(policyMutex_); | |
338 | |
339 if (policy_.get() != NULL) | |
340 { | |
341 std::list<CacheIndex> toPrefetch; | |
342 | |
343 { | |
344 policy_->Apply(toPrefetch, *this, CacheIndex(bundle, item), content); | |
345 } | |
346 | |
347 for (std::list<CacheIndex>::const_reverse_iterator | |
348 it = toPrefetch.rbegin(); it != toPrefetch.rend(); ++it) | |
349 { | |
350 Prefetch(it->GetBundle(), it->GetItem()); | |
351 } | |
352 } | |
353 } | |
354 | |
355 | |
356 bool CacheScheduler::Access(std::string& content, | |
357 int bundle, | |
358 const std::string& item) | |
359 { | |
360 bool existing; | |
361 | |
362 { | |
363 boost::mutex::scoped_lock lock(cacheMutex_); | |
364 existing = cache_.Access(content, bundle, item); | |
365 } | |
366 | |
367 if (existing) | |
368 { | |
369 ApplyPrefetchPolicy(bundle, item, content); | |
370 return true; | |
371 } | |
372 | |
373 if (!GetBundleScheduler(bundle).CallFactory(content, item)) | |
374 { | |
375 // This item cannot be generated by the factory | |
376 return false; | |
377 } | |
378 | |
379 { | |
380 boost::mutex::scoped_lock lock(cacheMutex_); | |
381 cache_.Store(bundle, item, content); | |
382 } | |
383 | |
384 ApplyPrefetchPolicy(bundle, item, content); | |
385 | |
386 return true; | |
387 } | |
388 | |
389 | |
390 void CacheScheduler::Prefetch(int bundle, | |
391 const std::string& item) | |
392 { | |
393 GetBundleScheduler(bundle).Prefetch(item); | |
394 } | |
395 | |
396 | |
397 void CacheScheduler::RegisterPolicy(IPrefetchPolicy* policy) | |
398 { | |
399 boost::recursive_mutex::scoped_lock lock(policyMutex_); | |
400 policy_.reset(policy); | |
401 } | |
402 | |
403 } |