Retire redundant sp->slavesCount field
[stockfish] / src / thread.h
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
6   Stockfish is free software: you can redistribute it and/or modify
7   it under the terms of the GNU General Public License as published by
8   the Free Software Foundation, either version 3 of the License, or
9   (at your option) any later version.
10
11   Stockfish is distributed in the hope that it will be useful,
12   but WITHOUT ANY WARRANTY; without even the implied warranty of
13   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14   GNU General Public License for more details.
15
16   You should have received a copy of the GNU General Public License
17   along with this program.  If not, see <http://www.gnu.org/licenses/>.
18 */
19
20 #ifndef THREAD_H_INCLUDED
21 #define THREAD_H_INCLUDED
22
23 #include <bitset>
24 #include <vector>
25
26 #include "material.h"
27 #include "movepick.h"
28 #include "pawns.h"
29 #include "position.h"
30 #include "search.h"
31
32 struct Thread;
33
34 const int MAX_THREADS = 128;
35 const int MAX_SPLITPOINTS_PER_THREAD = 8;
36 const size_t MAX_SLAVES_PER_SPLITPOINT = 4;
37
38 /// Mutex and ConditionVariable struct are wrappers of the low level locking
39 /// machinery and are modeled after the corresponding C++11 classes.
40
41 struct Mutex {
42   Mutex() { lock_init(l); }
43  ~Mutex() { lock_destroy(l); }
44
45   void lock() { lock_grab(l); }
46   void unlock() { lock_release(l); }
47
48 private:
49   friend struct ConditionVariable;
50
51   Lock l;
52 };
53
54 struct ConditionVariable {
55   ConditionVariable() { cond_init(c); }
56  ~ConditionVariable() { cond_destroy(c); }
57
58   void wait(Mutex& m) { cond_wait(c, m.l); }
59   void wait_for(Mutex& m, int ms) { timed_wait(c, m.l, ms); }
60   void notify_one() { cond_signal(c); }
61
62 private:
63   WaitCondition c;
64 };
65
66
67 /// SplitPoint struct stores information shared by the threads searching in
68 /// parallel below the same split point. It is populated at splitting time.
69
70 struct SplitPoint {
71
72   // Const data after split point has been setup
73   const Position* pos;
74   Search::Stack* ss;
75   Thread* masterThread;
76   Depth depth;
77   Value beta;
78   int nodeType;
79   bool cutNode;
80
81   // Const pointers to shared data
82   MovePicker* movePicker;
83   SplitPoint* parentSplitPoint;
84
85   // Shared variable data
86   Mutex mutex;
87   std::bitset<MAX_THREADS> slavesMask;
88   volatile bool allSlavesSearching;
89   volatile uint64_t nodes;
90   volatile Value alpha;
91   volatile Value bestValue;
92   volatile Move bestMove;
93   volatile int moveCount;
94   volatile bool cutoff;
95 };
96
97
98 /// ThreadBase struct is the base of the hierarchy from where we derive all the
99 /// specialized thread classes.
100
101 struct ThreadBase {
102
103   ThreadBase() : handle(NativeHandle()), exit(false) {}
104   virtual ~ThreadBase() {}
105   virtual void idle_loop() = 0;
106   void notify_one();
107   void wait_for(volatile const bool& b);
108
109   Mutex mutex;
110   ConditionVariable sleepCondition;
111   NativeHandle handle;
112   volatile bool exit;
113 };
114
115
116 /// Thread struct keeps together all the thread related stuff like locks, state
117 /// and especially split points. We also use per-thread pawn and material hash
118 /// tables so that once we get a pointer to an entry its life time is unlimited
119 /// and we don't have to care about someone changing the entry under our feet.
120
121 struct Thread : public ThreadBase {
122
123   Thread();
124   virtual void idle_loop();
125   bool cutoff_occurred() const;
126   bool available_to(const Thread* master) const;
127
128   void split(Position& pos, Search::Stack* ss, Value alpha, Value beta, Value* bestValue, Move* bestMove,
129              Depth depth, int moveCount, MovePicker* movePicker, int nodeType, bool cutNode);
130
131   SplitPoint splitPoints[MAX_SPLITPOINTS_PER_THREAD];
132   Pawns::Table pawnsTable;
133   Material::Table materialTable;
134   Endgames endgames;
135   Position* activePosition;
136   size_t idx;
137   int maxPly;
138   SplitPoint* volatile activeSplitPoint;
139   volatile int splitPointsSize;
140   volatile bool searching;
141 };
142
143
144 /// MainThread and TimerThread are derived classes used to characterize the two
145 /// special threads: the main one and the recurring timer.
146
147 struct MainThread : public Thread {
148   MainThread() : thinking(true) {} // Avoid a race with start_thinking()
149   virtual void idle_loop();
150   volatile bool thinking;
151 };
152
153 struct TimerThread : public ThreadBase {
154
155   static const int Resolution = 5; // Millisec between two check_time() calls
156
157   TimerThread() : run(false) {}
158   virtual void idle_loop();
159
160   bool run;
161 };
162
163
164 /// ThreadPool struct handles all the threads related stuff like init, starting,
165 /// parking and, most importantly, launching a slave thread at a split point.
166 /// All the access to shared thread data is done through this class.
167
168 struct ThreadPool : public std::vector<Thread*> {
169
170   void init(); // No c'tor and d'tor, threads rely on globals that should be
171   void exit(); // initialized and are valid during the whole thread lifetime.
172
173   MainThread* main() { return static_cast<MainThread*>(at(0)); }
174   void read_uci_options();
175   Thread* available_slave(const Thread* master) const;
176   void wait_for_think_finished();
177   void start_thinking(const Position&, const Search::LimitsType&, Search::StateStackPtr&);
178
179   Depth minimumSplitDepth;
180   Mutex mutex;
181   ConditionVariable sleepCondition;
182   TimerThread* timer;
183 };
184
185 extern ThreadPool Threads;
186
187 #endif // #ifndef THREAD_H_INCLUDED