Simplify locking usage
[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 ThreadsManager 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 simply calls idle_loop() of the supplied thread. The first
36  // and last thread are special. First one is the main search thread while the
37  // last one mimics a timer, they run in main_loop() and timer_loop().
38
39 #if defined(_MSC_VER)
40   DWORD WINAPI start_routine(LPVOID thread) {
41 #else
42   void* start_routine(void* thread) {
43 #endif
44
45     Thread* th = (Thread*)thread;
46
47     if (th->threadID == 0)
48         th->main_loop();
49
50     else if (th->threadID == MAX_THREADS)
51         th->timer_loop();
52
53     else
54         th->idle_loop(NULL);
55
56     return 0;
57   }
58
59 } }
60
61
62 // wake_up() wakes up the thread, normally at the beginning of the search or,
63 // if "sleeping threads" is used, when there is some work to do.
64
65 void Thread::wake_up() {
66
67   lock_grab(sleepLock);
68   cond_signal(sleepCond);
69   lock_release(sleepLock);
70 }
71
72
73 // cutoff_occurred() checks whether a beta cutoff has occurred in the current
74 // active split point, or in some ancestor of the split point.
75
76 bool Thread::cutoff_occurred() const {
77
78   for (SplitPoint* sp = splitPoint; sp; sp = sp->parent)
79       if (sp->is_betaCutoff)
80           return true;
81
82   return false;
83 }
84
85
86 // is_available_to() checks whether the thread is available to help the thread with
87 // threadID "master" at a split point. An obvious requirement is that thread must be
88 // idle. With more than two threads, this is not by itself sufficient: If the thread
89 // is the master of some active split point, it is only available as a slave to the
90 // threads which are busy searching the split point at the top of "slave"'s split
91 // point stack (the "helpful master concept" in YBWC terminology).
92
93 bool Thread::is_available_to(int master) const {
94
95   if (is_searching)
96       return false;
97
98   // Make a local copy to be sure doesn't become zero under our feet while
99   // testing next condition and so leading to an out of bound access.
100   int localActiveSplitPoints = activeSplitPoints;
101
102   // No active split points means that the thread is available as a slave for any
103   // other thread otherwise apply the "helpful master" concept if possible.
104   if (   !localActiveSplitPoints
105       || splitPoints[localActiveSplitPoints - 1].is_slave[master])
106       return true;
107
108   return false;
109 }
110
111
112 // read_uci_options() updates number of active threads and other parameters
113 // according to the UCI options values. It is called before to start a new search.
114
115 void ThreadsManager::read_uci_options() {
116
117   maxThreadsPerSplitPoint = Options["Max Threads per Split Point"];
118   minimumSplitDepth       = Options["Min Split Depth"] * ONE_PLY;
119   useSleepingThreads      = Options["Use Sleeping Threads"];
120
121   set_size(Options["Threads"]);
122 }
123
124
125 // set_size() changes the number of active threads and raises do_sleep flag for
126 // all the unused threads that will go immediately to sleep.
127
128 void ThreadsManager::set_size(int cnt) {
129
130   assert(cnt > 0 && cnt <= MAX_THREADS);
131
132   activeThreads = cnt;
133
134   for (int i = 1; i < MAX_THREADS; i++) // Ignore main thread
135       if (i < activeThreads)
136       {
137           // Dynamically allocate pawn and material hash tables according to the
138           // number of active threads. This avoids preallocating memory for all
139           // possible threads if only few are used.
140           threads[i].pawnTable.init();
141           threads[i].materialTable.init();
142
143           threads[i].do_sleep = false;
144       }
145       else
146           threads[i].do_sleep = true;
147 }
148
149
150 // init() is called during startup. Initializes locks and condition variables
151 // and launches all threads sending them immediately to sleep.
152
153 void ThreadsManager::init() {
154
155   // Initialize sleep condition and lock used by thread manager
156   cond_init(sleepCond);
157   lock_init(threadsLock);
158
159   // Initialize thread's sleep conditions and split point locks
160   for (int i = 0; i <= MAX_THREADS; i++)
161   {
162       lock_init(threads[i].sleepLock);
163       cond_init(threads[i].sleepCond);
164
165       for (int j = 0; j < MAX_ACTIVE_SPLIT_POINTS; j++)
166           lock_init(threads[i].splitPoints[j].lock);
167   }
168
169   // Allocate main thread tables to call evaluate() also when not searching
170   threads[0].pawnTable.init();
171   threads[0].materialTable.init();
172
173   // Create and launch all the threads, threads will go immediately to sleep
174   for (int i = 0; i <= MAX_THREADS; i++)
175   {
176       threads[i].is_searching = false;
177       threads[i].do_sleep = (i != 0); // Avoid a race with start_thinking()
178       threads[i].threadID = i;
179
180       bool ok = thread_create(threads[i].handle, start_routine, threads[i]);
181
182       if (!ok)
183       {
184           std::cerr << "Failed to create thread number " << i << std::endl;
185           ::exit(EXIT_FAILURE);
186       }
187   }
188 }
189
190
191 // exit() is called to cleanly terminate the threads when the program finishes
192
193 void ThreadsManager::exit() {
194
195   for (int i = 0; i <= MAX_THREADS; i++)
196   {
197       threads[i].do_terminate = true; // Search must be already finished
198       threads[i].wake_up();
199
200       thread_join(threads[i].handle); // Wait for thread termination
201
202       // Now we can safely destroy associated locks and wait conditions
203       lock_destroy(threads[i].sleepLock);
204       cond_destroy(threads[i].sleepCond);
205
206       for (int j = 0; j < MAX_ACTIVE_SPLIT_POINTS; j++)
207           lock_destroy(threads[i].splitPoints[j].lock);
208   }
209
210   lock_destroy(threadsLock);
211   cond_destroy(sleepCond);
212 }
213
214
215 // available_slave_exists() tries to find an idle thread which is available as
216 // a slave for the thread with threadID 'master'.
217
218 bool ThreadsManager::available_slave_exists(int master) const {
219
220   assert(master >= 0 && master < activeThreads);
221
222   for (int i = 0; i < activeThreads; i++)
223       if (threads[i].is_available_to(master))
224           return true;
225
226   return false;
227 }
228
229
230 // split_point_finished() checks if all the slave threads of a given split
231 // point have finished searching.
232
233 bool ThreadsManager::split_point_finished(SplitPoint* sp) const {
234
235   for (int i = 0; i < activeThreads; i++)
236       if (sp->is_slave[i])
237           return false;
238
239   return true;
240 }
241
242
243 // split() does the actual work of distributing the work at a node between
244 // several available threads. If it does not succeed in splitting the node
245 // (because no idle threads are available, or because we have no unused split
246 // point objects), the function immediately returns. If splitting is possible, a
247 // SplitPoint object is initialized with all the data that must be copied to the
248 // helper threads and then helper threads are told that they have been assigned
249 // work. This will cause them to instantly leave their idle loops and call
250 // search(). When all threads have returned from search() then split() returns.
251
252 template <bool Fake>
253 Value ThreadsManager::split(Position& pos, Stack* ss, Value alpha, Value beta,
254                             Value bestValue, Depth depth, Move threatMove,
255                             int moveCount, MovePicker* mp, int nodeType) {
256   assert(pos.pos_is_ok());
257   assert(bestValue > -VALUE_INFINITE);
258   assert(bestValue <= alpha);
259   assert(alpha < beta);
260   assert(beta <= VALUE_INFINITE);
261   assert(depth > DEPTH_ZERO);
262   assert(pos.thread() >= 0 && pos.thread() < activeThreads);
263   assert(activeThreads > 1);
264
265   int i, master = pos.thread();
266   Thread& masterThread = threads[master];
267
268   // If we already have too many active split points, don't split
269   if (masterThread.activeSplitPoints >= MAX_ACTIVE_SPLIT_POINTS)
270       return bestValue;
271
272   // Pick the next available split point from the split point stack
273   SplitPoint* sp = &masterThread.splitPoints[masterThread.activeSplitPoints];
274
275   // Initialize the split point
276   sp->parent = masterThread.splitPoint;
277   sp->master = master;
278   sp->is_betaCutoff = false;
279   sp->depth = depth;
280   sp->threatMove = threatMove;
281   sp->alpha = alpha;
282   sp->beta = beta;
283   sp->nodeType = nodeType;
284   sp->bestValue = bestValue;
285   sp->mp = mp;
286   sp->moveCount = moveCount;
287   sp->pos = &pos;
288   sp->nodes = 0;
289   sp->ss = ss;
290
291   for (i = 0; i < activeThreads; i++)
292       sp->is_slave[i] = false;
293
294   // If we are here it means we are not available
295   assert(masterThread.is_searching);
296
297   int workersCnt = 1; // At least the master is included
298
299   // Try to allocate available threads and ask them to start searching setting
300   // is_searching flag. This must be done under lock protection to avoid concurrent
301   // allocation of the same slave by another master.
302   lock_grab(threadsLock);
303
304   for (i = 0; !Fake && i < activeThreads && workersCnt < maxThreadsPerSplitPoint; i++)
305       if (threads[i].is_available_to(master))
306       {
307           workersCnt++;
308           sp->is_slave[i] = true;
309           threads[i].splitPoint = sp;
310
311           // This makes the slave to exit from idle_loop()
312           threads[i].is_searching = true;
313
314           if (useSleepingThreads)
315               threads[i].wake_up();
316       }
317
318   lock_release(threadsLock);
319
320   // We failed to allocate even one slave, return
321   if (!Fake && workersCnt == 1)
322       return bestValue;
323
324   masterThread.splitPoint = sp;
325   masterThread.activeSplitPoints++;
326
327   // Everything is set up. The master thread enters the idle loop, from which
328   // it will instantly launch a search, because its is_searching flag is set.
329   // We pass the split point as a parameter to the idle loop, which means that
330   // the thread will return from the idle loop when all slaves have finished
331   // their work at this split point.
332   masterThread.idle_loop(sp);
333
334   // In helpful master concept a master can help only a sub-tree of its split
335   // point, and because here is all finished is not possible master is booked.
336   assert(!masterThread.is_searching);
337
338   // We have returned from the idle loop, which means that all threads are
339   // finished. Note that changing state and decreasing activeSplitPoints is done
340   // under lock protection to avoid a race with Thread::is_available_to().
341   lock_grab(threadsLock);
342
343   masterThread.is_searching = true;
344   masterThread.activeSplitPoints--;
345
346   lock_release(threadsLock);
347
348   masterThread.splitPoint = sp->parent;
349   pos.set_nodes_searched(pos.nodes_searched() + sp->nodes);
350
351   return sp->bestValue;
352 }
353
354 // Explicit template instantiations
355 template Value ThreadsManager::split<false>(Position&, Stack*, Value, Value, Value, Depth, Move, int, MovePicker*, int);
356 template Value ThreadsManager::split<true>(Position&, Stack*, Value, Value, Value, Depth, Move, int, MovePicker*, int);
357
358
359 // Thread::timer_loop() is where the timer thread waits maxPly milliseconds and
360 // then calls do_timer_event(). If maxPly is 0 thread sleeps until is woken up.
361 extern void check_time();
362
363 void Thread::timer_loop() {
364
365   while (!do_terminate)
366   {
367       lock_grab(sleepLock);
368       timed_wait(sleepCond, sleepLock, maxPly ? maxPly : INT_MAX);
369       lock_release(sleepLock);
370       check_time();
371   }
372 }
373
374
375 // ThreadsManager::set_timer() is used to set the timer to trigger after msec
376 // milliseconds. If msec is 0 then timer is stopped.
377
378 void ThreadsManager::set_timer(int msec) {
379
380   Thread& timer = threads[MAX_THREADS];
381
382   lock_grab(timer.sleepLock);
383   timer.maxPly = msec;
384   cond_signal(timer.sleepCond); // Wake up and restart the timer
385   lock_release(timer.sleepLock);
386 }
387
388
389 // Thread::main_loop() is where the main thread is parked waiting to be started
390 // when there is a new search. Main thread will launch all the slave threads.
391
392 void Thread::main_loop() {
393
394   while (true)
395   {
396       lock_grab(sleepLock);
397
398       do_sleep = true; // Always return to sleep after a search
399       is_searching = false;
400
401       while (do_sleep && !do_terminate)
402       {
403           cond_signal(Threads.sleepCond); // Wake up UI thread if needed
404           cond_wait(sleepCond, sleepLock);
405       }
406
407       is_searching = true;
408
409       lock_release(sleepLock);
410
411       if (do_terminate)
412           return;
413
414       Search::think();
415   }
416 }
417
418
419 // ThreadsManager::start_thinking() is used by UI thread to wake up the main
420 // thread parked in main_loop() and starting a new search. If asyncMode is true
421 // then function returns immediately, otherwise caller is blocked waiting for
422 // the search to finish.
423
424 void ThreadsManager::start_thinking(const Position& pos, const LimitsType& limits,
425                                     const std::set<Move>& searchMoves, bool async) {
426   Thread& main = threads[0];
427
428   lock_grab(main.sleepLock);
429
430   // Wait main thread has finished before to launch a new search
431   while (!main.do_sleep)
432       cond_wait(sleepCond, main.sleepLock);
433
434   // Copy input arguments to initialize the search
435   RootPosition.copy(pos, 0);
436   Limits = limits;
437   RootMoves.clear();
438
439   // Populate RootMoves with all the legal moves (default) or, if a searchMoves
440   // set is given, with the subset of legal moves to search.
441   for (MoveList<MV_LEGAL> ml(pos); !ml.end(); ++ml)
442       if (searchMoves.empty() || searchMoves.count(ml.move()))
443           RootMoves.push_back(RootMove(ml.move()));
444
445   // Reset signals before to start the new search
446   Signals.stopOnPonderhit = Signals.firstRootMove = false;
447   Signals.stop = Signals.failedLowAtRoot = false;
448
449   main.do_sleep = false;
450   cond_signal(main.sleepCond); // Wake up main thread and start searching
451
452   if (!async)
453       while (!main.do_sleep)
454           cond_wait(sleepCond, main.sleepLock);
455
456   lock_release(main.sleepLock);
457 }
458
459
460 // ThreadsManager::stop_thinking() is used by UI thread to raise a stop request
461 // and to wait for the main thread finishing the search. Needed to wait exiting
462 // and terminate the threads after a 'quit' command.
463
464 void ThreadsManager::stop_thinking() {
465
466   Thread& main = threads[0];
467
468   Search::Signals.stop = true;
469
470   lock_grab(main.sleepLock);
471
472   cond_signal(main.sleepCond); // In case is waiting for stop or ponderhit
473
474   while (!main.do_sleep)
475       cond_wait(sleepCond, main.sleepLock);
476
477   lock_release(main.sleepLock);
478 }
479
480
481 // ThreadsManager::wait_for_stop_or_ponderhit() is called when the maximum depth
482 // is reached while the program is pondering. The point is to work around a wrinkle
483 // in the UCI protocol: When pondering, the engine is not allowed to give a
484 // "bestmove" before the GUI sends it a "stop" or "ponderhit" command. We simply
485 // wait here until one of these commands (that raise StopRequest) is sent and
486 // then return, after which the bestmove and pondermove will be printed.
487
488 void ThreadsManager::wait_for_stop_or_ponderhit() {
489
490   Signals.stopOnPonderhit = true;
491
492   Thread& main = threads[0];
493
494   lock_grab(main.sleepLock);
495
496   while (!Signals.stop)
497       cond_wait(main.sleepCond, main.sleepLock);
498
499   lock_release(main.sleepLock);
500 }