2 Stockfish, a UCI chess playing engine derived from Glaurung 2.1
3 Copyright (C) 2004-2023 The Stockfish developers (see AUTHORS file)
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.
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.
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/>.
20 #if _WIN32_WINNT < 0x0601
22 #define _WIN32_WINNT 0x0601 // Force to include needed API prototypes
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.
35 using fun1_t = bool(*)(LOGICAL_PROCESSOR_RELATIONSHIP,
36 PSYSTEM_LOGICAL_PROCESSOR_INFORMATION_EX, PDWORD);
37 using fun2_t = bool(*)(USHORT, PGROUP_AFFINITY);
38 using fun3_t = bool(*)(HANDLE, CONST GROUP_AFFINITY*, PGROUP_AFFINITY);
39 using fun4_t = bool(*)(USHORT, PGROUP_AFFINITY, USHORT, PUSHORT);
40 using fun5_t = WORD(*)();
41 using fun6_t = bool(*)(HANDLE, DWORD, PHANDLE);
42 using fun7_t = bool(*)(LPCSTR, LPCSTR, PLUID);
43 using fun8_t = bool(*)(HANDLE, BOOL, PTOKEN_PRIVILEGES, DWORD, PTOKEN_PRIVILEGES, PDWORD);
53 #include <string_view>
56 #if defined(__linux__) && !defined(__ANDROID__)
61 #if defined(__APPLE__) || defined(__ANDROID__) || defined(__OpenBSD__) || (defined(__GLIBCXX__) && !defined(_GLIBCXX_HAVE_ALIGNED_ALLOC) && !defined(_WIN32)) || defined(__e2k__)
62 #define POSIXALIGNEDALLOC
75 /// Version number or dev.
76 constexpr string_view version = "dev";
78 /// Our fancy logging facility. The trick here is to replace cin.rdbuf() and
79 /// cout.rdbuf() with two Tie objects that tie cin and cout to a file stream. We
80 /// can toggle the logging of std::cout and std:cin at runtime whilst preserving
81 /// usual I/O functionality, all without changing a single line of code!
82 /// Idea from http://groups.google.com/group/comp.lang.c++/msg/1d941c0f26ea0d81
84 struct Tie: public streambuf { // MSVC requires split streambuf for cin and cout
86 Tie(streambuf* b, streambuf* l) : buf(b), logBuf(l) {}
88 int sync() override { return logBuf->pubsync(), buf->pubsync(); }
89 int overflow(int c) override { return log(buf->sputc((char)c), "<< "); }
90 int underflow() override { return buf->sgetc(); }
91 int uflow() override { return log(buf->sbumpc(), ">> "); }
93 streambuf *buf, *logBuf;
95 int log(int c, const char* prefix) {
97 static int last = '\n'; // Single log file
100 logBuf->sputn(prefix, 3);
102 return last = logBuf->sputc((char)c);
108 Logger() : in(cin.rdbuf(), file.rdbuf()), out(cout.rdbuf(), file.rdbuf()) {}
109 ~Logger() { start(""); }
115 static void start(const std::string& fname) {
119 if (l.file.is_open())
121 cout.rdbuf(l.out.buf);
128 l.file.open(fname, ifstream::out);
130 if (!l.file.is_open())
132 cerr << "Unable to open debug log file " << fname << endl;
145 /// engine_info() returns the full name of the current Stockfish version.
146 /// For local dev compiles we try to append the commit sha and commit date
147 /// from git if that fails only the local compilation date is set and "nogit" is specified:
148 /// Stockfish dev-YYYYMMDD-SHA
150 /// Stockfish dev-YYYYMMDD-nogit
152 /// For releases (non dev builds) we only include the version number:
153 /// Stockfish version
155 string engine_info(bool to_uci) {
157 ss << "Stockfish " << version << setfill('0');
159 if constexpr (version == "dev")
163 ss << stringify(GIT_DATE);
165 constexpr string_view months("Jan Feb Mar Apr May Jun Jul Aug Sep Oct Nov Dec");
166 string month, day, year;
167 stringstream date(__DATE__); // From compiler, format is "Sep 21 2008"
169 date >> month >> day >> year;
170 ss << year << setw(2) << setfill('0') << (1 + months.find(month) / 4) << setw(2) << setfill('0') << day;
176 ss << stringify(GIT_SHA);
182 ss << (to_uci ? "\nid author ": " by ")
183 << "the Stockfish developers (see AUTHORS file)";
189 /// compiler_info() returns a string trying to describe the compiler we use
191 std::string compiler_info() {
193 #define make_version_string(major, minor, patch) stringify(major) "." stringify(minor) "." stringify(patch)
195 /// Predefined macros hell:
197 /// __GNUC__ Compiler is gcc, Clang or Intel on Linux
198 /// __INTEL_COMPILER Compiler is Intel
199 /// _MSC_VER Compiler is MSVC or Intel on Windows
200 /// _WIN32 Building on Windows (any)
201 /// _WIN64 Building on Windows 64 bit
203 std::string compiler = "\nCompiled by ";
206 compiler += "clang++ ";
207 compiler += make_version_string(__clang_major__, __clang_minor__, __clang_patchlevel__);
208 #elif __INTEL_COMPILER
209 compiler += "Intel compiler ";
210 compiler += "(version ";
211 compiler += stringify(__INTEL_COMPILER) " update " stringify(__INTEL_COMPILER_UPDATE);
215 compiler += "(version ";
216 compiler += stringify(_MSC_FULL_VER) "." stringify(_MSC_BUILD);
218 #elif defined(__e2k__) && defined(__LCC__)
219 #define dot_ver2(n) \
220 compiler += (char)'.'; \
221 compiler += (char)('0' + (n) / 10); \
222 compiler += (char)('0' + (n) % 10);
224 compiler += "MCST LCC ";
225 compiler += "(version ";
226 compiler += std::to_string(__LCC__ / 100);
227 dot_ver2(__LCC__ % 100)
228 dot_ver2(__LCC_MINOR__)
231 compiler += "g++ (GNUC) ";
232 compiler += make_version_string(__GNUC__, __GNUC_MINOR__, __GNUC_PATCHLEVEL__);
234 compiler += "Unknown compiler ";
235 compiler += "(unknown version)";
238 #if defined(__APPLE__)
239 compiler += " on Apple";
240 #elif defined(__CYGWIN__)
241 compiler += " on Cygwin";
242 #elif defined(__MINGW64__)
243 compiler += " on MinGW64";
244 #elif defined(__MINGW32__)
245 compiler += " on MinGW32";
246 #elif defined(__ANDROID__)
247 compiler += " on Android";
248 #elif defined(__linux__)
249 compiler += " on Linux";
250 #elif defined(_WIN64)
251 compiler += " on Microsoft Windows 64-bit";
252 #elif defined(_WIN32)
253 compiler += " on Microsoft Windows 32-bit";
255 compiler += " on unknown system";
258 compiler += "\nCompilation settings include: ";
259 compiler += (Is64Bit ? " 64bit" : " 32bit");
260 #if defined(USE_VNNI)
263 #if defined(USE_AVX512)
264 compiler += " AVX512";
266 compiler += (HasPext ? " BMI2" : "");
267 #if defined(USE_AVX2)
270 #if defined(USE_SSE41)
271 compiler += " SSE41";
273 #if defined(USE_SSSE3)
274 compiler += " SSSE3";
276 #if defined(USE_SSE2)
279 compiler += (HasPopCnt ? " POPCNT" : "");
283 #if defined(USE_NEON_DOTPROD)
284 compiler += " NEON_DOTPROD";
285 #elif defined(USE_NEON)
290 compiler += " DEBUG";
293 compiler += "\n__VERSION__ macro expands to: ";
295 compiler += __VERSION__;
297 compiler += "(undefined macro)";
305 /// Debug functions used mainly to collect run-time statistics
306 constexpr int MaxDebugSlots = 32;
312 std::atomic<int64_t> data[N] = { 0 };
314 constexpr inline std::atomic<int64_t>& operator[](int index) { return data[index]; }
317 DebugInfo<2> hit[MaxDebugSlots];
318 DebugInfo<2> mean[MaxDebugSlots];
319 DebugInfo<3> stdev[MaxDebugSlots];
320 DebugInfo<6> correl[MaxDebugSlots];
324 void dbg_hit_on(bool cond, int slot) {
331 void dbg_mean_of(int64_t value, int slot) {
334 mean[slot][1] += value;
337 void dbg_stdev_of(int64_t value, int slot) {
340 stdev[slot][1] += value;
341 stdev[slot][2] += value * value;
344 void dbg_correl_of(int64_t value1, int64_t value2, int slot) {
347 correl[slot][1] += value1;
348 correl[slot][2] += value1 * value1;
349 correl[slot][3] += value2;
350 correl[slot][4] += value2 * value2;
351 correl[slot][5] += value1 * value2;
357 auto E = [&n](int64_t x) { return double(x) / n; };
358 auto sqr = [](double x) { return x * x; };
360 for (int i = 0; i < MaxDebugSlots; ++i)
362 std::cerr << "Hit #" << i
363 << ": Total " << n << " Hits " << hit[i][1]
364 << " Hit Rate (%) " << 100.0 * E(hit[i][1])
367 for (int i = 0; i < MaxDebugSlots; ++i)
368 if ((n = mean[i][0]))
370 std::cerr << "Mean #" << i
371 << ": Total " << n << " Mean " << E(mean[i][1])
375 for (int i = 0; i < MaxDebugSlots; ++i)
376 if ((n = stdev[i][0]))
378 double r = sqrtl(E(stdev[i][2]) - sqr(E(stdev[i][1])));
379 std::cerr << "Stdev #" << i
380 << ": Total " << n << " Stdev " << r
384 for (int i = 0; i < MaxDebugSlots; ++i)
385 if ((n = correl[i][0]))
387 double r = (E(correl[i][5]) - E(correl[i][1]) * E(correl[i][3]))
388 / ( sqrtl(E(correl[i][2]) - sqr(E(correl[i][1])))
389 * sqrtl(E(correl[i][4]) - sqr(E(correl[i][3]))));
390 std::cerr << "Correl. #" << i
391 << ": Total " << n << " Coefficient " << r
397 /// Used to serialize access to std::cout to avoid multiple threads writing at
400 std::ostream& operator<<(std::ostream& os, SyncCout sc) {
414 /// Trampoline helper to avoid moving Logger to misc.h
415 void start_logger(const std::string& fname) { Logger::start(fname); }
418 /// prefetch() preloads the given address in L1/L2 cache. This is a non-blocking
419 /// function that doesn't stall the CPU waiting for data to be loaded from memory,
420 /// which can be quite slow.
423 void prefetch(void*) {}
427 void prefetch(void* addr) {
429 # if defined(__INTEL_COMPILER)
430 // This hack prevents prefetches from being optimized away by
431 // Intel compiler. Both MSVC and gcc seem not be affected by this.
435 # if defined(__INTEL_COMPILER) || defined(_MSC_VER)
436 _mm_prefetch((char*)addr, _MM_HINT_T0);
438 __builtin_prefetch(addr);
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().
449 void* std_aligned_alloc(size_t alignment, size_t size) {
451 #if defined(POSIXALIGNEDALLOC)
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);
459 return std::aligned_alloc(alignment, size);
463 void std_aligned_free(void* ptr) {
465 #if defined(POSIXALIGNEDALLOC)
467 #elif defined(_WIN32) && !defined(_M_ARM) && !defined(_M_ARM64)
469 #elif defined(_WIN32)
476 /// aligned_large_pages_alloc() will return suitably aligned memory, if possible using large pages.
480 static void* aligned_large_pages_alloc_windows([[maybe_unused]] size_t allocSize) {
486 HANDLE hProcessToken { };
490 const size_t largePageSize = GetLargePageMinimum();
494 // Dynamically link OpenProcessToken, LookupPrivilegeValue and AdjustTokenPrivileges
496 HMODULE hAdvapi32 = GetModuleHandle(TEXT("advapi32.dll"));
499 hAdvapi32 = LoadLibrary(TEXT("advapi32.dll"));
501 auto fun6 = (fun6_t)(void(*)())GetProcAddress(hAdvapi32, "OpenProcessToken");
504 auto fun7 = (fun7_t)(void(*)())GetProcAddress(hAdvapi32, "LookupPrivilegeValueA");
507 auto fun8 = (fun8_t)(void(*)())GetProcAddress(hAdvapi32, "AdjustTokenPrivileges");
511 // We need SeLockMemoryPrivilege, so try to enable it for the process
512 if (!fun6( // OpenProcessToken()
513 GetCurrentProcess(), TOKEN_ADJUST_PRIVILEGES | TOKEN_QUERY, &hProcessToken))
516 if (fun7( // LookupPrivilegeValue(nullptr, SE_LOCK_MEMORY_NAME, &luid)
517 nullptr, "SeLockMemoryPrivilege", &luid))
519 TOKEN_PRIVILEGES tp { };
520 TOKEN_PRIVILEGES prevTp { };
523 tp.PrivilegeCount = 1;
524 tp.Privileges[0].Luid = luid;
525 tp.Privileges[0].Attributes = SE_PRIVILEGE_ENABLED;
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)
533 // Round up size to full pages and allocate
534 allocSize = (allocSize + largePageSize - 1) & ~size_t(largePageSize - 1);
536 nullptr, allocSize, MEM_RESERVE | MEM_COMMIT | MEM_LARGE_PAGES, PAGE_READWRITE);
538 // Privilege no longer needed, restore previous state
539 fun8( // AdjustTokenPrivileges ()
540 hProcessToken, FALSE, &prevTp, 0, nullptr, nullptr);
544 CloseHandle(hProcessToken);
551 void* aligned_large_pages_alloc(size_t allocSize) {
553 // Try to allocate large pages
554 void* mem = aligned_large_pages_alloc_windows(allocSize);
556 // Fall back to regular, page aligned, allocation if necessary
558 mem = VirtualAlloc(nullptr, allocSize, MEM_RESERVE | MEM_COMMIT, PAGE_READWRITE);
565 void* aligned_large_pages_alloc(size_t allocSize) {
567 #if defined(__linux__)
568 constexpr size_t alignment = 2 * 1024 * 1024; // assumed 2MB page size
570 constexpr size_t alignment = 4096; // assumed small page size
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);
585 /// aligned_large_pages_free() will free the previously allocated ttmem
589 void aligned_large_pages_free(void* mem) {
591 if (mem && !VirtualFree(mem, 0, MEM_RELEASE))
593 DWORD err = GetLastError();
594 std::cerr << "Failed to free large page memory. Error code: 0x"
596 << std::dec << std::endl;
603 void aligned_large_pages_free(void *mem) {
604 std_aligned_free(mem);
610 namespace WinProcGroup {
614 void bindThisThread(size_t) {}
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.
622 static int best_node(size_t idx) {
627 DWORD returnLength = 0;
628 DWORD byteOffset = 0;
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");
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))
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);
645 // Second call to GetLogicalProcessorInformationEx(), now we expect to succeed
646 if (!fun1(RelationAll, buffer, &returnLength))
652 while (byteOffset < returnLength)
654 if (ptr->Relationship == RelationNumaNode)
657 else if (ptr->Relationship == RelationProcessorCore)
660 threads += (ptr->Processor.Flags == LTP_PC_SMT) ? 2 : 1;
664 byteOffset += ptr->Size;
665 ptr = (SYSTEM_LOGICAL_PROCESSOR_INFORMATION_EX*)(((char*)ptr) + ptr->Size);
670 std::vector<int> groups;
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++)
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
681 for (int t = 0; t < threads - cores; t++)
682 groups.push_back(t % nodes);
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;
690 /// bindThisThread() set the group affinity of the current thread
692 void bindThisThread(size_t idx) {
694 // Use only local variables to be thread-safe
695 int node = best_node(idx);
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");
712 GROUP_AFFINITY affinity;
713 if (fun2(node, &affinity)) // GetNumaNodeProcessorMaskEx
714 fun3(GetCurrentThread(), &affinity, nullptr); // SetThreadGroupAffinity
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
731 } // namespace WinProcGroup
735 #define GETCWD _getcwd
738 #define GETCWD getcwd
741 namespace CommandLine {
743 string argv0; // path+name of the executable binary, as given by argv[0]
744 string binaryDirectory; // path of the executable directory
745 string workingDirectory; // path of the working directory
747 void init([[maybe_unused]] int argc, char* argv[]) {
748 string pathSeparator;
750 // extract the path+name of the executable binary
754 pathSeparator = "\\";
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)
766 // extract the working directory
767 workingDirectory = "";
769 char* cwd = GETCWD(buff, 40000);
771 workingDirectory = cwd;
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;
779 binaryDirectory.resize(pos + 1);
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);
787 } // namespace CommandLine
789 } // namespace Stockfish