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