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