Rewrite async I/O
[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 == 0)
42         ((Thread*)thread)->main_loop();
43
44     else if (((Thread*)thread)->threadID == MAX_THREADS)
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 = 1; i < MAX_THREADS; i++) // Ignore main thread
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 end of searching
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; 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].pawnTable.init();
168   threads[0].materialTable.init();
169
170   // Create and launch all the threads, threads will go immediately to sleep
171   for (int i = 0; i <= MAX_THREADS; i++)
172   {
173       threads[i].is_searching = false;
174       threads[i].do_sleep = true;
175       threads[i].threadID = i;
176
177 #if defined(_MSC_VER)
178       threads[i].handle = CreateThread(NULL, 0, start_routine, (LPVOID)&threads[i], 0, NULL);
179       bool ok = (threads[i].handle != NULL);
180 #else
181       bool ok = (pthread_create(&threads[i].handle, NULL, start_routine, (void*)&threads[i]) == 0);
182 #endif
183
184       if (!ok)
185       {
186           std::cerr << "Failed to create thread number " << i << std::endl;
187           ::exit(EXIT_FAILURE);
188       }
189   }
190 }
191
192
193 // exit() is called to cleanly terminate the threads when the program finishes
194
195 void ThreadsManager::exit() {
196
197   for (int i = 0; i <= MAX_THREADS; i++)
198   {
199       threads[i].do_terminate = true;
200       threads[i].wake_up();
201
202       // Wait for slave termination
203 #if defined(_MSC_VER)
204       WaitForSingleObject(threads[i].handle, 0);
205       CloseHandle(threads[i].handle);
206 #else
207       pthread_join(threads[i].handle, NULL);
208 #endif
209
210       // Now we can safely destroy locks and wait conditions
211       lock_destroy(&threads[i].sleepLock);
212       cond_destroy(&threads[i].sleepCond);
213
214       for (int j = 0; j < MAX_ACTIVE_SPLIT_POINTS; j++)
215           lock_destroy(&(threads[i].splitPoints[j].lock));
216   }
217
218   lock_destroy(&threadsLock);
219   cond_destroy(&sleepCond);
220 }
221
222
223 // available_slave_exists() tries to find an idle thread which is available as
224 // a slave for the thread with threadID "master".
225
226 bool ThreadsManager::available_slave_exists(int master) const {
227
228   assert(master >= 0 && master < activeThreads);
229
230   for (int i = 0; i < activeThreads; i++)
231       if (i != master && threads[i].is_available_to(master))
232           return true;
233
234   return false;
235 }
236
237
238 // split_point_finished() checks if all the slave threads of a given split
239 // point have finished searching.
240
241 bool ThreadsManager::split_point_finished(SplitPoint* sp) const {
242
243   for (int i = 0; i < activeThreads; i++)
244       if (sp->is_slave[i])
245           return false;
246
247   return true;
248 }
249
250
251 // split() does the actual work of distributing the work at a node between
252 // several available threads. If it does not succeed in splitting the
253 // node (because no idle threads are available, or because we have no unused
254 // split point objects), the function immediately returns. If splitting is
255 // possible, a SplitPoint object is initialized with all the data that must be
256 // copied to the helper threads and we tell our helper threads that they have
257 // been assigned work. This will cause them to instantly leave their idle loops and
258 // call search().When all threads have returned from search() then split() returns.
259
260 template <bool Fake>
261 Value ThreadsManager::split(Position& pos, SearchStack* ss, Value alpha, Value beta,
262                             Value bestValue, Depth depth, Move threatMove,
263                             int moveCount, MovePicker* mp, int nodeType) {
264   assert(pos.pos_is_ok());
265   assert(bestValue >= -VALUE_INFINITE);
266   assert(bestValue <= alpha);
267   assert(alpha < beta);
268   assert(beta <= VALUE_INFINITE);
269   assert(depth > DEPTH_ZERO);
270   assert(pos.thread() >= 0 && pos.thread() < activeThreads);
271   assert(activeThreads > 1);
272
273   int i, master = pos.thread();
274   Thread& masterThread = threads[master];
275
276   // If we already have too many active split points, don't split
277   if (masterThread.activeSplitPoints >= MAX_ACTIVE_SPLIT_POINTS)
278       return bestValue;
279
280   // Pick the next available split point object from the split point stack
281   SplitPoint* sp = masterThread.splitPoints + masterThread.activeSplitPoints;
282
283   // Initialize the split point object
284   sp->parent = masterThread.splitPoint;
285   sp->master = master;
286   sp->is_betaCutoff = false;
287   sp->depth = depth;
288   sp->threatMove = threatMove;
289   sp->alpha = alpha;
290   sp->beta = beta;
291   sp->nodeType = nodeType;
292   sp->bestValue = bestValue;
293   sp->mp = mp;
294   sp->moveCount = moveCount;
295   sp->pos = &pos;
296   sp->nodes = 0;
297   sp->ss = ss;
298   for (i = 0; i < activeThreads; i++)
299       sp->is_slave[i] = false;
300
301   // If we are here it means we are not available
302   assert(masterThread.is_searching);
303
304   int workersCnt = 1; // At least the master is included
305
306   // Try to allocate available threads and ask them to start searching setting
307   // the state to Thread::WORKISWAITING, this must be done under lock protection
308   // to avoid concurrent allocation of the same slave by another master.
309   lock_grab(&threadsLock);
310
311   for (i = 0; !Fake && i < activeThreads && workersCnt < maxThreadsPerSplitPoint; i++)
312       if (i != master && threads[i].is_available_to(master))
313       {
314           workersCnt++;
315           sp->is_slave[i] = true;
316           threads[i].splitPoint = sp;
317
318           // This makes the slave to exit from idle_loop()
319           threads[i].is_searching = true;
320
321           if (useSleepingThreads)
322               threads[i].wake_up();
323       }
324
325   lock_release(&threadsLock);
326
327   // We failed to allocate even one slave, return
328   if (!Fake && workersCnt == 1)
329       return bestValue;
330
331   masterThread.splitPoint = sp;
332   masterThread.activeSplitPoints++;
333
334   // Everything is set up. The master thread enters the idle loop, from which
335   // it will instantly launch a search, because its is_searching flag is set.
336   // We pass the split point as a parameter to the idle loop, which means that
337   // the thread will return from the idle loop when all slaves have finished
338   // their work at this split point.
339   masterThread.idle_loop(sp);
340
341   // In helpful master concept a master can help only a sub-tree, and
342   // because here is all finished is not possible master is booked.
343   assert(!masterThread.is_searching);
344
345   // We have returned from the idle loop, which means that all threads are
346   // finished. Note that changing state and decreasing activeSplitPoints is done
347   // under lock protection to avoid a race with Thread::is_available_to().
348   lock_grab(&threadsLock);
349
350   masterThread.is_searching = true;
351   masterThread.activeSplitPoints--;
352
353   lock_release(&threadsLock);
354
355   masterThread.splitPoint = sp->parent;
356   pos.set_nodes_searched(pos.nodes_searched() + sp->nodes);
357
358   return sp->bestValue;
359 }
360
361 // Explicit template instantiations
362 template Value ThreadsManager::split<false>(Position&, SearchStack*, Value, Value, Value, Depth, Move, int, MovePicker*, int);
363 template Value ThreadsManager::split<true>(Position&, SearchStack*, Value, Value, Value, Depth, Move, int, MovePicker*, int);
364
365
366 // Thread::timer_loop() is where the timer thread waits maxPly milliseconds
367 // and then calls do_timer_event().
368
369 void Thread::timer_loop() {
370
371   while (!do_terminate)
372   {
373       lock_grab(&sleepLock);
374       timed_wait(&sleepCond, &sleepLock, maxPly ? maxPly : INT_MAX);
375       lock_release(&sleepLock);
376       do_timer_event();
377   }
378 }
379
380
381 // ThreadsManager::set_timer() is used to set the timer to trigger after msec
382 // milliseconds. If msec is 0 then timer is stopped.
383
384 void ThreadsManager::set_timer(int msec) {
385
386   Thread& timer = threads[MAX_THREADS];
387
388   lock_grab(&timer.sleepLock);
389   timer.maxPly = msec;
390   cond_signal(&timer.sleepCond); // Wake up and restart the timer
391   lock_release(&timer.sleepLock);
392 }
393
394
395 // Thread::main_loop() is where the main thread is parked waiting to be started
396 // when there is a new search. Main thread will launch all the slave threads.
397
398 void Thread::main_loop() {
399
400   while (true)
401   {
402       lock_grab(&sleepLock);
403
404       do_sleep = true; // Always return to sleep after a search
405
406       is_searching = false;
407
408       while (do_sleep && !do_terminate)
409       {
410           cond_signal(&Threads.sleepCond); // Wake up UI thread if needed
411           cond_wait(&sleepCond, &sleepLock);
412       }
413
414       is_searching = true;
415
416       lock_release(&sleepLock);
417
418       if (do_terminate)
419           return;
420
421       think(); // Search entry point
422   }
423 }
424
425
426 // ThreadsManager::start_thinking() is used by UI thread to wake up the main
427 // thread parked in main_loop() and starting a new search. If asyncMode is true
428 // then function returns immediately, otherwise caller is blocked waiting for
429 // the search to finish.
430
431 void ThreadsManager::start_thinking(bool asyncMode) {
432
433   Thread& main = threads[0];
434
435   lock_grab(&main.sleepLock);
436
437   // Wait main thread has finished before to launch a new search
438   while (!main.do_sleep)
439       cond_wait(&sleepCond, &main.sleepLock);
440
441   main.do_sleep = false;
442   cond_signal(&main.sleepCond); // Wake up main thread
443
444   if (!asyncMode)
445       cond_wait(&sleepCond, &main.sleepLock);
446
447   lock_release(&main.sleepLock);
448 }