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