Try to keep memory access in the same cache line
[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-2010 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 const Bitboard EmptyBoardBB = 0;
27
28 const Bitboard FileABB = 0x0101010101010101ULL;
29 const Bitboard FileBBB = FileABB << 1;
30 const Bitboard FileCBB = FileABB << 2;
31 const Bitboard FileDBB = FileABB << 3;
32 const Bitboard FileEBB = FileABB << 4;
33 const Bitboard FileFBB = FileABB << 5;
34 const Bitboard FileGBB = FileABB << 6;
35 const Bitboard FileHBB = FileABB << 7;
36
37 const Bitboard Rank1BB = 0xFF;
38 const Bitboard Rank2BB = Rank1BB << (8 * 1);
39 const Bitboard Rank3BB = Rank1BB << (8 * 2);
40 const Bitboard Rank4BB = Rank1BB << (8 * 3);
41 const Bitboard Rank5BB = Rank1BB << (8 * 4);
42 const Bitboard Rank6BB = Rank1BB << (8 * 5);
43 const Bitboard Rank7BB = Rank1BB << (8 * 6);
44 const Bitboard Rank8BB = Rank1BB << (8 * 7);
45
46 extern Bitboard SquaresByColorBB[2];
47 extern Bitboard FileBB[8];
48 extern Bitboard NeighboringFilesBB[8];
49 extern Bitboard ThisAndNeighboringFilesBB[8];
50 extern Bitboard RankBB[8];
51 extern Bitboard InFrontBB[2][8];
52
53 extern Bitboard SetMaskBB[65];
54 extern Bitboard ClearMaskBB[65];
55
56 extern Bitboard StepAttacksBB[16][64];
57 extern Bitboard BetweenBB[64][64];
58
59 extern Bitboard SquaresInFrontMask[2][64];
60 extern Bitboard PassedPawnMask[2][64];
61 extern Bitboard AttackSpanMask[2][64];
62
63 extern Bitboard BishopPseudoAttacks[64];
64 extern Bitboard RookPseudoAttacks[64];
65 extern Bitboard QueenPseudoAttacks[64];
66
67 extern uint8_t BitCount8Bit[256];
68
69 struct Magics {
70   Bitboard mask;
71   uint64_t mult;
72   uint32_t index;
73   uint32_t shift;
74 };
75
76 extern Magics RMagics[64];
77 extern Magics BMagics[64];
78
79 extern Bitboard RAttacks[0x19000];
80 extern Bitboard BAttacks[0x1480];
81
82
83 /// Functions for testing whether a given bit is set in a bitboard, and for
84 /// setting and clearing bits.
85
86 inline Bitboard bit_is_set(Bitboard b, Square s) {
87   return b & SetMaskBB[s];
88 }
89
90 inline void set_bit(Bitboard *b, Square s) {
91   *b |= SetMaskBB[s];
92 }
93
94 inline void clear_bit(Bitboard *b, Square s) {
95   *b &= ClearMaskBB[s];
96 }
97
98
99 /// Functions used to update a bitboard after a move. This is faster
100 /// then calling a sequence of clear_bit() + set_bit()
101
102 inline Bitboard make_move_bb(Square from, Square to) {
103   return SetMaskBB[from] | SetMaskBB[to];
104 }
105
106 inline void do_move_bb(Bitboard *b, Bitboard move_bb) {
107   *b ^= move_bb;
108 }
109
110
111 /// rank_bb() and file_bb() take a file or a square as input and return
112 /// a bitboard representing all squares on the given file or rank.
113
114 inline Bitboard rank_bb(Rank r) {
115   return RankBB[r];
116 }
117
118 inline Bitboard rank_bb(Square s) {
119   return RankBB[square_rank(s)];
120 }
121
122 inline Bitboard file_bb(File f) {
123   return FileBB[f];
124 }
125
126 inline Bitboard file_bb(Square s) {
127   return FileBB[square_file(s)];
128 }
129
130
131 /// neighboring_files_bb takes a file or a square as input and returns a
132 /// bitboard representing all squares on the neighboring files.
133
134 inline Bitboard neighboring_files_bb(File f) {
135   return NeighboringFilesBB[f];
136 }
137
138 inline Bitboard neighboring_files_bb(Square s) {
139   return NeighboringFilesBB[square_file(s)];
140 }
141
142
143 /// this_and_neighboring_files_bb takes a file or a square as input and returns
144 /// a bitboard representing all squares on the given and neighboring files.
145
146 inline Bitboard this_and_neighboring_files_bb(File f) {
147   return ThisAndNeighboringFilesBB[f];
148 }
149
150 inline Bitboard this_and_neighboring_files_bb(Square s) {
151   return ThisAndNeighboringFilesBB[square_file(s)];
152 }
153
154
155 /// in_front_bb() takes a color and a rank or square as input, and returns a
156 /// bitboard representing all the squares on all ranks in front of the rank
157 /// (or square), from the given color's point of view.  For instance,
158 /// in_front_bb(WHITE, RANK_5) will give all squares on ranks 6, 7 and 8, while
159 /// in_front_bb(BLACK, SQ_D3) will give all squares on ranks 1 and 2.
160
161 inline Bitboard in_front_bb(Color c, Rank r) {
162   return InFrontBB[c][r];
163 }
164
165 inline Bitboard in_front_bb(Color c, Square s) {
166   return InFrontBB[c][square_rank(s)];
167 }
168
169
170 /// Functions for computing sliding attack bitboards. rook_attacks_bb(),
171 /// bishop_attacks_bb() and queen_attacks_bb() all take a square and a
172 /// bitboard of occupied squares as input, and return a bitboard representing
173 /// all squares attacked by a rook, bishop or queen on the given square.
174
175 #if defined(IS_64BIT)
176
177 inline Bitboard rook_attacks_bb(Square s, Bitboard occ) {
178   const Magics& m = RMagics[s];
179   return RAttacks[m.index + (((occ & m.mask) * m.mult) >> m.shift)];
180 }
181
182 inline Bitboard bishop_attacks_bb(Square s, Bitboard occ) {
183   const Magics& m = BMagics[s];
184   return BAttacks[m.index + (((occ & m.mask) * m.mult) >> m.shift)];
185 }
186
187 #else // if !defined(IS_64BIT)
188
189 inline Bitboard rook_attacks_bb(Square s, Bitboard occ) {
190   const Magics& m = RMagics[s];
191   Bitboard b = occ & m.mask;
192   return RAttacks[m.index +
193         ((unsigned(b) * unsigned(m.mult) ^ unsigned(b >> 32) * unsigned(m.mult >> 32)) >> m.shift)];
194 }
195
196 inline Bitboard bishop_attacks_bb(Square s, Bitboard occ) {
197   const Magics& m = BMagics[s];
198   Bitboard b = occ & m.mask;
199   return BAttacks[m.index +
200         ((unsigned(b) * unsigned(m.mult) ^ unsigned(b >> 32) * unsigned(m.mult >> 32)) >> m.shift)];
201 }
202
203 #endif
204
205 inline Bitboard queen_attacks_bb(Square s, Bitboard blockers) {
206   return rook_attacks_bb(s, blockers) | bishop_attacks_bb(s, blockers);
207 }
208
209
210 /// squares_between returns a bitboard representing all squares between
211 /// two squares.  For instance, squares_between(SQ_C4, SQ_F7) returns a
212 /// bitboard with the bits for square d5 and e6 set.  If s1 and s2 are not
213 /// on the same line, file or diagonal, EmptyBoardBB is returned.
214
215 inline Bitboard squares_between(Square s1, Square s2) {
216   return BetweenBB[s1][s2];
217 }
218
219
220 /// squares_in_front_of takes a color and a square as input, and returns a
221 /// bitboard representing all squares along the line in front of the square,
222 /// from the point of view of the given color. Definition of the table is:
223 /// SquaresInFrontOf[c][s] = in_front_bb(c, s) & file_bb(s)
224
225 inline Bitboard squares_in_front_of(Color c, Square s) {
226   return SquaresInFrontMask[c][s];
227 }
228
229
230 /// passed_pawn_mask takes a color and a square as input, and returns a
231 /// bitboard mask which can be used to test if a pawn of the given color on
232 /// the given square is a passed pawn. Definition of the table is:
233 /// PassedPawnMask[c][s] = in_front_bb(c, s) & this_and_neighboring_files_bb(s)
234
235 inline Bitboard passed_pawn_mask(Color c, Square s) {
236   return PassedPawnMask[c][s];
237 }
238
239
240 /// attack_span_mask takes a color and a square as input, and returns a bitboard
241 /// representing all squares that can be attacked by a pawn of the given color
242 /// when it moves along its file starting from the given square. Definition is:
243 /// AttackSpanMask[c][s] = in_front_bb(c, s) & neighboring_files_bb(s);
244
245 inline Bitboard attack_span_mask(Color c, Square s) {
246   return AttackSpanMask[c][s];
247 }
248
249
250 /// squares_aligned returns true if the squares s1, s2 and s3 are aligned
251 /// either on a straight or on a diagonal line.
252
253 inline bool squares_aligned(Square s1, Square s2, Square s3) {
254   return  (BetweenBB[s1][s2] | BetweenBB[s1][s3] | BetweenBB[s2][s3])
255         & ((1ULL << s1) | (1ULL << s2) | (1ULL << s3));
256 }
257
258
259 /// first_1() finds the least significant nonzero bit in a nonzero bitboard.
260 /// pop_1st_bit() finds and clears the least significant nonzero bit in a
261 /// nonzero bitboard.
262
263 #if defined(USE_BSFQ)
264
265 #if defined(_MSC_VER) && !defined(__INTEL_COMPILER)
266
267 FORCE_INLINE Square first_1(Bitboard b) {
268    unsigned long index;
269    _BitScanForward64(&index, b);
270    return (Square) index;
271 }
272 #else
273
274 FORCE_INLINE Square first_1(Bitboard b) { // Assembly code by Heinz van Saanen
275   Bitboard dummy;
276   __asm__("bsfq %1, %0": "=r"(dummy): "rm"(b) );
277   return (Square) dummy;
278 }
279 #endif
280
281 FORCE_INLINE Square pop_1st_bit(Bitboard* b) {
282   const Square s = first_1(*b);
283   *b &= ~(1ULL<<s);
284   return s;
285 }
286
287 #else // if !defined(USE_BSFQ)
288
289 extern Square first_1(Bitboard b);
290 extern Square pop_1st_bit(Bitboard* b);
291
292 #endif
293
294
295 extern void print_bitboard(Bitboard b);
296 extern void init_bitboards();
297
298 #endif // !defined(BITBOARD_H_INCLUDED)