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