4d6483e73d20f78d352429bbc24289a648fc3649
[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-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 #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 #if defined(__linux__) && !defined(__ANDROID__)
51 #include <stdlib.h>
52 #include <sys/mman.h>
53 #endif
54
55 #include "misc.h"
56 #include "thread.h"
57
58 using namespace std;
59
60 namespace {
61
62 /// Version number. If Version is left empty, then compile date in the format
63 /// DD-MM-YY and show in engine_info.
64 const string Version = "";
65
66 /// Our fancy logging facility. The trick here is to replace cin.rdbuf() and
67 /// cout.rdbuf() with two Tie objects that tie cin and cout to a file stream. We
68 /// can toggle the logging of std::cout and std:cin at runtime whilst preserving
69 /// usual I/O functionality, all without changing a single line of code!
70 /// Idea from http://groups.google.com/group/comp.lang.c++/msg/1d941c0f26ea0d81
71
72 struct Tie: public streambuf { // MSVC requires split streambuf for cin and cout
73
74   Tie(streambuf* b, streambuf* l) : buf(b), logBuf(l) {}
75
76   int sync() override { return logBuf->pubsync(), buf->pubsync(); }
77   int overflow(int c) override { return log(buf->sputc((char)c), "<< "); }
78   int underflow() override { return buf->sgetc(); }
79   int uflow() override { return log(buf->sbumpc(), ">> "); }
80
81   streambuf *buf, *logBuf;
82
83   int log(int c, const char* prefix) {
84
85     static int last = '\n'; // Single log file
86
87     if (last == '\n')
88         logBuf->sputn(prefix, 3);
89
90     return last = logBuf->sputc((char)c);
91   }
92 };
93
94 class Logger {
95
96   Logger() : in(cin.rdbuf(), file.rdbuf()), out(cout.rdbuf(), file.rdbuf()) {}
97  ~Logger() { start(""); }
98
99   ofstream file;
100   Tie in, out;
101
102 public:
103   static void start(const std::string& fname) {
104
105     static Logger l;
106
107     if (!fname.empty() && !l.file.is_open())
108     {
109         l.file.open(fname, ifstream::out);
110
111         if (!l.file.is_open())
112         {
113             cerr << "Unable to open debug log file " << fname << endl;
114             exit(EXIT_FAILURE);
115         }
116
117         cin.rdbuf(&l.in);
118         cout.rdbuf(&l.out);
119     }
120     else if (fname.empty() && l.file.is_open())
121     {
122         cout.rdbuf(l.out.buf);
123         cin.rdbuf(l.in.buf);
124         l.file.close();
125     }
126   }
127 };
128
129 } // namespace
130
131 /// engine_info() returns the full name of the current Stockfish version. This
132 /// will be either "Stockfish <Tag> DD-MM-YY" (where DD-MM-YY is the date when
133 /// the program was compiled) or "Stockfish <Version>", depending on whether
134 /// Version is empty.
135
136 const string engine_info(bool to_uci) {
137
138   const string months("Jan Feb Mar Apr May Jun Jul Aug Sep Oct Nov Dec");
139   string month, day, year;
140   stringstream ss, date(__DATE__); // From compiler, format is "Sep 21 2008"
141
142   ss << "Stockfish " << Version << setfill('0');
143
144   if (Version.empty())
145   {
146       date >> month >> day >> year;
147       ss << setw(2) << day << setw(2) << (1 + months.find(month) / 4) << year.substr(2);
148   }
149
150   ss << (Is64Bit ? " 64" : "")
151      << (HasPext ? " BMI2" : (HasPopCnt ? " POPCNT" : ""))
152      << (to_uci  ? "\nid author ": " by ")
153      << "T. Romstad, M. Costalba, J. Kiiski, G. Linscott";
154
155   return ss.str();
156 }
157
158
159 /// compiler_info() returns a string trying to describe the compiler we use
160
161 const std::string compiler_info() {
162
163   #define stringify2(x) #x
164   #define stringify(x) stringify2(x)
165   #define make_version_string(major, minor, patch) stringify(major) "." stringify(minor) "." stringify(patch)
166
167 /// Predefined macros hell:
168 ///
169 /// __GNUC__           Compiler is gcc, Clang or Intel on Linux
170 /// __INTEL_COMPILER   Compiler is Intel
171 /// _MSC_VER           Compiler is MSVC or Intel on Windows
172 /// _WIN32             Building on Windows (any)
173 /// _WIN64             Building on Windows 64 bit
174
175   std::string compiler = "\nCompiled by ";
176
177   #ifdef __clang__
178      compiler += "clang++ ";
179      compiler += make_version_string(__clang_major__, __clang_minor__, __clang_patchlevel__);
180   #elif __INTEL_COMPILER
181      compiler += "Intel compiler ";
182      compiler += "(version ";
183      compiler += stringify(__INTEL_COMPILER) " update " stringify(__INTEL_COMPILER_UPDATE);
184      compiler += ")";
185   #elif _MSC_VER
186      compiler += "MSVC ";
187      compiler += "(version ";
188      compiler += stringify(_MSC_FULL_VER) "." stringify(_MSC_BUILD);
189      compiler += ")";
190   #elif __GNUC__
191      compiler += "g++ (GNUC) ";
192      compiler += make_version_string(__GNUC__, __GNUC_MINOR__, __GNUC_PATCHLEVEL__);
193   #else
194      compiler += "Unknown compiler ";
195      compiler += "(unknown version)";
196   #endif
197
198   #if defined(__APPLE__)
199      compiler += " on Apple";
200   #elif defined(__CYGWIN__)
201      compiler += " on Cygwin";
202   #elif defined(__MINGW64__)
203      compiler += " on MinGW64";
204   #elif defined(__MINGW32__)
205      compiler += " on MinGW32";
206   #elif defined(__ANDROID__)
207      compiler += " on Android";
208   #elif defined(__linux__)
209      compiler += " on Linux";
210   #elif defined(_WIN64)
211      compiler += " on Microsoft Windows 64-bit";
212   #elif defined(_WIN32)
213      compiler += " on Microsoft Windows 32-bit";
214   #else
215      compiler += " on unknown system";
216   #endif
217
218   compiler += "\n __VERSION__ macro expands to: ";
219   #ifdef __VERSION__
220      compiler += __VERSION__;
221   #else
222      compiler += "(undefined macro)";
223   #endif
224   compiler += "\n";
225
226   return compiler;
227 }
228
229
230 /// Debug functions used mainly to collect run-time statistics
231 static std::atomic<int64_t> hits[2], means[2];
232
233 void dbg_hit_on(bool b) { ++hits[0]; if (b) ++hits[1]; }
234 void dbg_hit_on(bool c, bool b) { if (c) dbg_hit_on(b); }
235 void dbg_mean_of(int v) { ++means[0]; means[1] += v; }
236
237 void dbg_print() {
238
239   if (hits[0])
240       cerr << "Total " << hits[0] << " Hits " << hits[1]
241            << " hit rate (%) " << 100 * hits[1] / hits[0] << endl;
242
243   if (means[0])
244       cerr << "Total " << means[0] << " Mean "
245            << (double)means[1] / means[0] << endl;
246 }
247
248
249 /// Used to serialize access to std::cout to avoid multiple threads writing at
250 /// the same time.
251
252 std::ostream& operator<<(std::ostream& os, SyncCout sc) {
253
254   static std::mutex m;
255
256   if (sc == IO_LOCK)
257       m.lock();
258
259   if (sc == IO_UNLOCK)
260       m.unlock();
261
262   return os;
263 }
264
265
266 /// Trampoline helper to avoid moving Logger to misc.h
267 void start_logger(const std::string& fname) { Logger::start(fname); }
268
269
270 /// prefetch() preloads the given address in L1/L2 cache. This is a non-blocking
271 /// function that doesn't stall the CPU waiting for data to be loaded from memory,
272 /// which can be quite slow.
273 #ifdef NO_PREFETCH
274
275 void prefetch(void*) {}
276
277 #else
278
279 void prefetch(void* addr) {
280
281 #  if defined(__INTEL_COMPILER)
282    // This hack prevents prefetches from being optimized away by
283    // Intel compiler. Both MSVC and gcc seem not be affected by this.
284    __asm__ ("");
285 #  endif
286
287 #  if defined(__INTEL_COMPILER) || defined(_MSC_VER)
288   _mm_prefetch((char*)addr, _MM_HINT_T0);
289 #  else
290   __builtin_prefetch(addr);
291 #  endif
292 }
293
294 #endif
295
296
297 /// aligned_ttmem_alloc will return suitably aligned memory, and if possible use large pages.
298 /// The returned pointer is the aligned one, while the mem argument is the one that needs to be passed to free.
299 /// With c++17 some of this functionality can be simplified.
300 #if defined(__linux__) && !defined(__ANDROID__)
301
302 void* aligned_ttmem_alloc(size_t allocSize, void*& mem) {
303
304   constexpr size_t alignment = 2 * 1024 * 1024; // assumed 2MB page sizes
305   size_t size = ((allocSize + alignment - 1) / alignment) * alignment; // multiple of alignment
306   mem = aligned_alloc(alignment, size);
307   madvise(mem, allocSize, MADV_HUGEPAGE);
308   return mem;
309 }
310
311 #else
312
313 void* aligned_ttmem_alloc(size_t allocSize, void*& mem) {
314
315   constexpr size_t alignment = 64; // assumed cache line size
316   size_t size = allocSize + alignment - 1; // allocate some extra space
317   mem = malloc(size);
318   void* ret = reinterpret_cast<void*>((uintptr_t(mem) + alignment - 1) & ~uintptr_t(alignment - 1));
319   return ret;
320 }
321
322 #endif
323
324
325 namespace WinProcGroup {
326
327 #ifndef _WIN32
328
329 void bindThisThread(size_t) {}
330
331 #else
332
333 /// best_group() retrieves logical processor information using Windows specific
334 /// API and returns the best group id for the thread with index idx. Original
335 /// code from Texel by Peter Ă–sterlund.
336
337 int best_group(size_t idx) {
338
339   int threads = 0;
340   int nodes = 0;
341   int cores = 0;
342   DWORD returnLength = 0;
343   DWORD byteOffset = 0;
344
345   // Early exit if the needed API is not available at runtime
346   HMODULE k32 = GetModuleHandle("Kernel32.dll");
347   auto fun1 = (fun1_t)(void(*)())GetProcAddress(k32, "GetLogicalProcessorInformationEx");
348   if (!fun1)
349       return -1;
350
351   // First call to get returnLength. We expect it to fail due to null buffer
352   if (fun1(RelationAll, nullptr, &returnLength))
353       return -1;
354
355   // Once we know returnLength, allocate the buffer
356   SYSTEM_LOGICAL_PROCESSOR_INFORMATION_EX *buffer, *ptr;
357   ptr = buffer = (SYSTEM_LOGICAL_PROCESSOR_INFORMATION_EX*)malloc(returnLength);
358
359   // Second call, now we expect to succeed
360   if (!fun1(RelationAll, buffer, &returnLength))
361   {
362       free(buffer);
363       return -1;
364   }
365
366   while (byteOffset < returnLength)
367   {
368       if (ptr->Relationship == RelationNumaNode)
369           nodes++;
370
371       else if (ptr->Relationship == RelationProcessorCore)
372       {
373           cores++;
374           threads += (ptr->Processor.Flags == LTP_PC_SMT) ? 2 : 1;
375       }
376
377       assert(ptr->Size);
378       byteOffset += ptr->Size;
379       ptr = (SYSTEM_LOGICAL_PROCESSOR_INFORMATION_EX*)(((char*)ptr) + ptr->Size);
380   }
381
382   free(buffer);
383
384   std::vector<int> groups;
385
386   // Run as many threads as possible on the same node until core limit is
387   // reached, then move on filling the next node.
388   for (int n = 0; n < nodes; n++)
389       for (int i = 0; i < cores / nodes; i++)
390           groups.push_back(n);
391
392   // In case a core has more than one logical processor (we assume 2) and we
393   // have still threads to allocate, then spread them evenly across available
394   // nodes.
395   for (int t = 0; t < threads - cores; t++)
396       groups.push_back(t % nodes);
397
398   // If we still have more threads than the total number of logical processors
399   // then return -1 and let the OS to decide what to do.
400   return idx < groups.size() ? groups[idx] : -1;
401 }
402
403
404 /// bindThisThread() set the group affinity of the current thread
405
406 void bindThisThread(size_t idx) {
407
408   // Use only local variables to be thread-safe
409   int group = best_group(idx);
410
411   if (group == -1)
412       return;
413
414   // Early exit if the needed API are not available at runtime
415   HMODULE k32 = GetModuleHandle("Kernel32.dll");
416   auto fun2 = (fun2_t)(void(*)())GetProcAddress(k32, "GetNumaNodeProcessorMaskEx");
417   auto fun3 = (fun3_t)(void(*)())GetProcAddress(k32, "SetThreadGroupAffinity");
418
419   if (!fun2 || !fun3)
420       return;
421
422   GROUP_AFFINITY affinity;
423   if (fun2(group, &affinity))
424       fun3(GetCurrentThread(), &affinity, nullptr);
425 }
426
427 #endif
428
429 } // namespace WinProcGroup