3cfaa072ae5f2bf71f0693c7e9d998d0135226e4
[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 - 2 * MAX_PLY,
179   VALUE_MATED_IN_MAX_PLY = -VALUE_MATE + 2 * 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   DEPTH_MAX  = MAX_PLY
217 };
218
219 enum Square {
220   SQ_A1, SQ_B1, SQ_C1, SQ_D1, SQ_E1, SQ_F1, SQ_G1, SQ_H1,
221   SQ_A2, SQ_B2, SQ_C2, SQ_D2, SQ_E2, SQ_F2, SQ_G2, SQ_H2,
222   SQ_A3, SQ_B3, SQ_C3, SQ_D3, SQ_E3, SQ_F3, SQ_G3, SQ_H3,
223   SQ_A4, SQ_B4, SQ_C4, SQ_D4, SQ_E4, SQ_F4, SQ_G4, SQ_H4,
224   SQ_A5, SQ_B5, SQ_C5, SQ_D5, SQ_E5, SQ_F5, SQ_G5, SQ_H5,
225   SQ_A6, SQ_B6, SQ_C6, SQ_D6, SQ_E6, SQ_F6, SQ_G6, SQ_H6,
226   SQ_A7, SQ_B7, SQ_C7, SQ_D7, SQ_E7, SQ_F7, SQ_G7, SQ_H7,
227   SQ_A8, SQ_B8, SQ_C8, SQ_D8, SQ_E8, SQ_F8, SQ_G8, SQ_H8,
228   SQ_NONE,
229
230   SQUARE_NB = 64,
231
232   DELTA_N =  8,
233   DELTA_E =  1,
234   DELTA_S = -8,
235   DELTA_W = -1,
236
237   DELTA_NN = DELTA_N + DELTA_N,
238   DELTA_NE = DELTA_N + DELTA_E,
239   DELTA_SE = DELTA_S + DELTA_E,
240   DELTA_SS = DELTA_S + DELTA_S,
241   DELTA_SW = DELTA_S + DELTA_W,
242   DELTA_NW = DELTA_N + DELTA_W
243 };
244
245 enum File {
246   FILE_A, FILE_B, FILE_C, FILE_D, FILE_E, FILE_F, FILE_G, FILE_H, FILE_NB
247 };
248
249 enum Rank {
250   RANK_1, RANK_2, RANK_3, RANK_4, RANK_5, RANK_6, RANK_7, RANK_8, RANK_NB
251 };
252
253
254 /// The Score enum stores a middlegame and an endgame value in a single integer
255 /// (enum). The least significant 16 bits are used to store the endgame value
256 /// and the upper 16 bits are used to store the middlegame value. The compiler
257 /// is free to choose the enum type as long as it can store the data, so we
258 /// ensure that Score is an integer type by assigning some big int values.
259 enum Score {
260   SCORE_ZERO,
261   SCORE_ENSURE_INTEGER_SIZE_P = INT_MAX,
262   SCORE_ENSURE_INTEGER_SIZE_N = INT_MIN
263 };
264
265 inline Score make_score(int mg, int eg) { return Score((mg << 16) + eg); }
266
267 /// Extracting the signed lower and upper 16 bits is not so trivial because
268 /// according to the standard a simple cast to short is implementation defined
269 /// and so is a right shift of a signed integer.
270 inline Value mg_value(Score s) {
271   return Value(((s + 0x8000) & ~0xffff) / 0x10000);
272 }
273
274 inline Value eg_value(Score s) {
275   return Value((int)(unsigned(s) & 0x7FFFU) - (int)(unsigned(s) & 0x8000U));
276 }
277
278 #define ENABLE_BASE_OPERATORS_ON(T)                             \
279 inline T operator+(T d1, T d2) { return T(int(d1) + int(d2)); } \
280 inline T operator-(T d1, T d2) { return T(int(d1) - int(d2)); } \
281 inline T operator*(int i, T d) { return T(i * int(d)); }        \
282 inline T operator*(T d, int i) { return T(int(d) * i); }        \
283 inline T operator-(T d) { return T(-int(d)); }                  \
284 inline T& operator+=(T& d1, T d2) { return d1 = d1 + d2; }      \
285 inline T& operator-=(T& d1, T d2) { return d1 = d1 - d2; }      \
286 inline T& operator*=(T& d, int i) { return d = T(int(d) * i); }
287
288 ENABLE_BASE_OPERATORS_ON(Score)
289
290 #define ENABLE_FULL_OPERATORS_ON(T)                             \
291 ENABLE_BASE_OPERATORS_ON(T)                                     \
292 inline T& operator++(T& d) { return d = T(int(d) + 1); }        \
293 inline T& operator--(T& d) { return d = T(int(d) - 1); }        \
294 inline T operator/(T d, int i) { return T(int(d) / i); }        \
295 inline int operator/(T d1, T d2) { return int(d1) / int(d2); }  \
296 inline T& operator/=(T& d, int i) { return d = T(int(d) / i); }
297
298 ENABLE_FULL_OPERATORS_ON(Value)
299 ENABLE_FULL_OPERATORS_ON(PieceType)
300 ENABLE_FULL_OPERATORS_ON(Piece)
301 ENABLE_FULL_OPERATORS_ON(Color)
302 ENABLE_FULL_OPERATORS_ON(Depth)
303 ENABLE_FULL_OPERATORS_ON(Square)
304 ENABLE_FULL_OPERATORS_ON(File)
305 ENABLE_FULL_OPERATORS_ON(Rank)
306
307 #undef ENABLE_FULL_OPERATORS_ON
308 #undef ENABLE_BASE_OPERATORS_ON
309
310 /// Additional operators to add integers to a Value
311 inline Value operator+(Value v, int i) { return Value(int(v) + i); }
312 inline Value operator-(Value v, int i) { return Value(int(v) - i); }
313 inline Value& operator+=(Value& v, int i) { return v = v + i; }
314 inline Value& operator-=(Value& v, int i) { return v = v - i; }
315
316 /// Only declared but not defined. We don't want to multiply two scores due to
317 /// a very high risk of overflow. So user should explicitly convert to integer.
318 inline Score operator*(Score s1, Score s2);
319
320 /// Division of a Score must be handled separately for each term
321 inline Score operator/(Score s, int i) {
322   return make_score(mg_value(s) / i, eg_value(s) / i);
323 }
324
325 extern Value PieceValue[PHASE_NB][PIECE_NB];
326
327 struct ExtMove {
328   Move move;
329   Value value;
330 };
331
332 inline bool operator<(const ExtMove& f, const ExtMove& s) {
333   return f.value < s.value;
334 }
335
336 inline Color operator~(Color c) {
337   return Color(c ^ BLACK);
338 }
339
340 inline Square operator~(Square s) {
341   return Square(s ^ SQ_A8); // Vertical flip SQ_A1 -> SQ_A8
342 }
343
344 inline CastlingRight operator|(Color c, CastlingSide s) {
345   return CastlingRight(WHITE_OO << ((s == QUEEN_SIDE) + 2 * c));
346 }
347
348 inline Value mate_in(int ply) {
349   return VALUE_MATE - ply;
350 }
351
352 inline Value mated_in(int ply) {
353   return -VALUE_MATE + ply;
354 }
355
356 inline Square make_square(File f, Rank r) {
357   return Square((r << 3) | f);
358 }
359
360 inline Piece make_piece(Color c, PieceType pt) {
361   return Piece((c << 3) | pt);
362 }
363
364 inline PieceType type_of(Piece pc)  {
365   return PieceType(pc & 7);
366 }
367
368 inline Color color_of(Piece pc) {
369   assert(pc != NO_PIECE);
370   return Color(pc >> 3);
371 }
372
373 inline bool is_ok(Square s) {
374   return s >= SQ_A1 && s <= SQ_H8;
375 }
376
377 inline File file_of(Square s) {
378   return File(s & 7);
379 }
380
381 inline Rank rank_of(Square s) {
382   return Rank(s >> 3);
383 }
384
385 inline Square relative_square(Color c, Square s) {
386   return Square(s ^ (c * 56));
387 }
388
389 inline Rank relative_rank(Color c, Rank r) {
390   return Rank(r ^ (c * 7));
391 }
392
393 inline Rank relative_rank(Color c, Square s) {
394   return relative_rank(c, rank_of(s));
395 }
396
397 inline bool opposite_colors(Square s1, Square s2) {
398   int s = int(s1) ^ int(s2);
399   return ((s >> 3) ^ s) & 1;
400 }
401
402 inline Square pawn_push(Color c) {
403   return c == WHITE ? DELTA_N : DELTA_S;
404 }
405
406 inline Square from_sq(Move m) {
407   return Square((m >> 6) & 0x3F);
408 }
409
410 inline Square to_sq(Move m) {
411   return Square(m & 0x3F);
412 }
413
414 inline MoveType type_of(Move m) {
415   return MoveType(m & (3 << 14));
416 }
417
418 inline PieceType promotion_type(Move m) {
419   return PieceType(((m >> 12) & 3) + 2);
420 }
421
422 inline Move make_move(Square from, Square to) {
423   return Move(to | (from << 6));
424 }
425
426 template<MoveType T>
427 inline Move make(Square from, Square to, PieceType pt = KNIGHT) {
428   return Move(to | (from << 6) | T | ((pt - KNIGHT) << 12));
429 }
430
431 inline bool is_ok(Move m) {
432   return from_sq(m) != to_sq(m); // Catch also MOVE_NULL and MOVE_NONE
433 }
434
435 #endif // #ifndef TYPES_H_INCLUDED