Update copyright year to 2012
[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-2012 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
128 /// HasPopCnt is a global constant initialized at compile time that is set to
129 /// true if CPU on which application runs supports popcnt hardware instruction.
130 #if defined(USE_POPCNT)
131 const bool HasPopCnt = true;
132 #else
133 const bool HasPopCnt = false;
134 #endif
135
136
137 /// Is64Bit is a global constant initialized at compile time that is set to
138 /// true if CPU on which application runs is a 64 bits.
139 #if defined(IS_64BIT)
140 const bool Is64Bit = true;
141 #else
142 const bool Is64Bit = false;
143 #endif
144
145 #include <string>
146
147 typedef uint64_t Key;
148 typedef uint64_t Bitboard;
149
150 const int MAX_MOVES = 256;
151 const int PLY_MAX = 100;
152 const int PLY_MAX_PLUS_2 = PLY_MAX + 2;
153
154 const Bitboard FileABB = 0x0101010101010101ULL;
155 const Bitboard FileBBB = FileABB << 1;
156 const Bitboard FileCBB = FileABB << 2;
157 const Bitboard FileDBB = FileABB << 3;
158 const Bitboard FileEBB = FileABB << 4;
159 const Bitboard FileFBB = FileABB << 5;
160 const Bitboard FileGBB = FileABB << 6;
161 const Bitboard FileHBB = FileABB << 7;
162
163 const Bitboard Rank1BB = 0xFF;
164 const Bitboard Rank2BB = Rank1BB << (8 * 1);
165 const Bitboard Rank3BB = Rank1BB << (8 * 2);
166 const Bitboard Rank4BB = Rank1BB << (8 * 3);
167 const Bitboard Rank5BB = Rank1BB << (8 * 4);
168 const Bitboard Rank6BB = Rank1BB << (8 * 5);
169 const Bitboard Rank7BB = Rank1BB << (8 * 6);
170 const Bitboard Rank8BB = Rank1BB << (8 * 7);
171
172 /// A move needs 16 bits to be stored
173 ///
174 /// bit  0- 5: destination square (from 0 to 63)
175 /// bit  6-11: origin square (from 0 to 63)
176 /// bit 12-13: promotion piece type - 2 (from KNIGHT-2 to QUEEN-2)
177 /// bit 14-15: special move flag: promotion (1), en passant (2), castle (3)
178 ///
179 /// Special cases are MOVE_NONE and MOVE_NULL. We can sneak these in because in
180 /// any normal move destination square is always different from origin square
181 /// while MOVE_NONE and MOVE_NULL have the same origin and destination square.
182
183 enum Move {
184   MOVE_NONE = 0,
185   MOVE_NULL = 65
186 };
187
188 struct MoveStack {
189   Move move;
190   int score;
191 };
192
193 inline bool operator<(const MoveStack& f, const MoveStack& s) {
194   return f.score < s.score;
195 }
196
197 enum ValueType {
198   VALUE_TYPE_NONE  = 0,
199   VALUE_TYPE_UPPER = 1,
200   VALUE_TYPE_LOWER = 2,
201   VALUE_TYPE_EXACT = VALUE_TYPE_UPPER | VALUE_TYPE_LOWER
202 };
203
204 enum Value {
205   VALUE_ZERO      = 0,
206   VALUE_DRAW      = 0,
207   VALUE_KNOWN_WIN = 15000,
208   VALUE_MATE      = 30000,
209   VALUE_INFINITE  = 30001,
210   VALUE_NONE      = 30002,
211
212   VALUE_MATE_IN_PLY_MAX  =  VALUE_MATE - PLY_MAX,
213   VALUE_MATED_IN_PLY_MAX = -VALUE_MATE + PLY_MAX,
214
215   VALUE_ENSURE_INTEGER_SIZE_P = INT_MAX,
216   VALUE_ENSURE_INTEGER_SIZE_N = INT_MIN
217 };
218
219 enum PieceType {
220   NO_PIECE_TYPE = 0,
221   PAWN = 1, KNIGHT = 2, BISHOP = 3, ROOK = 4, QUEEN = 5, KING = 6
222 };
223
224 enum Piece {
225   NO_PIECE = 16, // color_of(NO_PIECE) == NO_COLOR
226   W_PAWN = 1, W_KNIGHT =  2, W_BISHOP =  3, W_ROOK =  4, W_QUEEN =  5, W_KING =  6,
227   B_PAWN = 9, B_KNIGHT = 10, B_BISHOP = 11, B_ROOK = 12, B_QUEEN = 13, B_KING = 14
228 };
229
230 enum Color {
231   WHITE, BLACK, NO_COLOR
232 };
233
234 enum Depth {
235
236   ONE_PLY = 2,
237
238   DEPTH_ZERO          =  0 * ONE_PLY,
239   DEPTH_QS_CHECKS     = -1 * ONE_PLY,
240   DEPTH_QS_NO_CHECKS  = -2 * ONE_PLY,
241   DEPTH_QS_RECAPTURES = -4 * ONE_PLY,
242
243   DEPTH_NONE = -127 * ONE_PLY
244 };
245
246 enum Square {
247   SQ_A1, SQ_B1, SQ_C1, SQ_D1, SQ_E1, SQ_F1, SQ_G1, SQ_H1,
248   SQ_A2, SQ_B2, SQ_C2, SQ_D2, SQ_E2, SQ_F2, SQ_G2, SQ_H2,
249   SQ_A3, SQ_B3, SQ_C3, SQ_D3, SQ_E3, SQ_F3, SQ_G3, SQ_H3,
250   SQ_A4, SQ_B4, SQ_C4, SQ_D4, SQ_E4, SQ_F4, SQ_G4, SQ_H4,
251   SQ_A5, SQ_B5, SQ_C5, SQ_D5, SQ_E5, SQ_F5, SQ_G5, SQ_H5,
252   SQ_A6, SQ_B6, SQ_C6, SQ_D6, SQ_E6, SQ_F6, SQ_G6, SQ_H6,
253   SQ_A7, SQ_B7, SQ_C7, SQ_D7, SQ_E7, SQ_F7, SQ_G7, SQ_H7,
254   SQ_A8, SQ_B8, SQ_C8, SQ_D8, SQ_E8, SQ_F8, SQ_G8, SQ_H8,
255   SQ_NONE,
256
257   DELTA_N =  8,
258   DELTA_E =  1,
259   DELTA_S = -8,
260   DELTA_W = -1,
261
262   DELTA_NN = DELTA_N + DELTA_N,
263   DELTA_NE = DELTA_N + DELTA_E,
264   DELTA_SE = DELTA_S + DELTA_E,
265   DELTA_SS = DELTA_S + DELTA_S,
266   DELTA_SW = DELTA_S + DELTA_W,
267   DELTA_NW = DELTA_N + DELTA_W
268 };
269
270 enum File {
271   FILE_A, FILE_B, FILE_C, FILE_D, FILE_E, FILE_F, FILE_G, FILE_H
272 };
273
274 enum Rank {
275   RANK_1, RANK_2, RANK_3, RANK_4, RANK_5, RANK_6, RANK_7, RANK_8
276 };
277
278 enum ScaleFactor {
279   SCALE_FACTOR_DRAW   = 0,
280   SCALE_FACTOR_NORMAL = 64,
281   SCALE_FACTOR_MAX    = 128,
282   SCALE_FACTOR_NONE   = 255
283 };
284
285 enum CastleRight {
286   CASTLES_NONE = 0,
287   WHITE_OO     = 1,
288   BLACK_OO     = 2,
289   WHITE_OOO    = 4,
290   BLACK_OOO    = 8,
291   ALL_CASTLES  = 15
292 };
293
294
295 /// Score enum keeps a midgame and an endgame value in a single
296 /// integer (enum), first LSB 16 bits are used to store endgame
297 /// value, while upper bits are used for midgame value. Compiler
298 /// is free to choose the enum type as long as can keep its data,
299 /// so ensure Score to be an integer type.
300 enum Score {
301     SCORE_ZERO = 0,
302     SCORE_ENSURE_INTEGER_SIZE_P = INT_MAX,
303     SCORE_ENSURE_INTEGER_SIZE_N = INT_MIN
304 };
305
306 #define ENABLE_OPERATORS_ON(T) \
307 inline T operator+ (const T d1, const T d2) { return T(int(d1) + int(d2)); } \
308 inline T operator- (const T d1, const T d2) { return T(int(d1) - int(d2)); } \
309 inline T operator* (int i, const T d) {  return T(i * int(d)); } \
310 inline T operator* (const T d, int i) {  return T(int(d) * i); } \
311 inline T operator/ (const T d, int i) { return T(int(d) / i); } \
312 inline T operator- (const T d) { return T(-int(d)); } \
313 inline T operator++ (T& d, int) {d = T(int(d) + 1); return d; } \
314 inline T operator-- (T& d, int) { d = T(int(d) - 1); return d; } \
315 inline T& operator+= (T& d1, const T d2) { d1 = d1 + d2; return d1; } \
316 inline T& operator-= (T& d1, const T d2) { d1 = d1 - d2; return d1; } \
317 inline T& operator*= (T& d, int i) { d = T(int(d) * i); return d; } \
318 inline T& operator/= (T& d, int i) { d = T(int(d) / i); return d; }
319
320 ENABLE_OPERATORS_ON(Value)
321 ENABLE_OPERATORS_ON(PieceType)
322 ENABLE_OPERATORS_ON(Piece)
323 ENABLE_OPERATORS_ON(Color)
324 ENABLE_OPERATORS_ON(Depth)
325 ENABLE_OPERATORS_ON(Square)
326 ENABLE_OPERATORS_ON(File)
327 ENABLE_OPERATORS_ON(Rank)
328
329 #undef ENABLE_OPERATORS_ON
330
331 // Extra operators for adding integers to a Value
332 inline Value operator+ (Value v, int i) { return Value(int(v) + i); }
333 inline Value operator- (Value v, int i) { return Value(int(v) - i); }
334
335 // Extracting the _signed_ lower and upper 16 bits it not so trivial
336 // because according to the standard a simple cast to short is
337 // implementation defined and so is a right shift of a signed integer.
338 inline Value mg_value(Score s) { return Value(((s + 32768) & ~0xffff) / 0x10000); }
339
340 // Unfortunatly on Intel 64 bit we have a small speed regression, so use a faster code in
341 // this case, although not 100% standard compliant it seems to work for Intel and MSVC.
342 #if defined(IS_64BIT) && (!defined(__GNUC__) || defined(__INTEL_COMPILER))
343 inline Value eg_value(Score s) { return Value(int16_t(s & 0xffff)); }
344 #else
345 inline Value eg_value(Score s) { return Value((int)(unsigned(s) & 0x7fffu) - (int)(unsigned(s) & 0x8000u)); }
346 #endif
347
348 inline Score make_score(int mg, int eg) { return Score((mg << 16) + eg); }
349
350 // Division must be handled separately for each term
351 inline Score operator/(Score s, int i) { return make_score(mg_value(s) / i, eg_value(s) / i); }
352
353 // Only declared but not defined. We don't want to multiply two scores due to
354 // a very high risk of overflow. So user should explicitly convert to integer.
355 inline Score operator*(Score s1, Score s2);
356
357 // Remaining Score operators are standard
358 inline Score operator+ (const Score d1, const Score d2) { return Score(int(d1) + int(d2)); }
359 inline Score operator- (const Score d1, const Score d2) { return Score(int(d1) - int(d2)); }
360 inline Score operator* (int i, const Score d) {  return Score(i * int(d)); }
361 inline Score operator* (const Score d, int i) {  return Score(int(d) * i); }
362 inline Score operator- (const Score d) { return Score(-int(d)); }
363 inline void operator+= (Score& d1, const Score d2) { d1 = d1 + d2; }
364 inline void operator-= (Score& d1, const Score d2) { d1 = d1 - d2; }
365 inline void operator*= (Score& d, int i) { d = Score(int(d) * i); }
366 inline void operator/= (Score& d, int i) { d = Score(int(d) / i); }
367
368 const Value PawnValueMidgame   = Value(0x0C6);
369 const Value PawnValueEndgame   = Value(0x102);
370 const Value KnightValueMidgame = Value(0x331);
371 const Value KnightValueEndgame = Value(0x34E);
372 const Value BishopValueMidgame = Value(0x344);
373 const Value BishopValueEndgame = Value(0x359);
374 const Value RookValueMidgame   = Value(0x4F6);
375 const Value RookValueEndgame   = Value(0x4FE);
376 const Value QueenValueMidgame  = Value(0x9D9);
377 const Value QueenValueEndgame  = Value(0x9FE);
378
379 extern const Value PieceValueMidgame[17];
380 extern const Value PieceValueEndgame[17];
381 extern int SquareDistance[64][64];
382
383 inline Value mate_in(int ply) {
384   return VALUE_MATE - ply;
385 }
386
387 inline Value mated_in(int ply) {
388   return -VALUE_MATE + ply;
389 }
390
391 inline Piece make_piece(Color c, PieceType pt) {
392   return Piece((c << 3) | pt);
393 }
394
395 inline PieceType type_of(Piece p)  {
396   return PieceType(p & 7);
397 }
398
399 inline Color color_of(Piece p) {
400   return Color(p >> 3);
401 }
402
403 inline Color flip(Color c) {
404   return Color(c ^ 1);
405 }
406
407 inline Square make_square(File f, Rank r) {
408   return Square((r << 3) | f);
409 }
410
411 inline bool square_is_ok(Square s) {
412   return s >= SQ_A1 && s <= SQ_H8;
413 }
414
415 inline File file_of(Square s) {
416   return File(s & 7);
417 }
418
419 inline Rank rank_of(Square s) {
420   return Rank(s >> 3);
421 }
422
423 inline Square flip(Square s) {
424   return Square(s ^ 56);
425 }
426
427 inline Square mirror(Square s) {
428   return Square(s ^ 7);
429 }
430
431 inline Square relative_square(Color c, Square s) {
432   return Square(s ^ (c * 56));
433 }
434
435 inline Rank relative_rank(Color c, Rank r) {
436   return Rank(r ^ (c * 7));
437 }
438
439 inline Rank relative_rank(Color c, Square s) {
440   return relative_rank(c, rank_of(s));
441 }
442
443 inline bool opposite_colors(Square s1, Square s2) {
444   int s = s1 ^ s2;
445   return ((s >> 3) ^ s) & 1;
446 }
447
448 inline int file_distance(Square s1, Square s2) {
449   return abs(file_of(s1) - file_of(s2));
450 }
451
452 inline int rank_distance(Square s1, Square s2) {
453   return abs(rank_of(s1) - rank_of(s2));
454 }
455
456 inline int square_distance(Square s1, Square s2) {
457   return SquareDistance[s1][s2];
458 }
459
460 inline char piece_type_to_char(PieceType pt) {
461   return " PNBRQK"[pt];
462 }
463
464 inline char file_to_char(File f) {
465   return char(f - FILE_A + int('a'));
466 }
467
468 inline char rank_to_char(Rank r) {
469   return char(r - RANK_1 + int('1'));
470 }
471
472 inline const std::string square_to_string(Square s) {
473   char ch[] = { file_to_char(file_of(s)), rank_to_char(rank_of(s)), 0 };
474   return ch;
475 }
476
477 inline Square pawn_push(Color c) {
478   return c == WHITE ? DELTA_N : DELTA_S;
479 }
480
481 // An helper insertion sort implementation, works with pointers and iterators
482 template<typename T, typename K>
483 inline void sort(K firstMove, K lastMove)
484 {
485   T value;
486   K cur, p, d;
487
488   if (firstMove != lastMove)
489       for (cur = firstMove + 1; cur != lastMove; cur++)
490       {
491           p = d = cur;
492           value = *p--;
493           if (*p < value)
494           {
495               do *d = *p;
496               while (--d != firstMove && *--p < value);
497               *d = value;
498           }
499       }
500 }
501
502 inline Square move_from(Move m) {
503   return Square((m >> 6) & 0x3F);
504 }
505
506 inline Square move_to(Move m) {
507   return Square(m & 0x3F);
508 }
509
510 inline bool is_special(Move m) {
511   return m & (3 << 14);
512 }
513
514 inline bool is_promotion(Move m) {
515   return (m & (3 << 14)) == (1 << 14);
516 }
517
518 inline int is_enpassant(Move m) {
519   return (m & (3 << 14)) == (2 << 14);
520 }
521
522 inline int is_castle(Move m) {
523   return (m & (3 << 14)) == (3 << 14);
524 }
525
526 inline PieceType promotion_piece_type(Move m) {
527   return PieceType(((m >> 12) & 3) + 2);
528 }
529
530 inline Move make_move(Square from, Square to) {
531   return Move(to | (from << 6));
532 }
533
534 inline Move make_promotion_move(Square from, Square to, PieceType promotion) {
535   return Move(to | (from << 6) | (1 << 14) | ((promotion - 2) << 12)) ;
536 }
537
538 inline Move make_enpassant_move(Square from, Square to) {
539   return Move(to | (from << 6) | (2 << 14));
540 }
541
542 inline Move make_castle_move(Square from, Square to) {
543   return Move(to | (from << 6) | (3 << 14));
544 }
545
546 inline bool is_ok(Move m) {
547   return move_from(m) != move_to(m); // Catches also MOVE_NULL and MOVE_NONE
548 }
549
550 #endif // !defined(TYPES_H_INCLUDED)