Merge remote-tracking branch 'upstream/master'
[stockfish] / src / misc.cpp
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-2019 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 #ifdef _WIN32
22 #if _WIN32_WINNT < 0x0601
23 #undef  _WIN32_WINNT
24 #define _WIN32_WINNT 0x0601 // Force to include needed API prototypes
25 #endif
26
27 #ifndef NOMINMAX
28 #define NOMINMAX
29 #endif
30
31 #include <windows.h>
32 // The needed Windows API for processor groups could be missed from old Windows
33 // versions, so instead of calling them directly (forcing the linker to resolve
34 // the calls at compile time), try to load them at runtime. To do this we need
35 // first to define the corresponding function pointers.
36 extern "C" {
37 typedef bool(*fun1_t)(LOGICAL_PROCESSOR_RELATIONSHIP,
38                       PSYSTEM_LOGICAL_PROCESSOR_INFORMATION_EX, PDWORD);
39 typedef bool(*fun2_t)(USHORT, PGROUP_AFFINITY);
40 typedef bool(*fun3_t)(HANDLE, CONST GROUP_AFFINITY*, PGROUP_AFFINITY);
41 }
42 #endif
43
44 #include <fstream>
45 #include <iomanip>
46 #include <iostream>
47 #include <sstream>
48 #include <vector>
49
50 #include "misc.h"
51 #include "thread.h"
52
53 using namespace std;
54
55 namespace {
56
57 /// Version number. If Version is left empty, then compile date in the format
58 /// DD-MM-YY and show in engine_info.
59 const string Version = "";
60
61 /// Our fancy logging facility. The trick here is to replace cin.rdbuf() and
62 /// cout.rdbuf() with two Tie objects that tie cin and cout to a file stream. We
63 /// can toggle the logging of std::cout and std:cin at runtime whilst preserving
64 /// usual I/O functionality, all without changing a single line of code!
65 /// Idea from http://groups.google.com/group/comp.lang.c++/msg/1d941c0f26ea0d81
66
67 struct Tie: public streambuf { // MSVC requires split streambuf for cin and cout
68
69   Tie(streambuf* b, streambuf* l) : buf(b), logBuf(l) {}
70
71   int sync() override { return logBuf->pubsync(), buf->pubsync(); }
72   int overflow(int c) override { return log(buf->sputc((char)c), "<< "); }
73   int underflow() override { return buf->sgetc(); }
74   int uflow() override { return log(buf->sbumpc(), ">> "); }
75
76   streambuf *buf, *logBuf;
77
78   int log(int c, const char* prefix) {
79
80     static int last = '\n'; // Single log file
81
82     if (last == '\n')
83         logBuf->sputn(prefix, 3);
84
85     return last = logBuf->sputc((char)c);
86   }
87 };
88
89 class Logger {
90
91   Logger() : in(cin.rdbuf(), file.rdbuf()), out(cout.rdbuf(), file.rdbuf()) {}
92  ~Logger() { start(""); }
93
94   ofstream file;
95   Tie in, out;
96
97 public:
98   static void start(const std::string& fname) {
99
100     static Logger l;
101
102     if (!fname.empty() && !l.file.is_open())
103     {
104         l.file.open(fname, ifstream::out);
105
106         if (!l.file.is_open())
107         {
108             cerr << "Unable to open debug log file " << fname << endl;
109             exit(EXIT_FAILURE);
110         }
111
112         cin.rdbuf(&l.in);
113         cout.rdbuf(&l.out);
114     }
115     else if (fname.empty() && l.file.is_open())
116     {
117         cout.rdbuf(l.out.buf);
118         cin.rdbuf(l.in.buf);
119         l.file.close();
120     }
121   }
122 };
123
124 } // namespace
125
126 /// engine_info() returns the full name of the current Stockfish version. This
127 /// will be either "Stockfish <Tag> DD-MM-YY" (where DD-MM-YY is the date when
128 /// the program was compiled) or "Stockfish <Version>", depending on whether
129 /// Version is empty.
130
131 const string engine_info(bool to_uci) {
132
133   const string months("Jan Feb Mar Apr May Jun Jul Aug Sep Oct Nov Dec");
134   string month, day, year;
135   stringstream ss, date(__DATE__); // From compiler, format is "Sep 21 2008"
136
137   ss << "Stockfish " << Version << setfill('0');
138
139   if (Version.empty())
140   {
141       date >> month >> day >> year;
142       ss << setw(2) << day << setw(2) << (1 + months.find(month) / 4) << year.substr(2);
143       ss << "-asn";
144   }
145
146   ss << (Is64Bit ? " 64" : "")
147      << (HasPext ? " BMI2" : (HasPopCnt ? " POPCNT" : ""))
148      << (to_uci  ? "\nid author ": " by ")
149      << "T. Romstad, M. Costalba, J. Kiiski, G. Linscott";
150
151   return ss.str();
152 }
153
154
155 /// Debug functions used mainly to collect run-time statistics
156 static std::atomic<int64_t> hits[2], means[2];
157
158 void dbg_hit_on(bool b) { ++hits[0]; if (b) ++hits[1]; }
159 void dbg_hit_on(bool c, bool b) { if (c) dbg_hit_on(b); }
160 void dbg_mean_of(int v) { ++means[0]; means[1] += v; }
161
162 void dbg_print() {
163
164   if (hits[0])
165       cerr << "Total " << hits[0] << " Hits " << hits[1]
166            << " hit rate (%) " << 100 * hits[1] / hits[0] << endl;
167
168   if (means[0])
169       cerr << "Total " << means[0] << " Mean "
170            << (double)means[1] / means[0] << endl;
171 }
172
173
174 /// Used to serialize access to std::cout to avoid multiple threads writing at
175 /// the same time.
176
177 std::ostream& operator<<(std::ostream& os, SyncCout sc) {
178
179   static std::mutex m;
180
181   if (sc == IO_LOCK)
182       m.lock();
183
184   if (sc == IO_UNLOCK)
185       m.unlock();
186
187   return os;
188 }
189
190
191 /// Trampoline helper to avoid moving Logger to misc.h
192 void start_logger(const std::string& fname) { Logger::start(fname); }
193
194
195 /// prefetch() preloads the given address in L1/L2 cache. This is a non-blocking
196 /// function that doesn't stall the CPU waiting for data to be loaded from memory,
197 /// which can be quite slow.
198 #ifdef NO_PREFETCH
199
200 void prefetch(void*) {}
201
202 #else
203
204 void prefetch(void* addr) {
205
206 #  if defined(__INTEL_COMPILER)
207    // This hack prevents prefetches from being optimized away by
208    // Intel compiler. Both MSVC and gcc seem not be affected by this.
209    __asm__ ("");
210 #  endif
211
212 #  if defined(__INTEL_COMPILER) || defined(_MSC_VER)
213   _mm_prefetch((char*)addr, _MM_HINT_T0);
214 #  else
215   __builtin_prefetch(addr);
216 #  endif
217 }
218
219 #endif
220
221 namespace WinProcGroup {
222
223 #ifndef _WIN32
224
225 void bindThisThread(size_t) {}
226
227 #else
228
229 /// best_group() retrieves logical processor information using Windows specific
230 /// API and returns the best group id for the thread with index idx. Original
231 /// code from Texel by Peter Ă–sterlund.
232
233 int best_group(size_t idx) {
234
235   int threads = 0;
236   int nodes = 0;
237   int cores = 0;
238   DWORD returnLength = 0;
239   DWORD byteOffset = 0;
240
241   // Early exit if the needed API is not available at runtime
242   HMODULE k32 = GetModuleHandle("Kernel32.dll");
243   auto fun1 = (fun1_t)(void(*)())GetProcAddress(k32, "GetLogicalProcessorInformationEx");
244   if (!fun1)
245       return -1;
246
247   // First call to get returnLength. We expect it to fail due to null buffer
248   if (fun1(RelationAll, nullptr, &returnLength))
249       return -1;
250
251   // Once we know returnLength, allocate the buffer
252   SYSTEM_LOGICAL_PROCESSOR_INFORMATION_EX *buffer, *ptr;
253   ptr = buffer = (SYSTEM_LOGICAL_PROCESSOR_INFORMATION_EX*)malloc(returnLength);
254
255   // Second call, now we expect to succeed
256   if (!fun1(RelationAll, buffer, &returnLength))
257   {
258       free(buffer);
259       return -1;
260   }
261
262   while (byteOffset < returnLength)
263   {
264       if (ptr->Relationship == RelationNumaNode)
265           nodes++;
266
267       else if (ptr->Relationship == RelationProcessorCore)
268       {
269           cores++;
270           threads += (ptr->Processor.Flags == LTP_PC_SMT) ? 2 : 1;
271       }
272
273       assert(ptr->Size);
274       byteOffset += ptr->Size;
275       ptr = (SYSTEM_LOGICAL_PROCESSOR_INFORMATION_EX*)(((char*)ptr) + ptr->Size);
276   }
277
278   free(buffer);
279
280   std::vector<int> groups;
281
282   // Run as many threads as possible on the same node until core limit is
283   // reached, then move on filling the next node.
284   for (int n = 0; n < nodes; n++)
285       for (int i = 0; i < cores / nodes; i++)
286           groups.push_back(n);
287
288   // In case a core has more than one logical processor (we assume 2) and we
289   // have still threads to allocate, then spread them evenly across available
290   // nodes.
291   for (int t = 0; t < threads - cores; t++)
292       groups.push_back(t % nodes);
293
294   // If we still have more threads than the total number of logical processors
295   // then return -1 and let the OS to decide what to do.
296   return idx < groups.size() ? groups[idx] : -1;
297 }
298
299
300 /// bindThisThread() set the group affinity of the current thread
301
302 void bindThisThread(size_t idx) {
303
304   // Use only local variables to be thread-safe
305   int group = best_group(idx);
306
307   if (group == -1)
308       return;
309
310   // Early exit if the needed API are not available at runtime
311   HMODULE k32 = GetModuleHandle("Kernel32.dll");
312   auto fun2 = (fun2_t)(void(*)())GetProcAddress(k32, "GetNumaNodeProcessorMaskEx");
313   auto fun3 = (fun3_t)(void(*)())GetProcAddress(k32, "SetThreadGroupAffinity");
314
315   if (!fun2 || !fun3)
316       return;
317
318   GROUP_AFFINITY affinity;
319   if (fun2(group, &affinity))
320       fun3(GetCurrentThread(), &affinity, nullptr);
321 }
322
323 #endif
324
325 } // namespace WinProcGroup