git.sesse.net Git - stockfish/blob - src/tt.h

   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 #if !defined(TT_H_INCLUDED)
  21 #define TT_H_INCLUDED
  22
  23 #include <iostream>
  24
  25 #include "move.h"
  26 #include "types.h"
  27
  28 /// A simple fixed size hash table used to store pawns and material
  29 /// configurations. It is basically just an array of Entry objects.
  30 /// Without cluster concept or overwrite policy.
  31
  32 template<class Entry, int HashSize>
  33 class SimpleHash {
  34
  35   SimpleHash(const SimpleHash&);
  36   SimpleHash& operator=(const SimpleHash&);
  37
  38 public:
  39   SimpleHash() {
  40
  41     entries = new (std::nothrow) Entry[HashSize];
  42     if (!entries)
  43     {
  44         std::cerr << "Failed to allocate " << HashSize * sizeof(Entry)
  45                   << " bytes for material hash table." << std::endl;
  46         exit(EXIT_FAILURE);
  47     }
  48     memset(entries, 0, HashSize * sizeof(Entry));
  49   }
  50
  51   virtual ~SimpleHash() { delete [] entries; }
  52
  53   Entry* find(Key key) const { return entries + ((uint32_t)key & (HashSize - 1)); }
  54
  55 protected:
  56   Entry* entries;
  57 };
  58
  59
  60 /// The TTEntry class is the class of transposition table entries
  61 ///
  62 /// A TTEntry needs 128 bits to be stored
  63 ///
  64 /// bit  0-31: key
  65 /// bit 32-63: data
  66 /// bit 64-79: value
  67 /// bit 80-95: depth
  68 /// bit 96-111: static value
  69 /// bit 112-127: margin of static value
  70 ///
  71 /// the 32 bits of the data field are so defined
  72 ///
  73 /// bit  0-15: move
  74 /// bit 16-20: not used
  75 /// bit 21-22: value type
  76 /// bit 23-31: generation
  77
  78 class TTEntry {
  79
  80 public:
  81   void save(uint32_t k, Value v, ValueType t, Depth d, Move m, int g, Value statV, Value statM) {
  82
  83     key32        = (uint32_t)k;
  84     move16       = (uint16_t)m;
  85     valueType    = (uint8_t)t;
  86     generation8  = (uint8_t)g;
  87     value16      = (int16_t)v;
  88     depth16      = (int16_t)d;
  89     staticValue  = (int16_t)statV;
  90     staticMargin = (int16_t)statM;
  91   }
  92   void set_generation(int g) { generation8 = (uint8_t)g; }
  93
  94   uint32_t key() const { return key32; }
  95   Depth depth() const { return Depth(depth16); }
  96   Move move() const { return Move(move16); }
  97   Value value() const { return Value(value16); }
  98   ValueType type() const { return ValueType(valueType); }
  99   int generation() const { return generation8; }
 100   Value static_value() const { return Value(staticValue); }
 101   Value static_value_margin() const { return Value(staticMargin); }
 102
 103 private:
 104   uint32_t key32;
 105   uint16_t move16;
 106   uint8_t valueType;
 107   uint8_t generation8;
 108   int16_t value16;
 109   int16_t depth16;
 110   int16_t staticValue;
 111   int16_t staticMargin;
 112 };
 113
 114
 115 /// This is the number of TTEntry slots for each cluster
 116 const int ClusterSize = 4;
 117
 118 /// TTCluster consists of ClusterSize number of TTEntries.
 119 /// Size of TTCluster must not be bigger than a cache line size.
 120 /// In case it is less, it should be padded to guarantee always aligned accesses.
 121
 122 struct TTCluster {
 123   TTEntry data[ClusterSize];
 124 };
 125
 126
 127 /// The transposition table class. This is basically just a huge array
 128 /// containing TTCluster objects, and a few methods for writing new entries
 129 /// and reading new ones.
 130
 131 class TranspositionTable {
 132
 133   TranspositionTable(const TranspositionTable&);
 134   TranspositionTable& operator=(const TranspositionTable&);
 135
 136 public:
 137   TranspositionTable();
 138   ~TranspositionTable();
 139   void set_size(size_t mbSize);
 140   void clear();
 141   void store(const Key posKey, Value v, ValueType type, Depth d, Move m, Value statV, Value kingD);
 142   TTEntry* retrieve(const Key posKey) const;
 143   void new_search();
 144   TTEntry* first_entry(const Key posKey) const;
 145   void refresh(const TTEntry* tte) const;
 146
 147 private:
 148   size_t size;
 149   TTCluster* entries;
 150   uint8_t generation; // To properly compare, size must be smaller then TT stored value
 151 };
 152
 153 extern TranspositionTable TT;
 154
 155
 156 /// TranspositionTable::first_entry returns a pointer to the first
 157 /// entry of a cluster given a position. The lowest order bits of the key
 158 /// are used to get the index of the cluster.
 159
 160 inline TTEntry* TranspositionTable::first_entry(const Key posKey) const {
 161
 162   return entries[((uint32_t)posKey) & (size - 1)].data;
 163 }
 164
 165
 166 /// TranspositionTable::refresh updates the 'generation' value of the TTEntry
 167 /// to avoid aging. Normally called after a TT hit, before to return.
 168
 169 inline void TranspositionTable::refresh(const TTEntry* tte) const {
 170
 171   const_cast<TTEntry*>(tte)->set_generation(generation);
 172 }
 173
 174 #endif // !defined(TT_H_INCLUDED)