Per-thread TB hit counters
[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-2016 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 /// Thread constructor launches the thread and then waits until it goes to sleep
33 /// in idle_loop().
34
35 Thread::Thread() {
36
37   resetCalls = exit = false;
38   maxPly = callsCnt = tbHits = 0;
39   history.clear();
40   counterMoves.clear();
41   idx = Threads.size(); // Start from 0
42
43   std::unique_lock<Mutex> lk(mutex);
44   searching = true;
45   nativeThread = std::thread(&Thread::idle_loop, this);
46   sleepCondition.wait(lk, [&]{ return !searching; });
47 }
48
49
50 /// Thread destructor waits for thread termination before returning
51
52 Thread::~Thread() {
53
54   mutex.lock();
55   exit = true;
56   sleepCondition.notify_one();
57   mutex.unlock();
58   nativeThread.join();
59 }
60
61
62 /// Thread::wait_for_search_finished() waits on sleep condition
63 /// until not searching
64
65 void Thread::wait_for_search_finished() {
66
67   std::unique_lock<Mutex> lk(mutex);
68   sleepCondition.wait(lk, [&]{ return !searching; });
69 }
70
71
72 /// Thread::wait() waits on sleep condition until condition is true
73
74 void Thread::wait(std::atomic_bool& condition) {
75
76   std::unique_lock<Mutex> lk(mutex);
77   sleepCondition.wait(lk, [&]{ return bool(condition); });
78 }
79
80
81 /// Thread::start_searching() wakes up the thread that will start the search
82
83 void Thread::start_searching(bool resume) {
84
85   std::unique_lock<Mutex> lk(mutex);
86
87   if (!resume)
88       searching = true;
89
90   sleepCondition.notify_one();
91 }
92
93
94 /// Thread::idle_loop() is where the thread is parked when it has no work to do
95
96 void Thread::idle_loop() {
97
98   while (!exit)
99   {
100       std::unique_lock<Mutex> lk(mutex);
101
102       searching = false;
103
104       while (!searching && !exit)
105       {
106           sleepCondition.notify_one(); // Wake up any waiting thread
107           sleepCondition.wait(lk);
108       }
109
110       lk.unlock();
111
112       if (!exit)
113           search();
114   }
115 }
116
117
118 /// ThreadPool::init() creates and launches requested threads that will go
119 /// immediately to sleep. We cannot use a constructor because Threads is a
120 /// static object and we need a fully initialized engine at this point due to
121 /// allocation of Endgames in the Thread constructor.
122
123 void ThreadPool::init() {
124
125   push_back(new MainThread);
126   read_uci_options();
127 }
128
129
130 /// ThreadPool::exit() terminates threads before the program exits. Cannot be
131 /// done in destructor because threads must be terminated before deleting any
132 /// static objects while still in main().
133
134 void ThreadPool::exit() {
135
136   while (size())
137       delete back(), pop_back();
138 }
139
140
141 /// ThreadPool::read_uci_options() updates internal threads parameters from the
142 /// corresponding UCI options and creates/destroys threads to match requested
143 /// number. Thread objects are dynamically allocated.
144
145 void ThreadPool::read_uci_options() {
146
147   size_t requested = Options["Threads"];
148
149   assert(requested > 0);
150
151   while (size() < requested)
152       push_back(new Thread);
153
154   while (size() > requested)
155       delete back(), pop_back();
156 }
157
158
159 /// ThreadPool::nodes_searched() returns the number of nodes searched
160
161 uint64_t ThreadPool::nodes_searched() {
162
163   uint64_t nodes = 0;
164   for (Thread* th : *this)
165       nodes += th->rootPos.nodes_searched();
166   return nodes;
167 }
168
169
170 /// ThreadPool::tb_hits() returns the number of TB hits
171
172 uint64_t ThreadPool::tb_hits() {
173
174   uint64_t hits = 0;
175   for (Thread* th : *this)
176       hits += th->tbHits;
177   return hits;
178 }
179
180
181 /// ThreadPool::start_thinking() wakes up the main thread sleeping in idle_loop()
182 /// and starts a new search, then returns immediately.
183
184 void ThreadPool::start_thinking(Position& pos, StateListPtr& states,
185                                 const Search::LimitsType& limits) {
186
187   main()->wait_for_search_finished();
188
189   Search::Signals.stopOnPonderhit = Search::Signals.stop = false;
190   Search::Limits = limits;
191   Search::RootMoves rootMoves;
192
193   for (const auto& m : MoveList<LEGAL>(pos))
194       if (   limits.searchmoves.empty()
195           || std::count(limits.searchmoves.begin(), limits.searchmoves.end(), m))
196           rootMoves.push_back(Search::RootMove(m));
197
198   if (!rootMoves.empty())
199       Tablebases::filter_root_moves(pos, rootMoves);
200
201   // After ownership transfer 'states' becomes empty, so if we stop the search
202   // and call 'go' again without setting a new position states.get() == NULL.
203   assert(states.get() || setupStates.get());
204
205   if (states.get())
206       setupStates = std::move(states); // Ownership transfer, states is now empty
207
208   StateInfo tmp = setupStates->back();
209
210   for (Thread* th : Threads)
211   {
212       th->maxPly = 0;
213       th->rootDepth = DEPTH_ZERO;
214       th->rootMoves = rootMoves;
215       th->rootPos.set(pos.fen(), pos.is_chess960(), &setupStates->back(), th);
216   }
217
218   setupStates->back() = tmp; // Restore st->previous, cleared by Position::set()
219
220   main()->start_searching();
221 }