]> git.sesse.net Git - stockfish/blob - src/search.cpp
Rename iteration in depth in id_loop()
[stockfish] / src / search.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
21 ////
22 //// Includes
23 ////
24
25 #include <cassert>
26 #include <cmath>
27 #include <cstring>
28 #include <fstream>
29 #include <iostream>
30 #include <sstream>
31 #include <vector>
32
33 #include "book.h"
34 #include "evaluate.h"
35 #include "history.h"
36 #include "misc.h"
37 #include "move.h"
38 #include "movegen.h"
39 #include "movepick.h"
40 #include "lock.h"
41 #include "search.h"
42 #include "timeman.h"
43 #include "thread.h"
44 #include "tt.h"
45 #include "ucioption.h"
46
47 using std::cout;
48 using std::endl;
49
50 ////
51 //// Local definitions
52 ////
53
54 namespace {
55
56   // Types
57   enum NodeType { NonPV, PV };
58
59   // Set to true to force running with one thread.
60   // Used for debugging SMP code.
61   const bool FakeSplit = false;
62
63   // Fast lookup table of sliding pieces indexed by Piece
64   const bool Slidings[18] = { 0, 0, 0, 1, 1, 1, 0, 0, 0, 0, 0, 1, 1, 1 };
65   inline bool piece_is_slider(Piece p) { return Slidings[p]; }
66
67   // ThreadsManager class is used to handle all the threads related stuff in search,
68   // init, starting, parking and, the most important, launching a slave thread at a
69   // split point are what this class does. All the access to shared thread data is
70   // done through this class, so that we avoid using global variables instead.
71
72   class ThreadsManager {
73     /* As long as the single ThreadsManager object is defined as a global we don't
74        need to explicitly initialize to zero its data members because variables with
75        static storage duration are automatically set to zero before enter main()
76     */
77   public:
78     void init_threads();
79     void exit_threads();
80
81     int min_split_depth() const { return minimumSplitDepth; }
82     int active_threads() const { return activeThreads; }
83     void set_active_threads(int cnt) { activeThreads = cnt; }
84
85     void read_uci_options();
86     bool available_thread_exists(int master) const;
87     bool thread_is_available(int slave, int master) const;
88     bool cutoff_at_splitpoint(int threadID) const;
89     void wake_sleeping_thread(int threadID);
90     void idle_loop(int threadID, SplitPoint* sp);
91
92     template <bool Fake>
93     void split(Position& pos, SearchStack* ss, int ply, Value* alpha, const Value beta, Value* bestValue,
94                Depth depth, Move threatMove, bool mateThreat, int moveCount, MovePicker* mp, bool pvNode);
95
96   private:
97     Depth minimumSplitDepth;
98     int maxThreadsPerSplitPoint;
99     bool useSleepingThreads;
100     int activeThreads;
101     volatile bool allThreadsShouldExit;
102     Thread threads[MAX_THREADS];
103     Lock mpLock, sleepLock[MAX_THREADS];
104     WaitCondition sleepCond[MAX_THREADS];
105   };
106
107
108   // RootMove struct is used for moves at the root at the tree. For each root
109   // move, we store two scores, a node count, and a PV (really a refutation
110   // in the case of moves which fail low). Value pv_score is normally set at
111   // -VALUE_INFINITE for all non-pv moves, while non_pv_score is computed
112   // according to the order in which moves are returned by MovePicker.
113
114   struct RootMove {
115
116     RootMove();
117     RootMove(const RootMove& rm) { *this = rm; }
118     RootMove& operator=(const RootMove& rm);
119
120     // RootMove::operator<() is the comparison function used when
121     // sorting the moves. A move m1 is considered to be better
122     // than a move m2 if it has an higher pv_score, or if it has
123     // equal pv_score but m1 has the higher non_pv_score. In this
124     // way we are guaranteed that PV moves are always sorted as first.
125     bool operator<(const RootMove& m) const {
126       return pv_score != m.pv_score ? pv_score < m.pv_score
127                                     : non_pv_score < m.non_pv_score;
128     }
129
130     void extract_pv_from_tt(Position& pos);
131     void insert_pv_in_tt(Position& pos);
132     std::string pv_info_to_uci(Position& pos, int depth, Value alpha, Value beta, int pvLine = 0);
133
134     int64_t nodes;
135     Value pv_score;
136     Value non_pv_score;
137     Move pv[PLY_MAX_PLUS_2];
138   };
139
140
141   // RootMoveList struct is essentially a std::vector<> of RootMove objects,
142   // with an handful of methods above the standard ones.
143
144   struct RootMoveList : public std::vector<RootMove> {
145
146     typedef std::vector<RootMove> Base;
147
148     void init(Position& pos, Move searchMoves[]);
149     void sort() { insertion_sort<RootMove, Base::iterator>(begin(), end()); }
150     void sort_multipv(int n) { insertion_sort<RootMove, Base::iterator>(begin(), begin() + n); }
151
152     int bestMoveChanges;
153   };
154
155
156   // When formatting a move for std::cout we must know if we are in Chess960
157   // or not. To keep using the handy operator<<() on the move the trick is to
158   // embed this flag in the stream itself. Function-like named enum set960 is
159   // used as a custom manipulator and the stream internal general-purpose array,
160   // accessed through ios_base::iword(), is used to pass the flag to the move's
161   // operator<<() that will use it to properly format castling moves.
162   enum set960 {};
163
164   std::ostream& operator<< (std::ostream& os, const set960& f) {
165
166     os.iword(0) = int(f);
167     return os;
168   }
169
170
171   // Overload operator << for moves to make it easier to print moves in
172   // coordinate notation compatible with UCI protocol.
173   std::ostream& operator<<(std::ostream& os, Move m) {
174
175     bool chess960 = (os.iword(0) != 0); // See set960()
176     return os << move_to_uci(m, chess960);
177   }
178
179
180   /// Adjustments
181
182   // Step 6. Razoring
183
184   // Maximum depth for razoring
185   const Depth RazorDepth = 4 * ONE_PLY;
186
187   // Dynamic razoring margin based on depth
188   inline Value razor_margin(Depth d) { return Value(0x200 + 0x10 * int(d)); }
189
190   // Maximum depth for use of dynamic threat detection when null move fails low
191   const Depth ThreatDepth = 5 * ONE_PLY;
192
193   // Step 9. Internal iterative deepening
194
195   // Minimum depth for use of internal iterative deepening
196   const Depth IIDDepth[2] = { 8 * ONE_PLY /* non-PV */, 5 * ONE_PLY /* PV */};
197
198   // At Non-PV nodes we do an internal iterative deepening search
199   // when the static evaluation is bigger then beta - IIDMargin.
200   const Value IIDMargin = Value(0x100);
201
202   // Step 11. Decide the new search depth
203
204   // Extensions. Configurable UCI options
205   // Array index 0 is used at non-PV nodes, index 1 at PV nodes.
206   Depth CheckExtension[2], PawnPushTo7thExtension[2], PassedPawnExtension[2];
207   Depth PawnEndgameExtension[2], MateThreatExtension[2];
208
209   // Minimum depth for use of singular extension
210   const Depth SingularExtensionDepth[2] = { 8 * ONE_PLY /* non-PV */, 6 * ONE_PLY /* PV */};
211
212   // If the TT move is at least SingularExtensionMargin better then the
213   // remaining ones we will extend it.
214   const Value SingularExtensionMargin = Value(0x20);
215
216   // Step 12. Futility pruning
217
218   // Futility margin for quiescence search
219   const Value FutilityMarginQS = Value(0x80);
220
221   // Futility lookup tables (initialized at startup) and their getter functions
222   Value FutilityMarginsMatrix[16][64]; // [depth][moveNumber]
223   int FutilityMoveCountArray[32]; // [depth]
224
225   inline Value futility_margin(Depth d, int mn) { return d < 7 * ONE_PLY ? FutilityMarginsMatrix[Max(d, 1)][Min(mn, 63)] : 2 * VALUE_INFINITE; }
226   inline int futility_move_count(Depth d) { return d < 16 * ONE_PLY ? FutilityMoveCountArray[d] : 512; }
227
228   // Step 14. Reduced search
229
230   // Reduction lookup tables (initialized at startup) and their getter functions
231   int8_t ReductionMatrix[2][64][64]; // [pv][depth][moveNumber]
232
233   template <NodeType PV>
234   inline Depth reduction(Depth d, int mn) { return (Depth) ReductionMatrix[PV][Min(d / 2, 63)][Min(mn, 63)]; }
235
236   // Easy move margin. An easy move candidate must be at least this much
237   // better than the second best move.
238   const Value EasyMoveMargin = Value(0x200);
239
240
241   /// Namespace variables
242
243   // Book object
244   Book OpeningBook;
245
246   // Root move list
247   RootMoveList Rml;
248
249   // MultiPV mode
250   int MultiPV;
251
252   // Time managment variables
253   int SearchStartTime, MaxNodes, MaxDepth, ExactMaxTime;
254   bool UseTimeManagement, InfiniteSearch, Pondering, StopOnPonderhit;
255   bool FirstRootMove, StopRequest, QuitRequest, AspirationFailLow;
256   TimeManager TimeMgr;
257
258   // Log file
259   bool UseLogFile;
260   std::ofstream LogFile;
261
262   // Multi-threads manager object
263   ThreadsManager ThreadsMgr;
264
265   // Node counters, used only by thread[0] but try to keep in different cache
266   // lines (64 bytes each) from the heavy multi-thread read accessed variables.
267   bool SendSearchedNodes;
268   int NodesSincePoll;
269   int NodesBetweenPolls = 30000;
270
271   // History table
272   History H;
273
274   /// Local functions
275
276   Move id_loop(Position& pos, Move searchMoves[], Move* ponderMove);
277
278   template <NodeType PvNode, bool SpNode, bool Root>
279   Value search(Position& pos, SearchStack* ss, Value alpha, Value beta, Depth depth, int ply);
280
281   template <NodeType PvNode>
282   Value qsearch(Position& pos, SearchStack* ss, Value alpha, Value beta, Depth depth, int ply);
283
284   template <NodeType PvNode>
285   inline Value search(Position& pos, SearchStack* ss, Value alpha, Value beta, Depth depth, int ply) {
286
287       return depth < ONE_PLY ? qsearch<PvNode>(pos, ss, alpha, beta, DEPTH_ZERO, ply)
288                              : search<PvNode, false, false>(pos, ss, alpha, beta, depth, ply);
289   }
290
291   template <NodeType PvNode>
292   Depth extension(const Position& pos, Move m, bool captureOrPromotion, bool moveIsCheck, bool mateThreat, bool* dangerous);
293
294   bool check_is_dangerous(Position &pos, Move move, Value futilityBase, Value beta, Value *bValue);
295   bool connected_moves(const Position& pos, Move m1, Move m2);
296   bool value_is_mate(Value value);
297   Value value_to_tt(Value v, int ply);
298   Value value_from_tt(Value v, int ply);
299   bool ok_to_use_TT(const TTEntry* tte, Depth depth, Value beta, int ply);
300   bool connected_threat(const Position& pos, Move m, Move threat);
301   Value refine_eval(const TTEntry* tte, Value defaultEval, int ply);
302   void update_history(const Position& pos, Move move, Depth depth, Move movesSearched[], int moveCount);
303   void update_killers(Move m, Move killers[]);
304   void update_gains(const Position& pos, Move move, Value before, Value after);
305   void qsearch_scoring(Position& pos, MoveStack* mlist, MoveStack* last);
306
307   int current_search_time();
308   std::string value_to_uci(Value v);
309   int nps(const Position& pos);
310   void poll(const Position& pos);
311   void wait_for_stop_or_ponderhit();
312
313 #if !defined(_MSC_VER)
314   void* init_thread(void* threadID);
315 #else
316   DWORD WINAPI init_thread(LPVOID threadID);
317 #endif
318
319
320   // MovePickerExt is an extended MovePicker used to choose at compile time
321   // the proper move source according to the type of node.
322   template<bool SpNode, bool Root> struct MovePickerExt;
323
324   // In Root nodes use RootMoveList Rml as source. Score and sort the root moves
325   // before to search them.
326   template<> struct MovePickerExt<false, true> : public MovePicker {
327
328     MovePickerExt(const Position& p, Move ttm, Depth d, const History& h, SearchStack* ss, Value b)
329                  : MovePicker(p, ttm, d, h, ss, b), firstCall(true) {
330       Move move;
331       Value score = VALUE_ZERO;
332
333       // Score root moves using the standard way used in main search, the moves
334       // are scored according to the order in which are returned by MovePicker.
335       // This is the second order score that is used to compare the moves when
336       // the first order pv scores of both moves are equal.
337       while ((move = MovePicker::get_next_move()) != MOVE_NONE)
338           for (rm = Rml.begin(); rm != Rml.end(); ++rm)
339               if (rm->pv[0] == move)
340               {
341                   rm->non_pv_score = score--;
342                   break;
343               }
344
345       Rml.sort();
346       rm = Rml.begin();
347     }
348
349     Move get_next_move() {
350
351       if (!firstCall)
352           ++rm;
353       else
354           firstCall = false;
355
356       return rm != Rml.end() ? rm->pv[0] : MOVE_NONE;
357     }
358
359     RootMoveList::iterator rm;
360     bool firstCall;
361   };
362
363   // In SpNodes use split point's shared MovePicker object as move source
364   template<> struct MovePickerExt<true, false> : public MovePicker {
365
366     MovePickerExt(const Position& p, Move ttm, Depth d, const History& h,
367                   SearchStack* ss, Value b) : MovePicker(p, ttm, d, h, ss, b),
368                   mp(ss->sp->mp) {}
369
370     Move get_next_move() { return mp->get_next_move(); }
371
372     RootMoveList::iterator rm; // Dummy, needed to compile
373     MovePicker* mp;
374   };
375
376   // Default case, create and use a MovePicker object as source
377   template<> struct MovePickerExt<false, false> : public MovePicker {
378
379     MovePickerExt(const Position& p, Move ttm, Depth d, const History& h,
380                   SearchStack* ss, Value b) : MovePicker(p, ttm, d, h, ss, b) {}
381
382     RootMoveList::iterator rm; // Dummy, needed to compile
383   };
384
385 } // namespace
386
387
388 ////
389 //// Functions
390 ////
391
392 /// init_threads(), exit_threads() and nodes_searched() are helpers to
393 /// give accessibility to some TM methods from outside of current file.
394
395 void init_threads() { ThreadsMgr.init_threads(); }
396 void exit_threads() { ThreadsMgr.exit_threads(); }
397
398
399 /// init_search() is called during startup. It initializes various lookup tables
400
401 void init_search() {
402
403   int d;  // depth (ONE_PLY == 2)
404   int hd; // half depth (ONE_PLY == 1)
405   int mc; // moveCount
406
407   // Init reductions array
408   for (hd = 1; hd < 64; hd++) for (mc = 1; mc < 64; mc++)
409   {
410       double    pvRed = log(double(hd)) * log(double(mc)) / 3.0;
411       double nonPVRed = 0.33 + log(double(hd)) * log(double(mc)) / 2.25;
412       ReductionMatrix[PV][hd][mc]    = (int8_t) (   pvRed >= 1.0 ? floor(   pvRed * int(ONE_PLY)) : 0);
413       ReductionMatrix[NonPV][hd][mc] = (int8_t) (nonPVRed >= 1.0 ? floor(nonPVRed * int(ONE_PLY)) : 0);
414   }
415
416   // Init futility margins array
417   for (d = 1; d < 16; d++) for (mc = 0; mc < 64; mc++)
418       FutilityMarginsMatrix[d][mc] = Value(112 * int(log(double(d * d) / 2) / log(2.0) + 1.001) - 8 * mc + 45);
419
420   // Init futility move count array
421   for (d = 0; d < 32; d++)
422       FutilityMoveCountArray[d] = int(3.001 + 0.25 * pow(d, 2.0));
423 }
424
425
426 /// perft() is our utility to verify move generation is bug free. All the legal
427 /// moves up to given depth are generated and counted and the sum returned.
428
429 int64_t perft(Position& pos, Depth depth)
430 {
431     MoveStack mlist[MOVES_MAX];
432     StateInfo st;
433     Move m;
434     int64_t sum = 0;
435
436     // Generate all legal moves
437     MoveStack* last = generate<MV_LEGAL>(pos, mlist);
438
439     // If we are at the last ply we don't need to do and undo
440     // the moves, just to count them.
441     if (depth <= ONE_PLY)
442         return int(last - mlist);
443
444     // Loop through all legal moves
445     CheckInfo ci(pos);
446     for (MoveStack* cur = mlist; cur != last; cur++)
447     {
448         m = cur->move;
449         pos.do_move(m, st, ci, pos.move_is_check(m, ci));
450         sum += perft(pos, depth - ONE_PLY);
451         pos.undo_move(m);
452     }
453     return sum;
454 }
455
456
457 /// think() is the external interface to Stockfish's search, and is called when
458 /// the program receives the UCI 'go' command. It initializes various
459 /// search-related global variables, and calls id_loop(). It returns false
460 /// when a quit command is received during the search.
461
462 bool think(Position& pos, bool infinite, bool ponder, int time[], int increment[],
463            int movesToGo, int maxDepth, int maxNodes, int maxTime, Move searchMoves[]) {
464
465   // Initialize global search variables
466   StopOnPonderhit = StopRequest = QuitRequest = AspirationFailLow = SendSearchedNodes = false;
467   NodesSincePoll = 0;
468   SearchStartTime = get_system_time();
469   ExactMaxTime = maxTime;
470   MaxDepth = maxDepth;
471   MaxNodes = maxNodes;
472   InfiniteSearch = infinite;
473   Pondering = ponder;
474   UseTimeManagement = !ExactMaxTime && !MaxDepth && !MaxNodes && !InfiniteSearch;
475
476   // Look for a book move, only during games, not tests
477   if (UseTimeManagement && Options["OwnBook"].value<bool>())
478   {
479       if (Options["Book File"].value<std::string>() != OpeningBook.name())
480           OpeningBook.open(Options["Book File"].value<std::string>());
481
482       Move bookMove = OpeningBook.get_move(pos, Options["Best Book Move"].value<bool>());
483       if (bookMove != MOVE_NONE)
484       {
485           if (Pondering)
486               wait_for_stop_or_ponderhit();
487
488           cout << "bestmove " << bookMove << endl;
489           return !QuitRequest;
490       }
491   }
492
493   // Read UCI option values
494   TT.set_size(Options["Hash"].value<int>());
495   if (Options["Clear Hash"].value<bool>())
496   {
497       Options["Clear Hash"].set_value("false");
498       TT.clear();
499   }
500
501   CheckExtension[1]         = Options["Check Extension (PV nodes)"].value<Depth>();
502   CheckExtension[0]         = Options["Check Extension (non-PV nodes)"].value<Depth>();
503   PawnPushTo7thExtension[1] = Options["Pawn Push to 7th Extension (PV nodes)"].value<Depth>();
504   PawnPushTo7thExtension[0] = Options["Pawn Push to 7th Extension (non-PV nodes)"].value<Depth>();
505   PassedPawnExtension[1]    = Options["Passed Pawn Extension (PV nodes)"].value<Depth>();
506   PassedPawnExtension[0]    = Options["Passed Pawn Extension (non-PV nodes)"].value<Depth>();
507   PawnEndgameExtension[1]   = Options["Pawn Endgame Extension (PV nodes)"].value<Depth>();
508   PawnEndgameExtension[0]   = Options["Pawn Endgame Extension (non-PV nodes)"].value<Depth>();
509   MateThreatExtension[1]    = Options["Mate Threat Extension (PV nodes)"].value<Depth>();
510   MateThreatExtension[0]    = Options["Mate Threat Extension (non-PV nodes)"].value<Depth>();
511   MultiPV                   = Options["MultiPV"].value<int>();
512   UseLogFile                = Options["Use Search Log"].value<bool>();
513
514   read_evaluation_uci_options(pos.side_to_move());
515
516   // Set the number of active threads
517   ThreadsMgr.read_uci_options();
518   init_eval(ThreadsMgr.active_threads());
519
520   // Wake up needed threads
521   for (int i = 1; i < ThreadsMgr.active_threads(); i++)
522       ThreadsMgr.wake_sleeping_thread(i);
523
524   // Set thinking time
525   int myTime = time[pos.side_to_move()];
526   int myIncrement = increment[pos.side_to_move()];
527   if (UseTimeManagement)
528       TimeMgr.init(myTime, myIncrement, movesToGo, pos.startpos_ply_counter());
529
530   // Set best NodesBetweenPolls interval to avoid lagging under
531   // heavy time pressure.
532   if (MaxNodes)
533       NodesBetweenPolls = Min(MaxNodes, 30000);
534   else if (myTime && myTime < 1000)
535       NodesBetweenPolls = 1000;
536   else if (myTime && myTime < 5000)
537       NodesBetweenPolls = 5000;
538   else
539       NodesBetweenPolls = 30000;
540
541   // Write search information to log file
542   if (UseLogFile)
543   {
544       std::string name = Options["Search Log Filename"].value<std::string>();
545       LogFile.open(name.c_str(), std::ios::out | std::ios::app);
546
547       LogFile << "Searching: "  << pos.to_fen()
548               << "\ninfinite: " << infinite
549               << " ponder: "    << ponder
550               << " time: "      << myTime
551               << " increment: " << myIncrement
552               << " moves to go: " << movesToGo << endl;
553   }
554
555   // We're ready to start thinking. Call the iterative deepening loop function
556   Move ponderMove = MOVE_NONE;
557   Move bestMove = id_loop(pos, searchMoves, &ponderMove);
558
559   // Print final search statistics
560   cout << "info nodes " << pos.nodes_searched()
561        << " nps " << nps(pos)
562        << " time " << current_search_time() << endl;
563
564   if (UseLogFile)
565   {
566       LogFile << "\nNodes: " << pos.nodes_searched()
567               << "\nNodes/second: " << nps(pos)
568               << "\nBest move: " << move_to_san(pos, bestMove);
569
570       StateInfo st;
571       pos.do_move(bestMove, st);
572       LogFile << "\nPonder move: "
573               << move_to_san(pos, ponderMove) // Works also with MOVE_NONE
574               << endl;
575
576       // Return from think() with unchanged position
577       pos.undo_move(bestMove);
578
579       LogFile.close();
580   }
581
582   // This makes all the threads to go to sleep
583   ThreadsMgr.set_active_threads(1);
584
585   // If we are pondering or in infinite search, we shouldn't print the
586   // best move before we are told to do so.
587   if (!StopRequest && (Pondering || InfiniteSearch))
588       wait_for_stop_or_ponderhit();
589
590   // Could be both MOVE_NONE when searching on a stalemate position
591   cout << "bestmove " << bestMove << " ponder " << ponderMove << endl;
592
593   return !QuitRequest;
594 }
595
596
597 namespace {
598
599   // id_loop() is the main iterative deepening loop. It calls search() repeatedly
600   // with increasing depth until the allocated thinking time has been consumed,
601   // user stops the search, or the maximum search depth is reached.
602
603   Move id_loop(Position& pos, Move searchMoves[], Move* ponderMove) {
604
605     SearchStack ss[PLY_MAX_PLUS_2];
606     Value bestValues[PLY_MAX_PLUS_2];
607     int bestMoveChanges[PLY_MAX_PLUS_2];
608     int depth, researchCountFL, researchCountFH, aspirationDelta;
609     Value value, alpha, beta;
610     Move bestMove, easyMove;
611
612     // Moves to search are verified, scored and sorted
613     Rml.init(pos, searchMoves);
614
615     // Initialize FIXME move before Rml.init()
616     TT.new_search();
617     H.clear();
618     memset(ss, 0, PLY_MAX_PLUS_2 * sizeof(SearchStack));
619     *ponderMove = bestMove = easyMove = MOVE_NONE;
620     depth = aspirationDelta = 0;
621     ss->currentMove = MOVE_NULL; // Hack to skip update_gains()
622     alpha = -VALUE_INFINITE, beta = VALUE_INFINITE;
623
624     // Handle special case of searching on a mate/stale position
625     if (Rml.size() == 0)
626     {
627         cout << "info depth 0 score "
628              << value_to_uci(pos.is_check() ? -VALUE_MATE : VALUE_DRAW)
629              << endl;
630
631         return MOVE_NONE;
632     }
633
634     // Is one move significantly better than others after initial scoring ?
635     if (   Rml.size() == 1
636         || Rml[0].pv_score > Rml[1].pv_score + EasyMoveMargin)
637         easyMove = Rml[0].pv[0];
638
639     // Iterative deepening loop
640     while (++depth <= PLY_MAX && (!MaxDepth || depth <= MaxDepth) && !StopRequest)
641     {
642         Rml.bestMoveChanges = researchCountFL = researchCountFH = 0;
643         cout << "info depth " << depth << endl;
644
645         // Calculate dynamic aspiration window based on previous iterations
646         if (MultiPV == 1 && depth >= 5 && abs(bestValues[depth - 1]) < VALUE_KNOWN_WIN)
647         {
648             int prevDelta1 = bestValues[depth - 1] - bestValues[depth - 2];
649             int prevDelta2 = bestValues[depth - 2] - bestValues[depth - 3];
650
651             aspirationDelta = Min(Max(abs(prevDelta1) + abs(prevDelta2) / 2, 16), 24);
652             aspirationDelta = (aspirationDelta + 7) / 8 * 8; // Round to match grainSize
653
654             alpha = Max(bestValues[depth - 1] - aspirationDelta, -VALUE_INFINITE);
655             beta  = Min(bestValues[depth - 1] + aspirationDelta,  VALUE_INFINITE);
656         }
657
658         // Start with a small aspiration window and, in case of fail high/low,
659         // research with bigger window until not failing high/low anymore.
660         while (true)
661         {
662             // Search starting from ss+1 to allow calling update_gains()
663             value = search<PV, false, true>(pos, ss+1, alpha, beta, depth * ONE_PLY, 0);
664
665             // Send PV line to GUI and write to transposition table in case the
666             // relevant entries have been overwritten during the search.
667             for (int i = 0; i < Min(MultiPV, (int)Rml.size()); i++)
668             {
669                 Rml[i].insert_pv_in_tt(pos);
670                 cout << set960(pos.is_chess960())
671                      << Rml[i].pv_info_to_uci(pos, depth, alpha, beta, i) << endl;
672             }
673
674             // Value cannot be trusted. Break out immediately!
675             if (StopRequest)
676                 break;
677
678             assert(value >= alpha);
679
680             // In case of failing high/low increase aspiration window and research,
681             // otherwise exit the fail high/low loop.
682             if (value >= beta)
683             {
684                 beta = Min(beta + aspirationDelta * (1 << researchCountFH), VALUE_INFINITE);
685                 researchCountFH++;
686             }
687             else if (value <= alpha)
688             {
689                 AspirationFailLow = true;
690                 StopOnPonderhit = false;
691
692                 alpha = Max(alpha - aspirationDelta * (1 << researchCountFL), -VALUE_INFINITE);
693                 researchCountFL++;
694             }
695             else
696                 break;
697         }
698
699         // Collect info about search result
700         bestMove = Rml[0].pv[0];
701         bestValues[depth] = value;
702         bestMoveChanges[depth] = Rml.bestMoveChanges;
703
704         // Drop the easy move if differs from the new best move
705         if (bestMove != easyMove)
706             easyMove = MOVE_NONE;
707
708         if (UseTimeManagement && !StopRequest)
709         {
710             // Time to stop?
711             bool noMoreTime = false;
712
713             // Stop search early when the last two iterations returned a mate score
714             if (   depth >= 5
715                 && abs(bestValues[depth])     >= abs(VALUE_MATE) - 100
716                 && abs(bestValues[depth - 1]) >= abs(VALUE_MATE) - 100)
717                 noMoreTime = true;
718
719             // Stop search early if one move seems to be much better than the
720             // others or if there is only a single legal move. In this latter
721             // case we search up to Iteration 8 anyway to get a proper score.
722             if (   depth >= 7
723                 && easyMove == bestMove
724                 && (   Rml.size() == 1
725                     ||(   Rml[0].nodes > (pos.nodes_searched() * 85) / 100
726                        && current_search_time() > TimeMgr.available_time() / 16)
727                     ||(   Rml[0].nodes > (pos.nodes_searched() * 98) / 100
728                        && current_search_time() > TimeMgr.available_time() / 32)))
729                 noMoreTime = true;
730
731             // Add some extra time if the best move has changed during the last two iterations
732             if (depth > 4 && depth < 50)
733                 TimeMgr.pv_instability(bestMoveChanges[depth], bestMoveChanges[depth-1]);
734
735             // Stop search if most of MaxSearchTime is consumed at the end of the
736             // iteration. We probably don't have enough time to search the first
737             // move at the next iteration anyway.
738             if (current_search_time() > (TimeMgr.available_time() * 80) / 128)
739                 noMoreTime = true;
740
741             if (noMoreTime)
742             {
743                 if (Pondering)
744                     StopOnPonderhit = true;
745                 else
746                     break;
747             }
748         }
749     }
750
751     *ponderMove = Rml[0].pv[1];
752     return bestMove;
753   }
754
755
756   // search<>() is the main search function for both PV and non-PV nodes and for
757   // normal and SplitPoint nodes. When called just after a split point the search
758   // is simpler because we have already probed the hash table, done a null move
759   // search, and searched the first move before splitting, we don't have to repeat
760   // all this work again. We also don't need to store anything to the hash table
761   // here: This is taken care of after we return from the split point.
762
763   template <NodeType PvNode, bool SpNode, bool Root>
764   Value search(Position& pos, SearchStack* ss, Value alpha, Value beta, Depth depth, int ply) {
765
766     assert(alpha >= -VALUE_INFINITE && alpha <= VALUE_INFINITE);
767     assert(beta > alpha && beta <= VALUE_INFINITE);
768     assert(PvNode || alpha == beta - 1);
769     assert((Root || ply > 0) && ply < PLY_MAX);
770     assert(pos.thread() >= 0 && pos.thread() < ThreadsMgr.active_threads());
771
772     Move movesSearched[MOVES_MAX];
773     int64_t nodes;
774     StateInfo st;
775     const TTEntry *tte;
776     Key posKey;
777     Move ttMove, move, excludedMove, threatMove;
778     Depth ext, newDepth;
779     ValueType vt;
780     Value bestValue, value, oldAlpha;
781     Value refinedValue, nullValue, futilityBase, futilityValueScaled; // Non-PV specific
782     bool isPvMove, isCheck, singularExtensionNode, moveIsCheck, captureOrPromotion, dangerous;
783     bool mateThreat = false;
784     int moveCount = 0, playedMoveCount = 0;
785     int threadID = pos.thread();
786     SplitPoint* sp = NULL;
787
788     refinedValue = bestValue = value = -VALUE_INFINITE;
789     oldAlpha = alpha;
790     isCheck = pos.is_check();
791
792     if (SpNode)
793     {
794         sp = ss->sp;
795         tte = NULL;
796         ttMove = excludedMove = MOVE_NONE;
797         threatMove = sp->threatMove;
798         mateThreat = sp->mateThreat;
799         goto split_point_start;
800     }
801     else if (Root)
802         bestValue = alpha;
803
804     // Step 1. Initialize node and poll. Polling can abort search
805     ss->currentMove = ss->bestMove = threatMove = MOVE_NONE;
806     (ss+2)->killers[0] = (ss+2)->killers[1] = (ss+2)->mateKiller = MOVE_NONE;
807
808     if (threadID == 0 && ++NodesSincePoll > NodesBetweenPolls)
809     {
810         NodesSincePoll = 0;
811         poll(pos);
812     }
813
814     // Step 2. Check for aborted search and immediate draw
815     if ((   StopRequest
816          || ThreadsMgr.cutoff_at_splitpoint(threadID)
817          || pos.is_draw()
818          || ply >= PLY_MAX - 1) && !Root)
819         return VALUE_DRAW;
820
821     // Step 3. Mate distance pruning
822     alpha = Max(value_mated_in(ply), alpha);
823     beta = Min(value_mate_in(ply+1), beta);
824     if (alpha >= beta)
825         return alpha;
826
827     // Step 4. Transposition table lookup
828     // We don't want the score of a partial search to overwrite a previous full search
829     // TT value, so we use a different position key in case of an excluded move exists.
830     excludedMove = ss->excludedMove;
831     posKey = excludedMove ? pos.get_exclusion_key() : pos.get_key();
832
833     tte = TT.retrieve(posKey);
834     ttMove = tte ? tte->move() : MOVE_NONE;
835
836     // At PV nodes we check for exact scores, while at non-PV nodes we check for
837     // and return a fail high/low. Biggest advantage at probing at PV nodes is
838     // to have a smooth experience in analysis mode.
839     if (   !Root
840         && tte
841         && (PvNode ? tte->depth() >= depth && tte->type() == VALUE_TYPE_EXACT
842                    : ok_to_use_TT(tte, depth, beta, ply)))
843     {
844         TT.refresh(tte);
845         ss->bestMove = ttMove; // Can be MOVE_NONE
846         return value_from_tt(tte->value(), ply);
847     }
848
849     // Step 5. Evaluate the position statically and
850     // update gain statistics of parent move.
851     if (isCheck)
852         ss->eval = ss->evalMargin = VALUE_NONE;
853     else if (tte)
854     {
855         assert(tte->static_value() != VALUE_NONE);
856
857         ss->eval = tte->static_value();
858         ss->evalMargin = tte->static_value_margin();
859         refinedValue = refine_eval(tte, ss->eval, ply);
860     }
861     else
862     {
863         refinedValue = ss->eval = evaluate(pos, ss->evalMargin);
864         TT.store(posKey, VALUE_NONE, VALUE_TYPE_NONE, DEPTH_NONE, MOVE_NONE, ss->eval, ss->evalMargin);
865     }
866
867     // Save gain for the parent non-capture move
868     update_gains(pos, (ss-1)->currentMove, (ss-1)->eval, ss->eval);
869
870     // Step 6. Razoring (is omitted in PV nodes)
871     if (   !PvNode
872         &&  depth < RazorDepth
873         && !isCheck
874         &&  refinedValue < beta - razor_margin(depth)
875         &&  ttMove == MOVE_NONE
876         && !value_is_mate(beta)
877         && !pos.has_pawn_on_7th(pos.side_to_move()))
878     {
879         Value rbeta = beta - razor_margin(depth);
880         Value v = qsearch<NonPV>(pos, ss, rbeta-1, rbeta, DEPTH_ZERO, ply);
881         if (v < rbeta)
882             // Logically we should return (v + razor_margin(depth)), but
883             // surprisingly this did slightly weaker in tests.
884             return v;
885     }
886
887     // Step 7. Static null move pruning (is omitted in PV nodes)
888     // We're betting that the opponent doesn't have a move that will reduce
889     // the score by more than futility_margin(depth) if we do a null move.
890     if (   !PvNode
891         && !ss->skipNullMove
892         &&  depth < RazorDepth
893         && !isCheck
894         &&  refinedValue >= beta + futility_margin(depth, 0)
895         && !value_is_mate(beta)
896         &&  pos.non_pawn_material(pos.side_to_move()))
897         return refinedValue - futility_margin(depth, 0);
898
899     // Step 8. Null move search with verification search (is omitted in PV nodes)
900     if (   !PvNode
901         && !ss->skipNullMove
902         &&  depth > ONE_PLY
903         && !isCheck
904         &&  refinedValue >= beta
905         && !value_is_mate(beta)
906         &&  pos.non_pawn_material(pos.side_to_move()))
907     {
908         ss->currentMove = MOVE_NULL;
909
910         // Null move dynamic reduction based on depth
911         int R = 3 + (depth >= 5 * ONE_PLY ? depth / 8 : 0);
912
913         // Null move dynamic reduction based on value
914         if (refinedValue - beta > PawnValueMidgame)
915             R++;
916
917         pos.do_null_move(st);
918         (ss+1)->skipNullMove = true;
919         nullValue = -search<NonPV>(pos, ss+1, -beta, -alpha, depth-R*ONE_PLY, ply+1);
920         (ss+1)->skipNullMove = false;
921         pos.undo_null_move();
922
923         if (nullValue >= beta)
924         {
925             // Do not return unproven mate scores
926             if (nullValue >= value_mate_in(PLY_MAX))
927                 nullValue = beta;
928
929             if (depth < 6 * ONE_PLY)
930                 return nullValue;
931
932             // Do verification search at high depths
933             ss->skipNullMove = true;
934             Value v = search<NonPV>(pos, ss, alpha, beta, depth-R*ONE_PLY, ply);
935             ss->skipNullMove = false;
936
937             if (v >= beta)
938                 return nullValue;
939         }
940         else
941         {
942             // The null move failed low, which means that we may be faced with
943             // some kind of threat. If the previous move was reduced, check if
944             // the move that refuted the null move was somehow connected to the
945             // move which was reduced. If a connection is found, return a fail
946             // low score (which will cause the reduced move to fail high in the
947             // parent node, which will trigger a re-search with full depth).
948             if (nullValue == value_mated_in(ply + 2))
949                 mateThreat = true;
950
951             threatMove = (ss+1)->bestMove;
952             if (   depth < ThreatDepth
953                 && (ss-1)->reduction
954                 && threatMove != MOVE_NONE
955                 && connected_moves(pos, (ss-1)->currentMove, threatMove))
956                 return beta - 1;
957         }
958     }
959
960     // Step 9. Internal iterative deepening
961     if (   depth >= IIDDepth[PvNode]
962         && ttMove == MOVE_NONE
963         && (PvNode || (!isCheck && ss->eval >= beta - IIDMargin)))
964     {
965         Depth d = (PvNode ? depth - 2 * ONE_PLY : depth / 2);
966
967         ss->skipNullMove = true;
968         search<PvNode>(pos, ss, alpha, beta, d, ply);
969         ss->skipNullMove = false;
970
971         ttMove = ss->bestMove;
972         tte = TT.retrieve(posKey);
973     }
974
975     // Expensive mate threat detection (only for PV nodes)
976     if (PvNode)
977         mateThreat = pos.has_mate_threat();
978
979 split_point_start: // At split points actual search starts from here
980
981     // Initialize a MovePicker object for the current position
982     MovePickerExt<SpNode, Root> mp(pos, ttMove, depth, H, ss, (PvNode ? -VALUE_INFINITE : beta));
983     CheckInfo ci(pos);
984     ss->bestMove = MOVE_NONE;
985     futilityBase = ss->eval + ss->evalMargin;
986     singularExtensionNode =   !Root
987                            && !SpNode
988                            && depth >= SingularExtensionDepth[PvNode]
989                            && tte
990                            && tte->move()
991                            && !excludedMove // Do not allow recursive singular extension search
992                            && (tte->type() & VALUE_TYPE_LOWER)
993                            && tte->depth() >= depth - 3 * ONE_PLY;
994     if (SpNode)
995     {
996         lock_grab(&(sp->lock));
997         bestValue = sp->bestValue;
998     }
999
1000     // Step 10. Loop through moves
1001     // Loop through all legal moves until no moves remain or a beta cutoff occurs
1002     while (   bestValue < beta
1003            && (move = mp.get_next_move()) != MOVE_NONE
1004            && !ThreadsMgr.cutoff_at_splitpoint(threadID))
1005     {
1006       assert(move_is_ok(move));
1007
1008       if (SpNode)
1009       {
1010           moveCount = ++sp->moveCount;
1011           lock_release(&(sp->lock));
1012       }
1013       else if (move == excludedMove)
1014           continue;
1015       else
1016           moveCount++;
1017
1018       if (Root)
1019       {
1020           // This is used by time management
1021           FirstRootMove = (moveCount == 1);
1022
1023           // Save the current node count before the move is searched
1024           nodes = pos.nodes_searched();
1025
1026           // If it's time to send nodes info, do it here where we have the
1027           // correct accumulated node counts searched by each thread.
1028           if (SendSearchedNodes)
1029           {
1030               SendSearchedNodes = false;
1031               cout << "info nodes " << nodes
1032                    << " nps " << nps(pos)
1033                    << " time " << current_search_time() << endl;
1034           }
1035
1036           if (current_search_time() >= 1000)
1037               cout << "info currmove " << move
1038                    << " currmovenumber " << moveCount << endl;
1039       }
1040
1041       isPvMove = (PvNode && moveCount <= (Root ? MultiPV : 1));
1042       moveIsCheck = pos.move_is_check(move, ci);
1043       captureOrPromotion = pos.move_is_capture_or_promotion(move);
1044
1045       // Step 11. Decide the new search depth
1046       ext = extension<PvNode>(pos, move, captureOrPromotion, moveIsCheck, mateThreat, &dangerous);
1047
1048       // Singular extension search. If all moves but one fail low on a search of (alpha-s, beta-s),
1049       // and just one fails high on (alpha, beta), then that move is singular and should be extended.
1050       // To verify this we do a reduced search on all the other moves but the ttMove, if result is
1051       // lower then ttValue minus a margin then we extend ttMove.
1052       if (   singularExtensionNode
1053           && move == tte->move()
1054           && ext < ONE_PLY)
1055       {
1056           Value ttValue = value_from_tt(tte->value(), ply);
1057
1058           if (abs(ttValue) < VALUE_KNOWN_WIN)
1059           {
1060               Value b = ttValue - SingularExtensionMargin;
1061               ss->excludedMove = move;
1062               ss->skipNullMove = true;
1063               Value v = search<NonPV>(pos, ss, b - 1, b, depth / 2, ply);
1064               ss->skipNullMove = false;
1065               ss->excludedMove = MOVE_NONE;
1066               ss->bestMove = MOVE_NONE;
1067               if (v < b)
1068                   ext = ONE_PLY;
1069           }
1070       }
1071
1072       // Update current move (this must be done after singular extension search)
1073       ss->currentMove = move;
1074       newDepth = depth - (!Root ? ONE_PLY : DEPTH_ZERO) + ext;
1075
1076       // Step 12. Futility pruning (is omitted in PV nodes)
1077       if (   !PvNode
1078           && !captureOrPromotion
1079           && !isCheck
1080           && !dangerous
1081           &&  move != ttMove
1082           && !move_is_castle(move))
1083       {
1084           // Move count based pruning
1085           if (   moveCount >= futility_move_count(depth)
1086               && !(threatMove && connected_threat(pos, move, threatMove))
1087               && bestValue > value_mated_in(PLY_MAX)) // FIXME bestValue is racy
1088           {
1089               if (SpNode)
1090                   lock_grab(&(sp->lock));
1091
1092               continue;
1093           }
1094
1095           // Value based pruning
1096           // We illogically ignore reduction condition depth >= 3*ONE_PLY for predicted depth,
1097           // but fixing this made program slightly weaker.
1098           Depth predictedDepth = newDepth - reduction<NonPV>(depth, moveCount);
1099           futilityValueScaled =  futilityBase + futility_margin(predictedDepth, moveCount)
1100                                + H.gain(pos.piece_on(move_from(move)), move_to(move));
1101
1102           if (futilityValueScaled < beta)
1103           {
1104               if (SpNode)
1105               {
1106                   lock_grab(&(sp->lock));
1107                   if (futilityValueScaled > sp->bestValue)
1108                       sp->bestValue = bestValue = futilityValueScaled;
1109               }
1110               else if (futilityValueScaled > bestValue)
1111                   bestValue = futilityValueScaled;
1112
1113               continue;
1114           }
1115
1116           // Prune moves with negative SEE at low depths
1117           if (   predictedDepth < 2 * ONE_PLY
1118               && bestValue > value_mated_in(PLY_MAX)
1119               && pos.see_sign(move) < 0)
1120           {
1121               if (SpNode)
1122                   lock_grab(&(sp->lock));
1123
1124               continue;
1125           }
1126       }
1127
1128       // Step 13. Make the move
1129       pos.do_move(move, st, ci, moveIsCheck);
1130
1131       if (!SpNode && !captureOrPromotion)
1132           movesSearched[playedMoveCount++] = move;
1133
1134       // Step extra. pv search (only in PV nodes)
1135       // The first move in list is the expected PV
1136       if (isPvMove)
1137       {
1138           // Aspiration window is disabled in multi-pv case
1139           if (Root && MultiPV > 1)
1140               alpha = -VALUE_INFINITE;
1141
1142           value = -search<PV>(pos, ss+1, -beta, -alpha, newDepth, ply+1);
1143       }
1144       else
1145       {
1146           // Step 14. Reduced depth search
1147           // If the move fails high will be re-searched at full depth.
1148           bool doFullDepthSearch = true;
1149
1150           if (    depth >= 3 * ONE_PLY
1151               && !captureOrPromotion
1152               && !dangerous
1153               && !move_is_castle(move)
1154               &&  ss->killers[0] != move
1155               &&  ss->killers[1] != move)
1156           {
1157               ss->reduction = Root ? reduction<PvNode>(depth, moveCount - MultiPV + 1)
1158                                    : reduction<PvNode>(depth, moveCount);
1159               if (ss->reduction)
1160               {
1161                   alpha = SpNode ? sp->alpha : alpha;
1162                   Depth d = newDepth - ss->reduction;
1163                   value = -search<NonPV>(pos, ss+1, -(alpha+1), -alpha, d, ply+1);
1164
1165                   doFullDepthSearch = (value > alpha);
1166               }
1167               ss->reduction = DEPTH_ZERO; // Restore original reduction
1168           }
1169
1170           // Step 15. Full depth search
1171           if (doFullDepthSearch)
1172           {
1173               alpha = SpNode ? sp->alpha : alpha;
1174               value = -search<NonPV>(pos, ss+1, -(alpha+1), -alpha, newDepth, ply+1);
1175
1176               // Step extra. pv search (only in PV nodes)
1177               // Search only for possible new PV nodes, if instead value >= beta then
1178               // parent node fails low with value <= alpha and tries another move.
1179               if (PvNode && value > alpha && (Root || value < beta))
1180                   value = -search<PV>(pos, ss+1, -beta, -alpha, newDepth, ply+1);
1181           }
1182       }
1183
1184       // Step 16. Undo move
1185       pos.undo_move(move);
1186
1187       assert(value > -VALUE_INFINITE && value < VALUE_INFINITE);
1188
1189       // Step 17. Check for new best move
1190       if (SpNode)
1191       {
1192           lock_grab(&(sp->lock));
1193           bestValue = sp->bestValue;
1194           alpha = sp->alpha;
1195       }
1196
1197       if (!Root && value > bestValue && !(SpNode && ThreadsMgr.cutoff_at_splitpoint(threadID)))
1198       {
1199           bestValue = value;
1200
1201           if (SpNode)
1202               sp->bestValue = value;
1203
1204           if (value > alpha)
1205           {
1206               if (PvNode && value < beta) // We want always alpha < beta
1207               {
1208                   alpha = value;
1209
1210                   if (SpNode)
1211                       sp->alpha = value;
1212               }
1213               else if (SpNode)
1214                   sp->betaCutoff = true;
1215
1216               if (value == value_mate_in(ply + 1))
1217                   ss->mateKiller = move;
1218
1219               ss->bestMove = move;
1220
1221               if (SpNode)
1222                   sp->parentSstack->bestMove = move;
1223           }
1224       }
1225
1226       if (Root)
1227       {
1228           // To avoid to exit with bestValue == -VALUE_INFINITE
1229           if (value > bestValue)
1230               bestValue = value;
1231
1232           // Finished searching the move. If StopRequest is true, the search
1233           // was aborted because the user interrupted the search or because we
1234           // ran out of time. In this case, the return value of the search cannot
1235           // be trusted, and we break out of the loop without updating the best
1236           // move and/or PV.
1237           if (StopRequest)
1238               break;
1239
1240           // Remember searched nodes counts for this move
1241           mp.rm->nodes += pos.nodes_searched() - nodes;
1242
1243           // Step 17. Check for new best move
1244           if (!isPvMove && value <= alpha)
1245               mp.rm->pv_score = -VALUE_INFINITE;
1246           else
1247           {
1248               // PV move or new best move!
1249
1250               // Update PV
1251               ss->bestMove = move;
1252               mp.rm->pv_score = value;
1253               mp.rm->extract_pv_from_tt(pos);
1254
1255               // We record how often the best move has been changed in each
1256               // iteration. This information is used for time managment: When
1257               // the best move changes frequently, we allocate some more time.
1258               if (!isPvMove && MultiPV == 1)
1259                   Rml.bestMoveChanges++;
1260
1261               Rml.sort_multipv(moveCount);
1262
1263               // Update alpha. In multi-pv we don't use aspiration window, so
1264               // set alpha equal to minimum score among the PV lines.
1265               if (MultiPV > 1)
1266                   alpha = Rml[Min(moveCount, MultiPV) - 1].pv_score; // FIXME why moveCount?
1267               else if (value > alpha)
1268                   alpha = value;
1269
1270           } // PV move or new best move
1271       }
1272
1273       // Step 18. Check for split
1274       if (   !Root
1275           && !SpNode
1276           && depth >= ThreadsMgr.min_split_depth()
1277           && ThreadsMgr.active_threads() > 1
1278           && bestValue < beta
1279           && ThreadsMgr.available_thread_exists(threadID)
1280           && !StopRequest
1281           && !ThreadsMgr.cutoff_at_splitpoint(threadID))
1282           ThreadsMgr.split<FakeSplit>(pos, ss, ply, &alpha, beta, &bestValue, depth,
1283                                       threatMove, mateThreat, moveCount, &mp, PvNode);
1284     }
1285
1286     // Step 19. Check for mate and stalemate
1287     // All legal moves have been searched and if there are
1288     // no legal moves, it must be mate or stalemate.
1289     // If one move was excluded return fail low score.
1290     if (!SpNode && !moveCount)
1291         return excludedMove ? oldAlpha : isCheck ? value_mated_in(ply) : VALUE_DRAW;
1292
1293     // Step 20. Update tables
1294     // If the search is not aborted, update the transposition table,
1295     // history counters, and killer moves.
1296     if (!SpNode && !StopRequest && !ThreadsMgr.cutoff_at_splitpoint(threadID))
1297     {
1298         move = bestValue <= oldAlpha ? MOVE_NONE : ss->bestMove;
1299         vt   = bestValue <= oldAlpha ? VALUE_TYPE_UPPER
1300              : bestValue >= beta ? VALUE_TYPE_LOWER : VALUE_TYPE_EXACT;
1301
1302         TT.store(posKey, value_to_tt(bestValue, ply), vt, depth, move, ss->eval, ss->evalMargin);
1303
1304         // Update killers and history only for non capture moves that fails high
1305         if (    bestValue >= beta
1306             && !pos.move_is_capture_or_promotion(move))
1307         {
1308             update_history(pos, move, depth, movesSearched, playedMoveCount);
1309             update_killers(move, ss->killers);
1310         }
1311     }
1312
1313     if (SpNode)
1314     {
1315         // Here we have the lock still grabbed
1316         sp->slaves[threadID] = 0;
1317         sp->nodes += pos.nodes_searched();
1318         lock_release(&(sp->lock));
1319     }
1320
1321     assert(bestValue > -VALUE_INFINITE && bestValue < VALUE_INFINITE);
1322
1323     return bestValue;
1324   }
1325
1326   // qsearch() is the quiescence search function, which is called by the main
1327   // search function when the remaining depth is zero (or, to be more precise,
1328   // less than ONE_PLY).
1329
1330   template <NodeType PvNode>
1331   Value qsearch(Position& pos, SearchStack* ss, Value alpha, Value beta, Depth depth, int ply) {
1332
1333     assert(alpha >= -VALUE_INFINITE && alpha <= VALUE_INFINITE);
1334     assert(beta >= -VALUE_INFINITE && beta <= VALUE_INFINITE);
1335     assert(PvNode || alpha == beta - 1);
1336     assert(depth <= 0);
1337     assert(ply > 0 && ply < PLY_MAX);
1338     assert(pos.thread() >= 0 && pos.thread() < ThreadsMgr.active_threads());
1339
1340     StateInfo st;
1341     Move ttMove, move;
1342     Value bestValue, value, evalMargin, futilityValue, futilityBase;
1343     bool isCheck, enoughMaterial, moveIsCheck, evasionPrunable;
1344     const TTEntry* tte;
1345     Depth ttDepth;
1346     Value oldAlpha = alpha;
1347
1348     ss->bestMove = ss->currentMove = MOVE_NONE;
1349
1350     // Check for an instant draw or maximum ply reached
1351     if (pos.is_draw() || ply >= PLY_MAX - 1)
1352         return VALUE_DRAW;
1353
1354     // Decide whether or not to include checks, this fixes also the type of
1355     // TT entry depth that we are going to use. Note that in qsearch we use
1356     // only two types of depth in TT: DEPTH_QS_CHECKS or DEPTH_QS_NO_CHECKS.
1357     isCheck = pos.is_check();
1358     ttDepth = (isCheck || depth >= DEPTH_QS_CHECKS ? DEPTH_QS_CHECKS : DEPTH_QS_NO_CHECKS);
1359
1360     // Transposition table lookup. At PV nodes, we don't use the TT for
1361     // pruning, but only for move ordering.
1362     tte = TT.retrieve(pos.get_key());
1363     ttMove = (tte ? tte->move() : MOVE_NONE);
1364
1365     if (!PvNode && tte && ok_to_use_TT(tte, ttDepth, beta, ply))
1366     {
1367         ss->bestMove = ttMove; // Can be MOVE_NONE
1368         return value_from_tt(tte->value(), ply);
1369     }
1370
1371     // Evaluate the position statically
1372     if (isCheck)
1373     {
1374         bestValue = futilityBase = -VALUE_INFINITE;
1375         ss->eval = evalMargin = VALUE_NONE;
1376         enoughMaterial = false;
1377     }
1378     else
1379     {
1380         if (tte)
1381         {
1382             assert(tte->static_value() != VALUE_NONE);
1383
1384             evalMargin = tte->static_value_margin();
1385             ss->eval = bestValue = tte->static_value();
1386         }
1387         else
1388             ss->eval = bestValue = evaluate(pos, evalMargin);
1389
1390         update_gains(pos, (ss-1)->currentMove, (ss-1)->eval, ss->eval);
1391
1392         // Stand pat. Return immediately if static value is at least beta
1393         if (bestValue >= beta)
1394         {
1395             if (!tte)
1396                 TT.store(pos.get_key(), value_to_tt(bestValue, ply), VALUE_TYPE_LOWER, DEPTH_NONE, MOVE_NONE, ss->eval, evalMargin);
1397
1398             return bestValue;
1399         }
1400
1401         if (PvNode && bestValue > alpha)
1402             alpha = bestValue;
1403
1404         // Futility pruning parameters, not needed when in check
1405         futilityBase = ss->eval + evalMargin + FutilityMarginQS;
1406         enoughMaterial = pos.non_pawn_material(pos.side_to_move()) > RookValueMidgame;
1407     }
1408
1409     // Initialize a MovePicker object for the current position, and prepare
1410     // to search the moves. Because the depth is <= 0 here, only captures,
1411     // queen promotions and checks (only if depth >= DEPTH_QS_CHECKS) will
1412     // be generated.
1413     MovePicker mp(pos, ttMove, depth, H);
1414     CheckInfo ci(pos);
1415
1416     // Loop through the moves until no moves remain or a beta cutoff occurs
1417     while (   alpha < beta
1418            && (move = mp.get_next_move()) != MOVE_NONE)
1419     {
1420       assert(move_is_ok(move));
1421
1422       moveIsCheck = pos.move_is_check(move, ci);
1423
1424       // Futility pruning
1425       if (   !PvNode
1426           && !isCheck
1427           && !moveIsCheck
1428           &&  move != ttMove
1429           &&  enoughMaterial
1430           && !move_is_promotion(move)
1431           && !pos.move_is_passed_pawn_push(move))
1432       {
1433           futilityValue =  futilityBase
1434                          + pos.endgame_value_of_piece_on(move_to(move))
1435                          + (move_is_ep(move) ? PawnValueEndgame : VALUE_ZERO);
1436
1437           if (futilityValue < alpha)
1438           {
1439               if (futilityValue > bestValue)
1440                   bestValue = futilityValue;
1441               continue;
1442           }
1443       }
1444
1445       // Detect non-capture evasions that are candidate to be pruned
1446       evasionPrunable =   isCheck
1447                        && bestValue > value_mated_in(PLY_MAX)
1448                        && !pos.move_is_capture(move)
1449                        && !pos.can_castle(pos.side_to_move());
1450
1451       // Don't search moves with negative SEE values
1452       if (   !PvNode
1453           && (!isCheck || evasionPrunable)
1454           &&  move != ttMove
1455           && !move_is_promotion(move)
1456           &&  pos.see_sign(move) < 0)
1457           continue;
1458
1459       // Don't search useless checks
1460       if (   !PvNode
1461           && !isCheck
1462           &&  moveIsCheck
1463           &&  move != ttMove
1464           && !pos.move_is_capture_or_promotion(move)
1465           &&  ss->eval + PawnValueMidgame / 4 < beta
1466           && !check_is_dangerous(pos, move, futilityBase, beta, &bestValue))
1467       {
1468           if (ss->eval + PawnValueMidgame / 4 > bestValue)
1469               bestValue = ss->eval + PawnValueMidgame / 4;
1470
1471           continue;
1472       }
1473
1474       // Update current move
1475       ss->currentMove = move;
1476
1477       // Make and search the move
1478       pos.do_move(move, st, ci, moveIsCheck);
1479       value = -qsearch<PvNode>(pos, ss+1, -beta, -alpha, depth-ONE_PLY, ply+1);
1480       pos.undo_move(move);
1481
1482       assert(value > -VALUE_INFINITE && value < VALUE_INFINITE);
1483
1484       // New best move?
1485       if (value > bestValue)
1486       {
1487           bestValue = value;
1488           if (value > alpha)
1489           {
1490               alpha = value;
1491               ss->bestMove = move;
1492           }
1493        }
1494     }
1495
1496     // All legal moves have been searched. A special case: If we're in check
1497     // and no legal moves were found, it is checkmate.
1498     if (isCheck && bestValue == -VALUE_INFINITE)
1499         return value_mated_in(ply);
1500
1501     // Update transposition table
1502     ValueType vt = (bestValue <= oldAlpha ? VALUE_TYPE_UPPER : bestValue >= beta ? VALUE_TYPE_LOWER : VALUE_TYPE_EXACT);
1503     TT.store(pos.get_key(), value_to_tt(bestValue, ply), vt, ttDepth, ss->bestMove, ss->eval, evalMargin);
1504
1505     assert(bestValue > -VALUE_INFINITE && bestValue < VALUE_INFINITE);
1506
1507     return bestValue;
1508   }
1509
1510
1511   // qsearch_scoring() scores each move of a list using a qsearch() evaluation,
1512   // it is used in RootMoveList to get an initial scoring.
1513   void qsearch_scoring(Position& pos, MoveStack* mlist, MoveStack* last) {
1514
1515     SearchStack ss[PLY_MAX_PLUS_2];
1516     StateInfo st;
1517
1518     memset(ss, 0, 4 * sizeof(SearchStack));
1519     ss[0].eval = ss[0].evalMargin = VALUE_NONE;
1520
1521     for (MoveStack* cur = mlist; cur != last; cur++)
1522     {
1523         ss[0].currentMove = cur->move;
1524         pos.do_move(cur->move, st);
1525         cur->score = -qsearch<PV>(pos, ss+1, -VALUE_INFINITE, VALUE_INFINITE, DEPTH_ZERO, 1);
1526         pos.undo_move(cur->move);
1527     }
1528   }
1529
1530
1531   // check_is_dangerous() tests if a checking move can be pruned in qsearch().
1532   // bestValue is updated only when returning false because in that case move
1533   // will be pruned.
1534
1535   bool check_is_dangerous(Position &pos, Move move, Value futilityBase, Value beta, Value *bestValue)
1536   {
1537     Bitboard b, occ, oldAtt, newAtt, kingAtt;
1538     Square from, to, ksq, victimSq;
1539     Piece pc;
1540     Color them;
1541     Value futilityValue, bv = *bestValue;
1542
1543     from = move_from(move);
1544     to = move_to(move);
1545     them = opposite_color(pos.side_to_move());
1546     ksq = pos.king_square(them);
1547     kingAtt = pos.attacks_from<KING>(ksq);
1548     pc = pos.piece_on(from);
1549
1550     occ = pos.occupied_squares() & ~(1ULL << from) & ~(1ULL << ksq);
1551     oldAtt = pos.attacks_from(pc, from, occ);
1552     newAtt = pos.attacks_from(pc,   to, occ);
1553
1554     // Rule 1. Checks which give opponent's king at most one escape square are dangerous
1555     b = kingAtt & ~pos.pieces_of_color(them) & ~newAtt & ~(1ULL << to);
1556
1557     if (!(b && (b & (b - 1))))
1558         return true;
1559
1560     // Rule 2. Queen contact check is very dangerous
1561     if (   type_of_piece(pc) == QUEEN
1562         && bit_is_set(kingAtt, to))
1563         return true;
1564
1565     // Rule 3. Creating new double threats with checks
1566     b = pos.pieces_of_color(them) & newAtt & ~oldAtt & ~(1ULL << ksq);
1567
1568     while (b)
1569     {
1570         victimSq = pop_1st_bit(&b);
1571         futilityValue = futilityBase + pos.endgame_value_of_piece_on(victimSq);
1572
1573         // Note that here we generate illegal "double move"!
1574         if (   futilityValue >= beta
1575             && pos.see_sign(make_move(from, victimSq)) >= 0)
1576             return true;
1577
1578         if (futilityValue > bv)
1579             bv = futilityValue;
1580     }
1581
1582     // Update bestValue only if check is not dangerous (because we will prune the move)
1583     *bestValue = bv;
1584     return false;
1585   }
1586
1587
1588   // connected_moves() tests whether two moves are 'connected' in the sense
1589   // that the first move somehow made the second move possible (for instance
1590   // if the moving piece is the same in both moves). The first move is assumed
1591   // to be the move that was made to reach the current position, while the
1592   // second move is assumed to be a move from the current position.
1593
1594   bool connected_moves(const Position& pos, Move m1, Move m2) {
1595
1596     Square f1, t1, f2, t2;
1597     Piece p;
1598
1599     assert(m1 && move_is_ok(m1));
1600     assert(m2 && move_is_ok(m2));
1601
1602     // Case 1: The moving piece is the same in both moves
1603     f2 = move_from(m2);
1604     t1 = move_to(m1);
1605     if (f2 == t1)
1606         return true;
1607
1608     // Case 2: The destination square for m2 was vacated by m1
1609     t2 = move_to(m2);
1610     f1 = move_from(m1);
1611     if (t2 == f1)
1612         return true;
1613
1614     // Case 3: Moving through the vacated square
1615     if (   piece_is_slider(pos.piece_on(f2))
1616         && bit_is_set(squares_between(f2, t2), f1))
1617       return true;
1618
1619     // Case 4: The destination square for m2 is defended by the moving piece in m1
1620     p = pos.piece_on(t1);
1621     if (bit_is_set(pos.attacks_from(p, t1), t2))
1622         return true;
1623
1624     // Case 5: Discovered check, checking piece is the piece moved in m1
1625     if (    piece_is_slider(p)
1626         &&  bit_is_set(squares_between(t1, pos.king_square(pos.side_to_move())), f2)
1627         && !bit_is_set(squares_between(t1, pos.king_square(pos.side_to_move())), t2))
1628     {
1629         // discovered_check_candidates() works also if the Position's side to
1630         // move is the opposite of the checking piece.
1631         Color them = opposite_color(pos.side_to_move());
1632         Bitboard dcCandidates = pos.discovered_check_candidates(them);
1633
1634         if (bit_is_set(dcCandidates, f2))
1635             return true;
1636     }
1637     return false;
1638   }
1639
1640
1641   // value_is_mate() checks if the given value is a mate one eventually
1642   // compensated for the ply.
1643
1644   bool value_is_mate(Value value) {
1645
1646     assert(abs(value) <= VALUE_INFINITE);
1647
1648     return   value <= value_mated_in(PLY_MAX)
1649           || value >= value_mate_in(PLY_MAX);
1650   }
1651
1652
1653   // value_to_tt() adjusts a mate score from "plies to mate from the root" to
1654   // "plies to mate from the current ply".  Non-mate scores are unchanged.
1655   // The function is called before storing a value to the transposition table.
1656
1657   Value value_to_tt(Value v, int ply) {
1658
1659     if (v >= value_mate_in(PLY_MAX))
1660       return v + ply;
1661
1662     if (v <= value_mated_in(PLY_MAX))
1663       return v - ply;
1664
1665     return v;
1666   }
1667
1668
1669   // value_from_tt() is the inverse of value_to_tt(): It adjusts a mate score from
1670   // the transposition table to a mate score corrected for the current ply.
1671
1672   Value value_from_tt(Value v, int ply) {
1673
1674     if (v >= value_mate_in(PLY_MAX))
1675       return v - ply;
1676
1677     if (v <= value_mated_in(PLY_MAX))
1678       return v + ply;
1679
1680     return v;
1681   }
1682
1683
1684   // extension() decides whether a move should be searched with normal depth,
1685   // or with extended depth. Certain classes of moves (checking moves, in
1686   // particular) are searched with bigger depth than ordinary moves and in
1687   // any case are marked as 'dangerous'. Note that also if a move is not
1688   // extended, as example because the corresponding UCI option is set to zero,
1689   // the move is marked as 'dangerous' so, at least, we avoid to prune it.
1690   template <NodeType PvNode>
1691   Depth extension(const Position& pos, Move m, bool captureOrPromotion,
1692                   bool moveIsCheck, bool mateThreat, bool* dangerous) {
1693
1694     assert(m != MOVE_NONE);
1695
1696     Depth result = DEPTH_ZERO;
1697     *dangerous = moveIsCheck | mateThreat;
1698
1699     if (*dangerous)
1700     {
1701         if (moveIsCheck && pos.see_sign(m) >= 0)
1702             result += CheckExtension[PvNode];
1703
1704         if (mateThreat)
1705             result += MateThreatExtension[PvNode];
1706     }
1707
1708     if (pos.type_of_piece_on(move_from(m)) == PAWN)
1709     {
1710         Color c = pos.side_to_move();
1711         if (relative_rank(c, move_to(m)) == RANK_7)
1712         {
1713             result += PawnPushTo7thExtension[PvNode];
1714             *dangerous = true;
1715         }
1716         if (pos.pawn_is_passed(c, move_to(m)))
1717         {
1718             result += PassedPawnExtension[PvNode];
1719             *dangerous = true;
1720         }
1721     }
1722
1723     if (   captureOrPromotion
1724         && pos.type_of_piece_on(move_to(m)) != PAWN
1725         && (  pos.non_pawn_material(WHITE) + pos.non_pawn_material(BLACK)
1726             - pos.midgame_value_of_piece_on(move_to(m)) == VALUE_ZERO)
1727         && !move_is_promotion(m)
1728         && !move_is_ep(m))
1729     {
1730         result += PawnEndgameExtension[PvNode];
1731         *dangerous = true;
1732     }
1733
1734     if (   PvNode
1735         && captureOrPromotion
1736         && pos.type_of_piece_on(move_to(m)) != PAWN
1737         && pos.see_sign(m) >= 0)
1738     {
1739         result += ONE_PLY / 2;
1740         *dangerous = true;
1741     }
1742
1743     return Min(result, ONE_PLY);
1744   }
1745
1746
1747   // connected_threat() tests whether it is safe to forward prune a move or if
1748   // is somehow coonected to the threat move returned by null search.
1749
1750   bool connected_threat(const Position& pos, Move m, Move threat) {
1751
1752     assert(move_is_ok(m));
1753     assert(threat && move_is_ok(threat));
1754     assert(!pos.move_is_check(m));
1755     assert(!pos.move_is_capture_or_promotion(m));
1756     assert(!pos.move_is_passed_pawn_push(m));
1757
1758     Square mfrom, mto, tfrom, tto;
1759
1760     mfrom = move_from(m);
1761     mto = move_to(m);
1762     tfrom = move_from(threat);
1763     tto = move_to(threat);
1764
1765     // Case 1: Don't prune moves which move the threatened piece
1766     if (mfrom == tto)
1767         return true;
1768
1769     // Case 2: If the threatened piece has value less than or equal to the
1770     // value of the threatening piece, don't prune move which defend it.
1771     if (   pos.move_is_capture(threat)
1772         && (   pos.midgame_value_of_piece_on(tfrom) >= pos.midgame_value_of_piece_on(tto)
1773             || pos.type_of_piece_on(tfrom) == KING)
1774         && pos.move_attacks_square(m, tto))
1775         return true;
1776
1777     // Case 3: If the moving piece in the threatened move is a slider, don't
1778     // prune safe moves which block its ray.
1779     if (   piece_is_slider(pos.piece_on(tfrom))
1780         && bit_is_set(squares_between(tfrom, tto), mto)
1781         && pos.see_sign(m) >= 0)
1782         return true;
1783
1784     return false;
1785   }
1786
1787
1788   // ok_to_use_TT() returns true if a transposition table score
1789   // can be used at a given point in search.
1790
1791   bool ok_to_use_TT(const TTEntry* tte, Depth depth, Value beta, int ply) {
1792
1793     Value v = value_from_tt(tte->value(), ply);
1794
1795     return   (   tte->depth() >= depth
1796               || v >= Max(value_mate_in(PLY_MAX), beta)
1797               || v < Min(value_mated_in(PLY_MAX), beta))
1798
1799           && (   ((tte->type() & VALUE_TYPE_LOWER) && v >= beta)
1800               || ((tte->type() & VALUE_TYPE_UPPER) && v < beta));
1801   }
1802
1803
1804   // refine_eval() returns the transposition table score if
1805   // possible otherwise falls back on static position evaluation.
1806
1807   Value refine_eval(const TTEntry* tte, Value defaultEval, int ply) {
1808
1809       assert(tte);
1810
1811       Value v = value_from_tt(tte->value(), ply);
1812
1813       if (   ((tte->type() & VALUE_TYPE_LOWER) && v >= defaultEval)
1814           || ((tte->type() & VALUE_TYPE_UPPER) && v < defaultEval))
1815           return v;
1816
1817       return defaultEval;
1818   }
1819
1820
1821   // update_history() registers a good move that produced a beta-cutoff
1822   // in history and marks as failures all the other moves of that ply.
1823
1824   void update_history(const Position& pos, Move move, Depth depth,
1825                       Move movesSearched[], int moveCount) {
1826     Move m;
1827     Value bonus = Value(int(depth) * int(depth));
1828
1829     H.update(pos.piece_on(move_from(move)), move_to(move), bonus);
1830
1831     for (int i = 0; i < moveCount - 1; i++)
1832     {
1833         m = movesSearched[i];
1834
1835         assert(m != move);
1836
1837         H.update(pos.piece_on(move_from(m)), move_to(m), -bonus);
1838     }
1839   }
1840
1841
1842   // update_killers() add a good move that produced a beta-cutoff
1843   // among the killer moves of that ply.
1844
1845   void update_killers(Move m, Move killers[]) {
1846
1847     if (m != killers[0])
1848     {
1849         killers[1] = killers[0];
1850         killers[0] = m;
1851     }
1852   }
1853
1854
1855   // update_gains() updates the gains table of a non-capture move given
1856   // the static position evaluation before and after the move.
1857
1858   void update_gains(const Position& pos, Move m, Value before, Value after) {
1859
1860     if (   m != MOVE_NULL
1861         && before != VALUE_NONE
1862         && after != VALUE_NONE
1863         && pos.captured_piece_type() == PIECE_TYPE_NONE
1864         && !move_is_special(m))
1865         H.update_gain(pos.piece_on(move_to(m)), move_to(m), -(before + after));
1866   }
1867
1868
1869   // value_to_uci() converts a value to a string suitable for use with the UCI
1870   // protocol specifications:
1871   //
1872   // cp <x>     The score from the engine's point of view in centipawns.
1873   // mate <y>   Mate in y moves, not plies. If the engine is getting mated
1874   //            use negative values for y.
1875
1876   std::string value_to_uci(Value v) {
1877
1878     std::stringstream s;
1879
1880     if (abs(v) < VALUE_MATE - PLY_MAX * ONE_PLY)
1881       s << "cp " << int(v) * 100 / int(PawnValueMidgame); // Scale to centipawns
1882     else
1883       s << "mate " << (v > 0 ? (VALUE_MATE - v + 1) / 2 : -(VALUE_MATE + v) / 2 );
1884
1885     return s.str();
1886   }
1887
1888
1889   // current_search_time() returns the number of milliseconds which have passed
1890   // since the beginning of the current search.
1891
1892   int current_search_time() {
1893
1894     return get_system_time() - SearchStartTime;
1895   }
1896
1897
1898   // nps() computes the current nodes/second count
1899
1900   int nps(const Position& pos) {
1901
1902     int t = current_search_time();
1903     return (t > 0 ? int((pos.nodes_searched() * 1000) / t) : 0);
1904   }
1905
1906
1907   // poll() performs two different functions: It polls for user input, and it
1908   // looks at the time consumed so far and decides if it's time to abort the
1909   // search.
1910
1911   void poll(const Position& pos) {
1912
1913     static int lastInfoTime;
1914     int t = current_search_time();
1915
1916     //  Poll for input
1917     if (input_available())
1918     {
1919         // We are line oriented, don't read single chars
1920         std::string command;
1921
1922         if (!std::getline(std::cin, command))
1923             command = "quit";
1924
1925         if (command == "quit")
1926         {
1927             // Quit the program as soon as possible
1928             Pondering = false;
1929             QuitRequest = StopRequest = true;
1930             return;
1931         }
1932         else if (command == "stop")
1933         {
1934             // Stop calculating as soon as possible, but still send the "bestmove"
1935             // and possibly the "ponder" token when finishing the search.
1936             Pondering = false;
1937             StopRequest = true;
1938         }
1939         else if (command == "ponderhit")
1940         {
1941             // The opponent has played the expected move. GUI sends "ponderhit" if
1942             // we were told to ponder on the same move the opponent has played. We
1943             // should continue searching but switching from pondering to normal search.
1944             Pondering = false;
1945
1946             if (StopOnPonderhit)
1947                 StopRequest = true;
1948         }
1949     }
1950
1951     // Print search information
1952     if (t < 1000)
1953         lastInfoTime = 0;
1954
1955     else if (lastInfoTime > t)
1956         // HACK: Must be a new search where we searched less than
1957         // NodesBetweenPolls nodes during the first second of search.
1958         lastInfoTime = 0;
1959
1960     else if (t - lastInfoTime >= 1000)
1961     {
1962         lastInfoTime = t;
1963
1964         if (dbg_show_mean)
1965             dbg_print_mean();
1966
1967         if (dbg_show_hit_rate)
1968             dbg_print_hit_rate();
1969
1970         // Send info on searched nodes as soon as we return to root
1971         SendSearchedNodes = true;
1972     }
1973
1974     // Should we stop the search?
1975     if (Pondering)
1976         return;
1977
1978     bool stillAtFirstMove =    FirstRootMove
1979                            && !AspirationFailLow
1980                            &&  t > TimeMgr.available_time();
1981
1982     bool noMoreTime =   t > TimeMgr.maximum_time()
1983                      || stillAtFirstMove;
1984
1985     if (   (UseTimeManagement && noMoreTime)
1986         || (ExactMaxTime && t >= ExactMaxTime)
1987         || (MaxNodes && pos.nodes_searched() >= MaxNodes)) // FIXME
1988         StopRequest = true;
1989   }
1990
1991
1992   // wait_for_stop_or_ponderhit() is called when the maximum depth is reached
1993   // while the program is pondering. The point is to work around a wrinkle in
1994   // the UCI protocol: When pondering, the engine is not allowed to give a
1995   // "bestmove" before the GUI sends it a "stop" or "ponderhit" command.
1996   // We simply wait here until one of these commands is sent, and return,
1997   // after which the bestmove and pondermove will be printed.
1998
1999   void wait_for_stop_or_ponderhit() {
2000
2001     std::string command;
2002
2003     while (true)
2004     {
2005         // Wait for a command from stdin
2006         if (!std::getline(std::cin, command))
2007             command = "quit";
2008
2009         if (command == "quit")
2010         {
2011             QuitRequest = true;
2012             break;
2013         }
2014         else if (command == "ponderhit" || command == "stop")
2015             break;
2016     }
2017   }
2018
2019
2020   // init_thread() is the function which is called when a new thread is
2021   // launched. It simply calls the idle_loop() function with the supplied
2022   // threadID. There are two versions of this function; one for POSIX
2023   // threads and one for Windows threads.
2024
2025 #if !defined(_MSC_VER)
2026
2027   void* init_thread(void* threadID) {
2028
2029     ThreadsMgr.idle_loop(*(int*)threadID, NULL);
2030     return NULL;
2031   }
2032
2033 #else
2034
2035   DWORD WINAPI init_thread(LPVOID threadID) {
2036
2037     ThreadsMgr.idle_loop(*(int*)threadID, NULL);
2038     return 0;
2039   }
2040
2041 #endif
2042
2043
2044   /// The ThreadsManager class
2045
2046
2047   // read_uci_options() updates number of active threads and other internal
2048   // parameters according to the UCI options values. It is called before
2049   // to start a new search.
2050
2051   void ThreadsManager::read_uci_options() {
2052
2053     maxThreadsPerSplitPoint = Options["Maximum Number of Threads per Split Point"].value<int>();
2054     minimumSplitDepth       = Options["Minimum Split Depth"].value<int>() * ONE_PLY;
2055     useSleepingThreads      = Options["Use Sleeping Threads"].value<bool>();
2056     activeThreads           = Options["Threads"].value<int>();
2057   }
2058
2059
2060   // idle_loop() is where the threads are parked when they have no work to do.
2061   // The parameter 'sp', if non-NULL, is a pointer to an active SplitPoint
2062   // object for which the current thread is the master.
2063
2064   void ThreadsManager::idle_loop(int threadID, SplitPoint* sp) {
2065
2066     assert(threadID >= 0 && threadID < MAX_THREADS);
2067
2068     int i;
2069     bool allFinished = false;
2070
2071     while (true)
2072     {
2073         // Slave threads can exit as soon as AllThreadsShouldExit raises,
2074         // master should exit as last one.
2075         if (allThreadsShouldExit)
2076         {
2077             assert(!sp);
2078             threads[threadID].state = THREAD_TERMINATED;
2079             return;
2080         }
2081
2082         // If we are not thinking, wait for a condition to be signaled
2083         // instead of wasting CPU time polling for work.
2084         while (   threadID >= activeThreads || threads[threadID].state == THREAD_INITIALIZING
2085                || (useSleepingThreads && threads[threadID].state == THREAD_AVAILABLE))
2086         {
2087             assert(!sp || useSleepingThreads);
2088             assert(threadID != 0 || useSleepingThreads);
2089
2090             if (threads[threadID].state == THREAD_INITIALIZING)
2091                 threads[threadID].state = THREAD_AVAILABLE;
2092
2093             // Grab the lock to avoid races with wake_sleeping_thread()
2094             lock_grab(&sleepLock[threadID]);
2095
2096             // If we are master and all slaves have finished do not go to sleep
2097             for (i = 0; sp && i < activeThreads && !sp->slaves[i]; i++) {}
2098             allFinished = (i == activeThreads);
2099
2100             if (allFinished || allThreadsShouldExit)
2101             {
2102                 lock_release(&sleepLock[threadID]);
2103                 break;
2104             }
2105
2106             // Do sleep here after retesting sleep conditions
2107             if (threadID >= activeThreads || threads[threadID].state == THREAD_AVAILABLE)
2108                 cond_wait(&sleepCond[threadID], &sleepLock[threadID]);
2109
2110             lock_release(&sleepLock[threadID]);
2111         }
2112
2113         // If this thread has been assigned work, launch a search
2114         if (threads[threadID].state == THREAD_WORKISWAITING)
2115         {
2116             assert(!allThreadsShouldExit);
2117
2118             threads[threadID].state = THREAD_SEARCHING;
2119
2120             // Here we call search() with SplitPoint template parameter set to true
2121             SplitPoint* tsp = threads[threadID].splitPoint;
2122             Position pos(*tsp->pos, threadID);
2123             SearchStack* ss = tsp->sstack[threadID] + 1;
2124             ss->sp = tsp;
2125
2126             if (tsp->pvNode)
2127                 search<PV, true, false>(pos, ss, tsp->alpha, tsp->beta, tsp->depth, tsp->ply);
2128             else
2129                 search<NonPV, true, false>(pos, ss, tsp->alpha, tsp->beta, tsp->depth, tsp->ply);
2130
2131             assert(threads[threadID].state == THREAD_SEARCHING);
2132
2133             threads[threadID].state = THREAD_AVAILABLE;
2134
2135             // Wake up master thread so to allow it to return from the idle loop in
2136             // case we are the last slave of the split point.
2137             if (useSleepingThreads && threadID != tsp->master && threads[tsp->master].state == THREAD_AVAILABLE)
2138                 wake_sleeping_thread(tsp->master);
2139         }
2140
2141         // If this thread is the master of a split point and all slaves have
2142         // finished their work at this split point, return from the idle loop.
2143         for (i = 0; sp && i < activeThreads && !sp->slaves[i]; i++) {}
2144         allFinished = (i == activeThreads);
2145
2146         if (allFinished)
2147         {
2148             // Because sp->slaves[] is reset under lock protection,
2149             // be sure sp->lock has been released before to return.
2150             lock_grab(&(sp->lock));
2151             lock_release(&(sp->lock));
2152
2153             // In helpful master concept a master can help only a sub-tree, and
2154             // because here is all finished is not possible master is booked.
2155             assert(threads[threadID].state == THREAD_AVAILABLE);
2156
2157             threads[threadID].state = THREAD_SEARCHING;
2158             return;
2159         }
2160     }
2161   }
2162
2163
2164   // init_threads() is called during startup. It launches all helper threads,
2165   // and initializes the split point stack and the global locks and condition
2166   // objects.
2167
2168   void ThreadsManager::init_threads() {
2169
2170     int i, arg[MAX_THREADS];
2171     bool ok;
2172
2173     // Initialize global locks
2174     lock_init(&mpLock);
2175
2176     for (i = 0; i < MAX_THREADS; i++)
2177     {
2178         lock_init(&sleepLock[i]);
2179         cond_init(&sleepCond[i]);
2180     }
2181
2182     // Initialize splitPoints[] locks
2183     for (i = 0; i < MAX_THREADS; i++)
2184         for (int j = 0; j < MAX_ACTIVE_SPLIT_POINTS; j++)
2185             lock_init(&(threads[i].splitPoints[j].lock));
2186
2187     // Will be set just before program exits to properly end the threads
2188     allThreadsShouldExit = false;
2189
2190     // Threads will be put all threads to sleep as soon as created
2191     activeThreads = 1;
2192
2193     // All threads except the main thread should be initialized to THREAD_INITIALIZING
2194     threads[0].state = THREAD_SEARCHING;
2195     for (i = 1; i < MAX_THREADS; i++)
2196         threads[i].state = THREAD_INITIALIZING;
2197
2198     // Launch the helper threads
2199     for (i = 1; i < MAX_THREADS; i++)
2200     {
2201         arg[i] = i;
2202
2203 #if !defined(_MSC_VER)
2204         pthread_t pthread[1];
2205         ok = (pthread_create(pthread, NULL, init_thread, (void*)(&arg[i])) == 0);
2206         pthread_detach(pthread[0]);
2207 #else
2208         ok = (CreateThread(NULL, 0, init_thread, (LPVOID)(&arg[i]), 0, NULL) != NULL);
2209 #endif
2210         if (!ok)
2211         {
2212             cout << "Failed to create thread number " << i << endl;
2213             exit(EXIT_FAILURE);
2214         }
2215
2216         // Wait until the thread has finished launching and is gone to sleep
2217         while (threads[i].state == THREAD_INITIALIZING) {}
2218     }
2219   }
2220
2221
2222   // exit_threads() is called when the program exits. It makes all the
2223   // helper threads exit cleanly.
2224
2225   void ThreadsManager::exit_threads() {
2226
2227     allThreadsShouldExit = true; // Let the woken up threads to exit idle_loop()
2228
2229     // Wake up all the threads and waits for termination
2230     for (int i = 1; i < MAX_THREADS; i++)
2231     {
2232         wake_sleeping_thread(i);
2233         while (threads[i].state != THREAD_TERMINATED) {}
2234     }
2235
2236     // Now we can safely destroy the locks
2237     for (int i = 0; i < MAX_THREADS; i++)
2238         for (int j = 0; j < MAX_ACTIVE_SPLIT_POINTS; j++)
2239             lock_destroy(&(threads[i].splitPoints[j].lock));
2240
2241     lock_destroy(&mpLock);
2242
2243     // Now we can safely destroy the wait conditions
2244     for (int i = 0; i < MAX_THREADS; i++)
2245     {
2246         lock_destroy(&sleepLock[i]);
2247         cond_destroy(&sleepCond[i]);
2248     }
2249   }
2250
2251
2252   // cutoff_at_splitpoint() checks whether a beta cutoff has occurred in
2253   // the thread's currently active split point, or in some ancestor of
2254   // the current split point.
2255
2256   bool ThreadsManager::cutoff_at_splitpoint(int threadID) const {
2257
2258     assert(threadID >= 0 && threadID < activeThreads);
2259
2260     SplitPoint* sp = threads[threadID].splitPoint;
2261
2262     for ( ; sp && !sp->betaCutoff; sp = sp->parent) {}
2263     return sp != NULL;
2264   }
2265
2266
2267   // thread_is_available() checks whether the thread with threadID "slave" is
2268   // available to help the thread with threadID "master" at a split point. An
2269   // obvious requirement is that "slave" must be idle. With more than two
2270   // threads, this is not by itself sufficient:  If "slave" is the master of
2271   // some active split point, it is only available as a slave to the other
2272   // threads which are busy searching the split point at the top of "slave"'s
2273   // split point stack (the "helpful master concept" in YBWC terminology).
2274
2275   bool ThreadsManager::thread_is_available(int slave, int master) const {
2276
2277     assert(slave >= 0 && slave < activeThreads);
2278     assert(master >= 0 && master < activeThreads);
2279     assert(activeThreads > 1);
2280
2281     if (threads[slave].state != THREAD_AVAILABLE || slave == master)
2282         return false;
2283
2284     // Make a local copy to be sure doesn't change under our feet
2285     int localActiveSplitPoints = threads[slave].activeSplitPoints;
2286
2287     // No active split points means that the thread is available as
2288     // a slave for any other thread.
2289     if (localActiveSplitPoints == 0 || activeThreads == 2)
2290         return true;
2291
2292     // Apply the "helpful master" concept if possible. Use localActiveSplitPoints
2293     // that is known to be > 0, instead of threads[slave].activeSplitPoints that
2294     // could have been set to 0 by another thread leading to an out of bound access.
2295     if (threads[slave].splitPoints[localActiveSplitPoints - 1].slaves[master])
2296         return true;
2297
2298     return false;
2299   }
2300
2301
2302   // available_thread_exists() tries to find an idle thread which is available as
2303   // a slave for the thread with threadID "master".
2304
2305   bool ThreadsManager::available_thread_exists(int master) const {
2306
2307     assert(master >= 0 && master < activeThreads);
2308     assert(activeThreads > 1);
2309
2310     for (int i = 0; i < activeThreads; i++)
2311         if (thread_is_available(i, master))
2312             return true;
2313
2314     return false;
2315   }
2316
2317
2318   // split() does the actual work of distributing the work at a node between
2319   // several available threads. If it does not succeed in splitting the
2320   // node (because no idle threads are available, or because we have no unused
2321   // split point objects), the function immediately returns. If splitting is
2322   // possible, a SplitPoint object is initialized with all the data that must be
2323   // copied to the helper threads and we tell our helper threads that they have
2324   // been assigned work. This will cause them to instantly leave their idle loops and
2325   // call search().When all threads have returned from search() then split() returns.
2326
2327   template <bool Fake>
2328   void ThreadsManager::split(Position& pos, SearchStack* ss, int ply, Value* alpha,
2329                              const Value beta, Value* bestValue, Depth depth, Move threatMove,
2330                              bool mateThreat, int moveCount, MovePicker* mp, bool pvNode) {
2331     assert(pos.is_ok());
2332     assert(ply > 0 && ply < PLY_MAX);
2333     assert(*bestValue >= -VALUE_INFINITE);
2334     assert(*bestValue <= *alpha);
2335     assert(*alpha < beta);
2336     assert(beta <= VALUE_INFINITE);
2337     assert(depth > DEPTH_ZERO);
2338     assert(pos.thread() >= 0 && pos.thread() < activeThreads);
2339     assert(activeThreads > 1);
2340
2341     int i, master = pos.thread();
2342     Thread& masterThread = threads[master];
2343
2344     lock_grab(&mpLock);
2345
2346     // If no other thread is available to help us, or if we have too many
2347     // active split points, don't split.
2348     if (   !available_thread_exists(master)
2349         || masterThread.activeSplitPoints >= MAX_ACTIVE_SPLIT_POINTS)
2350     {
2351         lock_release(&mpLock);
2352         return;
2353     }
2354
2355     // Pick the next available split point object from the split point stack
2356     SplitPoint& splitPoint = masterThread.splitPoints[masterThread.activeSplitPoints++];
2357
2358     // Initialize the split point object
2359     splitPoint.parent = masterThread.splitPoint;
2360     splitPoint.master = master;
2361     splitPoint.betaCutoff = false;
2362     splitPoint.ply = ply;
2363     splitPoint.depth = depth;
2364     splitPoint.threatMove = threatMove;
2365     splitPoint.mateThreat = mateThreat;
2366     splitPoint.alpha = *alpha;
2367     splitPoint.beta = beta;
2368     splitPoint.pvNode = pvNode;
2369     splitPoint.bestValue = *bestValue;
2370     splitPoint.mp = mp;
2371     splitPoint.moveCount = moveCount;
2372     splitPoint.pos = &pos;
2373     splitPoint.nodes = 0;
2374     splitPoint.parentSstack = ss;
2375     for (i = 0; i < activeThreads; i++)
2376         splitPoint.slaves[i] = 0;
2377
2378     masterThread.splitPoint = &splitPoint;
2379
2380     // If we are here it means we are not available
2381     assert(masterThread.state != THREAD_AVAILABLE);
2382
2383     int workersCnt = 1; // At least the master is included
2384
2385     // Allocate available threads setting state to THREAD_BOOKED
2386     for (i = 0; !Fake && i < activeThreads && workersCnt < maxThreadsPerSplitPoint; i++)
2387         if (thread_is_available(i, master))
2388         {
2389             threads[i].state = THREAD_BOOKED;
2390             threads[i].splitPoint = &splitPoint;
2391             splitPoint.slaves[i] = 1;
2392             workersCnt++;
2393         }
2394
2395     assert(Fake || workersCnt > 1);
2396
2397     // We can release the lock because slave threads are already booked and master is not available
2398     lock_release(&mpLock);
2399
2400     // Tell the threads that they have work to do. This will make them leave
2401     // their idle loop. But before copy search stack tail for each thread.
2402     for (i = 0; i < activeThreads; i++)
2403         if (i == master || splitPoint.slaves[i])
2404         {
2405             memcpy(splitPoint.sstack[i], ss - 1, 4 * sizeof(SearchStack));
2406
2407             assert(i == master || threads[i].state == THREAD_BOOKED);
2408
2409             threads[i].state = THREAD_WORKISWAITING; // This makes the slave to exit from idle_loop()
2410
2411             if (useSleepingThreads && i != master)
2412                 wake_sleeping_thread(i);
2413         }
2414
2415     // Everything is set up. The master thread enters the idle loop, from
2416     // which it will instantly launch a search, because its state is
2417     // THREAD_WORKISWAITING.  We send the split point as a second parameter to the
2418     // idle loop, which means that the main thread will return from the idle
2419     // loop when all threads have finished their work at this split point.
2420     idle_loop(master, &splitPoint);
2421
2422     // We have returned from the idle loop, which means that all threads are
2423     // finished. Update alpha and bestValue, and return.
2424     lock_grab(&mpLock);
2425
2426     *alpha = splitPoint.alpha;
2427     *bestValue = splitPoint.bestValue;
2428     masterThread.activeSplitPoints--;
2429     masterThread.splitPoint = splitPoint.parent;
2430     pos.set_nodes_searched(pos.nodes_searched() + splitPoint.nodes);
2431
2432     lock_release(&mpLock);
2433   }
2434
2435
2436   // wake_sleeping_thread() wakes up the thread with the given threadID
2437   // when it is time to start a new search.
2438
2439   void ThreadsManager::wake_sleeping_thread(int threadID) {
2440
2441      lock_grab(&sleepLock[threadID]);
2442      cond_signal(&sleepCond[threadID]);
2443      lock_release(&sleepLock[threadID]);
2444   }
2445
2446
2447   /// RootMove and RootMoveList method's definitions
2448
2449   RootMove::RootMove() {
2450
2451     nodes = 0;
2452     pv_score = non_pv_score = -VALUE_INFINITE;
2453     pv[0] = MOVE_NONE;
2454   }
2455
2456   RootMove& RootMove::operator=(const RootMove& rm) {
2457
2458     const Move* src = rm.pv;
2459     Move* dst = pv;
2460
2461     // Avoid a costly full rm.pv[] copy
2462     do *dst++ = *src; while (*src++ != MOVE_NONE);
2463
2464     nodes = rm.nodes;
2465     pv_score = rm.pv_score;
2466     non_pv_score = rm.non_pv_score;
2467     return *this;
2468   }
2469
2470   // extract_pv_from_tt() builds a PV by adding moves from the transposition table.
2471   // We consider also failing high nodes and not only VALUE_TYPE_EXACT nodes. This
2472   // allow to always have a ponder move even when we fail high at root and also a
2473   // long PV to print that is important for position analysis.
2474
2475   void RootMove::extract_pv_from_tt(Position& pos) {
2476
2477     StateInfo state[PLY_MAX_PLUS_2], *st = state;
2478     TTEntry* tte;
2479     int ply = 1;
2480
2481     assert(pv[0] != MOVE_NONE && move_is_legal(pos, pv[0]));
2482
2483     pos.do_move(pv[0], *st++);
2484
2485     while (   (tte = TT.retrieve(pos.get_key())) != NULL
2486            && tte->move() != MOVE_NONE
2487            && move_is_legal(pos, tte->move())
2488            && ply < PLY_MAX
2489            && (!pos.is_draw() || ply < 2))
2490     {
2491         pv[ply] = tte->move();
2492         pos.do_move(pv[ply++], *st++);
2493     }
2494     pv[ply] = MOVE_NONE;
2495
2496     do pos.undo_move(pv[--ply]); while (ply);
2497   }
2498
2499   // insert_pv_in_tt() is called at the end of a search iteration, and inserts
2500   // the PV back into the TT. This makes sure the old PV moves are searched
2501   // first, even if the old TT entries have been overwritten.
2502
2503   void RootMove::insert_pv_in_tt(Position& pos) {
2504
2505     StateInfo state[PLY_MAX_PLUS_2], *st = state;
2506     TTEntry* tte;
2507     Key k;
2508     Value v, m = VALUE_NONE;
2509     int ply = 0;
2510
2511     assert(pv[0] != MOVE_NONE && move_is_legal(pos, pv[0]));
2512
2513     do {
2514         k = pos.get_key();
2515         tte = TT.retrieve(k);
2516
2517         // Don't overwrite exsisting correct entries
2518         if (!tte || tte->move() != pv[ply])
2519         {
2520             v = (pos.is_check() ? VALUE_NONE : evaluate(pos, m));
2521             TT.store(k, VALUE_NONE, VALUE_TYPE_NONE, DEPTH_NONE, pv[ply], v, m);
2522         }
2523         pos.do_move(pv[ply], *st++);
2524
2525     } while (pv[++ply] != MOVE_NONE);
2526
2527     do pos.undo_move(pv[--ply]); while (ply);
2528   }
2529
2530   // pv_info_to_uci() returns a string with information on the current PV line
2531   // formatted according to UCI specification and eventually writes the info
2532   // to a log file. It is called at each iteration or after a new pv is found.
2533
2534   std::string RootMove::pv_info_to_uci(Position& pos, int depth, Value alpha, Value beta, int pvLine) {
2535
2536     std::stringstream s, l;
2537     Move* m = pv;
2538
2539     while (*m != MOVE_NONE)
2540         l << *m++ << " ";
2541
2542     s << "info depth " << depth
2543       << " seldepth " << int(m - pv)
2544       << " multipv " << pvLine + 1
2545       << " score " << value_to_uci(pv_score)
2546       << (pv_score >= beta ? " lowerbound" : pv_score <= alpha ? " upperbound" : "")
2547       << " time "  << current_search_time()
2548       << " nodes " << pos.nodes_searched()
2549       << " nps "   << nps(pos)
2550       << " pv "    << l.str();
2551
2552     if (UseLogFile && pvLine == 0)
2553     {
2554         ValueType t = pv_score >= beta  ? VALUE_TYPE_LOWER :
2555                       pv_score <= alpha ? VALUE_TYPE_UPPER : VALUE_TYPE_EXACT;
2556
2557         LogFile << pretty_pv(pos, current_search_time(), depth, pv_score, t, pv) << endl;
2558     }
2559     return s.str();
2560   }
2561
2562
2563   void RootMoveList::init(Position& pos, Move searchMoves[]) {
2564
2565     MoveStack mlist[MOVES_MAX];
2566     Move* sm;
2567
2568     clear();
2569     bestMoveChanges = 0;
2570
2571     // Generate all legal moves and score them
2572     MoveStack* last = generate<MV_LEGAL>(pos, mlist);
2573     qsearch_scoring(pos, mlist, last);
2574
2575     // Add each move to the RootMoveList's vector
2576     for (MoveStack* cur = mlist; cur != last; cur++)
2577     {
2578         // If we have a searchMoves[] list then verify cur->move
2579         // is in the list before to add it.
2580         for (sm = searchMoves; *sm && *sm != cur->move; sm++) {}
2581
2582         if (searchMoves[0] && *sm != cur->move)
2583             continue;
2584
2585         RootMove rm;
2586         rm.pv[0] = cur->move;
2587         rm.pv[1] = MOVE_NONE;
2588         rm.pv_score = Value(cur->score);
2589         push_back(rm);
2590     }
2591     sort();
2592   }
2593
2594 } // namespace