Mercurial > hg > orthanc
annotate OrthancFramework/Sources/MultiThreading/RunnableWorkersPool.cpp @ 5474:6cb91df32207 Orthanc-1.12.2
Orthanc-1.12.2
author | Alain Mazy <am@osimis.io> |
---|---|
date | Tue, 19 Dec 2023 10:05:57 +0100 |
parents | 9ffd6d18daf3 |
children | 48b8dae6dc77 |
rev | line source |
---|---|
1679 | 1 /** |
2 * Orthanc - A Lightweight, RESTful DICOM Store | |
1900 | 3 * Copyright (C) 2012-2016 Sebastien Jodogne, Medical Physics |
1679 | 4 * Department, University Hospital of Liege, Belgium |
5185
0ea402b4d901
upgrade to year 2023
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4870
diff
changeset
|
5 * Copyright (C) 2017-2023 Osimis S.A., Belgium |
0ea402b4d901
upgrade to year 2023
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4870
diff
changeset
|
6 * Copyright (C) 2021-2023 Sebastien Jodogne, ICTEAM UCLouvain, Belgium |
1679 | 7 * |
8 * This program is free software: you can redistribute it and/or | |
4119
bf7b9edf6b81
re-licensing the OrthancFramework to LGPL, in order to license Stone of Orthanc under LGPL
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4044
diff
changeset
|
9 * modify it under the terms of the GNU Lesser General Public License |
bf7b9edf6b81
re-licensing the OrthancFramework to LGPL, in order to license Stone of Orthanc under LGPL
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4044
diff
changeset
|
10 * as published by the Free Software Foundation, either version 3 of |
bf7b9edf6b81
re-licensing the OrthancFramework to LGPL, in order to license Stone of Orthanc under LGPL
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4044
diff
changeset
|
11 * the License, or (at your option) any later version. |
1679 | 12 * |
13 * This program is distributed in the hope that it will be useful, but | |
14 * WITHOUT ANY WARRANTY; without even the implied warranty of | |
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | |
4119
bf7b9edf6b81
re-licensing the OrthancFramework to LGPL, in order to license Stone of Orthanc under LGPL
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4044
diff
changeset
|
16 * Lesser General Public License for more details. |
1679 | 17 * |
4119
bf7b9edf6b81
re-licensing the OrthancFramework to LGPL, in order to license Stone of Orthanc under LGPL
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4044
diff
changeset
|
18 * You should have received a copy of the GNU Lesser General Public |
bf7b9edf6b81
re-licensing the OrthancFramework to LGPL, in order to license Stone of Orthanc under LGPL
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4044
diff
changeset
|
19 * License along with this program. If not, see |
bf7b9edf6b81
re-licensing the OrthancFramework to LGPL, in order to license Stone of Orthanc under LGPL
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4044
diff
changeset
|
20 * <http://www.gnu.org/licenses/>. |
1679 | 21 **/ |
22 | |
23 | |
24 #include "../PrecompiledHeaders.h" | |
25 #include "RunnableWorkersPool.h" | |
26 | |
27 #include "SharedMessageQueue.h" | |
3712
2a170a8f1faf
replacing std::auto_ptr by std::unique_ptr
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3640
diff
changeset
|
28 #include "../Compatibility.h" |
1679 | 29 #include "../OrthancException.h" |
30 #include "../Logging.h" | |
31 | |
32 namespace Orthanc | |
33 { | |
34 struct RunnableWorkersPool::PImpl | |
35 { | |
36 class Worker | |
37 { | |
38 private: | |
39 const bool& continue_; | |
40 SharedMessageQueue& queue_; | |
41 boost::thread thread_; | |
5450
9ffd6d18daf3
log lines now contain the thread name
Alain Mazy <am@osimis.io>
parents:
5185
diff
changeset
|
42 std::string name_; |
1679 | 43 |
44 static void WorkerThread(Worker* that) | |
45 { | |
5450
9ffd6d18daf3
log lines now contain the thread name
Alain Mazy <am@osimis.io>
parents:
5185
diff
changeset
|
46 Logging::SetCurrentThreadName(that->name_); |
9ffd6d18daf3
log lines now contain the thread name
Alain Mazy <am@osimis.io>
parents:
5185
diff
changeset
|
47 |
1679 | 48 while (that->continue_) |
49 { | |
2134
ddc75c6c712d
Avoid hard crash if not enough memory
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1900
diff
changeset
|
50 try |
1679 | 51 { |
3712
2a170a8f1faf
replacing std::auto_ptr by std::unique_ptr
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3640
diff
changeset
|
52 std::unique_ptr<IDynamicObject> obj(that->queue_.Dequeue(100)); |
2134
ddc75c6c712d
Avoid hard crash if not enough memory
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1900
diff
changeset
|
53 if (obj.get() != NULL) |
1679 | 54 { |
55 IRunnableBySteps& runnable = *dynamic_cast<IRunnableBySteps*>(obj.get()); | |
2134
ddc75c6c712d
Avoid hard crash if not enough memory
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1900
diff
changeset
|
56 |
1679 | 57 bool wishToContinue = runnable.Step(); |
2134
ddc75c6c712d
Avoid hard crash if not enough memory
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1900
diff
changeset
|
58 |
1679 | 59 if (wishToContinue) |
60 { | |
61 // The runnable wishes to continue, reinsert it at the beginning of the queue | |
62 that->queue_.Enqueue(obj.release()); | |
63 } | |
64 } | |
2134
ddc75c6c712d
Avoid hard crash if not enough memory
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1900
diff
changeset
|
65 } |
ddc75c6c712d
Avoid hard crash if not enough memory
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1900
diff
changeset
|
66 catch (OrthancException& e) |
ddc75c6c712d
Avoid hard crash if not enough memory
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1900
diff
changeset
|
67 { |
ddc75c6c712d
Avoid hard crash if not enough memory
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1900
diff
changeset
|
68 LOG(ERROR) << "Exception while handling some runnable object: " << e.What(); |
ddc75c6c712d
Avoid hard crash if not enough memory
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1900
diff
changeset
|
69 } |
ddc75c6c712d
Avoid hard crash if not enough memory
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1900
diff
changeset
|
70 catch (std::bad_alloc&) |
ddc75c6c712d
Avoid hard crash if not enough memory
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1900
diff
changeset
|
71 { |
ddc75c6c712d
Avoid hard crash if not enough memory
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1900
diff
changeset
|
72 LOG(ERROR) << "Not enough memory to handle some runnable object"; |
ddc75c6c712d
Avoid hard crash if not enough memory
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1900
diff
changeset
|
73 } |
2290
4d500a555aad
catching std::exception before (...) to try to get more debug info
Alain Mazy <alain@mazy.be>
parents:
2244
diff
changeset
|
74 catch (std::exception& e) |
4d500a555aad
catching std::exception before (...) to try to get more debug info
Alain Mazy <alain@mazy.be>
parents:
2244
diff
changeset
|
75 { |
2291 | 76 LOG(ERROR) << "std::exception while handling some runnable object: " << e.what(); |
2290
4d500a555aad
catching std::exception before (...) to try to get more debug info
Alain Mazy <alain@mazy.be>
parents:
2244
diff
changeset
|
77 } |
2134
ddc75c6c712d
Avoid hard crash if not enough memory
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1900
diff
changeset
|
78 catch (...) |
ddc75c6c712d
Avoid hard crash if not enough memory
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1900
diff
changeset
|
79 { |
ddc75c6c712d
Avoid hard crash if not enough memory
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1900
diff
changeset
|
80 LOG(ERROR) << "Native exception while handling some runnable object"; |
1679 | 81 } |
82 } | |
83 } | |
84 | |
85 public: | |
86 Worker(const bool& globalContinue, | |
5450
9ffd6d18daf3
log lines now contain the thread name
Alain Mazy <am@osimis.io>
parents:
5185
diff
changeset
|
87 SharedMessageQueue& queue, |
9ffd6d18daf3
log lines now contain the thread name
Alain Mazy <am@osimis.io>
parents:
5185
diff
changeset
|
88 const std::string& name) : |
1679 | 89 continue_(globalContinue), |
5450
9ffd6d18daf3
log lines now contain the thread name
Alain Mazy <am@osimis.io>
parents:
5185
diff
changeset
|
90 queue_(queue), |
9ffd6d18daf3
log lines now contain the thread name
Alain Mazy <am@osimis.io>
parents:
5185
diff
changeset
|
91 name_(name) |
1679 | 92 { |
93 thread_ = boost::thread(WorkerThread, this); | |
94 } | |
95 | |
96 void Join() | |
97 { | |
98 if (thread_.joinable()) | |
99 { | |
100 thread_.join(); | |
101 } | |
102 } | |
103 }; | |
104 | |
105 | |
106 bool continue_; | |
107 std::vector<Worker*> workers_; | |
108 SharedMessageQueue queue_; | |
109 }; | |
110 | |
111 | |
112 | |
5450
9ffd6d18daf3
log lines now contain the thread name
Alain Mazy <am@osimis.io>
parents:
5185
diff
changeset
|
113 RunnableWorkersPool::RunnableWorkersPool(size_t countWorkers, const std::string& name) : pimpl_(new PImpl) |
1679 | 114 { |
115 pimpl_->continue_ = true; | |
116 | |
1847 | 117 if (countWorkers == 0) |
1679 | 118 { |
119 throw OrthancException(ErrorCode_ParameterOutOfRange); | |
120 } | |
121 | |
122 pimpl_->workers_.resize(countWorkers); | |
123 | |
124 for (size_t i = 0; i < countWorkers; i++) | |
125 { | |
5450
9ffd6d18daf3
log lines now contain the thread name
Alain Mazy <am@osimis.io>
parents:
5185
diff
changeset
|
126 std::string workerName = name + boost::lexical_cast<std::string>(i); |
9ffd6d18daf3
log lines now contain the thread name
Alain Mazy <am@osimis.io>
parents:
5185
diff
changeset
|
127 pimpl_->workers_[i] = new PImpl::Worker(pimpl_->continue_, pimpl_->queue_, workerName); |
1679 | 128 } |
129 } | |
130 | |
131 | |
1681
ee4367497d0d
got rid of buggy BagOfRunnablesBySteps
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1679
diff
changeset
|
132 void RunnableWorkersPool::Stop() |
1679 | 133 { |
1681
ee4367497d0d
got rid of buggy BagOfRunnablesBySteps
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1679
diff
changeset
|
134 if (pimpl_->continue_) |
1679 | 135 { |
1681
ee4367497d0d
got rid of buggy BagOfRunnablesBySteps
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1679
diff
changeset
|
136 pimpl_->continue_ = false; |
ee4367497d0d
got rid of buggy BagOfRunnablesBySteps
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1679
diff
changeset
|
137 |
ee4367497d0d
got rid of buggy BagOfRunnablesBySteps
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1679
diff
changeset
|
138 for (size_t i = 0; i < pimpl_->workers_.size(); i++) |
ee4367497d0d
got rid of buggy BagOfRunnablesBySteps
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1679
diff
changeset
|
139 { |
ee4367497d0d
got rid of buggy BagOfRunnablesBySteps
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1679
diff
changeset
|
140 PImpl::Worker* worker = pimpl_->workers_[i]; |
1679 | 141 |
1681
ee4367497d0d
got rid of buggy BagOfRunnablesBySteps
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1679
diff
changeset
|
142 if (worker != NULL) |
ee4367497d0d
got rid of buggy BagOfRunnablesBySteps
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1679
diff
changeset
|
143 { |
ee4367497d0d
got rid of buggy BagOfRunnablesBySteps
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1679
diff
changeset
|
144 worker->Join(); |
ee4367497d0d
got rid of buggy BagOfRunnablesBySteps
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1679
diff
changeset
|
145 delete worker; |
ee4367497d0d
got rid of buggy BagOfRunnablesBySteps
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1679
diff
changeset
|
146 } |
1679 | 147 } |
148 } | |
149 } | |
150 | |
151 | |
1681
ee4367497d0d
got rid of buggy BagOfRunnablesBySteps
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1679
diff
changeset
|
152 RunnableWorkersPool::~RunnableWorkersPool() |
1679 | 153 { |
1681
ee4367497d0d
got rid of buggy BagOfRunnablesBySteps
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1679
diff
changeset
|
154 Stop(); |
1679 | 155 } |
156 | |
157 | |
1681
ee4367497d0d
got rid of buggy BagOfRunnablesBySteps
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1679
diff
changeset
|
158 void RunnableWorkersPool::Add(IRunnableBySteps* runnable) |
1679 | 159 { |
1681
ee4367497d0d
got rid of buggy BagOfRunnablesBySteps
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1679
diff
changeset
|
160 if (!pimpl_->continue_) |
ee4367497d0d
got rid of buggy BagOfRunnablesBySteps
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1679
diff
changeset
|
161 { |
ee4367497d0d
got rid of buggy BagOfRunnablesBySteps
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1679
diff
changeset
|
162 throw OrthancException(ErrorCode_BadSequenceOfCalls); |
ee4367497d0d
got rid of buggy BagOfRunnablesBySteps
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1679
diff
changeset
|
163 } |
ee4367497d0d
got rid of buggy BagOfRunnablesBySteps
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1679
diff
changeset
|
164 |
ee4367497d0d
got rid of buggy BagOfRunnablesBySteps
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1679
diff
changeset
|
165 pimpl_->queue_.Enqueue(runnable); |
1679 | 166 } |
167 } |