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