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
  21 #if !defined(TT_H_INCLUDED)
  22 #define TT_H_INCLUDED
  23
  24 ////
  25 //// Includes
  26 ////
  27
  28 #include "depth.h"
  29 #include "position.h"
  30 #include "value.h"
  31
  32
  33 ////
  34 //// Types
  35 ////
  36
  37 /// The TTEntry class is the class of transposition table entries
  38 ///
  39 /// A TTEntry needs 128 bits to be stored
  40 ///
  41 /// bit  0-31: key
  42 /// bit 32-63: data
  43 /// bit 64-79: value
  44 /// bit 80-95: depth
  45 /// bit 96-111: static value
  46 /// bit 112-127: king danger value
  47 ///
  48 /// the 32 bits of the data field are so defined
  49 ///
  50 /// bit  0-16: move
  51 /// bit 17-19: not used
  52 /// bit 20-22: value type
  53 /// bit 23-31: generation
  54
  55 class TTEntry {
  56
  57 public:
  58   void save(uint32_t k, Value v, ValueType t, Depth d, Move m, int g, Value statV, Value kd) {
  59
  60       key32 = k;
  61       data = (m & 0x1FFFF) | (t << 20) | (g << 23);
  62       value16     = int16_t(v);
  63       depth16     = int16_t(d);
  64       staticValue = int16_t(statV);
  65       kingDanger  = int16_t(kd);
  66   }
  67
  68   uint32_t key() const { return key32; }
  69   Depth depth() const { return Depth(depth16); }
  70   Move move() const { return Move(data & 0x1FFFF); }
  71   Value value() const { return Value(value16); }
  72   ValueType type() const { return ValueType((data >> 20) & 7); }
  73   int generation() const { return data >> 23; }
  74   Value static_value() const { return Value(staticValue); }
  75   Value king_danger() const { return Value(kingDanger); }
  76
  77 private:
  78   uint32_t key32;
  79   uint32_t data;
  80   int16_t value16;
  81   int16_t depth16;
  82   int16_t staticValue;
  83   int16_t kingDanger;
  84 };
  85
  86
  87 /// This is the number of TTEntry slots for each position
  88 const int ClusterSize = 4;
  89
  90 /// Each group of ClusterSize number of TTEntry form a TTCluster
  91 /// that is indexed by a single position key. TTCluster size must
  92 ///  be not bigger then a cache line size, in case it is less then
  93 /// it should be padded to guarantee always aligned accesses.
  94
  95 struct TTCluster {
  96   TTEntry data[ClusterSize];
  97 };
  98
  99
 100 /// The transposition table class. This is basically just a huge array
 101 /// containing TTEntry objects, and a few methods for writing new entries
 102 /// and reading new ones.
 103
 104 class TranspositionTable {
 105
 106 public:
 107   TranspositionTable();
 108   ~TranspositionTable();
 109   void set_size(size_t mbSize);
 110   void clear();
 111   void store(const Key posKey, Value v, ValueType type, Depth d, Move m, Value statV, Value kingD);
 112   TTEntry* retrieve(const Key posKey) const;
 113   void new_search();
 114   void insert_pv(const Position& pos, Move pv[]);
 115   void extract_pv(const Position& pos, Move bestMove, Move pv[], const int PLY_MAX);
 116   int full() const;
 117   TTEntry* first_entry(const Key posKey) const;
 118
 119 private:
 120   // Be sure 'overwrites' is at least one cache line away
 121   // from read only variables.
 122   unsigned char pad_before[64 - sizeof(unsigned)];
 123   unsigned overwrites; // heavy SMP read/write access here
 124   unsigned char pad_after[64];
 125
 126   size_t size;
 127   TTCluster* entries;
 128   uint8_t generation;
 129 };
 130
 131 extern TranspositionTable TT;
 132
 133
 134 /// TranspositionTable::first_entry returns a pointer to the first
 135 /// entry of a cluster given a position. The low 32 bits of the key
 136 /// are used to get the index in the table.
 137
 138 inline TTEntry* TranspositionTable::first_entry(const Key posKey) const {
 139
 140   return entries[uint32_t(posKey) & (size - 1)].data;
 141 }
 142
 143 #endif // !defined(TT_H_INCLUDED)