e6d400942c3a3cf9102496f783d6a06473fe4b46
[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-2010 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
25 #include "lock.h"
26 #include "material.h"
27 #include "movepick.h"
28 #include "pawns.h"
29 #include "position.h"
30
31 const int MAX_THREADS = 32;
32 const int MAX_ACTIVE_SPLIT_POINTS = 8;
33
34 struct SplitPoint {
35
36   // Const data after splitPoint has been setup
37   SplitPoint* parent;
38   const Position* pos;
39   Depth depth;
40   Value beta;
41   int nodeType;
42   int ply;
43   int master;
44   Move threatMove;
45
46   // Const pointers to shared data
47   MovePicker* mp;
48   SearchStack* ss;
49
50   // Shared data
51   Lock lock;
52   volatile int64_t nodes;
53   volatile Value alpha;
54   volatile Value bestValue;
55   volatile int moveCount;
56   volatile bool is_betaCutoff;
57   volatile bool is_slave[MAX_THREADS];
58 };
59
60
61 /// Thread struct is used to keep together all the thread related stuff like locks,
62 /// state and especially split points. We also use per-thread pawn and material hash
63 /// tables so that once we get a pointer to an entry its life time is unlimited and
64 /// we don't have to care about someone changing the entry under our feet.
65
66 struct Thread {
67
68   void wake_up();
69   bool cutoff_occurred() const;
70   bool is_available_to(int master) const;
71   void idle_loop(SplitPoint* sp);
72   void listener_loop();
73   void timer_loop();
74
75   SplitPoint splitPoints[MAX_ACTIVE_SPLIT_POINTS];
76   MaterialInfoTable materialTable;
77   PawnInfoTable pawnTable;
78   int threadID;
79   int maxPly;
80   Lock sleepLock;
81   WaitCondition sleepCond;
82   SplitPoint* volatile splitPoint;
83   volatile int activeSplitPoints;
84   volatile bool is_searching;
85   volatile bool do_sleep;
86   volatile bool do_terminate;
87
88 #if defined(_MSC_VER)
89   HANDLE handle;
90 #else
91   pthread_t handle;
92 #endif
93 };
94
95
96 /// ThreadsManager class is used to handle all the threads related stuff like init,
97 /// starting, parking and, the most important, launching a slave thread at a split
98 /// point. 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 set_size(int cnt);
115   void read_uci_options();
116   bool available_slave_exists(int master) const;
117   bool split_point_finished(SplitPoint* sp) const;
118
119   void getline(std::string& cmd);
120   void start_listener();
121   void stop_listener();
122   void set_timer(int msec);
123
124   template <bool Fake>
125   Value split(Position& pos, SearchStack* ss, Value alpha, Value beta, Value bestValue,
126               Depth depth, Move threatMove, int moveCount, MovePicker* mp, int nodeType);
127 private:
128   friend struct Thread;
129
130   Thread threads[MAX_THREADS + 2]; // Last 2 are the listener and the timer
131   Lock threadsLock;
132   Depth minimumSplitDepth;
133   int maxThreadsPerSplitPoint;
134   int activeThreads;
135   bool useSleepingThreads;
136   WaitCondition sleepCond;
137   std::string inputLine;
138 };
139
140 extern ThreadsManager Threads;
141
142 #endif // !defined(THREAD_H_INCLUDED)