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-2023 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 namespace Stockfish {
  87
  88 #ifdef USE_POPCNT
  89 constexpr bool HasPopCnt = true;
  90 #else
  91 constexpr bool HasPopCnt = false;
  92 #endif
  93
  94 #ifdef USE_PEXT
  95 constexpr bool HasPext = true;
  96 #else
  97 constexpr bool HasPext = false;
  98 #endif
  99
 100 #ifdef IS_64BIT
 101 constexpr bool Is64Bit = true;
 102 #else
 103 constexpr bool Is64Bit = false;
 104 #endif
 105
 106 using Key = uint64_t;
 107 using Bitboard = uint64_t;
 108
 109 constexpr int MAX_MOVES = 256;
 110 constexpr int MAX_PLY   = 246;
 111
 112 /// A move needs 16 bits to be stored
 113 ///
 114 /// bit  0- 5: destination square (from 0 to 63)
 115 /// bit  6-11: origin square (from 0 to 63)
 116 /// bit 12-13: promotion piece type - 2 (from KNIGHT-2 to QUEEN-2)
 117 /// bit 14-15: special move flag: promotion (1), en passant (2), castling (3)
 118 /// NOTE: en passant bit is set only when a pawn can be captured
 119 ///
 120 /// Special cases are MOVE_NONE and MOVE_NULL. We can sneak these in because in
 121 /// any normal move destination square is always different from origin square
 122 /// while MOVE_NONE and MOVE_NULL have the same origin and destination square.
 123
 124 enum Move : int {
 125   MOVE_NONE,
 126   MOVE_NULL = 65
 127 };
 128
 129 enum MoveType {
 130   NORMAL,
 131   PROMOTION = 1 << 14,
 132   EN_PASSANT = 2 << 14,
 133   CASTLING  = 3 << 14
 134 };
 135
 136 enum Color {
 137   WHITE, BLACK, COLOR_NB = 2
 138 };
 139
 140 enum CastlingRights {
 141   NO_CASTLING,
 142   WHITE_OO,
 143   WHITE_OOO = WHITE_OO << 1,
 144   BLACK_OO  = WHITE_OO << 2,
 145   BLACK_OOO = WHITE_OO << 3,
 146
 147   KING_SIDE      = WHITE_OO  | BLACK_OO,
 148   QUEEN_SIDE     = WHITE_OOO | BLACK_OOO,
 149   WHITE_CASTLING = WHITE_OO  | WHITE_OOO,
 150   BLACK_CASTLING = BLACK_OO  | BLACK_OOO,
 151   ANY_CASTLING   = WHITE_CASTLING | BLACK_CASTLING,
 152
 153   CASTLING_RIGHT_NB = 16
 154 };
 155
 156 enum Phase {
 157   MG = 0, EG = 1, PHASE_NB = 2
 158 };
 159
 160 enum Bound {
 161   BOUND_NONE,
 162   BOUND_UPPER,
 163   BOUND_LOWER,
 164   BOUND_EXACT = BOUND_UPPER | BOUND_LOWER
 165 };
 166
 167 enum Value : int {
 168   VALUE_ZERO      = 0,
 169   VALUE_DRAW      = 0,
 170   VALUE_KNOWN_WIN = 10000,
 171   VALUE_MATE      = 32000,
 172   VALUE_INFINITE  = 32001,
 173   VALUE_NONE      = 32002,
 174
 175   VALUE_TB_WIN_IN_MAX_PLY  =  VALUE_MATE - 2 * MAX_PLY,
 176   VALUE_TB_LOSS_IN_MAX_PLY = -VALUE_TB_WIN_IN_MAX_PLY,
 177   VALUE_MATE_IN_MAX_PLY  =  VALUE_MATE - MAX_PLY,
 178   VALUE_MATED_IN_MAX_PLY = -VALUE_MATE_IN_MAX_PLY,
 179
 180   // In the code, we make the assumption that these values
 181   // are such that non_pawn_material() can be used to uniquely
 182   // identify the material on the board.
 183   PawnValueMg   = 126,   PawnValueEg   = 208,
 184   KnightValueMg = 781,   KnightValueEg = 854,
 185   BishopValueMg = 825,   BishopValueEg = 915,
 186   RookValueMg   = 1276,  RookValueEg   = 1380,
 187   QueenValueMg  = 2538,  QueenValueEg  = 2682,
 188 };
 189
 190 enum PieceType {
 191   NO_PIECE_TYPE, PAWN, KNIGHT, BISHOP, ROOK, QUEEN, KING,
 192   ALL_PIECES = 0,
 193   PIECE_TYPE_NB = 8
 194 };
 195
 196 enum Piece {
 197   NO_PIECE,
 198   W_PAWN = PAWN,     W_KNIGHT, W_BISHOP, W_ROOK, W_QUEEN, W_KING,
 199   B_PAWN = PAWN + 8, B_KNIGHT, B_BISHOP, B_ROOK, B_QUEEN, B_KING,
 200   PIECE_NB = 16
 201 };
 202
 203 constexpr Value PieceValue[PHASE_NB][PIECE_NB] = {
 204   { VALUE_ZERO, PawnValueMg, KnightValueMg, BishopValueMg, RookValueMg, QueenValueMg, VALUE_ZERO, VALUE_ZERO,
 205     VALUE_ZERO, PawnValueMg, KnightValueMg, BishopValueMg, RookValueMg, QueenValueMg, VALUE_ZERO, VALUE_ZERO },
 206   { VALUE_ZERO, PawnValueEg, KnightValueEg, BishopValueEg, RookValueEg, QueenValueEg, VALUE_ZERO, VALUE_ZERO,
 207     VALUE_ZERO, PawnValueEg, KnightValueEg, BishopValueEg, RookValueEg, QueenValueEg, VALUE_ZERO, VALUE_ZERO }
 208 };
 209
 210 using Depth = int;
 211
 212 enum : int {
 213   DEPTH_QS_CHECKS     =  0,
 214   DEPTH_QS_NO_CHECKS  = -1,
 215   DEPTH_QS_RECAPTURES = -5,
 216
 217   DEPTH_NONE   = -6,
 218
 219   DEPTH_OFFSET = -7 // value used only for TT entry occupancy check
 220 };
 221
 222 enum Square : int {
 223   SQ_A1, SQ_B1, SQ_C1, SQ_D1, SQ_E1, SQ_F1, SQ_G1, SQ_H1,
 224   SQ_A2, SQ_B2, SQ_C2, SQ_D2, SQ_E2, SQ_F2, SQ_G2, SQ_H2,
 225   SQ_A3, SQ_B3, SQ_C3, SQ_D3, SQ_E3, SQ_F3, SQ_G3, SQ_H3,
 226   SQ_A4, SQ_B4, SQ_C4, SQ_D4, SQ_E4, SQ_F4, SQ_G4, SQ_H4,
 227   SQ_A5, SQ_B5, SQ_C5, SQ_D5, SQ_E5, SQ_F5, SQ_G5, SQ_H5,
 228   SQ_A6, SQ_B6, SQ_C6, SQ_D6, SQ_E6, SQ_F6, SQ_G6, SQ_H6,
 229   SQ_A7, SQ_B7, SQ_C7, SQ_D7, SQ_E7, SQ_F7, SQ_G7, SQ_H7,
 230   SQ_A8, SQ_B8, SQ_C8, SQ_D8, SQ_E8, SQ_F8, SQ_G8, SQ_H8,
 231   SQ_NONE,
 232
 233   SQUARE_ZERO = 0,
 234   SQUARE_NB   = 64
 235 };
 236
 237 enum Direction : int {
 238   NORTH =  8,
 239   EAST  =  1,
 240   SOUTH = -NORTH,
 241   WEST  = -EAST,
 242
 243   NORTH_EAST = NORTH + EAST,
 244   SOUTH_EAST = SOUTH + EAST,
 245   SOUTH_WEST = SOUTH + WEST,
 246   NORTH_WEST = NORTH + WEST
 247 };
 248
 249 enum File : int {
 250   FILE_A, FILE_B, FILE_C, FILE_D, FILE_E, FILE_F, FILE_G, FILE_H, FILE_NB
 251 };
 252
 253 enum Rank : int {
 254   RANK_1, RANK_2, RANK_3, RANK_4, RANK_5, RANK_6, RANK_7, RANK_8, RANK_NB
 255 };
 256
 257 // Keep track of what a move changes on the board (used by NNUE)
 258 struct DirtyPiece {
 259
 260   // Number of changed pieces
 261   int dirty_num;
 262
 263   // Max 3 pieces can change in one move. A promotion with capture moves
 264   // both the pawn and the captured piece to SQ_NONE and the piece promoted
 265   // to from SQ_NONE to the capture square.
 266   Piece piece[3];
 267
 268   // From and to squares, which may be SQ_NONE
 269   Square from[3];
 270   Square to[3];
 271 };
 272
 273 #define ENABLE_BASE_OPERATORS_ON(T)                                \
 274 constexpr T operator+(T d1, int d2) { return T(int(d1) + d2); }    \
 275 constexpr T operator-(T d1, int d2) { return T(int(d1) - d2); }    \
 276 constexpr T operator-(T d) { return T(-int(d)); }                  \
 277 inline T& operator+=(T& d1, int d2) { return d1 = d1 + d2; }       \
 278 inline T& operator-=(T& d1, int d2) { return d1 = d1 - d2; }
 279
 280 #define ENABLE_INCR_OPERATORS_ON(T)                                \
 281 inline T& operator++(T& d) { return d = T(int(d) + 1); }           \
 282 inline T& operator--(T& d) { return d = T(int(d) - 1); }
 283
 284 #define ENABLE_FULL_OPERATORS_ON(T)                                \
 285 ENABLE_BASE_OPERATORS_ON(T)                                        \
 286 constexpr T operator*(int i, T d) { return T(i * int(d)); }        \
 287 constexpr T operator*(T d, int i) { return T(int(d) * i); }        \
 288 constexpr T operator/(T d, int i) { return T(int(d) / i); }        \
 289 constexpr int operator/(T d1, T d2) { return int(d1) / int(d2); }  \
 290 inline T& operator*=(T& d, int i) { return d = T(int(d) * i); }    \
 291 inline T& operator/=(T& d, int i) { return d = T(int(d) / i); }
 292
 293 ENABLE_FULL_OPERATORS_ON(Value)
 294 ENABLE_FULL_OPERATORS_ON(Direction)
 295
 296 ENABLE_INCR_OPERATORS_ON(PieceType)
 297 ENABLE_INCR_OPERATORS_ON(Square)
 298 ENABLE_INCR_OPERATORS_ON(File)
 299 ENABLE_INCR_OPERATORS_ON(Rank)
 300
 301 #undef ENABLE_FULL_OPERATORS_ON
 302 #undef ENABLE_INCR_OPERATORS_ON
 303 #undef ENABLE_BASE_OPERATORS_ON
 304
 305 /// Additional operators to add a Direction to a Square
 306 constexpr Square operator+(Square s, Direction d) { return Square(int(s) + int(d)); }
 307 constexpr Square operator-(Square s, Direction d) { return Square(int(s) - int(d)); }
 308 inline Square& operator+=(Square& s, Direction d) { return s = s + d; }
 309 inline Square& operator-=(Square& s, Direction d) { return s = s - d; }
 310
 311 constexpr Color operator~(Color c) {
 312   return Color(c ^ BLACK); // Toggle color
 313 }
 314
 315 constexpr Square flip_rank(Square s) { // Swap A1 <-> A8
 316   return Square(s ^ SQ_A8);
 317 }
 318
 319 constexpr Square flip_file(Square s) { // Swap A1 <-> H1
 320   return Square(s ^ SQ_H1);
 321 }
 322
 323 constexpr Piece operator~(Piece pc) {
 324   return Piece(pc ^ 8); // Swap color of piece B_KNIGHT <-> W_KNIGHT
 325 }
 326
 327 constexpr CastlingRights operator&(Color c, CastlingRights cr) {
 328   return CastlingRights((c == WHITE ? WHITE_CASTLING : BLACK_CASTLING) & cr);
 329 }
 330
 331 constexpr Value mate_in(int ply) {
 332   return VALUE_MATE - ply;
 333 }
 334
 335 constexpr Value mated_in(int ply) {
 336   return -VALUE_MATE + ply;
 337 }
 338
 339 constexpr Square make_square(File f, Rank r) {
 340   return Square((r << 3) + f);
 341 }
 342
 343 constexpr Piece make_piece(Color c, PieceType pt) {
 344   return Piece((c << 3) + pt);
 345 }
 346
 347 constexpr PieceType type_of(Piece pc) {
 348   return PieceType(pc & 7);
 349 }
 350
 351 inline Color color_of(Piece pc) {
 352   assert(pc != NO_PIECE);
 353   return Color(pc >> 3);
 354 }
 355
 356 constexpr bool is_ok(Move m) {
 357   return m != MOVE_NONE && m != MOVE_NULL;
 358 }
 359
 360 constexpr bool is_ok(Square s) {
 361   return s >= SQ_A1 && s <= SQ_H8;
 362 }
 363
 364 constexpr File file_of(Square s) {
 365   return File(s & 7);
 366 }
 367
 368 constexpr Rank rank_of(Square s) {
 369   return Rank(s >> 3);
 370 }
 371
 372 constexpr Square relative_square(Color c, Square s) {
 373   return Square(s ^ (c * 56));
 374 }
 375
 376 constexpr Rank relative_rank(Color c, Rank r) {
 377   return Rank(r ^ (c * 7));
 378 }
 379
 380 constexpr Rank relative_rank(Color c, Square s) {
 381   return relative_rank(c, rank_of(s));
 382 }
 383
 384 constexpr Direction pawn_push(Color c) {
 385   return c == WHITE ? NORTH : SOUTH;
 386 }
 387
 388 constexpr Square from_sq(Move m) {
 389   assert(is_ok(m));
 390   return Square((m >> 6) & 0x3F);
 391 }
 392
 393 constexpr Square to_sq(Move m) {
 394   assert(is_ok(m));
 395   return Square(m & 0x3F);
 396 }
 397
 398 constexpr int from_to(Move m) {
 399   return m & 0xFFF;
 400 }
 401
 402 constexpr MoveType type_of(Move m) {
 403   return MoveType(m & (3 << 14));
 404 }
 405
 406 constexpr PieceType promotion_type(Move m) {
 407   return PieceType(((m >> 12) & 3) + KNIGHT);
 408 }
 409
 410 constexpr Move make_move(Square from, Square to) {
 411   return Move((from << 6) + to);
 412 }
 413
 414 template<MoveType T>
 415 constexpr Move make(Square from, Square to, PieceType pt = KNIGHT) {
 416   return Move(T + ((pt - KNIGHT) << 12) + (from << 6) + to);
 417 }
 418
 419 /// Based on a congruential pseudo random number generator
 420 constexpr Key make_key(uint64_t seed) {
 421   return seed * 6364136223846793005ULL + 1442695040888963407ULL;
 422 }
 423
 424 } // namespace Stockfish
 425
 426 #endif // #ifndef TYPES_H_INCLUDED
 427
 428 #include "tune.h" // Global visibility to tuning setup