Refactor Position::pinned_pieces() to use templates
[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 Marco Costalba
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
21 #if !defined(BITBOARD_H_INCLUDED)
22 #define BITBOARD_H_INCLUDED
23
24
25 ////
26 //// Defines
27 ////
28
29 // Comment following define if you prefer manually adjust
30 // platform macros defined below
31 #define AUTO_CONFIGURATION
32
33 // Quiet a warning on Intel compiler
34 #if !defined(__SIZEOF_INT__ )
35 #define __SIZEOF_INT__ 0
36 #endif
37
38 // Check for 64 bits for different compilers: Intel, MSVC and gcc
39 #if defined(__x86_64) || defined(_WIN64) || (__SIZEOF_INT__ > 4)
40 #define IS_64BIT
41 #endif
42
43 #if !defined(AUTO_CONFIGURATION) || defined(IS_64BIT)
44
45 //#define USE_COMPACT_ROOK_ATTACKS
46 //#define USE_32BIT_ATTACKS
47 #define USE_FOLDED_BITSCAN
48
49 #define BITCOUNT_SWAR_64
50 //#define BITCOUNT_SWAR_32
51 //#define BITCOUNT_LOOP
52
53 #else
54
55 #define USE_32BIT_ATTACKS
56 #define USE_FOLDED_BITSCAN
57 #define BITCOUNT_SWAR_32
58
59 #endif
60
61 ////
62 //// Includes
63 ////
64
65 #include "direction.h"
66 #include "piece.h"
67 #include "square.h"
68 #include "types.h"
69
70
71 ////
72 //// Types
73 ////
74
75 typedef uint64_t Bitboard;
76
77
78 ////
79 //// Constants and variables
80 ////
81
82 const Bitboard EmptyBoardBB = 0ULL;
83
84 const Bitboard WhiteSquaresBB = 0x55AA55AA55AA55AAULL;
85 const Bitboard BlackSquaresBB = 0xAA55AA55AA55AA55ULL;
86
87 extern const Bitboard SquaresByColorBB[2];
88
89 const Bitboard FileABB = 0x0101010101010101ULL;
90 const Bitboard FileBBB = 0x0202020202020202ULL;
91 const Bitboard FileCBB = 0x0404040404040404ULL;
92 const Bitboard FileDBB = 0x0808080808080808ULL;
93 const Bitboard FileEBB = 0x1010101010101010ULL;
94 const Bitboard FileFBB = 0x2020202020202020ULL;
95 const Bitboard FileGBB = 0x4040404040404040ULL;
96 const Bitboard FileHBB = 0x8080808080808080ULL;
97
98 extern const Bitboard FileBB[8];
99 extern const Bitboard NeighboringFilesBB[8];
100 extern const Bitboard ThisAndNeighboringFilesBB[8];
101
102 const Bitboard Rank1BB = 0xFFULL;
103 const Bitboard Rank2BB = 0xFF00ULL;
104 const Bitboard Rank3BB = 0xFF0000ULL;
105 const Bitboard Rank4BB = 0xFF000000ULL;
106 const Bitboard Rank5BB = 0xFF00000000ULL;
107 const Bitboard Rank6BB = 0xFF0000000000ULL;
108 const Bitboard Rank7BB = 0xFF000000000000ULL;
109 const Bitboard Rank8BB = 0xFF00000000000000ULL;
110
111 extern const Bitboard RankBB[8];
112 extern const Bitboard RelativeRankBB[2][8];
113 extern const Bitboard InFrontBB[2][8];
114
115 extern Bitboard SetMaskBB[64];
116 extern Bitboard ClearMaskBB[64];
117
118 extern Bitboard StepAttackBB[16][64];
119 extern Bitboard RayBB[64][8];
120 extern Bitboard BetweenBB[64][64];
121
122 extern Bitboard PassedPawnMask[2][64];
123 extern Bitboard OutpostMask[2][64];
124
125 #if defined(USE_COMPACT_ROOK_ATTACKS)
126 extern Bitboard RankAttacks[8][64], FileAttacks[8][64];
127 #else
128 extern const uint64_t RMult[64];
129 extern const int RShift[64];
130 extern Bitboard RMask[64];
131 extern int RAttackIndex[64];
132 extern Bitboard RAttacks[0x19000];
133 #endif // defined(USE_COMPACT_ROOK_ATTACKS)
134
135 extern const uint64_t BMult[64];
136 extern const int BShift[64];
137 extern Bitboard BMask[64];
138 extern int BAttackIndex[64];
139 extern Bitboard BAttacks[0x1480];
140
141 extern Bitboard BishopPseudoAttacks[64];
142 extern Bitboard RookPseudoAttacks[64];
143 extern Bitboard QueenPseudoAttacks[64];
144
145
146 ////
147 //// Inline functions
148 ////
149
150 /// Functions for testing whether a given bit is set in a bitboard, and for
151 /// setting and clearing bits.
152
153 inline Bitboard bit_is_set(Bitboard b, Square s) {
154   return b & SetMaskBB[s];
155 }
156
157 inline void set_bit(Bitboard *b, Square s) {
158   *b |= SetMaskBB[s];
159 }
160
161 inline void clear_bit(Bitboard *b, Square s) {
162   *b &= ClearMaskBB[s];
163 }
164
165
166 /// rank_bb() and file_bb() gives a bitboard containing all squares on a given
167 /// file or rank.  It is also possible to pass a square as input to these
168 /// functions.
169
170 inline Bitboard rank_bb(Rank r) {
171   return RankBB[r];
172 }
173
174 inline Bitboard rank_bb(Square s) {
175   return rank_bb(square_rank(s));
176 }
177
178 inline Bitboard file_bb(File f) {
179   return FileBB[f];
180 }
181
182 inline Bitboard file_bb(Square s) {
183   return file_bb(square_file(s));
184 }
185
186
187 /// neighboring_files_bb takes a file or a square as input, and returns a
188 /// bitboard representing all squares on the neighboring files.
189
190 inline Bitboard neighboring_files_bb(File f) {
191   return NeighboringFilesBB[f];
192 }
193
194 inline Bitboard neighboring_files_bb(Square s) {
195   return neighboring_files_bb(square_file(s));
196 }
197
198
199 /// this_and_neighboring_files_bb takes a file or a square as input, and
200 /// returns a bitboard representing all squares on the given and neighboring
201 /// files.
202
203 inline Bitboard this_and_neighboring_files_bb(File f) {
204   return ThisAndNeighboringFilesBB[f];
205 }
206
207 inline Bitboard this_and_neighboring_files_bb(Square s) {
208   return this_and_neighboring_files_bb(square_file(s));
209 }
210
211
212 /// relative_rank_bb() takes a color and a rank as input, and returns a bitboard
213 /// representing all squares on the given rank from the given color's point of
214 /// view.  For instance, relative_rank_bb(WHITE, 7) gives all squares on the
215 /// 7th rank, while relative_rank_bb(BLACK, 7) gives all squares on the 2nd
216 /// rank.
217
218 inline Bitboard relative_rank_bb(Color c, Rank r) {
219   return RelativeRankBB[c][r];
220 }
221
222
223 /// in_front_bb() takes a color and a rank or square as input, and returns a
224 /// bitboard representing all the squares on all ranks in front of the rank
225 /// (or square), from the given color's point of view.  For instance,
226 /// in_front_bb(WHITE, RANK_5) will give all squares on ranks 6, 7 and 8, while
227 /// in_front_bb(BLACK, SQ_D3) will give all squares on ranks 1 and 2.
228
229 inline Bitboard in_front_bb(Color c, Rank r) {
230   return InFrontBB[c][r];
231 }
232
233 inline Bitboard in_front_bb(Color c, Square s) {
234   return in_front_bb(c, square_rank(s));
235 }
236
237
238 /// ray_bb() gives a bitboard representing all squares along the ray in a
239 /// given direction from a given square.
240
241 inline Bitboard ray_bb(Square s, SignedDirection d) {
242   return RayBB[s][d];
243 }
244
245
246 /// Functions for computing sliding attack bitboards.  rook_attacks_bb(),
247 /// bishop_attacks_bb() and queen_attacks_bb() all take a square and a
248 /// bitboard of occupied squares as input, and return a bitboard representing
249 /// all squares attacked by a rook, bishop or queen on the given square.
250
251 #if defined(USE_COMPACT_ROOK_ATTACKS)
252
253 inline Bitboard file_attacks_bb(Square s, Bitboard blockers) {
254   Bitboard b = (blockers >> square_file(s)) & 0x01010101010100ULL;
255   return
256     FileAttacks[square_rank(s)][(b*0xd6e8802041d0c441ULL)>>58] & file_bb(s);
257 }
258
259 inline Bitboard rank_attacks_bb(Square s, Bitboard blockers) {
260   Bitboard b = (blockers >> ((s & 56) + 1)) & 63;
261   return RankAttacks[square_file(s)][b] & rank_bb(s);
262 }
263
264 inline Bitboard rook_attacks_bb(Square s, Bitboard blockers) {
265   return file_attacks_bb(s, blockers) | rank_attacks_bb(s, blockers);
266 }
267
268 #elif defined(USE_32BIT_ATTACKS)
269
270 inline Bitboard rook_attacks_bb(Square s, Bitboard blockers) {
271   Bitboard b = blockers & RMask[s];
272   return RAttacks[RAttackIndex[s] +
273                   (unsigned(int(b) * int(RMult[s]) ^
274                             int(b >> 32) * int(RMult[s] >> 32))
275                    >> RShift[s])];
276 }
277
278 #else
279
280 inline Bitboard rook_attacks_bb(Square s, Bitboard blockers) {
281   Bitboard b = blockers & RMask[s];
282   return RAttacks[RAttackIndex[s] + ((b * RMult[s]) >> RShift[s])];
283 }
284
285 #endif
286
287 #if defined(USE_32BIT_ATTACKS)
288
289 inline Bitboard bishop_attacks_bb(Square s, Bitboard blockers) {
290   Bitboard b = blockers & BMask[s];
291   return BAttacks[BAttackIndex[s] +
292                   (unsigned(int(b) * int(BMult[s]) ^
293                             int(b >> 32) * int(BMult[s] >> 32))
294                    >> BShift[s])];
295 }
296
297 #else // defined(USE_32BIT_ATTACKS)
298
299 inline Bitboard bishop_attacks_bb(Square s, Bitboard blockers) {
300   Bitboard b = blockers & BMask[s];
301   return BAttacks[BAttackIndex[s] + ((b * BMult[s]) >> BShift[s])];
302 }
303
304 #endif // defined(USE_32BIT_ATTACKS)
305
306 inline Bitboard queen_attacks_bb(Square s, Bitboard blockers) {
307   return rook_attacks_bb(s, blockers) | bishop_attacks_bb(s, blockers);
308 }
309
310
311 /// squares_between returns a bitboard representing all squares between
312 /// two squares.  For instance, squares_between(SQ_C4, SQ_F7) returns a
313 /// bitboard with the bits for square d5 and e6 set.  If s1 and s2 are not
314 /// on the same line, file or diagonal, EmptyBoardBB is returned.
315
316 inline Bitboard squares_between(Square s1, Square s2) {
317   return BetweenBB[s1][s2];
318 }
319
320
321 /// squares_in_front_of takes a color and a square as input, and returns a
322 /// bitboard representing all squares along the line in front of the square,
323 /// from the point of view of the given color.  For instance,
324 /// squares_in_front_of(BLACK, SQ_E4) returns a bitboard with the squares
325 /// e3, e2 and e1 set.
326
327 inline Bitboard squares_in_front_of(Color c, Square s) {
328   return in_front_bb(c, s) & file_bb(s);
329 }
330
331
332 /// squares_behind is similar to squares_in_front, but returns the squares
333 /// behind the square instead of in front of the square.
334
335 inline Bitboard squares_behind(Color c, Square s) {
336   return in_front_bb(opposite_color(c), s) & file_bb(s);
337 }
338
339
340 /// passed_pawn_mask takes a color and a square as input, and returns a
341 /// bitboard mask which can be used to test if a pawn of the given color on
342 /// the given square is a passed pawn.
343
344 inline Bitboard passed_pawn_mask(Color c, Square s) {
345   return PassedPawnMask[c][s];
346 }
347
348
349 /// outpost_mask takes a color and a square as input, and returns a bitboard
350 /// mask which can be used to test whether a piece on the square can possibly
351 /// be driven away by an enemy pawn.
352
353 inline Bitboard outpost_mask(Color c, Square s) {
354   return OutpostMask[c][s];
355 }
356
357
358 /// isolated_pawn_mask takes a square as input, and returns a bitboard mask
359 /// which can be used to test whether a pawn on the given square is isolated.
360
361 inline Bitboard isolated_pawn_mask(Square s) {
362   return neighboring_files_bb(s);
363 }
364
365
366 /// count_1s() counts the number of nonzero bits in a bitboard.
367
368 #if defined(BITCOUNT_LOOP)
369
370 inline int count_1s(Bitboard b) {
371   int r;
372   for(r = 0; b; r++, b &= b - 1);
373   return r;
374 }
375
376 inline int count_1s_max_15(Bitboard b) {
377   return count_1s(b);
378 }
379
380 #elif defined(BITCOUNT_SWAR_32)
381
382 inline int count_1s(Bitboard b) {
383   unsigned w = unsigned(b >> 32), v = unsigned(b);
384   v = v - ((v >> 1) & 0x55555555);
385   w = w - ((w >> 1) & 0x55555555);
386   v = (v & 0x33333333) + ((v >> 2) & 0x33333333);
387   w = (w & 0x33333333) + ((w >> 2) & 0x33333333);
388   v = (v + (v >> 4)) & 0x0F0F0F0F;
389   w = (w + (w >> 4)) & 0x0F0F0F0F;
390   v = ((v+w) * 0x01010101) >> 24; // mul is fast on amd procs
391   return int(v);
392 }
393
394 inline int count_1s_max_15(Bitboard b) {
395   unsigned w = unsigned(b >> 32), v = unsigned(b);
396   v = v - ((v >> 1) & 0x55555555);
397   w = w - ((w >> 1) & 0x55555555);
398   v = (v & 0x33333333) + ((v >> 2) & 0x33333333);
399   w = (w & 0x33333333) + ((w >> 2) & 0x33333333);
400   v = ((v+w) * 0x11111111) >> 28;
401   return int(v);
402 }
403
404 #elif defined(BITCOUNT_SWAR_64)
405
406 inline int count_1s(Bitboard b) {
407   b -= ((b>>1) & 0x5555555555555555ULL);
408   b = ((b>>2) & 0x3333333333333333ULL) + (b & 0x3333333333333333ULL);
409   b = ((b>>4) + b) & 0x0F0F0F0F0F0F0F0FULL;
410   b *= 0x0101010101010101ULL;
411   return int(b >> 56);
412 }
413
414 inline int count_1s_max_15(Bitboard b) {
415   b -= (b>>1) & 0x5555555555555555ULL;
416   b = ((b>>2) & 0x3333333333333333ULL) + (b & 0x3333333333333333ULL);
417   b *= 0x1111111111111111ULL;
418   return int(b >> 60);
419 }
420
421 #endif // BITCOUNT
422
423
424 ////
425 //// Prototypes
426 ////
427
428 extern void print_bitboard(Bitboard b);
429 extern void init_bitboards();
430 extern Square first_1(Bitboard b);
431 extern Square pop_1st_bit(Bitboard *b);
432
433
434 #endif // !defined(BITBOARD_H_INCLUDED)