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
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.
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.
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/>.
20 #include <algorithm> // For std::count
28 using namespace Search;
30 ThreadPool Threads; // Global object
32 extern void check_time();
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().
39 extern "C" { long start_routine(ThreadBase* th) { th->idle_loop(); return 0; } }
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.
46 template<typename T> T* new_thread() {
48 thread_create(th->handle, start_routine, th); // Will go to sleep
52 void delete_thread(ThreadBase* th) {
55 th->exit = true; // Search must be already finished
59 thread_join(th->handle); // Wait for thread termination
66 // ThreadBase::notify_one() wakes up the thread when there is some work to do
68 void ThreadBase::notify_one() {
71 sleepCondition.notify_one();
76 // ThreadBase::wait_for() set the thread to sleep until 'condition' turns true
78 void ThreadBase::wait_for(volatile const bool& condition) {
81 while (!condition) sleepCondition.wait(mutex);
86 // Thread c'tor makes some init but does not launch any execution thread that
87 // will be started only when c'tor returns.
89 Thread::Thread() /* : splitPoints() */ { // Initialization of non POD broken in MSVC
92 maxPly = splitPointsSize = 0;
93 activeSplitPoint = NULL;
94 activePosition = NULL;
95 idx = Threads.size(); // Starts from 0
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.
102 bool Thread::cutoff_occurred() const {
104 for (SplitPoint* sp = activeSplitPoint; sp; sp = sp->parentSplitPoint)
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).
119 bool Thread::available_to(const Thread* master) const {
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;
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);
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.
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) {
148 assert(-VALUE_INFINITE < *bestValue && *bestValue <= alpha && alpha < beta && beta <= VALUE_INFINITE);
149 assert(depth >= Threads.minimumSplitDepth);
150 assert(splitPointsSize < MAX_SPLITPOINTS_PER_THREAD);
152 // Pick and init the next available split point
153 SplitPoint& sp = splitPoints[splitPointsSize];
155 sp.masterThread = this;
156 sp.parentSplitPoint = activeSplitPoint;
157 sp.spLevel = activeSplitPoint ? activeSplitPoint->spLevel + 1 : 0;
158 sp.slavesMask = 0, sp.slavesMask.set(idx);
161 sp.bestValue = *bestValue;
162 sp.bestMove = *bestMove;
165 sp.nodeType = nodeType;
166 sp.cutNode = cutNode;
167 sp.movePicker = movePicker;
168 sp.moveCount = moveCount;
174 // Try to allocate available threads and ask them to start searching setting
175 // 'searching' flag. This must be done under lock protection to avoid concurrent
176 // allocation of the same slave by another master.
177 Threads.mutex.lock();
180 sp.allSlavesSearching = true; // Must be set under lock protection
182 activeSplitPoint = &sp;
183 activePosition = NULL;
187 while ( sp.slavesCount < MAX_SLAVES_PER_SPLITPOINT
188 && (slave = Threads.available_slave(this)) != NULL)
190 sp.slavesMask.set(slave->idx);
192 slave->activeSplitPoint = &sp;
193 slave->searching = true; // Slave leaves idle_loop()
194 slave->notify_one(); // Could be sleeping
197 // Everything is set up. The master thread enters the idle loop, from which
198 // it will instantly launch a search, because its 'searching' flag is set.
199 // The thread will return from the idle loop when all slaves have finished
200 // their work at this split point.
202 Threads.mutex.unlock();
204 Thread::idle_loop(); // Force a call to base class idle_loop()
206 // In the helpful master concept, a master can help only a sub-tree of its
207 // split point and because everything is finished here, it's not possible
208 // for the master to be booked.
210 assert(!activePosition);
212 // We have returned from the idle loop, which means that all threads are
213 // finished. Note that setting 'searching' and decreasing splitPointsSize must
214 // be done under lock protection to avoid a race with Thread::available_to().
215 Threads.mutex.lock();
220 activeSplitPoint = sp.parentSplitPoint;
221 activePosition = &pos;
222 pos.set_nodes_searched(pos.nodes_searched() + sp.nodes);
223 *bestMove = sp.bestMove;
224 *bestValue = sp.bestValue;
227 Threads.mutex.unlock();
231 // TimerThread::idle_loop() is where the timer thread waits Resolution milliseconds
232 // and then calls check_time(). When not searching, thread sleeps until it's woken up.
234 void TimerThread::idle_loop() {
241 sleepCondition.wait_for(mutex, run ? Resolution : INT_MAX);
251 // MainThread::idle_loop() is where the main thread is parked waiting to be started
252 // when there is a new search. The main thread will launch all the slave threads.
254 void MainThread::idle_loop() {
262 while (!thinking && !exit)
264 Threads.sleepCondition.notify_one(); // Wake up the UI thread if needed
265 sleepCondition.wait(mutex);
284 // ThreadPool::init() is called at startup to create and launch requested threads,
285 // that will go immediately to sleep. We cannot use a c'tor because Threads is a
286 // static object and we need a fully initialized engine at this point due to
287 // allocation of Endgames in Thread c'tor.
289 void ThreadPool::init() {
291 timer = new_thread<TimerThread>();
292 push_back(new_thread<MainThread>());
297 // ThreadPool::exit() terminates the threads before the program exits. Cannot be
298 // done in d'tor because threads must be terminated before freeing us.
300 void ThreadPool::exit() {
302 delete_thread(timer); // As first because check_time() accesses threads data
304 for (iterator it = begin(); it != end(); ++it)
309 // ThreadPool::read_uci_options() updates internal threads parameters from the
310 // corresponding UCI options and creates/destroys threads to match the requested
311 // number. Thread objects are dynamically allocated to avoid creating all possible
312 // threads in advance (which include pawns and material tables), even if only a
313 // few are to be used.
315 void ThreadPool::read_uci_options() {
317 minimumSplitDepth = Options["Min Split Depth"] * ONE_PLY;
318 size_t requested = Options["Threads"];
320 assert(requested > 0);
322 // If zero (default) then set best minimum split depth automatically
323 if (!minimumSplitDepth)
324 minimumSplitDepth = requested < 8 ? 4 * ONE_PLY : 7 * ONE_PLY;
326 while (size() < requested)
327 push_back(new_thread<Thread>());
329 while (size() > requested)
331 delete_thread(back());
337 // ThreadPool::available_slave() tries to find an idle thread which is available
338 // as a slave for the thread 'master'.
340 Thread* ThreadPool::available_slave(const Thread* master) const {
342 for (const_iterator it = begin(); it != end(); ++it)
343 if ((*it)->available_to(master))
350 // ThreadPool::wait_for_think_finished() waits for main thread to finish the search
352 void ThreadPool::wait_for_think_finished() {
354 MainThread* th = main();
356 while (th->thinking) sleepCondition.wait(th->mutex);
361 // ThreadPool::start_thinking() wakes up the main thread sleeping in
362 // MainThread::idle_loop() and starts a new search, then returns immediately.
364 void ThreadPool::start_thinking(const Position& pos, const LimitsType& limits,
365 StateStackPtr& states) {
366 wait_for_think_finished();
368 SearchTime = Time::now(); // As early as possible
370 Signals.stopOnPonderhit = Signals.firstRootMove = false;
371 Signals.stop = Signals.failedLowAtRoot = false;
376 if (states.get()) // If we don't set a new position, preserve current state
378 SetupStates = states; // Ownership transfer here
379 assert(!states.get());
382 for (MoveList<LEGAL> it(pos); *it; ++it)
383 if ( limits.searchmoves.empty()
384 || std::count(limits.searchmoves.begin(), limits.searchmoves.end(), *it))
385 RootMoves.push_back(RootMove(*it));
387 main()->thinking = true;
388 main()->notify_one(); // Starts main thread