git.sesse.net Git - stockfish/blob - 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 <bitset>
  24 #include <condition_variable>
  25 #include <mutex>
  26 #include <thread>
  27 #include <vector>
  28
  29 #include "material.h"
  30 #include "movepick.h"
  31 #include "pawns.h"
  32 #include "position.h"
  33 #include "search.h"
  34
  35 struct Thread;
  36
  37 const int MAX_THREADS = 128;
  38 const int MAX_SPLITPOINTS_PER_THREAD = 8;
  39
  40 /// SplitPoint struct stores information shared by the threads searching in
  41 /// parallel below the same split point. It is populated at splitting time.
  42
  43 struct SplitPoint {
  44
  45   // Const data after split point has been setup
  46   const Position* pos;
  47   Search::Stack* ss;
  48   Thread* masterThread;
  49   Depth depth;
  50   Value beta;
  51   int nodeType;
  52   bool cutNode;
  53
  54   // Const pointers to shared data
  55   MovePicker* movePicker;
  56   SplitPoint* parentSplitPoint;
  57
  58   // Shared variable data
  59   std::mutex mutex;
  60   std::bitset<MAX_THREADS> slavesMask;
  61   volatile bool allSlavesSearching;
  62   volatile uint64_t nodes;
  63   volatile Value alpha;
  64   volatile Value bestValue;
  65   volatile Move bestMove;
  66   volatile int moveCount;
  67   volatile bool cutoff;
  68 };
  69
  70
  71 /// ThreadBase struct is the base of the hierarchy from where we derive all the
  72 /// specialized thread classes.
  73
  74 struct ThreadBase {
  75
  76   virtual ~ThreadBase() = default;
  77   virtual void idle_loop() = 0;
  78   void notify_one();
  79   void wait_for(volatile const bool& b);
  80
  81   std::thread nativeThread;
  82   std::mutex mutex;
  83   std::condition_variable sleepCondition;
  84   volatile bool exit = false;
  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 struct Thread : public ThreadBase {
  94
  95   Thread();
  96   virtual void idle_loop();
  97   bool cutoff_occurred() const;
  98   bool available_to(const Thread* master) const;
  99
 100   void split(Position& pos, Search::Stack* ss, Value alpha, Value beta, Value* bestValue, Move* bestMove,
 101              Depth depth, int moveCount, MovePicker* movePicker, int nodeType, bool cutNode);
 102
 103   SplitPoint splitPoints[MAX_SPLITPOINTS_PER_THREAD];
 104   Pawns::Table pawnsTable;
 105   Material::Table materialTable;
 106   Endgames endgames;
 107   Position* activePosition;
 108   size_t idx;
 109   int maxPly;
 110   SplitPoint* volatile activeSplitPoint;
 111   volatile int splitPointsSize;
 112   volatile bool searching;
 113 };
 114
 115
 116 /// MainThread and TimerThread are derived classes used to characterize the two
 117 /// special threads: the main one and the recurring timer.
 118
 119 struct MainThread : public Thread {
 120   virtual void idle_loop();
 121   volatile bool thinking = true; // Avoid a race with start_thinking()
 122 };
 123
 124 struct TimerThread : public ThreadBase {
 125
 126   static const int Resolution = 5; // Millisec between two check_time() calls
 127
 128   virtual void idle_loop();
 129
 130   bool run = false;
 131 };
 132
 133
 134 /// ThreadPool struct handles all the threads related stuff like init, starting,
 135 /// parking and, most importantly, launching a slave thread at a split point.
 136 /// All the access to shared thread data is done through this class.
 137
 138 struct ThreadPool : public std::vector<Thread*> {
 139
 140   void init(); // No c'tor and d'tor, threads rely on globals that should be
 141   void exit(); // initialized and are valid during the whole thread lifetime.
 142
 143   MainThread* main() { return static_cast<MainThread*>(at(0)); }
 144   void read_uci_options();
 145   Thread* available_slave(const Thread* master) const;
 146   void wait_for_think_finished();
 147   void start_thinking(const Position&, const Search::LimitsType&, Search::StateStackPtr&);
 148
 149   Depth minimumSplitDepth;
 150   std::mutex mutex;
 151   std::condition_variable sleepCondition;
 152   TimerThread* timer;
 153 };
 154
 155 extern ThreadPool Threads;
 156
 157 #endif // #ifndef THREAD_H_INCLUDED