Revert store of distinct upper and lower bounds
[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 TranspositionTable::TranspositionTable() {
29
30   size = generation = 0;
31   entries = NULL;
32 }
33
34 TranspositionTable::~TranspositionTable() {
35
36   delete [] entries;
37 }
38
39
40 /// TranspositionTable::set_size() sets the size of the transposition table,
41 /// measured in megabytes. Transposition table consists of a power of 2 number of
42 /// TTCluster and each cluster consists of ClusterSize number of TTEntries. Each
43 /// non-empty entry contains information of exactly one position.
44
45 void TranspositionTable::set_size(size_t mbSize) {
46
47   size_t newSize = 1ULL << msb((mbSize << 20) / sizeof(TTCluster));
48
49   if (newSize == size)
50       return;
51
52   size = newSize;
53   delete [] entries;
54   entries = new (std::nothrow) TTCluster[size];
55
56   if (!entries)
57   {
58       std::cerr << "Failed to allocate " << mbSize
59                 << "MB for transposition table." << std::endl;
60       exit(EXIT_FAILURE);
61   }
62
63   clear(); // Operator new is not guaranteed to initialize memory to zero
64 }
65
66
67 /// TranspositionTable::clear() overwrites the entire transposition table
68 /// with zeroes. It is called whenever the table is resized, or when the
69 /// user asks the program to clear the table (from the UCI interface).
70
71 void TranspositionTable::clear() {
72
73   memset(entries, 0, size * sizeof(TTCluster));
74 }
75
76
77 /// TranspositionTable::store() writes a new entry containing position key and
78 /// valuable information of current position. The lowest order bits of position
79 /// key are used to decide on which cluster the position will be placed.
80 /// When a new entry is written and there are no empty entries available in cluster,
81 /// it replaces the least valuable of entries. A TTEntry t1 is considered to be
82 /// more valuable than a TTEntry t2 if t1 is from the current search and t2 is from
83 /// a previous search, or if the depth of t1 is bigger than the depth of t2.
84
85 void TranspositionTable::store(const Key posKey, Value v, Bound t, Depth d, Move m) {
86
87   int c1, c2, c3;
88   TTEntry *tte, *replace;
89   uint32_t posKey32 = posKey >> 32; // Use the high 32 bits as key inside the cluster
90
91   tte = replace = first_entry(posKey);
92
93   for (int i = 0; i < ClusterSize; i++, tte++)
94   {
95       if (!tte->key() || tte->key() == posKey32) // Empty or overwrite old
96       {
97           // Preserve any existing ttMove
98           if (m == MOVE_NONE)
99               m = tte->move();
100
101           tte->save(posKey32, v, t, d, m, generation);
102           return;
103       }
104
105       // Implement replace strategy
106       c1 = (replace->generation() == generation ?  2 : 0);
107       c2 = (tte->generation() == generation || tte->type() == BOUND_EXACT ? -2 : 0);
108       c3 = (tte->depth() < replace->depth() ?  1 : 0);
109
110       if (c1 + c2 + c3 > 0)
111           replace = tte;
112   }
113   replace->save(posKey32, v, t, d, m, generation);
114 }
115
116
117 /// TranspositionTable::probe() looks up the current position in the
118 /// transposition table. Returns a pointer to the TTEntry or NULL if
119 /// position is not found.
120
121 TTEntry* TranspositionTable::probe(const Key posKey) const {
122
123   uint32_t posKey32 = posKey >> 32;
124   TTEntry* tte = first_entry(posKey);
125
126   for (int i = 0; i < ClusterSize; i++, tte++)
127       if (tte->key() == posKey32)
128           return tte;
129
130   return NULL;
131 }
132
133
134 /// TranspositionTable::new_search() is called at the beginning of every new
135 /// search. It increments the "generation" variable, which is used to
136 /// distinguish transposition table entries from previous searches from
137 /// entries from the current search.
138
139 void TranspositionTable::new_search() {
140   generation++;
141 }