Use 32 bit key in TT
[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-2009 Marco Costalba
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         : key_ (k), data((m & 0x1FFFF) | (t << 20) | (generation << 23)),
59           value_(int16_t(v)), depth_(int16_t(d)) {}
60
61   uint32_t key() const { return key_; }
62   Depth depth() const { return Depth(depth_); }
63   Move move() const { return Move(data & 0x1FFFF); }
64   Value value() const { return Value(value_); }
65   ValueType type() const { return ValueType((data >> 20) & 7); }
66   int generation() const { return (data >> 23); }
67
68 private:
69   uint32_t key_;
70   uint32_t data;
71   int16_t value_;
72   int16_t depth_;
73 };
74
75 /// The transposition table class.  This is basically just a huge array
76 /// containing TTEntry objects, and a few methods for writing new entries
77 /// and reading new ones.
78
79 class TranspositionTable {
80
81 public:
82   TranspositionTable();
83   ~TranspositionTable();
84   void set_size(unsigned mbSize);
85   void clear();
86   void store(const Key posKey, Value v, ValueType type, Depth d, Move m);
87   TTEntry* retrieve(const Key posKey) const;
88   void new_search();
89   void insert_pv(const Position& pos, Move pv[]);
90   void extract_pv(const Position& pos, Move pv[]);
91   int full() const;
92
93 private:
94   inline TTEntry* first_entry(const Key posKey) const;
95
96   // Be sure 'writes' is at least one cacheline away
97   // from read only variables.
98   unsigned char pad_before[64 - sizeof(unsigned)];
99   unsigned writes; // heavy SMP read/write access here
100   unsigned char pad_after[64];
101
102   unsigned size;
103   TTEntry* entries;
104   uint8_t generation;
105 };
106
107 #endif // !defined(TT_H_INCLUDED)