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