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 (m || (k >> 48) != key16) // Preserve any existing move for the same position
  47         move16 = (uint16_t)m;
  48
  49     key16     = (uint16_t)(k >> 48);
  50     value16   = (int16_t)v;
  51     eval16    = (int16_t)ev;
  52     genBound8 = (uint8_t)(g | b);
  53     depth8    = (int8_t)d;
  54   }
  55
  56 private:
  57   friend class TranspositionTable;
  58
  59   uint16_t key16;
  60   uint16_t move16;
  61   int16_t  value16;
  62   int16_t  eval16;
  63   uint8_t  genBound8;
  64   int8_t   depth8;
  65 };
  66
  67
  68 /// A TranspositionTable consists of a power of 2 number of clusters and each
  69 /// cluster consists of TTClusterSize number of TTEntry. Each non-empty entry
  70 /// contains information of exactly one position. The size of a cluster should
  71 /// not be bigger than a cache line size. In case it is less, it should be padded
  72 /// to guarantee always aligned accesses.
  73
  74 class TranspositionTable {
  75
  76   static const int CacheLineSize = 64;
  77   static const int TTClusterSize = 3;
  78
  79   struct TTCluster {
  80     TTEntry entry[TTClusterSize];
  81     char padding[2]; // Align to the cache line size
  82   };
  83
  84 public:
  85  ~TranspositionTable() { free(mem); }
  86   void new_search() { generation8 += 4; } // Lower 2 bits are used by Bound
  87   uint8_t generation() const { return generation8; }
  88   TTEntry* probe(const Key key, bool& found) const;
  89   void resize(size_t mbSize);
  90   void clear();
  91
  92   // The lowest order bits of the key are used to get the index of the cluster
  93   TTEntry* first_entry(const Key key) const {
  94     return &table[(size_t)key & (clusterCount - 1)].entry[0];
  95   }
  96
  97 private:
  98   size_t clusterCount;
  99   TTCluster* table;
 100   void* mem;
 101   uint8_t generation8; // Size must be not bigger than TTEntry::genBound8
 102 };
 103
 104 extern TranspositionTable TT;
 105
 106 #endif // #ifndef TT_H_INCLUDED