Merge remote-tracking branch 'upstream/master' into HEAD
[stockfish] / src / misc.cpp
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 #ifdef _WIN32
20 #if _WIN32_WINNT < 0x0601
21 #undef  _WIN32_WINNT
22 #define _WIN32_WINNT 0x0601 // Force to include needed API prototypes
23 #endif
24
25 #ifndef NOMINMAX
26 #define NOMINMAX
27 #endif
28
29 #include <windows.h>
30 // The needed Windows API for processor groups could be missed from old Windows
31 // versions, so instead of calling them directly (forcing the linker to resolve
32 // the calls at compile time), try to load them at runtime. To do this we need
33 // first to define the corresponding function pointers.
34 extern "C" {
35 typedef bool(*fun1_t)(LOGICAL_PROCESSOR_RELATIONSHIP,
36                       PSYSTEM_LOGICAL_PROCESSOR_INFORMATION_EX, PDWORD);
37 typedef bool(*fun2_t)(USHORT, PGROUP_AFFINITY);
38 typedef bool(*fun3_t)(HANDLE, CONST GROUP_AFFINITY*, PGROUP_AFFINITY);
39 }
40 #endif
41
42 #include <fstream>
43 #include <iomanip>
44 #include <iostream>
45 #include <sstream>
46 #include <vector>
47 #include <cstdlib>
48
49 #if defined(__linux__) && !defined(__ANDROID__)
50 #include <stdlib.h>
51 #include <sys/mman.h>
52 #endif
53
54 #include "misc.h"
55 #include "thread.h"
56
57 using namespace std;
58
59 namespace {
60
61 /// Version number. If Version is left empty, then compile date in the format
62 /// DD-MM-YY and show in engine_info.
63 const string Version = "";
64
65 /// Our fancy logging facility. The trick here is to replace cin.rdbuf() and
66 /// cout.rdbuf() with two Tie objects that tie cin and cout to a file stream. We
67 /// can toggle the logging of std::cout and std:cin at runtime whilst preserving
68 /// usual I/O functionality, all without changing a single line of code!
69 /// Idea from http://groups.google.com/group/comp.lang.c++/msg/1d941c0f26ea0d81
70
71 struct Tie: public streambuf { // MSVC requires split streambuf for cin and cout
72
73   Tie(streambuf* b, streambuf* l) : buf(b), logBuf(l) {}
74
75   int sync() override { return logBuf->pubsync(), buf->pubsync(); }
76   int overflow(int c) override { return log(buf->sputc((char)c), "<< "); }
77   int underflow() override { return buf->sgetc(); }
78   int uflow() override { return log(buf->sbumpc(), ">> "); }
79
80   streambuf *buf, *logBuf;
81
82   int log(int c, const char* prefix) {
83
84     static int last = '\n'; // Single log file
85
86     if (last == '\n')
87         logBuf->sputn(prefix, 3);
88
89     return last = logBuf->sputc((char)c);
90   }
91 };
92
93 class Logger {
94
95   Logger() : in(cin.rdbuf(), file.rdbuf()), out(cout.rdbuf(), file.rdbuf()) {}
96  ~Logger() { start(""); }
97
98   ofstream file;
99   Tie in, out;
100
101 public:
102   static void start(const std::string& fname) {
103
104     static Logger l;
105
106     if (!fname.empty() && !l.file.is_open())
107     {
108         l.file.open(fname, ifstream::out);
109
110         if (!l.file.is_open())
111         {
112             cerr << "Unable to open debug log file " << fname << endl;
113             exit(EXIT_FAILURE);
114         }
115
116         cin.rdbuf(&l.in);
117         cout.rdbuf(&l.out);
118     }
119     else if (fname.empty() && l.file.is_open())
120     {
121         cout.rdbuf(l.out.buf);
122         cin.rdbuf(l.in.buf);
123         l.file.close();
124     }
125   }
126 };
127
128 } // namespace
129
130 /// engine_info() returns the full name of the current Stockfish version. This
131 /// will be either "Stockfish <Tag> DD-MM-YY" (where DD-MM-YY is the date when
132 /// the program was compiled) or "Stockfish <Version>", depending on whether
133 /// Version is empty.
134
135 const string engine_info(bool to_uci) {
136
137   const string months("Jan Feb Mar Apr May Jun Jul Aug Sep Oct Nov Dec");
138   string month, day, year;
139   stringstream ss, date(__DATE__); // From compiler, format is "Sep 21 2008"
140
141   ss << "Stockfish " << Version << setfill('0');
142
143   if (Version.empty())
144   {
145       date >> month >> day >> year;
146       ss << setw(2) << day << setw(2) << (1 + months.find(month) / 4) << year.substr(2);
147       ss << "-asn";
148   }
149
150   ss << (to_uci  ? "\nid author ": " by ")
151      << "the Stockfish developers (see AUTHORS file)";
152
153   return ss.str();
154 }
155
156
157 /// compiler_info() returns a string trying to describe the compiler we use
158
159 const std::string compiler_info() {
160
161   #define stringify2(x) #x
162   #define stringify(x) stringify2(x)
163   #define make_version_string(major, minor, patch) stringify(major) "." stringify(minor) "." stringify(patch)
164
165 /// Predefined macros hell:
166 ///
167 /// __GNUC__           Compiler is gcc, Clang or Intel on Linux
168 /// __INTEL_COMPILER   Compiler is Intel
169 /// _MSC_VER           Compiler is MSVC or Intel on Windows
170 /// _WIN32             Building on Windows (any)
171 /// _WIN64             Building on Windows 64 bit
172
173   std::string compiler = "\nCompiled by ";
174
175   #ifdef __clang__
176      compiler += "clang++ ";
177      compiler += make_version_string(__clang_major__, __clang_minor__, __clang_patchlevel__);
178   #elif __INTEL_COMPILER
179      compiler += "Intel compiler ";
180      compiler += "(version ";
181      compiler += stringify(__INTEL_COMPILER) " update " stringify(__INTEL_COMPILER_UPDATE);
182      compiler += ")";
183   #elif _MSC_VER
184      compiler += "MSVC ";
185      compiler += "(version ";
186      compiler += stringify(_MSC_FULL_VER) "." stringify(_MSC_BUILD);
187      compiler += ")";
188   #elif __GNUC__
189      compiler += "g++ (GNUC) ";
190      compiler += make_version_string(__GNUC__, __GNUC_MINOR__, __GNUC_PATCHLEVEL__);
191   #else
192      compiler += "Unknown compiler ";
193      compiler += "(unknown version)";
194   #endif
195
196   #if defined(__APPLE__)
197      compiler += " on Apple";
198   #elif defined(__CYGWIN__)
199      compiler += " on Cygwin";
200   #elif defined(__MINGW64__)
201      compiler += " on MinGW64";
202   #elif defined(__MINGW32__)
203      compiler += " on MinGW32";
204   #elif defined(__ANDROID__)
205      compiler += " on Android";
206   #elif defined(__linux__)
207      compiler += " on Linux";
208   #elif defined(_WIN64)
209      compiler += " on Microsoft Windows 64-bit";
210   #elif defined(_WIN32)
211      compiler += " on Microsoft Windows 32-bit";
212   #else
213      compiler += " on unknown system";
214   #endif
215
216   compiler += "\nCompilation settings include: ";
217   compiler += (Is64Bit ? " 64bit" : " 32bit");
218   #if defined(USE_AVX512)
219     compiler += " AVX512";
220   #endif
221   #if defined(USE_AVX2)
222     compiler += " AVX2";
223   #endif
224   #if defined(USE_SSE42)
225     compiler += " SSE42";
226   #endif
227   #if defined(USE_SSE41)
228     compiler += " SSE41";
229   #endif
230   #if defined(USE_SSSE3)
231     compiler += " SSSE3";
232   #endif
233   #if defined(USE_SSE3)
234     compiler += " SSE3";
235   #endif
236     compiler += (HasPext ? " BMI2" : "");
237     compiler += (HasPopCnt ? " POPCNT" : "");
238   #if !defined(NDEBUG)
239     compiler += " DEBUG";
240   #endif
241
242   compiler += "\n__VERSION__ macro expands to: ";
243   #ifdef __VERSION__
244      compiler += __VERSION__;
245   #else
246      compiler += "(undefined macro)";
247   #endif
248   compiler += "\n";
249
250   return compiler;
251 }
252
253
254 /// Debug functions used mainly to collect run-time statistics
255 static std::atomic<int64_t> hits[2], means[2];
256
257 void dbg_hit_on(bool b) { ++hits[0]; if (b) ++hits[1]; }
258 void dbg_hit_on(bool c, bool b) { if (c) dbg_hit_on(b); }
259 void dbg_mean_of(int v) { ++means[0]; means[1] += v; }
260
261 void dbg_print() {
262
263   if (hits[0])
264       cerr << "Total " << hits[0] << " Hits " << hits[1]
265            << " hit rate (%) " << 100 * hits[1] / hits[0] << endl;
266
267   if (means[0])
268       cerr << "Total " << means[0] << " Mean "
269            << (double)means[1] / means[0] << endl;
270 }
271
272
273 /// Used to serialize access to std::cout to avoid multiple threads writing at
274 /// the same time.
275
276 std::ostream& operator<<(std::ostream& os, SyncCout sc) {
277
278   static std::mutex m;
279
280   if (sc == IO_LOCK)
281       m.lock();
282
283   if (sc == IO_UNLOCK)
284       m.unlock();
285
286   return os;
287 }
288
289
290 /// Trampoline helper to avoid moving Logger to misc.h
291 void start_logger(const std::string& fname) { Logger::start(fname); }
292
293
294 /// prefetch() preloads the given address in L1/L2 cache. This is a non-blocking
295 /// function that doesn't stall the CPU waiting for data to be loaded from memory,
296 /// which can be quite slow.
297 #ifdef NO_PREFETCH
298
299 void prefetch(void*) {}
300
301 #else
302
303 void prefetch(void* addr) {
304
305 #  if defined(__INTEL_COMPILER)
306    // This hack prevents prefetches from being optimized away by
307    // Intel compiler. Both MSVC and gcc seem not be affected by this.
308    __asm__ ("");
309 #  endif
310
311 #  if defined(__INTEL_COMPILER) || defined(_MSC_VER)
312   _mm_prefetch((char*)addr, _MM_HINT_T0);
313 #  else
314   __builtin_prefetch(addr);
315 #  endif
316 }
317
318 #endif
319
320 /// Wrappers for systems where the c++17 implementation doesn't guarantee the availability of aligned_alloc.
321 /// Memory allocated with std_aligned_alloc must be freed with std_aligned_free.
322 ///
323
324 void* std_aligned_alloc(size_t alignment, size_t size) {
325 #if defined(__APPLE__)
326   return aligned_alloc(alignment, size);
327 #elif defined(_WIN32)
328   return _mm_malloc(size, alignment);
329 #else
330   return std::aligned_alloc(alignment, size);
331 #endif
332 }
333
334 void std_aligned_free(void* ptr) {
335 #if defined(__APPLE__)
336   free(ptr);
337 #elif defined(_WIN32)
338   _mm_free(ptr);
339 #else
340   free(ptr);
341 #endif
342 }
343
344 /// aligned_ttmem_alloc() will return suitably aligned memory, and if possible use large pages.
345 /// The returned pointer is the aligned one, while the mem argument is the one that needs
346 /// to be passed to free. With c++17 some of this functionality could be simplified.
347
348 #if defined(__linux__) && !defined(__ANDROID__)
349
350 void* aligned_ttmem_alloc(size_t allocSize, void*& mem) {
351
352   constexpr size_t alignment = 2 * 1024 * 1024; // assumed 2MB page sizes
353   size_t size = ((allocSize + alignment - 1) / alignment) * alignment; // multiple of alignment
354   if (posix_memalign(&mem, alignment, size))
355      mem = nullptr;
356   madvise(mem, allocSize, MADV_HUGEPAGE);
357   return mem;
358 }
359
360 #elif defined(_WIN64)
361
362 static void* aligned_ttmem_alloc_large_pages(size_t allocSize) {
363
364   HANDLE hProcessToken { };
365   LUID luid { };
366   void* mem = nullptr;
367
368   const size_t largePageSize = GetLargePageMinimum();
369   if (!largePageSize)
370       return nullptr;
371
372   // We need SeLockMemoryPrivilege, so try to enable it for the process
373   if (!OpenProcessToken(GetCurrentProcess(), TOKEN_ADJUST_PRIVILEGES | TOKEN_QUERY, &hProcessToken))
374       return nullptr;
375
376   if (LookupPrivilegeValue(NULL, SE_LOCK_MEMORY_NAME, &luid))
377   {
378       TOKEN_PRIVILEGES tp { };
379       TOKEN_PRIVILEGES prevTp { };
380       DWORD prevTpLen = 0;
381
382       tp.PrivilegeCount = 1;
383       tp.Privileges[0].Luid = luid;
384       tp.Privileges[0].Attributes = SE_PRIVILEGE_ENABLED;
385
386       // Try to enable SeLockMemoryPrivilege. Note that even if AdjustTokenPrivileges() succeeds,
387       // we still need to query GetLastError() to ensure that the privileges were actually obtained.
388       if (AdjustTokenPrivileges(
389               hProcessToken, FALSE, &tp, sizeof(TOKEN_PRIVILEGES), &prevTp, &prevTpLen) &&
390           GetLastError() == ERROR_SUCCESS)
391       {
392           // Round up size to full pages and allocate
393           allocSize = (allocSize + largePageSize - 1) & ~size_t(largePageSize - 1);
394           mem = VirtualAlloc(
395               NULL, allocSize, MEM_RESERVE | MEM_COMMIT | MEM_LARGE_PAGES, PAGE_READWRITE);
396
397           // Privilege no longer needed, restore previous state
398           AdjustTokenPrivileges(hProcessToken, FALSE, &prevTp, 0, NULL, NULL);
399       }
400   }
401
402   CloseHandle(hProcessToken);
403
404   return mem;
405 }
406
407 void* aligned_ttmem_alloc(size_t allocSize, void*& mem) {
408
409   static bool firstCall = true;
410
411   // Try to allocate large pages
412   mem = aligned_ttmem_alloc_large_pages(allocSize);
413
414   // Suppress info strings on the first call. The first call occurs before 'uci'
415   // is received and in that case this output confuses some GUIs.
416   if (!firstCall)
417   {
418       if (mem)
419           sync_cout << "info string Hash table allocation: Windows large pages used." << sync_endl;
420       else
421           sync_cout << "info string Hash table allocation: Windows large pages not used." << sync_endl;
422   }
423   firstCall = false;
424
425   // Fall back to regular, page aligned, allocation if necessary
426   if (!mem)
427       mem = VirtualAlloc(NULL, allocSize, MEM_RESERVE | MEM_COMMIT, PAGE_READWRITE);
428
429   return mem;
430 }
431
432 #else
433
434 void* aligned_ttmem_alloc(size_t allocSize, void*& mem) {
435
436   constexpr size_t alignment = 64; // assumed cache line size
437   size_t size = allocSize + alignment - 1; // allocate some extra space
438   mem = malloc(size);
439   void* ret = reinterpret_cast<void*>((uintptr_t(mem) + alignment - 1) & ~uintptr_t(alignment - 1));
440   return ret;
441 }
442
443 #endif
444
445
446 /// aligned_ttmem_free() will free the previously allocated ttmem
447
448 #if defined(_WIN64)
449
450 void aligned_ttmem_free(void* mem) {
451
452   if (mem && !VirtualFree(mem, 0, MEM_RELEASE))
453   {
454       DWORD err = GetLastError();
455       std::cerr << "Failed to free transposition table. Error code: 0x" <<
456           std::hex << err << std::dec << std::endl;
457       exit(EXIT_FAILURE);
458   }
459 }
460
461 #else
462
463 void aligned_ttmem_free(void *mem) {
464   free(mem);
465 }
466
467 #endif
468
469
470 namespace WinProcGroup {
471
472 #ifndef _WIN32
473
474 void bindThisThread(size_t) {}
475
476 #else
477
478 /// best_group() retrieves logical processor information using Windows specific
479 /// API and returns the best group id for the thread with index idx. Original
480 /// code from Texel by Peter Ă–sterlund.
481
482 int best_group(size_t idx) {
483
484   int threads = 0;
485   int nodes = 0;
486   int cores = 0;
487   DWORD returnLength = 0;
488   DWORD byteOffset = 0;
489
490   // Early exit if the needed API is not available at runtime
491   HMODULE k32 = GetModuleHandle("Kernel32.dll");
492   auto fun1 = (fun1_t)(void(*)())GetProcAddress(k32, "GetLogicalProcessorInformationEx");
493   if (!fun1)
494       return -1;
495
496   // First call to get returnLength. We expect it to fail due to null buffer
497   if (fun1(RelationAll, nullptr, &returnLength))
498       return -1;
499
500   // Once we know returnLength, allocate the buffer
501   SYSTEM_LOGICAL_PROCESSOR_INFORMATION_EX *buffer, *ptr;
502   ptr = buffer = (SYSTEM_LOGICAL_PROCESSOR_INFORMATION_EX*)malloc(returnLength);
503
504   // Second call, now we expect to succeed
505   if (!fun1(RelationAll, buffer, &returnLength))
506   {
507       free(buffer);
508       return -1;
509   }
510
511   while (byteOffset < returnLength)
512   {
513       if (ptr->Relationship == RelationNumaNode)
514           nodes++;
515
516       else if (ptr->Relationship == RelationProcessorCore)
517       {
518           cores++;
519           threads += (ptr->Processor.Flags == LTP_PC_SMT) ? 2 : 1;
520       }
521
522       assert(ptr->Size);
523       byteOffset += ptr->Size;
524       ptr = (SYSTEM_LOGICAL_PROCESSOR_INFORMATION_EX*)(((char*)ptr) + ptr->Size);
525   }
526
527   free(buffer);
528
529   std::vector<int> groups;
530
531   // Run as many threads as possible on the same node until core limit is
532   // reached, then move on filling the next node.
533   for (int n = 0; n < nodes; n++)
534       for (int i = 0; i < cores / nodes; i++)
535           groups.push_back(n);
536
537   // In case a core has more than one logical processor (we assume 2) and we
538   // have still threads to allocate, then spread them evenly across available
539   // nodes.
540   for (int t = 0; t < threads - cores; t++)
541       groups.push_back(t % nodes);
542
543   // If we still have more threads than the total number of logical processors
544   // then return -1 and let the OS to decide what to do.
545   return idx < groups.size() ? groups[idx] : -1;
546 }
547
548
549 /// bindThisThread() set the group affinity of the current thread
550
551 void bindThisThread(size_t idx) {
552
553   // Use only local variables to be thread-safe
554   int group = best_group(idx);
555
556   if (group == -1)
557       return;
558
559   // Early exit if the needed API are not available at runtime
560   HMODULE k32 = GetModuleHandle("Kernel32.dll");
561   auto fun2 = (fun2_t)(void(*)())GetProcAddress(k32, "GetNumaNodeProcessorMaskEx");
562   auto fun3 = (fun3_t)(void(*)())GetProcAddress(k32, "SetThreadGroupAffinity");
563
564   if (!fun2 || !fun3)
565       return;
566
567   GROUP_AFFINITY affinity;
568   if (fun2(group, &affinity))
569       fun3(GetCurrentThread(), &affinity, nullptr);
570 }
571
572 #endif
573
574 } // namespace WinProcGroup