Mercurial > hg > orthanc
annotate Core/JobsEngine/JobsEngine.cpp @ 2573:3372c5255333 jobs
StoreScuJob, Orthanc Explorer for jobs
| author | Sebastien Jodogne <s.jodogne@gmail.com> |
|---|---|
| date | Wed, 09 May 2018 17:56:14 +0200 |
| parents | 2e879c796ec7 |
| children | 8da2cffc2378 |
| rev | line source |
|---|---|
| 2569 | 1 /** |
| 2 * Orthanc - A Lightweight, RESTful DICOM Store | |
| 3 * Copyright (C) 2012-2016 Sebastien Jodogne, Medical Physics | |
| 4 * Department, University Hospital of Liege, Belgium | |
| 5 * Copyright (C) 2017-2018 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 General Public License as | |
| 9 * published by the Free Software Foundation, either version 3 of the | |
| 10 * License, or (at your option) any later version. | |
| 11 * | |
| 12 * In addition, as a special exception, the copyright holders of this | |
| 13 * program give permission to link the code of its release with the | |
| 14 * OpenSSL project's "OpenSSL" library (or with modified versions of it | |
| 15 * that use the same license as the "OpenSSL" library), and distribute | |
| 16 * the linked executables. You must obey the GNU General Public License | |
| 17 * in all respects for all of the code used other than "OpenSSL". If you | |
| 18 * modify file(s) with this exception, you may extend this exception to | |
| 19 * your version of the file(s), but you are not obligated to do so. If | |
| 20 * you do not wish to do so, delete this exception statement from your | |
| 21 * version. If you delete this exception statement from all source files | |
| 22 * in the program, then also delete it here. | |
| 23 * | |
| 24 * This program is distributed in the hope that it will be useful, but | |
| 25 * WITHOUT ANY WARRANTY; without even the implied warranty of | |
| 26 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | |
| 27 * General Public License for more details. | |
| 28 * | |
| 29 * You should have received a copy of the GNU General Public License | |
| 30 * along with this program. If not, see <http://www.gnu.org/licenses/>. | |
| 31 **/ | |
| 32 | |
| 33 | |
| 34 #include "../PrecompiledHeaders.h" | |
| 35 #include "JobsEngine.h" | |
| 36 | |
| 37 #include "JobStepRetry.h" | |
| 38 | |
| 39 #include "../Logging.h" | |
| 40 #include "../OrthancException.h" | |
| 41 | |
| 42 namespace Orthanc | |
| 43 { | |
|
2573
3372c5255333
StoreScuJob, Orthanc Explorer for jobs
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2570
diff
changeset
|
44 bool JobsEngine::IsRunning() |
|
3372c5255333
StoreScuJob, Orthanc Explorer for jobs
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2570
diff
changeset
|
45 { |
|
3372c5255333
StoreScuJob, Orthanc Explorer for jobs
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2570
diff
changeset
|
46 boost::mutex::scoped_lock lock(stateMutex_); |
|
3372c5255333
StoreScuJob, Orthanc Explorer for jobs
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2570
diff
changeset
|
47 return (state_ == State_Running); |
|
3372c5255333
StoreScuJob, Orthanc Explorer for jobs
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2570
diff
changeset
|
48 } |
|
3372c5255333
StoreScuJob, Orthanc Explorer for jobs
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2570
diff
changeset
|
49 |
|
3372c5255333
StoreScuJob, Orthanc Explorer for jobs
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2570
diff
changeset
|
50 |
| 2569 | 51 bool JobsEngine::ExecuteStep(JobsRegistry::RunningJob& running, |
| 52 size_t workerIndex) | |
| 53 { | |
| 54 assert(running.IsValid()); | |
| 55 | |
| 56 if (running.IsPauseScheduled()) | |
| 57 { | |
| 58 running.GetJob().ReleaseResources(); | |
| 59 running.MarkPause(); | |
| 60 return false; | |
| 61 } | |
| 62 | |
| 63 std::auto_ptr<JobStepResult> result; | |
| 64 | |
| 65 { | |
| 66 try | |
| 67 { | |
| 68 result.reset(running.GetJob().ExecuteStep()); | |
| 69 | |
| 70 if (result->GetCode() == JobStepCode_Failure) | |
| 71 { | |
| 72 running.UpdateStatus(ErrorCode_InternalError); | |
| 73 } | |
| 74 else | |
| 75 { | |
| 76 running.UpdateStatus(ErrorCode_Success); | |
| 77 } | |
| 78 } | |
| 79 catch (OrthancException& e) | |
| 80 { | |
| 81 running.UpdateStatus(e.GetErrorCode()); | |
| 82 } | |
| 83 catch (boost::bad_lexical_cast&) | |
| 84 { | |
| 85 running.UpdateStatus(ErrorCode_BadFileFormat); | |
| 86 } | |
| 87 catch (...) | |
| 88 { | |
| 89 running.UpdateStatus(ErrorCode_InternalError); | |
| 90 } | |
| 91 | |
| 92 if (result.get() == NULL) | |
| 93 { | |
| 94 result.reset(new JobStepResult(JobStepCode_Failure)); | |
| 95 } | |
| 96 } | |
| 97 | |
| 98 switch (result->GetCode()) | |
| 99 { | |
| 100 case JobStepCode_Success: | |
|
2573
3372c5255333
StoreScuJob, Orthanc Explorer for jobs
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2570
diff
changeset
|
101 running.GetJob().ReleaseResources(); |
| 2569 | 102 running.MarkSuccess(); |
| 103 return false; | |
| 104 | |
| 105 case JobStepCode_Failure: | |
|
2573
3372c5255333
StoreScuJob, Orthanc Explorer for jobs
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2570
diff
changeset
|
106 running.GetJob().ReleaseResources(); |
| 2569 | 107 running.MarkFailure(); |
| 108 return false; | |
| 109 | |
| 110 case JobStepCode_Retry: | |
|
2570
2e879c796ec7
JobsRegistry::SubmitAndWait(), StoreScuJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2569
diff
changeset
|
111 running.GetJob().ReleaseResources(); |
| 2569 | 112 running.MarkRetry(dynamic_cast<JobStepRetry&>(*result).GetTimeout()); |
| 113 return false; | |
| 114 | |
| 115 case JobStepCode_Continue: | |
| 116 return true; | |
| 117 | |
| 118 default: | |
| 119 throw OrthancException(ErrorCode_InternalError); | |
| 120 } | |
| 121 } | |
| 122 | |
| 123 | |
| 124 void JobsEngine::RetryHandler(JobsEngine* engine) | |
| 125 { | |
| 126 assert(engine != NULL); | |
| 127 | |
|
2573
3372c5255333
StoreScuJob, Orthanc Explorer for jobs
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2570
diff
changeset
|
128 while (engine->IsRunning()) |
| 2569 | 129 { |
| 130 boost::this_thread::sleep(boost::posix_time::milliseconds(200)); | |
| 131 engine->GetRegistry().ScheduleRetries(); | |
| 132 } | |
| 133 } | |
| 134 | |
| 135 | |
| 136 void JobsEngine::Worker(JobsEngine* engine, | |
| 137 size_t workerIndex) | |
| 138 { | |
| 139 assert(engine != NULL); | |
| 140 | |
| 141 LOG(INFO) << "Worker thread " << workerIndex << " has started"; | |
| 142 | |
|
2573
3372c5255333
StoreScuJob, Orthanc Explorer for jobs
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2570
diff
changeset
|
143 while (engine->IsRunning()) |
| 2569 | 144 { |
| 145 JobsRegistry::RunningJob running(engine->GetRegistry(), 100); | |
| 146 | |
| 147 if (running.IsValid()) | |
| 148 { | |
|
2573
3372c5255333
StoreScuJob, Orthanc Explorer for jobs
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2570
diff
changeset
|
149 LOG(INFO) << "Executing job with priority " << running.GetPriority() |
|
3372c5255333
StoreScuJob, Orthanc Explorer for jobs
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2570
diff
changeset
|
150 << " in worker thread " << workerIndex << ": " << running.GetId(); |
|
3372c5255333
StoreScuJob, Orthanc Explorer for jobs
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2570
diff
changeset
|
151 |
|
3372c5255333
StoreScuJob, Orthanc Explorer for jobs
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2570
diff
changeset
|
152 while (engine->IsRunning()) |
| 2569 | 153 { |
| 154 if (!engine->ExecuteStep(running, workerIndex)) | |
| 155 { | |
| 156 break; | |
| 157 } | |
| 158 } | |
| 159 } | |
| 160 } | |
| 161 } | |
| 162 | |
| 163 | |
| 164 JobsEngine::JobsEngine() : | |
| 165 state_(State_Setup), | |
| 166 workers_(1) | |
| 167 { | |
| 168 } | |
| 169 | |
| 170 | |
| 171 JobsEngine::~JobsEngine() | |
| 172 { | |
| 173 if (state_ != State_Setup && | |
| 174 state_ != State_Done) | |
| 175 { | |
| 176 LOG(ERROR) << "INTERNAL ERROR: JobsEngine::Stop() should be invoked manually to avoid mess in the destruction order!"; | |
| 177 Stop(); | |
| 178 } | |
| 179 } | |
| 180 | |
| 181 | |
| 182 void JobsEngine::SetWorkersCount(size_t count) | |
| 183 { | |
| 184 boost::mutex::scoped_lock lock(stateMutex_); | |
| 185 | |
| 186 if (state_ != State_Setup) | |
| 187 { | |
| 188 // Can only be invoked before calling "Start()" | |
| 189 throw OrthancException(ErrorCode_BadSequenceOfCalls); | |
| 190 } | |
| 191 | |
| 192 workers_.resize(count); | |
| 193 } | |
| 194 | |
| 195 | |
| 196 void JobsEngine::Start() | |
| 197 { | |
| 198 boost::mutex::scoped_lock lock(stateMutex_); | |
| 199 | |
| 200 if (state_ != State_Setup) | |
| 201 { | |
| 202 throw OrthancException(ErrorCode_BadSequenceOfCalls); | |
| 203 } | |
| 204 | |
| 205 retryHandler_ = boost::thread(RetryHandler, this); | |
| 206 | |
|
2570
2e879c796ec7
JobsRegistry::SubmitAndWait(), StoreScuJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2569
diff
changeset
|
207 if (workers_.size() == 0) |
|
2e879c796ec7
JobsRegistry::SubmitAndWait(), StoreScuJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2569
diff
changeset
|
208 { |
|
2e879c796ec7
JobsRegistry::SubmitAndWait(), StoreScuJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2569
diff
changeset
|
209 // Use all the available CPUs |
|
2e879c796ec7
JobsRegistry::SubmitAndWait(), StoreScuJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2569
diff
changeset
|
210 size_t n = boost::thread::hardware_concurrency(); |
|
2e879c796ec7
JobsRegistry::SubmitAndWait(), StoreScuJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2569
diff
changeset
|
211 |
|
2e879c796ec7
JobsRegistry::SubmitAndWait(), StoreScuJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2569
diff
changeset
|
212 if (n == 0) |
|
2e879c796ec7
JobsRegistry::SubmitAndWait(), StoreScuJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2569
diff
changeset
|
213 { |
|
2e879c796ec7
JobsRegistry::SubmitAndWait(), StoreScuJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2569
diff
changeset
|
214 n = 1; |
|
2e879c796ec7
JobsRegistry::SubmitAndWait(), StoreScuJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2569
diff
changeset
|
215 } |
|
2e879c796ec7
JobsRegistry::SubmitAndWait(), StoreScuJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2569
diff
changeset
|
216 |
|
2e879c796ec7
JobsRegistry::SubmitAndWait(), StoreScuJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2569
diff
changeset
|
217 workers_.resize(n); |
|
2e879c796ec7
JobsRegistry::SubmitAndWait(), StoreScuJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2569
diff
changeset
|
218 } |
|
2e879c796ec7
JobsRegistry::SubmitAndWait(), StoreScuJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2569
diff
changeset
|
219 |
| 2569 | 220 for (size_t i = 0; i < workers_.size(); i++) |
| 221 { | |
| 222 workers_[i] = boost::thread(Worker, this, i); | |
| 223 } | |
| 224 | |
| 225 state_ = State_Running; | |
| 226 | |
|
2570
2e879c796ec7
JobsRegistry::SubmitAndWait(), StoreScuJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2569
diff
changeset
|
227 LOG(WARNING) << "The jobs engine has started with " << workers_.size() << " threads"; |
| 2569 | 228 } |
| 229 | |
| 230 | |
| 231 void JobsEngine::Stop() | |
| 232 { | |
| 233 { | |
| 234 boost::mutex::scoped_lock lock(stateMutex_); | |
| 235 | |
| 236 if (state_ != State_Running) | |
| 237 { | |
| 238 return; | |
| 239 } | |
| 240 | |
| 241 state_ = State_Stopping; | |
| 242 } | |
| 243 | |
| 244 LOG(INFO) << "Stopping the jobs engine"; | |
| 245 | |
| 246 if (retryHandler_.joinable()) | |
| 247 { | |
| 248 retryHandler_.join(); | |
| 249 } | |
| 250 | |
| 251 for (size_t i = 0; i < workers_.size(); i++) | |
| 252 { | |
| 253 if (workers_[i].joinable()) | |
| 254 { | |
| 255 workers_[i].join(); | |
| 256 } | |
| 257 } | |
| 258 | |
| 259 { | |
| 260 boost::mutex::scoped_lock lock(stateMutex_); | |
| 261 state_ = State_Done; | |
| 262 } | |
| 263 | |
| 264 LOG(WARNING) << "The jobs engine has stopped"; | |
| 265 } | |
| 266 } |