Use self-describing constants instead of numbers
[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 "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 ThisAndAdjacentFilesBB[FILE_NB];
46 Bitboard InFrontBB[COLOR_NB][RANK_NB];
47 Bitboard StepAttacksBB[PIECE_NB][SQUARE_NB];
48 Bitboard BetweenBB[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 AttackSpanMask[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 #if !defined(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 // !defined(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   {
175       AdjacentFilesBB[f] = (f > FILE_A ? FileBB[f - 1] : 0) | (f < FILE_H ? FileBB[f + 1] : 0);
176       ThisAndAdjacentFilesBB[f] = FileBB[f] | AdjacentFilesBB[f];
177   }
178
179   for (Rank r = RANK_1; r < RANK_8; r++)
180       InFrontBB[WHITE][r] = ~(InFrontBB[BLACK][r + 1] = InFrontBB[BLACK][r] | RankBB[r]);
181
182   for (Color c = WHITE; c <= BLACK; c++)
183       for (Square s = SQ_A1; s <= SQ_H8; s++)
184       {
185           ForwardBB[c][s]      = InFrontBB[c][rank_of(s)] & FileBB[file_of(s)];
186           PassedPawnMask[c][s] = InFrontBB[c][rank_of(s)] & ThisAndAdjacentFilesBB[file_of(s)];
187           AttackSpanMask[c][s] = InFrontBB[c][rank_of(s)] & AdjacentFilesBB[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 (Square s1 = SQ_A1; s1 <= SQ_H8; s1++)
195       for (int d = 1; d < 8; d++)
196           for (Square s2 = SQ_A1; s2 <= SQ_H8; s2++)
197               if (SquareDistance[s1][s2] == d)
198                   DistanceRingsBB[s1][d - 1] |= s2;
199
200   int steps[][9] = { {}, { 7, 9 }, { 17, 15, 10, 6, -6, -10, -15, -17 },
201                      {}, {}, {}, { 9, 7, -7, -9, 8, 1, -1, -8 } };
202
203   for (Color c = WHITE; c <= BLACK; c++)
204       for (PieceType pt = PAWN; pt <= KING; pt++)
205           for (Square s = SQ_A1; s <= SQ_H8; s++)
206               for (int k = 0; steps[pt][k]; k++)
207               {
208                   Square to = s + Square(c == WHITE ? steps[pt][k] : -steps[pt][k]);
209
210                   if (is_ok(to) && square_distance(s, to) < 3)
211                       StepAttacksBB[make_piece(c, pt)][s] |= to;
212               }
213
214   Square RDeltas[] = { DELTA_N,  DELTA_E,  DELTA_S,  DELTA_W  };
215   Square BDeltas[] = { DELTA_NE, DELTA_SE, DELTA_SW, DELTA_NW };
216
217   init_magics(RTable, RAttacks, RMagics, RMasks, RShifts, RDeltas, magic_index<ROOK>);
218   init_magics(BTable, BAttacks, BMagics, BMasks, BShifts, BDeltas, magic_index<BISHOP>);
219
220   for (Square s = SQ_A1; s <= SQ_H8; s++)
221   {
222       PseudoAttacks[QUEEN][s]  = PseudoAttacks[BISHOP][s] = attacks_bb<BISHOP>(s, 0);
223       PseudoAttacks[QUEEN][s] |= PseudoAttacks[  ROOK][s] = attacks_bb<  ROOK>(s, 0);
224   }
225
226   for (Square s1 = SQ_A1; s1 <= SQ_H8; s1++)
227       for (Square s2 = SQ_A1; s2 <= SQ_H8; s2++)
228           if (PseudoAttacks[QUEEN][s1] & s2)
229           {
230               Square delta = (s2 - s1) / square_distance(s1, s2);
231
232               for (Square s = s1 + delta; s != s2; s += delta)
233                   BetweenBB[s1][s2] |= s;
234           }
235 }
236
237
238 namespace {
239
240   Bitboard sliding_attack(Square deltas[], Square sq, Bitboard occupied) {
241
242     Bitboard attack = 0;
243
244     for (int i = 0; i < 4; i++)
245         for (Square s = sq + deltas[i];
246              is_ok(s) && square_distance(s, s - deltas[i]) == 1;
247              s += deltas[i])
248         {
249             attack |= s;
250
251             if (occupied & s)
252                 break;
253         }
254
255     return attack;
256   }
257
258
259   Bitboard pick_random(RKISS& rk, int booster) {
260
261     // Values s1 and s2 are used to rotate the candidate magic of a
262     // quantity known to be the optimal to quickly find the magics.
263     int s1 = booster & 63, s2 = (booster >> 6) & 63;
264
265     Bitboard m = rk.rand<Bitboard>();
266     m = (m >> s1) | (m << (64 - s1));
267     m &= rk.rand<Bitboard>();
268     m = (m >> s2) | (m << (64 - s2));
269     return m & rk.rand<Bitboard>();
270   }
271
272
273   // init_magics() computes all rook and bishop attacks at startup. Magic
274   // bitboards are used to look up attacks of sliding pieces. As a reference see
275   // chessprogramming.wikispaces.com/Magic+Bitboards. In particular, here we
276   // use the so called "fancy" approach.
277
278   void init_magics(Bitboard table[], Bitboard* attacks[], Bitboard magics[],
279                    Bitboard masks[], unsigned shifts[], Square deltas[], Fn index) {
280
281     int MagicBoosters[][8] = { { 3191, 2184, 1310, 3618, 2091, 1308, 2452, 3996 },
282                                { 1059, 3608,  605, 3234, 3326,   38, 2029, 3043 } };
283     RKISS rk;
284     Bitboard occupancy[4096], reference[4096], edges, b;
285     int i, size, booster;
286
287     // attacks[s] is a pointer to the beginning of the attacks table for square 's'
288     attacks[SQ_A1] = table;
289
290     for (Square s = SQ_A1; s <= SQ_H8; s++)
291     {
292         // Board edges are not considered in the relevant occupancies
293         edges = ((Rank1BB | Rank8BB) & ~rank_bb(s)) | ((FileABB | FileHBB) & ~file_bb(s));
294
295         // Given a square 's', the mask is the bitboard of sliding attacks from
296         // 's' computed on an empty board. The index must be big enough to contain
297         // all the attacks for each possible subset of the mask and so is 2 power
298         // the number of 1s of the mask. Hence we deduce the size of the shift to
299         // apply to the 64 or 32 bits word to get the index.
300         masks[s]  = sliding_attack(deltas, s, 0) & ~edges;
301         shifts[s] = (Is64Bit ? 64 : 32) - popcount<Max15>(masks[s]);
302
303         // Use Carry-Rippler trick to enumerate all subsets of masks[s] and
304         // store the corresponding sliding attack bitboard in reference[].
305         b = size = 0;
306         do {
307             occupancy[size] = b;
308             reference[size++] = sliding_attack(deltas, s, b);
309             b = (b - masks[s]) & masks[s];
310         } while (b);
311
312         // Set the offset for the table of the next square. We have individual
313         // table sizes for each square with "Fancy Magic Bitboards".
314         if (s < SQ_H8)
315             attacks[s + 1] = attacks[s] + size;
316
317         booster = MagicBoosters[Is64Bit][rank_of(s)];
318
319         // Find a magic for square 's' picking up an (almost) random number
320         // until we find the one that passes the verification test.
321         do {
322             do magics[s] = pick_random(rk, booster);
323             while (popcount<Max15>((magics[s] * masks[s]) >> 56) < 6);
324
325             memset(attacks[s], 0, size * sizeof(Bitboard));
326
327             // A good magic must map every possible occupancy to an index that
328             // looks up the correct sliding attack in the attacks[s] database.
329             // Note that we build up the database for square 's' as a side
330             // effect of verifying the magic.
331             for (i = 0; i < size; i++)
332             {
333                 Bitboard& attack = attacks[s][index(s, occupancy[i])];
334
335                 if (attack && attack != reference[i])
336                     break;
337
338                 assert(reference[i] != 0);
339
340                 attack = reference[i];
341             }
342         } while (i != size);
343     }
344   }
345 }