Increase the maximum hash size by a factor of 256
[stockfish] / 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   Copyright (C) 2015-2020 Marco Costalba, Joona Kiiski, Gary Linscott, Tord Romstad
6
7   Stockfish is free software: you can redistribute it and/or modify
8   it under the terms of the GNU General Public License as published by
9   the Free Software Foundation, either version 3 of the License, or
10   (at your option) any later version.
11
12   Stockfish is distributed in the hope that it will be useful,
13   but WITHOUT ANY WARRANTY; without even the implied warranty of
14   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15   GNU General Public License for more details.
16
17   You should have received a copy of the GNU General Public License
18   along with this program.  If not, see <http://www.gnu.org/licenses/>.
19 */
20
21 #ifndef TT_H_INCLUDED
22 #define TT_H_INCLUDED
23
24 #include "misc.h"
25 #include "types.h"
26
27 /// TTEntry struct is the 10 bytes transposition table entry, defined as below:
28 ///
29 /// key        16 bit
30 /// move       16 bit
31 /// value      16 bit
32 /// eval value 16 bit
33 /// generation  5 bit
34 /// pv node     1 bit
35 /// bound type  2 bit
36 /// depth       8 bit
37
38 struct TTEntry {
39
40   Move  move()  const { return (Move )move16; }
41   Value value() const { return (Value)value16; }
42   Value eval()  const { return (Value)eval16; }
43   Depth depth() const { return (Depth)depth8 + DEPTH_OFFSET; }
44   bool is_pv()  const { return (bool)(genBound8 & 0x4); }
45   Bound bound() const { return (Bound)(genBound8 & 0x3); }
46   void save(Key k, Value v, bool pv, Bound b, Depth d, Move m, Value ev);
47
48 private:
49   friend class TranspositionTable;
50
51   uint16_t key16;
52   uint16_t move16;
53   int16_t  value16;
54   int16_t  eval16;
55   uint8_t  genBound8;
56   uint8_t  depth8;
57 };
58
59
60 /// A TranspositionTable is an array of Cluster, of size clusterCount. Each
61 /// cluster consists of ClusterSize number of TTEntry. Each non-empty TTEntry
62 /// contains information on exactly one position. The size of a Cluster should
63 /// divide the size of a cache line for best performance,
64 /// as the cacheline is prefetched when possible.
65
66 class TranspositionTable {
67
68   static constexpr int ClusterSize = 3;
69   static constexpr int ClustersPerSuperCluster = 256;
70
71   struct Cluster {
72     TTEntry entry[ClusterSize];
73     char padding[2]; // Pad to 32 bytes
74   };
75
76   static_assert(sizeof(Cluster) == 32, "Unexpected Cluster size");
77
78 public:
79  ~TranspositionTable() { aligned_ttmem_free(mem); }
80   void new_search() { generation8 += 8; } // Lower 3 bits are used by PV flag and Bound
81   TTEntry* probe(const Key key, bool& found) const;
82   int hashfull() const;
83   void resize(size_t mbSize);
84   void clear();
85
86   TTEntry* first_entry(const Key key) const {
87
88     // The index is computed from
89     // Idx = (K48 * SCC) / 2^40, with K48 the 48 lowest bits swizzled.
90
91     const uint64_t firstTerm =  uint32_t(key) * uint64_t(superClusterCount);
92     const uint64_t secondTerm = (uint16_t(key >> 32) * uint64_t(superClusterCount)) >> 16;
93
94     return &table[(firstTerm + secondTerm) >> 24].entry[0];
95   }
96
97 private:
98   friend struct TTEntry;
99
100   size_t superClusterCount;
101   Cluster* table;
102   void* mem;
103   uint8_t generation8; // Size must be not bigger than TTEntry::genBound8
104 };
105
106 extern TranspositionTable TT;
107
108 #endif // #ifndef TT_H_INCLUDED