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