]> git.sesse.net Git - stockfish/blob - src/tt.cpp
d494c27d4ec654fc705d1f45b11fb844cc47314d
[stockfish] / src / tt.cpp
1 /*
2   Stockfish, a UCI chess playing engine derived from Glaurung 2.1
3   Copyright (C) 2004-2020 The Stockfish developers (see AUTHORS file)
4
5   Stockfish is free software: you can redistribute it and/or modify
6   it under the terms of the GNU General Public License as published by
7   the Free Software Foundation, either version 3 of the License, or
8   (at your option) any later version.
9
10   Stockfish is distributed in the hope that it will be useful,
11   but WITHOUT ANY WARRANTY; without even the implied warranty of
12   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13   GNU General Public License for more details.
14
15   You should have received a copy of the GNU General Public License
16   along with this program.  If not, see <http://www.gnu.org/licenses/>.
17 */
18
19 #include <cstring>   // For std::memset
20 #include <iostream>
21 #include <thread>
22
23 #include "bitboard.h"
24 #include "misc.h"
25 #include "thread.h"
26 #include "tt.h"
27 #include "uci.h"
28
29 TranspositionTable TT; // Our global transposition table
30
31 /// TTEntry::save() populates the TTEntry with a new node's data, possibly
32 /// overwriting an old position. Update is not atomic and can be racy.
33
34 void TTEntry::save(Key k, Value v, bool pv, Bound b, Depth d, Move m, Value ev) {
35
36   // Preserve any existing move for the same position
37   if (m || (uint16_t)k != key16)
38       move16 = (uint16_t)m;
39
40   // Overwrite less valuable entries
41   if ((uint16_t)k != key16
42       || d - DEPTH_OFFSET > depth8 - 4
43       || b == BOUND_EXACT)
44   {
45       assert(d >= DEPTH_OFFSET);
46
47       key16     = (uint16_t)k;
48       value16   = (int16_t)v;
49       eval16    = (int16_t)ev;
50       genBound8 = (uint8_t)(TT.generation8 | uint8_t(pv) << 2 | b);
51       depth8    = (uint8_t)(d - DEPTH_OFFSET);
52   }
53 }
54
55
56 /// TranspositionTable::resize() sets the size of the transposition table,
57 /// measured in megabytes. Transposition table consists of a power of 2 number
58 /// of clusters and each cluster consists of ClusterSize number of TTEntry.
59
60 void TranspositionTable::resize(size_t mbSize) {
61
62   Threads.main()->wait_for_search_finished();
63
64   aligned_ttmem_free(mem);
65
66   clusterCount = mbSize * 1024 * 1024 / sizeof(Cluster);
67   table = static_cast<Cluster*>(aligned_ttmem_alloc(clusterCount * sizeof(Cluster), mem));
68   if (!mem)
69   {
70       std::cerr << "Failed to allocate " << mbSize
71                 << "MB for transposition table." << std::endl;
72       exit(EXIT_FAILURE);
73   }
74
75   clear();
76 }
77
78
79 /// TranspositionTable::clear() initializes the entire transposition table to zero,
80 //  in a multi-threaded way.
81
82 void TranspositionTable::clear() {
83
84   std::vector<std::thread> threads;
85
86   for (size_t idx = 0; idx < Options["Threads"]; ++idx)
87   {
88       threads.emplace_back([this, idx]() {
89
90           // Thread binding gives faster search on systems with a first-touch policy
91           if (Options["Threads"] > 8)
92               WinProcGroup::bindThisThread(idx);
93
94           // Each thread will zero its part of the hash table
95           const size_t stride = size_t(clusterCount / Options["Threads"]),
96                        start  = size_t(stride * idx),
97                        len    = idx != Options["Threads"] - 1 ?
98                                 stride : clusterCount - start;
99
100           std::memset(&table[start], 0, len * sizeof(Cluster));
101       });
102   }
103
104   for (std::thread& th : threads)
105       th.join();
106 }
107
108
109 /// TranspositionTable::probe() looks up the current position in the transposition
110 /// table. It returns true and a pointer to the TTEntry if the position is found.
111 /// Otherwise, it returns false and a pointer to an empty or least valuable TTEntry
112 /// to be replaced later. The replace value of an entry is calculated as its depth
113 /// minus 8 times its relative age. TTEntry t1 is considered more valuable than
114 /// TTEntry t2 if its replace value is greater than that of t2.
115
116 TTEntry* TranspositionTable::probe(const Key key, bool& found) const {
117
118   TTEntry* const tte = first_entry(key);
119   const uint16_t key16 = (uint16_t)key;  // Use the low 16 bits as key inside the cluster
120
121   for (int i = 0; i < ClusterSize; ++i)
122       if (!tte[i].key16 || tte[i].key16 == key16)
123       {
124           tte[i].genBound8 = uint8_t(generation8 | (tte[i].genBound8 & 0x7)); // Refresh
125
126           return found = (bool)tte[i].key16, &tte[i];
127       }
128
129   // Find an entry to be replaced according to the replacement strategy
130   TTEntry* replace = tte;
131   for (int i = 1; i < ClusterSize; ++i)
132       // Due to our packed storage format for generation and its cyclic
133       // nature we add 263 (256 is the modulus plus 7 to keep the unrelated
134       // lowest three bits from affecting the result) to calculate the entry
135       // age correctly even after generation8 overflows into the next cycle.
136       if (  replace->depth8 - ((263 + generation8 - replace->genBound8) & 0xF8)
137           >   tte[i].depth8 - ((263 + generation8 -   tte[i].genBound8) & 0xF8))
138           replace = &tte[i];
139
140   return found = false, replace;
141 }
142
143
144 /// TranspositionTable::hashfull() returns an approximation of the hashtable
145 /// occupation during a search. The hash is x permill full, as per UCI protocol.
146
147 int TranspositionTable::hashfull() const {
148
149   int cnt = 0;
150   for (int i = 0; i < 1000; ++i)
151       for (int j = 0; j < ClusterSize; ++j)
152           cnt += (table[i].entry[j].genBound8 & 0xF8) == generation8;
153
154   return cnt / ClusterSize;
155 }