Move idle_loop() under Thread
[stockfish] / 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-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 #include <iostream>
21
22 #include "thread.h"
23 #include "ucioption.h"
24
25 ThreadsManager Threads; // Global object definition
26
27 namespace { extern "C" {
28
29  // start_routine() is the C function which is called when a new thread
30  // is launched. It simply calls idle_loop() with the supplied threadID.
31  // There are two versions of this function; one for POSIX threads and
32  // one for Windows threads.
33
34 #if defined(_MSC_VER)
35
36   DWORD WINAPI start_routine(LPVOID threadID) {
37
38     Threads[*(int*)threadID].idle_loop(NULL);
39     return 0;
40   }
41
42 #else
43
44   void* start_routine(void* threadID) {
45
46     Threads[*(int*)threadID].idle_loop(NULL);
47     return NULL;
48   }
49
50 #endif
51
52 } }
53
54
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.
57
58 void Thread::wake_up() {
59
60   lock_grab(&sleepLock);
61   cond_signal(&sleepCond);
62   lock_release(&sleepLock);
63 }
64
65
66 // cutoff_occurred() checks whether a beta cutoff has occurred in
67 // the thread's currently active split point, or in some ancestor of
68 // the current split point.
69
70 bool Thread::cutoff_occurred() const {
71
72   for (SplitPoint* sp = splitPoint; sp; sp = sp->parent)
73       if (sp->is_betaCutoff)
74           return true;
75   return false;
76 }
77
78
79 // is_available_to() checks whether the thread is available to help the thread with
80 // threadID "master" at a split point. An obvious requirement is that thread must be
81 // idle. With more than two threads, this is not by itself sufficient: If the thread
82 // is the master of some active split point, it is only available as a slave to the
83 // threads which are busy searching the split point at the top of "slave"'s split
84 // point stack (the "helpful master concept" in YBWC terminology).
85
86 bool Thread::is_available_to(int master) const {
87
88   if (state != AVAILABLE)
89       return false;
90
91   // Make a local copy to be sure doesn't become zero under our feet while
92   // testing next condition and so leading to an out of bound access.
93   int localActiveSplitPoints = activeSplitPoints;
94
95   // No active split points means that the thread is available as a slave for any
96   // other thread otherwise apply the "helpful master" concept if possible.
97   if (   !localActiveSplitPoints
98       || splitPoints[localActiveSplitPoints - 1].is_slave[master])
99       return true;
100
101   return false;
102 }
103
104
105 // read_uci_options() updates number of active threads and other internal
106 // parameters according to the UCI options values. It is called before
107 // to start a new search.
108
109 void ThreadsManager::read_uci_options() {
110
111   maxThreadsPerSplitPoint = Options["Maximum Number of Threads per Split Point"].value<int>();
112   minimumSplitDepth       = Options["Minimum Split Depth"].value<int>() * ONE_PLY;
113   useSleepingThreads      = Options["Use Sleeping Threads"].value<bool>();
114
115   set_size(Options["Threads"].value<int>());
116 }
117
118
119 // set_size() changes the number of active threads and raises do_sleep flag for
120 // all the unused threads that will go immediately to sleep.
121
122 void ThreadsManager::set_size(int cnt) {
123
124   assert(cnt > 0 && cnt <= MAX_THREADS);
125
126   activeThreads = cnt;
127
128   for (int i = 0; i < MAX_THREADS; i++)
129       threads[i].do_sleep = !(i < activeThreads);
130 }
131
132
133 // init() is called during startup. Initializes locks and condition variables
134 // and launches all threads sending them immediately to sleep.
135
136 void ThreadsManager::init() {
137
138   // Threads will sent to sleep as soon as created, only main thread is kept alive
139   set_size(1);
140   threads[0].state = Thread::SEARCHING;
141   threads[0].threadID = 0;
142
143   // Allocate pawn and material hash tables for main thread
144   init_hash_tables();
145
146   // Initialize threads lock, used when allocating slaves during splitting
147   lock_init(&threadsLock);
148
149   // Initialize sleep and split point locks
150   for (int i = 0; i < MAX_THREADS; i++)
151   {
152       lock_init(&threads[i].sleepLock);
153       cond_init(&threads[i].sleepCond);
154
155       for (int j = 0; j < MAX_ACTIVE_SPLIT_POINTS; j++)
156           lock_init(&(threads[i].splitPoints[j].lock));
157   }
158
159   // Create and startup all the threads but the main that is already running
160   for (int i = 1; i < MAX_THREADS; i++)
161   {
162       threads[i].state = Thread::INITIALIZING;
163       threads[i].threadID = i;
164
165 #if defined(_MSC_VER)
166       bool ok = (CreateThread(NULL, 0, start_routine, (LPVOID)&threads[i].threadID , 0, NULL) != NULL);
167 #else
168       pthread_t pthreadID;
169       bool ok = (pthread_create(&pthreadID, NULL, start_routine, (void*)&threads[i].threadID) == 0);
170       pthread_detach(pthreadID);
171 #endif
172       if (!ok)
173       {
174           std::cout << "Failed to create thread number " << i << std::endl;
175           ::exit(EXIT_FAILURE);
176       }
177
178       // Wait until the thread has finished launching and is gone to sleep
179       while (threads[i].state == Thread::INITIALIZING) {}
180   }
181 }
182
183
184 // exit() is called to cleanly terminate the threads when the program finishes
185
186 void ThreadsManager::exit() {
187
188   for (int i = 0; i < MAX_THREADS; i++)
189   {
190       // Wake up all the slave threads and wait for termination
191       if (i != 0)
192       {
193           threads[i].do_terminate = true;
194           threads[i].wake_up();
195           while (threads[i].state != Thread::TERMINATED) {}
196       }
197
198       // Now we can safely destroy locks and wait conditions
199       lock_destroy(&threads[i].sleepLock);
200       cond_destroy(&threads[i].sleepCond);
201
202       for (int j = 0; j < MAX_ACTIVE_SPLIT_POINTS; j++)
203           lock_destroy(&(threads[i].splitPoints[j].lock));
204   }
205
206   lock_destroy(&threadsLock);
207 }
208
209
210 // init_hash_tables() dynamically allocates pawn and material hash tables
211 // according to the number of active threads. This avoids preallocating
212 // memory for all possible threads if only few are used as, for instance,
213 // on mobile devices where memory is scarce and allocating for MAX_THREADS
214 // threads could even result in a crash.
215
216 void ThreadsManager::init_hash_tables() {
217
218   for (int i = 0; i < activeThreads; i++)
219   {
220       threads[i].pawnTable.init();
221       threads[i].materialTable.init();
222   }
223 }
224
225
226 // available_slave_exists() tries to find an idle thread which is available as
227 // a slave for the thread with threadID "master".
228
229 bool ThreadsManager::available_slave_exists(int master) const {
230
231   assert(master >= 0 && master < activeThreads);
232
233   for (int i = 0; i < activeThreads; i++)
234       if (i != master && 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
243 // node (because no idle threads are available, or because we have no unused
244 // split point objects), the function immediately returns. If splitting is
245 // possible, a SplitPoint object is initialized with all the data that must be
246 // copied to the helper threads and we tell our helper threads that they have
247 // been assigned work. This will cause them to instantly leave their idle loops and
248 // call search().When all threads have returned from search() then split() returns.
249
250 template <bool Fake>
251 Value ThreadsManager::split(Position& pos, SearchStack* ss, Value alpha, Value beta,
252                             Value bestValue, Depth depth, Move threatMove,
253                             int moveCount, MovePicker* mp, int nodeType) {
254   assert(pos.is_ok());
255   assert(bestValue >= -VALUE_INFINITE);
256   assert(bestValue <= alpha);
257   assert(alpha < beta);
258   assert(beta <= VALUE_INFINITE);
259   assert(depth > DEPTH_ZERO);
260   assert(pos.thread() >= 0 && pos.thread() < activeThreads);
261   assert(activeThreads > 1);
262
263   int i, master = pos.thread();
264   Thread& masterThread = threads[master];
265
266   // If we already have too many active split points, don't split
267   if (masterThread.activeSplitPoints >= MAX_ACTIVE_SPLIT_POINTS)
268       return bestValue;
269
270   // Pick the next available split point object from the split point stack
271   SplitPoint* sp = masterThread.splitPoints + masterThread.activeSplitPoints;
272
273   // Initialize the split point object
274   sp->parent = masterThread.splitPoint;
275   sp->master = master;
276   sp->is_betaCutoff = false;
277   sp->depth = depth;
278   sp->threatMove = threatMove;
279   sp->alpha = alpha;
280   sp->beta = beta;
281   sp->nodeType = nodeType;
282   sp->bestValue = bestValue;
283   sp->mp = mp;
284   sp->moveCount = moveCount;
285   sp->pos = &pos;
286   sp->nodes = 0;
287   sp->ss = ss;
288   for (i = 0; i < activeThreads; i++)
289       sp->is_slave[i] = false;
290
291   // If we are here it means we are not available
292   assert(masterThread.state == Thread::SEARCHING);
293
294   int workersCnt = 1; // At least the master is included
295
296   // Try to allocate available threads and ask them to start searching setting
297   // the state to Thread::WORKISWAITING, this must be done under lock protection
298   // to avoid concurrent allocation of the same slave by another master.
299   lock_grab(&threadsLock);
300
301   for (i = 0; !Fake && i < activeThreads && workersCnt < maxThreadsPerSplitPoint; i++)
302       if (i != master && threads[i].is_available_to(master))
303       {
304           workersCnt++;
305           sp->is_slave[i] = true;
306           threads[i].splitPoint = sp;
307
308           // This makes the slave to exit from idle_loop()
309           threads[i].state = Thread::WORKISWAITING;
310
311           if (useSleepingThreads)
312               threads[i].wake_up();
313       }
314
315   lock_release(&threadsLock);
316
317   // We failed to allocate even one slave, return
318   if (!Fake && workersCnt == 1)
319       return bestValue;
320
321   masterThread.splitPoint = sp;
322   masterThread.activeSplitPoints++;
323   masterThread.state = Thread::WORKISWAITING;
324
325   // Everything is set up. The master thread enters the idle loop, from
326   // which it will instantly launch a search, because its state is
327   // Thread::WORKISWAITING. We send the split point as a second parameter to
328   // the idle loop, which means that the main thread will return from the idle
329   // loop when all threads have finished their work at this split point.
330   masterThread.idle_loop(sp);
331
332   // In helpful master concept a master can help only a sub-tree, and
333   // because here is all finished is not possible master is booked.
334   assert(masterThread.state == Thread::AVAILABLE);
335
336   // We have returned from the idle loop, which means that all threads are
337   // finished. Note that changing state and decreasing activeSplitPoints is done
338   // under lock protection to avoid a race with Thread::is_available_to().
339   lock_grab(&threadsLock);
340
341   masterThread.state = Thread::SEARCHING;
342   masterThread.activeSplitPoints--;
343
344   lock_release(&threadsLock);
345
346   masterThread.splitPoint = sp->parent;
347   pos.set_nodes_searched(pos.nodes_searched() + sp->nodes);
348
349   return sp->bestValue;
350 }
351
352 // Explicit template instantiations
353 template Value ThreadsManager::split<false>(Position&, SearchStack*, Value, Value, Value, Depth, Move, int, MovePicker*, int);
354 template Value ThreadsManager::split<true>(Position&, SearchStack*, Value, Value, Value, Depth, Move, int, MovePicker*, int);