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 "evaluate.h"
  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 = 32;
  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 class 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   Depth depth;
  68   Value beta;
  69   int nodeType;
  70   Thread* master;
  71   Move threatMove;
  72
  73   // Const pointers to shared data
  74   MovePicker* mp;
  75   SplitPoint* parent;
  76
  77   // Shared data
  78   Mutex mutex;
  79   Position* activePositions[MAX_THREADS];
  80   volatile uint64_t slavesMask;
  81   volatile int64_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 /// Thread struct keeps together all the thread related stuff like locks, state
  91 /// and especially split points. We also use per-thread pawn and material hash
  92 /// tables so that once we get a pointer to an entry its life time is unlimited
  93 /// and we don't have to care about someone changing the entry under our feet.
  94
  95 class Thread {
  96
  97   typedef void (Thread::* Fn) (); // Pointer to member function
  98
  99 public:
 100   Thread(Fn fn);
 101  ~Thread();
 102
 103   void wake_up();
 104   bool cutoff_occurred() const;
 105   bool is_available_to(Thread* master) const;
 106   void idle_loop();
 107   void main_loop();
 108   void timer_loop();
 109   void wait_for_stop_or_ponderhit();
 110
 111   SplitPoint splitPoints[MAX_SPLITPOINTS_PER_THREAD];
 112   Eval::Table evalTable;
 113   MaterialTable materialTable;
 114   PawnTable pawnTable;
 115   size_t idx;
 116   int maxPly;
 117   Mutex mutex;
 118   ConditionVariable sleepCondition;
 119   NativeHandle handle;
 120   Fn start_fn;
 121   SplitPoint* volatile curSplitPoint;
 122   volatile int splitPointsCnt;
 123   volatile bool is_searching;
 124   volatile bool do_sleep;
 125   volatile bool do_exit;
 126 };
 127
 128
 129 /// ThreadPool class handles all the threads related stuff like init, starting,
 130 /// parking and, the most important, launching a slave thread at a split point.
 131 /// All the access to shared thread data is done through this class.
 132
 133 class ThreadPool {
 134
 135 public:
 136   void init(); // No c'tor and d'tor, threads rely on globals that should
 137   void exit(); // be initialized and valid during the whole thread lifetime.
 138
 139   Thread& operator[](size_t id) { return *threads[id]; }
 140   bool use_sleeping_threads() const { return useSleepingThreads; }
 141   int min_split_depth() const { return minimumSplitDepth; }
 142   size_t size() const { return threads.size(); }
 143   Thread* main_thread() { return threads[0]; }
 144
 145   void wake_up() const;
 146   void sleep() const;
 147   void read_uci_options();
 148   bool available_slave_exists(Thread* master) const;
 149   void set_timer(int msec);
 150   void wait_for_search_finished();
 151   void start_searching(const Position&, const Search::LimitsType&,
 152                        const std::vector<Move>&, Search::StateStackPtr&);
 153
 154   template <bool Fake>
 155   Value split(Position& pos, Search::Stack* ss, Value alpha, Value beta, Value bestValue, Move* bestMove,
 156               Depth depth, Move threatMove, int moveCount, MovePicker& mp, int nodeType);
 157 private:
 158   friend class Thread;
 159   friend void check_time();
 160
 161   std::vector<Thread*> threads;
 162   Thread* timer;
 163   Mutex mutex;
 164   ConditionVariable sleepCondition;
 165   Depth minimumSplitDepth;
 166   int maxThreadsPerSplitPoint;
 167   bool useSleepingThreads;
 168 };
 169
 170 extern ThreadPool Threads;
 171
 172 #endif // !defined(THREAD_H_INCLUDED)