1e036e8997ce421437ef2632594d80b148043129
[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-2013 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 #include <cassert>
39 #include <cctype>
40 #include <climits>
41 #include <cstdlib>
42
43 #include "platform.h"
44
45 #if defined(_WIN64) && !defined(IS_64BIT)
46 #  include <intrin.h> // MSVC popcnt and bsfq instrinsics
47 #  define IS_64BIT
48 #  define USE_BSFQ
49 #endif
50
51 #if defined(USE_POPCNT) && defined(_MSC_VER) && defined(__INTEL_COMPILER)
52 #  include <nmmintrin.h> // Intel header for _mm_popcnt_u64() intrinsic
53 #endif
54
55 #  if !defined(NO_PREFETCH) && (defined(__INTEL_COMPILER) || defined(_MSC_VER))
56 #   include <xmmintrin.h> // Intel and Microsoft header for _mm_prefetch()
57 #  endif
58
59 #define CACHE_LINE_SIZE 64
60 #if defined(_MSC_VER) || defined(__INTEL_COMPILER)
61 #  define CACHE_LINE_ALIGNMENT __declspec(align(CACHE_LINE_SIZE))
62 #else
63 #  define CACHE_LINE_ALIGNMENT  __attribute__ ((aligned(CACHE_LINE_SIZE)))
64 #endif
65
66 #if defined(_MSC_VER)
67 #  define FORCE_INLINE  __forceinline
68 #elif defined(__GNUC__)
69 #  define FORCE_INLINE  inline __attribute__((always_inline))
70 #else
71 #  define FORCE_INLINE  inline
72 #endif
73
74 #if defined(USE_POPCNT)
75 const bool HasPopCnt = true;
76 #else
77 const bool HasPopCnt = false;
78 #endif
79
80 #if defined(IS_64BIT)
81 const bool Is64Bit = true;
82 #else
83 const bool Is64Bit = false;
84 #endif
85
86 typedef uint64_t Key;
87 typedef uint64_t Bitboard;
88
89 const int MAX_MOVES      = 192;
90 const int MAX_PLY        = 100;
91 const int MAX_PLY_PLUS_2 = MAX_PLY + 2;
92
93 const Bitboard FileABB = 0x0101010101010101ULL;
94 const Bitboard FileBBB = FileABB << 1;
95 const Bitboard FileCBB = FileABB << 2;
96 const Bitboard FileDBB = FileABB << 3;
97 const Bitboard FileEBB = FileABB << 4;
98 const Bitboard FileFBB = FileABB << 5;
99 const Bitboard FileGBB = FileABB << 6;
100 const Bitboard FileHBB = FileABB << 7;
101
102 const Bitboard Rank1BB = 0xFF;
103 const Bitboard Rank2BB = Rank1BB << (8 * 1);
104 const Bitboard Rank3BB = Rank1BB << (8 * 2);
105 const Bitboard Rank4BB = Rank1BB << (8 * 3);
106 const Bitboard Rank5BB = Rank1BB << (8 * 4);
107 const Bitboard Rank6BB = Rank1BB << (8 * 5);
108 const Bitboard Rank7BB = Rank1BB << (8 * 6);
109 const Bitboard Rank8BB = Rank1BB << (8 * 7);
110
111
112 /// A move needs 16 bits to be stored
113 ///
114 /// bit  0- 5: destination square (from 0 to 63)
115 /// bit  6-11: origin square (from 0 to 63)
116 /// bit 12-13: promotion piece type - 2 (from KNIGHT-2 to QUEEN-2)
117 /// bit 14-15: special move flag: promotion (1), en passant (2), castle (3)
118 ///
119 /// Special cases are MOVE_NONE and MOVE_NULL. We can sneak these in because in
120 /// any normal move destination square is always different from origin square
121 /// while MOVE_NONE and MOVE_NULL have the same origin and destination square.
122
123 enum Move {
124   MOVE_NONE = 0,
125   MOVE_NULL = 65
126 };
127
128 enum MoveType {
129   NORMAL    = 0,
130   PROMOTION = 1 << 14,
131   ENPASSANT = 2 << 14,
132   CASTLE    = 3 << 14
133 };
134
135 enum CastleRight {  // Defined as in PolyGlot book hash key
136   CASTLES_NONE = 0,
137   WHITE_OO     = 1,
138   WHITE_OOO    = 2,
139   BLACK_OO     = 4,
140   BLACK_OOO    = 8,
141   ALL_CASTLES  = 15,
142   CASTLE_RIGHT_NB = 16
143 };
144
145 enum CastlingSide {
146   KING_SIDE,
147   QUEEN_SIDE,
148   CASTLING_SIDE_NB = 2
149 };
150
151 enum Phase {
152   PHASE_ENDGAME = 0,
153   PHASE_MIDGAME = 128,
154   MG = 0, EG = 1, PHASE_NB = 2
155 };
156
157 enum ScaleFactor {
158   SCALE_FACTOR_DRAW   = 0,
159   SCALE_FACTOR_NORMAL = 64,
160   SCALE_FACTOR_MAX    = 128,
161   SCALE_FACTOR_NONE   = 255
162 };
163
164 enum Bound {
165   BOUND_NONE  = 0,
166   BOUND_UPPER = 1,
167   BOUND_LOWER = 2,
168   BOUND_EXACT = BOUND_UPPER | BOUND_LOWER
169 };
170
171 enum Value {
172   VALUE_ZERO      = 0,
173   VALUE_DRAW      = 0,
174   VALUE_KNOWN_WIN = 15000,
175   VALUE_MATE      = 30000,
176   VALUE_INFINITE  = 30001,
177   VALUE_NONE      = 30002,
178
179   VALUE_MATE_IN_MAX_PLY  =  VALUE_MATE - MAX_PLY,
180   VALUE_MATED_IN_MAX_PLY = -VALUE_MATE + MAX_PLY,
181
182   VALUE_ENSURE_INTEGER_SIZE_P = INT_MAX,
183   VALUE_ENSURE_INTEGER_SIZE_N = INT_MIN,
184
185   PawnValueMg   = 198,   PawnValueEg   = 258,
186   KnightValueMg = 817,   KnightValueEg = 846,
187   BishopValueMg = 836,   BishopValueEg = 857,
188   RookValueMg   = 1270,  RookValueEg   = 1278,
189   QueenValueMg  = 2521,  QueenValueEg  = 2558
190 };
191
192 enum PieceType {
193   NO_PIECE_TYPE = 0, ALL_PIECES = 0,
194   PAWN = 1, KNIGHT = 2, BISHOP = 3, ROOK = 4, QUEEN = 5, KING = 6,
195   PIECE_TYPE_NB = 8
196 };
197
198 enum Piece {
199   NO_PIECE = 0,
200   W_PAWN = 1, W_KNIGHT =  2, W_BISHOP =  3, W_ROOK =  4, W_QUEEN =  5, W_KING =  6,
201   B_PAWN = 9, B_KNIGHT = 10, B_BISHOP = 11, B_ROOK = 12, B_QUEEN = 13, B_KING = 14,
202   PIECE_NB = 16
203 };
204
205 enum Color {
206   WHITE, BLACK, NO_COLOR, COLOR_NB = 2
207 };
208
209 enum Depth {
210
211   ONE_PLY = 2,
212
213   DEPTH_ZERO          =  0 * ONE_PLY,
214   DEPTH_QS_CHECKS     = -1 * ONE_PLY,
215   DEPTH_QS_NO_CHECKS  = -2 * ONE_PLY,
216   DEPTH_QS_RECAPTURES = -7 * ONE_PLY,
217
218   DEPTH_NONE = -127 * ONE_PLY
219 };
220
221 enum Square {
222   SQ_A1, SQ_B1, SQ_C1, SQ_D1, SQ_E1, SQ_F1, SQ_G1, SQ_H1,
223   SQ_A2, SQ_B2, SQ_C2, SQ_D2, SQ_E2, SQ_F2, SQ_G2, SQ_H2,
224   SQ_A3, SQ_B3, SQ_C3, SQ_D3, SQ_E3, SQ_F3, SQ_G3, SQ_H3,
225   SQ_A4, SQ_B4, SQ_C4, SQ_D4, SQ_E4, SQ_F4, SQ_G4, SQ_H4,
226   SQ_A5, SQ_B5, SQ_C5, SQ_D5, SQ_E5, SQ_F5, SQ_G5, SQ_H5,
227   SQ_A6, SQ_B6, SQ_C6, SQ_D6, SQ_E6, SQ_F6, SQ_G6, SQ_H6,
228   SQ_A7, SQ_B7, SQ_C7, SQ_D7, SQ_E7, SQ_F7, SQ_G7, SQ_H7,
229   SQ_A8, SQ_B8, SQ_C8, SQ_D8, SQ_E8, SQ_F8, SQ_G8, SQ_H8,
230   SQ_NONE,
231
232   SQUARE_NB = 64,
233
234   DELTA_N =  8,
235   DELTA_E =  1,
236   DELTA_S = -8,
237   DELTA_W = -1,
238
239   DELTA_NN = DELTA_N + DELTA_N,
240   DELTA_NE = DELTA_N + DELTA_E,
241   DELTA_SE = DELTA_S + DELTA_E,
242   DELTA_SS = DELTA_S + DELTA_S,
243   DELTA_SW = DELTA_S + DELTA_W,
244   DELTA_NW = DELTA_N + DELTA_W
245 };
246
247 enum File {
248   FILE_A, FILE_B, FILE_C, FILE_D, FILE_E, FILE_F, FILE_G, FILE_H, FILE_NB = 8
249 };
250
251 enum Rank {
252   RANK_1, RANK_2, RANK_3, RANK_4, RANK_5, RANK_6, RANK_7, RANK_8, RANK_NB = 8
253 };
254
255
256 /// Score enum keeps a midgame and an endgame value in a single integer (enum),
257 /// first LSB 16 bits are used to store endgame value, while upper bits are used
258 /// for midgame value. Compiler is free to choose the enum type as long as can
259 /// keep its data, so ensure Score to be an integer type.
260 enum Score {
261   SCORE_ZERO = 0,
262   SCORE_ENSURE_INTEGER_SIZE_P = INT_MAX,
263   SCORE_ENSURE_INTEGER_SIZE_N = INT_MIN
264 };
265
266 inline Score make_score(int mg, int eg) { return Score((mg << 16) + eg); }
267
268 /// Extracting the signed lower and upper 16 bits it not so trivial because
269 /// according to the standard a simple cast to short is implementation defined
270 /// and so is a right shift of a signed integer.
271 inline Value mg_value(Score s) { return Value(((s + 0x8000) & ~0xffff) / 0x10000); }
272
273 /// On Intel 64 bit we have a small speed regression with the standard conforming
274 /// version, so use a faster code in this case that, although not 100% standard
275 /// compliant it seems to work for Intel and MSVC.
276 #if defined(IS_64BIT) && (!defined(__GNUC__) || defined(__INTEL_COMPILER))
277
278 inline Value eg_value(Score s) { return Value(int16_t(s & 0xffff)); }
279
280 #else
281
282 inline Value eg_value(Score s) {
283   return Value((int)(unsigned(s) & 0x7fffu) - (int)(unsigned(s) & 0x8000u));
284 }
285
286 #endif
287
288 #define ENABLE_SAFE_OPERATORS_ON(T)                                         \
289 inline T operator+(const T d1, const T d2) { return T(int(d1) + int(d2)); } \
290 inline T operator-(const T d1, const T d2) { return T(int(d1) - int(d2)); } \
291 inline T operator*(int i, const T d) { return T(i * int(d)); }              \
292 inline T operator*(const T d, int i) { return T(int(d) * i); }              \
293 inline T operator-(const T d) { return T(-int(d)); }                        \
294 inline T& operator+=(T& d1, const T d2) { d1 = d1 + d2; return d1; }        \
295 inline T& operator-=(T& d1, const T d2) { d1 = d1 - d2; return d1; }        \
296 inline T& operator*=(T& d, int i) { d = T(int(d) * i); return d; }
297
298 #define ENABLE_OPERATORS_ON(T) ENABLE_SAFE_OPERATORS_ON(T)                  \
299 inline T operator++(T& d, int) { d = T(int(d) + 1); return d; }             \
300 inline T operator--(T& d, int) { d = T(int(d) - 1); return d; }             \
301 inline T operator/(const T d, int i) { return T(int(d) / i); }              \
302 inline T& operator/=(T& d, int i) { d = T(int(d) / i); return d; }
303
304 ENABLE_OPERATORS_ON(Value)
305 ENABLE_OPERATORS_ON(PieceType)
306 ENABLE_OPERATORS_ON(Piece)
307 ENABLE_OPERATORS_ON(Color)
308 ENABLE_OPERATORS_ON(Depth)
309 ENABLE_OPERATORS_ON(Square)
310 ENABLE_OPERATORS_ON(File)
311 ENABLE_OPERATORS_ON(Rank)
312
313 /// Added operators for adding integers to a Value
314 inline Value operator+(Value v, int i) { return Value(int(v) + i); }
315 inline Value operator-(Value v, int i) { return Value(int(v) - i); }
316
317 ENABLE_SAFE_OPERATORS_ON(Score)
318
319 /// Only declared but not defined. We don't want to multiply two scores due to
320 /// a very high risk of overflow. So user should explicitly convert to integer.
321 inline Score operator*(Score s1, Score s2);
322
323 /// Division of a Score must be handled separately for each term
324 inline Score operator/(Score s, int i) {
325   return make_score(mg_value(s) / i, eg_value(s) / i);
326 }
327
328 /// Weight score v by score w trying to prevent overflow
329 inline Score apply_weight(Score v, Score w) {
330   return make_score((int(mg_value(v)) * mg_value(w)) / 0x100,
331                     (int(eg_value(v)) * eg_value(w)) / 0x100);
332 }
333
334 #undef ENABLE_OPERATORS_ON
335 #undef ENABLE_SAFE_OPERATORS_ON
336
337 namespace Zobrist {
338
339   extern Key psq[COLOR_NB][PIECE_TYPE_NB][SQUARE_NB];
340   extern Key enpassant[FILE_NB];
341   extern Key castle[CASTLE_RIGHT_NB];
342   extern Key side;
343   extern Key exclusion;
344
345   void init();
346 }
347
348 CACHE_LINE_ALIGNMENT
349
350 extern Score pieceSquareTable[PIECE_NB][SQUARE_NB];
351 extern Value PieceValue[PHASE_NB][PIECE_NB];
352 extern int SquareDistance[SQUARE_NB][SQUARE_NB];
353
354 struct MoveStack {
355   Move move;
356   int score;
357 };
358
359 inline bool operator<(const MoveStack& f, const MoveStack& s) {
360   return f.score < s.score;
361 }
362
363 inline Color operator~(Color c) {
364   return Color(c ^ 1);
365 }
366
367 inline Square operator~(Square s) {
368   return Square(s ^ 56); // Vertical flip SQ_A1 -> SQ_A8
369 }
370
371 inline Square operator|(File f, Rank r) {
372   return Square((r << 3) | f);
373 }
374
375 inline Value mate_in(int ply) {
376   return VALUE_MATE - ply;
377 }
378
379 inline Value mated_in(int ply) {
380   return -VALUE_MATE + ply;
381 }
382
383 inline Piece make_piece(Color c, PieceType pt) {
384   return Piece((c << 3) | pt);
385 }
386
387 inline CastleRight make_castle_right(Color c, CastlingSide s) {
388   return CastleRight(WHITE_OO << ((s == QUEEN_SIDE) + 2 * c));
389 }
390
391 inline PieceType type_of(Piece p)  {
392   return PieceType(p & 7);
393 }
394
395 inline Color color_of(Piece p) {
396   assert(p != NO_PIECE);
397   return Color(p >> 3);
398 }
399
400 inline bool is_ok(Square s) {
401   return s >= SQ_A1 && s <= SQ_H8;
402 }
403
404 inline File file_of(Square s) {
405   return File(s & 7);
406 }
407
408 inline Rank rank_of(Square s) {
409   return Rank(s >> 3);
410 }
411
412 inline Square mirror(Square s) {
413   return Square(s ^ 7); // Horizontal flip SQ_A1 -> SQ_H1
414 }
415
416 inline Square relative_square(Color c, Square s) {
417   return Square(s ^ (c * 56));
418 }
419
420 inline Rank relative_rank(Color c, Rank r) {
421   return Rank(r ^ (c * 7));
422 }
423
424 inline Rank relative_rank(Color c, Square s) {
425   return relative_rank(c, rank_of(s));
426 }
427
428 inline bool opposite_colors(Square s1, Square s2) {
429   int s = int(s1) ^ int(s2);
430   return ((s >> 3) ^ s) & 1;
431 }
432
433 inline int file_distance(Square s1, Square s2) {
434   return abs(file_of(s1) - file_of(s2));
435 }
436
437 inline int rank_distance(Square s1, Square s2) {
438   return abs(rank_of(s1) - rank_of(s2));
439 }
440
441 inline int square_distance(Square s1, Square s2) {
442   return SquareDistance[s1][s2];
443 }
444
445 inline char file_to_char(File f, bool tolower = true) {
446   return char(f - FILE_A + (tolower ? 'a' : 'A'));
447 }
448
449 inline char rank_to_char(Rank r) {
450   return char(r - RANK_1 + '1');
451 }
452
453 inline Square pawn_push(Color c) {
454   return c == WHITE ? DELTA_N : DELTA_S;
455 }
456
457 inline Square from_sq(Move m) {
458   return Square((m >> 6) & 0x3F);
459 }
460
461 inline Square to_sq(Move m) {
462   return Square(m & 0x3F);
463 }
464
465 inline MoveType type_of(Move m) {
466   return MoveType(m & (3 << 14));
467 }
468
469 inline PieceType promotion_type(Move m) {
470   return PieceType(((m >> 12) & 3) + 2);
471 }
472
473 inline Move make_move(Square from, Square to) {
474   return Move(to | (from << 6));
475 }
476
477 template<MoveType T>
478 inline Move make(Square from, Square to, PieceType pt = KNIGHT) {
479   return Move(to | (from << 6) | T | ((pt - KNIGHT) << 12));
480 }
481
482 inline bool is_ok(Move m) {
483   return from_sq(m) != to_sq(m); // Catches also MOVE_NULL and MOVE_NONE
484 }
485
486 #include <string>
487
488 inline const std::string square_to_string(Square s) {
489   char ch[] = { file_to_char(file_of(s)), rank_to_char(rank_of(s)), 0 };
490   return ch;
491 }
492
493 #endif // !defined(TYPES_H_INCLUDED)