0265ee670b2ea9e84765a8b6208f8b1f8ccb2e9c
[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 int 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   int slavesCount;
89   volatile bool allSlavesSearching;
90   volatile uint64_t nodes;
91   volatile Value alpha;
92   volatile Value bestValue;
93   volatile Move bestMove;
94   volatile int moveCount;
95   volatile bool cutoff;
96 };
97
98
99 /// ThreadBase struct is the base of the hierarchy from where we derive all the
100 /// specialized thread classes.
101
102 struct ThreadBase {
103
104   ThreadBase() : handle(NativeHandle()), exit(false) {}
105   virtual ~ThreadBase() {}
106   virtual void idle_loop() = 0;
107   void notify_one();
108   void wait_for(volatile const bool& b);
109
110   Mutex mutex;
111   ConditionVariable sleepCondition;
112   NativeHandle handle;
113   volatile bool exit;
114 };
115
116
117 /// Thread struct keeps together all the thread related stuff like locks, state
118 /// and especially split points. We also use per-thread pawn and material hash
119 /// tables so that once we get a pointer to an entry its life time is unlimited
120 /// and we don't have to care about someone changing the entry under our feet.
121
122 struct Thread : public ThreadBase {
123
124   Thread();
125   virtual void idle_loop();
126   bool cutoff_occurred() const;
127   bool available_to(const Thread* master) const;
128
129   void split(Position& pos, Search::Stack* ss, Value alpha, Value beta, Value* bestValue, Move* bestMove,
130              Depth depth, int moveCount, MovePicker* movePicker, int nodeType, bool cutNode);
131
132   SplitPoint splitPoints[MAX_SPLITPOINTS_PER_THREAD];
133   Pawns::Table pawnsTable;
134   Material::Table materialTable;
135   Endgames endgames;
136   Position* activePosition;
137   size_t idx;
138   int maxPly;
139   SplitPoint* volatile activeSplitPoint;
140   volatile int splitPointsSize;
141   volatile bool searching;
142 };
143
144
145 /// MainThread and TimerThread are derived classes used to characterize the two
146 /// special threads: the main one and the recurring timer.
147
148 struct MainThread : public Thread {
149   MainThread() : thinking(true) {} // Avoid a race with start_thinking()
150   virtual void idle_loop();
151   volatile bool thinking;
152 };
153
154 struct TimerThread : public ThreadBase {
155
156   static const int Resolution = 5; // Millisec between two check_time() calls
157
158   TimerThread() : run(false) {}
159   virtual void idle_loop();
160
161   bool run;
162 };
163
164
165 /// ThreadPool struct handles all the threads related stuff like init, starting,
166 /// parking and, most importantly, launching a slave thread at a split point.
167 /// All the access to shared thread data is done through this class.
168
169 struct ThreadPool : public std::vector<Thread*> {
170
171   void init(); // No c'tor and d'tor, threads rely on globals that should be
172   void exit(); // initialized and are valid during the whole thread lifetime.
173
174   MainThread* main() { return static_cast<MainThread*>(at(0)); }
175   void read_uci_options();
176   Thread* available_slave(const Thread* master) const;
177   void wait_for_think_finished();
178   void start_thinking(const Position&, const Search::LimitsType&, Search::StateStackPtr&);
179
180   Depth minimumSplitDepth;
181   Mutex mutex;
182   ConditionVariable sleepCondition;
183   TimerThread* timer;
184 };
185
186 extern ThreadPool Threads;
187
188 #endif // #ifndef THREAD_H_INCLUDED