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-2015 Marco Costalba, Joona Kiiski, Tord Romstad
5 Copyright (C) 2015-2020 Marco Costalba, Joona Kiiski, Gary Linscott, Tord Romstad
7 Stockfish is free software: you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation, either version 3 of the License, or
10 (at your option) any later version.
12 Stockfish is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with this program. If not, see <http://www.gnu.org/licenses/>.
21 #ifndef MISC_H_INCLUDED
22 #define MISC_H_INCLUDED
32 const std::string engine_info(bool to_uci = false);
33 const std::string compiler_info();
34 void prefetch(void* addr);
35 void start_logger(const std::string& fname);
36 void* aligned_ttmem_alloc(size_t size, void*& mem);
38 void dbg_hit_on(bool b);
39 void dbg_hit_on(bool c, bool b);
40 void dbg_mean_of(int v);
43 typedef std::chrono::milliseconds::rep TimePoint; // A value in milliseconds
45 static_assert(sizeof(TimePoint) == sizeof(int64_t), "TimePoint should be 64 bits");
47 inline TimePoint now() {
48 return std::chrono::duration_cast<std::chrono::milliseconds>
49 (std::chrono::steady_clock::now().time_since_epoch()).count();
52 template<class Entry, int Size>
54 Entry* operator[](Key key) { return &table[(uint32_t)key & (Size - 1)]; }
57 std::vector<Entry> table = std::vector<Entry>(Size); // Allocate on the heap
61 enum SyncCout { IO_LOCK, IO_UNLOCK };
62 std::ostream& operator<<(std::ostream&, SyncCout);
64 #define sync_cout std::cout << IO_LOCK
65 #define sync_endl std::endl << IO_UNLOCK
69 /// Clamp a value between lo and hi. Available in c++17.
70 template<class T> constexpr const T& clamp(const T& v, const T& lo, const T& hi) {
71 return v < lo ? lo : v > hi ? hi : v;
76 /// xorshift64star Pseudo-Random Number Generator
77 /// This class is based on original code written and dedicated
78 /// to the public domain by Sebastiano Vigna (2014).
79 /// It has the following characteristics:
81 /// - Outputs 64-bit numbers
82 /// - Passes Dieharder and SmallCrush test batteries
83 /// - Does not require warm-up, no zeroland to escape
84 /// - Internal state is a single 64-bit integer
85 /// - Period is 2^64 - 1
86 /// - Speed: 1.60 ns/call (Core i7 @3.40GHz)
88 /// For further analysis see
89 /// <http://vigna.di.unimi.it/ftp/papers/xorshift.pdf>
97 s ^= s >> 12, s ^= s << 25, s ^= s >> 27;
98 return s * 2685821657736338717LL;
102 PRNG(uint64_t seed) : s(seed) { assert(seed); }
104 template<typename T> T rand() { return T(rand64()); }
106 /// Special generator used to fast init magic numbers.
107 /// Output values only have 1/8th of their bits set on average.
108 template<typename T> T sparse_rand()
109 { return T(rand64() & rand64() & rand64()); }
113 /// Under Windows it is not possible for a process to run on more than one
114 /// logical processor group. This usually means to be limited to use max 64
115 /// cores. To overcome this, some special platform specific API should be
116 /// called to set group affinity for each thread. Original code from Texel by
117 /// Peter Ă–sterlund.
119 namespace WinProcGroup {
120 void bindThisThread(size_t idx);
123 #endif // #ifndef MISC_H_INCLUDED