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-2008 Tord Romstad (Glaurung author)
   4   Copyright (C) 2008-2015 Marco Costalba, Joona Kiiski, Tord Romstad
   5   Copyright (C) 2015-2018 Marco Costalba, Joona Kiiski, Gary Linscott, Tord Romstad
   6
   7   Stockfish is free software: you can redistribute it and/or modify
   8   it under the terms of the GNU General Public License as published by
   9   the Free Software Foundation, either version 3 of the License, or
  10   (at your option) any later version.
  11
  12   Stockfish is distributed in the hope that it will be useful,
  13   but WITHOUT ANY WARRANTY; without even the implied warranty of
  14   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15   GNU General Public License for more details.
  16
  17   You should have received a copy of the GNU General Public License
  18   along with this program.  If not, see <http://www.gnu.org/licenses/>.
  19 */
  20
  21 #ifndef TYPES_H_INCLUDED
  22 #define TYPES_H_INCLUDED
  23
  24 /// When compiling with provided Makefile (e.g. for Linux and OSX), configuration
  25 /// is done automatically. To get started type 'make help'.
  26 ///
  27 /// When Makefile is not used (e.g. with Microsoft Visual Studio) some switches
  28 /// need to be set manually:
  29 ///
  30 /// -DNDEBUG      | Disable debugging mode. Always use this for release.
  31 ///
  32 /// -DNO_PREFETCH | Disable use of prefetch asm-instruction. You may need this to
  33 ///               | run on some very old machines.
  34 ///
  35 /// -DUSE_POPCNT  | Add runtime support for use of popcnt asm-instruction. Works
  36 ///               | only in 64-bit mode and requires hardware with popcnt support.
  37 ///
  38 /// -DUSE_PEXT    | Add runtime support for use of pext asm-instruction. Works
  39 ///               | only in 64-bit mode and requires hardware with pext support.
  40
  41 #include <cassert>
  42 #include <cctype>
  43 #include <climits>
  44 #include <cstdint>
  45 #include <cstdlib>
  46
  47 #if defined(_MSC_VER)
  48 // Disable some silly and noisy warning from MSVC compiler
  49 #pragma warning(disable: 4127) // Conditional expression is constant
  50 #pragma warning(disable: 4146) // Unary minus operator applied to unsigned type
  51 #pragma warning(disable: 4800) // Forcing value to bool 'true' or 'false'
  52 #endif
  53
  54 /// Predefined macros hell:
  55 ///
  56 /// __GNUC__           Compiler is gcc, Clang or Intel on Linux
  57 /// __INTEL_COMPILER   Compiler is Intel
  58 /// _MSC_VER           Compiler is MSVC or Intel on Windows
  59 /// _WIN32             Building on Windows (any)
  60 /// _WIN64             Building on Windows 64 bit
  61
  62 #if defined(_WIN64) && defined(_MSC_VER) // No Makefile used
  63 #  include <intrin.h> // Microsoft header for _BitScanForward64()
  64 #  define IS_64BIT
  65 #endif
  66
  67 #if defined(USE_POPCNT) && (defined(__INTEL_COMPILER) || defined(_MSC_VER))
  68 #  include <nmmintrin.h> // Intel and Microsoft header for _mm_popcnt_u64()
  69 #endif
  70
  71 #if !defined(NO_PREFETCH) && (defined(__INTEL_COMPILER) || defined(_MSC_VER))
  72 #  include <xmmintrin.h> // Intel and Microsoft header for _mm_prefetch()
  73 #endif
  74
  75 #if defined(USE_PEXT)
  76 #  include <immintrin.h> // Header for _pext_u64() intrinsic
  77 #  define pext(b, m) _pext_u64(b, m)
  78 #else
  79 #  define pext(b, m) 0
  80 #endif
  81
  82 #ifdef USE_POPCNT
  83 constexpr bool HasPopCnt = true;
  84 #else
  85 constexpr bool HasPopCnt = false;
  86 #endif
  87
  88 #ifdef USE_PEXT
  89 constexpr bool HasPext = true;
  90 #else
  91 constexpr bool HasPext = false;
  92 #endif
  93
  94 #ifdef IS_64BIT
  95 constexpr bool Is64Bit = true;
  96 #else
  97 constexpr bool Is64Bit = false;
  98 #endif
  99
 100 typedef uint64_t Key;
 101 typedef uint64_t Bitboard;
 102
 103 constexpr int MAX_MOVES = 256;
 104 constexpr int MAX_PLY   = 128;
 105
 106 /// A move needs 16 bits to be stored
 107 ///
 108 /// bit  0- 5: destination square (from 0 to 63)
 109 /// bit  6-11: origin square (from 0 to 63)
 110 /// bit 12-13: promotion piece type - 2 (from KNIGHT-2 to QUEEN-2)
 111 /// bit 14-15: special move flag: promotion (1), en passant (2), castling (3)
 112 /// NOTE: EN-PASSANT bit is set only when a pawn can be captured
 113 ///
 114 /// Special cases are MOVE_NONE and MOVE_NULL. We can sneak these in because in
 115 /// any normal move destination square is always different from origin square
 116 /// while MOVE_NONE and MOVE_NULL have the same origin and destination square.
 117
 118 enum Move : int {
 119   MOVE_NONE,
 120   MOVE_NULL = 65
 121 };
 122
 123 enum MoveType {
 124   NORMAL,
 125   PROMOTION = 1 << 14,
 126   ENPASSANT = 2 << 14,
 127   CASTLING  = 3 << 14
 128 };
 129
 130 enum Color {
 131   WHITE, BLACK, COLOR_NB = 2
 132 };
 133
 134 enum CastlingSide {
 135   KING_SIDE, QUEEN_SIDE, CASTLING_SIDE_NB = 2
 136 };
 137
 138 enum CastlingRight {
 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   ANY_CASTLING = WHITE_OO | WHITE_OOO | BLACK_OO | BLACK_OOO,
 145   CASTLING_RIGHT_NB = 16
 146 };
 147
 148 template<Color C, CastlingSide S> struct MakeCastling {
 149   static constexpr CastlingRight
 150   right = C == WHITE ? S == QUEEN_SIDE ? WHITE_OOO : WHITE_OO
 151                      : S == QUEEN_SIDE ? BLACK_OOO : BLACK_OO;
 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_MATE_IN_MAX_PLY  =  VALUE_MATE - 2 * MAX_PLY,
 183   VALUE_MATED_IN_MAX_PLY = -VALUE_MATE + 2 * MAX_PLY,
 184
 185   PawnValueMg   = 171,   PawnValueEg   = 240,
 186   KnightValueMg = 764,   KnightValueEg = 848,
 187   BishopValueMg = 826,   BishopValueEg = 891,
 188   RookValueMg   = 1282,  RookValueEg   = 1373,
 189   QueenValueMg  = 2500,  QueenValueEg  = 2670,
 190
 191   MidgameLimit  = 15258, EndgameLimit  = 3915
 192 };
 193
 194 enum PieceType {
 195   NO_PIECE_TYPE, PAWN, KNIGHT, BISHOP, ROOK, QUEEN, KING,
 196   ALL_PIECES = 0,
 197   PIECE_TYPE_NB = 8
 198 };
 199
 200 enum Piece {
 201   NO_PIECE,
 202   W_PAWN = 1, W_KNIGHT, W_BISHOP, W_ROOK, W_QUEEN, W_KING,
 203   B_PAWN = 9, B_KNIGHT, B_BISHOP, B_ROOK, B_QUEEN, B_KING,
 204   PIECE_NB = 16
 205 };
 206
 207 extern Value PieceValue[PHASE_NB][PIECE_NB];
 208
 209 enum Depth : int {
 210
 211   ONE_PLY = 1,
 212
 213   DEPTH_ZERO          =  0 * ONE_PLY,
 214   DEPTH_QS_CHECKS     =  0 * ONE_PLY,
 215   DEPTH_QS_NO_CHECKS  = -1 * ONE_PLY,
 216   DEPTH_QS_RECAPTURES = -5 * ONE_PLY,
 217
 218   DEPTH_NONE = -6 * ONE_PLY,
 219   DEPTH_MAX  = MAX_PLY * ONE_PLY
 220 };
 221
 222 static_assert(!(ONE_PLY & (ONE_PLY - 1)), "ONE_PLY is not a power of 2");
 223
 224 enum Square : int {
 225   SQ_A1, SQ_B1, SQ_C1, SQ_D1, SQ_E1, SQ_F1, SQ_G1, SQ_H1,
 226   SQ_A2, SQ_B2, SQ_C2, SQ_D2, SQ_E2, SQ_F2, SQ_G2, SQ_H2,
 227   SQ_A3, SQ_B3, SQ_C3, SQ_D3, SQ_E3, SQ_F3, SQ_G3, SQ_H3,
 228   SQ_A4, SQ_B4, SQ_C4, SQ_D4, SQ_E4, SQ_F4, SQ_G4, SQ_H4,
 229   SQ_A5, SQ_B5, SQ_C5, SQ_D5, SQ_E5, SQ_F5, SQ_G5, SQ_H5,
 230   SQ_A6, SQ_B6, SQ_C6, SQ_D6, SQ_E6, SQ_F6, SQ_G6, SQ_H6,
 231   SQ_A7, SQ_B7, SQ_C7, SQ_D7, SQ_E7, SQ_F7, SQ_G7, SQ_H7,
 232   SQ_A8, SQ_B8, SQ_C8, SQ_D8, SQ_E8, SQ_F8, SQ_G8, SQ_H8,
 233   SQ_NONE,
 234
 235   SQUARE_NB = 64
 236 };
 237
 238 enum Direction : int {
 239   NORTH =  8,
 240   EAST  =  1,
 241   SOUTH = -NORTH,
 242   WEST  = -EAST,
 243
 244   NORTH_EAST = NORTH + EAST,
 245   SOUTH_EAST = SOUTH + EAST,
 246   SOUTH_WEST = SOUTH + WEST,
 247   NORTH_WEST = NORTH + WEST
 248 };
 249
 250 enum File : int {
 251   FILE_A, FILE_B, FILE_C, FILE_D, FILE_E, FILE_F, FILE_G, FILE_H, FILE_NB
 252 };
 253
 254 enum Rank : int {
 255   RANK_1, RANK_2, RANK_3, RANK_4, RANK_5, RANK_6, RANK_7, RANK_8, RANK_NB
 256 };
 257
 258
 259 /// Score enum stores a middlegame and an endgame value in a single integer (enum).
 260 /// The least significant 16 bits are used to store the middlegame value and the
 261 /// upper 16 bits are used to store the endgame value. We have to take care to
 262 /// avoid left-shifting a signed int to avoid undefined behavior.
 263 enum Score : int { SCORE_ZERO };
 264
 265 constexpr Score make_score(int mg, int eg) {
 266   return Score((int)((unsigned int)eg << 16) + mg);
 267 }
 268
 269 /// Extracting the signed lower and upper 16 bits is not so trivial because
 270 /// according to the standard a simple cast to short is implementation defined
 271 /// and so is a right shift of a signed integer.
 272 inline Value eg_value(Score s) {
 273   union { uint16_t u; int16_t s; } eg = { uint16_t(unsigned(s + 0x8000) >> 16) };
 274   return Value(eg.s);
 275 }
 276
 277 inline Value mg_value(Score s) {
 278   union { uint16_t u; int16_t s; } mg = { uint16_t(unsigned(s)) };
 279   return Value(mg.s);
 280 }
 281
 282 #define ENABLE_BASE_OPERATORS_ON(T)                                \
 283 constexpr T operator+(T d1, T d2) { return T(int(d1) + int(d2)); } \
 284 constexpr T operator-(T d1, T d2) { return T(int(d1) - int(d2)); } \
 285 constexpr T operator-(T d) { return T(-int(d)); }                  \
 286 inline T& operator+=(T& d1, T d2) { return d1 = d1 + d2; }         \
 287 inline T& operator-=(T& d1, T d2) { return d1 = d1 - d2; }
 288
 289 #define ENABLE_INCR_OPERATORS_ON(T)                                \
 290 inline T& operator++(T& d) { return d = T(int(d) + 1); }           \
 291 inline T& operator--(T& d) { return d = T(int(d) - 1); }
 292
 293 #define ENABLE_FULL_OPERATORS_ON(T)                                \
 294 ENABLE_BASE_OPERATORS_ON(T)                                        \
 295 ENABLE_INCR_OPERATORS_ON(T)                                        \
 296 constexpr T operator*(int i, T d) { return T(i * int(d)); }        \
 297 constexpr T operator*(T d, int i) { return T(int(d) * i); }        \
 298 constexpr T operator/(T d, int i) { return T(int(d) / i); }        \
 299 constexpr int operator/(T d1, T d2) { return int(d1) / int(d2); }  \
 300 inline T& operator*=(T& d, int i) { return d = T(int(d) * i); }    \
 301 inline T& operator/=(T& d, int i) { return d = T(int(d) / i); }
 302
 303 ENABLE_FULL_OPERATORS_ON(Value)
 304 ENABLE_FULL_OPERATORS_ON(Depth)
 305 ENABLE_FULL_OPERATORS_ON(Direction)
 306
 307 ENABLE_INCR_OPERATORS_ON(PieceType)
 308 ENABLE_INCR_OPERATORS_ON(Piece)
 309 ENABLE_INCR_OPERATORS_ON(Color)
 310 ENABLE_INCR_OPERATORS_ON(Square)
 311 ENABLE_INCR_OPERATORS_ON(File)
 312 ENABLE_INCR_OPERATORS_ON(Rank)
 313
 314 ENABLE_BASE_OPERATORS_ON(Score)
 315
 316 #undef ENABLE_FULL_OPERATORS_ON
 317 #undef ENABLE_INCR_OPERATORS_ON
 318 #undef ENABLE_BASE_OPERATORS_ON
 319
 320 /// Additional operators to add integers to a Value
 321 constexpr Value operator+(Value v, int i) { return Value(int(v) + i); }
 322 constexpr Value operator-(Value v, int i) { return Value(int(v) - i); }
 323 inline Value& operator+=(Value& v, int i) { return v = v + i; }
 324 inline Value& operator-=(Value& v, int i) { return v = v - i; }
 325
 326 /// Additional operators to add a Direction to a Square
 327 constexpr Square operator+(Square s, Direction d) { return Square(int(s) + int(d)); }
 328 constexpr Square operator-(Square s, Direction d) { return Square(int(s) - int(d)); }
 329 inline Square& operator+=(Square& s, Direction d) { return s = s + d; }
 330 inline Square& operator-=(Square& s, Direction d) { return s = s - d; }
 331
 332 /// Only declared but not defined. We don't want to multiply two scores due to
 333 /// a very high risk of overflow. So user should explicitly convert to integer.
 334 Score operator*(Score, Score) = delete;
 335
 336 /// Division of a Score must be handled separately for each term
 337 inline Score operator/(Score s, int i) {
 338   return make_score(mg_value(s) / i, eg_value(s) / i);
 339 }
 340
 341 /// Multiplication of a Score by an integer. We check for overflow in debug mode.
 342 inline Score operator*(Score s, int i) {
 343
 344   Score result = Score(int(s) * i);
 345
 346   assert(eg_value(result) == (i * eg_value(s)));
 347   assert(mg_value(result) == (i * mg_value(s)));
 348   assert((i == 0) || (result / i) == s);
 349
 350   return result;
 351 }
 352
 353 constexpr Color operator~(Color c) {
 354   return Color(c ^ BLACK); // Toggle color
 355 }
 356
 357 constexpr Square operator~(Square s) {
 358   return Square(s ^ SQ_A8); // Vertical flip SQ_A1 -> SQ_A8
 359 }
 360
 361 constexpr File operator~(File f) {
 362   return File(f ^ FILE_H); // Horizontal flip FILE_A -> FILE_H
 363 }
 364
 365 constexpr Piece operator~(Piece pc) {
 366   return Piece(pc ^ 8); // Swap color of piece B_KNIGHT -> W_KNIGHT
 367 }
 368
 369 constexpr CastlingRight operator|(Color c, CastlingSide s) {
 370   return CastlingRight(WHITE_OO << ((s == QUEEN_SIDE) + 2 * c));
 371 }
 372
 373 constexpr Value mate_in(int ply) {
 374   return VALUE_MATE - ply;
 375 }
 376
 377 constexpr Value mated_in(int ply) {
 378   return -VALUE_MATE + ply;
 379 }
 380
 381 constexpr Square make_square(File f, Rank r) {
 382   return Square((r << 3) + f);
 383 }
 384
 385 constexpr Piece make_piece(Color c, PieceType pt) {
 386   return Piece((c << 3) + pt);
 387 }
 388
 389 constexpr PieceType type_of(Piece pc) {
 390   return PieceType(pc & 7);
 391 }
 392
 393 inline Color color_of(Piece pc) {
 394   assert(pc != NO_PIECE);
 395   return Color(pc >> 3);
 396 }
 397
 398 constexpr bool is_ok(Square s) {
 399   return s >= SQ_A1 && s <= SQ_H8;
 400 }
 401
 402 constexpr File file_of(Square s) {
 403   return File(s & 7);
 404 }
 405
 406 constexpr Rank rank_of(Square s) {
 407   return Rank(s >> 3);
 408 }
 409
 410 constexpr Square relative_square(Color c, Square s) {
 411   return Square(s ^ (c * 56));
 412 }
 413
 414 constexpr Rank relative_rank(Color c, Rank r) {
 415   return Rank(r ^ (c * 7));
 416 }
 417
 418 constexpr Rank relative_rank(Color c, Square s) {
 419   return relative_rank(c, rank_of(s));
 420 }
 421
 422 inline bool opposite_colors(Square s1, Square s2) {
 423   int s = int(s1) ^ int(s2);
 424   return ((s >> 3) ^ s) & 1;
 425 }
 426
 427 constexpr Direction pawn_push(Color c) {
 428   return c == WHITE ? NORTH : SOUTH;
 429 }
 430
 431 constexpr Square from_sq(Move m) {
 432   return Square((m >> 6) & 0x3F);
 433 }
 434
 435 constexpr Square to_sq(Move m) {
 436   return Square(m & 0x3F);
 437 }
 438
 439 constexpr int from_to(Move m) {
 440  return m & 0xFFF;
 441 }
 442
 443 constexpr MoveType type_of(Move m) {
 444   return MoveType(m & (3 << 14));
 445 }
 446
 447 constexpr PieceType promotion_type(Move m) {
 448   return PieceType(((m >> 12) & 3) + KNIGHT);
 449 }
 450
 451 constexpr Move make_move(Square from, Square to) {
 452   return Move((from << 6) + to);
 453 }
 454
 455 template<MoveType T>
 456 constexpr Move make(Square from, Square to, PieceType pt = KNIGHT) {
 457   return Move(T + ((pt - KNIGHT) << 12) + (from << 6) + to);
 458 }
 459
 460 constexpr bool is_ok(Move m) {
 461   return from_sq(m) != to_sq(m); // Catch MOVE_NULL and MOVE_NONE
 462 }
 463
 464 #endif // #ifndef TYPES_H_INCLUDED