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-2015 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 /// When compiling with provided Makefile (e.g. for Linux and OSX), configuration
  24 /// is done automatically. To get started type 'make help'.
  25 ///
  26 /// When Makefile is not used (e.g. with Microsoft Visual Studio) some switches
  27 /// need to be set manually:
  28 ///
  29 /// -DNDEBUG      | Disable debugging mode. Always use this for release.
  30 ///
  31 /// -DNO_PREFETCH | Disable use of prefetch asm-instruction. You may need this to
  32 ///               | 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 and requires hardware with popcnt support.
  36
  37 #include <cassert>
  38 #include <cctype>
  39 #include <climits>
  40 #include <cstdint>
  41 #include <cstdlib>
  42
  43 #if defined(_MSC_VER)
  44 // Disable some silly and noisy warning from MSVC compiler
  45 #pragma warning(disable: 4127) // Conditional expression is constant
  46 #pragma warning(disable: 4146) // Unary minus operator applied to unsigned type
  47 #pragma warning(disable: 4800) // Forcing value to bool 'true' or 'false'
  48 #endif
  49
  50 /// Predefined macros hell:
  51 ///
  52 /// __GNUC__           Compiler is gcc, Clang or Intel on Linux
  53 /// __INTEL_COMPILER   Compiler is Intel
  54 /// _MSC_VER           Compiler is MSVC or Intel on Windows
  55 /// _WIN32             Building on Windows (any)
  56 /// _WIN64             Building on Windows 64 bit
  57
  58 #if defined(_WIN64) && !defined(IS_64BIT) // Last condition means Makefile is not used
  59 #  include <intrin.h> // MSVC popcnt and bsfq instrinsics
  60 #  define IS_64BIT
  61 #  define USE_BSFQ
  62 #endif
  63
  64 #if defined(USE_POPCNT) && defined(__INTEL_COMPILER) && defined(_MSC_VER)
  65 #  include <nmmintrin.h> // Intel header for _mm_popcnt_u64() intrinsic
  66 #endif
  67
  68 #if !defined(NO_PREFETCH) && (defined(__INTEL_COMPILER) || defined(_MSC_VER))
  69 #  include <xmmintrin.h> // Intel and Microsoft header for _mm_prefetch()
  70 #endif
  71
  72 #if defined(USE_PEXT)
  73 #  include <immintrin.h> // Header for _pext_u64() intrinsic
  74 #  define pext(b, m) _pext_u64(b, m)
  75 #else
  76 #  define pext(b, m) (0)
  77 #endif
  78
  79 #ifdef _MSC_VER
  80 #  define FORCE_INLINE  __forceinline
  81 #elif defined(__GNUC__)
  82 #  define FORCE_INLINE  inline __attribute__((always_inline))
  83 #else
  84 #  define FORCE_INLINE  inline
  85 #endif
  86
  87 #ifdef USE_POPCNT
  88 const bool HasPopCnt = true;
  89 #else
  90 const bool HasPopCnt = false;
  91 #endif
  92
  93 #ifdef USE_PEXT
  94 const bool HasPext = true;
  95 #else
  96 const bool HasPext = false;
  97 #endif
  98
  99 #ifdef IS_64BIT
 100 const bool Is64Bit = true;
 101 #else
 102 const bool Is64Bit = false;
 103 #endif
 104
 105 typedef uint64_t Key;
 106 typedef uint64_t Bitboard;
 107
 108 const int MAX_MOVES = 256;
 109 const int MAX_PLY   = 128;
 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), castling (3)
 117 /// NOTE: EN-PASSANT bit is set only when a pawn can be captured
 118 ///
 119 /// Special cases are MOVE_NONE and MOVE_NULL. We can sneak these in because in
 120 /// any normal move destination square is always different from origin square
 121 /// while MOVE_NONE and MOVE_NULL have the same origin and destination square.
 122
 123 enum Move {
 124   MOVE_NONE,
 125   MOVE_NULL = 65
 126 };
 127
 128 enum MoveType {
 129   NORMAL,
 130   PROMOTION = 1 << 14,
 131   ENPASSANT = 2 << 14,
 132   CASTLING  = 3 << 14
 133 };
 134
 135 enum Color {
 136   WHITE, BLACK, NO_COLOR, COLOR_NB = 2
 137 };
 138
 139 enum CastlingSide {
 140   KING_SIDE, QUEEN_SIDE, CASTLING_SIDE_NB = 2
 141 };
 142
 143 enum CastlingRight {
 144   NO_CASTLING,
 145   WHITE_OO,
 146   WHITE_OOO = WHITE_OO << 1,
 147   BLACK_OO  = WHITE_OO << 2,
 148   BLACK_OOO = WHITE_OO << 3,
 149   ANY_CASTLING = WHITE_OO | WHITE_OOO | BLACK_OO | BLACK_OOO,
 150   CASTLING_RIGHT_NB = 16
 151 };
 152
 153 template<Color C, CastlingSide S> struct MakeCastling {
 154   static const CastlingRight
 155   right = C == WHITE ? S == QUEEN_SIDE ? WHITE_OOO : WHITE_OO
 156                      : S == QUEEN_SIDE ? BLACK_OOO : BLACK_OO;
 157 };
 158
 159 enum Phase {
 160   PHASE_ENDGAME,
 161   PHASE_MIDGAME = 128,
 162   MG = 0, EG = 1, PHASE_NB = 2
 163 };
 164
 165 enum ScaleFactor {
 166   SCALE_FACTOR_DRAW    = 0,
 167   SCALE_FACTOR_ONEPAWN = 48,
 168   SCALE_FACTOR_NORMAL  = 64,
 169   SCALE_FACTOR_MAX     = 128,
 170   SCALE_FACTOR_NONE    = 255
 171 };
 172
 173 enum Bound {
 174   BOUND_NONE,
 175   BOUND_UPPER,
 176   BOUND_LOWER,
 177   BOUND_EXACT = BOUND_UPPER | BOUND_LOWER
 178 };
 179
 180 enum Value : int {
 181   VALUE_ZERO      = 0,
 182   VALUE_DRAW      = 0,
 183   VALUE_KNOWN_WIN = 10000,
 184   VALUE_MATE      = 32000,
 185   VALUE_INFINITE  = 32001,
 186   VALUE_NONE      = 32002,
 187
 188   VALUE_MATE_IN_MAX_PLY  =  VALUE_MATE - 2 * MAX_PLY,
 189   VALUE_MATED_IN_MAX_PLY = -VALUE_MATE + 2 * MAX_PLY,
 190
 191   PawnValueMg   = 198,   PawnValueEg   = 258,
 192   KnightValueMg = 817,   KnightValueEg = 846,
 193   BishopValueMg = 836,   BishopValueEg = 857,
 194   RookValueMg   = 1270,  RookValueEg   = 1278,
 195   QueenValueMg  = 2521,  QueenValueEg  = 2558,
 196
 197   MidgameLimit  = 15581, EndgameLimit  = 3998
 198 };
 199
 200 enum PieceType {
 201   NO_PIECE_TYPE, PAWN, KNIGHT, BISHOP, ROOK, QUEEN, KING,
 202   ALL_PIECES = 0,
 203   PIECE_TYPE_NB = 8
 204 };
 205
 206 enum Piece {
 207   NO_PIECE,
 208   W_PAWN = 1, W_KNIGHT, W_BISHOP, W_ROOK, W_QUEEN, W_KING,
 209   B_PAWN = 9, B_KNIGHT, B_BISHOP, B_ROOK, B_QUEEN, B_KING,
 210   PIECE_NB = 16
 211 };
 212
 213 enum Depth {
 214
 215   ONE_PLY = 1,
 216
 217   DEPTH_ZERO          =  0,
 218   DEPTH_QS_CHECKS     =  0,
 219   DEPTH_QS_NO_CHECKS  = -1,
 220   DEPTH_QS_RECAPTURES = -5,
 221
 222   DEPTH_NONE = -6,
 223   DEPTH_MAX  = MAX_PLY
 224 };
 225
 226 enum Square {
 227   SQ_A1, SQ_B1, SQ_C1, SQ_D1, SQ_E1, SQ_F1, SQ_G1, SQ_H1,
 228   SQ_A2, SQ_B2, SQ_C2, SQ_D2, SQ_E2, SQ_F2, SQ_G2, SQ_H2,
 229   SQ_A3, SQ_B3, SQ_C3, SQ_D3, SQ_E3, SQ_F3, SQ_G3, SQ_H3,
 230   SQ_A4, SQ_B4, SQ_C4, SQ_D4, SQ_E4, SQ_F4, SQ_G4, SQ_H4,
 231   SQ_A5, SQ_B5, SQ_C5, SQ_D5, SQ_E5, SQ_F5, SQ_G5, SQ_H5,
 232   SQ_A6, SQ_B6, SQ_C6, SQ_D6, SQ_E6, SQ_F6, SQ_G6, SQ_H6,
 233   SQ_A7, SQ_B7, SQ_C7, SQ_D7, SQ_E7, SQ_F7, SQ_G7, SQ_H7,
 234   SQ_A8, SQ_B8, SQ_C8, SQ_D8, SQ_E8, SQ_F8, SQ_G8, SQ_H8,
 235   SQ_NONE,
 236
 237   SQUARE_NB = 64,
 238
 239   DELTA_N =  8,
 240   DELTA_E =  1,
 241   DELTA_S = -8,
 242   DELTA_W = -1,
 243
 244   DELTA_NN = DELTA_N + DELTA_N,
 245   DELTA_NE = DELTA_N + DELTA_E,
 246   DELTA_SE = DELTA_S + DELTA_E,
 247   DELTA_SS = DELTA_S + DELTA_S,
 248   DELTA_SW = DELTA_S + DELTA_W,
 249   DELTA_NW = DELTA_N + DELTA_W
 250 };
 251
 252 enum File {
 253   FILE_A, FILE_B, FILE_C, FILE_D, FILE_E, FILE_F, FILE_G, FILE_H, FILE_NB
 254 };
 255
 256 enum Rank {
 257   RANK_1, RANK_2, RANK_3, RANK_4, RANK_5, RANK_6, RANK_7, RANK_8, RANK_NB
 258 };
 259
 260
 261 /// Score enum stores a middlegame and an endgame value in a single integer
 262 /// (enum). The least significant 16 bits are used to store the endgame value
 263 /// and the upper 16 bits are used to store the middlegame value.
 264 enum Score : int { SCORE_ZERO };
 265
 266 inline Score make_score(int mg, int eg) {
 267   return Score((mg << 16) + eg);
 268 }
 269
 270 /// Extracting the signed lower and upper 16 bits is not so trivial because
 271 /// according to the standard a simple cast to short is implementation defined
 272 /// and so is a right shift of a signed integer.
 273 inline Value mg_value(Score s) {
 274
 275   union { uint16_t u; int16_t s; } mg = { uint16_t(unsigned(s + 0x8000) >> 16) };
 276   return Value(mg.s);
 277 }
 278
 279 inline Value eg_value(Score s) {
 280
 281   union { uint16_t u; int16_t s; } eg = { uint16_t(unsigned(s)) };
 282   return Value(eg.s);
 283 }
 284
 285 #define ENABLE_BASE_OPERATORS_ON(T)                             \
 286 inline T operator+(T d1, T d2) { return T(int(d1) + int(d2)); } \
 287 inline T operator-(T d1, T d2) { return T(int(d1) - int(d2)); } \
 288 inline T operator*(int i, T d) { return T(i * int(d)); }        \
 289 inline T operator*(T d, int i) { return T(int(d) * i); }        \
 290 inline T operator-(T d) { return T(-int(d)); }                  \
 291 inline T& operator+=(T& d1, T d2) { return d1 = d1 + d2; }      \
 292 inline T& operator-=(T& d1, T d2) { return d1 = d1 - d2; }      \
 293 inline T& operator*=(T& d, int i) { return d = T(int(d) * i); }
 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/(T d, int i) { return T(int(d) / i); }        \
 300 inline int operator/(T d1, T d2) { return int(d1) / int(d2); }  \
 301 inline T& operator/=(T& d, int i) { return d = T(int(d) / i); }
 302
 303 ENABLE_FULL_OPERATORS_ON(Value)
 304 ENABLE_FULL_OPERATORS_ON(PieceType)
 305 ENABLE_FULL_OPERATORS_ON(Piece)
 306 ENABLE_FULL_OPERATORS_ON(Color)
 307 ENABLE_FULL_OPERATORS_ON(Depth)
 308 ENABLE_FULL_OPERATORS_ON(Square)
 309 ENABLE_FULL_OPERATORS_ON(File)
 310 ENABLE_FULL_OPERATORS_ON(Rank)
 311
 312 ENABLE_BASE_OPERATORS_ON(Score)
 313
 314 #undef ENABLE_FULL_OPERATORS_ON
 315 #undef ENABLE_BASE_OPERATORS_ON
 316
 317 /// Additional operators to add integers to a Value
 318 inline Value operator+(Value v, int i) { return Value(int(v) + i); }
 319 inline Value operator-(Value v, int i) { return Value(int(v) - i); }
 320 inline Value& operator+=(Value& v, int i) { return v = v + i; }
 321 inline Value& operator-=(Value& v, int i) { return v = v - i; }
 322
 323 /// Only declared but not defined. We don't want to multiply two scores due to
 324 /// a very high risk of overflow. So user should explicitly convert to integer.
 325 inline Score operator*(Score s1, Score s2);
 326
 327 /// Division of a Score must be handled separately for each term
 328 inline Score operator/(Score s, int i) {
 329   return make_score(mg_value(s) / i, eg_value(s) / i);
 330 }
 331
 332 extern Value PieceValue[PHASE_NB][PIECE_NB];
 333
 334 inline Color operator~(Color c) {
 335   return Color(c ^ BLACK);
 336 }
 337
 338 inline Square operator~(Square s) {
 339   return Square(s ^ SQ_A8); // Vertical flip SQ_A1 -> SQ_A8
 340 }
 341
 342 inline CastlingRight operator|(Color c, CastlingSide s) {
 343   return CastlingRight(WHITE_OO << ((s == QUEEN_SIDE) + 2 * c));
 344 }
 345
 346 inline Value mate_in(int ply) {
 347   return VALUE_MATE - ply;
 348 }
 349
 350 inline Value mated_in(int ply) {
 351   return -VALUE_MATE + ply;
 352 }
 353
 354 inline Square make_square(File f, Rank r) {
 355   return Square((r << 3) | f);
 356 }
 357
 358 inline Piece make_piece(Color c, PieceType pt) {
 359   return Piece((c << 3) | pt);
 360 }
 361
 362 inline PieceType type_of(Piece pc)  {
 363   return PieceType(pc & 7);
 364 }
 365
 366 inline Color color_of(Piece pc) {
 367   assert(pc != NO_PIECE);
 368   return Color(pc >> 3);
 369 }
 370
 371 inline bool is_ok(Square s) {
 372   return s >= SQ_A1 && s <= SQ_H8;
 373 }
 374
 375 inline File file_of(Square s) {
 376   return File(s & 7);
 377 }
 378
 379 inline Rank rank_of(Square s) {
 380   return Rank(s >> 3);
 381 }
 382
 383 inline Square relative_square(Color c, Square s) {
 384   return Square(s ^ (c * 56));
 385 }
 386
 387 inline Rank relative_rank(Color c, Rank r) {
 388   return Rank(r ^ (c * 7));
 389 }
 390
 391 inline Rank relative_rank(Color c, Square s) {
 392   return relative_rank(c, rank_of(s));
 393 }
 394
 395 inline bool opposite_colors(Square s1, Square s2) {
 396   int s = int(s1) ^ int(s2);
 397   return ((s >> 3) ^ s) & 1;
 398 }
 399
 400 inline Square pawn_push(Color c) {
 401   return c == WHITE ? DELTA_N : DELTA_S;
 402 }
 403
 404 inline Square from_sq(Move m) {
 405   return Square((m >> 6) & 0x3F);
 406 }
 407
 408 inline Square to_sq(Move m) {
 409   return Square(m & 0x3F);
 410 }
 411
 412 inline MoveType type_of(Move m) {
 413   return MoveType(m & (3 << 14));
 414 }
 415
 416 inline PieceType promotion_type(Move m) {
 417   return PieceType(((m >> 12) & 3) + 2);
 418 }
 419
 420 inline Move make_move(Square from, Square to) {
 421   return Move(to | (from << 6));
 422 }
 423
 424 template<MoveType T>
 425 inline Move make(Square from, Square to, PieceType pt = KNIGHT) {
 426   return Move(to | (from << 6) | T | ((pt - KNIGHT) << 12));
 427 }
 428
 429 inline bool is_ok(Move m) {
 430   return from_sq(m) != to_sq(m); // Catch MOVE_NULL and MOVE_NONE
 431 }
 432
 433 #endif // #ifndef TYPES_H_INCLUDED