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