Small cleanups
[stockfish] / src / position.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-2015 Marco Costalba, Joona Kiiski, Tord Romstad
5   Copyright (C) 2015-2020 Marco Costalba, Joona Kiiski, Gary Linscott, Tord Romstad
6
7   Stockfish is free software: you can redistribute it and/or modify
8   it under the terms of the GNU General Public License as published by
9   the Free Software Foundation, either version 3 of the License, or
10   (at your option) any later version.
11
12   Stockfish is distributed in the hope that it will be useful,
13   but WITHOUT ANY WARRANTY; without even the implied warranty of
14   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15   GNU General Public License for more details.
16
17   You should have received a copy of the GNU General Public License
18   along with this program.  If not, see <http://www.gnu.org/licenses/>.
19 */
20
21 #include <algorithm>
22 #include <cassert>
23 #include <cstddef> // For offsetof()
24 #include <cstring> // For std::memset, std::memcmp
25 #include <iomanip>
26 #include <sstream>
27
28 #include "bitboard.h"
29 #include "misc.h"
30 #include "movegen.h"
31 #include "position.h"
32 #include "thread.h"
33 #include "tt.h"
34 #include "uci.h"
35 #include "syzygy/tbprobe.h"
36
37 using std::string;
38
39 namespace Zobrist {
40
41   Key psq[PIECE_NB][SQUARE_NB];
42   Key enpassant[FILE_NB];
43   Key castling[CASTLING_RIGHT_NB];
44   Key side, noPawns;
45 }
46
47 namespace {
48
49 const string PieceToChar(" PNBRQK  pnbrqk");
50
51 constexpr Piece Pieces[] = { W_PAWN, W_KNIGHT, W_BISHOP, W_ROOK, W_QUEEN, W_KING,
52                              B_PAWN, B_KNIGHT, B_BISHOP, B_ROOK, B_QUEEN, B_KING };
53 } // namespace
54
55
56 /// operator<<(Position) returns an ASCII representation of the position
57
58 std::ostream& operator<<(std::ostream& os, const Position& pos) {
59
60   os << "\n +---+---+---+---+---+---+---+---+\n";
61
62   for (Rank r = RANK_8; r >= RANK_1; --r)
63   {
64       for (File f = FILE_A; f <= FILE_H; ++f)
65           os << " | " << PieceToChar[pos.piece_on(make_square(f, r))];
66
67       os << " |\n +---+---+---+---+---+---+---+---+\n";
68   }
69
70   os << "\nFen: " << pos.fen() << "\nKey: " << std::hex << std::uppercase
71      << std::setfill('0') << std::setw(16) << pos.key()
72      << std::setfill(' ') << std::dec << "\nCheckers: ";
73
74   for (Bitboard b = pos.checkers(); b; )
75       os << UCI::square(pop_lsb(&b)) << " ";
76
77   if (    int(Tablebases::MaxCardinality) >= popcount(pos.pieces())
78       && !pos.can_castle(ANY_CASTLING))
79   {
80       StateInfo st;
81       Position p;
82       p.set(pos.fen(), pos.is_chess960(), &st, pos.this_thread());
83       Tablebases::ProbeState s1, s2;
84       Tablebases::WDLScore wdl = Tablebases::probe_wdl(p, &s1);
85       int dtz = Tablebases::probe_dtz(p, &s2);
86       os << "\nTablebases WDL: " << std::setw(4) << wdl << " (" << s1 << ")"
87          << "\nTablebases DTZ: " << std::setw(4) << dtz << " (" << s2 << ")";
88   }
89
90   return os;
91 }
92
93
94 // Marcel van Kervinck's cuckoo algorithm for fast detection of "upcoming repetition"
95 // situations. Description of the algorithm in the following paper:
96 // https://marcelk.net/2013-04-06/paper/upcoming-rep-v2.pdf
97
98 // First and second hash functions for indexing the cuckoo tables
99 inline int H1(Key h) { return h & 0x1fff; }
100 inline int H2(Key h) { return (h >> 16) & 0x1fff; }
101
102 // Cuckoo tables with Zobrist hashes of valid reversible moves, and the moves themselves
103 Key cuckoo[8192];
104 Move cuckooMove[8192];
105
106
107 /// Position::init() initializes at startup the various arrays used to compute
108 /// hash keys.
109
110 void Position::init() {
111
112   PRNG rng(1070372);
113
114   for (Piece pc : Pieces)
115       for (Square s = SQ_A1; s <= SQ_H8; ++s)
116           Zobrist::psq[pc][s] = rng.rand<Key>();
117
118   for (File f = FILE_A; f <= FILE_H; ++f)
119       Zobrist::enpassant[f] = rng.rand<Key>();
120
121   for (int cr = NO_CASTLING; cr <= ANY_CASTLING; ++cr)
122   {
123       Zobrist::castling[cr] = 0;
124       Bitboard b = cr;
125       while (b)
126       {
127           Key k = Zobrist::castling[1ULL << pop_lsb(&b)];
128           Zobrist::castling[cr] ^= k ? k : rng.rand<Key>();
129       }
130   }
131
132   Zobrist::side = rng.rand<Key>();
133   Zobrist::noPawns = rng.rand<Key>();
134
135   // Prepare the cuckoo tables
136   std::memset(cuckoo, 0, sizeof(cuckoo));
137   std::memset(cuckooMove, 0, sizeof(cuckooMove));
138   int count = 0;
139   for (Piece pc : Pieces)
140       for (Square s1 = SQ_A1; s1 <= SQ_H8; ++s1)
141           for (Square s2 = Square(s1 + 1); s2 <= SQ_H8; ++s2)
142               if (PseudoAttacks[type_of(pc)][s1] & s2)
143               {
144                   Move move = make_move(s1, s2);
145                   Key key = Zobrist::psq[pc][s1] ^ Zobrist::psq[pc][s2] ^ Zobrist::side;
146                   int i = H1(key);
147                   while (true)
148                   {
149                       std::swap(cuckoo[i], key);
150                       std::swap(cuckooMove[i], move);
151                       if (move == MOVE_NONE) // Arrived at empty slot?
152                           break;
153                       i = (i == H1(key)) ? H2(key) : H1(key); // Push victim to alternative slot
154                   }
155                   count++;
156              }
157   assert(count == 3668);
158 }
159
160
161 /// Position::set() initializes the position object with the given FEN string.
162 /// This function is not very robust - make sure that input FENs are correct,
163 /// this is assumed to be the responsibility of the GUI.
164
165 Position& Position::set(const string& fenStr, bool isChess960, StateInfo* si, Thread* th) {
166 /*
167    A FEN string defines a particular position using only the ASCII character set.
168
169    A FEN string contains six fields separated by a space. The fields are:
170
171    1) Piece placement (from white's perspective). Each rank is described, starting
172       with rank 8 and ending with rank 1. Within each rank, the contents of each
173       square are described from file A through file H. Following the Standard
174       Algebraic Notation (SAN), each piece is identified by a single letter taken
175       from the standard English names. White pieces are designated using upper-case
176       letters ("PNBRQK") whilst Black uses lowercase ("pnbrqk"). Blank squares are
177       noted using digits 1 through 8 (the number of blank squares), and "/"
178       separates ranks.
179
180    2) Active color. "w" means white moves next, "b" means black.
181
182    3) Castling availability. If neither side can castle, this is "-". Otherwise,
183       this has one or more letters: "K" (White can castle kingside), "Q" (White
184       can castle queenside), "k" (Black can castle kingside), and/or "q" (Black
185       can castle queenside).
186
187    4) En passant target square (in algebraic notation). If there's no en passant
188       target square, this is "-". If a pawn has just made a 2-square move, this
189       is the position "behind" the pawn. This is recorded only if there is a pawn
190       in position to make an en passant capture, and if there really is a pawn
191       that might have advanced two squares.
192
193    5) Halfmove clock. This is the number of halfmoves since the last pawn advance
194       or capture. This is used to determine if a draw can be claimed under the
195       fifty-move rule.
196
197    6) Fullmove number. The number of the full move. It starts at 1, and is
198       incremented after Black's move.
199 */
200
201   unsigned char col, row, token;
202   size_t idx;
203   Square sq = SQ_A8;
204   std::istringstream ss(fenStr);
205
206   std::memset(this, 0, sizeof(Position));
207   std::memset(si, 0, sizeof(StateInfo));
208   std::fill_n(&pieceList[0][0], sizeof(pieceList) / sizeof(Square), SQ_NONE);
209   st = si;
210
211   ss >> std::noskipws;
212
213   // 1. Piece placement
214   while ((ss >> token) && !isspace(token))
215   {
216       if (isdigit(token))
217           sq += (token - '0') * EAST; // Advance the given number of files
218
219       else if (token == '/')
220           sq += 2 * SOUTH;
221
222       else if ((idx = PieceToChar.find(token)) != string::npos)
223       {
224           put_piece(Piece(idx), sq);
225           ++sq;
226       }
227   }
228
229   // 2. Active color
230   ss >> token;
231   sideToMove = (token == 'w' ? WHITE : BLACK);
232   ss >> token;
233
234   // 3. Castling availability. Compatible with 3 standards: Normal FEN standard,
235   // Shredder-FEN that uses the letters of the columns on which the rooks began
236   // the game instead of KQkq and also X-FEN standard that, in case of Chess960,
237   // if an inner rook is associated with the castling right, the castling tag is
238   // replaced by the file letter of the involved rook, as for the Shredder-FEN.
239   while ((ss >> token) && !isspace(token))
240   {
241       Square rsq;
242       Color c = islower(token) ? BLACK : WHITE;
243       Piece rook = make_piece(c, ROOK);
244
245       token = char(toupper(token));
246
247       if (token == 'K')
248           for (rsq = relative_square(c, SQ_H1); piece_on(rsq) != rook; --rsq) {}
249
250       else if (token == 'Q')
251           for (rsq = relative_square(c, SQ_A1); piece_on(rsq) != rook; ++rsq) {}
252
253       else if (token >= 'A' && token <= 'H')
254           rsq = make_square(File(token - 'A'), relative_rank(c, RANK_1));
255
256       else
257           continue;
258
259       set_castling_right(c, rsq);
260   }
261
262   // 4. En passant square. Ignore if no pawn capture is possible
263   if (   ((ss >> col) && (col >= 'a' && col <= 'h'))
264       && ((ss >> row) && (row == '3' || row == '6')))
265   {
266       st->epSquare = make_square(File(col - 'a'), Rank(row - '1'));
267
268       if (   !(attackers_to(st->epSquare) & pieces(sideToMove, PAWN))
269           || !(pieces(~sideToMove, PAWN) & (st->epSquare + pawn_push(~sideToMove))))
270           st->epSquare = SQ_NONE;
271   }
272   else
273       st->epSquare = SQ_NONE;
274
275   // 5-6. Halfmove clock and fullmove number
276   ss >> std::skipws >> st->rule50 >> gamePly;
277
278   // Convert from fullmove starting from 1 to gamePly starting from 0,
279   // handle also common incorrect FEN with fullmove = 0.
280   gamePly = std::max(2 * (gamePly - 1), 0) + (sideToMove == BLACK);
281
282   chess960 = isChess960;
283   thisThread = th;
284   set_state(st);
285
286   assert(pos_is_ok());
287
288   return *this;
289 }
290
291
292 /// Position::set_castling_right() is a helper function used to set castling
293 /// rights given the corresponding color and the rook starting square.
294
295 void Position::set_castling_right(Color c, Square rfrom) {
296
297   Square kfrom = square<KING>(c);
298   CastlingRights cr = c & (kfrom < rfrom ? KING_SIDE: QUEEN_SIDE);
299
300   st->castlingRights |= cr;
301   castlingRightsMask[kfrom] |= cr;
302   castlingRightsMask[rfrom] |= cr;
303   castlingRookSquare[cr] = rfrom;
304
305   Square kto = relative_square(c, cr & KING_SIDE ? SQ_G1 : SQ_C1);
306   Square rto = relative_square(c, cr & KING_SIDE ? SQ_F1 : SQ_D1);
307
308   castlingPath[cr] =   (between_bb(rfrom, rto) | between_bb(kfrom, kto) | rto | kto)
309                     & ~(square_bb(kfrom) | rfrom);
310 }
311
312
313 /// Position::set_check_info() sets king attacks to detect if a move gives check
314
315 void Position::set_check_info(StateInfo* si) const {
316
317   si->blockersForKing[WHITE] = slider_blockers(pieces(BLACK), square<KING>(WHITE), si->pinners[BLACK]);
318   si->blockersForKing[BLACK] = slider_blockers(pieces(WHITE), square<KING>(BLACK), si->pinners[WHITE]);
319
320   Square ksq = square<KING>(~sideToMove);
321
322   si->checkSquares[PAWN]   = attacks_from<PAWN>(ksq, ~sideToMove);
323   si->checkSquares[KNIGHT] = attacks_from<KNIGHT>(ksq);
324   si->checkSquares[BISHOP] = attacks_from<BISHOP>(ksq);
325   si->checkSquares[ROOK]   = attacks_from<ROOK>(ksq);
326   si->checkSquares[QUEEN]  = si->checkSquares[BISHOP] | si->checkSquares[ROOK];
327   si->checkSquares[KING]   = 0;
328 }
329
330
331 /// Position::set_state() computes the hash keys of the position, and other
332 /// data that once computed is updated incrementally as moves are made.
333 /// The function is only used when a new position is set up, and to verify
334 /// the correctness of the StateInfo data when running in debug mode.
335
336 void Position::set_state(StateInfo* si) const {
337
338   si->key = si->materialKey = 0;
339   si->pawnKey = Zobrist::noPawns;
340   si->nonPawnMaterial[WHITE] = si->nonPawnMaterial[BLACK] = VALUE_ZERO;
341   si->checkersBB = attackers_to(square<KING>(sideToMove)) & pieces(~sideToMove);
342
343   set_check_info(si);
344
345   for (Bitboard b = pieces(); b; )
346   {
347       Square s = pop_lsb(&b);
348       Piece pc = piece_on(s);
349       si->key ^= Zobrist::psq[pc][s];
350
351       if (type_of(pc) == PAWN)
352           si->pawnKey ^= Zobrist::psq[pc][s];
353
354       else if (type_of(pc) != KING)
355           si->nonPawnMaterial[color_of(pc)] += PieceValue[MG][pc];
356   }
357
358   if (si->epSquare != SQ_NONE)
359       si->key ^= Zobrist::enpassant[file_of(si->epSquare)];
360
361   if (sideToMove == BLACK)
362       si->key ^= Zobrist::side;
363
364   si->key ^= Zobrist::castling[si->castlingRights];
365
366   for (Piece pc : Pieces)
367       for (int cnt = 0; cnt < pieceCount[pc]; ++cnt)
368           si->materialKey ^= Zobrist::psq[pc][cnt];
369 }
370
371
372 /// Position::set() is an overload to initialize the position object with
373 /// the given endgame code string like "KBPKN". It is mainly a helper to
374 /// get the material key out of an endgame code.
375
376 Position& Position::set(const string& code, Color c, StateInfo* si) {
377
378   assert(code[0] == 'K');
379
380   string sides[] = { code.substr(code.find('K', 1)),      // Weak
381                      code.substr(0, std::min(code.find('v'), code.find('K', 1))) }; // Strong
382
383   assert(sides[0].length() > 0 && sides[0].length() < 8);
384   assert(sides[1].length() > 0 && sides[1].length() < 8);
385
386   std::transform(sides[c].begin(), sides[c].end(), sides[c].begin(), tolower);
387
388   string fenStr = "8/" + sides[0] + char(8 - sides[0].length() + '0') + "/8/8/8/8/"
389                        + sides[1] + char(8 - sides[1].length() + '0') + "/8 w - - 0 10";
390
391   return set(fenStr, false, si, nullptr);
392 }
393
394
395 /// Position::fen() returns a FEN representation of the position. In case of
396 /// Chess960 the Shredder-FEN notation is used. This is mainly a debugging function.
397
398 const string Position::fen() const {
399
400   int emptyCnt;
401   std::ostringstream ss;
402
403   for (Rank r = RANK_8; r >= RANK_1; --r)
404   {
405       for (File f = FILE_A; f <= FILE_H; ++f)
406       {
407           for (emptyCnt = 0; f <= FILE_H && empty(make_square(f, r)); ++f)
408               ++emptyCnt;
409
410           if (emptyCnt)
411               ss << emptyCnt;
412
413           if (f <= FILE_H)
414               ss << PieceToChar[piece_on(make_square(f, r))];
415       }
416
417       if (r > RANK_1)
418           ss << '/';
419   }
420
421   ss << (sideToMove == WHITE ? " w " : " b ");
422
423   if (can_castle(WHITE_OO))
424       ss << (chess960 ? char('A' + file_of(castling_rook_square(WHITE_OO ))) : 'K');
425
426   if (can_castle(WHITE_OOO))
427       ss << (chess960 ? char('A' + file_of(castling_rook_square(WHITE_OOO))) : 'Q');
428
429   if (can_castle(BLACK_OO))
430       ss << (chess960 ? char('a' + file_of(castling_rook_square(BLACK_OO ))) : 'k');
431
432   if (can_castle(BLACK_OOO))
433       ss << (chess960 ? char('a' + file_of(castling_rook_square(BLACK_OOO))) : 'q');
434
435   if (!can_castle(ANY_CASTLING))
436       ss << '-';
437
438   ss << (ep_square() == SQ_NONE ? " - " : " " + UCI::square(ep_square()) + " ")
439      << st->rule50 << " " << 1 + (gamePly - (sideToMove == BLACK)) / 2;
440
441   return ss.str();
442 }
443
444
445 /// Position::slider_blockers() returns a bitboard of all the pieces (both colors)
446 /// that are blocking attacks on the square 's' from 'sliders'. A piece blocks a
447 /// slider if removing that piece from the board would result in a position where
448 /// square 's' is attacked. For example, a king-attack blocking piece can be either
449 /// a pinned or a discovered check piece, according if its color is the opposite
450 /// or the same of the color of the slider.
451
452 Bitboard Position::slider_blockers(Bitboard sliders, Square s, Bitboard& pinners) const {
453
454   Bitboard blockers = 0;
455   pinners = 0;
456
457   // Snipers are sliders that attack 's' when a piece and other snipers are removed
458   Bitboard snipers = (  (PseudoAttacks[  ROOK][s] & pieces(QUEEN, ROOK))
459                       | (PseudoAttacks[BISHOP][s] & pieces(QUEEN, BISHOP))) & sliders;
460   Bitboard occupancy = pieces() ^ snipers;
461
462   while (snipers)
463   {
464     Square sniperSq = pop_lsb(&snipers);
465     Bitboard b = between_bb(s, sniperSq) & occupancy;
466
467     if (b && !more_than_one(b))
468     {
469         blockers |= b;
470         if (b & pieces(color_of(piece_on(s))))
471             pinners |= sniperSq;
472     }
473   }
474   return blockers;
475 }
476
477
478 /// Position::attackers_to() computes a bitboard of all pieces which attack a
479 /// given square. Slider attacks use the occupied bitboard to indicate occupancy.
480
481 Bitboard Position::attackers_to(Square s, Bitboard occupied) const {
482
483   return  (attacks_from<PAWN>(s, BLACK)    & pieces(WHITE, PAWN))
484         | (attacks_from<PAWN>(s, WHITE)    & pieces(BLACK, PAWN))
485         | (attacks_from<KNIGHT>(s)         & pieces(KNIGHT))
486         | (attacks_bb<  ROOK>(s, occupied) & pieces(  ROOK, QUEEN))
487         | (attacks_bb<BISHOP>(s, occupied) & pieces(BISHOP, QUEEN))
488         | (attacks_from<KING>(s)           & pieces(KING));
489 }
490
491
492 /// Position::legal() tests whether a pseudo-legal move is legal
493
494 bool Position::legal(Move m) const {
495
496   assert(is_ok(m));
497
498   Color us = sideToMove;
499   Square from = from_sq(m);
500   Square to = to_sq(m);
501
502   assert(color_of(moved_piece(m)) == us);
503   assert(piece_on(square<KING>(us)) == make_piece(us, KING));
504
505   // En passant captures are a tricky special case. Because they are rather
506   // uncommon, we do it simply by testing whether the king is attacked after
507   // the move is made.
508   if (type_of(m) == ENPASSANT)
509   {
510       Square ksq = square<KING>(us);
511       Square capsq = to - pawn_push(us);
512       Bitboard occupied = (pieces() ^ from ^ capsq) | to;
513
514       assert(to == ep_square());
515       assert(moved_piece(m) == make_piece(us, PAWN));
516       assert(piece_on(capsq) == make_piece(~us, PAWN));
517       assert(piece_on(to) == NO_PIECE);
518
519       return   !(attacks_bb<  ROOK>(ksq, occupied) & pieces(~us, QUEEN, ROOK))
520             && !(attacks_bb<BISHOP>(ksq, occupied) & pieces(~us, QUEEN, BISHOP));
521   }
522
523   // Castling moves generation does not check if the castling path is clear of
524   // enemy attacks, it is delayed at a later time: now!
525   if (type_of(m) == CASTLING)
526   {
527       // After castling, the rook and king final positions are the same in
528       // Chess960 as they would be in standard chess.
529       to = relative_square(us, to > from ? SQ_G1 : SQ_C1);
530       Direction step = to > from ? WEST : EAST;
531
532       for (Square s = to; s != from; s += step)
533           if (attackers_to(s) & pieces(~us))
534               return false;
535
536       // In case of Chess960, verify that when moving the castling rook we do
537       // not discover some hidden checker.
538       // For instance an enemy queen in SQ_A1 when castling rook is in SQ_B1.
539       return   !chess960
540             || !(attacks_bb<ROOK>(to, pieces() ^ to_sq(m)) & pieces(~us, ROOK, QUEEN));
541   }
542
543   // If the moving piece is a king, check whether the destination square is
544   // attacked by the opponent.
545   if (type_of(piece_on(from)) == KING)
546       return !(attackers_to(to) & pieces(~us));
547
548   // A non-king move is legal if and only if it is not pinned or it
549   // is moving along the ray towards or away from the king.
550   return   !(blockers_for_king(us) & from)
551         ||  aligned(from, to, square<KING>(us));
552 }
553
554
555 /// Position::pseudo_legal() takes a random move and tests whether the move is
556 /// pseudo legal. It is used to validate moves from TT that can be corrupted
557 /// due to SMP concurrent access or hash position key aliasing.
558
559 bool Position::pseudo_legal(const Move m) const {
560
561   Color us = sideToMove;
562   Square from = from_sq(m);
563   Square to = to_sq(m);
564   Piece pc = moved_piece(m);
565
566   // Use a slower but simpler function for uncommon cases
567   if (type_of(m) != NORMAL)
568       return MoveList<LEGAL>(*this).contains(m);
569
570   // Is not a promotion, so promotion piece must be empty
571   if (promotion_type(m) - KNIGHT != NO_PIECE_TYPE)
572       return false;
573
574   // If the 'from' square is not occupied by a piece belonging to the side to
575   // move, the move is obviously not legal.
576   if (pc == NO_PIECE || color_of(pc) != us)
577       return false;
578
579   // The destination square cannot be occupied by a friendly piece
580   if (pieces(us) & to)
581       return false;
582
583   // Handle the special case of a pawn move
584   if (type_of(pc) == PAWN)
585   {
586       // We have already handled promotion moves, so destination
587       // cannot be on the 8th/1st rank.
588       if ((Rank8BB | Rank1BB) & to)
589           return false;
590
591       if (   !(attacks_from<PAWN>(from, us) & pieces(~us) & to) // Not a capture
592           && !((from + pawn_push(us) == to) && empty(to))       // Not a single push
593           && !(   (from + 2 * pawn_push(us) == to)              // Not a double push
594                && (rank_of(from) == relative_rank(us, RANK_2))
595                && empty(to)
596                && empty(to - pawn_push(us))))
597           return false;
598   }
599   else if (!(attacks_from(type_of(pc), from) & to))
600       return false;
601
602   // Evasions generator already takes care to avoid some kind of illegal moves
603   // and legal() relies on this. We therefore have to take care that the same
604   // kind of moves are filtered out here.
605   if (checkers())
606   {
607       if (type_of(pc) != KING)
608       {
609           // Double check? In this case a king move is required
610           if (more_than_one(checkers()))
611               return false;
612
613           // Our move must be a blocking evasion or a capture of the checking piece
614           if (!((between_bb(lsb(checkers()), square<KING>(us)) | checkers()) & to))
615               return false;
616       }
617       // In case of king moves under check we have to remove king so as to catch
618       // invalid moves like b1a1 when opposite queen is on c1.
619       else if (attackers_to(to, pieces() ^ from) & pieces(~us))
620           return false;
621   }
622
623   return true;
624 }
625
626
627 /// Position::gives_check() tests whether a pseudo-legal move gives a check
628
629 bool Position::gives_check(Move m) const {
630
631   assert(is_ok(m));
632   assert(color_of(moved_piece(m)) == sideToMove);
633
634   Square from = from_sq(m);
635   Square to = to_sq(m);
636
637   // Is there a direct check?
638   if (check_squares(type_of(piece_on(from))) & to)
639       return true;
640
641   // Is there a discovered check?
642   if (   (blockers_for_king(~sideToMove) & from)
643       && !aligned(from, to, square<KING>(~sideToMove)))
644       return true;
645
646   switch (type_of(m))
647   {
648   case NORMAL:
649       return false;
650
651   case PROMOTION:
652       return attacks_bb(promotion_type(m), to, pieces() ^ from) & square<KING>(~sideToMove);
653
654   // En passant capture with check? We have already handled the case
655   // of direct checks and ordinary discovered check, so the only case we
656   // need to handle is the unusual case of a discovered check through
657   // the captured pawn.
658   case ENPASSANT:
659   {
660       Square capsq = make_square(file_of(to), rank_of(from));
661       Bitboard b = (pieces() ^ from ^ capsq) | to;
662
663       return  (attacks_bb<  ROOK>(square<KING>(~sideToMove), b) & pieces(sideToMove, QUEEN, ROOK))
664             | (attacks_bb<BISHOP>(square<KING>(~sideToMove), b) & pieces(sideToMove, QUEEN, BISHOP));
665   }
666   case CASTLING:
667   {
668       Square kfrom = from;
669       Square rfrom = to; // Castling is encoded as 'King captures the rook'
670       Square kto = relative_square(sideToMove, rfrom > kfrom ? SQ_G1 : SQ_C1);
671       Square rto = relative_square(sideToMove, rfrom > kfrom ? SQ_F1 : SQ_D1);
672
673       return   (PseudoAttacks[ROOK][rto] & square<KING>(~sideToMove))
674             && (attacks_bb<ROOK>(rto, (pieces() ^ kfrom ^ rfrom) | rto | kto) & square<KING>(~sideToMove));
675   }
676   default:
677       assert(false);
678       return false;
679   }
680 }
681
682
683 /// Position::do_move() makes a move, and saves all information necessary
684 /// to a StateInfo object. The move is assumed to be legal. Pseudo-legal
685 /// moves should be filtered out before this function is called.
686
687 void Position::do_move(Move m, StateInfo& newSt, bool givesCheck) {
688
689   assert(is_ok(m));
690   assert(&newSt != st);
691
692   thisThread->nodes.fetch_add(1, std::memory_order_relaxed);
693   Key k = st->key ^ Zobrist::side;
694
695   // Copy some fields of the old state to our new StateInfo object except the
696   // ones which are going to be recalculated from scratch anyway and then switch
697   // our state pointer to point to the new (ready to be updated) state.
698   std::memcpy(&newSt, st, offsetof(StateInfo, key));
699   newSt.previous = st;
700   st = &newSt;
701
702   // Increment ply counters. In particular, rule50 will be reset to zero later on
703   // in case of a capture or a pawn move.
704   ++gamePly;
705   ++st->rule50;
706   ++st->pliesFromNull;
707
708   Color us = sideToMove;
709   Color them = ~us;
710   Square from = from_sq(m);
711   Square to = to_sq(m);
712   Piece pc = piece_on(from);
713   Piece captured = type_of(m) == ENPASSANT ? make_piece(them, PAWN) : piece_on(to);
714
715   assert(color_of(pc) == us);
716   assert(captured == NO_PIECE || color_of(captured) == (type_of(m) != CASTLING ? them : us));
717   assert(type_of(captured) != KING);
718
719   if (type_of(m) == CASTLING)
720   {
721       assert(pc == make_piece(us, KING));
722       assert(captured == make_piece(us, ROOK));
723
724       Square rfrom, rto;
725       do_castling<true>(us, from, to, rfrom, rto);
726
727       k ^= Zobrist::psq[captured][rfrom] ^ Zobrist::psq[captured][rto];
728       captured = NO_PIECE;
729   }
730
731   if (captured)
732   {
733       Square capsq = to;
734
735       // If the captured piece is a pawn, update pawn hash key, otherwise
736       // update non-pawn material.
737       if (type_of(captured) == PAWN)
738       {
739           if (type_of(m) == ENPASSANT)
740           {
741               capsq -= pawn_push(us);
742
743               assert(pc == make_piece(us, PAWN));
744               assert(to == st->epSquare);
745               assert(relative_rank(us, to) == RANK_6);
746               assert(piece_on(to) == NO_PIECE);
747               assert(piece_on(capsq) == make_piece(them, PAWN));
748           }
749
750           st->pawnKey ^= Zobrist::psq[captured][capsq];
751       }
752       else
753           st->nonPawnMaterial[them] -= PieceValue[MG][captured];
754
755       // Update board and piece lists
756       remove_piece(capsq);
757
758       if (type_of(m) == ENPASSANT)
759           board[capsq] = NO_PIECE;
760
761       // Update material hash key and prefetch access to materialTable
762       k ^= Zobrist::psq[captured][capsq];
763       st->materialKey ^= Zobrist::psq[captured][pieceCount[captured]];
764       prefetch(thisThread->materialTable[st->materialKey]);
765
766       // Reset rule 50 counter
767       st->rule50 = 0;
768   }
769
770   // Update hash key
771   k ^= Zobrist::psq[pc][from] ^ Zobrist::psq[pc][to];
772
773   // Reset en passant square
774   if (st->epSquare != SQ_NONE)
775   {
776       k ^= Zobrist::enpassant[file_of(st->epSquare)];
777       st->epSquare = SQ_NONE;
778   }
779
780   // Update castling rights if needed
781   if (st->castlingRights && (castlingRightsMask[from] | castlingRightsMask[to]))
782   {
783       int cr = castlingRightsMask[from] | castlingRightsMask[to];
784       k ^= Zobrist::castling[st->castlingRights & cr];
785       st->castlingRights &= ~cr;
786   }
787
788   // Move the piece. The tricky Chess960 castling is handled earlier
789   if (type_of(m) != CASTLING)
790       move_piece(from, to);
791
792   // If the moving piece is a pawn do some special extra work
793   if (type_of(pc) == PAWN)
794   {
795       // Set en-passant square if the moved pawn can be captured
796       if (   (int(to) ^ int(from)) == 16
797           && (attacks_from<PAWN>(to - pawn_push(us), us) & pieces(them, PAWN)))
798       {
799           st->epSquare = to - pawn_push(us);
800           k ^= Zobrist::enpassant[file_of(st->epSquare)];
801       }
802
803       else if (type_of(m) == PROMOTION)
804       {
805           Piece promotion = make_piece(us, promotion_type(m));
806
807           assert(relative_rank(us, to) == RANK_8);
808           assert(type_of(promotion) >= KNIGHT && type_of(promotion) <= QUEEN);
809
810           remove_piece(to);
811           put_piece(promotion, to);
812
813           // Update hash keys
814           k ^= Zobrist::psq[pc][to] ^ Zobrist::psq[promotion][to];
815           st->pawnKey ^= Zobrist::psq[pc][to];
816           st->materialKey ^=  Zobrist::psq[promotion][pieceCount[promotion]-1]
817                             ^ Zobrist::psq[pc][pieceCount[pc]];
818
819           // Update material
820           st->nonPawnMaterial[us] += PieceValue[MG][promotion];
821       }
822
823       // Update pawn hash key
824       st->pawnKey ^= Zobrist::psq[pc][from] ^ Zobrist::psq[pc][to];
825
826       // Reset rule 50 draw counter
827       st->rule50 = 0;
828   }
829
830   // Set capture piece
831   st->capturedPiece = captured;
832
833   // Update the key with the final value
834   st->key = k;
835
836   // Calculate checkers bitboard (if move gives check)
837   st->checkersBB = givesCheck ? attackers_to(square<KING>(them)) & pieces(us) : 0;
838
839   sideToMove = ~sideToMove;
840
841   // Update king attacks used for fast check detection
842   set_check_info(st);
843
844   // Calculate the repetition info. It is the ply distance from the previous
845   // occurrence of the same position, negative in the 3-fold case, or zero
846   // if the position was not repeated.
847   st->repetition = 0;
848   int end = std::min(st->rule50, st->pliesFromNull);
849   if (end >= 4)
850   {
851       StateInfo* stp = st->previous->previous;
852       for (int i = 4; i <= end; i += 2)
853       {
854           stp = stp->previous->previous;
855           if (stp->key == st->key)
856           {
857               st->repetition = stp->repetition ? -i : i;
858               break;
859           }
860       }
861   }
862
863   assert(pos_is_ok());
864 }
865
866
867 /// Position::undo_move() unmakes a move. When it returns, the position should
868 /// be restored to exactly the same state as before the move was made.
869
870 void Position::undo_move(Move m) {
871
872   assert(is_ok(m));
873
874   sideToMove = ~sideToMove;
875
876   Color us = sideToMove;
877   Square from = from_sq(m);
878   Square to = to_sq(m);
879   Piece pc = piece_on(to);
880
881   assert(empty(from) || type_of(m) == CASTLING);
882   assert(type_of(st->capturedPiece) != KING);
883
884   if (type_of(m) == PROMOTION)
885   {
886       assert(relative_rank(us, to) == RANK_8);
887       assert(type_of(pc) == promotion_type(m));
888       assert(type_of(pc) >= KNIGHT && type_of(pc) <= QUEEN);
889
890       remove_piece(to);
891       pc = make_piece(us, PAWN);
892       put_piece(pc, to);
893   }
894
895   if (type_of(m) == CASTLING)
896   {
897       Square rfrom, rto;
898       do_castling<false>(us, from, to, rfrom, rto);
899   }
900   else
901   {
902       move_piece(to, from); // Put the piece back at the source square
903
904       if (st->capturedPiece)
905       {
906           Square capsq = to;
907
908           if (type_of(m) == ENPASSANT)
909           {
910               capsq -= pawn_push(us);
911
912               assert(type_of(pc) == PAWN);
913               assert(to == st->previous->epSquare);
914               assert(relative_rank(us, to) == RANK_6);
915               assert(piece_on(capsq) == NO_PIECE);
916               assert(st->capturedPiece == make_piece(~us, PAWN));
917           }
918
919           put_piece(st->capturedPiece, capsq); // Restore the captured piece
920       }
921   }
922
923   // Finally point our state pointer back to the previous state
924   st = st->previous;
925   --gamePly;
926
927   assert(pos_is_ok());
928 }
929
930
931 /// Position::do_castling() is a helper used to do/undo a castling move. This
932 /// is a bit tricky in Chess960 where from/to squares can overlap.
933 template<bool Do>
934 void Position::do_castling(Color us, Square from, Square& to, Square& rfrom, Square& rto) {
935
936   bool kingSide = to > from;
937   rfrom = to; // Castling is encoded as "king captures friendly rook"
938   rto = relative_square(us, kingSide ? SQ_F1 : SQ_D1);
939   to = relative_square(us, kingSide ? SQ_G1 : SQ_C1);
940
941   // Remove both pieces first since squares could overlap in Chess960
942   remove_piece(Do ? from : to);
943   remove_piece(Do ? rfrom : rto);
944   board[Do ? from : to] = board[Do ? rfrom : rto] = NO_PIECE; // Since remove_piece doesn't do this for us
945   put_piece(make_piece(us, KING), Do ? to : from);
946   put_piece(make_piece(us, ROOK), Do ? rto : rfrom);
947 }
948
949
950 /// Position::do(undo)_null_move() is used to do(undo) a "null move": it flips
951 /// the side to move without executing any move on the board.
952
953 void Position::do_null_move(StateInfo& newSt) {
954
955   assert(!checkers());
956   assert(&newSt != st);
957
958   std::memcpy(&newSt, st, sizeof(StateInfo));
959   newSt.previous = st;
960   st = &newSt;
961
962   if (st->epSquare != SQ_NONE)
963   {
964       st->key ^= Zobrist::enpassant[file_of(st->epSquare)];
965       st->epSquare = SQ_NONE;
966   }
967
968   st->key ^= Zobrist::side;
969   prefetch(TT.first_entry(st->key));
970
971   ++st->rule50;
972   st->pliesFromNull = 0;
973
974   sideToMove = ~sideToMove;
975
976   set_check_info(st);
977
978   st->repetition = 0;
979
980   assert(pos_is_ok());
981 }
982
983 void Position::undo_null_move() {
984
985   assert(!checkers());
986
987   st = st->previous;
988   sideToMove = ~sideToMove;
989 }
990
991
992 /// Position::key_after() computes the new hash key after the given move. Needed
993 /// for speculative prefetch. It doesn't recognize special moves like castling,
994 /// en-passant and promotions.
995
996 Key Position::key_after(Move m) const {
997
998   Square from = from_sq(m);
999   Square to = to_sq(m);
1000   Piece pc = piece_on(from);
1001   Piece captured = piece_on(to);
1002   Key k = st->key ^ Zobrist::side;
1003
1004   if (captured)
1005       k ^= Zobrist::psq[captured][to];
1006
1007   return k ^ Zobrist::psq[pc][to] ^ Zobrist::psq[pc][from];
1008 }
1009
1010
1011 /// Position::see_ge (Static Exchange Evaluation Greater or Equal) tests if the
1012 /// SEE value of move is greater or equal to the given threshold. We'll use an
1013 /// algorithm similar to alpha-beta pruning with a null window.
1014
1015 bool Position::see_ge(Move m, Value threshold) const {
1016
1017   assert(is_ok(m));
1018
1019   // Only deal with normal moves, assume others pass a simple see
1020   if (type_of(m) != NORMAL)
1021       return VALUE_ZERO >= threshold;
1022
1023   Square from = from_sq(m), to = to_sq(m);
1024
1025   int swap = PieceValue[MG][piece_on(to)] - threshold;
1026   if (swap < 0)
1027       return false;
1028
1029   swap = PieceValue[MG][piece_on(from)] - swap;
1030   if (swap <= 0)
1031       return true;
1032
1033   Bitboard occupied = pieces() ^ from ^ to;
1034   Color stm = color_of(piece_on(from));
1035   Bitboard attackers = attackers_to(to, occupied);
1036   Bitboard stmAttackers, bb;
1037   int res = 1;
1038
1039   while (true)
1040   {
1041       stm = ~stm;
1042       attackers &= occupied;
1043
1044       // If stm has no more attackers then give up: stm loses
1045       if (!(stmAttackers = attackers & pieces(stm)))
1046           break;
1047
1048       // Don't allow pinned pieces to attack (except the king) as long as
1049       // there are pinners on their original square.
1050       if (st->pinners[~stm] & occupied)
1051           stmAttackers &= ~st->blockersForKing[stm];
1052
1053       if (!stmAttackers)
1054           break;
1055
1056       res ^= 1;
1057
1058       // Locate and remove the next least valuable attacker, and add to
1059       // the bitboard 'attackers' any X-ray attackers behind it.
1060       if ((bb = stmAttackers & pieces(PAWN)))
1061       {
1062           if ((swap = PawnValueMg - swap) < res)
1063               break;
1064
1065           occupied ^= lsb(bb);
1066           attackers |= attacks_bb<BISHOP>(to, occupied) & pieces(BISHOP, QUEEN);
1067       }
1068
1069       else if ((bb = stmAttackers & pieces(KNIGHT)))
1070       {
1071           if ((swap = KnightValueMg - swap) < res)
1072               break;
1073
1074           occupied ^= lsb(bb);
1075       }
1076
1077       else if ((bb = stmAttackers & pieces(BISHOP)))
1078       {
1079           if ((swap = BishopValueMg - swap) < res)
1080               break;
1081
1082           occupied ^= lsb(bb);
1083           attackers |= attacks_bb<BISHOP>(to, occupied) & pieces(BISHOP, QUEEN);
1084       }
1085
1086       else if ((bb = stmAttackers & pieces(ROOK)))
1087       {
1088           if ((swap = RookValueMg - swap) < res)
1089               break;
1090
1091           occupied ^= lsb(bb);
1092           attackers |= attacks_bb<ROOK>(to, occupied) & pieces(ROOK, QUEEN);
1093       }
1094
1095       else if ((bb = stmAttackers & pieces(QUEEN)))
1096       {
1097           if ((swap = QueenValueMg - swap) < res)
1098               break;
1099
1100           occupied ^= lsb(bb);
1101           attackers |=  (attacks_bb<BISHOP>(to, occupied) & pieces(BISHOP, QUEEN))
1102                       | (attacks_bb<ROOK  >(to, occupied) & pieces(ROOK  , QUEEN));
1103       }
1104
1105       else // KING
1106            // If we "capture" with the king but opponent still has attackers,
1107            // reverse the result.
1108           return (attackers & ~pieces(stm)) ? res ^ 1 : res;
1109   }
1110
1111   return bool(res);
1112 }
1113
1114 /// Position::is_draw() tests whether the position is drawn by 50-move rule
1115 /// or by repetition. It does not detect stalemates.
1116
1117 bool Position::is_draw(int ply) const {
1118
1119   if (st->rule50 > 99 && (!checkers() || MoveList<LEGAL>(*this).size()))
1120       return true;
1121
1122   // Return a draw score if a position repeats once earlier but strictly
1123   // after the root, or repeats twice before or at the root.
1124   return st->repetition && st->repetition < ply;
1125 }
1126
1127
1128 // Position::has_repeated() tests whether there has been at least one repetition
1129 // of positions since the last capture or pawn move.
1130
1131 bool Position::has_repeated() const {
1132
1133     StateInfo* stc = st;
1134     int end = std::min(st->rule50, st->pliesFromNull);
1135     while (end-- >= 4)
1136     {
1137         if (stc->repetition)
1138             return true;
1139
1140         stc = stc->previous;
1141     }
1142     return false;
1143 }
1144
1145
1146 /// Position::has_game_cycle() tests if the position has a move which draws by repetition,
1147 /// or an earlier position has a move that directly reaches the current position.
1148
1149 bool Position::has_game_cycle(int ply) const {
1150
1151   int j;
1152
1153   int end = std::min(st->rule50, st->pliesFromNull);
1154
1155   if (end < 3)
1156     return false;
1157
1158   Key originalKey = st->key;
1159   StateInfo* stp = st->previous;
1160
1161   for (int i = 3; i <= end; i += 2)
1162   {
1163       stp = stp->previous->previous;
1164
1165       Key moveKey = originalKey ^ stp->key;
1166       if (   (j = H1(moveKey), cuckoo[j] == moveKey)
1167           || (j = H2(moveKey), cuckoo[j] == moveKey))
1168       {
1169           Move move = cuckooMove[j];
1170           Square s1 = from_sq(move);
1171           Square s2 = to_sq(move);
1172
1173           if (!(between_bb(s1, s2) & pieces()))
1174           {
1175               if (ply > i)
1176                   return true;
1177
1178               // For nodes before or at the root, check that the move is a
1179               // repetition rather than a move to the current position.
1180               // In the cuckoo table, both moves Rc1c5 and Rc5c1 are stored in
1181               // the same location, so we have to select which square to check.
1182               if (color_of(piece_on(empty(s1) ? s2 : s1)) != side_to_move())
1183                   continue;
1184
1185               // For repetitions before or at the root, require one more
1186               if (stp->repetition)
1187                   return true;
1188           }
1189       }
1190   }
1191   return false;
1192 }
1193
1194
1195 /// Position::flip() flips position with the white and black sides reversed. This
1196 /// is only useful for debugging e.g. for finding evaluation symmetry bugs.
1197
1198 void Position::flip() {
1199
1200   string f, token;
1201   std::stringstream ss(fen());
1202
1203   for (Rank r = RANK_8; r >= RANK_1; --r) // Piece placement
1204   {
1205       std::getline(ss, token, r > RANK_1 ? '/' : ' ');
1206       f.insert(0, token + (f.empty() ? " " : "/"));
1207   }
1208
1209   ss >> token; // Active color
1210   f += (token == "w" ? "B " : "W "); // Will be lowercased later
1211
1212   ss >> token; // Castling availability
1213   f += token + " ";
1214
1215   std::transform(f.begin(), f.end(), f.begin(),
1216                  [](char c) { return char(islower(c) ? toupper(c) : tolower(c)); });
1217
1218   ss >> token; // En passant square
1219   f += (token == "-" ? token : token.replace(1, 1, token[1] == '3' ? "6" : "3"));
1220
1221   std::getline(ss, token); // Half and full moves
1222   f += token;
1223
1224   set(f, is_chess960(), st, this_thread());
1225
1226   assert(pos_is_ok());
1227 }
1228
1229
1230 /// Position::pos_is_ok() performs some consistency checks for the
1231 /// position object and raises an asserts if something wrong is detected.
1232 /// This is meant to be helpful when debugging.
1233
1234 bool Position::pos_is_ok() const {
1235
1236   constexpr bool Fast = true; // Quick (default) or full check?
1237
1238   if (   (sideToMove != WHITE && sideToMove != BLACK)
1239       || piece_on(square<KING>(WHITE)) != W_KING
1240       || piece_on(square<KING>(BLACK)) != B_KING
1241       || (   ep_square() != SQ_NONE
1242           && relative_rank(sideToMove, ep_square()) != RANK_6))
1243       assert(0 && "pos_is_ok: Default");
1244
1245   if (Fast)
1246       return true;
1247
1248   if (   pieceCount[W_KING] != 1
1249       || pieceCount[B_KING] != 1
1250       || attackers_to(square<KING>(~sideToMove)) & pieces(sideToMove))
1251       assert(0 && "pos_is_ok: Kings");
1252
1253   if (   (pieces(PAWN) & (Rank1BB | Rank8BB))
1254       || pieceCount[W_PAWN] > 8
1255       || pieceCount[B_PAWN] > 8)
1256       assert(0 && "pos_is_ok: Pawns");
1257
1258   if (   (pieces(WHITE) & pieces(BLACK))
1259       || (pieces(WHITE) | pieces(BLACK)) != pieces()
1260       || popcount(pieces(WHITE)) > 16
1261       || popcount(pieces(BLACK)) > 16)
1262       assert(0 && "pos_is_ok: Bitboards");
1263
1264   for (PieceType p1 = PAWN; p1 <= KING; ++p1)
1265       for (PieceType p2 = PAWN; p2 <= KING; ++p2)
1266           if (p1 != p2 && (pieces(p1) & pieces(p2)))
1267               assert(0 && "pos_is_ok: Bitboards");
1268
1269   StateInfo si = *st;
1270   set_state(&si);
1271   if (std::memcmp(&si, st, sizeof(StateInfo)))
1272       assert(0 && "pos_is_ok: State");
1273
1274   for (Piece pc : Pieces)
1275   {
1276       if (   pieceCount[pc] != popcount(pieces(color_of(pc), type_of(pc)))
1277           || pieceCount[pc] != std::count(board, board + SQUARE_NB, pc))
1278           assert(0 && "pos_is_ok: Pieces");
1279
1280       for (int i = 0; i < pieceCount[pc]; ++i)
1281           if (board[pieceList[pc][i]] != pc || index[pieceList[pc][i]] != i)
1282               assert(0 && "pos_is_ok: Index");
1283   }
1284
1285   for (Color c : { WHITE, BLACK })
1286       for (CastlingRights cr : {c & KING_SIDE, c & QUEEN_SIDE})
1287       {
1288           if (!can_castle(cr))
1289               continue;
1290
1291           if (   piece_on(castlingRookSquare[cr]) != make_piece(c, ROOK)
1292               || castlingRightsMask[castlingRookSquare[cr]] != cr
1293               || (castlingRightsMask[square<KING>(c)] & cr) != cr)
1294               assert(0 && "pos_is_ok: Castling");
1295       }
1296
1297   return true;
1298 }