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-2023 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 BetweenBB[SQUARE_NB][SQUARE_NB];
  78 extern Bitboard LineBB[SQUARE_NB][SQUARE_NB];
  79 extern Bitboard PseudoAttacks[PIECE_TYPE_NB][SQUARE_NB];
  80 extern Bitboard PawnAttacks[COLOR_NB][SQUARE_NB];
  81
  82
  83 /// Magic holds all magic bitboards relevant data for a single square
  84 struct Magic {
  85   Bitboard  mask;
  86   Bitboard  magic;
  87   Bitboard* attacks;
  88   unsigned  shift;
  89
  90   // Compute the attack's index using the 'magic bitboards' approach
  91   unsigned index(Bitboard occupied) const {
  92
  93     if (HasPext)
  94         return unsigned(pext(occupied, mask));
  95
  96     if (Is64Bit)
  97         return unsigned(((occupied & mask) * magic) >> shift);
  98
  99     unsigned lo = unsigned(occupied) & unsigned(mask);
 100     unsigned hi = unsigned(occupied >> 32) & unsigned(mask >> 32);
 101     return (lo * unsigned(magic) ^ hi * unsigned(magic >> 32)) >> shift;
 102   }
 103 };
 104
 105 extern Magic RookMagics[SQUARE_NB];
 106 extern Magic BishopMagics[SQUARE_NB];
 107
 108 inline Bitboard square_bb(Square s) {
 109   assert(is_ok(s));
 110   return (1ULL << s);
 111 }
 112
 113
 114 /// Overloads of bitwise operators between a Bitboard and a Square for testing
 115 /// whether a given bit is set in a bitboard, and for setting and clearing bits.
 116
 117 inline Bitboard  operator&( Bitboard  b, Square s) { return b &  square_bb(s); }
 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
 123 inline Bitboard  operator&(Square s, Bitboard b) { return b & s; }
 124 inline Bitboard  operator|(Square s, Bitboard b) { return b | s; }
 125 inline Bitboard  operator^(Square s, Bitboard b) { return b ^ s; }
 126
 127 inline Bitboard  operator|(Square s1, Square s2) { return square_bb(s1) | s2; }
 128
 129 constexpr bool more_than_one(Bitboard b) {
 130   return b & (b - 1);
 131 }
 132
 133
 134 constexpr bool opposite_colors(Square s1, Square s2) {
 135   return (s1 + rank_of(s1) + s2 + rank_of(s2)) & 1;
 136 }
 137
 138
 139 /// rank_bb() and file_bb() return a bitboard representing all the squares on
 140 /// the given file or rank.
 141
 142 constexpr Bitboard rank_bb(Rank r) {
 143   return Rank1BB << (8 * r);
 144 }
 145
 146 constexpr Bitboard rank_bb(Square s) {
 147   return rank_bb(rank_of(s));
 148 }
 149
 150 constexpr Bitboard file_bb(File f) {
 151   return FileABB << f;
 152 }
 153
 154 constexpr Bitboard file_bb(Square s) {
 155   return file_bb(file_of(s));
 156 }
 157
 158
 159 /// shift() moves a bitboard one or two steps as specified by the direction D
 160
 161 template<Direction D>
 162 constexpr Bitboard shift(Bitboard b) {
 163   return  D == NORTH      ?  b             << 8 : D == SOUTH      ?  b             >> 8
 164         : D == NORTH+NORTH?  b             <<16 : D == SOUTH+SOUTH?  b             >>16
 165         : D == EAST       ? (b & ~FileHBB) << 1 : D == WEST       ? (b & ~FileABB) >> 1
 166         : D == NORTH_EAST ? (b & ~FileHBB) << 9 : D == NORTH_WEST ? (b & ~FileABB) << 7
 167         : D == SOUTH_EAST ? (b & ~FileHBB) >> 7 : D == SOUTH_WEST ? (b & ~FileABB) >> 9
 168         : 0;
 169 }
 170
 171
 172 /// pawn_attacks_bb() returns the squares attacked by pawns of the given color
 173 /// from the squares in the given bitboard.
 174
 175 template<Color C>
 176 constexpr Bitboard pawn_attacks_bb(Bitboard b) {
 177   return C == WHITE ? shift<NORTH_WEST>(b) | shift<NORTH_EAST>(b)
 178                     : shift<SOUTH_WEST>(b) | shift<SOUTH_EAST>(b);
 179 }
 180
 181 inline Bitboard pawn_attacks_bb(Color c, Square s) {
 182
 183   assert(is_ok(s));
 184   return PawnAttacks[c][s];
 185 }
 186
 187
 188 /// pawn_double_attacks_bb() returns the squares doubly attacked by pawns of the
 189 /// given color from the squares in the given bitboard.
 190
 191 template<Color C>
 192 constexpr Bitboard pawn_double_attacks_bb(Bitboard b) {
 193   return C == WHITE ? shift<NORTH_WEST>(b) & shift<NORTH_EAST>(b)
 194                     : shift<SOUTH_WEST>(b) & shift<SOUTH_EAST>(b);
 195 }
 196
 197
 198 /// adjacent_files_bb() returns a bitboard representing all the squares on the
 199 /// adjacent files of a given square.
 200
 201 constexpr Bitboard adjacent_files_bb(Square s) {
 202   return shift<EAST>(file_bb(s)) | shift<WEST>(file_bb(s));
 203 }
 204
 205
 206 /// line_bb() returns a bitboard representing an entire line (from board edge
 207 /// to board edge) that intersects the two given squares. If the given squares
 208 /// are not on a same file/rank/diagonal, the function returns 0. For instance,
 209 /// line_bb(SQ_C4, SQ_F7) will return a bitboard with the A2-G8 diagonal.
 210
 211 inline Bitboard line_bb(Square s1, Square s2) {
 212
 213   assert(is_ok(s1) && is_ok(s2));
 214
 215   return LineBB[s1][s2];
 216 }
 217
 218
 219 /// between_bb(s1, s2) returns a bitboard representing the squares in the semi-open
 220 /// segment between the squares s1 and s2 (excluding s1 but including s2). If the
 221 /// given squares are not on a same file/rank/diagonal, it returns s2. For instance,
 222 /// between_bb(SQ_C4, SQ_F7) will return a bitboard with squares D5, E6 and F7, but
 223 /// between_bb(SQ_E6, SQ_F8) will return a bitboard with the square F8. This trick
 224 /// allows to generate non-king evasion moves faster: the defending piece must either
 225 /// interpose itself to cover the check or capture the checking piece.
 226
 227 inline Bitboard between_bb(Square s1, Square s2) {
 228
 229   assert(is_ok(s1) && is_ok(s2));
 230
 231   return BetweenBB[s1][s2];
 232 }
 233
 234
 235 /// forward_ranks_bb() returns a bitboard representing the squares on the ranks in
 236 /// front of the given one, from the point of view of the given color. For instance,
 237 /// forward_ranks_bb(BLACK, SQ_D3) will return the 16 squares on ranks 1 and 2.
 238
 239 constexpr Bitboard forward_ranks_bb(Color c, Square s) {
 240   return c == WHITE ? ~Rank1BB << 8 * relative_rank(WHITE, s)
 241                     : ~Rank8BB >> 8 * relative_rank(BLACK, s);
 242 }
 243
 244
 245 /// forward_file_bb() returns a bitboard representing all the squares along the
 246 /// line in front of the given one, from the point of view of the given color.
 247
 248 constexpr Bitboard forward_file_bb(Color c, Square s) {
 249   return forward_ranks_bb(c, s) & file_bb(s);
 250 }
 251
 252
 253 /// pawn_attack_span() returns a bitboard representing all the squares that can
 254 /// be attacked by a pawn of the given color when it moves along its file, starting
 255 /// from the given square.
 256
 257 constexpr Bitboard pawn_attack_span(Color c, Square s) {
 258   return forward_ranks_bb(c, s) & adjacent_files_bb(s);
 259 }
 260
 261
 262 /// passed_pawn_span() returns a bitboard which can be used to test if a pawn of
 263 /// the given color and on the given square is a passed pawn.
 264
 265 constexpr Bitboard passed_pawn_span(Color c, Square s) {
 266   return pawn_attack_span(c, s) | forward_file_bb(c, s);
 267 }
 268
 269
 270 /// aligned() returns true if the squares s1, s2 and s3 are aligned either on a
 271 /// straight or on a diagonal line.
 272
 273 inline bool aligned(Square s1, Square s2, Square s3) {
 274   return line_bb(s1, s2) & s3;
 275 }
 276
 277
 278 /// distance() functions return the distance between x and y, defined as the
 279 /// number of steps for a king in x to reach y.
 280
 281 template<typename T1 = Square> inline int distance(Square x, Square y);
 282 template<> inline int distance<File>(Square x, Square y) { return std::abs(file_of(x) - file_of(y)); }
 283 template<> inline int distance<Rank>(Square x, Square y) { return std::abs(rank_of(x) - rank_of(y)); }
 284 template<> inline int distance<Square>(Square x, Square y) { return SquareDistance[x][y]; }
 285
 286 inline int edge_distance(File f) { return std::min(f, File(FILE_H - f)); }
 287 inline int edge_distance(Rank r) { return std::min(r, Rank(RANK_8 - r)); }
 288
 289
 290 /// attacks_bb(Square) returns the pseudo attacks of the give piece type
 291 /// assuming an empty board.
 292
 293 template<PieceType Pt>
 294 inline Bitboard attacks_bb(Square s) {
 295
 296   assert((Pt != PAWN) && (is_ok(s)));
 297
 298   return PseudoAttacks[Pt][s];
 299 }
 300
 301
 302 /// attacks_bb(Square, Bitboard) returns the attacks by the given piece
 303 /// assuming the board is occupied according to the passed Bitboard.
 304 /// Sliding piece attacks do not continue passed an occupied square.
 305
 306 template<PieceType Pt>
 307 inline Bitboard attacks_bb(Square s, Bitboard occupied) {
 308
 309   assert((Pt != PAWN) && (is_ok(s)));
 310
 311   switch (Pt)
 312   {
 313   case BISHOP: return BishopMagics[s].attacks[BishopMagics[s].index(occupied)];
 314   case ROOK  : return   RookMagics[s].attacks[  RookMagics[s].index(occupied)];
 315   case QUEEN : return attacks_bb<BISHOP>(s, occupied) | attacks_bb<ROOK>(s, occupied);
 316   default    : return PseudoAttacks[Pt][s];
 317   }
 318 }
 319
 320 inline Bitboard attacks_bb(PieceType pt, Square s, Bitboard occupied) {
 321
 322   assert((pt != PAWN) && (is_ok(s)));
 323
 324   switch (pt)
 325   {
 326   case BISHOP: return attacks_bb<BISHOP>(s, occupied);
 327   case ROOK  : return attacks_bb<  ROOK>(s, occupied);
 328   case QUEEN : return attacks_bb<BISHOP>(s, occupied) | attacks_bb<ROOK>(s, occupied);
 329   default    : return PseudoAttacks[pt][s];
 330   }
 331 }
 332
 333
 334 /// popcount() counts the number of non-zero bits in a bitboard
 335
 336 inline int popcount(Bitboard b) {
 337
 338 #ifndef USE_POPCNT
 339
 340   union { Bitboard bb; uint16_t u[4]; } v = { b };
 341   return PopCnt16[v.u[0]] + PopCnt16[v.u[1]] + PopCnt16[v.u[2]] + PopCnt16[v.u[3]];
 342
 343 #elif defined(_MSC_VER) || defined(__INTEL_COMPILER)
 344
 345   return (int)_mm_popcnt_u64(b);
 346
 347 #else // Assumed gcc or compatible compiler
 348
 349   return __builtin_popcountll(b);
 350
 351 #endif
 352 }
 353
 354
 355 /// lsb() and msb() return the least/most significant bit in a non-zero bitboard
 356
 357 #if defined(__GNUC__)  // GCC, Clang, ICC
 358
 359 inline Square lsb(Bitboard b) {
 360   assert(b);
 361   return Square(__builtin_ctzll(b));
 362 }
 363
 364 inline Square msb(Bitboard b) {
 365   assert(b);
 366   return Square(63 ^ __builtin_clzll(b));
 367 }
 368
 369 #elif defined(_MSC_VER)  // MSVC
 370
 371 #ifdef _WIN64  // MSVC, WIN64
 372
 373 inline Square lsb(Bitboard b) {
 374   assert(b);
 375   unsigned long idx;
 376   _BitScanForward64(&idx, b);
 377   return (Square) idx;
 378 }
 379
 380 inline Square msb(Bitboard b) {
 381   assert(b);
 382   unsigned long idx;
 383   _BitScanReverse64(&idx, b);
 384   return (Square) idx;
 385 }
 386
 387 #else  // MSVC, WIN32
 388
 389 inline Square lsb(Bitboard b) {
 390   assert(b);
 391   unsigned long idx;
 392
 393   if (b & 0xffffffff) {
 394       _BitScanForward(&idx, int32_t(b));
 395       return Square(idx);
 396   } else {
 397       _BitScanForward(&idx, int32_t(b >> 32));
 398       return Square(idx + 32);
 399   }
 400 }
 401
 402 inline Square msb(Bitboard b) {
 403   assert(b);
 404   unsigned long idx;
 405
 406   if (b >> 32) {
 407       _BitScanReverse(&idx, int32_t(b >> 32));
 408       return Square(idx + 32);
 409   } else {
 410       _BitScanReverse(&idx, int32_t(b));
 411       return Square(idx);
 412   }
 413 }
 414
 415 #endif
 416
 417 #else  // Compiler is neither GCC nor MSVC compatible
 418
 419 #error "Compiler not supported."
 420
 421 #endif
 422
 423 /// least_significant_square_bb() returns the bitboard of the least significant
 424 /// square of a non-zero bitboard. It is equivalent to square_bb(lsb(bb)).
 425
 426 inline Bitboard least_significant_square_bb(Bitboard b) {
 427   assert(b);
 428   return b & -b;
 429 }
 430
 431 /// pop_lsb() finds and clears the least significant bit in a non-zero bitboard
 432
 433 inline Square pop_lsb(Bitboard& b) {
 434   assert(b);
 435   const Square s = lsb(b);
 436   b &= b - 1;
 437   return s;
 438 }
 439
 440
 441 /// frontmost_sq() returns the most advanced square for the given color,
 442 /// requires a non-zero bitboard.
 443 inline Square frontmost_sq(Color c, Bitboard b) {
 444   assert(b);
 445   return c == WHITE ? msb(b) : lsb(b);
 446 }
 447
 448 } // namespace Stockfish
 449
 450 #endif // #ifndef BITBOARD_H_INCLUDED