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