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