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