Make init_magic() piece agnostic
[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-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   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>
22 #include <iostream>
23
24 #include "bitboard.h"
25 #include "bitcount.h"
26 #include "rkiss.h"
27
28 Bitboard RMasks[64];
29 Bitboard RMagics[64];
30 Bitboard* RAttacks[64];
31 int RShifts[64];
32
33 Bitboard BMasks[64];
34 Bitboard BMagics[64];
35 Bitboard* BAttacks[64];
36 int BShifts[64];
37
38 Bitboard SetMaskBB[65];
39 Bitboard ClearMaskBB[65];
40
41 Bitboard FileBB[8];
42 Bitboard RankBB[8];
43 Bitboard AdjacentFilesBB[8];
44 Bitboard ThisAndAdjacentFilesBB[8];
45 Bitboard InFrontBB[2][8];
46 Bitboard StepAttacksBB[16][64];
47 Bitboard BetweenBB[64][64];
48 Bitboard SquaresInFrontMask[2][64];
49 Bitboard PassedPawnMask[2][64];
50 Bitboard AttackSpanMask[2][64];
51
52 Bitboard PseudoAttacks[6][64];
53
54 uint8_t BitCount8Bit[256];
55 int SquareDistance[64][64];
56
57 namespace {
58
59   CACHE_LINE_ALIGNMENT
60
61   int BSFTable[64];
62   Bitboard RTable[0x19000]; // Storage space for rook attacks
63   Bitboard BTable[0x1480];  // Storage space for bishop attacks
64
65   typedef unsigned (Fn)(Square, Bitboard);
66
67   void init_magics(Bitboard table[], Bitboard* attacks[], Bitboard magics[],
68                    Bitboard masks[], int shifts[], Square deltas[], Fn get_index);
69 }
70
71
72 /// print_bitboard() prints a bitboard in an easily readable format to the
73 /// standard output. This is sometimes useful for debugging.
74
75 void print_bitboard(Bitboard b) {
76
77   for (Rank r = RANK_8; r >= RANK_1; r--)
78   {
79       std::cout << "+---+---+---+---+---+---+---+---+" << '\n';
80       for (File f = FILE_A; f <= FILE_H; f++)
81           std::cout << "| " << (bit_is_set(b, make_square(f, r)) ? "X " : "  ");
82
83       std::cout << "|\n";
84   }
85   std::cout << "+---+---+---+---+---+---+---+---+" << std::endl;
86 }
87
88
89 /// first_1() finds the least significant nonzero bit in a nonzero bitboard.
90 /// pop_1st_bit() finds and clears the least significant nonzero bit in a
91 /// nonzero bitboard.
92
93 #if defined(IS_64BIT) && !defined(USE_BSFQ)
94
95 Square first_1(Bitboard b) {
96   return Square(BSFTable[((b & -b) * 0x218A392CD3D5DBFULL) >> 58]);
97 }
98
99 Square pop_1st_bit(Bitboard* b) {
100   Bitboard bb = *b;
101   *b &= (*b - 1);
102   return Square(BSFTable[((bb & -bb) * 0x218A392CD3D5DBFULL) >> 58]);
103 }
104
105 #elif !defined(USE_BSFQ)
106
107 Square first_1(Bitboard b) {
108   b ^= (b - 1);
109   uint32_t fold = unsigned(b) ^ unsigned(b >> 32);
110   return Square(BSFTable[(fold * 0x783A9B23) >> 26]);
111 }
112
113 // Use type-punning
114 union b_union {
115
116     Bitboard b;
117     struct {
118 #if defined (BIGENDIAN)
119         uint32_t h;
120         uint32_t l;
121 #else
122         uint32_t l;
123         uint32_t h;
124 #endif
125     } dw;
126 };
127
128 Square pop_1st_bit(Bitboard* bb) {
129
130    b_union u;
131    Square ret;
132
133    u.b = *bb;
134
135    if (u.dw.l)
136    {
137        ret = Square(BSFTable[((u.dw.l ^ (u.dw.l - 1)) * 0x783A9B23) >> 26]);
138        u.dw.l &= (u.dw.l - 1);
139        *bb = u.b;
140        return ret;
141    }
142    ret = Square(BSFTable[((~(u.dw.h ^ (u.dw.h - 1))) * 0x783A9B23) >> 26]);
143    u.dw.h &= (u.dw.h - 1);
144    *bb = u.b;
145    return ret;
146 }
147
148 #endif // !defined(USE_BSFQ)
149
150
151 /// bitboards_init() initializes various bitboard arrays. It is called during
152 /// program initialization.
153
154 void bitboards_init() {
155
156   for (Bitboard b = 0; b < 256; b++)
157       BitCount8Bit[b] = (uint8_t)popcount<Max15>(b);
158
159   for (Square s = SQ_A1; s <= SQ_H8; s++)
160   {
161       SetMaskBB[s] = 1ULL << s;
162       ClearMaskBB[s] = ~SetMaskBB[s];
163   }
164
165   ClearMaskBB[SQ_NONE] = ~0ULL;
166
167   FileBB[FILE_A] = FileABB;
168   RankBB[RANK_1] = Rank1BB;
169
170   for (int f = FILE_B; f <= FILE_H; f++)
171   {
172       FileBB[f] = FileBB[f - 1] << 1;
173       RankBB[f] = RankBB[f - 1] << 8;
174   }
175
176   for (int f = FILE_A; f <= FILE_H; f++)
177   {
178       AdjacentFilesBB[f] = (f > FILE_A ? FileBB[f - 1] : 0) | (f < FILE_H ? FileBB[f + 1] : 0);
179       ThisAndAdjacentFilesBB[f] = FileBB[f] | AdjacentFilesBB[f];
180   }
181
182   for (int rw = RANK_7, rb = RANK_2; rw >= RANK_1; rw--, rb++)
183   {
184       InFrontBB[WHITE][rw] = InFrontBB[WHITE][rw + 1] | RankBB[rw + 1];
185       InFrontBB[BLACK][rb] = InFrontBB[BLACK][rb - 1] | RankBB[rb - 1];
186   }
187
188   for (Color c = WHITE; c <= BLACK; c++)
189       for (Square s = SQ_A1; s <= SQ_H8; s++)
190       {
191           SquaresInFrontMask[c][s] = in_front_bb(c, s) & file_bb(s);
192           PassedPawnMask[c][s]     = in_front_bb(c, s) & this_and_adjacent_files_bb(file_of(s));
193           AttackSpanMask[c][s]     = in_front_bb(c, s) & adjacent_files_bb(file_of(s));
194       }
195
196   for (Square s1 = SQ_A1; s1 <= SQ_H8; s1++)
197       for (Square s2 = SQ_A1; s2 <= SQ_H8; s2++)
198           SquareDistance[s1][s2] = std::max(file_distance(s1, s2), rank_distance(s1, s2));
199
200   for (int i = 0; i < 64; i++)
201       if (!Is64Bit) // Matt Taylor's folding trick for 32 bit systems
202       {
203           Bitboard b = 1ULL << i;
204           b ^= b - 1;
205           b ^= b >> 32;
206           BSFTable[(uint32_t)(b * 0x783A9B23) >> 26] = i;
207       }
208       else
209           BSFTable[((1ULL << i) * 0x218A392CD3D5DBFULL) >> 58] = i;
210
211   int steps[][9] = { {}, { 7, 9 }, { 17, 15, 10, 6, -6, -10, -15, -17 },
212                      {}, {}, {}, { 9, 7, -7, -9, 8, 1, -1, -8 } };
213
214   for (Color c = WHITE; c <= BLACK; c++)
215       for (PieceType pt = PAWN; pt <= KING; pt++)
216           for (Square s = SQ_A1; s <= SQ_H8; s++)
217               for (int k = 0; steps[pt][k]; k++)
218               {
219                   Square to = s + Square(c == WHITE ? steps[pt][k] : -steps[pt][k]);
220
221                   if (square_is_ok(to) && square_distance(s, to) < 3)
222                       set_bit(&StepAttacksBB[make_piece(c, pt)][s], to);
223               }
224
225   Square RDeltas[] = { DELTA_N,  DELTA_E,  DELTA_S,  DELTA_W  };
226   Square BDeltas[] = { DELTA_NE, DELTA_SE, DELTA_SW, DELTA_NW };
227
228   init_magics(RTable, RAttacks, RMagics, RMasks, RShifts, RDeltas, r_index);
229   init_magics(BTable, BAttacks, BMagics, BMasks, BShifts, BDeltas, b_index);
230
231   for (Square s = SQ_A1; s <= SQ_H8; s++)
232   {
233       PseudoAttacks[BISHOP][s] = bishop_attacks_bb(s, 0);
234       PseudoAttacks[ROOK][s]   = rook_attacks_bb(s, 0);
235       PseudoAttacks[QUEEN][s]  = PseudoAttacks[BISHOP][s] | PseudoAttacks[ROOK][s];
236   }
237
238   for (Square s1 = SQ_A1; s1 <= SQ_H8; s1++)
239       for (Square s2 = SQ_A1; s2 <= SQ_H8; s2++)
240           if (bit_is_set(PseudoAttacks[QUEEN][s1], s2))
241           {
242               Square delta = (s2 - s1) / square_distance(s1, s2);
243
244               for (Square s = s1 + delta; s != s2; s += delta)
245                   set_bit(&BetweenBB[s1][s2], s);
246           }
247 }
248
249
250 namespace {
251
252   Bitboard sliding_attack(Square deltas[], Square sq, Bitboard occupied) {
253
254     Bitboard attack = 0;
255
256     for (int i = 0; i < 4; i++)
257         for (Square s = sq + deltas[i];
258              square_is_ok(s) && square_distance(s, s - deltas[i]) == 1;
259              s += deltas[i])
260         {
261             set_bit(&attack, s);
262
263             if (bit_is_set(occupied, s))
264                 break;
265         }
266
267     return attack;
268   }
269
270
271   Bitboard pick_random(Bitboard mask, RKISS& rk, int booster) {
272
273     Bitboard magic;
274
275     // Values s1 and s2 are used to rotate the candidate magic of a
276     // quantity known to be the optimal to quickly find the magics.
277     int s1 = booster & 63, s2 = (booster >> 6) & 63;
278
279     while (true)
280     {
281         magic = rk.rand<Bitboard>();
282         magic = (magic >> s1) | (magic << (64 - s1));
283         magic &= rk.rand<Bitboard>();
284         magic = (magic >> s2) | (magic << (64 - s2));
285         magic &= rk.rand<Bitboard>();
286
287         if (BitCount8Bit[(mask * magic) >> 56] >= 6)
288             return magic;
289     }
290   }
291
292
293   // init_magics() computes all rook and bishop attacks at startup. Magic
294   // bitboards are used to look up attacks of sliding pieces. As a reference see
295   // chessprogramming.wikispaces.com/Magic+Bitboards. In particular, here we
296   // use the so called "fancy" approach.
297
298   void init_magics(Bitboard table[], Bitboard* attacks[], Bitboard magics[],
299                    Bitboard masks[], int shifts[], Square deltas[], Fn get_index) {
300
301     int MagicBoosters[][8] = { { 3191, 2184, 1310, 3618, 2091, 1308, 2452, 3996 },
302                                { 1059, 3608,  605, 3234, 3326,   38, 2029, 3043 } };
303     RKISS rk;
304     Bitboard occupancy[4096], reference[4096], edges, b;
305     int i, size, booster;
306
307     // attacks[s] is a pointer to the beginning of the attacks table for square 's'
308     attacks[SQ_A1] = table;
309
310     for (Square s = SQ_A1; s <= SQ_H8; s++)
311     {
312         // Board edges are not considered in the relevant occupancies
313         edges = ((Rank1BB | Rank8BB) & ~rank_bb(s)) | ((FileABB | FileHBB) & ~file_bb(s));
314
315         // Given a square 's', the mask is the bitboard of sliding attacks from
316         // 's' computed on an empty board. The index must be big enough to contain
317         // all the attacks for each possible subset of the mask and so is 2 power
318         // the number of 1s of the mask. Hence we deduce the size of the shift to
319         // apply to the 64 or 32 bits word to get the index.
320         masks[s]  = sliding_attack(deltas, s, 0) & ~edges;
321         shifts[s] = (Is64Bit ? 64 : 32) - popcount<Max15>(masks[s]);
322
323         // Use Carry-Rippler trick to enumerate all subsets of masks[s] and
324         // store the corresponding sliding attack bitboard in reference[].
325         b = size = 0;
326         do {
327             occupancy[size] = b;
328             reference[size++] = sliding_attack(deltas, s, b);
329             b = (b - masks[s]) & masks[s];
330         } while (b);
331
332         // Set the offset for the table of the next square. We have individual
333         // table sizes for each square with "Fancy Magic Bitboards".
334         if (s < SQ_H8)
335             attacks[s + 1] = attacks[s] + size;
336
337         booster = MagicBoosters[Is64Bit][rank_of(s)];
338
339         // Find a magic for square 's' picking up an (almost) random number
340         // until we find the one that passes the verification test.
341         do {
342             magics[s] = pick_random(masks[s], rk, booster);
343             memset(attacks[s], 0, size * sizeof(Bitboard));
344
345             // A good magic must map every possible occupancy to an index that
346             // looks up the correct sliding attack in the attacks[s] database.
347             // Note that we build up the database for square 's' as a side
348             // effect of verifying the magic.
349             for (i = 0; i < size; i++)
350             {
351                 Bitboard& attack = attacks[s][get_index(s, occupancy[i])];
352
353                 if (attack && attack != reference[i])
354                     break;
355
356                 attack = reference[i];
357             }
358         } while (i != size);
359     }
360   }
361 }