Merge remote-tracking branch 'upstream/master'
[stockfish] / src / thread.h
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 #ifndef THREAD_H_INCLUDED
20 #define THREAD_H_INCLUDED
21
22 #include <atomic>
23 #include <condition_variable>
24 #include <mutex>
25 #include <thread>
26 #include <vector>
27
28 #include "material.h"
29 #include "movepick.h"
30 #include "pawns.h"
31 #include "position.h"
32 #include "search.h"
33 #include "thread_win32_osx.h"
34
35 namespace Stockfish {
36
37 /// Thread class keeps together all the thread-related stuff. We use
38 /// per-thread pawn and material hash tables so that once we get a
39 /// pointer to an entry its life time is unlimited and we don't have
40 /// to care about someone changing the entry under our feet.
41
42 class Thread {
43
44   std::mutex mutex;
45   std::condition_variable cv;
46   size_t idx;
47   bool exit = false, searching = true; // Set before starting std::thread
48   NativeThread stdThread;
49
50 public:
51   explicit Thread(size_t);
52   virtual ~Thread();
53   virtual void search();
54   void clear();
55   void idle_loop();
56   void start_searching();
57   void wait_for_search_finished();
58   size_t id() const { return idx; }
59
60   Pawns::Table pawnsTable;
61   Material::Table materialTable;
62   size_t pvIdx, pvLast;
63   RunningAverage doubleExtensionAverage[COLOR_NB];
64   uint64_t nodesLastExplosive;
65   uint64_t nodesLastNormal;
66   std::atomic<uint64_t> nodes, tbHits, bestMoveChanges;
67   Value bestValue;
68   int selDepth, nmpMinPly;
69   Color nmpColor;
70   ExplosionState state;
71   Value optimism[COLOR_NB];
72
73   Position rootPos;
74   StateInfo rootState;
75   Search::RootMoves rootMoves;
76   Depth rootDepth, completedDepth;
77   Value rootDelta;
78   CounterMoveHistory counterMoves;
79   ButterflyHistory mainHistory;
80   CapturePieceToHistory captureHistory;
81   ContinuationHistory continuationHistory[2][2];
82   Score trend;
83 };
84
85
86 /// MainThread is a derived class specific for main thread
87
88 struct MainThread : public Thread {
89
90   using Thread::Thread;
91
92   void search() override;
93   void check_time();
94
95   double previousTimeReduction;
96   Value bestPreviousScore;
97   Value bestPreviousAverageScore;
98   Value iterValue[4];
99   int callsCnt;
100   bool stopOnPonderhit;
101   std::atomic_bool ponder;
102 };
103
104
105 /// ThreadPool struct handles all the threads-related stuff like init, starting,
106 /// parking and, most importantly, launching a thread. All the access to threads
107 /// is done through this class.
108
109 struct ThreadPool : public std::vector<Thread*> {
110
111   void start_thinking(Position&, StateListPtr&, const Search::LimitsType&, bool = false);
112   void clear();
113   void set(size_t);
114
115   MainThread* main()        const { return static_cast<MainThread*>(front()); }
116   uint64_t nodes_searched() const { return accumulate(&Thread::nodes); }
117   uint64_t tb_hits()        const { return accumulate(&Thread::tbHits); }
118   Thread* get_best_thread() const;
119   void start_searching();
120   void wait_for_search_finished() const;
121
122   std::atomic_bool stop, increaseDepth;
123
124 private:
125   StateListPtr setupStates;
126
127   uint64_t accumulate(std::atomic<uint64_t> Thread::* member) const {
128
129     uint64_t sum = 0;
130     for (Thread* th : *this)
131         sum += (th->*member).load(std::memory_order_relaxed);
132     return sum;
133   }
134 };
135
136 extern ThreadPool Threads;
137
138 } // namespace Stockfish
139
140 #endif // #ifndef THREAD_H_INCLUDED