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
  24 #include "bitboard.h"
  25 #include "tt.h"
  26
  27 TranspositionTable TT; // Our global transposition table
  28
  29
  30 /// TranspositionTable::resize() sets the size of the transposition table,
  31 /// measured in megabytes. Transposition table consists of a power of 2 number
  32 /// of clusters and each cluster consists of ClusterSize number of TTEntry.
  33
  34 void TranspositionTable::resize(size_t mbSize) {
  35
  36   size_t newClusterCount = mbSize * 1024 * 1024 / sizeof(Cluster);
  37
  38   if (newClusterCount == clusterCount)
  39       return;
  40
  41   clusterCount = newClusterCount;
  42
  43   free(mem);
  44   mem = malloc(clusterCount * sizeof(Cluster) + CacheLineSize - 1);
  45
  46   if (!mem)
  47   {
  48       std::cerr << "Failed to allocate " << mbSize
  49                 << "MB for transposition table." << std::endl;
  50       exit(EXIT_FAILURE);
  51   }
  52
  53   table = (Cluster*)((uintptr_t(mem) + CacheLineSize - 1) & ~(CacheLineSize - 1));
  54   clear();
  55 }
  56
  57
  58 /// TranspositionTable::clear() overwrites the entire transposition table
  59 /// with zeros. It is called whenever the table is resized, or when the
  60 /// user asks the program to clear the table (from the UCI interface).
  61
  62 void TranspositionTable::clear() {
  63
  64   std::memset(table, 0, clusterCount * sizeof(Cluster));
  65 }
  66
  67
  68 /// TranspositionTable::probe() looks up the current position in the transposition
  69 /// table. It returns true and a pointer to the TTEntry if the position is found.
  70 /// Otherwise, it returns false and a pointer to an empty or least valuable TTEntry
  71 /// to be replaced later. The replace value of an entry is calculated as its depth
  72 /// minus 8 times its relative age. TTEntry t1 is considered more valuable than
  73 /// TTEntry t2 if its replace value is greater than that of t2.
  74
  75 TTEntry* TranspositionTable::probe(const Key key, bool& found) const {
  76
  77   TTEntry* const tte = first_entry(key);
  78   const uint16_t key16 = key >> 48;  // Use the high 16 bits as key inside the cluster
  79
  80   for (int i = 0; i < ClusterSize; ++i)
  81       if (!tte[i].key16 || tte[i].key16 == key16)
  82       {
  83           if ((tte[i].genBound8 & 0xFC) != generation8 && tte[i].key16)
  84               tte[i].genBound8 = uint8_t(generation8 | tte[i].bound()); // Refresh
  85
  86           return found = (bool)tte[i].key16, &tte[i];
  87       }
  88
  89   // Find an entry to be replaced according to the replacement strategy
  90   TTEntry* replace = tte;
  91   for (int i = 1; i < ClusterSize; ++i)
  92       // Due to our packed storage format for generation and its cyclic
  93       // nature we add 259 (256 is the modulus plus 3 to keep the lowest
  94       // two bound bits from affecting the result) to calculate the entry
  95       // age correctly even after generation8 overflows into the next cycle.
  96       if (  replace->depth8 - ((259 + generation8 - replace->genBound8) & 0xFC) * 2
  97           >   tte[i].depth8 - ((259 + generation8 -   tte[i].genBound8) & 0xFC) * 2)
  98           replace = &tte[i];
  99
 100   return found = false, replace;
 101 }
 102
 103
 104 /// TranspositionTable::hashfull() returns an approximation of the hashtable
 105 /// occupation during a search. The hash is x permill full, as per UCI protocol.
 106
 107 int TranspositionTable::hashfull() const {
 108
 109   int cnt = 0;
 110   for (int i = 0; i < 1000 / ClusterSize; i++)
 111   {
 112       const TTEntry* tte = &table[i].entry[0];
 113       for (int j = 0; j < ClusterSize; j++)
 114           if ((tte[j].genBound8 & 0xFC) == generation8)
 115               cnt++;
 116   }
 117   return cnt;
 118 }