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-2014 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 <vector>
  25
  26 #include "material.h"
  27 #include "movepick.h"
  28 #include "pawns.h"
  29 #include "position.h"
  30 #include "search.h"
  31
  32 const int MAX_THREADS = 128;
  33 const int MAX_SPLITPOINTS_PER_THREAD = 8;
  34
  35 struct Mutex {
  36   Mutex() { lock_init(l); }
  37  ~Mutex() { lock_destroy(l); }
  38
  39   void lock() { lock_grab(l); }
  40   void unlock() { lock_release(l); }
  41
  42 private:
  43   friend struct ConditionVariable;
  44
  45   Lock l;
  46 };
  47
  48 struct ConditionVariable {
  49   ConditionVariable() { cond_init(c); }
  50  ~ConditionVariable() { cond_destroy(c); }
  51
  52   void wait(Mutex& m) { cond_wait(c, m.l); }
  53   void wait_for(Mutex& m, int ms) { timed_wait(c, m.l, ms); }
  54   void notify_one() { cond_signal(c); }
  55
  56 private:
  57   WaitCondition c;
  58 };
  59
  60 struct Thread;
  61
  62 struct SplitPoint {
  63
  64   // Const data after split point has been setup
  65   const Position* pos;
  66   const Search::Stack* ss;
  67   Thread* masterThread;
  68   Depth depth;
  69   Value beta;
  70   int nodeType;
  71   bool cutNode;
  72
  73   // Const pointers to shared data
  74   MovePicker* movePicker;
  75   SplitPoint* parentSplitPoint;
  76
  77   // Shared data
  78   Mutex mutex;
  79   std::bitset<MAX_THREADS> slavesMask;
  80   volatile bool allowLatejoin;
  81   volatile uint64_t nodes;
  82   volatile Value alpha;
  83   volatile Value bestValue;
  84   volatile Move bestMove;
  85   volatile int moveCount;
  86   volatile bool cutoff;
  87 };
  88
  89
  90 /// ThreadBase struct is the base of the hierarchy from where we derive all the
  91 /// specialized thread classes.
  92
  93 struct ThreadBase {
  94
  95   ThreadBase() : handle(NativeHandle()), exit(false) {}
  96   virtual ~ThreadBase() {}
  97   virtual void idle_loop() = 0;
  98   void notify_one();
  99   void wait_for(volatile const bool& b);
 100
 101   Mutex mutex;
 102   ConditionVariable sleepCondition;
 103   NativeHandle handle;
 104   volatile bool exit;
 105 };
 106
 107
 108 /// Thread struct keeps together all the thread related stuff like locks, state
 109 /// and especially split points. We also use per-thread pawn and material hash
 110 /// tables so that once we get a pointer to an entry its life time is unlimited
 111 /// and we don't have to care about someone changing the entry under our feet.
 112
 113 struct Thread : public ThreadBase {
 114
 115   Thread();
 116   virtual void idle_loop();
 117   bool attempt_to_latejoin();
 118   bool cutoff_occurred() const;
 119   bool available_to(const Thread* master, bool latejoin) const;
 120
 121   template <bool Fake>
 122   void split(Position& pos, const Search::Stack* ss, Value alpha, Value beta, Value* bestValue, Move* bestMove,
 123              Depth depth, int moveCount, MovePicker* movePicker, int nodeType, bool cutNode);
 124
 125   SplitPoint splitPoints[MAX_SPLITPOINTS_PER_THREAD];
 126   Material::Table materialTable;
 127   Endgames endgames;
 128   Pawns::Table pawnsTable;
 129   Position* activePosition;
 130   size_t idx;
 131   int maxPly;
 132   SplitPoint* volatile activeSplitPoint;
 133   volatile int splitPointsSize;
 134   volatile bool searching;
 135 };
 136
 137
 138 /// MainThread and TimerThread are derived classes used to characterize the two
 139 /// special threads: the main one and the recurring timer.
 140
 141 struct MainThread : public Thread {
 142   MainThread() : thinking(true) {} // Avoid a race with start_thinking()
 143   virtual void idle_loop();
 144   volatile bool thinking;
 145 };
 146
 147 struct TimerThread : public ThreadBase {
 148   TimerThread() : run(false) {}
 149   virtual void idle_loop();
 150   bool run;
 151   static const int Resolution = 5; // msec between two check_time() calls
 152 };
 153
 154
 155 /// ThreadPool struct handles all the threads related stuff like init, starting,
 156 /// parking and, most importantly, launching a slave thread at a split point.
 157 /// All the access to shared thread data is done through this class.
 158
 159 struct ThreadPool : public std::vector<Thread*> {
 160
 161   void init(); // No c'tor and d'tor, threads rely on globals that should
 162   void exit(); // be initialized and are valid during the whole thread lifetime.
 163
 164   MainThread* main() { return static_cast<MainThread*>((*this)[0]); }
 165   void read_uci_options();
 166   Thread* available_slave(const Thread* master) const;
 167   void wait_for_think_finished();
 168   void start_thinking(const Position&, const Search::LimitsType&, Search::StateStackPtr&);
 169
 170   bool sleepWhileIdle;
 171   Depth minimumSplitDepth;
 172   Mutex mutex;
 173   ConditionVariable sleepCondition;
 174   TimerThread* timer;
 175 };
 176
 177 extern ThreadPool Threads;
 178
 179 #endif // #ifndef THREAD_H_INCLUDED