Mercurial > hg > orthanc
annotate Core/JobsEngine/JobsRegistry.h @ 4022:a2e4edc7b9aa more-changes
wip: adding job changes
| author | Alain Mazy <alain@mazy.be> |
|---|---|
| date | Tue, 09 Jun 2020 08:46:52 +0200 |
| parents | 94f4a18a79cc |
| children | 1d2b31fc782f |
| 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 | |
|
3640
94f4a18a79cc
upgrade to year 2020
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3240
diff
changeset
|
5 * Copyright (C) 2017-2020 Osimis S.A., Belgium |
| 2569 | 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 #pragma once | |
| 35 | |
| 36 #if !defined(ORTHANC_SANDBOXED) | |
| 37 # error The macro ORTHANC_SANDBOXED must be defined | |
| 38 #endif | |
| 39 | |
| 40 #if ORTHANC_SANDBOXED == 1 | |
| 41 # error The job engine cannot be used in sandboxed environments | |
| 42 #endif | |
| 43 | |
| 44 #include "JobInfo.h" | |
|
2648
e1893d31652a
serialization of JobHandler
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2581
diff
changeset
|
45 #include "IJobUnserializer.h" |
| 2569 | 46 |
| 47 #include <list> | |
| 48 #include <set> | |
| 49 #include <queue> | |
| 50 #include <boost/thread/mutex.hpp> | |
| 51 #include <boost/thread/condition_variable.hpp> | |
| 52 | |
| 53 namespace Orthanc | |
| 54 { | |
| 55 // This class handles the state machine of the jobs engine | |
| 56 class JobsRegistry : public boost::noncopyable | |
| 57 { | |
|
2673
8e0bc055d18c
JobsRegistry::IObserver
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2669
diff
changeset
|
58 public: |
|
8e0bc055d18c
JobsRegistry::IObserver
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2669
diff
changeset
|
59 class IObserver : public boost::noncopyable |
|
8e0bc055d18c
JobsRegistry::IObserver
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2669
diff
changeset
|
60 { |
|
8e0bc055d18c
JobsRegistry::IObserver
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2669
diff
changeset
|
61 public: |
|
8e0bc055d18c
JobsRegistry::IObserver
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2669
diff
changeset
|
62 virtual ~IObserver() |
|
8e0bc055d18c
JobsRegistry::IObserver
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2669
diff
changeset
|
63 { |
|
8e0bc055d18c
JobsRegistry::IObserver
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2669
diff
changeset
|
64 } |
|
8e0bc055d18c
JobsRegistry::IObserver
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2669
diff
changeset
|
65 |
|
8e0bc055d18c
JobsRegistry::IObserver
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2669
diff
changeset
|
66 virtual void SignalJobSubmitted(const std::string& jobId) = 0; |
|
8e0bc055d18c
JobsRegistry::IObserver
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2669
diff
changeset
|
67 |
|
8e0bc055d18c
JobsRegistry::IObserver
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2669
diff
changeset
|
68 virtual void SignalJobSuccess(const std::string& jobId) = 0; |
|
8e0bc055d18c
JobsRegistry::IObserver
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2669
diff
changeset
|
69 |
|
8e0bc055d18c
JobsRegistry::IObserver
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2669
diff
changeset
|
70 virtual void SignalJobFailure(const std::string& jobId) = 0; |
|
8e0bc055d18c
JobsRegistry::IObserver
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2669
diff
changeset
|
71 }; |
|
8e0bc055d18c
JobsRegistry::IObserver
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2669
diff
changeset
|
72 |
| 2569 | 73 private: |
|
2950
dc18d5804746
support of JobsHistorySize set to zero
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2867
diff
changeset
|
74 enum CompletedReason |
|
dc18d5804746
support of JobsHistorySize set to zero
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2867
diff
changeset
|
75 { |
|
dc18d5804746
support of JobsHistorySize set to zero
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2867
diff
changeset
|
76 CompletedReason_Success, |
|
dc18d5804746
support of JobsHistorySize set to zero
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2867
diff
changeset
|
77 CompletedReason_Failure, |
|
dc18d5804746
support of JobsHistorySize set to zero
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2867
diff
changeset
|
78 CompletedReason_Canceled |
|
dc18d5804746
support of JobsHistorySize set to zero
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2867
diff
changeset
|
79 }; |
|
dc18d5804746
support of JobsHistorySize set to zero
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2867
diff
changeset
|
80 |
| 2569 | 81 class JobHandler; |
| 82 | |
| 83 struct PriorityComparator | |
| 84 { | |
| 85 bool operator() (JobHandler*& a, | |
| 86 JobHandler*& b) const; | |
| 87 }; | |
| 88 | |
| 4022 | 89 typedef std::set<IObserver*> Observers; |
| 2569 | 90 typedef std::map<std::string, JobHandler*> JobsIndex; |
| 91 typedef std::list<JobHandler*> CompletedJobs; | |
| 92 typedef std::set<JobHandler*> RetryJobs; | |
| 93 typedef std::priority_queue<JobHandler*, | |
| 94 std::vector<JobHandler*>, // Could be a "std::deque" | |
| 95 PriorityComparator> PendingJobs; | |
| 96 | |
| 97 boost::mutex mutex_; | |
| 98 JobsIndex jobsIndex_; | |
| 99 PendingJobs pendingJobs_; | |
| 100 CompletedJobs completedJobs_; | |
| 101 RetryJobs retryJobs_; | |
| 102 | |
| 103 boost::condition_variable pendingJobAvailable_; | |
|
2570
2e879c796ec7
JobsRegistry::SubmitAndWait(), StoreScuJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2569
diff
changeset
|
104 boost::condition_variable someJobComplete_; |
| 2569 | 105 size_t maxCompletedJobs_; |
| 106 | |
| 4022 | 107 boost::shared_mutex observersMutex_; |
| 108 Observers observers_; | |
|
2673
8e0bc055d18c
JobsRegistry::IObserver
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2669
diff
changeset
|
109 |
| 2569 | 110 |
| 111 #ifndef NDEBUG | |
| 112 bool IsPendingJob(const JobHandler& job) const; | |
| 113 | |
| 114 bool IsCompletedJob(JobHandler& job) const; | |
| 115 | |
| 116 bool IsRetryJob(JobHandler& job) const; | |
| 117 #endif | |
| 118 | |
| 119 void CheckInvariants() const; | |
| 120 | |
| 121 void ForgetOldCompletedJobs(); | |
| 122 | |
|
2581
8da2cffc2378
JobsRegistry::Cancel()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2573
diff
changeset
|
123 void SetCompletedJob(JobHandler& job, |
|
8da2cffc2378
JobsRegistry::Cancel()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2573
diff
changeset
|
124 bool success); |
|
8da2cffc2378
JobsRegistry::Cancel()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2573
diff
changeset
|
125 |
| 2569 | 126 void MarkRunningAsCompleted(JobHandler& job, |
|
2950
dc18d5804746
support of JobsHistorySize set to zero
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2867
diff
changeset
|
127 CompletedReason reason); |
| 2569 | 128 |
| 129 void MarkRunningAsRetry(JobHandler& job, | |
| 130 unsigned int timeout); | |
| 131 | |
| 132 void MarkRunningAsPaused(JobHandler& job); | |
|
2570
2e879c796ec7
JobsRegistry::SubmitAndWait(), StoreScuJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2569
diff
changeset
|
133 |
|
2e879c796ec7
JobsRegistry::SubmitAndWait(), StoreScuJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2569
diff
changeset
|
134 bool GetStateInternal(JobState& state, |
|
2e879c796ec7
JobsRegistry::SubmitAndWait(), StoreScuJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2569
diff
changeset
|
135 const std::string& id); |
| 2569 | 136 |
|
2581
8da2cffc2378
JobsRegistry::Cancel()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2573
diff
changeset
|
137 void RemovePendingJob(const std::string& id); |
|
8da2cffc2378
JobsRegistry::Cancel()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2573
diff
changeset
|
138 |
|
8da2cffc2378
JobsRegistry::Cancel()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2573
diff
changeset
|
139 void RemoveRetryJob(JobHandler* handler); |
|
8da2cffc2378
JobsRegistry::Cancel()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2573
diff
changeset
|
140 |
|
2667
5fa2f2ce74f0
serialization of JobsRegistry
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2648
diff
changeset
|
141 void SubmitInternal(std::string& id, |
|
2950
dc18d5804746
support of JobsHistorySize set to zero
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2867
diff
changeset
|
142 JobHandler* handler); |
|
2667
5fa2f2ce74f0
serialization of JobsRegistry
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2648
diff
changeset
|
143 |
| 2569 | 144 public: |
|
2950
dc18d5804746
support of JobsHistorySize set to zero
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2867
diff
changeset
|
145 JobsRegistry(size_t maxCompletedJobs) : |
| 4022 | 146 maxCompletedJobs_(maxCompletedJobs) |
| 2569 | 147 { |
| 148 } | |
| 149 | |
|
2667
5fa2f2ce74f0
serialization of JobsRegistry
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2648
diff
changeset
|
150 JobsRegistry(IJobUnserializer& unserializer, |
|
2950
dc18d5804746
support of JobsHistorySize set to zero
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2867
diff
changeset
|
151 const Json::Value& s, |
|
dc18d5804746
support of JobsHistorySize set to zero
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2867
diff
changeset
|
152 size_t maxCompletedJobs); |
| 2569 | 153 |
| 154 ~JobsRegistry(); | |
| 155 | |
| 156 void SetMaxCompletedJobs(size_t i); | |
| 157 | |
|
2950
dc18d5804746
support of JobsHistorySize set to zero
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2867
diff
changeset
|
158 size_t GetMaxCompletedJobs(); |
|
dc18d5804746
support of JobsHistorySize set to zero
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2867
diff
changeset
|
159 |
| 2569 | 160 void ListJobs(std::set<std::string>& target); |
| 161 | |
| 162 bool GetJobInfo(JobInfo& target, | |
| 163 const std::string& id); | |
|
2648
e1893d31652a
serialization of JobHandler
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2581
diff
changeset
|
164 |
|
2976
cb5d75143da0
Asynchronous generation of ZIP archives and DICOM medias
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2950
diff
changeset
|
165 bool GetJobOutput(std::string& output, |
|
cb5d75143da0
Asynchronous generation of ZIP archives and DICOM medias
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2950
diff
changeset
|
166 MimeType& mime, |
|
cb5d75143da0
Asynchronous generation of ZIP archives and DICOM medias
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2950
diff
changeset
|
167 const std::string& job, |
|
cb5d75143da0
Asynchronous generation of ZIP archives and DICOM medias
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2950
diff
changeset
|
168 const std::string& key); |
|
cb5d75143da0
Asynchronous generation of ZIP archives and DICOM medias
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2950
diff
changeset
|
169 |
|
2648
e1893d31652a
serialization of JobHandler
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2581
diff
changeset
|
170 void Serialize(Json::Value& target); |
| 2569 | 171 |
| 172 void Submit(std::string& id, | |
| 173 IJob* job, // Takes ownership | |
| 174 int priority); | |
| 175 | |
| 176 void Submit(IJob* job, // Takes ownership | |
| 177 int priority); | |
|
2570
2e879c796ec7
JobsRegistry::SubmitAndWait(), StoreScuJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2569
diff
changeset
|
178 |
|
3240
e44e0127e553
Fix issue #134 (/patient/modify gives 500, should really be 400)
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3179
diff
changeset
|
179 void SubmitAndWait(Json::Value& successContent, |
| 2867 | 180 IJob* job, // Takes ownership |
|
2570
2e879c796ec7
JobsRegistry::SubmitAndWait(), StoreScuJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2569
diff
changeset
|
181 int priority); |
| 2569 | 182 |
|
2573
3372c5255333
StoreScuJob, Orthanc Explorer for jobs
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2570
diff
changeset
|
183 bool SetPriority(const std::string& id, |
| 2569 | 184 int priority); |
| 185 | |
|
2573
3372c5255333
StoreScuJob, Orthanc Explorer for jobs
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2570
diff
changeset
|
186 bool Pause(const std::string& id); |
| 2569 | 187 |
|
2573
3372c5255333
StoreScuJob, Orthanc Explorer for jobs
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2570
diff
changeset
|
188 bool Resume(const std::string& id); |
| 2569 | 189 |
|
2573
3372c5255333
StoreScuJob, Orthanc Explorer for jobs
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2570
diff
changeset
|
190 bool Resubmit(const std::string& id); |
|
2581
8da2cffc2378
JobsRegistry::Cancel()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2573
diff
changeset
|
191 |
|
8da2cffc2378
JobsRegistry::Cancel()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2573
diff
changeset
|
192 bool Cancel(const std::string& id); |
| 2569 | 193 |
| 194 void ScheduleRetries(); | |
| 195 | |
| 196 bool GetState(JobState& state, | |
| 197 const std::string& id); | |
| 198 | |
| 4022 | 199 void AddObserver(IObserver& observer); |
|
2673
8e0bc055d18c
JobsRegistry::IObserver
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2669
diff
changeset
|
200 |
| 4022 | 201 void ResetObserver(IObserver& observer); |
|
2673
8e0bc055d18c
JobsRegistry::IObserver
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2669
diff
changeset
|
202 |
|
3177
053e72ff9fc5
new metrics: orthanc_jobs_[pending|running|completed]
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3060
diff
changeset
|
203 void GetStatistics(unsigned int& pending, |
|
053e72ff9fc5
new metrics: orthanc_jobs_[pending|running|completed]
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3060
diff
changeset
|
204 unsigned int& running, |
|
3179
fca730c267d7
New primitives to set and refresh metrics
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3177
diff
changeset
|
205 unsigned int& success, |
|
fca730c267d7
New primitives to set and refresh metrics
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3177
diff
changeset
|
206 unsigned int& errors); |
|
3177
053e72ff9fc5
new metrics: orthanc_jobs_[pending|running|completed]
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3060
diff
changeset
|
207 |
| 2569 | 208 class RunningJob : public boost::noncopyable |
| 209 { | |
| 210 private: | |
| 211 JobsRegistry& registry_; | |
| 212 JobHandler* handler_; // Can only be accessed if the | |
| 213 // registry mutex is locked! | |
| 214 IJob* job_; // Will by design be in mutual exclusion, | |
| 215 // because only one RunningJob can be | |
| 216 // executed at a time on a JobHandler | |
| 217 | |
| 218 std::string id_; | |
| 219 int priority_; | |
| 220 JobState targetState_; | |
| 221 unsigned int targetRetryTimeout_; | |
|
2581
8da2cffc2378
JobsRegistry::Cancel()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2573
diff
changeset
|
222 bool canceled_; |
| 2569 | 223 |
| 224 public: | |
| 225 RunningJob(JobsRegistry& registry, | |
| 226 unsigned int timeout); | |
| 227 | |
| 228 ~RunningJob(); | |
| 229 | |
| 230 bool IsValid() const; | |
| 231 | |
| 232 const std::string& GetId() const; | |
| 233 | |
| 234 int GetPriority() const; | |
| 235 | |
| 236 IJob& GetJob(); | |
| 237 | |
| 238 bool IsPauseScheduled(); | |
| 239 | |
|
2581
8da2cffc2378
JobsRegistry::Cancel()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2573
diff
changeset
|
240 bool IsCancelScheduled(); |
|
8da2cffc2378
JobsRegistry::Cancel()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2573
diff
changeset
|
241 |
| 2569 | 242 void MarkSuccess(); |
| 243 | |
| 244 void MarkFailure(); | |
| 245 | |
| 246 void MarkPause(); | |
| 247 | |
|
2581
8da2cffc2378
JobsRegistry::Cancel()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2573
diff
changeset
|
248 void MarkCanceled(); |
|
8da2cffc2378
JobsRegistry::Cancel()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2573
diff
changeset
|
249 |
| 2569 | 250 void MarkRetry(unsigned int timeout); |
| 251 | |
|
3240
e44e0127e553
Fix issue #134 (/patient/modify gives 500, should really be 400)
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3179
diff
changeset
|
252 void UpdateStatus(ErrorCode code, |
|
e44e0127e553
Fix issue #134 (/patient/modify gives 500, should really be 400)
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3179
diff
changeset
|
253 const std::string& details); |
| 2569 | 254 }; |
| 255 }; | |
| 256 } |