Move struct RootMove to Search namespace
[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 <cstring>
24 #include <set>
25
26 #include "lock.h"
27 #include "material.h"
28 #include "movepick.h"
29 #include "pawns.h"
30 #include "position.h"
31 #include "search.h"
32
33 const int MAX_THREADS = 32;
34 const int MAX_ACTIVE_SPLIT_POINTS = 8;
35
36 struct SplitPoint {
37
38   // Const data after splitPoint has been setup
39   SplitPoint* parent;
40   const Position* pos;
41   Depth depth;
42   Value beta;
43   int nodeType;
44   int ply;
45   int master;
46   Move threatMove;
47
48   // Const pointers to shared data
49   MovePicker* mp;
50   Search::Stack* ss;
51
52   // Shared data
53   Lock lock;
54   volatile int64_t nodes;
55   volatile Value alpha;
56   volatile Value bestValue;
57   volatile int moveCount;
58   volatile bool is_betaCutoff;
59   volatile bool is_slave[MAX_THREADS];
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 struct Thread {
69
70   void wake_up();
71   bool cutoff_occurred() const;
72   bool is_available_to(int master) const;
73   void idle_loop(SplitPoint* sp);
74   void main_loop();
75   void timer_loop();
76
77   SplitPoint splitPoints[MAX_ACTIVE_SPLIT_POINTS];
78   MaterialInfoTable materialTable;
79   PawnInfoTable pawnTable;
80   int threadID;
81   int maxPly;
82   Lock sleepLock;
83   WaitCondition sleepCond;
84   SplitPoint* volatile splitPoint;
85   volatile int activeSplitPoints;
86   volatile bool is_searching;
87   volatile bool do_sleep;
88   volatile bool do_terminate;
89
90 #if defined(_MSC_VER)
91   HANDLE handle;
92 #else
93   pthread_t handle;
94 #endif
95 };
96
97
98 /// ThreadsManager class handles all the threads related stuff like init, starting,
99 /// parking and, the most important, launching a slave thread at a split point.
100 /// All the access to shared thread data is done through this class.
101
102 class ThreadsManager {
103   /* As long as the single ThreadsManager object is defined as a global we don't
104      need to explicitly initialize to zero its data members because variables with
105      static storage duration are automatically set to zero before enter main()
106   */
107 public:
108   Thread& operator[](int threadID) { return threads[threadID]; }
109   void init();
110   void exit();
111
112   bool use_sleeping_threads() const { return useSleepingThreads; }
113   int min_split_depth() const { return minimumSplitDepth; }
114   int size() const { return activeThreads; }
115
116   void set_size(int cnt);
117   void read_uci_options();
118   bool available_slave_exists(int master) const;
119   bool split_point_finished(SplitPoint* sp) const;
120   void set_timer(int msec);
121   void wait_for_stop_or_ponderhit();
122   void stop_thinking();
123   void start_thinking(const Position& pos, const Search::LimitsType& limits,
124                       const std::set<Move>& = std::set<Move>(), bool async = false);
125
126   template <bool Fake>
127   Value split(Position& pos, Search::Stack* ss, Value alpha, Value beta, Value bestValue,
128               Depth depth, Move threatMove, int moveCount, MovePicker* mp, int nodeType);
129 private:
130   friend struct Thread;
131
132   Thread threads[MAX_THREADS + 1]; // Last one is used as a timer
133   Lock threadsLock;
134   Depth minimumSplitDepth;
135   int maxThreadsPerSplitPoint;
136   int activeThreads;
137   bool useSleepingThreads;
138   WaitCondition sleepCond;
139 };
140
141 extern ThreadsManager Threads;
142
143 #endif // !defined(THREAD_H_INCLUDED)