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-2010 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 <cstring>
  24
  25 #include "lock.h"
  26 #include "material.h"
  27 #include "movepick.h"
  28 #include "pawns.h"
  29 #include "position.h"
  30
  31 const int MAX_THREADS = 32;
  32 const int MAX_ACTIVE_SPLIT_POINTS = 8;
  33
  34 struct SplitPoint {
  35
  36   // Const data after splitPoint has been setup
  37   SplitPoint* parent;
  38   const Position* pos;
  39   Depth depth;
  40   bool pvNode;
  41   Value beta;
  42   int ply;
  43   int master;
  44   Move threatMove;
  45
  46   // Const pointers to shared data
  47   MovePicker* mp;
  48   SearchStack* ss;
  49
  50   // Shared data
  51   Lock lock;
  52   volatile int64_t nodes;
  53   volatile Value alpha;
  54   volatile Value bestValue;
  55   volatile int moveCount;
  56   volatile bool betaCutoff;
  57   volatile int slaves[MAX_THREADS];
  58 };
  59
  60 // ThreadState type is used to represent thread's current state
  61 enum ThreadState
  62 {
  63   THREAD_INITIALIZING,  // thread is initializing itself
  64   THREAD_SEARCHING,     // thread is performing work
  65   THREAD_AVAILABLE,     // thread is waiting for work
  66   THREAD_BOOKED,        // other thread (master) has booked us as a slave
  67   THREAD_WORKISWAITING, // master has ordered us to start
  68   THREAD_TERMINATED     // we are quitting and thread is terminated
  69 };
  70
  71
  72 // We use per-thread Pawn and material hash tables so that once we get a
  73 // pointer to an entry its life time is unlimited and we don't have to
  74 // care about someone changing the entry under our feet.
  75
  76 struct Thread {
  77   MaterialInfoTable materialTable;
  78   PawnInfoTable pawnTable;
  79   int maxPly;
  80   Lock sleepLock;
  81   WaitCondition sleepCond;
  82   volatile ThreadState state;
  83   SplitPoint* volatile splitPoint;
  84   volatile int activeSplitPoints;
  85   SplitPoint splitPoints[MAX_ACTIVE_SPLIT_POINTS];
  86
  87   void wake_up() {
  88     lock_grab(&sleepLock);
  89     cond_signal(&sleepCond);
  90     lock_release(&sleepLock);
  91   }
  92 };
  93
  94
  95 // ThreadsManager class is used to handle all the threads related stuff like init,
  96 // starting, parking and, the most important, launching a slave thread at a split
  97 // point. All the access to shared thread data is done through this class.
  98
  99 class ThreadsManager {
 100   /* As long as the single ThreadsManager object is defined as a global we don't
 101      need to explicitly initialize to zero its data members because variables with
 102      static storage duration are automatically set to zero before enter main()
 103   */
 104 public:
 105   Thread& operator[](int threadID) { return threads[threadID]; }
 106   void init_threads();
 107   void exit_threads();
 108
 109   int min_split_depth() const { return minimumSplitDepth; }
 110   int active_threads() const { return activeThreads; }
 111   void set_active_threads(int cnt) { activeThreads = cnt; }
 112
 113   void read_uci_options();
 114   bool available_thread_exists(int master) const;
 115   bool thread_is_available(int slave, int master) const;
 116   bool cutoff_at_splitpoint(int threadID) const;
 117   void idle_loop(int threadID, SplitPoint* sp);
 118
 119   template <bool Fake>
 120   void split(Position& pos, SearchStack* ss, Value* alpha, const Value beta, Value* bestValue,
 121              Depth depth, Move threatMove, int moveCount, MovePicker* mp, bool pvNode);
 122 private:
 123   Lock mpLock;
 124   Depth minimumSplitDepth;
 125   int maxThreadsPerSplitPoint;
 126   bool useSleepingThreads;
 127   int activeThreads;
 128   volatile bool allThreadsShouldExit;
 129   Thread threads[MAX_THREADS];
 130 };
 131
 132 extern ThreadsManager ThreadsMgr;
 133
 134 #endif // !defined(THREAD_H_INCLUDED)