Retire PawnsFileSpan
[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 10 bytes transposition table entry, defined as below:
27 ///
28 /// key        16 bit
29 /// move       16 bit
30 /// value      16 bit
31 /// eval value 16 bit
32 /// generation  6 bit
33 /// bound type  2 bit
34 /// depth       8 bit
35
36 struct TTEntry {
37
38   Move  move()  const      { return (Move )move16; }
39   Value value() const      { return (Value)value16; }
40   Value eval_value() const { return (Value)evalValue; }
41   Depth depth() const      { return (Depth)depth8; }
42   Bound bound() const      { return (Bound)(genBound8 & 0x3); }
43
44 private:
45   friend class TranspositionTable;
46
47   void save(uint16_t k, Value v, Bound b, Depth d, Move m, uint8_t g, Value ev) {
48
49     key16     = (uint16_t)k;
50     move16    = (uint16_t)m;
51     value16   = (int16_t)v;
52     evalValue = (int16_t)ev;
53     genBound8 = (uint8_t)(g | b);
54     depth8    = (int8_t)d;
55   }
56
57   uint16_t key16;
58   uint16_t move16;
59   int16_t  value16;
60   int16_t  evalValue;
61   uint8_t  genBound8;
62   int8_t   depth8;
63 };
64
65 /// TTCluster is a 32 bytes cluster of TT entries consisting of:
66 ///
67 /// 3 x TTEntry (3 x 10 bytes)
68 /// padding     (2 bytes)
69
70 const unsigned TTClusterSize = 3;
71
72 struct TTCluster {
73   TTEntry entry[TTClusterSize];
74   char padding[2];
75 };
76
77 /// A TranspositionTable consists of a power of 2 number of clusters and each
78 /// cluster consists of TTClusterSize number of TTEntry. Each non-empty entry
79 /// contains information of exactly one position. The size of a cluster should
80 /// not be bigger than a cache line size. In case it is less, it should be padded
81 /// to guarantee always aligned accesses.
82
83 class TranspositionTable {
84
85 public:
86  ~TranspositionTable() { free(mem); }
87   void new_search() { generation += 4; } // Lower 2 bits are used by Bound
88
89   const TTEntry* probe(const Key key) const;
90   TTEntry* first_entry(const Key key) const;
91   void resize(size_t mbSize);
92   void clear();
93   void store(const Key key, Value v, Bound type, Depth d, Move m, Value statV);
94
95 private:
96   size_t clusterCount;
97   TTCluster* table;
98   void* mem;
99   uint8_t generation; // Size must be not bigger than TTEntry::genBound8
100 };
101
102 extern TranspositionTable TT;
103
104
105 /// TranspositionTable::first_entry() returns a pointer to the first entry of
106 /// a cluster given a position. The lowest order bits of the key are used to
107 /// get the index of the cluster inside the table.
108
109 inline TTEntry* TranspositionTable::first_entry(const Key key) const {
110
111   return &table[(size_t)key & (clusterCount - 1)].entry[0];
112 }
113
114 #endif // #ifndef TT_H_INCLUDED