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