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-2014 Marco Costalba, Joona Kiiski, Tord Romstad
   5
   6   Stockfish is free software: you can redistribute it and/or modify
   7   it under the terms of the GNU General Public License as published by
   8   the Free Software Foundation, either version 3 of the License, or
   9   (at your option) any later version.
  10
  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 "types.h"
  25
  26 namespace Bitboards {
  27
  28 void init();
  29 const std::string pretty(Bitboard b);
  30
  31 }
  32
  33 namespace Bitbases {
  34
  35 void init_kpk();
  36 bool probe_kpk(Square wksq, Square wpsq, Square bksq, Color us);
  37
  38 }
  39
  40 const Bitboard FileABB = 0x0101010101010101ULL;
  41 const Bitboard FileBBB = FileABB << 1;
  42 const Bitboard FileCBB = FileABB << 2;
  43 const Bitboard FileDBB = FileABB << 3;
  44 const Bitboard FileEBB = FileABB << 4;
  45 const Bitboard FileFBB = FileABB << 5;
  46 const Bitboard FileGBB = FileABB << 6;
  47 const Bitboard FileHBB = FileABB << 7;
  48
  49 const Bitboard Rank1BB = 0xFF;
  50 const Bitboard Rank2BB = Rank1BB << (8 * 1);
  51 const Bitboard Rank3BB = Rank1BB << (8 * 2);
  52 const Bitboard Rank4BB = Rank1BB << (8 * 3);
  53 const Bitboard Rank5BB = Rank1BB << (8 * 4);
  54 const Bitboard Rank6BB = Rank1BB << (8 * 5);
  55 const Bitboard Rank7BB = Rank1BB << (8 * 6);
  56 const Bitboard Rank8BB = Rank1BB << (8 * 7);
  57
  58 CACHE_LINE_ALIGNMENT
  59
  60 extern Bitboard RMasks[SQUARE_NB];
  61 extern Bitboard RMagics[SQUARE_NB];
  62 extern Bitboard* RAttacks[SQUARE_NB];
  63 extern unsigned RShifts[SQUARE_NB];
  64
  65 extern Bitboard BMasks[SQUARE_NB];
  66 extern Bitboard BMagics[SQUARE_NB];
  67 extern Bitboard* BAttacks[SQUARE_NB];
  68 extern unsigned BShifts[SQUARE_NB];
  69
  70 extern Bitboard SquareBB[SQUARE_NB];
  71 extern Bitboard FileBB[FILE_NB];
  72 extern Bitboard RankBB[RANK_NB];
  73 extern Bitboard AdjacentFilesBB[FILE_NB];
  74 extern Bitboard InFrontBB[COLOR_NB][RANK_NB];
  75 extern Bitboard StepAttacksBB[PIECE_NB][SQUARE_NB];
  76 extern Bitboard BetweenBB[SQUARE_NB][SQUARE_NB];
  77 extern Bitboard LineBB[SQUARE_NB][SQUARE_NB];
  78 extern Bitboard DistanceRingsBB[SQUARE_NB][8];
  79 extern Bitboard ForwardBB[COLOR_NB][SQUARE_NB];
  80 extern Bitboard PassedPawnMask[COLOR_NB][SQUARE_NB];
  81 extern Bitboard PawnAttackSpan[COLOR_NB][SQUARE_NB];
  82 extern Bitboard PseudoAttacks[PIECE_TYPE_NB][SQUARE_NB];
  83
  84 extern int SquareDistance[SQUARE_NB][SQUARE_NB];
  85
  86 const Bitboard DarkSquares = 0xAA55AA55AA55AA55ULL;
  87
  88 /// Overloads of bitwise operators between a Bitboard and a Square for testing
  89 /// whether a given bit is set in a bitboard, and for setting and clearing bits.
  90
  91 inline Bitboard operator&(Bitboard b, Square s) {
  92   return b & SquareBB[s];
  93 }
  94
  95 inline Bitboard& operator|=(Bitboard& b, Square s) {
  96   return b |= SquareBB[s];
  97 }
  98
  99 inline Bitboard& operator^=(Bitboard& b, Square s) {
 100   return b ^= SquareBB[s];
 101 }
 102
 103 inline Bitboard operator|(Bitboard b, Square s) {
 104   return b | SquareBB[s];
 105 }
 106
 107 inline Bitboard operator^(Bitboard b, Square s) {
 108   return b ^ SquareBB[s];
 109 }
 110
 111 inline bool more_than_one(Bitboard b) {
 112   return b & (b - 1);
 113 }
 114
 115 inline int square_distance(Square s1, Square s2) {
 116   return SquareDistance[s1][s2];
 117 }
 118
 119 inline int file_distance(Square s1, Square s2) {
 120   return abs(file_of(s1) - file_of(s2));
 121 }
 122
 123 inline int rank_distance(Square s1, Square s2) {
 124   return abs(rank_of(s1) - rank_of(s2));
 125 }
 126
 127
 128 /// shift_bb() moves bitboard one step along direction Delta. Mainly for pawns.
 129
 130 template<Square Delta>
 131 inline Bitboard shift_bb(Bitboard b) {
 132
 133   return  Delta == DELTA_NE ? (b & ~FileHBB) << 9 : Delta == DELTA_SE ? (b & ~FileHBB) >> 7
 134         : Delta == DELTA_NW ? (b & ~FileABB) << 7 : Delta == DELTA_SW ? (b & ~FileABB) >> 9
 135         : Delta > 0 ? b << Delta : b >> -Delta;
 136 }
 137
 138
 139 /// rank_bb() and file_bb() take a file or a square as input and return
 140 /// a bitboard representing all squares on the given file or rank.
 141
 142 inline Bitboard rank_bb(Rank r) {
 143   return RankBB[r];
 144 }
 145
 146 inline Bitboard rank_bb(Square s) {
 147   return RankBB[rank_of(s)];
 148 }
 149
 150 inline Bitboard file_bb(File f) {
 151   return FileBB[f];
 152 }
 153
 154 inline Bitboard file_bb(Square s) {
 155   return FileBB[file_of(s)];
 156 }
 157
 158
 159 /// adjacent_files_bb() takes a file as input and returns a bitboard representing
 160 /// all squares on the adjacent files.
 161
 162 inline Bitboard adjacent_files_bb(File f) {
 163   return AdjacentFilesBB[f];
 164 }
 165
 166
 167 /// in_front_bb() takes a color and a rank as input, and returns a bitboard
 168 /// representing all the squares on all ranks in front of the rank, from the
 169 /// given color's point of view. For instance, in_front_bb(BLACK, RANK_3) will
 170 /// give all squares on ranks 1 and 2.
 171
 172 inline Bitboard in_front_bb(Color c, Rank r) {
 173   return InFrontBB[c][r];
 174 }
 175
 176
 177 /// between_bb() returns a bitboard representing all squares between two squares.
 178 /// For instance, between_bb(SQ_C4, SQ_F7) returns a bitboard with the bits for
 179 /// square d5 and e6 set.  If s1 and s2 are not on the same rank, file or diagonal,
 180 /// 0 is returned.
 181
 182 inline Bitboard between_bb(Square s1, Square s2) {
 183   return BetweenBB[s1][s2];
 184 }
 185
 186
 187 /// forward_bb() takes a color and a square as input, and returns a bitboard
 188 /// representing all squares along the line in front of the square, from the
 189 /// point of view of the given color. Definition of the table is:
 190 /// ForwardBB[c][s] = in_front_bb(c, s) & file_bb(s)
 191
 192 inline Bitboard forward_bb(Color c, Square s) {
 193   return ForwardBB[c][s];
 194 }
 195
 196
 197 /// pawn_attack_span() takes a color and a square as input, and returns a bitboard
 198 /// representing all squares that can be attacked by a pawn of the given color
 199 /// when it moves along its file starting from the given square. Definition is:
 200 /// PawnAttackSpan[c][s] = in_front_bb(c, s) & adjacent_files_bb(s);
 201
 202 inline Bitboard pawn_attack_span(Color c, Square s) {
 203   return PawnAttackSpan[c][s];
 204 }
 205
 206
 207 /// passed_pawn_mask() takes a color and a square as input, and returns a
 208 /// bitboard mask which can be used to test if a pawn of the given color on
 209 /// the given square is a passed pawn. Definition of the table is:
 210 /// PassedPawnMask[c][s] = pawn_attack_span(c, s) | forward_bb(c, s)
 211
 212 inline Bitboard passed_pawn_mask(Color c, Square s) {
 213   return PassedPawnMask[c][s];
 214 }
 215
 216
 217 /// squares_of_color() returns a bitboard representing all squares with the same
 218 /// color of the given square.
 219
 220 inline Bitboard squares_of_color(Square s) {
 221   return DarkSquares & s ? DarkSquares : ~DarkSquares;
 222 }
 223
 224
 225 /// aligned() returns true if the squares s1, s2 and s3 are aligned
 226 /// either on a straight or on a diagonal line.
 227
 228 inline bool aligned(Square s1, Square s2, Square s3) {
 229   return LineBB[s1][s2] & s3;
 230 }
 231
 232
 233 /// Functions for computing sliding attack bitboards. Function attacks_bb() takes
 234 /// a square and a bitboard of occupied squares as input, and returns a bitboard
 235 /// representing all squares attacked by Pt (bishop or rook) on the given square.
 236 template<PieceType Pt>
 237 FORCE_INLINE unsigned magic_index(Square s, Bitboard occ) {
 238
 239   Bitboard* const Masks  = Pt == ROOK ? RMasks  : BMasks;
 240   Bitboard* const Magics = Pt == ROOK ? RMagics : BMagics;
 241   unsigned* const Shifts = Pt == ROOK ? RShifts : BShifts;
 242
 243   if (HasPext)
 244       return unsigned(_pext_u64(occ, Masks[s]));
 245
 246   if (Is64Bit)
 247       return unsigned(((occ & Masks[s]) * Magics[s]) >> Shifts[s]);
 248
 249   unsigned lo = unsigned(occ) & unsigned(Masks[s]);
 250   unsigned hi = unsigned(occ >> 32) & unsigned(Masks[s] >> 32);
 251   return (lo * unsigned(Magics[s]) ^ hi * unsigned(Magics[s] >> 32)) >> Shifts[s];
 252 }
 253
 254 template<PieceType Pt>
 255 inline Bitboard attacks_bb(Square s, Bitboard occ) {
 256   return (Pt == ROOK ? RAttacks : BAttacks)[s][magic_index<Pt>(s, occ)];
 257 }
 258
 259 inline Bitboard attacks_bb(Piece pc, Square s, Bitboard occ) {
 260
 261   switch (type_of(pc))
 262   {
 263   case BISHOP: return attacks_bb<BISHOP>(s, occ);
 264   case ROOK  : return attacks_bb<ROOK>(s, occ);
 265   case QUEEN : return attacks_bb<BISHOP>(s, occ) | attacks_bb<ROOK>(s, occ);
 266   default    : return StepAttacksBB[pc][s];
 267   }
 268 }
 269
 270 /// lsb()/msb() finds the least/most significant bit in a non-zero bitboard.
 271 /// pop_lsb() finds and clears the least significant bit in a non-zero bitboard.
 272
 273 #ifdef USE_BSFQ
 274
 275 #  if defined(_MSC_VER) && !defined(__INTEL_COMPILER)
 276
 277 FORCE_INLINE Square lsb(Bitboard b) {
 278   unsigned long idx;
 279   _BitScanForward64(&idx, b);
 280   return (Square) idx;
 281 }
 282
 283 FORCE_INLINE Square msb(Bitboard b) {
 284   unsigned long idx;
 285   _BitScanReverse64(&idx, b);
 286   return (Square) idx;
 287 }
 288
 289 #  elif defined(__arm__)
 290
 291 FORCE_INLINE int lsb32(uint32_t v) {
 292   __asm__("rbit %0, %1" : "=r"(v) : "r"(v));
 293   return __builtin_clz(v);
 294 }
 295
 296 FORCE_INLINE Square msb(Bitboard b) {
 297   return (Square) (63 - __builtin_clzll(b));
 298 }
 299
 300 FORCE_INLINE Square lsb(Bitboard b) {
 301   return (Square) (uint32_t(b) ? lsb32(uint32_t(b)) : 32 + lsb32(uint32_t(b >> 32)));
 302 }
 303
 304 #  else
 305
 306 FORCE_INLINE Square lsb(Bitboard b) { // Assembly code by Heinz van Saanen
 307   Bitboard idx;
 308   __asm__("bsfq %1, %0": "=r"(idx): "rm"(b) );
 309   return (Square) idx;
 310 }
 311
 312 FORCE_INLINE Square msb(Bitboard b) {
 313   Bitboard idx;
 314   __asm__("bsrq %1, %0": "=r"(idx): "rm"(b) );
 315   return (Square) idx;
 316 }
 317
 318 #  endif
 319
 320 FORCE_INLINE Square pop_lsb(Bitboard* b) {
 321   const Square s = lsb(*b);
 322   *b &= *b - 1;
 323   return s;
 324 }
 325
 326 #else // if defined(USE_BSFQ)
 327
 328 extern Square msb(Bitboard b);
 329 extern Square lsb(Bitboard b);
 330 extern Square pop_lsb(Bitboard* b);
 331
 332 #endif
 333
 334 /// frontmost_sq() and backmost_sq() find the square corresponding to the
 335 /// most/least advanced bit relative to the given color.
 336
 337 inline Square frontmost_sq(Color c, Bitboard b) { return c == WHITE ? msb(b) : lsb(b); }
 338 inline Square  backmost_sq(Color c, Bitboard b) { return c == WHITE ? lsb(b) : msb(b); }
 339
 340 #endif // #ifndef BITBOARD_H_INCLUDED