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