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-2023 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 "tt.h"
  20
  21 #include <cassert>
  22 #include <cstdlib>
  23 #include <cstring>
  24 #include <iostream>
  25 #include <thread>
  26 #include <vector>
  27
  28 #include "misc.h"
  29 #include "thread.h"
  30 #include "uci.h"
  31
  32 namespace Stockfish {
  33
  34 TranspositionTable TT; // Our global transposition table
  35
  36 /// TTEntry::save() populates the TTEntry with a new node's data, possibly
  37 /// overwriting an old position. Update is not atomic and can be racy.
  38
  39 void TTEntry::save(Key k, Value v, bool pv, Bound b, Depth d, Move m, Value ev) {
  40
  41   // Preserve any existing move for the same position
  42   if (m || uint16_t(k) != key16)
  43       move16 = uint16_t(m);
  44
  45   // Overwrite less valuable entries (cheapest checks first)
  46   if (   b == BOUND_EXACT
  47       || uint16_t(k) != key16
  48       || d - DEPTH_OFFSET + 2 * pv > depth8 - 4)
  49   {
  50       assert(d > DEPTH_OFFSET);
  51       assert(d < 256 + DEPTH_OFFSET);
  52
  53       key16     = uint16_t(k);
  54       depth8    = uint8_t(d - DEPTH_OFFSET);
  55       genBound8 = uint8_t(TT.generation8 | uint8_t(pv) << 2 | b);
  56       value16   = int16_t(v);
  57       eval16    = int16_t(ev);
  58   }
  59 }
  60
  61
  62 /// TranspositionTable::resize() sets the size of the transposition table,
  63 /// measured in megabytes. Transposition table consists of a power of 2 number
  64 /// of clusters and each cluster consists of ClusterSize number of TTEntry.
  65
  66 void TranspositionTable::resize(size_t mbSize) {
  67
  68   Threads.main()->wait_for_search_finished();
  69
  70   aligned_large_pages_free(table);
  71
  72   clusterCount = mbSize * 1024 * 1024 / sizeof(Cluster);
  73
  74   table = static_cast<Cluster*>(aligned_large_pages_alloc(clusterCount * sizeof(Cluster)));
  75   if (!table)
  76   {
  77       std::cerr << "Failed to allocate " << mbSize
  78                 << "MB for transposition table." << std::endl;
  79       exit(EXIT_FAILURE);
  80   }
  81
  82   clear();
  83 }
  84
  85
  86 /// TranspositionTable::clear() initializes the entire transposition table to zero,
  87 //  in a multi-threaded way.
  88
  89 void TranspositionTable::clear() {
  90
  91   std::vector<std::thread> threads;
  92
  93   for (size_t idx = 0; idx < size_t(Options["Threads"]); ++idx)
  94   {
  95       threads.emplace_back([this, idx]() {
  96
  97           // Thread binding gives faster search on systems with a first-touch policy
  98           if (Options["Threads"] > 8)
  99               WinProcGroup::bindThisThread(idx);
 100
 101           // Each thread will zero its part of the hash table
 102           const size_t stride = size_t(clusterCount / Options["Threads"]),
 103                        start  = size_t(stride * idx),
 104                        len    = idx != size_t(Options["Threads"]) - 1 ?
 105                                 stride : clusterCount - start;
 106
 107           std::memset(&table[start], 0, len * sizeof(Cluster));
 108       });
 109   }
 110
 111   for (std::thread& th : threads)
 112       th.join();
 113 }
 114
 115
 116 /// TranspositionTable::probe() looks up the current position in the transposition
 117 /// table. It returns true and a pointer to the TTEntry if the position is found.
 118 /// Otherwise, it returns false and a pointer to an empty or least valuable TTEntry
 119 /// to be replaced later. The replace value of an entry is calculated as its depth
 120 /// minus 8 times its relative age. TTEntry t1 is considered more valuable than
 121 /// TTEntry t2 if its replace value is greater than that of t2.
 122
 123 TTEntry* TranspositionTable::probe(const Key key, bool& found) const {
 124
 125   TTEntry* const tte = first_entry(key);
 126   const uint16_t key16 = uint16_t(key);  // Use the low 16 bits as key inside the cluster
 127
 128   for (int i = 0; i < ClusterSize; ++i)
 129       if (tte[i].key16 == key16 || !tte[i].depth8)
 130       {
 131           tte[i].genBound8 = uint8_t(generation8 | (tte[i].genBound8 & (GENERATION_DELTA - 1))); // Refresh
 132
 133           return found = bool(tte[i].depth8), &tte[i];
 134       }
 135
 136   // Find an entry to be replaced according to the replacement strategy
 137   TTEntry* replace = tte;
 138   for (int i = 1; i < ClusterSize; ++i)
 139       // Due to our packed storage format for generation and its cyclic
 140       // nature we add GENERATION_CYCLE (256 is the modulus, plus what
 141       // is needed to keep the unrelated lowest n bits from affecting
 142       // the result) to calculate the entry age correctly even after
 143       // generation8 overflows into the next cycle.
 144       if (  replace->depth8 - ((GENERATION_CYCLE + generation8 - replace->genBound8) & GENERATION_MASK)
 145           >   tte[i].depth8 - ((GENERATION_CYCLE + generation8 -   tte[i].genBound8) & GENERATION_MASK))
 146           replace = &tte[i];
 147
 148   return found = false, replace;
 149 }
 150
 151
 152 /// TranspositionTable::hashfull() returns an approximation of the hashtable
 153 /// occupation during a search. The hash is x permill full, as per UCI protocol.
 154
 155 int TranspositionTable::hashfull() const {
 156
 157   int cnt = 0;
 158   for (int i = 0; i < 1000; ++i)
 159       for (int j = 0; j < ClusterSize; ++j)
 160           cnt += table[i].entry[j].depth8 && (table[i].entry[j].genBound8 & GENERATION_MASK) == generation8;
 161
 162   return cnt / ClusterSize;
 163 }
 164
 165 } // namespace Stockfish