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 <cstdint>
  41
  42 #if defined(_MSC_VER)
  43 // Disable some silly and noisy warning from MSVC compiler
  44 #pragma warning(disable: 4127) // Conditional expression is constant
  45 #pragma warning(disable: 4146) // Unary minus operator applied to unsigned type
  46 #pragma warning(disable: 4800) // Forcing value to bool 'true' or 'false'
  47 #endif
  48
  49 /// Predefined macros hell:
  50 ///
  51 /// __GNUC__                Compiler is GCC, Clang or ICX
  52 /// __clang__               Compiler is Clang or ICX
  53 /// __INTEL_LLVM_COMPILER   Compiler is ICX
  54 /// _MSC_VER                Compiler is MSVC
  55 /// _WIN32                  Building on Windows (any)
  56 /// _WIN64                  Building on Windows 64 bit
  57
  58 #if defined(__GNUC__ ) && (__GNUC__ < 9 || (__GNUC__ == 9 && __GNUC_MINOR__ <= 2)) && defined(_WIN32) && !defined(__clang__)
  59 #define ALIGNAS_ON_STACK_VARIABLES_BROKEN
  60 #endif
  61
  62 #define ASSERT_ALIGNED(ptr, alignment) assert(reinterpret_cast<uintptr_t>(ptr) % alignment == 0)
  63
  64 #if defined(_WIN64) && defined(_MSC_VER) // No Makefile used
  65 #  include <intrin.h> // Microsoft header for _BitScanForward64()
  66 #  define IS_64BIT
  67 #endif
  68
  69 #if defined(USE_POPCNT) && defined(_MSC_VER)
  70 #  include <nmmintrin.h> // Microsoft header for _mm_popcnt_u64()
  71 #endif
  72
  73 #if !defined(NO_PREFETCH) && defined(_MSC_VER)
  74 #  include <xmmintrin.h> // Microsoft header for _mm_prefetch()
  75 #endif
  76
  77 #if defined(USE_PEXT)
  78 #  include <immintrin.h> // Header for _pext_u64() intrinsic
  79 #  define pext(b, m) _pext_u64(b, m)
  80 #else
  81 #  define pext(b, m) 0
  82 #endif
  83
  84 namespace Stockfish {
  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 using Key = uint64_t;
 105 using Bitboard = uint64_t;
 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   EN_PASSANT = 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 Bound {
 155   BOUND_NONE,
 156   BOUND_UPPER,
 157   BOUND_LOWER,
 158   BOUND_EXACT = BOUND_UPPER | BOUND_LOWER
 159 };
 160
 161 enum Value : int {
 162   VALUE_ZERO      = 0,
 163   VALUE_DRAW      = 0,
 164   VALUE_MATE      = 32000,
 165   VALUE_INFINITE  = 32001,
 166   VALUE_NONE      = 32002,
 167
 168   VALUE_TB_WIN_IN_MAX_PLY  =  VALUE_MATE - 2 * MAX_PLY,
 169   VALUE_TB_LOSS_IN_MAX_PLY = -VALUE_TB_WIN_IN_MAX_PLY,
 170   VALUE_MATE_IN_MAX_PLY  =  VALUE_MATE - MAX_PLY,
 171   VALUE_MATED_IN_MAX_PLY = -VALUE_MATE_IN_MAX_PLY,
 172
 173   // In the code, we make the assumption that these values
 174   // are such that non_pawn_material() can be used to uniquely
 175   // identify the material on the board.
 176   PawnValue   = 208,
 177   KnightValue = 781,
 178   BishopValue = 825,
 179   RookValue   = 1276,
 180   QueenValue  = 2538,
 181 };
 182
 183 enum PieceType {
 184   NO_PIECE_TYPE, PAWN, KNIGHT, BISHOP, ROOK, QUEEN, KING,
 185   ALL_PIECES = 0,
 186   PIECE_TYPE_NB = 8
 187 };
 188
 189 enum Piece {
 190   NO_PIECE,
 191   W_PAWN = PAWN,     W_KNIGHT, W_BISHOP, W_ROOK, W_QUEEN, W_KING,
 192   B_PAWN = PAWN + 8, B_KNIGHT, B_BISHOP, B_ROOK, B_QUEEN, B_KING,
 193   PIECE_NB = 16
 194 };
 195
 196 constexpr Value PieceValue[PIECE_NB] = { VALUE_ZERO, PawnValue, KnightValue, BishopValue, RookValue, QueenValue, VALUE_ZERO, VALUE_ZERO,
 197                                          VALUE_ZERO, PawnValue, KnightValue, BishopValue, RookValue, QueenValue, VALUE_ZERO, VALUE_ZERO };
 198
 199 using Depth = int;
 200
 201 enum : int {
 202   DEPTH_QS_CHECKS     =  0,
 203   DEPTH_QS_NO_CHECKS  = -1,
 204   DEPTH_QS_RECAPTURES = -5,
 205
 206   DEPTH_NONE   = -6,
 207
 208   DEPTH_OFFSET = -7 // value used only for TT entry occupancy check
 209 };
 210
 211 enum Square : int {
 212   SQ_A1, SQ_B1, SQ_C1, SQ_D1, SQ_E1, SQ_F1, SQ_G1, SQ_H1,
 213   SQ_A2, SQ_B2, SQ_C2, SQ_D2, SQ_E2, SQ_F2, SQ_G2, SQ_H2,
 214   SQ_A3, SQ_B3, SQ_C3, SQ_D3, SQ_E3, SQ_F3, SQ_G3, SQ_H3,
 215   SQ_A4, SQ_B4, SQ_C4, SQ_D4, SQ_E4, SQ_F4, SQ_G4, SQ_H4,
 216   SQ_A5, SQ_B5, SQ_C5, SQ_D5, SQ_E5, SQ_F5, SQ_G5, SQ_H5,
 217   SQ_A6, SQ_B6, SQ_C6, SQ_D6, SQ_E6, SQ_F6, SQ_G6, SQ_H6,
 218   SQ_A7, SQ_B7, SQ_C7, SQ_D7, SQ_E7, SQ_F7, SQ_G7, SQ_H7,
 219   SQ_A8, SQ_B8, SQ_C8, SQ_D8, SQ_E8, SQ_F8, SQ_G8, SQ_H8,
 220   SQ_NONE,
 221
 222   SQUARE_ZERO = 0,
 223   SQUARE_NB   = 64
 224 };
 225
 226 enum Direction : int {
 227   NORTH =  8,
 228   EAST  =  1,
 229   SOUTH = -NORTH,
 230   WEST  = -EAST,
 231
 232   NORTH_EAST = NORTH + EAST,
 233   SOUTH_EAST = SOUTH + EAST,
 234   SOUTH_WEST = SOUTH + WEST,
 235   NORTH_WEST = NORTH + WEST
 236 };
 237
 238 enum File : int {
 239   FILE_A, FILE_B, FILE_C, FILE_D, FILE_E, FILE_F, FILE_G, FILE_H, FILE_NB
 240 };
 241
 242 enum Rank : int {
 243   RANK_1, RANK_2, RANK_3, RANK_4, RANK_5, RANK_6, RANK_7, RANK_8, RANK_NB
 244 };
 245
 246 // Keep track of what a move changes on the board (used by NNUE)
 247 struct DirtyPiece {
 248
 249   // Number of changed pieces
 250   int dirty_num;
 251
 252   // Max 3 pieces can change in one move. A promotion with capture moves
 253   // both the pawn and the captured piece to SQ_NONE and the piece promoted
 254   // to from SQ_NONE to the capture square.
 255   Piece piece[3];
 256
 257   // From and to squares, which may be SQ_NONE
 258   Square from[3];
 259   Square to[3];
 260 };
 261
 262 #define ENABLE_BASE_OPERATORS_ON(T)                                \
 263 constexpr T operator+(T d1, int d2) { return T(int(d1) + d2); }    \
 264 constexpr T operator-(T d1, int d2) { return T(int(d1) - d2); }    \
 265 constexpr T operator-(T d) { return T(-int(d)); }                  \
 266 inline T& operator+=(T& d1, int d2) { return d1 = d1 + d2; }       \
 267 inline T& operator-=(T& d1, int d2) { return d1 = d1 - d2; }
 268
 269 #define ENABLE_INCR_OPERATORS_ON(T)                                \
 270 inline T& operator++(T& d) { return d = T(int(d) + 1); }           \
 271 inline T& operator--(T& d) { return d = T(int(d) - 1); }
 272
 273 #define ENABLE_FULL_OPERATORS_ON(T)                                \
 274 ENABLE_BASE_OPERATORS_ON(T)                                        \
 275 constexpr T operator*(int i, T d) { return T(i * int(d)); }        \
 276 constexpr T operator*(T d, int i) { return T(int(d) * i); }        \
 277 constexpr T operator/(T d, int i) { return T(int(d) / i); }        \
 278 constexpr int operator/(T d1, T d2) { return int(d1) / int(d2); }  \
 279 inline T& operator*=(T& d, int i) { return d = T(int(d) * i); }    \
 280 inline T& operator/=(T& d, int i) { return d = T(int(d) / i); }
 281
 282 ENABLE_FULL_OPERATORS_ON(Value)
 283 ENABLE_FULL_OPERATORS_ON(Direction)
 284
 285 ENABLE_INCR_OPERATORS_ON(PieceType)
 286 ENABLE_INCR_OPERATORS_ON(Square)
 287 ENABLE_INCR_OPERATORS_ON(File)
 288 ENABLE_INCR_OPERATORS_ON(Rank)
 289
 290 #undef ENABLE_FULL_OPERATORS_ON
 291 #undef ENABLE_INCR_OPERATORS_ON
 292 #undef ENABLE_BASE_OPERATORS_ON
 293
 294 /// Additional operators to add a Direction to a Square
 295 constexpr Square operator+(Square s, Direction d) { return Square(int(s) + int(d)); }
 296 constexpr Square operator-(Square s, Direction d) { return Square(int(s) - int(d)); }
 297 inline Square& operator+=(Square& s, Direction d) { return s = s + d; }
 298 inline Square& operator-=(Square& s, Direction d) { return s = s - d; }
 299
 300 constexpr Color operator~(Color c) {
 301   return Color(c ^ BLACK); // Toggle color
 302 }
 303
 304 constexpr Square flip_rank(Square s) { // Swap A1 <-> A8
 305   return Square(s ^ SQ_A8);
 306 }
 307
 308 constexpr Square flip_file(Square s) { // Swap A1 <-> H1
 309   return Square(s ^ SQ_H1);
 310 }
 311
 312 constexpr Piece operator~(Piece pc) {
 313   return Piece(pc ^ 8); // Swap color of piece B_KNIGHT <-> W_KNIGHT
 314 }
 315
 316 constexpr CastlingRights operator&(Color c, CastlingRights cr) {
 317   return CastlingRights((c == WHITE ? WHITE_CASTLING : BLACK_CASTLING) & cr);
 318 }
 319
 320 constexpr Value mate_in(int ply) {
 321   return VALUE_MATE - ply;
 322 }
 323
 324 constexpr Value mated_in(int ply) {
 325   return -VALUE_MATE + ply;
 326 }
 327
 328 constexpr Square make_square(File f, Rank r) {
 329   return Square((r << 3) + f);
 330 }
 331
 332 constexpr Piece make_piece(Color c, PieceType pt) {
 333   return Piece((c << 3) + pt);
 334 }
 335
 336 constexpr PieceType type_of(Piece pc) {
 337   return PieceType(pc & 7);
 338 }
 339
 340 inline Color color_of(Piece pc) {
 341   assert(pc != NO_PIECE);
 342   return Color(pc >> 3);
 343 }
 344
 345 constexpr bool is_ok(Move m) {
 346   return m != MOVE_NONE && m != MOVE_NULL;
 347 }
 348
 349 constexpr bool is_ok(Square s) {
 350   return s >= SQ_A1 && s <= SQ_H8;
 351 }
 352
 353 constexpr File file_of(Square s) {
 354   return File(s & 7);
 355 }
 356
 357 constexpr Rank rank_of(Square s) {
 358   return Rank(s >> 3);
 359 }
 360
 361 constexpr Square relative_square(Color c, Square s) {
 362   return Square(s ^ (c * 56));
 363 }
 364
 365 constexpr Rank relative_rank(Color c, Rank r) {
 366   return Rank(r ^ (c * 7));
 367 }
 368
 369 constexpr Rank relative_rank(Color c, Square s) {
 370   return relative_rank(c, rank_of(s));
 371 }
 372
 373 constexpr Direction pawn_push(Color c) {
 374   return c == WHITE ? NORTH : SOUTH;
 375 }
 376
 377 constexpr Square from_sq(Move m) {
 378   assert(is_ok(m));
 379   return Square((m >> 6) & 0x3F);
 380 }
 381
 382 constexpr Square to_sq(Move m) {
 383   assert(is_ok(m));
 384   return Square(m & 0x3F);
 385 }
 386
 387 constexpr int from_to(Move m) {
 388   return m & 0xFFF;
 389 }
 390
 391 constexpr MoveType type_of(Move m) {
 392   return MoveType(m & (3 << 14));
 393 }
 394
 395 constexpr PieceType promotion_type(Move m) {
 396   return PieceType(((m >> 12) & 3) + KNIGHT);
 397 }
 398
 399 constexpr Move make_move(Square from, Square to) {
 400   return Move((from << 6) + to);
 401 }
 402
 403 template<MoveType T>
 404 constexpr Move make(Square from, Square to, PieceType pt = KNIGHT) {
 405   return Move(T + ((pt - KNIGHT) << 12) + (from << 6) + to);
 406 }
 407
 408 /// Based on a congruential pseudo random number generator
 409 constexpr Key make_key(uint64_t seed) {
 410   return seed * 6364136223846793005ULL + 1442695040888963407ULL;
 411 }
 412
 413 } // namespace Stockfish
 414
 415 #endif // #ifndef TYPES_H_INCLUDED
 416
 417 #include "tune.h" // Global visibility to tuning setup