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-2014 Marco Costalba, Joona Kiiski, Tord Romstad
   5
   6   Stockfish is free software: you can redistribute it and/or modify
   7   it under the terms of the GNU General Public License as published by
   8   the Free Software Foundation, either version 3 of the License, or
   9   (at your option) any later version.
  10
  11   Stockfish is distributed in the hope that it will be useful,
  12   but WITHOUT ANY WARRANTY; without even the implied warranty of
  13   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14   GNU General Public License for more details.
  15
  16   You should have received a copy of the GNU General Public License
  17   along with this program.  If not, see <http://www.gnu.org/licenses/>.
  18 */
  19
  20 #ifndef TYPES_H_INCLUDED
  21 #define TYPES_H_INCLUDED
  22
  23 /// For Linux and OSX configuration is done automatically using Makefile. To get
  24 /// started type 'make help'.
  25 ///
  26 /// For Windows, part of the configuration is detected automatically, but some
  27 /// switches need to be set manually:
  28 ///
  29 /// -DNDEBUG      | Disable debugging mode. Always use this.
  30 ///
  31 /// -DNO_PREFETCH | Disable use of prefetch asm-instruction. A must if you want
  32 ///               | the executable to run on some very old machines.
  33 ///
  34 /// -DUSE_POPCNT  | Add runtime support for use of popcnt asm-instruction. Works
  35 ///               | only in 64-bit mode. For compiling requires hardware with
  36 ///               | popcnt support.
  37
  38 #include <cassert>
  39 #include <cctype>
  40 #include <climits>
  41 #include <cstdlib>
  42
  43 #include "platform.h"
  44
  45 #define unlikely(x) (x) // For code annotation purposes
  46
  47 #if defined(_WIN64) && !defined(IS_64BIT)
  48 #  include <intrin.h> // MSVC popcnt and bsfq instrinsics
  49 #  define IS_64BIT
  50 #  define USE_BSFQ
  51 #endif
  52
  53 #if defined(USE_POPCNT) && defined(_MSC_VER) && defined(__INTEL_COMPILER)
  54 #  include <nmmintrin.h> // Intel header for _mm_popcnt_u64() intrinsic
  55 #endif
  56
  57 #if defined(USE_PEXT)
  58 #  include <immintrin.h> // Header for _pext_u64() intrinsic
  59 #else
  60 #  define _pext_u64(b, m) (0)
  61 #endif
  62
  63 #  if !defined(NO_PREFETCH) && (defined(__INTEL_COMPILER) || defined(_MSC_VER))
  64 #   include <xmmintrin.h> // Intel and Microsoft header for _mm_prefetch()
  65 #  endif
  66
  67 #define CACHE_LINE_SIZE 64
  68 #if defined(_MSC_VER) || defined(__INTEL_COMPILER)
  69 #  define CACHE_LINE_ALIGNMENT __declspec(align(CACHE_LINE_SIZE))
  70 #else
  71 #  define CACHE_LINE_ALIGNMENT  __attribute__ ((aligned(CACHE_LINE_SIZE)))
  72 #endif
  73
  74 #ifdef _MSC_VER
  75 #  define FORCE_INLINE  __forceinline
  76 #elif defined(__GNUC__)
  77 #  define FORCE_INLINE  inline __attribute__((always_inline))
  78 #else
  79 #  define FORCE_INLINE  inline
  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        = 120;
 105 const int MAX_PLY_PLUS_6 = MAX_PLY + 6;
 106
 107 /// A move needs 16 bits to be stored
 108 ///
 109 /// bit  0- 5: destination square (from 0 to 63)
 110 /// bit  6-11: origin square (from 0 to 63)
 111 /// bit 12-13: promotion piece type - 2 (from KNIGHT-2 to QUEEN-2)
 112 /// bit 14-15: special move flag: promotion (1), en passant (2), castling (3)
 113 /// NOTE: EN-PASSANT bit is set only when a pawn can be captured
 114 ///
 115 /// Special cases are MOVE_NONE and MOVE_NULL. We can sneak these in because in
 116 /// any normal move destination square is always different from origin square
 117 /// while MOVE_NONE and MOVE_NULL have the same origin and destination square.
 118
 119 enum Move {
 120   MOVE_NONE,
 121   MOVE_NULL = 65
 122 };
 123
 124 enum MoveType {
 125   NORMAL,
 126   PROMOTION = 1 << 14,
 127   ENPASSANT = 2 << 14,
 128   CASTLING  = 3 << 14
 129 };
 130
 131 enum Color {
 132   WHITE, BLACK, NO_COLOR, COLOR_NB = 2
 133 };
 134
 135 enum CastlingSide {
 136   KING_SIDE, QUEEN_SIDE, CASTLING_SIDE_NB = 2
 137 };
 138
 139 enum CastlingRight {
 140   NO_CASTLING,
 141   WHITE_OO,
 142   WHITE_OOO   = WHITE_OO << 1,
 143   BLACK_OO    = WHITE_OO << 2,
 144   BLACK_OOO   = WHITE_OO << 3,
 145   ANY_CASTLING = WHITE_OO | WHITE_OOO | BLACK_OO | BLACK_OOO,
 146   CASTLING_RIGHT_NB = 16
 147 };
 148
 149 template<Color C, CastlingSide S> struct MakeCastling {
 150   static const CastlingRight
 151   right = C == WHITE ? S == QUEEN_SIDE ? WHITE_OOO : WHITE_OO
 152                      : S == QUEEN_SIDE ? BLACK_OOO : BLACK_OO;
 153 };
 154
 155 enum Phase {
 156   PHASE_ENDGAME,
 157   PHASE_MIDGAME = 128,
 158   MG = 0, EG = 1, PHASE_NB = 2
 159 };
 160
 161 enum ScaleFactor {
 162   SCALE_FACTOR_DRAW    = 0,
 163   SCALE_FACTOR_ONEPAWN = 48,
 164   SCALE_FACTOR_NORMAL  = 64,
 165   SCALE_FACTOR_MAX     = 128,
 166   SCALE_FACTOR_NONE    = 255
 167 };
 168
 169 enum Bound {
 170   BOUND_NONE,
 171   BOUND_UPPER,
 172   BOUND_LOWER,
 173   BOUND_EXACT = BOUND_UPPER | BOUND_LOWER
 174 };
 175
 176 enum Value {
 177   VALUE_ZERO      = 0,
 178   VALUE_DRAW      = 0,
 179   VALUE_KNOWN_WIN = 10000,
 180   VALUE_MATE      = 32000,
 181   VALUE_INFINITE  = 32001,
 182   VALUE_NONE      = 32002,
 183
 184   VALUE_MATE_IN_MAX_PLY  =  VALUE_MATE - MAX_PLY,
 185   VALUE_MATED_IN_MAX_PLY = -VALUE_MATE + MAX_PLY,
 186
 187   VALUE_ENSURE_INTEGER_SIZE_P = INT_MAX,
 188   VALUE_ENSURE_INTEGER_SIZE_N = INT_MIN,
 189
 190   PawnValueMg   = 198,   PawnValueEg   = 258,
 191   KnightValueMg = 817,   KnightValueEg = 846,
 192   BishopValueMg = 836,   BishopValueEg = 857,
 193   RookValueMg   = 1270,  RookValueEg   = 1278,
 194   QueenValueMg  = 2521,  QueenValueEg  = 2558,
 195
 196   MidgameLimit  = 15581, EndgameLimit  = 3998
 197 };
 198
 199 enum PieceType {
 200   NO_PIECE_TYPE, PAWN, KNIGHT, BISHOP, ROOK, QUEEN, KING,
 201   ALL_PIECES = 0,
 202   PIECE_TYPE_NB = 8
 203 };
 204
 205 enum Piece {
 206   NO_PIECE,
 207   W_PAWN = 1, W_KNIGHT, W_BISHOP, W_ROOK, W_QUEEN, W_KING,
 208   B_PAWN = 9, B_KNIGHT, B_BISHOP, B_ROOK, B_QUEEN, B_KING,
 209   PIECE_NB = 16
 210 };
 211
 212 enum Depth {
 213
 214   ONE_PLY = 2,
 215
 216   DEPTH_ZERO          =  0 * ONE_PLY,
 217   DEPTH_QS_CHECKS     =  0 * ONE_PLY,
 218   DEPTH_QS_NO_CHECKS  = -1 * ONE_PLY,
 219   DEPTH_QS_RECAPTURES = -5 * ONE_PLY,
 220
 221   DEPTH_NONE = -6 * ONE_PLY
 222 };
 223
 224 enum Square {
 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   DELTA_N =  8,
 238   DELTA_E =  1,
 239   DELTA_S = -8,
 240   DELTA_W = -1,
 241
 242   DELTA_NN = DELTA_N + DELTA_N,
 243   DELTA_NE = DELTA_N + DELTA_E,
 244   DELTA_SE = DELTA_S + DELTA_E,
 245   DELTA_SS = DELTA_S + DELTA_S,
 246   DELTA_SW = DELTA_S + DELTA_W,
 247   DELTA_NW = DELTA_N + DELTA_W
 248 };
 249
 250 enum File {
 251   FILE_A, FILE_B, FILE_C, FILE_D, FILE_E, FILE_F, FILE_G, FILE_H, FILE_NB
 252 };
 253
 254 enum Rank {
 255   RANK_1, RANK_2, RANK_3, RANK_4, RANK_5, RANK_6, RANK_7, RANK_8, RANK_NB
 256 };
 257
 258
 259 /// The Score enum stores a middlegame and an endgame value in a single integer
 260 /// (enum). The least significant 16 bits are used to store the endgame value
 261 /// and the upper 16 bits are used to store the middlegame value. The compiler
 262 /// is free to choose the enum type as long as it can store the data, so we
 263 /// ensure that Score is an integer type by assigning some big int values.
 264 enum Score {
 265   SCORE_ZERO,
 266   SCORE_ENSURE_INTEGER_SIZE_P = INT_MAX,
 267   SCORE_ENSURE_INTEGER_SIZE_N = INT_MIN
 268 };
 269
 270 inline Score make_score(int mg, int eg) { return Score((mg << 16) + eg); }
 271
 272 /// Extracting the signed lower and upper 16 bits is not so trivial because
 273 /// according to the standard a simple cast to short is implementation defined
 274 /// and so is a right shift of a signed integer.
 275 inline Value mg_value(Score s) {
 276   return Value(((s + 0x8000) & ~0xffff) / 0x10000);
 277 }
 278
 279 inline Value eg_value(Score s) {
 280   return Value((int)(unsigned(s) & 0x7FFFU) - (int)(unsigned(s) & 0x8000U));
 281 }
 282
 283 #define ENABLE_BASE_OPERATORS_ON(T)                                         \
 284 inline T operator+(const T d1, const T d2) { return T(int(d1) + int(d2)); } \
 285 inline T operator-(const T d1, const T d2) { return T(int(d1) - int(d2)); } \
 286 inline T operator*(int i, const T d) { return T(i * int(d)); }              \
 287 inline T operator*(const T d, int i) { return T(int(d) * i); }              \
 288 inline T operator-(const T d) { return T(-int(d)); }                        \
 289 inline T& operator+=(T& d1, const T d2) { return d1 = d1 + d2; }            \
 290 inline T& operator-=(T& d1, const T d2) { return d1 = d1 - d2; }            \
 291 inline T& operator*=(T& d, int i) { return d = T(int(d) * i); }
 292
 293 ENABLE_BASE_OPERATORS_ON(Score)
 294
 295 #define ENABLE_FULL_OPERATORS_ON(T)                                         \
 296 ENABLE_BASE_OPERATORS_ON(T)                                                 \
 297 inline T& operator++(T& d) { return d = T(int(d) + 1); }                    \
 298 inline T& operator--(T& d) { return d = T(int(d) - 1); }                    \
 299 inline T operator/(const T d, int i) { return T(int(d) / i); }              \
 300 inline T& operator/=(T& d, int i) { return d = T(int(d) / i); }
 301
 302 ENABLE_FULL_OPERATORS_ON(Value)
 303 ENABLE_FULL_OPERATORS_ON(PieceType)
 304 ENABLE_FULL_OPERATORS_ON(Piece)
 305 ENABLE_FULL_OPERATORS_ON(Color)
 306 ENABLE_FULL_OPERATORS_ON(Depth)
 307 ENABLE_FULL_OPERATORS_ON(Square)
 308 ENABLE_FULL_OPERATORS_ON(File)
 309 ENABLE_FULL_OPERATORS_ON(Rank)
 310
 311 #undef ENABLE_FULL_OPERATORS_ON
 312 #undef ENABLE_BASE_OPERATORS_ON
 313
 314 /// Additional operators to add integers to a Value
 315 inline Value operator+(Value v, int i) { return Value(int(v) + i); }
 316 inline Value operator-(Value v, int i) { return Value(int(v) - i); }
 317 inline Value& operator+=(Value& v, int i) { return v = v + i; }
 318 inline Value& operator-=(Value& v, int i) { return v = v - i; }
 319
 320 /// Only declared but not defined. We don't want to multiply two scores due to
 321 /// a very high risk of overflow. So user should explicitly convert to integer.
 322 inline Score operator*(Score s1, Score s2);
 323
 324 /// Division of a Score must be handled separately for each term
 325 inline Score operator/(Score s, int i) {
 326   return make_score(mg_value(s) / i, eg_value(s) / i);
 327 }
 328
 329 CACHE_LINE_ALIGNMENT
 330
 331 extern Value PieceValue[PHASE_NB][PIECE_NB];
 332
 333 struct ExtMove {
 334   Move move;
 335   Value value;
 336 };
 337
 338 inline bool operator<(const ExtMove& f, const ExtMove& s) {
 339   return f.value < s.value;
 340 }
 341
 342 inline Color operator~(Color c) {
 343   return Color(c ^ BLACK);
 344 }
 345
 346 inline Square operator~(Square s) {
 347   return Square(s ^ SQ_A8); // Vertical flip SQ_A1 -> SQ_A8
 348 }
 349
 350 inline CastlingRight operator|(Color c, CastlingSide s) {
 351   return CastlingRight(WHITE_OO << ((s == QUEEN_SIDE) + 2 * c));
 352 }
 353
 354 inline Value mate_in(int ply) {
 355   return VALUE_MATE - ply;
 356 }
 357
 358 inline Value mated_in(int ply) {
 359   return -VALUE_MATE + ply;
 360 }
 361
 362 inline Square make_square(File f, Rank r) {
 363   return Square((r << 3) | f);
 364 }
 365
 366 inline Piece make_piece(Color c, PieceType pt) {
 367   return Piece((c << 3) | pt);
 368 }
 369
 370 inline PieceType type_of(Piece pc)  {
 371   return PieceType(pc & 7);
 372 }
 373
 374 inline Color color_of(Piece pc) {
 375   assert(pc != NO_PIECE);
 376   return Color(pc >> 3);
 377 }
 378
 379 inline bool is_ok(Square s) {
 380   return s >= SQ_A1 && s <= SQ_H8;
 381 }
 382
 383 inline File file_of(Square s) {
 384   return File(s & 7);
 385 }
 386
 387 inline Rank rank_of(Square s) {
 388   return Rank(s >> 3);
 389 }
 390
 391 inline Square relative_square(Color c, Square s) {
 392   return Square(s ^ (c * 56));
 393 }
 394
 395 inline Rank relative_rank(Color c, Rank r) {
 396   return Rank(r ^ (c * 7));
 397 }
 398
 399 inline Rank relative_rank(Color c, Square s) {
 400   return relative_rank(c, rank_of(s));
 401 }
 402
 403 inline bool opposite_colors(Square s1, Square s2) {
 404   int s = int(s1) ^ int(s2);
 405   return ((s >> 3) ^ s) & 1;
 406 }
 407
 408 inline char to_char(File f, bool tolower = true) {
 409   return char(f - FILE_A + (tolower ? 'a' : 'A'));
 410 }
 411
 412 inline char to_char(Rank r) {
 413   return char(r - RANK_1 + '1');
 414 }
 415
 416 inline Square pawn_push(Color c) {
 417   return c == WHITE ? DELTA_N : DELTA_S;
 418 }
 419
 420 inline Square from_sq(Move m) {
 421   return Square((m >> 6) & 0x3F);
 422 }
 423
 424 inline Square to_sq(Move m) {
 425   return Square(m & 0x3F);
 426 }
 427
 428 inline MoveType type_of(Move m) {
 429   return MoveType(m & (3 << 14));
 430 }
 431
 432 inline PieceType promotion_type(Move m) {
 433   return PieceType(((m >> 12) & 3) + 2);
 434 }
 435
 436 inline Move make_move(Square from, Square to) {
 437   return Move(to | (from << 6));
 438 }
 439
 440 template<MoveType T>
 441 inline Move make(Square from, Square to, PieceType pt = KNIGHT) {
 442   return Move(to | (from << 6) | T | ((pt - KNIGHT) << 12));
 443 }
 444
 445 inline bool is_ok(Move m) {
 446   return from_sq(m) != to_sq(m); // Catches also MOVE_NULL and MOVE_NONE
 447 }
 448
 449 #include <string>
 450
 451 inline const std::string to_string(Square s) {
 452   char ch[] = { to_char(file_of(s)), to_char(rank_of(s)), 0 };
 453   return ch;
 454 }
 455
 456 #endif // #ifndef TYPES_H_INCLUDED