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