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