2fd3c7aa9e37fbfc24b579ddd2f89d33dbb6d983
[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    std::thread* th = new T;
42    *th = std::thread(&T::idle_loop, (T*)th); // Will go to sleep
43    return (T*)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->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<Mutex> lk(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<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 = 0;
85   splitPointsSize = 0;
86   activeSplitPoint = nullptr;
87   activePosition = nullptr;
88   idx = Threads.size(); // Starts from 0
89 }
90
91
92 // Thread::cutoff_occurred() checks whether a beta cutoff has occurred in the
93 // current active split point, or in some ancestor of the split point.
94
95 bool Thread::cutoff_occurred() const {
96
97   for (SplitPoint* sp = activeSplitPoint; sp; sp = sp->parentSplitPoint)
98       if (sp->cutoff)
99           return true;
100
101   return false;
102 }
103
104
105 // Thread::can_join() checks whether the thread is available to join the split
106 // point 'sp'. An obvious requirement is that thread must be idle. With more than
107 // two threads, this is not sufficient: If the thread is the master of some split
108 // point, it is only available as a slave for the split points below his active
109 // one (the "helpful master" concept in YBWC terminology).
110
111 bool Thread::can_join(const SplitPoint* sp) 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 size_t 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(sp->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.spinlock.acquire(); // No contention here until we don't increment splitPointsSize
148
149   sp.master = this;
150   sp.parentSplitPoint = activeSplitPoint;
151   sp.slavesMask = 0, sp.slavesMask.set(idx);
152   sp.depth = depth;
153   sp.bestValue = *bestValue;
154   sp.bestMove = *bestMove;
155   sp.alpha = alpha;
156   sp.beta = beta;
157   sp.nodeType = nodeType;
158   sp.cutNode = cutNode;
159   sp.movePicker = movePicker;
160   sp.moveCount = moveCount;
161   sp.pos = &pos;
162   sp.nodes = 0;
163   sp.cutoff = false;
164   sp.ss = ss;
165   sp.allSlavesSearching = true; // Must be set under lock protection
166
167   ++splitPointsSize;
168   activeSplitPoint = &sp;
169   activePosition = nullptr;
170
171   // Try to allocate available threads
172   Thread* slave;
173
174   while (    sp.slavesMask.count() < MAX_SLAVES_PER_SPLITPOINT
175          && (slave = Threads.available_slave(&sp)) != nullptr)
176   {
177      slave->spinlock.acquire();
178
179       if (slave->can_join(activeSplitPoint))
180       {
181           activeSplitPoint->slavesMask.set(slave->idx);
182           slave->activeSplitPoint = activeSplitPoint;
183           slave->searching = true;
184       }
185
186       slave->spinlock.release();
187   }
188
189   // Everything is set up. The master thread enters the idle loop, from which
190   // it will instantly launch a search, because its 'searching' flag is set.
191   // The thread will return from the idle loop when all slaves have finished
192   // their work at this split point.
193   sp.spinlock.release();
194
195   Thread::idle_loop(); // Force a call to base class idle_loop()
196
197   // In the helpful master concept, a master can help only a sub-tree of its
198   // split point and because everything is finished here, it's not possible
199   // for the master to be booked.
200   assert(!searching);
201   assert(!activePosition);
202
203   searching = true;
204
205   // We have returned from the idle loop, which means that all threads are
206   // finished. Note that decreasing splitPointsSize must be done under lock
207   // protection to avoid a race with Thread::can_join().
208   sp.spinlock.acquire();
209
210   --splitPointsSize;
211   activeSplitPoint = sp.parentSplitPoint;
212   activePosition = &pos;
213   pos.set_nodes_searched(pos.nodes_searched() + sp.nodes);
214   *bestMove = sp.bestMove;
215   *bestValue = sp.bestValue;
216
217   sp.spinlock.release();
218 }
219
220
221 // TimerThread::idle_loop() is where the timer thread waits Resolution milliseconds
222 // and then calls check_time(). When not searching, thread sleeps until it's woken up.
223
224 void TimerThread::idle_loop() {
225
226   while (!exit)
227   {
228       std::unique_lock<Mutex> lk(mutex);
229
230       if (!exit)
231           sleepCondition.wait_for(lk, std::chrono::milliseconds(run ? Resolution : INT_MAX));
232
233       lk.unlock();
234
235       if (run)
236           check_time();
237   }
238 }
239
240
241 // MainThread::idle_loop() is where the main thread is parked waiting to be started
242 // when there is a new search. The main thread will launch all the slave threads.
243
244 void MainThread::idle_loop() {
245
246   while (!exit)
247   {
248       std::unique_lock<Mutex> lk(mutex);
249
250       thinking = false;
251
252       while (!thinking && !exit)
253       {
254           sleepCondition.notify_one(); // Wake up the UI thread if needed
255           sleepCondition.wait(lk);
256       }
257
258       lk.unlock();
259
260       if (!exit)
261       {
262           searching = true;
263
264           Search::think();
265
266           assert(searching);
267
268           searching = false;
269       }
270   }
271 }
272
273
274 // MainThread::join() waits for main thread to finish the search
275
276 void MainThread::join() {
277
278   std::unique_lock<Mutex> lk(mutex);
279   sleepCondition.wait(lk, [&]{ return !thinking; });
280 }
281
282
283 // ThreadPool::init() is called at startup to create and launch requested threads,
284 // that will go immediately to sleep. We cannot use a c'tor because Threads is a
285 // static object and we need a fully initialized engine at this point due to
286 // allocation of Endgames in Thread c'tor.
287
288 void ThreadPool::init() {
289
290   timer = new_thread<TimerThread>();
291   push_back(new_thread<MainThread>());
292   read_uci_options();
293 }
294
295
296 // ThreadPool::exit() terminates the threads before the program exits. Cannot be
297 // done in d'tor because threads must be terminated before freeing us.
298
299 void ThreadPool::exit() {
300
301   delete_thread(timer); // As first because check_time() accesses threads data
302   timer = nullptr;
303
304   for (Thread* th : *this)
305       delete_thread(th);
306
307   clear(); // Get rid of stale pointers
308 }
309
310
311 // ThreadPool::read_uci_options() updates internal threads parameters from the
312 // corresponding UCI options and creates/destroys threads to match the requested
313 // number. Thread objects are dynamically allocated to avoid creating all possible
314 // threads in advance (which include pawns and material tables), even if only a
315 // few are to be used.
316
317 void ThreadPool::read_uci_options() {
318
319   minimumSplitDepth = Options["Min Split Depth"] * ONE_PLY;
320   size_t requested  = Options["Threads"];
321
322   assert(requested > 0);
323
324   // If zero (default) then set best minimum split depth automatically
325   if (!minimumSplitDepth)
326       minimumSplitDepth = requested < 8 ? 4 * ONE_PLY : 7 * ONE_PLY;
327
328   while (size() < requested)
329       push_back(new_thread<Thread>());
330
331   while (size() > requested)
332   {
333       delete_thread(back());
334       pop_back();
335   }
336 }
337
338
339 // ThreadPool::available_slave() tries to find an idle thread which is available
340 // to join SplitPoint 'sp'.
341
342 Thread* ThreadPool::available_slave(const SplitPoint* sp) const {
343
344   for (Thread* th : *this)
345       if (th->can_join(sp))
346           return th;
347
348   return nullptr;
349 }
350
351
352 // ThreadPool::start_thinking() wakes up the main thread sleeping in
353 // MainThread::idle_loop() and starts a new search, then returns immediately.
354
355 void ThreadPool::start_thinking(const Position& pos, const LimitsType& limits,
356                                 StateStackPtr& states) {
357   main()->join();
358
359   Signals.stopOnPonderhit = Signals.firstRootMove = false;
360   Signals.stop = Signals.failedLowAtRoot = false;
361
362   RootMoves.clear();
363   RootPos = pos;
364   Limits = limits;
365   if (states.get()) // If we don't set a new position, preserve current state
366   {
367       SetupStates = std::move(states); // Ownership transfer here
368       assert(!states.get());
369   }
370
371   for (const auto& m : MoveList<LEGAL>(pos))
372       if (   limits.searchmoves.empty()
373           || std::count(limits.searchmoves.begin(), limits.searchmoves.end(), m))
374           RootMoves.push_back(RootMove(m));
375
376   main()->thinking = true;
377   main()->notify_one(); // Wake up main thread: 'thinking' must be already set
378 }