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