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