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 96 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 ///
  46 /// the 32 bits of the data field are so defined
  47 ///
  48 /// bit  0-16: move
  49 /// bit 17-19: not used
  50 /// bit 20-22: value type
  51 /// bit 23-31: generation
  52
  53 class TTEntry {
  54
  55 public:
  56   TTEntry() {}
  57   TTEntry(uint32_t k, Value v, ValueType t, Depth d, Move m, int generation,
  58           Value statV, Value kingD)
  59         : key_ (k), data((m & 0x1FFFF) | (t << 20) | (generation << 23)),
  60           value_(int16_t(v)), depth_(int16_t(d)),
  61           staticValue_(int16_t(statV)), kingDanger_(int16_t(kingD)) {}
  62
  63   uint32_t key() const { return key_; }
  64   Depth depth() const { return Depth(depth_); }
  65   Move move() const { return Move(data & 0x1FFFF); }
  66   Value value() const { return Value(value_); }
  67   ValueType type() const { return ValueType((data >> 20) & 7); }
  68   int generation() const { return (data >> 23); }
  69   Value static_value() const { return Value(staticValue_); }
  70   Value king_danger() const { return Value(kingDanger_); }
  71
  72 private:
  73   uint32_t key_;
  74   uint32_t data;
  75   int16_t value_;
  76   int16_t depth_;
  77   int16_t staticValue_;
  78   int16_t kingDanger_;
  79 };
  80
  81
  82 /// This is the number of TTEntry slots for each position
  83 const int ClusterSize = 4;
  84
  85 /// Each group of ClusterSize number of TTEntry form a TTCluster
  86 /// that is indexed by a single position key. Cluster is padded
  87 /// to a cache line size so to guarantee always aligned accesses.
  88
  89 struct TTCluster {
  90   TTEntry data[ClusterSize];
  91   char cache_line_padding[64 - sizeof(TTEntry[ClusterSize])];
  92 };
  93
  94
  95 /// The transposition table class. This is basically just a huge array
  96 /// containing TTEntry objects, and a few methods for writing new entries
  97 /// and reading new ones.
  98
  99 class TranspositionTable {
 100
 101 public:
 102   TranspositionTable();
 103   ~TranspositionTable();
 104   void set_size(size_t mbSize);
 105   void clear();
 106   void store(const Key posKey, Value v, ValueType type, Depth d, Move m, Value statV, Value kingD);
 107   TTEntry* retrieve(const Key posKey) const;
 108   void prefetch(const Key posKey) const;
 109   void new_search();
 110   void insert_pv(const Position& pos, Move pv[]);
 111   void extract_pv(const Position& pos, Move pv[], const int PLY_MAX);
 112   int full() const;
 113
 114 private:
 115   inline TTEntry* first_entry(const Key posKey) const;
 116
 117   // Be sure 'writes' is at least one cache line away
 118   // from read only variables.
 119   unsigned char pad_before[64 - sizeof(unsigned)];
 120   unsigned writes; // heavy SMP read/write access here
 121   unsigned char pad_after[64];
 122
 123   size_t size;
 124   TTCluster* entries;
 125   uint8_t generation;
 126 };
 127
 128 extern TranspositionTable TT;
 129
 130 #endif // !defined(TT_H_INCLUDED)