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