Mercurial > hg > orthanc
annotate Core/MultiThreading/BagOfRunnablesBySteps.cpp @ 1453:c0bdc47165ef
code to warn about possible threading problems
| author | Sebastien Jodogne <s.jodogne@gmail.com> |
|---|---|
| date | Thu, 02 Jul 2015 12:26:44 +0200 |
| parents | 6e7e5ed91c2d |
| children | f967bdf8534e |
| rev | line source |
|---|---|
| 0 | 1 /** |
| 59 | 2 * Orthanc - A Lightweight, RESTful DICOM Store |
|
1288
6e7e5ed91c2d
upgrade to year 2015
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
824
diff
changeset
|
3 * Copyright (C) 2012-2015 Sebastien Jodogne, Medical Physics |
|
6e7e5ed91c2d
upgrade to year 2015
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
824
diff
changeset
|
4 * Department, University Hospital of Liege, Belgium |
| 0 | 5 * |
| 6 * This program is free software: you can redistribute it and/or | |
| 7 * modify it under the terms of the GNU General Public License as | |
| 8 * published by the Free Software Foundation, either version 3 of the | |
| 9 * License, or (at your option) any later version. | |
| 136 | 10 * |
| 11 * In addition, as a special exception, the copyright holders of this | |
| 12 * program give permission to link the code of its release with the | |
| 13 * OpenSSL project's "OpenSSL" library (or with modified versions of it | |
| 14 * that use the same license as the "OpenSSL" library), and distribute | |
| 15 * the linked executables. You must obey the GNU General Public License | |
| 16 * in all respects for all of the code used other than "OpenSSL". If you | |
| 17 * modify file(s) with this exception, you may extend this exception to | |
| 18 * your version of the file(s), but you are not obligated to do so. If | |
| 19 * you do not wish to do so, delete this exception statement from your | |
| 20 * version. If you delete this exception statement from all source files | |
| 21 * in the program, then also delete it here. | |
| 0 | 22 * |
| 23 * This program is distributed in the hope that it will be useful, but | |
| 24 * WITHOUT ANY WARRANTY; without even the implied warranty of | |
| 25 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | |
| 26 * General Public License for more details. | |
| 27 * | |
| 28 * You should have received a copy of the GNU General Public License | |
| 29 * along with this program. If not, see <http://www.gnu.org/licenses/>. | |
| 30 **/ | |
| 31 | |
| 32 | |
|
824
a811bdf8b8eb
precompiled headers
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
689
diff
changeset
|
33 #include "../PrecompiledHeaders.h" |
| 0 | 34 #include "BagOfRunnablesBySteps.h" |
| 35 | |
| 36 #include <stack> | |
| 37 #include <boost/thread.hpp> | |
|
1453
c0bdc47165ef
code to warn about possible threading problems
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1288
diff
changeset
|
38 #include <glog/logging.h> |
| 0 | 39 |
| 59 | 40 namespace Orthanc |
| 0 | 41 { |
| 42 struct BagOfRunnablesBySteps::PImpl | |
| 43 { | |
| 44 bool continue_; | |
| 45 bool stopFinishListener_; | |
| 46 | |
| 47 boost::mutex mutex_; | |
| 48 boost::condition_variable oneThreadIsStopped_; | |
| 49 boost::condition_variable oneThreadIsJoined_; | |
| 50 | |
| 51 // The list of threads that are waiting to be joined. | |
| 52 typedef std::stack<IRunnableBySteps*> StoppedThreads; | |
| 53 StoppedThreads stoppedThreads_; | |
| 54 | |
| 55 // The set of active runnables, i.e. the runnables that have not | |
| 56 // finished their job yet, plus the runnables that have not been | |
| 57 // joined yet. | |
| 58 typedef std::map<IRunnableBySteps*, boost::thread*> ActiveThreads; | |
| 59 ActiveThreads activeThreads_; | |
| 60 | |
| 61 // The thread that joins the runnables after they stop | |
| 62 std::auto_ptr<boost::thread> finishListener_; | |
| 63 }; | |
| 64 | |
| 65 | |
| 66 | |
| 67 void BagOfRunnablesBySteps::RunnableThread(BagOfRunnablesBySteps* bag, | |
| 68 IRunnableBySteps* runnable) | |
| 69 { | |
| 70 while (bag->pimpl_->continue_) | |
| 71 { | |
| 72 if (!runnable->Step()) | |
| 73 { | |
| 74 break; | |
| 75 } | |
| 76 } | |
| 77 | |
| 78 { | |
| 79 // Register this runnable as having stopped | |
| 80 boost::mutex::scoped_lock lock(bag->pimpl_->mutex_); | |
| 81 bag->pimpl_->stoppedThreads_.push(runnable); | |
| 82 bag->pimpl_->oneThreadIsStopped_.notify_one(); | |
| 83 } | |
| 84 } | |
| 85 | |
| 86 | |
| 87 void BagOfRunnablesBySteps::FinishListener(BagOfRunnablesBySteps* bag) | |
| 88 { | |
| 89 boost::mutex::scoped_lock lock(bag->pimpl_->mutex_); | |
| 90 | |
| 91 while (!bag->pimpl_->stopFinishListener_) | |
| 92 { | |
| 93 while (!bag->pimpl_->stoppedThreads_.empty()) | |
| 94 { | |
| 95 std::auto_ptr<IRunnableBySteps> r(bag->pimpl_->stoppedThreads_.top()); | |
| 96 bag->pimpl_->stoppedThreads_.pop(); | |
| 97 | |
| 98 assert(r.get() != NULL); | |
| 99 assert(bag->pimpl_->activeThreads_.find(r.get()) != bag->pimpl_->activeThreads_.end()); | |
| 100 | |
| 101 std::auto_ptr<boost::thread> t(bag->pimpl_->activeThreads_[r.get()]); | |
| 102 bag->pimpl_->activeThreads_.erase(r.get()); | |
| 103 | |
| 104 assert(t.get() != NULL); | |
| 105 assert(bag->pimpl_->activeThreads_.find(r.get()) == bag->pimpl_->activeThreads_.end()); | |
| 106 | |
|
431
16b52fb8d034
fix by cyril paulus
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
398
diff
changeset
|
107 if (t->joinable()) |
|
16b52fb8d034
fix by cyril paulus
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
398
diff
changeset
|
108 { |
|
16b52fb8d034
fix by cyril paulus
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
398
diff
changeset
|
109 t->join(); |
|
16b52fb8d034
fix by cyril paulus
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
398
diff
changeset
|
110 } |
|
16b52fb8d034
fix by cyril paulus
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
398
diff
changeset
|
111 |
| 0 | 112 bag->pimpl_->oneThreadIsJoined_.notify_one(); |
| 113 } | |
| 114 | |
| 115 bag->pimpl_->oneThreadIsStopped_.wait(lock); | |
| 116 } | |
| 117 } | |
| 118 | |
| 119 | |
| 120 BagOfRunnablesBySteps::BagOfRunnablesBySteps() : pimpl_(new PImpl) | |
| 121 { | |
| 122 pimpl_->continue_ = true; | |
| 123 pimpl_->stopFinishListener_ = false; | |
| 124 | |
| 125 // Everyting is set up, the finish listener can be started | |
| 126 pimpl_->finishListener_.reset(new boost::thread(FinishListener, this)); | |
| 127 } | |
| 128 | |
| 129 | |
| 130 BagOfRunnablesBySteps::~BagOfRunnablesBySteps() | |
| 131 { | |
|
1453
c0bdc47165ef
code to warn about possible threading problems
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1288
diff
changeset
|
132 if (!pimpl_->stopFinishListener_) |
|
431
16b52fb8d034
fix by cyril paulus
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
398
diff
changeset
|
133 { |
|
1453
c0bdc47165ef
code to warn about possible threading problems
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1288
diff
changeset
|
134 LOG(ERROR) << "INTERNAL ERROR: BagOfRunnablesBySteps::Finalize() should be invoked manually to avoid mess in the destruction order!"; |
|
c0bdc47165ef
code to warn about possible threading problems
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1288
diff
changeset
|
135 Finalize(); |
|
431
16b52fb8d034
fix by cyril paulus
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
398
diff
changeset
|
136 } |
| 0 | 137 } |
| 138 | |
| 139 | |
| 140 void BagOfRunnablesBySteps::Add(IRunnableBySteps* runnable) | |
| 141 { | |
| 142 // Make sure the runnable is deleted is something goes wrong | |
| 143 std::auto_ptr<IRunnableBySteps> runnableRabi(runnable); | |
| 144 | |
| 145 boost::mutex::scoped_lock lock(pimpl_->mutex_); | |
| 146 boost::thread* t(new boost::thread(RunnableThread, this, runnable)); | |
| 147 | |
| 148 pimpl_->activeThreads_.insert(std::make_pair(runnableRabi.release(), t)); | |
| 149 } | |
| 150 | |
| 151 | |
| 152 void BagOfRunnablesBySteps::StopAll() | |
| 153 { | |
| 154 boost::mutex::scoped_lock lock(pimpl_->mutex_); | |
| 155 pimpl_->continue_ = false; | |
| 156 | |
| 157 while (pimpl_->activeThreads_.size() > 0) | |
| 158 { | |
| 159 pimpl_->oneThreadIsJoined_.wait(lock); | |
| 160 } | |
| 161 | |
| 162 pimpl_->continue_ = true; | |
| 163 } | |
|
1453
c0bdc47165ef
code to warn about possible threading problems
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1288
diff
changeset
|
164 |
|
c0bdc47165ef
code to warn about possible threading problems
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1288
diff
changeset
|
165 |
|
c0bdc47165ef
code to warn about possible threading problems
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1288
diff
changeset
|
166 |
|
c0bdc47165ef
code to warn about possible threading problems
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1288
diff
changeset
|
167 void BagOfRunnablesBySteps::Finalize() |
|
c0bdc47165ef
code to warn about possible threading problems
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1288
diff
changeset
|
168 { |
|
c0bdc47165ef
code to warn about possible threading problems
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1288
diff
changeset
|
169 if (!pimpl_->stopFinishListener_) |
|
c0bdc47165ef
code to warn about possible threading problems
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1288
diff
changeset
|
170 { |
|
c0bdc47165ef
code to warn about possible threading problems
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1288
diff
changeset
|
171 StopAll(); |
|
c0bdc47165ef
code to warn about possible threading problems
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1288
diff
changeset
|
172 |
|
c0bdc47165ef
code to warn about possible threading problems
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1288
diff
changeset
|
173 // Stop the finish listener |
|
c0bdc47165ef
code to warn about possible threading problems
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1288
diff
changeset
|
174 pimpl_->stopFinishListener_ = true; |
|
c0bdc47165ef
code to warn about possible threading problems
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1288
diff
changeset
|
175 pimpl_->oneThreadIsStopped_.notify_one(); // Awakens the listener |
|
c0bdc47165ef
code to warn about possible threading problems
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1288
diff
changeset
|
176 |
|
c0bdc47165ef
code to warn about possible threading problems
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1288
diff
changeset
|
177 if (pimpl_->finishListener_->joinable()) |
|
c0bdc47165ef
code to warn about possible threading problems
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1288
diff
changeset
|
178 { |
|
c0bdc47165ef
code to warn about possible threading problems
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1288
diff
changeset
|
179 pimpl_->finishListener_->join(); |
|
c0bdc47165ef
code to warn about possible threading problems
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1288
diff
changeset
|
180 } |
|
c0bdc47165ef
code to warn about possible threading problems
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1288
diff
changeset
|
181 } |
|
c0bdc47165ef
code to warn about possible threading problems
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1288
diff
changeset
|
182 } |
|
c0bdc47165ef
code to warn about possible threading problems
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1288
diff
changeset
|
183 |
| 0 | 184 } |