git.sesse.net Git - stockfish/blob - src/thread.cpp

   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 #include <cassert>
  21 #include <iostream>
  22
  23 #include "movegen.h"
  24 #include "search.h"
  25 #include "thread.h"
  26 #include "ucioption.h"
  27
  28 using namespace Search;
  29
  30 ThreadPool Threads; // Global object
  31
  32 namespace { extern "C" {
  33
  34  // start_routine() is the C function which is called when a new thread
  35  // is launched. It is a wrapper to the virtual function idle_loop().
  36
  37  long start_routine(Thread* th) { th->idle_loop(); return 0; }
  38
  39 } }
  40
  41
  42 // Thread c'tor starts a newly-created thread of execution that will call
  43 // the the virtual function idle_loop(), going immediately to sleep.
  44
  45 Thread::Thread() : splitPoints() {
  46
  47   searching = exit = false;
  48   maxPly = splitPointsSize = 0;
  49   activeSplitPoint = NULL;
  50   idx = Threads.size();
  51
  52   if (!thread_create(handle, start_routine, this))
  53   {
  54       std::cerr << "Failed to create thread number " << idx << std::endl;
  55       ::exit(EXIT_FAILURE);
  56   }
  57 }
  58
  59
  60 // Thread d'tor waits for thread termination before to return
  61
  62 Thread::~Thread() {
  63
  64   exit = true; // Search must be already finished
  65   notify_one();
  66   thread_join(handle); // Wait for thread termination
  67 }
  68
  69
  70 // TimerThread::idle_loop() is where the timer thread waits msec milliseconds
  71 // and then calls check_time(). If msec is 0 thread sleeps until is woken up.
  72 extern void check_time();
  73
  74 void TimerThread::idle_loop() {
  75
  76   while (!exit)
  77   {
  78       mutex.lock();
  79
  80       if (!exit)
  81           sleepCondition.wait_for(mutex, msec ? msec : INT_MAX);
  82
  83       mutex.unlock();
  84
  85       if (msec)
  86           check_time();
  87   }
  88 }
  89
  90
  91 // MainThread::idle_loop() is where the main thread is parked waiting to be started
  92 // when there is a new search. Main thread will launch all the slave threads.
  93
  94 void MainThread::idle_loop() {
  95
  96   while (true)
  97   {
  98       mutex.lock();
  99
 100       thinking = false;
 101
 102       while (!thinking && !exit)
 103       {
 104           Threads.sleepCondition.notify_one(); // Wake up UI thread if needed
 105           sleepCondition.wait(mutex);
 106       }
 107
 108       mutex.unlock();
 109
 110       if (exit)
 111           return;
 112
 113       searching = true;
 114
 115       Search::think();
 116
 117       assert(searching);
 118
 119       searching = false;
 120   }
 121 }
 122
 123
 124 // Thread::notify_one() wakes up the thread when there is some search to do
 125
 126 void Thread::notify_one() {
 127
 128   mutex.lock();
 129   sleepCondition.notify_one();
 130   mutex.unlock();
 131 }
 132
 133
 134 // Thread::wait_for() set the thread to sleep until condition 'b' turns true
 135
 136 void Thread::wait_for(volatile const bool& b) {
 137
 138   mutex.lock();
 139   while (!b) sleepCondition.wait(mutex);
 140   mutex.unlock();
 141 }
 142
 143
 144 // Thread::cutoff_occurred() checks whether a beta cutoff has occurred in the
 145 // current active split point, or in some ancestor of the split point.
 146
 147 bool Thread::cutoff_occurred() const {
 148
 149   for (SplitPoint* sp = activeSplitPoint; sp; sp = sp->parent)
 150       if (sp->cutoff)
 151           return true;
 152
 153   return false;
 154 }
 155
 156
 157 // Thread::is_available_to() checks whether the thread is available to help the
 158 // thread 'master' at a split point. An obvious requirement is that thread must
 159 // be idle. With more than two threads, this is not sufficient: If the thread is
 160 // the master of some split point, it is only available as a slave to the slaves
 161 // which are busy searching the split point at the top of slaves split point
 162 // stack (the "helpful master concept" in YBWC terminology).
 163
 164 bool Thread::is_available_to(Thread* master) const {
 165
 166   if (searching)
 167       return false;
 168
 169   // Make a local copy to be sure doesn't become zero under our feet while
 170   // testing next condition and so leading to an out of bound access.
 171   int size = splitPointsSize;
 172
 173   // No split points means that the thread is available as a slave for any
 174   // other thread otherwise apply the "helpful master" concept if possible.
 175   return !size || (splitPoints[size - 1].slavesMask & (1ULL << master->idx));
 176 }
 177
 178
 179 // init() is called at startup. Initializes lock and condition variable and
 180 // launches requested threads sending them immediately to sleep. We cannot use
 181 // a c'tor becuase Threads is a static object and we need a fully initialized
 182 // engine at this point due to allocation of endgames in Thread c'tor.
 183
 184 void ThreadPool::init() {
 185
 186   sleepWhileIdle = true;
 187   timer = new TimerThread();
 188   threads.push_back(new MainThread());
 189   read_uci_options();
 190 }
 191
 192
 193 // exit() cleanly terminates the threads before the program exits.
 194
 195 void ThreadPool::exit() {
 196
 197   delete timer; // As first becuase check_time() accesses threads data
 198
 199   for (size_t i = 0; i < threads.size(); i++)
 200       delete threads[i];
 201 }
 202
 203
 204 // read_uci_options() updates internal threads parameters from the corresponding
 205 // UCI options and creates/destroys threads to match the requested number. Thread
 206 // objects are dynamically allocated to avoid creating in advance all possible
 207 // threads, with included pawns and material tables, if only few are used.
 208
 209 void ThreadPool::read_uci_options() {
 210
 211   maxThreadsPerSplitPoint = Options["Max Threads per Split Point"];
 212   minimumSplitDepth       = Options["Min Split Depth"] * ONE_PLY;
 213   size_t requested        = Options["Threads"];
 214
 215   assert(requested > 0);
 216
 217   while (threads.size() < requested)
 218       threads.push_back(new Thread());
 219
 220   while (threads.size() > requested)
 221   {
 222       delete threads.back();
 223       threads.pop_back();
 224   }
 225 }
 226
 227
 228 // slave_available() tries to find an idle thread which is available as a slave
 229 // for the thread 'master'.
 230
 231 bool ThreadPool::slave_available(Thread* master) const {
 232
 233   for (size_t i = 0; i < threads.size(); i++)
 234       if (threads[i]->is_available_to(master))
 235           return true;
 236
 237   return false;
 238 }
 239
 240
 241 // split() does the actual work of distributing the work at a node between
 242 // several available threads. If it does not succeed in splitting the node
 243 // (because no idle threads are available, or because we have no unused split
 244 // point objects), the function immediately returns. If splitting is possible, a
 245 // SplitPoint object is initialized with all the data that must be copied to the
 246 // helper threads and then helper threads are told that they have been assigned
 247 // work. This will cause them to instantly leave their idle loops and call
 248 // search(). When all threads have returned from search() then split() returns.
 249
 250 template <bool Fake>
 251 Value ThreadPool::split(Position& pos, Stack* ss, Value alpha, Value beta,
 252                         Value bestValue, Move* bestMove, Depth depth, Move threatMove,
 253                         int moveCount, MovePicker& mp, int nodeType) {
 254
 255   assert(pos.pos_is_ok());
 256   assert(bestValue > -VALUE_INFINITE);
 257   assert(bestValue <= alpha);
 258   assert(alpha < beta);
 259   assert(beta <= VALUE_INFINITE);
 260   assert(depth > DEPTH_ZERO);
 261
 262   Thread* master = pos.this_thread();
 263
 264   if (master->splitPointsSize >= MAX_SPLITPOINTS_PER_THREAD)
 265       return bestValue;
 266
 267   // Pick the next available split point from the split point stack
 268   SplitPoint& sp = master->splitPoints[master->splitPointsSize];
 269
 270   sp.master = master;
 271   sp.parent = master->activeSplitPoint;
 272   sp.slavesMask = 1ULL << master->idx;
 273   sp.depth = depth;
 274   sp.bestMove = *bestMove;
 275   sp.threatMove = threatMove;
 276   sp.alpha = alpha;
 277   sp.beta = beta;
 278   sp.nodeType = nodeType;
 279   sp.bestValue = bestValue;
 280   sp.mp = &mp;
 281   sp.moveCount = moveCount;
 282   sp.pos = &pos;
 283   sp.nodes = 0;
 284   sp.cutoff = false;
 285   sp.ss = ss;
 286
 287   master->activeSplitPoint = &sp;
 288   int slavesCnt = 0;
 289
 290   assert(master->searching);
 291
 292   // Try to allocate available threads and ask them to start searching setting
 293   // 'searching' flag. This must be done under lock protection to avoid concurrent
 294   // allocation of the same slave by another master.
 295   mutex.lock();
 296   sp.mutex.lock();
 297
 298   for (size_t i = 0; i < threads.size() && !Fake; ++i)
 299       if (threads[i]->is_available_to(master))
 300       {
 301           sp.slavesMask |= 1ULL << i;
 302           threads[i]->activeSplitPoint = &sp;
 303           threads[i]->searching = true; // Slave leaves idle_loop()
 304           threads[i]->notify_one(); // Could be sleeping
 305
 306           if (++slavesCnt + 1 >= maxThreadsPerSplitPoint) // Include master
 307               break;
 308       }
 309
 310   master->splitPointsSize++;
 311
 312   sp.mutex.unlock();
 313   mutex.unlock();
 314
 315   // Everything is set up. The master thread enters the idle loop, from which
 316   // it will instantly launch a search, because its 'searching' flag is set.
 317   // The thread will return from the idle loop when all slaves have finished
 318   // their work at this split point.
 319   if (slavesCnt || Fake)
 320   {
 321       master->Thread::idle_loop(); // Force a call to base class idle_loop()
 322
 323       // In helpful master concept a master can help only a sub-tree of its split
 324       // point, and because here is all finished is not possible master is booked.
 325       assert(!master->searching);
 326   }
 327
 328   // We have returned from the idle loop, which means that all threads are
 329   // finished. Note that setting 'searching' and decreasing splitPointsSize is
 330   // done under lock protection to avoid a race with Thread::is_available_to().
 331   mutex.lock();
 332   sp.mutex.lock();
 333
 334   master->searching = true;
 335   master->splitPointsSize--;
 336   master->activeSplitPoint = sp.parent;
 337   pos.set_nodes_searched(pos.nodes_searched() + sp.nodes);
 338   *bestMove = sp.bestMove;
 339
 340   sp.mutex.unlock();
 341   mutex.unlock();
 342
 343   return sp.bestValue;
 344 }
 345
 346 // Explicit template instantiations
 347 template Value ThreadPool::split<false>(Position&, Stack*, Value, Value, Value, Move*, Depth, Move, int, MovePicker&, int);
 348 template Value ThreadPool::split<true>(Position&, Stack*, Value, Value, Value, Move*, Depth, Move, int, MovePicker&, int);
 349
 350
 351 // wait_for_think_finished() waits for main thread to go to sleep then returns
 352
 353 void ThreadPool::wait_for_think_finished() {
 354
 355   MainThread* t = main_thread();
 356   t->mutex.lock();
 357   while (t->thinking) sleepCondition.wait(t->mutex);
 358   t->mutex.unlock();
 359 }
 360
 361
 362 // start_thinking() wakes up the main thread sleeping in  main_loop() so to start
 363 // a new search, then returns immediately.
 364
 365 void ThreadPool::start_thinking(const Position& pos, const LimitsType& limits,
 366                                 const std::vector<Move>& searchMoves, StateStackPtr& states) {
 367   wait_for_think_finished();
 368
 369   SearchTime = Time::now(); // As early as possible
 370
 371   Signals.stopOnPonderhit = Signals.firstRootMove = false;
 372   Signals.stop = Signals.failedLowAtRoot = false;
 373
 374   RootPos = pos;
 375   Limits = limits;
 376   SetupStates = states; // Ownership transfer here
 377   RootMoves.clear();
 378
 379   for (MoveList<LEGAL> ml(pos); !ml.end(); ++ml)
 380       if (searchMoves.empty() || count(searchMoves.begin(), searchMoves.end(), ml.move()))
 381           RootMoves.push_back(RootMove(ml.move()));
 382
 383   main_thread()->thinking = true;
 384   main_thread()->notify_one(); // Starts main thread
 385 }