fc42ea76535feaf4c4a1df5cd1f59e4f32c44b32
[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-2010 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 #if !defined(TYPES_H_INCLUDED)
21 #define TYPES_H_INCLUDED
22
23 #include <climits>
24 #include <cstdlib>
25
26 #if defined(_MSC_VER)
27
28 // Disable some silly and noisy warning from MSVC compiler
29 #pragma warning(disable: 4800) // Forcing value to bool 'true' or 'false'
30 #pragma warning(disable: 4127) // Conditional expression is constant
31 #pragma warning(disable: 4146) // Unary minus operator applied to unsigned type
32
33 // MSVC does not support <inttypes.h>
34 typedef   signed __int8    int8_t;
35 typedef unsigned __int8   uint8_t;
36 typedef   signed __int16  int16_t;
37 typedef unsigned __int16 uint16_t;
38 typedef   signed __int32  int32_t;
39 typedef unsigned __int32 uint32_t;
40 typedef   signed __int64  int64_t;
41 typedef unsigned __int64 uint64_t;
42
43 #else
44
45 #include <inttypes.h>
46
47 #endif
48
49 ////
50 //// Configuration
51 ////
52
53 //// For Linux and OSX configuration is done automatically using Makefile.
54 //// To get started type "make help".
55 ////
56 //// For windows part of the configuration is detected automatically, but
57 //// some switches need to be set manually:
58 ////
59 //// -DNDEBUG       | Disable debugging mode. Use always.
60 ////
61 //// -DNO_PREFETCH  | Disable use of prefetch asm-instruction. A must if you want the
62 ////                | executable to run on some very old machines.
63 ////
64 //// -DUSE_POPCNT   | Add runtime support for use of popcnt asm-instruction.
65 ////                | Works only in 64-bit mode. For compiling requires hardware
66 ////                | with popcnt support. Around 4% speed-up.
67 ////
68 //// -DOLD_LOCKS    | By default under Windows are used the fast Slim Reader/Writer (SRW)
69 ////                | Locks and Condition Variables: these are not supported by Windows XP
70 ////                | and older, to compile for those platforms you should enable OLD_LOCKS.
71
72 // Automatic detection for 64-bit under Windows
73 #if defined(_WIN64)
74 #define IS_64BIT
75 #endif
76
77 // Automatic detection for use of bsfq asm-instruction under Windows
78 #if defined(_WIN64)
79 #define USE_BSFQ
80 #endif
81
82 // Intel header for _mm_popcnt_u64() intrinsic
83 #if defined(USE_POPCNT) && defined(_MSC_VER) && defined(__INTEL_COMPILER)
84 #include <nmmintrin.h>
85 #endif
86
87 // Cache line alignment specification
88 #if defined(_MSC_VER) || defined(__INTEL_COMPILER)
89 #define CACHE_LINE_ALIGNMENT __declspec(align(64))
90 #else
91 #define CACHE_LINE_ALIGNMENT  __attribute__ ((aligned(64)))
92 #endif
93
94 // Define a __cpuid() function for gcc compilers, for Intel and MSVC
95 // is already available as an intrinsic.
96 #if defined(_MSC_VER)
97 #include <intrin.h>
98 #elif defined(__GNUC__) && (defined(__i386__) || defined(__x86_64__))
99 inline void __cpuid(int CPUInfo[4], int InfoType)
100 {
101   int* eax = CPUInfo + 0;
102   int* ebx = CPUInfo + 1;
103   int* ecx = CPUInfo + 2;
104   int* edx = CPUInfo + 3;
105
106   *eax = InfoType;
107   *ecx = 0;
108   __asm__("cpuid" : "=a" (*eax), "=b" (*ebx), "=c" (*ecx), "=d" (*edx)
109                   : "0" (*eax), "2" (*ecx));
110 }
111 #else
112 inline void __cpuid(int CPUInfo[4], int)
113 {
114    CPUInfo[0] = CPUInfo[1] = CPUInfo[2] = CPUInfo[3] = 0;
115 }
116 #endif
117
118 // Define FORCE_INLINE macro to force inlining overriding compiler choice
119 #if defined(_MSC_VER)
120 #define FORCE_INLINE  __forceinline
121 #elif defined(__GNUC__)
122 #define FORCE_INLINE  inline __attribute__((always_inline))
123 #else
124 #define FORCE_INLINE  inline
125 #endif
126
127 /// cpu_has_popcnt() detects support for popcnt instruction at runtime
128 inline bool cpu_has_popcnt() {
129
130   int CPUInfo[4] = {-1};
131   __cpuid(CPUInfo, 0x00000001);
132   return (CPUInfo[2] >> 23) & 1;
133 }
134
135 /// CpuHasPOPCNT is a global constant initialized at startup that
136 /// is set to true if CPU on which application runs supports popcnt
137 /// hardware instruction. Unless USE_POPCNT is not defined.
138 #if defined(USE_POPCNT)
139 const bool CpuHasPOPCNT = cpu_has_popcnt();
140 #else
141 const bool CpuHasPOPCNT = false;
142 #endif
143
144
145 /// CpuIs64Bit is a global constant initialized at compile time that
146 /// is set to true if CPU on which application runs is a 64 bits.
147 #if defined(IS_64BIT)
148 const bool CpuIs64Bit = true;
149 #else
150 const bool CpuIs64Bit = false;
151 #endif
152
153 #include <string>
154
155 typedef uint64_t Key;
156 typedef uint64_t Bitboard;
157
158 const int MAX_MOVES = 256;
159 const int PLY_MAX = 100;
160 const int PLY_MAX_PLUS_2 = PLY_MAX + 2;
161
162 const Bitboard FileABB = 0x0101010101010101ULL;
163 const Bitboard FileBBB = FileABB << 1;
164 const Bitboard FileCBB = FileABB << 2;
165 const Bitboard FileDBB = FileABB << 3;
166 const Bitboard FileEBB = FileABB << 4;
167 const Bitboard FileFBB = FileABB << 5;
168 const Bitboard FileGBB = FileABB << 6;
169 const Bitboard FileHBB = FileABB << 7;
170
171 const Bitboard Rank1BB = 0xFF;
172 const Bitboard Rank2BB = Rank1BB << (8 * 1);
173 const Bitboard Rank3BB = Rank1BB << (8 * 2);
174 const Bitboard Rank4BB = Rank1BB << (8 * 3);
175 const Bitboard Rank5BB = Rank1BB << (8 * 4);
176 const Bitboard Rank6BB = Rank1BB << (8 * 5);
177 const Bitboard Rank7BB = Rank1BB << (8 * 6);
178 const Bitboard Rank8BB = Rank1BB << (8 * 7);
179
180 /// A move needs 16 bits to be stored
181 ///
182 /// bit  0- 5: destination square (from 0 to 63)
183 /// bit  6-11: origin square (from 0 to 63)
184 /// bit 12-13: promotion piece type - 2 (from KNIGHT-2 to QUEEN-2)
185 /// bit 14-15: special move flag: promotion (1), en passant (2), castle (3)
186 ///
187 /// Special cases are MOVE_NONE and MOVE_NULL. We can sneak these in because in
188 /// any normal move destination square is always different from origin square
189 /// while MOVE_NONE and MOVE_NULL have the same origin and destination square.
190
191 enum Move {
192   MOVE_NONE = 0,
193   MOVE_NULL = 65
194 };
195
196 struct MoveStack {
197   Move move;
198   int score;
199 };
200
201 inline bool operator<(const MoveStack& f, const MoveStack& s) {
202   return f.score < s.score;
203 }
204
205 enum ValueType {
206   VALUE_TYPE_NONE  = 0,
207   VALUE_TYPE_UPPER = 1,
208   VALUE_TYPE_LOWER = 2,
209   VALUE_TYPE_EXACT = VALUE_TYPE_UPPER | VALUE_TYPE_LOWER
210 };
211
212 enum Value {
213   VALUE_ZERO      = 0,
214   VALUE_DRAW      = 0,
215   VALUE_KNOWN_WIN = 15000,
216   VALUE_MATE      = 30000,
217   VALUE_INFINITE  = 30001,
218   VALUE_NONE      = 30002,
219
220   VALUE_MATE_IN_PLY_MAX  =  VALUE_MATE - PLY_MAX,
221   VALUE_MATED_IN_PLY_MAX = -VALUE_MATE + PLY_MAX,
222
223   VALUE_ENSURE_INTEGER_SIZE_P = INT_MAX,
224   VALUE_ENSURE_INTEGER_SIZE_N = INT_MIN
225 };
226
227 enum PieceType {
228   PIECE_TYPE_NONE = 0,
229   PAWN = 1, KNIGHT = 2, BISHOP = 3, ROOK = 4, QUEEN = 5, KING = 6
230 };
231
232 enum Piece {
233   PIECE_NONE_DARK_SQ = 0, WP = 1, WN = 2, WB = 3, WR = 4, WQ = 5, WK = 6,
234   BP = 9, BN = 10, BB = 11, BR = 12, BQ = 13, BK = 14, PIECE_NONE = 16
235 };
236
237 enum Color {
238   WHITE, BLACK, COLOR_NONE
239 };
240
241 enum Depth {
242
243   ONE_PLY = 2,
244
245   DEPTH_ZERO          =  0 * ONE_PLY,
246   DEPTH_QS_CHECKS     = -1 * ONE_PLY,
247   DEPTH_QS_NO_CHECKS  = -2 * ONE_PLY,
248   DEPTH_QS_RECAPTURES = -4 * ONE_PLY,
249
250   DEPTH_NONE = -127 * ONE_PLY
251 };
252
253 enum Square {
254   SQ_A1, SQ_B1, SQ_C1, SQ_D1, SQ_E1, SQ_F1, SQ_G1, SQ_H1,
255   SQ_A2, SQ_B2, SQ_C2, SQ_D2, SQ_E2, SQ_F2, SQ_G2, SQ_H2,
256   SQ_A3, SQ_B3, SQ_C3, SQ_D3, SQ_E3, SQ_F3, SQ_G3, SQ_H3,
257   SQ_A4, SQ_B4, SQ_C4, SQ_D4, SQ_E4, SQ_F4, SQ_G4, SQ_H4,
258   SQ_A5, SQ_B5, SQ_C5, SQ_D5, SQ_E5, SQ_F5, SQ_G5, SQ_H5,
259   SQ_A6, SQ_B6, SQ_C6, SQ_D6, SQ_E6, SQ_F6, SQ_G6, SQ_H6,
260   SQ_A7, SQ_B7, SQ_C7, SQ_D7, SQ_E7, SQ_F7, SQ_G7, SQ_H7,
261   SQ_A8, SQ_B8, SQ_C8, SQ_D8, SQ_E8, SQ_F8, SQ_G8, SQ_H8,
262   SQ_NONE,
263
264   DELTA_N =  8,
265   DELTA_E =  1,
266   DELTA_S = -8,
267   DELTA_W = -1,
268
269   DELTA_NN = DELTA_N + DELTA_N,
270   DELTA_NE = DELTA_N + DELTA_E,
271   DELTA_SE = DELTA_S + DELTA_E,
272   DELTA_SS = DELTA_S + DELTA_S,
273   DELTA_SW = DELTA_S + DELTA_W,
274   DELTA_NW = DELTA_N + DELTA_W
275 };
276
277 enum File {
278   FILE_A, FILE_B, FILE_C, FILE_D, FILE_E, FILE_F, FILE_G, FILE_H
279 };
280
281 enum Rank {
282   RANK_1, RANK_2, RANK_3, RANK_4, RANK_5, RANK_6, RANK_7, RANK_8
283 };
284
285 enum SquareColor {
286   DARK, LIGHT
287 };
288
289 enum ScaleFactor {
290   SCALE_FACTOR_DRAW   = 0,
291   SCALE_FACTOR_NORMAL = 64,
292   SCALE_FACTOR_MAX    = 128,
293   SCALE_FACTOR_NONE   = 255
294 };
295
296 enum CastleRight {
297   CASTLES_NONE = 0,
298   WHITE_OO     = 1,
299   BLACK_OO     = 2,
300   WHITE_OOO    = 4,
301   BLACK_OOO    = 8,
302   ALL_CASTLES  = 15
303 };
304
305
306 /// Score enum keeps a midgame and an endgame value in a single
307 /// integer (enum), first LSB 16 bits are used to store endgame
308 /// value, while upper bits are used for midgame value. Compiler
309 /// is free to choose the enum type as long as can keep its data,
310 /// so ensure Score to be an integer type.
311 enum Score {
312     SCORE_ZERO = 0,
313     SCORE_ENSURE_INTEGER_SIZE_P = INT_MAX,
314     SCORE_ENSURE_INTEGER_SIZE_N = INT_MIN
315 };
316
317 #define ENABLE_OPERATORS_ON(T) \
318 inline T operator+ (const T d1, const T d2) { return T(int(d1) + int(d2)); } \
319 inline T operator- (const T d1, const T d2) { return T(int(d1) - int(d2)); } \
320 inline T operator* (int i, const T d) {  return T(i * int(d)); } \
321 inline T operator* (const T d, int i) {  return T(int(d) * i); } \
322 inline T operator/ (const T d, int i) { return T(int(d) / i); } \
323 inline T operator- (const T d) { return T(-int(d)); } \
324 inline T operator++ (T& d, int) {d = T(int(d) + 1); return d; } \
325 inline T operator-- (T& d, int) { d = T(int(d) - 1); return d; } \
326 inline T& operator+= (T& d1, const T d2) { d1 = d1 + d2; return d1; } \
327 inline T& operator-= (T& d1, const T d2) { d1 = d1 - d2; return d1; } \
328 inline T& operator*= (T& d, int i) { d = T(int(d) * i); return d; } \
329 inline T& operator/= (T& d, int i) { d = T(int(d) / i); return d; }
330
331 ENABLE_OPERATORS_ON(Value)
332 ENABLE_OPERATORS_ON(PieceType)
333 ENABLE_OPERATORS_ON(Piece)
334 ENABLE_OPERATORS_ON(Color)
335 ENABLE_OPERATORS_ON(Depth)
336 ENABLE_OPERATORS_ON(Square)
337 ENABLE_OPERATORS_ON(File)
338 ENABLE_OPERATORS_ON(Rank)
339
340 #undef ENABLE_OPERATORS_ON
341
342 // Extra operators for adding integers to a Value
343 inline Value operator+ (Value v, int i) { return Value(int(v) + i); }
344 inline Value operator- (Value v, int i) { return Value(int(v) - i); }
345
346 // Extracting the _signed_ lower and upper 16 bits it not so trivial
347 // because according to the standard a simple cast to short is
348 // implementation defined and so is a right shift of a signed integer.
349 inline Value mg_value(Score s) { return Value(((s + 32768) & ~0xffff) / 0x10000); }
350
351 // Unfortunatly on Intel 64 bit we have a small speed regression, so use a faster code in
352 // this case, although not 100% standard compliant it seems to work for Intel and MSVC.
353 #if defined(IS_64BIT) && (!defined(__GNUC__) || defined(__INTEL_COMPILER))
354 inline Value eg_value(Score s) { return Value(int16_t(s & 0xffff)); }
355 #else
356 inline Value eg_value(Score s) { return Value((int)(unsigned(s) & 0x7fffu) - (int)(unsigned(s) & 0x8000u)); }
357 #endif
358
359 inline Score make_score(int mg, int eg) { return Score((mg << 16) + eg); }
360
361 // Division must be handled separately for each term
362 inline Score operator/(Score s, int i) { return make_score(mg_value(s) / i, eg_value(s) / i); }
363
364 // Only declared but not defined. We don't want to multiply two scores due to
365 // a very high risk of overflow. So user should explicitly convert to integer.
366 inline Score operator*(Score s1, Score s2);
367
368 // Remaining Score operators are standard
369 inline Score operator+ (const Score d1, const Score d2) { return Score(int(d1) + int(d2)); }
370 inline Score operator- (const Score d1, const Score d2) { return Score(int(d1) - int(d2)); }
371 inline Score operator* (int i, const Score d) {  return Score(i * int(d)); }
372 inline Score operator* (const Score d, int i) {  return Score(int(d) * i); }
373 inline Score operator- (const Score d) { return Score(-int(d)); }
374 inline void operator+= (Score& d1, const Score d2) { d1 = d1 + d2; }
375 inline void operator-= (Score& d1, const Score d2) { d1 = d1 - d2; }
376 inline void operator*= (Score& d, int i) { d = Score(int(d) * i); }
377 inline void operator/= (Score& d, int i) { d = Score(int(d) / i); }
378
379 const Value PawnValueMidgame   = Value(0x0C6);
380 const Value PawnValueEndgame   = Value(0x102);
381 const Value KnightValueMidgame = Value(0x331);
382 const Value KnightValueEndgame = Value(0x34E);
383 const Value BishopValueMidgame = Value(0x344);
384 const Value BishopValueEndgame = Value(0x359);
385 const Value RookValueMidgame   = Value(0x4F6);
386 const Value RookValueEndgame   = Value(0x4FE);
387 const Value QueenValueMidgame  = Value(0x9D9);
388 const Value QueenValueEndgame  = Value(0x9FE);
389
390 extern const Value PieceValueMidgame[17];
391 extern const Value PieceValueEndgame[17];
392 extern int SquareDistance[64][64];
393
394 inline Value mate_in(int ply) {
395   return VALUE_MATE - ply;
396 }
397
398 inline Value mated_in(int ply) {
399   return -VALUE_MATE + ply;
400 }
401
402 inline Piece make_piece(Color c, PieceType pt) {
403   return Piece((c << 3) | pt);
404 }
405
406 inline PieceType type_of(Piece p)  {
407   return PieceType(p & 7);
408 }
409
410 inline Color color_of(Piece p) {
411   return Color(p >> 3);
412 }
413
414 inline Color flip(Color c) {
415   return Color(c ^ 1);
416 }
417
418 inline Square make_square(File f, Rank r) {
419   return Square((r << 3) | f);
420 }
421
422 inline bool square_is_ok(Square s) {
423   return s >= SQ_A1 && s <= SQ_H8;
424 }
425
426 inline File file_of(Square s) {
427   return File(s & 7);
428 }
429
430 inline Rank rank_of(Square s) {
431   return Rank(s >> 3);
432 }
433
434 inline Square flip(Square s) {
435   return Square(s ^ 56);
436 }
437
438 inline Square mirror(Square s) {
439   return Square(s ^ 7);
440 }
441
442 inline Square relative_square(Color c, Square s) {
443   return Square(s ^ (c * 56));
444 }
445
446 inline Rank relative_rank(Color c, Rank r) {
447   return Rank(r ^ (c * 7));
448 }
449
450 inline Rank relative_rank(Color c, Square s) {
451   return relative_rank(c, rank_of(s));
452 }
453
454 inline SquareColor color_of(Square s) {
455   return SquareColor(int(rank_of(s) + s) & 1);
456 }
457
458 inline bool opposite_colors(Square s1, Square s2) {
459   int s = s1 ^ s2;
460   return ((s >> 3) ^ s) & 1;
461 }
462
463 inline int file_distance(Square s1, Square s2) {
464   return abs(file_of(s1) - file_of(s2));
465 }
466
467 inline int rank_distance(Square s1, Square s2) {
468   return abs(rank_of(s1) - rank_of(s2));
469 }
470
471 inline int square_distance(Square s1, Square s2) {
472   return SquareDistance[s1][s2];
473 }
474
475 inline char piece_type_to_char(PieceType pt) {
476   return " PNBRQK"[pt];
477 }
478
479 inline char file_to_char(File f) {
480   return char(f - FILE_A + int('a'));
481 }
482
483 inline char rank_to_char(Rank r) {
484   return char(r - RANK_1 + int('1'));
485 }
486
487 inline const std::string square_to_string(Square s) {
488   char ch[] = { file_to_char(file_of(s)), rank_to_char(rank_of(s)), 0 };
489   return ch;
490 }
491
492 inline Square pawn_push(Color c) {
493   return c == WHITE ? DELTA_N : DELTA_S;
494 }
495
496 // An helper insertion sort implementation, works with pointers and iterators
497 template<typename T, typename K>
498 inline void sort(K firstMove, K lastMove)
499 {
500   T value;
501   K cur, p, d;
502
503   if (firstMove != lastMove)
504       for (cur = firstMove + 1; cur != lastMove; cur++)
505       {
506           p = d = cur;
507           value = *p--;
508           if (*p < value)
509           {
510               do *d = *p;
511               while (--d != firstMove && *--p < value);
512               *d = value;
513           }
514       }
515 }
516
517 inline Square move_from(Move m) {
518   return Square((m >> 6) & 0x3F);
519 }
520
521 inline Square move_to(Move m) {
522   return Square(m & 0x3F);
523 }
524
525 inline bool is_special(Move m) {
526   return m & (3 << 14);
527 }
528
529 inline bool is_promotion(Move m) {
530   return (m & (3 << 14)) == (1 << 14);
531 }
532
533 inline int is_enpassant(Move m) {
534   return (m & (3 << 14)) == (2 << 14);
535 }
536
537 inline int is_castle(Move m) {
538   return (m & (3 << 14)) == (3 << 14);
539 }
540
541 inline PieceType promotion_piece_type(Move m) {
542   return PieceType(((m >> 12) & 3) + 2);
543 }
544
545 inline Move make_move(Square from, Square to) {
546   return Move(to | (from << 6));
547 }
548
549 inline Move make_promotion_move(Square from, Square to, PieceType promotion) {
550   return Move(to | (from << 6) | (1 << 14) | ((promotion - 2) << 12)) ;
551 }
552
553 inline Move make_enpassant_move(Square from, Square to) {
554   return Move(to | (from << 6) | (2 << 14));
555 }
556
557 inline Move make_castle_move(Square from, Square to) {
558   return Move(to | (from << 6) | (3 << 14));
559 }
560
561 inline bool is_ok(Move m) {
562   return move_from(m) != move_to(m); // Catches also MOVE_NULL and MOVE_NONE
563 }
564
565 #endif // !defined(TYPES_H_INCLUDED)