77f49ef675c506ce175a7cc4658661ff2530b65d
[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-2015 Marco Costalba, Joona Kiiski, Tord Romstad
5   Copyright (C) 2015-2019 Marco Costalba, Joona Kiiski, Gary Linscott, Tord Romstad
6
7   Stockfish is free software: you can redistribute it and/or modify
8   it under the terms of the GNU General Public License as published by
9   the Free Software Foundation, either version 3 of the License, or
10   (at your option) any later version.
11
12   Stockfish is distributed in the hope that it will be useful,
13   but WITHOUT ANY WARRANTY; without even the implied warranty of
14   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15   GNU General Public License for more details.
16
17   You should have received a copy of the GNU General Public License
18   along with this program.  If not, see <http://www.gnu.org/licenses/>.
19 */
20
21 #include <algorithm>
22
23 #include "bitboard.h"
24 #include "misc.h"
25
26 uint8_t PopCnt16[1 << 16];
27 int SquareDistance[SQUARE_NB][SQUARE_NB];
28
29 Bitboard SquareBB[SQUARE_NB];
30 Bitboard FileBB[FILE_NB];
31 Bitboard RankBB[RANK_NB];
32 Bitboard ForwardRanksBB[COLOR_NB][RANK_NB];
33 Bitboard BetweenBB[SQUARE_NB][SQUARE_NB];
34 Bitboard LineBB[SQUARE_NB][SQUARE_NB];
35 Bitboard DistanceRingBB[SQUARE_NB][8];
36 Bitboard ForwardFileBB[COLOR_NB][SQUARE_NB];
37 Bitboard PassedPawnMask[COLOR_NB][SQUARE_NB];
38 Bitboard PawnAttackSpan[COLOR_NB][SQUARE_NB];
39 Bitboard PseudoAttacks[PIECE_TYPE_NB][SQUARE_NB];
40 Bitboard PawnAttacks[COLOR_NB][SQUARE_NB];
41
42 Magic RookMagics[SQUARE_NB];
43 Magic BishopMagics[SQUARE_NB];
44
45 namespace {
46
47   Bitboard RookTable[0x19000];  // To store rook attacks
48   Bitboard BishopTable[0x1480]; // To store bishop attacks
49
50   void init_magics(Bitboard table[], Magic magics[], Direction directions[]);
51
52   // popcount16() counts the non-zero bits using SWAR-Popcount algorithm
53
54   unsigned popcount16(unsigned u) {
55     u -= (u >> 1) & 0x5555U;
56     u = ((u >> 2) & 0x3333U) + (u & 0x3333U);
57     u = ((u >> 4) + u) & 0x0F0FU;
58     return (u * 0x0101U) >> 8;
59   }
60 }
61
62
63 /// Bitboards::pretty() returns an ASCII representation of a bitboard suitable
64 /// to be printed to standard output. Useful for debugging.
65
66 const std::string Bitboards::pretty(Bitboard b) {
67
68   std::string s = "+---+---+---+---+---+---+---+---+\n";
69
70   for (Rank r = RANK_8; r >= RANK_1; --r)
71   {
72       for (File f = FILE_A; f <= FILE_H; ++f)
73           s += b & make_square(f, r) ? "| X " : "|   ";
74
75       s += "|\n+---+---+---+---+---+---+---+---+\n";
76   }
77
78   return s;
79 }
80
81
82 /// Bitboards::init() initializes various bitboard tables. It is called at
83 /// startup and relies on global objects to be already zero-initialized.
84
85 void Bitboards::init() {
86
87   for (unsigned i = 0; i < (1 << 16); ++i)
88       PopCnt16[i] = (uint8_t) popcount16(i);
89
90   for (Square s = SQ_A1; s <= SQ_H8; ++s)
91       SquareBB[s] = (1ULL << s);
92
93   for (File f = FILE_A; f <= FILE_H; ++f)
94       FileBB[f] = f > FILE_A ? FileBB[f - 1] << 1 : FileABB;
95
96   for (Rank r = RANK_1; r <= RANK_8; ++r)
97       RankBB[r] = r > RANK_1 ? RankBB[r - 1] << 8 : Rank1BB;
98
99   for (Rank r = RANK_1; r < RANK_8; ++r)
100       ForwardRanksBB[WHITE][r] = ~(ForwardRanksBB[BLACK][r + 1] = ForwardRanksBB[BLACK][r] | RankBB[r]);
101
102   for (Color c = WHITE; c <= BLACK; ++c)
103       for (Square s = SQ_A1; s <= SQ_H8; ++s)
104       {
105           ForwardFileBB [c][s] = ForwardRanksBB[c][rank_of(s)] & FileBB[file_of(s)];
106           PawnAttackSpan[c][s] = ForwardRanksBB[c][rank_of(s)] & adjacent_files_bb(file_of(s));
107           PassedPawnMask[c][s] = ForwardFileBB [c][s] | PawnAttackSpan[c][s];
108       }
109
110   for (Square s1 = SQ_A1; s1 <= SQ_H8; ++s1)
111       for (Square s2 = SQ_A1; s2 <= SQ_H8; ++s2)
112           if (s1 != s2)
113           {
114               SquareDistance[s1][s2] = std::max(distance<File>(s1, s2), distance<Rank>(s1, s2));
115               DistanceRingBB[s1][SquareDistance[s1][s2]] |= s2;
116           }
117
118   int steps[][5] = { {}, { 7, 9 }, { 6, 10, 15, 17 }, {}, {}, {}, { 1, 7, 8, 9 } };
119
120   for (Color c = WHITE; c <= BLACK; ++c)
121       for (PieceType pt : { PAWN, KNIGHT, KING })
122           for (Square s = SQ_A1; s <= SQ_H8; ++s)
123               for (int i = 0; steps[pt][i]; ++i)
124               {
125                   Square to = s + Direction(c == WHITE ? steps[pt][i] : -steps[pt][i]);
126
127                   if (is_ok(to) && distance(s, to) < 3)
128                   {
129                       if (pt == PAWN)
130                           PawnAttacks[c][s] |= to;
131                       else
132                           PseudoAttacks[pt][s] |= to;
133                   }
134               }
135
136   Direction RookDirections[] = { NORTH, EAST, SOUTH, WEST };
137   Direction BishopDirections[] = { NORTH_EAST, SOUTH_EAST, SOUTH_WEST, NORTH_WEST };
138
139   init_magics(RookTable, RookMagics, RookDirections);
140   init_magics(BishopTable, BishopMagics, BishopDirections);
141
142   for (Square s1 = SQ_A1; s1 <= SQ_H8; ++s1)
143   {
144       PseudoAttacks[QUEEN][s1]  = PseudoAttacks[BISHOP][s1] = attacks_bb<BISHOP>(s1, 0);
145       PseudoAttacks[QUEEN][s1] |= PseudoAttacks[  ROOK][s1] = attacks_bb<  ROOK>(s1, 0);
146
147       for (PieceType pt : { BISHOP, ROOK })
148           for (Square s2 = SQ_A1; s2 <= SQ_H8; ++s2)
149           {
150               if (!(PseudoAttacks[pt][s1] & s2))
151                   continue;
152
153               LineBB[s1][s2] = (attacks_bb(pt, s1, 0) & attacks_bb(pt, s2, 0)) | s1 | s2;
154               BetweenBB[s1][s2] = attacks_bb(pt, s1, SquareBB[s2]) & attacks_bb(pt, s2, SquareBB[s1]);
155           }
156   }
157 }
158
159
160 namespace {
161
162   Bitboard sliding_attack(Direction directions[], Square sq, Bitboard occupied) {
163
164     Bitboard attack = 0;
165
166     for (int i = 0; i < 4; ++i)
167         for (Square s = sq + directions[i];
168              is_ok(s) && distance(s, s - directions[i]) == 1;
169              s += directions[i])
170         {
171             attack |= s;
172
173             if (occupied & s)
174                 break;
175         }
176
177     return attack;
178   }
179
180
181   // init_magics() computes all rook and bishop attacks at startup. Magic
182   // bitboards are used to look up attacks of sliding pieces. As a reference see
183   // www.chessprogramming.org/Magic_Bitboards. In particular, here we use the so
184   // called "fancy" approach.
185
186   void init_magics(Bitboard table[], Magic magics[], Direction directions[]) {
187
188     // Optimal PRNG seeds to pick the correct magics in the shortest time
189     int seeds[][RANK_NB] = { { 8977, 44560, 54343, 38998,  5731, 95205, 104912, 17020 },
190                              {  728, 10316, 55013, 32803, 12281, 15100,  16645,   255 } };
191
192     Bitboard occupancy[4096], reference[4096], edges, b;
193     int epoch[4096] = {}, cnt = 0, size = 0;
194
195     for (Square s = SQ_A1; s <= SQ_H8; ++s)
196     {
197         // Board edges are not considered in the relevant occupancies
198         edges = ((Rank1BB | Rank8BB) & ~rank_bb(s)) | ((FileABB | FileHBB) & ~file_bb(s));
199
200         // Given a square 's', the mask is the bitboard of sliding attacks from
201         // 's' computed on an empty board. The index must be big enough to contain
202         // all the attacks for each possible subset of the mask and so is 2 power
203         // the number of 1s of the mask. Hence we deduce the size of the shift to
204         // apply to the 64 or 32 bits word to get the index.
205         Magic& m = magics[s];
206         m.mask  = sliding_attack(directions, s, 0) & ~edges;
207         m.shift = (Is64Bit ? 64 : 32) - popcount(m.mask);
208
209         // Set the offset for the attacks table of the square. We have individual
210         // table sizes for each square with "Fancy Magic Bitboards".
211         m.attacks = s == SQ_A1 ? table : magics[s - 1].attacks + size;
212
213         // Use Carry-Rippler trick to enumerate all subsets of masks[s] and
214         // store the corresponding sliding attack bitboard in reference[].
215         b = size = 0;
216         do {
217             occupancy[size] = b;
218             reference[size] = sliding_attack(directions, s, b);
219
220             if (HasPext)
221                 m.attacks[pext(b, m.mask)] = reference[size];
222
223             size++;
224             b = (b - m.mask) & m.mask;
225         } while (b);
226
227         if (HasPext)
228             continue;
229
230         PRNG rng(seeds[Is64Bit][rank_of(s)]);
231
232         // Find a magic for square 's' picking up an (almost) random number
233         // until we find the one that passes the verification test.
234         for (int i = 0; i < size; )
235         {
236             for (m.magic = 0; popcount((m.magic * m.mask) >> 56) < 6; )
237                 m.magic = rng.sparse_rand<Bitboard>();
238
239             // A good magic must map every possible occupancy to an index that
240             // looks up the correct sliding attack in the attacks[s] database.
241             // Note that we build up the database for square 's' as a side
242             // effect of verifying the magic. Keep track of the attempt count
243             // and save it in epoch[], little speed-up trick to avoid resetting
244             // m.attacks[] after every failed attempt.
245             for (++cnt, i = 0; i < size; ++i)
246             {
247                 unsigned idx = m.index(occupancy[i]);
248
249                 if (epoch[idx] < cnt)
250                 {
251                     epoch[idx] = cnt;
252                     m.attacks[idx] = reference[i];
253                 }
254                 else if (m.attacks[idx] != reference[i])
255                     break;
256             }
257         }
258     }
259   }
260 }