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