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