b4aad5cb7f42321c8954ee641452c5908f9d3cb5
[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 <atomic>
24 #include <bitset>
25 #include <condition_variable>
26 #include <mutex>
27 #include <thread>
28 #include <vector>
29
30 #include "material.h"
31 #include "movepick.h"
32 #include "pawns.h"
33 #include "position.h"
34 #include "search.h"
35 #include "thread_win32.h"
36
37 struct Thread;
38
39 const size_t MAX_THREADS = 128;
40 const size_t MAX_SPLITPOINTS_PER_THREAD = 8;
41 const size_t MAX_SLAVES_PER_SPLITPOINT = 4;
42
43
44 /// Spinlock class wraps low level atomic operations to provide a spin lock
45
46 class Spinlock {
47
48   std::atomic_int lock;
49
50 public:
51   Spinlock() { lock = 1; } // Init here to workaround a bug with MSVC 2013
52   void acquire() {
53     while (lock.fetch_sub(1, std::memory_order_acquire) != 1)
54         while (lock.load(std::memory_order_relaxed) <= 0) {}
55   }
56   void release() { lock.store(1, std::memory_order_release); }
57 };
58
59
60 /// SplitPoint struct stores information shared by the threads searching in
61 /// parallel below the same split point. It is populated at splitting time.
62
63 struct SplitPoint {
64
65   // Const data after split point has been setup
66   const Position* pos;
67   Search::Stack* ss;
68   Thread* master;
69   Depth depth;
70   Value beta;
71   int nodeType;
72   bool cutNode;
73
74   // Const pointers to shared data
75   MovePicker* movePicker;
76   SplitPoint* parentSplitPoint;
77
78   // Shared variable data
79   Spinlock spinlock;
80   std::bitset<MAX_THREADS> slavesMask;
81   volatile bool allSlavesSearching;
82   volatile uint64_t nodes;
83   volatile Value alpha;
84   volatile Value bestValue;
85   volatile Move bestMove;
86   volatile int moveCount;
87   volatile bool cutoff;
88 };
89
90
91 /// ThreadBase struct is the base of the hierarchy from where we derive all the
92 /// specialized thread classes.
93
94 struct ThreadBase {
95
96   virtual ~ThreadBase() = default;
97   virtual void idle_loop() = 0;
98   void notify_one();
99   void wait_for(volatile const bool& b);
100
101   std::thread nativeThread;
102   Mutex mutex;
103   ConditionVariable sleepCondition;
104   volatile bool exit = false;
105 };
106
107
108 /// Thread struct keeps together all the thread related stuff like locks, state
109 /// and especially split points. We also use per-thread pawn and material hash
110 /// tables so that once we get a pointer to an entry its life time is unlimited
111 /// and we don't have to care about someone changing the entry under our feet.
112
113 struct Thread : public ThreadBase {
114
115   Thread();
116   virtual void idle_loop();
117   bool cutoff_occurred() const;
118   bool can_join(const SplitPoint* sp) const;
119
120   void split(Position& pos, Search::Stack* ss, Value alpha, Value beta, Value* bestValue, Move* bestMove,
121              Depth depth, int moveCount, MovePicker* movePicker, int nodeType, bool cutNode);
122
123   SplitPoint splitPoints[MAX_SPLITPOINTS_PER_THREAD];
124   Pawns::Table pawnsTable;
125   Material::Table materialTable;
126   Endgames endgames;
127   Position* activePosition;
128   size_t idx;
129   int maxPly;
130   SplitPoint* volatile activeSplitPoint;
131   volatile size_t 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   virtual void idle_loop();
141   volatile bool thinking = true; // Avoid a race with start_thinking()
142 };
143
144 struct TimerThread : public ThreadBase {
145
146   static const int Resolution = 5; // Millisec between two check_time() calls
147
148   virtual void idle_loop();
149
150   bool run = false;
151 };
152
153
154 /// ThreadPool struct handles all the threads related stuff like init, starting,
155 /// parking and, most importantly, launching a slave thread at a split point.
156 /// All the access to shared thread data is done through this class.
157
158 struct ThreadPool : public std::vector<Thread*> {
159
160   void init(); // No c'tor and d'tor, threads rely on globals that should be
161   void exit(); // initialized and are valid during the whole thread lifetime.
162
163   MainThread* main() { return static_cast<MainThread*>(at(0)); }
164   void read_uci_options();
165   Thread* available_slave(const SplitPoint* sp) const;
166   void wait_for_think_finished();
167   void start_thinking(const Position&, const Search::LimitsType&, Search::StateStackPtr&);
168
169   Depth minimumSplitDepth;
170   Spinlock spinlock;
171   ConditionVariable sleepCondition;
172   TimerThread* timer;
173 };
174
175 extern ThreadPool Threads;
176
177 #endif // #ifndef THREAD_H_INCLUDED