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-2013 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 128 bit transposition table entry, defined as below:
  27 ///
  28 /// key: 32 bit
  29 /// move: 16 bit
  30 /// bound type: 8 bit
  31 /// generation: 8 bit
  32 /// value: 16 bit
  33 /// depth: 16 bit
  34 /// static value: 16 bit
  35 /// static margin: 16 bit
  36
  37 struct TTEntry {
  38
  39   void save(uint32_t k, Value v, Bound b, Depth d, Move m, int g, Value ev, Value em) {
  40
  41     key32        = (uint32_t)k;
  42     move16       = (uint16_t)m;
  43     bound8       = (uint8_t)b;
  44     generation8  = (uint8_t)g;
  45     value16      = (int16_t)v;
  46     depth16      = (int16_t)d;
  47     evalValue    = (int16_t)ev;
  48     evalMargin   = (int16_t)em;
  49   }
  50   void set_generation(uint8_t g) { generation8 = g; }
  51
  52   uint32_t key() const      { return key32; }
  53   Depth depth() const       { return (Depth)depth16; }
  54   Move move() const         { return (Move)move16; }
  55   Value value() const       { return (Value)value16; }
  56   Bound bound() const       { return (Bound)bound8; }
  57   int generation() const    { return (int)generation8; }
  58   Value eval_value() const  { return (Value)evalValue; }
  59   Value eval_margin() const { return (Value)evalMargin; }
  60
  61 private:
  62   uint32_t key32;
  63   uint16_t move16;
  64   uint8_t bound8, generation8;
  65   int16_t value16, depth16, evalValue, evalMargin;
  66 };
  67
  68
  69 /// A TranspositionTable consists of a power of 2 number of clusters and each
  70 /// cluster consists of ClusterSize number of TTEntry. Each non-empty entry
  71 /// contains information of exactly one position. Size of a cluster shall not be
  72 /// bigger than a cache line size. In case it is less, it should be padded to
  73 /// guarantee always aligned accesses.
  74
  75 class TranspositionTable {
  76
  77   static const unsigned ClusterSize = 4; // A cluster is 64 Bytes
  78
  79 public:
  80  ~TranspositionTable() { free(mem); }
  81   void new_search() { ++generation; }
  82
  83   const TTEntry* probe(const Key key) const;
  84   TTEntry* first_entry(const Key key) const;
  85   void refresh(const TTEntry* tte) const;
  86   void set_size(size_t mbSize);
  87   void clear();
  88   void store(const Key key, Value v, Bound type, Depth d, Move m, Value statV, Value kingD);
  89
  90 private:
  91   uint32_t hashMask;
  92   TTEntry* table;
  93   void* mem;
  94   uint8_t generation; // Size must be not bigger than TTEntry::generation8
  95 };
  96
  97 extern TranspositionTable TT;
  98
  99
 100 /// TranspositionTable::first_entry() returns a pointer to the first entry of
 101 /// a cluster given a position. The lowest order bits of the key are used to
 102 /// get the index of the cluster.
 103
 104 inline TTEntry* TranspositionTable::first_entry(const Key key) const {
 105
 106   return table + ((uint32_t)key & hashMask);
 107 }
 108
 109
 110 /// TranspositionTable::refresh() updates the 'generation' value of the TTEntry
 111 /// to avoid aging. Normally called after a TT hit.
 112
 113 inline void TranspositionTable::refresh(const TTEntry* tte) const {
 114
 115   const_cast<TTEntry*>(tte)->set_generation(generation);
 116 }
 117
 118 #endif // #ifndef TT_H_INCLUDED