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