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