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-2014 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 /// The TTEntry 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_value() const { return (Value)evalValue; }
  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     k >>= 48;
  47     if (m || k != key16) // preserve any existing ttMove
  48         move16 = (uint16_t)m;
  49     key16      = (uint16_t)k;
  50     value16    = (int16_t)v;
  51     evalValue  = (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  evalValue;
  63   uint8_t  genBound8;
  64   int8_t   depth8;
  65 };
  66
  67 /// TTCluster is a 32 bytes cluster of TT entries consisting of:
  68 ///
  69 /// 3 x TTEntry (3 x 10 bytes)
  70 /// padding     (2 bytes)
  71
  72 static const unsigned TTClusterSize = 3;
  73
  74 struct TTCluster {
  75   TTEntry entry[TTClusterSize];
  76   char padding[2];
  77 };
  78
  79 /// A TranspositionTable consists of a power of 2 number of clusters and each
  80 /// cluster consists of TTClusterSize number of TTEntry. Each non-empty entry
  81 /// contains information of exactly one position. The size of a cluster should
  82 /// not be bigger than a cache line size. In case it is less, it should be padded
  83 /// to guarantee always aligned accesses.
  84
  85 class TranspositionTable {
  86
  87 public:
  88  ~TranspositionTable() { free(mem); }
  89   void new_search() { generation += 4; } // Lower 2 bits are used by Bound
  90   uint8_t get_generation() const { return generation; }
  91   TTEntry* probe(const Key key, bool& found) const;
  92   TTEntry* first_entry(const Key key) const;
  93   void resize(size_t mbSize);
  94   void clear();
  95
  96 private:
  97   size_t clusterCount;
  98   TTCluster* table;
  99   void* mem;
 100   uint8_t generation; // Size must be not bigger than TTEntry::genBound8
 101 };
 102
 103 extern TranspositionTable TT;
 104
 105
 106 /// TranspositionTable::first_entry() returns a pointer to the first entry of
 107 /// a cluster given a position. The lowest order bits of the key are used to
 108 /// get the index of the cluster inside the table.
 109
 110 inline TTEntry* TranspositionTable::first_entry(const Key key) const {
 111
 112   return &table[(size_t)key & (clusterCount - 1)].entry[0];
 113 }
 114
 115 #endif // #ifndef TT_H_INCLUDED