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