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 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
 176   VALUE_MATE_IN_PLY_MAX  =  VALUE_MATE - PLY_MAX,
 177   VALUE_MATED_IN_PLY_MAX = -VALUE_MATE + PLY_MAX,
 178
 179   VALUE_ENSURE_INTEGER_SIZE_P = INT_MAX,
 180   VALUE_ENSURE_INTEGER_SIZE_N = INT_MIN
 181 };
 182
 183 enum PieceType {
 184   PIECE_TYPE_NONE = 0,
 185   PAWN = 1, KNIGHT = 2, BISHOP = 3, ROOK = 4, QUEEN = 5, KING = 6
 186 };
 187
 188 enum Piece {
 189   PIECE_NONE_DARK_SQ = 0, WP = 1, WN = 2, WB = 3, WR = 4, WQ = 5, WK = 6,
 190   BP = 9, BN = 10, BB = 11, BR = 12, BQ = 13, BK = 14, PIECE_NONE = 16
 191 };
 192
 193 enum Color {
 194   WHITE, BLACK, COLOR_NONE
 195 };
 196
 197 enum Depth {
 198
 199   ONE_PLY = 2,
 200
 201   DEPTH_ZERO          =  0 * ONE_PLY,
 202   DEPTH_QS_CHECKS     = -1 * ONE_PLY,
 203   DEPTH_QS_NO_CHECKS  = -2 * ONE_PLY,
 204   DEPTH_QS_RECAPTURES = -4 * ONE_PLY,
 205
 206   DEPTH_NONE = -127 * ONE_PLY
 207 };
 208
 209 enum Square {
 210   SQ_A1, SQ_B1, SQ_C1, SQ_D1, SQ_E1, SQ_F1, SQ_G1, SQ_H1,
 211   SQ_A2, SQ_B2, SQ_C2, SQ_D2, SQ_E2, SQ_F2, SQ_G2, SQ_H2,
 212   SQ_A3, SQ_B3, SQ_C3, SQ_D3, SQ_E3, SQ_F3, SQ_G3, SQ_H3,
 213   SQ_A4, SQ_B4, SQ_C4, SQ_D4, SQ_E4, SQ_F4, SQ_G4, SQ_H4,
 214   SQ_A5, SQ_B5, SQ_C5, SQ_D5, SQ_E5, SQ_F5, SQ_G5, SQ_H5,
 215   SQ_A6, SQ_B6, SQ_C6, SQ_D6, SQ_E6, SQ_F6, SQ_G6, SQ_H6,
 216   SQ_A7, SQ_B7, SQ_C7, SQ_D7, SQ_E7, SQ_F7, SQ_G7, SQ_H7,
 217   SQ_A8, SQ_B8, SQ_C8, SQ_D8, SQ_E8, SQ_F8, SQ_G8, SQ_H8,
 218   SQ_NONE,
 219
 220   DELTA_N =  8,
 221   DELTA_E =  1,
 222   DELTA_S = -8,
 223   DELTA_W = -1,
 224
 225   DELTA_NN = DELTA_N + DELTA_N,
 226   DELTA_NE = DELTA_N + DELTA_E,
 227   DELTA_SE = DELTA_S + DELTA_E,
 228   DELTA_SS = DELTA_S + DELTA_S,
 229   DELTA_SW = DELTA_S + DELTA_W,
 230   DELTA_NW = DELTA_N + DELTA_W
 231 };
 232
 233 enum File {
 234   FILE_A, FILE_B, FILE_C, FILE_D, FILE_E, FILE_F, FILE_G, FILE_H
 235 };
 236
 237 enum Rank {
 238   RANK_1, RANK_2, RANK_3, RANK_4, RANK_5, RANK_6, RANK_7, RANK_8
 239 };
 240
 241 enum SquareColor {
 242   DARK, LIGHT
 243 };
 244
 245 enum ScaleFactor {
 246   SCALE_FACTOR_ZERO   = 0,
 247   SCALE_FACTOR_NORMAL = 64,
 248   SCALE_FACTOR_MAX    = 128,
 249   SCALE_FACTOR_NONE   = 255
 250 };
 251
 252 enum CastleRight {
 253   CASTLES_NONE = 0,
 254   WHITE_OO     = 1,
 255   BLACK_OO     = 2,
 256   WHITE_OOO    = 4,
 257   BLACK_OOO    = 8,
 258   ALL_CASTLES  = 15
 259 };
 260
 261
 262 /// Score enum keeps a midgame and an endgame value in a single
 263 /// integer (enum), first LSB 16 bits are used to store endgame
 264 /// value, while upper bits are used for midgame value. Compiler
 265 /// is free to choose the enum type as long as can keep its data,
 266 /// so ensure Score to be an integer type.
 267 enum Score {
 268     SCORE_ZERO = 0,
 269     SCORE_ENSURE_INTEGER_SIZE_P = INT_MAX,
 270     SCORE_ENSURE_INTEGER_SIZE_N = INT_MIN
 271 };
 272
 273 #define ENABLE_OPERATORS_ON(T) \
 274 inline T operator+ (const T d1, const T d2) { return T(int(d1) + int(d2)); } \
 275 inline T operator- (const T d1, const T d2) { return T(int(d1) - int(d2)); } \
 276 inline T operator* (int i, const T d) {  return T(i * int(d)); } \
 277 inline T operator* (const T d, int i) {  return T(int(d) * i); } \
 278 inline T operator/ (const T d, int i) { return T(int(d) / i); } \
 279 inline T operator- (const T d) { return T(-int(d)); } \
 280 inline T operator++ (T& d, int) {d = T(int(d) + 1); return d; } \
 281 inline T operator-- (T& d, int) { d = T(int(d) - 1); return d; } \
 282 inline void operator+= (T& d1, const T d2) { d1 = d1 + d2; } \
 283 inline void operator-= (T& d1, const T d2) { d1 = d1 - d2; } \
 284 inline void operator*= (T& d, int i) { d = T(int(d) * i); } \
 285 inline void operator/= (T& d, int i) { d = T(int(d) / i); }
 286
 287 ENABLE_OPERATORS_ON(Value)
 288 ENABLE_OPERATORS_ON(PieceType)
 289 ENABLE_OPERATORS_ON(Piece)
 290 ENABLE_OPERATORS_ON(Color)
 291 ENABLE_OPERATORS_ON(Depth)
 292 ENABLE_OPERATORS_ON(Square)
 293 ENABLE_OPERATORS_ON(File)
 294 ENABLE_OPERATORS_ON(Rank)
 295
 296 #undef ENABLE_OPERATORS_ON
 297
 298 // Extra operators for adding integers to a Value
 299 inline Value operator+ (Value v, int i) { return Value(int(v) + i); }
 300 inline Value operator- (Value v, int i) { return Value(int(v) - i); }
 301
 302 // Extracting the _signed_ lower and upper 16 bits it not so trivial
 303 // because according to the standard a simple cast to short is
 304 // implementation defined and so is a right shift of a signed integer.
 305 inline Value mg_value(Score s) { return Value(((s + 32768) & ~0xffff) / 0x10000); }
 306
 307 // Unfortunatly on Intel 64 bit we have a small speed regression, so use a faster code in
 308 // this case, although not 100% standard compliant it seems to work for Intel and MSVC.
 309 #if defined(IS_64BIT) && (!defined(__GNUC__) || defined(__INTEL_COMPILER))
 310 inline Value eg_value(Score s) { return Value(int16_t(s & 0xffff)); }
 311 #else
 312 inline Value eg_value(Score s) { return Value((int)(unsigned(s) & 0x7fffu) - (int)(unsigned(s) & 0x8000u)); }
 313 #endif
 314
 315 inline Score make_score(int mg, int eg) { return Score((mg << 16) + eg); }
 316
 317 // Division must be handled separately for each term
 318 inline Score operator/(Score s, int i) { return make_score(mg_value(s) / i, eg_value(s) / i); }
 319
 320 // Only declared but not defined. We don't want to multiply two scores due to
 321 // a very high risk of overflow. So user should explicitly convert to integer.
 322 inline Score operator*(Score s1, Score s2);
 323
 324 // Remaining Score operators are standard
 325 inline Score operator+ (const Score d1, const Score d2) { return Score(int(d1) + int(d2)); }
 326 inline Score operator- (const Score d1, const Score d2) { return Score(int(d1) - int(d2)); }
 327 inline Score operator* (int i, const Score d) {  return Score(i * int(d)); }
 328 inline Score operator* (const Score d, int i) {  return Score(int(d) * i); }
 329 inline Score operator- (const Score d) { return Score(-int(d)); }
 330 inline void operator+= (Score& d1, const Score d2) { d1 = d1 + d2; }
 331 inline void operator-= (Score& d1, const Score d2) { d1 = d1 - d2; }
 332 inline void operator*= (Score& d, int i) { d = Score(int(d) * i); }
 333 inline void operator/= (Score& d, int i) { d = Score(int(d) / i); }
 334
 335 const Value PawnValueMidgame   = Value(0x0C6);
 336 const Value PawnValueEndgame   = Value(0x102);
 337 const Value KnightValueMidgame = Value(0x331);
 338 const Value KnightValueEndgame = Value(0x34E);
 339 const Value BishopValueMidgame = Value(0x344);
 340 const Value BishopValueEndgame = Value(0x359);
 341 const Value RookValueMidgame   = Value(0x4F6);
 342 const Value RookValueEndgame   = Value(0x4FE);
 343 const Value QueenValueMidgame  = Value(0x9D9);
 344 const Value QueenValueEndgame  = Value(0x9FE);
 345
 346 extern const Value PieceValueMidgame[17];
 347 extern const Value PieceValueEndgame[17];
 348 extern int SquareDistance[64][64];
 349
 350 inline Value value_mate_in(int ply) {
 351   return VALUE_MATE - ply;
 352 }
 353
 354 inline Value value_mated_in(int ply) {
 355   return -VALUE_MATE + ply;
 356 }
 357
 358 inline Piece make_piece(Color c, PieceType pt) {
 359   return Piece((c << 3) | pt);
 360 }
 361
 362 inline PieceType type_of(Piece p)  {
 363   return PieceType(p & 7);
 364 }
 365
 366 inline Color color_of(Piece p) {
 367   return Color(p >> 3);
 368 }
 369
 370 inline Color flip(Color c) {
 371   return Color(c ^ 1);
 372 }
 373
 374 inline Square make_square(File f, Rank r) {
 375   return Square((r << 3) | f);
 376 }
 377
 378 inline bool square_is_ok(Square s) {
 379   return s >= SQ_A1 && s <= SQ_H8;
 380 }
 381
 382 inline File file_of(Square s) {
 383   return File(s & 7);
 384 }
 385
 386 inline Rank rank_of(Square s) {
 387   return Rank(s >> 3);
 388 }
 389
 390 inline Square flip(Square s) {
 391   return Square(s ^ 56);
 392 }
 393
 394 inline Square mirror(Square s) {
 395   return Square(s ^ 7);
 396 }
 397
 398 inline Square relative_square(Color c, Square s) {
 399   return Square(s ^ (c * 56));
 400 }
 401
 402 inline Rank relative_rank(Color c, Rank r) {
 403   return Rank(r ^ (c * 7));
 404 }
 405
 406 inline Rank relative_rank(Color c, Square s) {
 407   return relative_rank(c, rank_of(s));
 408 }
 409
 410 inline SquareColor color_of(Square s) {
 411   return SquareColor(int(rank_of(s) + s) & 1);
 412 }
 413
 414 inline bool opposite_colors(Square s1, Square s2) {
 415   int s = s1 ^ s2;
 416   return ((s >> 3) ^ s) & 1;
 417 }
 418
 419 inline int file_distance(Square s1, Square s2) {
 420   return abs(file_of(s1) - file_of(s2));
 421 }
 422
 423 inline int rank_distance(Square s1, Square s2) {
 424   return abs(rank_of(s1) - rank_of(s2));
 425 }
 426
 427 inline int square_distance(Square s1, Square s2) {
 428   return SquareDistance[s1][s2];
 429 }
 430
 431 inline char piece_type_to_char(PieceType pt) {
 432   return " PNBRQK"[pt];
 433 }
 434
 435 inline char file_to_char(File f) {
 436   return char(f - FILE_A + int('a'));
 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(file_of(s)), rank_to_char(rank_of(s)), 0 };
 445   return ch;
 446 }
 447
 448 inline Square pawn_push(Color c) {
 449   return c == WHITE ? DELTA_N : DELTA_S;
 450 }
 451
 452 #endif // !defined(TYPES_H_INCLUDED)