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