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