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