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(USE_POPCNT)
  68 const bool HasPopCnt = true;
  69 #else
  70 const bool HasPopCnt = false;
  71 #endif
  72
  73 #if defined(IS_64BIT)
  74 const bool Is64Bit = true;
  75 #else
  76 const bool Is64Bit = false;
  77 #endif
  78
  79 typedef uint64_t Key;
  80 typedef uint64_t Bitboard;
  81
  82 const int MAX_MOVES      = 192;
  83 const int MAX_PLY        = 100;
  84 const int MAX_PLY_PLUS_2 = MAX_PLY + 2;
  85
  86 const Bitboard FileABB = 0x0101010101010101ULL;
  87 const Bitboard FileBBB = FileABB << 1;
  88 const Bitboard FileCBB = FileABB << 2;
  89 const Bitboard FileDBB = FileABB << 3;
  90 const Bitboard FileEBB = FileABB << 4;
  91 const Bitboard FileFBB = FileABB << 5;
  92 const Bitboard FileGBB = FileABB << 6;
  93 const Bitboard FileHBB = FileABB << 7;
  94
  95 const Bitboard Rank1BB = 0xFF;
  96 const Bitboard Rank2BB = Rank1BB << (8 * 1);
  97 const Bitboard Rank3BB = Rank1BB << (8 * 2);
  98 const Bitboard Rank4BB = Rank1BB << (8 * 3);
  99 const Bitboard Rank5BB = Rank1BB << (8 * 4);
 100 const Bitboard Rank6BB = Rank1BB << (8 * 5);
 101 const Bitboard Rank7BB = Rank1BB << (8 * 6);
 102 const Bitboard Rank8BB = Rank1BB << (8 * 7);
 103
 104
 105 /// A move needs 16 bits to be stored
 106 ///
 107 /// bit  0- 5: destination square (from 0 to 63)
 108 /// bit  6-11: origin square (from 0 to 63)
 109 /// bit 12-13: promotion piece type - 2 (from KNIGHT-2 to QUEEN-2)
 110 /// bit 14-15: special move flag: promotion (1), en passant (2), castle (3)
 111 ///
 112 /// Special cases are MOVE_NONE and MOVE_NULL. We can sneak these in because in
 113 /// any normal move destination square is always different from origin square
 114 /// while MOVE_NONE and MOVE_NULL have the same origin and destination square.
 115
 116 enum Move {
 117   MOVE_NONE = 0,
 118   MOVE_NULL = 65
 119 };
 120
 121 struct MoveStack {
 122   Move move;
 123   int score;
 124 };
 125
 126 inline bool operator<(const MoveStack& f, const MoveStack& s) {
 127   return f.score < s.score;
 128 }
 129
 130 enum CastleRight {
 131   CASTLES_NONE = 0,
 132   WHITE_OO     = 1,
 133   BLACK_OO     = 2,
 134   WHITE_OOO    = 4,
 135   BLACK_OOO    = 8,
 136   ALL_CASTLES  = 15
 137 };
 138
 139 enum CastlingSide {
 140   KING_SIDE,
 141   QUEEN_SIDE
 142 };
 143
 144 enum ScaleFactor {
 145   SCALE_FACTOR_DRAW   = 0,
 146   SCALE_FACTOR_NORMAL = 64,
 147   SCALE_FACTOR_MAX    = 128,
 148   SCALE_FACTOR_NONE   = 255
 149 };
 150
 151 enum Bound {
 152   BOUND_NONE  = 0,
 153   BOUND_UPPER = 1,
 154   BOUND_LOWER = 2,
 155   BOUND_EXACT = BOUND_UPPER | BOUND_LOWER
 156 };
 157
 158 enum Value {
 159   VALUE_ZERO      = 0,
 160   VALUE_DRAW      = 0,
 161   VALUE_KNOWN_WIN = 15000,
 162   VALUE_MATE      = 30000,
 163   VALUE_INFINITE  = 30001,
 164   VALUE_NONE      = 30002,
 165
 166   VALUE_MATE_IN_MAX_PLY  =  VALUE_MATE - MAX_PLY,
 167   VALUE_MATED_IN_MAX_PLY = -VALUE_MATE + MAX_PLY,
 168
 169   VALUE_ENSURE_INTEGER_SIZE_P = INT_MAX,
 170   VALUE_ENSURE_INTEGER_SIZE_N = INT_MIN
 171 };
 172
 173 enum PieceType {
 174   NO_PIECE_TYPE = 0, ALL_PIECES = 0,
 175   PAWN = 1, KNIGHT = 2, BISHOP = 3, ROOK = 4, QUEEN = 5, KING = 6
 176 };
 177
 178 enum Piece {
 179   NO_PIECE = 16, // color_of(NO_PIECE) == NO_COLOR
 180   W_PAWN = 1, W_KNIGHT =  2, W_BISHOP =  3, W_ROOK =  4, W_QUEEN =  5, W_KING =  6,
 181   B_PAWN = 9, B_KNIGHT = 10, B_BISHOP = 11, B_ROOK = 12, B_QUEEN = 13, B_KING = 14
 182 };
 183
 184 enum Color {
 185   WHITE, BLACK, NO_COLOR
 186 };
 187
 188 enum Depth {
 189
 190   ONE_PLY = 2,
 191
 192   DEPTH_ZERO          =  0 * ONE_PLY,
 193   DEPTH_QS_CHECKS     = -1 * ONE_PLY,
 194   DEPTH_QS_NO_CHECKS  = -2 * ONE_PLY,
 195   DEPTH_QS_RECAPTURES = -5 * ONE_PLY,
 196
 197   DEPTH_NONE = -127 * ONE_PLY
 198 };
 199
 200 enum Square {
 201   SQ_A1, SQ_B1, SQ_C1, SQ_D1, SQ_E1, SQ_F1, SQ_G1, SQ_H1,
 202   SQ_A2, SQ_B2, SQ_C2, SQ_D2, SQ_E2, SQ_F2, SQ_G2, SQ_H2,
 203   SQ_A3, SQ_B3, SQ_C3, SQ_D3, SQ_E3, SQ_F3, SQ_G3, SQ_H3,
 204   SQ_A4, SQ_B4, SQ_C4, SQ_D4, SQ_E4, SQ_F4, SQ_G4, SQ_H4,
 205   SQ_A5, SQ_B5, SQ_C5, SQ_D5, SQ_E5, SQ_F5, SQ_G5, SQ_H5,
 206   SQ_A6, SQ_B6, SQ_C6, SQ_D6, SQ_E6, SQ_F6, SQ_G6, SQ_H6,
 207   SQ_A7, SQ_B7, SQ_C7, SQ_D7, SQ_E7, SQ_F7, SQ_G7, SQ_H7,
 208   SQ_A8, SQ_B8, SQ_C8, SQ_D8, SQ_E8, SQ_F8, SQ_G8, SQ_H8,
 209   SQ_NONE,
 210
 211   DELTA_N =  8,
 212   DELTA_E =  1,
 213   DELTA_S = -8,
 214   DELTA_W = -1,
 215
 216   DELTA_NN = DELTA_N + DELTA_N,
 217   DELTA_NE = DELTA_N + DELTA_E,
 218   DELTA_SE = DELTA_S + DELTA_E,
 219   DELTA_SS = DELTA_S + DELTA_S,
 220   DELTA_SW = DELTA_S + DELTA_W,
 221   DELTA_NW = DELTA_N + DELTA_W
 222 };
 223
 224 enum File {
 225   FILE_A, FILE_B, FILE_C, FILE_D, FILE_E, FILE_F, FILE_G, FILE_H
 226 };
 227
 228 enum Rank {
 229   RANK_1, RANK_2, RANK_3, RANK_4, RANK_5, RANK_6, RANK_7, RANK_8
 230 };
 231
 232
 233 /// Score enum keeps a midgame and an endgame value in a single integer (enum),
 234 /// first LSB 16 bits are used to store endgame value, while upper bits are used
 235 /// for midgame value. Compiler is free to choose the enum type as long as can
 236 /// keep its data, so ensure Score to be an integer type.
 237 enum Score {
 238   SCORE_ZERO = 0,
 239   SCORE_ENSURE_INTEGER_SIZE_P = INT_MAX,
 240   SCORE_ENSURE_INTEGER_SIZE_N = INT_MIN
 241 };
 242
 243 inline Score make_score(int mg, int eg) { return Score((mg << 16) + eg); }
 244
 245 /// Extracting the signed lower and upper 16 bits it not so trivial because
 246 /// according to the standard a simple cast to short is implementation defined
 247 /// and so is a right shift of a signed integer.
 248 inline Value mg_value(Score s) { return Value(((s + 32768) & ~0xffff) / 0x10000); }
 249
 250 /// On Intel 64 bit we have a small speed regression with the standard conforming
 251 /// version, so use a faster code in this case that, although not 100% standard
 252 /// compliant it seems to work for Intel and MSVC.
 253 #if defined(IS_64BIT) && (!defined(__GNUC__) || defined(__INTEL_COMPILER))
 254
 255 inline Value eg_value(Score s) { return Value(int16_t(s & 0xffff)); }
 256
 257 #else
 258
 259 inline Value eg_value(Score s) {
 260   return Value((int)(unsigned(s) & 0x7fffu) - (int)(unsigned(s) & 0x8000u));
 261 }
 262
 263 #endif
 264
 265 #define ENABLE_SAFE_OPERATORS_ON(T)                                         \
 266 inline T operator+(const T d1, const T d2) { return T(int(d1) + int(d2)); } \
 267 inline T operator-(const T d1, const T d2) { return T(int(d1) - int(d2)); } \
 268 inline T operator*(int i, const T d) { return T(i * int(d)); }              \
 269 inline T operator*(const T d, int i) { return T(int(d) * i); }              \
 270 inline T operator-(const T d) { return T(-int(d)); }                        \
 271 inline T& operator+=(T& d1, const T d2) { d1 = d1 + d2; return d1; }        \
 272 inline T& operator-=(T& d1, const T d2) { d1 = d1 - d2; return d1; }        \
 273 inline T& operator*=(T& d, int i) { d = T(int(d) * i); return d; }
 274
 275 #define ENABLE_OPERATORS_ON(T) ENABLE_SAFE_OPERATORS_ON(T)                  \
 276 inline T operator++(T& d, int) { d = T(int(d) + 1); return d; }             \
 277 inline T operator--(T& d, int) { d = T(int(d) - 1); return d; }             \
 278 inline T operator/(const T d, int i) { return T(int(d) / i); }              \
 279 inline T& operator/=(T& d, int i) { d = T(int(d) / i); return d; }
 280
 281 ENABLE_OPERATORS_ON(Value)
 282 ENABLE_OPERATORS_ON(PieceType)
 283 ENABLE_OPERATORS_ON(Piece)
 284 ENABLE_OPERATORS_ON(Color)
 285 ENABLE_OPERATORS_ON(Depth)
 286 ENABLE_OPERATORS_ON(Square)
 287 ENABLE_OPERATORS_ON(File)
 288 ENABLE_OPERATORS_ON(Rank)
 289
 290 /// Added operators for adding integers to a Value
 291 inline Value operator+(Value v, int i) { return Value(int(v) + i); }
 292 inline Value operator-(Value v, int i) { return Value(int(v) - i); }
 293
 294 ENABLE_SAFE_OPERATORS_ON(Score)
 295
 296 /// Only declared but not defined. We don't want to multiply two scores due to
 297 /// a very high risk of overflow. So user should explicitly convert to integer.
 298 inline Score operator*(Score s1, Score s2);
 299
 300 /// Division of a Score must be handled separately for each term
 301 inline Score operator/(Score s, int i) {
 302   return make_score(mg_value(s) / i, eg_value(s) / i);
 303 }
 304
 305 /// Weight score v by score w trying to prevent overflow
 306 inline Score apply_weight(Score v, Score w) {
 307   return make_score((int(mg_value(v)) * mg_value(w)) / 0x100,
 308                     (int(eg_value(v)) * eg_value(w)) / 0x100);
 309 }
 310
 311 #undef ENABLE_OPERATORS_ON
 312 #undef ENABLE_SAFE_OPERATORS_ON
 313
 314 const Value PawnValueMidgame   = Value(0x0C6);
 315 const Value PawnValueEndgame   = Value(0x102);
 316 const Value KnightValueMidgame = Value(0x331);
 317 const Value KnightValueEndgame = Value(0x34E);
 318 const Value BishopValueMidgame = Value(0x344);
 319 const Value BishopValueEndgame = Value(0x359);
 320 const Value RookValueMidgame   = Value(0x4F6);
 321 const Value RookValueEndgame   = Value(0x4FE);
 322 const Value QueenValueMidgame  = Value(0x9D9);
 323 const Value QueenValueEndgame  = Value(0x9FE);
 324
 325 extern const Value PieceValueMidgame[17]; // Indexed by Piece or PieceType
 326 extern const Value PieceValueEndgame[17];
 327 extern int SquareDistance[64][64];
 328 extern uint8_t BitCount8Bit[256];
 329
 330 inline Color operator~(Color c) {
 331   return Color(c ^ 1);
 332 }
 333
 334 inline Square operator~(Square s) {
 335   return Square(s ^ 56); // Vertical flip SQ_A1 -> SQ_A8
 336 }
 337
 338 inline Value mate_in(int ply) {
 339   return VALUE_MATE - ply;
 340 }
 341
 342 inline Value mated_in(int ply) {
 343   return -VALUE_MATE + ply;
 344 }
 345
 346 inline Piece make_piece(Color c, PieceType pt) {
 347   return Piece((c << 3) | pt);
 348 }
 349
 350 inline PieceType type_of(Piece p)  {
 351   return PieceType(p & 7);
 352 }
 353
 354 inline Color color_of(Piece p) {
 355   return Color(p >> 3);
 356 }
 357
 358 inline Square make_square(File f, Rank r) {
 359   return Square((r << 3) | f);
 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 = s1 ^ s2;
 392   return ((s >> 3) ^ s) & 1;
 393 }
 394
 395 inline int file_distance(Square s1, Square s2) {
 396   return abs(file_of(s1) - file_of(s2));
 397 }
 398
 399 inline int rank_distance(Square s1, Square s2) {
 400   return abs(rank_of(s1) - rank_of(s2));
 401 }
 402
 403 inline int square_distance(Square s1, Square s2) {
 404   return SquareDistance[s1][s2];
 405 }
 406
 407 inline char piece_type_to_char(PieceType pt) {
 408   return " PNBRQK"[pt];
 409 }
 410
 411 inline char file_to_char(File f) {
 412   return char(f - FILE_A + int('a'));
 413 }
 414
 415 inline char rank_to_char(Rank r) {
 416   return char(r - RANK_1 + int('1'));
 417 }
 418
 419 inline Square pawn_push(Color c) {
 420   return c == WHITE ? DELTA_N : DELTA_S;
 421 }
 422
 423 inline Square from_sq(Move m) {
 424   return Square((m >> 6) & 0x3F);
 425 }
 426
 427 inline Square to_sq(Move m) {
 428   return Square(m & 0x3F);
 429 }
 430
 431 inline bool is_special(Move m) {
 432   return m & (3 << 14);
 433 }
 434
 435 inline bool is_promotion(Move m) {
 436   return (m & (3 << 14)) == (1 << 14);
 437 }
 438
 439 inline int is_enpassant(Move m) {
 440   return (m & (3 << 14)) == (2 << 14);
 441 }
 442
 443 inline int is_castle(Move m) {
 444   return (m & (3 << 14)) == (3 << 14);
 445 }
 446
 447 inline PieceType promotion_type(Move m) {
 448   return PieceType(((m >> 12) & 3) + 2);
 449 }
 450
 451 inline Move make_move(Square from, Square to) {
 452   return Move(to | (from << 6));
 453 }
 454
 455 inline Move make_promotion(Square from, Square to, PieceType pt) {
 456   return Move(to | (from << 6) | (1 << 14) | ((pt - 2) << 12)) ;
 457 }
 458
 459 inline Move make_enpassant(Square from, Square to) {
 460   return Move(to | (from << 6) | (2 << 14));
 461 }
 462
 463 inline Move make_castle(Square from, Square to) {
 464   return Move(to | (from << 6) | (3 << 14));
 465 }
 466
 467 inline bool is_ok(Move m) {
 468   return from_sq(m) != to_sq(m); // Catches also MOVE_NULL and MOVE_NONE
 469 }
 470
 471 #include <string>
 472
 473 inline const std::string square_to_string(Square s) {
 474   char ch[] = { file_to_char(file_of(s)), rank_to_char(rank_of(s)), 0 };
 475   return ch;
 476 }
 477
 478 /// Our insertion sort implementation, works with pointers and iterators and is
 479 /// guaranteed to be stable, as is needed.
 480 template<typename T, typename K>
 481 void sort(K first, K last)
 482 {
 483   T tmp;
 484   K p, q;
 485
 486   for (p = first + 1; p < last; p++)
 487   {
 488       tmp = *p;
 489       for (q = p; q != first && *(q-1) < tmp; --q)
 490           *q = *(q-1);
 491       *q = tmp;
 492   }
 493 }
 494
 495 #endif // !defined(TYPES_H_INCLUDED)