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