git.sesse.net Git - stockfish/blob - src/bitboard.h

   1 /*
   2   Stockfish, a UCI chess playing engine derived from Glaurung 2.1
   3   Copyright (C) 2004-2021 The Stockfish developers (see AUTHORS file)
   4
   5   Stockfish is free software: you can redistribute it and/or modify
   6   it under the terms of the GNU General Public License as published by
   7   the Free Software Foundation, either version 3 of the License, or
   8   (at your option) any later version.
   9
  10   Stockfish is distributed in the hope that it will be useful,
  11   but WITHOUT ANY WARRANTY; without even the implied warranty of
  12   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13   GNU General Public License for more details.
  14
  15   You should have received a copy of the GNU General Public License
  16   along with this program.  If not, see <http://www.gnu.org/licenses/>.
  17 */
  18
  19 #ifndef BITBOARD_H_INCLUDED
  20 #define BITBOARD_H_INCLUDED
  21
  22 #include <string>
  23
  24 #include "types.h"
  25
  26 namespace Stockfish {
  27
  28 namespace Bitbases {
  29
  30 void init();
  31 bool probe(Square wksq, Square wpsq, Square bksq, Color us);
  32
  33 } // namespace Stockfish::Bitbases
  34
  35 namespace Bitboards {
  36
  37 void init();
  38 std::string pretty(Bitboard b);
  39
  40 } // namespace Stockfish::Bitboards
  41
  42 constexpr Bitboard AllSquares = ~Bitboard(0);
  43 constexpr Bitboard DarkSquares = 0xAA55AA55AA55AA55ULL;
  44
  45 constexpr Bitboard FileABB = 0x0101010101010101ULL;
  46 constexpr Bitboard FileBBB = FileABB << 1;
  47 constexpr Bitboard FileCBB = FileABB << 2;
  48 constexpr Bitboard FileDBB = FileABB << 3;
  49 constexpr Bitboard FileEBB = FileABB << 4;
  50 constexpr Bitboard FileFBB = FileABB << 5;
  51 constexpr Bitboard FileGBB = FileABB << 6;
  52 constexpr Bitboard FileHBB = FileABB << 7;
  53
  54 constexpr Bitboard Rank1BB = 0xFF;
  55 constexpr Bitboard Rank2BB = Rank1BB << (8 * 1);
  56 constexpr Bitboard Rank3BB = Rank1BB << (8 * 2);
  57 constexpr Bitboard Rank4BB = Rank1BB << (8 * 3);
  58 constexpr Bitboard Rank5BB = Rank1BB << (8 * 4);
  59 constexpr Bitboard Rank6BB = Rank1BB << (8 * 5);
  60 constexpr Bitboard Rank7BB = Rank1BB << (8 * 6);
  61 constexpr Bitboard Rank8BB = Rank1BB << (8 * 7);
  62
  63 constexpr Bitboard QueenSide   = FileABB | FileBBB | FileCBB | FileDBB;
  64 constexpr Bitboard CenterFiles = FileCBB | FileDBB | FileEBB | FileFBB;
  65 constexpr Bitboard KingSide    = FileEBB | FileFBB | FileGBB | FileHBB;
  66 constexpr Bitboard Center      = (FileDBB | FileEBB) & (Rank4BB | Rank5BB);
  67
  68 constexpr Bitboard KingFlank[FILE_NB] = {
  69   QueenSide ^ FileDBB, QueenSide, QueenSide,
  70   CenterFiles, CenterFiles,
  71   KingSide, KingSide, KingSide ^ FileEBB
  72 };
  73
  74 extern uint8_t PopCnt16[1 << 16];
  75 extern uint8_t SquareDistance[SQUARE_NB][SQUARE_NB];
  76
  77 extern Bitboard SquareBB[SQUARE_NB];
  78 extern Bitboard BetweenBB[SQUARE_NB][SQUARE_NB];
  79 extern Bitboard LineBB[SQUARE_NB][SQUARE_NB];
  80 extern Bitboard PseudoAttacks[PIECE_TYPE_NB][SQUARE_NB];
  81 extern Bitboard PawnAttacks[COLOR_NB][SQUARE_NB];
  82
  83
  84 /// Magic holds all magic bitboards relevant data for a single square
  85 struct Magic {
  86   Bitboard  mask;
  87   Bitboard  magic;
  88   Bitboard* attacks;
  89   unsigned  shift;
  90
  91   // Compute the attack's index using the 'magic bitboards' approach
  92   unsigned index(Bitboard occupied) const {
  93
  94     if (HasPext)
  95         return unsigned(pext(occupied, mask));
  96
  97     if (Is64Bit)
  98         return unsigned(((occupied & mask) * magic) >> shift);
  99
 100     unsigned lo = unsigned(occupied) & unsigned(mask);
 101     unsigned hi = unsigned(occupied >> 32) & unsigned(mask >> 32);
 102     return (lo * unsigned(magic) ^ hi * unsigned(magic >> 32)) >> shift;
 103   }
 104 };
 105
 106 extern Magic RookMagics[SQUARE_NB];
 107 extern Magic BishopMagics[SQUARE_NB];
 108
 109 inline Bitboard square_bb(Square s) {
 110   assert(is_ok(s));
 111   return SquareBB[s];
 112 }
 113
 114
 115 /// Overloads of bitwise operators between a Bitboard and a Square for testing
 116 /// whether a given bit is set in a bitboard, and for setting and clearing bits.
 117
 118 inline Bitboard  operator&( Bitboard  b, Square s) { return b &  square_bb(s); }
 119 inline Bitboard  operator|( Bitboard  b, Square s) { return b |  square_bb(s); }
 120 inline Bitboard  operator^( Bitboard  b, Square s) { return b ^  square_bb(s); }
 121 inline Bitboard& operator|=(Bitboard& b, Square s) { return b |= square_bb(s); }
 122 inline Bitboard& operator^=(Bitboard& b, Square s) { return b ^= square_bb(s); }
 123
 124 inline Bitboard  operator&(Square s, Bitboard b) { return b & s; }
 125 inline Bitboard  operator|(Square s, Bitboard b) { return b | s; }
 126 inline Bitboard  operator^(Square s, Bitboard b) { return b ^ s; }
 127
 128 inline Bitboard  operator|(Square s1, Square s2) { return square_bb(s1) | s2; }
 129
 130 constexpr bool more_than_one(Bitboard b) {
 131   return b & (b - 1);
 132 }
 133
 134
 135 constexpr bool opposite_colors(Square s1, Square s2) {
 136   return (s1 + rank_of(s1) + s2 + rank_of(s2)) & 1;
 137 }
 138
 139
 140 /// rank_bb() and file_bb() return a bitboard representing all the squares on
 141 /// the given file or rank.
 142
 143 constexpr Bitboard rank_bb(Rank r) {
 144   return Rank1BB << (8 * r);
 145 }
 146
 147 constexpr Bitboard rank_bb(Square s) {
 148   return rank_bb(rank_of(s));
 149 }
 150
 151 constexpr Bitboard file_bb(File f) {
 152   return FileABB << f;
 153 }
 154
 155 constexpr Bitboard file_bb(Square s) {
 156   return file_bb(file_of(s));
 157 }
 158
 159
 160 /// shift() moves a bitboard one or two steps as specified by the direction D
 161
 162 template<Direction D>
 163 constexpr Bitboard shift(Bitboard b) {
 164   return  D == NORTH      ?  b             << 8 : D == SOUTH      ?  b             >> 8
 165         : D == NORTH+NORTH?  b             <<16 : D == SOUTH+SOUTH?  b             >>16
 166         : D == EAST       ? (b & ~FileHBB) << 1 : D == WEST       ? (b & ~FileABB) >> 1
 167         : D == NORTH_EAST ? (b & ~FileHBB) << 9 : D == NORTH_WEST ? (b & ~FileABB) << 7
 168         : D == SOUTH_EAST ? (b & ~FileHBB) >> 7 : D == SOUTH_WEST ? (b & ~FileABB) >> 9
 169         : 0;
 170 }
 171
 172
 173 /// pawn_attacks_bb() returns the squares attacked by pawns of the given color
 174 /// from the squares in the given bitboard.
 175
 176 template<Color C>
 177 constexpr Bitboard pawn_attacks_bb(Bitboard b) {
 178   return C == WHITE ? shift<NORTH_WEST>(b) | shift<NORTH_EAST>(b)
 179                     : shift<SOUTH_WEST>(b) | shift<SOUTH_EAST>(b);
 180 }
 181
 182 inline Bitboard pawn_attacks_bb(Color c, Square s) {
 183
 184   assert(is_ok(s));
 185   return PawnAttacks[c][s];
 186 }
 187
 188
 189 /// pawn_double_attacks_bb() returns the squares doubly attacked by pawns of the
 190 /// given color from the squares in the given bitboard.
 191
 192 template<Color C>
 193 constexpr Bitboard pawn_double_attacks_bb(Bitboard b) {
 194   return C == WHITE ? shift<NORTH_WEST>(b) & shift<NORTH_EAST>(b)
 195                     : shift<SOUTH_WEST>(b) & shift<SOUTH_EAST>(b);
 196 }
 197
 198
 199 /// adjacent_files_bb() returns a bitboard representing all the squares on the
 200 /// adjacent files of a given square.
 201
 202 constexpr Bitboard adjacent_files_bb(Square s) {
 203   return shift<EAST>(file_bb(s)) | shift<WEST>(file_bb(s));
 204 }
 205
 206
 207 /// line_bb() returns a bitboard representing an entire line (from board edge
 208 /// to board edge) that intersects the two given squares. If the given squares
 209 /// are not on a same file/rank/diagonal, the function returns 0. For instance,
 210 /// line_bb(SQ_C4, SQ_F7) will return a bitboard with the A2-G8 diagonal.
 211
 212 inline Bitboard line_bb(Square s1, Square s2) {
 213
 214   assert(is_ok(s1) && is_ok(s2));
 215
 216   return LineBB[s1][s2];
 217 }
 218
 219
 220 /// between_bb(s1, s2) returns a bitboard representing the squares in the semi-open
 221 /// segment between the squares s1 and s2 (excluding s1 but including s2). If the
 222 /// given squares are not on a same file/rank/diagonal, it returns s2. For instance,
 223 /// between_bb(SQ_C4, SQ_F7) will return a bitboard with squares D5, E6 and F7, but
 224 /// between_bb(SQ_E6, SQ_F8) will return a bitboard with the square F8. This trick
 225 /// allows to generate non-king evasion moves faster: the defending piece must either
 226 /// interpose itself to cover the check or capture the checking piece.
 227
 228 inline Bitboard between_bb(Square s1, Square s2) {
 229
 230   assert(is_ok(s1) && is_ok(s2));
 231
 232   return BetweenBB[s1][s2];
 233 }
 234
 235
 236 /// forward_ranks_bb() returns a bitboard representing the squares on the ranks in
 237 /// front of the given one, from the point of view of the given color. For instance,
 238 /// forward_ranks_bb(BLACK, SQ_D3) will return the 16 squares on ranks 1 and 2.
 239
 240 constexpr Bitboard forward_ranks_bb(Color c, Square s) {
 241   return c == WHITE ? ~Rank1BB << 8 * relative_rank(WHITE, s)
 242                     : ~Rank8BB >> 8 * relative_rank(BLACK, s);
 243 }
 244
 245
 246 /// forward_file_bb() returns a bitboard representing all the squares along the
 247 /// line in front of the given one, from the point of view of the given color.
 248
 249 constexpr Bitboard forward_file_bb(Color c, Square s) {
 250   return forward_ranks_bb(c, s) & file_bb(s);
 251 }
 252
 253
 254 /// pawn_attack_span() returns a bitboard representing all the squares that can
 255 /// be attacked by a pawn of the given color when it moves along its file, starting
 256 /// from the given square.
 257
 258 constexpr Bitboard pawn_attack_span(Color c, Square s) {
 259   return forward_ranks_bb(c, s) & adjacent_files_bb(s);
 260 }
 261
 262
 263 /// passed_pawn_span() returns a bitboard which can be used to test if a pawn of
 264 /// the given color and on the given square is a passed pawn.
 265
 266 constexpr Bitboard passed_pawn_span(Color c, Square s) {
 267   return pawn_attack_span(c, s) | forward_file_bb(c, s);
 268 }
 269
 270
 271 /// aligned() returns true if the squares s1, s2 and s3 are aligned either on a
 272 /// straight or on a diagonal line.
 273
 274 inline bool aligned(Square s1, Square s2, Square s3) {
 275   return line_bb(s1, s2) & s3;
 276 }
 277
 278
 279 /// distance() functions return the distance between x and y, defined as the
 280 /// number of steps for a king in x to reach y.
 281
 282 template<typename T1 = Square> inline int distance(Square x, Square y);
 283 template<> inline int distance<File>(Square x, Square y) { return std::abs(file_of(x) - file_of(y)); }
 284 template<> inline int distance<Rank>(Square x, Square y) { return std::abs(rank_of(x) - rank_of(y)); }
 285 template<> inline int distance<Square>(Square x, Square y) { return SquareDistance[x][y]; }
 286
 287 inline int edge_distance(File f) { return std::min(f, File(FILE_H - f)); }
 288 inline int edge_distance(Rank r) { return std::min(r, Rank(RANK_8 - r)); }
 289
 290
 291 /// attacks_bb(Square) returns the pseudo attacks of the give piece type
 292 /// assuming an empty board.
 293
 294 template<PieceType Pt>
 295 inline Bitboard attacks_bb(Square s) {
 296
 297   assert((Pt != PAWN) && (is_ok(s)));
 298
 299   return PseudoAttacks[Pt][s];
 300 }
 301
 302
 303 /// attacks_bb(Square, Bitboard) returns the attacks by the given piece
 304 /// assuming the board is occupied according to the passed Bitboard.
 305 /// Sliding piece attacks do not continue passed an occupied square.
 306
 307 template<PieceType Pt>
 308 inline Bitboard attacks_bb(Square s, Bitboard occupied) {
 309
 310   assert((Pt != PAWN) && (is_ok(s)));
 311
 312   switch (Pt)
 313   {
 314   case BISHOP: return BishopMagics[s].attacks[BishopMagics[s].index(occupied)];
 315   case ROOK  : return   RookMagics[s].attacks[  RookMagics[s].index(occupied)];
 316   case QUEEN : return attacks_bb<BISHOP>(s, occupied) | attacks_bb<ROOK>(s, occupied);
 317   default    : return PseudoAttacks[Pt][s];
 318   }
 319 }
 320
 321 inline Bitboard attacks_bb(PieceType pt, Square s, Bitboard occupied) {
 322
 323   assert((pt != PAWN) && (is_ok(s)));
 324
 325   switch (pt)
 326   {
 327   case BISHOP: return attacks_bb<BISHOP>(s, occupied);
 328   case ROOK  : return attacks_bb<  ROOK>(s, occupied);
 329   case QUEEN : return attacks_bb<BISHOP>(s, occupied) | attacks_bb<ROOK>(s, occupied);
 330   default    : return PseudoAttacks[pt][s];
 331   }
 332 }
 333
 334
 335 /// popcount() counts the number of non-zero bits in a bitboard
 336
 337 inline int popcount(Bitboard b) {
 338
 339 #ifndef USE_POPCNT
 340
 341   union { Bitboard bb; uint16_t u[4]; } v = { b };
 342   return PopCnt16[v.u[0]] + PopCnt16[v.u[1]] + PopCnt16[v.u[2]] + PopCnt16[v.u[3]];
 343
 344 #elif defined(_MSC_VER) || defined(__INTEL_COMPILER)
 345
 346   return (int)_mm_popcnt_u64(b);
 347
 348 #else // Assumed gcc or compatible compiler
 349
 350   return __builtin_popcountll(b);
 351
 352 #endif
 353 }
 354
 355
 356 /// lsb() and msb() return the least/most significant bit in a non-zero bitboard
 357
 358 #if defined(__GNUC__)  // GCC, Clang, ICC
 359
 360 inline Square lsb(Bitboard b) {
 361   assert(b);
 362   return Square(__builtin_ctzll(b));
 363 }
 364
 365 inline Square msb(Bitboard b) {
 366   assert(b);
 367   return Square(63 ^ __builtin_clzll(b));
 368 }
 369
 370 #elif defined(_MSC_VER)  // MSVC
 371
 372 #ifdef _WIN64  // MSVC, WIN64
 373
 374 inline Square lsb(Bitboard b) {
 375   assert(b);
 376   unsigned long idx;
 377   _BitScanForward64(&idx, b);
 378   return (Square) idx;
 379 }
 380
 381 inline Square msb(Bitboard b) {
 382   assert(b);
 383   unsigned long idx;
 384   _BitScanReverse64(&idx, b);
 385   return (Square) idx;
 386 }
 387
 388 #else  // MSVC, WIN32
 389
 390 inline Square lsb(Bitboard b) {
 391   assert(b);
 392   unsigned long idx;
 393
 394   if (b & 0xffffffff) {
 395       _BitScanForward(&idx, int32_t(b));
 396       return Square(idx);
 397   } else {
 398       _BitScanForward(&idx, int32_t(b >> 32));
 399       return Square(idx + 32);
 400   }
 401 }
 402
 403 inline Square msb(Bitboard b) {
 404   assert(b);
 405   unsigned long idx;
 406
 407   if (b >> 32) {
 408       _BitScanReverse(&idx, int32_t(b >> 32));
 409       return Square(idx + 32);
 410   } else {
 411       _BitScanReverse(&idx, int32_t(b));
 412       return Square(idx);
 413   }
 414 }
 415
 416 #endif
 417
 418 #else  // Compiler is neither GCC nor MSVC compatible
 419
 420 #error "Compiler not supported."
 421
 422 #endif
 423
 424 /// least_significant_square_bb() returns the bitboard of the least significant
 425 /// square of a non-zero bitboard. It is equivalent to square_bb(lsb(bb)).
 426
 427 inline Bitboard least_significant_square_bb(Bitboard b) {
 428   assert(b);
 429   return b & -b;
 430 }
 431
 432 /// pop_lsb() finds and clears the least significant bit in a non-zero bitboard
 433
 434 inline Square pop_lsb(Bitboard& b) {
 435   assert(b);
 436   const Square s = lsb(b);
 437   b &= b - 1;
 438   return s;
 439 }
 440
 441
 442 /// frontmost_sq() returns the most advanced square for the given color,
 443 /// requires a non-zero bitboard.
 444 inline Square frontmost_sq(Color c, Bitboard b) {
 445   assert(b);
 446   return c == WHITE ? msb(b) : lsb(b);
 447 }
 448
 449 } // namespace Stockfish
 450
 451 #endif // #ifndef BITBOARD_H_INCLUDED