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