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