Add support for Windows large pages
[stockfish] / src / misc.h
1 /*
2   Stockfish, a UCI chess playing engine derived from Glaurung 2.1
3   Copyright (C) 2004-2008 Tord Romstad (Glaurung author)
4   Copyright (C) 2008-2015 Marco Costalba, Joona Kiiski, Tord Romstad
5   Copyright (C) 2015-2020 Marco Costalba, Joona Kiiski, Gary Linscott, Tord Romstad
6
7   Stockfish is free software: you can redistribute it and/or modify
8   it under the terms of the GNU General Public License as published by
9   the Free Software Foundation, either version 3 of the License, or
10   (at your option) any later version.
11
12   Stockfish is distributed in the hope that it will be useful,
13   but WITHOUT ANY WARRANTY; without even the implied warranty of
14   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15   GNU General Public License for more details.
16
17   You should have received a copy of the GNU General Public License
18   along with this program.  If not, see <http://www.gnu.org/licenses/>.
19 */
20
21 #ifndef MISC_H_INCLUDED
22 #define MISC_H_INCLUDED
23
24 #include <cassert>
25 #include <chrono>
26 #include <ostream>
27 #include <string>
28 #include <vector>
29
30 #include "types.h"
31
32 const std::string engine_info(bool to_uci = false);
33 const std::string compiler_info();
34 void prefetch(void* addr);
35 void start_logger(const std::string& fname);
36 void* aligned_ttmem_alloc(size_t size, void*& mem);
37 void aligned_ttmem_free(void* mem);
38
39 void dbg_hit_on(bool b);
40 void dbg_hit_on(bool c, bool b);
41 void dbg_mean_of(int v);
42 void dbg_print();
43
44 typedef std::chrono::milliseconds::rep TimePoint; // A value in milliseconds
45
46 static_assert(sizeof(TimePoint) == sizeof(int64_t), "TimePoint should be 64 bits");
47
48 inline TimePoint now() {
49   return std::chrono::duration_cast<std::chrono::milliseconds>
50         (std::chrono::steady_clock::now().time_since_epoch()).count();
51 }
52
53 template<class Entry, int Size>
54 struct HashTable {
55   Entry* operator[](Key key) { return &table[(uint32_t)key & (Size - 1)]; }
56
57 private:
58   std::vector<Entry> table = std::vector<Entry>(Size); // Allocate on the heap
59 };
60
61
62 enum SyncCout { IO_LOCK, IO_UNLOCK };
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 namespace Utility {
69
70 /// Clamp a value between lo and hi. Available in c++17.
71 template<class T> constexpr const T& clamp(const T& v, const T& lo, const T& hi) {
72   return v < lo ? lo : v > hi ? hi : v;
73 }
74
75 }
76
77 /// xorshift64star Pseudo-Random Number Generator
78 /// This class is based on original code written and dedicated
79 /// to the public domain by Sebastiano Vigna (2014).
80 /// It has the following characteristics:
81 ///
82 ///  -  Outputs 64-bit numbers
83 ///  -  Passes Dieharder and SmallCrush test batteries
84 ///  -  Does not require warm-up, no zeroland to escape
85 ///  -  Internal state is a single 64-bit integer
86 ///  -  Period is 2^64 - 1
87 ///  -  Speed: 1.60 ns/call (Core i7 @3.40GHz)
88 ///
89 /// For further analysis see
90 ///   <http://vigna.di.unimi.it/ftp/papers/xorshift.pdf>
91
92 class PRNG {
93
94   uint64_t s;
95
96   uint64_t rand64() {
97
98     s ^= s >> 12, s ^= s << 25, s ^= s >> 27;
99     return s * 2685821657736338717LL;
100   }
101
102 public:
103   PRNG(uint64_t seed) : s(seed) { assert(seed); }
104
105   template<typename T> T rand() { return T(rand64()); }
106
107   /// Special generator used to fast init magic numbers.
108   /// Output values only have 1/8th of their bits set on average.
109   template<typename T> T sparse_rand()
110   { return T(rand64() & rand64() & rand64()); }
111 };
112
113
114 /// Under Windows it is not possible for a process to run on more than one
115 /// logical processor group. This usually means to be limited to use max 64
116 /// cores. To overcome this, some special platform specific API should be
117 /// called to set group affinity for each thread. Original code from Texel by
118 /// Peter Ă–sterlund.
119
120 namespace WinProcGroup {
121   void bindThisThread(size_t idx);
122 }
123
124 #endif // #ifndef MISC_H_INCLUDED