git.sesse.net Git - stockfish/blob - src/tt.cpp

   1 /*
   2   Stockfish, a UCI chess playing engine derived from Glaurung 2.1
   3   Copyright (C) 2004-2008 Tord Romstad (Glaurung author)
   4   Copyright (C) 2008-2015 Marco Costalba, Joona Kiiski, Tord Romstad
   5   Copyright (C) 2015-2018 Marco Costalba, Joona Kiiski, Gary Linscott, Tord Romstad
   6
   7   Stockfish is free software: you can redistribute it and/or modify
   8   it under the terms of the GNU General Public License as published by
   9   the Free Software Foundation, either version 3 of the License, or
  10   (at your option) any later version.
  11
  12   Stockfish is distributed in the hope that it will be useful,
  13   but WITHOUT ANY WARRANTY; without even the implied warranty of
  14   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15   GNU General Public License for more details.
  16
  17   You should have received a copy of the GNU General Public License
  18   along with this program.  If not, see <http://www.gnu.org/licenses/>.
  19 */
  20
  21 #include <cstring>   // For std::memset
  22 #include <iostream>
  23 #include <thread>
  24
  25 #include "bitboard.h"
  26 #include "misc.h"
  27 #include "tt.h"
  28 #include "uci.h"
  29
  30 TranspositionTable TT; // Our global transposition table
  31
  32
  33 /// TranspositionTable::resize() sets the size of the transposition table,
  34 /// measured in megabytes. Transposition table consists of a power of 2 number
  35 /// of clusters and each cluster consists of ClusterSize number of TTEntry.
  36
  37 void TranspositionTable::resize(size_t mbSize) {
  38
  39   clusterCount = mbSize * 1024 * 1024 / sizeof(Cluster);
  40
  41   free(mem);
  42   mem = malloc(clusterCount * sizeof(Cluster) + CacheLineSize - 1);
  43
  44   if (!mem)
  45   {
  46       std::cerr << "Failed to allocate " << mbSize
  47                 << "MB for transposition table." << std::endl;
  48       exit(EXIT_FAILURE);
  49   }
  50
  51   table = (Cluster*)((uintptr_t(mem) + CacheLineSize - 1) & ~(CacheLineSize - 1));
  52   clear();
  53 }
  54
  55
  56 /// TranspositionTable::clear() overwrites the entire transposition table
  57 /// with zeros. It is called whenever the table is resized, or when the
  58 /// user asks the program to clear the table (from the UCI interface).
  59 /// It starts as many threads as allowed by the Threads option.
  60
  61 void TranspositionTable::clear() {
  62
  63   const size_t stride = clusterCount / Options["Threads"];
  64   std::vector<std::thread> threads;
  65   for (size_t idx = 0; idx < Options["Threads"]; idx++)
  66   {
  67       const size_t start =  stride * idx,
  68                    len =    idx != Options["Threads"] - 1 ?
  69                             stride :
  70                             clusterCount - start;
  71       threads.push_back(std::thread([this, idx, start, len]() {
  72           if (Options["Threads"] >= 8)
  73               WinProcGroup::bindThisThread(idx);
  74           std::memset(&table[start], 0, len * sizeof(Cluster));
  75       }));
  76   }
  77
  78   for (std::thread& th: threads)
  79       th.join();
  80 }
  81
  82 /// TranspositionTable::probe() looks up the current position in the transposition
  83 /// table. It returns true and a pointer to the TTEntry if the position is found.
  84 /// Otherwise, it returns false and a pointer to an empty or least valuable TTEntry
  85 /// to be replaced later. The replace value of an entry is calculated as its depth
  86 /// minus 8 times its relative age. TTEntry t1 is considered more valuable than
  87 /// TTEntry t2 if its replace value is greater than that of t2.
  88
  89 TTEntry* TranspositionTable::probe(const Key key, bool& found) const {
  90
  91   TTEntry* const tte = first_entry(key);
  92   const uint16_t key16 = key >> 48;  // Use the high 16 bits as key inside the cluster
  93
  94   for (int i = 0; i < ClusterSize; ++i)
  95       if (!tte[i].key16 || tte[i].key16 == key16)
  96       {
  97           if ((tte[i].genBound8 & 0xFC) != generation8 && tte[i].key16)
  98               tte[i].genBound8 = uint8_t(generation8 | tte[i].bound()); // Refresh
  99
 100           return found = (bool)tte[i].key16, &tte[i];
 101       }
 102
 103   // Find an entry to be replaced according to the replacement strategy
 104   TTEntry* replace = tte;
 105   for (int i = 1; i < ClusterSize; ++i)
 106       // Due to our packed storage format for generation and its cyclic
 107       // nature we add 259 (256 is the modulus plus 3 to keep the lowest
 108       // two bound bits from affecting the result) to calculate the entry
 109       // age correctly even after generation8 overflows into the next cycle.
 110       if (  replace->depth8 - ((259 + generation8 - replace->genBound8) & 0xFC) * 2
 111           >   tte[i].depth8 - ((259 + generation8 -   tte[i].genBound8) & 0xFC) * 2)
 112           replace = &tte[i];
 113
 114   return found = false, replace;
 115 }
 116
 117
 118 /// TranspositionTable::hashfull() returns an approximation of the hashtable
 119 /// occupation during a search. The hash is x permill full, as per UCI protocol.
 120
 121 int TranspositionTable::hashfull() const {
 122
 123   int cnt = 0;
 124   for (int i = 0; i < 1000 / ClusterSize; i++)
 125   {
 126       const TTEntry* tte = &table[i].entry[0];
 127       for (int j = 0; j < ClusterSize; j++)
 128           if ((tte[j].genBound8 & 0xFC) == generation8)
 129               cnt++;
 130   }
 131   return cnt;
 132 }