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