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-2010 Marco Costalba, Joona Kiiski, Tord Romstad
   5
   6   Stockfish is free software: you can redistribute it and/or modify
   7   it under the terms of the GNU General Public License as published by
   8   the Free Software Foundation, either version 3 of the License, or
   9   (at your option) any later version.
  10
  11   Stockfish is distributed in the hope that it will be useful,
  12   but WITHOUT ANY WARRANTY; without even the implied warranty of
  13   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14   GNU General Public License for more details.
  15
  16   You should have received a copy of the GNU General Public License
  17   along with this program.  If not, see <http://www.gnu.org/licenses/>.
  18 */
  19
  20
  21 ////
  22 //// Includes
  23 ////
  24
  25 #include <cassert>
  26 #include <cmath>
  27 #include <cstring>
  28 #if defined(USE_PREFETCH)
  29 #  include <xmmintrin.h>
  30 #endif
  31
  32 #include "movegen.h"
  33 #include "tt.h"
  34
  35 // The main transposition table
  36 TranspositionTable TT;
  37
  38 ////
  39 //// Functions
  40 ////
  41
  42 TranspositionTable::TranspositionTable() {
  43
  44   size = writes = 0;
  45   entries = 0;
  46   generation = 0;
  47 }
  48
  49 TranspositionTable::~TranspositionTable() {
  50
  51   delete [] entries;
  52 }
  53
  54
  55 /// TranspositionTable::set_size sets the size of the transposition table,
  56 /// measured in megabytes.
  57
  58 void TranspositionTable::set_size(size_t mbSize) {
  59
  60   size_t newSize = 1024;
  61
  62   // We store a cluster of ClusterSize number of TTEntry for each position
  63   // and newSize is the maximum number of storable positions.
  64   while ((2 * newSize) * sizeof(TTCluster) <= (mbSize << 20))
  65       newSize *= 2;
  66
  67   if (newSize != size)
  68   {
  69       size = newSize;
  70       delete [] entries;
  71       entries = new TTCluster[size];
  72       if (!entries)
  73       {
  74           std::cerr << "Failed to allocate " << mbSize
  75                     << " MB for transposition table." << std::endl;
  76           Application::exit_with_failure();
  77       }
  78       clear();
  79   }
  80 }
  81
  82
  83 /// TranspositionTable::clear overwrites the entire transposition table
  84 /// with zeroes. It is called whenever the table is resized, or when the
  85 /// user asks the program to clear the table (from the UCI interface).
  86 /// Perhaps we should also clear it when the "ucinewgame" command is recieved?
  87
  88 void TranspositionTable::clear() {
  89
  90   memset(entries, 0, size * sizeof(TTCluster));
  91 }
  92
  93
  94 /// TranspositionTable::first_entry returns a pointer to the first
  95 /// entry of a cluster given a position. The low 32 bits of the key
  96 /// are used to get the index in the table.
  97
  98 inline TTEntry* TranspositionTable::first_entry(const Key posKey) const {
  99
 100   return entries[uint32_t(posKey) & (size - 1)].data;
 101 }
 102
 103
 104 /// TranspositionTable::store writes a new entry containing a position,
 105 /// a value, a value type, a search depth, and a best move to the
 106 /// transposition table. Transposition table is organized in clusters of
 107 /// four TTEntry objects, and when a new entry is written, it replaces
 108 /// the least valuable of the four entries in a cluster. A TTEntry t1 is
 109 /// considered to be more valuable than a TTEntry t2 if t1 is from the
 110 /// current search and t2 is from a previous search, or if the depth of t1
 111 /// is bigger than the depth of t2. A TTEntry of type VALUE_TYPE_EVAL
 112 /// never replaces another entry for the same position.
 113
 114 void TranspositionTable::store(const Key posKey, Value v, ValueType t, Depth d, Move m) {
 115
 116   TTEntry *tte, *replace;
 117   uint32_t posKey32 = posKey >> 32; // Use the high 32 bits as key
 118
 119   tte = replace = first_entry(posKey);
 120   for (int i = 0; i < ClusterSize; i++, tte++)
 121   {
 122       if (!tte->key() || tte->key() == posKey32) // empty or overwrite old
 123       {
 124           // Preserve any exsisting ttMove
 125           if (m == MOVE_NONE)
 126               m = tte->move();
 127
 128           *tte = TTEntry(posKey32, v, t, d, m, generation);
 129           return;
 130       }
 131       else if (i == 0)  // replace would be a no-op in this common case
 132           continue;
 133
 134       int c1 = (replace->generation() == generation ?  2 : 0);
 135       int c2 = (tte->generation() == generation ? -2 : 0);
 136       int c3 = (tte->depth() < replace->depth() ?  1 : 0);
 137
 138       if (c1 + c2 + c3 > 0)
 139           replace = tte;
 140   }
 141   *replace = TTEntry(posKey32, v, t, d, m, generation);
 142   writes++;
 143 }
 144
 145
 146 /// TranspositionTable::retrieve looks up the current position in the
 147 /// transposition table. Returns a pointer to the TTEntry or NULL
 148 /// if position is not found.
 149
 150 TTEntry* TranspositionTable::retrieve(const Key posKey) const {
 151
 152   uint32_t posKey32 = posKey >> 32;
 153   TTEntry* tte = first_entry(posKey);
 154
 155   for (int i = 0; i < ClusterSize; i++, tte++)
 156       if (tte->key() == posKey32)
 157           return tte;
 158
 159   return NULL;
 160 }
 161
 162
 163 /// TranspositionTable::prefetch looks up the current position in the
 164 /// transposition table and load it in L1/L2 cache. This is a non
 165 /// blocking function and do not stalls the CPU waiting for data
 166 /// to be loaded from RAM, that can be very slow. When we will
 167 /// subsequently call retrieve() the TT data will be already
 168 /// quickly accessible in L1/L2 CPU cache.
 169 #if !defined(USE_PREFETCH)
 170 void TranspositionTable::prefetch(const Key) const {}
 171 #else
 172
 173 void TranspositionTable::prefetch(const Key posKey) const {
 174
 175 #if defined(__INTEL_COMPILER) || defined(__ICL)
 176    // This hack prevents prefetches to be optimized away by
 177    // Intel compiler. Both MSVC and gcc seems not affected.
 178    __asm__ ("");
 179 #endif
 180
 181    char const* addr = (char*)first_entry(posKey);
 182   _mm_prefetch(addr, _MM_HINT_T2);
 183   _mm_prefetch(addr+64, _MM_HINT_T2); // 64 bytes ahead
 184 }
 185
 186 #endif
 187
 188 /// TranspositionTable::new_search() is called at the beginning of every new
 189 /// search. It increments the "generation" variable, which is used to
 190 /// distinguish transposition table entries from previous searches from
 191 /// entries from the current search.
 192
 193 void TranspositionTable::new_search() {
 194
 195   generation++;
 196   writes = 0;
 197 }
 198
 199
 200 /// TranspositionTable::insert_pv() is called at the end of a search
 201 /// iteration, and inserts the PV back into the PV. This makes sure
 202 /// the old PV moves are searched first, even if the old TT entries
 203 /// have been overwritten.
 204
 205 void TranspositionTable::insert_pv(const Position& pos, Move pv[]) {
 206
 207   StateInfo st;
 208   Position p(pos);
 209
 210   for (int i = 0; pv[i] != MOVE_NONE; i++)
 211   {
 212       TTEntry *tte = retrieve(p.get_key());
 213       if (!tte || tte->move() != pv[i])
 214           store(p.get_key(), VALUE_NONE, VALUE_TYPE_NONE, Depth(-127*OnePly), pv[i]);
 215       p.do_move(pv[i], st);
 216   }
 217 }
 218
 219
 220 /// TranspositionTable::extract_pv() extends a PV by adding moves from the
 221 /// transposition table at the end. This should ensure that the PV is almost
 222 /// always at least two plies long, which is important, because otherwise we
 223 /// will often get single-move PVs when the search stops while failing high,
 224 /// and a single-move PV means that we don't have a ponder move.
 225
 226 void TranspositionTable::extract_pv(const Position& pos, Move pv[], const int PLY_MAX) {
 227
 228   const TTEntry* tte;
 229   StateInfo st;
 230   Position p(pos);
 231   int ply = 0;
 232
 233   // Update position to the end of current PV
 234   while (pv[ply] != MOVE_NONE)
 235       p.do_move(pv[ply++], st);
 236
 237   // Try to add moves from TT while possible
 238   while (   (tte = retrieve(p.get_key())) != NULL
 239          && tte->move() != MOVE_NONE
 240          && move_is_legal(p, tte->move())
 241          && (!p.is_draw() || ply < 2)
 242          && ply < PLY_MAX)
 243   {
 244       pv[ply] = tte->move();
 245       p.do_move(pv[ply++], st);
 246   }
 247   pv[ply] = MOVE_NONE;
 248 }
 249
 250
 251 /// TranspositionTable::full() returns the permill of all transposition table
 252 /// entries which have received at least one write during the current search.
 253 /// It is used to display the "info hashfull ..." information in UCI.
 254
 255 int TranspositionTable::full() const {
 256
 257   double N = double(size) * ClusterSize;
 258   return int(1000 * (1 - exp(writes * log(1.0 - 1.0/N))));
 259 }