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