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