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-2015 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 #ifndef TT_H_INCLUDED
  21 #define TT_H_INCLUDED
  22
  23 #include "misc.h"
  24 #include "types.h"
  25
  26 /// TTEntry struct is the 10 bytes transposition table entry, defined as below:
  27 ///
  28 /// key        16 bit
  29 /// move       16 bit
  30 /// value      16 bit
  31 /// eval value 16 bit
  32 /// generation  6 bit
  33 /// bound type  2 bit
  34 /// depth       8 bit
  35
  36 struct TTEntry {
  37
  38   Move  move()  const { return (Move )move16; }
  39   Value value() const { return (Value)value16; }
  40   Value eval()  const { return (Value)eval16; }
  41   Depth depth() const { return (Depth)depth8; }
  42   Bound bound() const { return (Bound)(genBound8 & 0x3); }
  43
  44   void save(Key k, Value v, Bound b, Depth d, Move m, Value ev, uint8_t g) {
  45
  46       if (key16 != (k >> 48))
  47       {
  48           key16     = (uint16_t)(k >> 48);
  49           move16    = (uint16_t)m;
  50           value16   = (int16_t)v;
  51           eval16    = (int16_t)ev;
  52           genBound8 = (uint8_t)(g | b);
  53           depth8    = (int8_t)d;
  54       }
  55       else
  56       {
  57           // Preserve any existing move for the same position
  58           if (m)
  59               move16 = (uint16_t)m;
  60
  61           // Don't overwrite more valuable values
  62           if (   d + 2 > depth8
  63               || g != (genBound8 & 0xFC)
  64               || b == BOUND_EXACT)
  65           {
  66               value16   = (int16_t)v;
  67               genBound8 = (uint8_t)(g | b);
  68               depth8    = (int8_t)d;
  69           }
  70
  71           if (ev != VALUE_NONE)
  72               eval16 = (int16_t)ev;
  73       }
  74   }
  75
  76 private:
  77   friend class TranspositionTable;
  78
  79   uint16_t key16;
  80   uint16_t move16;
  81   int16_t  value16;
  82   int16_t  eval16;
  83   uint8_t  genBound8;
  84   int8_t   depth8;
  85 };
  86
  87
  88 /// A TranspositionTable consists of a power of 2 number of clusters and each
  89 /// cluster consists of ClusterSize number of TTEntry. Each non-empty entry
  90 /// contains information of exactly one position. The size of a cluster should
  91 /// not be bigger than a cache line size. In case it is less, it should be padded
  92 /// to guarantee always aligned accesses.
  93
  94 class TranspositionTable {
  95
  96   static const int CacheLineSize = 64;
  97   static const int ClusterSize = 3;
  98
  99   struct Cluster {
 100     TTEntry entry[ClusterSize];
 101     char padding[2]; // Align to the cache line size
 102   };
 103
 104   static_assert(sizeof(Cluster) == CacheLineSize / 2, "Cluster size incorrect");
 105
 106 public:
 107  ~TranspositionTable() { free(mem); }
 108   void new_search() { generation8 += 4; } // Lower 2 bits are used by Bound
 109   uint8_t generation() const { return generation8; }
 110   TTEntry* probe(const Key key, bool& found) const;
 111   int hashfull() const;
 112   void resize(size_t mbSize);
 113   void clear();
 114
 115   // The lowest order bits of the key are used to get the index of the cluster
 116   TTEntry* first_entry(const Key key) const {
 117     return &table[(size_t)key & (clusterCount - 1)].entry[0];
 118   }
 119
 120 private:
 121   size_t clusterCount;
 122   Cluster* table;
 123   void* mem;
 124   uint8_t generation8; // Size must be not bigger than TTEntry::genBound8
 125 };
 126
 127 extern TranspositionTable TT;
 128
 129 #endif // #ifndef TT_H_INCLUDED