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