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_NONE     = 32002,
 168     VALUE_INFINITE = 32001,
 169
 170     VALUE_MATE             = 32000,
 171     VALUE_MATE_IN_MAX_PLY  = VALUE_MATE - MAX_PLY,
 172     VALUE_MATED_IN_MAX_PLY = -VALUE_MATE_IN_MAX_PLY,
 173
 174     VALUE_TB                 = VALUE_MATE_IN_MAX_PLY - 1,
 175     VALUE_TB_WIN_IN_MAX_PLY  = VALUE_TB - MAX_PLY,
 176     VALUE_TB_LOSS_IN_MAX_PLY = -VALUE_TB_WIN_IN_MAX_PLY,
 177
 178     // In the code, we make the assumption that these values
 179     // are such that non_pawn_material() can be used to uniquely
 180     // identify the material on the board.
 181     PawnValue   = 208,
 182     KnightValue = 781,
 183     BishopValue = 825,
 184     RookValue   = 1276,
 185     QueenValue  = 2538,
 186 };
 187
 188 // clang-format off
 189 enum PieceType {
 190     NO_PIECE_TYPE, PAWN, KNIGHT, BISHOP, ROOK, QUEEN, KING,
 191     ALL_PIECES = 0,
 192     PIECE_TYPE_NB = 8
 193 };
 194
 195 enum Piece {
 196     NO_PIECE,
 197     W_PAWN = PAWN,     W_KNIGHT, W_BISHOP, W_ROOK, W_QUEEN, W_KING,
 198     B_PAWN = PAWN + 8, B_KNIGHT, B_BISHOP, B_ROOK, B_QUEEN, B_KING,
 199     PIECE_NB = 16
 200 };
 201 // clang-format on
 202
 203 constexpr Value PieceValue[PIECE_NB] = {
 204   VALUE_ZERO, PawnValue, KnightValue, BishopValue, RookValue, QueenValue, VALUE_ZERO, VALUE_ZERO,
 205   VALUE_ZERO, PawnValue, KnightValue, BishopValue, RookValue, QueenValue, VALUE_ZERO, VALUE_ZERO};
 206
 207 using Depth = int;
 208
 209 enum : int {
 210     DEPTH_QS_CHECKS    = 0,
 211     DEPTH_QS_NO_CHECKS = -1,
 212
 213     DEPTH_NONE = -6,
 214
 215     DEPTH_OFFSET = -7  // value used only for TT entry occupancy check
 216 };
 217
 218 // clang-format off
 219 enum Square : int {
 220     SQ_A1, SQ_B1, SQ_C1, SQ_D1, SQ_E1, SQ_F1, SQ_G1, SQ_H1,
 221     SQ_A2, SQ_B2, SQ_C2, SQ_D2, SQ_E2, SQ_F2, SQ_G2, SQ_H2,
 222     SQ_A3, SQ_B3, SQ_C3, SQ_D3, SQ_E3, SQ_F3, SQ_G3, SQ_H3,
 223     SQ_A4, SQ_B4, SQ_C4, SQ_D4, SQ_E4, SQ_F4, SQ_G4, SQ_H4,
 224     SQ_A5, SQ_B5, SQ_C5, SQ_D5, SQ_E5, SQ_F5, SQ_G5, SQ_H5,
 225     SQ_A6, SQ_B6, SQ_C6, SQ_D6, SQ_E6, SQ_F6, SQ_G6, SQ_H6,
 226     SQ_A7, SQ_B7, SQ_C7, SQ_D7, SQ_E7, SQ_F7, SQ_G7, SQ_H7,
 227     SQ_A8, SQ_B8, SQ_C8, SQ_D8, SQ_E8, SQ_F8, SQ_G8, SQ_H8,
 228     SQ_NONE,
 229
 230     SQUARE_ZERO = 0,
 231     SQUARE_NB   = 64
 232 };
 233 // clang-format on
 234
 235 enum Direction : int {
 236     NORTH = 8,
 237     EAST  = 1,
 238     SOUTH = -NORTH,
 239     WEST  = -EAST,
 240
 241     NORTH_EAST = NORTH + EAST,
 242     SOUTH_EAST = SOUTH + EAST,
 243     SOUTH_WEST = SOUTH + WEST,
 244     NORTH_WEST = NORTH + WEST
 245 };
 246
 247 enum File : int {
 248     FILE_A,
 249     FILE_B,
 250     FILE_C,
 251     FILE_D,
 252     FILE_E,
 253     FILE_F,
 254     FILE_G,
 255     FILE_H,
 256     FILE_NB
 257 };
 258
 259 enum Rank : int {
 260     RANK_1,
 261     RANK_2,
 262     RANK_3,
 263     RANK_4,
 264     RANK_5,
 265     RANK_6,
 266     RANK_7,
 267     RANK_8,
 268     RANK_NB
 269 };
 270
 271 // Keep track of what a move changes on the board (used by NNUE)
 272 struct DirtyPiece {
 273
 274     // Number of changed pieces
 275     int dirty_num;
 276
 277     // Max 3 pieces can change in one move. A promotion with capture moves
 278     // both the pawn and the captured piece to SQ_NONE and the piece promoted
 279     // to from SQ_NONE to the capture square.
 280     Piece piece[3];
 281
 282     // From and to squares, which may be SQ_NONE
 283     Square from[3];
 284     Square to[3];
 285 };
 286
 287     #define ENABLE_BASE_OPERATORS_ON(T) \
 288         constexpr T operator+(T d1, int d2) { return T(int(d1) + d2); } \
 289         constexpr T operator-(T d1, int d2) { return T(int(d1) - d2); } \
 290         constexpr T operator-(T d) { return T(-int(d)); } \
 291         inline T&   operator+=(T& d1, int d2) { return d1 = d1 + d2; } \
 292         inline T&   operator-=(T& d1, int d2) { return d1 = d1 - d2; }
 293
 294     #define ENABLE_INCR_OPERATORS_ON(T) \
 295         inline T& operator++(T& d) { return d = T(int(d) + 1); } \
 296         inline T& operator--(T& d) { return d = T(int(d) - 1); }
 297
 298     #define ENABLE_FULL_OPERATORS_ON(T) \
 299         ENABLE_BASE_OPERATORS_ON(T) \
 300         constexpr T   operator*(int i, T d) { return T(i * int(d)); } \
 301         constexpr T   operator*(T d, int i) { return T(int(d) * i); } \
 302         constexpr T   operator/(T d, int i) { return T(int(d) / i); } \
 303         constexpr int operator/(T d1, T d2) { return int(d1) / int(d2); } \
 304         inline T&     operator*=(T& d, int i) { return d = T(int(d) * i); } \
 305         inline T&     operator/=(T& d, int i) { return d = T(int(d) / i); }
 306
 307 ENABLE_FULL_OPERATORS_ON(Value)
 308 ENABLE_FULL_OPERATORS_ON(Direction)
 309
 310 ENABLE_INCR_OPERATORS_ON(PieceType)
 311 ENABLE_INCR_OPERATORS_ON(Square)
 312 ENABLE_INCR_OPERATORS_ON(File)
 313 ENABLE_INCR_OPERATORS_ON(Rank)
 314
 315     #undef ENABLE_FULL_OPERATORS_ON
 316     #undef ENABLE_INCR_OPERATORS_ON
 317     #undef ENABLE_BASE_OPERATORS_ON
 318
 319 // Additional operators to add a Direction to a Square
 320 constexpr Square operator+(Square s, Direction d) { return Square(int(s) + int(d)); }
 321 constexpr Square operator-(Square s, Direction d) { return Square(int(s) - int(d)); }
 322 inline Square&   operator+=(Square& s, Direction d) { return s = s + d; }
 323 inline Square&   operator-=(Square& s, Direction d) { return s = s - d; }
 324
 325 // Toggle color
 326 constexpr Color operator~(Color c) { return Color(c ^ BLACK); }
 327
 328 // Swap A1 <-> A8
 329 constexpr Square flip_rank(Square s) { return Square(s ^ SQ_A8); }
 330
 331 // Swap A1 <-> H1
 332 constexpr Square flip_file(Square s) { return Square(s ^ SQ_H1); }
 333
 334 // Swap color of piece B_KNIGHT <-> W_KNIGHT
 335 constexpr Piece operator~(Piece pc) { return Piece(pc ^ 8); }
 336
 337 constexpr CastlingRights operator&(Color c, CastlingRights cr) {
 338     return CastlingRights((c == WHITE ? WHITE_CASTLING : BLACK_CASTLING) & cr);
 339 }
 340
 341 constexpr Value mate_in(int ply) { return VALUE_MATE - ply; }
 342
 343 constexpr Value mated_in(int ply) { return -VALUE_MATE + ply; }
 344
 345 constexpr Square make_square(File f, Rank r) { return Square((r << 3) + f); }
 346
 347 constexpr Piece make_piece(Color c, PieceType pt) { return Piece((c << 3) + pt); }
 348
 349 constexpr PieceType type_of(Piece pc) { return PieceType(pc & 7); }
 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) { return m != MOVE_NONE && m != MOVE_NULL; }
 357
 358 constexpr bool is_ok(Square s) { return s >= SQ_A1 && s <= SQ_H8; }
 359
 360 constexpr File file_of(Square s) { return File(s & 7); }
 361
 362 constexpr Rank rank_of(Square s) { return Rank(s >> 3); }
 363
 364 constexpr Square relative_square(Color c, Square s) { return Square(s ^ (c * 56)); }
 365
 366 constexpr Rank relative_rank(Color c, Rank r) { return Rank(r ^ (c * 7)); }
 367
 368 constexpr Rank relative_rank(Color c, Square s) { return relative_rank(c, rank_of(s)); }
 369
 370 constexpr Direction pawn_push(Color c) { return c == WHITE ? NORTH : SOUTH; }
 371
 372 constexpr Square from_sq(Move m) {
 373     assert(is_ok(m));
 374     return Square((m >> 6) & 0x3F);
 375 }
 376
 377 constexpr Square to_sq(Move m) {
 378     assert(is_ok(m));
 379     return Square(m & 0x3F);
 380 }
 381
 382 constexpr int from_to(Move m) { return m & 0xFFF; }
 383
 384 constexpr MoveType type_of(Move m) { return MoveType(m & (3 << 14)); }
 385
 386 constexpr PieceType promotion_type(Move m) { return PieceType(((m >> 12) & 3) + KNIGHT); }
 387
 388 constexpr Move make_move(Square from, Square to) { return Move((from << 6) + to); }
 389
 390 template<MoveType T>
 391 constexpr Move make(Square from, Square to, PieceType pt = KNIGHT) {
 392     return Move(T + ((pt - KNIGHT) << 12) + (from << 6) + to);
 393 }
 394
 395 // Based on a congruential pseudo-random number generator
 396 constexpr Key make_key(uint64_t seed) {
 397     return seed * 6364136223846793005ULL + 1442695040888963407ULL;
 398 }
 399
 400 }  // namespace Stockfish
 401
 402 #endif  // #ifndef TYPES_H_INCLUDED
 403
 404 #include "tune.h"  // Global visibility to tuning setup