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