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