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