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 <cstring>
  27 #include <iostream>
  28
  29 #include "tt.h"
  30
  31 // The main transposition table
  32 TranspositionTable TT;
  33
  34 ////
  35 //// Functions
  36 ////
  37
  38 TranspositionTable::TranspositionTable() {
  39
  40   size = 0;
  41   entries = 0;
  42   generation = 0;
  43 }
  44
  45 TranspositionTable::~TranspositionTable() {
  46
  47   delete [] entries;
  48 }
  49
  50
  51 /// TranspositionTable::set_size sets the size of the transposition table,
  52 /// measured in megabytes.
  53
  54 void TranspositionTable::set_size(size_t mbSize) {
  55
  56   size_t newSize = 1024;
  57
  58   // Transposition table consists of clusters and
  59   // each cluster consists of ClusterSize number of TTEntries.
  60   // Each non-empty entry contains information of exactly one position.
  61   // newSize is the number of clusters we are going to allocate.
  62   while ((2 * newSize) * sizeof(TTCluster) <= (mbSize << 20))
  63       newSize *= 2;
  64
  65   if (newSize != size)
  66   {
  67       size = newSize;
  68       delete [] entries;
  69       entries = new TTCluster[size];
  70       if (!entries)
  71       {
  72           std::cerr << "Failed to allocate " << mbSize
  73                     << " MB for transposition table." << std::endl;
  74           exit(EXIT_FAILURE);
  75       }
  76       clear();
  77   }
  78 }
  79
  80
  81 /// TranspositionTable::clear overwrites the entire transposition table
  82 /// with zeroes. It is called whenever the table is resized, or when the
  83 /// user asks the program to clear the table (from the UCI interface).
  84 /// Perhaps we should also clear it when the "ucinewgame" command is received?
  85
  86 void TranspositionTable::clear() {
  87
  88   memset(entries, 0, size * sizeof(TTCluster));
  89 }
  90
  91
  92 /// TranspositionTable::store writes a new entry containing position key and
  93 /// valuable information of current position.
  94 /// The Lowest order bits of position key are used to decide on which cluster
  95 /// the position will be placed.
  96 /// When a new entry is written and there are no empty entries available in cluster,
  97 /// it replaces the least valuable of entries.
  98 /// A TTEntry t1 is considered to be more valuable than a TTEntry t2 if t1 is from the
  99 /// current search and t2 is from a previous search, or if the depth of t1
 100 /// is bigger than the depth of t2.
 101
 102 void TranspositionTable::store(const Key posKey, Value v, ValueType t, Depth d, Move m, Value statV, Value kingD) {
 103
 104   int c1, c2, c3;
 105   TTEntry *tte, *replace;
 106   uint32_t posKey32 = posKey >> 32; // Use the high 32 bits as key
 107
 108   tte = replace = first_entry(posKey);
 109   for (int i = 0; i < ClusterSize; i++, tte++)
 110   {
 111       if (!tte->key() || tte->key() == posKey32) // empty or overwrite old
 112       {
 113           // Preserve any existing ttMove
 114           if (m == MOVE_NONE)
 115               m = tte->move();
 116
 117           tte->save(posKey32, v, t, d, m, generation, statV, kingD);
 118           return;
 119       }
 120
 121       if (i == 0)  // Replacing first entry is default and already set before entering for-loop
 122           continue;
 123
 124       c1 = (replace->generation() == generation ?  2 : 0);
 125       c2 = (tte->generation() == generation ? -2 : 0);
 126       c3 = (tte->depth() < replace->depth() ?  1 : 0);
 127
 128       if (c1 + c2 + c3 > 0)
 129           replace = tte;
 130   }
 131   replace->save(posKey32, v, t, d, m, generation, statV, kingD);
 132 }
 133
 134
 135 /// TranspositionTable::retrieve looks up the current position in the
 136 /// transposition table. Returns a pointer to the TTEntry or NULL
 137 /// if position is not found.
 138
 139 TTEntry* TranspositionTable::retrieve(const Key posKey) const {
 140
 141   uint32_t posKey32 = posKey >> 32;
 142   TTEntry* tte = first_entry(posKey);
 143
 144   for (int i = 0; i < ClusterSize; i++, tte++)
 145       if (tte->key() == posKey32)
 146           return tte;
 147
 148   return NULL;
 149 }
 150
 151
 152 /// TranspositionTable::new_search() is called at the beginning of every new
 153 /// search. It increments the "generation" variable, which is used to
 154 /// distinguish transposition table entries from previous searches from
 155 /// entries from the current search.
 156
 157 void TranspositionTable::new_search() {
 158   generation++;
 159 }