Refactor Thread class
[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 <set>
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 = 32;
32 const int MAX_SPLITPOINTS_PER_THREAD = 8;
33
34 struct SplitPoint {
35
36   // Const data after split point has been setup
37   const Position* pos;
38   const Search::Stack* ss;
39   Depth depth;
40   Value beta;
41   int nodeType;
42   int master;
43   Move threatMove;
44
45   // Const pointers to shared data
46   MovePicker* mp;
47   SplitPoint* parent;
48
49
50   // Shared data
51   Lock lock;
52   volatile uint64_t slavesMask;
53   volatile int64_t nodes;
54   volatile Value alpha;
55   volatile Value bestValue;
56   volatile Move bestMove;
57   volatile int moveCount;
58   volatile bool cutoff;
59 };
60
61
62 /// Thread struct keeps together all the thread related stuff like locks, state
63 /// and especially split points. We also use per-thread pawn and material hash
64 /// tables so that once we get a pointer to an entry its life time is unlimited
65 /// and we don't have to care about someone changing the entry under our feet.
66
67 struct Thread {
68
69   Thread(int id);
70   ~Thread();
71
72   void wake_up();
73   bool cutoff_occurred() const;
74   bool is_available_to(int master) const;
75   void idle_loop(SplitPoint* sp_master);
76   void main_loop();
77   void timer_loop();
78   void wait_for_stop_or_ponderhit();
79
80   SplitPoint splitPoints[MAX_SPLITPOINTS_PER_THREAD];
81   MaterialInfoTable materialTable;
82   PawnInfoTable pawnTable;
83   int threadID;
84   int maxPly;
85   Lock sleepLock;
86   WaitCondition sleepCond;
87   ThreadHandle handle;
88   SplitPoint* volatile curSplitPoint;
89   volatile int splitPointsCnt;
90   volatile bool is_searching;
91   volatile bool do_sleep;
92   volatile bool do_exit;
93 };
94
95
96 /// ThreadsManager class handles all the threads related stuff like init, starting,
97 /// parking and, the most important, launching a slave thread at a split point.
98 /// All the access to shared thread data is done through this class.
99
100 class ThreadsManager {
101   /* As long as the single ThreadsManager object is defined as a global we don't
102      need to explicitly initialize to zero its data members because variables with
103      static storage duration are automatically set to zero before enter main()
104   */
105 public:
106   Thread& operator[](int threadID) { return *threads[threadID]; }
107   void init();
108   void exit();
109
110   bool use_sleeping_threads() const { return useSleepingThreads; }
111   int min_split_depth() const { return minimumSplitDepth; }
112   int size() const { return activeThreads; }
113
114   void wake_up();
115   void sleep();
116   void read_uci_options();
117   bool available_slave_exists(int master) const;
118   void set_timer(int msec);
119   void stop_thinking();
120   void start_thinking(const Position& pos, const Search::LimitsType& limits,
121                       const std::set<Move>& = std::set<Move>(), bool async = false);
122
123   template <bool Fake>
124   Value split(Position& pos, Search::Stack* ss, Value alpha, Value beta, Value bestValue, Move* bestMove,
125               Depth depth, Move threatMove, int moveCount, MovePicker* mp, int nodeType);
126 private:
127   friend struct Thread;
128
129   Thread* timer;
130   Thread* threads[MAX_THREADS];
131   Lock splitLock;
132   WaitCondition sleepCond;
133   Depth minimumSplitDepth;
134   int maxThreadsPerSplitPoint;
135   int activeThreads;
136   bool useSleepingThreads;
137 };
138
139 extern ThreadsManager Threads;
140
141 #endif // !defined(THREAD_H_INCLUDED)