Simplify start_searching() signature
[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   // 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 class Thread {
68
69   Thread(const Thread&);            // Only declared to disable the default ones
70   Thread& operator=(const Thread&); // that are not suitable in this case.
71
72   typedef void (Thread::* Fn) ();
73
74 public:
75   Thread(Fn fn);
76   ~Thread();
77
78   void wake_up();
79   bool cutoff_occurred() const;
80   bool is_available_to(int master) const;
81   void idle_loop(SplitPoint* sp_master);
82   void idle_loop() { idle_loop(NULL); } // Hack to allow storing in start_fn
83   void main_loop();
84   void timer_loop();
85   void wait_for_stop_or_ponderhit();
86
87   SplitPoint splitPoints[MAX_SPLITPOINTS_PER_THREAD];
88   MaterialInfoTable materialTable;
89   PawnInfoTable pawnTable;
90   int threadID;
91   int maxPly;
92   Lock sleepLock;
93   WaitCondition sleepCond;
94   NativeHandle handle;
95   Fn start_fn;
96   SplitPoint* volatile curSplitPoint;
97   volatile int splitPointsCnt;
98   volatile bool is_searching;
99   volatile bool do_sleep;
100   volatile bool do_exit;
101 };
102
103
104 /// ThreadsManager class handles all the threads related stuff like init, starting,
105 /// parking and, the most important, launching a slave thread at a split point.
106 /// All the access to shared thread data is done through this class.
107
108 class ThreadsManager {
109   /* As long as the single ThreadsManager object is defined as a global we don't
110      need to explicitly initialize to zero its data members because variables with
111      static storage duration are automatically set to zero before enter main()
112   */
113 public:
114   void init(); // No c'tor becuase Threads is static and we need stuff initialized
115   ~ThreadsManager();
116
117   Thread& operator[](int id) { return *threads[id]; }
118   bool use_sleeping_threads() const { return useSleepingThreads; }
119   int min_split_depth() const { return minimumSplitDepth; }
120   int size() const { return (int)threads.size(); }
121
122   void wake_up() const;
123   void sleep() const;
124   void read_uci_options();
125   bool available_slave_exists(int master) const;
126   void set_timer(int msec);
127   void wait_for_search_finished();
128   void start_searching(const Position& pos, const Search::LimitsType& limits,
129                        const std::set<Move>& = std::set<Move>());
130
131   template <bool Fake>
132   Value split(Position& pos, Search::Stack* ss, Value alpha, Value beta, Value bestValue, Move* bestMove,
133               Depth depth, Move threatMove, int moveCount, MovePicker* mp, int nodeType);
134 private:
135   friend class Thread;
136
137   std::vector<Thread*> threads;
138   Thread* timer;
139   Lock splitLock;
140   WaitCondition sleepCond;
141   Depth minimumSplitDepth;
142   int maxThreadsPerSplitPoint;
143   bool useSleepingThreads;
144 };
145
146 extern ThreadsManager Threads;
147
148 #endif // !defined(THREAD_H_INCLUDED)