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
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.
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.
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/>.
20 #if !defined(TYPES_H_INCLUDED)
21 #define TYPES_H_INCLUDED
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
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;
49 #define Min(x, y) (((x) < (y)) ? (x) : (y))
50 #define Max(x, y) (((x) < (y)) ? (y) : (x))
56 //// For Linux and OSX configuration is done automatically using Makefile.
57 //// To get started type "make help".
59 //// For windows part of the configuration is detected automatically, but
60 //// some switches need to be set manually:
62 //// -DNDEBUG | Disable debugging mode. Use always.
64 //// -DNO_PREFETCH | Disable use of prefetch asm-instruction. A must if you want the
65 //// | executable to run on some very old machines.
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.
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.
75 // Automatic detection for 64-bit under Windows
80 // Automatic detection for use of bsfq asm-instruction under Windows
85 // Intel header for _mm_popcnt_u64() intrinsic
86 #if defined(USE_POPCNT) && defined(_MSC_VER) && defined(__INTEL_COMPILER)
87 #include <nmmintrin.h>
90 // Cache line alignment specification
91 #if defined(_MSC_VER) || defined(__INTEL_COMPILER)
92 #define CACHE_LINE_ALIGNMENT __declspec(align(64))
94 #define CACHE_LINE_ALIGNMENT __attribute__ ((aligned(64)))
97 // Define a __cpuid() function for gcc compilers, for Intel and MSVC
98 // is already available as an intrinsic.
101 #elif defined(__GNUC__) && (defined(__i386__) || defined(__x86_64__))
102 inline void __cpuid(int CPUInfo[4], int InfoType)
104 int* eax = CPUInfo + 0;
105 int* ebx = CPUInfo + 1;
106 int* ecx = CPUInfo + 2;
107 int* edx = CPUInfo + 3;
111 __asm__("cpuid" : "=a" (*eax), "=b" (*ebx), "=c" (*ecx), "=d" (*edx)
112 : "0" (*eax), "2" (*ecx));
115 inline void __cpuid(int CPUInfo[4], int)
117 CPUInfo[0] = CPUInfo[1] = CPUInfo[2] = CPUInfo[3] = 0;
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))
127 #define FORCE_INLINE inline
130 /// cpu_has_popcnt() detects support for popcnt instruction at runtime
131 inline bool cpu_has_popcnt() {
133 int CPUInfo[4] = {-1};
134 __cpuid(CPUInfo, 0x00000001);
135 return (CPUInfo[2] >> 23) & 1;
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();
144 const bool CpuHasPOPCNT = false;
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;
153 const bool CpuIs64Bit = false;
158 typedef uint64_t Key;
159 typedef uint64_t Bitboard;
161 const int PLY_MAX = 100;
162 const int PLY_MAX_PLUS_2 = PLY_MAX + 2;
166 VALUE_TYPE_UPPER = 1,
167 VALUE_TYPE_LOWER = 2,
168 VALUE_TYPE_EXACT = VALUE_TYPE_UPPER | VALUE_TYPE_LOWER
174 VALUE_KNOWN_WIN = 15000,
176 VALUE_INFINITE = 30001,
179 VALUE_MATE_IN_PLY_MAX = VALUE_MATE - PLY_MAX,
180 VALUE_MATED_IN_PLY_MAX = -VALUE_MATE + PLY_MAX,
182 VALUE_ENSURE_INTEGER_SIZE_P = INT_MAX,
183 VALUE_ENSURE_INTEGER_SIZE_N = INT_MIN
188 PAWN = 1, KNIGHT = 2, BISHOP = 3, ROOK = 4, QUEEN = 5, KING = 6
192 PIECE_NONE_DARK_SQ = 0, WP = 1, WN = 2, WB = 3, WR = 4, WQ = 5, WK = 6,
193 BP = 9, BN = 10, BB = 11, BR = 12, BQ = 13, BK = 14, PIECE_NONE = 16
197 WHITE, BLACK, COLOR_NONE
204 DEPTH_ZERO = 0 * ONE_PLY,
205 DEPTH_QS_CHECKS = -1 * ONE_PLY,
206 DEPTH_QS_NO_CHECKS = -2 * ONE_PLY,
208 DEPTH_NONE = -127 * ONE_PLY
212 SQ_A1, SQ_B1, SQ_C1, SQ_D1, SQ_E1, SQ_F1, SQ_G1, SQ_H1,
213 SQ_A2, SQ_B2, SQ_C2, SQ_D2, SQ_E2, SQ_F2, SQ_G2, SQ_H2,
214 SQ_A3, SQ_B3, SQ_C3, SQ_D3, SQ_E3, SQ_F3, SQ_G3, SQ_H3,
215 SQ_A4, SQ_B4, SQ_C4, SQ_D4, SQ_E4, SQ_F4, SQ_G4, SQ_H4,
216 SQ_A5, SQ_B5, SQ_C5, SQ_D5, SQ_E5, SQ_F5, SQ_G5, SQ_H5,
217 SQ_A6, SQ_B6, SQ_C6, SQ_D6, SQ_E6, SQ_F6, SQ_G6, SQ_H6,
218 SQ_A7, SQ_B7, SQ_C7, SQ_D7, SQ_E7, SQ_F7, SQ_G7, SQ_H7,
219 SQ_A8, SQ_B8, SQ_C8, SQ_D8, SQ_E8, SQ_F8, SQ_G8, SQ_H8,
227 DELTA_NN = DELTA_N + DELTA_N,
228 DELTA_NE = DELTA_N + DELTA_E,
229 DELTA_SE = DELTA_S + DELTA_E,
230 DELTA_SS = DELTA_S + DELTA_S,
231 DELTA_SW = DELTA_S + DELTA_W,
232 DELTA_NW = DELTA_N + DELTA_W
236 FILE_A, FILE_B, FILE_C, FILE_D, FILE_E, FILE_F, FILE_G, FILE_H
240 RANK_1, RANK_2, RANK_3, RANK_4, RANK_5, RANK_6, RANK_7, RANK_8
248 SCALE_FACTOR_ZERO = 0,
249 SCALE_FACTOR_NORMAL = 64,
250 SCALE_FACTOR_MAX = 128,
251 SCALE_FACTOR_NONE = 255
255 /// Score enum keeps a midgame and an endgame value in a single
256 /// integer (enum), first LSB 16 bits are used to store endgame
257 /// value, while upper bits are used for midgame value. Compiler
258 /// is free to choose the enum type as long as can keep its data,
259 /// so ensure Score to be an integer type.
262 SCORE_ENSURE_INTEGER_SIZE_P = INT_MAX,
263 SCORE_ENSURE_INTEGER_SIZE_N = INT_MIN
266 #define ENABLE_OPERATORS_ON(T) \
267 inline T operator+ (const T d1, const T d2) { return T(int(d1) + int(d2)); } \
268 inline T operator- (const T d1, const T d2) { return T(int(d1) - int(d2)); } \
269 inline T operator* (int i, const T d) { return T(i * int(d)); } \
270 inline T operator* (const T d, int i) { return T(int(d) * i); } \
271 inline T operator/ (const T d, int i) { return T(int(d) / i); } \
272 inline T operator- (const T d) { return T(-int(d)); } \
273 inline T operator++ (T& d, int) {d = T(int(d) + 1); return d; } \
274 inline T operator-- (T& d, int) { d = T(int(d) - 1); return d; } \
275 inline void operator+= (T& d1, const T d2) { d1 = d1 + d2; } \
276 inline void operator-= (T& d1, const T d2) { d1 = d1 - d2; } \
277 inline void operator*= (T& d, int i) { d = T(int(d) * i); } \
278 inline void operator/= (T& d, int i) { d = T(int(d) / i); }
280 ENABLE_OPERATORS_ON(Value)
281 ENABLE_OPERATORS_ON(PieceType)
282 ENABLE_OPERATORS_ON(Piece)
283 ENABLE_OPERATORS_ON(Color)
284 ENABLE_OPERATORS_ON(Depth)
285 ENABLE_OPERATORS_ON(Square)
286 ENABLE_OPERATORS_ON(File)
287 ENABLE_OPERATORS_ON(Rank)
289 #undef ENABLE_OPERATORS_ON
291 // Extra operators for adding integers to a Value
292 inline Value operator+ (Value v, int i) { return Value(int(v) + i); }
293 inline Value operator- (Value v, int i) { return Value(int(v) - i); }
295 // Extracting the _signed_ lower and upper 16 bits it not so trivial
296 // because according to the standard a simple cast to short is
297 // implementation defined and so is a right shift of a signed integer.
298 inline Value mg_value(Score s) { return Value(((s + 32768) & ~0xffff) / 0x10000); }
300 // Unfortunatly on Intel 64 bit we have a small speed regression, so use a faster code in
301 // this case, although not 100% standard compliant it seems to work for Intel and MSVC.
302 #if defined(IS_64BIT) && (!defined(__GNUC__) || defined(__INTEL_COMPILER))
303 inline Value eg_value(Score s) { return Value(int16_t(s & 0xffff)); }
305 inline Value eg_value(Score s) { return Value((int)(unsigned(s) & 0x7fffu) - (int)(unsigned(s) & 0x8000u)); }
308 inline Score make_score(int mg, int eg) { return Score((mg << 16) + eg); }
310 // Division must be handled separately for each term
311 inline Score operator/(Score s, int i) { return make_score(mg_value(s) / i, eg_value(s) / i); }
313 // Only declared but not defined. We don't want to multiply two scores due to
314 // a very high risk of overflow. So user should explicitly convert to integer.
315 inline Score operator*(Score s1, Score s2);
317 // Remaining Score operators are standard
318 inline Score operator+ (const Score d1, const Score d2) { return Score(int(d1) + int(d2)); }
319 inline Score operator- (const Score d1, const Score d2) { return Score(int(d1) - int(d2)); }
320 inline Score operator* (int i, const Score d) { return Score(i * int(d)); }
321 inline Score operator* (const Score d, int i) { return Score(int(d) * i); }
322 inline Score operator- (const Score d) { return Score(-int(d)); }
323 inline void operator+= (Score& d1, const Score d2) { d1 = d1 + d2; }
324 inline void operator-= (Score& d1, const Score d2) { d1 = d1 - d2; }
325 inline void operator*= (Score& d, int i) { d = Score(int(d) * i); }
326 inline void operator/= (Score& d, int i) { d = Score(int(d) / i); }
328 const Value PawnValueMidgame = Value(0x0C6);
329 const Value PawnValueEndgame = Value(0x102);
330 const Value KnightValueMidgame = Value(0x331);
331 const Value KnightValueEndgame = Value(0x34E);
332 const Value BishopValueMidgame = Value(0x344);
333 const Value BishopValueEndgame = Value(0x359);
334 const Value RookValueMidgame = Value(0x4F6);
335 const Value RookValueEndgame = Value(0x4FE);
336 const Value QueenValueMidgame = Value(0x9D9);
337 const Value QueenValueEndgame = Value(0x9FE);
339 inline Value value_mate_in(int ply) {
340 return VALUE_MATE - ply;
343 inline Value value_mated_in(int ply) {
344 return -VALUE_MATE + ply;
347 inline Piece make_piece(Color c, PieceType pt) {
348 return Piece((c << 3) | pt);
351 inline PieceType type_of_piece(Piece p) {
352 return PieceType(p & 7);
355 inline Color color_of_piece(Piece p) {
356 return Color(p >> 3);
359 inline Color opposite_color(Color c) {
363 inline bool color_is_ok(Color c) {
364 return c == WHITE || c == BLACK;
367 inline bool piece_type_is_ok(PieceType pt) {
368 return pt >= PAWN && pt <= KING;
371 inline bool piece_is_ok(Piece p) {
372 return piece_type_is_ok(type_of_piece(p)) && color_is_ok(color_of_piece(p));
375 inline char piece_type_to_char(PieceType pt) {
376 static const char ch[] = " PNBRQK";
380 inline Square make_square(File f, Rank r) {
381 return Square((r << 3) | f);
384 inline File square_file(Square s) {
388 inline Rank square_rank(Square s) {
392 inline Square flip_square(Square s) {
393 return Square(s ^ 56);
396 inline Square flop_square(Square s) {
397 return Square(s ^ 7);
400 inline Square relative_square(Color c, Square s) {
401 return Square(s ^ (c * 56));
404 inline Rank relative_rank(Color c, Rank r) {
405 return Rank(r ^ (c * 7));
408 inline Rank relative_rank(Color c, Square s) {
409 return relative_rank(c, square_rank(s));
412 inline SquareColor square_color(Square s) {
413 return SquareColor(int(square_rank(s) + s) & 1);
416 inline bool opposite_color_squares(Square s1, Square s2) {
418 return ((s >> 3) ^ s) & 1;
421 inline int file_distance(Square s1, Square s2) {
422 return abs(square_file(s1) - square_file(s2));
425 inline int rank_distance(Square s1, Square s2) {
426 return abs(square_rank(s1) - square_rank(s2));
429 inline int square_distance(Square s1, Square s2) {
430 return Max(file_distance(s1, s2), rank_distance(s1, s2));
433 inline File file_from_char(char c) {
434 return File(c - 'a') + FILE_A;
437 inline char file_to_char(File f) {
438 return char(f - FILE_A + int('a'));
441 inline Rank rank_from_char(char c) {
442 return Rank(c - '1') + RANK_1;
445 inline char rank_to_char(Rank r) {
446 return char(r - RANK_1 + int('1'));
449 inline const std::string square_to_string(Square s) {
450 char ch[] = { file_to_char(square_file(s)), rank_to_char(square_rank(s)), 0 };
451 return std::string(ch);
454 inline bool file_is_ok(File f) {
455 return f >= FILE_A && f <= FILE_H;
458 inline bool rank_is_ok(Rank r) {
459 return r >= RANK_1 && r <= RANK_8;
462 inline bool square_is_ok(Square s) {
463 return s >= SQ_A1 && s <= SQ_H8;
466 inline Square pawn_push(Color c) {
467 return c == WHITE ? DELTA_N : DELTA_S;
470 #endif // !defined(TYPES_H_INCLUDED)