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-2012 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 <climits>
  39 #include <cstdlib>
  40
  41 #include "platform.h"
  42
  43 #if defined(_WIN64)
  44 #  include <intrin.h> // MSVC popcnt and bsfq instrinsics
  45 #  define IS_64BIT
  46 #  define USE_BSFQ
  47 #endif
  48
  49 #if defined(USE_POPCNT) && defined(_MSC_VER) && defined(__INTEL_COMPILER)
  50 #  include <nmmintrin.h> // Intel header for _mm_popcnt_u64() intrinsic
  51 #endif
  52
  53 #if defined(_MSC_VER) || defined(__INTEL_COMPILER)
  54 #  define CACHE_LINE_ALIGNMENT __declspec(align(64))
  55 #else
  56 #  define CACHE_LINE_ALIGNMENT  __attribute__ ((aligned(64)))
  57 #endif
  58
  59 #if defined(_MSC_VER)
  60 #  define FORCE_INLINE  __forceinline
  61 #elif defined(__GNUC__)
  62 #  define FORCE_INLINE  inline __attribute__((always_inline))
  63 #else
  64 #  define FORCE_INLINE  inline
  65 #endif
  66
  67 #if defined(__GNUC__)
  68 #  define THREAD_LOCAL  __thread
  69 #else
  70 #  define THREAD_LOCAL  __declspec(thread)
  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      = 256;
  89 const int MAX_PLY        = 256;
  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 struct MoveStack {
 128   Move move;
 129   int score;
 130 };
 131
 132 inline bool operator<(const MoveStack& f, const MoveStack& s) {
 133   return f.score < s.score;
 134 }
 135
 136 enum CastleRight {
 137   CASTLES_NONE = 0,
 138   WHITE_OO     = 1,
 139   BLACK_OO     = 2,
 140   WHITE_OOO    = 4,
 141   BLACK_OOO    = 8,
 142   ALL_CASTLES  = 15
 143 };
 144
 145 enum ScaleFactor {
 146   SCALE_FACTOR_DRAW   = 0,
 147   SCALE_FACTOR_NORMAL = 64,
 148   SCALE_FACTOR_MAX    = 128,
 149   SCALE_FACTOR_NONE   = 255
 150 };
 151
 152 enum Bound {
 153   BOUND_NONE  = 0,
 154   BOUND_UPPER = 1,
 155   BOUND_LOWER = 2,
 156   BOUND_EXACT = BOUND_UPPER | BOUND_LOWER
 157 };
 158
 159 enum Value {
 160   VALUE_ZERO      = 0,
 161   VALUE_DRAW      = 0,
 162   VALUE_KNOWN_WIN = 15000,
 163   VALUE_MATE      = 30000,
 164   VALUE_INFINITE  = 30001,
 165   VALUE_NONE      = 30002,
 166
 167   VALUE_MATE_IN_MAX_PLY  =  VALUE_MATE - MAX_PLY,
 168   VALUE_MATED_IN_MAX_PLY = -VALUE_MATE + MAX_PLY,
 169
 170   VALUE_ENSURE_INTEGER_SIZE_P = INT_MAX,
 171   VALUE_ENSURE_INTEGER_SIZE_N = INT_MIN
 172 };
 173
 174 enum PieceType {
 175   NO_PIECE_TYPE = 0, ALL_PIECES = 0,
 176   PAWN = 1, KNIGHT = 2, BISHOP = 3, ROOK = 4, QUEEN = 5, KING = 6
 177 };
 178
 179 enum Piece {
 180   NO_PIECE = 16, // color_of(NO_PIECE) == NO_COLOR
 181   W_PAWN = 1, W_KNIGHT =  2, W_BISHOP =  3, W_ROOK =  4, W_QUEEN =  5, W_KING =  6,
 182   B_PAWN = 9, B_KNIGHT = 10, B_BISHOP = 11, B_ROOK = 12, B_QUEEN = 13, B_KING = 14
 183 };
 184
 185 enum Color {
 186   WHITE, BLACK, NO_COLOR
 187 };
 188
 189 enum Depth {
 190
 191   ONE_PLY = 2,
 192
 193   DEPTH_ZERO          =  0 * ONE_PLY,
 194   DEPTH_QS_CHECKS     = -1 * ONE_PLY,
 195   DEPTH_QS_NO_CHECKS  = -2 * ONE_PLY,
 196   DEPTH_QS_RECAPTURES = -5 * ONE_PLY,
 197
 198   DEPTH_NONE = -127 * ONE_PLY
 199 };
 200
 201 enum Square {
 202   SQ_A1, SQ_B1, SQ_C1, SQ_D1, SQ_E1, SQ_F1, SQ_G1, SQ_H1,
 203   SQ_A2, SQ_B2, SQ_C2, SQ_D2, SQ_E2, SQ_F2, SQ_G2, SQ_H2,
 204   SQ_A3, SQ_B3, SQ_C3, SQ_D3, SQ_E3, SQ_F3, SQ_G3, SQ_H3,
 205   SQ_A4, SQ_B4, SQ_C4, SQ_D4, SQ_E4, SQ_F4, SQ_G4, SQ_H4,
 206   SQ_A5, SQ_B5, SQ_C5, SQ_D5, SQ_E5, SQ_F5, SQ_G5, SQ_H5,
 207   SQ_A6, SQ_B6, SQ_C6, SQ_D6, SQ_E6, SQ_F6, SQ_G6, SQ_H6,
 208   SQ_A7, SQ_B7, SQ_C7, SQ_D7, SQ_E7, SQ_F7, SQ_G7, SQ_H7,
 209   SQ_A8, SQ_B8, SQ_C8, SQ_D8, SQ_E8, SQ_F8, SQ_G8, SQ_H8,
 210   SQ_NONE,
 211
 212   DELTA_N =  8,
 213   DELTA_E =  1,
 214   DELTA_S = -8,
 215   DELTA_W = -1,
 216
 217   DELTA_NN = DELTA_N + DELTA_N,
 218   DELTA_NE = DELTA_N + DELTA_E,
 219   DELTA_SE = DELTA_S + DELTA_E,
 220   DELTA_SS = DELTA_S + DELTA_S,
 221   DELTA_SW = DELTA_S + DELTA_W,
 222   DELTA_NW = DELTA_N + DELTA_W
 223 };
 224
 225 enum File {
 226   FILE_A, FILE_B, FILE_C, FILE_D, FILE_E, FILE_F, FILE_G, FILE_H
 227 };
 228
 229 enum Rank {
 230   RANK_1, RANK_2, RANK_3, RANK_4, RANK_5, RANK_6, RANK_7, RANK_8
 231 };
 232
 233
 234 /// Score enum keeps a midgame and an endgame value in a single integer (enum),
 235 /// first LSB 16 bits are used to store endgame value, while upper bits are used
 236 /// for midgame value. Compiler is free to choose the enum type as long as can
 237 /// keep its data, so ensure Score to be an integer type.
 238 enum Score {
 239   SCORE_ZERO = 0,
 240   SCORE_ENSURE_INTEGER_SIZE_P = INT_MAX,
 241   SCORE_ENSURE_INTEGER_SIZE_N = INT_MIN
 242 };
 243
 244 inline Score make_score(int mg, int eg) { return Score((mg << 16) + eg); }
 245
 246 /// Extracting the signed lower and upper 16 bits it not so trivial because
 247 /// according to the standard a simple cast to short is implementation defined
 248 /// and so is a right shift of a signed integer.
 249 inline Value mg_value(Score s) { return Value(((s + 32768) & ~0xffff) / 0x10000); }
 250
 251 /// On Intel 64 bit we have a small speed regression with the standard conforming
 252 /// version, so use a faster code in this case that, although not 100% standard
 253 /// compliant it seems to work for Intel and MSVC.
 254 #if defined(IS_64BIT) && (!defined(__GNUC__) || defined(__INTEL_COMPILER))
 255
 256 inline Value eg_value(Score s) { return Value(int16_t(s & 0xffff)); }
 257
 258 #else
 259
 260 inline Value eg_value(Score s) {
 261   return Value((int)(unsigned(s) & 0x7fffu) - (int)(unsigned(s) & 0x8000u));
 262 }
 263
 264 #endif
 265
 266 #define ENABLE_SAFE_OPERATORS_ON(T)                                         \
 267 inline T operator+(const T d1, const T d2) { return T(int(d1) + int(d2)); } \
 268 inline T operator-(const T d1, const T d2) { return T(int(d1) - int(d2)); } \
 269 inline T operator*(int i, const T d) { return T(i * int(d)); }              \
 270 inline T operator*(const T d, int i) { return T(int(d) * i); }              \
 271 inline T operator-(const T d) { return T(-int(d)); }                        \
 272 inline T& operator+=(T& d1, const T d2) { d1 = d1 + d2; return d1; }        \
 273 inline T& operator-=(T& d1, const T d2) { d1 = d1 - d2; return d1; }        \
 274 inline T& operator*=(T& d, int i) { d = T(int(d) * i); return d; }
 275
 276 #define ENABLE_OPERATORS_ON(T) ENABLE_SAFE_OPERATORS_ON(T)                  \
 277 inline T operator++(T& d, int) { d = T(int(d) + 1); return d; }             \
 278 inline T operator--(T& d, int) { d = T(int(d) - 1); return d; }             \
 279 inline T operator/(const T d, int i) { return T(int(d) / i); }              \
 280 inline T& operator/=(T& d, int i) { d = T(int(d) / i); return d; }
 281
 282 ENABLE_OPERATORS_ON(Value)
 283 ENABLE_OPERATORS_ON(PieceType)
 284 ENABLE_OPERATORS_ON(Piece)
 285 ENABLE_OPERATORS_ON(Color)
 286 ENABLE_OPERATORS_ON(Depth)
 287 ENABLE_OPERATORS_ON(Square)
 288 ENABLE_OPERATORS_ON(File)
 289 ENABLE_OPERATORS_ON(Rank)
 290
 291 /// Added operators for adding integers to a Value
 292 inline Value operator+(Value v, int i) { return Value(int(v) + i); }
 293 inline Value operator-(Value v, int i) { return Value(int(v) - i); }
 294
 295 ENABLE_SAFE_OPERATORS_ON(Score)
 296
 297 /// Only declared but not defined. We don't want to multiply two scores due to
 298 /// a very high risk of overflow. So user should explicitly convert to integer.
 299 inline Score operator*(Score s1, Score s2);
 300
 301 /// Division of a Score must be handled separately for each term
 302 inline Score operator/(Score s, int i) {
 303   return make_score(mg_value(s) / i, eg_value(s) / i);
 304 }
 305
 306 /// Weight score v by score w trying to prevent overflow
 307 inline Score apply_weight(Score v, Score w) {
 308   return make_score((int(mg_value(v)) * mg_value(w)) / 0x100,
 309                     (int(eg_value(v)) * eg_value(w)) / 0x100);
 310 }
 311
 312 #undef ENABLE_OPERATORS_ON
 313 #undef ENABLE_SAFE_OPERATORS_ON
 314
 315 const Value PawnValueMidgame   = Value(0x0C6);
 316 const Value PawnValueEndgame   = Value(0x102);
 317 const Value KnightValueMidgame = Value(0x331);
 318 const Value KnightValueEndgame = Value(0x34E);
 319 const Value BishopValueMidgame = Value(0x344);
 320 const Value BishopValueEndgame = Value(0x359);
 321 const Value RookValueMidgame   = Value(0x4F6);
 322 const Value RookValueEndgame   = Value(0x4FE);
 323 const Value QueenValueMidgame  = Value(0x9D9);
 324 const Value QueenValueEndgame  = Value(0x9FE);
 325
 326 extern const Value PieceValueMidgame[17]; // Indexed by Piece or PieceType
 327 extern const Value PieceValueEndgame[17];
 328 extern int SquareDistance[64][64];
 329 extern uint8_t BitCount8Bit[256];
 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 Value mate_in(int ply) {
 340   return VALUE_MATE - ply;
 341 }
 342
 343 inline Value mated_in(int ply) {
 344   return -VALUE_MATE + ply;
 345 }
 346
 347 inline Piece make_piece(Color c, PieceType pt) {
 348   return Piece((c << 3) | pt);
 349 }
 350
 351 inline PieceType type_of(Piece p)  {
 352   return PieceType(p & 7);
 353 }
 354
 355 inline Color color_of(Piece p) {
 356   return Color(p >> 3);
 357 }
 358
 359 inline Square make_square(File f, Rank r) {
 360   return Square((r << 3) | f);
 361 }
 362
 363 inline bool is_ok(Square s) {
 364   return s >= SQ_A1 && s <= SQ_H8;
 365 }
 366
 367 inline File file_of(Square s) {
 368   return File(s & 7);
 369 }
 370
 371 inline Rank rank_of(Square s) {
 372   return Rank(s >> 3);
 373 }
 374
 375 inline Square mirror(Square s) {
 376   return Square(s ^ 7); // Horizontal flip SQ_A1 -> SQ_H1
 377 }
 378
 379 inline Square relative_square(Color c, Square s) {
 380   return Square(s ^ (c * 56));
 381 }
 382
 383 inline Rank relative_rank(Color c, Rank r) {
 384   return Rank(r ^ (c * 7));
 385 }
 386
 387 inline Rank relative_rank(Color c, Square s) {
 388   return relative_rank(c, rank_of(s));
 389 }
 390
 391 inline bool opposite_colors(Square s1, Square s2) {
 392   int s = s1 ^ s2;
 393   return ((s >> 3) ^ s) & 1;
 394 }
 395
 396 inline int file_distance(Square s1, Square s2) {
 397   return abs(file_of(s1) - file_of(s2));
 398 }
 399
 400 inline int rank_distance(Square s1, Square s2) {
 401   return abs(rank_of(s1) - rank_of(s2));
 402 }
 403
 404 inline int square_distance(Square s1, Square s2) {
 405   return SquareDistance[s1][s2];
 406 }
 407
 408 inline char piece_type_to_char(PieceType pt) {
 409   return " PNBRQK"[pt];
 410 }
 411
 412 inline char file_to_char(File f) {
 413   return char(f - FILE_A + int('a'));
 414 }
 415
 416 inline char rank_to_char(Rank r) {
 417   return char(r - RANK_1 + int('1'));
 418 }
 419
 420 inline Square pawn_push(Color c) {
 421   return c == WHITE ? DELTA_N : DELTA_S;
 422 }
 423
 424 inline Square from_sq(Move m) {
 425   return Square((m >> 6) & 0x3F);
 426 }
 427
 428 inline Square to_sq(Move m) {
 429   return Square(m & 0x3F);
 430 }
 431
 432 inline bool is_special(Move m) {
 433   return m & (3 << 14);
 434 }
 435
 436 inline bool is_promotion(Move m) {
 437   return (m & (3 << 14)) == (1 << 14);
 438 }
 439
 440 inline int is_enpassant(Move m) {
 441   return (m & (3 << 14)) == (2 << 14);
 442 }
 443
 444 inline int is_castle(Move m) {
 445   return (m & (3 << 14)) == (3 << 14);
 446 }
 447
 448 inline PieceType promotion_type(Move m) {
 449   return PieceType(((m >> 12) & 3) + 2);
 450 }
 451
 452 inline Move make_move(Square from, Square to) {
 453   return Move(to | (from << 6));
 454 }
 455
 456 inline Move make_promotion(Square from, Square to, PieceType pt) {
 457   return Move(to | (from << 6) | (1 << 14) | ((pt - 2) << 12)) ;
 458 }
 459
 460 inline Move make_enpassant(Square from, Square to) {
 461   return Move(to | (from << 6) | (2 << 14));
 462 }
 463
 464 inline Move make_castle(Square from, Square to) {
 465   return Move(to | (from << 6) | (3 << 14));
 466 }
 467
 468 inline bool is_ok(Move m) {
 469   return from_sq(m) != to_sq(m); // Catches also MOVE_NULL and MOVE_NONE
 470 }
 471
 472 #include <string>
 473
 474 inline const std::string square_to_string(Square s) {
 475   char ch[] = { file_to_char(file_of(s)), rank_to_char(rank_of(s)), 0 };
 476   return ch;
 477 }
 478
 479 /// Our insertion sort implementation, works with pointers and iterators and is
 480 /// guaranteed to be stable, as is needed.
 481 template<typename T, typename K>
 482 void sort(K first, K last)
 483 {
 484   T tmp;
 485   K p, q;
 486
 487   for (p = first + 1; p < last; p++)
 488   {
 489       tmp = *p;
 490       for (q = p; q != first && *(q-1) < tmp; --q)
 491           *q = *(q-1);
 492       *q = tmp;
 493   }
 494 }
 495
 496 #endif // !defined(TYPES_H_INCLUDED)