Rework lock protecting
[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   // We have returned from the idle loop, which means that all threads are
204   // finished. Note that decreasing splitPointsSize must be done under lock
205   // protection to avoid a race with Thread::can_join().
206   spinlock.acquire();
207
208   searching = true;
209   --splitPointsSize;
210   activeSplitPoint = sp.parentSplitPoint;
211   activePosition = &pos;
212
213   spinlock.release();
214
215   // Split point data cannot be changed now, so no need to lock protect
216   pos.set_nodes_searched(pos.nodes_searched() + sp.nodes);
217   *bestMove = sp.bestMove;
218   *bestValue = sp.bestValue;
219 }
220
221
222 // TimerThread::idle_loop() is where the timer thread waits Resolution milliseconds
223 // and then calls check_time(). When not searching, thread sleeps until it's woken up.
224
225 void TimerThread::idle_loop() {
226
227   while (!exit)
228   {
229       std::unique_lock<Mutex> lk(mutex);
230
231       if (!exit)
232           sleepCondition.wait_for(lk, std::chrono::milliseconds(run ? Resolution : INT_MAX));
233
234       lk.unlock();
235
236       if (run)
237           check_time();
238   }
239 }
240
241
242 // MainThread::idle_loop() is where the main thread is parked waiting to be started
243 // when there is a new search. The main thread will launch all the slave threads.
244
245 void MainThread::idle_loop() {
246
247   while (!exit)
248   {
249       std::unique_lock<Mutex> lk(mutex);
250
251       thinking = false;
252
253       while (!thinking && !exit)
254       {
255           sleepCondition.notify_one(); // Wake up the UI thread if needed
256           sleepCondition.wait(lk);
257       }
258
259       lk.unlock();
260
261       if (!exit)
262       {
263           searching = true;
264
265           Search::think();
266
267           assert(searching);
268
269           searching = false;
270       }
271   }
272 }
273
274
275 // MainThread::join() waits for main thread to finish the search
276
277 void MainThread::join() {
278
279   std::unique_lock<Mutex> lk(mutex);
280   sleepCondition.wait(lk, [&]{ return !thinking; });
281 }
282
283
284 // ThreadPool::init() is called at startup to create and launch requested threads,
285 // that will go immediately to sleep. We cannot use a c'tor because Threads is a
286 // static object and we need a fully initialized engine at this point due to
287 // allocation of Endgames in Thread c'tor.
288
289 void ThreadPool::init() {
290
291   timer = new_thread<TimerThread>();
292   push_back(new_thread<MainThread>());
293   read_uci_options();
294 }
295
296
297 // ThreadPool::exit() terminates the threads before the program exits. Cannot be
298 // done in d'tor because threads must be terminated before freeing us.
299
300 void ThreadPool::exit() {
301
302   delete_thread(timer); // As first because check_time() accesses threads data
303   timer = nullptr;
304
305   for (Thread* th : *this)
306       delete_thread(th);
307
308   clear(); // Get rid of stale pointers
309 }
310
311
312 // ThreadPool::read_uci_options() updates internal threads parameters from the
313 // corresponding UCI options and creates/destroys threads to match the requested
314 // number. Thread objects are dynamically allocated to avoid creating all possible
315 // threads in advance (which include pawns and material tables), even if only a
316 // few are to be used.
317
318 void ThreadPool::read_uci_options() {
319
320   minimumSplitDepth = Options["Min Split Depth"] * ONE_PLY;
321   size_t requested  = Options["Threads"];
322
323   assert(requested > 0);
324
325   while (size() < requested)
326       push_back(new_thread<Thread>());
327
328   while (size() > requested)
329   {
330       delete_thread(back());
331       pop_back();
332   }
333 }
334
335
336 // ThreadPool::available_slave() tries to find an idle thread which is available
337 // to join SplitPoint 'sp'.
338
339 Thread* ThreadPool::available_slave(const SplitPoint* sp) const {
340
341   for (Thread* th : *this)
342       if (th->can_join(sp))
343           return th;
344
345   return nullptr;
346 }
347
348
349 // ThreadPool::start_thinking() wakes up the main thread sleeping in
350 // MainThread::idle_loop() and starts a new search, then returns immediately.
351
352 void ThreadPool::start_thinking(const Position& pos, const LimitsType& limits,
353                                 StateStackPtr& states) {
354   main()->join();
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 auto& m : MoveList<LEGAL>(pos))
369       if (   limits.searchmoves.empty()
370           || std::count(limits.searchmoves.begin(), limits.searchmoves.end(), m))
371           RootMoves.push_back(RootMove(m));
372
373   main()->thinking = true;
374   main()->notify_one(); // Wake up main thread: 'thinking' must be already set
375 }