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 <cstddef>
  25 #include <cstdint>
  26 #include <iosfwd>
  27 #include <string>
  28
  29 #define stringify2(x) #x
  30 #define stringify(x) stringify2(x)
  31
  32 namespace Stockfish {
  33
  34 std::string engine_info(bool to_uci = false);
  35 std::string compiler_info();
  36
  37 // Preloads the given address in L1/L2 cache. This is a non-blocking
  38 // function that doesn't stall the CPU waiting for data to be loaded from memory,
  39 // which can be quite slow.
  40 void prefetch(void* addr);
  41
  42 void  start_logger(const std::string& fname);
  43 void* std_aligned_alloc(size_t alignment, size_t size);
  44 void  std_aligned_free(void* ptr);
  45 // memory aligned by page size, min alignment: 4096 bytes
  46 void* aligned_large_pages_alloc(size_t size);
  47 // nop if mem == nullptr
  48 void aligned_large_pages_free(void* mem);
  49
  50 void dbg_hit_on(bool cond, int slot = 0);
  51 void dbg_mean_of(int64_t value, int slot = 0);
  52 void dbg_stdev_of(int64_t value, int slot = 0);
  53 void dbg_correl_of(int64_t value1, int64_t value2, int slot = 0);
  54 void dbg_print();
  55
  56 using TimePoint = std::chrono::milliseconds::rep;  // A value in milliseconds
  57 static_assert(sizeof(TimePoint) == sizeof(int64_t), "TimePoint should be 64 bits");
  58 inline TimePoint now() {
  59     return std::chrono::duration_cast<std::chrono::milliseconds>(
  60              std::chrono::steady_clock::now().time_since_epoch())
  61       .count();
  62 }
  63
  64
  65 enum SyncCout {
  66     IO_LOCK,
  67     IO_UNLOCK
  68 };
  69 std::ostream& operator<<(std::ostream&, SyncCout);
  70
  71 #define sync_cout std::cout << IO_LOCK
  72 #define sync_endl std::endl << IO_UNLOCK
  73
  74
  75 // Get the first aligned element of an array.
  76 // ptr must point to an array of size at least `sizeof(T) * N + alignment` bytes,
  77 // where N is the number of elements in the array.
  78 template<uintptr_t Alignment, typename T>
  79 T* align_ptr_up(T* ptr) {
  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*>(
  84       reinterpret_cast<char*>((ptrint + (Alignment - 1)) / Alignment * Alignment));
  85 }
  86
  87
  88 // True if and only if the binary is compiled on a little-endian machine
  89 static inline const union {
  90     uint32_t i;
  91     char     c[4];
  92 } Le                                    = {0x01020304};
  93 static inline const bool IsLittleEndian = (Le.c[0] == 4);
  94
  95
  96 template<typename T, std::size_t MaxSize>
  97 class ValueList {
  98
  99    public:
 100     std::size_t size() const { return size_; }
 101     void        push_back(const T& value) { values_[size_++] = value; }
 102     const T*    begin() const { return values_; }
 103     const T*    end() const { return values_ + size_; }
 104     const T&    operator[](int index) const { return values_[index]; }
 105
 106    private:
 107     T           values_[MaxSize];
 108     std::size_t size_ = 0;
 109 };
 110
 111
 112 // xorshift64star Pseudo-Random Number Generator
 113 // This class is based on original code written and dedicated
 114 // to the public domain by Sebastiano Vigna (2014).
 115 // It has the following characteristics:
 116 //
 117 //  -  Outputs 64-bit numbers
 118 //  -  Passes Dieharder and SmallCrush test batteries
 119 //  -  Does not require warm-up, no zeroland to escape
 120 //  -  Internal state is a single 64-bit integer
 121 //  -  Period is 2^64 - 1
 122 //  -  Speed: 1.60 ns/call (Core i7 @3.40GHz)
 123 //
 124 // For further analysis see
 125 //   <http://vigna.di.unimi.it/ftp/papers/xorshift.pdf>
 126
 127 class PRNG {
 128
 129     uint64_t s;
 130
 131     uint64_t rand64() {
 132
 133         s ^= s >> 12, s ^= s << 25, s ^= s >> 27;
 134         return s * 2685821657736338717LL;
 135     }
 136
 137    public:
 138     PRNG(uint64_t seed) :
 139         s(seed) {
 140         assert(seed);
 141     }
 142
 143     template<typename T>
 144     T rand() {
 145         return T(rand64());
 146     }
 147
 148     // Special generator used to fast init magic numbers.
 149     // Output values only have 1/8th of their bits set on average.
 150     template<typename T>
 151     T sparse_rand() {
 152         return T(rand64() & rand64() & rand64());
 153     }
 154 };
 155
 156 inline uint64_t mul_hi64(uint64_t a, uint64_t b) {
 157 #if defined(__GNUC__) && defined(IS_64BIT)
 158     __extension__ using uint128 = unsigned __int128;
 159     return (uint128(a) * uint128(b)) >> 64;
 160 #else
 161     uint64_t aL = uint32_t(a), aH = a >> 32;
 162     uint64_t bL = uint32_t(b), bH = b >> 32;
 163     uint64_t c1 = (aL * bL) >> 32;
 164     uint64_t c2 = aH * bL + c1;
 165     uint64_t c3 = aL * bH + uint32_t(c2);
 166     return aH * bH + (c2 >> 32) + (c3 >> 32);
 167 #endif
 168 }
 169
 170 // Under Windows it is not possible for a process to run on more than one
 171 // logical processor group. This usually means being limited to using max 64
 172 // cores. To overcome this, some special platform-specific API should be
 173 // called to set group affinity for each thread. Original code from Texel by
 174 // Peter Österlund.
 175 namespace WinProcGroup {
 176 void bindThisThread(size_t idx);
 177 }
 178
 179 namespace CommandLine {
 180 void init(int argc, char* argv[]);
 181
 182 extern std::string binaryDirectory;   // path of the executable directory
 183 extern std::string workingDirectory;  // path of the working directory
 184 }
 185
 186 }  // namespace Stockfish
 187
 188 #endif  // #ifndef MISC_H_INCLUDED