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