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