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-2010 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 #include <climits>
  24 #include <cstdlib>
  25
  26 #if defined(_MSC_VER)
  27
  28 // Disable some silly and noisy warning from MSVC compiler
  29 #pragma warning(disable: 4800) // Forcing value to bool 'true' or 'false'
  30 #pragma warning(disable: 4127) // Conditional expression is constant
  31 #pragma warning(disable: 4146) // Unary minus operator applied to unsigned type
  32
  33 // MSVC does not support <inttypes.h>
  34 typedef   signed __int8    int8_t;
  35 typedef unsigned __int8   uint8_t;
  36 typedef   signed __int16  int16_t;
  37 typedef unsigned __int16 uint16_t;
  38 typedef   signed __int32  int32_t;
  39 typedef unsigned __int32 uint32_t;
  40 typedef   signed __int64  int64_t;
  41 typedef unsigned __int64 uint64_t;
  42
  43 #else
  44
  45 #include <inttypes.h>
  46
  47 #endif
  48
  49 ////
  50 //// Configuration
  51 ////
  52
  53 //// For Linux and OSX configuration is done automatically using Makefile.
  54 //// To get started type "make help".
  55 ////
  56 //// For windows part of the configuration is detected automatically, but
  57 //// some switches need to be set manually:
  58 ////
  59 //// -DNDEBUG       | Disable debugging mode. Use always.
  60 ////
  61 //// -DNO_PREFETCH  | Disable use of prefetch asm-instruction. A must if you want the
  62 ////                | executable to run on some very old machines.
  63 ////
  64 //// -DUSE_POPCNT   | Add runtime support for use of popcnt asm-instruction.
  65 ////                | Works only in 64-bit mode. For compiling requires hardware
  66 ////                | with popcnt support. Around 4% speed-up.
  67 ////
  68 //// -DOLD_LOCKS    | By default under Windows are used the fast Slim Reader/Writer (SRW)
  69 ////                | Locks and Condition Variables: these are not supported by Windows XP
  70 ////                | and older, to compile for those platforms you should enable OLD_LOCKS.
  71
  72 // Automatic detection for 64-bit under Windows
  73 #if defined(_WIN64)
  74 #define IS_64BIT
  75 #endif
  76
  77 // Automatic detection for use of bsfq asm-instruction under Windows
  78 #if defined(_WIN64)
  79 #define USE_BSFQ
  80 #endif
  81
  82 // Intel header for _mm_popcnt_u64() intrinsic
  83 #if defined(USE_POPCNT) && defined(_MSC_VER) && defined(__INTEL_COMPILER)
  84 #include <nmmintrin.h>
  85 #endif
  86
  87 // Cache line alignment specification
  88 #if defined(_MSC_VER) || defined(__INTEL_COMPILER)
  89 #define CACHE_LINE_ALIGNMENT __declspec(align(64))
  90 #else
  91 #define CACHE_LINE_ALIGNMENT  __attribute__ ((aligned(64)))
  92 #endif
  93
  94 // Define a __cpuid() function for gcc compilers, for Intel and MSVC
  95 // is already available as an intrinsic.
  96 #if defined(_MSC_VER)
  97 #include <intrin.h>
  98 #elif defined(__GNUC__) && (defined(__i386__) || defined(__x86_64__))
  99 inline void __cpuid(int CPUInfo[4], int InfoType)
 100 {
 101   int* eax = CPUInfo + 0;
 102   int* ebx = CPUInfo + 1;
 103   int* ecx = CPUInfo + 2;
 104   int* edx = CPUInfo + 3;
 105
 106   *eax = InfoType;
 107   *ecx = 0;
 108   __asm__("cpuid" : "=a" (*eax), "=b" (*ebx), "=c" (*ecx), "=d" (*edx)
 109                   : "0" (*eax), "2" (*ecx));
 110 }
 111 #else
 112 inline void __cpuid(int CPUInfo[4], int)
 113 {
 114    CPUInfo[0] = CPUInfo[1] = CPUInfo[2] = CPUInfo[3] = 0;
 115 }
 116 #endif
 117
 118 // Define FORCE_INLINE macro to force inlining overriding compiler choice
 119 #if defined(_MSC_VER)
 120 #define FORCE_INLINE  __forceinline
 121 #elif defined(__GNUC__)
 122 #define FORCE_INLINE  inline __attribute__((always_inline))
 123 #else
 124 #define FORCE_INLINE  inline
 125 #endif
 126
 127 /// cpu_has_popcnt() detects support for popcnt instruction at runtime
 128 inline bool cpu_has_popcnt() {
 129
 130   int CPUInfo[4] = {-1};
 131   __cpuid(CPUInfo, 0x00000001);
 132   return (CPUInfo[2] >> 23) & 1;
 133 }
 134
 135 /// CpuHasPOPCNT is a global constant initialized at startup that
 136 /// is set to true if CPU on which application runs supports popcnt
 137 /// hardware instruction. Unless USE_POPCNT is not defined.
 138 #if defined(USE_POPCNT)
 139 const bool CpuHasPOPCNT = cpu_has_popcnt();
 140 #else
 141 const bool CpuHasPOPCNT = false;
 142 #endif
 143
 144
 145 /// CpuIs64Bit is a global constant initialized at compile time that
 146 /// is set to true if CPU on which application runs is a 64 bits.
 147 #if defined(IS_64BIT)
 148 const bool CpuIs64Bit = true;
 149 #else
 150 const bool CpuIs64Bit = false;
 151 #endif
 152
 153 #include <string>
 154
 155 typedef uint64_t Key;
 156 typedef uint64_t Bitboard;
 157
 158 const int PLY_MAX = 100;
 159 const int PLY_MAX_PLUS_2 = PLY_MAX + 2;
 160
 161 const Bitboard FileABB = 0x0101010101010101ULL;
 162 const Bitboard FileBBB = FileABB << 1;
 163 const Bitboard FileCBB = FileABB << 2;
 164 const Bitboard FileDBB = FileABB << 3;
 165 const Bitboard FileEBB = FileABB << 4;
 166 const Bitboard FileFBB = FileABB << 5;
 167 const Bitboard FileGBB = FileABB << 6;
 168 const Bitboard FileHBB = FileABB << 7;
 169
 170 const Bitboard Rank1BB = 0xFF;
 171 const Bitboard Rank2BB = Rank1BB << (8 * 1);
 172 const Bitboard Rank3BB = Rank1BB << (8 * 2);
 173 const Bitboard Rank4BB = Rank1BB << (8 * 3);
 174 const Bitboard Rank5BB = Rank1BB << (8 * 4);
 175 const Bitboard Rank6BB = Rank1BB << (8 * 5);
 176 const Bitboard Rank7BB = Rank1BB << (8 * 6);
 177 const Bitboard Rank8BB = Rank1BB << (8 * 7);
 178
 179 enum ValueType {
 180   VALUE_TYPE_NONE  = 0,
 181   VALUE_TYPE_UPPER = 1,
 182   VALUE_TYPE_LOWER = 2,
 183   VALUE_TYPE_EXACT = VALUE_TYPE_UPPER | VALUE_TYPE_LOWER
 184 };
 185
 186 enum Value {
 187   VALUE_ZERO      = 0,
 188   VALUE_DRAW      = 0,
 189   VALUE_KNOWN_WIN = 15000,
 190   VALUE_MATE      = 30000,
 191   VALUE_INFINITE  = 30001,
 192   VALUE_NONE      = 30002,
 193
 194   VALUE_MATE_IN_PLY_MAX  =  VALUE_MATE - PLY_MAX,
 195   VALUE_MATED_IN_PLY_MAX = -VALUE_MATE + PLY_MAX,
 196
 197   VALUE_ENSURE_INTEGER_SIZE_P = INT_MAX,
 198   VALUE_ENSURE_INTEGER_SIZE_N = INT_MIN
 199 };
 200
 201 enum PieceType {
 202   PIECE_TYPE_NONE = 0,
 203   PAWN = 1, KNIGHT = 2, BISHOP = 3, ROOK = 4, QUEEN = 5, KING = 6
 204 };
 205
 206 enum Piece {
 207   PIECE_NONE_DARK_SQ = 0, WP = 1, WN = 2, WB = 3, WR = 4, WQ = 5, WK = 6,
 208   BP = 9, BN = 10, BB = 11, BR = 12, BQ = 13, BK = 14, PIECE_NONE = 16
 209 };
 210
 211 enum Color {
 212   WHITE, BLACK, COLOR_NONE
 213 };
 214
 215 enum Depth {
 216
 217   ONE_PLY = 2,
 218
 219   DEPTH_ZERO          =  0 * ONE_PLY,
 220   DEPTH_QS_CHECKS     = -1 * ONE_PLY,
 221   DEPTH_QS_NO_CHECKS  = -2 * ONE_PLY,
 222   DEPTH_QS_RECAPTURES = -4 * ONE_PLY,
 223
 224   DEPTH_NONE = -127 * ONE_PLY
 225 };
 226
 227 enum Square {
 228   SQ_A1, SQ_B1, SQ_C1, SQ_D1, SQ_E1, SQ_F1, SQ_G1, SQ_H1,
 229   SQ_A2, SQ_B2, SQ_C2, SQ_D2, SQ_E2, SQ_F2, SQ_G2, SQ_H2,
 230   SQ_A3, SQ_B3, SQ_C3, SQ_D3, SQ_E3, SQ_F3, SQ_G3, SQ_H3,
 231   SQ_A4, SQ_B4, SQ_C4, SQ_D4, SQ_E4, SQ_F4, SQ_G4, SQ_H4,
 232   SQ_A5, SQ_B5, SQ_C5, SQ_D5, SQ_E5, SQ_F5, SQ_G5, SQ_H5,
 233   SQ_A6, SQ_B6, SQ_C6, SQ_D6, SQ_E6, SQ_F6, SQ_G6, SQ_H6,
 234   SQ_A7, SQ_B7, SQ_C7, SQ_D7, SQ_E7, SQ_F7, SQ_G7, SQ_H7,
 235   SQ_A8, SQ_B8, SQ_C8, SQ_D8, SQ_E8, SQ_F8, SQ_G8, SQ_H8,
 236   SQ_NONE,
 237
 238   DELTA_N =  8,
 239   DELTA_E =  1,
 240   DELTA_S = -8,
 241   DELTA_W = -1,
 242
 243   DELTA_NN = DELTA_N + DELTA_N,
 244   DELTA_NE = DELTA_N + DELTA_E,
 245   DELTA_SE = DELTA_S + DELTA_E,
 246   DELTA_SS = DELTA_S + DELTA_S,
 247   DELTA_SW = DELTA_S + DELTA_W,
 248   DELTA_NW = DELTA_N + DELTA_W
 249 };
 250
 251 enum File {
 252   FILE_A, FILE_B, FILE_C, FILE_D, FILE_E, FILE_F, FILE_G, FILE_H
 253 };
 254
 255 enum Rank {
 256   RANK_1, RANK_2, RANK_3, RANK_4, RANK_5, RANK_6, RANK_7, RANK_8
 257 };
 258
 259 enum SquareColor {
 260   DARK, LIGHT
 261 };
 262
 263 enum ScaleFactor {
 264   SCALE_FACTOR_ZERO   = 0,
 265   SCALE_FACTOR_NORMAL = 64,
 266   SCALE_FACTOR_MAX    = 128,
 267   SCALE_FACTOR_NONE   = 255
 268 };
 269
 270 enum CastleRight {
 271   CASTLES_NONE = 0,
 272   WHITE_OO     = 1,
 273   BLACK_OO     = 2,
 274   WHITE_OOO    = 4,
 275   BLACK_OOO    = 8,
 276   ALL_CASTLES  = 15
 277 };
 278
 279
 280 /// Score enum keeps a midgame and an endgame value in a single
 281 /// integer (enum), first LSB 16 bits are used to store endgame
 282 /// value, while upper bits are used for midgame value. Compiler
 283 /// is free to choose the enum type as long as can keep its data,
 284 /// so ensure Score to be an integer type.
 285 enum Score {
 286     SCORE_ZERO = 0,
 287     SCORE_ENSURE_INTEGER_SIZE_P = INT_MAX,
 288     SCORE_ENSURE_INTEGER_SIZE_N = INT_MIN
 289 };
 290
 291 #define ENABLE_OPERATORS_ON(T) \
 292 inline T operator+ (const T d1, const T d2) { return T(int(d1) + int(d2)); } \
 293 inline T operator- (const T d1, const T d2) { return T(int(d1) - int(d2)); } \
 294 inline T operator* (int i, const T d) {  return T(i * int(d)); } \
 295 inline T operator* (const T d, int i) {  return T(int(d) * i); } \
 296 inline T operator/ (const T d, int i) { return T(int(d) / i); } \
 297 inline T operator- (const T d) { return T(-int(d)); } \
 298 inline T operator++ (T& d, int) {d = T(int(d) + 1); return d; } \
 299 inline T operator-- (T& d, int) { d = T(int(d) - 1); return d; } \
 300 inline void operator+= (T& d1, const T d2) { d1 = d1 + d2; } \
 301 inline void operator-= (T& d1, const T d2) { d1 = d1 - d2; } \
 302 inline void operator*= (T& d, int i) { d = T(int(d) * i); } \
 303 inline void operator/= (T& d, int i) { d = T(int(d) / i); }
 304
 305 ENABLE_OPERATORS_ON(Value)
 306 ENABLE_OPERATORS_ON(PieceType)
 307 ENABLE_OPERATORS_ON(Piece)
 308 ENABLE_OPERATORS_ON(Color)
 309 ENABLE_OPERATORS_ON(Depth)
 310 ENABLE_OPERATORS_ON(Square)
 311 ENABLE_OPERATORS_ON(File)
 312 ENABLE_OPERATORS_ON(Rank)
 313
 314 #undef ENABLE_OPERATORS_ON
 315
 316 // Extra operators for adding integers to a Value
 317 inline Value operator+ (Value v, int i) { return Value(int(v) + i); }
 318 inline Value operator- (Value v, int i) { return Value(int(v) - i); }
 319
 320 // Extracting the _signed_ lower and upper 16 bits it not so trivial
 321 // because according to the standard a simple cast to short is
 322 // implementation defined and so is a right shift of a signed integer.
 323 inline Value mg_value(Score s) { return Value(((s + 32768) & ~0xffff) / 0x10000); }
 324
 325 // Unfortunatly on Intel 64 bit we have a small speed regression, so use a faster code in
 326 // this case, although not 100% standard compliant it seems to work for Intel and MSVC.
 327 #if defined(IS_64BIT) && (!defined(__GNUC__) || defined(__INTEL_COMPILER))
 328 inline Value eg_value(Score s) { return Value(int16_t(s & 0xffff)); }
 329 #else
 330 inline Value eg_value(Score s) { return Value((int)(unsigned(s) & 0x7fffu) - (int)(unsigned(s) & 0x8000u)); }
 331 #endif
 332
 333 inline Score make_score(int mg, int eg) { return Score((mg << 16) + eg); }
 334
 335 // Division must be handled separately for each term
 336 inline Score operator/(Score s, int i) { return make_score(mg_value(s) / i, eg_value(s) / i); }
 337
 338 // Only declared but not defined. We don't want to multiply two scores due to
 339 // a very high risk of overflow. So user should explicitly convert to integer.
 340 inline Score operator*(Score s1, Score s2);
 341
 342 // Remaining Score operators are standard
 343 inline Score operator+ (const Score d1, const Score d2) { return Score(int(d1) + int(d2)); }
 344 inline Score operator- (const Score d1, const Score d2) { return Score(int(d1) - int(d2)); }
 345 inline Score operator* (int i, const Score d) {  return Score(i * int(d)); }
 346 inline Score operator* (const Score d, int i) {  return Score(int(d) * i); }
 347 inline Score operator- (const Score d) { return Score(-int(d)); }
 348 inline void operator+= (Score& d1, const Score d2) { d1 = d1 + d2; }
 349 inline void operator-= (Score& d1, const Score d2) { d1 = d1 - d2; }
 350 inline void operator*= (Score& d, int i) { d = Score(int(d) * i); }
 351 inline void operator/= (Score& d, int i) { d = Score(int(d) / i); }
 352
 353 const Value PawnValueMidgame   = Value(0x0C6);
 354 const Value PawnValueEndgame   = Value(0x102);
 355 const Value KnightValueMidgame = Value(0x331);
 356 const Value KnightValueEndgame = Value(0x34E);
 357 const Value BishopValueMidgame = Value(0x344);
 358 const Value BishopValueEndgame = Value(0x359);
 359 const Value RookValueMidgame   = Value(0x4F6);
 360 const Value RookValueEndgame   = Value(0x4FE);
 361 const Value QueenValueMidgame  = Value(0x9D9);
 362 const Value QueenValueEndgame  = Value(0x9FE);
 363
 364 extern const Value PieceValueMidgame[17];
 365 extern const Value PieceValueEndgame[17];
 366 extern int SquareDistance[64][64];
 367
 368 inline Value value_mate_in(int ply) {
 369   return VALUE_MATE - ply;
 370 }
 371
 372 inline Value value_mated_in(int ply) {
 373   return -VALUE_MATE + ply;
 374 }
 375
 376 inline Piece make_piece(Color c, PieceType pt) {
 377   return Piece((c << 3) | pt);
 378 }
 379
 380 inline PieceType type_of(Piece p)  {
 381   return PieceType(p & 7);
 382 }
 383
 384 inline Color color_of(Piece p) {
 385   return Color(p >> 3);
 386 }
 387
 388 inline Color flip(Color c) {
 389   return Color(c ^ 1);
 390 }
 391
 392 inline Square make_square(File f, Rank r) {
 393   return Square((r << 3) | f);
 394 }
 395
 396 inline bool square_is_ok(Square s) {
 397   return s >= SQ_A1 && s <= SQ_H8;
 398 }
 399
 400 inline File file_of(Square s) {
 401   return File(s & 7);
 402 }
 403
 404 inline Rank rank_of(Square s) {
 405   return Rank(s >> 3);
 406 }
 407
 408 inline Square flip(Square s) {
 409   return Square(s ^ 56);
 410 }
 411
 412 inline Square mirror(Square s) {
 413   return Square(s ^ 7);
 414 }
 415
 416 inline Square relative_square(Color c, Square s) {
 417   return Square(s ^ (c * 56));
 418 }
 419
 420 inline Rank relative_rank(Color c, Rank r) {
 421   return Rank(r ^ (c * 7));
 422 }
 423
 424 inline Rank relative_rank(Color c, Square s) {
 425   return relative_rank(c, rank_of(s));
 426 }
 427
 428 inline SquareColor color_of(Square s) {
 429   return SquareColor(int(rank_of(s) + s) & 1);
 430 }
 431
 432 inline bool opposite_colors(Square s1, Square s2) {
 433   int s = s1 ^ s2;
 434   return ((s >> 3) ^ s) & 1;
 435 }
 436
 437 inline int file_distance(Square s1, Square s2) {
 438   return abs(file_of(s1) - file_of(s2));
 439 }
 440
 441 inline int rank_distance(Square s1, Square s2) {
 442   return abs(rank_of(s1) - rank_of(s2));
 443 }
 444
 445 inline int square_distance(Square s1, Square s2) {
 446   return SquareDistance[s1][s2];
 447 }
 448
 449 inline char piece_type_to_char(PieceType pt) {
 450   return " PNBRQK"[pt];
 451 }
 452
 453 inline char file_to_char(File f) {
 454   return char(f - FILE_A + int('a'));
 455 }
 456
 457 inline char rank_to_char(Rank r) {
 458   return char(r - RANK_1 + int('1'));
 459 }
 460
 461 inline const std::string square_to_string(Square s) {
 462   char ch[] = { file_to_char(file_of(s)), rank_to_char(rank_of(s)), 0 };
 463   return ch;
 464 }
 465
 466 inline Square pawn_push(Color c) {
 467   return c == WHITE ? DELTA_N : DELTA_S;
 468 }
 469
 470 #endif // !defined(TYPES_H_INCLUDED)