Small renaming in Thread struct
[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   cond_init(sleepCond);
220   lock_init(splitLock);
221
222   for (int i = 0; i <= MAX_THREADS; i++)
223   {
224       lock_init(threads[i].sleepLock);
225       cond_init(threads[i].sleepCond);
226
227       for (int j = 0; j < MAX_SPLITPOINTS_PER_THREAD; j++)
228           lock_init(threads[i].splitPoints[j].lock);
229   }
230
231   // Allocate main thread tables to call evaluate() also when not searching
232   threads[0].pawnTable.init();
233   threads[0].materialTable.init();
234
235   // Create and launch all the threads, threads will go immediately to sleep
236   for (int i = 0; i <= MAX_THREADS; i++)
237   {
238       threads[i].is_searching = false;
239       threads[i].do_sleep = (i != 0); // Avoid a race with start_thinking()
240       threads[i].threadID = i;
241
242       if (!thread_create(threads[i].handle, start_routine, threads[i]))
243       {
244           std::cerr << "Failed to create thread number " << i << std::endl;
245           ::exit(EXIT_FAILURE);
246       }
247   }
248 }
249
250
251 // exit() is called to cleanly terminate the threads when the program finishes
252
253 void ThreadsManager::exit() {
254
255   for (int i = 0; i <= MAX_THREADS; i++)
256   {
257       assert(threads[i].do_sleep);
258
259       threads[i].do_exit = true; // Search must be already finished
260       threads[i].wake_up();
261
262       thread_join(threads[i].handle); // Wait for thread termination
263
264       lock_destroy(threads[i].sleepLock);
265       cond_destroy(threads[i].sleepCond);
266
267       for (int j = 0; j < MAX_SPLITPOINTS_PER_THREAD; j++)
268           lock_destroy(threads[i].splitPoints[j].lock);
269   }
270
271   lock_destroy(splitLock);
272   cond_destroy(sleepCond);
273 }
274
275
276 // available_slave_exists() tries to find an idle thread which is available as
277 // a slave for the thread with threadID 'master'.
278
279 bool ThreadsManager::available_slave_exists(int master) const {
280
281   assert(master >= 0 && master < activeThreads);
282
283   for (int i = 0; i < activeThreads; i++)
284       if (threads[i].is_available_to(master))
285           return true;
286
287   return false;
288 }
289
290
291 // split() does the actual work of distributing the work at a node between
292 // several available threads. If it does not succeed in splitting the node
293 // (because no idle threads are available, or because we have no unused split
294 // point objects), the function immediately returns. If splitting is possible, a
295 // SplitPoint object is initialized with all the data that must be copied to the
296 // helper threads and then helper threads are told that they have been assigned
297 // work. This will cause them to instantly leave their idle loops and call
298 // search(). When all threads have returned from search() then split() returns.
299
300 template <bool Fake>
301 Value ThreadsManager::split(Position& pos, Stack* ss, Value alpha, Value beta,
302                             Value bestValue, Depth depth, Move threatMove,
303                             int moveCount, MovePicker* mp, int nodeType) {
304   assert(pos.pos_is_ok());
305   assert(bestValue > -VALUE_INFINITE);
306   assert(bestValue <= alpha);
307   assert(alpha < beta);
308   assert(beta <= VALUE_INFINITE);
309   assert(depth > DEPTH_ZERO);
310   assert(pos.thread() >= 0 && pos.thread() < activeThreads);
311   assert(activeThreads > 1);
312
313   int master = pos.thread();
314   Thread& masterThread = threads[master];
315
316   if (masterThread.splitPointsCnt >= MAX_SPLITPOINTS_PER_THREAD)
317       return bestValue;
318
319   // Pick the next available split point from the split point stack
320   SplitPoint* sp = &masterThread.splitPoints[masterThread.splitPointsCnt];
321
322   sp->parent = masterThread.curSplitPoint;
323   sp->master = master;
324   sp->cutoff = false;
325   sp->slavesMask = 1ULL << master;
326   sp->depth = depth;
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   int slavesCnt = 0;
341
342   // Try to allocate available threads and ask them to start searching setting
343   // is_searching flag. This must be done under lock protection to avoid concurrent
344   // allocation of the same slave by another master.
345   lock_grab(sp->lock);
346   lock_grab(splitLock);
347
348   for (int i = 0; i < activeThreads && !Fake; i++)
349       if (threads[i].is_available_to(master))
350       {
351           sp->slavesMask |= 1ULL << i;
352           threads[i].curSplitPoint = sp;
353           threads[i].is_searching = true; // Slave leaves idle_loop()
354
355           if (useSleepingThreads)
356               threads[i].wake_up();
357
358           if (++slavesCnt + 1 >= maxThreadsPerSplitPoint) // Master is always included
359               break;
360       }
361
362   masterThread.curSplitPoint = sp;
363   masterThread.splitPointsCnt++;
364
365   lock_release(splitLock);
366   lock_release(sp->lock);
367
368   // Everything is set up. The master thread enters the idle loop, from which
369   // it will instantly launch a search, because its is_searching flag is set.
370   // We pass the split point as a parameter to the idle loop, which means that
371   // the thread will return from the idle loop when all slaves have finished
372   // their work at this split point.
373   if (slavesCnt || Fake)
374       masterThread.idle_loop(sp);
375
376   // We have returned from the idle loop, which means that all threads are
377   // finished. Note that setting is_searching and decreasing activeSplitPoints is
378   // done under lock protection to avoid a race with Thread::is_available_to().
379   lock_grab(sp->lock); // To protect sp->nodes
380   lock_grab(splitLock);
381
382   masterThread.is_searching = true;
383   masterThread.splitPointsCnt--;
384   masterThread.curSplitPoint = sp->parent;
385   pos.set_nodes_searched(pos.nodes_searched() + sp->nodes);
386
387   lock_release(splitLock);
388   lock_release(sp->lock);
389
390   return sp->bestValue;
391 }
392
393 // Explicit template instantiations
394 template Value ThreadsManager::split<false>(Position&, Stack*, Value, Value, Value, Depth, Move, int, MovePicker*, int);
395 template Value ThreadsManager::split<true>(Position&, Stack*, Value, Value, Value, Depth, Move, int, MovePicker*, int);
396
397
398 // ThreadsManager::set_timer() is used to set the timer to trigger after msec
399 // milliseconds. If msec is 0 then timer is stopped.
400
401 void ThreadsManager::set_timer(int msec) {
402
403   Thread& timer = threads[MAX_THREADS];
404
405   lock_grab(timer.sleepLock);
406   timer.maxPly = msec;
407   cond_signal(timer.sleepCond); // Wake up and restart the timer
408   lock_release(timer.sleepLock);
409 }
410
411
412 // ThreadsManager::start_thinking() is used by UI thread to wake up the main
413 // thread parked in main_loop() and starting a new search. If asyncMode is true
414 // then function returns immediately, otherwise caller is blocked waiting for
415 // the search to finish.
416
417 void ThreadsManager::start_thinking(const Position& pos, const LimitsType& limits,
418                                     const std::set<Move>& searchMoves, bool async) {
419   Thread& main = threads[0];
420
421   lock_grab(main.sleepLock);
422
423   // Wait main thread has finished before to launch a new search
424   while (!main.do_sleep)
425       cond_wait(sleepCond, main.sleepLock);
426
427   // Copy input arguments to initialize the search
428   RootPosition.copy(pos, 0);
429   Limits = limits;
430   RootMoves.clear();
431
432   // Populate RootMoves with all the legal moves (default) or, if a searchMoves
433   // set is given, with the subset of legal moves to search.
434   for (MoveList<MV_LEGAL> ml(pos); !ml.end(); ++ml)
435       if (searchMoves.empty() || searchMoves.count(ml.move()))
436           RootMoves.push_back(RootMove(ml.move()));
437
438   // Reset signals before to start the new search
439   Signals.stopOnPonderhit = Signals.firstRootMove = false;
440   Signals.stop = Signals.failedLowAtRoot = false;
441
442   main.do_sleep = false;
443   cond_signal(main.sleepCond); // Wake up main thread and start searching
444
445   if (!async)
446       while (!main.do_sleep)
447           cond_wait(sleepCond, main.sleepLock);
448
449   lock_release(main.sleepLock);
450 }
451
452
453 // ThreadsManager::stop_thinking() is used by UI thread to raise a stop request
454 // and to wait for the main thread finishing the search. Needed to wait exiting
455 // and terminate the threads after a 'quit' command.
456
457 void ThreadsManager::stop_thinking() {
458
459   Thread& main = threads[0];
460
461   Search::Signals.stop = true;
462
463   lock_grab(main.sleepLock);
464
465   cond_signal(main.sleepCond); // In case is waiting for stop or ponderhit
466
467   while (!main.do_sleep)
468       cond_wait(sleepCond, main.sleepLock);
469
470   lock_release(main.sleepLock);
471 }