]> git.sesse.net Git - stockfish/blob - src/tt.cpp
VLTC Search parameters tune
[stockfish] / src / tt.cpp
1 /*
2   Stockfish, a UCI chess playing engine derived from Glaurung 2.1
3   Copyright (C) 2004-2023 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 "tt.h"
20
21 #include <cassert>
22 #include <cstdlib>
23 #include <cstring>
24 #include <iostream>
25 #include <thread>
26 #include <vector>
27
28 #include "misc.h"
29 #include "thread.h"
30 #include "uci.h"
31
32 namespace Stockfish {
33
34 TranspositionTable TT;  // Our global transposition table
35
36 // Populates the TTEntry with a new node's data, possibly
37 // overwriting an old position. The update is not atomic and can be racy.
38 void TTEntry::save(Key k, Value v, bool pv, Bound b, Depth d, Move m, Value ev) {
39
40     // Preserve any existing move for the same position
41     if (m || uint16_t(k) != key16)
42         move16 = uint16_t(m);
43
44     // Overwrite less valuable entries (cheapest checks first)
45     if (b == BOUND_EXACT || uint16_t(k) != key16 || d - DEPTH_OFFSET + 2 * pv > depth8 - 4)
46     {
47         assert(d > DEPTH_OFFSET);
48         assert(d < 256 + DEPTH_OFFSET);
49
50         key16     = uint16_t(k);
51         depth8    = uint8_t(d - DEPTH_OFFSET);
52         genBound8 = uint8_t(TT.generation8 | uint8_t(pv) << 2 | b);
53         value16   = int16_t(v);
54         eval16    = int16_t(ev);
55     }
56 }
57
58
59 // 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.
62 void TranspositionTable::resize(size_t mbSize) {
63
64     Threads.main()->wait_for_search_finished();
65
66     aligned_large_pages_free(table);
67
68     clusterCount = mbSize * 1024 * 1024 / sizeof(Cluster);
69
70     table = static_cast<Cluster*>(aligned_large_pages_alloc(clusterCount * sizeof(Cluster)));
71     if (!table)
72     {
73         std::cerr << "Failed to allocate " << mbSize << "MB for transposition table." << std::endl;
74         exit(EXIT_FAILURE);
75     }
76
77     clear();
78 }
79
80
81 // Initializes the entire transposition table to zero,
82 // in a multi-threaded way.
83 void TranspositionTable::clear() {
84
85     std::vector<std::thread> threads;
86
87     for (size_t idx = 0; idx < size_t(Options["Threads"]); ++idx)
88     {
89         threads.emplace_back([this, idx]() {
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 =
98                            idx != size_t(Options["Threads"]) - 1 ? 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 // 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 TTEntry* TranspositionTable::probe(const Key key, bool& found) const {
116
117     TTEntry* const tte   = first_entry(key);
118     const uint16_t key16 = uint16_t(key);  // Use the low 16 bits as key inside the cluster
119
120     for (int i = 0; i < ClusterSize; ++i)
121         if (tte[i].key16 == key16 || !tte[i].depth8)
122         {
123             tte[i].genBound8 =
124               uint8_t(generation8 | (tte[i].genBound8 & (GENERATION_DELTA - 1)));  // Refresh
125
126             return found = bool(tte[i].depth8), &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 GENERATION_CYCLE (256 is the modulus, plus what
134         // is needed to keep the unrelated lowest n bits from affecting
135         // the result) to calculate the entry age correctly even after
136         // generation8 overflows into the next cycle.
137         if (replace->depth8
138               - ((GENERATION_CYCLE + generation8 - replace->genBound8) & GENERATION_MASK)
139             > tte[i].depth8
140                 - ((GENERATION_CYCLE + generation8 - tte[i].genBound8) & GENERATION_MASK))
141             replace = &tte[i];
142
143     return found = false, replace;
144 }
145
146
147 // Returns an approximation of the hashtable
148 // occupation during a search. The hash is x permill full, as per UCI protocol.
149
150 int TranspositionTable::hashfull() const {
151
152     int cnt = 0;
153     for (int i = 0; i < 1000; ++i)
154         for (int j = 0; j < ClusterSize; ++j)
155             cnt += table[i].entry[j].depth8
156                 && (table[i].entry[j].genBound8 & GENERATION_MASK) == generation8;
157
158     return cnt / ClusterSize;
159 }
160
161 }  // namespace Stockfish