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