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-2013 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 #include <cstring>
  21 #include <iostream>
  22
  23 #include "bitboard.h"
  24 #include "tt.h"
  25
  26 TranspositionTable TT; // Our global transposition table
  27
  28
  29 /// TranspositionTable::set_size() sets the size of the transposition table,
  30 /// measured in megabytes. Transposition table consists of a power of 2 number
  31 /// of clusters and each cluster consists of ClusterSize number of TTEntry.
  32
  33 void TranspositionTable::set_size(size_t mbSize) {
  34
  35   assert(msb((mbSize << 20) / sizeof(TTEntry)) < 32);
  36
  37   uint32_t size = ClusterSize << msb((mbSize << 20) / sizeof(TTEntry[ClusterSize]));
  38
  39   if (hashMask == size - ClusterSize)
  40       return;
  41
  42   hashMask = size - ClusterSize;
  43   free(mem);
  44   mem = malloc(size * sizeof(TTEntry) + CACHE_LINE_SIZE - 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   // Align table start address to a cache line
  54   for (char* c = (char*)mem; unsigned(table = (TTEntry*)(c)) % CACHE_LINE_SIZE; c++) {}
  55   clear(); // Operator new is not guaranteed to initialize memory to zero
  56 }
  57
  58
  59 /// TranspositionTable::clear() overwrites the entire transposition table
  60 /// with zeroes. It is called whenever the table is resized, or when the
  61 /// user asks the program to clear the table (from the UCI interface).
  62
  63 void TranspositionTable::clear() {
  64
  65   memset(table, 0, (hashMask + ClusterSize) * sizeof(TTEntry));
  66 }
  67
  68
  69 /// TranspositionTable::store() writes a new entry containing position key and
  70 /// valuable information of current position. The lowest order bits of position
  71 /// key are used to decide on which cluster the position will be placed.
  72 /// When a new entry is written and there are no empty entries available in cluster,
  73 /// it replaces the least valuable of entries. A TTEntry t1 is considered to be
  74 /// more valuable than a TTEntry t2 if t1 is from the current search and t2 is from
  75 /// a previous search, or if the depth of t1 is bigger than the depth of t2.
  76
  77 void TranspositionTable::store(const Key key, Value v, Bound t, Depth d, Move m, Value statV, Value kingD) {
  78
  79   int c1, c2, c3;
  80   TTEntry *tte, *replace;
  81   uint32_t key32 = key >> 32; // Use the high 32 bits as key inside the cluster
  82
  83   tte = replace = first_entry(key);
  84
  85   for (unsigned i = 0; i < ClusterSize; i++, tte++)
  86   {
  87       if (!tte->key() || tte->key() == key32) // Empty or overwrite old
  88       {
  89           // Preserve any existing ttMove
  90           if (m == MOVE_NONE)
  91               m = tte->move();
  92
  93           tte->save(key32, v, t, d, m, generation, statV, kingD);
  94           return;
  95       }
  96
  97       // Implement replace strategy
  98       c1 = (replace->generation() == generation ?  2 : 0);
  99       c2 = (tte->generation() == generation || tte->type() == BOUND_EXACT ? -2 : 0);
 100       c3 = (tte->depth() < replace->depth() ?  1 : 0);
 101
 102       if (c1 + c2 + c3 > 0)
 103           replace = tte;
 104   }
 105   replace->save(key32, v, t, d, m, generation, statV, kingD);
 106 }
 107
 108
 109 /// TranspositionTable::probe() looks up the current position in the
 110 /// transposition table. Returns a pointer to the TTEntry or NULL if
 111 /// position is not found.
 112
 113 TTEntry* TranspositionTable::probe(const Key key) const {
 114
 115   TTEntry* tte = first_entry(key);
 116   uint32_t key32 = key >> 32;
 117
 118   for (unsigned i = 0; i < ClusterSize; i++, tte++)
 119       if (tte->key() == key32)
 120           return tte;
 121
 122   return NULL;
 123 }