65d01d9100a874e19db9addea3772bafa735dd69
[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 is a wrapper to member function pointed by start_fn.
36
37  long start_routine(Thread* th) { (th->*(th->start_fn))(); return 0; }
38
39 } }
40
41
42 // Thread c'tor starts a newly-created thread of execution that will call
43 // the idle loop function pointed by start_fn going immediately to sleep.
44
45 Thread::Thread(Fn fn) {
46
47   is_searching = do_exit = false;
48   maxPly = splitPointsCnt = 0;
49   curSplitPoint = NULL;
50   start_fn = fn;
51   threadID = Threads.size();
52
53   do_sleep = (fn != &Thread::main_loop); // Avoid a race with start_searching()
54
55   lock_init(sleepLock);
56   cond_init(sleepCond);
57
58   for (int j = 0; j < MAX_SPLITPOINTS_PER_THREAD; j++)
59       lock_init(splitPoints[j].lock);
60
61   if (!thread_create(handle, start_routine, this))
62   {
63       std::cerr << "Failed to create thread number " << threadID << std::endl;
64       ::exit(EXIT_FAILURE);
65   }
66 }
67
68
69 // Thread d'tor waits for thread termination before to return.
70
71 Thread::~Thread() {
72
73   assert(do_sleep);
74
75   do_exit = true; // Search must be already finished
76   wake_up();
77
78   thread_join(handle); // Wait for thread termination
79
80   lock_destroy(sleepLock);
81   cond_destroy(sleepCond);
82
83   for (int j = 0; j < MAX_SPLITPOINTS_PER_THREAD; j++)
84       lock_destroy(splitPoints[j].lock);
85 }
86
87
88 // Thread::timer_loop() is where the timer thread waits maxPly milliseconds and
89 // then calls check_time(). If maxPly is 0 thread sleeps until is woken up.
90 extern void check_time();
91
92 void Thread::timer_loop() {
93
94   while (!do_exit)
95   {
96       lock_grab(sleepLock);
97       timed_wait(sleepCond, sleepLock, maxPly ? maxPly : INT_MAX);
98       lock_release(sleepLock);
99       check_time();
100   }
101 }
102
103
104 // Thread::main_loop() is where the main thread is parked waiting to be started
105 // when there is a new search. Main thread will launch all the slave threads.
106
107 void Thread::main_loop() {
108
109   while (true)
110   {
111       lock_grab(sleepLock);
112
113       do_sleep = true; // Always return to sleep after a search
114       is_searching = false;
115
116       while (do_sleep && !do_exit)
117       {
118           cond_signal(Threads.sleepCond); // Wake up UI thread if needed
119           cond_wait(sleepCond, sleepLock);
120       }
121
122       lock_release(sleepLock);
123
124       if (do_exit)
125           return;
126
127       is_searching = true;
128
129       Search::think();
130   }
131 }
132
133
134 // Thread::wake_up() wakes up the thread, normally at the beginning of the search
135 // or, if "sleeping threads" is used at split time.
136
137 void Thread::wake_up() {
138
139   lock_grab(sleepLock);
140   do_sleep = false;
141   cond_signal(sleepCond);
142   lock_release(sleepLock);
143 }
144
145
146 // Thread::wait_for_stop_or_ponderhit() is called when the maximum depth is
147 // reached while the program is pondering. The point is to work around a wrinkle
148 // in the UCI protocol: When pondering, the engine is not allowed to give a
149 // "bestmove" before the GUI sends it a "stop" or "ponderhit" command. We simply
150 // wait here until one of these commands (that raise StopRequest) is sent and
151 // then return, after which the bestmove and pondermove will be printed.
152
153 void Thread::wait_for_stop_or_ponderhit() {
154
155   Signals.stopOnPonderhit = true;
156
157   lock_grab(sleepLock);
158   while (!Signals.stop) cond_wait(sleepCond, sleepLock);
159   lock_release(sleepLock);
160 }
161
162
163 // Thread::cutoff_occurred() checks whether a beta cutoff has occurred in the
164 // current active split point, or in some ancestor of the split point.
165
166 bool Thread::cutoff_occurred() const {
167
168   for (SplitPoint* sp = curSplitPoint; sp; sp = sp->parent)
169       if (sp->cutoff)
170           return true;
171
172   return false;
173 }
174
175
176 // Thread::is_available_to() checks whether the thread is available to help the
177 // thread with threadID "master" at a split point. An obvious requirement is that
178 // thread must be idle. With more than two threads, this is not sufficient: If
179 // the thread is the master of some active split point, it is only available as a
180 // slave to the threads which are busy searching the split point at the top of
181 // "slave"'s split point stack (the "helpful master concept" in YBWC terminology).
182
183 bool Thread::is_available_to(int master) const {
184
185   if (is_searching)
186       return false;
187
188   // Make a local copy to be sure doesn't become zero under our feet while
189   // testing next condition and so leading to an out of bound access.
190   int spCnt = splitPointsCnt;
191
192   // No active split points means that the thread is available as a slave for any
193   // other thread otherwise apply the "helpful master" concept if possible.
194   return !spCnt || (splitPoints[spCnt - 1].slavesMask & (1ULL << master));
195 }
196
197
198 // init() is called at startup. Initializes lock and condition variable and
199 // launches requested threads sending them immediately to sleep. We cannot use
200 // a c'tor becuase Threads is a static object and we need a fully initialized
201 // engine at this point due to allocation of endgames in Thread c'tor.
202
203 void ThreadsManager::init() {
204
205   cond_init(sleepCond);
206   lock_init(splitLock);
207   timer = new Thread(&Thread::timer_loop);
208   threads.push_back(new Thread(&Thread::main_loop));
209   read_uci_options();
210 }
211
212
213 // d'tor cleanly terminates the threads when the program exits.
214
215 ThreadsManager::~ThreadsManager() {
216
217   for (int i = 0; i < size(); i++)
218       delete threads[i];
219
220   delete timer;
221   lock_destroy(splitLock);
222   cond_destroy(sleepCond);
223 }
224
225
226 // read_uci_options() updates internal threads parameters from the corresponding
227 // UCI options and creates/destroys threads to match the requested number. Thread
228 // objects are dynamically allocated to avoid creating in advance all possible
229 // threads, with included pawns and material tables, if only few are used.
230
231 void ThreadsManager::read_uci_options() {
232
233   maxThreadsPerSplitPoint = Options["Max Threads per Split Point"];
234   minimumSplitDepth       = Options["Min Split Depth"] * ONE_PLY;
235   useSleepingThreads      = Options["Use Sleeping Threads"];
236   int requested           = Options["Threads"];
237
238   assert(requested > 0);
239
240   while (size() < requested)
241       threads.push_back(new Thread(&Thread::idle_loop));
242
243   while (size() > requested)
244   {
245       delete threads.back();
246       threads.pop_back();
247   }
248 }
249
250
251 // wake_up() is called before a new search to start the threads that are waiting
252 // on the sleep condition and to reset maxPly. When useSleepingThreads is set
253 // threads will be woken up at split time.
254
255 void ThreadsManager::wake_up() const {
256
257   for (int i = 0; i < size(); i++)
258   {
259       threads[i]->maxPly = 0;
260
261       if (!useSleepingThreads)
262           threads[i]->wake_up();
263   }
264 }
265
266
267 // sleep() is called after the search finishes to ask all the threads but the
268 // main one to go waiting on a sleep condition.
269
270 void ThreadsManager::sleep() const {
271
272   for (int i = 1; i < size(); i++) // Main thread will go to sleep by itself
273       threads[i]->do_sleep = true; // to avoid a race with start_searching()
274 }
275
276
277 // available_slave_exists() tries to find an idle thread which is available as
278 // a slave for the thread with threadID 'master'.
279
280 bool ThreadsManager::available_slave_exists(int master) const {
281
282   assert(master >= 0 && master < size());
283
284   for (int i = 0; i < size(); i++)
285       if (threads[i]->is_available_to(master))
286           return true;
287
288   return false;
289 }
290
291
292 // split() does the actual work of distributing the work at a node between
293 // several available threads. If it does not succeed in splitting the node
294 // (because no idle threads are available, or because we have no unused split
295 // point objects), the function immediately returns. If splitting is possible, a
296 // SplitPoint object is initialized with all the data that must be copied to the
297 // helper threads and then helper threads are told that they have been assigned
298 // work. This will cause them to instantly leave their idle loops and call
299 // search(). When all threads have returned from search() then split() returns.
300
301 template <bool Fake>
302 Value ThreadsManager::split(Position& pos, Stack* ss, Value alpha, Value beta,
303                             Value bestValue, Move* bestMove, Depth depth,
304                             Move threatMove, int moveCount, MovePicker* mp, int nodeType) {
305   assert(pos.pos_is_ok());
306   assert(bestValue > -VALUE_INFINITE);
307   assert(bestValue <= alpha);
308   assert(alpha < beta);
309   assert(beta <= VALUE_INFINITE);
310   assert(depth > DEPTH_ZERO);
311
312   int master = pos.thread();
313   Thread& masterThread = *threads[master];
314
315   if (masterThread.splitPointsCnt >= MAX_SPLITPOINTS_PER_THREAD)
316       return bestValue;
317
318   // Pick the next available split point from the split point stack
319   SplitPoint* sp = &masterThread.splitPoints[masterThread.splitPointsCnt++];
320
321   sp->parent = masterThread.curSplitPoint;
322   sp->master = master;
323   sp->cutoff = false;
324   sp->slavesMask = 1ULL << master;
325   sp->depth = depth;
326   sp->bestMove = *bestMove;
327   sp->threatMove = threatMove;
328   sp->alpha = alpha;
329   sp->beta = beta;
330   sp->nodeType = nodeType;
331   sp->bestValue = bestValue;
332   sp->mp = mp;
333   sp->moveCount = moveCount;
334   sp->pos = &pos;
335   sp->nodes = 0;
336   sp->ss = ss;
337
338   assert(masterThread.is_searching);
339
340   masterThread.curSplitPoint = sp;
341   int slavesCnt = 0;
342
343   // Try to allocate available threads and ask them to start searching setting
344   // is_searching flag. This must be done under lock protection to avoid concurrent
345   // allocation of the same slave by another master.
346   lock_grab(sp->lock);
347   lock_grab(splitLock);
348
349   for (int i = 0; i < size() && !Fake; ++i)
350       if (threads[i]->is_available_to(master))
351       {
352           sp->slavesMask |= 1ULL << i;
353           threads[i]->curSplitPoint = sp;
354           threads[i]->is_searching = true; // Slave leaves idle_loop()
355
356           if (useSleepingThreads)
357               threads[i]->wake_up();
358
359           if (++slavesCnt + 1 >= maxThreadsPerSplitPoint) // Master is always included
360               break;
361       }
362
363   lock_release(splitLock);
364   lock_release(sp->lock);
365
366   // Everything is set up. The master thread enters the idle loop, from which
367   // it will instantly launch a search, because its is_searching flag is set.
368   // We pass the split point as a parameter to the idle loop, which means that
369   // the thread will return from the idle loop when all slaves have finished
370   // their work at this split point.
371   if (slavesCnt || Fake)
372   {
373       masterThread.idle_loop(sp);
374
375       // In helpful master concept a master can help only a sub-tree of its split
376       // point, and because here is all finished is not possible master is booked.
377       assert(!masterThread.is_searching);
378   }
379
380   // We have returned from the idle loop, which means that all threads are
381   // finished. Note that setting is_searching and decreasing splitPointsCnt is
382   // done under lock protection to avoid a race with Thread::is_available_to().
383   lock_grab(sp->lock); // To protect sp->nodes
384   lock_grab(splitLock);
385
386   masterThread.is_searching = true;
387   masterThread.splitPointsCnt--;
388   masterThread.curSplitPoint = sp->parent;
389   pos.set_nodes_searched(pos.nodes_searched() + sp->nodes);
390   *bestMove = sp->bestMove;
391
392   lock_release(splitLock);
393   lock_release(sp->lock);
394
395   return sp->bestValue;
396 }
397
398 // Explicit template instantiations
399 template Value ThreadsManager::split<false>(Position&, Stack*, Value, Value, Value, Move*, Depth, Move, int, MovePicker*, int);
400 template Value ThreadsManager::split<true>(Position&, Stack*, Value, Value, Value, Move*, Depth, Move, int, MovePicker*, int);
401
402
403 // ThreadsManager::set_timer() is used to set the timer to trigger after msec
404 // milliseconds. If msec is 0 then timer is stopped.
405
406 void ThreadsManager::set_timer(int msec) {
407
408   lock_grab(timer->sleepLock);
409   timer->maxPly = msec;
410   cond_signal(timer->sleepCond); // Wake up and restart the timer
411   lock_release(timer->sleepLock);
412 }
413
414
415 // ThreadsManager::wait_for_search_finished() waits for main thread to go to
416 // sleep, this means search is finished. Then returns.
417
418 void ThreadsManager::wait_for_search_finished() {
419
420   Thread* main = threads[0];
421   lock_grab(main->sleepLock);
422   while (!main->do_sleep) cond_wait(sleepCond, main->sleepLock);
423   lock_release(main->sleepLock);
424 }
425
426
427 // ThreadsManager::start_searching() is used by UI thread to wake up the main
428 // thread parked in main_loop() and starting a new search. If async is true
429 // then function returns immediately, otherwise caller is blocked waiting for
430 // the search to finish.
431
432 void ThreadsManager::start_searching(const Position& pos, const LimitsType& limits,
433                                      const std::set<Move>& searchMoves, bool async) {
434   wait_for_search_finished();
435
436   Signals.stopOnPonderhit = Signals.firstRootMove = false;
437   Signals.stop = Signals.failedLowAtRoot = false;
438
439   RootPosition.copy(pos, 0);
440   Limits = limits;
441   RootMoves.clear();
442
443   for (MoveList<MV_LEGAL> ml(pos); !ml.end(); ++ml)
444       if (searchMoves.empty() || searchMoves.count(ml.move()))
445           RootMoves.push_back(RootMove(ml.move()));
446
447   threads[0]->wake_up(); // Start main thread
448
449   if (!async)
450       wait_for_search_finished();
451 }