Micro-optimize pop_lsb() for 64bit case
[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-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
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 #if !defined(BITBOARD_H_INCLUDED)
22 #define BITBOARD_H_INCLUDED
23
24 #include "types.h"
25
26 namespace Bitboards {
27
28 void init();
29 void print(Bitboard b);
30
31 }
32
33 namespace Bitbases {
34
35 void init_kpk();
36 uint32_t probe_kpk(Square wksq, Square wpsq, Square bksq, Color stm);
37
38 }
39
40 CACHE_LINE_ALIGNMENT
41
42 extern Bitboard RMasks[SQUARE_NB];
43 extern Bitboard RMagics[SQUARE_NB];
44 extern Bitboard* RAttacks[SQUARE_NB];
45 extern unsigned RShifts[SQUARE_NB];
46
47 extern Bitboard BMasks[SQUARE_NB];
48 extern Bitboard BMagics[SQUARE_NB];
49 extern Bitboard* BAttacks[SQUARE_NB];
50 extern unsigned BShifts[SQUARE_NB];
51
52 extern Bitboard SquareBB[SQUARE_NB];
53 extern Bitboard FileBB[FILE_NB];
54 extern Bitboard RankBB[RANK_NB];
55 extern Bitboard AdjacentFilesBB[FILE_NB];
56 extern Bitboard ThisAndAdjacentFilesBB[FILE_NB];
57 extern Bitboard InFrontBB[COLOR_NB][RANK_NB];
58 extern Bitboard StepAttacksBB[PIECE_NB][SQUARE_NB];
59 extern Bitboard BetweenBB[SQUARE_NB][SQUARE_NB];
60 extern Bitboard DistanceRingsBB[SQUARE_NB][8];
61 extern Bitboard ForwardBB[COLOR_NB][SQUARE_NB];
62 extern Bitboard PassedPawnMask[COLOR_NB][SQUARE_NB];
63 extern Bitboard AttackSpanMask[COLOR_NB][SQUARE_NB];
64 extern Bitboard PseudoAttacks[PIECE_TYPE_NB][SQUARE_NB];
65
66
67 /// Overloads of bitwise operators between a Bitboard and a Square for testing
68 /// whether a given bit is set in a bitboard, and for setting and clearing bits.
69
70 inline Bitboard operator&(Bitboard b, Square s) {
71   return b & SquareBB[s];
72 }
73
74 inline Bitboard& operator|=(Bitboard& b, Square s) {
75   return b |= SquareBB[s];
76 }
77
78 inline Bitboard& operator^=(Bitboard& b, Square s) {
79   return b ^= SquareBB[s];
80 }
81
82 inline Bitboard operator|(Bitboard b, Square s) {
83   return b | SquareBB[s];
84 }
85
86 inline Bitboard operator^(Bitboard b, Square s) {
87   return b ^ SquareBB[s];
88 }
89
90
91 /// more_than_one() returns true if in 'b' there is more than one bit set
92
93 inline bool more_than_one(Bitboard b) {
94   return b & (b - 1);
95 }
96
97
98 /// rank_bb() and file_bb() take a file or a square as input and return
99 /// a bitboard representing all squares on the given file or rank.
100
101 inline Bitboard rank_bb(Rank r) {
102   return RankBB[r];
103 }
104
105 inline Bitboard rank_bb(Square s) {
106   return RankBB[rank_of(s)];
107 }
108
109 inline Bitboard file_bb(File f) {
110   return FileBB[f];
111 }
112
113 inline Bitboard file_bb(Square s) {
114   return FileBB[file_of(s)];
115 }
116
117
118 /// adjacent_files_bb takes a file as input and returns a bitboard representing
119 /// all squares on the adjacent files.
120
121 inline Bitboard adjacent_files_bb(File f) {
122   return AdjacentFilesBB[f];
123 }
124
125
126 /// this_and_adjacent_files_bb takes a file as input and returns a bitboard
127 /// representing all squares on the given and adjacent files.
128
129 inline Bitboard this_and_adjacent_files_bb(File f) {
130   return ThisAndAdjacentFilesBB[f];
131 }
132
133
134 /// in_front_bb() takes a color and a rank or square as input, and returns a
135 /// bitboard representing all the squares on all ranks in front of the rank
136 /// (or square), from the given color's point of view.  For instance,
137 /// in_front_bb(WHITE, RANK_5) will give all squares on ranks 6, 7 and 8, while
138 /// in_front_bb(BLACK, SQ_D3) will give all squares on ranks 1 and 2.
139
140 inline Bitboard in_front_bb(Color c, Rank r) {
141   return InFrontBB[c][r];
142 }
143
144 inline Bitboard in_front_bb(Color c, Square s) {
145   return InFrontBB[c][rank_of(s)];
146 }
147
148
149 /// between_bb returns a bitboard representing all squares between two squares.
150 /// For instance, between_bb(SQ_C4, SQ_F7) returns a bitboard with the bits for
151 /// square d5 and e6 set.  If s1 and s2 are not on the same line, file or diagonal,
152 /// 0 is returned.
153
154 inline Bitboard between_bb(Square s1, Square s2) {
155   return BetweenBB[s1][s2];
156 }
157
158
159 /// forward_bb takes a color and a square as input, and returns a bitboard
160 /// representing all squares along the line in front of the square, from the
161 /// point of view of the given color. Definition of the table is:
162 /// ForwardBB[c][s] = in_front_bb(c, s) & file_bb(s)
163
164 inline Bitboard forward_bb(Color c, Square s) {
165   return ForwardBB[c][s];
166 }
167
168
169 /// passed_pawn_mask takes a color and a square as input, and returns a
170 /// bitboard mask which can be used to test if a pawn of the given color on
171 /// the given square is a passed pawn. Definition of the table is:
172 /// PassedPawnMask[c][s] = in_front_bb(c, s) & this_and_adjacent_files_bb(s)
173
174 inline Bitboard passed_pawn_mask(Color c, Square s) {
175   return PassedPawnMask[c][s];
176 }
177
178
179 /// attack_span_mask takes a color and a square as input, and returns a bitboard
180 /// representing all squares that can be attacked by a pawn of the given color
181 /// when it moves along its file starting from the given square. Definition is:
182 /// AttackSpanMask[c][s] = in_front_bb(c, s) & adjacent_files_bb(s);
183
184 inline Bitboard attack_span_mask(Color c, Square s) {
185   return AttackSpanMask[c][s];
186 }
187
188
189 /// squares_aligned returns true if the squares s1, s2 and s3 are aligned
190 /// either on a straight or on a diagonal line.
191
192 inline bool squares_aligned(Square s1, Square s2, Square s3) {
193   return  (BetweenBB[s1][s2] | BetweenBB[s1][s3] | BetweenBB[s2][s3])
194         & (     SquareBB[s1] |      SquareBB[s2] |      SquareBB[s3]);
195 }
196
197
198 /// same_color_squares() returns a bitboard representing all squares with
199 /// the same color of the given square.
200
201 inline Bitboard same_color_squares(Square s) {
202   return Bitboard(0xAA55AA55AA55AA55ULL) & s ?  0xAA55AA55AA55AA55ULL
203                                              : ~0xAA55AA55AA55AA55ULL;
204 }
205
206
207 /// Functions for computing sliding attack bitboards. Function attacks_bb() takes
208 /// a square and a bitboard of occupied squares as input, and returns a bitboard
209 /// representing all squares attacked by Pt (bishop or rook) on the given square.
210 template<PieceType Pt>
211 FORCE_INLINE unsigned magic_index(Square s, Bitboard occ) {
212
213   Bitboard* const Masks  = Pt == ROOK ? RMasks  : BMasks;
214   Bitboard* const Magics = Pt == ROOK ? RMagics : BMagics;
215   unsigned* const Shifts = Pt == ROOK ? RShifts : BShifts;
216
217   if (Is64Bit)
218       return unsigned(((occ & Masks[s]) * Magics[s]) >> Shifts[s]);
219
220   unsigned lo = unsigned(occ) & unsigned(Masks[s]);
221   unsigned hi = unsigned(occ >> 32) & unsigned(Masks[s] >> 32);
222   return (lo * unsigned(Magics[s]) ^ hi * unsigned(Magics[s] >> 32)) >> Shifts[s];
223 }
224
225 template<PieceType Pt>
226 inline Bitboard attacks_bb(Square s, Bitboard occ) {
227   return (Pt == ROOK ? RAttacks : BAttacks)[s][magic_index<Pt>(s, occ)];
228 }
229
230
231 /// lsb()/msb() finds the least/most significant bit in a nonzero bitboard.
232 /// pop_lsb() finds and clears the least significant bit in a nonzero bitboard.
233
234 #if defined(USE_BSFQ)
235
236 #  if defined(_MSC_VER) && !defined(__INTEL_COMPILER)
237
238 FORCE_INLINE Square lsb(Bitboard b) {
239   unsigned long index;
240   _BitScanForward64(&index, b);
241   return (Square) index;
242 }
243
244 FORCE_INLINE Square msb(Bitboard b) {
245   unsigned long index;
246   _BitScanReverse64(&index, b);
247   return (Square) index;
248 }
249
250 #  elif defined(__arm__)
251
252 FORCE_INLINE int lsb32(uint32_t v) {
253   __asm__("rbit %0, %1" : "=r"(v) : "r"(v));
254   return __builtin_clz(v);
255 }
256
257 FORCE_INLINE Square msb(Bitboard b) {
258   return (Square) (63 - __builtin_clzll(b));
259 }
260
261 FORCE_INLINE Square lsb(Bitboard b) {
262   return (Square) (uint32_t(b) ? lsb32(uint32_t(b)) : 32 + lsb32(uint32_t(b >> 32)));
263 }
264
265 #  else
266
267 FORCE_INLINE Square lsb(Bitboard b) { // Assembly code by Heinz van Saanen
268   Bitboard index;
269   __asm__("bsfq %1, %0": "=r"(index): "rm"(b) );
270   return (Square) index;
271 }
272
273 FORCE_INLINE Square msb(Bitboard b) {
274   Bitboard index;
275   __asm__("bsrq %1, %0": "=r"(index): "rm"(b) );
276   return (Square) index;
277 }
278
279 #  endif
280
281 FORCE_INLINE Square pop_lsb(Bitboard* b) {
282   const Square s = lsb(*b);
283   *b &= *b - 1;
284   return s;
285 }
286
287 #else // if !defined(USE_BSFQ)
288
289 extern Square msb(Bitboard b);
290 extern Square lsb(Bitboard b);
291 extern Square pop_lsb(Bitboard* b);
292
293 #endif
294
295 #endif // !defined(BITBOARD_H_INCLUDED)