git.sesse.net Git - stockfish/blob - src/thread.cpp

   1 /*
   2   Stockfish, a UCI chess playing engine derived from Glaurung 2.1
   3   Copyright (C) 2004-2023 The Stockfish developers (see AUTHORS file)
   4
   5   Stockfish is free software: you can redistribute it and/or modify
   6   it under the terms of the GNU General Public License as published by
   7   the Free Software Foundation, either version 3 of the License, or
   8   (at your option) any later version.
   9
  10   Stockfish is distributed in the hope that it will be useful,
  11   but WITHOUT ANY WARRANTY; without even the implied warranty of
  12   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13   GNU General Public License for more details.
  14
  15   You should have received a copy of the GNU General Public License
  16   along with this program.  If not, see <http://www.gnu.org/licenses/>.
  17 */
  18
  19 #include "thread.h"
  20
  21 #include <algorithm>
  22 #include <cassert>
  23 #include <cstdlib>
  24 #include <deque>
  25 #include <initializer_list>
  26 #include <map>
  27 #include <memory>
  28 #include <utility>
  29
  30 #include "evaluate.h"
  31 #include "misc.h"
  32 #include "movegen.h"
  33 #include "search.h"
  34 #include "syzygy/tbprobe.h"
  35 #include "tt.h"
  36 #include "uci.h"
  37
  38 namespace Stockfish {
  39
  40 ThreadPool Threads;  // Global object
  41
  42
  43 // Constructor launches the thread and waits until it goes to sleep
  44 // in idle_loop(). Note that 'searching' and 'exit' should be already set.
  45 Thread::Thread(size_t n) :
  46     idx(n),
  47     stdThread(&Thread::idle_loop, this) {
  48
  49     wait_for_search_finished();
  50 }
  51
  52
  53 // Destructor wakes up the thread in idle_loop() and waits
  54 // for its termination. Thread should be already waiting.
  55 Thread::~Thread() {
  56
  57     assert(!searching);
  58
  59     exit = true;
  60     start_searching();
  61     stdThread.join();
  62 }
  63
  64
  65 // Reset histories, usually before a new game
  66 void Thread::clear() {
  67
  68     counterMoves.fill(MOVE_NONE);
  69     mainHistory.fill(0);
  70     captureHistory.fill(0);
  71
  72     for (bool inCheck : {false, true})
  73         for (StatsType c : {NoCaptures, Captures})
  74             for (auto& to : continuationHistory[inCheck][c])
  75                 for (auto& h : to)
  76                     h->fill(-71);
  77 }
  78
  79
  80 // Wakes up the thread that will start the search
  81 void Thread::start_searching() {
  82     mutex.lock();
  83     searching = true;
  84     mutex.unlock();   // Unlock before notifying saves a few CPU-cycles
  85     cv.notify_one();  // Wake up the thread in idle_loop()
  86 }
  87
  88
  89 // Blocks on the condition variable
  90 // until the thread has finished searching.
  91 void Thread::wait_for_search_finished() {
  92
  93     std::unique_lock<std::mutex> lk(mutex);
  94     cv.wait(lk, [&] { return !searching; });
  95 }
  96
  97
  98 // Thread gets parked here, blocked on the
  99 // condition variable, when it has no work to do.
 100
 101 void Thread::idle_loop() {
 102
 103     // If OS already scheduled us on a different group than 0 then don't overwrite
 104     // the choice, eventually we are one of many one-threaded processes running on
 105     // some Windows NUMA hardware, for instance in fishtest. To make it simple,
 106     // just check if running threads are below a threshold, in this case, all this
 107     // NUMA machinery is not needed.
 108     if (Options["Threads"] > 8)
 109         WinProcGroup::bindThisThread(idx);
 110
 111     while (true)
 112     {
 113         std::unique_lock<std::mutex> lk(mutex);
 114         searching = false;
 115         cv.notify_one();  // Wake up anyone waiting for search finished
 116         cv.wait(lk, [&] { return searching; });
 117
 118         if (exit)
 119             return;
 120
 121         lk.unlock();
 122
 123         search();
 124     }
 125 }
 126
 127 // Creates/destroys threads to match the requested number.
 128 // Created and launched threads will immediately go to sleep in idle_loop.
 129 // Upon resizing, threads are recreated to allow for binding if necessary.
 130 void ThreadPool::set(size_t requested) {
 131
 132     if (threads.size() > 0)  // destroy any existing thread(s)
 133     {
 134         main()->wait_for_search_finished();
 135
 136         while (threads.size() > 0)
 137             delete threads.back(), threads.pop_back();
 138     }
 139
 140     if (requested > 0)  // create new thread(s)
 141     {
 142         threads.push_back(new MainThread(0));
 143
 144         while (threads.size() < requested)
 145             threads.push_back(new Thread(threads.size()));
 146         clear();
 147
 148         // Reallocate the hash with the new threadpool size
 149         TT.resize(size_t(Options["Hash"]));
 150
 151         // Init thread number dependent search params.
 152         Search::init();
 153     }
 154 }
 155
 156
 157 // Sets threadPool data to initial values
 158 void ThreadPool::clear() {
 159
 160     for (Thread* th : threads)
 161         th->clear();
 162
 163     main()->callsCnt                 = 0;
 164     main()->bestPreviousScore        = VALUE_INFINITE;
 165     main()->bestPreviousAverageScore = VALUE_INFINITE;
 166     main()->previousTimeReduction    = 1.0;
 167 }
 168
 169
 170 // Wakes up main thread waiting in idle_loop() and
 171 // returns immediately. Main thread will wake up other threads and start the search.
 172 void ThreadPool::start_thinking(Position&                 pos,
 173                                 StateListPtr&             states,
 174                                 const Search::LimitsType& limits,
 175                                 bool                      ponderMode) {
 176
 177     main()->wait_for_search_finished();
 178
 179     main()->stopOnPonderhit = stop = false;
 180     increaseDepth                  = true;
 181     main()->ponder                 = ponderMode;
 182     Search::Limits                 = limits;
 183     Search::RootMoves rootMoves;
 184
 185     for (const auto& m : MoveList<LEGAL>(pos))
 186         if (limits.searchmoves.empty()
 187             || std::count(limits.searchmoves.begin(), limits.searchmoves.end(), m))
 188             rootMoves.emplace_back(m);
 189
 190     if (!rootMoves.empty())
 191         Tablebases::rank_root_moves(pos, rootMoves);
 192
 193     // After ownership transfer 'states' becomes empty, so if we stop the search
 194     // and call 'go' again without setting a new position states.get() == nullptr.
 195     assert(states.get() || setupStates.get());
 196
 197     if (states.get())
 198         setupStates = std::move(states);  // Ownership transfer, states is now empty
 199
 200     // We use Position::set() to set root position across threads. But there are
 201     // some StateInfo fields (previous, pliesFromNull, capturedPiece) that cannot
 202     // be deduced from a fen string, so set() clears them and they are set from
 203     // setupStates->back() later. The rootState is per thread, earlier states are shared
 204     // since they are read-only.
 205     for (Thread* th : threads)
 206     {
 207         th->nodes = th->tbHits = th->nmpMinPly = th->bestMoveChanges = 0;
 208         th->rootDepth = th->completedDepth = 0;
 209         th->rootMoves                      = rootMoves;
 210         th->rootPos.set(pos.fen(), pos.is_chess960(), &th->rootState, th);
 211         th->rootState      = setupStates->back();
 212         th->rootSimpleEval = Eval::simple_eval(pos, pos.side_to_move());
 213     }
 214
 215     main()->start_searching();
 216 }
 217
 218 Thread* ThreadPool::get_best_thread() const {
 219
 220     Thread*                 bestThread = threads.front();
 221     std::map<Move, int64_t> votes;
 222     Value                   minScore = VALUE_NONE;
 223
 224     // Find the minimum score of all threads
 225     for (Thread* th : threads)
 226         minScore = std::min(minScore, th->rootMoves[0].score);
 227
 228     // Vote according to score and depth, and select the best thread
 229     auto thread_value = [minScore](Thread* th) {
 230         return (th->rootMoves[0].score - minScore + 14) * int(th->completedDepth);
 231     };
 232
 233     for (Thread* th : threads)
 234         votes[th->rootMoves[0].pv[0]] += thread_value(th);
 235
 236     for (Thread* th : threads)
 237         if (abs(bestThread->rootMoves[0].score) >= VALUE_TB_WIN_IN_MAX_PLY)
 238         {
 239             // Make sure we pick the shortest mate / TB conversion or stave off mate the longest
 240             if (th->rootMoves[0].score > bestThread->rootMoves[0].score)
 241                 bestThread = th;
 242         }
 243         else if (th->rootMoves[0].score >= VALUE_TB_WIN_IN_MAX_PLY
 244                  || (th->rootMoves[0].score > VALUE_TB_LOSS_IN_MAX_PLY
 245                      && (votes[th->rootMoves[0].pv[0]] > votes[bestThread->rootMoves[0].pv[0]]
 246                          || (votes[th->rootMoves[0].pv[0]] == votes[bestThread->rootMoves[0].pv[0]]
 247                              && thread_value(th) * int(th->rootMoves[0].pv.size() > 2)
 248                                   > thread_value(bestThread)
 249                                       * int(bestThread->rootMoves[0].pv.size() > 2)))))
 250             bestThread = th;
 251
 252     return bestThread;
 253 }
 254
 255
 256 // Start non-main threads
 257
 258 void ThreadPool::start_searching() {
 259
 260     for (Thread* th : threads)
 261         if (th != threads.front())
 262             th->start_searching();
 263 }
 264
 265
 266 // Wait for non-main threads
 267
 268 void ThreadPool::wait_for_search_finished() const {
 269
 270     for (Thread* th : threads)
 271         if (th != threads.front())
 272             th->wait_for_search_finished();
 273 }
 274
 275 }  // namespace Stockfish