Mercurial > hg > orthanc-stone
annotate Framework/Oracle/ThreadedOracle.cpp @ 1098:17660df24c36 broker
simplification of IOracleRunner
| author | Sebastien Jodogne <s.jodogne@gmail.com> |
|---|---|
| date | Fri, 25 Oct 2019 13:01:24 +0200 |
| parents | 4383382db01d |
| children | 66e21ef2d657 |
| rev | line source |
|---|---|
| 748 | 1 /** |
| 2 * Stone of Orthanc | |
| 3 * Copyright (C) 2012-2016 Sebastien Jodogne, Medical Physics | |
| 4 * Department, University Hospital of Liege, Belgium | |
| 5 * Copyright (C) 2017-2019 Osimis S.A., Belgium | |
| 6 * | |
| 7 * This program is free software: you can redistribute it and/or | |
| 8 * modify it under the terms of the GNU Affero General Public License | |
| 9 * as published by the Free Software Foundation, either version 3 of | |
| 10 * the License, or (at your option) any later version. | |
| 11 * | |
| 12 * This program is distributed in the hope that it will be useful, but | |
| 13 * WITHOUT ANY WARRANTY; without even the implied warranty of | |
| 14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | |
| 15 * Affero General Public License for more details. | |
| 16 * | |
| 17 * You should have received a copy of the GNU Affero General Public License | |
| 18 * along with this program. If not, see <http://www.gnu.org/licenses/>. | |
| 19 **/ | |
| 20 | |
| 21 | |
| 22 #include "ThreadedOracle.h" | |
| 23 | |
| 24 #include "SleepOracleCommand.h" | |
| 25 | |
| 1077 | 26 #include <Core/Logging.h> |
| 748 | 27 #include <Core/OrthancException.h> |
| 28 | |
| 29 namespace OrthancStone | |
| 30 { | |
| 31 class ThreadedOracle::Item : public Orthanc::IDynamicObject | |
| 32 { | |
| 33 private: | |
| 1075 | 34 boost::weak_ptr<IObserver> receiver_; |
| 748 | 35 std::auto_ptr<IOracleCommand> command_; |
| 36 | |
| 37 public: | |
| 1075 | 38 Item(boost::weak_ptr<IObserver> receiver, |
| 748 | 39 IOracleCommand* command) : |
| 40 receiver_(receiver), | |
| 41 command_(command) | |
| 42 { | |
| 43 if (command == NULL) | |
| 44 { | |
| 45 throw Orthanc::OrthancException(Orthanc::ErrorCode_NullPointer); | |
| 46 } | |
| 47 } | |
| 48 | |
|
1098
17660df24c36
simplification of IOracleRunner
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1097
diff
changeset
|
49 boost::weak_ptr<IObserver> GetReceiver() |
| 748 | 50 { |
| 51 return receiver_; | |
| 52 } | |
| 53 | |
| 54 IOracleCommand& GetCommand() | |
| 55 { | |
| 56 assert(command_.get() != NULL); | |
| 57 return *command_; | |
| 58 } | |
| 59 }; | |
| 60 | |
| 61 | |
| 62 class ThreadedOracle::SleepingCommands : public boost::noncopyable | |
| 63 { | |
| 64 private: | |
| 65 class Item | |
| 66 { | |
| 67 private: | |
| 1075 | 68 boost::weak_ptr<IObserver> receiver_; |
| 748 | 69 std::auto_ptr<SleepOracleCommand> command_; |
| 70 boost::posix_time::ptime expiration_; | |
| 71 | |
| 72 public: | |
|
1098
17660df24c36
simplification of IOracleRunner
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1097
diff
changeset
|
73 Item(boost::weak_ptr<IObserver> receiver, |
| 748 | 74 SleepOracleCommand* command) : |
| 75 receiver_(receiver), | |
| 76 command_(command) | |
| 77 { | |
| 78 if (command == NULL) | |
| 79 { | |
| 80 throw Orthanc::OrthancException(Orthanc::ErrorCode_NullPointer); | |
| 81 } | |
| 82 | |
|
760
1181e1ad98ec
progressive loading working
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
748
diff
changeset
|
83 expiration_ = (boost::posix_time::microsec_clock::local_time() + |
| 748 | 84 boost::posix_time::milliseconds(command_->GetDelay())); |
| 85 } | |
| 86 | |
| 87 const boost::posix_time::ptime& GetExpirationTime() const | |
| 88 { | |
| 89 return expiration_; | |
| 90 } | |
| 91 | |
| 92 void Awake(IMessageEmitter& emitter) | |
| 93 { | |
| 94 assert(command_.get() != NULL); | |
| 95 | |
| 96 SleepOracleCommand::TimeoutMessage message(*command_); | |
| 97 emitter.EmitMessage(receiver_, message); | |
| 98 } | |
| 99 }; | |
| 100 | |
| 101 typedef std::list<Item*> Content; | |
| 102 | |
| 103 boost::mutex mutex_; | |
| 104 Content content_; | |
| 105 | |
| 106 public: | |
| 107 ~SleepingCommands() | |
| 108 { | |
| 109 for (Content::iterator it = content_.begin(); it != content_.end(); ++it) | |
| 110 { | |
| 111 if (*it != NULL) | |
| 112 { | |
| 113 delete *it; | |
| 114 } | |
| 115 } | |
| 116 } | |
| 117 | |
|
1098
17660df24c36
simplification of IOracleRunner
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1097
diff
changeset
|
118 void Add(boost::weak_ptr<IObserver> receiver, |
| 748 | 119 SleepOracleCommand* command) // Takes ownership |
| 120 { | |
| 121 boost::mutex::scoped_lock lock(mutex_); | |
| 122 | |
| 123 content_.push_back(new Item(receiver, command)); | |
| 124 } | |
| 125 | |
| 126 void AwakeExpired(IMessageEmitter& emitter) | |
| 127 { | |
| 128 boost::mutex::scoped_lock lock(mutex_); | |
| 129 | |
|
760
1181e1ad98ec
progressive loading working
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
748
diff
changeset
|
130 const boost::posix_time::ptime now = boost::posix_time::microsec_clock::local_time(); |
| 748 | 131 |
| 132 Content stillSleeping; | |
| 133 | |
| 134 for (Content::iterator it = content_.begin(); it != content_.end(); ++it) | |
| 135 { | |
| 136 if (*it != NULL && | |
| 137 (*it)->GetExpirationTime() <= now) | |
| 138 { | |
| 139 (*it)->Awake(emitter); | |
| 140 delete *it; | |
| 141 *it = NULL; | |
| 142 } | |
| 143 else | |
| 144 { | |
| 145 stillSleeping.push_back(*it); | |
| 146 } | |
| 147 } | |
| 148 | |
| 149 // Compact the still-sleeping commands | |
| 150 content_ = stillSleeping; | |
| 151 } | |
| 152 }; | |
| 153 | |
| 154 | |
| 155 void ThreadedOracle::Step() | |
| 156 { | |
| 157 std::auto_ptr<Orthanc::IDynamicObject> object(queue_.Dequeue(100)); | |
| 158 | |
| 159 if (object.get() != NULL) | |
| 160 { | |
| 161 Item& item = dynamic_cast<Item&>(*object); | |
| 162 | |
| 1077 | 163 if (item.GetCommand().GetType() == IOracleCommand::Type_Sleep) |
| 748 | 164 { |
| 1077 | 165 SleepOracleCommand& command = dynamic_cast<SleepOracleCommand&>(item.GetCommand()); |
| 166 | |
| 167 std::auto_ptr<SleepOracleCommand> copy(new SleepOracleCommand(command.GetDelay())); | |
| 168 | |
| 169 if (command.HasPayload()) | |
| 748 | 170 { |
| 1077 | 171 copy->SetPayload(command.ReleasePayload()); |
| 748 | 172 } |
| 1077 | 173 |
| 174 sleepingCommands_->Add(item.GetReceiver(), copy.release()); | |
| 748 | 175 } |
| 1077 | 176 else |
| 748 | 177 { |
|
1098
17660df24c36
simplification of IOracleRunner
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1097
diff
changeset
|
178 GenericOracleRunner runner(orthanc_); |
|
17660df24c36
simplification of IOracleRunner
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1097
diff
changeset
|
179 std::auto_ptr<IMessage> message(runner.Run(item.GetCommand())); |
|
17660df24c36
simplification of IOracleRunner
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1097
diff
changeset
|
180 |
|
17660df24c36
simplification of IOracleRunner
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1097
diff
changeset
|
181 emitter_.EmitMessage(item.GetReceiver(), *message); |
| 748 | 182 } |
| 183 } | |
| 184 } | |
| 185 | |
| 186 | |
| 187 void ThreadedOracle::Worker(ThreadedOracle* that) | |
| 188 { | |
| 189 assert(that != NULL); | |
| 190 | |
| 191 for (;;) | |
| 192 { | |
| 193 { | |
| 194 boost::mutex::scoped_lock lock(that->mutex_); | |
| 195 if (that->state_ != State_Running) | |
| 196 { | |
| 197 return; | |
| 198 } | |
| 199 } | |
| 200 | |
| 201 that->Step(); | |
| 202 } | |
| 203 } | |
| 204 | |
| 205 | |
| 206 void ThreadedOracle::SleepingWorker(ThreadedOracle* that) | |
| 207 { | |
| 208 assert(that != NULL); | |
| 209 | |
| 210 for (;;) | |
| 211 { | |
| 212 { | |
| 213 boost::mutex::scoped_lock lock(that->mutex_); | |
| 214 if (that->state_ != State_Running) | |
| 215 { | |
| 216 return; | |
| 217 } | |
| 218 } | |
| 219 | |
| 220 that->sleepingCommands_->AwakeExpired(that->emitter_); | |
| 221 | |
| 222 boost::this_thread::sleep(boost::posix_time::milliseconds(that->sleepingTimeResolution_)); | |
| 223 } | |
| 224 } | |
| 225 | |
| 226 | |
| 227 void ThreadedOracle::StopInternal() | |
| 228 { | |
| 229 { | |
| 230 boost::mutex::scoped_lock lock(mutex_); | |
| 231 | |
| 232 if (state_ == State_Setup || | |
| 233 state_ == State_Stopped) | |
| 234 { | |
| 235 return; | |
| 236 } | |
| 237 else | |
| 238 { | |
| 239 state_ = State_Stopped; | |
| 240 } | |
| 241 } | |
| 242 | |
| 243 if (sleepingWorker_.joinable()) | |
| 244 { | |
| 245 sleepingWorker_.join(); | |
| 246 } | |
| 247 | |
| 248 for (size_t i = 0; i < workers_.size(); i++) | |
| 249 { | |
| 250 if (workers_[i] != NULL) | |
| 251 { | |
| 252 if (workers_[i]->joinable()) | |
| 253 { | |
| 254 workers_[i]->join(); | |
| 255 } | |
| 256 | |
| 257 delete workers_[i]; | |
| 258 } | |
| 259 } | |
| 260 } | |
| 261 | |
| 262 | |
| 263 ThreadedOracle::ThreadedOracle(IMessageEmitter& emitter) : | |
| 264 emitter_(emitter), | |
| 265 state_(State_Setup), | |
| 266 workers_(4), | |
| 267 sleepingCommands_(new SleepingCommands), | |
| 268 sleepingTimeResolution_(50) // By default, time resolution of 50ms | |
| 269 { | |
| 270 } | |
| 271 | |
| 272 | |
| 765 | 273 ThreadedOracle::~ThreadedOracle() |
| 274 { | |
| 275 if (state_ == State_Running) | |
| 276 { | |
| 277 LOG(ERROR) << "The threaded oracle is still running, explicit call to " | |
| 278 << "Stop() is mandatory to avoid crashes"; | |
| 279 } | |
| 280 | |
| 281 try | |
| 282 { | |
| 283 StopInternal(); | |
| 284 } | |
| 285 catch (Orthanc::OrthancException& e) | |
| 286 { | |
| 287 LOG(ERROR) << "Exception while stopping the threaded oracle: " << e.What(); | |
| 288 } | |
| 289 catch (...) | |
| 290 { | |
| 291 LOG(ERROR) << "Native exception while stopping the threaded oracle"; | |
|
1097
4383382db01d
deprecating LockingEmitter
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1077
diff
changeset
|
292 } |
| 765 | 293 } |
| 294 | |
| 295 | |
| 748 | 296 void ThreadedOracle::SetOrthancParameters(const Orthanc::WebServiceParameters& orthanc) |
| 297 { | |
| 298 boost::mutex::scoped_lock lock(mutex_); | |
| 299 | |
| 300 if (state_ != State_Setup) | |
| 301 { | |
|
956
a7351ad54960
Made IsContextLost automatically set the flag by checking with the emscripten
Benjamin Golinvaux <bgo@osimis.io>
parents:
819
diff
changeset
|
302 LOG(ERROR) << "ThreadedOracle::SetOrthancParameters(): (state_ != State_Setup)"; |
| 748 | 303 throw Orthanc::OrthancException(Orthanc::ErrorCode_BadSequenceOfCalls); |
| 304 } | |
| 305 else | |
| 306 { | |
| 307 orthanc_ = orthanc; | |
| 308 } | |
| 309 } | |
| 310 | |
| 311 | |
|
760
1181e1ad98ec
progressive loading working
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
748
diff
changeset
|
312 void ThreadedOracle::SetThreadsCount(unsigned int count) |
| 748 | 313 { |
| 314 boost::mutex::scoped_lock lock(mutex_); | |
| 315 | |
| 316 if (count <= 0) | |
| 317 { | |
| 318 throw Orthanc::OrthancException(Orthanc::ErrorCode_ParameterOutOfRange); | |
| 319 } | |
| 320 else if (state_ != State_Setup) | |
| 321 { | |
|
956
a7351ad54960
Made IsContextLost automatically set the flag by checking with the emscripten
Benjamin Golinvaux <bgo@osimis.io>
parents:
819
diff
changeset
|
322 LOG(ERROR) << "ThreadedOracle::SetThreadsCount(): (state_ != State_Setup)"; |
| 748 | 323 throw Orthanc::OrthancException(Orthanc::ErrorCode_BadSequenceOfCalls); |
| 324 } | |
| 325 else | |
| 326 { | |
| 327 workers_.resize(count); | |
| 328 } | |
| 329 } | |
| 330 | |
| 331 | |
| 332 void ThreadedOracle::SetSleepingTimeResolution(unsigned int milliseconds) | |
| 333 { | |
| 334 boost::mutex::scoped_lock lock(mutex_); | |
| 335 | |
| 336 if (milliseconds <= 0) | |
| 337 { | |
| 338 throw Orthanc::OrthancException(Orthanc::ErrorCode_ParameterOutOfRange); | |
| 339 } | |
| 340 else if (state_ != State_Setup) | |
| 341 { | |
|
956
a7351ad54960
Made IsContextLost automatically set the flag by checking with the emscripten
Benjamin Golinvaux <bgo@osimis.io>
parents:
819
diff
changeset
|
342 LOG(ERROR) << "ThreadedOracle::SetSleepingTimeResolution(): (state_ != State_Setup)"; |
| 748 | 343 throw Orthanc::OrthancException(Orthanc::ErrorCode_BadSequenceOfCalls); |
| 344 } | |
| 345 else | |
| 346 { | |
| 347 sleepingTimeResolution_ = milliseconds; | |
| 348 } | |
| 349 } | |
| 350 | |
| 351 | |
| 352 void ThreadedOracle::Start() | |
| 353 { | |
| 354 boost::mutex::scoped_lock lock(mutex_); | |
| 355 | |
| 356 if (state_ != State_Setup) | |
| 357 { | |
|
956
a7351ad54960
Made IsContextLost automatically set the flag by checking with the emscripten
Benjamin Golinvaux <bgo@osimis.io>
parents:
819
diff
changeset
|
358 LOG(ERROR) << "ThreadedOracle::Start(): (state_ != State_Setup)"; |
| 748 | 359 throw Orthanc::OrthancException(Orthanc::ErrorCode_BadSequenceOfCalls); |
| 360 } | |
| 361 else | |
| 362 { | |
| 363 state_ = State_Running; | |
| 364 | |
| 365 for (unsigned int i = 0; i < workers_.size(); i++) | |
| 366 { | |
| 367 workers_[i] = new boost::thread(Worker, this); | |
| 368 } | |
| 369 | |
| 370 sleepingWorker_ = boost::thread(SleepingWorker, this); | |
| 371 } | |
| 372 } | |
| 373 | |
| 374 | |
|
1098
17660df24c36
simplification of IOracleRunner
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1097
diff
changeset
|
375 bool ThreadedOracle::Schedule(boost::shared_ptr<IObserver> receiver, |
| 748 | 376 IOracleCommand* command) |
| 377 { | |
|
1098
17660df24c36
simplification of IOracleRunner
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1097
diff
changeset
|
378 std::auto_ptr<Item> item(new Item(receiver, command)); |
|
17660df24c36
simplification of IOracleRunner
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1097
diff
changeset
|
379 |
|
17660df24c36
simplification of IOracleRunner
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1097
diff
changeset
|
380 { |
|
17660df24c36
simplification of IOracleRunner
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1097
diff
changeset
|
381 boost::mutex::scoped_lock lock(mutex_); |
|
17660df24c36
simplification of IOracleRunner
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1097
diff
changeset
|
382 |
|
17660df24c36
simplification of IOracleRunner
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1097
diff
changeset
|
383 if (state_ == State_Running) |
|
17660df24c36
simplification of IOracleRunner
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1097
diff
changeset
|
384 { |
|
17660df24c36
simplification of IOracleRunner
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1097
diff
changeset
|
385 //LOG(INFO) << "New oracle command queued"; |
|
17660df24c36
simplification of IOracleRunner
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1097
diff
changeset
|
386 queue_.Enqueue(item.release()); |
|
17660df24c36
simplification of IOracleRunner
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1097
diff
changeset
|
387 return true; |
|
17660df24c36
simplification of IOracleRunner
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1097
diff
changeset
|
388 } |
|
17660df24c36
simplification of IOracleRunner
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1097
diff
changeset
|
389 else |
|
17660df24c36
simplification of IOracleRunner
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1097
diff
changeset
|
390 { |
|
17660df24c36
simplification of IOracleRunner
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1097
diff
changeset
|
391 LOG(INFO) << "Command not enqueued, as the oracle is stopped"; |
|
17660df24c36
simplification of IOracleRunner
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1097
diff
changeset
|
392 |
|
17660df24c36
simplification of IOracleRunner
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1097
diff
changeset
|
393 /** |
|
17660df24c36
simplification of IOracleRunner
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1097
diff
changeset
|
394 * Answering "true" below results in a memory leak within |
|
17660df24c36
simplification of IOracleRunner
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1097
diff
changeset
|
395 * "OracleScheduler", as the scheduler believes that the |
|
17660df24c36
simplification of IOracleRunner
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1097
diff
changeset
|
396 * command is still active (i.e. pending to be executed by the |
|
17660df24c36
simplification of IOracleRunner
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1097
diff
changeset
|
397 * oracle), hereby stalling the scheduler during its |
|
17660df24c36
simplification of IOracleRunner
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1097
diff
changeset
|
398 * destruction (check out |
|
17660df24c36
simplification of IOracleRunner
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1097
diff
changeset
|
399 * "sjo-playground/WebViewer/Backend/Leak") |
|
17660df24c36
simplification of IOracleRunner
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1097
diff
changeset
|
400 **/ |
|
17660df24c36
simplification of IOracleRunner
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1097
diff
changeset
|
401 return false; |
|
17660df24c36
simplification of IOracleRunner
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1097
diff
changeset
|
402 } |
|
17660df24c36
simplification of IOracleRunner
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1097
diff
changeset
|
403 } |
| 748 | 404 } |
| 405 } |