Terminate threads before to exit main()
[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 <vector>
24
25 #include "material.h"
26 #include "movepick.h"
27 #include "pawns.h"
28 #include "position.h"
29 #include "search.h"
30
31 const int MAX_THREADS = 32;
32 const int MAX_SPLITPOINTS_PER_THREAD = 8;
33
34 struct Mutex {
35   Mutex() { lock_init(l); }
36  ~Mutex() { lock_destroy(l); }
37
38   void lock() { lock_grab(l); }
39   void unlock() { lock_release(l); }
40
41 private:
42   friend struct ConditionVariable;
43
44   Lock l;
45 };
46
47 struct ConditionVariable {
48   ConditionVariable() { cond_init(c); }
49  ~ConditionVariable() { cond_destroy(c); }
50
51   void wait(Mutex& m) { cond_wait(c, m.l); }
52   void wait_for(Mutex& m, int ms) { timed_wait(c, m.l, ms); }
53   void notify_one() { cond_signal(c); }
54
55 private:
56   WaitCondition c;
57 };
58
59 class Thread;
60
61 struct SplitPoint {
62
63   // Const data after split point has been setup
64   const Position* pos;
65   const Search::Stack* ss;
66   Depth depth;
67   Value beta;
68   int nodeType;
69   Thread* master;
70   Move threatMove;
71
72   // Const pointers to shared data
73   MovePicker* mp;
74   SplitPoint* parent;
75
76   // Shared data
77   Mutex mutex;
78   volatile uint64_t slavesMask;
79   volatile int64_t nodes;
80   volatile Value alpha;
81   volatile Value bestValue;
82   volatile Move bestMove;
83   volatile int moveCount;
84   volatile bool cutoff;
85 };
86
87
88 /// Thread struct keeps together all the thread related stuff like locks, state
89 /// and especially split points. We also use per-thread pawn and material hash
90 /// tables so that once we get a pointer to an entry its life time is unlimited
91 /// and we don't have to care about someone changing the entry under our feet.
92
93 class Thread {
94
95   typedef void (Thread::* Fn) (); // Pointer to member function
96
97 public:
98   Thread(Fn fn);
99  ~Thread();
100
101   void wake_up();
102   bool cutoff_occurred() const;
103   bool is_available_to(Thread* master) const;
104   void idle_loop();
105   void main_loop();
106   void timer_loop();
107   void wait_for_stop_or_ponderhit();
108
109   SplitPoint splitPoints[MAX_SPLITPOINTS_PER_THREAD];
110   MaterialTable materialTable;
111   PawnTable pawnTable;
112   size_t idx;
113   int maxPly;
114   Mutex mutex;
115   ConditionVariable sleepCondition;
116   NativeHandle handle;
117   Fn start_fn;
118   SplitPoint* volatile curSplitPoint;
119   volatile int splitPointsCnt;
120   volatile bool is_searching;
121   volatile bool do_sleep;
122   volatile bool do_exit;
123 };
124
125
126 /// ThreadPool class handles all the threads related stuff like init, starting,
127 /// parking and, the most important, launching a slave thread at a split point.
128 /// All the access to shared thread data is done through this class.
129
130 class ThreadPool {
131
132 public:
133   void init(); // No c'tor and d'tor, threads rely on globals that should
134   void exit(); // be initialized and valid during the whole thread lifetime.
135
136   Thread& operator[](size_t id) { return *threads[id]; }
137   bool use_sleeping_threads() const { return useSleepingThreads; }
138   int min_split_depth() const { return minimumSplitDepth; }
139   size_t size() const { return threads.size(); }
140   Thread* main_thread() { return threads[0]; }
141
142   void wake_up() const;
143   void sleep() const;
144   void read_uci_options();
145   bool available_slave_exists(Thread* master) const;
146   void set_timer(int msec);
147   void wait_for_search_finished();
148   void start_searching(const Position&, const Search::LimitsType&,
149                        const std::vector<Move>&, Search::StateStackPtr&);
150
151   template <bool Fake>
152   Value split(Position& pos, Search::Stack* ss, Value alpha, Value beta, Value bestValue, Move* bestMove,
153               Depth depth, Move threatMove, int moveCount, MovePicker* mp, int nodeType);
154 private:
155   friend class Thread;
156
157   std::vector<Thread*> threads;
158   Thread* timer;
159   Mutex mutex;
160   ConditionVariable sleepCondition;
161   Depth minimumSplitDepth;
162   int maxThreadsPerSplitPoint;
163   bool useSleepingThreads;
164 };
165
166 extern ThreadPool Threads;
167
168 #endif // !defined(THREAD_H_INCLUDED)