Introduce distance() and unify some API
[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-2014 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 #ifndef 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. Always use this.
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 #define unlikely(x) (x) // For code annotation purposes
46
47 #if defined(_WIN64) && !defined(IS_64BIT)
48 #  include <intrin.h> // MSVC popcnt and bsfq instrinsics
49 #  define IS_64BIT
50 #  define USE_BSFQ
51 #endif
52
53 #if defined(USE_POPCNT) && defined(_MSC_VER) && defined(__INTEL_COMPILER)
54 #  include <nmmintrin.h> // Intel header for _mm_popcnt_u64() intrinsic
55 #endif
56
57 #if defined(USE_PEXT)
58 #  include <immintrin.h> // Header for _pext_u64() intrinsic
59 #else
60 #  define _pext_u64(b, m) (0)
61 #endif
62
63 #  if !defined(NO_PREFETCH) && (defined(__INTEL_COMPILER) || defined(_MSC_VER))
64 #   include <xmmintrin.h> // Intel and Microsoft header for _mm_prefetch()
65 #  endif
66
67 #define CACHE_LINE_SIZE 64
68
69 #ifdef _MSC_VER
70 #  define FORCE_INLINE  __forceinline
71 #elif defined(__GNUC__)
72 #  define FORCE_INLINE  inline __attribute__((always_inline))
73 #else
74 #  define FORCE_INLINE  inline
75 #endif
76
77 #ifdef USE_POPCNT
78 const bool HasPopCnt = true;
79 #else
80 const bool HasPopCnt = false;
81 #endif
82
83 #ifdef USE_PEXT
84 const bool HasPext = true;
85 #else
86 const bool HasPext = false;
87 #endif
88
89 #ifdef IS_64BIT
90 const bool Is64Bit = true;
91 #else
92 const bool Is64Bit = false;
93 #endif
94
95 typedef uint64_t Key;
96 typedef uint64_t Bitboard;
97
98 const int MAX_MOVES = 256;
99 const int MAX_PLY   = 128;
100
101 /// A move needs 16 bits to be stored
102 ///
103 /// bit  0- 5: destination square (from 0 to 63)
104 /// bit  6-11: origin square (from 0 to 63)
105 /// bit 12-13: promotion piece type - 2 (from KNIGHT-2 to QUEEN-2)
106 /// bit 14-15: special move flag: promotion (1), en passant (2), castling (3)
107 /// NOTE: EN-PASSANT bit is set only when a pawn can be captured
108 ///
109 /// Special cases are MOVE_NONE and MOVE_NULL. We can sneak these in because in
110 /// any normal move destination square is always different from origin square
111 /// while MOVE_NONE and MOVE_NULL have the same origin and destination square.
112
113 enum Move {
114   MOVE_NONE,
115   MOVE_NULL = 65
116 };
117
118 enum MoveType {
119   NORMAL,
120   PROMOTION = 1 << 14,
121   ENPASSANT = 2 << 14,
122   CASTLING  = 3 << 14
123 };
124
125 enum Color {
126   WHITE, BLACK, NO_COLOR, COLOR_NB = 2
127 };
128
129 enum CastlingSide {
130   KING_SIDE, QUEEN_SIDE, CASTLING_SIDE_NB = 2
131 };
132
133 enum CastlingRight {
134   NO_CASTLING,
135   WHITE_OO,
136   WHITE_OOO   = WHITE_OO << 1,
137   BLACK_OO    = WHITE_OO << 2,
138   BLACK_OOO   = WHITE_OO << 3,
139   ANY_CASTLING = WHITE_OO | WHITE_OOO | BLACK_OO | BLACK_OOO,
140   CASTLING_RIGHT_NB = 16
141 };
142
143 template<Color C, CastlingSide S> struct MakeCastling {
144   static const CastlingRight
145   right = C == WHITE ? S == QUEEN_SIDE ? WHITE_OOO : WHITE_OO
146                      : S == QUEEN_SIDE ? BLACK_OOO : BLACK_OO;
147 };
148
149 enum Phase {
150   PHASE_ENDGAME,
151   PHASE_MIDGAME = 128,
152   MG = 0, EG = 1, PHASE_NB = 2
153 };
154
155 enum ScaleFactor {
156   SCALE_FACTOR_DRAW    = 0,
157   SCALE_FACTOR_ONEPAWN = 48,
158   SCALE_FACTOR_NORMAL  = 64,
159   SCALE_FACTOR_MAX     = 128,
160   SCALE_FACTOR_NONE    = 255
161 };
162
163 enum Bound {
164   BOUND_NONE,
165   BOUND_UPPER,
166   BOUND_LOWER,
167   BOUND_EXACT = BOUND_UPPER | BOUND_LOWER
168 };
169
170 enum Value {
171   VALUE_ZERO      = 0,
172   VALUE_DRAW      = 0,
173   VALUE_KNOWN_WIN = 10000,
174   VALUE_MATE      = 32000,
175   VALUE_INFINITE  = 32001,
176   VALUE_NONE      = 32002,
177
178   VALUE_MATE_IN_MAX_PLY  =  VALUE_MATE - MAX_PLY,
179   VALUE_MATED_IN_MAX_PLY = -VALUE_MATE + MAX_PLY,
180
181   VALUE_ENSURE_INTEGER_SIZE_P = INT_MAX,
182   VALUE_ENSURE_INTEGER_SIZE_N = INT_MIN,
183
184   PawnValueMg   = 198,   PawnValueEg   = 258,
185   KnightValueMg = 817,   KnightValueEg = 846,
186   BishopValueMg = 836,   BishopValueEg = 857,
187   RookValueMg   = 1270,  RookValueEg   = 1278,
188   QueenValueMg  = 2521,  QueenValueEg  = 2558,
189
190   MidgameLimit  = 15581, EndgameLimit  = 3998
191 };
192
193 enum PieceType {
194   NO_PIECE_TYPE, PAWN, KNIGHT, BISHOP, ROOK, QUEEN, KING,
195   ALL_PIECES = 0,
196   PIECE_TYPE_NB = 8
197 };
198
199 enum Piece {
200   NO_PIECE,
201   W_PAWN = 1, W_KNIGHT, W_BISHOP, W_ROOK, W_QUEEN, W_KING,
202   B_PAWN = 9, B_KNIGHT, B_BISHOP, B_ROOK, B_QUEEN, B_KING,
203   PIECE_NB = 16
204 };
205
206 enum Depth {
207
208   ONE_PLY = 1,
209
210   DEPTH_ZERO          =  0,
211   DEPTH_QS_CHECKS     =  0,
212   DEPTH_QS_NO_CHECKS  = -1,
213   DEPTH_QS_RECAPTURES = -5,
214
215   DEPTH_NONE = -6
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   SQUARE_NB = 64,
230
231   DELTA_N =  8,
232   DELTA_E =  1,
233   DELTA_S = -8,
234   DELTA_W = -1,
235
236   DELTA_NN = DELTA_N + DELTA_N,
237   DELTA_NE = DELTA_N + DELTA_E,
238   DELTA_SE = DELTA_S + DELTA_E,
239   DELTA_SS = DELTA_S + DELTA_S,
240   DELTA_SW = DELTA_S + DELTA_W,
241   DELTA_NW = DELTA_N + DELTA_W
242 };
243
244 enum File {
245   FILE_A, FILE_B, FILE_C, FILE_D, FILE_E, FILE_F, FILE_G, FILE_H, FILE_NB
246 };
247
248 enum Rank {
249   RANK_1, RANK_2, RANK_3, RANK_4, RANK_5, RANK_6, RANK_7, RANK_8, RANK_NB
250 };
251
252
253 /// The Score enum stores a middlegame and an endgame value in a single integer
254 /// (enum). The least significant 16 bits are used to store the endgame value
255 /// and the upper 16 bits are used to store the middlegame value. The compiler
256 /// is free to choose the enum type as long as it can store the data, so we
257 /// ensure that Score is an integer type by assigning some big int values.
258 enum Score {
259   SCORE_ZERO,
260   SCORE_ENSURE_INTEGER_SIZE_P = INT_MAX,
261   SCORE_ENSURE_INTEGER_SIZE_N = INT_MIN
262 };
263
264 inline Score make_score(int mg, int eg) { return Score((mg << 16) + eg); }
265
266 /// Extracting the signed lower and upper 16 bits is not so trivial because
267 /// according to the standard a simple cast to short is implementation defined
268 /// and so is a right shift of a signed integer.
269 inline Value mg_value(Score s) {
270   return Value(((s + 0x8000) & ~0xffff) / 0x10000);
271 }
272
273 inline Value eg_value(Score s) {
274   return Value((int)(unsigned(s) & 0x7FFFU) - (int)(unsigned(s) & 0x8000U));
275 }
276
277 #define ENABLE_BASE_OPERATORS_ON(T)                                         \
278 inline T operator+(const T d1, const T d2) { return T(int(d1) + int(d2)); } \
279 inline T operator-(const T d1, const T d2) { return T(int(d1) - int(d2)); } \
280 inline T operator*(int i, const T d) { return T(i * int(d)); }              \
281 inline T operator*(const T d, int i) { return T(int(d) * i); }              \
282 inline T operator-(const T d) { return T(-int(d)); }                        \
283 inline T& operator+=(T& d1, const T d2) { return d1 = d1 + d2; }            \
284 inline T& operator-=(T& d1, const T d2) { return d1 = d1 - d2; }            \
285 inline T& operator*=(T& d, int i) { return d = T(int(d) * i); }
286
287 ENABLE_BASE_OPERATORS_ON(Score)
288
289 #define ENABLE_FULL_OPERATORS_ON(T)                                         \
290 ENABLE_BASE_OPERATORS_ON(T)                                                 \
291 inline T& operator++(T& d) { return d = T(int(d) + 1); }                    \
292 inline T& operator--(T& d) { return d = T(int(d) - 1); }                    \
293 inline T operator/(const T d, int i) { return T(int(d) / i); }              \
294 inline T& operator/=(T& d, int i) { return d = T(int(d) / i); }
295
296 ENABLE_FULL_OPERATORS_ON(Value)
297 ENABLE_FULL_OPERATORS_ON(PieceType)
298 ENABLE_FULL_OPERATORS_ON(Piece)
299 ENABLE_FULL_OPERATORS_ON(Color)
300 ENABLE_FULL_OPERATORS_ON(Depth)
301 ENABLE_FULL_OPERATORS_ON(Square)
302 ENABLE_FULL_OPERATORS_ON(File)
303 ENABLE_FULL_OPERATORS_ON(Rank)
304
305 #undef ENABLE_FULL_OPERATORS_ON
306 #undef ENABLE_BASE_OPERATORS_ON
307
308 /// Additional operators to add 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 inline Value& operator+=(Value& v, int i) { return v = v + i; }
312 inline Value& operator-=(Value& v, int i) { return v = v - i; }
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 extern Value PieceValue[PHASE_NB][PIECE_NB];
324
325 struct ExtMove {
326   Move move;
327   Value value;
328 };
329
330 inline bool operator<(const ExtMove& f, const ExtMove& s) {
331   return f.value < s.value;
332 }
333
334 inline Color operator~(Color c) {
335   return Color(c ^ BLACK);
336 }
337
338 inline Square operator~(Square s) {
339   return Square(s ^ SQ_A8); // Vertical flip SQ_A1 -> SQ_A8
340 }
341
342 inline CastlingRight operator|(Color c, CastlingSide s) {
343   return CastlingRight(WHITE_OO << ((s == QUEEN_SIDE) + 2 * c));
344 }
345
346 inline Value mate_in(int ply) {
347   return VALUE_MATE - ply;
348 }
349
350 inline Value mated_in(int ply) {
351   return -VALUE_MATE + ply;
352 }
353
354 inline Square make_square(File f, Rank r) {
355   return Square((r << 3) | f);
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 pc)  {
363   return PieceType(pc & 7);
364 }
365
366 inline Color color_of(Piece pc) {
367   assert(pc != NO_PIECE);
368   return Color(pc >> 3);
369 }
370
371 inline bool is_ok(Square s) {
372   return s >= SQ_A1 && s <= SQ_H8;
373 }
374
375 inline File file_of(Square s) {
376   return File(s & 7);
377 }
378
379 inline Rank rank_of(Square s) {
380   return Rank(s >> 3);
381 }
382
383 inline Square relative_square(Color c, Square s) {
384   return Square(s ^ (c * 56));
385 }
386
387 inline Rank relative_rank(Color c, Rank r) {
388   return Rank(r ^ (c * 7));
389 }
390
391 inline Rank relative_rank(Color c, Square s) {
392   return relative_rank(c, rank_of(s));
393 }
394
395 inline bool opposite_colors(Square s1, Square s2) {
396   int s = int(s1) ^ int(s2);
397   return ((s >> 3) ^ s) & 1;
398 }
399
400 inline Square pawn_push(Color c) {
401   return c == WHITE ? DELTA_N : DELTA_S;
402 }
403
404 inline Square from_sq(Move m) {
405   return Square((m >> 6) & 0x3F);
406 }
407
408 inline Square to_sq(Move m) {
409   return Square(m & 0x3F);
410 }
411
412 inline MoveType type_of(Move m) {
413   return MoveType(m & (3 << 14));
414 }
415
416 inline PieceType promotion_type(Move m) {
417   return PieceType(((m >> 12) & 3) + 2);
418 }
419
420 inline Move make_move(Square from, Square to) {
421   return Move(to | (from << 6));
422 }
423
424 template<MoveType T>
425 inline Move make(Square from, Square to, PieceType pt = KNIGHT) {
426   return Move(to | (from << 6) | T | ((pt - KNIGHT) << 12));
427 }
428
429 inline bool is_ok(Move m) {
430   return from_sq(m) != to_sq(m); // Catches also MOVE_NULL and MOVE_NONE
431 }
432
433 #endif // #ifndef TYPES_H_INCLUDED