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