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