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