2 Stockfish, a UCI chess playing engine derived from Glaurung 2.1
3 Copyright (c) 2013 Ronald de Man
4 Copyright (C) 2016-2018 Marco Costalba, Lucas Braesch
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.
11 Stockfish is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
16 You should have received a copy of the GNU General Public License
17 along with this program. If not, see <http://www.gnu.org/licenses/>.
23 #include <cstring> // For std::memset and std::memcpy
29 #include <type_traits>
31 #include "../bitboard.h"
32 #include "../movegen.h"
33 #include "../position.h"
34 #include "../search.h"
35 #include "../thread_win32.h"
47 #define WIN32_LEAN_AND_MEAN
52 using namespace Tablebases;
54 int Tablebases::MaxCardinality;
58 constexpr int TBPIECES = 7; // Max number of supported pieces
60 enum { BigEndian, LittleEndian };
61 enum TBType { KEY, WDL, DTZ }; // Used as template parameter
63 // Each table has a set of flags: all of them refer to DTZ tables, the last one to WDL tables
64 enum TBFlag { STM = 1, Mapped = 2, WinPlies = 4, LossPlies = 8, Wide = 16, SingleValue = 128 };
66 inline WDLScore operator-(WDLScore d) { return WDLScore(-int(d)); }
67 inline Square operator^=(Square& s, int i) { return s = Square(int(s) ^ i); }
68 inline Square operator^(Square s, int i) { return Square(int(s) ^ i); }
70 const std::string PieceToChar = " PNBRQK pnbrqk";
72 int MapPawns[SQUARE_NB];
73 int MapB1H1H7[SQUARE_NB];
74 int MapA1D1D4[SQUARE_NB];
75 int MapKK[10][SQUARE_NB]; // [MapA1D1D4][SQUARE_NB]
77 int Binomial[6][SQUARE_NB]; // [k][n] k elements from a set of n elements
78 int LeadPawnIdx[6][SQUARE_NB]; // [leadPawnsCnt][SQUARE_NB]
79 int LeadPawnsSize[6][4]; // [leadPawnsCnt][FILE_A..FILE_D]
81 // Comparison function to sort leading pawns in ascending MapPawns[] order
82 bool pawns_comp(Square i, Square j) { return MapPawns[i] < MapPawns[j]; }
83 int off_A1H8(Square sq) { return int(rank_of(sq)) - file_of(sq); }
85 constexpr Value WDL_to_value[] = {
86 -VALUE_MATE + MAX_PLY + 1,
90 VALUE_MATE - MAX_PLY - 1
93 template<typename T, int Half = sizeof(T) / 2, int End = sizeof(T) - 1>
94 inline void swap_endian(T& x)
96 static_assert(std::is_unsigned<T>::value, "Argument of swap_endian not unsigned");
98 uint8_t tmp, *c = (uint8_t*)&x;
99 for (int i = 0; i < Half; ++i)
100 tmp = c[i], c[i] = c[End - i], c[End - i] = tmp;
102 template<> inline void swap_endian<uint8_t>(uint8_t&) {}
104 template<typename T, int LE> T number(void* addr)
106 static const union { uint32_t i; char c[4]; } Le = { 0x01020304 };
107 static const bool IsLittleEndian = (Le.c[0] == 4);
111 if ((uintptr_t)addr & (alignof(T) - 1)) // Unaligned pointer (very rare)
112 std::memcpy(&v, addr, sizeof(T));
116 if (LE != IsLittleEndian)
121 // DTZ tables don't store valid scores for moves that reset the rule50 counter
122 // like captures and pawn moves but we can easily recover the correct dtz of the
123 // previous move if we know the position's WDL score.
124 int dtz_before_zeroing(WDLScore wdl) {
125 return wdl == WDLWin ? 1 :
126 wdl == WDLCursedWin ? 101 :
127 wdl == WDLBlessedLoss ? -101 :
128 wdl == WDLLoss ? -1 : 0;
131 // Return the sign of a number (-1, 0, 1)
132 template <typename T> int sign_of(T val) {
133 return (T(0) < val) - (val < T(0));
136 // Numbers in little endian used by sparseIndex[] to point into blockLength[]
138 char block[4]; // Number of block
139 char offset[2]; // Offset within the block
142 static_assert(sizeof(SparseEntry) == 6, "SparseEntry must be 6 bytes");
144 typedef uint16_t Sym; // Huffman symbol
147 enum Side { Left, Right };
149 uint8_t lr[3]; // The first 12 bits is the left-hand symbol, the second 12
150 // bits is the right-hand symbol. If symbol has length 1,
151 // then the left-hand symbol is the stored value.
154 return S == Left ? ((lr[1] & 0xF) << 8) | lr[0] :
155 S == Right ? (lr[2] << 4) | (lr[1] >> 4) : (assert(false), Sym(-1));
159 static_assert(sizeof(LR) == 3, "LR tree entry must be 3 bytes");
161 // Tablebases data layout is structured as following:
163 // TBFile: memory maps/unmaps the physical .rtbw and .rtbz files
164 // TBTable: one object for each file with corresponding indexing information
165 // TBTables: has ownership of TBTable objects, keeping a list and a hash
167 // class TBFile memory maps/unmaps the single .rtbw and .rtbz files. Files are
168 // memory mapped for best performance. Files are mapped at first access: at init
169 // time only existence of the file is checked.
170 class TBFile : public std::ifstream {
175 // Look for and open the file among the Paths directories where the .rtbw
176 // and .rtbz files can be found. Multiple directories are separated by ";"
177 // on Windows and by ":" on Unix-based operating systems.
180 // C:\tb\wdl345;C:\tb\wdl6;D:\tb\dtz345;D:\tb\dtz6
181 static std::string Paths;
183 TBFile(const std::string& f) {
186 constexpr char SepChar = ':';
188 constexpr char SepChar = ';';
190 std::stringstream ss(Paths);
193 while (std::getline(ss, path, SepChar)) {
194 fname = path + "/" + f;
195 std::ifstream::open(fname);
201 // Memory map the file and check it. File should be already open and will be
202 // closed after mapping.
203 uint8_t* map(void** baseAddress, uint64_t* mapping, TBType type) {
207 close(); // Need to re-open to get native file descriptor
211 int fd = ::open(fname.c_str(), O_RDONLY);
214 return *baseAddress = nullptr, nullptr;
217 *mapping = statbuf.st_size;
218 *baseAddress = mmap(nullptr, statbuf.st_size, PROT_READ, MAP_SHARED, fd, 0);
219 madvise(*baseAddress, statbuf.st_size, MADV_RANDOM);
222 if (*baseAddress == MAP_FAILED) {
223 std::cerr << "Could not mmap() " << fname << std::endl;
227 // Note FILE_FLAG_RANDOM_ACCESS is only a hint to Windows and as such may get ignored.
228 HANDLE fd = CreateFile(fname.c_str(), GENERIC_READ, FILE_SHARE_READ, nullptr,
229 OPEN_EXISTING, FILE_FLAG_RANDOM_ACCESS, nullptr);
231 if (fd == INVALID_HANDLE_VALUE)
232 return *baseAddress = nullptr, nullptr;
235 DWORD size_low = GetFileSize(fd, &size_high);
236 HANDLE mmap = CreateFileMapping(fd, nullptr, PAGE_READONLY, size_high, size_low, nullptr);
240 std::cerr << "CreateFileMapping() failed" << std::endl;
244 *mapping = (uint64_t)mmap;
245 *baseAddress = MapViewOfFile(mmap, FILE_MAP_READ, 0, 0, 0);
248 std::cerr << "MapViewOfFile() failed, name = " << fname
249 << ", error = " << GetLastError() << std::endl;
253 uint8_t* data = (uint8_t*)*baseAddress;
255 constexpr uint8_t Magics[][4] = { { 0xD7, 0x66, 0x0C, 0xA5 },
256 { 0x71, 0xE8, 0x23, 0x5D } };
258 if (memcmp(data, Magics[type == WDL], 4)) {
259 std::cerr << "Corrupted table in file " << fname << std::endl;
260 unmap(*baseAddress, *mapping);
261 return *baseAddress = nullptr, nullptr;
264 return data + 4; // Skip Magics's header
267 static void unmap(void* baseAddress, uint64_t mapping) {
270 munmap(baseAddress, mapping);
272 UnmapViewOfFile(baseAddress);
273 CloseHandle((HANDLE)mapping);
278 std::string TBFile::Paths;
280 // struct PairsData contains low level indexing information to access TB data.
281 // There are 8, 4 or 2 PairsData records for each TBTable, according to type of
282 // table and if positions have pawns or not. It is populated at first access.
284 uint8_t flags; // Table flags, see enum TBFlag
285 uint8_t maxSymLen; // Maximum length in bits of the Huffman symbols
286 uint8_t minSymLen; // Minimum length in bits of the Huffman symbols
287 uint32_t blocksNum; // Number of blocks in the TB file
288 size_t sizeofBlock; // Block size in bytes
289 size_t span; // About every span values there is a SparseIndex[] entry
290 Sym* lowestSym; // lowestSym[l] is the symbol of length l with the lowest value
291 LR* btree; // btree[sym] stores the left and right symbols that expand sym
292 uint16_t* blockLength; // Number of stored positions (minus one) for each block: 1..65536
293 uint32_t blockLengthSize; // Size of blockLength[] table: padded so it's bigger than blocksNum
294 SparseEntry* sparseIndex; // Partial indices into blockLength[]
295 size_t sparseIndexSize; // Size of SparseIndex[] table
296 uint8_t* data; // Start of Huffman compressed data
297 std::vector<uint64_t> base64; // base64[l - min_sym_len] is the 64bit-padded lowest symbol of length l
298 std::vector<uint8_t> symlen; // Number of values (-1) represented by a given Huffman symbol: 1..256
299 Piece pieces[TBPIECES]; // Position pieces: the order of pieces defines the groups
300 uint64_t groupIdx[TBPIECES+1]; // Start index used for the encoding of the group's pieces
301 int groupLen[TBPIECES+1]; // Number of pieces in a given group: KRKN -> (3, 1)
302 uint16_t map_idx[4]; // WDLWin, WDLLoss, WDLCursedWin, WDLBlessedLoss (used in DTZ)
305 // struct TBTable contains indexing information to access the corresponding TBFile.
306 // There are 2 types of TBTable, corresponding to a WDL or a DTZ file. TBTable
307 // is populated at init time but the nested PairsData records are populated at
308 // first access, when the corresponding file is memory mapped.
309 template<TBType Type>
311 typedef typename std::conditional<Type == WDL, WDLScore, int>::type Ret;
313 static constexpr int Sides = Type == WDL ? 2 : 1;
315 std::atomic_bool ready;
323 bool hasUniquePieces;
324 uint8_t pawnCount[2]; // [Lead color / other color]
325 PairsData items[Sides][4]; // [wtm / btm][FILE_A..FILE_D or 0]
327 PairsData* get(int stm, int f) {
328 return &items[stm % Sides][hasPawns ? f : 0];
331 TBTable() : ready(false), baseAddress(nullptr) {}
332 explicit TBTable(const std::string& code);
333 explicit TBTable(const TBTable<WDL>& wdl);
337 TBFile::unmap(baseAddress, mapping);
342 TBTable<WDL>::TBTable(const std::string& code) : TBTable() {
347 key = pos.set(code, WHITE, &st).material_key();
348 pieceCount = pos.count<ALL_PIECES>();
349 hasPawns = pos.pieces(PAWN);
351 hasUniquePieces = false;
352 for (Color c = WHITE; c <= BLACK; ++c)
353 for (PieceType pt = PAWN; pt < KING; ++pt)
354 if (popcount(pos.pieces(c, pt)) == 1)
355 hasUniquePieces = true;
357 // Set the leading color. In case both sides have pawns the leading color
358 // is the side with less pawns because this leads to better compression.
359 bool c = !pos.count<PAWN>(BLACK)
360 || ( pos.count<PAWN>(WHITE)
361 && pos.count<PAWN>(BLACK) >= pos.count<PAWN>(WHITE));
363 pawnCount[0] = pos.count<PAWN>(c ? WHITE : BLACK);
364 pawnCount[1] = pos.count<PAWN>(c ? BLACK : WHITE);
366 key2 = pos.set(code, BLACK, &st).material_key();
370 TBTable<DTZ>::TBTable(const TBTable<WDL>& wdl) : TBTable() {
372 // Use the corresponding WDL table to avoid recalculating all from scratch
375 pieceCount = wdl.pieceCount;
376 hasPawns = wdl.hasPawns;
377 hasUniquePieces = wdl.hasUniquePieces;
378 pawnCount[0] = wdl.pawnCount[0];
379 pawnCount[1] = wdl.pawnCount[1];
382 // class TBTables creates and keeps ownership of the TBTable objects, one for
383 // each TB file found. It supports a fast, hash based, table lookup. Populated
384 // at init time, accessed at probe time.
387 typedef std::tuple<Key, TBTable<WDL>*, TBTable<DTZ>*> Entry;
389 static constexpr int Size = 1 << 12; // 4K table, indexed by key's 12 lsb
390 static constexpr int Overflow = 1; // Number of elements allowed to map to the last bucket
392 Entry hashTable[Size + Overflow];
394 std::deque<TBTable<WDL>> wdlTable;
395 std::deque<TBTable<DTZ>> dtzTable;
397 void insert(Key key, TBTable<WDL>* wdl, TBTable<DTZ>* dtz) {
398 uint32_t homeBucket = (uint32_t)key & (Size - 1);
399 Entry entry = std::make_tuple(key, wdl, dtz);
401 // Ensure last element is empty to avoid overflow when looking up
402 for (uint32_t bucket = homeBucket; bucket < Size + Overflow - 1; ++bucket) {
403 Key otherKey = std::get<KEY>(hashTable[bucket]);
404 if (otherKey == key || !std::get<WDL>(hashTable[bucket])) {
405 hashTable[bucket] = entry;
409 // Robin Hood hashing: If we've probed for longer than this element,
410 // insert here and search for a new spot for the other element instead.
411 uint32_t otherHomeBucket = (uint32_t)otherKey & (Size - 1);
412 if (otherHomeBucket > homeBucket) {
413 swap(entry, hashTable[bucket]);
415 homeBucket = otherHomeBucket;
418 std::cerr << "TB hash table size too low!" << std::endl;
423 template<TBType Type>
424 TBTable<Type>* get(Key key) {
425 for (const Entry* entry = &hashTable[(uint32_t)key & (Size - 1)]; ; ++entry) {
426 if (std::get<KEY>(*entry) == key || !std::get<Type>(*entry))
427 return std::get<Type>(*entry);
432 memset(hashTable, 0, sizeof(hashTable));
436 size_t size() const { return wdlTable.size(); }
437 void add(const std::vector<PieceType>& pieces);
442 // If the corresponding file exists two new objects TBTable<WDL> and TBTable<DTZ>
443 // are created and added to the lists and hash table. Called at init time.
444 void TBTables::add(const std::vector<PieceType>& pieces) {
448 for (PieceType pt : pieces)
449 code += PieceToChar[pt];
451 TBFile file(code.insert(code.find('K', 1), "v") + ".rtbw"); // KRK -> KRvK
453 if (!file.is_open()) // Only WDL file is checked
458 MaxCardinality = std::max((int)pieces.size(), MaxCardinality);
460 wdlTable.emplace_back(code);
461 dtzTable.emplace_back(wdlTable.back());
463 // Insert into the hash keys for both colors: KRvK with KR white and black
464 insert(wdlTable.back().key , &wdlTable.back(), &dtzTable.back());
465 insert(wdlTable.back().key2, &wdlTable.back(), &dtzTable.back());
468 // TB tables are compressed with canonical Huffman code. The compressed data is divided into
469 // blocks of size d->sizeofBlock, and each block stores a variable number of symbols.
470 // Each symbol represents either a WDL or a (remapped) DTZ value, or a pair of other symbols
471 // (recursively). If you keep expanding the symbols in a block, you end up with up to 65536
472 // WDL or DTZ values. Each symbol represents up to 256 values and will correspond after
473 // Huffman coding to at least 1 bit. So a block of 32 bytes corresponds to at most
474 // 32 x 8 x 256 = 65536 values. This maximum is only reached for tables that consist mostly
475 // of draws or mostly of wins, but such tables are actually quite common. In principle, the
476 // blocks in WDL tables are 64 bytes long (and will be aligned on cache lines). But for
477 // mostly-draw or mostly-win tables this can leave many 64-byte blocks only half-filled, so
478 // in such cases blocks are 32 bytes long. The blocks of DTZ tables are up to 1024 bytes long.
479 // The generator picks the size that leads to the smallest table. The "book" of symbols and
480 // Huffman codes is the same for all blocks in the table. A non-symmetric pawnless TB file
481 // will have one table for wtm and one for btm, a TB file with pawns will have tables per
482 // file a,b,c,d also in this case one set for wtm and one for btm.
483 int decompress_pairs(PairsData* d, uint64_t idx) {
485 // Special case where all table positions store the same value
486 if (d->flags & TBFlag::SingleValue)
489 // First we need to locate the right block that stores the value at index "idx".
490 // Because each block n stores blockLength[n] + 1 values, the index i of the block
491 // that contains the value at position idx is:
493 // for (i = -1, sum = 0; sum <= idx; i++)
494 // sum += blockLength[i + 1] + 1;
496 // This can be slow, so we use SparseIndex[] populated with a set of SparseEntry that
497 // point to known indices into blockLength[]. Namely SparseIndex[k] is a SparseEntry
498 // that stores the blockLength[] index and the offset within that block of the value
499 // with index I(k), where:
501 // I(k) = k * d->span + d->span / 2 (1)
503 // First step is to get the 'k' of the I(k) nearest to our idx, using definition (1)
504 uint32_t k = idx / d->span;
506 // Then we read the corresponding SparseIndex[] entry
507 uint32_t block = number<uint32_t, LittleEndian>(&d->sparseIndex[k].block);
508 int offset = number<uint16_t, LittleEndian>(&d->sparseIndex[k].offset);
510 // Now compute the difference idx - I(k). From definition of k we know that
512 // idx = k * d->span + idx % d->span (2)
514 // So from (1) and (2) we can compute idx - I(K):
515 int diff = idx % d->span - d->span / 2;
517 // Sum the above to offset to find the offset corresponding to our idx
520 // Move to previous/next block, until we reach the correct block that contains idx,
521 // that is when 0 <= offset <= d->blockLength[block]
523 offset += d->blockLength[--block] + 1;
525 while (offset > d->blockLength[block])
526 offset -= d->blockLength[block++] + 1;
528 // Finally, we find the start address of our block of canonical Huffman symbols
529 uint32_t* ptr = (uint32_t*)(d->data + ((uint64_t)block * d->sizeofBlock));
531 // Read the first 64 bits in our block, this is a (truncated) sequence of
532 // unknown number of symbols of unknown length but we know the first one
533 // is at the beginning of this 64 bits sequence.
534 uint64_t buf64 = number<uint64_t, BigEndian>(ptr); ptr += 2;
539 int len = 0; // This is the symbol length - d->min_sym_len
541 // Now get the symbol length. For any symbol s64 of length l right-padded
542 // to 64 bits we know that d->base64[l-1] >= s64 >= d->base64[l] so we
543 // can find the symbol length iterating through base64[].
544 while (buf64 < d->base64[len])
547 // All the symbols of a given length are consecutive integers (numerical
548 // sequence property), so we can compute the offset of our symbol of
549 // length len, stored at the beginning of buf64.
550 sym = (buf64 - d->base64[len]) >> (64 - len - d->minSymLen);
552 // Now add the value of the lowest symbol of length len to get our symbol
553 sym += number<Sym, LittleEndian>(&d->lowestSym[len]);
555 // If our offset is within the number of values represented by symbol sym
557 if (offset < d->symlen[sym] + 1)
560 // ...otherwise update the offset and continue to iterate
561 offset -= d->symlen[sym] + 1;
562 len += d->minSymLen; // Get the real length
563 buf64 <<= len; // Consume the just processed symbol
566 if (buf64Size <= 32) { // Refill the buffer
568 buf64 |= (uint64_t)number<uint32_t, BigEndian>(ptr++) << (64 - buf64Size);
572 // Ok, now we have our symbol that expands into d->symlen[sym] + 1 symbols.
573 // We binary-search for our value recursively expanding into the left and
574 // right child symbols until we reach a leaf node where symlen[sym] + 1 == 1
575 // that will store the value we need.
576 while (d->symlen[sym]) {
578 Sym left = d->btree[sym].get<LR::Left>();
580 // If a symbol contains 36 sub-symbols (d->symlen[sym] + 1 = 36) and
581 // expands in a pair (d->symlen[left] = 23, d->symlen[right] = 11), then
582 // we know that, for instance the ten-th value (offset = 10) will be on
583 // the left side because in Recursive Pairing child symbols are adjacent.
584 if (offset < d->symlen[left] + 1)
587 offset -= d->symlen[left] + 1;
588 sym = d->btree[sym].get<LR::Right>();
592 return d->btree[sym].get<LR::Left>();
595 bool check_dtz_stm(TBTable<WDL>*, int, File) { return true; }
597 bool check_dtz_stm(TBTable<DTZ>* entry, int stm, File f) {
599 auto flags = entry->get(stm, f)->flags;
600 return (flags & TBFlag::STM) == stm
601 || ((entry->key == entry->key2) && !entry->hasPawns);
604 // DTZ scores are sorted by frequency of occurrence and then assigned the
605 // values 0, 1, 2, ... in order of decreasing frequency. This is done for each
606 // of the four WDLScore values. The mapping information necessary to reconstruct
607 // the original values is stored in the TB file and read during map[] init.
608 WDLScore map_score(TBTable<WDL>*, File, int value, WDLScore) { return WDLScore(value - 2); }
610 int map_score(TBTable<DTZ>* entry, File f, int value, WDLScore wdl) {
612 constexpr int WDLMap[] = { 1, 3, 0, 2, 0 };
614 auto flags = entry->get(0, f)->flags;
616 uint8_t* map = entry->map;
617 uint16_t* idx = entry->get(0, f)->map_idx;
618 if (flags & TBFlag::Mapped) {
619 if (flags & TBFlag::Wide)
620 value = ((uint16_t *)map)[idx[WDLMap[wdl + 2]] + value];
622 value = map[idx[WDLMap[wdl + 2]] + value];
625 // DTZ tables store distance to zero in number of moves or plies. We
626 // want to return plies, so we have convert to plies when needed.
627 if ( (wdl == WDLWin && !(flags & TBFlag::WinPlies))
628 || (wdl == WDLLoss && !(flags & TBFlag::LossPlies))
629 || wdl == WDLCursedWin
630 || wdl == WDLBlessedLoss)
636 // Compute a unique index out of a position and use it to probe the TB file. To
637 // encode k pieces of same type and color, first sort the pieces by square in
638 // ascending order s1 <= s2 <= ... <= sk then compute the unique index as:
640 // idx = Binomial[1][s1] + Binomial[2][s2] + ... + Binomial[k][sk]
642 template<typename T, typename Ret = typename T::Ret>
643 Ret do_probe_table(const Position& pos, T* entry, WDLScore wdl, ProbeState* result) {
645 Square squares[TBPIECES];
646 Piece pieces[TBPIECES];
648 int next = 0, size = 0, leadPawnsCnt = 0;
650 Bitboard b, leadPawns = 0;
651 File tbFile = FILE_A;
653 // A given TB entry like KRK has associated two material keys: KRvk and Kvkr.
654 // If both sides have the same pieces keys are equal. In this case TB tables
655 // only store the 'white to move' case, so if the position to lookup has black
656 // to move, we need to switch the color and flip the squares before to lookup.
657 bool symmetricBlackToMove = (entry->key == entry->key2 && pos.side_to_move());
659 // TB files are calculated for white as stronger side. For instance we have
660 // KRvK, not KvKR. A position where stronger side is white will have its
661 // material key == entry->key, otherwise we have to switch the color and
662 // flip the squares before to lookup.
663 bool blackStronger = (pos.material_key() != entry->key);
665 int flipColor = (symmetricBlackToMove || blackStronger) * 8;
666 int flipSquares = (symmetricBlackToMove || blackStronger) * 070;
667 int stm = (symmetricBlackToMove || blackStronger) ^ pos.side_to_move();
669 // For pawns, TB files store 4 separate tables according if leading pawn is on
670 // file a, b, c or d after reordering. The leading pawn is the one with maximum
671 // MapPawns[] value, that is the one most toward the edges and with lowest rank.
672 if (entry->hasPawns) {
674 // In all the 4 tables, pawns are at the beginning of the piece sequence and
675 // their color is the reference one. So we just pick the first one.
676 Piece pc = Piece(entry->get(0, 0)->pieces[0] ^ flipColor);
678 assert(type_of(pc) == PAWN);
680 leadPawns = b = pos.pieces(color_of(pc), PAWN);
682 squares[size++] = pop_lsb(&b) ^ flipSquares;
687 std::swap(squares[0], *std::max_element(squares, squares + leadPawnsCnt, pawns_comp));
689 tbFile = file_of(squares[0]);
691 tbFile = file_of(squares[0] ^ 7); // Horizontal flip: SQ_H1 -> SQ_A1
694 // DTZ tables are one-sided, i.e. they store positions only for white to
695 // move or only for black to move, so check for side to move to be stm,
696 // early exit otherwise.
697 if (!check_dtz_stm(entry, stm, tbFile))
698 return *result = CHANGE_STM, Ret();
700 // Now we are ready to get all the position pieces (but the lead pawns) and
701 // directly map them to the correct color and square.
702 b = pos.pieces() ^ leadPawns;
704 Square s = pop_lsb(&b);
705 squares[size] = s ^ flipSquares;
706 pieces[size++] = Piece(pos.piece_on(s) ^ flipColor);
711 d = entry->get(stm, tbFile);
713 // Then we reorder the pieces to have the same sequence as the one stored
714 // in pieces[i]: the sequence that ensures the best compression.
715 for (int i = leadPawnsCnt; i < size; ++i)
716 for (int j = i; j < size; ++j)
717 if (d->pieces[i] == pieces[j])
719 std::swap(pieces[i], pieces[j]);
720 std::swap(squares[i], squares[j]);
724 // Now we map again the squares so that the square of the lead piece is in
725 // the triangle A1-D1-D4.
726 if (file_of(squares[0]) > FILE_D)
727 for (int i = 0; i < size; ++i)
728 squares[i] ^= 7; // Horizontal flip: SQ_H1 -> SQ_A1
730 // Encode leading pawns starting with the one with minimum MapPawns[] and
731 // proceeding in ascending order.
732 if (entry->hasPawns) {
733 idx = LeadPawnIdx[leadPawnsCnt][squares[0]];
735 std::sort(squares + 1, squares + leadPawnsCnt, pawns_comp);
737 for (int i = 1; i < leadPawnsCnt; ++i)
738 idx += Binomial[i][MapPawns[squares[i]]];
740 goto encode_remaining; // With pawns we have finished special treatments
743 // In positions withouth pawns, we further flip the squares to ensure leading
744 // piece is below RANK_5.
745 if (rank_of(squares[0]) > RANK_4)
746 for (int i = 0; i < size; ++i)
747 squares[i] ^= 070; // Vertical flip: SQ_A8 -> SQ_A1
749 // Look for the first piece of the leading group not on the A1-D4 diagonal
750 // and ensure it is mapped below the diagonal.
751 for (int i = 0; i < d->groupLen[0]; ++i) {
752 if (!off_A1H8(squares[i]))
755 if (off_A1H8(squares[i]) > 0) // A1-H8 diagonal flip: SQ_A3 -> SQ_C3
756 for (int j = i; j < size; ++j)
757 squares[j] = Square(((squares[j] >> 3) | (squares[j] << 3)) & 63);
761 // Encode the leading group.
763 // Suppose we have KRvK. Let's say the pieces are on square numbers wK, wR
764 // and bK (each 0...63). The simplest way to map this position to an index
767 // index = wK * 64 * 64 + wR * 64 + bK;
769 // But this way the TB is going to have 64*64*64 = 262144 positions, with
770 // lots of positions being equivalent (because they are mirrors of each
771 // other) and lots of positions being invalid (two pieces on one square,
772 // adjacent kings, etc.).
773 // Usually the first step is to take the wK and bK together. There are just
774 // 462 ways legal and not-mirrored ways to place the wK and bK on the board.
775 // Once we have placed the wK and bK, there are 62 squares left for the wR
776 // Mapping its square from 0..63 to available squares 0..61 can be done like:
778 // wR -= (wR > wK) + (wR > bK);
780 // In words: if wR "comes later" than wK, we deduct 1, and the same if wR
781 // "comes later" than bK. In case of two same pieces like KRRvK we want to
782 // place the two Rs "together". If we have 62 squares left, we can place two
783 // Rs "together" in 62 * 61 / 2 ways (we divide by 2 because rooks can be
784 // swapped and still get the same position.)
786 // In case we have at least 3 unique pieces (inlcuded kings) we encode them
788 if (entry->hasUniquePieces) {
790 int adjust1 = squares[1] > squares[0];
791 int adjust2 = (squares[2] > squares[0]) + (squares[2] > squares[1]);
793 // First piece is below a1-h8 diagonal. MapA1D1D4[] maps the b1-d1-d3
794 // triangle to 0...5. There are 63 squares for second piece and and 62
795 // (mapped to 0...61) for the third.
796 if (off_A1H8(squares[0]))
797 idx = ( MapA1D1D4[squares[0]] * 63
798 + (squares[1] - adjust1)) * 62
799 + squares[2] - adjust2;
801 // First piece is on a1-h8 diagonal, second below: map this occurence to
802 // 6 to differentiate from the above case, rank_of() maps a1-d4 diagonal
803 // to 0...3 and finally MapB1H1H7[] maps the b1-h1-h7 triangle to 0..27.
804 else if (off_A1H8(squares[1]))
805 idx = ( 6 * 63 + rank_of(squares[0]) * 28
806 + MapB1H1H7[squares[1]]) * 62
807 + squares[2] - adjust2;
809 // First two pieces are on a1-h8 diagonal, third below
810 else if (off_A1H8(squares[2]))
811 idx = 6 * 63 * 62 + 4 * 28 * 62
812 + rank_of(squares[0]) * 7 * 28
813 + (rank_of(squares[1]) - adjust1) * 28
814 + MapB1H1H7[squares[2]];
816 // All 3 pieces on the diagonal a1-h8
818 idx = 6 * 63 * 62 + 4 * 28 * 62 + 4 * 7 * 28
819 + rank_of(squares[0]) * 7 * 6
820 + (rank_of(squares[1]) - adjust1) * 6
821 + (rank_of(squares[2]) - adjust2);
823 // We don't have at least 3 unique pieces, like in KRRvKBB, just map
825 idx = MapKK[MapA1D1D4[squares[0]]][squares[1]];
828 idx *= d->groupIdx[0];
829 Square* groupSq = squares + d->groupLen[0];
831 // Encode remainig pawns then pieces according to square, in ascending order
832 bool remainingPawns = entry->hasPawns && entry->pawnCount[1];
834 while (d->groupLen[++next])
836 std::sort(groupSq, groupSq + d->groupLen[next]);
839 // Map down a square if "comes later" than a square in the previous
840 // groups (similar to what done earlier for leading group pieces).
841 for (int i = 0; i < d->groupLen[next]; ++i)
843 auto f = [&](Square s) { return groupSq[i] > s; };
844 auto adjust = std::count_if(squares, groupSq, f);
845 n += Binomial[i + 1][groupSq[i] - adjust - 8 * remainingPawns];
848 remainingPawns = false;
849 idx += n * d->groupIdx[next];
850 groupSq += d->groupLen[next];
853 // Now that we have the index, decompress the pair and get the score
854 return map_score(entry, tbFile, decompress_pairs(d, idx), wdl);
857 // Group together pieces that will be encoded together. The general rule is that
858 // a group contains pieces of same type and color. The exception is the leading
859 // group that, in case of positions withouth pawns, can be formed by 3 different
860 // pieces (default) or by the king pair when there is not a unique piece apart
861 // from the kings. When there are pawns, pawns are always first in pieces[].
863 // As example KRKN -> KRK + N, KNNK -> KK + NN, KPPKP -> P + PP + K + K
865 // The actual grouping depends on the TB generator and can be inferred from the
866 // sequence of pieces in piece[] array.
868 void set_groups(T& e, PairsData* d, int order[], File f) {
870 int n = 0, firstLen = e.hasPawns ? 0 : e.hasUniquePieces ? 3 : 2;
873 // Number of pieces per group is stored in groupLen[], for instance in KRKN
874 // the encoder will default on '111', so groupLen[] will be (3, 1).
875 for (int i = 1; i < e.pieceCount; ++i)
876 if (--firstLen > 0 || d->pieces[i] == d->pieces[i - 1])
879 d->groupLen[++n] = 1;
881 d->groupLen[++n] = 0; // Zero-terminated
883 // The sequence in pieces[] defines the groups, but not the order in which
884 // they are encoded. If the pieces in a group g can be combined on the board
885 // in N(g) different ways, then the position encoding will be of the form:
887 // g1 * N(g2) * N(g3) + g2 * N(g3) + g3
889 // This ensures unique encoding for the whole position. The order of the
890 // groups is a per-table parameter and could not follow the canonical leading
891 // pawns/pieces -> remainig pawns -> remaining pieces. In particular the
892 // first group is at order[0] position and the remaining pawns, when present,
893 // are at order[1] position.
894 bool pp = e.hasPawns && e.pawnCount[1]; // Pawns on both sides
895 int next = pp ? 2 : 1;
896 int freeSquares = 64 - d->groupLen[0] - (pp ? d->groupLen[1] : 0);
899 for (int k = 0; next < n || k == order[0] || k == order[1]; ++k)
900 if (k == order[0]) // Leading pawns or pieces
902 d->groupIdx[0] = idx;
903 idx *= e.hasPawns ? LeadPawnsSize[d->groupLen[0]][f]
904 : e.hasUniquePieces ? 31332 : 462;
906 else if (k == order[1]) // Remaining pawns
908 d->groupIdx[1] = idx;
909 idx *= Binomial[d->groupLen[1]][48 - d->groupLen[0]];
911 else // Remainig pieces
913 d->groupIdx[next] = idx;
914 idx *= Binomial[d->groupLen[next]][freeSquares];
915 freeSquares -= d->groupLen[next++];
918 d->groupIdx[n] = idx;
921 // In Recursive Pairing each symbol represents a pair of childern symbols. So
922 // read d->btree[] symbols data and expand each one in his left and right child
923 // symbol until reaching the leafs that represent the symbol value.
924 uint8_t set_symlen(PairsData* d, Sym s, std::vector<bool>& visited) {
926 visited[s] = true; // We can set it now because tree is acyclic
927 Sym sr = d->btree[s].get<LR::Right>();
932 Sym sl = d->btree[s].get<LR::Left>();
935 d->symlen[sl] = set_symlen(d, sl, visited);
938 d->symlen[sr] = set_symlen(d, sr, visited);
940 return d->symlen[sl] + d->symlen[sr] + 1;
943 uint8_t* set_sizes(PairsData* d, uint8_t* data) {
947 if (d->flags & TBFlag::SingleValue) {
948 d->blocksNum = d->blockLengthSize = 0;
949 d->span = d->sparseIndexSize = 0; // Broken MSVC zero-init
950 d->minSymLen = *data++; // Here we store the single value
954 // groupLen[] is a zero-terminated list of group lengths, the last groupIdx[]
955 // element stores the biggest index that is the tb size.
956 uint64_t tbSize = d->groupIdx[std::find(d->groupLen, d->groupLen + 7, 0) - d->groupLen];
958 d->sizeofBlock = 1ULL << *data++;
959 d->span = 1ULL << *data++;
960 d->sparseIndexSize = (tbSize + d->span - 1) / d->span; // Round up
961 auto padding = number<uint8_t, LittleEndian>(data++);
962 d->blocksNum = number<uint32_t, LittleEndian>(data); data += sizeof(uint32_t);
963 d->blockLengthSize = d->blocksNum + padding; // Padded to ensure SparseIndex[]
964 // does not point out of range.
965 d->maxSymLen = *data++;
966 d->minSymLen = *data++;
967 d->lowestSym = (Sym*)data;
968 d->base64.resize(d->maxSymLen - d->minSymLen + 1);
970 // The canonical code is ordered such that longer symbols (in terms of
971 // the number of bits of their Huffman code) have lower numeric value,
972 // so that d->lowestSym[i] >= d->lowestSym[i+1] (when read as LittleEndian).
973 // Starting from this we compute a base64[] table indexed by symbol length
974 // and containing 64 bit values so that d->base64[i] >= d->base64[i+1].
975 // See http://www.eecs.harvard.edu/~michaelm/E210/huffman.pdf
976 for (int i = d->base64.size() - 2; i >= 0; --i) {
977 d->base64[i] = (d->base64[i + 1] + number<Sym, LittleEndian>(&d->lowestSym[i])
978 - number<Sym, LittleEndian>(&d->lowestSym[i + 1])) / 2;
980 assert(d->base64[i] * 2 >= d->base64[i+1]);
983 // Now left-shift by an amount so that d->base64[i] gets shifted 1 bit more
984 // than d->base64[i+1] and given the above assert condition, we ensure that
985 // d->base64[i] >= d->base64[i+1]. Moreover for any symbol s64 of length i
986 // and right-padded to 64 bits holds d->base64[i-1] >= s64 >= d->base64[i].
987 for (size_t i = 0; i < d->base64.size(); ++i)
988 d->base64[i] <<= 64 - i - d->minSymLen; // Right-padding to 64 bits
990 data += d->base64.size() * sizeof(Sym);
991 d->symlen.resize(number<uint16_t, LittleEndian>(data)); data += sizeof(uint16_t);
992 d->btree = (LR*)data;
994 // The compression scheme used is "Recursive Pairing", that replaces the most
995 // frequent adjacent pair of symbols in the source message by a new symbol,
996 // reevaluating the frequencies of all of the symbol pairs with respect to
997 // the extended alphabet, and then repeating the process.
998 // See http://www.larsson.dogma.net/dcc99.pdf
999 std::vector<bool> visited(d->symlen.size());
1001 for (Sym sym = 0; sym < d->symlen.size(); ++sym)
1003 d->symlen[sym] = set_symlen(d, sym, visited);
1005 return data + d->symlen.size() * sizeof(LR) + (d->symlen.size() & 1);
1008 uint8_t* set_dtz_map(TBTable<WDL>&, uint8_t* data, File) { return data; }
1010 uint8_t* set_dtz_map(TBTable<DTZ>& e, uint8_t* data, File maxFile) {
1014 for (File f = FILE_A; f <= maxFile; ++f) {
1015 auto flags = e.get(0, f)->flags;
1016 if (flags & TBFlag::Mapped) {
1017 if (flags & TBFlag::Wide) {
1018 data += (uintptr_t)data & 1; // Word alignment, we may have a mixed table
1019 for (int i = 0; i < 4; ++i) { // Sequence like 3,x,x,x,1,x,0,2,x,x
1020 e.get(0, f)->map_idx[i] = (uint16_t)((uint16_t *)data - (uint16_t *)e.map + 1);
1021 data += 2 * number<uint16_t, LittleEndian>(data) + 2;
1025 for (int i = 0; i < 4; ++i) {
1026 e.get(0, f)->map_idx[i] = (uint16_t)(data - e.map + 1);
1033 return data += (uintptr_t)data & 1; // Word alignment
1036 // Populate entry's PairsData records with data from the just memory mapped file.
1037 // Called at first access.
1038 template<typename T>
1039 void set(T& e, uint8_t* data) {
1043 enum { Split = 1, HasPawns = 2 };
1045 assert(e.hasPawns == !!(*data & HasPawns));
1046 assert((e.key != e.key2) == !!(*data & Split));
1048 data++; // First byte stores flags
1050 const int sides = T::Sides == 2 && (e.key != e.key2) ? 2 : 1;
1051 const File maxFile = e.hasPawns ? FILE_D : FILE_A;
1053 bool pp = e.hasPawns && e.pawnCount[1]; // Pawns on both sides
1055 assert(!pp || e.pawnCount[0]);
1057 for (File f = FILE_A; f <= maxFile; ++f) {
1059 for (int i = 0; i < sides; i++)
1060 *e.get(i, f) = PairsData();
1062 int order[][2] = { { *data & 0xF, pp ? *(data + 1) & 0xF : 0xF },
1063 { *data >> 4, pp ? *(data + 1) >> 4 : 0xF } };
1066 for (int k = 0; k < e.pieceCount; ++k, ++data)
1067 for (int i = 0; i < sides; i++)
1068 e.get(i, f)->pieces[k] = Piece(i ? *data >> 4 : *data & 0xF);
1070 for (int i = 0; i < sides; ++i)
1071 set_groups(e, e.get(i, f), order[i], f);
1074 data += (uintptr_t)data & 1; // Word alignment
1076 for (File f = FILE_A; f <= maxFile; ++f)
1077 for (int i = 0; i < sides; i++)
1078 data = set_sizes(e.get(i, f), data);
1080 data = set_dtz_map(e, data, maxFile);
1082 for (File f = FILE_A; f <= maxFile; ++f)
1083 for (int i = 0; i < sides; i++) {
1084 (d = e.get(i, f))->sparseIndex = (SparseEntry*)data;
1085 data += d->sparseIndexSize * sizeof(SparseEntry);
1088 for (File f = FILE_A; f <= maxFile; ++f)
1089 for (int i = 0; i < sides; i++) {
1090 (d = e.get(i, f))->blockLength = (uint16_t*)data;
1091 data += d->blockLengthSize * sizeof(uint16_t);
1094 for (File f = FILE_A; f <= maxFile; ++f)
1095 for (int i = 0; i < sides; i++) {
1096 data = (uint8_t*)(((uintptr_t)data + 0x3F) & ~0x3F); // 64 byte alignment
1097 (d = e.get(i, f))->data = data;
1098 data += d->blocksNum * d->sizeofBlock;
1102 // If the TB file corresponding to the given position is already memory mapped
1103 // then return its base address, otherwise try to memory map and init it. Called
1104 // at every probe, memory map and init only at first access. Function is thread
1105 // safe and can be called concurrently.
1106 template<TBType Type>
1107 void* mapped(TBTable<Type>& e, const Position& pos) {
1111 // Use 'acquire' to avoid a thread reading 'ready' == true while
1112 // another is still working. (compiler reordering may cause this).
1113 if (e.ready.load(std::memory_order_acquire))
1114 return e.baseAddress; // Could be nullptr if file does not exist
1116 std::unique_lock<Mutex> lk(mutex);
1118 if (e.ready.load(std::memory_order_relaxed)) // Recheck under lock
1119 return e.baseAddress;
1121 // Pieces strings in decreasing order for each color, like ("KPP","KR")
1122 std::string fname, w, b;
1123 for (PieceType pt = KING; pt >= PAWN; --pt) {
1124 w += std::string(popcount(pos.pieces(WHITE, pt)), PieceToChar[pt]);
1125 b += std::string(popcount(pos.pieces(BLACK, pt)), PieceToChar[pt]);
1128 fname = (e.key == pos.material_key() ? w + 'v' + b : b + 'v' + w)
1129 + (Type == WDL ? ".rtbw" : ".rtbz");
1131 uint8_t* data = TBFile(fname).map(&e.baseAddress, &e.mapping, Type);
1136 e.ready.store(true, std::memory_order_release);
1137 return e.baseAddress;
1140 template<TBType Type, typename Ret = typename TBTable<Type>::Ret>
1141 Ret probe_table(const Position& pos, ProbeState* result, WDLScore wdl = WDLDraw) {
1143 if (pos.count<ALL_PIECES>() == 2) // KvK
1144 return Ret(WDLDraw);
1146 TBTable<Type>* entry = TBTables.get<Type>(pos.material_key());
1148 if (!entry || !mapped(*entry, pos))
1149 return *result = FAIL, Ret();
1151 return do_probe_table(pos, entry, wdl, result);
1154 // For a position where the side to move has a winning capture it is not necessary
1155 // to store a winning value so the generator treats such positions as "don't cares"
1156 // and tries to assign to it a value that improves the compression ratio. Similarly,
1157 // if the side to move has a drawing capture, then the position is at least drawn.
1158 // If the position is won, then the TB needs to store a win value. But if the
1159 // position is drawn, the TB may store a loss value if that is better for compression.
1160 // All of this means that during probing, the engine must look at captures and probe
1161 // their results and must probe the position itself. The "best" result of these
1162 // probes is the correct result for the position.
1163 // DTZ tables do not store values when a following move is a zeroing winning move
1164 // (winning capture or winning pawn move). Also DTZ store wrong values for positions
1165 // where the best move is an ep-move (even if losing). So in all these cases set
1166 // the state to ZEROING_BEST_MOVE.
1167 template<bool CheckZeroingMoves>
1168 WDLScore search(Position& pos, ProbeState* result) {
1170 WDLScore value, bestValue = WDLLoss;
1173 auto moveList = MoveList<LEGAL>(pos);
1174 size_t totalCount = moveList.size(), moveCount = 0;
1176 for (const Move& move : moveList)
1178 if ( !pos.capture(move)
1179 && (!CheckZeroingMoves || type_of(pos.moved_piece(move)) != PAWN))
1184 pos.do_move(move, st);
1185 value = -search<false>(pos, result);
1186 pos.undo_move(move);
1188 if (*result == FAIL)
1191 if (value > bestValue)
1195 if (value >= WDLWin)
1197 *result = ZEROING_BEST_MOVE; // Winning DTZ-zeroing move
1203 // In case we have already searched all the legal moves we don't have to probe
1204 // the TB because the stored score could be wrong. For instance TB tables
1205 // do not contain information on position with ep rights, so in this case
1206 // the result of probe_wdl_table is wrong. Also in case of only capture
1207 // moves, for instance here 4K3/4q3/6p1/2k5/6p1/8/8/8 w - - 0 7, we have to
1208 // return with ZEROING_BEST_MOVE set.
1209 bool noMoreMoves = (moveCount && moveCount == totalCount);
1215 value = probe_table<WDL>(pos, result);
1217 if (*result == FAIL)
1221 // DTZ stores a "don't care" value if bestValue is a win
1222 if (bestValue >= value)
1223 return *result = ( bestValue > WDLDraw
1224 || noMoreMoves ? ZEROING_BEST_MOVE : OK), bestValue;
1226 return *result = OK, value;
1232 /// Tablebases::init() is called at startup and after every change to
1233 /// "SyzygyPath" UCI option to (re)create the various tables. It is not thread
1234 /// safe, nor it needs to be.
1235 void Tablebases::init(const std::string& paths) {
1239 TBFile::Paths = paths;
1241 if (paths.empty() || paths == "<empty>")
1244 // MapB1H1H7[] encodes a square below a1-h8 diagonal to 0..27
1246 for (Square s = SQ_A1; s <= SQ_H8; ++s)
1247 if (off_A1H8(s) < 0)
1248 MapB1H1H7[s] = code++;
1250 // MapA1D1D4[] encodes a square in the a1-d1-d4 triangle to 0..9
1251 std::vector<Square> diagonal;
1253 for (Square s = SQ_A1; s <= SQ_D4; ++s)
1254 if (off_A1H8(s) < 0 && file_of(s) <= FILE_D)
1255 MapA1D1D4[s] = code++;
1257 else if (!off_A1H8(s) && file_of(s) <= FILE_D)
1258 diagonal.push_back(s);
1260 // Diagonal squares are encoded as last ones
1261 for (auto s : diagonal)
1262 MapA1D1D4[s] = code++;
1264 // MapKK[] encodes all the 461 possible legal positions of two kings where
1265 // the first is in the a1-d1-d4 triangle. If the first king is on the a1-d4
1266 // diagonal, the other one shall not to be above the a1-h8 diagonal.
1267 std::vector<std::pair<int, Square>> bothOnDiagonal;
1269 for (int idx = 0; idx < 10; idx++)
1270 for (Square s1 = SQ_A1; s1 <= SQ_D4; ++s1)
1271 if (MapA1D1D4[s1] == idx && (idx || s1 == SQ_B1)) // SQ_B1 is mapped to 0
1273 for (Square s2 = SQ_A1; s2 <= SQ_H8; ++s2)
1274 if ((PseudoAttacks[KING][s1] | s1) & s2)
1275 continue; // Illegal position
1277 else if (!off_A1H8(s1) && off_A1H8(s2) > 0)
1278 continue; // First on diagonal, second above
1280 else if (!off_A1H8(s1) && !off_A1H8(s2))
1281 bothOnDiagonal.emplace_back(idx, s2);
1284 MapKK[idx][s2] = code++;
1287 // Legal positions with both kings on diagonal are encoded as last ones
1288 for (auto p : bothOnDiagonal)
1289 MapKK[p.first][p.second] = code++;
1291 // Binomial[] stores the Binomial Coefficents using Pascal rule. There
1292 // are Binomial[k][n] ways to choose k elements from a set of n elements.
1295 for (int n = 1; n < 64; n++) // Squares
1296 for (int k = 0; k < 6 && k <= n; ++k) // Pieces
1297 Binomial[k][n] = (k > 0 ? Binomial[k - 1][n - 1] : 0)
1298 + (k < n ? Binomial[k ][n - 1] : 0);
1300 // MapPawns[s] encodes squares a2-h7 to 0..47. This is the number of possible
1301 // available squares when the leading one is in 's'. Moreover the pawn with
1302 // highest MapPawns[] is the leading pawn, the one nearest the edge and,
1303 // among pawns with same file, the one with lowest rank.
1304 int availableSquares = 47; // Available squares when lead pawn is in a2
1306 // Init the tables for the encoding of leading pawns group: with 7-men TB we
1307 // can have up to 5 leading pawns (KPPPPPK).
1308 for (int leadPawnsCnt = 1; leadPawnsCnt <= 5; ++leadPawnsCnt)
1309 for (File f = FILE_A; f <= FILE_D; ++f)
1311 // Restart the index at every file because TB table is splitted
1312 // by file, so we can reuse the same index for different files.
1315 // Sum all possible combinations for a given file, starting with
1316 // the leading pawn on rank 2 and increasing the rank.
1317 for (Rank r = RANK_2; r <= RANK_7; ++r)
1319 Square sq = make_square(f, r);
1321 // Compute MapPawns[] at first pass.
1322 // If sq is the leading pawn square, any other pawn cannot be
1323 // below or more toward the edge of sq. There are 47 available
1324 // squares when sq = a2 and reduced by 2 for any rank increase
1325 // due to mirroring: sq == a3 -> no a2, h2, so MapPawns[a3] = 45
1326 if (leadPawnsCnt == 1)
1328 MapPawns[sq] = availableSquares--;
1329 MapPawns[sq ^ 7] = availableSquares--; // Horizontal flip
1331 LeadPawnIdx[leadPawnsCnt][sq] = idx;
1332 idx += Binomial[leadPawnsCnt - 1][MapPawns[sq]];
1334 // After a file is traversed, store the cumulated per-file index
1335 LeadPawnsSize[leadPawnsCnt][f] = idx;
1338 // Add entries in TB tables if the corresponding ".rtbw" file exsists
1339 for (PieceType p1 = PAWN; p1 < KING; ++p1) {
1340 TBTables.add({KING, p1, KING});
1342 for (PieceType p2 = PAWN; p2 <= p1; ++p2) {
1343 TBTables.add({KING, p1, p2, KING});
1344 TBTables.add({KING, p1, KING, p2});
1346 for (PieceType p3 = PAWN; p3 < KING; ++p3)
1347 TBTables.add({KING, p1, p2, KING, p3});
1349 for (PieceType p3 = PAWN; p3 <= p2; ++p3) {
1350 TBTables.add({KING, p1, p2, p3, KING});
1352 for (PieceType p4 = PAWN; p4 <= p3; ++p4) {
1353 TBTables.add({KING, p1, p2, p3, p4, KING});
1355 for (PieceType p5 = PAWN; p5 <= p4; ++p5)
1356 TBTables.add({KING, p1, p2, p3, p4, p5, KING});
1358 for (PieceType p5 = PAWN; p5 < KING; ++p5)
1359 TBTables.add({KING, p1, p2, p3, p4, KING, p5});
1362 for (PieceType p4 = PAWN; p4 < KING; ++p4) {
1363 TBTables.add({KING, p1, p2, p3, KING, p4});
1365 for (PieceType p5 = PAWN; p5 <= p4; ++p5)
1366 TBTables.add({KING, p1, p2, p3, KING, p4, p5});
1370 for (PieceType p3 = PAWN; p3 <= p1; ++p3)
1371 for (PieceType p4 = PAWN; p4 <= (p1 == p3 ? p2 : p3); ++p4)
1372 TBTables.add({KING, p1, p2, KING, p3, p4});
1376 sync_cout << "info string Found " << TBTables.size() << " tablebases" << sync_endl;
1379 // Probe the WDL table for a particular position.
1380 // If *result != FAIL, the probe was successful.
1381 // The return value is from the point of view of the side to move:
1383 // -1 : loss, but draw under 50-move rule
1385 // 1 : win, but draw under 50-move rule
1387 WDLScore Tablebases::probe_wdl(Position& pos, ProbeState* result) {
1390 return search<false>(pos, result);
1393 // Probe the DTZ table for a particular position.
1394 // If *result != FAIL, the probe was successful.
1395 // The return value is from the point of view of the side to move:
1396 // n < -100 : loss, but draw under 50-move rule
1397 // -100 <= n < -1 : loss in n ply (assuming 50-move counter == 0)
1398 // -1 : loss, the side to move is mated
1400 // 1 < n <= 100 : win in n ply (assuming 50-move counter == 0)
1401 // 100 < n : win, but draw under 50-move rule
1403 // The return value n can be off by 1: a return value -n can mean a loss
1404 // in n+1 ply and a return value +n can mean a win in n+1 ply. This
1405 // cannot happen for tables with positions exactly on the "edge" of
1406 // the 50-move rule.
1408 // This implies that if dtz > 0 is returned, the position is certainly
1409 // a win if dtz + 50-move-counter <= 99. Care must be taken that the engine
1410 // picks moves that preserve dtz + 50-move-counter <= 99.
1412 // If n = 100 immediately after a capture or pawn move, then the position
1413 // is also certainly a win, and during the whole phase until the next
1414 // capture or pawn move, the inequality to be preserved is
1415 // dtz + 50-movecounter <= 100.
1417 // In short, if a move is available resulting in dtz + 50-move-counter <= 99,
1418 // then do not accept moves leading to dtz + 50-move-counter == 100.
1419 int Tablebases::probe_dtz(Position& pos, ProbeState* result) {
1422 WDLScore wdl = search<true>(pos, result);
1424 if (*result == FAIL || wdl == WDLDraw) // DTZ tables don't store draws
1427 // DTZ stores a 'don't care' value in this case, or even a plain wrong
1428 // one as in case the best move is a losing ep, so it cannot be probed.
1429 if (*result == ZEROING_BEST_MOVE)
1430 return dtz_before_zeroing(wdl);
1432 int dtz = probe_table<DTZ>(pos, result, wdl);
1434 if (*result == FAIL)
1437 if (*result != CHANGE_STM)
1438 return (dtz + 100 * (wdl == WDLBlessedLoss || wdl == WDLCursedWin)) * sign_of(wdl);
1440 // DTZ stores results for the other side, so we need to do a 1-ply search and
1441 // find the winning move that minimizes DTZ.
1443 int minDTZ = 0xFFFF;
1445 for (const Move& move : MoveList<LEGAL>(pos))
1447 bool zeroing = pos.capture(move) || type_of(pos.moved_piece(move)) == PAWN;
1449 pos.do_move(move, st);
1451 // For zeroing moves we want the dtz of the move _before_ doing it,
1452 // otherwise we will get the dtz of the next move sequence. Search the
1453 // position after the move to get the score sign (because even in a
1454 // winning position we could make a losing capture or going for a draw).
1455 dtz = zeroing ? -dtz_before_zeroing(search<false>(pos, result))
1456 : -probe_dtz(pos, result);
1458 // If the move mates, force minDTZ to 1
1459 if (dtz == 1 && pos.checkers() && MoveList<LEGAL>(pos).size() == 0)
1462 // Convert result from 1-ply search. Zeroing moves are already accounted
1463 // by dtz_before_zeroing() that returns the DTZ of the previous move.
1465 dtz += sign_of(dtz);
1467 // Skip the draws and if we are winning only pick positive dtz
1468 if (dtz < minDTZ && sign_of(dtz) == sign_of(wdl))
1471 pos.undo_move(move);
1473 if (*result == FAIL)
1477 // When there are no legal moves, the position is mate: we return -1
1478 return minDTZ == 0xFFFF ? -1 : minDTZ;
1482 // Use the DTZ tables to rank root moves.
1484 // A return value false indicates that not all probes were successful.
1485 bool Tablebases::root_probe(Position& pos, Search::RootMoves& rootMoves) {
1490 // Obtain 50-move counter for the root position
1491 int cnt50 = pos.rule50_count();
1493 // Check whether a position was repeated since the last zeroing move.
1494 bool rep = pos.has_repeated();
1496 int dtz, bound = Options["Syzygy50MoveRule"] ? 900 : 1;
1498 // Probe and rank each move
1499 for (auto& m : rootMoves)
1501 pos.do_move(m.pv[0], st);
1503 // Calculate dtz for the current move counting from the root position
1504 if (pos.rule50_count() == 0)
1506 // In case of a zeroing move, dtz is one of -101/-1/0/1/101
1507 WDLScore wdl = -probe_wdl(pos, &result);
1508 dtz = dtz_before_zeroing(wdl);
1512 // Otherwise, take dtz for the new position and correct by 1 ply
1513 dtz = -probe_dtz(pos, &result);
1514 dtz = dtz > 0 ? dtz + 1
1515 : dtz < 0 ? dtz - 1 : dtz;
1518 // Make sure that a mating move is assigned a dtz value of 1
1521 && MoveList<LEGAL>(pos).size() == 0)
1524 pos.undo_move(m.pv[0]);
1529 // Better moves are ranked higher. Certain wins are ranked equally.
1530 // Losing moves are ranked equally unless a 50-move draw is in sight.
1531 int r = dtz > 0 ? (dtz + cnt50 <= 99 && !rep ? 1000 : 1000 - (dtz + cnt50))
1532 : dtz < 0 ? (-dtz * 2 + cnt50 < 100 ? -1000 : -1000 + (-dtz + cnt50))
1536 // Determine the score to be displayed for this move. Assign at least
1537 // 1 cp to cursed wins and let it grow to 49 cp as the positions gets
1538 // closer to a real win.
1539 m.tbScore = r >= bound ? VALUE_MATE - MAX_PLY - 1
1540 : r > 0 ? Value((std::max( 3, r - 800) * int(PawnValueEg)) / 200)
1541 : r == 0 ? VALUE_DRAW
1542 : r > -bound ? Value((std::min(-3, r + 800) * int(PawnValueEg)) / 200)
1543 : -VALUE_MATE + MAX_PLY + 1;
1550 // Use the WDL tables to rank root moves.
1551 // This is a fallback for the case that some or all DTZ tables are missing.
1553 // A return value false indicates that not all probes were successful.
1554 bool Tablebases::root_probe_wdl(Position& pos, Search::RootMoves& rootMoves) {
1556 static const int WDL_to_rank[] = { -1000, -899, 0, 899, 1000 };
1561 bool rule50 = Options["Syzygy50MoveRule"];
1563 // Probe and rank each move
1564 for (auto& m : rootMoves)
1566 pos.do_move(m.pv[0], st);
1568 WDLScore wdl = -probe_wdl(pos, &result);
1570 pos.undo_move(m.pv[0]);
1575 m.tbRank = WDL_to_rank[wdl + 2];
1578 wdl = wdl > WDLDraw ? WDLWin
1579 : wdl < WDLDraw ? WDLLoss : WDLDraw;
1580 m.tbScore = WDL_to_value[wdl + 2];