90ec274d82052827dda6bd891534bd69e523b4f5
[stockfish] / src / thread.cpp
1 /*
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-2019 Marco Costalba, Joona Kiiski, Gary Linscott, Tord Romstad
6
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.
11
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.
16
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/>.
19 */
20
21 #include <cassert>
22
23 #include <algorithm> // For std::count
24 #include "movegen.h"
25 #include "search.h"
26 #include "thread.h"
27 #include "uci.h"
28 #include "syzygy/tbprobe.h"
29 #include "tt.h"
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 /// Thread::bestMoveCount(Move move) return best move counter for the given root move
56
57 int Thread::best_move_count(Move move) {
58
59   auto rm = std::find(rootMoves.begin() + pvIdx,
60                       rootMoves.begin() + pvLast, move);
61
62   return rm != rootMoves.begin() + pvLast ? rm->bestMoveCount : 0;
63 }
64
65 /// Thread::clear() reset histories, usually before a new game
66
67 void Thread::clear() {
68
69   counterMoves.fill(MOVE_NONE);
70   mainHistory.fill(0);
71   captureHistory.fill(0);
72
73   for (auto& to : continuationHistory)
74       for (auto& h : to)
75           h->fill(0);
76
77   continuationHistory[NO_PIECE][0]->fill(Search::CounterMovePruneThreshold - 1);
78 }
79
80 /// Thread::start_searching() wakes up the thread that will start the search
81
82 void Thread::start_searching() {
83
84   std::lock_guard<std::mutex> lk(mutex);
85   searching = true;
86   cv.notify_one(); // Wake up the thread in idle_loop()
87 }
88
89
90 /// Thread::wait_for_search_finished() blocks on the condition variable
91 /// until the thread has finished searching.
92
93 void Thread::wait_for_search_finished() {
94
95   std::unique_lock<std::mutex> lk(mutex);
96   cv.wait(lk, [&]{ return !searching; });
97 }
98
99
100 /// Thread::idle_loop() is where the thread is parked, blocked on the
101 /// condition variable, when it has no work to do.
102
103 void Thread::idle_loop() {
104
105   // If OS already scheduled us on a different group than 0 then don't overwrite
106   // the choice, eventually we are one of many one-threaded processes running on
107   // some Windows NUMA hardware, for instance in fishtest. To make it simple,
108   // just check if running threads are below a threshold, in this case all this
109   // NUMA machinery is not needed.
110   if (Options["Threads"] > 8)
111       WinProcGroup::bindThisThread(idx);
112
113   while (true)
114   {
115       std::unique_lock<std::mutex> lk(mutex);
116       searching = false;
117       cv.notify_one(); // Wake up anyone waiting for search finished
118       cv.wait(lk, [&]{ return searching; });
119
120       if (exit)
121           return;
122
123       lk.unlock();
124
125       search();
126   }
127 }
128
129 /// ThreadPool::set() creates/destroys threads to match the requested number.
130 /// Created and launched threads will immediately go to sleep in idle_loop.
131 /// Upon resizing, threads are recreated to allow for binding if necessary.
132
133 void ThreadPool::set(size_t requested) {
134
135   if (size() > 0) { // destroy any existing thread(s)
136       main()->wait_for_search_finished();
137
138       while (size() > 0)
139           delete back(), pop_back();
140   }
141
142   if (requested > 0) { // create new thread(s)
143       push_back(new MainThread(0));
144
145       while (size() < requested)
146           push_back(new Thread(size()));
147       clear();
148
149       // Reallocate the hash with the new threadpool size
150       TT.resize(Options["Hash"]);
151
152       // Init thread number dependent search params.
153       Search::init();
154   }
155 }
156
157 /// ThreadPool::clear() sets threadPool data to initial values.
158
159 void ThreadPool::clear() {
160
161   for (Thread* th : *this)
162       th->clear();
163
164   main()->callsCnt = 0;
165   main()->previousScore = VALUE_INFINITE;
166   main()->previousTimeReduction = 1.0;
167 }
168
169 /// ThreadPool::start_thinking() wakes up main thread waiting in idle_loop() and
170 /// returns immediately. Main thread will wake up other threads and start the search.
171
172 void ThreadPool::start_thinking(Position& pos, StateListPtr& states,
173                                 const Search::LimitsType& limits, bool ponderMode) {
174
175   main()->wait_for_search_finished();
176
177   main()->stopOnPonderhit = stop = false;
178   main()->ponder = ponderMode;
179   Search::Limits = limits;
180   Search::RootMoves rootMoves;
181
182   for (const auto& m : MoveList<LEGAL>(pos))
183       if (   limits.searchmoves.empty()
184           || std::count(limits.searchmoves.begin(), limits.searchmoves.end(), m))
185           rootMoves.emplace_back(m);
186
187   if (!rootMoves.empty())
188       Tablebases::rank_root_moves(pos, rootMoves);
189
190   // After ownership transfer 'states' becomes empty, so if we stop the search
191   // and call 'go' again without setting a new position states.get() == NULL.
192   assert(states.get() || setupStates.get());
193
194   if (states.get())
195       setupStates = std::move(states); // Ownership transfer, states is now empty
196
197   // We use Position::set() to set root position across threads. But there are
198   // some StateInfo fields (previous, pliesFromNull, capturedPiece) that cannot
199   // be deduced from a fen string, so set() clears them and to not lose the info
200   // we need to backup and later restore setupStates->back(). Note that setupStates
201   // is shared by threads but is accessed in read-only mode.
202   StateInfo tmp = setupStates->back();
203
204   for (Thread* th : *this)
205   {
206       th->shuffleExts = th->nodes = th->tbHits = th->nmpMinPly = 0;
207       th->rootDepth = th->completedDepth = DEPTH_ZERO;
208       th->rootMoves = rootMoves;
209       th->rootPos.set(pos.fen(), pos.is_chess960(), &setupStates->back(), th);
210   }
211
212   setupStates->back() = tmp;
213
214   main()->start_searching();
215 }