2 Stockfish, a UCI chess playing engine derived from Glaurung 2.1
3 Copyright (C) 2004-2023 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
31 #define stringify2(x) #x
32 #define stringify(x) stringify2(x)
36 std::string engine_info(bool to_uci = false);
37 std::string compiler_info();
38 void prefetch(void* addr);
39 void start_logger(const std::string& fname);
40 void* std_aligned_alloc(size_t alignment, size_t size);
41 void std_aligned_free(void* ptr);
42 void* aligned_large_pages_alloc(size_t size); // memory aligned by page size, min alignment: 4096 bytes
43 void aligned_large_pages_free(void* mem); // nop if mem == nullptr
45 void dbg_hit_on(bool cond, int slot = 0);
46 void dbg_mean_of(int64_t value, int slot = 0);
47 void dbg_stdev_of(int64_t value, int slot = 0);
48 void dbg_correl_of(int64_t value1, int64_t value2, int slot = 0);
51 using TimePoint = std::chrono::milliseconds::rep; // A value in milliseconds
52 static_assert(sizeof(TimePoint) == sizeof(int64_t), "TimePoint should be 64 bits");
53 inline TimePoint now() {
54 return std::chrono::duration_cast<std::chrono::milliseconds>
55 (std::chrono::steady_clock::now().time_since_epoch()).count();
59 enum SyncCout { IO_LOCK, IO_UNLOCK };
60 std::ostream& operator<<(std::ostream&, SyncCout);
62 #define sync_cout std::cout << IO_LOCK
63 #define sync_endl std::endl << IO_UNLOCK
66 // align_ptr_up() : get the first aligned element of an array.
67 // ptr must point to an array of size at least `sizeof(T) * N + alignment` bytes,
68 // where N is the number of elements in the array.
69 template <uintptr_t Alignment, typename T>
70 T* align_ptr_up(T* ptr)
72 static_assert(alignof(T) < Alignment);
74 const uintptr_t ptrint = reinterpret_cast<uintptr_t>(reinterpret_cast<char*>(ptr));
75 return reinterpret_cast<T*>(reinterpret_cast<char*>((ptrint + (Alignment - 1)) / Alignment * Alignment));
79 // IsLittleEndian : true if and only if the binary is compiled on a little endian machine
80 static inline const union { uint32_t i; char c[4]; } Le = { 0x01020304 };
81 static inline const bool IsLittleEndian = (Le.c[0] == 4);
84 template <typename T, std::size_t MaxSize>
88 std::size_t size() const { return size_; }
89 void push_back(const T& value) { values_[size_++] = value; }
90 const T* begin() const { return values_; }
91 const T* end() const { return values_ + size_; }
95 std::size_t size_ = 0;
99 /// xorshift64star Pseudo-Random Number Generator
100 /// This class is based on original code written and dedicated
101 /// to the public domain by Sebastiano Vigna (2014).
102 /// It has the following characteristics:
104 /// - Outputs 64-bit numbers
105 /// - Passes Dieharder and SmallCrush test batteries
106 /// - Does not require warm-up, no zeroland to escape
107 /// - Internal state is a single 64-bit integer
108 /// - Period is 2^64 - 1
109 /// - Speed: 1.60 ns/call (Core i7 @3.40GHz)
111 /// For further analysis see
112 /// <http://vigna.di.unimi.it/ftp/papers/xorshift.pdf>
120 s ^= s >> 12, s ^= s << 25, s ^= s >> 27;
121 return s * 2685821657736338717LL;
125 PRNG(uint64_t seed) : s(seed) { assert(seed); }
127 template<typename T> T rand() { return T(rand64()); }
129 /// Special generator used to fast init magic numbers.
130 /// Output values only have 1/8th of their bits set on average.
131 template<typename T> T sparse_rand()
132 { return T(rand64() & rand64() & rand64()); }
135 inline uint64_t mul_hi64(uint64_t a, uint64_t b) {
136 #if defined(__GNUC__) && defined(IS_64BIT)
137 __extension__ using uint128 = unsigned __int128;
138 return ((uint128)a * (uint128)b) >> 64;
140 uint64_t aL = (uint32_t)a, aH = a >> 32;
141 uint64_t bL = (uint32_t)b, bH = b >> 32;
142 uint64_t c1 = (aL * bL) >> 32;
143 uint64_t c2 = aH * bL + c1;
144 uint64_t c3 = aL * bH + (uint32_t)c2;
145 return aH * bH + (c2 >> 32) + (c3 >> 32);
149 /// Under Windows it is not possible for a process to run on more than one
150 /// logical processor group. This usually means to be limited to use max 64
151 /// cores. To overcome this, some special platform specific API should be
152 /// called to set group affinity for each thread. Original code from Texel by
153 /// Peter Ă–sterlund.
155 namespace WinProcGroup {
156 void bindThisThread(size_t idx);
159 namespace CommandLine {
160 void init(int argc, char* argv[]);
162 extern std::string binaryDirectory; // path of the executable directory
163 extern std::string workingDirectory; // path of the working directory
166 } // namespace Stockfish
168 #endif // #ifndef MISC_H_INCLUDED