/*
Stockfish, a UCI chess playing engine derived from Glaurung 2.1
- Copyright (C) 2004-2008 Tord Romstad (Glaurung author)
- Copyright (C) 2008-2013 Marco Costalba, Joona Kiiski, Tord Romstad
+ Copyright (C) 2004-2024 The Stockfish developers (see AUTHORS file)
Stockfish is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
#ifndef TT_H_INCLUDED
#define TT_H_INCLUDED
-#include "misc.h"
+#include <cstddef>
+#include <cstdint>
+#include <tuple>
+
+#include "memory.h"
#include "types.h"
-/// The TTEntry is the 128 bit transposition table entry, defined as below:
-///
-/// key: 32 bit
-/// move: 16 bit
-/// bound type: 8 bit
-/// generation: 8 bit
-/// value: 16 bit
-/// depth: 16 bit
-/// static value: 16 bit
-/// static margin: 16 bit
-
-struct TTEntry {
-
- void save(uint32_t k, Value v, Bound b, Depth d, Move m, int g, Value ev, Value em) {
-
- key32 = (uint32_t)k;
- move16 = (uint16_t)m;
- bound8 = (uint8_t)b;
- generation8 = (uint8_t)g;
- value16 = (int16_t)v;
- depth16 = (int16_t)d;
- evalValue = (int16_t)ev;
- evalMargin = (int16_t)em;
- }
- void set_generation(uint8_t g) { generation8 = g; }
-
- uint32_t key() const { return key32; }
- Depth depth() const { return (Depth)depth16; }
- Move move() const { return (Move)move16; }
- Value value() const { return (Value)value16; }
- Bound bound() const { return (Bound)bound8; }
- int generation() const { return (int)generation8; }
- Value eval_value() const { return (Value)evalValue; }
- Value eval_margin() const { return (Value)evalMargin; }
-
-private:
- uint32_t key32;
- uint16_t move16;
- uint8_t bound8, generation8;
- int16_t value16, depth16, evalValue, evalMargin;
+namespace Stockfish {
+
+class ThreadPool;
+struct TTEntry;
+struct Cluster;
+
+// There is only one global hash table for the engine and all its threads. For chess in particular, we even allow racy
+// updates between threads to and from the TT, as taking the time to synchronize access would cost thinking time and
+// thus elo. As a hash table, collisions are possible and may cause chess playing issues (bizarre blunders, faulty mate
+// reports, etc). Fixing these also loses elo; however such risk decreases quickly with larger TT size.
+//
+// `probe` is the primary method: given a board position, we lookup its entry in the table, and return a tuple of:
+// 1) whether the entry already has this position
+// 2) a copy of the prior data (if any) (may be inconsistent due to read races)
+// 3) a writer object to this entry
+// The copied data and the writer are separated to maintain clear boundaries between local vs global objects.
+
+
+// A copy of the data already in the entry (possibly collided). `probe` may be racy, resulting in inconsistent data.
+struct TTData {
+ Move move;
+ Value value, eval;
+ Depth depth;
+ Bound bound;
+ bool is_pv;
};
-/// A TranspositionTable consists of a power of 2 number of clusters and each
-/// cluster consists of ClusterSize number of TTEntry. Each non-empty entry
-/// contains information of exactly one position. Size of a cluster shall not be
-/// bigger than a cache line size. In case it is less, it should be padded to
-/// guarantee always aligned accesses.
-
-class TranspositionTable {
-
- static const unsigned ClusterSize = 4; // A cluster is 64 Bytes
-
-public:
- ~TranspositionTable() { free(mem); }
- void new_search() { ++generation; }
-
- const TTEntry* probe(const Key key) const;
- TTEntry* first_entry(const Key key) const;
- void refresh(const TTEntry* tte) const;
- void set_size(size_t mbSize);
- void clear();
- void store(const Key key, Value v, Bound type, Depth d, Move m, Value statV, Value kingD);
+// This is used to make racy writes to the global TT.
+struct TTWriter {
+ public:
+ void write(Key k, Value v, bool pv, Bound b, Depth d, Move m, Value ev, uint8_t generation8);
-private:
- uint32_t hashMask;
- TTEntry* table;
- void* mem;
- uint8_t generation; // Size must be not bigger than TTEntry::generation8
+ private:
+ friend class TranspositionTable;
+ TTEntry* entry;
+ TTWriter(TTEntry* tte);
};
-extern TranspositionTable TT;
+class TranspositionTable {
-/// 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.
+ public:
+ ~TranspositionTable() { aligned_large_pages_free(table); }
-inline TTEntry* TranspositionTable::first_entry(const Key key) const {
+ void resize(size_t mbSize, ThreadPool& threads); // Set TT size
+ void clear(ThreadPool& threads); // Re-initialize memory, multithreaded
+ int hashfull()
+ const; // Approximate what fraction of entries (permille) have been written to during this root search
- return table + ((uint32_t)key & hashMask);
-}
+ void
+ new_search(); // This must be called at the beginning of each root search to track entry aging
+ uint8_t generation() const; // The current age, used when writing new data to the TT
+ std::tuple<bool, TTData, TTWriter>
+ probe(const Key key) const; // The main method, whose retvals separate local vs global objects
+ TTEntry* first_entry(const Key key)
+ const; // This is the hash function; its only external use is memory prefetching.
+ private:
+ friend struct TTEntry;
-/// TranspositionTable::refresh() updates the 'generation' value of the TTEntry
-/// to avoid aging. Normally called after a TT hit.
+ size_t clusterCount;
+ Cluster* table = nullptr;
-inline void TranspositionTable::refresh(const TTEntry* tte) const {
+ uint8_t generation8 = 0; // Size must be not bigger than TTEntry::genBound8
+};
- const_cast<TTEntry*>(tte)->set_generation(generation);
-}
+} // namespace Stockfish
-#endif // #ifndef TT_H_INCLUDED
+#endif // #ifndef TT_H_INCLUDED
projects / stockfish / blobdiff