Pick bestmove from the deepest thread.
[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-2015 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 #ifndef THREAD_H_INCLUDED
21 #define THREAD_H_INCLUDED
22
23 #include <atomic>
24 #include <bitset>
25 #include <condition_variable>
26 #include <mutex>
27 #include <thread>
28 #include <vector>
29
30 #include "material.h"
31 #include "movepick.h"
32 #include "pawns.h"
33 #include "position.h"
34 #include "search.h"
35 #include "thread_win32.h"
36
37
38 /// ThreadBase struct is the base of the hierarchy from where we derive all the
39 /// specialized thread classes.
40
41 struct ThreadBase : public std::thread {
42
43   ThreadBase() { exit = false; }
44   virtual ~ThreadBase() = default;
45   virtual void idle_loop() = 0;
46   void notify_one();
47   void wait(std::atomic<bool>& b);
48   void wait_while(std::atomic<bool>& b);
49
50   Mutex mutex;
51   ConditionVariable sleepCondition;
52   std::atomic<bool> exit;
53 };
54
55
56 /// Thread struct keeps together all the thread related stuff like locks, state,
57 /// history and countermoves tables. We also use per-thread pawn and material hash
58 /// tables so that once we get a pointer to an entry its life time is unlimited
59 /// and we don't have to care about someone changing the entry under our feet.
60
61 struct Thread : public ThreadBase {
62
63   Thread();
64   virtual void idle_loop();
65   void search(bool isMainThread = false);
66
67   Pawns::Table pawnsTable;
68   Material::Table materialTable;
69   Endgames endgames;
70   size_t idx, PVIdx;
71   int maxPly;
72   std::atomic<bool> searching;
73
74   Position rootPos;
75   Search::RootMoveVector rootMoves;
76   Depth rootDepth;
77   HistoryStats history;
78   MovesStats counterMoves;
79   Depth completedDepth;
80 };
81
82
83 /// MainThread and TimerThread are derived classes used to characterize the two
84 /// special threads: the main one and the recurring timer.
85
86 struct MainThread : public Thread {
87   MainThread() { thinking = true; } // Avoid a race with start_thinking()
88   virtual void idle_loop();
89   void join();
90   void think();
91   std::atomic<bool> thinking;
92 };
93
94 struct TimerThread : public ThreadBase {
95
96   static const int Resolution = 5; // Millisec between two check_time() calls
97
98   virtual void idle_loop();
99   void check_time();
100
101   bool run = false;
102 };
103
104
105 /// ThreadPool struct handles all the threads related stuff like init, starting,
106 /// parking and, most importantly, launching a thread.
107 /// All the access to shared thread data is done through this class.
108
109 struct ThreadPool : public std::vector<Thread*> {
110
111   void init(); // No constructor and destructor, threads rely on globals that should 
112   void exit(); // be initialized and valid during the whole thread lifetime.
113
114   MainThread* main() { return static_cast<MainThread*>(at(0)); }
115   void read_uci_options();
116   void start_thinking(const Position&, const Search::LimitsType&, Search::StateStackPtr&);
117   int64_t nodes_searched();
118   TimerThread* timer;
119 };
120
121 extern ThreadPool Threads;
122
123 #endif // #ifndef THREAD_H_INCLUDED