b7fce20d9206a4fdab6716ef7158b08e27a5b12f
[stockfish] / src / bitboard.cpp
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-2014 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   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 #include <algorithm>
21 #include <cstring> // For memset
22
23 #include "bitboard.h"
24 #include "bitcount.h"
25 #include "rkiss.h"
26
27 CACHE_LINE_ALIGNMENT
28
29 Bitboard RMasks[SQUARE_NB];
30 Bitboard RMagics[SQUARE_NB];
31 Bitboard* RAttacks[SQUARE_NB];
32 unsigned RShifts[SQUARE_NB];
33
34 Bitboard BMasks[SQUARE_NB];
35 Bitboard BMagics[SQUARE_NB];
36 Bitboard* BAttacks[SQUARE_NB];
37 unsigned BShifts[SQUARE_NB];
38
39 Bitboard SquareBB[SQUARE_NB];
40 Bitboard FileBB[FILE_NB];
41 Bitboard RankBB[RANK_NB];
42 Bitboard AdjacentFilesBB[FILE_NB];
43 Bitboard InFrontBB[COLOR_NB][RANK_NB];
44 Bitboard StepAttacksBB[PIECE_NB][SQUARE_NB];
45 Bitboard BetweenBB[SQUARE_NB][SQUARE_NB];
46 Bitboard LineBB[SQUARE_NB][SQUARE_NB];
47 Bitboard DistanceRingsBB[SQUARE_NB][8];
48 Bitboard ForwardBB[COLOR_NB][SQUARE_NB];
49 Bitboard PassedPawnMask[COLOR_NB][SQUARE_NB];
50 Bitboard PawnAttackSpan[COLOR_NB][SQUARE_NB];
51 Bitboard PseudoAttacks[PIECE_TYPE_NB][SQUARE_NB];
52
53 int SquareDistance[SQUARE_NB][SQUARE_NB];
54
55 namespace {
56
57   // De Bruijn sequences. See chessprogramming.wikispaces.com/BitScan
58   const uint64_t DeBruijn_64 = 0x3F79D71B4CB0A89ULL;
59   const uint32_t DeBruijn_32 = 0x783A9B23;
60
61   CACHE_LINE_ALIGNMENT
62
63   int MS1BTable[256];
64   Square BSFTable[SQUARE_NB];
65   Bitboard RTable[0x19000]; // Storage space for rook attacks
66   Bitboard BTable[0x1480];  // Storage space for bishop attacks
67
68   typedef unsigned (Fn)(Square, Bitboard);
69
70   void init_magics(Bitboard table[], Bitboard* attacks[], Bitboard magics[],
71                    Bitboard masks[], unsigned shifts[], Square deltas[], Fn index);
72
73   FORCE_INLINE unsigned bsf_index(Bitboard b) {
74
75     // Matt Taylor's folding for 32 bit systems, extended to 64 bits by Kim Walisch
76     b ^= (b - 1);
77     return Is64Bit ? (b * DeBruijn_64) >> 58
78                    : ((unsigned(b) ^ unsigned(b >> 32)) * DeBruijn_32) >> 26;
79   }
80 }
81
82
83 /// Intel PEXT (parallel extraction) software implementation
84 Bitboard pext(Bitboard b, Bitboard mask) {
85
86   Bitboard res = 0;
87
88   for (Bitboard bb = 1; mask; bb += bb)
89   {
90       if (b & mask & -mask)
91           res |= bb;
92
93       mask &= mask - 1;
94   }
95   return res;
96 }
97
98
99 /// lsb()/msb() finds the least/most significant bit in a non-zero bitboard.
100 /// pop_lsb() finds and clears the least significant bit in a non-zero bitboard.
101
102 #ifndef USE_BSFQ
103
104 Square lsb(Bitboard b) { return BSFTable[bsf_index(b)]; }
105
106 Square pop_lsb(Bitboard* b) {
107
108   Bitboard bb = *b;
109   *b = bb & (bb - 1);
110   return BSFTable[bsf_index(bb)];
111 }
112
113 Square msb(Bitboard b) {
114
115   unsigned b32;
116   int result = 0;
117
118   if (b > 0xFFFFFFFF)
119   {
120       b >>= 32;
121       result = 32;
122   }
123
124   b32 = unsigned(b);
125
126   if (b32 > 0xFFFF)
127   {
128       b32 >>= 16;
129       result += 16;
130   }
131
132   if (b32 > 0xFF)
133   {
134       b32 >>= 8;
135       result += 8;
136   }
137
138   return Square(result + MS1BTable[b32]);
139 }
140
141 #endif // ifndef USE_BSFQ
142
143
144 /// Bitboards::pretty() returns an ASCII representation of a bitboard to be
145 /// printed to standard output. This is sometimes useful for debugging.
146
147 const std::string Bitboards::pretty(Bitboard b) {
148
149   std::string s = "+---+---+---+---+---+---+---+---+\n";
150
151   for (Rank r = RANK_8; r >= RANK_1; --r)
152   {
153       for (File f = FILE_A; f <= FILE_H; ++f)
154           s.append(b & make_square(f, r) ? "| X " : "|   ");
155
156       s.append("|\n+---+---+---+---+---+---+---+---+\n");
157   }
158
159   return s;
160 }
161
162
163 /// Bitboards::init() initializes various bitboard tables. It is called at
164 /// startup and relies on global objects to be already zero-initialized.
165
166 void Bitboards::init() {
167
168   for (Square s = SQ_A1; s <= SQ_H8; ++s)
169       BSFTable[bsf_index(SquareBB[s] = 1ULL << s)] = s;
170
171   for (Bitboard b = 1; b < 256; ++b)
172       MS1BTable[b] = more_than_one(b) ? MS1BTable[b - 1] : lsb(b);
173
174   for (File f = FILE_A; f <= FILE_H; ++f)
175       FileBB[f] = f > FILE_A ? FileBB[f - 1] << 1 : FileABB;
176
177   for (Rank r = RANK_1; r <= RANK_8; ++r)
178       RankBB[r] = r > RANK_1 ? RankBB[r - 1] << 8 : Rank1BB;
179
180   for (File f = FILE_A; f <= FILE_H; ++f)
181       AdjacentFilesBB[f] = (f > FILE_A ? FileBB[f - 1] : 0) | (f < FILE_H ? FileBB[f + 1] : 0);
182
183   for (Rank r = RANK_1; r < RANK_8; ++r)
184       InFrontBB[WHITE][r] = ~(InFrontBB[BLACK][r + 1] = InFrontBB[BLACK][r] | RankBB[r]);
185
186   for (Color c = WHITE; c <= BLACK; ++c)
187       for (Square s = SQ_A1; s <= SQ_H8; ++s)
188       {
189           ForwardBB[c][s]      = InFrontBB[c][rank_of(s)] & FileBB[file_of(s)];
190           PawnAttackSpan[c][s] = InFrontBB[c][rank_of(s)] & AdjacentFilesBB[file_of(s)];
191           PassedPawnMask[c][s] = ForwardBB[c][s] | PawnAttackSpan[c][s];
192       }
193
194   for (Square s1 = SQ_A1; s1 <= SQ_H8; ++s1)
195       for (Square s2 = SQ_A1; s2 <= SQ_H8; ++s2)
196           if (s1 != s2)
197           {
198               SquareDistance[s1][s2] = std::max(file_distance(s1, s2), rank_distance(s1, s2));
199               DistanceRingsBB[s1][SquareDistance[s1][s2] - 1] |= s2;
200           }
201
202   int steps[][9] = { {}, { 7, 9 }, { 17, 15, 10, 6, -6, -10, -15, -17 },
203                      {}, {}, {}, { 9, 7, -7, -9, 8, 1, -1, -8 } };
204
205   for (Color c = WHITE; c <= BLACK; ++c)
206       for (PieceType pt = PAWN; pt <= KING; ++pt)
207           for (Square s = SQ_A1; s <= SQ_H8; ++s)
208               for (int i = 0; steps[pt][i]; ++i)
209               {
210                   Square to = s + Square(c == WHITE ? steps[pt][i] : -steps[pt][i]);
211
212                   if (is_ok(to) && square_distance(s, to) < 3)
213                       StepAttacksBB[make_piece(c, pt)][s] |= to;
214               }
215
216   Square RDeltas[] = { DELTA_N,  DELTA_E,  DELTA_S,  DELTA_W  };
217   Square BDeltas[] = { DELTA_NE, DELTA_SE, DELTA_SW, DELTA_NW };
218
219   init_magics(RTable, RAttacks, RMagics, RMasks, RShifts, RDeltas, magic_index<ROOK>);
220   init_magics(BTable, BAttacks, BMagics, BMasks, BShifts, BDeltas, magic_index<BISHOP>);
221
222   for (Square s1 = SQ_A1; s1 <= SQ_H8; ++s1)
223   {
224       PseudoAttacks[QUEEN][s1]  = PseudoAttacks[BISHOP][s1] = attacks_bb<BISHOP>(s1, 0);
225       PseudoAttacks[QUEEN][s1] |= PseudoAttacks[  ROOK][s1] = attacks_bb<  ROOK>(s1, 0);
226
227       for (Square s2 = SQ_A1; s2 <= SQ_H8; ++s2)
228       {
229           Piece pc = (PseudoAttacks[BISHOP][s1] & s2) ? W_BISHOP :
230                      (PseudoAttacks[ROOK][s1]   & s2) ? W_ROOK   : NO_PIECE;
231
232           if (pc == NO_PIECE)
233               continue;
234
235           LineBB[s1][s2] = (attacks_bb(pc, s1, 0) & attacks_bb(pc, s2, 0)) | s1 | s2;
236           BetweenBB[s1][s2] = attacks_bb(pc, s1, SquareBB[s2]) & attacks_bb(pc, s2, SquareBB[s1]);
237       }
238   }
239 }
240
241
242 namespace {
243
244   Bitboard sliding_attack(Square deltas[], Square sq, Bitboard occupied) {
245
246     Bitboard attack = 0;
247
248     for (int i = 0; i < 4; ++i)
249         for (Square s = sq + deltas[i];
250              is_ok(s) && square_distance(s, s - deltas[i]) == 1;
251              s += deltas[i])
252         {
253             attack |= s;
254
255             if (occupied & s)
256                 break;
257         }
258
259     return attack;
260   }
261
262
263   // init_magics() computes all rook and bishop attacks at startup. Magic
264   // bitboards are used to look up attacks of sliding pieces. As a reference see
265   // chessprogramming.wikispaces.com/Magic+Bitboards. In particular, here we
266   // use the so called "fancy" approach.
267
268   void init_magics(Bitboard table[], Bitboard* attacks[], Bitboard magics[],
269                    Bitboard masks[], unsigned shifts[], Square deltas[], Fn index) {
270
271     int MagicBoosters[][8] = { {  969, 1976, 2850,  542, 2069, 2852, 1708,  164 },
272                                { 3101,  552, 3555,  926,  834,   26, 2131, 1117 } };
273
274     RKISS rk;
275     Bitboard occupancy[4096], reference[4096], edges, b;
276     int i, size, booster;
277
278     // attacks[s] is a pointer to the beginning of the attacks table for square 's'
279     attacks[SQ_A1] = table;
280
281     for (Square s = SQ_A1; s <= SQ_H8; ++s)
282     {
283         // Board edges are not considered in the relevant occupancies
284         edges = ((Rank1BB | Rank8BB) & ~rank_bb(s)) | ((FileABB | FileHBB) & ~file_bb(s));
285
286         // Given a square 's', the mask is the bitboard of sliding attacks from
287         // 's' computed on an empty board. The index must be big enough to contain
288         // all the attacks for each possible subset of the mask and so is 2 power
289         // the number of 1s of the mask. Hence we deduce the size of the shift to
290         // apply to the 64 or 32 bits word to get the index.
291         masks[s]  = sliding_attack(deltas, s, 0) & ~edges;
292         shifts[s] = (Is64Bit ? 64 : 32) - popcount<Max15>(masks[s]);
293
294         // Use Carry-Rippler trick to enumerate all subsets of masks[s] and
295         // store the corresponding sliding attack bitboard in reference[].
296         b = size = 0;
297         do {
298             occupancy[size] = b;
299             reference[size] = sliding_attack(deltas, s, b);
300
301             if (HasPext)
302                 attacks[s][pext(occupancy[size], masks[s])] = reference[size];
303
304             size++;
305             b = (b - masks[s]) & masks[s];
306         } while (b);
307
308         // Set the offset for the table of the next square. We have individual
309         // table sizes for each square with "Fancy Magic Bitboards".
310         if (s < SQ_H8)
311             attacks[s + 1] = attacks[s] + size;
312
313         if (HasPext)
314             continue;
315
316         booster = MagicBoosters[Is64Bit][rank_of(s)];
317
318         // Find a magic for square 's' picking up an (almost) random number
319         // until we find the one that passes the verification test.
320         do {
321             do magics[s] = rk.magic_rand<Bitboard>(booster);
322             while (popcount<Max15>((magics[s] * masks[s]) >> 56) < 6);
323
324             std::memset(attacks[s], 0, size * sizeof(Bitboard));
325
326             // A good magic must map every possible occupancy to an index that
327             // looks up the correct sliding attack in the attacks[s] database.
328             // Note that we build up the database for square 's' as a side
329             // effect of verifying the magic.
330             for (i = 0; i < size; ++i)
331             {
332                 Bitboard& attack = attacks[s][index(s, occupancy[i])];
333
334                 if (attack && attack != reference[i])
335                     break;
336
337                 assert(reference[i]);
338
339                 attack = reference[i];
340             }
341         } while (i < size);
342     }
343   }
344 }