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