Fix reported DTZ for mate-in-1-ply positions
[stockfish] / src / syzygy / tbprobe.cpp
1 /*
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
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   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.
15
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/>.
18 */
19
20 #include <algorithm>
21 #include <atomic>
22 #include <cstdint>
23 #include <cstring>   // For std::memset and std::memcpy
24 #include <deque>
25 #include <fstream>
26 #include <iostream>
27 #include <list>
28 #include <sstream>
29 #include <type_traits>
30
31 #include "../bitboard.h"
32 #include "../movegen.h"
33 #include "../position.h"
34 #include "../search.h"
35 #include "../thread_win32.h"
36 #include "../types.h"
37
38 #include "tbprobe.h"
39
40 #ifndef _WIN32
41 #include <fcntl.h>
42 #include <unistd.h>
43 #include <sys/mman.h>
44 #include <sys/stat.h>
45 #else
46 #define WIN32_LEAN_AND_MEAN
47 #define NOMINMAX
48 #include <windows.h>
49 #endif
50
51 using namespace Tablebases;
52
53 int Tablebases::MaxCardinality;
54
55 namespace {
56
57 constexpr int TBPIECES = 6; // Max number of supported pieces
58
59 enum { BigEndian, LittleEndian };
60 enum TBType { KEY, WDL, DTZ }; // Used as template parameter
61
62 // Each table has a set of flags: all of them refer to DTZ tables, the last one to WDL tables
63 enum TBFlag { STM = 1, Mapped = 2, WinPlies = 4, LossPlies = 8, SingleValue = 128 };
64
65 inline WDLScore operator-(WDLScore d) { return WDLScore(-int(d)); }
66 inline Square operator^=(Square& s, int i) { return s = Square(int(s) ^ i); }
67 inline Square operator^(Square s, int i) { return Square(int(s) ^ i); }
68
69 const std::string PieceToChar = " PNBRQK  pnbrqk";
70
71 int MapPawns[SQUARE_NB];
72 int MapB1H1H7[SQUARE_NB];
73 int MapA1D1D4[SQUARE_NB];
74 int MapKK[10][SQUARE_NB]; // [MapA1D1D4][SQUARE_NB]
75
76 int Binomial[6][SQUARE_NB];    // [k][n] k elements from a set of n elements
77 int LeadPawnIdx[5][SQUARE_NB]; // [leadPawnsCnt][SQUARE_NB]
78 int LeadPawnsSize[5][4];       // [leadPawnsCnt][FILE_A..FILE_D]
79
80 // Comparison function to sort leading pawns in ascending MapPawns[] order
81 bool pawns_comp(Square i, Square j) { return MapPawns[i] < MapPawns[j]; }
82 int off_A1H8(Square sq) { return int(rank_of(sq)) - file_of(sq); }
83
84 constexpr Value WDL_to_value[] = {
85    -VALUE_MATE + MAX_PLY + 1,
86     VALUE_DRAW - 2,
87     VALUE_DRAW,
88     VALUE_DRAW + 2,
89     VALUE_MATE - MAX_PLY - 1
90 };
91
92 template<typename T, int Half = sizeof(T) / 2, int End = sizeof(T) - 1>
93 inline void swap_endian(T& x)
94 {
95     static_assert(std::is_unsigned<T>::value, "Argument of swap_endian not unsigned");
96
97     uint8_t tmp, *c = (uint8_t*)&x;
98     for (int i = 0; i < Half; ++i)
99         tmp = c[i], c[i] = c[End - i], c[End - i] = tmp;
100 }
101 template<> inline void swap_endian<uint8_t>(uint8_t&) {}
102
103 template<typename T, int LE> T number(void* addr)
104 {
105     static const union { uint32_t i; char c[4]; } Le = { 0x01020304 };
106     static const bool IsLittleEndian = (Le.c[0] == 4);
107
108     T v;
109
110     if ((uintptr_t)addr & (alignof(T) - 1)) // Unaligned pointer (very rare)
111         std::memcpy(&v, addr, sizeof(T));
112     else
113         v = *((T*)addr);
114
115     if (LE != IsLittleEndian)
116         swap_endian(v);
117     return v;
118 }
119
120 // DTZ tables don't store valid scores for moves that reset the rule50 counter
121 // like captures and pawn moves but we can easily recover the correct dtz of the
122 // previous move if we know the position's WDL score.
123 int dtz_before_zeroing(WDLScore wdl) {
124     return wdl == WDLWin         ?  1   :
125            wdl == WDLCursedWin   ?  101 :
126            wdl == WDLBlessedLoss ? -101 :
127            wdl == WDLLoss        ? -1   : 0;
128 }
129
130 // Return the sign of a number (-1, 0, 1)
131 template <typename T> int sign_of(T val) {
132     return (T(0) < val) - (val < T(0));
133 }
134
135 // Numbers in little endian used by sparseIndex[] to point into blockLength[]
136 struct SparseEntry {
137     char block[4];   // Number of block
138     char offset[2];  // Offset within the block
139 };
140
141 static_assert(sizeof(SparseEntry) == 6, "SparseEntry must be 6 bytes");
142
143 typedef uint16_t Sym; // Huffman symbol
144
145 struct LR {
146     enum Side { Left, Right, Value };
147
148     uint8_t lr[3]; // The first 12 bits is the left-hand symbol, the second 12
149                    // bits is the right-hand symbol. If symbol has length 1,
150                    // then the first byte is the stored value.
151     template<Side S>
152     Sym get() {
153         return S == Left  ? ((lr[1] & 0xF) << 8) | lr[0] :
154                S == Right ?  (lr[2] << 4) | (lr[1] >> 4) :
155                S == Value ?   lr[0] : (assert(false), Sym(-1));
156     }
157 };
158
159 static_assert(sizeof(LR) == 3, "LR tree entry must be 3 bytes");
160
161 // Tablebases data layout is structured as following:
162 //
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
166
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 {
171
172     std::string fname;
173
174 public:
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.
178     //
179     // Example:
180     // C:\tb\wdl345;C:\tb\wdl6;D:\tb\dtz345;D:\tb\dtz6
181     static std::string Paths;
182
183     TBFile(const std::string& f) {
184
185 #ifndef _WIN32
186         constexpr char SepChar = ':';
187 #else
188         constexpr char SepChar = ';';
189 #endif
190         std::stringstream ss(Paths);
191         std::string path;
192
193         while (std::getline(ss, path, SepChar)) {
194             fname = path + "/" + f;
195             std::ifstream::open(fname);
196             if (is_open())
197                 return;
198         }
199     }
200
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) {
204
205         assert(is_open());
206
207         close(); // Need to re-open to get native file descriptor
208
209 #ifndef _WIN32
210         struct stat statbuf;
211         int fd = ::open(fname.c_str(), O_RDONLY);
212
213         if (fd == -1)
214             return *baseAddress = nullptr, nullptr;
215
216         fstat(fd, &statbuf);
217         *mapping = statbuf.st_size;
218         *baseAddress = mmap(nullptr, statbuf.st_size, PROT_READ, MAP_SHARED, fd, 0);
219         ::close(fd);
220
221         if (*baseAddress == MAP_FAILED) {
222             std::cerr << "Could not mmap() " << fname << std::endl;
223             exit(1);
224         }
225 #else
226         HANDLE fd = CreateFile(fname.c_str(), GENERIC_READ, FILE_SHARE_READ, nullptr,
227                                OPEN_EXISTING, FILE_ATTRIBUTE_NORMAL, nullptr);
228
229         if (fd == INVALID_HANDLE_VALUE)
230             return *baseAddress = nullptr, nullptr;
231
232         DWORD size_high;
233         DWORD size_low = GetFileSize(fd, &size_high);
234         HANDLE mmap = CreateFileMapping(fd, nullptr, PAGE_READONLY, size_high, size_low, nullptr);
235         CloseHandle(fd);
236
237         if (!mmap) {
238             std::cerr << "CreateFileMapping() failed" << std::endl;
239             exit(1);
240         }
241
242         *mapping = (uint64_t)mmap;
243         *baseAddress = MapViewOfFile(mmap, FILE_MAP_READ, 0, 0, 0);
244
245         if (!*baseAddress) {
246             std::cerr << "MapViewOfFile() failed, name = " << fname
247                       << ", error = " << GetLastError() << std::endl;
248             exit(1);
249         }
250 #endif
251         uint8_t* data = (uint8_t*)*baseAddress;
252
253         constexpr uint8_t Magics[][4] = { { 0xD7, 0x66, 0x0C, 0xA5 },
254                                           { 0x71, 0xE8, 0x23, 0x5D } };
255
256         if (memcmp(data, Magics[type == WDL], 4)) {
257             std::cerr << "Corrupted table in file " << fname << std::endl;
258             unmap(*baseAddress, *mapping);
259             return *baseAddress = nullptr, nullptr;
260         }
261
262         return data + 4; // Skip Magics's header
263     }
264
265     static void unmap(void* baseAddress, uint64_t mapping) {
266
267 #ifndef _WIN32
268         munmap(baseAddress, mapping);
269 #else
270         UnmapViewOfFile(baseAddress);
271         CloseHandle((HANDLE)mapping);
272 #endif
273     }
274 };
275
276 std::string TBFile::Paths;
277
278 // struct PairsData contains low level indexing information to access TB data.
279 // There are 8, 4 or 2 PairsData records for each TBTable, according to type of
280 // table and if positions have pawns or not. It is populated at first access.
281 struct PairsData {
282     uint8_t flags;                 // Table flags, see enum TBFlag
283     uint8_t maxSymLen;             // Maximum length in bits of the Huffman symbols
284     uint8_t minSymLen;             // Minimum length in bits of the Huffman symbols
285     uint32_t blocksNum;            // Number of blocks in the TB file
286     size_t sizeofBlock;            // Block size in bytes
287     size_t span;                   // About every span values there is a SparseIndex[] entry
288     Sym* lowestSym;                // lowestSym[l] is the symbol of length l with the lowest value
289     LR* btree;                     // btree[sym] stores the left and right symbols that expand sym
290     uint16_t* blockLength;         // Number of stored positions (minus one) for each block: 1..65536
291     uint32_t blockLengthSize;      // Size of blockLength[] table: padded so it's bigger than blocksNum
292     SparseEntry* sparseIndex;      // Partial indices into blockLength[]
293     size_t sparseIndexSize;        // Size of SparseIndex[] table
294     uint8_t* data;                 // Start of Huffman compressed data
295     std::vector<uint64_t> base64;  // base64[l - min_sym_len] is the 64bit-padded lowest symbol of length l
296     std::vector<uint8_t> symlen;   // Number of values (-1) represented by a given Huffman symbol: 1..256
297     Piece pieces[TBPIECES];        // Position pieces: the order of pieces defines the groups
298     uint64_t groupIdx[TBPIECES+1]; // Start index used for the encoding of the group's pieces
299     int groupLen[TBPIECES+1];      // Number of pieces in a given group: KRKN -> (3, 1)
300     uint16_t map_idx[4];           // WDLWin, WDLLoss, WDLCursedWin, WDLBlessedLoss (used in DTZ)
301 };
302
303 // struct TBTable contains indexing information to access the corresponding TBFile.
304 // There are 2 types of TBTable, corresponding to a WDL or a DTZ file. TBTable
305 // is populated at init time but the nested PairsData records are populated at
306 // first access, when the corresponding file is memory mapped.
307 template<TBType Type>
308 struct TBTable {
309     typedef typename std::conditional<Type == WDL, WDLScore, int>::type Ret;
310
311     static constexpr int Sides = Type == WDL ? 2 : 1;
312
313     std::atomic_bool ready;
314     void* baseAddress;
315     uint8_t* map;
316     uint64_t mapping;
317     Key key;
318     Key key2;
319     int pieceCount;
320     bool hasPawns;
321     bool hasUniquePieces;
322     uint8_t pawnCount[2]; // [Lead color / other color]
323     PairsData items[Sides][4]; // [wtm / btm][FILE_A..FILE_D or 0]
324
325     PairsData* get(int stm, int f) {
326         return &items[stm % Sides][hasPawns ? f : 0];
327     }
328
329     TBTable() : ready(false), baseAddress(nullptr) {}
330     explicit TBTable(const std::string& code);
331     explicit TBTable(const TBTable<WDL>& wdl);
332
333     ~TBTable() {
334         if (baseAddress)
335             TBFile::unmap(baseAddress, mapping);
336     }
337 };
338
339 template<>
340 TBTable<WDL>::TBTable(const std::string& code) : TBTable() {
341
342     StateInfo st;
343     Position pos;
344
345     key = pos.set(code, WHITE, &st).material_key();
346     pieceCount = pos.count<ALL_PIECES>();
347     hasPawns = pos.pieces(PAWN);
348
349     hasUniquePieces = false;
350     for (Color c = WHITE; c <= BLACK; ++c)
351         for (PieceType pt = PAWN; pt < KING; ++pt)
352             if (popcount(pos.pieces(c, pt)) == 1)
353                 hasUniquePieces = true;
354
355     // Set the leading color. In case both sides have pawns the leading color
356     // is the side with less pawns because this leads to better compression.
357     bool c =   !pos.count<PAWN>(BLACK)
358             || (   pos.count<PAWN>(WHITE)
359                 && pos.count<PAWN>(BLACK) >= pos.count<PAWN>(WHITE));
360
361     pawnCount[0] = pos.count<PAWN>(c ? WHITE : BLACK);
362     pawnCount[1] = pos.count<PAWN>(c ? BLACK : WHITE);
363
364     key2 = pos.set(code, BLACK, &st).material_key();
365 }
366
367 template<>
368 TBTable<DTZ>::TBTable(const TBTable<WDL>& wdl) : TBTable() {
369
370     // Use the corresponding WDL table to avoid recalculating all from scratch
371     key = wdl.key;
372     key2 = wdl.key2;
373     pieceCount = wdl.pieceCount;
374     hasPawns = wdl.hasPawns;
375     hasUniquePieces = wdl.hasUniquePieces;
376     pawnCount[0] = wdl.pawnCount[0];
377     pawnCount[1] = wdl.pawnCount[1];
378 }
379
380 // class TBTables creates and keeps ownership of the TBTable objects, one for
381 // each TB file found. It supports a fast, hash based, table lookup. Populated
382 // at init time, accessed at probe time.
383 class TBTables {
384
385     typedef std::tuple<Key, TBTable<WDL>*, TBTable<DTZ>*> Entry;
386
387     static const int Size = 1 << 12; // 4K table, indexed by key's 12 lsb
388
389     Entry hashTable[Size];
390
391     std::deque<TBTable<WDL>> wdlTable;
392     std::deque<TBTable<DTZ>> dtzTable;
393
394     void insert(Key key, TBTable<WDL>* wdl, TBTable<DTZ>* dtz) {
395         Entry* entry = &hashTable[(uint32_t)key & (Size - 1)];
396
397         // Ensure last element is empty to avoid overflow when looking up
398         for ( ; entry - hashTable < Size - 1; ++entry)
399             if (std::get<KEY>(*entry) == key || !std::get<WDL>(*entry)) {
400                 *entry = std::make_tuple(key, wdl, dtz);
401                 return;
402             }
403         std::cerr << "TB hash table size too low!" << std::endl;
404         exit(1);
405     }
406
407 public:
408     template<TBType Type>
409     TBTable<Type>* get(Key key) {
410         for (const Entry* entry = &hashTable[(uint32_t)key & (Size - 1)]; ; ++entry) {
411             if (std::get<KEY>(*entry) == key || !std::get<Type>(*entry))
412                 return std::get<Type>(*entry);
413         }
414     }
415
416     void clear() {
417         memset(hashTable, 0, sizeof(hashTable));
418         wdlTable.clear();
419         dtzTable.clear();
420     }
421     size_t size() const { return wdlTable.size(); }
422     void add(const std::vector<PieceType>& pieces);
423 };
424
425 TBTables TBTables;
426
427 // If the corresponding file exists two new objects TBTable<WDL> and TBTable<DTZ>
428 // are created and added to the lists and hash table. Called at init time.
429 void TBTables::add(const std::vector<PieceType>& pieces) {
430
431     std::string code;
432
433     for (PieceType pt : pieces)
434         code += PieceToChar[pt];
435
436     TBFile file(code.insert(code.find('K', 1), "v") + ".rtbw"); // KRK -> KRvK
437
438     if (!file.is_open()) // Only WDL file is checked
439         return;
440
441     file.close();
442
443     MaxCardinality = std::max((int)pieces.size(), MaxCardinality);
444
445     wdlTable.emplace_back(code);
446     dtzTable.emplace_back(wdlTable.back());
447
448     // Insert into the hash keys for both colors: KRvK with KR white and black
449     insert(wdlTable.back().key , &wdlTable.back(), &dtzTable.back());
450     insert(wdlTable.back().key2, &wdlTable.back(), &dtzTable.back());
451 }
452
453 // TB tables are compressed with canonical Huffman code. The compressed data is divided into
454 // blocks of size d->sizeofBlock, and each block stores a variable number of symbols.
455 // Each symbol represents either a WDL or a (remapped) DTZ value, or a pair of other symbols
456 // (recursively). If you keep expanding the symbols in a block, you end up with up to 65536
457 // WDL or DTZ values. Each symbol represents up to 256 values and will correspond after
458 // Huffman coding to at least 1 bit. So a block of 32 bytes corresponds to at most
459 // 32 x 8 x 256 = 65536 values. This maximum is only reached for tables that consist mostly
460 // of draws or mostly of wins, but such tables are actually quite common. In principle, the
461 // blocks in WDL tables are 64 bytes long (and will be aligned on cache lines). But for
462 // mostly-draw or mostly-win tables this can leave many 64-byte blocks only half-filled, so
463 // in such cases blocks are 32 bytes long. The blocks of DTZ tables are up to 1024 bytes long.
464 // The generator picks the size that leads to the smallest table. The "book" of symbols and
465 // Huffman codes is the same for all blocks in the table. A non-symmetric pawnless TB file
466 // will have one table for wtm and one for btm, a TB file with pawns will have tables per
467 // file a,b,c,d also in this case one set for wtm and one for btm.
468 int decompress_pairs(PairsData* d, uint64_t idx) {
469
470     // Special case where all table positions store the same value
471     if (d->flags & TBFlag::SingleValue)
472         return d->minSymLen;
473
474     // First we need to locate the right block that stores the value at index "idx".
475     // Because each block n stores blockLength[n] + 1 values, the index i of the block
476     // that contains the value at position idx is:
477     //
478     //                    for (i = -1, sum = 0; sum <= idx; i++)
479     //                        sum += blockLength[i + 1] + 1;
480     //
481     // This can be slow, so we use SparseIndex[] populated with a set of SparseEntry that
482     // point to known indices into blockLength[]. Namely SparseIndex[k] is a SparseEntry
483     // that stores the blockLength[] index and the offset within that block of the value
484     // with index I(k), where:
485     //
486     //       I(k) = k * d->span + d->span / 2      (1)
487
488     // First step is to get the 'k' of the I(k) nearest to our idx, using definition (1)
489     uint32_t k = idx / d->span;
490
491     // Then we read the corresponding SparseIndex[] entry
492     uint32_t block = number<uint32_t, LittleEndian>(&d->sparseIndex[k].block);
493     int offset     = number<uint16_t, LittleEndian>(&d->sparseIndex[k].offset);
494
495     // Now compute the difference idx - I(k). From definition of k we know that
496     //
497     //       idx = k * d->span + idx % d->span    (2)
498     //
499     // So from (1) and (2) we can compute idx - I(K):
500     int diff = idx % d->span - d->span / 2;
501
502     // Sum the above to offset to find the offset corresponding to our idx
503     offset += diff;
504
505     // Move to previous/next block, until we reach the correct block that contains idx,
506     // that is when 0 <= offset <= d->blockLength[block]
507     while (offset < 0)
508         offset += d->blockLength[--block] + 1;
509
510     while (offset > d->blockLength[block])
511         offset -= d->blockLength[block++] + 1;
512
513     // Finally, we find the start address of our block of canonical Huffman symbols
514     uint32_t* ptr = (uint32_t*)(d->data + block * d->sizeofBlock);
515
516     // Read the first 64 bits in our block, this is a (truncated) sequence of
517     // unknown number of symbols of unknown length but we know the first one
518     // is at the beginning of this 64 bits sequence.
519     uint64_t buf64 = number<uint64_t, BigEndian>(ptr); ptr += 2;
520     int buf64Size = 64;
521     Sym sym;
522
523     while (true) {
524         int len = 0; // This is the symbol length - d->min_sym_len
525
526         // Now get the symbol length. For any symbol s64 of length l right-padded
527         // to 64 bits we know that d->base64[l-1] >= s64 >= d->base64[l] so we
528         // can find the symbol length iterating through base64[].
529         while (buf64 < d->base64[len])
530             ++len;
531
532         // All the symbols of a given length are consecutive integers (numerical
533         // sequence property), so we can compute the offset of our symbol of
534         // length len, stored at the beginning of buf64.
535         sym = (buf64 - d->base64[len]) >> (64 - len - d->minSymLen);
536
537         // Now add the value of the lowest symbol of length len to get our symbol
538         sym += number<Sym, LittleEndian>(&d->lowestSym[len]);
539
540         // If our offset is within the number of values represented by symbol sym
541         // we are done...
542         if (offset < d->symlen[sym] + 1)
543             break;
544
545         // ...otherwise update the offset and continue to iterate
546         offset -= d->symlen[sym] + 1;
547         len += d->minSymLen; // Get the real length
548         buf64 <<= len;       // Consume the just processed symbol
549         buf64Size -= len;
550
551         if (buf64Size <= 32) { // Refill the buffer
552             buf64Size += 32;
553             buf64 |= (uint64_t)number<uint32_t, BigEndian>(ptr++) << (64 - buf64Size);
554         }
555     }
556
557     // Ok, now we have our symbol that expands into d->symlen[sym] + 1 symbols.
558     // We binary-search for our value recursively expanding into the left and
559     // right child symbols until we reach a leaf node where symlen[sym] + 1 == 1
560     // that will store the value we need.
561     while (d->symlen[sym]) {
562
563         Sym left = d->btree[sym].get<LR::Left>();
564
565         // If a symbol contains 36 sub-symbols (d->symlen[sym] + 1 = 36) and
566         // expands in a pair (d->symlen[left] = 23, d->symlen[right] = 11), then
567         // we know that, for instance the ten-th value (offset = 10) will be on
568         // the left side because in Recursive Pairing child symbols are adjacent.
569         if (offset < d->symlen[left] + 1)
570             sym = left;
571         else {
572             offset -= d->symlen[left] + 1;
573             sym = d->btree[sym].get<LR::Right>();
574         }
575     }
576
577     return d->btree[sym].get<LR::Value>();
578 }
579
580 bool check_dtz_stm(TBTable<WDL>*, int, File) { return true; }
581
582 bool check_dtz_stm(TBTable<DTZ>* entry, int stm, File f) {
583
584     auto flags = entry->get(stm, f)->flags;
585     return   (flags & TBFlag::STM) == stm
586           || ((entry->key == entry->key2) && !entry->hasPawns);
587 }
588
589 // DTZ scores are sorted by frequency of occurrence and then assigned the
590 // values 0, 1, 2, ... in order of decreasing frequency. This is done for each
591 // of the four WDLScore values. The mapping information necessary to reconstruct
592 // the original values is stored in the TB file and read during map[] init.
593 WDLScore map_score(TBTable<WDL>*, File, int value, WDLScore) { return WDLScore(value - 2); }
594
595 int map_score(TBTable<DTZ>* entry, File f, int value, WDLScore wdl) {
596
597     constexpr int WDLMap[] = { 1, 3, 0, 2, 0 };
598
599     auto flags = entry->get(0, f)->flags;
600
601     uint8_t* map = entry->map;
602     uint16_t* idx = entry->get(0, f)->map_idx;
603     if (flags & TBFlag::Mapped)
604         value = map[idx[WDLMap[wdl + 2]] + value];
605
606     // DTZ tables store distance to zero in number of moves or plies. We
607     // want to return plies, so we have convert to plies when needed.
608     if (   (wdl == WDLWin  && !(flags & TBFlag::WinPlies))
609         || (wdl == WDLLoss && !(flags & TBFlag::LossPlies))
610         ||  wdl == WDLCursedWin
611         ||  wdl == WDLBlessedLoss)
612         value *= 2;
613
614     return value + 1;
615 }
616
617 // Compute a unique index out of a position and use it to probe the TB file. To
618 // encode k pieces of same type and color, first sort the pieces by square in
619 // ascending order s1 <= s2 <= ... <= sk then compute the unique index as:
620 //
621 //      idx = Binomial[1][s1] + Binomial[2][s2] + ... + Binomial[k][sk]
622 //
623 template<typename T, typename Ret = typename T::Ret>
624 Ret do_probe_table(const Position& pos, T* entry, WDLScore wdl, ProbeState* result) {
625
626     Square squares[TBPIECES];
627     Piece pieces[TBPIECES];
628     uint64_t idx;
629     int next = 0, size = 0, leadPawnsCnt = 0;
630     PairsData* d;
631     Bitboard b, leadPawns = 0;
632     File tbFile = FILE_A;
633
634     // A given TB entry like KRK has associated two material keys: KRvk and Kvkr.
635     // If both sides have the same pieces keys are equal. In this case TB tables
636     // only store the 'white to move' case, so if the position to lookup has black
637     // to move, we need to switch the color and flip the squares before to lookup.
638     bool symmetricBlackToMove = (entry->key == entry->key2 && pos.side_to_move());
639
640     // TB files are calculated for white as stronger side. For instance we have
641     // KRvK, not KvKR. A position where stronger side is white will have its
642     // material key == entry->key, otherwise we have to switch the color and
643     // flip the squares before to lookup.
644     bool blackStronger = (pos.material_key() != entry->key);
645
646     int flipColor   = (symmetricBlackToMove || blackStronger) * 8;
647     int flipSquares = (symmetricBlackToMove || blackStronger) * 070;
648     int stm         = (symmetricBlackToMove || blackStronger) ^ pos.side_to_move();
649
650     // For pawns, TB files store 4 separate tables according if leading pawn is on
651     // file a, b, c or d after reordering. The leading pawn is the one with maximum
652     // MapPawns[] value, that is the one most toward the edges and with lowest rank.
653     if (entry->hasPawns) {
654
655         // In all the 4 tables, pawns are at the beginning of the piece sequence and
656         // their color is the reference one. So we just pick the first one.
657         Piece pc = Piece(entry->get(0, 0)->pieces[0] ^ flipColor);
658
659         assert(type_of(pc) == PAWN);
660
661         leadPawns = b = pos.pieces(color_of(pc), PAWN);
662         do
663             squares[size++] = pop_lsb(&b) ^ flipSquares;
664         while (b);
665
666         leadPawnsCnt = size;
667
668         std::swap(squares[0], *std::max_element(squares, squares + leadPawnsCnt, pawns_comp));
669
670         tbFile = file_of(squares[0]);
671         if (tbFile > FILE_D)
672             tbFile = file_of(squares[0] ^ 7); // Horizontal flip: SQ_H1 -> SQ_A1
673     }
674
675     // DTZ tables are one-sided, i.e. they store positions only for white to
676     // move or only for black to move, so check for side to move to be stm,
677     // early exit otherwise.
678     if (!check_dtz_stm(entry, stm, tbFile))
679         return *result = CHANGE_STM, Ret();
680
681     // Now we are ready to get all the position pieces (but the lead pawns) and
682     // directly map them to the correct color and square.
683     b = pos.pieces() ^ leadPawns;
684     do {
685         Square s = pop_lsb(&b);
686         squares[size] = s ^ flipSquares;
687         pieces[size++] = Piece(pos.piece_on(s) ^ flipColor);
688     } while (b);
689
690     assert(size >= 2);
691
692     d = entry->get(stm, tbFile);
693
694     // Then we reorder the pieces to have the same sequence as the one stored
695     // in pieces[i]: the sequence that ensures the best compression.
696     for (int i = leadPawnsCnt; i < size; ++i)
697         for (int j = i; j < size; ++j)
698             if (d->pieces[i] == pieces[j])
699             {
700                 std::swap(pieces[i], pieces[j]);
701                 std::swap(squares[i], squares[j]);
702                 break;
703             }
704
705     // Now we map again the squares so that the square of the lead piece is in
706     // the triangle A1-D1-D4.
707     if (file_of(squares[0]) > FILE_D)
708         for (int i = 0; i < size; ++i)
709             squares[i] ^= 7; // Horizontal flip: SQ_H1 -> SQ_A1
710
711     // Encode leading pawns starting with the one with minimum MapPawns[] and
712     // proceeding in ascending order.
713     if (entry->hasPawns) {
714         idx = LeadPawnIdx[leadPawnsCnt][squares[0]];
715
716         std::sort(squares + 1, squares + leadPawnsCnt, pawns_comp);
717
718         for (int i = 1; i < leadPawnsCnt; ++i)
719             idx += Binomial[i][MapPawns[squares[i]]];
720
721         goto encode_remaining; // With pawns we have finished special treatments
722     }
723
724     // In positions withouth pawns, we further flip the squares to ensure leading
725     // piece is below RANK_5.
726     if (rank_of(squares[0]) > RANK_4)
727         for (int i = 0; i < size; ++i)
728             squares[i] ^= 070; // Vertical flip: SQ_A8 -> SQ_A1
729
730     // Look for the first piece of the leading group not on the A1-D4 diagonal
731     // and ensure it is mapped below the diagonal.
732     for (int i = 0; i < d->groupLen[0]; ++i) {
733         if (!off_A1H8(squares[i]))
734             continue;
735
736         if (off_A1H8(squares[i]) > 0) // A1-H8 diagonal flip: SQ_A3 -> SQ_C3
737             for (int j = i; j < size; ++j)
738                 squares[j] = Square(((squares[j] >> 3) | (squares[j] << 3)) & 63);
739         break;
740     }
741
742     // Encode the leading group.
743     //
744     // Suppose we have KRvK. Let's say the pieces are on square numbers wK, wR
745     // and bK (each 0...63). The simplest way to map this position to an index
746     // is like this:
747     //
748     //   index = wK * 64 * 64 + wR * 64 + bK;
749     //
750     // But this way the TB is going to have 64*64*64 = 262144 positions, with
751     // lots of positions being equivalent (because they are mirrors of each
752     // other) and lots of positions being invalid (two pieces on one square,
753     // adjacent kings, etc.).
754     // Usually the first step is to take the wK and bK together. There are just
755     // 462 ways legal and not-mirrored ways to place the wK and bK on the board.
756     // Once we have placed the wK and bK, there are 62 squares left for the wR
757     // Mapping its square from 0..63 to available squares 0..61 can be done like:
758     //
759     //   wR -= (wR > wK) + (wR > bK);
760     //
761     // In words: if wR "comes later" than wK, we deduct 1, and the same if wR
762     // "comes later" than bK. In case of two same pieces like KRRvK we want to
763     // place the two Rs "together". If we have 62 squares left, we can place two
764     // Rs "together" in 62 * 61 / 2 ways (we divide by 2 because rooks can be
765     // swapped and still get the same position.)
766     //
767     // In case we have at least 3 unique pieces (inlcuded kings) we encode them
768     // together.
769     if (entry->hasUniquePieces) {
770
771         int adjust1 =  squares[1] > squares[0];
772         int adjust2 = (squares[2] > squares[0]) + (squares[2] > squares[1]);
773
774         // First piece is below a1-h8 diagonal. MapA1D1D4[] maps the b1-d1-d3
775         // triangle to 0...5. There are 63 squares for second piece and and 62
776         // (mapped to 0...61) for the third.
777         if (off_A1H8(squares[0]))
778             idx = (   MapA1D1D4[squares[0]]  * 63
779                    + (squares[1] - adjust1)) * 62
780                    +  squares[2] - adjust2;
781
782         // First piece is on a1-h8 diagonal, second below: map this occurence to
783         // 6 to differentiate from the above case, rank_of() maps a1-d4 diagonal
784         // to 0...3 and finally MapB1H1H7[] maps the b1-h1-h7 triangle to 0..27.
785         else if (off_A1H8(squares[1]))
786             idx = (  6 * 63 + rank_of(squares[0]) * 28
787                    + MapB1H1H7[squares[1]])       * 62
788                    + squares[2] - adjust2;
789
790         // First two pieces are on a1-h8 diagonal, third below
791         else if (off_A1H8(squares[2]))
792             idx =  6 * 63 * 62 + 4 * 28 * 62
793                  +  rank_of(squares[0])        * 7 * 28
794                  + (rank_of(squares[1]) - adjust1) * 28
795                  +  MapB1H1H7[squares[2]];
796
797         // All 3 pieces on the diagonal a1-h8
798         else
799             idx = 6 * 63 * 62 + 4 * 28 * 62 + 4 * 7 * 28
800                  +  rank_of(squares[0])         * 7 * 6
801                  + (rank_of(squares[1]) - adjust1)  * 6
802                  + (rank_of(squares[2]) - adjust2);
803     } else
804         // We don't have at least 3 unique pieces, like in KRRvKBB, just map
805         // the kings.
806         idx = MapKK[MapA1D1D4[squares[0]]][squares[1]];
807
808 encode_remaining:
809     idx *= d->groupIdx[0];
810     Square* groupSq = squares + d->groupLen[0];
811
812     // Encode remainig pawns then pieces according to square, in ascending order
813     bool remainingPawns = entry->hasPawns && entry->pawnCount[1];
814
815     while (d->groupLen[++next])
816     {
817         std::sort(groupSq, groupSq + d->groupLen[next]);
818         uint64_t n = 0;
819
820         // Map down a square if "comes later" than a square in the previous
821         // groups (similar to what done earlier for leading group pieces).
822         for (int i = 0; i < d->groupLen[next]; ++i)
823         {
824             auto f = [&](Square s) { return groupSq[i] > s; };
825             auto adjust = std::count_if(squares, groupSq, f);
826             n += Binomial[i + 1][groupSq[i] - adjust - 8 * remainingPawns];
827         }
828
829         remainingPawns = false;
830         idx += n * d->groupIdx[next];
831         groupSq += d->groupLen[next];
832     }
833
834     // Now that we have the index, decompress the pair and get the score
835     return map_score(entry, tbFile, decompress_pairs(d, idx), wdl);
836 }
837
838 // Group together pieces that will be encoded together. The general rule is that
839 // a group contains pieces of same type and color. The exception is the leading
840 // group that, in case of positions withouth pawns, can be formed by 3 different
841 // pieces (default) or by the king pair when there is not a unique piece apart
842 // from the kings. When there are pawns, pawns are always first in pieces[].
843 //
844 // As example KRKN -> KRK + N, KNNK -> KK + NN, KPPKP -> P + PP + K + K
845 //
846 // The actual grouping depends on the TB generator and can be inferred from the
847 // sequence of pieces in piece[] array.
848 template<typename T>
849 void set_groups(T& e, PairsData* d, int order[], File f) {
850
851     int n = 0, firstLen = e.hasPawns ? 0 : e.hasUniquePieces ? 3 : 2;
852     d->groupLen[n] = 1;
853
854     // Number of pieces per group is stored in groupLen[], for instance in KRKN
855     // the encoder will default on '111', so groupLen[] will be (3, 1).
856     for (int i = 1; i < e.pieceCount; ++i)
857         if (--firstLen > 0 || d->pieces[i] == d->pieces[i - 1])
858             d->groupLen[n]++;
859         else
860             d->groupLen[++n] = 1;
861
862     d->groupLen[++n] = 0; // Zero-terminated
863
864     // The sequence in pieces[] defines the groups, but not the order in which
865     // they are encoded. If the pieces in a group g can be combined on the board
866     // in N(g) different ways, then the position encoding will be of the form:
867     //
868     //           g1 * N(g2) * N(g3) + g2 * N(g3) + g3
869     //
870     // This ensures unique encoding for the whole position. The order of the
871     // groups is a per-table parameter and could not follow the canonical leading
872     // pawns/pieces -> remainig pawns -> remaining pieces. In particular the
873     // first group is at order[0] position and the remaining pawns, when present,
874     // are at order[1] position.
875     bool pp = e.hasPawns && e.pawnCount[1]; // Pawns on both sides
876     int next = pp ? 2 : 1;
877     int freeSquares = 64 - d->groupLen[0] - (pp ? d->groupLen[1] : 0);
878     uint64_t idx = 1;
879
880     for (int k = 0; next < n || k == order[0] || k == order[1]; ++k)
881         if (k == order[0]) // Leading pawns or pieces
882         {
883             d->groupIdx[0] = idx;
884             idx *=         e.hasPawns ? LeadPawnsSize[d->groupLen[0]][f]
885                   : e.hasUniquePieces ? 31332 : 462;
886         }
887         else if (k == order[1]) // Remaining pawns
888         {
889             d->groupIdx[1] = idx;
890             idx *= Binomial[d->groupLen[1]][48 - d->groupLen[0]];
891         }
892         else // Remainig pieces
893         {
894             d->groupIdx[next] = idx;
895             idx *= Binomial[d->groupLen[next]][freeSquares];
896             freeSquares -= d->groupLen[next++];
897         }
898
899     d->groupIdx[n] = idx;
900 }
901
902 // In Recursive Pairing each symbol represents a pair of childern symbols. So
903 // read d->btree[] symbols data and expand each one in his left and right child
904 // symbol until reaching the leafs that represent the symbol value.
905 uint8_t set_symlen(PairsData* d, Sym s, std::vector<bool>& visited) {
906
907     visited[s] = true; // We can set it now because tree is acyclic
908     Sym sr = d->btree[s].get<LR::Right>();
909
910     if (sr == 0xFFF)
911         return 0;
912
913     Sym sl = d->btree[s].get<LR::Left>();
914
915     if (!visited[sl])
916         d->symlen[sl] = set_symlen(d, sl, visited);
917
918     if (!visited[sr])
919         d->symlen[sr] = set_symlen(d, sr, visited);
920
921     return d->symlen[sl] + d->symlen[sr] + 1;
922 }
923
924 uint8_t* set_sizes(PairsData* d, uint8_t* data) {
925
926     d->flags = *data++;
927
928     if (d->flags & TBFlag::SingleValue) {
929         d->blocksNum = d->blockLengthSize = 0;
930         d->span = d->sparseIndexSize = 0; // Broken MSVC zero-init
931         d->minSymLen = *data++; // Here we store the single value
932         return data;
933     }
934
935     // groupLen[] is a zero-terminated list of group lengths, the last groupIdx[]
936     // element stores the biggest index that is the tb size.
937     uint64_t tbSize = d->groupIdx[std::find(d->groupLen, d->groupLen + 7, 0) - d->groupLen];
938
939     d->sizeofBlock = 1ULL << *data++;
940     d->span = 1ULL << *data++;
941     d->sparseIndexSize = (tbSize + d->span - 1) / d->span; // Round up
942     auto padding = number<uint8_t, LittleEndian>(data++);
943     d->blocksNum = number<uint32_t, LittleEndian>(data); data += sizeof(uint32_t);
944     d->blockLengthSize = d->blocksNum + padding; // Padded to ensure SparseIndex[]
945                                                  // does not point out of range.
946     d->maxSymLen = *data++;
947     d->minSymLen = *data++;
948     d->lowestSym = (Sym*)data;
949     d->base64.resize(d->maxSymLen - d->minSymLen + 1);
950
951     // The canonical code is ordered such that longer symbols (in terms of
952     // the number of bits of their Huffman code) have lower numeric value,
953     // so that d->lowestSym[i] >= d->lowestSym[i+1] (when read as LittleEndian).
954     // Starting from this we compute a base64[] table indexed by symbol length
955     // and containing 64 bit values so that d->base64[i] >= d->base64[i+1].
956     // See http://www.eecs.harvard.edu/~michaelm/E210/huffman.pdf
957     for (int i = d->base64.size() - 2; i >= 0; --i) {
958         d->base64[i] = (d->base64[i + 1] + number<Sym, LittleEndian>(&d->lowestSym[i])
959                                          - number<Sym, LittleEndian>(&d->lowestSym[i + 1])) / 2;
960
961         assert(d->base64[i] * 2 >= d->base64[i+1]);
962     }
963
964     // Now left-shift by an amount so that d->base64[i] gets shifted 1 bit more
965     // than d->base64[i+1] and given the above assert condition, we ensure that
966     // d->base64[i] >= d->base64[i+1]. Moreover for any symbol s64 of length i
967     // and right-padded to 64 bits holds d->base64[i-1] >= s64 >= d->base64[i].
968     for (size_t i = 0; i < d->base64.size(); ++i)
969         d->base64[i] <<= 64 - i - d->minSymLen; // Right-padding to 64 bits
970
971     data += d->base64.size() * sizeof(Sym);
972     d->symlen.resize(number<uint16_t, LittleEndian>(data)); data += sizeof(uint16_t);
973     d->btree = (LR*)data;
974
975     // The comrpession scheme used is "Recursive Pairing", that replaces the most
976     // frequent adjacent pair of symbols in the source message by a new symbol,
977     // reevaluating the frequencies of all of the symbol pairs with respect to
978     // the extended alphabet, and then repeating the process.
979     // See http://www.larsson.dogma.net/dcc99.pdf
980     std::vector<bool> visited(d->symlen.size());
981
982     for (Sym sym = 0; sym < d->symlen.size(); ++sym)
983         if (!visited[sym])
984             d->symlen[sym] = set_symlen(d, sym, visited);
985
986     return data + d->symlen.size() * sizeof(LR) + (d->symlen.size() & 1);
987 }
988
989 uint8_t* set_dtz_map(TBTable<WDL>&, uint8_t* data, File) { return data; }
990
991 uint8_t* set_dtz_map(TBTable<DTZ>& e, uint8_t* data, File maxFile) {
992
993     e.map = data;
994
995     for (File f = FILE_A; f <= maxFile; ++f) {
996         if (e.get(0, f)->flags & TBFlag::Mapped)
997             for (int i = 0; i < 4; ++i) { // Sequence like 3,x,x,x,1,x,0,2,x,x
998                 e.get(0, f)->map_idx[i] = (uint16_t)(data - e.map + 1);
999                 data += *data + 1;
1000             }
1001     }
1002
1003     return data += (uintptr_t)data & 1; // Word alignment
1004 }
1005
1006 // Populate entry's PairsData records with data from the just memory mapped file.
1007 // Called at first access.
1008 template<typename T>
1009 void set(T& e, uint8_t* data) {
1010
1011     PairsData* d;
1012
1013     enum { Split = 1, HasPawns = 2 };
1014
1015     assert(e.hasPawns        == !!(*data & HasPawns));
1016     assert((e.key != e.key2) == !!(*data & Split));
1017
1018     data++; // First byte stores flags
1019
1020     const int sides = T::Sides == 2 && (e.key != e.key2) ? 2 : 1;
1021     const File maxFile = e.hasPawns ? FILE_D : FILE_A;
1022
1023     bool pp = e.hasPawns && e.pawnCount[1]; // Pawns on both sides
1024
1025     assert(!pp || e.pawnCount[0]);
1026
1027     for (File f = FILE_A; f <= maxFile; ++f) {
1028
1029         for (int i = 0; i < sides; i++)
1030             *e.get(i, f) = PairsData();
1031
1032         int order[][2] = { { *data & 0xF, pp ? *(data + 1) & 0xF : 0xF },
1033                            { *data >>  4, pp ? *(data + 1) >>  4 : 0xF } };
1034         data += 1 + pp;
1035
1036         for (int k = 0; k < e.pieceCount; ++k, ++data)
1037             for (int i = 0; i < sides; i++)
1038                 e.get(i, f)->pieces[k] = Piece(i ? *data >>  4 : *data & 0xF);
1039
1040         for (int i = 0; i < sides; ++i)
1041             set_groups(e, e.get(i, f), order[i], f);
1042     }
1043
1044     data += (uintptr_t)data & 1; // Word alignment
1045
1046     for (File f = FILE_A; f <= maxFile; ++f)
1047         for (int i = 0; i < sides; i++)
1048             data = set_sizes(e.get(i, f), data);
1049
1050     data = set_dtz_map(e, data, maxFile);
1051
1052     for (File f = FILE_A; f <= maxFile; ++f)
1053         for (int i = 0; i < sides; i++) {
1054             (d = e.get(i, f))->sparseIndex = (SparseEntry*)data;
1055             data += d->sparseIndexSize * sizeof(SparseEntry);
1056         }
1057
1058     for (File f = FILE_A; f <= maxFile; ++f)
1059         for (int i = 0; i < sides; i++) {
1060             (d = e.get(i, f))->blockLength = (uint16_t*)data;
1061             data += d->blockLengthSize * sizeof(uint16_t);
1062         }
1063
1064     for (File f = FILE_A; f <= maxFile; ++f)
1065         for (int i = 0; i < sides; i++) {
1066             data = (uint8_t*)(((uintptr_t)data + 0x3F) & ~0x3F); // 64 byte alignment
1067             (d = e.get(i, f))->data = data;
1068             data += d->blocksNum * d->sizeofBlock;
1069         }
1070 }
1071
1072 // If the TB file corresponding to the given position is already memory mapped
1073 // then return its base address, otherwise try to memory map and init it. Called
1074 // at every probe, memory map and init only at first access. Function is thread
1075 // safe and can be called concurrently.
1076 template<TBType Type>
1077 void* mapped(TBTable<Type>& e, const Position& pos) {
1078
1079     static Mutex mutex;
1080
1081     // Use 'aquire' to avoid a thread reads 'ready' == true while another is
1082     // still working, this could happen due to compiler reordering.
1083     if (e.ready.load(std::memory_order_acquire))
1084         return e.baseAddress; // Could be nullptr if file does not exsist
1085
1086     std::unique_lock<Mutex> lk(mutex);
1087
1088     if (e.ready.load(std::memory_order_relaxed)) // Recheck under lock
1089         return e.baseAddress;
1090
1091     // Pieces strings in decreasing order for each color, like ("KPP","KR")
1092     std::string fname, w, b;
1093     for (PieceType pt = KING; pt >= PAWN; --pt) {
1094         w += std::string(popcount(pos.pieces(WHITE, pt)), PieceToChar[pt]);
1095         b += std::string(popcount(pos.pieces(BLACK, pt)), PieceToChar[pt]);
1096     }
1097
1098     fname =  (e.key == pos.material_key() ? w + 'v' + b : b + 'v' + w)
1099            + (Type == WDL ? ".rtbw" : ".rtbz");
1100
1101     uint8_t* data = TBFile(fname).map(&e.baseAddress, &e.mapping, Type);
1102
1103     if (data)
1104         set(e, data);
1105
1106     e.ready.store(true, std::memory_order_release);
1107     return e.baseAddress;
1108 }
1109
1110 template<TBType Type, typename Ret = typename TBTable<Type>::Ret>
1111 Ret probe_table(const Position& pos, ProbeState* result, WDLScore wdl = WDLDraw) {
1112
1113     if (pos.count<ALL_PIECES>() == 2) // KvK
1114         return Ret(WDLDraw);
1115
1116     TBTable<Type>* entry = TBTables.get<Type>(pos.material_key());
1117
1118     if (!entry || !mapped(*entry, pos))
1119         return *result = FAIL, Ret();
1120
1121     return do_probe_table(pos, entry, wdl, result);
1122 }
1123
1124 // For a position where the side to move has a winning capture it is not necessary
1125 // to store a winning value so the generator treats such positions as "don't cares"
1126 // and tries to assign to it a value that improves the compression ratio. Similarly,
1127 // if the side to move has a drawing capture, then the position is at least drawn.
1128 // If the position is won, then the TB needs to store a win value. But if the
1129 // position is drawn, the TB may store a loss value if that is better for compression.
1130 // All of this means that during probing, the engine must look at captures and probe
1131 // their results and must probe the position itself. The "best" result of these
1132 // probes is the correct result for the position.
1133 // DTZ table don't store values when a following move is a zeroing winning move
1134 // (winning capture or winning pawn move). Also DTZ store wrong values for positions
1135 // where the best move is an ep-move (even if losing). So in all these cases set
1136 // the state to ZEROING_BEST_MOVE.
1137 template<bool CheckZeroingMoves = false>
1138 WDLScore search(Position& pos, ProbeState* result) {
1139
1140     WDLScore value, bestValue = WDLLoss;
1141     StateInfo st;
1142
1143     auto moveList = MoveList<LEGAL>(pos);
1144     size_t totalCount = moveList.size(), moveCount = 0;
1145
1146     for (const Move& move : moveList)
1147     {
1148         if (   !pos.capture(move)
1149             && (!CheckZeroingMoves || type_of(pos.moved_piece(move)) != PAWN))
1150             continue;
1151
1152         moveCount++;
1153
1154         pos.do_move(move, st);
1155         value = -search(pos, result);
1156         pos.undo_move(move);
1157
1158         if (*result == FAIL)
1159             return WDLDraw;
1160
1161         if (value > bestValue)
1162         {
1163             bestValue = value;
1164
1165             if (value >= WDLWin)
1166             {
1167                 *result = ZEROING_BEST_MOVE; // Winning DTZ-zeroing move
1168                 return value;
1169             }
1170         }
1171     }
1172
1173     // In case we have already searched all the legal moves we don't have to probe
1174     // the TB because the stored score could be wrong. For instance TB tables
1175     // do not contain information on position with ep rights, so in this case
1176     // the result of probe_wdl_table is wrong. Also in case of only capture
1177     // moves, for instance here 4K3/4q3/6p1/2k5/6p1/8/8/8 w - - 0 7, we have to
1178     // return with ZEROING_BEST_MOVE set.
1179     bool noMoreMoves = (moveCount && moveCount == totalCount);
1180
1181     if (noMoreMoves)
1182         value = bestValue;
1183     else
1184     {
1185         value = probe_table<WDL>(pos, result);
1186
1187         if (*result == FAIL)
1188             return WDLDraw;
1189     }
1190
1191     // DTZ stores a "don't care" value if bestValue is a win
1192     if (bestValue >= value)
1193         return *result = (   bestValue > WDLDraw
1194                           || noMoreMoves ? ZEROING_BEST_MOVE : OK), bestValue;
1195
1196     return *result = OK, value;
1197 }
1198
1199 } // namespace
1200
1201
1202 /// Tablebases::init() is called at startup and after every change to
1203 /// "SyzygyPath" UCI option to (re)create the various tables. It is not thread
1204 /// safe, nor it needs to be.
1205 void Tablebases::init(const std::string& paths) {
1206
1207     TBTables.clear();
1208     MaxCardinality = 0;
1209     TBFile::Paths = paths;
1210
1211     if (paths.empty() || paths == "<empty>")
1212         return;
1213
1214     // MapB1H1H7[] encodes a square below a1-h8 diagonal to 0..27
1215     int code = 0;
1216     for (Square s = SQ_A1; s <= SQ_H8; ++s)
1217         if (off_A1H8(s) < 0)
1218             MapB1H1H7[s] = code++;
1219
1220     // MapA1D1D4[] encodes a square in the a1-d1-d4 triangle to 0..9
1221     std::vector<Square> diagonal;
1222     code = 0;
1223     for (Square s = SQ_A1; s <= SQ_D4; ++s)
1224         if (off_A1H8(s) < 0 && file_of(s) <= FILE_D)
1225             MapA1D1D4[s] = code++;
1226
1227         else if (!off_A1H8(s) && file_of(s) <= FILE_D)
1228             diagonal.push_back(s);
1229
1230     // Diagonal squares are encoded as last ones
1231     for (auto s : diagonal)
1232         MapA1D1D4[s] = code++;
1233
1234     // MapKK[] encodes all the 461 possible legal positions of two kings where
1235     // the first is in the a1-d1-d4 triangle. If the first king is on the a1-d4
1236     // diagonal, the other one shall not to be above the a1-h8 diagonal.
1237     std::vector<std::pair<int, Square>> bothOnDiagonal;
1238     code = 0;
1239     for (int idx = 0; idx < 10; idx++)
1240         for (Square s1 = SQ_A1; s1 <= SQ_D4; ++s1)
1241             if (MapA1D1D4[s1] == idx && (idx || s1 == SQ_B1)) // SQ_B1 is mapped to 0
1242             {
1243                 for (Square s2 = SQ_A1; s2 <= SQ_H8; ++s2)
1244                     if ((PseudoAttacks[KING][s1] | s1) & s2)
1245                         continue; // Illegal position
1246
1247                     else if (!off_A1H8(s1) && off_A1H8(s2) > 0)
1248                         continue; // First on diagonal, second above
1249
1250                     else if (!off_A1H8(s1) && !off_A1H8(s2))
1251                         bothOnDiagonal.push_back(std::make_pair(idx, s2));
1252
1253                     else
1254                         MapKK[idx][s2] = code++;
1255             }
1256
1257     // Legal positions with both kings on diagonal are encoded as last ones
1258     for (auto p : bothOnDiagonal)
1259         MapKK[p.first][p.second] = code++;
1260
1261     // Binomial[] stores the Binomial Coefficents using Pascal rule. There
1262     // are Binomial[k][n] ways to choose k elements from a set of n elements.
1263     Binomial[0][0] = 1;
1264
1265     for (int n = 1; n < 64; n++) // Squares
1266         for (int k = 0; k < 6 && k <= n; ++k) // Pieces
1267             Binomial[k][n] =  (k > 0 ? Binomial[k - 1][n - 1] : 0)
1268                             + (k < n ? Binomial[k    ][n - 1] : 0);
1269
1270     // MapPawns[s] encodes squares a2-h7 to 0..47. This is the number of possible
1271     // available squares when the leading one is in 's'. Moreover the pawn with
1272     // highest MapPawns[] is the leading pawn, the one nearest the edge and,
1273     // among pawns with same file, the one with lowest rank.
1274     int availableSquares = 47; // Available squares when lead pawn is in a2
1275
1276     // Init the tables for the encoding of leading pawns group: with 6-men TB we
1277     // can have up to 4 leading pawns (KPPPPK).
1278     for (int leadPawnsCnt = 1; leadPawnsCnt <= 4; ++leadPawnsCnt)
1279         for (File f = FILE_A; f <= FILE_D; ++f)
1280         {
1281             // Restart the index at every file because TB table is splitted
1282             // by file, so we can reuse the same index for different files.
1283             int idx = 0;
1284
1285             // Sum all possible combinations for a given file, starting with
1286             // the leading pawn on rank 2 and increasing the rank.
1287             for (Rank r = RANK_2; r <= RANK_7; ++r)
1288             {
1289                 Square sq = make_square(f, r);
1290
1291                 // Compute MapPawns[] at first pass.
1292                 // If sq is the leading pawn square, any other pawn cannot be
1293                 // below or more toward the edge of sq. There are 47 available
1294                 // squares when sq = a2 and reduced by 2 for any rank increase
1295                 // due to mirroring: sq == a3 -> no a2, h2, so MapPawns[a3] = 45
1296                 if (leadPawnsCnt == 1)
1297                 {
1298                     MapPawns[sq] = availableSquares--;
1299                     MapPawns[sq ^ 7] = availableSquares--; // Horizontal flip
1300                 }
1301                 LeadPawnIdx[leadPawnsCnt][sq] = idx;
1302                 idx += Binomial[leadPawnsCnt - 1][MapPawns[sq]];
1303             }
1304             // After a file is traversed, store the cumulated per-file index
1305             LeadPawnsSize[leadPawnsCnt][f] = idx;
1306         }
1307
1308     // Add entries in TB tables if the corresponding ".rtbw" file exsists
1309     for (PieceType p1 = PAWN; p1 < KING; ++p1) {
1310         TBTables.add({KING, p1, KING});
1311
1312         for (PieceType p2 = PAWN; p2 <= p1; ++p2) {
1313             TBTables.add({KING, p1, p2, KING});
1314             TBTables.add({KING, p1, KING, p2});
1315
1316             for (PieceType p3 = PAWN; p3 < KING; ++p3)
1317                 TBTables.add({KING, p1, p2, KING, p3});
1318
1319             for (PieceType p3 = PAWN; p3 <= p2; ++p3) {
1320                 TBTables.add({KING, p1, p2, p3, KING});
1321
1322                 for (PieceType p4 = PAWN; p4 <= p3; ++p4)
1323                     TBTables.add({KING, p1, p2, p3, p4, KING});
1324
1325                 for (PieceType p4 = PAWN; p4 < KING; ++p4)
1326                     TBTables.add({KING, p1, p2, p3, KING, p4});
1327             }
1328
1329             for (PieceType p3 = PAWN; p3 <= p1; ++p3)
1330                 for (PieceType p4 = PAWN; p4 <= (p1 == p3 ? p2 : p3); ++p4)
1331                     TBTables.add({KING, p1, p2, KING, p3, p4});
1332         }
1333     }
1334
1335     sync_cout << "info string Found " << TBTables.size() << " tablebases" << sync_endl;
1336 }
1337
1338 // Probe the WDL table for a particular position.
1339 // If *result != FAIL, the probe was successful.
1340 // The return value is from the point of view of the side to move:
1341 // -2 : loss
1342 // -1 : loss, but draw under 50-move rule
1343 //  0 : draw
1344 //  1 : win, but draw under 50-move rule
1345 //  2 : win
1346 WDLScore Tablebases::probe_wdl(Position& pos, ProbeState* result) {
1347
1348     *result = OK;
1349     return search(pos, result);
1350 }
1351
1352 // Probe the DTZ table for a particular position.
1353 // If *result != FAIL, the probe was successful.
1354 // The return value is from the point of view of the side to move:
1355 //         n < -100 : loss, but draw under 50-move rule
1356 // -100 <= n < -1   : loss in n ply (assuming 50-move counter == 0)
1357 //        -1        : loss, the side to move is mated
1358 //         0        : draw
1359 //     1 < n <= 100 : win in n ply (assuming 50-move counter == 0)
1360 //   100 < n        : win, but draw under 50-move rule
1361 //
1362 // The return value n can be off by 1: a return value -n can mean a loss
1363 // in n+1 ply and a return value +n can mean a win in n+1 ply. This
1364 // cannot happen for tables with positions exactly on the "edge" of
1365 // the 50-move rule.
1366 //
1367 // This implies that if dtz > 0 is returned, the position is certainly
1368 // a win if dtz + 50-move-counter <= 99. Care must be taken that the engine
1369 // picks moves that preserve dtz + 50-move-counter <= 99.
1370 //
1371 // If n = 100 immediately after a capture or pawn move, then the position
1372 // is also certainly a win, and during the whole phase until the next
1373 // capture or pawn move, the inequality to be preserved is
1374 // dtz + 50-movecounter <= 100.
1375 //
1376 // In short, if a move is available resulting in dtz + 50-move-counter <= 99,
1377 // then do not accept moves leading to dtz + 50-move-counter == 100.
1378 int Tablebases::probe_dtz(Position& pos, ProbeState* result) {
1379
1380     *result = OK;
1381     WDLScore wdl = search<true>(pos, result);
1382
1383     if (*result == FAIL || wdl == WDLDraw) // DTZ tables don't store draws
1384         return 0;
1385
1386     // DTZ stores a 'don't care' value in this case, or even a plain wrong
1387     // one as in case the best move is a losing ep, so it cannot be probed.
1388     if (*result == ZEROING_BEST_MOVE)
1389         return dtz_before_zeroing(wdl);
1390
1391     int dtz = probe_table<DTZ>(pos, result, wdl);
1392
1393     if (*result == FAIL)
1394         return 0;
1395
1396     if (*result != CHANGE_STM)
1397         return (dtz + 100 * (wdl == WDLBlessedLoss || wdl == WDLCursedWin)) * sign_of(wdl);
1398
1399     // DTZ stores results for the other side, so we need to do a 1-ply search and
1400     // find the winning move that minimizes DTZ.
1401     StateInfo st;
1402     int minDTZ = 0xFFFF;
1403
1404     for (const Move& move : MoveList<LEGAL>(pos))
1405     {
1406         bool zeroing = pos.capture(move) || type_of(pos.moved_piece(move)) == PAWN;
1407
1408         pos.do_move(move, st);
1409
1410         // For zeroing moves we want the dtz of the move _before_ doing it,
1411         // otherwise we will get the dtz of the next move sequence. Search the
1412         // position after the move to get the score sign (because even in a
1413         // winning position we could make a losing capture or going for a draw).
1414         dtz = zeroing ? -dtz_before_zeroing(search(pos, result))
1415                       : -probe_dtz(pos, result);
1416
1417         // If the move mates, force minDTZ to 1
1418         if (dtz == 1 && pos.checkers() && MoveList<LEGAL>(pos).size() == 0)
1419             minDTZ = 1;
1420
1421         // Convert result from 1-ply search. Zeroing moves are already accounted
1422         // by dtz_before_zeroing() that returns the DTZ of the previous move.
1423         if (!zeroing)
1424             dtz += sign_of(dtz);
1425
1426         // Skip the draws and if we are winning only pick positive dtz
1427         if (dtz < minDTZ && sign_of(dtz) == sign_of(wdl))
1428             minDTZ = dtz;
1429
1430         pos.undo_move(move);
1431
1432         if (*result == FAIL)
1433             return 0;
1434     }
1435
1436     // When there are no legal moves, the position is mate: we return -1
1437     return minDTZ == 0xFFFF ? -1 : minDTZ;
1438 }
1439
1440 // Check whether there has been at least one repetition of positions
1441 // since the last capture or pawn move.
1442 static int has_repeated(StateInfo *st)
1443 {
1444     while (1) {
1445         int i = 4, e = std::min(st->rule50, st->pliesFromNull);
1446
1447         if (e < i)
1448             return 0;
1449
1450         StateInfo *stp = st->previous->previous;
1451
1452         do {
1453             stp = stp->previous->previous;
1454
1455             if (stp->key == st->key)
1456                 return 1;
1457
1458             i += 2;
1459         } while (i <= e);
1460
1461         st = st->previous;
1462     }
1463 }
1464
1465 // Use the DTZ tables to filter out moves that don't preserve the win or draw.
1466 // If the position is lost, but DTZ is fairly high, only keep moves that
1467 // maximise DTZ.
1468 //
1469 // A return value false indicates that not all probes were successful and that
1470 // no moves were filtered out.
1471 bool Tablebases::root_probe(Position& pos, Search::RootMoves& rootMoves, Value& score)
1472 {
1473     assert(rootMoves.size());
1474
1475     ProbeState result;
1476     int dtz = probe_dtz(pos, &result);
1477
1478     if (result == FAIL)
1479         return false;
1480
1481     StateInfo st;
1482
1483     // Probe each move
1484     for (size_t i = 0; i < rootMoves.size(); ++i) {
1485         Move move = rootMoves[i].pv[0];
1486         pos.do_move(move, st);
1487         int v = 0;
1488
1489         if (pos.checkers() && dtz > 0) {
1490             ExtMove s[MAX_MOVES];
1491
1492             if (generate<LEGAL>(pos, s) == s)
1493                 v = 1;
1494         }
1495
1496         if (!v) {
1497             if (st.rule50 != 0) {
1498                 v = -probe_dtz(pos, &result);
1499
1500                 if (v > 0)
1501                     ++v;
1502                 else if (v < 0)
1503                     --v;
1504             } else {
1505                 v = -probe_wdl(pos, &result);
1506                 v = dtz_before_zeroing(WDLScore(v));
1507             }
1508         }
1509
1510         pos.undo_move(move);
1511
1512         if (result == FAIL)
1513             return false;
1514
1515         rootMoves[i].score = (Value)v;
1516     }
1517
1518     // Obtain 50-move counter for the root position.
1519     // In Stockfish there seems to be no clean way, so we do it like this:
1520     int cnt50 = st.previous ? st.previous->rule50 : 0;
1521
1522     // Use 50-move counter to determine whether the root position is
1523     // won, lost or drawn.
1524     WDLScore wdl = WDLDraw;
1525
1526     if (dtz > 0)
1527         wdl = (dtz + cnt50 <= 100) ? WDLWin : WDLCursedWin;
1528     else if (dtz < 0)
1529         wdl = (-dtz + cnt50 <= 100) ? WDLLoss : WDLBlessedLoss;
1530
1531     // Determine the score to report to the user.
1532     score = WDL_to_value[wdl + 2];
1533
1534     // If the position is winning or losing, but too few moves left, adjust the
1535     // score to show how close it is to winning or losing.
1536     // NOTE: int(PawnValueEg) is used as scaling factor in score_to_uci().
1537     if (wdl == WDLCursedWin && dtz <= 100)
1538         score = (Value)(((200 - dtz - cnt50) * int(PawnValueEg)) / 200);
1539     else if (wdl == WDLBlessedLoss && dtz >= -100)
1540         score = -(Value)(((200 + dtz - cnt50) * int(PawnValueEg)) / 200);
1541
1542     // Now be a bit smart about filtering out moves.
1543     size_t j = 0;
1544
1545     if (dtz > 0) { // winning (or 50-move rule draw)
1546         int best = 0xffff;
1547
1548         for (size_t i = 0; i < rootMoves.size(); ++i) {
1549             int v = rootMoves[i].score;
1550
1551             if (v > 0 && v < best)
1552                 best = v;
1553         }
1554
1555         int max = best;
1556
1557         // If the current phase has not seen repetitions, then try all moves
1558         // that stay safely within the 50-move budget, if there are any.
1559         if (!has_repeated(st.previous) && best + cnt50 <= 99)
1560             max = 99 - cnt50;
1561
1562         for (size_t i = 0; i < rootMoves.size(); ++i) {
1563             int v = rootMoves[i].score;
1564
1565             if (v > 0 && v <= max)
1566                 rootMoves[j++] = rootMoves[i];
1567         }
1568     } else if (dtz < 0) { // losing (or 50-move rule draw)
1569         int best = 0;
1570
1571         for (size_t i = 0; i < rootMoves.size(); ++i) {
1572             int v = rootMoves[i].score;
1573
1574             if (v < best)
1575                 best = v;
1576         }
1577
1578         // Try all moves, unless we approach or have a 50-move rule draw.
1579         if (-best * 2 + cnt50 < 100)
1580             return true;
1581
1582         for (size_t i = 0; i < rootMoves.size(); ++i) {
1583             if (rootMoves[i].score == best)
1584                 rootMoves[j++] = rootMoves[i];
1585         }
1586     } else { // drawing
1587         // Try all moves that preserve the draw.
1588         for (size_t i = 0; i < rootMoves.size(); ++i) {
1589             if (rootMoves[i].score == 0)
1590                 rootMoves[j++] = rootMoves[i];
1591         }
1592     }
1593
1594     rootMoves.resize(j, Search::RootMove(MOVE_NONE));
1595
1596     return true;
1597 }
1598
1599 // Use the WDL tables to filter out moves that don't preserve the win or draw.
1600 // This is a fallback for the case that some or all DTZ tables are missing.
1601 //
1602 // A return value false indicates that not all probes were successful and that
1603 // no moves were filtered out.
1604 bool Tablebases::root_probe_wdl(Position& pos, Search::RootMoves& rootMoves, Value& score)
1605 {
1606     ProbeState result;
1607
1608     WDLScore wdl = Tablebases::probe_wdl(pos, &result);
1609
1610     if (result == FAIL)
1611         return false;
1612
1613     score = WDL_to_value[wdl + 2];
1614
1615     StateInfo st;
1616
1617     int best = WDLLoss;
1618
1619     // Probe each move
1620     for (size_t i = 0; i < rootMoves.size(); ++i) {
1621         Move move = rootMoves[i].pv[0];
1622         pos.do_move(move, st);
1623         WDLScore v = -Tablebases::probe_wdl(pos, &result);
1624         pos.undo_move(move);
1625
1626         if (result == FAIL)
1627             return false;
1628
1629         rootMoves[i].score = (Value)v;
1630
1631         if (v > best)
1632             best = v;
1633     }
1634
1635     size_t j = 0;
1636
1637     for (size_t i = 0; i < rootMoves.size(); ++i) {
1638         if (rootMoves[i].score == best)
1639             rootMoves[j++] = rootMoves[i];
1640     }
1641
1642     rootMoves.resize(j, Search::RootMove(MOVE_NONE));
1643
1644     return true;
1645 }