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-2019 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 extern int SquareDistance[SQUARE_NB][SQUARE_NB];
  64
  65 extern Bitboard SquareBB[SQUARE_NB];
  66 extern Bitboard FileBB[FILE_NB];
  67 extern Bitboard RankBB[RANK_NB];
  68 extern Bitboard AdjacentFilesBB[FILE_NB];
  69 extern Bitboard ForwardRanksBB[COLOR_NB][RANK_NB];
  70 extern Bitboard BetweenBB[SQUARE_NB][SQUARE_NB];
  71 extern Bitboard LineBB[SQUARE_NB][SQUARE_NB];
  72 extern Bitboard DistanceRingBB[SQUARE_NB][8];
  73 extern Bitboard ForwardFileBB[COLOR_NB][SQUARE_NB];
  74 extern Bitboard PassedPawnMask[COLOR_NB][SQUARE_NB];
  75 extern Bitboard PawnAttackSpan[COLOR_NB][SQUARE_NB];
  76 extern Bitboard PseudoAttacks[PIECE_TYPE_NB][SQUARE_NB];
  77 extern Bitboard PawnAttacks[COLOR_NB][SQUARE_NB];
  78
  79
  80 /// Magic holds all magic bitboards relevant data for a single square
  81 struct Magic {
  82   Bitboard  mask;
  83   Bitboard  magic;
  84   Bitboard* attacks;
  85   unsigned  shift;
  86
  87   // Compute the attack's index using the 'magic bitboards' approach
  88   unsigned index(Bitboard occupied) const {
  89
  90     if (HasPext)
  91         return unsigned(pext(occupied, mask));
  92
  93     if (Is64Bit)
  94         return unsigned(((occupied & mask) * magic) >> shift);
  95
  96     unsigned lo = unsigned(occupied) & unsigned(mask);
  97     unsigned hi = unsigned(occupied >> 32) & unsigned(mask >> 32);
  98     return (lo * unsigned(magic) ^ hi * unsigned(magic >> 32)) >> shift;
  99   }
 100 };
 101
 102 extern Magic RookMagics[SQUARE_NB];
 103 extern Magic BishopMagics[SQUARE_NB];
 104
 105
 106 /// Overloads of bitwise operators between a Bitboard and a Square for testing
 107 /// whether a given bit is set in a bitboard, and for setting and clearing bits.
 108
 109 inline Bitboard operator&(Bitboard b, Square s) {
 110   assert(s >= SQ_A1 && s <= SQ_H8);
 111   return b & SquareBB[s];
 112 }
 113
 114 inline Bitboard operator|(Bitboard b, Square s) {
 115   assert(s >= SQ_A1 && s <= SQ_H8);
 116   return b | SquareBB[s];
 117 }
 118
 119 inline Bitboard operator^(Bitboard b, Square s) {
 120   assert(s >= SQ_A1 && s <= SQ_H8);
 121   return b ^ SquareBB[s];
 122 }
 123
 124 inline Bitboard& operator|=(Bitboard& b, Square s) {
 125   assert(s >= SQ_A1 && s <= SQ_H8);
 126   return b |= SquareBB[s];
 127 }
 128
 129 inline Bitboard& operator^=(Bitboard& b, Square s) {
 130   assert(s >= SQ_A1 && s <= SQ_H8);
 131   return b ^= SquareBB[s];
 132 }
 133
 134 constexpr bool more_than_one(Bitboard b) {
 135   return b & (b - 1);
 136 }
 137
 138 inline bool opposite_colors(Square s1, Square s2) {
 139   return bool(DarkSquares & s1) != bool(DarkSquares & s2);
 140 }
 141
 142 /// rank_bb() and file_bb() return a bitboard representing all the squares on
 143 /// the given file or rank.
 144
 145 inline Bitboard rank_bb(Rank r) {
 146   return RankBB[r];
 147 }
 148
 149 inline Bitboard rank_bb(Square s) {
 150   return RankBB[rank_of(s)];
 151 }
 152
 153 inline Bitboard file_bb(File f) {
 154   return FileBB[f];
 155 }
 156
 157 inline Bitboard file_bb(Square s) {
 158   return FileBB[file_of(s)];
 159 }
 160
 161
 162 /// shift() moves a bitboard one step along direction D (mainly for pawns)
 163
 164 template<Direction D>
 165 constexpr Bitboard shift(Bitboard b) {
 166   return  D == NORTH      ?  b             << 8 : D == SOUTH      ?  b             >> 8
 167         : D == EAST       ? (b & ~FileHBB) << 1 : D == WEST       ? (b & ~FileABB) >> 1
 168         : D == NORTH_EAST ? (b & ~FileHBB) << 9 : D == NORTH_WEST ? (b & ~FileABB) << 7
 169         : D == SOUTH_EAST ? (b & ~FileHBB) >> 7 : D == SOUTH_WEST ? (b & ~FileABB) >> 9
 170         : 0;
 171 }
 172
 173
 174 /// pawn_attacks_bb() returns the pawn attacks for the given color from the
 175 /// squares in the given bitboard.
 176
 177 template<Color C>
 178 constexpr Bitboard pawn_attacks_bb(Bitboard b) {
 179   return C == WHITE ? shift<NORTH_WEST>(b) | shift<NORTH_EAST>(b)
 180                     : shift<SOUTH_WEST>(b) | shift<SOUTH_EAST>(b);
 181 }
 182
 183
 184 /// double_pawn_attacks_bb() returns the pawn attacks for the given color
 185 /// from the squares in the given bitboard.
 186
 187 template<Color C>
 188 constexpr Bitboard double_pawn_attacks_bb(Bitboard b) {
 189   return C == WHITE ? shift<NORTH_WEST>(b) & shift<NORTH_EAST>(b)
 190                     : shift<SOUTH_WEST>(b) & shift<SOUTH_EAST>(b);
 191 }
 192
 193
 194 /// adjacent_files_bb() returns a bitboard representing all the squares on the
 195 /// adjacent files of the given one.
 196
 197 inline Bitboard adjacent_files_bb(File f) {
 198   return AdjacentFilesBB[f];
 199 }
 200
 201
 202 /// between_bb() returns a bitboard representing all the squares between the two
 203 /// given ones. For instance, between_bb(SQ_C4, SQ_F7) returns a bitboard with
 204 /// the bits for square d5 and e6 set. If s1 and s2 are not on the same rank, file
 205 /// or diagonal, 0 is returned.
 206
 207 inline Bitboard between_bb(Square s1, Square s2) {
 208   return BetweenBB[s1][s2];
 209 }
 210
 211
 212 /// forward_ranks_bb() returns a bitboard representing the squares on all the ranks
 213 /// in front of the given one, from the point of view of the given color. For instance,
 214 /// forward_ranks_bb(BLACK, SQ_D3) will return the 16 squares on ranks 1 and 2.
 215
 216 inline Bitboard forward_ranks_bb(Color c, Square s) {
 217   return ForwardRanksBB[c][rank_of(s)];
 218 }
 219
 220
 221 /// forward_file_bb() returns a bitboard representing all the squares along the line
 222 /// in front of the given one, from the point of view of the given color:
 223 ///      ForwardFileBB[c][s] = forward_ranks_bb(c, s) & file_bb(s)
 224
 225 inline Bitboard forward_file_bb(Color c, Square s) {
 226   return ForwardFileBB[c][s];
 227 }
 228
 229
 230 /// pawn_attack_span() returns a bitboard representing all the squares that can be
 231 /// attacked by a pawn of the given color when it moves along its file, starting
 232 /// from the given square:
 233 ///      PawnAttackSpan[c][s] = forward_ranks_bb(c, s) & adjacent_files_bb(file_of(s));
 234
 235 inline Bitboard pawn_attack_span(Color c, Square s) {
 236   return PawnAttackSpan[c][s];
 237 }
 238
 239
 240 /// passed_pawn_mask() returns a bitboard mask which can be used to test if a
 241 /// pawn of the given color and on the given square is a passed pawn:
 242 ///      PassedPawnMask[c][s] = pawn_attack_span(c, s) | forward_file_bb(c, s)
 243
 244 inline Bitboard passed_pawn_mask(Color c, Square s) {
 245   return PassedPawnMask[c][s];
 246 }
 247
 248
 249 /// aligned() returns true if the squares s1, s2 and s3 are aligned either on a
 250 /// straight or on a diagonal line.
 251
 252 inline bool aligned(Square s1, Square s2, Square s3) {
 253   return LineBB[s1][s2] & s3;
 254 }
 255
 256
 257 /// distance() functions return the distance between x and y, defined as the
 258 /// number of steps for a king in x to reach y. Works with squares, ranks, files.
 259
 260 template<typename T> inline int distance(T x, T y) { return x < y ? y - x : x - y; }
 261 template<> inline int distance<Square>(Square x, Square y) { return SquareDistance[x][y]; }
 262
 263 template<typename T1, typename T2> inline int distance(T2 x, T2 y);
 264 template<> inline int distance<File>(Square x, Square y) { return distance(file_of(x), file_of(y)); }
 265 template<> inline int distance<Rank>(Square x, Square y) { return distance(rank_of(x), rank_of(y)); }
 266
 267
 268 /// attacks_bb() returns a bitboard representing all the squares attacked by a
 269 /// piece of type Pt (bishop or rook) placed on 's'.
 270
 271 template<PieceType Pt>
 272 inline Bitboard attacks_bb(Square s, Bitboard occupied) {
 273
 274   const Magic& m = Pt == ROOK ? RookMagics[s] : BishopMagics[s];
 275   return m.attacks[m.index(occupied)];
 276 }
 277
 278 inline Bitboard attacks_bb(PieceType pt, Square s, Bitboard occupied) {
 279
 280   assert(pt != PAWN);
 281
 282   switch (pt)
 283   {
 284   case BISHOP: return attacks_bb<BISHOP>(s, occupied);
 285   case ROOK  : return attacks_bb<  ROOK>(s, occupied);
 286   case QUEEN : return attacks_bb<BISHOP>(s, occupied) | attacks_bb<ROOK>(s, occupied);
 287   default    : return PseudoAttacks[pt][s];
 288   }
 289 }
 290
 291
 292 /// popcount() counts the number of non-zero bits in a bitboard
 293
 294 inline int popcount(Bitboard b) {
 295
 296 #ifndef USE_POPCNT
 297
 298   extern uint8_t PopCnt16[1 << 16];
 299   union { Bitboard bb; uint16_t u[4]; } v = { b };
 300   return PopCnt16[v.u[0]] + PopCnt16[v.u[1]] + PopCnt16[v.u[2]] + PopCnt16[v.u[3]];
 301
 302 #elif defined(_MSC_VER) || defined(__INTEL_COMPILER)
 303
 304   return (int)_mm_popcnt_u64(b);
 305
 306 #else // Assumed gcc or compatible compiler
 307
 308   return __builtin_popcountll(b);
 309
 310 #endif
 311 }
 312
 313
 314 /// lsb() and msb() return the least/most significant bit in a non-zero bitboard
 315
 316 #if defined(__GNUC__)  // GCC, Clang, ICC
 317
 318 inline Square lsb(Bitboard b) {
 319   assert(b);
 320   return Square(__builtin_ctzll(b));
 321 }
 322
 323 inline Square msb(Bitboard b) {
 324   assert(b);
 325   return Square(63 ^ __builtin_clzll(b));
 326 }
 327
 328 #elif defined(_MSC_VER)  // MSVC
 329
 330 #ifdef _WIN64  // MSVC, WIN64
 331
 332 inline Square lsb(Bitboard b) {
 333   assert(b);
 334   unsigned long idx;
 335   _BitScanForward64(&idx, b);
 336   return (Square) idx;
 337 }
 338
 339 inline Square msb(Bitboard b) {
 340   assert(b);
 341   unsigned long idx;
 342   _BitScanReverse64(&idx, b);
 343   return (Square) idx;
 344 }
 345
 346 #else  // MSVC, WIN32
 347
 348 inline Square lsb(Bitboard b) {
 349   assert(b);
 350   unsigned long idx;
 351
 352   if (b & 0xffffffff) {
 353       _BitScanForward(&idx, int32_t(b));
 354       return Square(idx);
 355   } else {
 356       _BitScanForward(&idx, int32_t(b >> 32));
 357       return Square(idx + 32);
 358   }
 359 }
 360
 361 inline Square msb(Bitboard b) {
 362   assert(b);
 363   unsigned long idx;
 364
 365   if (b >> 32) {
 366       _BitScanReverse(&idx, int32_t(b >> 32));
 367       return Square(idx + 32);
 368   } else {
 369       _BitScanReverse(&idx, int32_t(b));
 370       return Square(idx);
 371   }
 372 }
 373
 374 #endif
 375
 376 #else  // Compiler is neither GCC nor MSVC compatible
 377
 378 #error "Compiler not supported."
 379
 380 #endif
 381
 382
 383 /// pop_lsb() finds and clears the least significant bit in a non-zero bitboard
 384
 385 inline Square pop_lsb(Bitboard* b) {
 386   const Square s = lsb(*b);
 387   *b &= *b - 1;
 388   return s;
 389 }
 390
 391
 392 /// frontmost_sq() and backmost_sq() return the square corresponding to the
 393 /// most/least advanced bit relative to the given color.
 394
 395 inline Square frontmost_sq(Color c, Bitboard b) { return c == WHITE ? msb(b) : lsb(b); }
 396 inline Square  backmost_sq(Color c, Bitboard b) { return c == WHITE ? lsb(b) : msb(b); }
 397
 398 #endif // #ifndef BITBOARD_H_INCLUDED