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-2012 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 #if !defined(THREAD_H_INCLUDED)
  21 #define THREAD_H_INCLUDED
  22
  23 #include <vector>
  24
  25 #include "material.h"
  26 #include "movepick.h"
  27 #include "pawns.h"
  28 #include "position.h"
  29 #include "search.h"
  30
  31 const int MAX_THREADS = 32;
  32 const int MAX_SPLITPOINTS_PER_THREAD = 8;
  33
  34 struct Mutex {
  35   Mutex() { lock_init(l); }
  36  ~Mutex() { lock_destroy(l); }
  37
  38   void lock() { lock_grab(l); }
  39   void unlock() { lock_release(l); }
  40
  41 private:
  42   friend struct ConditionVariable;
  43
  44   Lock l;
  45 };
  46
  47 struct ConditionVariable {
  48   ConditionVariable() { cond_init(c); }
  49  ~ConditionVariable() { cond_destroy(c); }
  50
  51   void wait(Mutex& m) { cond_wait(c, m.l); }
  52   void wait_for(Mutex& m, int ms) { timed_wait(c, m.l, ms); }
  53   void notify_one() { cond_signal(c); }
  54
  55 private:
  56   WaitCondition c;
  57 };
  58
  59 class Thread;
  60
  61 struct SplitPoint {
  62
  63   // Const data after split point has been setup
  64   const Position* pos;
  65   const Search::Stack* ss;
  66   Depth depth;
  67   Value beta;
  68   int nodeType;
  69   Thread* master;
  70   Move threatMove;
  71
  72   // Const pointers to shared data
  73   MovePicker* mp;
  74   SplitPoint* parent;
  75
  76   // Shared data
  77   Mutex mutex;
  78   Position* activePositions[MAX_THREADS];
  79   volatile uint64_t slavesMask;
  80   volatile int64_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 /// Thread struct keeps together all the thread related stuff like locks, state
  90 /// and especially split points. We also use per-thread pawn and material hash
  91 /// tables so that once we get a pointer to an entry its life time is unlimited
  92 /// and we don't have to care about someone changing the entry under our feet.
  93
  94 class Thread {
  95
  96   typedef void (Thread::* Fn) (); // Pointer to member function
  97
  98 public:
  99   Thread(Fn fn);
 100  ~Thread();
 101
 102   void wake_up();
 103   bool cutoff_occurred() const;
 104   bool is_available_to(Thread* master) const;
 105   void idle_loop();
 106   void main_loop();
 107   void timer_loop();
 108   void wait_for_stop_or_ponderhit();
 109
 110   SplitPoint splitPoints[MAX_SPLITPOINTS_PER_THREAD];
 111   MaterialTable materialTable;
 112   PawnTable pawnTable;
 113   size_t idx;
 114   int maxPly;
 115   Mutex mutex;
 116   ConditionVariable sleepCondition;
 117   NativeHandle handle;
 118   Fn start_fn;
 119   SplitPoint* volatile curSplitPoint;
 120   volatile int splitPointsCnt;
 121   volatile bool is_searching;
 122   volatile bool do_sleep;
 123   volatile bool do_exit;
 124 };
 125
 126
 127 /// ThreadPool class handles all the threads related stuff like init, starting,
 128 /// parking and, the most important, launching a slave thread at a split point.
 129 /// All the access to shared thread data is done through this class.
 130
 131 class ThreadPool {
 132
 133 public:
 134   void init(); // No c'tor and d'tor, threads rely on globals that should
 135   void exit(); // be initialized and valid during the whole thread lifetime.
 136
 137   Thread& operator[](size_t id) { return *threads[id]; }
 138   bool use_sleeping_threads() const { return useSleepingThreads; }
 139   int min_split_depth() const { return minimumSplitDepth; }
 140   size_t size() const { return threads.size(); }
 141   Thread* main_thread() { return threads[0]; }
 142
 143   void wake_up() const;
 144   void sleep() const;
 145   void read_uci_options();
 146   bool available_slave_exists(Thread* master) const;
 147   void set_timer(int msec);
 148   void wait_for_search_finished();
 149   void start_searching(const Position&, const Search::LimitsType&,
 150                        const std::vector<Move>&, Search::StateStackPtr&);
 151
 152   template <bool Fake>
 153   Value split(Position& pos, Search::Stack* ss, Value alpha, Value beta, Value bestValue, Move* bestMove,
 154               Depth depth, Move threatMove, int moveCount, MovePicker& mp, int nodeType);
 155 private:
 156   friend class Thread;
 157   friend void check_time();
 158
 159   std::vector<Thread*> threads;
 160   Thread* timer;
 161   Mutex mutex;
 162   ConditionVariable sleepCondition;
 163   Depth minimumSplitDepth;
 164   int maxThreadsPerSplitPoint;
 165   bool useSleepingThreads;
 166 };
 167
 168 extern ThreadPool Threads;
 169
 170 #endif // !defined(THREAD_H_INCLUDED)