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