6032f47f6294b385847716154fe145009dfb5604
[stockfish] / src / bitboard.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   Copyright (C) 2015-2018 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 BITBOARD_H_INCLUDED
22 #define BITBOARD_H_INCLUDED
23
24 #include <string>
25
26 #include "types.h"
27
28 namespace Bitbases {
29
30 void init();
31 bool probe(Square wksq, Square wpsq, Square bksq, Color us);
32
33 }
34
35 namespace Bitboards {
36
37 void init();
38 const std::string pretty(Bitboard b);
39
40 }
41
42 constexpr Bitboard AllSquares = ~Bitboard(0);
43 constexpr Bitboard DarkSquares = 0xAA55AA55AA55AA55ULL;
44
45 constexpr Bitboard FileABB = 0x0101010101010101ULL;
46 constexpr Bitboard FileBBB = FileABB << 1;
47 constexpr Bitboard FileCBB = FileABB << 2;
48 constexpr Bitboard FileDBB = FileABB << 3;
49 constexpr Bitboard FileEBB = FileABB << 4;
50 constexpr Bitboard FileFBB = FileABB << 5;
51 constexpr Bitboard FileGBB = FileABB << 6;
52 constexpr Bitboard FileHBB = FileABB << 7;
53
54 constexpr Bitboard Rank1BB = 0xFF;
55 constexpr Bitboard Rank2BB = Rank1BB << (8 * 1);
56 constexpr Bitboard Rank3BB = Rank1BB << (8 * 2);
57 constexpr Bitboard Rank4BB = Rank1BB << (8 * 3);
58 constexpr Bitboard Rank5BB = Rank1BB << (8 * 4);
59 constexpr Bitboard Rank6BB = Rank1BB << (8 * 5);
60 constexpr Bitboard Rank7BB = Rank1BB << (8 * 6);
61 constexpr Bitboard Rank8BB = Rank1BB << (8 * 7);
62
63 extern int SquareDistance[SQUARE_NB][SQUARE_NB];
64
65 extern Bitboard SquareBB[SQUARE_NB];
66 extern Bitboard FileBB[FILE_NB];
67 extern Bitboard RankBB[RANK_NB];
68 extern Bitboard AdjacentFilesBB[FILE_NB];
69 extern Bitboard ForwardRanksBB[COLOR_NB][RANK_NB];
70 extern Bitboard BetweenBB[SQUARE_NB][SQUARE_NB];
71 extern Bitboard LineBB[SQUARE_NB][SQUARE_NB];
72 extern Bitboard DistanceRingBB[SQUARE_NB][8];
73 extern Bitboard ForwardFileBB[COLOR_NB][SQUARE_NB];
74 extern Bitboard PassedPawnMask[COLOR_NB][SQUARE_NB];
75 extern Bitboard PawnAttackSpan[COLOR_NB][SQUARE_NB];
76 extern Bitboard PseudoAttacks[PIECE_TYPE_NB][SQUARE_NB];
77 extern Bitboard PawnAttacks[COLOR_NB][SQUARE_NB];
78
79
80 /// Magic holds all magic bitboards relevant data for a single square
81 struct Magic {
82   Bitboard  mask;
83   Bitboard  magic;
84   Bitboard* attacks;
85   unsigned  shift;
86
87   // Compute the attack's index using the 'magic bitboards' approach
88   unsigned index(Bitboard occupied) const {
89
90     if (HasPext)
91         return unsigned(pext(occupied, mask));
92
93     if (Is64Bit)
94         return unsigned(((occupied & mask) * magic) >> shift);
95
96     unsigned lo = unsigned(occupied) & unsigned(mask);
97     unsigned hi = unsigned(occupied >> 32) & unsigned(mask >> 32);
98     return (lo * unsigned(magic) ^ hi * unsigned(magic >> 32)) >> shift;
99   }
100 };
101
102 extern Magic RookMagics[SQUARE_NB];
103 extern Magic BishopMagics[SQUARE_NB];
104
105
106 /// Overloads of bitwise operators between a Bitboard and a Square for testing
107 /// whether a given bit is set in a bitboard, and for setting and clearing bits.
108
109 inline Bitboard operator&(Bitboard b, Square s) {
110   return b & SquareBB[s];
111 }
112
113 inline Bitboard operator|(Bitboard b, Square s) {
114   return b | SquareBB[s];
115 }
116
117 inline Bitboard operator^(Bitboard b, Square s) {
118   return b ^ SquareBB[s];
119 }
120
121 inline Bitboard& operator|=(Bitboard& b, Square s) {
122   return b |= SquareBB[s];
123 }
124
125 inline Bitboard& operator^=(Bitboard& b, Square s) {
126   return b ^= SquareBB[s];
127 }
128
129 constexpr bool more_than_one(Bitboard b) {
130   return b & (b - 1);
131 }
132
133 /// rank_bb() and file_bb() return a bitboard representing all the squares on
134 /// the given file or rank.
135
136 inline Bitboard rank_bb(Rank r) {
137   return RankBB[r];
138 }
139
140 inline Bitboard rank_bb(Square s) {
141   return RankBB[rank_of(s)];
142 }
143
144 inline Bitboard file_bb(File f) {
145   return FileBB[f];
146 }
147
148 inline Bitboard file_bb(Square s) {
149   return FileBB[file_of(s)];
150 }
151
152
153 /// make_bitboard() returns a bitboard from a list of squares
154
155 constexpr Bitboard make_bitboard() { return 0; }
156
157 template<typename ...Squares>
158 constexpr Bitboard make_bitboard(Square s, Squares... squares) {
159   return (1ULL << s) | make_bitboard(squares...);
160 }
161
162
163 /// shift() moves a bitboard one step along direction D (mainly for pawns)
164
165 template<Direction D>
166 constexpr Bitboard shift(Bitboard b) {
167   return  D == NORTH      ?  b             << 8 : D == SOUTH      ?  b             >> 8
168         : D == NORTH_EAST ? (b & ~FileHBB) << 9 : D == SOUTH_EAST ? (b & ~FileHBB) >> 7
169         : D == NORTH_WEST ? (b & ~FileABB) << 7 : D == SOUTH_WEST ? (b & ~FileABB) >> 9
170         : 0;
171 }
172
173
174 /// pawn_attacks_bb() returns the pawn attacks for the given color from the
175 /// squares in the given bitboard.
176
177 template<Color C>
178 constexpr Bitboard pawn_attacks_bb(Bitboard b) {
179   return C == WHITE ? shift<NORTH_WEST>(b) | shift<NORTH_EAST>(b)
180                     : shift<SOUTH_WEST>(b) | shift<SOUTH_EAST>(b);
181 }
182
183
184 /// adjacent_files_bb() returns a bitboard representing all the squares on the
185 /// adjacent files of the given one.
186
187 inline Bitboard adjacent_files_bb(File f) {
188   return AdjacentFilesBB[f];
189 }
190
191
192 /// between_bb() returns a bitboard representing all the squares between the two
193 /// given ones. For instance, between_bb(SQ_C4, SQ_F7) returns a bitboard with
194 /// the bits for square d5 and e6 set. If s1 and s2 are not on the same rank, file
195 /// or diagonal, 0 is returned.
196
197 inline Bitboard between_bb(Square s1, Square s2) {
198   return BetweenBB[s1][s2];
199 }
200
201
202 /// forward_ranks_bb() returns a bitboard representing the squares on all the ranks
203 /// in front of the given one, from the point of view of the given color. For instance,
204 /// forward_ranks_bb(BLACK, SQ_D3) will return the 16 squares on ranks 1 and 2.
205
206 inline Bitboard forward_ranks_bb(Color c, Square s) {
207   return ForwardRanksBB[c][rank_of(s)];
208 }
209
210
211 /// forward_file_bb() returns a bitboard representing all the squares along the line
212 /// in front of the given one, from the point of view of the given color:
213 ///      ForwardFileBB[c][s] = forward_ranks_bb(c, s) & file_bb(s)
214
215 inline Bitboard forward_file_bb(Color c, Square s) {
216   return ForwardFileBB[c][s];
217 }
218
219
220 /// pawn_attack_span() returns a bitboard representing all the squares that can be
221 /// attacked by a pawn of the given color when it moves along its file, starting
222 /// from the given square:
223 ///      PawnAttackSpan[c][s] = forward_ranks_bb(c, s) & adjacent_files_bb(file_of(s));
224
225 inline Bitboard pawn_attack_span(Color c, Square s) {
226   return PawnAttackSpan[c][s];
227 }
228
229
230 /// passed_pawn_mask() returns a bitboard mask which can be used to test if a
231 /// pawn of the given color and on the given square is a passed pawn:
232 ///      PassedPawnMask[c][s] = pawn_attack_span(c, s) | forward_file_bb(c, s)
233
234 inline Bitboard passed_pawn_mask(Color c, Square s) {
235   return PassedPawnMask[c][s];
236 }
237
238
239 /// aligned() returns true if the squares s1, s2 and s3 are aligned either on a
240 /// straight or on a diagonal line.
241
242 inline bool aligned(Square s1, Square s2, Square s3) {
243   return LineBB[s1][s2] & s3;
244 }
245
246
247 /// distance() functions return the distance between x and y, defined as the
248 /// number of steps for a king in x to reach y. Works with squares, ranks, files.
249
250 template<typename T> inline int distance(T x, T y) { return x < y ? y - x : x - y; }
251 template<> inline int distance<Square>(Square x, Square y) { return SquareDistance[x][y]; }
252
253 template<typename T1, typename T2> inline int distance(T2 x, T2 y);
254 template<> inline int distance<File>(Square x, Square y) { return distance(file_of(x), file_of(y)); }
255 template<> inline int distance<Rank>(Square x, Square y) { return distance(rank_of(x), rank_of(y)); }
256
257
258 /// attacks_bb() returns a bitboard representing all the squares attacked by a
259 /// piece of type Pt (bishop or rook) placed on 's'.
260
261 template<PieceType Pt>
262 inline Bitboard attacks_bb(Square s, Bitboard occupied) {
263
264   const Magic& m = Pt == ROOK ? RookMagics[s] : BishopMagics[s];
265   return m.attacks[m.index(occupied)];
266 }
267
268 inline Bitboard attacks_bb(PieceType pt, Square s, Bitboard occupied) {
269
270   assert(pt != PAWN);
271
272   switch (pt)
273   {
274   case BISHOP: return attacks_bb<BISHOP>(s, occupied);
275   case ROOK  : return attacks_bb<  ROOK>(s, occupied);
276   case QUEEN : return attacks_bb<BISHOP>(s, occupied) | attacks_bb<ROOK>(s, occupied);
277   default    : return PseudoAttacks[pt][s];
278   }
279 }
280
281
282 /// popcount() counts the number of non-zero bits in a bitboard
283
284 inline int popcount(Bitboard b) {
285
286 #ifndef USE_POPCNT
287
288   extern uint8_t PopCnt16[1 << 16];
289   union { Bitboard bb; uint16_t u[4]; } v = { b };
290   return PopCnt16[v.u[0]] + PopCnt16[v.u[1]] + PopCnt16[v.u[2]] + PopCnt16[v.u[3]];
291
292 #elif defined(_MSC_VER) || defined(__INTEL_COMPILER)
293
294   return (int)_mm_popcnt_u64(b);
295
296 #else // Assumed gcc or compatible compiler
297
298   return __builtin_popcountll(b);
299
300 #endif
301 }
302
303
304 /// lsb() and msb() return the least/most significant bit in a non-zero bitboard
305
306 #if defined(__GNUC__)  // GCC, Clang, ICC
307
308 inline Square lsb(Bitboard b) {
309   assert(b);
310   return Square(__builtin_ctzll(b));
311 }
312
313 inline Square msb(Bitboard b) {
314   assert(b);
315   return Square(63 ^ __builtin_clzll(b));
316 }
317
318 #elif defined(_MSC_VER)  // MSVC
319
320 #ifdef _WIN64  // MSVC, WIN64
321
322 inline Square lsb(Bitboard b) {
323   assert(b);
324   unsigned long idx;
325   _BitScanForward64(&idx, b);
326   return (Square) idx;
327 }
328
329 inline Square msb(Bitboard b) {
330   assert(b);
331   unsigned long idx;
332   _BitScanReverse64(&idx, b);
333   return (Square) idx;
334 }
335
336 #else  // MSVC, WIN32
337
338 inline Square lsb(Bitboard b) {
339   assert(b);
340   unsigned long idx;
341
342   if (b & 0xffffffff) {
343       _BitScanForward(&idx, int32_t(b));
344       return Square(idx);
345   } else {
346       _BitScanForward(&idx, int32_t(b >> 32));
347       return Square(idx + 32);
348   }
349 }
350
351 inline Square msb(Bitboard b) {
352   assert(b);
353   unsigned long idx;
354
355   if (b >> 32) {
356       _BitScanReverse(&idx, int32_t(b >> 32));
357       return Square(idx + 32);
358   } else {
359       _BitScanReverse(&idx, int32_t(b));
360       return Square(idx);
361   }
362 }
363
364 #endif
365
366 #else  // Compiler is neither GCC nor MSVC compatible
367
368 #error "Compiler not supported."
369
370 #endif
371
372
373 /// pop_lsb() finds and clears the least significant bit in a non-zero bitboard
374
375 inline Square pop_lsb(Bitboard* b) {
376   const Square s = lsb(*b);
377   *b &= *b - 1;
378   return s;
379 }
380
381
382 /// frontmost_sq() and backmost_sq() return the square corresponding to the
383 /// most/least advanced bit relative to the given color.
384
385 inline Square frontmost_sq(Color c, Bitboard b) { return c == WHITE ? msb(b) : lsb(b); }
386 inline Square  backmost_sq(Color c, Bitboard b) { return c == WHITE ? lsb(b) : msb(b); }
387
388 #endif // #ifndef BITBOARD_H_INCLUDED