Rework Thread hierarchy
[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-2013 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 <vector>
24
25 #include "material.h"
26 #include "movepick.h"
27 #include "pawns.h"
28 #include "position.h"
29 #include "search.h"
30
31 const int MAX_THREADS = 64; // Because SplitPoint::slavesMask is a uint64_t
32 const int MAX_SPLITPOINTS_PER_THREAD = 8;
33
34 struct Mutex {
35   Mutex() { lock_init(l); }
36  ~Mutex() { lock_destroy(l); }
37
38   void lock() { lock_grab(l); }
39   void unlock() { lock_release(l); }
40
41 private:
42   friend struct ConditionVariable;
43
44   Lock l;
45 };
46
47 struct ConditionVariable {
48   ConditionVariable() { cond_init(c); }
49  ~ConditionVariable() { cond_destroy(c); }
50
51   void wait(Mutex& m) { cond_wait(c, m.l); }
52   void wait_for(Mutex& m, int ms) { timed_wait(c, m.l, ms); }
53   void notify_one() { cond_signal(c); }
54
55 private:
56   WaitCondition c;
57 };
58
59 struct Thread;
60
61 struct SplitPoint {
62
63   // Const data after split point has been setup
64   const Position* pos;
65   const Search::Stack* ss;
66   Thread* masterThread;
67   Depth depth;
68   Value beta;
69   int nodeType;
70   Move threatMove;
71   bool cutNode;
72
73   // Const pointers to shared data
74   MovePicker* movePicker;
75   SplitPoint* parentSplitPoint;
76
77   // Shared data
78   Mutex mutex;
79   volatile uint64_t slavesMask;
80   volatile int64_t nodes;
81   volatile Value alpha;
82   volatile Value bestValue;
83   volatile Move bestMove;
84   volatile int moveCount;
85   volatile bool cutoff;
86 };
87
88
89 /// ThreadBase struct is the base of the hierarchy from where we derive all the
90 /// specialized thread classes.
91
92 struct ThreadBase {
93
94   ThreadBase() : exit(false) {}
95   virtual ~ThreadBase() {}
96   virtual void idle_loop() = 0;
97   void notify_one();
98   void wait_for(volatile const bool& b);
99
100   Mutex mutex;
101   ConditionVariable sleepCondition;
102   NativeHandle handle;
103   volatile bool exit;
104 };
105
106
107 /// Thread struct keeps together all the thread related stuff like locks, state
108 /// and especially split points. We also use per-thread pawn and material hash
109 /// tables so that once we get a pointer to an entry its life time is unlimited
110 /// and we don't have to care about someone changing the entry under our feet.
111
112 struct Thread : public ThreadBase {
113
114   Thread();
115   virtual void idle_loop();
116   bool cutoff_occurred() const;
117   bool is_available_to(Thread* master) const;
118
119   template <bool Fake>
120   void split(Position& pos, Search::Stack* ss, Value alpha, Value beta, Value* bestValue, Move* bestMove,
121              Depth depth, Move threatMove, int moveCount, MovePicker* movePicker, int nodeType, bool cutNode);
122
123   SplitPoint splitPoints[MAX_SPLITPOINTS_PER_THREAD];
124   Material::Table materialTable;
125   Endgames endgames;
126   Pawns::Table pawnsTable;
127   Position* activePosition;
128   size_t idx;
129   int maxPly;
130   SplitPoint* volatile activeSplitPoint;
131   volatile int splitPointsSize;
132   volatile bool searching;
133 };
134
135
136 /// MainThread and TimerThread are derived classes used to characterize the two
137 /// special threads: the main one and the recurring timer.
138
139 struct MainThread : public Thread {
140   MainThread() : thinking(true) {} // Avoid a race with start_thinking()
141   virtual void idle_loop();
142   volatile bool thinking;
143 };
144
145 struct TimerThread : public ThreadBase {
146   TimerThread() : msec(0) {}
147   virtual void idle_loop();
148   int msec;
149 };
150
151
152 /// ThreadPool struct handles all the threads related stuff like init, starting,
153 /// parking and, the most important, launching a slave thread at a split point.
154 /// All the access to shared thread data is done through this class.
155
156 struct ThreadPool : public std::vector<Thread*> {
157
158   void init(); // No c'tor and d'tor, threads rely on globals that should
159   void exit(); // be initialized and valid during the whole thread lifetime.
160
161   MainThread* main() { return static_cast<MainThread*>((*this)[0]); }
162   void read_uci_options();
163   Thread* available_slave(Thread* master) const;
164   void wait_for_think_finished();
165   void start_thinking(const Position&, const Search::LimitsType&,
166                       const std::vector<Move>&, Search::StateStackPtr&);
167
168   bool sleepWhileIdle;
169   Depth minimumSplitDepth;
170   size_t maxThreadsPerSplitPoint;
171   Mutex mutex;
172   ConditionVariable sleepCondition;
173   TimerThread* timer;
174 };
175
176 extern ThreadPool Threads;
177
178 #endif // #ifndef THREAD_H_INCLUDED