Use size_t as operator[] argument type
[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 class Thread;
35
36 struct SplitPoint {
37
38   // Const data after split point has been setup
39   const Position* pos;
40   const Search::Stack* ss;
41   Depth depth;
42   Value beta;
43   int nodeType;
44   Thread* master;
45   Move threatMove;
46
47   // Const pointers to shared data
48   MovePicker* mp;
49   SplitPoint* parent;
50
51   // Shared data
52   Lock lock;
53   volatile uint64_t slavesMask;
54   volatile int64_t nodes;
55   volatile Value alpha;
56   volatile Value bestValue;
57   volatile Move bestMove;
58   volatile int moveCount;
59   volatile bool cutoff;
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 class Thread {
69
70   typedef void (Thread::* Fn) (); // Pointer to member function
71
72 public:
73   Thread(Fn fn);
74  ~Thread();
75
76   void wake_up();
77   bool cutoff_occurred() const;
78   bool is_available_to(Thread* master) const;
79   void idle_loop();
80   void main_loop();
81   void timer_loop();
82   void wait_for_stop_or_ponderhit();
83
84   SplitPoint splitPoints[MAX_SPLITPOINTS_PER_THREAD];
85   MaterialTable materialTable;
86   PawnTable pawnTable;
87   size_t idx;
88   int maxPly;
89   Lock sleepLock;
90   WaitCondition sleepCond;
91   NativeHandle handle;
92   Fn start_fn;
93   SplitPoint* volatile curSplitPoint;
94   volatile int splitPointsCnt;
95   volatile bool is_searching;
96   volatile bool do_sleep;
97   volatile bool do_exit;
98 };
99
100
101 /// ThreadPool class handles all the threads related stuff like init, starting,
102 /// parking and, the most important, launching a slave thread at a split point.
103 /// All the access to shared thread data is done through this class.
104
105 class ThreadPool {
106
107 public:
108   void init(); // No c'tor, Threads object is global and engine shall be fully initialized
109   ~ThreadPool();
110
111   Thread& operator[](size_t id) { return *threads[id]; }
112   bool use_sleeping_threads() const { return useSleepingThreads; }
113   int min_split_depth() const { return minimumSplitDepth; }
114   size_t size() const { return threads.size(); }
115   Thread* main_thread() { return threads[0]; }
116
117   void wake_up() const;
118   void sleep() const;
119   void read_uci_options();
120   bool available_slave_exists(Thread* master) const;
121   void set_timer(int msec);
122   void wait_for_search_finished();
123   void start_searching(const Position& pos, const Search::LimitsType& limits,
124                        const std::vector<Move>& searchMoves);
125
126   template <bool Fake>
127   Value split(Position& pos, Search::Stack* ss, Value alpha, Value beta, Value bestValue, Move* bestMove,
128               Depth depth, Move threatMove, int moveCount, MovePicker* mp, int nodeType);
129 private:
130   friend class Thread;
131
132   std::vector<Thread*> threads;
133   Thread* timer;
134   Lock splitLock;
135   WaitCondition sleepCond;
136   Depth minimumSplitDepth;
137   int maxThreadsPerSplitPoint;
138   bool useSleepingThreads;
139 };
140
141 extern ThreadPool Threads;
142
143 #endif // !defined(THREAD_H_INCLUDED)