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