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