Pack 3 TT entries in 32 bytes cluster
[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-2014 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>
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 TTClusterSize number of TTEntry.
32
33 void TranspositionTable::resize(uint64_t mbSize) {
34
35   assert(msb((mbSize * 1024 * 1024) / sizeof(TTCluster)) < 32);
36
37   uint32_t newClusterCount = 1 << msb((mbSize * 1024 * 1024) / sizeof(TTCluster));
38
39   if (newClusterCount == clusterCount)
40       return;
41
42   clusterCount = newClusterCount;
43
44   free(mem);
45   mem = calloc(clusterCount * sizeof(TTCluster) + CACHE_LINE_SIZE - 1, 1);
46
47   if (!mem)
48   {
49       std::cerr << "Failed to allocate " << mbSize
50                 << "MB for transposition table." << std::endl;
51       exit(EXIT_FAILURE);
52   }
53
54   table = (TTCluster*)((uintptr_t(mem) + CACHE_LINE_SIZE - 1) & ~(CACHE_LINE_SIZE - 1));
55 }
56
57
58 /// TranspositionTable::clear() overwrites the entire transposition table
59 /// with zeroes. It is called whenever the table is resized, or when the
60 /// user asks the program to clear the table (from the UCI interface).
61
62 void TranspositionTable::clear() {
63
64   std::memset(table, 0, clusterCount * sizeof(TTCluster));
65 }
66
67
68 /// TranspositionTable::probe() looks up the current position in the
69 /// transposition table. Returns a pointer to the TTEntry or NULL if
70 /// position is not found.
71
72 const TTEntry* TranspositionTable::probe(const Key key) const {
73
74   TTEntry* tte = first_entry(key);
75   uint16_t key16 = key >> 48;
76
77   for (unsigned i = 0; i < TTClusterSize; ++i, ++tte)
78       if (tte->key16 == key16)
79       {
80           tte->genBound8 = generation | tte->bound(); // Refresh
81           return tte;
82       }
83
84   return NULL;
85 }
86
87
88 /// TranspositionTable::store() writes a new entry containing position key and
89 /// valuable information of current position. The lowest order bits of position
90 /// key are used to decide in which cluster the position will be placed.
91 /// When a new entry is written and there are no empty entries available in the
92 /// cluster, it replaces the least valuable of the entries. A TTEntry t1 is considered
93 /// to be more valuable than a TTEntry t2 if t1 is from the current search and t2
94 /// is from a previous search, or if the depth of t1 is bigger than the depth of t2.
95
96 void TranspositionTable::store(const Key key, Value v, Bound b, Depth d, Move m, Value statV) {
97
98   TTEntry *tte, *replace;
99   uint16_t key16 = key >> 48; // Use the high 16 bits as key inside the cluster
100
101   tte = replace = first_entry(key);
102
103   for (unsigned i = 0; i < TTClusterSize; ++i, ++tte)
104   {
105       if (!tte->key16 || tte->key16 == key16) // Empty or overwrite old
106       {
107           if (!m)
108               m = tte->move(); // Preserve any existing ttMove
109
110           replace = tte;
111           break;
112       }
113
114       // Implement replace strategy
115       if (  ((    tte->genBound8 & 0xFC) == generation || tte->bound() == BOUND_EXACT)
116           - ((replace->genBound8 & 0xFC) == generation)
117           - (tte->depth8 < replace->depth8) < 0)
118           replace = tte;
119   }
120
121   replace->save(key16, v, b, d, m, generation, statV);
122 }