Update stats at pv nodes
[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-2015 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 #include <cstring>   // For std::memset
21 #include <iostream>
22
23 #include "bitboard.h"
24 #include "tt.h"
25
26 TranspositionTable TT; // Our global transposition table
27
28
29 /// TranspositionTable::resize() sets the size of the transposition table,
30 /// measured in megabytes. Transposition table consists of a power of 2 number
31 /// of clusters and each cluster consists of ClusterSize number of TTEntry.
32
33 void TranspositionTable::resize(size_t mbSize) {
34
35   size_t newClusterCount = size_t(1) << msb((mbSize * 1024 * 1024) / sizeof(Cluster));
36
37   if (newClusterCount == clusterCount)
38       return;
39
40   clusterCount = newClusterCount;
41
42   free(mem);
43   mem = calloc(clusterCount * sizeof(Cluster) + CacheLineSize - 1, 1);
44
45   if (!mem)
46   {
47       std::cerr << "Failed to allocate " << mbSize
48                 << "MB for transposition table." << std::endl;
49       exit(EXIT_FAILURE);
50   }
51
52   table = (Cluster*)((uintptr_t(mem) + CacheLineSize - 1) & ~(CacheLineSize - 1));
53 }
54
55
56 /// TranspositionTable::clear() overwrites the entire transposition table
57 /// with zeros. It is called whenever the table is resized, or when the
58 /// user asks the program to clear the table (from the UCI interface).
59
60 void TranspositionTable::clear() {
61
62   std::memset(table, 0, clusterCount * sizeof(Cluster));
63 }
64
65
66 /// TranspositionTable::probe() looks up the current position in the transposition
67 /// table. It returns true and a pointer to the TTEntry if the position is found.
68 /// Otherwise, it returns false and a pointer to an empty or least valuable TTEntry
69 /// to be replaced later. A TTEntry t1 is considered to be more valuable than a
70 /// TTEntry t2 if t1 is from the current search and t2 is from a previous search,
71 /// or if the depth of t1 is bigger than the depth of t2.
72
73 TTEntry* TranspositionTable::probe(const Key key, bool& found) const {
74
75   TTEntry* const tte = first_entry(key);
76   const uint16_t key16 = key >> 48;  // Use the high 16 bits as key inside the cluster
77
78   for (int i = 0; i < ClusterSize; ++i)
79       if (!tte[i].key16 || tte[i].key16 == key16)
80       {
81           if (tte[i].key16)
82               tte[i].genBound8 = uint8_t(generation8 | tte[i].bound()); // Refresh
83
84           return found = (bool)tte[i].key16, &tte[i];
85       }
86
87   // Find an entry to be replaced according to the replacement strategy
88   TTEntry* replace = tte;
89   for (int i = 1; i < ClusterSize; ++i)
90       if (  ((  tte[i].genBound8 & 0xFC) == generation8 || tte[i].bound() == BOUND_EXACT)
91           - ((replace->genBound8 & 0xFC) == generation8)
92           - (tte[i].depth8 < replace->depth8) < 0)
93           replace = &tte[i];
94
95   return found = false, replace;
96 }
97
98
99 /// Returns an approximation of the hashtable occupation during a search. The
100 /// hash is x permill full, as per UCI protocol.
101
102 int TranspositionTable::hashfull() const
103 {
104   int cnt = 0;
105   for (int i = 0; i < 1000 / ClusterSize; i++)
106   {
107       const TTEntry* tte = &table[i].entry[0];
108       for (int j = 0; j < ClusterSize; j++)
109           if ((tte[j].genBound8 & 0xFC) == generation8)
110               cnt++;
111   }
112   return cnt;
113 }