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 Copyright (C) 2015-2020 Marco Costalba, Joona Kiiski, Gary Linscott, Tord Romstad
7 Stockfish is free software: you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation, either version 3 of the License, or
10 (at your option) any later version.
12 Stockfish is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with this program. If not, see <http://www.gnu.org/licenses/>.
23 #include <algorithm> // For std::count
28 #include "syzygy/tbprobe.h"
31 ThreadPool Threads; // Global object
34 /// Thread constructor launches the thread and waits until it goes to sleep
35 /// in idle_loop(). Note that 'searching' and 'exit' should be already set.
37 Thread::Thread(size_t n) : idx(n), stdThread(&Thread::idle_loop, this) {
39 wait_for_search_finished();
43 /// Thread destructor wakes up the thread in idle_loop() and waits
44 /// for its termination. Thread should be already waiting.
55 /// Thread::bestMoveCount(Move move) return best move counter for the given root move
57 int Thread::best_move_count(Move move) const {
59 auto rm = std::find(rootMoves.begin() + pvIdx,
60 rootMoves.begin() + pvLast, move);
62 return rm != rootMoves.begin() + pvLast ? rm->bestMoveCount : 0;
65 /// Thread::clear() reset histories, usually before a new game
67 void Thread::clear() {
69 counterMoves.fill(MOVE_NONE);
71 lowPlyHistory.fill(0);
72 captureHistory.fill(0);
74 for (bool inCheck : { false, true })
75 for (StatsType c : { NoCaptures, Captures })
77 for (auto& to : continuationHistory[inCheck][c])
80 continuationHistory[inCheck][c][NO_PIECE][0]->fill(Search::CounterMovePruneThreshold - 1);
84 /// Thread::start_searching() wakes up the thread that will start the search
86 void Thread::start_searching() {
88 std::lock_guard<std::mutex> lk(mutex);
90 cv.notify_one(); // Wake up the thread in idle_loop()
94 /// Thread::wait_for_search_finished() blocks on the condition variable
95 /// until the thread has finished searching.
97 void Thread::wait_for_search_finished() {
99 std::unique_lock<std::mutex> lk(mutex);
100 cv.wait(lk, [&]{ return !searching; });
104 /// Thread::idle_loop() is where the thread is parked, blocked on the
105 /// condition variable, when it has no work to do.
107 void Thread::idle_loop() {
109 // If OS already scheduled us on a different group than 0 then don't overwrite
110 // the choice, eventually we are one of many one-threaded processes running on
111 // some Windows NUMA hardware, for instance in fishtest. To make it simple,
112 // just check if running threads are below a threshold, in this case all this
113 // NUMA machinery is not needed.
114 if (Options["Threads"] > 8)
115 WinProcGroup::bindThisThread(idx);
119 std::unique_lock<std::mutex> lk(mutex);
121 cv.notify_one(); // Wake up anyone waiting for search finished
122 cv.wait(lk, [&]{ return searching; });
133 /// ThreadPool::set() creates/destroys threads to match the requested number.
134 /// Created and launched threads will immediately go to sleep in idle_loop.
135 /// Upon resizing, threads are recreated to allow for binding if necessary.
137 void ThreadPool::set(size_t requested) {
139 if (size() > 0) { // destroy any existing thread(s)
140 main()->wait_for_search_finished();
143 delete back(), pop_back();
146 if (requested > 0) { // create new thread(s)
147 push_back(new MainThread(0));
149 while (size() < requested)
150 push_back(new Thread(size()));
153 // Reallocate the hash with the new threadpool size
154 TT.resize(size_t(Options["Hash"]));
156 // Init thread number dependent search params.
161 /// ThreadPool::clear() sets threadPool data to initial values.
163 void ThreadPool::clear() {
165 for (Thread* th : *this)
168 main()->callsCnt = 0;
169 main()->bestPreviousScore = VALUE_INFINITE;
170 main()->previousTimeReduction = 1.0;
173 /// ThreadPool::start_thinking() wakes up main thread waiting in idle_loop() and
174 /// returns immediately. Main thread will wake up other threads and start the search.
176 void ThreadPool::start_thinking(Position& pos, StateListPtr& states,
177 const Search::LimitsType& limits, bool ponderMode) {
179 main()->wait_for_search_finished();
181 main()->stopOnPonderhit = stop = false;
182 increaseDepth = true;
183 main()->ponder = ponderMode;
184 Search::Limits = limits;
185 Search::RootMoves rootMoves;
187 for (const auto& m : MoveList<LEGAL>(pos))
188 if ( limits.searchmoves.empty()
189 || std::count(limits.searchmoves.begin(), limits.searchmoves.end(), m))
190 rootMoves.emplace_back(m);
192 if (!rootMoves.empty())
193 Tablebases::rank_root_moves(pos, rootMoves);
195 // After ownership transfer 'states' becomes empty, so if we stop the search
196 // and call 'go' again without setting a new position states.get() == NULL.
197 assert(states.get() || setupStates.get());
200 setupStates = std::move(states); // Ownership transfer, states is now empty
202 // We use Position::set() to set root position across threads. But there are
203 // some StateInfo fields (previous, pliesFromNull, capturedPiece) that cannot
204 // be deduced from a fen string, so set() clears them and to not lose the info
205 // we need to backup and later restore setupStates->back(). Note that setupStates
206 // is shared by threads but is accessed in read-only mode.
207 StateInfo tmp = setupStates->back();
209 for (Thread* th : *this)
211 th->nodes = th->tbHits = th->nmpMinPly = th->bestMoveChanges = 0;
212 th->rootDepth = th->completedDepth = 0;
213 th->rootMoves = rootMoves;
214 th->rootPos.set(pos.fen(), pos.is_chess960(), &setupStates->back(), th);
217 setupStates->back() = tmp;
219 main()->start_searching();
222 Thread* ThreadPool::get_best_thread() const {
224 Thread* bestThread = front();
225 std::map<Move, int64_t> votes;
226 Value minScore = VALUE_NONE;
228 // Find minimum score of all threads
229 for (Thread* th: *this)
230 minScore = std::min(minScore, th->rootMoves[0].score);
232 // Vote according to score and depth, and select the best thread
233 for (Thread* th : *this)
235 votes[th->rootMoves[0].pv[0]] +=
236 (th->rootMoves[0].score - minScore + 14) * int(th->completedDepth);
238 if (abs(bestThread->rootMoves[0].score) >= VALUE_TB_WIN_IN_MAX_PLY)
240 // Make sure we pick the shortest mate / TB conversion or stave off mate the longest
241 if (th->rootMoves[0].score > bestThread->rootMoves[0].score)
244 else if ( th->rootMoves[0].score >= VALUE_TB_WIN_IN_MAX_PLY
245 || ( th->rootMoves[0].score > VALUE_TB_LOSS_IN_MAX_PLY
246 && votes[th->rootMoves[0].pv[0]] > votes[bestThread->rootMoves[0].pv[0]]))
253 /// Start non-main threads.
255 void ThreadPool::start_searching() {
257 for (Thread* th : *this)
259 th->start_searching();
262 /// Wait for non-main threads.
264 void ThreadPool::wait_for_search_finished() const {
266 for (Thread* th : *this)
268 th->wait_for_search_finished();