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 <algorithm>
  23 #include <cassert>
  24 #include <cmath>
  25 #include <cstdint>
  26 #include <cstdlib>
  27 #include <string>
  28
  29 #include "types.h"
  30
  31 namespace Stockfish {
  32
  33 namespace Bitboards {
  34
  35 void        init();
  36 std::string pretty(Bitboard b);
  37
  38 }  // namespace Stockfish::Bitboards
  39
  40 constexpr Bitboard FileABB = 0x0101010101010101ULL;
  41 constexpr Bitboard FileBBB = FileABB << 1;
  42 constexpr Bitboard FileCBB = FileABB << 2;
  43 constexpr Bitboard FileDBB = FileABB << 3;
  44 constexpr Bitboard FileEBB = FileABB << 4;
  45 constexpr Bitboard FileFBB = FileABB << 5;
  46 constexpr Bitboard FileGBB = FileABB << 6;
  47 constexpr Bitboard FileHBB = FileABB << 7;
  48
  49 constexpr Bitboard Rank1BB = 0xFF;
  50 constexpr Bitboard Rank2BB = Rank1BB << (8 * 1);
  51 constexpr Bitboard Rank3BB = Rank1BB << (8 * 2);
  52 constexpr Bitboard Rank4BB = Rank1BB << (8 * 3);
  53 constexpr Bitboard Rank5BB = Rank1BB << (8 * 4);
  54 constexpr Bitboard Rank6BB = Rank1BB << (8 * 5);
  55 constexpr Bitboard Rank7BB = Rank1BB << (8 * 6);
  56 constexpr Bitboard Rank8BB = Rank1BB << (8 * 7);
  57
  58 extern uint8_t PopCnt16[1 << 16];
  59 extern uint8_t SquareDistance[SQUARE_NB][SQUARE_NB];
  60
  61 extern Bitboard BetweenBB[SQUARE_NB][SQUARE_NB];
  62 extern Bitboard LineBB[SQUARE_NB][SQUARE_NB];
  63 extern Bitboard PseudoAttacks[PIECE_TYPE_NB][SQUARE_NB];
  64 extern Bitboard PawnAttacks[COLOR_NB][SQUARE_NB];
  65
  66
  67 // Magic holds all magic bitboards relevant data for a single square
  68 struct Magic {
  69     Bitboard  mask;
  70     Bitboard  magic;
  71     Bitboard* attacks;
  72     unsigned  shift;
  73
  74     // Compute the attack's index using the 'magic bitboards' approach
  75     unsigned index(Bitboard occupied) const {
  76
  77         if (HasPext)
  78             return unsigned(pext(occupied, mask));
  79
  80         if (Is64Bit)
  81             return unsigned(((occupied & mask) * magic) >> shift);
  82
  83         unsigned lo = unsigned(occupied) & unsigned(mask);
  84         unsigned hi = unsigned(occupied >> 32) & unsigned(mask >> 32);
  85         return (lo * unsigned(magic) ^ hi * unsigned(magic >> 32)) >> shift;
  86     }
  87 };
  88
  89 extern Magic RookMagics[SQUARE_NB];
  90 extern Magic BishopMagics[SQUARE_NB];
  91
  92 inline Bitboard square_bb(Square s) {
  93     assert(is_ok(s));
  94     return (1ULL << s);
  95 }
  96
  97
  98 // Overloads of bitwise operators between a Bitboard and a Square for testing
  99 // whether a given bit is set in a bitboard, and for setting and clearing bits.
 100
 101 inline Bitboard  operator&(Bitboard b, Square s) { return b & square_bb(s); }
 102 inline Bitboard  operator|(Bitboard b, Square s) { return b | square_bb(s); }
 103 inline Bitboard  operator^(Bitboard b, Square s) { return b ^ square_bb(s); }
 104 inline Bitboard& operator|=(Bitboard& b, Square s) { return b |= square_bb(s); }
 105 inline Bitboard& operator^=(Bitboard& b, Square s) { return b ^= square_bb(s); }
 106
 107 inline Bitboard operator&(Square s, Bitboard b) { return b & s; }
 108 inline Bitboard operator|(Square s, Bitboard b) { return b | s; }
 109 inline Bitboard operator^(Square s, Bitboard b) { return b ^ s; }
 110
 111 inline Bitboard operator|(Square s1, Square s2) { return square_bb(s1) | s2; }
 112
 113 constexpr bool more_than_one(Bitboard b) { return b & (b - 1); }
 114
 115
 116 // rank_bb() and file_bb() return a bitboard representing all the squares on
 117 // the given file or rank.
 118
 119 constexpr Bitboard rank_bb(Rank r) { return Rank1BB << (8 * r); }
 120
 121 constexpr Bitboard rank_bb(Square s) { return rank_bb(rank_of(s)); }
 122
 123 constexpr Bitboard file_bb(File f) { return FileABB << f; }
 124
 125 constexpr Bitboard file_bb(Square s) { return file_bb(file_of(s)); }
 126
 127
 128 // shift() moves a bitboard one or two steps as specified by the direction D
 129
 130 template<Direction D>
 131 constexpr Bitboard shift(Bitboard b) {
 132     return D == NORTH         ? b << 8
 133          : D == SOUTH         ? b >> 8
 134          : D == NORTH + NORTH ? b << 16
 135          : D == SOUTH + SOUTH ? b >> 16
 136          : D == EAST          ? (b & ~FileHBB) << 1
 137          : D == WEST          ? (b & ~FileABB) >> 1
 138          : D == NORTH_EAST    ? (b & ~FileHBB) << 9
 139          : D == NORTH_WEST    ? (b & ~FileABB) << 7
 140          : D == SOUTH_EAST    ? (b & ~FileHBB) >> 7
 141          : D == SOUTH_WEST    ? (b & ~FileABB) >> 9
 142                               : 0;
 143 }
 144
 145
 146 // pawn_attacks_bb() returns the squares attacked by pawns of the given color
 147 // from the squares in the given bitboard.
 148
 149 template<Color C>
 150 constexpr Bitboard pawn_attacks_bb(Bitboard b) {
 151     return C == WHITE ? shift<NORTH_WEST>(b) | shift<NORTH_EAST>(b)
 152                       : shift<SOUTH_WEST>(b) | shift<SOUTH_EAST>(b);
 153 }
 154
 155 inline Bitboard pawn_attacks_bb(Color c, Square s) {
 156
 157     assert(is_ok(s));
 158     return PawnAttacks[c][s];
 159 }
 160
 161 // line_bb() returns a bitboard representing an entire line (from board edge
 162 // to board edge) that intersects the two given squares. If the given squares
 163 // are not on a same file/rank/diagonal, the function returns 0. For instance,
 164 // line_bb(SQ_C4, SQ_F7) will return a bitboard with the A2-G8 diagonal.
 165
 166 inline Bitboard line_bb(Square s1, Square s2) {
 167
 168     assert(is_ok(s1) && is_ok(s2));
 169
 170     return LineBB[s1][s2];
 171 }
 172
 173
 174 // between_bb(s1, s2) returns a bitboard representing the squares in the semi-open
 175 // segment between the squares s1 and s2 (excluding s1 but including s2). If the
 176 // given squares are not on a same file/rank/diagonal, it returns s2. For instance,
 177 // between_bb(SQ_C4, SQ_F7) will return a bitboard with squares D5, E6 and F7, but
 178 // between_bb(SQ_E6, SQ_F8) will return a bitboard with the square F8. This trick
 179 // allows to generate non-king evasion moves faster: the defending piece must either
 180 // interpose itself to cover the check or capture the checking piece.
 181
 182 inline Bitboard between_bb(Square s1, Square s2) {
 183
 184     assert(is_ok(s1) && is_ok(s2));
 185
 186     return BetweenBB[s1][s2];
 187 }
 188
 189 // aligned() returns true if the squares s1, s2 and s3 are aligned either on a
 190 // straight or on a diagonal line.
 191
 192 inline bool aligned(Square s1, Square s2, Square s3) { return line_bb(s1, s2) & s3; }
 193
 194
 195 // distance() functions return the distance between x and y, defined as the
 196 // number of steps for a king in x to reach y.
 197
 198 template<typename T1 = Square>
 199 inline int distance(Square x, Square y);
 200 template<>
 201 inline int distance<File>(Square x, Square y) {
 202     return std::abs(file_of(x) - file_of(y));
 203 }
 204 template<>
 205 inline int distance<Rank>(Square x, Square y) {
 206     return std::abs(rank_of(x) - rank_of(y));
 207 }
 208 template<>
 209 inline int distance<Square>(Square x, Square y) {
 210     return SquareDistance[x][y];
 211 }
 212
 213 inline int edge_distance(File f) { return std::min(f, File(FILE_H - f)); }
 214
 215 // attacks_bb(Square) returns the pseudo attacks of the given piece type
 216 // assuming an empty board.
 217
 218 template<PieceType Pt>
 219 inline Bitboard attacks_bb(Square s) {
 220
 221     assert((Pt != PAWN) && (is_ok(s)));
 222
 223     return PseudoAttacks[Pt][s];
 224 }
 225
 226
 227 // attacks_bb(Square, Bitboard) returns the attacks by the given piece
 228 // assuming the board is occupied according to the passed Bitboard.
 229 // Sliding piece attacks do not continue passed an occupied square.
 230
 231 template<PieceType Pt>
 232 inline Bitboard attacks_bb(Square s, Bitboard occupied) {
 233
 234     assert((Pt != PAWN) && (is_ok(s)));
 235
 236     switch (Pt)
 237     {
 238     case BISHOP :
 239         return BishopMagics[s].attacks[BishopMagics[s].index(occupied)];
 240     case ROOK :
 241         return RookMagics[s].attacks[RookMagics[s].index(occupied)];
 242     case QUEEN :
 243         return attacks_bb<BISHOP>(s, occupied) | attacks_bb<ROOK>(s, occupied);
 244     default :
 245         return PseudoAttacks[Pt][s];
 246     }
 247 }
 248
 249 inline Bitboard attacks_bb(PieceType pt, Square s, Bitboard occupied) {
 250
 251     assert((pt != PAWN) && (is_ok(s)));
 252
 253     switch (pt)
 254     {
 255     case BISHOP :
 256         return attacks_bb<BISHOP>(s, occupied);
 257     case ROOK :
 258         return attacks_bb<ROOK>(s, occupied);
 259     case QUEEN :
 260         return attacks_bb<BISHOP>(s, occupied) | attacks_bb<ROOK>(s, occupied);
 261     default :
 262         return PseudoAttacks[pt][s];
 263     }
 264 }
 265
 266
 267 // popcount() counts the number of non-zero bits in a bitboard
 268
 269 inline int popcount(Bitboard b) {
 270
 271 #ifndef USE_POPCNT
 272
 273     union {
 274         Bitboard bb;
 275         uint16_t u[4];
 276     } v = {b};
 277     return PopCnt16[v.u[0]] + PopCnt16[v.u[1]] + PopCnt16[v.u[2]] + PopCnt16[v.u[3]];
 278
 279 #elif defined(_MSC_VER)
 280
 281     return int(_mm_popcnt_u64(b));
 282
 283 #else  // Assumed gcc or compatible compiler
 284
 285     return __builtin_popcountll(b);
 286
 287 #endif
 288 }
 289
 290
 291 // lsb() and msb() return the least/most significant bit in a non-zero bitboard
 292
 293 #if defined(__GNUC__)  // GCC, Clang, ICX
 294
 295 inline Square lsb(Bitboard b) {
 296     assert(b);
 297     return Square(__builtin_ctzll(b));
 298 }
 299
 300 inline Square msb(Bitboard b) {
 301     assert(b);
 302     return Square(63 ^ __builtin_clzll(b));
 303 }
 304
 305 #elif defined(_MSC_VER)  // MSVC
 306
 307     #ifdef _WIN64  // MSVC, WIN64
 308
 309 inline Square lsb(Bitboard b) {
 310     assert(b);
 311     unsigned long idx;
 312     _BitScanForward64(&idx, b);
 313     return (Square) idx;
 314 }
 315
 316 inline Square msb(Bitboard b) {
 317     assert(b);
 318     unsigned long idx;
 319     _BitScanReverse64(&idx, b);
 320     return (Square) idx;
 321 }
 322
 323     #else  // MSVC, WIN32
 324
 325 inline Square lsb(Bitboard b) {
 326     assert(b);
 327     unsigned long idx;
 328
 329     if (b & 0xffffffff)
 330     {
 331         _BitScanForward(&idx, int32_t(b));
 332         return Square(idx);
 333     }
 334     else
 335     {
 336         _BitScanForward(&idx, int32_t(b >> 32));
 337         return Square(idx + 32);
 338     }
 339 }
 340
 341 inline Square msb(Bitboard b) {
 342     assert(b);
 343     unsigned long idx;
 344
 345     if (b >> 32)
 346     {
 347         _BitScanReverse(&idx, int32_t(b >> 32));
 348         return Square(idx + 32);
 349     }
 350     else
 351     {
 352         _BitScanReverse(&idx, int32_t(b));
 353         return Square(idx);
 354     }
 355 }
 356
 357     #endif
 358
 359 #else  // Compiler is neither GCC nor MSVC compatible
 360
 361     #error "Compiler not supported."
 362
 363 #endif
 364
 365 // least_significant_square_bb() returns the bitboard of the least significant
 366 // square of a non-zero bitboard. It is equivalent to square_bb(lsb(bb)).
 367
 368 inline Bitboard least_significant_square_bb(Bitboard b) {
 369     assert(b);
 370     return b & -b;
 371 }
 372
 373 // pop_lsb() finds and clears the least significant bit in a non-zero bitboard
 374
 375 inline Square pop_lsb(Bitboard& b) {
 376     assert(b);
 377     const Square s = lsb(b);
 378     b &= b - 1;
 379     return s;
 380 }
 381
 382 }  // namespace Stockfish
 383
 384 #endif  // #ifndef BITBOARD_H_INCLUDED