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