Better naming borrowed from Critter
[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-2010 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 <cstring>
21 #include <iostream>
22
23 #include "bitboard.h"
24 #include "bitcount.h"
25 #include "rkiss.h"
26
27 // Global bitboards definitions with static storage duration are
28 // automatically set to zero before enter main().
29 Bitboard RMask[64];
30 Bitboard RMult[64];
31 Bitboard* RAttacks[64];
32 int RShift[64];
33
34 Bitboard BMask[64];
35 Bitboard BMult[64];
36 Bitboard* BAttacks[64];
37 int BShift[64];
38
39 Bitboard SetMaskBB[65];
40 Bitboard ClearMaskBB[65];
41
42 Bitboard SquaresByColorBB[2];
43 Bitboard FileBB[8];
44 Bitboard RankBB[8];
45 Bitboard NeighboringFilesBB[8];
46 Bitboard ThisAndNeighboringFilesBB[8];
47 Bitboard InFrontBB[2][8];
48 Bitboard StepAttacksBB[16][64];
49 Bitboard BetweenBB[64][64];
50 Bitboard SquaresInFrontMask[2][64];
51 Bitboard PassedPawnMask[2][64];
52 Bitboard AttackSpanMask[2][64];
53
54 Bitboard BishopPseudoAttacks[64];
55 Bitboard RookPseudoAttacks[64];
56 Bitboard QueenPseudoAttacks[64];
57
58 uint8_t BitCount8Bit[256];
59 int SquareDistance[64][64];
60
61 namespace {
62
63   CACHE_LINE_ALIGNMENT
64
65   int BSFTable[64];
66   Bitboard RAttacksTable[0x19000];
67   Bitboard BAttacksTable[0x1480];
68
69   void init_sliding_attacks(Bitboard magic[], Bitboard* attack[], Bitboard attTable[],
70                             Bitboard mask[], int shift[], Square delta[]);
71 }
72
73
74 /// print_bitboard() prints a bitboard in an easily readable format to the
75 /// standard output. This is sometimes useful for debugging.
76
77 void print_bitboard(Bitboard b) {
78
79   for (Rank r = RANK_8; r >= RANK_1; r--)
80   {
81       std::cout << "+---+---+---+---+---+---+---+---+" << '\n';
82       for (File f = FILE_A; f <= FILE_H; f++)
83           std::cout << "| " << (bit_is_set(b, make_square(f, r)) ? "X " : "  ");
84
85       std::cout << "|\n";
86   }
87   std::cout << "+---+---+---+---+---+---+---+---+" << std::endl;
88 }
89
90
91 /// first_1() finds the least significant nonzero bit in a nonzero bitboard.
92 /// pop_1st_bit() finds and clears the least significant nonzero bit in a
93 /// nonzero bitboard.
94
95 #if defined(IS_64BIT) && !defined(USE_BSFQ)
96
97 Square first_1(Bitboard b) {
98   return Square(BSFTable[((b & -b) * 0x218A392CD3D5DBFULL) >> 58]);
99 }
100
101 Square pop_1st_bit(Bitboard* b) {
102   Bitboard bb = *b;
103   *b &= (*b - 1);
104   return Square(BSFTable[((bb & -bb) * 0x218A392CD3D5DBFULL) >> 58]);
105 }
106
107 #elif !defined(USE_BSFQ)
108
109 Square first_1(Bitboard b) {
110   b ^= (b - 1);
111   uint32_t fold = unsigned(b) ^ unsigned(b >> 32);
112   return Square(BSFTable[(fold * 0x783A9B23) >> 26]);
113 }
114
115 // Use type-punning
116 union b_union {
117
118     Bitboard b;
119     struct {
120 #if defined (BIGENDIAN)
121         uint32_t h;
122         uint32_t l;
123 #else
124         uint32_t l;
125         uint32_t h;
126 #endif
127     } dw;
128 };
129
130 Square pop_1st_bit(Bitboard* bb) {
131
132    b_union u;
133    Square ret;
134
135    u.b = *bb;
136
137    if (u.dw.l)
138    {
139        ret = Square(BSFTable[((u.dw.l ^ (u.dw.l - 1)) * 0x783A9B23) >> 26]);
140        u.dw.l &= (u.dw.l - 1);
141        *bb = u.b;
142        return ret;
143    }
144    ret = Square(BSFTable[((~(u.dw.h ^ (u.dw.h - 1))) * 0x783A9B23) >> 26]);
145    u.dw.h &= (u.dw.h - 1);
146    *bb = u.b;
147    return ret;
148 }
149
150 #endif // !defined(USE_BSFQ)
151
152
153 /// init_bitboards() initializes various bitboard arrays. It is called during
154 /// program initialization.
155
156 void init_bitboards() {
157
158   for (Bitboard b = 0; b < 256; b++)
159       BitCount8Bit[b] = (uint8_t)count_1s<CNT32_MAX15>(b);
160
161   for (Square s1 = SQ_A1; s1 <= SQ_H8; s1++)
162       for (Square s2 = SQ_A1; s2 <= SQ_H8; s2++)
163           SquareDistance[s1][s2] = Max(file_distance(s1, s2), rank_distance(s1, s2));
164
165   SquaresByColorBB[DARK]  =  0xAA55AA55AA55AA55ULL;
166   SquaresByColorBB[LIGHT] = ~SquaresByColorBB[DARK];
167
168   for (Square s = SQ_A1; s <= SQ_H8; s++)
169   {
170       SetMaskBB[s] = 1ULL << s;
171       ClearMaskBB[s] = ~SetMaskBB[s];
172   }
173
174   ClearMaskBB[SQ_NONE] = ~EmptyBoardBB;
175
176   FileBB[FILE_A] = FileABB;
177   RankBB[RANK_1] = Rank1BB;
178
179   for (int f = FILE_B; f <= FILE_H; f++)
180   {
181       FileBB[f] = FileBB[f - 1] << 1;
182       RankBB[f] = RankBB[f - 1] << 8;
183   }
184
185   for (int f = FILE_A; f <= FILE_H; f++)
186   {
187       NeighboringFilesBB[f] = (f > FILE_A ? FileBB[f - 1] : 0) | (f < FILE_H ? FileBB[f + 1] : 0);
188       ThisAndNeighboringFilesBB[f] = FileBB[f] | NeighboringFilesBB[f];
189   }
190
191   for (int rw = RANK_7, rb = RANK_2; rw >= RANK_1; rw--, rb++)
192   {
193       InFrontBB[WHITE][rw] = InFrontBB[WHITE][rw + 1] | RankBB[rw + 1];
194       InFrontBB[BLACK][rb] = InFrontBB[BLACK][rb - 1] | RankBB[rb - 1];
195   }
196
197   for (Color c = WHITE; c <= BLACK; c++)
198       for (Square s = SQ_A1; s <= SQ_H8; s++)
199       {
200           SquaresInFrontMask[c][s] = in_front_bb(c, s) & file_bb(s);
201           PassedPawnMask[c][s]     = in_front_bb(c, s) & this_and_neighboring_files_bb(s);
202           AttackSpanMask[c][s]     = in_front_bb(c, s) & neighboring_files_bb(s);
203       }
204
205   for (int i = 0; i < 64; i++)
206       if (!CpuIs64Bit) // 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 (square_is_ok(to) && square_distance(s, to) < 3)
227                       set_bit(&StepAttacksBB[make_piece(c, pt)][s], to);
228               }
229
230   Square RDelta[] = { DELTA_N,  DELTA_E,  DELTA_S,  DELTA_W  };
231   Square BDelta[] = { DELTA_NE, DELTA_SE, DELTA_SW, DELTA_NW };
232
233   init_sliding_attacks(BMult, BAttacks, BAttacksTable, BMask, BShift, BDelta);
234   init_sliding_attacks(RMult, RAttacks, RAttacksTable, RMask, RShift, RDelta);
235
236   for (Square s = SQ_A1; s <= SQ_H8; s++)
237   {
238       BishopPseudoAttacks[s] = bishop_attacks_bb(s, EmptyBoardBB);
239       RookPseudoAttacks[s]   = rook_attacks_bb(s, EmptyBoardBB);
240       QueenPseudoAttacks[s]  = queen_attacks_bb(s, EmptyBoardBB);
241   }
242
243   for (Square s1 = SQ_A1; s1 <= SQ_H8; s1++)
244       for (Square s2 = SQ_A1; s2 <= SQ_H8; s2++)
245           if (bit_is_set(QueenPseudoAttacks[s1], s2))
246           {
247               int f = file_distance(s1, s2);
248               int r = rank_distance(s1, s2);
249
250               Square d = (s2 - s1) / Max(f, r);
251
252               for (Square s3 = s1 + d; s3 != s2; s3 += d)
253                   set_bit(&BetweenBB[s1][s2], s3);
254           }
255 }
256
257
258 namespace {
259
260   Bitboard sliding_attacks(Square sq, Bitboard occupied, Square delta[]) {
261
262     Bitboard attacks = 0;
263
264     for (int i = 0; i < 4; i++)
265     {
266         Square s = sq + delta[i];
267
268         while (square_is_ok(s) && square_distance(s, s - delta[i]) == 1)
269         {
270             set_bit(&attacks, s);
271
272             if (bit_is_set(occupied, s))
273                 break;
274
275             s += delta[i];
276         }
277     }
278     return attacks;
279   }
280
281   Bitboard pick_magic(Bitboard mask, RKISS& rk, int booster) {
282
283     Bitboard magic;
284
285     // Values s1 and s2 are used to rotate the candidate magic of a
286     // quantity known to be the optimal to quickly find the magics.
287     int s1 = booster & 63, s2 = (booster >> 6) & 63;
288
289     while (true)
290     {
291         magic = rk.rand<Bitboard>();
292         magic = (magic >> s1) | (magic << (64 - s1));
293         magic &= rk.rand<Bitboard>();
294         magic = (magic >> s2) | (magic << (64 - s2));
295         magic &= rk.rand<Bitboard>();
296
297         if (BitCount8Bit[(mask * magic) >> 56] >= 6)
298             return magic;
299     }
300   }
301
302   void init_sliding_attacks(Bitboard magic[], Bitboard* attack[], Bitboard attTable[],
303                             Bitboard mask[], int shift[], Square delta[]) {
304
305     const int  MagicBoosters[][8] = { { 3191, 2184, 1310, 3618, 2091, 1308, 2452, 3996 },
306                                       { 1059, 3608,  605, 3234, 3326,   38, 2029, 3043 } };
307     RKISS rk;
308     Bitboard occupancy[4096], reference[4096], edges, b;
309     int key, maxKey, index, booster, offset = 0;
310
311     for (Square s = SQ_A1; s <= SQ_H8; s++)
312     {
313         edges = ((Rank1BB | Rank8BB) & ~rank_bb(s)) | ((FileABB | FileHBB) & ~file_bb(s));
314
315         attack[s] = &attTable[offset];
316         mask[s]   = sliding_attacks(s, EmptyBoardBB, delta) & ~edges;
317         shift[s]  = (CpuIs64Bit ? 64 : 32) - count_1s<CNT32_MAX15>(mask[s]);
318
319         // Use Carry-Rippler trick to enumerate all subsets of mask[s]
320         b = maxKey = 0;
321         do {
322             occupancy[maxKey] = b;
323             reference[maxKey++] = sliding_attacks(s, b, delta);
324             b = (b - mask[s]) & mask[s];
325         } while (b);
326
327         offset += maxKey;
328         booster = MagicBoosters[CpuIs64Bit][rank_of(s)];
329
330         // Then find a possible magic and the corresponding attacks
331         do {
332             magic[s] = pick_magic(mask[s], rk, booster);
333             memset(attack[s], 0, maxKey * sizeof(Bitboard));
334
335             for (key = 0; key < maxKey; key++)
336             {
337                 index = CpuIs64Bit ? unsigned((occupancy[key] * magic[s]) >> shift[s])
338                                    : unsigned(occupancy[key] * magic[s] ^ (occupancy[key] >> 32) * (magic[s] >> 32)) >> shift[s];
339
340                 if (!attack[s][index])
341                     attack[s][index] = reference[key];
342
343                 else if (attack[s][index] != reference[key])
344                     break;
345             }
346         } while (key != maxKey);
347     }
348   }
349 }