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
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.
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.
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/>.
23 #include "ucioption.h"
25 ThreadsManager Threads; // Global object definition
27 namespace { extern "C" {
29 // start_routine() is the C function which is called when a new thread
30 // is launched. It simply calls idle_loop() of the supplied thread.
31 // There are two versions of this function; one for POSIX threads and
32 // one for Windows threads.
36 DWORD WINAPI start_routine(LPVOID thread) {
38 ((Thread*)thread)->idle_loop(NULL);
44 void* start_routine(void* thread) {
46 ((Thread*)thread)->idle_loop(NULL);
55 // wake_up() wakes up the thread, normally at the beginning of the search or,
56 // if "sleeping threads" is used, when there is some work to do.
58 void Thread::wake_up() {
60 lock_grab(&sleepLock);
61 cond_signal(&sleepCond);
62 lock_release(&sleepLock);
66 // cutoff_occurred() checks whether a beta cutoff has occurred in the current
67 // active split point, or in some ancestor of the split point.
69 bool Thread::cutoff_occurred() const {
71 for (SplitPoint* sp = splitPoint; sp; sp = sp->parent)
72 if (sp->is_betaCutoff)
78 // is_available_to() checks whether the thread is available to help the thread with
79 // threadID "master" at a split point. An obvious requirement is that thread must be
80 // idle. With more than two threads, this is not by itself sufficient: If the thread
81 // is the master of some active split point, it is only available as a slave to the
82 // threads which are busy searching the split point at the top of "slave"'s split
83 // point stack (the "helpful master concept" in YBWC terminology).
85 bool Thread::is_available_to(int master) const {
90 // Make a local copy to be sure doesn't become zero under our feet while
91 // testing next condition and so leading to an out of bound access.
92 int localActiveSplitPoints = activeSplitPoints;
94 // No active split points means that the thread is available as a slave for any
95 // other thread otherwise apply the "helpful master" concept if possible.
96 if ( !localActiveSplitPoints
97 || splitPoints[localActiveSplitPoints - 1].is_slave[master])
104 // read_uci_options() updates number of active threads and other internal
105 // parameters according to the UCI options values. It is called before
106 // to start a new search.
108 void ThreadsManager::read_uci_options() {
110 maxThreadsPerSplitPoint = Options["Maximum Number of Threads per Split Point"].value<int>();
111 minimumSplitDepth = Options["Minimum Split Depth"].value<int>() * ONE_PLY;
112 useSleepingThreads = Options["Use Sleeping Threads"].value<bool>();
114 set_size(Options["Threads"].value<int>());
118 // set_size() changes the number of active threads and raises do_sleep flag for
119 // all the unused threads that will go immediately to sleep.
121 void ThreadsManager::set_size(int cnt) {
123 assert(cnt > 0 && cnt <= MAX_THREADS);
127 for (int i = 0; i < MAX_THREADS; i++)
128 if (i < activeThreads)
130 // Dynamically allocate pawn and material hash tables according to the
131 // number of active threads. This avoids preallocating memory for all
132 // possible threads if only few are used as, for instance, on mobile
133 // devices where memory is scarce and allocating for MAX_THREADS could
134 // even result in a crash.
135 threads[i].pawnTable.init();
136 threads[i].materialTable.init();
138 threads[i].do_sleep = false;
141 threads[i].do_sleep = true;
145 // init() is called during startup. Initializes locks and condition variables
146 // and launches all threads sending them immediately to sleep.
148 void ThreadsManager::init() {
150 // Initialize threads lock, used when allocating slaves during splitting
151 lock_init(&threadsLock);
153 // Initialize sleep and split point locks
154 for (int i = 0; i < MAX_THREADS; i++)
156 lock_init(&threads[i].sleepLock);
157 cond_init(&threads[i].sleepCond);
159 for (int j = 0; j < MAX_ACTIVE_SPLIT_POINTS; j++)
160 lock_init(&(threads[i].splitPoints[j].lock));
163 // Initialize main thread's associated data
164 threads[0].is_searching = true;
165 threads[0].threadID = 0;
166 set_size(1); // This makes all the threads but the main to go to sleep
168 // Create and launch all the threads but the main that is already running,
169 // threads will go immediately to sleep.
170 for (int i = 1; i < MAX_THREADS; i++)
172 threads[i].is_searching = false;
173 threads[i].threadID = i;
175 #if defined(_MSC_VER)
176 threads[i].handle = CreateThread(NULL, 0, start_routine, (LPVOID)&threads[i], 0, NULL);
177 bool ok = (threads[i].handle != NULL);
179 bool ok = (pthread_create(&threads[i].handle, NULL, start_routine, (void*)&threads[i]) == 0);
184 std::cerr << "Failed to create thread number " << i << std::endl;
185 ::exit(EXIT_FAILURE);
191 // exit() is called to cleanly terminate the threads when the program finishes
193 void ThreadsManager::exit() {
195 // Wake up all the slave threads at once. This is faster than "wake and wait"
196 // for each thread and avoids a rare crash once every 10K games under Linux.
197 for (int i = 1; i < MAX_THREADS; i++)
199 threads[i].do_terminate = true;
200 threads[i].wake_up();
203 for (int i = 0; i < MAX_THREADS; i++)
207 // Wait for slave termination
208 #if defined(_MSC_VER)
209 WaitForSingleObject(threads[i].handle, 0);
210 CloseHandle(threads[i].handle);
212 pthread_join(threads[i].handle, NULL);
216 // Now we can safely destroy locks and wait conditions
217 lock_destroy(&threads[i].sleepLock);
218 cond_destroy(&threads[i].sleepCond);
220 for (int j = 0; j < MAX_ACTIVE_SPLIT_POINTS; j++)
221 lock_destroy(&(threads[i].splitPoints[j].lock));
224 lock_destroy(&threadsLock);
228 // available_slave_exists() tries to find an idle thread which is available as
229 // a slave for the thread with threadID "master".
231 bool ThreadsManager::available_slave_exists(int master) const {
233 assert(master >= 0 && master < activeThreads);
235 for (int i = 0; i < activeThreads; i++)
236 if (i != master && threads[i].is_available_to(master))
243 // split() does the actual work of distributing the work at a node between
244 // several available threads. If it does not succeed in splitting the
245 // node (because no idle threads are available, or because we have no unused
246 // split point objects), the function immediately returns. If splitting is
247 // possible, a SplitPoint object is initialized with all the data that must be
248 // copied to the helper threads and we tell our helper threads that they have
249 // been assigned work. This will cause them to instantly leave their idle loops and
250 // call search().When all threads have returned from search() then split() returns.
253 Value ThreadsManager::split(Position& pos, SearchStack* ss, Value alpha, Value beta,
254 Value bestValue, Depth depth, Move threatMove,
255 int moveCount, MovePicker* mp, int nodeType) {
256 assert(pos.pos_is_ok());
257 assert(bestValue >= -VALUE_INFINITE);
258 assert(bestValue <= alpha);
259 assert(alpha < beta);
260 assert(beta <= VALUE_INFINITE);
261 assert(depth > DEPTH_ZERO);
262 assert(pos.thread() >= 0 && pos.thread() < activeThreads);
263 assert(activeThreads > 1);
265 int i, master = pos.thread();
266 Thread& masterThread = threads[master];
268 // If we already have too many active split points, don't split
269 if (masterThread.activeSplitPoints >= MAX_ACTIVE_SPLIT_POINTS)
272 // Pick the next available split point object from the split point stack
273 SplitPoint* sp = masterThread.splitPoints + masterThread.activeSplitPoints;
275 // Initialize the split point object
276 sp->parent = masterThread.splitPoint;
278 sp->is_betaCutoff = false;
280 sp->threatMove = threatMove;
283 sp->nodeType = nodeType;
284 sp->bestValue = bestValue;
286 sp->moveCount = moveCount;
290 for (i = 0; i < activeThreads; i++)
291 sp->is_slave[i] = false;
293 // If we are here it means we are not available
294 assert(masterThread.is_searching);
296 int workersCnt = 1; // At least the master is included
298 // Try to allocate available threads and ask them to start searching setting
299 // the state to Thread::WORKISWAITING, this must be done under lock protection
300 // to avoid concurrent allocation of the same slave by another master.
301 lock_grab(&threadsLock);
303 for (i = 0; !Fake && i < activeThreads && workersCnt < maxThreadsPerSplitPoint; i++)
304 if (i != master && threads[i].is_available_to(master))
307 sp->is_slave[i] = true;
308 threads[i].splitPoint = sp;
310 // This makes the slave to exit from idle_loop()
311 threads[i].is_searching = true;
313 if (useSleepingThreads)
314 threads[i].wake_up();
317 lock_release(&threadsLock);
319 // We failed to allocate even one slave, return
320 if (!Fake && workersCnt == 1)
323 masterThread.splitPoint = sp;
324 masterThread.activeSplitPoints++;
326 // Everything is set up. The master thread enters the idle loop, from which
327 // it will instantly launch a search, because its is_searching flag is set.
328 // We pass the split point as a parameter to the idle loop, which means that
329 // the thread will return from the idle loop when all slaves have finished
330 // their work at this split point.
331 masterThread.idle_loop(sp);
333 // In helpful master concept a master can help only a sub-tree, and
334 // because here is all finished is not possible master is booked.
335 assert(!masterThread.is_searching);
337 // We have returned from the idle loop, which means that all threads are
338 // finished. Note that changing state and decreasing activeSplitPoints is done
339 // under lock protection to avoid a race with Thread::is_available_to().
340 lock_grab(&threadsLock);
342 masterThread.is_searching = true;
343 masterThread.activeSplitPoints--;
345 lock_release(&threadsLock);
347 masterThread.splitPoint = sp->parent;
348 pos.set_nodes_searched(pos.nodes_searched() + sp->nodes);
350 return sp->bestValue;
353 // Explicit template instantiations
354 template Value ThreadsManager::split<false>(Position&, SearchStack*, Value, Value, Value, Depth, Move, int, MovePicker*, int);
355 template Value ThreadsManager::split<true>(Position&, SearchStack*, Value, Value, Value, Depth, Move, int, MovePicker*, int);