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-2015 Marco Costalba, Joona Kiiski, Tord Romstad
5 Copyright (C) 2015-2018 Marco Costalba, Joona Kiiski, Gary Linscott, Tord Romstad
7 Stockfish is free software: you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation, either version 3 of the License, or
10 (at your option) any later version.
12 Stockfish is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with this program. If not, see <http://www.gnu.org/licenses/>.
21 #include <cstring> // For std::memset
30 TranspositionTable TT; // Our global transposition table
33 /// TranspositionTable::resize() sets the size of the transposition table,
34 /// measured in megabytes. Transposition table consists of a power of 2 number
35 /// of clusters and each cluster consists of ClusterSize number of TTEntry.
37 void TranspositionTable::resize(size_t mbSize) {
39 size_t newClusterCount = mbSize * 1024 * 1024 / sizeof(Cluster);
41 if (newClusterCount == clusterCount)
44 clusterCount = newClusterCount;
47 mem = malloc(clusterCount * sizeof(Cluster) + CacheLineSize - 1);
51 std::cerr << "Failed to allocate " << mbSize
52 << "MB for transposition table." << std::endl;
56 table = (Cluster*)((uintptr_t(mem) + CacheLineSize - 1) & ~(CacheLineSize - 1));
61 /// TranspositionTable::clear() overwrites the entire transposition table
62 /// with zeros. It is called whenever the table is resized, or when the
63 /// user asks the program to clear the table (from the UCI interface).
64 /// It starts as many threads as allowed by the Threads option.
66 void TranspositionTable::clear() {
68 const size_t stride = clusterCount / Options["Threads"];
69 std::vector<std::thread> threads;
70 for (size_t idx = 0; idx < Options["Threads"]; idx++)
72 const size_t start = stride * idx,
73 len = idx != Options["Threads"] - 1 ?
76 threads.push_back(std::thread([this, idx, start, len]() {
77 if (Options["Threads"] >= 8)
78 WinProcGroup::bindThisThread(idx);
79 std::memset(&table[start], 0, len * sizeof(Cluster));
83 for (std::thread& th: threads)
87 /// TranspositionTable::probe() looks up the current position in the transposition
88 /// table. It returns true and a pointer to the TTEntry if the position is found.
89 /// Otherwise, it returns false and a pointer to an empty or least valuable TTEntry
90 /// to be replaced later. The replace value of an entry is calculated as its depth
91 /// minus 8 times its relative age. TTEntry t1 is considered more valuable than
92 /// TTEntry t2 if its replace value is greater than that of t2.
94 TTEntry* TranspositionTable::probe(const Key key, bool& found) const {
96 TTEntry* const tte = first_entry(key);
97 const uint16_t key16 = key >> 48; // Use the high 16 bits as key inside the cluster
99 for (int i = 0; i < ClusterSize; ++i)
100 if (!tte[i].key16 || tte[i].key16 == key16)
102 if ((tte[i].genBound8 & 0xFC) != generation8 && tte[i].key16)
103 tte[i].genBound8 = uint8_t(generation8 | tte[i].bound()); // Refresh
105 return found = (bool)tte[i].key16, &tte[i];
108 // Find an entry to be replaced according to the replacement strategy
109 TTEntry* replace = tte;
110 for (int i = 1; i < ClusterSize; ++i)
111 // Due to our packed storage format for generation and its cyclic
112 // nature we add 259 (256 is the modulus plus 3 to keep the lowest
113 // two bound bits from affecting the result) to calculate the entry
114 // age correctly even after generation8 overflows into the next cycle.
115 if ( replace->depth8 - ((259 + generation8 - replace->genBound8) & 0xFC) * 2
116 > tte[i].depth8 - ((259 + generation8 - tte[i].genBound8) & 0xFC) * 2)
119 return found = false, replace;
123 /// TranspositionTable::hashfull() returns an approximation of the hashtable
124 /// occupation during a search. The hash is x permill full, as per UCI protocol.
126 int TranspositionTable::hashfull() const {
129 for (int i = 0; i < 1000 / ClusterSize; i++)
131 const TTEntry* tte = &table[i].entry[0];
132 for (int j = 0; j < ClusterSize; j++)
133 if ((tte[j].genBound8 & 0xFC) == generation8)