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-2012 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 "misc.h"
  24 #include "types.h"
  25
  26 /// The TTEntry is the class of transposition table entries
  27 ///
  28 /// A TTEntry needs 128 bits to be stored
  29 ///
  30 /// bit  0-31: key
  31 /// bit 32-63: data
  32 /// bit 64-79: value
  33 /// bit 80-95: depth
  34 /// bit 96-111: static value
  35 /// bit 112-127: margin of static value
  36 ///
  37 /// the 32 bits of the data field are so defined
  38 ///
  39 /// bit  0-15: move
  40 /// bit 16-20: not used
  41 /// bit 21-22: value type
  42 /// bit 23-31: generation
  43
  44 class TTEntry {
  45
  46 public:
  47   void save(uint32_t k, Value v, Bound b, Depth d, Move m, int g) {
  48
  49     key32       = (uint32_t)k;
  50     move16      = (uint16_t)m;
  51     bound       = (uint8_t)b;
  52     generation8 = (uint8_t)g;
  53     valueUpper = (int16_t)(b & BOUND_UPPER ? v : VALUE_NONE);
  54     depthUpper = (int16_t)(b & BOUND_UPPER ? d : DEPTH_NONE);
  55     valueLower = (int16_t)(b & BOUND_LOWER ? v : VALUE_NONE);
  56     depthLower = (int16_t)(b & BOUND_LOWER ? d : DEPTH_NONE);
  57   }
  58
  59   void update(Value v, Bound b, Depth d, Move m, int g) {
  60
  61     move16      = (uint16_t)m;
  62     generation8 = (uint8_t)g;
  63
  64     if (bound == BOUND_EXACT)
  65         bound = BOUND_UPPER | BOUND_LOWER; // Drop 'EXACT' flag
  66
  67     if (b & BOUND_UPPER)
  68     {
  69         valueUpper = (int16_t)v;
  70         depthUpper = (int16_t)d;
  71
  72         if ((bound & BOUND_LOWER) && v < valueLower)
  73         {
  74             bound ^= BOUND_LOWER;
  75             valueLower = VALUE_NONE;
  76             depthLower = DEPTH_NONE;
  77         }
  78     }
  79
  80     if (b & BOUND_LOWER)
  81     {
  82         valueLower = (int16_t)v;
  83         depthLower = (int16_t)d;
  84
  85         if ((bound & BOUND_UPPER) && v > valueUpper)
  86         {
  87             bound ^= BOUND_UPPER;
  88             valueUpper = VALUE_NONE;
  89             depthUpper = DEPTH_NONE;
  90         }
  91     }
  92
  93     bound |= (uint8_t)b;
  94   }
  95
  96   void set_generation(int g) { generation8 = (uint8_t)g; }
  97
  98   uint32_t key() const              { return key32; }
  99   Depth depth() const               { return (Depth)depthLower; }
 100   Depth depth_upper() const         { return (Depth)depthUpper; }
 101   Move move() const                 { return (Move)move16; }
 102   Value value() const               { return (Value)valueLower; }
 103   Value value_upper() const         { return (Value)valueUpper; }
 104   Bound type() const                { return (Bound)bound; }
 105   int generation() const            { return (int)generation8; }
 106
 107 private:
 108   uint32_t key32;
 109   uint16_t move16;
 110   uint8_t bound, generation8;
 111   int16_t valueLower, depthLower, valueUpper, depthUpper;
 112 };
 113
 114
 115 /// This is the number of TTEntry slots for each cluster
 116 const int ClusterSize = 4;
 117
 118
 119 /// TTCluster consists of ClusterSize number of TTEntries. Size of TTCluster
 120 /// must not be bigger than a cache line size. In case it is less, it should
 121 /// be padded to guarantee always aligned accesses.
 122
 123 struct TTCluster {
 124   TTEntry data[ClusterSize];
 125 };
 126
 127
 128 /// The transposition table class. This is basically just a huge array containing
 129 /// TTCluster objects, and a few methods for writing and reading entries.
 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, Bound b, Depth d, Move m);
 142   TTEntry* probe(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; // Size must be not bigger then TTEntry::generation8
 151 };
 152
 153 extern TranspositionTable TT;
 154
 155
 156 /// TranspositionTable::first_entry() returns a pointer to the first entry of
 157 /// a cluster given a position. The lowest order bits of the key are used to
 158 /// 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.
 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)