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-2012 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 #if !defined(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. Use always.
  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 <cctype>
  39 #include <climits>
  40 #include <cstdlib>
  41
  42 #include "platform.h"
  43
  44 #if defined(_WIN64) && !defined(IS_64BIT)
  45 #  include <intrin.h> // MSVC popcnt and bsfq instrinsics
  46 #  define IS_64BIT
  47 #  define USE_BSFQ
  48 #endif
  49
  50 #if defined(USE_POPCNT) && defined(_MSC_VER) && defined(__INTEL_COMPILER)
  51 #  include <nmmintrin.h> // Intel header for _mm_popcnt_u64() intrinsic
  52 #endif
  53
  54 #  if !defined(NO_PREFETCH) && (defined(__INTEL_COMPILER) || defined(_MSC_VER))
  55 #   include <xmmintrin.h> // Intel and Microsoft header for _mm_prefetch()
  56 #  endif
  57
  58 #if defined(_MSC_VER) || defined(__INTEL_COMPILER)
  59 #  define CACHE_LINE_ALIGNMENT __declspec(align(64))
  60 #else
  61 #  define CACHE_LINE_ALIGNMENT  __attribute__ ((aligned(64)))
  62 #endif
  63
  64 #if defined(_MSC_VER)
  65 #  define FORCE_INLINE  __forceinline
  66 #elif defined(__GNUC__)
  67 #  define FORCE_INLINE  inline __attribute__((always_inline))
  68 #else
  69 #  define FORCE_INLINE  inline
  70 #endif
  71
  72 #if defined(USE_POPCNT)
  73 const bool HasPopCnt = true;
  74 #else
  75 const bool HasPopCnt = false;
  76 #endif
  77
  78 #if defined(IS_64BIT)
  79 const bool Is64Bit = true;
  80 #else
  81 const bool Is64Bit = false;
  82 #endif
  83
  84 typedef uint64_t Key;
  85 typedef uint64_t Bitboard;
  86
  87 const int MAX_MOVES      = 192;
  88 const int MAX_PLY        = 100;
  89 const int MAX_PLY_PLUS_2 = MAX_PLY + 2;
  90
  91 const Bitboard FileABB = 0x0101010101010101ULL;
  92 const Bitboard FileBBB = FileABB << 1;
  93 const Bitboard FileCBB = FileABB << 2;
  94 const Bitboard FileDBB = FileABB << 3;
  95 const Bitboard FileEBB = FileABB << 4;
  96 const Bitboard FileFBB = FileABB << 5;
  97 const Bitboard FileGBB = FileABB << 6;
  98 const Bitboard FileHBB = FileABB << 7;
  99
 100 const Bitboard Rank1BB = 0xFF;
 101 const Bitboard Rank2BB = Rank1BB << (8 * 1);
 102 const Bitboard Rank3BB = Rank1BB << (8 * 2);
 103 const Bitboard Rank4BB = Rank1BB << (8 * 3);
 104 const Bitboard Rank5BB = Rank1BB << (8 * 4);
 105 const Bitboard Rank6BB = Rank1BB << (8 * 5);
 106 const Bitboard Rank7BB = Rank1BB << (8 * 6);
 107 const Bitboard Rank8BB = Rank1BB << (8 * 7);
 108
 109
 110 /// A move needs 16 bits to be stored
 111 ///
 112 /// bit  0- 5: destination square (from 0 to 63)
 113 /// bit  6-11: origin square (from 0 to 63)
 114 /// bit 12-13: promotion piece type - 2 (from KNIGHT-2 to QUEEN-2)
 115 /// bit 14-15: special move flag: promotion (1), en passant (2), castle (3)
 116 ///
 117 /// Special cases are MOVE_NONE and MOVE_NULL. We can sneak these in because in
 118 /// any normal move destination square is always different from origin square
 119 /// while MOVE_NONE and MOVE_NULL have the same origin and destination square.
 120
 121 enum Move {
 122   MOVE_NONE = 0,
 123   MOVE_NULL = 65
 124 };
 125
 126 enum MoveType {
 127   NORMAL    = 0,
 128   PROMOTION = 1 << 14,
 129   ENPASSANT = 2 << 14,
 130   CASTLE    = 3 << 14
 131 };
 132
 133 enum CastleRight {  // Defined as in PolyGlot book hash key
 134   CASTLES_NONE = 0,
 135   WHITE_OO     = 1,
 136   WHITE_OOO    = 2,
 137   BLACK_OO     = 4,
 138   BLACK_OOO    = 8,
 139   ALL_CASTLES  = 15,
 140   CASTLE_RIGHT_NB = 16
 141 };
 142
 143 enum CastlingSide {
 144   KING_SIDE,
 145   QUEEN_SIDE,
 146   CASTLING_SIDE_NB = 2
 147 };
 148
 149 enum Phase {
 150   PHASE_ENDGAME = 0,
 151   PHASE_MIDGAME = 128,
 152   MG = 0, EG = 1, PHASE_NB = 2
 153 };
 154
 155 enum ScaleFactor {
 156   SCALE_FACTOR_DRAW   = 0,
 157   SCALE_FACTOR_NORMAL = 64,
 158   SCALE_FACTOR_MAX    = 128,
 159   SCALE_FACTOR_NONE   = 255
 160 };
 161
 162 enum Bound {
 163   BOUND_NONE  = 0,
 164   BOUND_UPPER = 1,
 165   BOUND_LOWER = 2,
 166   BOUND_EXACT = BOUND_UPPER | BOUND_LOWER
 167 };
 168
 169 enum Value {
 170   VALUE_ZERO      = 0,
 171   VALUE_DRAW      = 0,
 172   VALUE_KNOWN_WIN = 15000,
 173   VALUE_MATE      = 30000,
 174   VALUE_INFINITE  = 30001,
 175   VALUE_NONE      = 30002,
 176
 177   VALUE_MATE_IN_MAX_PLY  =  VALUE_MATE - MAX_PLY,
 178   VALUE_MATED_IN_MAX_PLY = -VALUE_MATE + MAX_PLY,
 179
 180   VALUE_ENSURE_INTEGER_SIZE_P = INT_MAX,
 181   VALUE_ENSURE_INTEGER_SIZE_N = INT_MIN,
 182
 183   PawnValueMg   = 198,   PawnValueEg   = 258,
 184   KnightValueMg = 817,   KnightValueEg = 846,
 185   BishopValueMg = 836,   BishopValueEg = 857,
 186   RookValueMg   = 1270,  RookValueEg   = 1278,
 187   QueenValueMg  = 2521,  QueenValueEg  = 2558
 188 };
 189
 190 enum PieceType {
 191   NO_PIECE_TYPE = 0, ALL_PIECES = 0,
 192   PAWN = 1, KNIGHT = 2, BISHOP = 3, ROOK = 4, QUEEN = 5, KING = 6,
 193   PIECE_TYPE_NB = 8
 194 };
 195
 196 enum Piece {
 197   NO_PIECE = 0,
 198   W_PAWN = 1, W_KNIGHT =  2, W_BISHOP =  3, W_ROOK =  4, W_QUEEN =  5, W_KING =  6,
 199   B_PAWN = 9, B_KNIGHT = 10, B_BISHOP = 11, B_ROOK = 12, B_QUEEN = 13, B_KING = 14,
 200   PIECE_NB = 16
 201 };
 202
 203 enum Color {
 204   WHITE, BLACK, NO_COLOR, COLOR_NB = 2
 205 };
 206
 207 enum Depth {
 208
 209   ONE_PLY = 2,
 210
 211   DEPTH_ZERO          =  0 * ONE_PLY,
 212   DEPTH_QS_CHECKS     = -1 * ONE_PLY,
 213   DEPTH_QS_NO_CHECKS  = -2 * ONE_PLY,
 214   DEPTH_QS_RECAPTURES = -5 * ONE_PLY,
 215
 216   DEPTH_NONE = -127 * ONE_PLY
 217 };
 218
 219 enum Square {
 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_NB = 64,
 231
 232   DELTA_N =  8,
 233   DELTA_E =  1,
 234   DELTA_S = -8,
 235   DELTA_W = -1,
 236
 237   DELTA_NN = DELTA_N + DELTA_N,
 238   DELTA_NE = DELTA_N + DELTA_E,
 239   DELTA_SE = DELTA_S + DELTA_E,
 240   DELTA_SS = DELTA_S + DELTA_S,
 241   DELTA_SW = DELTA_S + DELTA_W,
 242   DELTA_NW = DELTA_N + DELTA_W
 243 };
 244
 245 enum File {
 246   FILE_A, FILE_B, FILE_C, FILE_D, FILE_E, FILE_F, FILE_G, FILE_H, FILE_NB = 8
 247 };
 248
 249 enum Rank {
 250   RANK_1, RANK_2, RANK_3, RANK_4, RANK_5, RANK_6, RANK_7, RANK_8, RANK_NB = 8
 251 };
 252
 253
 254 /// Score enum keeps a midgame and an endgame value in a single integer (enum),
 255 /// first LSB 16 bits are used to store endgame value, while upper bits are used
 256 /// for midgame value. Compiler is free to choose the enum type as long as can
 257 /// keep its data, so ensure Score to be an integer type.
 258 enum Score {
 259   SCORE_ZERO = 0,
 260   SCORE_ENSURE_INTEGER_SIZE_P = INT_MAX,
 261   SCORE_ENSURE_INTEGER_SIZE_N = INT_MIN
 262 };
 263
 264 inline Score make_score(int mg, int eg) { return Score((mg << 16) + eg); }
 265
 266 /// Extracting the signed lower and upper 16 bits it not so trivial because
 267 /// according to the standard a simple cast to short is implementation defined
 268 /// and so is a right shift of a signed integer.
 269 inline Value mg_value(Score s) { return Value(((s + 32768) & ~0xffff) / 0x10000); }
 270
 271 /// On Intel 64 bit we have a small speed regression with the standard conforming
 272 /// version, so use a faster code in this case that, although not 100% standard
 273 /// compliant it seems to work for Intel and MSVC.
 274 #if defined(IS_64BIT) && (!defined(__GNUC__) || defined(__INTEL_COMPILER))
 275
 276 inline Value eg_value(Score s) { return Value(int16_t(s & 0xffff)); }
 277
 278 #else
 279
 280 inline Value eg_value(Score s) {
 281   return Value((int)(unsigned(s) & 0x7fffu) - (int)(unsigned(s) & 0x8000u));
 282 }
 283
 284 #endif
 285
 286 #define ENABLE_SAFE_OPERATORS_ON(T)                                         \
 287 inline T operator+(const T d1, const T d2) { return T(int(d1) + int(d2)); } \
 288 inline T operator-(const T d1, const T d2) { return T(int(d1) - int(d2)); } \
 289 inline T operator*(int i, const T d) { return T(i * int(d)); }              \
 290 inline T operator*(const T d, int i) { return T(int(d) * i); }              \
 291 inline T operator-(const T d) { return T(-int(d)); }                        \
 292 inline T& operator+=(T& d1, const T d2) { d1 = d1 + d2; return d1; }        \
 293 inline T& operator-=(T& d1, const T d2) { d1 = d1 - d2; return d1; }        \
 294 inline T& operator*=(T& d, int i) { d = T(int(d) * i); return d; }
 295
 296 #define ENABLE_OPERATORS_ON(T) ENABLE_SAFE_OPERATORS_ON(T)                  \
 297 inline T operator++(T& d, int) { d = T(int(d) + 1); return d; }             \
 298 inline T operator--(T& d, int) { d = T(int(d) - 1); return d; }             \
 299 inline T operator/(const T d, int i) { return T(int(d) / i); }              \
 300 inline T& operator/=(T& d, int i) { d = T(int(d) / i); return d; }
 301
 302 ENABLE_OPERATORS_ON(Value)
 303 ENABLE_OPERATORS_ON(PieceType)
 304 ENABLE_OPERATORS_ON(Piece)
 305 ENABLE_OPERATORS_ON(Color)
 306 ENABLE_OPERATORS_ON(Depth)
 307 ENABLE_OPERATORS_ON(Square)
 308 ENABLE_OPERATORS_ON(File)
 309 ENABLE_OPERATORS_ON(Rank)
 310
 311 /// Added operators for adding integers to a Value
 312 inline Value operator+(Value v, int i) { return Value(int(v) + i); }
 313 inline Value operator-(Value v, int i) { return Value(int(v) - i); }
 314
 315 ENABLE_SAFE_OPERATORS_ON(Score)
 316
 317 /// Only declared but not defined. We don't want to multiply two scores due to
 318 /// a very high risk of overflow. So user should explicitly convert to integer.
 319 inline Score operator*(Score s1, Score s2);
 320
 321 /// Division of a Score must be handled separately for each term
 322 inline Score operator/(Score s, int i) {
 323   return make_score(mg_value(s) / i, eg_value(s) / i);
 324 }
 325
 326 /// Weight score v by score w trying to prevent overflow
 327 inline Score apply_weight(Score v, Score w) {
 328   return make_score((int(mg_value(v)) * mg_value(w)) / 0x100,
 329                     (int(eg_value(v)) * eg_value(w)) / 0x100);
 330 }
 331
 332 #undef ENABLE_OPERATORS_ON
 333 #undef ENABLE_SAFE_OPERATORS_ON
 334
 335 namespace Zobrist {
 336
 337   extern Key psq[COLOR_NB][PIECE_TYPE_NB][SQUARE_NB];
 338   extern Key enpassant[FILE_NB];
 339   extern Key castle[CASTLE_RIGHT_NB];
 340   extern Key side;
 341   extern Key exclusion;
 342
 343   void init();
 344 }
 345
 346 CACHE_LINE_ALIGNMENT
 347
 348 extern Score pieceSquareTable[PIECE_NB][SQUARE_NB];
 349 extern Value PieceValue[PHASE_NB][PIECE_NB];
 350 extern int SquareDistance[SQUARE_NB][SQUARE_NB];
 351
 352 struct MoveStack {
 353   Move move;
 354   int score;
 355 };
 356
 357 inline bool operator<(const MoveStack& f, const MoveStack& s) {
 358   return f.score < s.score;
 359 }
 360
 361 inline Color operator~(Color c) {
 362   return Color(c ^ 1);
 363 }
 364
 365 inline Square operator~(Square s) {
 366   return Square(s ^ 56); // Vertical flip SQ_A1 -> SQ_A8
 367 }
 368
 369 inline Square operator|(File f, Rank r) {
 370   return Square((r << 3) | f);
 371 }
 372
 373 inline Value mate_in(int ply) {
 374   return VALUE_MATE - ply;
 375 }
 376
 377 inline Value mated_in(int ply) {
 378   return -VALUE_MATE + ply;
 379 }
 380
 381 inline Piece make_piece(Color c, PieceType pt) {
 382   return Piece((c << 3) | pt);
 383 }
 384
 385 inline CastleRight make_castle_right(Color c, CastlingSide s) {
 386   return CastleRight(WHITE_OO << ((s == QUEEN_SIDE) + 2 * c));
 387 }
 388
 389 inline PieceType type_of(Piece p)  {
 390   return PieceType(p & 7);
 391 }
 392
 393 inline Color color_of(Piece p) {
 394   return p == NO_PIECE ? NO_COLOR : Color(p >> 3);
 395 }
 396
 397 inline bool is_ok(Square s) {
 398   return s >= SQ_A1 && s <= SQ_H8;
 399 }
 400
 401 inline File file_of(Square s) {
 402   return File(s & 7);
 403 }
 404
 405 inline Rank rank_of(Square s) {
 406   return Rank(s >> 3);
 407 }
 408
 409 inline Square mirror(Square s) {
 410   return Square(s ^ 7); // Horizontal flip SQ_A1 -> SQ_H1
 411 }
 412
 413 inline Square relative_square(Color c, Square s) {
 414   return Square(s ^ (c * 56));
 415 }
 416
 417 inline Rank relative_rank(Color c, Rank r) {
 418   return Rank(r ^ (c * 7));
 419 }
 420
 421 inline Rank relative_rank(Color c, Square s) {
 422   return relative_rank(c, rank_of(s));
 423 }
 424
 425 inline bool opposite_colors(Square s1, Square s2) {
 426   int s = int(s1) ^ int(s2);
 427   return ((s >> 3) ^ s) & 1;
 428 }
 429
 430 inline int file_distance(Square s1, Square s2) {
 431   return abs(file_of(s1) - file_of(s2));
 432 }
 433
 434 inline int rank_distance(Square s1, Square s2) {
 435   return abs(rank_of(s1) - rank_of(s2));
 436 }
 437
 438 inline int square_distance(Square s1, Square s2) {
 439   return SquareDistance[s1][s2];
 440 }
 441
 442 inline char file_to_char(File f) {
 443   return char(f - FILE_A + int('a'));
 444 }
 445
 446 inline char rank_to_char(Rank r) {
 447   return char(r - RANK_1 + int('1'));
 448 }
 449
 450 inline Square pawn_push(Color c) {
 451   return c == WHITE ? DELTA_N : DELTA_S;
 452 }
 453
 454 inline Square from_sq(Move m) {
 455   return Square((m >> 6) & 0x3F);
 456 }
 457
 458 inline Square to_sq(Move m) {
 459   return Square(m & 0x3F);
 460 }
 461
 462 inline MoveType type_of(Move m) {
 463   return MoveType(m & (3 << 14));
 464 }
 465
 466 inline PieceType promotion_type(Move m) {
 467   return PieceType(((m >> 12) & 3) + 2);
 468 }
 469
 470 inline Move make_move(Square from, Square to) {
 471   return Move(to | (from << 6));
 472 }
 473
 474 template<MoveType T>
 475 inline Move make(Square from, Square to, PieceType pt = KNIGHT) {
 476   return Move(to | (from << 6) | T | ((pt - KNIGHT) << 12)) ;
 477 }
 478
 479 inline bool is_ok(Move m) {
 480   return from_sq(m) != to_sq(m); // Catches also MOVE_NULL and MOVE_NONE
 481 }
 482
 483 #include <string>
 484
 485 inline const std::string square_to_string(Square s) {
 486   char ch[] = { file_to_char(file_of(s)), rank_to_char(rank_of(s)), 0 };
 487   return ch;
 488 }
 489
 490 /// Our insertion sort implementation, works with pointers and iterators and is
 491 /// guaranteed to be stable, as is needed.
 492 template<typename T, typename K>
 493 void sort(K first, K last)
 494 {
 495   T tmp;
 496   K p, q;
 497
 498   for (p = first + 1; p < last; p++)
 499   {
 500       tmp = *p;
 501       for (q = p; q != first && *(q-1) < tmp; --q)
 502           *q = *(q-1);
 503       *q = tmp;
 504   }
 505 }
 506
 507 #endif // !defined(TYPES_H_INCLUDED)