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