X-Git-Url: https://git.sesse.net/?p=stockfish;a=blobdiff_plain;f=src%2Fthread.cpp;h=b38bdd6ed51e2848fd60770c936d7a80793e427c;hp=9f5a13f8624dac701d3827ee0d2beefca76e8cf4;hb=ca14345ba26fc40e1039029659f57028f510502f;hpb=e4efc8b74159a77e77d0d6b53c9ef7215cfdcb9a diff --git a/src/thread.cpp b/src/thread.cpp index 9f5a13f8..b38bdd6e 100644 --- a/src/thread.cpp +++ b/src/thread.cpp @@ -1,7 +1,8 @@ /* Stockfish, a UCI chess playing engine derived from Glaurung 2.1 Copyright (C) 2004-2008 Tord Romstad (Glaurung author) - Copyright (C) 2008-2012 Marco Costalba, Joona Kiiski, Tord Romstad + Copyright (C) 2008-2015 Marco Costalba, Joona Kiiski, Tord Romstad + Copyright (C) 2015-2016 Marco Costalba, Joona Kiiski, Gary Linscott, 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 @@ -17,458 +18,192 @@ along with this program. If not, see . */ +#include // For std::count #include -#include #include "movegen.h" #include "search.h" #include "thread.h" -#include "ucioption.h" +#include "uci.h" +#include "syzygy/tbprobe.h" -using namespace Search; +ThreadPool Threads; // Global object -ThreadsManager Threads; // Global object +/// Thread constructor launches the thread and then waits until it goes to sleep +/// in idle_loop(). -namespace { extern "C" { +Thread::Thread() { - // start_routine() is the C function which is called when a new thread - // is launched. It is a wrapper to member function pointed by start_fn + resetCalls = exit = false; + maxPly = callsCnt = 0; + history.clear(); + counterMoves.clear(); + idx = Threads.size(); // Start from 0 - long start_routine(Thread* th) { (th->*(th->start_fn))(); return 0; } + std::unique_lock lk(mutex); + searching = true; + nativeThread = std::thread(&Thread::idle_loop, this); + sleepCondition.wait(lk, [&]{ return !searching; }); +} -} } +/// Thread destructor waits for thread termination before returning -// Thread c'tor starts a newly-created thread of execution that will call -// the idle loop function pointed by start_fn going immediately to sleep. +Thread::~Thread() { -Thread::Thread(Fn fn) { + mutex.lock(); + exit = true; + sleepCondition.notify_one(); + mutex.unlock(); + nativeThread.join(); +} - is_searching = do_exit = false; - maxPly = splitPointsCnt = 0; - curSplitPoint = NULL; - start_fn = fn; - threadID = Threads.size(); - do_sleep = (threadID != 0); // Avoid a race with start_thinking() - lock_init(sleepLock); - cond_init(sleepCond); +/// Thread::wait_for_search_finished() waits on sleep condition +/// until not searching - for (int j = 0; j < MAX_SPLITPOINTS_PER_THREAD; j++) - lock_init(splitPoints[j].lock); +void Thread::wait_for_search_finished() { - if (!thread_create(handle, start_routine, this)) - { - std::cerr << "Failed to create thread number " << threadID << std::endl; - ::exit(EXIT_FAILURE); - } + std::unique_lock lk(mutex); + sleepCondition.wait(lk, [&]{ return !searching; }); } -// Thread d'tor will wait for thread termination before to return. +/// Thread::wait() waits on sleep condition until condition is true -Thread::~Thread() { +void Thread::wait(std::atomic_bool& condition) { - assert(do_sleep); - - do_exit = true; // Search must be already finished - wake_up(); + std::unique_lock lk(mutex); + sleepCondition.wait(lk, [&]{ return bool(condition); }); +} - thread_join(handle); // Wait for thread termination - lock_destroy(sleepLock); - cond_destroy(sleepCond); +/// Thread::start_searching() wakes up the thread that will start the search - for (int j = 0; j < MAX_SPLITPOINTS_PER_THREAD; j++) - lock_destroy(splitPoints[j].lock); -} +void Thread::start_searching(bool resume) { + std::unique_lock lk(mutex); -// 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(); + if (!resume) + searching = true; -void Thread::timer_loop() { - - while (!do_exit) - { - lock_grab(sleepLock); - timed_wait(sleepCond, sleepLock, maxPly ? maxPly : INT_MAX); - lock_release(sleepLock); - check_time(); - } + sleepCondition.notify_one(); } -// Thread::main_loop() is where the main thread is parked waiting to be started -// when there is a new search. Main thread will launch all the slave threads. +/// Thread::idle_loop() is where the thread is parked when it has no work to do -void Thread::main_loop() { +void Thread::idle_loop() { - while (true) + while (!exit) { - lock_grab(sleepLock); + std::unique_lock lk(mutex); - do_sleep = true; // Always return to sleep after a search - is_searching = false; + searching = false; - while (do_sleep && !do_exit) + while (!searching && !exit) { - cond_signal(Threads.sleepCond); // Wake up UI thread if needed - cond_wait(sleepCond, sleepLock); + sleepCondition.notify_one(); // Wake up any waiting thread + sleepCondition.wait(lk); } - lock_release(sleepLock); - - if (do_exit) - return; - - is_searching = true; + lk.unlock(); - Search::think(); + if (!exit) + search(); } } -// Thread::wake_up() wakes up the thread, normally at the beginning of the search -// or, if "sleeping threads" is used, when there is some work to do. +/// ThreadPool::init() creates and launches requested threads that will go +/// immediately to sleep. We cannot use a constructor because Threads is a +/// static object and we need a fully initialized engine at this point due to +/// allocation of Endgames in the Thread constructor. -void Thread::wake_up() { +void ThreadPool::init() { - lock_grab(sleepLock); - cond_signal(sleepCond); - lock_release(sleepLock); + push_back(new MainThread); + read_uci_options(); } -// Thread::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 -// then return, after which the bestmove and pondermove will be printed. - -void Thread::wait_for_stop_or_ponderhit() { - - Signals.stopOnPonderhit = true; - - lock_grab(sleepLock); +/// ThreadPool::exit() terminates threads before the program exits. Cannot be +/// done in destructor because threads must be terminated before deleting any +/// static objects while still in main(). - while (!Signals.stop) - cond_wait(sleepCond, sleepLock); +void ThreadPool::exit() { - lock_release(sleepLock); + while (size()) + delete back(), pop_back(); } -// cutoff_occurred() checks whether a beta cutoff has occurred in the current -// active split point, or in some ancestor of the split point. - -bool Thread::cutoff_occurred() const { - - for (SplitPoint* sp = curSplitPoint; sp; sp = sp->parent) - if (sp->cutoff) - return true; - - return false; -} - +/// ThreadPool::read_uci_options() updates internal threads parameters from the +/// corresponding UCI options and creates/destroys threads to match requested +/// number. Thread objects are dynamically allocated. -// is_available_to() checks whether the thread is available to help the thread with -// threadID "master" at a split point. An obvious requirement is that thread must be -// idle. With more than two threads, this is not by itself sufficient: If the thread -// is the master of some active split point, it is only available as a slave to the -// threads which are busy searching the split point at the top of "slave"'s split -// point stack (the "helpful master concept" in YBWC terminology). +void ThreadPool::read_uci_options() { -bool Thread::is_available_to(int master) const { - - if (is_searching) - return false; - - // Make a local copy to be sure doesn't become zero under our feet while - // testing next condition and so leading to an out of bound access. - int spCnt = splitPointsCnt; - - // No active split points means that the thread is available as a slave for any - // other thread otherwise apply the "helpful master" concept if possible. - return !spCnt || (splitPoints[spCnt - 1].slavesMask & (1ULL << master)); -} - - -// read_uci_options() updates internal threads parameters from the corresponding -// UCI options and creates/destroys threads to match the requested number. Thread -// objects are dynamically allocated to avoid creating in advance all possible -// threads, with included pawns and material tables, if only few are used. - -void ThreadsManager::read_uci_options() { - - maxThreadsPerSplitPoint = Options["Max Threads per Split Point"]; - minimumSplitDepth = Options["Min Split Depth"] * ONE_PLY; - useSleepingThreads = Options["Use Sleeping Threads"]; - int requested = Options["Threads"]; + size_t requested = Options["Threads"]; assert(requested > 0); while (size() < requested) - threads.push_back(new Thread(&Thread::idle_loop)); + push_back(new Thread); while (size() > requested) - { - delete threads.back(); - threads.pop_back(); - } -} - - -// wake_up() is called before a new search to start the threads that are waiting -// on the sleep condition. If useSleepingThreads is set threads will be woken up -// at split time. - -void ThreadsManager::wake_up() { - - for (int i = 0; i < size(); i++) - { - threads[i]->do_sleep = false; - threads[i]->maxPly = 0; - - if (!useSleepingThreads) - threads[i]->wake_up(); - } -} - - -// sleep() is called after the search to ask all the threads but the main to go -// waiting on a sleep condition. - -void ThreadsManager::sleep() { - - for (int i = 1; i < size(); i++) // Main thread will go to sleep by itself - threads[i]->do_sleep = true; // to avoid a race with start_thinking() + delete back(), pop_back(); } -// init() is called during startup. Initializes locks and condition variables -// and launches all threads sending them immediately to sleep. +/// ThreadPool::nodes_searched() returns the number of nodes searched -void ThreadsManager::init() { +int64_t ThreadPool::nodes_searched() { - cond_init(sleepCond); - lock_init(splitLock); - timer = new Thread(&Thread::timer_loop); - threads.push_back(new Thread(&Thread::main_loop)); - read_uci_options(); + int64_t nodes = 0; + for (Thread* th : *this) + nodes += th->rootPos.nodes_searched(); + return nodes; } -// exit() is called to cleanly terminate the threads before the program finishes - -void ThreadsManager::exit() { - - for (int i = 0; i < size(); i++) - delete threads[i]; - - delete timer; - lock_destroy(splitLock); - cond_destroy(sleepCond); -} +/// ThreadPool::start_thinking() wakes up the main thread sleeping in idle_loop() +/// and starts a new search, then returns immediately. +void ThreadPool::start_thinking(Position& pos, StateListPtr& states, + const Search::LimitsType& limits) { -// available_slave_exists() tries to find an idle thread which is available as -// a slave for the thread with threadID 'master'. + main()->wait_for_search_finished(); -bool ThreadsManager::available_slave_exists(int master) const { + Search::Signals.stopOnPonderhit = Search::Signals.stop = false; + Search::Limits = limits; + Search::RootMoves rootMoves; - assert(master >= 0 && master < size()); + for (const auto& m : MoveList(pos)) + if ( limits.searchmoves.empty() + || std::count(limits.searchmoves.begin(), limits.searchmoves.end(), m)) + rootMoves.push_back(Search::RootMove(m)); - for (int i = 0; i < size(); i++) - if (threads[i]->is_available_to(master)) - return true; - - return false; -} - - -// 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 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 -Value ThreadsManager::split(Position& pos, Stack* ss, Value alpha, Value beta, - Value bestValue, Move* bestMove, Depth depth, - Move threatMove, int moveCount, MovePicker* mp, int nodeType) { - assert(pos.pos_is_ok()); - assert(bestValue > -VALUE_INFINITE); - assert(bestValue <= alpha); - assert(alpha < beta); - assert(beta <= VALUE_INFINITE); - assert(depth > DEPTH_ZERO); - - int master = pos.thread(); - Thread& masterThread = *threads[master]; - - if (masterThread.splitPointsCnt >= MAX_SPLITPOINTS_PER_THREAD) - return bestValue; - - // Pick the next available split point from the split point stack - SplitPoint* sp = &masterThread.splitPoints[masterThread.splitPointsCnt++]; - - sp->parent = masterThread.curSplitPoint; - sp->master = master; - sp->cutoff = false; - sp->slavesMask = 1ULL << master; - sp->depth = depth; - sp->bestMove = *bestMove; - sp->threatMove = threatMove; - sp->alpha = alpha; - sp->beta = beta; - sp->nodeType = nodeType; - sp->bestValue = bestValue; - sp->mp = mp; - sp->moveCount = moveCount; - sp->pos = &pos; - sp->nodes = 0; - sp->ss = ss; - - assert(masterThread.is_searching); - - masterThread.curSplitPoint = sp; - int slavesCnt = 0; - - // Try to allocate available threads and ask them to start searching setting - // is_searching flag. This must be done under lock protection to avoid concurrent - // allocation of the same slave by another master. - lock_grab(sp->lock); - lock_grab(splitLock); - - for (int i = 0; i < size() && !Fake; ++i) - if (threads[i]->is_available_to(master)) - { - sp->slavesMask |= 1ULL << i; - threads[i]->curSplitPoint = sp; - threads[i]->is_searching = true; // Slave leaves idle_loop() + Tablebases::filter_root_moves(pos, rootMoves); - if (useSleepingThreads) - threads[i]->wake_up(); + // After ownership transfer 'states' becomes empty, so if we stop the search + // and call 'go' again without setting a new position states.get() == NULL. + assert(states.get() || setupStates.get()); - if (++slavesCnt + 1 >= maxThreadsPerSplitPoint) // Master is always included - break; - } + if (states.get()) + setupStates = std::move(states); // Ownership transfer, states is now empty - lock_release(splitLock); - lock_release(sp->lock); + StateInfo tmp = setupStates->back(); - // Everything is set up. The master thread enters the idle loop, from which - // it will instantly launch a search, because its is_searching flag is set. - // We pass the split point as a parameter to the idle loop, which means that - // the thread will return from the idle loop when all slaves have finished - // their work at this split point. - if (slavesCnt || Fake) + for (Thread* th : Threads) { - masterThread.idle_loop(sp); - - // 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); + th->maxPly = 0; + th->rootDepth = DEPTH_ZERO; + th->rootMoves = rootMoves; + th->rootPos.set(pos.fen(), pos.is_chess960(), &setupStates->back(), th); } - // We have returned from the idle loop, which means that all threads are - // finished. Note that setting is_searching and decreasing splitPointsCnt is - // done under lock protection to avoid a race with Thread::is_available_to(). - lock_grab(sp->lock); // To protect sp->nodes - lock_grab(splitLock); - - masterThread.is_searching = true; - masterThread.splitPointsCnt--; - masterThread.curSplitPoint = sp->parent; - pos.set_nodes_searched(pos.nodes_searched() + sp->nodes); - *bestMove = sp->bestMove; - - lock_release(splitLock); - lock_release(sp->lock); - - return sp->bestValue; -} - -// Explicit template instantiations -template Value ThreadsManager::split(Position&, Stack*, Value, Value, Value, Move*, Depth, Move, int, MovePicker*, int); -template Value ThreadsManager::split(Position&, Stack*, Value, Value, Value, Move*, Depth, Move, int, MovePicker*, int); - - -// ThreadsManager::set_timer() is used to set the timer to trigger after msec -// milliseconds. If msec is 0 then timer is stopped. - -void ThreadsManager::set_timer(int msec) { - - lock_grab(timer->sleepLock); - timer->maxPly = msec; - cond_signal(timer->sleepCond); // Wake up and restart the timer - lock_release(timer->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. - -void ThreadsManager::start_thinking(const Position& pos, const LimitsType& limits, - const std::set& searchMoves, bool async) { - Thread& main = *threads.front(); - - lock_grab(main.sleepLock); - - // Wait main thread has finished before to launch a new search - while (!main.do_sleep) - 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 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); -} - - -// 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::stop_thinking() { - - Thread& main = *threads.front(); - - Search::Signals.stop = true; - - lock_grab(main.sleepLock); - - cond_signal(main.sleepCond); // In case is waiting for stop or ponderhit - - while (!main.do_sleep) - cond_wait(sleepCond, main.sleepLock); + setupStates->back() = tmp; // Restore st->previous, cleared by Position::set() - lock_release(main.sleepLock); + main()->start_searching(); }