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-2013 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 #if !defined(BITBOARD_H_INCLUDED)
  22 #define BITBOARD_H_INCLUDED
  23
  24 #include "types.h"
  25
  26 namespace Bitboards {
  27
  28 void init();
  29 void print(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 CACHE_LINE_ALIGNMENT
  41
  42 extern Bitboard RMasks[SQUARE_NB];
  43 extern Bitboard RMagics[SQUARE_NB];
  44 extern Bitboard* RAttacks[SQUARE_NB];
  45 extern unsigned RShifts[SQUARE_NB];
  46
  47 extern Bitboard BMasks[SQUARE_NB];
  48 extern Bitboard BMagics[SQUARE_NB];
  49 extern Bitboard* BAttacks[SQUARE_NB];
  50 extern unsigned BShifts[SQUARE_NB];
  51
  52 extern Bitboard SquareBB[SQUARE_NB];
  53 extern Bitboard FileBB[FILE_NB];
  54 extern Bitboard RankBB[RANK_NB];
  55 extern Bitboard AdjacentFilesBB[FILE_NB];
  56 extern Bitboard InFrontBB[COLOR_NB][RANK_NB];
  57 extern Bitboard StepAttacksBB[PIECE_NB][SQUARE_NB];
  58 extern Bitboard BetweenBB[SQUARE_NB][SQUARE_NB];
  59 extern Bitboard DistanceRingsBB[SQUARE_NB][8];
  60 extern Bitboard ForwardBB[COLOR_NB][SQUARE_NB];
  61 extern Bitboard PassedPawnMask[COLOR_NB][SQUARE_NB];
  62 extern Bitboard PawnAttackSpan[COLOR_NB][SQUARE_NB];
  63 extern Bitboard PseudoAttacks[PIECE_TYPE_NB][SQUARE_NB];
  64
  65 const Bitboard BlackSquares = 0xAA55AA55AA55AA55ULL;
  66
  67 /// Overloads of bitwise operators between a Bitboard and a Square for testing
  68 /// whether a given bit is set in a bitboard, and for setting and clearing bits.
  69
  70 inline Bitboard operator&(Bitboard b, Square s) {
  71   return b & SquareBB[s];
  72 }
  73
  74 inline Bitboard& operator|=(Bitboard& b, Square s) {
  75   return b |= SquareBB[s];
  76 }
  77
  78 inline Bitboard& operator^=(Bitboard& b, Square s) {
  79   return b ^= SquareBB[s];
  80 }
  81
  82 inline Bitboard operator|(Bitboard b, Square s) {
  83   return b | SquareBB[s];
  84 }
  85
  86 inline Bitboard operator^(Bitboard b, Square s) {
  87   return b ^ SquareBB[s];
  88 }
  89
  90
  91 /// more_than_one() returns true if in 'b' there is more than one bit set
  92
  93 inline bool more_than_one(Bitboard b) {
  94   return b & (b - 1);
  95 }
  96
  97
  98 /// shift_bb() moves bitboard one step along direction Delta. Mainly for pawns.
  99
 100 template<Square Delta>
 101 inline Bitboard shift_bb(Bitboard b) {
 102
 103   return  Delta == DELTA_N  ?  b             << 8 : Delta == DELTA_S  ?  b             >> 8
 104         : Delta == DELTA_NE ? (b & ~FileHBB) << 9 : Delta == DELTA_SE ? (b & ~FileHBB) >> 7
 105         : Delta == DELTA_NW ? (b & ~FileABB) << 7 : Delta == DELTA_SW ? (b & ~FileABB) >> 9
 106         : 0;
 107 }
 108
 109
 110 /// rank_bb() and file_bb() take a file or a square as input and return
 111 /// a bitboard representing all squares on the given file or rank.
 112
 113 inline Bitboard rank_bb(Rank r) {
 114   return RankBB[r];
 115 }
 116
 117 inline Bitboard rank_bb(Square s) {
 118   return RankBB[rank_of(s)];
 119 }
 120
 121 inline Bitboard file_bb(File f) {
 122   return FileBB[f];
 123 }
 124
 125 inline Bitboard file_bb(Square s) {
 126   return FileBB[file_of(s)];
 127 }
 128
 129
 130 /// adjacent_files_bb takes a file as input and returns a bitboard representing
 131 /// all squares on the adjacent files.
 132
 133 inline Bitboard adjacent_files_bb(File f) {
 134   return AdjacentFilesBB[f];
 135 }
 136
 137
 138 /// in_front_bb() takes a color and a rank as input, and returns a bitboard
 139 /// representing all the squares on all ranks in front of the rank, from the
 140 /// given color's point of view. For instance, in_front_bb(BLACK, RANK_3) will
 141 /// give all squares on ranks 1 and 2.
 142
 143 inline Bitboard in_front_bb(Color c, Rank r) {
 144   return InFrontBB[c][r];
 145 }
 146
 147
 148 /// between_bb returns a bitboard representing all squares between two squares.
 149 /// For instance, between_bb(SQ_C4, SQ_F7) returns a bitboard with the bits for
 150 /// square d5 and e6 set.  If s1 and s2 are not on the same line, file or diagonal,
 151 /// 0 is returned.
 152
 153 inline Bitboard between_bb(Square s1, Square s2) {
 154   return BetweenBB[s1][s2];
 155 }
 156
 157
 158 /// forward_bb takes a color and a square as input, and returns a bitboard
 159 /// representing all squares along the line in front of the square, from the
 160 /// point of view of the given color. Definition of the table is:
 161 /// ForwardBB[c][s] = in_front_bb(c, s) & file_bb(s)
 162
 163 inline Bitboard forward_bb(Color c, Square s) {
 164   return ForwardBB[c][s];
 165 }
 166
 167
 168 /// passed_pawn_mask takes a color and a square as input, and returns a
 169 /// bitboard mask which can be used to test if a pawn of the given color on
 170 /// the given square is a passed pawn. Definition of the table is:
 171 /// PassedPawnMask[c][s] = in_front_bb(c, s) & this_and_adjacent_files_bb(s)
 172
 173 inline Bitboard passed_pawn_mask(Color c, Square s) {
 174   return PassedPawnMask[c][s];
 175 }
 176
 177
 178 /// attack_span_mask takes a color and a square as input, and returns a bitboard
 179 /// representing all squares that can be attacked by a pawn of the given color
 180 /// when it moves along its file starting from the given square. Definition is:
 181 /// AttackSpanMask[c][s] = in_front_bb(c, s) & adjacent_files_bb(s);
 182
 183 inline Bitboard pawn_attack_span(Color c, Square s) {
 184   return PawnAttackSpan[c][s];
 185 }
 186
 187
 188 /// squares_aligned returns true if the squares s1, s2 and s3 are aligned
 189 /// either on a straight or on a diagonal line.
 190
 191 inline bool squares_aligned(Square s1, Square s2, Square s3) {
 192   return  (BetweenBB[s1][s2] | BetweenBB[s1][s3] | BetweenBB[s2][s3])
 193         & (     SquareBB[s1] |      SquareBB[s2] |      SquareBB[s3]);
 194 }
 195
 196
 197 /// same_color_squares() returns a bitboard representing all squares with
 198 /// the same color of the given square.
 199
 200 inline Bitboard same_color_squares(Square s) {
 201   return BlackSquares & s ? BlackSquares : ~BlackSquares;
 202 }
 203
 204
 205 /// Functions for computing sliding attack bitboards. Function attacks_bb() takes
 206 /// a square and a bitboard of occupied squares as input, and returns a bitboard
 207 /// representing all squares attacked by Pt (bishop or rook) on the given square.
 208 template<PieceType Pt>
 209 FORCE_INLINE unsigned magic_index(Square s, Bitboard occ) {
 210
 211   Bitboard* const Masks  = Pt == ROOK ? RMasks  : BMasks;
 212   Bitboard* const Magics = Pt == ROOK ? RMagics : BMagics;
 213   unsigned* const Shifts = Pt == ROOK ? RShifts : BShifts;
 214
 215   if (Is64Bit)
 216       return unsigned(((occ & Masks[s]) * Magics[s]) >> Shifts[s]);
 217
 218   unsigned lo = unsigned(occ) & unsigned(Masks[s]);
 219   unsigned hi = unsigned(occ >> 32) & unsigned(Masks[s] >> 32);
 220   return (lo * unsigned(Magics[s]) ^ hi * unsigned(Magics[s] >> 32)) >> Shifts[s];
 221 }
 222
 223 template<PieceType Pt>
 224 inline Bitboard attacks_bb(Square s, Bitboard occ) {
 225   return (Pt == ROOK ? RAttacks : BAttacks)[s][magic_index<Pt>(s, occ)];
 226 }
 227
 228
 229 /// lsb()/msb() finds the least/most significant bit in a nonzero bitboard.
 230 /// pop_lsb() finds and clears the least significant bit in a nonzero bitboard.
 231
 232 #if defined(USE_BSFQ)
 233
 234 #  if defined(_MSC_VER) && !defined(__INTEL_COMPILER)
 235
 236 FORCE_INLINE Square lsb(Bitboard b) {
 237   unsigned long index;
 238   _BitScanForward64(&index, b);
 239   return (Square) index;
 240 }
 241
 242 FORCE_INLINE Square msb(Bitboard b) {
 243   unsigned long index;
 244   _BitScanReverse64(&index, b);
 245   return (Square) index;
 246 }
 247
 248 #  elif defined(__arm__)
 249
 250 FORCE_INLINE int lsb32(uint32_t v) {
 251   __asm__("rbit %0, %1" : "=r"(v) : "r"(v));
 252   return __builtin_clz(v);
 253 }
 254
 255 FORCE_INLINE Square msb(Bitboard b) {
 256   return (Square) (63 - __builtin_clzll(b));
 257 }
 258
 259 FORCE_INLINE Square lsb(Bitboard b) {
 260   return (Square) (uint32_t(b) ? lsb32(uint32_t(b)) : 32 + lsb32(uint32_t(b >> 32)));
 261 }
 262
 263 #  else
 264
 265 FORCE_INLINE Square lsb(Bitboard b) { // Assembly code by Heinz van Saanen
 266   Bitboard index;
 267   __asm__("bsfq %1, %0": "=r"(index): "rm"(b) );
 268   return (Square) index;
 269 }
 270
 271 FORCE_INLINE Square msb(Bitboard b) {
 272   Bitboard index;
 273   __asm__("bsrq %1, %0": "=r"(index): "rm"(b) );
 274   return (Square) index;
 275 }
 276
 277 #  endif
 278
 279 FORCE_INLINE Square pop_lsb(Bitboard* b) {
 280   const Square s = lsb(*b);
 281   *b &= *b - 1;
 282   return s;
 283 }
 284
 285 #else // if !defined(USE_BSFQ)
 286
 287 extern Square msb(Bitboard b);
 288 extern Square lsb(Bitboard b);
 289 extern Square pop_lsb(Bitboard* b);
 290
 291 #endif
 292
 293 #endif // !defined(BITBOARD_H_INCLUDED)