/*
Stockfish, a UCI chess playing engine derived from Glaurung 2.1
Copyright (C) 2004-2008 Tord Romstad (Glaurung author)
- Copyright (C) 2008-2010 Marco Costalba, Joona Kiiski, Tord Romstad
+ Copyright (C) 2008-2014 Marco Costalba, Joona Kiiski, Tord Romstad
Stockfish is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
-
-#if !defined(TT_H_INCLUDED)
+#ifndef TT_H_INCLUDED
#define TT_H_INCLUDED
-#include <iostream>
-
-#include "depth.h"
-#include "move.h"
-#include "value.h"
-
-
-////
-//// Types
-////
-
+#include "misc.h"
+#include "types.h"
-/// A simple fixed size hash table used to store pawns and material
-/// configurations. It is basically just an array of Entry objects.
-/// Without cluster concept or overwrite policy.
-
-template<class Entry, int HashSize>
-class SimpleHash {
-
- SimpleHash(const SimpleHash&);
- SimpleHash& operator=(const SimpleHash&);
-
-public:
- SimpleHash() {
-
- entries = new Entry[HashSize];
- if (!entries)
- {
- std::cerr << "Failed to allocate " << HashSize * sizeof(Entry)
- << " bytes for material hash table." << std::endl;
- exit(EXIT_FAILURE);
- }
- memset(entries, 0, HashSize * sizeof(Entry));
- }
-
- ~SimpleHash() { delete [] entries; }
-
- Entry* find(Key key) const { return entries + ((uint32_t)key & (HashSize - 1)); }
-
-protected:
- Entry* entries;
-};
-
-
-/// The TTEntry class is the class of transposition table entries
-///
-/// A TTEntry needs 128 bits to be stored
+/// The TTEntry is the 10 bytes transposition table entry, defined as below:
///
-/// bit 0-31: key
-/// bit 32-63: data
-/// bit 64-79: value
-/// bit 80-95: depth
-/// bit 96-111: static value
-/// bit 112-127: margin of static value
-///
-/// the 32 bits of the data field are so defined
-///
-/// bit 0-15: move
-/// bit 16-20: not used
-/// bit 21-22: value type
-/// bit 23-31: generation
+/// key 16 bit
+/// move 16 bit
+/// value 16 bit
+/// eval value 16 bit
+/// generation 6 bit
+/// bound type 2 bit
+/// depth 8 bit
+
+struct TTEntry {
+
+ Move move() const { return (Move )move16; }
+ Value value() const { return (Value)value16; }
+ Value eval_value() const { return (Value)evalValue; }
+ Depth depth() const { return (Depth)depth8; }
+ Bound bound() const { return (Bound)(genBound8 & 0x3); }
-class TTEntry {
+private:
+ friend class TranspositionTable;
-public:
- void save(uint32_t k, Value v, ValueType t, Depth d, Move m, int g, Value statV, Value statM) {
-
- key32 = (uint32_t)k;
- move16 = (uint16_t)m;
- valueType = (uint8_t)t;
- generation8 = (uint8_t)g;
- value16 = (int16_t)v;
- depth16 = (int16_t)d;
- staticValue = (int16_t)statV;
- staticMargin = (int16_t)statM;
- }
- void set_generation(int g) { generation8 = (uint8_t)g; }
+ void save(uint16_t k, Value v, Bound b, Depth d, Move m, uint8_t g, Value ev) {
- uint32_t key() const { return key32; }
- Depth depth() const { return Depth(depth16); }
- Move move() const { return Move(move16); }
- Value value() const { return Value(value16); }
- ValueType type() const { return ValueType(valueType); }
- int generation() const { return generation8; }
- Value static_value() const { return Value(staticValue); }
- Value static_value_margin() const { return Value(staticMargin); }
+ key16 = (uint16_t)k;
+ move16 = (uint16_t)m;
+ value16 = (int16_t)v;
+ evalValue = (int16_t)ev;
+ genBound8 = (uint8_t)(g | b);
+ depth8 = (int8_t)d;
+ }
-private:
- uint32_t key32;
+ uint16_t key16;
uint16_t move16;
- uint8_t valueType;
- uint8_t generation8;
- int16_t value16;
- int16_t depth16;
- int16_t staticValue;
- int16_t staticMargin;
+ int16_t value16;
+ int16_t evalValue;
+ uint8_t genBound8;
+ int8_t depth8;
};
+/// TTCluster is a 32 bytes cluster of TT entries consisting of:
+///
+/// 3 x TTEntry (3 x 10 bytes)
+/// padding (2 bytes)
-/// This is the number of TTEntry slots for each cluster
-const int ClusterSize = 4;
-
-/// TTCluster consists of ClusterSize number of TTEntries.
-/// Size of TTCluster must not be bigger than a cache line size.
-/// In case it is less, it should be padded to guarantee always aligned accesses.
+const unsigned TTClusterSize = 3;
struct TTCluster {
- TTEntry data[ClusterSize];
+ TTEntry entry[TTClusterSize];
+ char padding[2];
};
-
-/// The transposition table class. This is basically just a huge array
-/// containing TTCluster objects, and a few methods for writing new entries
-/// and reading new ones.
+/// A TranspositionTable consists of a power of 2 number of clusters and each
+/// cluster consists of TTClusterSize number of TTEntry. Each non-empty entry
+/// contains information of exactly one position. The size of a cluster should
+/// not be bigger than a cache line size. In case it is less, it should be padded
+/// to guarantee always aligned accesses.
class TranspositionTable {
- TranspositionTable(const TranspositionTable&);
- TranspositionTable& operator=(const TranspositionTable&);
-
public:
- TranspositionTable();
- ~TranspositionTable();
- void set_size(size_t mbSize);
+ ~TranspositionTable() { free(mem); }
+ void new_search() { generation += 4; } // Lower 2 bits are used by Bound
+
+ const TTEntry* probe(const Key key) const;
+ TTEntry* first_entry(const Key key) const;
+ void resize(size_t mbSize);
void clear();
- void store(const Key posKey, Value v, ValueType type, Depth d, Move m, Value statV, Value kingD);
- TTEntry* retrieve(const Key posKey) const;
- void new_search();
- TTEntry* first_entry(const Key posKey) const;
- void refresh(const TTEntry* tte) const;
+ void store(const Key key, Value v, Bound type, Depth d, Move m, Value statV);
private:
- size_t size;
- TTCluster* entries;
- uint8_t generation; // To properly compare, size must be smaller then TT stored value
+ size_t clusterCount;
+ TTCluster* table;
+ void* mem;
+ uint8_t generation; // Size must be not bigger than TTEntry::genBound8
};
extern TranspositionTable TT;
-/// TranspositionTable::first_entry returns a pointer to the first
-/// entry of a cluster given a position. The lowest order bits of the key
-/// are used to get the index of the cluster.
-
-inline TTEntry* TranspositionTable::first_entry(const Key posKey) const {
-
- return entries[((uint32_t)posKey) & (size - 1)].data;
-}
-
-
-/// TranspositionTable::refresh updates the 'generation' value of the TTEntry
-/// to avoid aging. Normally called after a TT hit, before to return.
+/// TranspositionTable::first_entry() returns a pointer to the first entry of
+/// a cluster given a position. The lowest order bits of the key are used to
+/// get the index of the cluster inside the table.
-inline void TranspositionTable::refresh(const TTEntry* tte) const {
+inline TTEntry* TranspositionTable::first_entry(const Key key) const {
- const_cast<TTEntry*>(tte)->set_generation(generation);
+ return &table[(size_t)key & (clusterCount - 1)].entry[0];
}
-#endif // !defined(TT_H_INCLUDED)
+#endif // #ifndef TT_H_INCLUDED