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