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