2b09a69fad957307932a7ed427ea66d285e95c52
[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-2013 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 <algorithm> // For std::count
21 #include <cassert>
22 #include <iostream>
23
24 #include "movegen.h"
25 #include "search.h"
26 #include "thread.h"
27 #include "ucioption.h"
28
29 using namespace Search;
30
31 ThreadPool Threads; // Global object
32
33 namespace { extern "C" {
34
35  // start_routine() is the C function which is called when a new thread
36  // is launched. It is a wrapper to the virtual function idle_loop().
37
38  long start_routine(Thread* th) { th->idle_loop(); return 0; }
39
40 } }
41
42
43 // Thread c'tor starts a newly-created thread of execution that will call
44 // the the virtual function idle_loop(), going immediately to sleep.
45
46 Thread::Thread() /* : splitPoints() */ { // Value-initialization bug in MSVC
47
48   searching = exit = false;
49   maxPly = splitPointsSize = 0;
50   activeSplitPoint = NULL;
51   activePosition = NULL;
52   idx = Threads.size();
53
54   if (!thread_create(handle, start_routine, this))
55   {
56       std::cerr << "Failed to create thread number " << idx << std::endl;
57       ::exit(EXIT_FAILURE);
58   }
59 }
60
61
62 // Thread d'tor waits for thread termination before to return
63
64 Thread::~Thread() {
65
66   exit = true; // Search must be already finished
67   notify_one();
68   thread_join(handle); // Wait for thread termination
69 }
70
71
72 // TimerThread::idle_loop() is where the timer thread waits msec milliseconds
73 // and then calls check_time(). If msec is 0 thread sleeps until is woken up.
74 extern void check_time();
75
76 void TimerThread::idle_loop() {
77
78   while (!exit)
79   {
80       mutex.lock();
81
82       if (!exit)
83           sleepCondition.wait_for(mutex, msec ? msec : INT_MAX);
84
85       mutex.unlock();
86
87       if (msec)
88           check_time();
89   }
90 }
91
92
93 // MainThread::idle_loop() is where the main thread is parked waiting to be started
94 // when there is a new search. Main thread will launch all the slave threads.
95
96 void MainThread::idle_loop() {
97
98   while (true)
99   {
100       mutex.lock();
101
102       thinking = false;
103
104       while (!thinking && !exit)
105       {
106           Threads.sleepCondition.notify_one(); // Wake up UI thread if needed
107           sleepCondition.wait(mutex);
108       }
109
110       mutex.unlock();
111
112       if (exit)
113           return;
114
115       searching = true;
116
117       Search::think();
118
119       assert(searching);
120
121       searching = false;
122   }
123 }
124
125
126 // Thread::notify_one() wakes up the thread when there is some search to do
127
128 void Thread::notify_one() {
129
130   mutex.lock();
131   sleepCondition.notify_one();
132   mutex.unlock();
133 }
134
135
136 // Thread::wait_for() set the thread to sleep until condition 'b' turns true
137
138 void Thread::wait_for(volatile const bool& b) {
139
140   mutex.lock();
141   while (!b) sleepCondition.wait(mutex);
142   mutex.unlock();
143 }
144
145
146 // Thread::cutoff_occurred() checks whether a beta cutoff has occurred in the
147 // current active split point, or in some ancestor of the split point.
148
149 bool Thread::cutoff_occurred() const {
150
151   for (SplitPoint* sp = activeSplitPoint; sp; sp = sp->parentSplitPoint)
152       if (sp->cutoff)
153           return true;
154
155   return false;
156 }
157
158
159 // Thread::is_available_to() checks whether the thread is available to help the
160 // thread 'master' at a split point. An obvious requirement is that thread must
161 // be idle. With more than two threads, this is not sufficient: If the thread is
162 // the master of some split point, it is only available as a slave to the slaves
163 // which are busy searching the split point at the top of slaves split point
164 // stack (the "helpful master concept" in YBWC terminology).
165
166 bool Thread::is_available_to(Thread* master) const {
167
168   if (searching)
169       return false;
170
171   // Make a local copy to be sure doesn't become zero under our feet while
172   // testing next condition and so leading to an out of bound access.
173   int size = splitPointsSize;
174
175   // No split points means that the thread is available as a slave for any
176   // other thread otherwise apply the "helpful master" concept if possible.
177   return !size || (splitPoints[size - 1].slavesMask & (1ULL << master->idx));
178 }
179
180
181 // init() is called at startup to create and launch requested threads, that will
182 // go immediately to sleep due to 'sleepWhileIdle' set to true. We cannot use
183 // a c'tor becuase Threads is a static object and we need a fully initialized
184 // engine at this point due to allocation of Endgames in Thread c'tor.
185
186 void ThreadPool::init() {
187
188   sleepWhileIdle = true;
189   timer = new TimerThread();
190   push_back(new MainThread());
191   read_uci_options();
192 }
193
194
195 // exit() cleanly terminates the threads before the program exits
196
197 void ThreadPool::exit() {
198
199   delete timer; // As first because check_time() accesses threads data
200
201   for (iterator it = begin(); it != end(); ++it)
202       delete *it;
203 }
204
205
206 // read_uci_options() updates internal threads parameters from the corresponding
207 // UCI options and creates/destroys threads to match the requested number. Thread
208 // objects are dynamically allocated to avoid creating in advance all possible
209 // threads, with included pawns and material tables, if only few are used.
210
211 void ThreadPool::read_uci_options() {
212
213   maxThreadsPerSplitPoint = Options["Max Threads per Split Point"];
214   minimumSplitDepth       = Options["Min Split Depth"] * ONE_PLY;
215   size_t requested        = Options["Threads"];
216
217   assert(requested > 0);
218
219   while (size() < requested)
220       push_back(new Thread());
221
222   while (size() > requested)
223   {
224       delete back();
225       pop_back();
226   }
227 }
228
229
230 // slave_available() tries to find an idle thread which is available as a slave
231 // for the thread 'master'.
232
233 Thread* ThreadPool::available_slave(Thread* master) const {
234
235   for (const_iterator it = begin(); it != end(); ++it)
236       if ((*it)->is_available_to(master))
237           return *it;
238
239   return NULL;
240 }
241
242
243 // split() does the actual work of distributing the work at a node between
244 // several available threads. If it does not succeed in splitting the node
245 // (because no idle threads are available), the function immediately returns.
246 // If splitting is possible, a SplitPoint object is initialized with all the
247 // data that must be copied to the helper threads and then helper threads are
248 // told that they have been assigned work. This will cause them to instantly
249 // leave their idle loops and call search(). When all threads have returned from
250 // search() then split() returns.
251
252 template <bool Fake>
253 void Thread::split(Position& pos, Stack* ss, Value alpha, Value beta, Value* bestValue,
254                    Move* bestMove, Depth depth, Move threatMove, int moveCount,
255                    MovePicker* movePicker, int nodeType, bool cutNode) {
256
257   assert(pos.pos_is_ok());
258   assert(*bestValue <= alpha && alpha < beta && beta <= VALUE_INFINITE);
259   assert(*bestValue > -VALUE_INFINITE);
260   assert(depth >= Threads.minimumSplitDepth);
261   assert(searching);
262   assert(splitPointsSize < MAX_SPLITPOINTS_PER_THREAD);
263
264   // Pick the next available split point from the split point stack
265   SplitPoint& sp = splitPoints[splitPointsSize];
266
267   sp.masterThread = this;
268   sp.parentSplitPoint = activeSplitPoint;
269   sp.slavesMask = 1ULL << idx;
270   sp.depth = depth;
271   sp.bestValue = *bestValue;
272   sp.bestMove = *bestMove;
273   sp.threatMove = threatMove;
274   sp.alpha = alpha;
275   sp.beta = beta;
276   sp.nodeType = nodeType;
277   sp.cutNode = cutNode;
278   sp.movePicker = movePicker;
279   sp.moveCount = moveCount;
280   sp.pos = &pos;
281   sp.nodes = 0;
282   sp.cutoff = false;
283   sp.ss = ss;
284
285   // Try to allocate available threads and ask them to start searching setting
286   // 'searching' flag. This must be done under lock protection to avoid concurrent
287   // allocation of the same slave by another master.
288   Threads.mutex.lock();
289   sp.mutex.lock();
290
291   splitPointsSize++;
292   activeSplitPoint = &sp;
293   activePosition = NULL;
294
295   size_t slavesCnt = 1; // This thread is always included
296   Thread* slave;
297
298   while (    (slave = Threads.available_slave(this)) != NULL
299          && ++slavesCnt <= Threads.maxThreadsPerSplitPoint && !Fake)
300   {
301       sp.slavesMask |= 1ULL << slave->idx;
302       slave->activeSplitPoint = &sp;
303       slave->searching = true; // Slave leaves idle_loop()
304       slave->notify_one(); // Could be sleeping
305   }
306
307   // Everything is set up. The master thread enters the idle loop, from which
308   // it will instantly launch a search, because its 'searching' flag is set.
309   // The thread will return from the idle loop when all slaves have finished
310   // their work at this split point.
311   if (slavesCnt > 1 || Fake)
312   {
313       sp.mutex.unlock();
314       Threads.mutex.unlock();
315
316       Thread::idle_loop(); // Force a call to base class idle_loop()
317
318       // In helpful master concept a master can help only a sub-tree of its split
319       // point, and because here is all finished is not possible master is booked.
320       assert(!searching);
321       assert(!activePosition);
322
323       // We have returned from the idle loop, which means that all threads are
324       // finished. Note that setting 'searching' and decreasing splitPointsSize is
325       // done under lock protection to avoid a race with Thread::is_available_to().
326       Threads.mutex.lock();
327       sp.mutex.lock();
328   }
329
330   searching = true;
331   splitPointsSize--;
332   activeSplitPoint = sp.parentSplitPoint;
333   activePosition = &pos;
334   pos.set_nodes_searched(pos.nodes_searched() + sp.nodes);
335   *bestMove = sp.bestMove;
336   *bestValue = sp.bestValue;
337
338   sp.mutex.unlock();
339   Threads.mutex.unlock();
340 }
341
342 // Explicit template instantiations
343 template void Thread::split<false>(Position&, Stack*, Value, Value, Value*, Move*, Depth, Move, int, MovePicker*, int, bool);
344 template void Thread::split< true>(Position&, Stack*, Value, Value, Value*, Move*, Depth, Move, int, MovePicker*, int, bool);
345
346
347 // wait_for_think_finished() waits for main thread to go to sleep then returns
348
349 void ThreadPool::wait_for_think_finished() {
350
351   MainThread* t = main_thread();
352   t->mutex.lock();
353   while (t->thinking) sleepCondition.wait(t->mutex);
354   t->mutex.unlock();
355 }
356
357
358 // start_thinking() wakes up the main thread sleeping in MainThread::idle_loop()
359 // so to start a new search, then returns immediately.
360
361 void ThreadPool::start_thinking(const Position& pos, const LimitsType& limits,
362                                 const std::vector<Move>& searchMoves, StateStackPtr& states) {
363   wait_for_think_finished();
364
365   SearchTime = Time::now(); // As early as possible
366
367   Signals.stopOnPonderhit = Signals.firstRootMove = false;
368   Signals.stop = Signals.failedLowAtRoot = false;
369
370   RootMoves.clear();
371   RootPos = pos;
372   Limits = limits;
373   if (states.get()) // If we don't set a new position, preserve current state
374   {
375       SetupStates = states; // Ownership transfer here
376       assert(!states.get());
377   }
378
379   for (MoveList<LEGAL> it(pos); *it; ++it)
380       if (   searchMoves.empty()
381           || std::count(searchMoves.begin(), searchMoves.end(), *it))
382           RootMoves.push_back(RootMove(*it));
383
384   main_thread()->thinking = true;
385   main_thread()->notify_one(); // Starts main thread
386 }