Merge remote-tracking branch 'upstream/master'
[stockfish] / src / misc.h
1 /*
2   Stockfish, a UCI chess playing engine derived from Glaurung 2.1
3   Copyright (C) 2004-2022 The Stockfish developers (see AUTHORS file)
4
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.
9
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.
14
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/>.
17 */
18
19 #ifndef MISC_H_INCLUDED
20 #define MISC_H_INCLUDED
21
22 #include <cassert>
23 #include <chrono>
24 #include <ostream>
25 #include <string>
26 #include <vector>
27 #include <cstdint>
28
29 #include "types.h"
30
31 namespace Stockfish {
32
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
41
42 void dbg_hit_on(bool b);
43 void dbg_hit_on(bool c, bool b);
44 void dbg_mean_of(int v);
45 void dbg_print();
46
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();
52 }
53
54 template<class Entry, int Size>
55 struct HashTable {
56   Entry* operator[](Key key) { return &table[(uint32_t)key & (Size - 1)]; }
57
58 private:
59   std::vector<Entry> table = std::vector<Entry>(Size); // Allocate on the heap
60 };
61
62
63 enum SyncCout { IO_LOCK, IO_UNLOCK };
64 std::ostream& operator<<(std::ostream&, SyncCout);
65
66 #define sync_cout std::cout << IO_LOCK
67 #define sync_endl std::endl << IO_UNLOCK
68
69
70 // align_ptr_up() : get the first aligned element of an array.
71 // ptr must point to an array of size at least `sizeof(T) * N + alignment` bytes,
72 // where N is the number of elements in the array.
73 template <uintptr_t Alignment, typename T>
74 T* align_ptr_up(T* ptr)
75 {
76   static_assert(alignof(T) < Alignment);
77
78   const uintptr_t ptrint = reinterpret_cast<uintptr_t>(reinterpret_cast<char*>(ptr));
79   return reinterpret_cast<T*>(reinterpret_cast<char*>((ptrint + (Alignment - 1)) / Alignment * Alignment));
80 }
81
82
83 // IsLittleEndian : true if and only if the binary is compiled on a little endian machine
84 static inline const union { uint32_t i; char c[4]; } Le = { 0x01020304 };
85 static inline const bool IsLittleEndian = (Le.c[0] == 4);
86
87
88 // RunningAverage : a class to calculate a running average of a series of values.
89 // For efficiency, all computations are done with integers.
90 class RunningAverage {
91   public:
92
93       // Constructor
94       RunningAverage() {}
95
96       // Reset the running average to rational value p / q
97       void set(int64_t p, int64_t q)
98         { average = p * PERIOD * RESOLUTION / q; }
99
100       // Update average with value v
101       void update(int64_t v)
102         { average = RESOLUTION * v + (PERIOD - 1) * average / PERIOD; }
103
104       // Test if average is strictly greater than rational a / b
105       bool is_greater(int64_t a, int64_t b)
106         { return b * average > a * PERIOD * RESOLUTION ; }
107
108   private :
109       static constexpr int64_t PERIOD     = 4096;
110       static constexpr int64_t RESOLUTION = 1024;
111       int64_t average;
112 };
113
114 template <typename T, std::size_t MaxSize>
115 class ValueList {
116
117 public:
118   std::size_t size() const { return size_; }
119   void resize(std::size_t newSize) { size_ = newSize; }
120   void push_back(const T& value) { values_[size_++] = value; }
121   T& operator[](std::size_t index) { return values_[index]; }
122   T* begin() { return values_; }
123   T* end() { return values_ + size_; }
124   const T& operator[](std::size_t index) const { return values_[index]; }
125   const T* begin() const { return values_; }
126   const T* end() const { return values_ + size_; }
127
128   void swap(ValueList& other) {
129     const std::size_t maxSize = std::max(size_, other.size_);
130     for (std::size_t i = 0; i < maxSize; ++i) {
131       std::swap(values_[i], other.values_[i]);
132     }
133     std::swap(size_, other.size_);
134   }
135
136 private:
137   T values_[MaxSize];
138   std::size_t size_ = 0;
139 };
140
141
142 /// sigmoid(t, x0, y0, C, P, Q) implements a sigmoid-like function using only integers,
143 /// with the following properties:
144 ///
145 ///  -  sigmoid is centered in (x0, y0)
146 ///  -  sigmoid has amplitude [-P/Q , P/Q] instead of [-1 , +1]
147 ///  -  limit is (y0 - P/Q) when t tends to -infinity
148 ///  -  limit is (y0 + P/Q) when t tends to +infinity
149 ///  -  the slope can be adjusted using C > 0, smaller C giving a steeper sigmoid
150 ///  -  the slope of the sigmoid when t = x0 is P/(Q*C)
151 ///  -  sigmoid is increasing with t when P > 0 and Q > 0
152 ///  -  to get a decreasing sigmoid, call with -t, or change sign of P
153 ///  -  mean value of the sigmoid is y0
154 ///
155 /// Use <https://www.desmos.com/calculator/jhh83sqq92> to draw the sigmoid
156
157 inline int64_t sigmoid(int64_t t, int64_t x0,
158                                   int64_t y0,
159                                   int64_t  C,
160                                   int64_t  P,
161                                   int64_t  Q)
162 {
163    assert(C > 0);
164    return y0 + P * (t-x0) / (Q * (std::abs(t-x0) + C)) ;
165 }
166
167
168 /// xorshift64star Pseudo-Random Number Generator
169 /// This class is based on original code written and dedicated
170 /// to the public domain by Sebastiano Vigna (2014).
171 /// It has the following characteristics:
172 ///
173 ///  -  Outputs 64-bit numbers
174 ///  -  Passes Dieharder and SmallCrush test batteries
175 ///  -  Does not require warm-up, no zeroland to escape
176 ///  -  Internal state is a single 64-bit integer
177 ///  -  Period is 2^64 - 1
178 ///  -  Speed: 1.60 ns/call (Core i7 @3.40GHz)
179 ///
180 /// For further analysis see
181 ///   <http://vigna.di.unimi.it/ftp/papers/xorshift.pdf>
182
183 class PRNG {
184
185   uint64_t s;
186
187   uint64_t rand64() {
188
189     s ^= s >> 12, s ^= s << 25, s ^= s >> 27;
190     return s * 2685821657736338717LL;
191   }
192
193 public:
194   PRNG(uint64_t seed) : s(seed) { assert(seed); }
195
196   template<typename T> T rand() { return T(rand64()); }
197
198   /// Special generator used to fast init magic numbers.
199   /// Output values only have 1/8th of their bits set on average.
200   template<typename T> T sparse_rand()
201   { return T(rand64() & rand64() & rand64()); }
202 };
203
204 inline uint64_t mul_hi64(uint64_t a, uint64_t b) {
205 #if defined(__GNUC__) && defined(IS_64BIT)
206     __extension__ typedef unsigned __int128 uint128;
207     return ((uint128)a * (uint128)b) >> 64;
208 #else
209     uint64_t aL = (uint32_t)a, aH = a >> 32;
210     uint64_t bL = (uint32_t)b, bH = b >> 32;
211     uint64_t c1 = (aL * bL) >> 32;
212     uint64_t c2 = aH * bL + c1;
213     uint64_t c3 = aL * bH + (uint32_t)c2;
214     return aH * bH + (c2 >> 32) + (c3 >> 32);
215 #endif
216 }
217
218 /// Under Windows it is not possible for a process to run on more than one
219 /// logical processor group. This usually means to be limited to use max 64
220 /// cores. To overcome this, some special platform specific API should be
221 /// called to set group affinity for each thread. Original code from Texel by
222 /// Peter Ă–sterlund.
223
224 namespace WinProcGroup {
225   void bindThisThread(size_t idx);
226 }
227
228 namespace CommandLine {
229   void init(int argc, char* argv[]);
230
231   extern std::string binaryDirectory;  // path of the executable directory
232   extern std::string workingDirectory; // path of the working directory
233 }
234
235 } // namespace Stockfish
236
237 #endif // #ifndef MISC_H_INCLUDED