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