Disable spinlocks
[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
36 struct Thread;
37
38 const size_t MAX_THREADS = 128;
39 const size_t MAX_SPLITPOINTS_PER_THREAD = 8;
40 const size_t MAX_SLAVES_PER_SPLITPOINT = 4;
41
42 #if 0
43 /// Spinlock class wraps low level atomic operations to provide a spin lock
44
45 class Spinlock {
46
47   std::atomic_int lock;
48
49 public:
50   Spinlock() { lock = 1; } // Init here to workaround a bug with MSVC 2013
51   void acquire() {
52     while (lock.fetch_sub(1, std::memory_order_acquire) != 1)
53         while (lock.load(std::memory_order_relaxed) <= 0) {}
54   }
55   void release() { lock.store(1, std::memory_order_release); }
56 };
57
58 #else
59
60 class Spinlock {
61
62   std::mutex mutex;
63
64 public:
65   void acquire() { mutex.lock(); }
66   void release() { mutex.unlock(); }
67 };
68
69 #endif
70
71 /// SplitPoint struct stores information shared by the threads searching in
72 /// parallel below the same split point. It is populated at splitting time.
73
74 struct SplitPoint {
75
76   // Const data after split point has been setup
77   const Position* pos;
78   Search::Stack* ss;
79   Thread* master;
80   Depth depth;
81   Value beta;
82   int nodeType;
83   bool cutNode;
84
85   // Const pointers to shared data
86   MovePicker* movePicker;
87   SplitPoint* parentSplitPoint;
88
89   // Shared variable data
90   Spinlock spinlock;
91   std::bitset<MAX_THREADS> slavesMask;
92   volatile bool allSlavesSearching;
93   volatile uint64_t nodes;
94   volatile Value alpha;
95   volatile Value bestValue;
96   volatile Move bestMove;
97   volatile int moveCount;
98   volatile bool cutoff;
99 };
100
101
102 /// ThreadBase struct is the base of the hierarchy from where we derive all the
103 /// specialized thread classes.
104
105 struct ThreadBase {
106
107   virtual ~ThreadBase() = default;
108   virtual void idle_loop() = 0;
109   void notify_one();
110   void wait_for(volatile const bool& b);
111
112   std::thread nativeThread;
113   std::mutex mutex;
114   std::condition_variable sleepCondition;
115   volatile bool exit = false;
116 };
117
118
119 /// Thread struct keeps together all the thread related stuff like locks, state
120 /// and especially split points. We also use per-thread pawn and material hash
121 /// tables so that once we get a pointer to an entry its life time is unlimited
122 /// and we don't have to care about someone changing the entry under our feet.
123
124 struct Thread : public ThreadBase {
125
126   Thread();
127   virtual void idle_loop();
128   bool cutoff_occurred() const;
129   bool can_join(const SplitPoint* sp) const;
130
131   void split(Position& pos, Search::Stack* ss, Value alpha, Value beta, Value* bestValue, Move* bestMove,
132              Depth depth, int moveCount, MovePicker* movePicker, int nodeType, bool cutNode);
133
134   SplitPoint splitPoints[MAX_SPLITPOINTS_PER_THREAD];
135   Pawns::Table pawnsTable;
136   Material::Table materialTable;
137   Endgames endgames;
138   Position* activePosition;
139   size_t idx;
140   int maxPly;
141   SplitPoint* volatile activeSplitPoint;
142   volatile size_t splitPointsSize;
143   volatile bool searching;
144 };
145
146
147 /// MainThread and TimerThread are derived classes used to characterize the two
148 /// special threads: the main one and the recurring timer.
149
150 struct MainThread : public Thread {
151   virtual void idle_loop();
152   volatile bool thinking = true; // Avoid a race with start_thinking()
153 };
154
155 struct TimerThread : public ThreadBase {
156
157   static const int Resolution = 5; // Millisec between two check_time() calls
158
159   virtual void idle_loop();
160
161   bool run = false;
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 SplitPoint* sp) const;
177   void wait_for_think_finished();
178   void start_thinking(const Position&, const Search::LimitsType&, Search::StateStackPtr&);
179
180   Depth minimumSplitDepth;
181   Spinlock spinlock;
182   std::condition_variable sleepCondition;
183   TimerThread* timer;
184 };
185
186 extern ThreadPool Threads;
187
188 #endif // #ifndef THREAD_H_INCLUDED