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
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/>.
26 #include "ucioption.h"
28 using namespace Search;
30 ThreadPool Threads; // Global object
32 namespace { extern "C" {
34 // start_routine() is the C function which is called when a new thread
35 // is launched. It is a wrapper to member function pointed by start_fn.
37 long start_routine(Thread* th) { (th->*(th->start_fn))(); return 0; }
42 // Thread c'tor starts a newly-created thread of execution that will call
43 // the idle loop function pointed by start_fn going immediately to sleep.
45 Thread::Thread(Fn fn) : splitPoints() {
47 is_searching = do_exit = false;
48 maxPly = splitPointsCnt = 0;
54 if (!thread_create(handle, start_routine, this))
56 std::cerr << "Failed to create thread number " << idx << std::endl;
62 // Thread d'tor waits for thread termination before to return.
68 do_exit = true; // Search must be already finished
70 thread_join(handle); // Wait for thread termination
74 // Thread::timer_loop() is where the timer thread waits maxPly milliseconds and
75 // then calls check_time(). If maxPly is 0 thread sleeps until is woken up.
76 extern void check_time();
78 void Thread::timer_loop() {
83 sleepCondition.wait_for(mutex, maxPly ? maxPly : INT_MAX);
90 // Thread::main_loop() is where the main thread is parked waiting to be started
91 // when there is a new search. Main thread will launch all the slave threads.
93 void Thread::main_loop() {
99 do_sleep = true; // Always return to sleep after a search
100 is_searching = false;
102 while (do_sleep && !do_exit)
104 Threads.sleepCondition.notify_one(); // Wake up UI thread if needed
105 sleepCondition.wait(mutex);
117 assert(is_searching);
122 // Thread::notify_one() wakes up the thread, normally at the beginning of the
123 // search or, if "sleeping threads" is used at split time.
125 void Thread::notify_one() {
128 sleepCondition.notify_one();
133 // Thread::wait_for() set the thread to sleep until condition 'b' turns true
135 void Thread::wait_for(volatile const bool& b) {
138 while (!b) sleepCondition.wait(mutex);
143 // Thread::cutoff_occurred() checks whether a beta cutoff has occurred in the
144 // current active split point, or in some ancestor of the split point.
146 bool Thread::cutoff_occurred() const {
148 for (SplitPoint* sp = curSplitPoint; sp; sp = sp->parent)
156 // Thread::is_available_to() checks whether the thread is available to help the
157 // thread 'master' at a split point. An obvious requirement is that thread must
158 // be idle. With more than two threads, this is not sufficient: If the thread is
159 // the master of some active split point, it is only available as a slave to the
160 // slaves which are busy searching the split point at the top of slaves split
161 // point stack (the "helpful master concept" in YBWC terminology).
163 bool Thread::is_available_to(Thread* master) const {
168 // Make a local copy to be sure doesn't become zero under our feet while
169 // testing next condition and so leading to an out of bound access.
170 int spCnt = splitPointsCnt;
172 // No active split points means that the thread is available as a slave for any
173 // other thread otherwise apply the "helpful master" concept if possible.
174 return !spCnt || (splitPoints[spCnt - 1].slavesMask & (1ULL << master->idx));
178 // init() is called at startup. Initializes lock and condition variable and
179 // launches requested threads sending them immediately to sleep. We cannot use
180 // a c'tor becuase Threads is a static object and we need a fully initialized
181 // engine at this point due to allocation of endgames in Thread c'tor.
183 void ThreadPool::init() {
185 timer = new Thread(&Thread::timer_loop);
186 threads.push_back(new Thread(&Thread::main_loop));
191 // exit() cleanly terminates the threads before the program exits.
193 void ThreadPool::exit() {
195 delete timer; // As first becuase check_time() accesses threads data
197 for (size_t i = 0; i < threads.size(); i++)
202 // read_uci_options() updates internal threads parameters from the corresponding
203 // UCI options and creates/destroys threads to match the requested number. Thread
204 // objects are dynamically allocated to avoid creating in advance all possible
205 // threads, with included pawns and material tables, if only few are used.
207 void ThreadPool::read_uci_options() {
209 maxThreadsPerSplitPoint = Options["Max Threads per Split Point"];
210 minimumSplitDepth = Options["Min Split Depth"] * ONE_PLY;
211 useSleepingThreads = Options["Use Sleeping Threads"];
212 size_t requested = Options["Threads"];
214 assert(requested > 0);
216 while (threads.size() < requested)
217 threads.push_back(new Thread(&Thread::idle_loop));
219 while (threads.size() > requested)
221 delete threads.back();
227 // available_slave_exists() tries to find an idle thread which is available as
228 // a slave for the thread 'master'.
230 bool ThreadPool::available_slave_exists(Thread* master) const {
232 for (size_t i = 0; i < threads.size(); i++)
233 if (threads[i]->is_available_to(master))
240 // set_timer() is used to set the timer to trigger after msec milliseconds.
241 // If msec is 0 then timer is stopped.
243 void ThreadPool::set_timer(int msec) {
245 timer->maxPly = msec;
246 timer->notify_one(); // Wake up and restart the timer
250 // split() does the actual work of distributing the work at a node between
251 // several available threads. If it does not succeed in splitting the node
252 // (because no idle threads are available, or because we have no unused split
253 // point objects), the function immediately returns. If splitting is possible, a
254 // SplitPoint object is initialized with all the data that must be copied to the
255 // helper threads and then helper threads are told that they have been assigned
256 // work. This will cause them to instantly leave their idle loops and call
257 // search(). When all threads have returned from search() then split() returns.
260 Value ThreadPool::split(Position& pos, Stack* ss, Value alpha, Value beta,
261 Value bestValue, Move* bestMove, Depth depth, Move threatMove,
262 int moveCount, MovePicker& mp, int nodeType) {
264 assert(pos.pos_is_ok());
265 assert(bestValue > -VALUE_INFINITE);
266 assert(bestValue <= alpha);
267 assert(alpha < beta);
268 assert(beta <= VALUE_INFINITE);
269 assert(depth > DEPTH_ZERO);
271 Thread* master = pos.this_thread();
273 if (master->splitPointsCnt >= MAX_SPLITPOINTS_PER_THREAD)
276 // Pick the next available split point from the split point stack
277 SplitPoint& sp = master->splitPoints[master->splitPointsCnt];
279 sp.parent = master->curSplitPoint;
282 sp.slavesMask = 1ULL << master->idx;
284 sp.bestMove = *bestMove;
285 sp.threatMove = threatMove;
288 sp.nodeType = nodeType;
289 sp.bestValue = bestValue;
291 sp.moveCount = moveCount;
296 assert(master->is_searching);
298 master->curSplitPoint = &sp;
301 // Try to allocate available threads and ask them to start searching setting
302 // is_searching flag. This must be done under lock protection to avoid concurrent
303 // allocation of the same slave by another master.
307 for (size_t i = 0; i < threads.size() && !Fake; ++i)
308 if (threads[i]->is_available_to(master))
310 sp.slavesMask |= 1ULL << i;
311 threads[i]->curSplitPoint = &sp;
312 threads[i]->is_searching = true; // Slave leaves idle_loop()
314 if (useSleepingThreads)
315 threads[i]->notify_one();
317 if (++slavesCnt + 1 >= maxThreadsPerSplitPoint) // Master is always included
321 master->splitPointsCnt++;
326 // Everything is set up. The master thread enters the idle loop, from which
327 // it will instantly launch a search, because its is_searching flag is set.
328 // The thread will return from the idle loop when all slaves have finished
329 // their work at this split point.
330 if (slavesCnt || Fake)
334 // In helpful master concept a master can help only a sub-tree of its split
335 // point, and because here is all finished is not possible master is booked.
336 assert(!master->is_searching);
339 // We have returned from the idle loop, which means that all threads are
340 // finished. Note that setting is_searching and decreasing splitPointsCnt is
341 // done under lock protection to avoid a race with Thread::is_available_to().
345 master->is_searching = true;
346 master->splitPointsCnt--;
347 master->curSplitPoint = sp.parent;
348 pos.set_nodes_searched(pos.nodes_searched() + sp.nodes);
349 *bestMove = sp.bestMove;
357 // Explicit template instantiations
358 template Value ThreadPool::split<false>(Position&, Stack*, Value, Value, Value, Move*, Depth, Move, int, MovePicker&, int);
359 template Value ThreadPool::split<true>(Position&, Stack*, Value, Value, Value, Move*, Depth, Move, int, MovePicker&, int);
362 // wait_for_search_finished() waits for main thread to go to sleep, this means
363 // search is finished. Then returns.
365 void ThreadPool::wait_for_search_finished() {
367 Thread* t = main_thread();
369 while (!t->do_sleep) sleepCondition.wait(t->mutex);
374 // start_searching() wakes up the main thread sleeping in main_loop() so to start
375 // a new search, then returns immediately.
377 void ThreadPool::start_searching(const Position& pos, const LimitsType& limits,
378 const std::vector<Move>& searchMoves, StateStackPtr& states) {
379 wait_for_search_finished();
381 SearchTime = Time::now(); // As early as possible
383 Signals.stopOnPonderhit = Signals.firstRootMove = false;
384 Signals.stop = Signals.failedLowAtRoot = false;
388 SetupStates = states; // Ownership transfer here
391 for (MoveList<LEGAL> ml(pos); !ml.end(); ++ml)
392 if (searchMoves.empty() || count(searchMoves.begin(), searchMoves.end(), ml.move()))
393 RootMoves.push_back(RootMove(ml.move()));
395 main_thread()->do_sleep = false;
396 main_thread()->notify_one();