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