Save threadID info in Position
[stockfish] / src / position.h
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 #if !defined(POSITION_H_INCLUDED)
22 #define POSITION_H_INCLUDED
23
24 // Disable some silly and noisy warning from MSVC compiler
25 #if defined(_MSC_VER)
26
27 // Forcing value to bool 'true' or 'false' (performance warning)
28 #pragma warning(disable: 4800)
29
30 // Conditional expression is constant
31 #pragma warning(disable: 4127)
32
33
34 #endif
35
36 ////
37 //// Includes
38 ////
39
40 #include "bitboard.h"
41 #include "color.h"
42 #include "direction.h"
43 #include "move.h"
44 #include "piece.h"
45 #include "square.h"
46 #include "value.h"
47
48
49 ////
50 //// Constants
51 ////
52
53 /// FEN string for the initial position
54 const std::string StartPosition = "rnbqkbnr/pppppppp/8/8/8/8/PPPPPPPP/RNBQKBNR w KQkq - 0 1";
55
56 /// Maximum number of plies per game (220 should be enough, because the
57 /// maximum search depth is 100, and during position setup we reset the
58 /// move counter for every non-reversible move).
59 const int MaxGameLength = 220;
60
61
62 ////
63 //// Types
64 ////
65
66 /// struct checkInfo is initialized at c'tor time and keeps
67 /// info used to detect if a move gives check.
68
69 struct CheckInfo {
70
71     CheckInfo(const Position&);
72
73     Bitboard dcCandidates;
74     Bitboard checkSq[8];
75     Square ksq;
76 };
77
78 /// Castle rights, encoded as bit fields
79
80 enum CastleRights {
81   NO_CASTLES  = 0,
82   WHITE_OO    = 1,
83   BLACK_OO    = 2,
84   WHITE_OOO   = 4,
85   BLACK_OOO   = 8,
86   ALL_CASTLES = 15
87 };
88
89 /// Game phase
90 enum Phase {
91   PHASE_ENDGAME = 0,
92   PHASE_MIDGAME = 128
93 };
94
95
96 /// The StateInfo struct stores information we need to restore a Position
97 /// object to its previous state when we retract a move. Whenever a move
98 /// is made on the board (by calling Position::do_move), an StateInfo object
99 /// must be passed as a parameter.
100
101 struct StateInfo {
102   Key pawnKey, materialKey;
103   int castleRights, rule50, ply, pliesFromNull;
104   Square epSquare;
105   Score value;
106   Value npMaterial[2];
107
108   PieceType capture;
109   Key key;
110   Bitboard checkersBB;
111   StateInfo* previous;
112 };
113
114
115 /// The position data structure. A position consists of the following data:
116 ///
117 ///    * For each piece type, a bitboard representing the squares occupied
118 ///      by pieces of that type.
119 ///    * For each color, a bitboard representing the squares occupied by
120 ///      pieces of that color.
121 ///    * A bitboard of all occupied squares.
122 ///    * A bitboard of all checking pieces.
123 ///    * A 64-entry array of pieces, indexed by the squares of the board.
124 ///    * The current side to move.
125 ///    * Information about the castling rights for both sides.
126 ///    * The initial files of the kings and both pairs of rooks. This is
127 ///      used to implement the Chess960 castling rules.
128 ///    * The en passant square (which is SQ_NONE if no en passant capture is
129 ///      possible).
130 ///    * The squares of the kings for both sides.
131 ///    * Hash keys for the position itself, the current pawn structure, and
132 ///      the current material situation.
133 ///    * Hash keys for all previous positions in the game for detecting
134 ///      repetition draws.
135 ///    * A counter for detecting 50 move rule draws.
136
137 class Position {
138
139   friend class MaterialInfo;
140   friend class EndgameFunctions;
141
142   Position(); // No default or copy c'tor allowed
143   Position(const Position& pos);
144
145 public:
146   enum GamePhase {
147       MidGame,
148       EndGame
149   };
150
151   // Constructors
152   explicit Position(int threadID);
153   Position(const Position& pos, int threadID);
154   Position(const std::string& fen, int threadID);
155
156   // Text input/output
157   void from_fen(const std::string& fen);
158   const std::string to_fen() const;
159   void print(Move m = MOVE_NONE) const;
160
161   // Copying
162   void flipped_copy(const Position& pos);
163
164   // The piece on a given square
165   Piece piece_on(Square s) const;
166   PieceType type_of_piece_on(Square s) const;
167   Color color_of_piece_on(Square s) const;
168   bool square_is_empty(Square s) const;
169   bool square_is_occupied(Square s) const;
170   Value midgame_value_of_piece_on(Square s) const;
171   Value endgame_value_of_piece_on(Square s) const;
172
173   // Side to move
174   Color side_to_move() const;
175
176   // Bitboard representation of the position
177   Bitboard empty_squares() const;
178   Bitboard occupied_squares() const;
179   Bitboard pieces_of_color(Color c) const;
180   Bitboard pieces(PieceType pt) const;
181   Bitboard pieces(PieceType pt, Color c) const;
182   Bitboard pieces(PieceType pt1, PieceType pt2) const;
183   Bitboard pieces(PieceType pt1, PieceType pt2, Color c) const;
184
185   // Number of pieces of each color and type
186   int piece_count(Color c, PieceType pt) const;
187
188   // The en passant square
189   Square ep_square() const;
190
191   // Current king position for each color
192   Square king_square(Color c) const;
193
194   // Castling rights
195   bool can_castle_kingside(Color c) const;
196   bool can_castle_queenside(Color c) const;
197   bool can_castle(Color c) const;
198   Square initial_kr_square(Color c) const;
199   Square initial_qr_square(Color c) const;
200
201   // Bitboards for pinned pieces and discovered check candidates
202   Bitboard discovered_check_candidates(Color c) const;
203   Bitboard pinned_pieces(Color c) const;
204
205   // Checking pieces and under check information
206   Bitboard checkers() const;
207   bool is_check() const;
208
209   // Piece lists
210   Square piece_list(Color c, PieceType pt, int index) const;
211   const Square* piece_list_begin(Color c, PieceType pt) const;
212
213   // Information about attacks to or from a given square
214   Bitboard attackers_to(Square s) const;
215   Bitboard attacks_from(Piece p, Square s) const;
216   template<PieceType> Bitboard attacks_from(Square s) const;
217   template<PieceType> Bitboard attacks_from(Square s, Color c) const;
218
219   // Properties of moves
220   bool pl_move_is_legal(Move m, Bitboard pinned) const;
221   bool pl_move_is_evasion(Move m, Bitboard pinned) const;
222   bool move_is_check(Move m) const;
223   bool move_is_check(Move m, const CheckInfo& ci) const;
224   bool move_is_capture(Move m) const;
225   bool move_is_capture_or_promotion(Move m) const;
226   bool move_is_passed_pawn_push(Move m) const;
227   bool move_attacks_square(Move m, Square s) const;
228
229   // Piece captured with previous moves
230   PieceType captured_piece() const;
231
232   // Information about pawns
233   bool pawn_is_passed(Color c, Square s) const;
234
235   // Weak squares
236   bool square_is_weak(Square s, Color c) const;
237
238   // Doing and undoing moves
239   void detach();
240   void do_move(Move m, StateInfo& st);
241   void do_move(Move m, StateInfo& st, const CheckInfo& ci, bool moveIsCheck);
242   void undo_move(Move m);
243   void do_null_move(StateInfo& st);
244   void undo_null_move();
245
246   // Static exchange evaluation
247   int see(Square from, Square to) const;
248   int see(Move m) const;
249   int see(Square to) const;
250   int see_sign(Move m) const;
251
252   // Accessing hash keys
253   Key get_key() const;
254   Key get_exclusion_key() const;
255   Key get_pawn_key() const;
256   Key get_material_key() const;
257
258   // Incremental evaluation
259   Score value() const;
260   Value non_pawn_material(Color c) const;
261   Score pst_delta(Piece piece, Square from, Square to) const;
262
263   // Game termination checks
264   bool is_mate() const;
265   bool is_draw() const;
266
267   // Check if one side threatens a mate in one
268   bool has_mate_threat(Color c);
269
270   // Number of plies since the last non-reversible move
271   int rule_50_counter() const;
272
273   // Other properties of the position
274   bool opposite_colored_bishops() const;
275   bool has_pawn_on_7th(Color c) const;
276
277   // Game ply information
278   int thread() const;
279   int ply() const;
280   void reset_ply();
281
282   // Position consistency check, for debugging
283   bool is_ok(int* failedStep = NULL) const;
284
285   // Static member functions
286   static void init_zobrist();
287   static void init_piece_square_tables();
288
289 private:
290
291   // Initialization helper functions (used while setting up a position)
292   void clear();
293   void put_piece(Piece p, Square s);
294   void allow_oo(Color c);
295   void allow_ooo(Color c);
296
297   // Helper functions for doing and undoing moves
298   void do_capture_move(Key& key, PieceType capture, Color them, Square to, bool ep);
299   void do_castle_move(Move m);
300   void undo_castle_move(Move m);
301   void find_checkers();
302
303   template<bool FindPinned>
304   Bitboard hidden_checkers(Color c) const;
305
306   // Computing hash keys from scratch (for initialization and debugging)
307   Key compute_key() const;
308   Key compute_pawn_key() const;
309   Key compute_material_key() const;
310
311   // Computing incremental evaluation scores and material counts
312   Score pst(Color c, PieceType pt, Square s) const;
313   Score compute_value() const;
314   Value compute_non_pawn_material(Color c) const;
315
316   // Board
317   Piece board[64];
318
319   // Bitboards
320   Bitboard byTypeBB[8], byColorBB[2];
321
322   // Piece counts
323   int pieceCount[2][8]; // [color][pieceType]
324
325   // Piece lists
326   Square pieceList[2][8][16]; // [color][pieceType][index]
327   int index[64]; // [square]
328
329   // Other info
330   Color sideToMove;
331   Key history[MaxGameLength];
332   int castleRightsMask[64];
333   StateInfo startState;
334   File initialKFile, initialKRFile, initialQRFile;
335   int threadID;
336   StateInfo* st;
337
338   // Static variables
339   static Key zobrist[2][8][64];
340   static Key zobEp[64];
341   static Key zobCastle[16];
342   static Key zobSideToMove;
343   static Score PieceSquareTable[16][64];
344   static Key zobExclusion;
345 };
346
347
348 ////
349 //// Inline functions
350 ////
351
352 inline Piece Position::piece_on(Square s) const {
353   return board[s];
354 }
355
356 inline Color Position::color_of_piece_on(Square s) const {
357   return color_of_piece(piece_on(s));
358 }
359
360 inline PieceType Position::type_of_piece_on(Square s) const {
361   return type_of_piece(piece_on(s));
362 }
363
364 inline bool Position::square_is_empty(Square s) const {
365   return piece_on(s) == EMPTY;
366 }
367
368 inline bool Position::square_is_occupied(Square s) const {
369   return !square_is_empty(s);
370 }
371
372 inline Value Position::midgame_value_of_piece_on(Square s) const {
373   return piece_value_midgame(piece_on(s));
374 }
375
376 inline Value Position::endgame_value_of_piece_on(Square s) const {
377   return piece_value_endgame(piece_on(s));
378 }
379
380 inline Color Position::side_to_move() const {
381   return sideToMove;
382 }
383
384 inline Bitboard Position::occupied_squares() const {
385   return byTypeBB[0];
386 }
387
388 inline Bitboard Position::empty_squares() const {
389   return ~(occupied_squares());
390 }
391
392 inline Bitboard Position::pieces_of_color(Color c) const {
393   return byColorBB[c];
394 }
395
396 inline Bitboard Position::pieces(PieceType pt) const {
397   return byTypeBB[pt];
398 }
399
400 inline Bitboard Position::pieces(PieceType pt, Color c) const {
401   return byTypeBB[pt] & byColorBB[c];
402 }
403
404 inline Bitboard Position::pieces(PieceType pt1, PieceType pt2) const {
405   return byTypeBB[pt1] | byTypeBB[pt2];
406 }
407
408 inline Bitboard Position::pieces(PieceType pt1, PieceType pt2, Color c) const {
409   return (byTypeBB[pt1] | byTypeBB[pt2]) & byColorBB[c];
410 }
411
412 inline int Position::piece_count(Color c, PieceType pt) const {
413   return pieceCount[c][pt];
414 }
415
416 inline Square Position::piece_list(Color c, PieceType pt, int idx) const {
417   return pieceList[c][pt][idx];
418 }
419
420 inline const Square* Position::piece_list_begin(Color c, PieceType pt) const {
421   return pieceList[c][pt];
422 }
423
424 inline Square Position::ep_square() const {
425   return st->epSquare;
426 }
427
428 inline Square Position::king_square(Color c) const {
429   return pieceList[c][KING][0];
430 }
431
432 inline bool Position::can_castle_kingside(Color side) const {
433   return st->castleRights & (1+int(side));
434 }
435
436 inline bool Position::can_castle_queenside(Color side) const {
437   return st->castleRights & (4+4*int(side));
438 }
439
440 inline bool Position::can_castle(Color side) const {
441   return can_castle_kingside(side) || can_castle_queenside(side);
442 }
443
444 inline Square Position::initial_kr_square(Color c) const {
445   return relative_square(c, make_square(initialKRFile, RANK_1));
446 }
447
448 inline Square Position::initial_qr_square(Color c) const {
449   return relative_square(c, make_square(initialQRFile, RANK_1));
450 }
451
452 template<>
453 inline Bitboard Position::attacks_from<PAWN>(Square s, Color c) const {
454   return StepAttackBB[piece_of_color_and_type(c, PAWN)][s];
455 }
456
457 template<PieceType Piece> // Knight and King and white pawns
458 inline Bitboard Position::attacks_from(Square s) const {
459   return StepAttackBB[Piece][s];
460 }
461
462 template<>
463 inline Bitboard Position::attacks_from<BISHOP>(Square s) const {
464   return bishop_attacks_bb(s, occupied_squares());
465 }
466
467 template<>
468 inline Bitboard Position::attacks_from<ROOK>(Square s) const {
469   return rook_attacks_bb(s, occupied_squares());
470 }
471
472 template<>
473 inline Bitboard Position::attacks_from<QUEEN>(Square s) const {
474   return attacks_from<ROOK>(s) | attacks_from<BISHOP>(s);
475 }
476
477 inline Bitboard Position::checkers() const {
478   return st->checkersBB;
479 }
480
481 inline bool Position::is_check() const {
482   return st->checkersBB != EmptyBoardBB;
483 }
484
485 inline bool Position::pawn_is_passed(Color c, Square s) const {
486   return !(pieces(PAWN, opposite_color(c)) & passed_pawn_mask(c, s));
487 }
488
489 inline bool Position::square_is_weak(Square s, Color c) const {
490   return !(pieces(PAWN, opposite_color(c)) & attack_span_mask(c, s));
491 }
492
493 inline Key Position::get_key() const {
494   return st->key;
495 }
496
497 inline Key Position::get_exclusion_key() const {
498   return st->key ^ zobExclusion;
499 }
500
501 inline Key Position::get_pawn_key() const {
502   return st->pawnKey;
503 }
504
505 inline Key Position::get_material_key() const {
506   return st->materialKey;
507 }
508
509 inline Score Position::pst(Color c, PieceType pt, Square s) const {
510   return PieceSquareTable[piece_of_color_and_type(c, pt)][s];
511 }
512
513 inline Score Position::pst_delta(Piece piece, Square from, Square to) const {
514   return PieceSquareTable[piece][to] - PieceSquareTable[piece][from];
515 }
516
517 inline Score Position::value() const {
518   return st->value;
519 }
520
521 inline Value Position::non_pawn_material(Color c) const {
522   return st->npMaterial[c];
523 }
524
525 inline bool Position::move_is_passed_pawn_push(Move m) const {
526
527   Color c = side_to_move();
528   return   piece_on(move_from(m)) == piece_of_color_and_type(c, PAWN)
529         && pawn_is_passed(c, move_to(m));
530 }
531
532 inline int Position::rule_50_counter() const {
533
534   return st->rule50;
535 }
536
537 inline bool Position::opposite_colored_bishops() const {
538
539   return   piece_count(WHITE, BISHOP) == 1
540         && piece_count(BLACK, BISHOP) == 1
541         && square_color(piece_list(WHITE, BISHOP, 0)) != square_color(piece_list(BLACK, BISHOP, 0));
542 }
543
544 inline bool Position::has_pawn_on_7th(Color c) const {
545
546   return pieces(PAWN, c) & relative_rank_bb(c, RANK_7);
547 }
548
549 inline bool Position::move_is_capture(Move m) const {
550
551   // Move must not be MOVE_NONE !
552   return (m & (3 << 15)) ? !move_is_castle(m) : !square_is_empty(move_to(m));
553 }
554
555 inline bool Position::move_is_capture_or_promotion(Move m) const {
556
557   // Move must not be MOVE_NONE !
558   return (m & (0x1F << 12)) ? !move_is_castle(m) : !square_is_empty(move_to(m));
559 }
560
561 inline PieceType Position::captured_piece() const {
562   return st->capture;
563 }
564
565 inline int Position::thread() const {
566   return threadID;
567 }
568
569 inline int Position::ply() const {
570   return st->ply;
571 }
572
573 #endif // !defined(POSITION_H_INCLUDED)