Use a timer to avoid polling
[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-2010 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 <iostream>
21
22 #include "search.h"
23 #include "thread.h"
24 #include "ucioption.h"
25
26 ThreadsManager Threads; // Global object definition
27
28 namespace { extern "C" {
29
30  // start_routine() is the C function which is called when a new thread
31  // is launched. It simply calls idle_loop() of the supplied thread. The
32  // last two threads are dedicated to read input from GUI and to mimic a
33  // timer, so they run in listener_loop() and timer_loop() respectively.
34
35 #if defined(_MSC_VER)
36   DWORD WINAPI start_routine(LPVOID thread) {
37 #else
38   void* start_routine(void* thread) {
39 #endif
40
41     if (((Thread*)thread)->threadID == MAX_THREADS)
42         ((Thread*)thread)->listener_loop();
43
44     else if (((Thread*)thread)->threadID == MAX_THREADS + 1)
45         ((Thread*)thread)->timer_loop();
46     else
47         ((Thread*)thread)->idle_loop(NULL);
48
49     return 0;
50   }
51
52 } }
53
54
55 // wake_up() wakes up the thread, normally at the beginning of the search or,
56 // if "sleeping threads" is used, when there is some work to do.
57
58 void Thread::wake_up() {
59
60   lock_grab(&sleepLock);
61   cond_signal(&sleepCond);
62   lock_release(&sleepLock);
63 }
64
65
66 // cutoff_occurred() checks whether a beta cutoff has occurred in the current
67 // active split point, or in some ancestor of the split point.
68
69 bool Thread::cutoff_occurred() const {
70
71   for (SplitPoint* sp = splitPoint; sp; sp = sp->parent)
72       if (sp->is_betaCutoff)
73           return true;
74   return false;
75 }
76
77
78 // is_available_to() checks whether the thread is available to help the thread with
79 // threadID "master" at a split point. An obvious requirement is that thread must be
80 // idle. With more than two threads, this is not by itself sufficient: If the thread
81 // is the master of some active split point, it is only available as a slave to the
82 // threads which are busy searching the split point at the top of "slave"'s split
83 // point stack (the "helpful master concept" in YBWC terminology).
84
85 bool Thread::is_available_to(int master) const {
86
87   if (is_searching)
88       return false;
89
90   // Make a local copy to be sure doesn't become zero under our feet while
91   // testing next condition and so leading to an out of bound access.
92   int localActiveSplitPoints = activeSplitPoints;
93
94   // No active split points means that the thread is available as a slave for any
95   // other thread otherwise apply the "helpful master" concept if possible.
96   if (   !localActiveSplitPoints
97       || splitPoints[localActiveSplitPoints - 1].is_slave[master])
98       return true;
99
100   return false;
101 }
102
103
104 // read_uci_options() updates number of active threads and other internal
105 // parameters according to the UCI options values. It is called before
106 // to start a new search.
107
108 void ThreadsManager::read_uci_options() {
109
110   maxThreadsPerSplitPoint = Options["Maximum Number of Threads per Split Point"].value<int>();
111   minimumSplitDepth       = Options["Minimum Split Depth"].value<int>() * ONE_PLY;
112   useSleepingThreads      = Options["Use Sleeping Threads"].value<bool>();
113
114   set_size(Options["Threads"].value<int>());
115 }
116
117
118 // set_size() changes the number of active threads and raises do_sleep flag for
119 // all the unused threads that will go immediately to sleep.
120
121 void ThreadsManager::set_size(int cnt) {
122
123   assert(cnt > 0 && cnt <= MAX_THREADS);
124
125   activeThreads = cnt;
126
127   for (int i = 0; i < MAX_THREADS; i++)
128       if (i < activeThreads)
129       {
130           // Dynamically allocate pawn and material hash tables according to the
131           // number of active threads. This avoids preallocating memory for all
132           // possible threads if only few are used as, for instance, on mobile
133           // devices where memory is scarce and allocating for MAX_THREADS could
134           // even result in a crash.
135           threads[i].pawnTable.init();
136           threads[i].materialTable.init();
137
138           threads[i].do_sleep = false;
139       }
140       else
141           threads[i].do_sleep = true;
142 }
143
144
145 // init() is called during startup. Initializes locks and condition variables
146 // and launches all threads sending them immediately to sleep.
147
148 void ThreadsManager::init() {
149
150   // Initialize sleep condition used to block waiting for GUI input
151   cond_init(&sleepCond);
152
153   // Initialize threads lock, used when allocating slaves during splitting
154   lock_init(&threadsLock);
155
156   // Initialize sleep and split point locks
157   for (int i = 0; i < MAX_THREADS + 2; i++)
158   {
159       lock_init(&threads[i].sleepLock);
160       cond_init(&threads[i].sleepCond);
161
162       for (int j = 0; j < MAX_ACTIVE_SPLIT_POINTS; j++)
163           lock_init(&(threads[i].splitPoints[j].lock));
164   }
165
166   // Initialize main thread's associated data
167   threads[0].is_searching = true;
168   threads[0].threadID = 0;
169   set_size(1); // This makes all the threads but the main to go to sleep
170
171   // Create and launch all the threads but the main that is already running,
172   // threads will go immediately to sleep.
173   for (int i = 1; i < MAX_THREADS + 2; i++)
174   {
175       threads[i].is_searching = false;
176       threads[i].threadID = i;
177
178 #if defined(_MSC_VER)
179       threads[i].handle = CreateThread(NULL, 0, start_routine, (LPVOID)&threads[i], 0, NULL);
180       bool ok = (threads[i].handle != NULL);
181 #else
182       bool ok = (pthread_create(&threads[i].handle, NULL, start_routine, (void*)&threads[i]) == 0);
183 #endif
184
185       if (!ok)
186       {
187           std::cerr << "Failed to create thread number " << i << std::endl;
188           ::exit(EXIT_FAILURE);
189       }
190   }
191 }
192
193
194 // exit() is called to cleanly terminate the threads when the program finishes
195
196 void ThreadsManager::exit() {
197
198   for (int i = 0; i < MAX_THREADS + 2; i++)
199   {
200       if (i != 0)
201       {
202           threads[i].do_terminate = true;
203           threads[i].wake_up();
204
205           // Wait for slave termination
206 #if defined(_MSC_VER)
207           WaitForSingleObject(threads[i].handle, 0);
208           CloseHandle(threads[i].handle);
209 #else
210           pthread_join(threads[i].handle, NULL);
211 #endif
212       }
213
214       // Now we can safely destroy locks and wait conditions
215       lock_destroy(&threads[i].sleepLock);
216       cond_destroy(&threads[i].sleepCond);
217
218       for (int j = 0; j < MAX_ACTIVE_SPLIT_POINTS; j++)
219           lock_destroy(&(threads[i].splitPoints[j].lock));
220   }
221
222   lock_destroy(&threadsLock);
223   cond_destroy(&sleepCond);
224 }
225
226
227 // available_slave_exists() tries to find an idle thread which is available as
228 // a slave for the thread with threadID "master".
229
230 bool ThreadsManager::available_slave_exists(int master) const {
231
232   assert(master >= 0 && master < activeThreads);
233
234   for (int i = 0; i < activeThreads; i++)
235       if (i != master && threads[i].is_available_to(master))
236           return true;
237
238   return false;
239 }
240
241
242 // split() does the actual work of distributing the work at a node between
243 // several available threads. If it does not succeed in splitting the
244 // node (because no idle threads are available, or because we have no unused
245 // split point objects), the function immediately returns. If splitting is
246 // possible, a SplitPoint object is initialized with all the data that must be
247 // copied to the helper threads and we tell our helper threads that they have
248 // been assigned work. This will cause them to instantly leave their idle loops and
249 // call search().When all threads have returned from search() then split() returns.
250
251 template <bool Fake>
252 Value ThreadsManager::split(Position& pos, SearchStack* ss, Value alpha, Value beta,
253                             Value bestValue, Depth depth, Move threatMove,
254                             int moveCount, MovePicker* mp, int nodeType) {
255   assert(pos.pos_is_ok());
256   assert(bestValue >= -VALUE_INFINITE);
257   assert(bestValue <= alpha);
258   assert(alpha < beta);
259   assert(beta <= VALUE_INFINITE);
260   assert(depth > DEPTH_ZERO);
261   assert(pos.thread() >= 0 && pos.thread() < activeThreads);
262   assert(activeThreads > 1);
263
264   int i, master = pos.thread();
265   Thread& masterThread = threads[master];
266
267   // If we already have too many active split points, don't split
268   if (masterThread.activeSplitPoints >= MAX_ACTIVE_SPLIT_POINTS)
269       return bestValue;
270
271   // Pick the next available split point object from the split point stack
272   SplitPoint* sp = masterThread.splitPoints + masterThread.activeSplitPoints;
273
274   // Initialize the split point object
275   sp->parent = masterThread.splitPoint;
276   sp->master = master;
277   sp->is_betaCutoff = false;
278   sp->depth = depth;
279   sp->threatMove = threatMove;
280   sp->alpha = alpha;
281   sp->beta = beta;
282   sp->nodeType = nodeType;
283   sp->bestValue = bestValue;
284   sp->mp = mp;
285   sp->moveCount = moveCount;
286   sp->pos = &pos;
287   sp->nodes = 0;
288   sp->ss = ss;
289   for (i = 0; i < activeThreads; i++)
290       sp->is_slave[i] = false;
291
292   // If we are here it means we are not available
293   assert(masterThread.is_searching);
294
295   int workersCnt = 1; // At least the master is included
296
297   // Try to allocate available threads and ask them to start searching setting
298   // the state to Thread::WORKISWAITING, this must be done under lock protection
299   // to avoid concurrent allocation of the same slave by another master.
300   lock_grab(&threadsLock);
301
302   for (i = 0; !Fake && i < activeThreads && workersCnt < maxThreadsPerSplitPoint; i++)
303       if (i != master && threads[i].is_available_to(master))
304       {
305           workersCnt++;
306           sp->is_slave[i] = true;
307           threads[i].splitPoint = sp;
308
309           // This makes the slave to exit from idle_loop()
310           threads[i].is_searching = true;
311
312           if (useSleepingThreads)
313               threads[i].wake_up();
314       }
315
316   lock_release(&threadsLock);
317
318   // We failed to allocate even one slave, return
319   if (!Fake && workersCnt == 1)
320       return bestValue;
321
322   masterThread.splitPoint = sp;
323   masterThread.activeSplitPoints++;
324
325   // Everything is set up. The master thread enters the idle loop, from which
326   // it will instantly launch a search, because its is_searching flag is set.
327   // We pass the split point as a parameter to the idle loop, which means that
328   // the thread will return from the idle loop when all slaves have finished
329   // their work at this split point.
330   masterThread.idle_loop(sp);
331
332   // In helpful master concept a master can help only a sub-tree, and
333   // because here is all finished is not possible master is booked.
334   assert(!masterThread.is_searching);
335
336   // We have returned from the idle loop, which means that all threads are
337   // finished. Note that changing state and decreasing activeSplitPoints is done
338   // under lock protection to avoid a race with Thread::is_available_to().
339   lock_grab(&threadsLock);
340
341   masterThread.is_searching = true;
342   masterThread.activeSplitPoints--;
343
344   lock_release(&threadsLock);
345
346   masterThread.splitPoint = sp->parent;
347   pos.set_nodes_searched(pos.nodes_searched() + sp->nodes);
348
349   return sp->bestValue;
350 }
351
352 // Explicit template instantiations
353 template Value ThreadsManager::split<false>(Position&, SearchStack*, Value, Value, Value, Depth, Move, int, MovePicker*, int);
354 template Value ThreadsManager::split<true>(Position&, SearchStack*, Value, Value, Value, Depth, Move, int, MovePicker*, int);
355
356
357 // Thread::timer_loop() is where the timer thread waits maxPly milliseconds
358 // and then calls do_timer_event().
359
360 void Thread::timer_loop() {
361
362   while (!do_terminate)
363   {
364       lock_grab(&sleepLock);
365       timed_wait(&sleepCond, &sleepLock, maxPly ? maxPly : INT_MAX);
366       lock_release(&sleepLock);
367       do_timer_event();
368   }
369 }
370
371
372 // ThreadsManager::set_timer() is used to set the timer to trigger after msec
373 // milliseconds. If msec is 0 then timer is stopped.
374
375 void ThreadsManager::set_timer(int msec) {
376
377   Thread& timer = threads[MAX_THREADS + 1];
378
379   lock_grab(&timer.sleepLock);
380   timer.maxPly = msec;
381   cond_signal(&timer.sleepCond); // Wake up and restart the timer
382   lock_release(&timer.sleepLock);
383 }
384
385
386 // Thread::listener_loop() is where the listener thread, used for I/O, waits for
387 // input. When is_searching is false then input is read in sync with main thread
388 // (that blocks), otherwise the listener thread reads any input asynchronously
389 // and processes the input line calling do_uci_async_cmd().
390
391 void Thread::listener_loop() {
392
393   std::string cmd;
394
395   while (true)
396   {
397       lock_grab(&sleepLock);
398
399       Threads.inputLine = cmd;
400       do_sleep = !is_searching;
401
402       // Here the thread is parked in sync mode after a line has been read
403       while (do_sleep && !do_terminate) // Catches spurious wake ups
404       {
405           cond_signal(&Threads.sleepCond);   // Wake up main thread
406           cond_wait(&sleepCond, &sleepLock); // Sleep here
407       }
408
409       lock_release(&sleepLock);
410
411       if (do_terminate)
412           return;
413
414       if (!std::getline(std::cin, cmd)) // Block waiting for input
415           cmd = "quit";
416
417       lock_grab(&sleepLock);
418
419       // If we are in async mode then process the command now
420       if (is_searching)
421       {
422           // Command "quit" is the last one received by the GUI, so park the
423           // thread waiting for exiting.
424           if (cmd == "quit")
425               is_searching = false;
426
427           do_uci_async_cmd(cmd);
428           cmd = ""; // Input has been consumed
429       }
430
431       lock_release(&sleepLock);
432   }
433 }
434
435
436 // ThreadsManager::getline() is used by main thread to block and wait for input,
437 // the behaviour mimics std::getline().
438
439 void ThreadsManager::getline(std::string& cmd) {
440
441   Thread& listener = threads[MAX_THREADS];
442
443   lock_grab(&listener.sleepLock);
444
445   listener.is_searching = false; // Set sync mode
446
447   // If there is already some input to grab then skip without to wake up the
448   // listener. This can happen if after we send the "bestmove", the GUI sends
449   // a command that the listener buffers in inputLine before going to sleep.
450   if (inputLine.empty())
451   {
452       listener.do_sleep = false;
453       cond_signal(&listener.sleepCond); // Wake up listener thread
454
455       while (!listener.do_sleep)
456           cond_wait(&sleepCond, &listener.sleepLock); // Wait for input
457   }
458
459   cmd = inputLine;
460   inputLine = ""; // Input has been consumed
461
462   lock_release(&listener.sleepLock);
463 }
464
465
466 // ThreadsManager::start_listener() is called at the beginning of the search to
467 // swith from sync behaviour (default) to async and so be able to read from UCI
468 // while other threads are searching. This avoids main thread polling for input.
469
470 void ThreadsManager::start_listener() {
471
472   Thread& listener = threads[MAX_THREADS];
473
474   lock_grab(&listener.sleepLock);
475   listener.is_searching = true;
476   listener.do_sleep = false;
477   cond_signal(&listener.sleepCond); // Wake up listener thread
478   lock_release(&listener.sleepLock);
479 }
480
481
482 // ThreadsManager::stop_listener() is called before to send "bestmove" to GUI to
483 // return to in-sync behaviour. This is needed because while in async mode any
484 // command is discarded without being processed (except for a very few ones).
485
486 void ThreadsManager::stop_listener() {
487
488   Thread& listener = threads[MAX_THREADS];
489
490   lock_grab(&listener.sleepLock);
491   listener.is_searching = false;
492   lock_release(&listener.sleepLock);
493 }