Big renaming in thread stuff
[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-2012 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 #if !defined(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   Depth depth;
67   Value beta;
68   int nodeType;
69   Thread* master;
70   Move threatMove;
71
72   // Const pointers to shared data
73   MovePicker* mp;
74   SplitPoint* parent;
75
76   // Shared data
77   Mutex mutex;
78   Position* activePositions[MAX_THREADS];
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 /// Thread struct keeps together all the thread related stuff like locks, state
90 /// and especially split points. We also use per-thread pawn and material hash
91 /// tables so that once we get a pointer to an entry its life time is unlimited
92 /// and we don't have to care about someone changing the entry under our feet.
93
94 struct Thread {
95
96   Thread();
97   virtual ~Thread();
98
99   virtual void idle_loop();
100   void notify_one();
101   bool cutoff_occurred() const;
102   bool is_available_to(Thread* master) const;
103   void wait_for(volatile const bool& b);
104
105   SplitPoint splitPoints[MAX_SPLITPOINTS_PER_THREAD];
106   Material::Table materialTable;
107   Endgames endgames;
108   Pawns::Table pawnsTable;
109   size_t idx;
110   int maxPly;
111   Mutex mutex;
112   ConditionVariable sleepCondition;
113   NativeHandle handle;
114   SplitPoint* volatile curSplitPoint;
115   volatile int splitPointsCnt;
116   volatile bool searching;
117   volatile bool exit;
118 };
119
120
121 /// MainThread and TimerThread are sublassed from Thread to charaterize the two
122 /// special threads: the main one and the recurring timer.
123
124 struct MainThread : public Thread {
125   MainThread() : thinking(true) {} // Avoid a race with start_thinking()
126   virtual void idle_loop();
127   volatile bool thinking;
128 };
129
130 struct TimerThread : public Thread {
131   TimerThread() : msec(0) {}
132   virtual void idle_loop();
133   int msec;
134 };
135
136
137 /// ThreadPool class handles all the threads related stuff like init, starting,
138 /// parking and, the most important, launching a slave thread at a split point.
139 /// All the access to shared thread data is done through this class.
140
141 class ThreadPool {
142
143 public:
144   void init(); // No c'tor and d'tor, threads rely on globals that should
145   void exit(); // be initialized and valid during the whole thread lifetime.
146
147   Thread& operator[](size_t id) { return *threads[id]; }
148   size_t size() const { return threads.size(); }
149   MainThread* main_thread() { return static_cast<MainThread*>(threads[0]); }
150   TimerThread* timer_thread() { return timer; }
151
152   void read_uci_options();
153   bool available_slave_exists(Thread* master) const;
154   void wait_for_think_finished();
155   void start_thinking(const Position&, const Search::LimitsType&,
156                        const std::vector<Move>&, Search::StateStackPtr&);
157
158   template <bool Fake>
159   Value split(Position& pos, Search::Stack* ss, Value alpha, Value beta, Value bestValue, Move* bestMove,
160               Depth depth, Move threatMove, int moveCount, MovePicker& mp, int nodeType);
161
162   bool sleepWhileIdle;
163   Depth minimumSplitDepth;
164
165 private:
166   friend struct Thread;
167   friend struct MainThread;
168   friend void check_time();
169
170   std::vector<Thread*> threads;
171   TimerThread* timer;
172   Mutex mutex;
173   ConditionVariable sleepCondition;
174   int maxThreadsPerSplitPoint;
175 };
176
177 extern ThreadPool Threads;
178
179 #endif // !defined(THREAD_H_INCLUDED)