2 Stockfish, a UCI chess playing engine derived from Glaurung 2.1
3 Copyright (C) 2004-2020 The Stockfish developers (see AUTHORS file)
5 Stockfish is free software: you can redistribute it and/or modify
6 it under the terms of the GNU General Public License as published by
7 the Free Software Foundation, either version 3 of the License, or
8 (at your option) any later version.
10 Stockfish is distributed in the hope that it will be useful,
11 but WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 GNU General Public License for more details.
15 You should have received a copy of the GNU General Public License
16 along with this program. If not, see <http://www.gnu.org/licenses/>.
19 #ifndef TYPES_H_INCLUDED
20 #define TYPES_H_INCLUDED
22 /// When compiling with provided Makefile (e.g. for Linux and OSX), configuration
23 /// is done automatically. To get started type 'make help'.
25 /// When Makefile is not used (e.g. with Microsoft Visual Studio) some switches
26 /// need to be set manually:
28 /// -DNDEBUG | Disable debugging mode. Always use this for release.
30 /// -DNO_PREFETCH | Disable use of prefetch asm-instruction. You may need this to
31 /// | run on some very old machines.
33 /// -DUSE_POPCNT | Add runtime support for use of popcnt asm-instruction. Works
34 /// | only in 64-bit mode and requires hardware with popcnt support.
36 /// -DUSE_PEXT | Add runtime support for use of pext asm-instruction. Works
37 /// | only in 64-bit mode and requires hardware with pext support.
46 // Disable some silly and noisy warning from MSVC compiler
47 #pragma warning(disable: 4127) // Conditional expression is constant
48 #pragma warning(disable: 4146) // Unary minus operator applied to unsigned type
49 #pragma warning(disable: 4800) // Forcing value to bool 'true' or 'false'
52 /// Predefined macros hell:
54 /// __GNUC__ Compiler is gcc, Clang or Intel on Linux
55 /// __INTEL_COMPILER Compiler is Intel
56 /// _MSC_VER Compiler is MSVC or Intel on Windows
57 /// _WIN32 Building on Windows (any)
58 /// _WIN64 Building on Windows 64 bit
60 #if defined(_WIN64) && defined(_MSC_VER) // No Makefile used
61 # include <intrin.h> // Microsoft header for _BitScanForward64()
65 #if defined(USE_POPCNT) && (defined(__INTEL_COMPILER) || defined(_MSC_VER))
66 # include <nmmintrin.h> // Intel and Microsoft header for _mm_popcnt_u64()
69 #if !defined(NO_PREFETCH) && (defined(__INTEL_COMPILER) || defined(_MSC_VER))
70 # include <xmmintrin.h> // Intel and Microsoft header for _mm_prefetch()
74 # include <immintrin.h> // Header for _pext_u64() intrinsic
75 # define pext(b, m) _pext_u64(b, m)
81 constexpr bool HasPopCnt = true;
83 constexpr bool HasPopCnt = false;
87 constexpr bool HasPext = true;
89 constexpr bool HasPext = false;
93 constexpr bool Is64Bit = true;
95 constexpr bool Is64Bit = false;
99 typedef uint64_t Bitboard;
101 constexpr int MAX_MOVES = 256;
102 constexpr int MAX_PLY = 246;
104 /// A move needs 16 bits to be stored
106 /// bit 0- 5: destination square (from 0 to 63)
107 /// bit 6-11: origin square (from 0 to 63)
108 /// bit 12-13: promotion piece type - 2 (from KNIGHT-2 to QUEEN-2)
109 /// bit 14-15: special move flag: promotion (1), en passant (2), castling (3)
110 /// NOTE: EN-PASSANT bit is set only when a pawn can be captured
112 /// Special cases are MOVE_NONE and MOVE_NULL. We can sneak these in because in
113 /// any normal move destination square is always different from origin square
114 /// while MOVE_NONE and MOVE_NULL have the same origin and destination square.
129 WHITE, BLACK, COLOR_NB = 2
132 enum CastlingRights {
135 WHITE_OOO = WHITE_OO << 1,
136 BLACK_OO = WHITE_OO << 2,
137 BLACK_OOO = WHITE_OO << 3,
139 KING_SIDE = WHITE_OO | BLACK_OO,
140 QUEEN_SIDE = WHITE_OOO | BLACK_OOO,
141 WHITE_CASTLING = WHITE_OO | WHITE_OOO,
142 BLACK_CASTLING = BLACK_OO | BLACK_OOO,
143 ANY_CASTLING = WHITE_CASTLING | BLACK_CASTLING,
145 CASTLING_RIGHT_NB = 16
151 MG = 0, EG = 1, PHASE_NB = 2
155 SCALE_FACTOR_DRAW = 0,
156 SCALE_FACTOR_NORMAL = 64,
157 SCALE_FACTOR_MAX = 128,
158 SCALE_FACTOR_NONE = 255
165 BOUND_EXACT = BOUND_UPPER | BOUND_LOWER
171 VALUE_KNOWN_WIN = 10000,
173 VALUE_INFINITE = 32001,
176 VALUE_TB_WIN_IN_MAX_PLY = VALUE_MATE - 2 * MAX_PLY,
177 VALUE_TB_LOSS_IN_MAX_PLY = -VALUE_TB_WIN_IN_MAX_PLY,
178 VALUE_MATE_IN_MAX_PLY = VALUE_MATE - MAX_PLY,
179 VALUE_MATED_IN_MAX_PLY = -VALUE_MATE_IN_MAX_PLY,
181 PawnValueMg = 126, PawnValueEg = 208,
182 KnightValueMg = 781, KnightValueEg = 854,
183 BishopValueMg = 825, BishopValueEg = 915,
184 RookValueMg = 1276, RookValueEg = 1380,
185 QueenValueMg = 2538, QueenValueEg = 2682,
188 MidgameLimit = 15258, EndgameLimit = 3915
192 NO_PIECE_TYPE, PAWN, KNIGHT, BISHOP, ROOK, QUEEN, KING,
199 W_PAWN = 1, W_KNIGHT, W_BISHOP, W_ROOK, W_QUEEN, W_KING,
200 B_PAWN = 9, B_KNIGHT, B_BISHOP, B_ROOK, B_QUEEN, B_KING,
204 // An ID used to track the pieces. Max. 32 pieces on board.
213 inline PieceId operator++(PieceId& d, int) {
216 d = PieceId(int(d) + 1);
220 constexpr Value PieceValue[PHASE_NB][PIECE_NB] = {
221 { VALUE_ZERO, PawnValueMg, KnightValueMg, BishopValueMg, RookValueMg, QueenValueMg, VALUE_ZERO, VALUE_ZERO,
222 VALUE_ZERO, PawnValueMg, KnightValueMg, BishopValueMg, RookValueMg, QueenValueMg, VALUE_ZERO, VALUE_ZERO },
223 { VALUE_ZERO, PawnValueEg, KnightValueEg, BishopValueEg, RookValueEg, QueenValueEg, VALUE_ZERO, VALUE_ZERO,
224 VALUE_ZERO, PawnValueEg, KnightValueEg, BishopValueEg, RookValueEg, QueenValueEg, VALUE_ZERO, VALUE_ZERO }
231 DEPTH_QS_NO_CHECKS = -1,
232 DEPTH_QS_RECAPTURES = -5,
236 DEPTH_OFFSET = -7 // value used only for TT entry occupancy check
240 SQ_A1, SQ_B1, SQ_C1, SQ_D1, SQ_E1, SQ_F1, SQ_G1, SQ_H1,
241 SQ_A2, SQ_B2, SQ_C2, SQ_D2, SQ_E2, SQ_F2, SQ_G2, SQ_H2,
242 SQ_A3, SQ_B3, SQ_C3, SQ_D3, SQ_E3, SQ_F3, SQ_G3, SQ_H3,
243 SQ_A4, SQ_B4, SQ_C4, SQ_D4, SQ_E4, SQ_F4, SQ_G4, SQ_H4,
244 SQ_A5, SQ_B5, SQ_C5, SQ_D5, SQ_E5, SQ_F5, SQ_G5, SQ_H5,
245 SQ_A6, SQ_B6, SQ_C6, SQ_D6, SQ_E6, SQ_F6, SQ_G6, SQ_H6,
246 SQ_A7, SQ_B7, SQ_C7, SQ_D7, SQ_E7, SQ_F7, SQ_G7, SQ_H7,
247 SQ_A8, SQ_B8, SQ_C8, SQ_D8, SQ_E8, SQ_F8, SQ_G8, SQ_H8,
254 enum Direction : int {
260 NORTH_EAST = NORTH + EAST,
261 SOUTH_EAST = SOUTH + EAST,
262 SOUTH_WEST = SOUTH + WEST,
263 NORTH_WEST = NORTH + WEST
267 FILE_A, FILE_B, FILE_C, FILE_D, FILE_E, FILE_F, FILE_G, FILE_H, FILE_NB
271 RANK_1, RANK_2, RANK_3, RANK_4, RANK_5, RANK_6, RANK_7, RANK_8, RANK_NB
274 // unique number for each piece type on each square
275 enum PieceSquare : uint32_t {
278 PS_B_PAWN = 1 * SQUARE_NB + 1,
279 PS_W_KNIGHT = 2 * SQUARE_NB + 1,
280 PS_B_KNIGHT = 3 * SQUARE_NB + 1,
281 PS_W_BISHOP = 4 * SQUARE_NB + 1,
282 PS_B_BISHOP = 5 * SQUARE_NB + 1,
283 PS_W_ROOK = 6 * SQUARE_NB + 1,
284 PS_B_ROOK = 7 * SQUARE_NB + 1,
285 PS_W_QUEEN = 8 * SQUARE_NB + 1,
286 PS_B_QUEEN = 9 * SQUARE_NB + 1,
287 PS_W_KING = 10 * SQUARE_NB + 1,
288 PS_END = PS_W_KING, // pieces without kings (pawns included)
289 PS_B_KING = 11 * SQUARE_NB + 1,
290 PS_END2 = 12 * SQUARE_NB + 1
293 struct ExtPieceSquare {
294 PieceSquare from[COLOR_NB];
297 // Array for finding the PieceSquare corresponding to the piece on the board
298 extern ExtPieceSquare kpp_board_index[PIECE_NB];
300 constexpr bool is_ok(PieceId pid);
301 constexpr Square rotate180(Square sq);
303 // Structure holding which tracked piece (PieceId) is where (PieceSquare)
307 // Max. number of pieces without kings is 30 but must be a multiple of 4 in AVX2
308 static const int MAX_LENGTH = 32;
310 // Array that holds the piece id for the pieces on the board
311 PieceId piece_id_list[SQUARE_NB];
313 // List of pieces, separate from White and Black POV
314 PieceSquare* piece_list_fw() const { return const_cast<PieceSquare*>(pieceListFw); }
315 PieceSquare* piece_list_fb() const { return const_cast<PieceSquare*>(pieceListFb); }
317 // Place the piece pc with piece_id on the square sq on the board
318 void put_piece(PieceId piece_id, Square sq, Piece pc)
320 assert(is_ok(piece_id));
323 pieceListFw[piece_id] = PieceSquare(kpp_board_index[pc].from[WHITE] + sq);
324 pieceListFb[piece_id] = PieceSquare(kpp_board_index[pc].from[BLACK] + rotate180(sq));
325 piece_id_list[sq] = piece_id;
329 pieceListFw[piece_id] = PS_NONE;
330 pieceListFb[piece_id] = PS_NONE;
331 piece_id_list[sq] = piece_id;
335 // Convert the specified piece_id piece to ExtPieceSquare type and return it
336 ExtPieceSquare piece_with_id(PieceId piece_id) const
339 eps.from[WHITE] = pieceListFw[piece_id];
340 eps.from[BLACK] = pieceListFb[piece_id];
345 PieceSquare pieceListFw[MAX_LENGTH];
346 PieceSquare pieceListFb[MAX_LENGTH];
349 // For differential evaluation of pieces that changed since last turn
352 // Number of changed pieces
355 // The ids of changed pieces, max. 2 pieces can change in one move
358 // What changed from the piece with that piece number
359 ExtPieceSquare old_piece[2];
360 ExtPieceSquare new_piece[2];
363 /// Score enum stores a middlegame and an endgame value in a single integer (enum).
364 /// The least significant 16 bits are used to store the middlegame value and the
365 /// upper 16 bits are used to store the endgame value. We have to take care to
366 /// avoid left-shifting a signed int to avoid undefined behavior.
367 enum Score : int { SCORE_ZERO };
369 constexpr Score make_score(int mg, int eg) {
370 return Score((int)((unsigned int)eg << 16) + mg);
373 /// Extracting the signed lower and upper 16 bits is not so trivial because
374 /// according to the standard a simple cast to short is implementation defined
375 /// and so is a right shift of a signed integer.
376 inline Value eg_value(Score s) {
377 union { uint16_t u; int16_t s; } eg = { uint16_t(unsigned(s + 0x8000) >> 16) };
381 inline Value mg_value(Score s) {
382 union { uint16_t u; int16_t s; } mg = { uint16_t(unsigned(s)) };
386 #define ENABLE_BASE_OPERATORS_ON(T) \
387 constexpr T operator+(T d1, int d2) { return T(int(d1) + d2); } \
388 constexpr T operator-(T d1, int d2) { return T(int(d1) - d2); } \
389 constexpr T operator-(T d) { return T(-int(d)); } \
390 inline T& operator+=(T& d1, int d2) { return d1 = d1 + d2; } \
391 inline T& operator-=(T& d1, int d2) { return d1 = d1 - d2; }
393 #define ENABLE_INCR_OPERATORS_ON(T) \
394 inline T& operator++(T& d) { return d = T(int(d) + 1); } \
395 inline T& operator--(T& d) { return d = T(int(d) - 1); }
397 #define ENABLE_FULL_OPERATORS_ON(T) \
398 ENABLE_BASE_OPERATORS_ON(T) \
399 constexpr T operator*(int i, T d) { return T(i * int(d)); } \
400 constexpr T operator*(T d, int i) { return T(int(d) * i); } \
401 constexpr T operator/(T d, int i) { return T(int(d) / i); } \
402 constexpr int operator/(T d1, T d2) { return int(d1) / int(d2); } \
403 inline T& operator*=(T& d, int i) { return d = T(int(d) * i); } \
404 inline T& operator/=(T& d, int i) { return d = T(int(d) / i); }
406 ENABLE_FULL_OPERATORS_ON(Value)
407 ENABLE_FULL_OPERATORS_ON(Direction)
409 ENABLE_INCR_OPERATORS_ON(Piece)
410 ENABLE_INCR_OPERATORS_ON(PieceSquare)
411 ENABLE_INCR_OPERATORS_ON(PieceId)
412 ENABLE_INCR_OPERATORS_ON(PieceType)
413 ENABLE_INCR_OPERATORS_ON(Square)
414 ENABLE_INCR_OPERATORS_ON(File)
415 ENABLE_INCR_OPERATORS_ON(Rank)
417 ENABLE_BASE_OPERATORS_ON(Score)
419 #undef ENABLE_FULL_OPERATORS_ON
420 #undef ENABLE_INCR_OPERATORS_ON
421 #undef ENABLE_BASE_OPERATORS_ON
423 /// Additional operators to add a Direction to a Square
424 constexpr Square operator+(Square s, Direction d) { return Square(int(s) + int(d)); }
425 constexpr Square operator-(Square s, Direction d) { return Square(int(s) - int(d)); }
426 inline Square& operator+=(Square& s, Direction d) { return s = s + d; }
427 inline Square& operator-=(Square& s, Direction d) { return s = s - d; }
429 /// Only declared but not defined. We don't want to multiply two scores due to
430 /// a very high risk of overflow. So user should explicitly convert to integer.
431 Score operator*(Score, Score) = delete;
433 /// Division of a Score must be handled separately for each term
434 inline Score operator/(Score s, int i) {
435 return make_score(mg_value(s) / i, eg_value(s) / i);
438 /// Multiplication of a Score by an integer. We check for overflow in debug mode.
439 inline Score operator*(Score s, int i) {
441 Score result = Score(int(s) * i);
443 assert(eg_value(result) == (i * eg_value(s)));
444 assert(mg_value(result) == (i * mg_value(s)));
445 assert((i == 0) || (result / i) == s);
450 /// Multiplication of a Score by a boolean
451 inline Score operator*(Score s, bool b) {
452 return b ? s : SCORE_ZERO;
455 constexpr Color operator~(Color c) {
456 return Color(c ^ BLACK); // Toggle color
459 constexpr Square flip_rank(Square s) { // Swap A1 <-> A8
460 return Square(s ^ SQ_A8);
463 constexpr Square flip_file(Square s) { // Swap A1 <-> H1
464 return Square(s ^ SQ_H1);
467 constexpr Piece operator~(Piece pc) {
468 return Piece(pc ^ 8); // Swap color of piece B_KNIGHT <-> W_KNIGHT
471 constexpr CastlingRights operator&(Color c, CastlingRights cr) {
472 return CastlingRights((c == WHITE ? WHITE_CASTLING : BLACK_CASTLING) & cr);
475 constexpr Value mate_in(int ply) {
476 return VALUE_MATE - ply;
479 constexpr Value mated_in(int ply) {
480 return -VALUE_MATE + ply;
483 constexpr Square make_square(File f, Rank r) {
484 return Square((r << 3) + f);
487 constexpr Piece make_piece(Color c, PieceType pt) {
488 return Piece((c << 3) + pt);
491 constexpr PieceType type_of(Piece pc) {
492 return PieceType(pc & 7);
495 inline Color color_of(Piece pc) {
496 assert(pc != NO_PIECE);
497 return Color(pc >> 3);
500 constexpr bool is_ok(PieceId pid) {
501 return pid < PIECE_ID_NONE;
504 constexpr bool is_ok(Square s) {
505 return s >= SQ_A1 && s <= SQ_H8;
508 constexpr File file_of(Square s) {
512 constexpr Rank rank_of(Square s) {
516 constexpr Square relative_square(Color c, Square s) {
517 return Square(s ^ (c * 56));
520 constexpr Rank relative_rank(Color c, Rank r) {
521 return Rank(r ^ (c * 7));
524 constexpr Rank relative_rank(Color c, Square s) {
525 return relative_rank(c, rank_of(s));
528 constexpr Direction pawn_push(Color c) {
529 return c == WHITE ? NORTH : SOUTH;
532 constexpr Square from_sq(Move m) {
533 return Square((m >> 6) & 0x3F);
536 constexpr Square to_sq(Move m) {
537 return Square(m & 0x3F);
540 // Return relative square when turning the board 180 degrees
541 constexpr Square rotate180(Square sq) {
542 return (Square)(sq ^ 0x3F);
545 constexpr int from_to(Move m) {
549 constexpr MoveType type_of(Move m) {
550 return MoveType(m & (3 << 14));
553 constexpr PieceType promotion_type(Move m) {
554 return PieceType(((m >> 12) & 3) + KNIGHT);
557 constexpr Move make_move(Square from, Square to) {
558 return Move((from << 6) + to);
561 constexpr Move reverse_move(Move m) {
562 return make_move(to_sq(m), from_sq(m));
566 constexpr Move make(Square from, Square to, PieceType pt = KNIGHT) {
567 return Move(T + ((pt - KNIGHT) << 12) + (from << 6) + to);
570 constexpr bool is_ok(Move m) {
571 return from_sq(m) != to_sq(m); // Catch MOVE_NULL and MOVE_NONE
574 /// Based on a congruential pseudo random number generator
575 constexpr Key make_key(uint64_t seed) {
576 return seed * 6364136223846793005ULL + 1442695040888963407ULL;
579 #endif // #ifndef TYPES_H_INCLUDED
581 #include "tune.h" // Global visibility to tuning setup