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-2014 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> // For memset
  22
  23 #include "bitboard.h"
  24 #include "bitcount.h"
  25 #include "rkiss.h"
  26
  27 Bitboard RookMasks[SQUARE_NB];
  28 Bitboard RookMagics[SQUARE_NB];
  29 Bitboard* RookAttacks[SQUARE_NB];
  30 unsigned RookShifts[SQUARE_NB];
  31
  32 Bitboard BishopMasks[SQUARE_NB];
  33 Bitboard BishopMagics[SQUARE_NB];
  34 Bitboard* BishopAttacks[SQUARE_NB];
  35 unsigned BishopShifts[SQUARE_NB];
  36
  37 Bitboard SquareBB[SQUARE_NB];
  38 Bitboard FileBB[FILE_NB];
  39 Bitboard RankBB[RANK_NB];
  40 Bitboard AdjacentFilesBB[FILE_NB];
  41 Bitboard InFrontBB[COLOR_NB][RANK_NB];
  42 Bitboard StepAttacksBB[PIECE_NB][SQUARE_NB];
  43 Bitboard BetweenBB[SQUARE_NB][SQUARE_NB];
  44 Bitboard LineBB[SQUARE_NB][SQUARE_NB];
  45 Bitboard DistanceRingsBB[SQUARE_NB][8];
  46 Bitboard ForwardBB[COLOR_NB][SQUARE_NB];
  47 Bitboard PassedPawnMask[COLOR_NB][SQUARE_NB];
  48 Bitboard PawnAttackSpan[COLOR_NB][SQUARE_NB];
  49 Bitboard PseudoAttacks[PIECE_TYPE_NB][SQUARE_NB];
  50
  51 int SquareDistance[SQUARE_NB][SQUARE_NB];
  52
  53 namespace {
  54
  55   // De Bruijn sequences. See chessprogramming.wikispaces.com/BitScan
  56   const uint64_t DeBruijn_64 = 0x3F79D71B4CB0A89ULL;
  57   const uint32_t DeBruijn_32 = 0x783A9B23;
  58
  59   int MS1BTable[256];
  60   Square BSFTable[SQUARE_NB];
  61   Bitboard RookTable[0x19000];  // Storage space for rook attacks
  62   Bitboard BishopTable[0x1480]; // Storage space for bishop attacks
  63
  64   typedef unsigned (Fn)(Square, Bitboard);
  65
  66   void init_magics(Bitboard table[], Bitboard* attacks[], Bitboard magics[],
  67                    Bitboard masks[], unsigned shifts[], Square deltas[], Fn index);
  68
  69   FORCE_INLINE unsigned bsf_index(Bitboard b) {
  70
  71     // Matt Taylor's folding for 32 bit systems, extended to 64 bits by Kim Walisch
  72     b ^= (b - 1);
  73     return Is64Bit ? (b * DeBruijn_64) >> 58
  74                    : ((unsigned(b) ^ unsigned(b >> 32)) * DeBruijn_32) >> 26;
  75   }
  76 }
  77
  78 /// lsb()/msb() finds the least/most significant bit in a non-zero bitboard.
  79 /// pop_lsb() finds and clears the least significant bit in a non-zero bitboard.
  80
  81 #ifndef USE_BSFQ
  82
  83 Square lsb(Bitboard b) { return BSFTable[bsf_index(b)]; }
  84
  85 Square pop_lsb(Bitboard* b) {
  86
  87   Bitboard bb = *b;
  88   *b = bb & (bb - 1);
  89   return BSFTable[bsf_index(bb)];
  90 }
  91
  92 Square msb(Bitboard b) {
  93
  94   unsigned b32;
  95   int result = 0;
  96
  97   if (b > 0xFFFFFFFF)
  98   {
  99       b >>= 32;
 100       result = 32;
 101   }
 102
 103   b32 = unsigned(b);
 104
 105   if (b32 > 0xFFFF)
 106   {
 107       b32 >>= 16;
 108       result += 16;
 109   }
 110
 111   if (b32 > 0xFF)
 112   {
 113       b32 >>= 8;
 114       result += 8;
 115   }
 116
 117   return Square(result + MS1BTable[b32]);
 118 }
 119
 120 #endif // ifndef USE_BSFQ
 121
 122
 123 /// Bitboards::pretty() returns an ASCII representation of a bitboard to be
 124 /// printed to standard output. This is sometimes useful for debugging.
 125
 126 const std::string Bitboards::pretty(Bitboard b) {
 127
 128   std::string s = "+---+---+---+---+---+---+---+---+\n";
 129
 130   for (Rank r = RANK_8; r >= RANK_1; --r)
 131   {
 132       for (File f = FILE_A; f <= FILE_H; ++f)
 133           s.append(b & make_square(f, r) ? "| X " : "|   ");
 134
 135       s.append("|\n+---+---+---+---+---+---+---+---+\n");
 136   }
 137
 138   return s;
 139 }
 140
 141
 142 /// Bitboards::init() initializes various bitboard tables. It is called at
 143 /// startup and relies on global objects to be already zero-initialized.
 144
 145 void Bitboards::init() {
 146
 147   for (Square s = SQ_A1; s <= SQ_H8; ++s)
 148   {
 149       SquareBB[s] = 1ULL << s;
 150       BSFTable[bsf_index(SquareBB[s])] = s;
 151   }
 152
 153   for (Bitboard b = 1; b < 256; ++b)
 154       MS1BTable[b] = more_than_one(b) ? MS1BTable[b - 1] : lsb(b);
 155
 156   for (File f = FILE_A; f <= FILE_H; ++f)
 157       FileBB[f] = f > FILE_A ? FileBB[f - 1] << 1 : FileABB;
 158
 159   for (Rank r = RANK_1; r <= RANK_8; ++r)
 160       RankBB[r] = r > RANK_1 ? RankBB[r - 1] << 8 : Rank1BB;
 161
 162   for (File f = FILE_A; f <= FILE_H; ++f)
 163       AdjacentFilesBB[f] = (f > FILE_A ? FileBB[f - 1] : 0) | (f < FILE_H ? FileBB[f + 1] : 0);
 164
 165   for (Rank r = RANK_1; r < RANK_8; ++r)
 166       InFrontBB[WHITE][r] = ~(InFrontBB[BLACK][r + 1] = InFrontBB[BLACK][r] | RankBB[r]);
 167
 168   for (Color c = WHITE; c <= BLACK; ++c)
 169       for (Square s = SQ_A1; s <= SQ_H8; ++s)
 170       {
 171           ForwardBB[c][s]      = InFrontBB[c][rank_of(s)] & FileBB[file_of(s)];
 172           PawnAttackSpan[c][s] = InFrontBB[c][rank_of(s)] & AdjacentFilesBB[file_of(s)];
 173           PassedPawnMask[c][s] = ForwardBB[c][s] | PawnAttackSpan[c][s];
 174       }
 175
 176   for (Square s1 = SQ_A1; s1 <= SQ_H8; ++s1)
 177       for (Square s2 = SQ_A1; s2 <= SQ_H8; ++s2)
 178           if (s1 != s2)
 179           {
 180               SquareDistance[s1][s2] = std::max(distance<File>(s1, s2), distance<Rank>(s1, s2));
 181               DistanceRingsBB[s1][SquareDistance[s1][s2] - 1] |= s2;
 182           }
 183
 184   int steps[][9] = { {}, { 7, 9 }, { 17, 15, 10, 6, -6, -10, -15, -17 },
 185                      {}, {}, {}, { 9, 7, -7, -9, 8, 1, -1, -8 } };
 186
 187   for (Color c = WHITE; c <= BLACK; ++c)
 188       for (PieceType pt = PAWN; pt <= KING; ++pt)
 189           for (Square s = SQ_A1; s <= SQ_H8; ++s)
 190               for (int i = 0; steps[pt][i]; ++i)
 191               {
 192                   Square to = s + Square(c == WHITE ? steps[pt][i] : -steps[pt][i]);
 193
 194                   if (is_ok(to) && distance(s, to) < 3)
 195                       StepAttacksBB[make_piece(c, pt)][s] |= to;
 196               }
 197
 198   Square RookDeltas[] = { DELTA_N,  DELTA_E,  DELTA_S,  DELTA_W  };
 199   Square BishopDeltas[] = { DELTA_NE, DELTA_SE, DELTA_SW, DELTA_NW };
 200
 201   init_magics(RookTable, RookAttacks, RookMagics, RookMasks, RookShifts, RookDeltas, magic_index<ROOK>);
 202   init_magics(BishopTable, BishopAttacks, BishopMagics, BishopMasks, BishopShifts, BishopDeltas, magic_index<BISHOP>);
 203
 204   for (Square s1 = SQ_A1; s1 <= SQ_H8; ++s1)
 205   {
 206       PseudoAttacks[QUEEN][s1]  = PseudoAttacks[BISHOP][s1] = attacks_bb<BISHOP>(s1, 0);
 207       PseudoAttacks[QUEEN][s1] |= PseudoAttacks[  ROOK][s1] = attacks_bb<  ROOK>(s1, 0);
 208
 209       for (Square s2 = SQ_A1; s2 <= SQ_H8; ++s2)
 210       {
 211           Piece pc = (PseudoAttacks[BISHOP][s1] & s2) ? W_BISHOP :
 212                      (PseudoAttacks[ROOK][s1]   & s2) ? W_ROOK   : NO_PIECE;
 213
 214           if (pc == NO_PIECE)
 215               continue;
 216
 217           LineBB[s1][s2] = (attacks_bb(pc, s1, 0) & attacks_bb(pc, s2, 0)) | s1 | s2;
 218           BetweenBB[s1][s2] = attacks_bb(pc, s1, SquareBB[s2]) & attacks_bb(pc, s2, SquareBB[s1]);
 219       }
 220   }
 221 }
 222
 223
 224 namespace {
 225
 226   Bitboard sliding_attack(Square deltas[], Square sq, Bitboard occupied) {
 227
 228     Bitboard attack = 0;
 229
 230     for (int i = 0; i < 4; ++i)
 231         for (Square s = sq + deltas[i];
 232              is_ok(s) && distance(s, s - deltas[i]) == 1;
 233              s += deltas[i])
 234         {
 235             attack |= s;
 236
 237             if (occupied & s)
 238                 break;
 239         }
 240
 241     return attack;
 242   }
 243
 244
 245   // init_magics() computes all rook and bishop attacks at startup. Magic
 246   // bitboards are used to look up attacks of sliding pieces. As a reference see
 247   // chessprogramming.wikispaces.com/Magic+Bitboards. In particular, here we
 248   // use the so called "fancy" approach.
 249
 250   void init_magics(Bitboard table[], Bitboard* attacks[], Bitboard magics[],
 251                    Bitboard masks[], unsigned shifts[], Square deltas[], Fn index) {
 252
 253     int MagicBoosters[][RANK_NB] = { {  969, 1976, 2850,  542, 2069, 2852, 1708,  164 },
 254                                      { 3101,  552, 3555,  926,  834,   26, 2131, 1117 } };
 255     RKISS rk;
 256     Bitboard occupancy[4096], reference[4096], edges, b;
 257     int i, size, booster;
 258
 259     // attacks[s] is a pointer to the beginning of the attacks table for square 's'
 260     attacks[SQ_A1] = table;
 261
 262     for (Square s = SQ_A1; s <= SQ_H8; ++s)
 263     {
 264         // Board edges are not considered in the relevant occupancies
 265         edges = ((Rank1BB | Rank8BB) & ~rank_bb(s)) | ((FileABB | FileHBB) & ~file_bb(s));
 266
 267         // Given a square 's', the mask is the bitboard of sliding attacks from
 268         // 's' computed on an empty board. The index must be big enough to contain
 269         // all the attacks for each possible subset of the mask and so is 2 power
 270         // the number of 1s of the mask. Hence we deduce the size of the shift to
 271         // apply to the 64 or 32 bits word to get the index.
 272         masks[s]  = sliding_attack(deltas, s, 0) & ~edges;
 273         shifts[s] = (Is64Bit ? 64 : 32) - popcount<Max15>(masks[s]);
 274
 275         // Use Carry-Rippler trick to enumerate all subsets of masks[s] and
 276         // store the corresponding sliding attack bitboard in reference[].
 277         b = size = 0;
 278         do {
 279             occupancy[size] = b;
 280             reference[size] = sliding_attack(deltas, s, b);
 281
 282             if (HasPext)
 283                 attacks[s][_pext_u64(b, masks[s])] = reference[size];
 284
 285             size++;
 286             b = (b - masks[s]) & masks[s];
 287         } while (b);
 288
 289         // Set the offset for the table of the next square. We have individual
 290         // table sizes for each square with "Fancy Magic Bitboards".
 291         if (s < SQ_H8)
 292             attacks[s + 1] = attacks[s] + size;
 293
 294         if (HasPext)
 295             continue;
 296
 297         booster = MagicBoosters[Is64Bit][rank_of(s)];
 298
 299         // Find a magic for square 's' picking up an (almost) random number
 300         // until we find the one that passes the verification test.
 301         do {
 302             do
 303                 magics[s] = rk.magic_rand<Bitboard>(booster);
 304             while (popcount<Max15>((magics[s] * masks[s]) >> 56) < 6);
 305
 306             std::memset(attacks[s], 0, size * sizeof(Bitboard));
 307
 308             // A good magic must map every possible occupancy to an index that
 309             // looks up the correct sliding attack in the attacks[s] database.
 310             // Note that we build up the database for square 's' as a side
 311             // effect of verifying the magic.
 312             for (i = 0; i < size; ++i)
 313             {
 314                 Bitboard& attack = attacks[s][index(s, occupancy[i])];
 315
 316                 if (attack && attack != reference[i])
 317                     break;
 318
 319                 assert(reference[i]);
 320
 321                 attack = reference[i];
 322             }
 323         } while (i < size);
 324     }
 325   }
 326 }