Fix race while exiting
[stockfish] / src / thread.cpp
1 /*
2   Stockfish, a UCI chess playing engine derived from Glaurung 2.1
3   Copyright (C) 2004-2008 Tord Romstad (Glaurung author)
4   Copyright (C) 2008-2012 Marco Costalba, Joona Kiiski, Tord Romstad
5
6   Stockfish is free software: you can redistribute it and/or modify
7   it under the terms of the GNU General Public License as published by
8   the Free Software Foundation, either version 3 of the License, or
9   (at your option) any later version.
10
11   Stockfish is distributed in the hope that it will be useful,
12   but WITHOUT ANY WARRANTY; without even the implied warranty of
13   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14   GNU General Public License for more details.
15
16   You should have received a copy of the GNU General Public License
17   along with this program.  If not, see <http://www.gnu.org/licenses/>.
18 */
19
20 #include <cassert>
21 #include <iostream>
22
23 #include "movegen.h"
24 #include "search.h"
25 #include "thread.h"
26 #include "ucioption.h"
27
28 using namespace Search;
29
30 ThreadPool Threads; // Global object
31
32 namespace { extern "C" {
33
34  // start_routine() is the C function which is called when a new thread
35  // is launched. It is a wrapper to the virtual function idle_loop().
36
37  long start_routine(Thread* th) { th->idle_loop(); return 0; }
38
39 } }
40
41
42 // Thread c'tor starts a newly-created thread of execution that will call
43 // the the virtual function idle_loop(), going immediately to sleep.
44
45 Thread::Thread() : splitPoints() {
46
47   is_searching = do_exit = false;
48   maxPly = splitPointsCnt = 0;
49   curSplitPoint = NULL;
50   idx = Threads.size();
51
52   if (!thread_create(handle, start_routine, this))
53   {
54       std::cerr << "Failed to create thread number " << idx << std::endl;
55       ::exit(EXIT_FAILURE);
56   }
57 }
58
59
60 // Thread d'tor waits for thread termination before to return
61
62 Thread::~Thread() {
63
64   do_exit = true; // Search must be already finished
65   notify_one();
66   thread_join(handle); // Wait for thread termination
67 }
68
69
70 // TimerThread::idle_loop() is where the timer thread waits msec milliseconds
71 // and then calls check_time(). If msec is 0 thread sleeps until is woken up.
72 extern void check_time();
73
74 void TimerThread::idle_loop() {
75
76   while (!do_exit)
77   {
78       mutex.lock();
79
80       if (!do_exit)
81           sleepCondition.wait_for(mutex, msec ? msec : INT_MAX);
82
83       mutex.unlock();
84
85       if (msec)
86           check_time();
87   }
88 }
89
90
91 // MainThread::idle_loop() is where the main thread is parked waiting to be started
92 // when there is a new search. Main thread will launch all the slave threads.
93
94 void MainThread::idle_loop() {
95
96   while (true)
97   {
98       mutex.lock();
99
100       is_finished = true; // Always return to sleep after a search
101       is_searching = false;
102
103       while (is_finished && !do_exit)
104       {
105           Threads.sleepCondition.notify_one(); // Wake up UI thread if needed
106           sleepCondition.wait(mutex);
107       }
108
109       mutex.unlock();
110
111       if (do_exit)
112           return;
113
114       is_searching = true;
115
116       Search::think();
117
118       assert(is_searching);
119   }
120 }
121
122
123 // Thread::notify_one() wakes up the thread, normally at split time
124
125 void Thread::notify_one() {
126
127   mutex.lock();
128   sleepCondition.notify_one();
129   mutex.unlock();
130 }
131
132
133 // Thread::wait_for() set the thread to sleep until condition 'b' turns true
134
135 void Thread::wait_for(volatile const bool& b) {
136
137   mutex.lock();
138   while (!b) sleepCondition.wait(mutex);
139   mutex.unlock();
140 }
141
142
143 // Thread::cutoff_occurred() checks whether a beta cutoff has occurred in the
144 // current active split point, or in some ancestor of the split point.
145
146 bool Thread::cutoff_occurred() const {
147
148   for (SplitPoint* sp = curSplitPoint; sp; sp = sp->parent)
149       if (sp->cutoff)
150           return true;
151
152   return false;
153 }
154
155
156 // Thread::is_available_to() checks whether the thread is available to help the
157 // thread 'master' at a split point. An obvious requirement is that thread must
158 // be idle. With more than two threads, this is not sufficient: If the thread is
159 // the master of some active split point, it is only available as a slave to the
160 // slaves which are busy searching the split point at the top of slaves split
161 // point stack (the "helpful master concept" in YBWC terminology).
162
163 bool Thread::is_available_to(Thread* master) const {
164
165   if (is_searching)
166       return false;
167
168   // Make a local copy to be sure doesn't become zero under our feet while
169   // testing next condition and so leading to an out of bound access.
170   int spCnt = splitPointsCnt;
171
172   // No active split points means that the thread is available as a slave for any
173   // other thread otherwise apply the "helpful master" concept if possible.
174   return !spCnt || (splitPoints[spCnt - 1].slavesMask & (1ULL << master->idx));
175 }
176
177
178 // init() is called at startup. Initializes lock and condition variable and
179 // launches requested threads sending them immediately to sleep. We cannot use
180 // a c'tor becuase Threads is a static object and we need a fully initialized
181 // engine at this point due to allocation of endgames in Thread c'tor.
182
183 void ThreadPool::init() {
184
185   sleepWhileIdle = true;
186   timer = new TimerThread();
187   threads.push_back(new MainThread());
188   read_uci_options();
189 }
190
191
192 // exit() cleanly terminates the threads before the program exits.
193
194 void ThreadPool::exit() {
195
196   delete timer; // As first becuase check_time() accesses threads data
197
198   for (size_t i = 0; i < threads.size(); i++)
199       delete threads[i];
200 }
201
202
203 // read_uci_options() updates internal threads parameters from the corresponding
204 // UCI options and creates/destroys threads to match the requested number. Thread
205 // objects are dynamically allocated to avoid creating in advance all possible
206 // threads, with included pawns and material tables, if only few are used.
207
208 void ThreadPool::read_uci_options() {
209
210   maxThreadsPerSplitPoint = Options["Max Threads per Split Point"];
211   minimumSplitDepth       = Options["Min Split Depth"] * ONE_PLY;
212   size_t requested        = Options["Threads"];
213
214   assert(requested > 0);
215
216   while (threads.size() < requested)
217       threads.push_back(new Thread());
218
219   while (threads.size() > requested)
220   {
221       delete threads.back();
222       threads.pop_back();
223   }
224 }
225
226
227 // available_slave_exists() tries to find an idle thread which is available as
228 // a slave for the thread 'master'.
229
230 bool ThreadPool::available_slave_exists(Thread* master) const {
231
232   for (size_t i = 0; i < threads.size(); i++)
233       if (threads[i]->is_available_to(master))
234           return true;
235
236   return false;
237 }
238
239
240 // split() does the actual work of distributing the work at a node between
241 // several available threads. If it does not succeed in splitting the node
242 // (because no idle threads are available, or because we have no unused split
243 // point objects), the function immediately returns. If splitting is possible, a
244 // SplitPoint object is initialized with all the data that must be copied to the
245 // helper threads and then helper threads are told that they have been assigned
246 // work. This will cause them to instantly leave their idle loops and call
247 // search(). When all threads have returned from search() then split() returns.
248
249 template <bool Fake>
250 Value ThreadPool::split(Position& pos, Stack* ss, Value alpha, Value beta,
251                         Value bestValue, Move* bestMove, Depth depth, Move threatMove,
252                         int moveCount, MovePicker& mp, int nodeType) {
253
254   assert(pos.pos_is_ok());
255   assert(bestValue > -VALUE_INFINITE);
256   assert(bestValue <= alpha);
257   assert(alpha < beta);
258   assert(beta <= VALUE_INFINITE);
259   assert(depth > DEPTH_ZERO);
260
261   Thread* master = pos.this_thread();
262
263   if (master->splitPointsCnt >= MAX_SPLITPOINTS_PER_THREAD)
264       return bestValue;
265
266   // Pick the next available split point from the split point stack
267   SplitPoint& sp = master->splitPoints[master->splitPointsCnt];
268
269   sp.parent = master->curSplitPoint;
270   sp.master = master;
271   sp.cutoff = false;
272   sp.slavesMask = 1ULL << master->idx;
273   sp.depth = depth;
274   sp.bestMove = *bestMove;
275   sp.threatMove = threatMove;
276   sp.alpha = alpha;
277   sp.beta = beta;
278   sp.nodeType = nodeType;
279   sp.bestValue = bestValue;
280   sp.mp = &mp;
281   sp.moveCount = moveCount;
282   sp.pos = &pos;
283   sp.nodes = 0;
284   sp.ss = ss;
285
286   assert(master->is_searching);
287
288   master->curSplitPoint = &sp;
289   int slavesCnt = 0;
290
291   // Try to allocate available threads and ask them to start searching setting
292   // is_searching flag. This must be done under lock protection to avoid concurrent
293   // allocation of the same slave by another master.
294   mutex.lock();
295   sp.mutex.lock();
296
297   for (size_t i = 0; i < threads.size() && !Fake; ++i)
298       if (threads[i]->is_available_to(master))
299       {
300           sp.slavesMask |= 1ULL << i;
301           threads[i]->curSplitPoint = &sp;
302           threads[i]->is_searching = true; // Slave leaves idle_loop()
303           threads[i]->notify_one(); // Could be sleeping
304
305           if (++slavesCnt + 1 >= maxThreadsPerSplitPoint) // Master is always included
306               break;
307       }
308
309   master->splitPointsCnt++;
310
311   sp.mutex.unlock();
312   mutex.unlock();
313
314   // Everything is set up. The master thread enters the idle loop, from which
315   // it will instantly launch a search, because its is_searching flag is set.
316   // The thread will return from the idle loop when all slaves have finished
317   // their work at this split point.
318   if (slavesCnt || Fake)
319   {
320       master->Thread::idle_loop(); // Force a call to base class idle_loop()
321
322       // In helpful master concept a master can help only a sub-tree of its split
323       // point, and because here is all finished is not possible master is booked.
324       assert(!master->is_searching);
325   }
326
327   // We have returned from the idle loop, which means that all threads are
328   // finished. Note that setting is_searching and decreasing splitPointsCnt is
329   // done under lock protection to avoid a race with Thread::is_available_to().
330   mutex.lock();
331   sp.mutex.lock();
332
333   master->is_searching = true;
334   master->splitPointsCnt--;
335   master->curSplitPoint = sp.parent;
336   pos.set_nodes_searched(pos.nodes_searched() + sp.nodes);
337   *bestMove = sp.bestMove;
338
339   sp.mutex.unlock();
340   mutex.unlock();
341
342   return sp.bestValue;
343 }
344
345 // Explicit template instantiations
346 template Value ThreadPool::split<false>(Position&, Stack*, Value, Value, Value, Move*, Depth, Move, int, MovePicker&, int);
347 template Value ThreadPool::split<true>(Position&, Stack*, Value, Value, Value, Move*, Depth, Move, int, MovePicker&, int);
348
349
350 // wait_for_search_finished() waits for main thread to go to sleep, this means
351 // search is finished. Then returns.
352
353 void ThreadPool::wait_for_search_finished() {
354
355   MainThread* t = main_thread();
356   t->mutex.lock();
357   while (!t->is_finished) sleepCondition.wait(t->mutex);
358   t->mutex.unlock();
359 }
360
361
362 // start_searching() wakes up the main thread sleeping in  main_loop() so to start
363 // a new search, then returns immediately.
364
365 void ThreadPool::start_searching(const Position& pos, const LimitsType& limits,
366                                  const std::vector<Move>& searchMoves, StateStackPtr& states) {
367   wait_for_search_finished();
368
369   SearchTime = Time::now(); // As early as possible
370
371   Signals.stopOnPonderhit = Signals.firstRootMove = false;
372   Signals.stop = Signals.failedLowAtRoot = false;
373
374   RootPos = pos;
375   Limits = limits;
376   SetupStates = states; // Ownership transfer here
377   RootMoves.clear();
378
379   for (MoveList<LEGAL> ml(pos); !ml.end(); ++ml)
380       if (searchMoves.empty() || count(searchMoves.begin(), searchMoves.end(), ml.move()))
381           RootMoves.push_back(RootMove(ml.move()));
382
383   main_thread()->is_finished = false;
384   main_thread()->notify_one(); // Starts main thread
385 }