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