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-2016 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 const bool HasPopCnt = true;
  84 #else
  85 const bool HasPopCnt = false;
  86 #endif
  87
  88 #ifdef USE_PEXT
  89 const bool HasPext = true;
  90 #else
  91 const bool HasPext = false;
  92 #endif
  93
  94 #ifdef IS_64BIT
  95 const bool Is64Bit = true;
  96 #else
  97 const bool Is64Bit = false;
  98 #endif
  99
 100 typedef uint64_t Key;
 101 typedef uint64_t Bitboard;
 102
 103 const int MAX_MOVES = 256;
 104 const 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 {
 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, NO_COLOR, 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 const 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_ONEPAWN = 48,
 163   SCALE_FACTOR_NORMAL  = 64,
 164   SCALE_FACTOR_MAX     = 128,
 165   SCALE_FACTOR_NONE    = 255
 166 };
 167
 168 enum Bound {
 169   BOUND_NONE,
 170   BOUND_UPPER,
 171   BOUND_LOWER,
 172   BOUND_EXACT = BOUND_UPPER | BOUND_LOWER
 173 };
 174
 175 enum Value : int {
 176   VALUE_ZERO      = 0,
 177   VALUE_DRAW      = 0,
 178   VALUE_KNOWN_WIN = 10000,
 179   VALUE_MATE      = 32000,
 180   VALUE_INFINITE  = 32001,
 181   VALUE_NONE      = 32002,
 182
 183   VALUE_MATE_IN_MAX_PLY  =  VALUE_MATE - 2 * MAX_PLY,
 184   VALUE_MATED_IN_MAX_PLY = -VALUE_MATE + 2 * MAX_PLY,
 185
 186   PawnValueMg   = 198,   PawnValueEg   = 258,
 187   KnightValueMg = 817,   KnightValueEg = 896,
 188   BishopValueMg = 836,   BishopValueEg = 907,
 189   RookValueMg   = 1270,  RookValueEg   = 1356,
 190   QueenValueMg  = 2521,  QueenValueEg  = 2658,
 191
 192   MidgameLimit  = 15581, EndgameLimit  = 3998
 193 };
 194
 195 enum PieceType {
 196   NO_PIECE_TYPE, PAWN, KNIGHT, BISHOP, ROOK, QUEEN, KING,
 197   ALL_PIECES = 0,
 198   PIECE_TYPE_NB = 8
 199 };
 200
 201 enum Piece {
 202   NO_PIECE,
 203   W_PAWN = 1, W_KNIGHT, W_BISHOP, W_ROOK, W_QUEEN, W_KING,
 204   B_PAWN = 9, B_KNIGHT, B_BISHOP, B_ROOK, B_QUEEN, B_KING,
 205   PIECE_NB = 16
 206 };
 207
 208 enum Depth {
 209
 210   ONE_PLY = 1,
 211
 212   DEPTH_ZERO          =  0,
 213   DEPTH_QS_CHECKS     =  0,
 214   DEPTH_QS_NO_CHECKS  = -1,
 215   DEPTH_QS_RECAPTURES = -5,
 216
 217   DEPTH_NONE = -6,
 218   DEPTH_MAX  = MAX_PLY
 219 };
 220
 221 enum Square {
 222   SQ_A1, SQ_B1, SQ_C1, SQ_D1, SQ_E1, SQ_F1, SQ_G1, SQ_H1,
 223   SQ_A2, SQ_B2, SQ_C2, SQ_D2, SQ_E2, SQ_F2, SQ_G2, SQ_H2,
 224   SQ_A3, SQ_B3, SQ_C3, SQ_D3, SQ_E3, SQ_F3, SQ_G3, SQ_H3,
 225   SQ_A4, SQ_B4, SQ_C4, SQ_D4, SQ_E4, SQ_F4, SQ_G4, SQ_H4,
 226   SQ_A5, SQ_B5, SQ_C5, SQ_D5, SQ_E5, SQ_F5, SQ_G5, SQ_H5,
 227   SQ_A6, SQ_B6, SQ_C6, SQ_D6, SQ_E6, SQ_F6, SQ_G6, SQ_H6,
 228   SQ_A7, SQ_B7, SQ_C7, SQ_D7, SQ_E7, SQ_F7, SQ_G7, SQ_H7,
 229   SQ_A8, SQ_B8, SQ_C8, SQ_D8, SQ_E8, SQ_F8, SQ_G8, SQ_H8,
 230   SQ_NONE,
 231
 232   SQUARE_NB = 64,
 233
 234   DELTA_N =  8,
 235   DELTA_E =  1,
 236   DELTA_S = -8,
 237   DELTA_W = -1,
 238
 239   DELTA_NN = DELTA_N + DELTA_N,
 240   DELTA_NE = DELTA_N + DELTA_E,
 241   DELTA_SE = DELTA_S + DELTA_E,
 242   DELTA_SS = DELTA_S + DELTA_S,
 243   DELTA_SW = DELTA_S + DELTA_W,
 244   DELTA_NW = DELTA_N + DELTA_W
 245 };
 246
 247 enum File {
 248   FILE_A, FILE_B, FILE_C, FILE_D, FILE_E, FILE_F, FILE_G, FILE_H, FILE_NB
 249 };
 250
 251 enum Rank {
 252   RANK_1, RANK_2, RANK_3, RANK_4, RANK_5, RANK_6, RANK_7, RANK_8, RANK_NB
 253 };
 254
 255
 256 /// Score enum stores a middlegame and an endgame value in a single integer
 257 /// (enum). The least significant 16 bits are used to store the endgame value
 258 /// and the upper 16 bits are used to store the middlegame value.
 259 enum Score : int { SCORE_ZERO };
 260
 261 inline Score make_score(int mg, int eg) {
 262   return Score((mg << 16) + eg);
 263 }
 264
 265 /// Extracting the signed lower and upper 16 bits is not so trivial because
 266 /// according to the standard a simple cast to short is implementation defined
 267 /// and so is a right shift of a signed integer.
 268 inline Value mg_value(Score s) {
 269
 270   union { uint16_t u; int16_t s; } mg = { uint16_t(unsigned(s + 0x8000) >> 16) };
 271   return Value(mg.s);
 272 }
 273
 274 inline Value eg_value(Score s) {
 275
 276   union { uint16_t u; int16_t s; } eg = { uint16_t(unsigned(s)) };
 277   return Value(eg.s);
 278 }
 279
 280 #define ENABLE_BASE_OPERATORS_ON(T)                             \
 281 inline T operator+(T d1, T d2) { return T(int(d1) + int(d2)); } \
 282 inline T operator-(T d1, T d2) { return T(int(d1) - int(d2)); } \
 283 inline T operator*(int i, T d) { return T(i * int(d)); }        \
 284 inline T operator*(T d, int i) { return T(int(d) * i); }        \
 285 inline 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 inline T& operator*=(T& d, int i) { return d = T(int(d) * i); }
 289
 290 #define ENABLE_FULL_OPERATORS_ON(T)                             \
 291 ENABLE_BASE_OPERATORS_ON(T)                                     \
 292 inline T& operator++(T& d) { return d = T(int(d) + 1); }        \
 293 inline T& operator--(T& d) { return d = T(int(d) - 1); }        \
 294 inline T operator/(T d, int i) { return T(int(d) / i); }        \
 295 inline int operator/(T d1, T d2) { return int(d1) / int(d2); }  \
 296 inline T& operator/=(T& d, int i) { return d = T(int(d) / i); }
 297
 298 ENABLE_FULL_OPERATORS_ON(Value)
 299 ENABLE_FULL_OPERATORS_ON(PieceType)
 300 ENABLE_FULL_OPERATORS_ON(Piece)
 301 ENABLE_FULL_OPERATORS_ON(Color)
 302 ENABLE_FULL_OPERATORS_ON(Depth)
 303 ENABLE_FULL_OPERATORS_ON(Square)
 304 ENABLE_FULL_OPERATORS_ON(File)
 305 ENABLE_FULL_OPERATORS_ON(Rank)
 306
 307 ENABLE_BASE_OPERATORS_ON(Score)
 308
 309 #undef ENABLE_FULL_OPERATORS_ON
 310 #undef ENABLE_BASE_OPERATORS_ON
 311
 312 /// Additional operators to add integers to a Value
 313 inline Value operator+(Value v, int i) { return Value(int(v) + i); }
 314 inline Value operator-(Value v, int i) { return Value(int(v) - i); }
 315 inline Value& operator+=(Value& v, int i) { return v = v + i; }
 316 inline Value& operator-=(Value& v, int i) { return v = v - i; }
 317
 318 /// Only declared but not defined. We don't want to multiply two scores due to
 319 /// a very high risk of overflow. So user should explicitly convert to integer.
 320 inline Score operator*(Score s1, Score s2);
 321
 322 /// Division of a Score must be handled separately for each term
 323 inline Score operator/(Score s, int i) {
 324   return make_score(mg_value(s) / i, eg_value(s) / i);
 325 }
 326
 327 extern Value PieceValue[PHASE_NB][PIECE_NB];
 328
 329 inline Color operator~(Color c) {
 330   return Color(c ^ BLACK);
 331 }
 332
 333 inline Square operator~(Square s) {
 334   return Square(s ^ SQ_A8); // Vertical flip SQ_A1 -> SQ_A8
 335 }
 336
 337 inline CastlingRight operator|(Color c, CastlingSide s) {
 338   return CastlingRight(WHITE_OO << ((s == QUEEN_SIDE) + 2 * c));
 339 }
 340
 341 inline Value mate_in(int ply) {
 342   return VALUE_MATE - ply;
 343 }
 344
 345 inline Value mated_in(int ply) {
 346   return -VALUE_MATE + ply;
 347 }
 348
 349 inline Square make_square(File f, Rank r) {
 350   return Square((r << 3) | f);
 351 }
 352
 353 inline Piece make_piece(Color c, PieceType pt) {
 354   return Piece((c << 3) | pt);
 355 }
 356
 357 inline PieceType type_of(Piece pc) {
 358   return PieceType(pc & 7);
 359 }
 360
 361 inline Color color_of(Piece pc) {
 362   assert(pc != NO_PIECE);
 363   return Color(pc >> 3);
 364 }
 365
 366 inline bool is_ok(Square s) {
 367   return s >= SQ_A1 && s <= SQ_H8;
 368 }
 369
 370 inline File file_of(Square s) {
 371   return File(s & 7);
 372 }
 373
 374 inline Rank rank_of(Square s) {
 375   return Rank(s >> 3);
 376 }
 377
 378 inline Square relative_square(Color c, Square s) {
 379   return Square(s ^ (c * 56));
 380 }
 381
 382 inline Rank relative_rank(Color c, Rank r) {
 383   return Rank(r ^ (c * 7));
 384 }
 385
 386 inline Rank relative_rank(Color c, Square s) {
 387   return relative_rank(c, rank_of(s));
 388 }
 389
 390 inline bool opposite_colors(Square s1, Square s2) {
 391   int s = int(s1) ^ int(s2);
 392   return ((s >> 3) ^ s) & 1;
 393 }
 394
 395 inline Square pawn_push(Color c) {
 396   return c == WHITE ? DELTA_N : DELTA_S;
 397 }
 398
 399 inline Square from_sq(Move m) {
 400   return Square((m >> 6) & 0x3F);
 401 }
 402
 403 inline Square to_sq(Move m) {
 404   return Square(m & 0x3F);
 405 }
 406
 407 inline MoveType type_of(Move m) {
 408   return MoveType(m & (3 << 14));
 409 }
 410
 411 inline PieceType promotion_type(Move m) {
 412   return PieceType(((m >> 12) & 3) + KNIGHT);
 413 }
 414
 415 inline Move make_move(Square from, Square to) {
 416   return Move(to | (from << 6));
 417 }
 418
 419 template<MoveType T>
 420 inline Move make(Square from, Square to, PieceType pt = KNIGHT) {
 421   return Move(to | (from << 6) | T | ((pt - KNIGHT) << 12));
 422 }
 423
 424 inline bool is_ok(Move m) {
 425   return from_sq(m) != to_sq(m); // Catch MOVE_NULL and MOVE_NONE
 426 }
 427
 428 #endif // #ifndef TYPES_H_INCLUDED