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 <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 const size_t MAX_SPLITPOINTS_PER_THREAD = 8;
  41 const size_t MAX_SLAVES_PER_SPLITPOINT = 4;
  42
  43 class Spinlock {
  44   std::atomic_int _lock;
  45
  46 public:
  47   Spinlock() { _lock = 1; } // Init here to workaround a bug with MSVC 2013
  48   void lock() {
  49       while (_lock.fetch_sub(1, std::memory_order_acquire) != 1)
  50           for (int cnt = 0; _lock.load(std::memory_order_relaxed) <= 0; ++cnt)
  51               if (cnt >= 10000) std::this_thread::yield(); // Be nice to hyperthreading
  52   }
  53   void unlock() { _lock.store(1, std::memory_order_release); }
  54 };
  55
  56
  57 /// SplitPoint struct stores information shared by the threads searching in
  58 /// parallel below the same split point. It is populated at splitting time.
  59
  60 struct SplitPoint {
  61
  62   // Const data after split point has been setup
  63   const Position* pos;
  64   Search::Stack* ss;
  65   Thread* master;
  66   Depth depth;
  67   Value beta;
  68   int nodeType;
  69   bool cutNode;
  70
  71   // Const pointers to shared data
  72   MovePicker* movePicker;
  73   SplitPoint* parentSplitPoint;
  74
  75   // Shared variable data
  76   Spinlock mutex;
  77   std::bitset<MAX_THREADS> slavesMask;
  78   volatile bool allSlavesSearching;
  79   volatile uint64_t nodes;
  80   volatile Value alpha;
  81   volatile Value bestValue;
  82   volatile Move bestMove;
  83   volatile int moveCount;
  84   volatile bool cutoff;
  85 };
  86
  87
  88 /// ThreadBase struct is the base of the hierarchy from where we derive all the
  89 /// specialized thread classes.
  90
  91 struct ThreadBase {
  92
  93   virtual ~ThreadBase() = default;
  94   virtual void idle_loop() = 0;
  95   void notify_one();
  96   void wait_for(volatile const bool& b);
  97
  98   std::thread nativeThread;
  99   Mutex mutex;
 100   ConditionVariable sleepCondition;
 101   volatile bool exit = false;
 102 };
 103
 104
 105 /// Thread struct keeps together all the thread related stuff like locks, state
 106 /// and especially split points. We also use per-thread pawn and material hash
 107 /// tables so that once we get a pointer to an entry its life time is unlimited
 108 /// and we don't have to care about someone changing the entry under our feet.
 109
 110 struct Thread : public ThreadBase {
 111
 112   Thread();
 113   virtual void idle_loop();
 114   bool cutoff_occurred() const;
 115   bool can_join(const SplitPoint* sp) const;
 116
 117   void split(Position& pos, Search::Stack* ss, Value alpha, Value beta, Value* bestValue, Move* bestMove,
 118              Depth depth, int moveCount, MovePicker* movePicker, int nodeType, bool cutNode);
 119
 120   SplitPoint splitPoints[MAX_SPLITPOINTS_PER_THREAD];
 121   Pawns::Table pawnsTable;
 122   Material::Table materialTable;
 123   Endgames endgames;
 124   Position* activePosition;
 125   size_t idx;
 126   int maxPly;
 127   SplitPoint* volatile activeSplitPoint;
 128   volatile size_t splitPointsSize;
 129   volatile bool searching;
 130   Spinlock allocMutex;
 131 };
 132
 133
 134 /// MainThread and TimerThread are derived classes used to characterize the two
 135 /// special threads: the main one and the recurring timer.
 136
 137 struct MainThread : public Thread {
 138   virtual void idle_loop();
 139   volatile bool thinking = true; // Avoid a race with start_thinking()
 140 };
 141
 142 struct TimerThread : public ThreadBase {
 143
 144   static const int Resolution = 5; // Millisec between two check_time() calls
 145
 146   virtual void idle_loop();
 147
 148   bool run = false;
 149 };
 150
 151
 152 /// ThreadPool struct handles all the threads related stuff like init, starting,
 153 /// parking and, most importantly, launching a slave thread at a split point.
 154 /// All the access to shared thread data is done through this class.
 155
 156 struct ThreadPool : public std::vector<Thread*> {
 157
 158   void init(); // No c'tor and d'tor, threads rely on globals that should be
 159   void exit(); // initialized and are valid during the whole thread lifetime.
 160
 161   MainThread* main() { return static_cast<MainThread*>(at(0)); }
 162   void read_uci_options();
 163   Thread* available_slave(const SplitPoint* sp) const;
 164   void wait_for_think_finished();
 165   void start_thinking(const Position&, const Search::LimitsType&, Search::StateStackPtr&);
 166
 167   Depth minimumSplitDepth;
 168   ConditionVariable sleepCondition;
 169   TimerThread* timer;
 170 };
 171
 172 extern ThreadPool Threads;
 173
 174 #endif // #ifndef THREAD_H_INCLUDED