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