b63e613fc80f3d182af41e35bfb17a3208b01e55
[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-2017 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 void prefetch(void* addr);
34 void prefetch2(void* addr);
35 void start_logger(const std::string& fname);
36
37 void dbg_hit_on(bool b);
38 void dbg_hit_on(bool c, bool b);
39 void dbg_mean_of(int v);
40 void dbg_print();
41
42 typedef std::chrono::milliseconds::rep TimePoint; // A value in milliseconds
43
44 inline TimePoint now() {
45   return std::chrono::duration_cast<std::chrono::milliseconds>
46         (std::chrono::steady_clock::now().time_since_epoch()).count();
47 }
48
49 template<class Entry, int Size>
50 struct HashTable {
51   Entry* operator[](Key key) { return &table[(uint32_t)key & (Size - 1)]; }
52
53 private:
54   std::vector<Entry> table = std::vector<Entry>(Size);
55 };
56
57
58 enum SyncCout { IO_LOCK, IO_UNLOCK };
59 std::ostream& operator<<(std::ostream&, SyncCout);
60
61 #define sync_cout std::cout << IO_LOCK
62 #define sync_endl std::endl << IO_UNLOCK
63
64
65 /// xorshift64star Pseudo-Random Number Generator
66 /// This class is based on original code written and dedicated
67 /// to the public domain by Sebastiano Vigna (2014).
68 /// It has the following characteristics:
69 ///
70 ///  -  Outputs 64-bit numbers
71 ///  -  Passes Dieharder and SmallCrush test batteries
72 ///  -  Does not require warm-up, no zeroland to escape
73 ///  -  Internal state is a single 64-bit integer
74 ///  -  Period is 2^64 - 1
75 ///  -  Speed: 1.60 ns/call (Core i7 @3.40GHz)
76 ///
77 /// For further analysis see
78 ///   <http://vigna.di.unimi.it/ftp/papers/xorshift.pdf>
79
80 class PRNG {
81
82   uint64_t s;
83
84   uint64_t rand64() {
85
86     s ^= s >> 12, s ^= s << 25, s ^= s >> 27;
87     return s * 2685821657736338717LL;
88   }
89
90 public:
91   PRNG(uint64_t seed) : s(seed) { assert(seed); }
92
93   template<typename T> T rand() { return T(rand64()); }
94
95   /// Special generator used to fast init magic numbers.
96   /// Output values only have 1/8th of their bits set on average.
97   template<typename T> T sparse_rand()
98   { return T(rand64() & rand64() & rand64()); }
99 };
100
101
102 /// Under Windows it is not possible for a process to run on more than one
103 /// logical processor group. This usually means to be limited to use max 64
104 /// cores. To overcome this, some special platform specific API should be
105 /// called to set group affinity for each thread. Original code from Texel by
106 /// Peter Ă–sterlund.
107
108 namespace WinProcGroup {
109   void bindThisThread(size_t idx);
110 }
111
112 #endif // #ifndef MISC_H_INCLUDED