]> git.sesse.net Git - stockfish/blobdiff - src/thread.cpp
Simplify locking usage
[stockfish] / src / thread.cpp
index 536f22c1194cf6912eb578f550cf1d298d21d959..2c40ef6f8c14ecc7ccc218a01d06dada354d8874 100644 (file)
@@ -1,7 +1,7 @@
 /*
   Stockfish, a UCI chess playing engine derived from Glaurung 2.1
   Copyright (C) 2004-2008 Tord Romstad (Glaurung author)
-  Copyright (C) 2008-2010 Marco Costalba, Joona Kiiski, Tord Romstad
+  Copyright (C) 2008-2012 Marco Costalba, Joona Kiiski, Tord Romstad
 
   Stockfish is free software: you can redistribute it and/or modify
   it under the terms of the GNU General Public License as published by
   along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
 
+#include <cassert>
 #include <iostream>
 
+#include "movegen.h"
 #include "search.h"
 #include "thread.h"
 #include "ucioption.h"
 
-ThreadsManager Threads; // Global object definition
+using namespace Search;
+
+ThreadsManager Threads; // Global object
 
 namespace { extern "C" {
 
  // start_routine() is the C function which is called when a new thread
- // is launched. It simply calls idle_loop() of the supplied thread. The
- // last two threads are dedicated to read input from GUI and to mimic a
- // timer, so they run in listener_loop() and timer_loop() respectively.
+ // is launched. It simply calls idle_loop() of the supplied thread. The first
+ // and last thread are special. First one is the main search thread while the
+ // last one mimics a timer, they run in main_loop() and timer_loop().
 
 #if defined(_MSC_VER)
   DWORD WINAPI start_routine(LPVOID thread) {
@@ -38,13 +42,16 @@ namespace { extern "C" {
   void* start_routine(void* thread) {
 #endif
 
-    if (((Thread*)thread)->threadID == 0)
-        ((Thread*)thread)->main_loop();
+    Thread* th = (Thread*)thread;
+
+    if (th->threadID == 0)
+        th->main_loop();
+
+    else if (th->threadID == MAX_THREADS)
+        th->timer_loop();
 
-    else if (((Thread*)thread)->threadID == MAX_THREADS)
-        ((Thread*)thread)->timer_loop();
     else
-        ((Thread*)thread)->idle_loop(NULL);
+        th->idle_loop(NULL);
 
     return 0;
   }
@@ -57,9 +64,9 @@ namespace { extern "C" {
 
 void Thread::wake_up() {
 
-  lock_grab(&sleepLock);
-  cond_signal(&sleepCond);
-  lock_release(&sleepLock);
+  lock_grab(sleepLock);
+  cond_signal(sleepCond);
+  lock_release(sleepLock);
 }
 
 
@@ -71,6 +78,7 @@ bool Thread::cutoff_occurred() const {
   for (SplitPoint* sp = splitPoint; sp; sp = sp->parent)
       if (sp->is_betaCutoff)
           return true;
+
   return false;
 }
 
@@ -101,17 +109,16 @@ bool Thread::is_available_to(int master) const {
 }
 
 
-// read_uci_options() updates number of active threads and other internal
-// parameters according to the UCI options values. It is called before
-// to start a new search.
+// read_uci_options() updates number of active threads and other parameters
+// according to the UCI options values. It is called before to start a new search.
 
 void ThreadsManager::read_uci_options() {
 
-  maxThreadsPerSplitPoint = Options["Maximum Number of Threads per Split Point"].value<int>();
-  minimumSplitDepth       = Options["Minimum Split Depth"].value<int>() * ONE_PLY;
-  useSleepingThreads      = Options["Use Sleeping Threads"].value<bool>();
+  maxThreadsPerSplitPoint = Options["Max Threads per Split Point"];
+  minimumSplitDepth       = Options["Min Split Depth"] * ONE_PLY;
+  useSleepingThreads      = Options["Use Sleeping Threads"];
 
-  set_size(Options["Threads"].value<int>());
+  set_size(Options["Threads"]);
 }
 
 
@@ -129,9 +136,7 @@ void ThreadsManager::set_size(int cnt) {
       {
           // Dynamically allocate pawn and material hash tables according to the
           // number of active threads. This avoids preallocating memory for all
-          // possible threads if only few are used as, for instance, on mobile
-          // devices where memory is scarce and allocating for MAX_THREADS could
-          // even result in a crash.
+          // possible threads if only few are used.
           threads[i].pawnTable.init();
           threads[i].materialTable.init();
 
@@ -147,23 +152,21 @@ void ThreadsManager::set_size(int cnt) {
 
 void ThreadsManager::init() {
 
-  // Initialize sleep condition used to block waiting for end of searching
-  cond_init(&sleepCond);
-
-  // Initialize threads lock, used when allocating slaves during splitting
-  lock_init(&threadsLock);
+  // Initialize sleep condition and lock used by thread manager
+  cond_init(sleepCond);
+  lock_init(threadsLock);
 
-  // Initialize sleep and split point locks
+  // Initialize thread's sleep conditions and split point locks
   for (int i = 0; i <= MAX_THREADS; i++)
   {
-      lock_init(&threads[i].sleepLock);
-      cond_init(&threads[i].sleepCond);
+      lock_init(threads[i].sleepLock);
+      cond_init(threads[i].sleepCond);
 
       for (int j = 0; j < MAX_ACTIVE_SPLIT_POINTS; j++)
-          lock_init(&(threads[i].splitPoints[j].lock));
+          lock_init(threads[i].splitPoints[j].lock);
   }
 
-  // Initialize main thread's associated data
+  // Allocate main thread tables to call evaluate() also when not searching
   threads[0].pawnTable.init();
   threads[0].materialTable.init();
 
@@ -171,15 +174,10 @@ void ThreadsManager::init() {
   for (int i = 0; i <= MAX_THREADS; i++)
   {
       threads[i].is_searching = false;
-      threads[i].do_sleep = true;
+      threads[i].do_sleep = (i != 0); // Avoid a race with start_thinking()
       threads[i].threadID = i;
 
-#if defined(_MSC_VER)
-      threads[i].handle = CreateThread(NULL, 0, start_routine, (LPVOID)&threads[i], 0, NULL);
-      bool ok = (threads[i].handle != NULL);
-#else
-      bool ok = (pthread_create(&threads[i].handle, NULL, start_routine, (void*)&threads[i]) == 0);
-#endif
+      bool ok = thread_create(threads[i].handle, start_routine, threads[i]);
 
       if (!ok)
       {
@@ -196,39 +194,33 @@ void ThreadsManager::exit() {
 
   for (int i = 0; i <= MAX_THREADS; i++)
   {
-      threads[i].do_terminate = true;
+      threads[i].do_terminate = true; // Search must be already finished
       threads[i].wake_up();
 
-      // Wait for slave termination
-#if defined(_MSC_VER)
-      WaitForSingleObject(threads[i].handle, 0);
-      CloseHandle(threads[i].handle);
-#else
-      pthread_join(threads[i].handle, NULL);
-#endif
+      thread_join(threads[i].handle); // Wait for thread termination
 
-      // Now we can safely destroy locks and wait conditions
-      lock_destroy(&threads[i].sleepLock);
-      cond_destroy(&threads[i].sleepCond);
+      // Now we can safely destroy associated locks and wait conditions
+      lock_destroy(threads[i].sleepLock);
+      cond_destroy(threads[i].sleepCond);
 
       for (int j = 0; j < MAX_ACTIVE_SPLIT_POINTS; j++)
-          lock_destroy(&(threads[i].splitPoints[j].lock));
+          lock_destroy(threads[i].splitPoints[j].lock);
   }
 
-  lock_destroy(&threadsLock);
-  cond_destroy(&sleepCond);
+  lock_destroy(threadsLock);
+  cond_destroy(sleepCond);
 }
 
 
 // available_slave_exists() tries to find an idle thread which is available as
-// a slave for the thread with threadID "master".
+// a slave for the thread with threadID 'master'.
 
 bool ThreadsManager::available_slave_exists(int master) const {
 
   assert(master >= 0 && master < activeThreads);
 
   for (int i = 0; i < activeThreads; i++)
-      if (i != master && threads[i].is_available_to(master))
+      if (threads[i].is_available_to(master))
           return true;
 
   return false;
@@ -249,20 +241,20 @@ bool ThreadsManager::split_point_finished(SplitPoint* sp) const {
 
 
 // split() does the actual work of distributing the work at a node between
-// several available threads. If it does not succeed in splitting the
-// node (because no idle threads are available, or because we have no unused
-// split point objects), the function immediately returns. If splitting is
-// possible, a SplitPoint object is initialized with all the data that must be
-// copied to the helper threads and we tell our helper threads that they have
-// been assigned work. This will cause them to instantly leave their idle loops and
-// call search().When all threads have returned from search() then split() returns.
+// several available threads. If it does not succeed in splitting the node
+// (because no idle threads are available, or because we have no unused split
+// point objects), the function immediately returns. If splitting is possible, a
+// SplitPoint object is initialized with all the data that must be copied to the
+// helper threads and then helper threads are told that they have been assigned
+// work. This will cause them to instantly leave their idle loops and call
+// search(). When all threads have returned from search() then split() returns.
 
 template <bool Fake>
-Value ThreadsManager::split(Position& pos, SearchStack* ss, Value alpha, Value beta,
+Value ThreadsManager::split(Position& pos, Stack* ss, Value alpha, Value beta,
                             Value bestValue, Depth depth, Move threatMove,
                             int moveCount, MovePicker* mp, int nodeType) {
   assert(pos.pos_is_ok());
-  assert(bestValue >= -VALUE_INFINITE);
+  assert(bestValue > -VALUE_INFINITE);
   assert(bestValue <= alpha);
   assert(alpha < beta);
   assert(beta <= VALUE_INFINITE);
@@ -277,10 +269,10 @@ Value ThreadsManager::split(Position& pos, SearchStack* ss, Value alpha, Value b
   if (masterThread.activeSplitPoints >= MAX_ACTIVE_SPLIT_POINTS)
       return bestValue;
 
-  // Pick the next available split point object from the split point stack
-  SplitPoint* sp = masterThread.splitPoints + masterThread.activeSplitPoints;
+  // Pick the next available split point from the split point stack
+  SplitPoint* sp = &masterThread.splitPoints[masterThread.activeSplitPoints];
 
-  // Initialize the split point object
+  // Initialize the split point
   sp->parent = masterThread.splitPoint;
   sp->master = master;
   sp->is_betaCutoff = false;
@@ -295,6 +287,7 @@ Value ThreadsManager::split(Position& pos, SearchStack* ss, Value alpha, Value b
   sp->pos = &pos;
   sp->nodes = 0;
   sp->ss = ss;
+
   for (i = 0; i < activeThreads; i++)
       sp->is_slave[i] = false;
 
@@ -304,12 +297,12 @@ Value ThreadsManager::split(Position& pos, SearchStack* ss, Value alpha, Value b
   int workersCnt = 1; // At least the master is included
 
   // Try to allocate available threads and ask them to start searching setting
-  // the state to Thread::WORKISWAITING, this must be done under lock protection
-  // to avoid concurrent allocation of the same slave by another master.
-  lock_grab(&threadsLock);
+  // is_searching flag. This must be done under lock protection to avoid concurrent
+  // allocation of the same slave by another master.
+  lock_grab(threadsLock);
 
   for (i = 0; !Fake && i < activeThreads && workersCnt < maxThreadsPerSplitPoint; i++)
-      if (i != master && threads[i].is_available_to(master))
+      if (threads[i].is_available_to(master))
       {
           workersCnt++;
           sp->is_slave[i] = true;
@@ -322,7 +315,7 @@ Value ThreadsManager::split(Position& pos, SearchStack* ss, Value alpha, Value b
               threads[i].wake_up();
       }
 
-  lock_release(&threadsLock);
+  lock_release(threadsLock);
 
   // We failed to allocate even one slave, return
   if (!Fake && workersCnt == 1)
@@ -338,19 +331,19 @@ Value ThreadsManager::split(Position& pos, SearchStack* ss, Value alpha, Value b
   // their work at this split point.
   masterThread.idle_loop(sp);
 
-  // In helpful master concept a master can help only a sub-tree, and
-  // because here is all finished is not possible master is booked.
+  // In helpful master concept a master can help only a sub-tree of its split
+  // point, and because here is all finished is not possible master is booked.
   assert(!masterThread.is_searching);
 
   // We have returned from the idle loop, which means that all threads are
   // finished. Note that changing state and decreasing activeSplitPoints is done
   // under lock protection to avoid a race with Thread::is_available_to().
-  lock_grab(&threadsLock);
+  lock_grab(threadsLock);
 
   masterThread.is_searching = true;
   masterThread.activeSplitPoints--;
 
-  lock_release(&threadsLock);
+  lock_release(threadsLock);
 
   masterThread.splitPoint = sp->parent;
   pos.set_nodes_searched(pos.nodes_searched() + sp->nodes);
@@ -359,21 +352,22 @@ Value ThreadsManager::split(Position& pos, SearchStack* ss, Value alpha, Value b
 }
 
 // Explicit template instantiations
-template Value ThreadsManager::split<false>(Position&, SearchStack*, Value, Value, Value, Depth, Move, int, MovePicker*, int);
-template Value ThreadsManager::split<true>(Position&, SearchStack*, Value, Value, Value, Depth, Move, int, MovePicker*, int);
+template Value ThreadsManager::split<false>(Position&, Stack*, Value, Value, Value, Depth, Move, int, MovePicker*, int);
+template Value ThreadsManager::split<true>(Position&, Stack*, Value, Value, Value, Depth, Move, int, MovePicker*, int);
 
 
-// Thread::timer_loop() is where the timer thread waits maxPly milliseconds
-// and then calls do_timer_event().
+// Thread::timer_loop() is where the timer thread waits maxPly milliseconds and
+// then calls do_timer_event(). If maxPly is 0 thread sleeps until is woken up.
+extern void check_time();
 
 void Thread::timer_loop() {
 
   while (!do_terminate)
   {
-      lock_grab(&sleepLock);
-      timed_wait(&sleepCond, &sleepLock, maxPly ? maxPly : INT_MAX);
-      lock_release(&sleepLock);
-      do_timer_event();
+      lock_grab(sleepLock);
+      timed_wait(sleepCond, sleepLock, maxPly ? maxPly : INT_MAX);
+      lock_release(sleepLock);
+      check_time();
   }
 }
 
@@ -385,10 +379,10 @@ void ThreadsManager::set_timer(int msec) {
 
   Thread& timer = threads[MAX_THREADS];
 
-  lock_grab(&timer.sleepLock);
+  lock_grab(timer.sleepLock);
   timer.maxPly = msec;
-  cond_signal(&timer.sleepCond); // Wake up and restart the timer
-  lock_release(&timer.sleepLock);
+  cond_signal(timer.sleepCond); // Wake up and restart the timer
+  lock_release(timer.sleepLock);
 }
 
 
@@ -399,21 +393,20 @@ void Thread::main_loop() {
 
   while (true)
   {
-      lock_grab(&sleepLock);
+      lock_grab(sleepLock);
 
       do_sleep = true; // Always return to sleep after a search
-
       is_searching = false;
 
       while (do_sleep && !do_terminate)
       {
-          cond_signal(&Threads.sleepCond); // Wake up UI thread if needed
-          cond_wait(&sleepCond, &sleepLock);
+          cond_signal(Threads.sleepCond); // Wake up UI thread if needed
+          cond_wait(sleepCond, sleepLock);
       }
 
       is_searching = true;
 
-      lock_release(&sleepLock);
+      lock_release(sleepLock);
 
       if (do_terminate)
           return;
@@ -423,67 +416,85 @@ void Thread::main_loop() {
 }
 
 
-// ThreadsManager::wait_end_of_search() blocks UI thread until main thread has
-// returned to sleep in main_loop(). It is needed becuase xboard sends immediately
-// new position to search after a "stop" due to ponder miss.
-
-void ThreadsManager::wait_end_of_search() {
+// ThreadsManager::start_thinking() is used by UI thread to wake up the main
+// thread parked in main_loop() and starting a new search. If asyncMode is true
+// then function returns immediately, otherwise caller is blocked waiting for
+// the search to finish.
 
+void ThreadsManager::start_thinking(const Position& pos, const LimitsType& limits,
+                                    const std::set<Move>& searchMoves, bool async) {
   Thread& main = threads[0];
 
-  lock_grab(&main.sleepLock);
+  lock_grab(main.sleepLock);
 
+  // Wait main thread has finished before to launch a new search
   while (!main.do_sleep)
-      cond_wait(&sleepCond, &main.sleepLock);
+      cond_wait(sleepCond, main.sleepLock);
+
+  // Copy input arguments to initialize the search
+  RootPosition.copy(pos, 0);
+  Limits = limits;
+  RootMoves.clear();
+
+  // Populate RootMoves with all the legal moves (default) or, if a searchMoves
+  // set is given, with the subset of legal moves to search.
+  for (MoveList<MV_LEGAL> ml(pos); !ml.end(); ++ml)
+      if (searchMoves.empty() || searchMoves.count(ml.move()))
+          RootMoves.push_back(RootMove(ml.move()));
+
+  // Reset signals before to start the new search
+  Signals.stopOnPonderhit = Signals.firstRootMove = false;
+  Signals.stop = Signals.failedLowAtRoot = false;
+
+  main.do_sleep = false;
+  cond_signal(main.sleepCond); // Wake up main thread and start searching
+
+  if (!async)
+      while (!main.do_sleep)
+          cond_wait(sleepCond, main.sleepLock);
 
-  lock_release(&main.sleepLock);
+  lock_release(main.sleepLock);
 }
 
 
-// ThreadsManager::start_thinking() is used by UI thread to wake up the main
-// thread parked in main_loop() and starting a new search. If asyncMode is true
-// then function returns immediately, otherwise caller is blocked waiting for
-// the search to finish.
+// ThreadsManager::stop_thinking() is used by UI thread to raise a stop request
+// and to wait for the main thread finishing the search. Needed to wait exiting
+// and terminate the threads after a 'quit' command.
 
-void ThreadsManager::start_thinking(bool asyncMode) {
+void ThreadsManager::stop_thinking() {
 
   Thread& main = threads[0];
 
-  // Wait main thread has finished before to launch a new search
-  wait_end_of_search();
-
-  lock_grab(&main.sleepLock);
+  Search::Signals.stop = true;
 
-  // Reset signals before to start the search
-  memset((void*)&Search::Signals, 0, sizeof(Search::Signals));
+  lock_grab(main.sleepLock);
 
-  main.do_sleep = false;
-  cond_signal(&main.sleepCond); // Wake up main thread
+  cond_signal(main.sleepCond); // In case is waiting for stop or ponderhit
 
-  if (!asyncMode)
-      cond_wait(&sleepCond, &main.sleepLock);
+  while (!main.do_sleep)
+      cond_wait(sleepCond, main.sleepLock);
 
-  lock_release(&main.sleepLock);
+  lock_release(main.sleepLock);
 }
 
 
 // ThreadsManager::wait_for_stop_or_ponderhit() is called when the maximum depth
 // is reached while the program is pondering. The point is to work around a wrinkle
 // in the UCI protocol: When pondering, the engine is not allowed to give a
-// "bestmove" before the GUI sends it a "stop" or "ponderhit" command.
-// We simply wait here until one of these commands (that raise StopRequest) is
-// sent, and return, after which the bestmove and pondermove will be printed.
+// "bestmove" before the GUI sends it a "stop" or "ponderhit" command. We simply
+// wait here until one of these commands (that raise StopRequest) is sent and
+// then return, after which the bestmove and pondermove will be printed.
 
 void ThreadsManager::wait_for_stop_or_ponderhit() {
 
-  Search::Signals.stopOnPonderhit = true;
+  Signals.stopOnPonderhit = true;
 
   Thread& main = threads[0];
 
-  lock_grab(&main.sleepLock);
+  lock_grab(main.sleepLock);
 
-  while (!Search::Signals.stop)
-      cond_wait(&main.sleepCond, &main.sleepLock);
+  while (!Signals.stop)
+      cond_wait(main.sleepCond, main.sleepLock);
 
-  lock_release(&main.sleepLock);
+  lock_release(main.sleepLock);
 }