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-2008 Tord Romstad (Glaurung author)
   4   Copyright (C) 2008-2015 Marco Costalba, Joona Kiiski, Tord Romstad
   5   Copyright (C) 2015-2020 Marco Costalba, Joona Kiiski, Gary Linscott, Tord Romstad
   6
   7   Stockfish is free software: you can redistribute it and/or modify
   8   it under the terms of the GNU General Public License as published by
   9   the Free Software Foundation, either version 3 of the License, or
  10   (at your option) any later version.
  11
  12   Stockfish is distributed in the hope that it will be useful,
  13   but WITHOUT ANY WARRANTY; without even the implied warranty of
  14   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15   GNU General Public License for more details.
  16
  17   You should have received a copy of the GNU General Public License
  18   along with this program.  If not, see <http://www.gnu.org/licenses/>.
  19 */
  20
  21 #ifndef BITBOARD_H_INCLUDED
  22 #define BITBOARD_H_INCLUDED
  23
  24 #include <string>
  25
  26 #include "types.h"
  27
  28 namespace Bitbases {
  29
  30 void init();
  31 bool probe(Square wksq, Square wpsq, Square bksq, Color us);
  32
  33 }
  34
  35 namespace Bitboards {
  36
  37 void init();
  38 const std::string pretty(Bitboard b);
  39
  40 }
  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 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 SquareBB[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   return LineBB[s1][s2];
 215 }
 216
 217
 218 /// between_bb() returns a bitboard representing squares that are linearly
 219 /// between the two given squares (excluding the given squares). If the given
 220 /// squares are not on a same file/rank/diagonal, we return 0. For instance,
 221 /// between_bb(SQ_C4, SQ_F7) will return a bitboard with squares D5 and E6.
 222
 223 inline Bitboard between_bb(Square s1, Square s2) {
 224   Bitboard b = line_bb(s1, s2) & ((AllSquares << s1) ^ (AllSquares << s2));
 225   return b & (b - 1); //exclude lsb
 226 }
 227
 228
 229 /// forward_ranks_bb() returns a bitboard representing the squares on the ranks
 230 /// in front of the given one, from the point of view of the given color. For instance,
 231 /// forward_ranks_bb(BLACK, SQ_D3) will return the 16 squares on ranks 1 and 2.
 232
 233 constexpr Bitboard forward_ranks_bb(Color c, Square s) {
 234   return c == WHITE ? ~Rank1BB << 8 * relative_rank(WHITE, s)
 235                     : ~Rank8BB >> 8 * relative_rank(BLACK, s);
 236 }
 237
 238
 239 /// forward_file_bb() returns a bitboard representing all the squares along the
 240 /// line in front of the given one, from the point of view of the given color.
 241
 242 constexpr Bitboard forward_file_bb(Color c, Square s) {
 243   return forward_ranks_bb(c, s) & file_bb(s);
 244 }
 245
 246
 247 /// pawn_attack_span() returns a bitboard representing all the squares that can
 248 /// be attacked by a pawn of the given color when it moves along its file, starting
 249 /// from the given square.
 250
 251 constexpr Bitboard pawn_attack_span(Color c, Square s) {
 252   return forward_ranks_bb(c, s) & adjacent_files_bb(s);
 253 }
 254
 255
 256 /// passed_pawn_span() returns a bitboard which can be used to test if a pawn of
 257 /// the given color and on the given square is a passed pawn.
 258
 259 constexpr Bitboard passed_pawn_span(Color c, Square s) {
 260   return pawn_attack_span(c, s) | forward_file_bb(c, s);
 261 }
 262
 263
 264 /// aligned() returns true if the squares s1, s2 and s3 are aligned either on a
 265 /// straight or on a diagonal line.
 266
 267 inline bool aligned(Square s1, Square s2, Square s3) {
 268   return line_bb(s1, s2) & s3;
 269 }
 270
 271
 272 /// distance() functions return the distance between x and y, defined as the
 273 /// number of steps for a king in x to reach y.
 274
 275 template<typename T1 = Square> inline int distance(Square x, Square y);
 276 template<> inline int distance<File>(Square x, Square y) { return std::abs(file_of(x) - file_of(y)); }
 277 template<> inline int distance<Rank>(Square x, Square y) { return std::abs(rank_of(x) - rank_of(y)); }
 278 template<> inline int distance<Square>(Square x, Square y) { return SquareDistance[x][y]; }
 279
 280 inline int edge_distance(File f) { return std::min(f, File(FILE_H - f)); }
 281 inline int edge_distance(Rank r) { return std::min(r, Rank(RANK_8 - r)); }
 282
 283
 284 /// safe_destination() returns the bitboard of target square for the given step
 285 /// from the given square. If the step is off the board, returns empty bitboard.
 286
 287 inline Bitboard safe_destination(Square s, int step)
 288 {
 289     Square to = Square(s + step);
 290     return is_ok(to) && distance(s, to) <= 2 ? square_bb(to) : Bitboard(0);
 291 }
 292
 293
 294 /// attacks_bb(Square) returns the pseudo attacks of the give piece type
 295 /// assuming an empty board.
 296
 297 template<PieceType Pt>
 298 inline Bitboard attacks_bb(Square s) {
 299
 300   assert((Pt != PAWN) && (is_ok(s)));
 301
 302   return PseudoAttacks[Pt][s];
 303 }
 304
 305
 306 /// attacks_bb(Square, Bitboard) returns the attacks by the given piece
 307 /// assuming the board is occupied according to the passed Bitboard.
 308 /// Sliding piece attacks do not continue passed an occupied square.
 309
 310 template<PieceType Pt>
 311 inline Bitboard attacks_bb(Square s, Bitboard occupied) {
 312
 313   assert((Pt != PAWN) && (is_ok(s)));
 314
 315   switch (Pt)
 316   {
 317   case BISHOP: return BishopMagics[s].attacks[BishopMagics[s].index(occupied)];
 318   case ROOK  : return   RookMagics[s].attacks[  RookMagics[s].index(occupied)];
 319   case QUEEN : return attacks_bb<BISHOP>(s, occupied) | attacks_bb<ROOK>(s, occupied);
 320   default    : return PseudoAttacks[Pt][s];
 321   }
 322 }
 323
 324 inline Bitboard attacks_bb(PieceType pt, Square s, Bitboard occupied) {
 325
 326   assert((pt != PAWN) && (is_ok(s)));
 327
 328   switch (pt)
 329   {
 330   case BISHOP: return attacks_bb<BISHOP>(s, occupied);
 331   case ROOK  : return attacks_bb<  ROOK>(s, occupied);
 332   case QUEEN : return attacks_bb<BISHOP>(s, occupied) | attacks_bb<ROOK>(s, occupied);
 333   default    : return PseudoAttacks[pt][s];
 334   }
 335 }
 336
 337
 338 /// popcount() counts the number of non-zero bits in a bitboard
 339
 340 inline int popcount(Bitboard b) {
 341
 342 #ifndef USE_POPCNT
 343
 344   union { Bitboard bb; uint16_t u[4]; } v = { b };
 345   return PopCnt16[v.u[0]] + PopCnt16[v.u[1]] + PopCnt16[v.u[2]] + PopCnt16[v.u[3]];
 346
 347 #elif defined(_MSC_VER) || defined(__INTEL_COMPILER)
 348
 349   return (int)_mm_popcnt_u64(b);
 350
 351 #else // Assumed gcc or compatible compiler
 352
 353   return __builtin_popcountll(b);
 354
 355 #endif
 356 }
 357
 358
 359 /// lsb() and msb() return the least/most significant bit in a non-zero bitboard
 360
 361 #if defined(__GNUC__)  // GCC, Clang, ICC
 362
 363 inline Square lsb(Bitboard b) {
 364   assert(b);
 365   return Square(__builtin_ctzll(b));
 366 }
 367
 368 inline Square msb(Bitboard b) {
 369   assert(b);
 370   return Square(63 ^ __builtin_clzll(b));
 371 }
 372
 373 #elif defined(_MSC_VER)  // MSVC
 374
 375 #ifdef _WIN64  // MSVC, WIN64
 376
 377 inline Square lsb(Bitboard b) {
 378   assert(b);
 379   unsigned long idx;
 380   _BitScanForward64(&idx, b);
 381   return (Square) idx;
 382 }
 383
 384 inline Square msb(Bitboard b) {
 385   assert(b);
 386   unsigned long idx;
 387   _BitScanReverse64(&idx, b);
 388   return (Square) idx;
 389 }
 390
 391 #else  // MSVC, WIN32
 392
 393 inline Square lsb(Bitboard b) {
 394   assert(b);
 395   unsigned long idx;
 396
 397   if (b & 0xffffffff) {
 398       _BitScanForward(&idx, int32_t(b));
 399       return Square(idx);
 400   } else {
 401       _BitScanForward(&idx, int32_t(b >> 32));
 402       return Square(idx + 32);
 403   }
 404 }
 405
 406 inline Square msb(Bitboard b) {
 407   assert(b);
 408   unsigned long idx;
 409
 410   if (b >> 32) {
 411       _BitScanReverse(&idx, int32_t(b >> 32));
 412       return Square(idx + 32);
 413   } else {
 414       _BitScanReverse(&idx, int32_t(b));
 415       return Square(idx);
 416   }
 417 }
 418
 419 #endif
 420
 421 #else  // Compiler is neither GCC nor MSVC compatible
 422
 423 #error "Compiler not supported."
 424
 425 #endif
 426
 427
 428 /// pop_lsb() finds and clears the least significant bit in a non-zero bitboard
 429
 430 inline Square pop_lsb(Bitboard* b) {
 431   assert(*b);
 432   const Square s = lsb(*b);
 433   *b &= *b - 1;
 434   return s;
 435 }
 436
 437
 438 /// frontmost_sq() returns the most advanced square for the given color,
 439 /// requires a non-zero bitboard.
 440 inline Square frontmost_sq(Color c, Bitboard b) {
 441   assert(b);
 442   return c == WHITE ? msb(b) : lsb(b);
 443 }
 444
 445 #endif // #ifndef BITBOARD_H_INCLUDED