Even more spelling fixes
[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 the object will 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 and does not launch any execution thread.
81 // Such a thread will only be started when c'tor returns.
82
83 Thread::Thread() /* : splitPoints() */ { // Value-initialization bug in MSVC
84
85   searching = false;
86   maxPly = splitPointsSize = 0;
87   activeSplitPoint = NULL;
88   activePosition = NULL;
89   idx = Threads.size();
90 }
91
92
93 // TimerThread::idle_loop() is where the timer thread waits msec milliseconds
94 // and then calls check_time(). If msec is 0 thread sleeps until it's woken up.
95 extern void check_time();
96
97 void TimerThread::idle_loop() {
98
99   while (!exit)
100   {
101       mutex.lock();
102
103       if (!exit)
104           sleepCondition.wait_for(mutex, run ? Resolution : INT_MAX);
105
106       mutex.unlock();
107
108       if (run)
109           check_time();
110   }
111 }
112
113
114 // MainThread::idle_loop() is where the main thread is parked waiting to be started
115 // when there is a new search. The main thread will launch all the slave threads.
116
117 void MainThread::idle_loop() {
118
119   while (true)
120   {
121       mutex.lock();
122
123       thinking = false;
124
125       while (!thinking && !exit)
126       {
127           Threads.sleepCondition.notify_one(); // Wake up the UI thread if needed
128           sleepCondition.wait(mutex);
129       }
130
131       mutex.unlock();
132
133       if (exit)
134           return;
135
136       searching = true;
137
138       Search::think();
139
140       assert(searching);
141
142       searching = false;
143   }
144 }
145
146
147 // Thread::cutoff_occurred() checks whether a beta cutoff has occurred in the
148 // current active split point, or in some ancestor of the split point.
149
150 bool Thread::cutoff_occurred() const {
151
152   for (SplitPoint* sp = activeSplitPoint; sp; sp = sp->parentSplitPoint)
153       if (sp->cutoff)
154           return true;
155
156   return false;
157 }
158
159
160 // Thread::available_to() checks whether the thread is available to help the
161 // thread 'master' at a split point. An obvious requirement is that thread must
162 // be idle. With more than two threads, this is not sufficient: If the thread is
163 // the master of some split point, it is only available as a slave to the slaves
164 // which are busy searching the split point at the top of slave's split point
165 // stack (the "helpful master concept" in YBWC terminology).
166
167 bool Thread::available_to(const Thread* master) const {
168
169   if (searching)
170       return false;
171
172   // Make a local copy to be sure it doesn't become zero under our feet while
173   // testing next condition and so leading to an out of bounds access.
174   int size = splitPointsSize;
175
176   // No split points means that the thread is available as a slave for any
177   // other thread otherwise apply the "helpful master" concept if possible.
178   return !size || (splitPoints[size - 1].slavesMask & (1ULL << master->idx));
179 }
180
181
182 // init() is called at startup to create and launch requested threads, that will
183 // go immediately to sleep due to 'sleepWhileIdle' set to true. We cannot use
184 // a c'tor because Threads is a static object and we need a fully initialized
185 // engine at this point due to allocation of Endgames in Thread c'tor.
186
187 void ThreadPool::init() {
188
189   sleepWhileIdle = true;
190   timer = new_thread<TimerThread>();
191   push_back(new_thread<MainThread>());
192   read_uci_options();
193 }
194
195
196 // exit() cleanly terminates the threads before the program exits
197
198 void ThreadPool::exit() {
199
200   delete_thread(timer); // As first because check_time() accesses threads data
201
202   for (iterator it = begin(); it != end(); ++it)
203       delete_thread(*it);
204 }
205
206
207 // read_uci_options() updates internal threads parameters from the corresponding
208 // UCI options and creates/destroys threads to match the requested number. Thread
209 // objects are dynamically allocated to avoid creating all possible threads
210 // in advance (which include pawns and material tables), even if only a few
211 // are to be 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)->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 the helpful master concept, a master can help only a sub-tree of its
328       // split point and because everything is finished here, it's not possible
329       // for the master to be booked.
330       assert(!searching);
331       assert(!activePosition);
332
333       // We have returned from the idle loop, which means that all threads are
334       // finished. Note that setting 'searching' and decreasing splitPointsSize is
335       // done under lock protection to avoid a race with Thread::available_to().
336       Threads.mutex.lock();
337       sp.mutex.lock();
338   }
339
340   searching = true;
341   --splitPointsSize;
342   activeSplitPoint = sp.parentSplitPoint;
343   activePosition = &pos;
344   pos.set_nodes_searched(pos.nodes_searched() + sp.nodes);
345   *bestMove = sp.bestMove;
346   *bestValue = sp.bestValue;
347
348   sp.mutex.unlock();
349   Threads.mutex.unlock();
350 }
351
352 // Explicit template instantiations
353 template void Thread::split<false>(Position&, const Stack*, Value, Value, Value*, Move*, Depth, Move, int, MovePicker*, int, bool);
354 template void Thread::split< true>(Position&, const Stack*, Value, Value, Value*, Move*, Depth, Move, int, MovePicker*, int, bool);
355
356
357 // wait_for_think_finished() waits for main thread to go to sleep then returns
358
359 void ThreadPool::wait_for_think_finished() {
360
361   MainThread* t = main();
362   t->mutex.lock();
363   while (t->thinking) sleepCondition.wait(t->mutex);
364   t->mutex.unlock();
365 }
366
367
368 // start_thinking() wakes up the main thread sleeping in MainThread::idle_loop()
369 // so to start a new search, then returns immediately.
370
371 void ThreadPool::start_thinking(const Position& pos, const LimitsType& limits,
372                                 const std::vector<Move>& searchMoves, StateStackPtr& states) {
373   wait_for_think_finished();
374
375   SearchTime = Time::now(); // As early as possible
376
377   Signals.stopOnPonderhit = Signals.firstRootMove = false;
378   Signals.stop = Signals.failedLowAtRoot = false;
379
380   RootMoves.clear();
381   RootPos = pos;
382   Limits = limits;
383   if (states.get()) // If we don't set a new position, preserve current state
384   {
385       SetupStates = states; // Ownership transfer here
386       assert(!states.get());
387   }
388
389   for (MoveList<LEGAL> it(pos); *it; ++it)
390       if (   searchMoves.empty()
391           || std::count(searchMoves.begin(), searchMoves.end(), *it))
392           RootMoves.push_back(RootMove(*it));
393
394   main()->thinking = true;
395   main()->notify_one(); // Starts main thread
396 }