Sync with master
[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-2015 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 /// When compiling with provided Makefile (e.g. for Linux and OSX), configuration
24 /// is done automatically. To get started type 'make help'.
25 ///
26 /// When Makefile is not used (e.g. with Microsoft Visual Studio) some switches
27 /// need to be set manually:
28 ///
29 /// -DNDEBUG      | Disable debugging mode. Always use this for release.
30 ///
31 /// -DNO_PREFETCH | Disable use of prefetch asm-instruction. You may need this to
32 ///               | 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 and requires hardware with popcnt support.
36 ///
37 /// -DUSE_PEXT    | Add runtime support for use of pext asm-instruction. Works
38 ///               | only in 64-bit mode and requires hardware with pext support.
39
40 #include <cassert>
41 #include <cctype>
42 #include <climits>
43 #include <cstdint>
44 #include <cstdlib>
45
46 #if defined(_MSC_VER)
47 // Disable some silly and noisy warning from MSVC compiler
48 #pragma warning(disable: 4127) // Conditional expression is constant
49 #pragma warning(disable: 4146) // Unary minus operator applied to unsigned type
50 #pragma warning(disable: 4800) // Forcing value to bool 'true' or 'false'
51 #endif
52
53 /// Predefined macros hell:
54 ///
55 /// __GNUC__           Compiler is gcc, Clang or Intel on Linux
56 /// __INTEL_COMPILER   Compiler is Intel
57 /// _MSC_VER           Compiler is MSVC or Intel on Windows
58 /// _WIN32             Building on Windows (any)
59 /// _WIN64             Building on Windows 64 bit
60
61 #if defined(_WIN64) && !defined(IS_64BIT) // Last condition means Makefile is not used
62 #  include <intrin.h> // MSVC popcnt and bsfq instrinsics
63 #  define IS_64BIT
64 #  define USE_BSFQ
65 #endif
66
67 #if defined(USE_POPCNT) && defined(__INTEL_COMPILER) && defined(_MSC_VER)
68 #  include <nmmintrin.h> // Intel header for _mm_popcnt_u64() intrinsic
69 #endif
70
71 #if !defined(NO_PREFETCH) && (defined(__INTEL_COMPILER) || defined(_MSC_VER))
72 #  include <xmmintrin.h> // Intel and Microsoft header for _mm_prefetch()
73 #endif
74
75 #if defined(USE_PEXT)
76 #  include <immintrin.h> // Header for _pext_u64() intrinsic
77 #  define pext(b, m) _pext_u64(b, m)
78 #else
79 #  define pext(b, m) (0)
80 #endif
81
82 #ifdef _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 #ifdef USE_POPCNT
91 const bool HasPopCnt = true;
92 #else
93 const bool HasPopCnt = false;
94 #endif
95
96 #ifdef USE_PEXT
97 const bool HasPext = true;
98 #else
99 const bool HasPext = false;
100 #endif
101
102 #ifdef IS_64BIT
103 const bool Is64Bit = true;
104 #else
105 const bool Is64Bit = false;
106 #endif
107
108 typedef uint64_t Key;
109 typedef uint64_t Bitboard;
110
111 const int MAX_MOVES = 256;
112 const int MAX_PLY   = 128;
113
114 /// A move needs 16 bits to be stored
115 ///
116 /// bit  0- 5: destination square (from 0 to 63)
117 /// bit  6-11: origin square (from 0 to 63)
118 /// bit 12-13: promotion piece type - 2 (from KNIGHT-2 to QUEEN-2)
119 /// bit 14-15: special move flag: promotion (1), en passant (2), castling (3)
120 /// NOTE: EN-PASSANT bit is set only when a pawn can be captured
121 ///
122 /// Special cases are MOVE_NONE and MOVE_NULL. We can sneak these in because in
123 /// any normal move destination square is always different from origin square
124 /// while MOVE_NONE and MOVE_NULL have the same origin and destination square.
125
126 enum Move {
127   MOVE_NONE,
128   MOVE_NULL = 65
129 };
130
131 enum MoveType {
132   NORMAL,
133   PROMOTION = 1 << 14,
134   ENPASSANT = 2 << 14,
135   CASTLING  = 3 << 14
136 };
137
138 enum Color {
139   WHITE, BLACK, NO_COLOR, COLOR_NB = 2
140 };
141
142 enum CastlingSide {
143   KING_SIDE, QUEEN_SIDE, CASTLING_SIDE_NB = 2
144 };
145
146 enum CastlingRight {
147   NO_CASTLING,
148   WHITE_OO,
149   WHITE_OOO = WHITE_OO << 1,
150   BLACK_OO  = WHITE_OO << 2,
151   BLACK_OOO = WHITE_OO << 3,
152   ANY_CASTLING = WHITE_OO | WHITE_OOO | BLACK_OO | BLACK_OOO,
153   CASTLING_RIGHT_NB = 16
154 };
155
156 template<Color C, CastlingSide S> struct MakeCastling {
157   static const CastlingRight
158   right = C == WHITE ? S == QUEEN_SIDE ? WHITE_OOO : WHITE_OO
159                      : S == QUEEN_SIDE ? BLACK_OOO : BLACK_OO;
160 };
161
162 enum Phase {
163   PHASE_ENDGAME,
164   PHASE_MIDGAME = 128,
165   MG = 0, EG = 1, PHASE_NB = 2
166 };
167
168 enum ScaleFactor {
169   SCALE_FACTOR_DRAW    = 0,
170   SCALE_FACTOR_ONEPAWN = 48,
171   SCALE_FACTOR_NORMAL  = 64,
172   SCALE_FACTOR_MAX     = 128,
173   SCALE_FACTOR_NONE    = 255
174 };
175
176 enum Bound {
177   BOUND_NONE,
178   BOUND_UPPER,
179   BOUND_LOWER,
180   BOUND_EXACT = BOUND_UPPER | BOUND_LOWER
181 };
182
183 enum Value : int {
184   VALUE_ZERO      = 0,
185   VALUE_DRAW      = 0,
186   VALUE_KNOWN_WIN = 10000,
187   VALUE_MATE      = 32000,
188   VALUE_INFINITE  = 32001,
189   VALUE_NONE      = 32002,
190
191   VALUE_MATE_IN_MAX_PLY  =  VALUE_MATE - 2 * MAX_PLY,
192   VALUE_MATED_IN_MAX_PLY = -VALUE_MATE + 2 * MAX_PLY,
193
194   PawnValueMg   = 198,   PawnValueEg   = 258,
195   KnightValueMg = 817,   KnightValueEg = 846,
196   BishopValueMg = 836,   BishopValueEg = 857,
197   RookValueMg   = 1270,  RookValueEg   = 1278,
198   QueenValueMg  = 2521,  QueenValueEg  = 2558,
199
200   MidgameLimit  = 15581, EndgameLimit  = 3998
201 };
202
203 enum PieceType {
204   NO_PIECE_TYPE, PAWN, KNIGHT, BISHOP, ROOK, QUEEN, KING,
205   ALL_PIECES = 0,
206   PIECE_TYPE_NB = 8
207 };
208
209 enum Piece {
210   NO_PIECE,
211   W_PAWN = 1, W_KNIGHT, W_BISHOP, W_ROOK, W_QUEEN, W_KING,
212   B_PAWN = 9, B_KNIGHT, B_BISHOP, B_ROOK, B_QUEEN, B_KING,
213   PIECE_NB = 16
214 };
215
216 enum Depth {
217
218   ONE_PLY = 1,
219
220   DEPTH_ZERO          =  0,
221   DEPTH_QS_CHECKS     =  0,
222   DEPTH_QS_NO_CHECKS  = -1,
223   DEPTH_QS_RECAPTURES = -5,
224
225   DEPTH_NONE = -6,
226   DEPTH_MAX  = MAX_PLY
227 };
228
229 enum Square {
230   SQ_A1, SQ_B1, SQ_C1, SQ_D1, SQ_E1, SQ_F1, SQ_G1, SQ_H1,
231   SQ_A2, SQ_B2, SQ_C2, SQ_D2, SQ_E2, SQ_F2, SQ_G2, SQ_H2,
232   SQ_A3, SQ_B3, SQ_C3, SQ_D3, SQ_E3, SQ_F3, SQ_G3, SQ_H3,
233   SQ_A4, SQ_B4, SQ_C4, SQ_D4, SQ_E4, SQ_F4, SQ_G4, SQ_H4,
234   SQ_A5, SQ_B5, SQ_C5, SQ_D5, SQ_E5, SQ_F5, SQ_G5, SQ_H5,
235   SQ_A6, SQ_B6, SQ_C6, SQ_D6, SQ_E6, SQ_F6, SQ_G6, SQ_H6,
236   SQ_A7, SQ_B7, SQ_C7, SQ_D7, SQ_E7, SQ_F7, SQ_G7, SQ_H7,
237   SQ_A8, SQ_B8, SQ_C8, SQ_D8, SQ_E8, SQ_F8, SQ_G8, SQ_H8,
238   SQ_NONE,
239
240   SQUARE_NB = 64,
241
242   DELTA_N =  8,
243   DELTA_E =  1,
244   DELTA_S = -8,
245   DELTA_W = -1,
246
247   DELTA_NN = DELTA_N + DELTA_N,
248   DELTA_NE = DELTA_N + DELTA_E,
249   DELTA_SE = DELTA_S + DELTA_E,
250   DELTA_SS = DELTA_S + DELTA_S,
251   DELTA_SW = DELTA_S + DELTA_W,
252   DELTA_NW = DELTA_N + DELTA_W
253 };
254
255 enum File {
256   FILE_A, FILE_B, FILE_C, FILE_D, FILE_E, FILE_F, FILE_G, FILE_H, FILE_NB
257 };
258
259 enum Rank {
260   RANK_1, RANK_2, RANK_3, RANK_4, RANK_5, RANK_6, RANK_7, RANK_8, RANK_NB
261 };
262
263
264 /// Score enum stores a middlegame and an endgame value in a single integer
265 /// (enum). The least significant 16 bits are used to store the endgame value
266 /// and the upper 16 bits are used to store the middlegame value.
267 enum Score : int { SCORE_ZERO };
268
269 inline Score make_score(int mg, int eg) {
270   return Score((mg << 16) + eg);
271 }
272
273 /// Extracting the signed lower and upper 16 bits is not so trivial because
274 /// according to the standard a simple cast to short is implementation defined
275 /// and so is a right shift of a signed integer.
276 inline Value mg_value(Score s) {
277
278   union { uint16_t u; int16_t s; } mg = { uint16_t(unsigned(s + 0x8000) >> 16) };
279   return Value(mg.s);
280 }
281
282 inline Value eg_value(Score s) {
283
284   union { uint16_t u; int16_t s; } eg = { uint16_t(unsigned(s)) };
285   return Value(eg.s);
286 }
287
288 #define ENABLE_BASE_OPERATORS_ON(T)                             \
289 inline T operator+(T d1, T d2) { return T(int(d1) + int(d2)); } \
290 inline T operator-(T d1, T d2) { return T(int(d1) - int(d2)); } \
291 inline T operator*(int i, T d) { return T(i * int(d)); }        \
292 inline T operator*(T d, int i) { return T(int(d) * i); }        \
293 inline T operator-(T d) { return T(-int(d)); }                  \
294 inline T& operator+=(T& d1, T d2) { return d1 = d1 + d2; }      \
295 inline T& operator-=(T& d1, T d2) { return d1 = d1 - d2; }      \
296 inline T& operator*=(T& d, int i) { return d = T(int(d) * i); }
297
298 #define ENABLE_FULL_OPERATORS_ON(T)                             \
299 ENABLE_BASE_OPERATORS_ON(T)                                     \
300 inline T& operator++(T& d) { return d = T(int(d) + 1); }        \
301 inline T& operator--(T& d) { return d = T(int(d) - 1); }        \
302 inline T operator/(T d, int i) { return T(int(d) / i); }        \
303 inline int operator/(T d1, T d2) { return int(d1) / int(d2); }  \
304 inline T& operator/=(T& d, int i) { return d = T(int(d) / i); }
305
306 ENABLE_FULL_OPERATORS_ON(Value)
307 ENABLE_FULL_OPERATORS_ON(PieceType)
308 ENABLE_FULL_OPERATORS_ON(Piece)
309 ENABLE_FULL_OPERATORS_ON(Color)
310 ENABLE_FULL_OPERATORS_ON(Depth)
311 ENABLE_FULL_OPERATORS_ON(Square)
312 ENABLE_FULL_OPERATORS_ON(File)
313 ENABLE_FULL_OPERATORS_ON(Rank)
314
315 ENABLE_BASE_OPERATORS_ON(Score)
316
317 #undef ENABLE_FULL_OPERATORS_ON
318 #undef ENABLE_BASE_OPERATORS_ON
319
320 /// Additional operators to add integers to a Value
321 inline Value operator+(Value v, int i) { return Value(int(v) + i); }
322 inline Value operator-(Value v, int i) { return Value(int(v) - i); }
323 inline Value& operator+=(Value& v, int i) { return v = v + i; }
324 inline Value& operator-=(Value& v, int i) { return v = v - i; }
325
326 /// Only declared but not defined. We don't want to multiply two scores due to
327 /// a very high risk of overflow. So user should explicitly convert to integer.
328 inline Score operator*(Score s1, Score s2);
329
330 /// Division of a Score must be handled separately for each term
331 inline Score operator/(Score s, int i) {
332   return make_score(mg_value(s) / i, eg_value(s) / i);
333 }
334
335 extern Value PieceValue[PHASE_NB][PIECE_NB];
336
337 inline Color operator~(Color c) {
338   return Color(c ^ BLACK);
339 }
340
341 inline Square operator~(Square s) {
342   return Square(s ^ SQ_A8); // Vertical flip SQ_A1 -> SQ_A8
343 }
344
345 inline CastlingRight operator|(Color c, CastlingSide s) {
346   return CastlingRight(WHITE_OO << ((s == QUEEN_SIDE) + 2 * c));
347 }
348
349 inline Value mate_in(int ply) {
350   return VALUE_MATE - ply;
351 }
352
353 inline Value mated_in(int ply) {
354   return -VALUE_MATE + ply;
355 }
356
357 inline Square make_square(File f, Rank r) {
358   return Square((r << 3) | f);
359 }
360
361 inline Piece make_piece(Color c, PieceType pt) {
362   return Piece((c << 3) | pt);
363 }
364
365 inline PieceType type_of(Piece pc)  {
366   return PieceType(pc & 7);
367 }
368
369 inline Color color_of(Piece pc) {
370   assert(pc != NO_PIECE);
371   return Color(pc >> 3);
372 }
373
374 inline bool is_ok(Square s) {
375   return s >= SQ_A1 && s <= SQ_H8;
376 }
377
378 inline File file_of(Square s) {
379   return File(s & 7);
380 }
381
382 inline Rank rank_of(Square s) {
383   return Rank(s >> 3);
384 }
385
386 inline Square relative_square(Color c, Square s) {
387   return Square(s ^ (c * 56));
388 }
389
390 inline Rank relative_rank(Color c, Rank r) {
391   return Rank(r ^ (c * 7));
392 }
393
394 inline Rank relative_rank(Color c, Square s) {
395   return relative_rank(c, rank_of(s));
396 }
397
398 inline bool opposite_colors(Square s1, Square s2) {
399   int s = int(s1) ^ int(s2);
400   return ((s >> 3) ^ s) & 1;
401 }
402
403 inline Square pawn_push(Color c) {
404   return c == WHITE ? DELTA_N : DELTA_S;
405 }
406
407 inline Square from_sq(Move m) {
408   return Square((m >> 6) & 0x3F);
409 }
410
411 inline Square to_sq(Move m) {
412   return Square(m & 0x3F);
413 }
414
415 inline MoveType type_of(Move m) {
416   return MoveType(m & (3 << 14));
417 }
418
419 inline PieceType promotion_type(Move m) {
420   return PieceType(((m >> 12) & 3) + KNIGHT);
421 }
422
423 inline Move make_move(Square from, Square to) {
424   return Move(to | (from << 6));
425 }
426
427 template<MoveType T>
428 inline Move make(Square from, Square to, PieceType pt = KNIGHT) {
429   return Move(to | (from << 6) | T | ((pt - KNIGHT) << 12));
430 }
431
432 inline bool is_ok(Move m) {
433   return from_sq(m) != to_sq(m); // Catch MOVE_NULL and MOVE_NONE
434 }
435
436 #endif // #ifndef TYPES_H_INCLUDED