4ad08465ff30751ae3f89777ac57ff068d2485d5
[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 /// 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   template <bool Fake>
106   void split(Position& pos, Search::Stack* ss, Value alpha, Value beta, Value* bestValue, Move* bestMove,
107              Depth depth, Move threatMove, int moveCount, MovePicker* movePicker, int nodeType, bool cutNode);
108
109   SplitPoint splitPoints[MAX_SPLITPOINTS_PER_THREAD];
110   Material::Table materialTable;
111   Endgames endgames;
112   Pawns::Table pawnsTable;
113   Position* activePosition;
114   size_t idx;
115   int maxPly;
116   Mutex mutex;
117   ConditionVariable sleepCondition;
118   NativeHandle handle;
119   SplitPoint* volatile activeSplitPoint;
120   volatile int splitPointsSize;
121   volatile bool searching;
122   volatile bool exit;
123 };
124
125
126 /// MainThread and TimerThread are sublassed from Thread to characterize the two
127 /// special threads: the main one and the recurring timer.
128
129 struct MainThread : public Thread {
130   MainThread() : thinking(true) {} // Avoid a race with start_thinking()
131   virtual void idle_loop();
132   volatile bool thinking;
133 };
134
135 struct TimerThread : public Thread {
136   TimerThread() : msec(0) {}
137   virtual void idle_loop();
138   int msec;
139 };
140
141
142 /// ThreadPool struct handles all the threads related stuff like init, starting,
143 /// parking and, the most important, launching a slave thread at a split point.
144 /// All the access to shared thread data is done through this class.
145
146 struct ThreadPool : public std::vector<Thread*> {
147
148   void init(); // No c'tor and d'tor, threads rely on globals that should
149   void exit(); // be initialized and valid during the whole thread lifetime.
150
151   MainThread* main_thread() { return static_cast<MainThread*>((*this)[0]); }
152   void read_uci_options();
153   Thread* available_slave(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   bool sleepWhileIdle;
159   Depth minimumSplitDepth;
160   size_t maxThreadsPerSplitPoint;
161   Mutex mutex;
162   ConditionVariable sleepCondition;
163   TimerThread* timer;
164 };
165
166 extern ThreadPool Threads;
167
168 #endif // #ifndef THREAD_H_INCLUDED