]> git.sesse.net Git - stockfish/blob - src/tt.cpp
Retire TTCluster and simplify TT
[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-2012 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::set_size() 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::set_size(size_t mbSize) {
34
35   size_t newSize = 1ULL << msb((mbSize << 20) / sizeof(TTEntry[ClusterSize]));
36
37   if (newSize == size)
38       return;
39
40   size = newSize;
41   delete [] entries;
42   entries = new (std::nothrow) TTEntry[size * ClusterSize];
43
44   if (!entries)
45   {
46       std::cerr << "Failed to allocate " << mbSize
47                 << "MB for transposition table." << std::endl;
48       exit(EXIT_FAILURE);
49   }
50
51   clear(); // Operator new is not guaranteed to initialize memory to zero
52 }
53
54
55 /// TranspositionTable::clear() overwrites the entire transposition table
56 /// with zeroes. It is called whenever the table is resized, or when the
57 /// user asks the program to clear the table (from the UCI interface).
58
59 void TranspositionTable::clear() {
60
61   memset(entries, 0, size * sizeof(TTEntry[ClusterSize]));
62 }
63
64
65 /// TranspositionTable::store() writes a new entry containing position key and
66 /// valuable information of current position. The lowest order bits of position
67 /// key are used to decide on which cluster the position will be placed.
68 /// When a new entry is written and there are no empty entries available in cluster,
69 /// it replaces the least valuable of entries. A TTEntry t1 is considered to be
70 /// more valuable than a TTEntry t2 if t1 is from the current search and t2 is from
71 /// a previous search, or if the depth of t1 is bigger than the depth of t2.
72
73 void TranspositionTable::store(const Key key, Value v, Bound t, Depth d, Move m, Value statV, Value kingD) {
74
75   int c1, c2, c3;
76   TTEntry *tte, *replace;
77   uint32_t key32 = key >> 32; // Use the high 32 bits as key inside the cluster
78
79   tte = replace = first_entry(key);
80
81   for (unsigned i = 0; i < ClusterSize; i++, tte++)
82   {
83       if (!tte->key() || tte->key() == key32) // Empty or overwrite old
84       {
85           // Preserve any existing ttMove
86           if (m == MOVE_NONE)
87               m = tte->move();
88
89           tte->save(key32, v, t, d, m, generation, statV, kingD);
90           return;
91       }
92
93       // Implement replace strategy
94       c1 = (replace->generation() == generation ?  2 : 0);
95       c2 = (tte->generation() == generation || tte->type() == BOUND_EXACT ? -2 : 0);
96       c3 = (tte->depth() < replace->depth() ?  1 : 0);
97
98       if (c1 + c2 + c3 > 0)
99           replace = tte;
100   }
101   replace->save(key32, v, t, d, m, generation, statV, kingD);
102 }
103
104
105 /// TranspositionTable::probe() looks up the current position in the
106 /// transposition table. Returns a pointer to the TTEntry or NULL if
107 /// position is not found.
108
109 TTEntry* TranspositionTable::probe(const Key key) const {
110
111   TTEntry* tte = first_entry(key);
112   uint32_t key32 = key >> 32;
113
114   for (unsigned i = 0; i < ClusterSize; i++, tte++)
115       if (tte->key() == key32)
116           return tte;
117
118   return NULL;
119 }