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