7fec4724dc10d6d4d9063ab60eda41c4cca75a3a
[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-2018 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 <algorithm> // For std::count
22 #include <cassert>
23
24 #include "movegen.h"
25 #include "search.h"
26 #include "thread.h"
27 #include "uci.h"
28 #include "syzygy/tbprobe.h"
29
30 ThreadPool Threads; // Global object
31
32
33 /// Thread constructor launches the thread and waits until it goes to sleep
34 /// in idle_loop(). Note that 'searching' and 'exit' should be alredy set.
35
36 Thread::Thread(size_t n) : idx(n), stdThread(&Thread::idle_loop, this) {
37
38   wait_for_search_finished();
39 }
40
41
42 /// Thread destructor wakes up the thread in idle_loop() and waits
43 /// for its termination. Thread should be already waiting.
44
45 Thread::~Thread() {
46
47   assert(!searching);
48
49   exit = true;
50   start_searching();
51   stdThread.join();
52 }
53
54
55 /// Thread::clear() reset histories, usually before a new game
56
57 void Thread::clear() {
58
59   counterMoves.fill(MOVE_NONE);
60   mainHistory.fill(0);
61   captureHistory.fill(0);
62
63   for (auto& to : contHistory)
64       for (auto& h : to)
65           h.get()->fill(0);
66
67   contHistory[NO_PIECE][0].get()->fill(Search::CounterMovePruneThreshold - 1);
68 }
69
70 /// Thread::start_searching() wakes up the thread that will start the search
71
72 void Thread::start_searching() {
73
74   std::lock_guard<Mutex> lk(mutex);
75   searching = true;
76   cv.notify_one(); // Wake up the thread in idle_loop()
77 }
78
79
80 /// Thread::wait_for_search_finished() blocks on the condition variable
81 /// until the thread has finished searching.
82
83 void Thread::wait_for_search_finished() {
84
85   std::unique_lock<Mutex> lk(mutex);
86   cv.wait(lk, [&]{ return !searching; });
87 }
88
89
90 /// Thread::idle_loop() is where the thread is parked, blocked on the
91 /// condition variable, when it has no work to do.
92
93 void Thread::idle_loop() {
94
95   // If OS already scheduled us on a different group than 0 then don't overwrite
96   // the choice, eventually we are one of many one-threaded processes running on
97   // some Windows NUMA hardware, for instance in fishtest. To make it simple,
98   // just check if running threads are below a threshold, in this case all this
99   // NUMA machinery is not needed.
100   if (Options["Threads"] >= 8)
101       WinProcGroup::bindThisThread(idx);
102
103   while (true)
104   {
105       std::unique_lock<Mutex> lk(mutex);
106       searching = false;
107       cv.notify_one(); // Wake up anyone waiting for search finished
108       cv.wait(lk, [&]{ return searching; });
109
110       if (exit)
111           return;
112
113       lk.unlock();
114
115       search();
116   }
117 }
118
119 /// ThreadPool::set() creates/destroys threads to match the requested number.
120 /// Created and launched threads wil go immediately to sleep in idle_loop.
121 /// Upon resizing, threads are recreated to allow for binding if necessary.
122
123 void ThreadPool::set(size_t requested) {
124
125   if (size() > 0) { // destroy any existing thread(s)
126       main()->wait_for_search_finished();
127
128       while (size() > 0)
129           delete back(), pop_back();
130   }
131
132   if (requested > 0) { // create new thread(s)
133       push_back(new MainThread(0));
134
135       while (size() < requested)
136           push_back(new Thread(size()));
137       clear();
138   }
139 }
140
141 /// ThreadPool::clear() sets threadPool data to initial values.
142
143 void ThreadPool::clear() {
144
145   for (Thread* th : *this)
146       th->clear();
147
148   main()->callsCnt = 0;
149   main()->previousScore = VALUE_INFINITE;
150   main()->previousTimeReduction = 1.0;
151 }
152
153 /// ThreadPool::start_thinking() wakes up main thread waiting in idle_loop() and
154 /// returns immediately. Main thread will wake up other threads and start the search.
155
156 void ThreadPool::start_thinking(Position& pos, StateListPtr& states,
157                                 const Search::LimitsType& limits, bool ponderMode) {
158
159   main()->wait_for_search_finished();
160
161   stopOnPonderhit = stop = false;
162   ponder = ponderMode;
163   Search::Limits = limits;
164   Search::RootMoves rootMoves;
165
166   for (const auto& m : MoveList<LEGAL>(pos))
167       if (   limits.searchmoves.empty()
168           || std::count(limits.searchmoves.begin(), limits.searchmoves.end(), m))
169           rootMoves.emplace_back(m);
170
171   if (!rootMoves.empty())
172       Tablebases::rank_root_moves(pos, rootMoves);
173
174   // After ownership transfer 'states' becomes empty, so if we stop the search
175   // and call 'go' again without setting a new position states.get() == NULL.
176   assert(states.get() || setupStates.get());
177
178   if (states.get())
179       setupStates = std::move(states); // Ownership transfer, states is now empty
180
181   // We use Position::set() to set root position across threads. But there are
182   // some StateInfo fields (previous, pliesFromNull, capturedPiece) that cannot
183   // be deduced from a fen string, so set() clears them and to not lose the info
184   // we need to backup and later restore setupStates->back(). Note that setupStates
185   // is shared by threads but is accessed in read-only mode.
186   StateInfo tmp = setupStates->back();
187
188   for (Thread* th : *this)
189   {
190       th->nodes = th->tbHits = th->nmp_ply = th->nmp_odd = 0;
191       th->rootDepth = th->completedDepth = DEPTH_ZERO;
192       th->rootMoves = rootMoves;
193       th->rootPos.set(pos.fen(), pos.is_chess960(), &setupStates->back(), th);
194   }
195
196   setupStates->back() = tmp;
197
198   main()->start_searching();
199 }