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