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