Mercurial > hg > orthanc-webviewer
annotate Plugin/Cache/CacheScheduler.cpp @ 245:cc3f8d31f23d OrthancWebViewer-2.1
closing OrthancWebViewer-2.1
| author | Sebastien Jodogne <s.jodogne@gmail.com> |
|---|---|
| date | Mon, 25 May 2020 14:09:00 +0200 |
| parents | c8ca47a67bf3 |
| children | 3809121c3290 |
| 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 | |
| 26 | 25 #include "../../Orthanc/Core/OrthancException.h" |
| 0 | 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 } | |
| 96 | 257 |
| 258 ICacheFactory& GetFactory() | |
| 259 { | |
| 260 return *factory_; | |
| 261 } | |
| 0 | 262 }; |
| 263 | |
| 264 | |
| 265 | |
| 266 CacheScheduler::BundleScheduler& CacheScheduler::GetBundleScheduler(unsigned int bundleIndex) | |
| 267 { | |
| 268 boost::mutex::scoped_lock lock(factoryMutex_); | |
| 269 | |
| 270 BundleSchedulers::iterator it = bundles_.find(bundleIndex); | |
| 271 if (it == bundles_.end()) | |
| 272 { | |
| 79 | 273 // No factory associated with this bundle |
| 274 throw Orthanc::OrthancException(Orthanc::ErrorCode_ParameterOutOfRange); | |
| 0 | 275 } |
| 276 | |
| 277 return *(it->second); | |
| 278 } | |
| 279 | |
| 280 | |
| 281 | |
| 282 CacheScheduler::CacheScheduler(CacheManager& cache, | |
| 283 unsigned int maxPrefetchSize) : | |
| 284 maxPrefetchSize_(maxPrefetchSize), | |
| 285 cache_(cache), | |
| 286 policy_(NULL) | |
| 287 { | |
| 288 } | |
| 289 | |
| 290 | |
| 291 CacheScheduler::~CacheScheduler() | |
| 292 { | |
| 293 for (BundleSchedulers::iterator it = bundles_.begin(); | |
| 294 it != bundles_.end(); it++) | |
| 295 { | |
| 296 delete it->second; | |
| 297 } | |
| 298 } | |
| 299 | |
| 300 | |
| 301 void CacheScheduler::Register(int bundle, | |
| 302 ICacheFactory* factory /* takes ownership */, | |
| 303 size_t numThreads) | |
| 304 { | |
| 305 boost::mutex::scoped_lock lock(factoryMutex_); | |
| 306 | |
| 307 BundleSchedulers::iterator it = bundles_.find(bundle); | |
| 308 if (it != bundles_.end()) | |
| 309 { | |
| 310 // This bundle is already registered | |
| 311 throw Orthanc::OrthancException(Orthanc::ErrorCode_BadSequenceOfCalls); | |
| 312 } | |
| 313 | |
| 314 bundles_[bundle] = new BundleScheduler(bundle, factory, cache_, cacheMutex_, numThreads, maxPrefetchSize_); | |
| 315 } | |
| 316 | |
| 317 | |
|
4
ecefd45026bf
configuration of the cache
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
318 void CacheScheduler::SetQuota(int bundle, |
|
ecefd45026bf
configuration of the cache
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
319 uint32_t maxCount, |
|
ecefd45026bf
configuration of the cache
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
320 uint64_t maxSpace) |
|
ecefd45026bf
configuration of the cache
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
321 { |
|
ecefd45026bf
configuration of the cache
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
322 boost::mutex::scoped_lock lock(cacheMutex_); |
|
ecefd45026bf
configuration of the cache
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
323 cache_.SetBundleQuota(bundle, maxCount, maxSpace); |
|
ecefd45026bf
configuration of the cache
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
324 } |
|
ecefd45026bf
configuration of the cache
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
325 |
|
ecefd45026bf
configuration of the cache
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
326 |
| 0 | 327 void CacheScheduler::Invalidate(int bundle, |
| 328 const std::string& item) | |
| 329 { | |
| 330 { | |
| 331 boost::mutex::scoped_lock lock(cacheMutex_); | |
| 332 cache_.Invalidate(bundle, item); | |
| 333 } | |
| 334 | |
| 335 GetBundleScheduler(bundle).Invalidate(item); | |
| 336 } | |
| 337 | |
| 338 | |
| 339 void CacheScheduler::ApplyPrefetchPolicy(int bundle, | |
| 340 const std::string& item, | |
| 341 const std::string& content) | |
| 342 { | |
| 343 boost::recursive_mutex::scoped_lock lock(policyMutex_); | |
| 344 | |
| 345 if (policy_.get() != NULL) | |
| 346 { | |
| 347 std::list<CacheIndex> toPrefetch; | |
| 348 | |
| 349 { | |
| 350 policy_->Apply(toPrefetch, *this, CacheIndex(bundle, item), content); | |
| 351 } | |
| 352 | |
| 353 for (std::list<CacheIndex>::const_reverse_iterator | |
| 354 it = toPrefetch.rbegin(); it != toPrefetch.rend(); ++it) | |
| 355 { | |
| 356 Prefetch(it->GetBundle(), it->GetItem()); | |
| 357 } | |
| 358 } | |
| 359 } | |
| 360 | |
| 361 | |
| 362 bool CacheScheduler::Access(std::string& content, | |
| 363 int bundle, | |
| 364 const std::string& item) | |
| 365 { | |
| 366 bool existing; | |
| 367 | |
| 368 { | |
| 369 boost::mutex::scoped_lock lock(cacheMutex_); | |
| 370 existing = cache_.Access(content, bundle, item); | |
| 371 } | |
| 372 | |
| 373 if (existing) | |
| 374 { | |
| 375 ApplyPrefetchPolicy(bundle, item, content); | |
| 376 return true; | |
| 377 } | |
| 378 | |
| 379 if (!GetBundleScheduler(bundle).CallFactory(content, item)) | |
| 380 { | |
| 381 // This item cannot be generated by the factory | |
| 382 return false; | |
| 383 } | |
| 384 | |
| 385 { | |
| 386 boost::mutex::scoped_lock lock(cacheMutex_); | |
| 387 cache_.Store(bundle, item, content); | |
| 388 } | |
| 389 | |
| 390 ApplyPrefetchPolicy(bundle, item, content); | |
| 391 | |
| 392 return true; | |
| 393 } | |
| 394 | |
| 395 | |
| 396 void CacheScheduler::Prefetch(int bundle, | |
| 397 const std::string& item) | |
| 398 { | |
| 399 GetBundleScheduler(bundle).Prefetch(item); | |
| 400 } | |
| 401 | |
| 402 | |
| 403 void CacheScheduler::RegisterPolicy(IPrefetchPolicy* policy) | |
| 404 { | |
| 405 boost::recursive_mutex::scoped_lock lock(policyMutex_); | |
| 406 policy_.reset(policy); | |
| 407 } | |
| 408 | |
| 96 | 409 |
| 410 ICacheFactory& CacheScheduler::GetFactory(int bundle) | |
| 411 { | |
| 412 return GetBundleScheduler(bundle).GetFactory(); | |
| 413 } | |
|
115
c8ca47a67bf3
automatic clearing of the cache
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
96
diff
changeset
|
414 |
|
c8ca47a67bf3
automatic clearing of the cache
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
96
diff
changeset
|
415 |
|
c8ca47a67bf3
automatic clearing of the cache
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
96
diff
changeset
|
416 void CacheScheduler::SetProperty(CacheProperty property, |
|
c8ca47a67bf3
automatic clearing of the cache
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
96
diff
changeset
|
417 const std::string& value) |
|
c8ca47a67bf3
automatic clearing of the cache
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
96
diff
changeset
|
418 { |
|
c8ca47a67bf3
automatic clearing of the cache
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
96
diff
changeset
|
419 boost::mutex::scoped_lock lock(cacheMutex_); |
|
c8ca47a67bf3
automatic clearing of the cache
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
96
diff
changeset
|
420 cache_.SetProperty(property, value); |
|
c8ca47a67bf3
automatic clearing of the cache
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
96
diff
changeset
|
421 } |
|
c8ca47a67bf3
automatic clearing of the cache
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
96
diff
changeset
|
422 |
|
c8ca47a67bf3
automatic clearing of the cache
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
96
diff
changeset
|
423 |
|
c8ca47a67bf3
automatic clearing of the cache
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
96
diff
changeset
|
424 bool CacheScheduler::LookupProperty(std::string& target, |
|
c8ca47a67bf3
automatic clearing of the cache
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
96
diff
changeset
|
425 CacheProperty property) |
|
c8ca47a67bf3
automatic clearing of the cache
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
96
diff
changeset
|
426 { |
|
c8ca47a67bf3
automatic clearing of the cache
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
96
diff
changeset
|
427 boost::mutex::scoped_lock lock(cacheMutex_); |
|
c8ca47a67bf3
automatic clearing of the cache
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
96
diff
changeset
|
428 return cache_.LookupProperty(target, property); |
|
c8ca47a67bf3
automatic clearing of the cache
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
96
diff
changeset
|
429 } |
|
c8ca47a67bf3
automatic clearing of the cache
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
96
diff
changeset
|
430 |
|
c8ca47a67bf3
automatic clearing of the cache
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
96
diff
changeset
|
431 |
|
c8ca47a67bf3
automatic clearing of the cache
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
96
diff
changeset
|
432 void CacheScheduler::Clear() |
|
c8ca47a67bf3
automatic clearing of the cache
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
96
diff
changeset
|
433 { |
|
c8ca47a67bf3
automatic clearing of the cache
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
96
diff
changeset
|
434 boost::mutex::scoped_lock lock(cacheMutex_); |
|
c8ca47a67bf3
automatic clearing of the cache
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
96
diff
changeset
|
435 return cache_.Clear(); |
|
c8ca47a67bf3
automatic clearing of the cache
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
96
diff
changeset
|
436 } |
| 0 | 437 } |