2 Stockfish, a UCI chess playing engine derived from Glaurung 2.1
3 Copyright (C) 2004-2021 The Stockfish developers (see AUTHORS file)
5 Stockfish is free software: you can redistribute it and/or modify
6 it under the terms of the GNU General Public License as published by
7 the Free Software Foundation, either version 3 of the License, or
8 (at your option) any later version.
10 Stockfish is distributed in the hope that it will be useful,
11 but WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 GNU General Public License for more details.
15 You should have received a copy of the GNU General Public License
16 along with this program. If not, see <http://www.gnu.org/licenses/>.
19 #ifndef MISC_H_INCLUDED
20 #define MISC_H_INCLUDED
33 std::string engine_info(bool to_uci = false);
34 std::string compiler_info();
35 void prefetch(void* addr);
36 void start_logger(const std::string& fname);
37 void* std_aligned_alloc(size_t alignment, size_t size);
38 void std_aligned_free(void* ptr);
39 void* aligned_large_pages_alloc(size_t size); // memory aligned by page size, min alignment: 4096 bytes
40 void aligned_large_pages_free(void* mem); // nop if mem == nullptr
42 void dbg_hit_on(bool b);
43 void dbg_hit_on(bool c, bool b);
44 void dbg_mean_of(int v);
47 typedef std::chrono::milliseconds::rep TimePoint; // A value in milliseconds
48 static_assert(sizeof(TimePoint) == sizeof(int64_t), "TimePoint should be 64 bits");
49 inline TimePoint now() {
50 return std::chrono::duration_cast<std::chrono::milliseconds>
51 (std::chrono::steady_clock::now().time_since_epoch()).count();
54 template<class Entry, int Size>
56 Entry* operator[](Key key) { return &table[(uint32_t)key & (Size - 1)]; }
59 std::vector<Entry> table = std::vector<Entry>(Size); // Allocate on the heap
63 enum SyncCout { IO_LOCK, IO_UNLOCK };
64 std::ostream& operator<<(std::ostream&, SyncCout);
66 #define sync_cout std::cout << IO_LOCK
67 #define sync_endl std::endl << IO_UNLOCK
69 // `ptr` must point to an array of size at least
70 // `sizeof(T) * N + alignment` bytes, where `N` is the
71 // number of elements in the array.
72 template <uintptr_t Alignment, typename T>
73 T* align_ptr_up(T* ptr)
75 static_assert(alignof(T) < Alignment);
77 const uintptr_t ptrint = reinterpret_cast<uintptr_t>(reinterpret_cast<char*>(ptr));
78 return reinterpret_cast<T*>(reinterpret_cast<char*>((ptrint + (Alignment - 1)) / Alignment * Alignment));
82 class ValueListInserter {
84 ValueListInserter(T* v, std::size_t& s) :
90 void push_back(const T& value) { values[(*size)++] = value; }
96 template <typename T, std::size_t MaxSize>
100 std::size_t size() const { return size_; }
101 void resize(std::size_t newSize) { size_ = newSize; }
102 void push_back(const T& value) { values_[size_++] = value; }
103 T& operator[](std::size_t index) { return values_[index]; }
104 T* begin() { return values_; }
105 T* end() { return values_ + size_; }
106 const T& operator[](std::size_t index) const { return values_[index]; }
107 const T* begin() const { return values_; }
108 const T* end() const { return values_ + size_; }
109 operator ValueListInserter<T>() { return ValueListInserter(values_, size_); }
111 void swap(ValueList& other) {
112 const std::size_t maxSize = std::max(size_, other.size_);
113 for (std::size_t i = 0; i < maxSize; ++i) {
114 std::swap(values_[i], other.values_[i]);
116 std::swap(size_, other.size_);
121 std::size_t size_ = 0;
124 /// xorshift64star Pseudo-Random Number Generator
125 /// This class is based on original code written and dedicated
126 /// to the public domain by Sebastiano Vigna (2014).
127 /// It has the following characteristics:
129 /// - Outputs 64-bit numbers
130 /// - Passes Dieharder and SmallCrush test batteries
131 /// - Does not require warm-up, no zeroland to escape
132 /// - Internal state is a single 64-bit integer
133 /// - Period is 2^64 - 1
134 /// - Speed: 1.60 ns/call (Core i7 @3.40GHz)
136 /// For further analysis see
137 /// <http://vigna.di.unimi.it/ftp/papers/xorshift.pdf>
145 s ^= s >> 12, s ^= s << 25, s ^= s >> 27;
146 return s * 2685821657736338717LL;
150 PRNG(uint64_t seed) : s(seed) { assert(seed); }
152 template<typename T> T rand() { return T(rand64()); }
154 /// Special generator used to fast init magic numbers.
155 /// Output values only have 1/8th of their bits set on average.
156 template<typename T> T sparse_rand()
157 { return T(rand64() & rand64() & rand64()); }
160 inline uint64_t mul_hi64(uint64_t a, uint64_t b) {
161 #if defined(__GNUC__) && defined(IS_64BIT)
162 __extension__ typedef unsigned __int128 uint128;
163 return ((uint128)a * (uint128)b) >> 64;
165 uint64_t aL = (uint32_t)a, aH = a >> 32;
166 uint64_t bL = (uint32_t)b, bH = b >> 32;
167 uint64_t c1 = (aL * bL) >> 32;
168 uint64_t c2 = aH * bL + c1;
169 uint64_t c3 = aL * bH + (uint32_t)c2;
170 return aH * bH + (c2 >> 32) + (c3 >> 32);
174 /// Under Windows it is not possible for a process to run on more than one
175 /// logical processor group. This usually means to be limited to use max 64
176 /// cores. To overcome this, some special platform specific API should be
177 /// called to set group affinity for each thread. Original code from Texel by
178 /// Peter Ă–sterlund.
180 namespace WinProcGroup {
181 void bindThisThread(size_t idx);
184 namespace CommandLine {
185 void init(int argc, char* argv[]);
187 extern std::string binaryDirectory; // path of the executable directory
188 extern std::string workingDirectory; // path of the working directory
191 } // namespace Stockfish
193 #endif // #ifndef MISC_H_INCLUDED