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