2 Stockfish, a UCI chess playing engine derived from Glaurung 2.1
3 Copyright (C) 2004-2021 The Stockfish developers (see AUTHORS file)
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.
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.
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/>.
19 #include <cstring> // For std::memset
31 TranspositionTable TT; // Our global transposition table
33 /// TTEntry::save() populates the TTEntry with a new node's data, possibly
34 /// overwriting an old position. Update is not atomic and can be racy.
36 void TTEntry::save(Key k, Value v, bool pv, Bound b, Depth d, Move m, Value ev) {
38 // Preserve any existing move for the same position
39 if (m || (uint16_t)k != key16)
42 // Overwrite less valuable entries (cheapest checks first)
44 || (uint16_t)k != key16
45 || d - DEPTH_OFFSET > depth8 - 4)
47 assert(d > DEPTH_OFFSET);
48 assert(d < 256 + DEPTH_OFFSET);
51 depth8 = (uint8_t)(d - DEPTH_OFFSET);
52 genBound8 = (uint8_t)(TT.generation8 | uint8_t(pv) << 2 | b);
59 /// TranspositionTable::resize() sets the size of the transposition table,
60 /// measured in megabytes. Transposition table consists of a power of 2 number
61 /// of clusters and each cluster consists of ClusterSize number of TTEntry.
63 void TranspositionTable::resize(size_t mbSize) {
65 Threads.main()->wait_for_search_finished();
67 aligned_large_pages_free(table);
69 clusterCount = mbSize * 1024 * 1024 / sizeof(Cluster);
71 table = static_cast<Cluster*>(aligned_large_pages_alloc(clusterCount * sizeof(Cluster)));
74 std::cerr << "Failed to allocate " << mbSize
75 << "MB for transposition table." << std::endl;
83 /// TranspositionTable::clear() initializes the entire transposition table to zero,
84 // in a multi-threaded way.
86 void TranspositionTable::clear() {
88 std::vector<std::thread> threads;
90 for (size_t idx = 0; idx < Options["Threads"]; ++idx)
92 threads.emplace_back([this, idx]() {
94 // Thread binding gives faster search on systems with a first-touch policy
95 if (Options["Threads"] > 8)
96 WinProcGroup::bindThisThread(idx);
98 // Each thread will zero its part of the hash table
99 const size_t stride = size_t(clusterCount / Options["Threads"]),
100 start = size_t(stride * idx),
101 len = idx != Options["Threads"] - 1 ?
102 stride : clusterCount - start;
104 std::memset(&table[start], 0, len * sizeof(Cluster));
108 for (std::thread& th : threads)
113 /// TranspositionTable::probe() looks up the current position in the transposition
114 /// table. It returns true and a pointer to the TTEntry if the position is found.
115 /// Otherwise, it returns false and a pointer to an empty or least valuable TTEntry
116 /// to be replaced later. The replace value of an entry is calculated as its depth
117 /// minus 8 times its relative age. TTEntry t1 is considered more valuable than
118 /// TTEntry t2 if its replace value is greater than that of t2.
120 TTEntry* TranspositionTable::probe(const Key key, bool& found) const {
122 TTEntry* const tte = first_entry(key);
123 const uint16_t key16 = (uint16_t)key; // Use the low 16 bits as key inside the cluster
125 for (int i = 0; i < ClusterSize; ++i)
126 if (tte[i].key16 == key16 || !tte[i].depth8)
128 tte[i].genBound8 = uint8_t(generation8 | (tte[i].genBound8 & (GENERATION_DELTA - 1))); // Refresh
130 return found = (bool)tte[i].depth8, &tte[i];
133 // Find an entry to be replaced according to the replacement strategy
134 TTEntry* replace = tte;
135 for (int i = 1; i < ClusterSize; ++i)
136 // Due to our packed storage format for generation and its cyclic
137 // nature we add GENERATION_CYCLE (256 is the modulus, plus what
138 // is needed to keep the unrelated lowest n bits from affecting
139 // the result) to calculate the entry age correctly even after
140 // generation8 overflows into the next cycle.
141 if ( replace->depth8 - ((GENERATION_CYCLE + generation8 - replace->genBound8) & GENERATION_MASK)
142 > tte[i].depth8 - ((GENERATION_CYCLE + generation8 - tte[i].genBound8) & GENERATION_MASK))
145 return found = false, replace;
149 /// TranspositionTable::hashfull() returns an approximation of the hashtable
150 /// occupation during a search. The hash is x permill full, as per UCI protocol.
152 int TranspositionTable::hashfull() const {
155 for (int i = 0; i < 1000; ++i)
156 for (int j = 0; j < ClusterSize; ++j)
157 cnt += table[i].entry[j].depth8 && (table[i].entry[j].genBound8 & GENERATION_MASK) == generation8;
159 return cnt / ClusterSize;
162 } // namespace Stockfish