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