935336dac3c7354e23c878fd1ba62d1a22adf72a
[stockfish] / src / tt.cpp
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-2010 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
21 ////
22 //// Includes
23 ////
24
25 #include <cassert>
26 #include <cmath>
27 #include <cstring>
28 #if !defined(__hpux)
29 #  include <xmmintrin.h>
30 #endif
31
32 #include "movegen.h"
33 #include "tt.h"
34
35 // The main transposition table
36 TranspositionTable TT;
37
38 ////
39 //// Functions
40 ////
41
42 TranspositionTable::TranspositionTable() {
43
44   size = writes = 0;
45   entries = 0;
46   generation = 0;
47 }
48
49 TranspositionTable::~TranspositionTable() {
50
51   delete [] entries;
52 }
53
54
55 /// TranspositionTable::set_size sets the size of the transposition table,
56 /// measured in megabytes.
57
58 void TranspositionTable::set_size(size_t mbSize) {
59
60   size_t newSize = 1024;
61
62   // We store a cluster of ClusterSize number of TTEntry for each position
63   // and newSize is the maximum number of storable positions.
64   while ((2 * newSize) * sizeof(TTCluster) <= (mbSize << 20))
65       newSize *= 2;
66
67   if (newSize != size)
68   {
69       size = newSize;
70       delete [] entries;
71       entries = new TTCluster[size];
72       if (!entries)
73       {
74           std::cerr << "Failed to allocate " << mbSize
75                     << " MB for transposition table." << std::endl;
76           Application::exit_with_failure();
77       }
78       clear();
79   }
80 }
81
82
83 /// TranspositionTable::clear overwrites the entire transposition table
84 /// with zeroes. It is called whenever the table is resized, or when the
85 /// user asks the program to clear the table (from the UCI interface).
86 /// Perhaps we should also clear it when the "ucinewgame" command is recieved?
87
88 void TranspositionTable::clear() {
89
90   memset(entries, 0, size * sizeof(TTCluster));
91 }
92
93
94 /// TranspositionTable::first_entry returns a pointer to the first
95 /// entry of a cluster given a position. The low 32 bits of the key
96 /// are used to get the index in the table.
97
98 inline TTEntry* TranspositionTable::first_entry(const Key posKey) const {
99
100   return entries[uint32_t(posKey) & (size - 1)].data;
101 }
102
103
104 /// TranspositionTable::store writes a new entry containing a position,
105 /// a value, a value type, a search depth, and a best move to the
106 /// transposition table. Transposition table is organized in clusters of
107 /// four TTEntry objects, and when a new entry is written, it replaces
108 /// the least valuable of the four entries in a cluster. A TTEntry t1 is
109 /// considered to be more valuable than a TTEntry t2 if t1 is from the
110 /// current search and t2 is from a previous search, or if the depth of t1
111 /// is bigger than the depth of t2. A TTEntry of type VALUE_TYPE_EVAL
112 /// never replaces another entry for the same position.
113
114 void TranspositionTable::store(const Key posKey, Value v, ValueType t, Depth d, Move m) {
115
116   TTEntry *tte, *replace;
117   uint32_t posKey32 = posKey >> 32; // Use the high 32 bits as key
118
119   tte = replace = first_entry(posKey);
120   for (int i = 0; i < ClusterSize; i++, tte++)
121   {
122       if (!tte->key() || tte->key() == posKey32) // empty or overwrite old
123       {
124           // Do not overwrite when new type is VALUE_TYPE_EV_LO
125           if (tte->key() && t == VALUE_TYPE_EV_LO)
126               return;
127
128           if (m == MOVE_NONE)
129               m = tte->move();
130
131           *tte = TTEntry(posKey32, v, t, d, m, generation);
132           return;
133       }
134       else if (i == 0)  // replace would be a no-op in this common case
135           continue;
136
137       int c1 = (replace->generation() == generation ?  2 : 0);
138       int c2 = (tte->generation() == generation ? -2 : 0);
139       int c3 = (tte->depth() < replace->depth() ?  1 : 0);
140
141       if (c1 + c2 + c3 > 0)
142           replace = tte;
143   }
144   *replace = TTEntry(posKey32, v, t, d, m, generation);
145   writes++;
146 }
147
148
149 /// TranspositionTable::retrieve looks up the current position in the
150 /// transposition table. Returns a pointer to the TTEntry or NULL
151 /// if position is not found.
152
153 TTEntry* TranspositionTable::retrieve(const Key posKey) const {
154
155   uint32_t posKey32 = posKey >> 32;
156   TTEntry* tte = first_entry(posKey);
157
158   for (int i = 0; i < ClusterSize; i++, tte++)
159       if (tte->key() == posKey32)
160           return tte;
161
162   return NULL;
163 }
164
165
166 /// TranspositionTable::prefetch looks up the current position in the
167 /// transposition table and load it in L1/L2 cache. This is a non
168 /// blocking function and do not stalls the CPU waiting for data
169 /// to be loaded from RAM, that can be very slow. When we will
170 /// subsequently call retrieve() the TT data will be already
171 /// quickly accessible in L1/L2 CPU cache.
172 #if defined(__hpux)
173 void TranspositionTable::prefetch(const Key) const {} // Not supported on HP UX
174 #else
175
176 void TranspositionTable::prefetch(const Key posKey) const {
177
178 #if defined(__INTEL_COMPILER) || defined(__ICL)
179    // This hack prevents prefetches to be optimized away by
180    // Intel compiler. Both MSVC and gcc seems not affected.
181    __asm__ ("");
182 #endif
183
184    char const* addr = (char*)first_entry(posKey);
185   _mm_prefetch(addr, _MM_HINT_T2);
186   _mm_prefetch(addr+64, _MM_HINT_T2); // 64 bytes ahead
187 }
188
189 #endif
190
191 /// TranspositionTable::new_search() is called at the beginning of every new
192 /// search. It increments the "generation" variable, which is used to
193 /// distinguish transposition table entries from previous searches from
194 /// entries from the current search.
195
196 void TranspositionTable::new_search() {
197
198   generation++;
199   writes = 0;
200 }
201
202
203 /// TranspositionTable::insert_pv() is called at the end of a search
204 /// iteration, and inserts the PV back into the PV. This makes sure
205 /// the old PV moves are searched first, even if the old TT entries
206 /// have been overwritten.
207
208 void TranspositionTable::insert_pv(const Position& pos, Move pv[]) {
209
210   StateInfo st;
211   Position p(pos);
212
213   for (int i = 0; pv[i] != MOVE_NONE; i++)
214   {
215       TTEntry *tte = retrieve(p.get_key());
216       if (!tte || tte->move() != pv[i])
217           store(p.get_key(), VALUE_NONE, VALUE_TYPE_NONE, Depth(-127*OnePly), pv[i]);
218       p.do_move(pv[i], st);
219   }
220 }
221
222
223 /// TranspositionTable::extract_pv() extends a PV by adding moves from the
224 /// transposition table at the end. This should ensure that the PV is almost
225 /// always at least two plies long, which is important, because otherwise we
226 /// will often get single-move PVs when the search stops while failing high,
227 /// and a single-move PV means that we don't have a ponder move.
228
229 void TranspositionTable::extract_pv(const Position& pos, Move pv[], const int PLY_MAX) {
230
231   const TTEntry* tte;
232   StateInfo st;
233   Position p(pos);
234   int ply = 0;
235
236   // Update position to the end of current PV
237   while (pv[ply] != MOVE_NONE)
238       p.do_move(pv[ply++], st);
239
240   // Try to add moves from TT while possible
241   while (   (tte = retrieve(p.get_key())) != NULL
242          && tte->move() != MOVE_NONE
243          && move_is_legal(p, tte->move())
244          && (!p.is_draw() || ply < 2)
245          && ply < PLY_MAX)
246   {
247       pv[ply] = tte->move();
248       p.do_move(pv[ply++], st);
249   }
250   pv[ply] = MOVE_NONE;
251 }
252
253
254 /// TranspositionTable::full() returns the permill of all transposition table
255 /// entries which have received at least one write during the current search.
256 /// It is used to display the "info hashfull ..." information in UCI.
257
258 int TranspositionTable::full() const {
259
260   double N = double(size) * ClusterSize;
261   return int(1000 * (1 - exp(writes * log(1.0 - 1.0/N))));
262 }