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