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