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