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