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