git.sesse.net Git - stockfish/blob - src/misc.h

   1 /*
   2   Stockfish, a UCI chess playing engine derived from Glaurung 2.1
   3   Copyright (C) 2004-2023 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 cond, int slot = 0);
  43 void dbg_mean_of(int64_t value, int slot = 0);
  44 void dbg_stdev_of(int64_t value, int slot = 0);
  45 void dbg_correl_of(int64_t value1, int64_t value2, int slot = 0);
  46 void dbg_print();
  47
  48 typedef std::chrono::milliseconds::rep TimePoint; // A value in milliseconds
  49 static_assert(sizeof(TimePoint) == sizeof(int64_t), "TimePoint should be 64 bits");
  50 inline TimePoint now() {
  51   return std::chrono::duration_cast<std::chrono::milliseconds>
  52         (std::chrono::steady_clock::now().time_since_epoch()).count();
  53 }
  54
  55 template<class Entry, int Size>
  56 struct HashTable {
  57   Entry* operator[](Key key) { return &table[(uint32_t)key & (Size - 1)]; }
  58
  59 private:
  60   std::vector<Entry> table = std::vector<Entry>(Size); // Allocate on the heap
  61 };
  62
  63
  64 enum SyncCout { IO_LOCK, IO_UNLOCK };
  65 std::ostream& operator<<(std::ostream&, SyncCout);
  66
  67 #define sync_cout std::cout << IO_LOCK
  68 #define sync_endl std::endl << IO_UNLOCK
  69
  70
  71 // align_ptr_up() : get the first aligned element of an array.
  72 // ptr must point to an array of size at least `sizeof(T) * N + alignment` bytes,
  73 // where N is the number of elements in the array.
  74 template <uintptr_t Alignment, typename T>
  75 T* align_ptr_up(T* ptr)
  76 {
  77   static_assert(alignof(T) < Alignment);
  78
  79   const uintptr_t ptrint = reinterpret_cast<uintptr_t>(reinterpret_cast<char*>(ptr));
  80   return reinterpret_cast<T*>(reinterpret_cast<char*>((ptrint + (Alignment - 1)) / Alignment * Alignment));
  81 }
  82
  83
  84 // IsLittleEndian : true if and only if the binary is compiled on a little endian machine
  85 static inline const union { uint32_t i; char c[4]; } Le = { 0x01020304 };
  86 static inline const bool IsLittleEndian = (Le.c[0] == 4);
  87
  88
  89 // RunningAverage : a class to calculate a running average of a series of values.
  90 // For efficiency, all computations are done with integers.
  91 class RunningAverage {
  92   public:
  93
  94       // Reset the running average to rational value p / q
  95       void set(int64_t p, int64_t q)
  96         { average = p * PERIOD * RESOLUTION / q; }
  97
  98       // Update average with value v
  99       void update(int64_t v)
 100         { average = RESOLUTION * v + (PERIOD - 1) * average / PERIOD; }
 101
 102       // Test if average is strictly greater than rational a / b
 103       bool is_greater(int64_t a, int64_t b) const
 104         { return b * average > a * (PERIOD * RESOLUTION); }
 105
 106       int64_t value() const
 107         { return average / (PERIOD * RESOLUTION); }
 108
 109   private :
 110       static constexpr int64_t PERIOD     = 4096;
 111       static constexpr int64_t RESOLUTION = 1024;
 112       int64_t average;
 113 };
 114
 115 template <typename T, std::size_t MaxSize>
 116 class ValueList {
 117
 118 public:
 119   std::size_t size() const { return size_; }
 120   void push_back(const T& value) { values_[size_++] = value; }
 121   const T* begin() const { return values_; }
 122   const T* end() const { return values_ + size_; }
 123
 124 private:
 125   T values_[MaxSize];
 126   std::size_t size_ = 0;
 127 };
 128
 129
 130 /// xorshift64star Pseudo-Random Number Generator
 131 /// This class is based on original code written and dedicated
 132 /// to the public domain by Sebastiano Vigna (2014).
 133 /// It has the following characteristics:
 134 ///
 135 ///  -  Outputs 64-bit numbers
 136 ///  -  Passes Dieharder and SmallCrush test batteries
 137 ///  -  Does not require warm-up, no zeroland to escape
 138 ///  -  Internal state is a single 64-bit integer
 139 ///  -  Period is 2^64 - 1
 140 ///  -  Speed: 1.60 ns/call (Core i7 @3.40GHz)
 141 ///
 142 /// For further analysis see
 143 ///   <http://vigna.di.unimi.it/ftp/papers/xorshift.pdf>
 144
 145 class PRNG {
 146
 147   uint64_t s;
 148
 149   uint64_t rand64() {
 150
 151     s ^= s >> 12, s ^= s << 25, s ^= s >> 27;
 152     return s * 2685821657736338717LL;
 153   }
 154
 155 public:
 156   PRNG(uint64_t seed) : s(seed) { assert(seed); }
 157
 158   template<typename T> T rand() { return T(rand64()); }
 159
 160   /// Special generator used to fast init magic numbers.
 161   /// Output values only have 1/8th of their bits set on average.
 162   template<typename T> T sparse_rand()
 163   { return T(rand64() & rand64() & rand64()); }
 164 };
 165
 166 inline uint64_t mul_hi64(uint64_t a, uint64_t b) {
 167 #if defined(__GNUC__) && defined(IS_64BIT)
 168     __extension__ typedef unsigned __int128 uint128;
 169     return ((uint128)a * (uint128)b) >> 64;
 170 #else
 171     uint64_t aL = (uint32_t)a, aH = a >> 32;
 172     uint64_t bL = (uint32_t)b, bH = b >> 32;
 173     uint64_t c1 = (aL * bL) >> 32;
 174     uint64_t c2 = aH * bL + c1;
 175     uint64_t c3 = aL * bH + (uint32_t)c2;
 176     return aH * bH + (c2 >> 32) + (c3 >> 32);
 177 #endif
 178 }
 179
 180 /// Under Windows it is not possible for a process to run on more than one
 181 /// logical processor group. This usually means to be limited to use max 64
 182 /// cores. To overcome this, some special platform specific API should be
 183 /// called to set group affinity for each thread. Original code from Texel by
 184 /// Peter Österlund.
 185
 186 namespace WinProcGroup {
 187   void bindThisThread(size_t idx);
 188 }
 189
 190 namespace CommandLine {
 191   void init(int argc, char* argv[]);
 192
 193   extern std::string binaryDirectory;  // path of the executable directory
 194   extern std::string workingDirectory; // path of the working directory
 195 }
 196
 197 } // namespace Stockfish
 198
 199 #endif // #ifndef MISC_H_INCLUDED