git.sesse.net Git - stockfish/blob - src/types.h

   1 /*
   2   Stockfish, a UCI chess playing engine derived from Glaurung 2.1
   3   Copyright (C) 2004-2020 The Stockfish developers (see AUTHORS file)
   4
   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.
   9
  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.
  14
  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/>.
  17 */
  18
  19 #ifndef TYPES_H_INCLUDED
  20 #define TYPES_H_INCLUDED
  21
  22 /// When compiling with provided Makefile (e.g. for Linux and OSX), configuration
  23 /// is done automatically. To get started type 'make help'.
  24 ///
  25 /// When Makefile is not used (e.g. with Microsoft Visual Studio) some switches
  26 /// need to be set manually:
  27 ///
  28 /// -DNDEBUG      | Disable debugging mode. Always use this for release.
  29 ///
  30 /// -DNO_PREFETCH | Disable use of prefetch asm-instruction. You may need this to
  31 ///               | run on some very old machines.
  32 ///
  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.
  35 ///
  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.
  38
  39 #include <cassert>
  40 #include <cctype>
  41 #include <cstdint>
  42 #include <cstdlib>
  43 #include <algorithm>
  44
  45 #if defined(_MSC_VER)
  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'
  50 #endif
  51
  52 /// Predefined macros hell:
  53 ///
  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
  59
  60 #if defined(_WIN64) && defined(_MSC_VER) // No Makefile used
  61 #  include <intrin.h> // Microsoft header for _BitScanForward64()
  62 #  define IS_64BIT
  63 #endif
  64
  65 #if defined(USE_POPCNT) && (defined(__INTEL_COMPILER) || defined(_MSC_VER))
  66 #  include <nmmintrin.h> // Intel and Microsoft header for _mm_popcnt_u64()
  67 #endif
  68
  69 #if !defined(NO_PREFETCH) && (defined(__INTEL_COMPILER) || defined(_MSC_VER))
  70 #  include <xmmintrin.h> // Intel and Microsoft header for _mm_prefetch()
  71 #endif
  72
  73 #if defined(USE_PEXT)
  74 #  include <immintrin.h> // Header for _pext_u64() intrinsic
  75 #  define pext(b, m) _pext_u64(b, m)
  76 #else
  77 #  define pext(b, m) 0
  78 #endif
  79
  80 #ifdef USE_POPCNT
  81 constexpr bool HasPopCnt = true;
  82 #else
  83 constexpr bool HasPopCnt = false;
  84 #endif
  85
  86 #ifdef USE_PEXT
  87 constexpr bool HasPext = true;
  88 #else
  89 constexpr bool HasPext = false;
  90 #endif
  91
  92 #ifdef IS_64BIT
  93 constexpr bool Is64Bit = true;
  94 #else
  95 constexpr bool Is64Bit = false;
  96 #endif
  97
  98 typedef uint64_t Key;
  99 typedef uint64_t Bitboard;
 100
 101 constexpr int MAX_MOVES = 256;
 102 constexpr int MAX_PLY   = 246;
 103
 104 /// A move needs 16 bits to be stored
 105 ///
 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
 111 ///
 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.
 115
 116 enum Move : int {
 117   MOVE_NONE,
 118   MOVE_NULL = 65
 119 };
 120
 121 enum MoveType {
 122   NORMAL,
 123   PROMOTION = 1 << 14,
 124   ENPASSANT = 2 << 14,
 125   CASTLING  = 3 << 14
 126 };
 127
 128 enum Color {
 129   WHITE, BLACK, COLOR_NB = 2
 130 };
 131
 132 enum CastlingRights {
 133   NO_CASTLING,
 134   WHITE_OO,
 135   WHITE_OOO = WHITE_OO << 1,
 136   BLACK_OO  = WHITE_OO << 2,
 137   BLACK_OOO = WHITE_OO << 3,
 138
 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,
 144
 145   CASTLING_RIGHT_NB = 16
 146 };
 147
 148 enum Phase {
 149   PHASE_ENDGAME,
 150   PHASE_MIDGAME = 128,
 151   MG = 0, EG = 1, PHASE_NB = 2
 152 };
 153
 154 enum ScaleFactor {
 155   SCALE_FACTOR_DRAW    = 0,
 156   SCALE_FACTOR_NORMAL  = 64,
 157   SCALE_FACTOR_MAX     = 128,
 158   SCALE_FACTOR_NONE    = 255
 159 };
 160
 161 enum Bound {
 162   BOUND_NONE,
 163   BOUND_UPPER,
 164   BOUND_LOWER,
 165   BOUND_EXACT = BOUND_UPPER | BOUND_LOWER
 166 };
 167
 168 enum Value : int {
 169   VALUE_ZERO      = 0,
 170   VALUE_DRAW      = 0,
 171   VALUE_KNOWN_WIN = 10000,
 172   VALUE_MATE      = 32000,
 173   VALUE_INFINITE  = 32001,
 174   VALUE_NONE      = 32002,
 175
 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,
 180
 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,
 186   Tempo = 28,
 187
 188   MidgameLimit  = 15258, EndgameLimit  = 3915
 189 };
 190
 191 enum PieceType {
 192   NO_PIECE_TYPE, PAWN, KNIGHT, BISHOP, ROOK, QUEEN, KING,
 193   ALL_PIECES = 0,
 194   PIECE_TYPE_NB = 8
 195 };
 196
 197 enum Piece {
 198   NO_PIECE,
 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,
 201   PIECE_NB = 16
 202 };
 203
 204 constexpr Value PieceValue[PHASE_NB][PIECE_NB] = {
 205   { VALUE_ZERO, PawnValueMg, KnightValueMg, BishopValueMg, RookValueMg, QueenValueMg, VALUE_ZERO, VALUE_ZERO,
 206     VALUE_ZERO, PawnValueMg, KnightValueMg, BishopValueMg, RookValueMg, QueenValueMg, VALUE_ZERO, VALUE_ZERO },
 207   { VALUE_ZERO, PawnValueEg, KnightValueEg, BishopValueEg, RookValueEg, QueenValueEg, VALUE_ZERO, VALUE_ZERO,
 208     VALUE_ZERO, PawnValueEg, KnightValueEg, BishopValueEg, RookValueEg, QueenValueEg, VALUE_ZERO, VALUE_ZERO }
 209 };
 210
 211 typedef int Depth;
 212
 213 enum : int {
 214   DEPTH_QS_CHECKS     =  0,
 215   DEPTH_QS_NO_CHECKS  = -1,
 216   DEPTH_QS_RECAPTURES = -5,
 217
 218   DEPTH_NONE   = -6,
 219
 220   DEPTH_OFFSET = -7 // value used only for TT entry occupancy check
 221 };
 222
 223 enum Square : int {
 224   SQ_A1, SQ_B1, SQ_C1, SQ_D1, SQ_E1, SQ_F1, SQ_G1, SQ_H1,
 225   SQ_A2, SQ_B2, SQ_C2, SQ_D2, SQ_E2, SQ_F2, SQ_G2, SQ_H2,
 226   SQ_A3, SQ_B3, SQ_C3, SQ_D3, SQ_E3, SQ_F3, SQ_G3, SQ_H3,
 227   SQ_A4, SQ_B4, SQ_C4, SQ_D4, SQ_E4, SQ_F4, SQ_G4, SQ_H4,
 228   SQ_A5, SQ_B5, SQ_C5, SQ_D5, SQ_E5, SQ_F5, SQ_G5, SQ_H5,
 229   SQ_A6, SQ_B6, SQ_C6, SQ_D6, SQ_E6, SQ_F6, SQ_G6, SQ_H6,
 230   SQ_A7, SQ_B7, SQ_C7, SQ_D7, SQ_E7, SQ_F7, SQ_G7, SQ_H7,
 231   SQ_A8, SQ_B8, SQ_C8, SQ_D8, SQ_E8, SQ_F8, SQ_G8, SQ_H8,
 232   SQ_NONE,
 233
 234   SQUARE_ZERO = 0,
 235   SQUARE_NB   = 64
 236 };
 237
 238 enum Direction : int {
 239   NORTH =  8,
 240   EAST  =  1,
 241   SOUTH = -NORTH,
 242   WEST  = -EAST,
 243
 244   NORTH_EAST = NORTH + EAST,
 245   SOUTH_EAST = SOUTH + EAST,
 246   SOUTH_WEST = SOUTH + WEST,
 247   NORTH_WEST = NORTH + WEST
 248 };
 249
 250 enum File : int {
 251   FILE_A, FILE_B, FILE_C, FILE_D, FILE_E, FILE_F, FILE_G, FILE_H, FILE_NB
 252 };
 253
 254 enum Rank : int {
 255   RANK_1, RANK_2, RANK_3, RANK_4, RANK_5, RANK_6, RANK_7, RANK_8, RANK_NB
 256 };
 257
 258 // Keep track of what a move changes on the board (used by NNUE)
 259 struct DirtyPiece {
 260
 261   // Number of changed pieces
 262   int dirty_num;
 263
 264   // Max 3 pieces can change in one move. A promotion with capture moves
 265   // both the pawn and the captured piece to SQ_NONE and the piece promoted
 266   // to from SQ_NONE to the capture square.
 267   Piece piece[3];
 268
 269   // From and to squares, which may be SQ_NONE
 270   Square from[3];
 271   Square to[3];
 272 };
 273
 274 /// Score enum stores a middlegame and an endgame value in a single integer (enum).
 275 /// The least significant 16 bits are used to store the middlegame value and the
 276 /// upper 16 bits are used to store the endgame value. We have to take care to
 277 /// avoid left-shifting a signed int to avoid undefined behavior.
 278 enum Score : int { SCORE_ZERO };
 279
 280 constexpr Score make_score(int mg, int eg) {
 281   return Score((int)((unsigned int)eg << 16) + mg);
 282 }
 283
 284 /// Extracting the signed lower and upper 16 bits is not so trivial because
 285 /// according to the standard a simple cast to short is implementation defined
 286 /// and so is a right shift of a signed integer.
 287 inline Value eg_value(Score s) {
 288   union { uint16_t u; int16_t s; } eg = { uint16_t(unsigned(s + 0x8000) >> 16) };
 289   return Value(eg.s);
 290 }
 291
 292 inline Value mg_value(Score s) {
 293   union { uint16_t u; int16_t s; } mg = { uint16_t(unsigned(s)) };
 294   return Value(mg.s);
 295 }
 296
 297 #define ENABLE_BASE_OPERATORS_ON(T)                                \
 298 constexpr T operator+(T d1, int d2) { return T(int(d1) + d2); }    \
 299 constexpr T operator-(T d1, int d2) { return T(int(d1) - d2); }    \
 300 constexpr T operator-(T d) { return T(-int(d)); }                  \
 301 inline T& operator+=(T& d1, int d2) { return d1 = d1 + d2; }       \
 302 inline T& operator-=(T& d1, int d2) { return d1 = d1 - d2; }
 303
 304 #define ENABLE_INCR_OPERATORS_ON(T)                                \
 305 inline T& operator++(T& d) { return d = T(int(d) + 1); }           \
 306 inline T& operator--(T& d) { return d = T(int(d) - 1); }
 307
 308 #define ENABLE_FULL_OPERATORS_ON(T)                                \
 309 ENABLE_BASE_OPERATORS_ON(T)                                        \
 310 constexpr T operator*(int i, T d) { return T(i * int(d)); }        \
 311 constexpr T operator*(T d, int i) { return T(int(d) * i); }        \
 312 constexpr T operator/(T d, int i) { return T(int(d) / i); }        \
 313 constexpr int operator/(T d1, T d2) { return int(d1) / int(d2); }  \
 314 inline T& operator*=(T& d, int i) { return d = T(int(d) * i); }    \
 315 inline T& operator/=(T& d, int i) { return d = T(int(d) / i); }
 316
 317 ENABLE_FULL_OPERATORS_ON(Value)
 318 ENABLE_FULL_OPERATORS_ON(Direction)
 319
 320 ENABLE_INCR_OPERATORS_ON(Piece)
 321 ENABLE_INCR_OPERATORS_ON(PieceType)
 322 ENABLE_INCR_OPERATORS_ON(Square)
 323 ENABLE_INCR_OPERATORS_ON(File)
 324 ENABLE_INCR_OPERATORS_ON(Rank)
 325
 326 ENABLE_BASE_OPERATORS_ON(Score)
 327
 328 #undef ENABLE_FULL_OPERATORS_ON
 329 #undef ENABLE_INCR_OPERATORS_ON
 330 #undef ENABLE_BASE_OPERATORS_ON
 331
 332 /// Additional operators to add a Direction to a Square
 333 constexpr Square operator+(Square s, Direction d) { return Square(int(s) + int(d)); }
 334 constexpr Square operator-(Square s, Direction d) { return Square(int(s) - int(d)); }
 335 inline Square& operator+=(Square& s, Direction d) { return s = s + d; }
 336 inline Square& operator-=(Square& s, Direction d) { return s = s - d; }
 337
 338 /// Only declared but not defined. We don't want to multiply two scores due to
 339 /// a very high risk of overflow. So user should explicitly convert to integer.
 340 Score operator*(Score, Score) = delete;
 341
 342 /// Division of a Score must be handled separately for each term
 343 inline Score operator/(Score s, int i) {
 344   return make_score(mg_value(s) / i, eg_value(s) / i);
 345 }
 346
 347 /// Multiplication of a Score by an integer. We check for overflow in debug mode.
 348 inline Score operator*(Score s, int i) {
 349
 350   Score result = Score(int(s) * i);
 351
 352   assert(eg_value(result) == (i * eg_value(s)));
 353   assert(mg_value(result) == (i * mg_value(s)));
 354   assert((i == 0) || (result / i) == s);
 355
 356   return result;
 357 }
 358
 359 /// Multiplication of a Score by a boolean
 360 inline Score operator*(Score s, bool b) {
 361   return b ? s : SCORE_ZERO;
 362 }
 363
 364 constexpr Color operator~(Color c) {
 365   return Color(c ^ BLACK); // Toggle color
 366 }
 367
 368 constexpr Square flip_rank(Square s) { // Swap A1 <-> A8
 369   return Square(s ^ SQ_A8);
 370 }
 371
 372 constexpr Square flip_file(Square s) { // Swap A1 <-> H1
 373   return Square(s ^ SQ_H1);
 374 }
 375
 376 constexpr Piece operator~(Piece pc) {
 377   return Piece(pc ^ 8); // Swap color of piece B_KNIGHT <-> W_KNIGHT
 378 }
 379
 380 constexpr CastlingRights operator&(Color c, CastlingRights cr) {
 381   return CastlingRights((c == WHITE ? WHITE_CASTLING : BLACK_CASTLING) & cr);
 382 }
 383
 384 constexpr Value mate_in(int ply) {
 385   return VALUE_MATE - ply;
 386 }
 387
 388 constexpr Value mated_in(int ply) {
 389   return -VALUE_MATE + ply;
 390 }
 391
 392 constexpr Square make_square(File f, Rank r) {
 393   return Square((r << 3) + f);
 394 }
 395
 396 constexpr Piece make_piece(Color c, PieceType pt) {
 397   return Piece((c << 3) + pt);
 398 }
 399
 400 constexpr PieceType type_of(Piece pc) {
 401   return PieceType(pc & 7);
 402 }
 403
 404 inline Color color_of(Piece pc) {
 405   assert(pc != NO_PIECE);
 406   return Color(pc >> 3);
 407 }
 408
 409 constexpr bool is_ok(Square s) {
 410   return s >= SQ_A1 && s <= SQ_H8;
 411 }
 412
 413 constexpr File file_of(Square s) {
 414   return File(s & 7);
 415 }
 416
 417 constexpr Rank rank_of(Square s) {
 418   return Rank(s >> 3);
 419 }
 420
 421 constexpr Square relative_square(Color c, Square s) {
 422   return Square(s ^ (c * 56));
 423 }
 424
 425 constexpr Rank relative_rank(Color c, Rank r) {
 426   return Rank(r ^ (c * 7));
 427 }
 428
 429 constexpr Rank relative_rank(Color c, Square s) {
 430   return relative_rank(c, rank_of(s));
 431 }
 432
 433 constexpr Direction pawn_push(Color c) {
 434   return c == WHITE ? NORTH : SOUTH;
 435 }
 436
 437 constexpr Square from_sq(Move m) {
 438   return Square((m >> 6) & 0x3F);
 439 }
 440
 441 constexpr Square to_sq(Move m) {
 442   return Square(m & 0x3F);
 443 }
 444
 445 constexpr int from_to(Move m) {
 446  return m & 0xFFF;
 447 }
 448
 449 constexpr MoveType type_of(Move m) {
 450   return MoveType(m & (3 << 14));
 451 }
 452
 453 constexpr PieceType promotion_type(Move m) {
 454   return PieceType(((m >> 12) & 3) + KNIGHT);
 455 }
 456
 457 constexpr Move make_move(Square from, Square to) {
 458   return Move((from << 6) + to);
 459 }
 460
 461 constexpr Move reverse_move(Move m) {
 462   return make_move(to_sq(m), from_sq(m));
 463 }
 464
 465 template<MoveType T>
 466 constexpr Move make(Square from, Square to, PieceType pt = KNIGHT) {
 467   return Move(T + ((pt - KNIGHT) << 12) + (from << 6) + to);
 468 }
 469
 470 constexpr bool is_ok(Move m) {
 471   return from_sq(m) != to_sq(m); // Catch MOVE_NULL and MOVE_NONE
 472 }
 473
 474 /// Based on a congruential pseudo random number generator
 475 constexpr Key make_key(uint64_t seed) {
 476   return seed * 6364136223846793005ULL + 1442695040888963407ULL;
 477 }
 478
 479 #endif // #ifndef TYPES_H_INCLUDED
 480
 481 #include "tune.h" // Global visibility to tuning setup