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