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