2 Stockfish, a UCI chess playing engine derived from Glaurung 2.1
3 Copyright (C) 2004-2022 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 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 typedef bool(*fun4_t)(USHORT, PGROUP_AFFINITY, USHORT, PUSHORT);
40 typedef WORD(*fun5_t)();
51 #if defined(__linux__) && !defined(__ANDROID__)
56 #if defined(__APPLE__) || defined(__ANDROID__) || defined(__OpenBSD__) || (defined(__GLIBCXX__) && !defined(_GLIBCXX_HAVE_ALIGNED_ALLOC) && !defined(_WIN32)) || defined(__e2k__)
57 #define POSIXALIGNEDALLOC
70 /// Version number. If Version is left empty, then compile date in the format
71 /// DD-MM-YY and show in engine_info.
72 const string Version = "";
74 /// Our fancy logging facility. The trick here is to replace cin.rdbuf() and
75 /// cout.rdbuf() with two Tie objects that tie cin and cout to a file stream. We
76 /// can toggle the logging of std::cout and std:cin at runtime whilst preserving
77 /// usual I/O functionality, all without changing a single line of code!
78 /// Idea from http://groups.google.com/group/comp.lang.c++/msg/1d941c0f26ea0d81
80 struct Tie: public streambuf { // MSVC requires split streambuf for cin and cout
82 Tie(streambuf* b, streambuf* l) : buf(b), logBuf(l) {}
84 int sync() override { return logBuf->pubsync(), buf->pubsync(); }
85 int overflow(int c) override { return log(buf->sputc((char)c), "<< "); }
86 int underflow() override { return buf->sgetc(); }
87 int uflow() override { return log(buf->sbumpc(), ">> "); }
89 streambuf *buf, *logBuf;
91 int log(int c, const char* prefix) {
93 static int last = '\n'; // Single log file
96 logBuf->sputn(prefix, 3);
98 return last = logBuf->sputc((char)c);
104 Logger() : in(cin.rdbuf(), file.rdbuf()), out(cout.rdbuf(), file.rdbuf()) {}
105 ~Logger() { start(""); }
111 static void start(const std::string& fname) {
115 if (l.file.is_open())
117 cout.rdbuf(l.out.buf);
124 l.file.open(fname, ifstream::out);
126 if (!l.file.is_open())
128 cerr << "Unable to open debug log file " << fname << endl;
141 /// engine_info() returns the full name of the current Stockfish version. This
142 /// will be either "Stockfish <Tag> DD-MM-YY" (where DD-MM-YY is the date when
143 /// the program was compiled) or "Stockfish <Version>", depending on whether
144 /// Version is empty.
146 string engine_info(bool to_uci) {
148 const string months("Jan Feb Mar Apr May Jun Jul Aug Sep Oct Nov Dec");
149 string month, day, year;
150 stringstream ss, date(__DATE__); // From compiler, format is "Sep 21 2008"
152 ss << "Stockfish " << Version << setfill('0');
156 date >> month >> day >> year;
157 ss << setw(2) << day << setw(2) << (1 + months.find(month) / 4) << year.substr(2);
161 ss << (to_uci ? "\nid author ": " by ")
162 << "the Stockfish developers (see AUTHORS file)";
168 /// compiler_info() returns a string trying to describe the compiler we use
170 std::string compiler_info() {
172 #define stringify2(x) #x
173 #define stringify(x) stringify2(x)
174 #define make_version_string(major, minor, patch) stringify(major) "." stringify(minor) "." stringify(patch)
176 /// Predefined macros hell:
178 /// __GNUC__ Compiler is gcc, Clang or Intel on Linux
179 /// __INTEL_COMPILER Compiler is Intel
180 /// _MSC_VER Compiler is MSVC or Intel on Windows
181 /// _WIN32 Building on Windows (any)
182 /// _WIN64 Building on Windows 64 bit
184 std::string compiler = "\nCompiled by ";
187 compiler += "clang++ ";
188 compiler += make_version_string(__clang_major__, __clang_minor__, __clang_patchlevel__);
189 #elif __INTEL_COMPILER
190 compiler += "Intel compiler ";
191 compiler += "(version ";
192 compiler += stringify(__INTEL_COMPILER) " update " stringify(__INTEL_COMPILER_UPDATE);
196 compiler += "(version ";
197 compiler += stringify(_MSC_FULL_VER) "." stringify(_MSC_BUILD);
199 #elif defined(__e2k__) && defined(__LCC__)
200 #define dot_ver2(n) \
201 compiler += (char)'.'; \
202 compiler += (char)('0' + (n) / 10); \
203 compiler += (char)('0' + (n) % 10);
205 compiler += "MCST LCC ";
206 compiler += "(version ";
207 compiler += std::to_string(__LCC__ / 100);
208 dot_ver2(__LCC__ % 100)
209 dot_ver2(__LCC_MINOR__)
212 compiler += "g++ (GNUC) ";
213 compiler += make_version_string(__GNUC__, __GNUC_MINOR__, __GNUC_PATCHLEVEL__);
215 compiler += "Unknown compiler ";
216 compiler += "(unknown version)";
219 #if defined(__APPLE__)
220 compiler += " on Apple";
221 #elif defined(__CYGWIN__)
222 compiler += " on Cygwin";
223 #elif defined(__MINGW64__)
224 compiler += " on MinGW64";
225 #elif defined(__MINGW32__)
226 compiler += " on MinGW32";
227 #elif defined(__ANDROID__)
228 compiler += " on Android";
229 #elif defined(__linux__)
230 compiler += " on Linux";
231 #elif defined(_WIN64)
232 compiler += " on Microsoft Windows 64-bit";
233 #elif defined(_WIN32)
234 compiler += " on Microsoft Windows 32-bit";
236 compiler += " on unknown system";
239 compiler += "\nCompilation settings include: ";
240 compiler += (Is64Bit ? " 64bit" : " 32bit");
241 #if defined(USE_VNNI)
244 #if defined(USE_AVX512)
245 compiler += " AVX512";
247 compiler += (HasPext ? " BMI2" : "");
248 #if defined(USE_AVX2)
251 #if defined(USE_SSE41)
252 compiler += " SSE41";
254 #if defined(USE_SSSE3)
255 compiler += " SSSE3";
257 #if defined(USE_SSE2)
260 compiler += (HasPopCnt ? " POPCNT" : "");
264 #if defined(USE_NEON)
269 compiler += " DEBUG";
272 compiler += "\n__VERSION__ macro expands to: ";
274 compiler += __VERSION__;
276 compiler += "(undefined macro)";
284 /// Debug functions used mainly to collect run-time statistics
285 static std::atomic<int64_t> hits[2], means[2];
287 void dbg_hit_on(bool b) { ++hits[0]; if (b) ++hits[1]; }
288 void dbg_hit_on(bool c, bool b) { if (c) dbg_hit_on(b); }
289 void dbg_mean_of(int v) { ++means[0]; means[1] += v; }
294 cerr << "Total " << hits[0] << " Hits " << hits[1]
295 << " hit rate (%) " << 100 * hits[1] / hits[0] << endl;
298 cerr << "Total " << means[0] << " Mean "
299 << (double)means[1] / means[0] << endl;
303 /// Used to serialize access to std::cout to avoid multiple threads writing at
306 std::ostream& operator<<(std::ostream& os, SyncCout sc) {
320 /// Trampoline helper to avoid moving Logger to misc.h
321 void start_logger(const std::string& fname) { Logger::start(fname); }
324 /// prefetch() preloads the given address in L1/L2 cache. This is a non-blocking
325 /// function that doesn't stall the CPU waiting for data to be loaded from memory,
326 /// which can be quite slow.
329 void prefetch(void*) {}
333 void prefetch(void* addr) {
335 # if defined(__INTEL_COMPILER)
336 // This hack prevents prefetches from being optimized away by
337 // Intel compiler. Both MSVC and gcc seem not be affected by this.
341 # if defined(__INTEL_COMPILER) || defined(_MSC_VER)
342 _mm_prefetch((char*)addr, _MM_HINT_T0);
344 __builtin_prefetch(addr);
351 /// std_aligned_alloc() is our wrapper for systems where the c++17 implementation
352 /// does not guarantee the availability of aligned_alloc(). Memory allocated with
353 /// std_aligned_alloc() must be freed with std_aligned_free().
355 void* std_aligned_alloc(size_t alignment, size_t size) {
357 #if defined(POSIXALIGNEDALLOC)
359 return posix_memalign(&mem, alignment, size) ? nullptr : mem;
360 #elif defined(_WIN32)
361 return _mm_malloc(size, alignment);
363 return std::aligned_alloc(alignment, size);
367 void std_aligned_free(void* ptr) {
369 #if defined(POSIXALIGNEDALLOC)
371 #elif defined(_WIN32)
378 /// aligned_large_pages_alloc() will return suitably aligned memory, if possible using large pages.
382 static void* aligned_large_pages_alloc_windows(size_t allocSize) {
385 (void)allocSize; // suppress unused-parameter compiler warning
389 HANDLE hProcessToken { };
393 const size_t largePageSize = GetLargePageMinimum();
397 // We need SeLockMemoryPrivilege, so try to enable it for the process
398 if (!OpenProcessToken(GetCurrentProcess(), TOKEN_ADJUST_PRIVILEGES | TOKEN_QUERY, &hProcessToken))
401 if (LookupPrivilegeValue(NULL, SE_LOCK_MEMORY_NAME, &luid))
403 TOKEN_PRIVILEGES tp { };
404 TOKEN_PRIVILEGES prevTp { };
407 tp.PrivilegeCount = 1;
408 tp.Privileges[0].Luid = luid;
409 tp.Privileges[0].Attributes = SE_PRIVILEGE_ENABLED;
411 // Try to enable SeLockMemoryPrivilege. Note that even if AdjustTokenPrivileges() succeeds,
412 // we still need to query GetLastError() to ensure that the privileges were actually obtained.
413 if (AdjustTokenPrivileges(
414 hProcessToken, FALSE, &tp, sizeof(TOKEN_PRIVILEGES), &prevTp, &prevTpLen) &&
415 GetLastError() == ERROR_SUCCESS)
417 // Round up size to full pages and allocate
418 allocSize = (allocSize + largePageSize - 1) & ~size_t(largePageSize - 1);
420 NULL, allocSize, MEM_RESERVE | MEM_COMMIT | MEM_LARGE_PAGES, PAGE_READWRITE);
422 // Privilege no longer needed, restore previous state
423 AdjustTokenPrivileges(hProcessToken, FALSE, &prevTp, 0, NULL, NULL);
427 CloseHandle(hProcessToken);
434 void* aligned_large_pages_alloc(size_t allocSize) {
436 // Try to allocate large pages
437 void* mem = aligned_large_pages_alloc_windows(allocSize);
439 // Fall back to regular, page aligned, allocation if necessary
441 mem = VirtualAlloc(NULL, allocSize, MEM_RESERVE | MEM_COMMIT, PAGE_READWRITE);
448 void* aligned_large_pages_alloc(size_t allocSize) {
450 #if defined(__linux__)
451 constexpr size_t alignment = 2 * 1024 * 1024; // assumed 2MB page size
453 constexpr size_t alignment = 4096; // assumed small page size
456 // round up to multiples of alignment
457 size_t size = ((allocSize + alignment - 1) / alignment) * alignment;
458 void *mem = std_aligned_alloc(alignment, size);
459 #if defined(MADV_HUGEPAGE)
460 madvise(mem, size, MADV_HUGEPAGE);
468 /// aligned_large_pages_free() will free the previously allocated ttmem
472 void aligned_large_pages_free(void* mem) {
474 if (mem && !VirtualFree(mem, 0, MEM_RELEASE))
476 DWORD err = GetLastError();
477 std::cerr << "Failed to free large page memory. Error code: 0x"
479 << std::dec << std::endl;
486 void aligned_large_pages_free(void *mem) {
487 std_aligned_free(mem);
493 namespace WinProcGroup {
497 void bindThisThread(size_t) {}
501 /// best_node() retrieves logical processor information using Windows specific
502 /// API and returns the best node id for the thread with index idx. Original
503 /// code from Texel by Peter Ă–sterlund.
505 int best_node(size_t idx) {
510 DWORD returnLength = 0;
511 DWORD byteOffset = 0;
513 // Early exit if the needed API is not available at runtime
514 HMODULE k32 = GetModuleHandle("Kernel32.dll");
515 auto fun1 = (fun1_t)(void(*)())GetProcAddress(k32, "GetLogicalProcessorInformationEx");
519 // First call to GetLogicalProcessorInformationEx() to get returnLength.
520 // We expect the call to fail due to null buffer.
521 if (fun1(RelationAll, nullptr, &returnLength))
524 // Once we know returnLength, allocate the buffer
525 SYSTEM_LOGICAL_PROCESSOR_INFORMATION_EX *buffer, *ptr;
526 ptr = buffer = (SYSTEM_LOGICAL_PROCESSOR_INFORMATION_EX*)malloc(returnLength);
528 // Second call to GetLogicalProcessorInformationEx(), now we expect to succeed
529 if (!fun1(RelationAll, buffer, &returnLength))
535 while (byteOffset < returnLength)
537 if (ptr->Relationship == RelationNumaNode)
540 else if (ptr->Relationship == RelationProcessorCore)
543 threads += (ptr->Processor.Flags == LTP_PC_SMT) ? 2 : 1;
547 byteOffset += ptr->Size;
548 ptr = (SYSTEM_LOGICAL_PROCESSOR_INFORMATION_EX*)(((char*)ptr) + ptr->Size);
553 std::vector<int> groups;
555 // Run as many threads as possible on the same node until core limit is
556 // reached, then move on filling the next node.
557 for (int n = 0; n < nodes; n++)
558 for (int i = 0; i < cores / nodes; i++)
561 // In case a core has more than one logical processor (we assume 2) and we
562 // have still threads to allocate, then spread them evenly across available
564 for (int t = 0; t < threads - cores; t++)
565 groups.push_back(t % nodes);
567 // If we still have more threads than the total number of logical processors
568 // then return -1 and let the OS to decide what to do.
569 return idx < groups.size() ? groups[idx] : -1;
573 /// bindThisThread() set the group affinity of the current thread
575 void bindThisThread(size_t idx) {
577 // Use only local variables to be thread-safe
578 int node = best_node(idx);
583 // Early exit if the needed API are not available at runtime
584 HMODULE k32 = GetModuleHandle("Kernel32.dll");
585 auto fun2 = (fun2_t)(void(*)())GetProcAddress(k32, "GetNumaNodeProcessorMaskEx");
586 auto fun3 = (fun3_t)(void(*)())GetProcAddress(k32, "SetThreadGroupAffinity");
587 auto fun4 = (fun4_t)(void(*)())GetProcAddress(k32, "GetNumaNodeProcessorMask2");
588 auto fun5 = (fun5_t)(void(*)())GetProcAddress(k32, "GetMaximumProcessorGroupCount");
595 GROUP_AFFINITY affinity;
596 if (fun2(node, &affinity)) // GetNumaNodeProcessorMaskEx
597 fun3(GetCurrentThread(), &affinity, nullptr); // SetThreadGroupAffinity
601 // If a numa node has more than one processor group, we assume they are
602 // sized equal and we spread threads evenly across the groups.
603 USHORT elements, returnedElements;
604 elements = fun5(); // GetMaximumProcessorGroupCount
605 GROUP_AFFINITY *affinity = (GROUP_AFFINITY*)malloc(elements * sizeof(GROUP_AFFINITY));
606 if (fun4(node, affinity, elements, &returnedElements)) // GetNumaNodeProcessorMask2
607 fun3(GetCurrentThread(), &affinity[idx % returnedElements], nullptr); // SetThreadGroupAffinity
614 } // namespace WinProcGroup
618 #define GETCWD _getcwd
621 #define GETCWD getcwd
624 namespace CommandLine {
626 string argv0; // path+name of the executable binary, as given by argv[0]
627 string binaryDirectory; // path of the executable directory
628 string workingDirectory; // path of the working directory
630 void init(int argc, char* argv[]) {
632 string pathSeparator;
634 // extract the path+name of the executable binary
638 pathSeparator = "\\";
640 // Under windows argv[0] may not have the extension. Also _get_pgmptr() had
641 // issues in some windows 10 versions, so check returned values carefully.
642 char* pgmptr = nullptr;
643 if (!_get_pgmptr(&pgmptr) && pgmptr != nullptr && *pgmptr)
650 // extract the working directory
651 workingDirectory = "";
653 char* cwd = GETCWD(buff, 40000);
655 workingDirectory = cwd;
657 // extract the binary directory path from argv0
658 binaryDirectory = argv0;
659 size_t pos = binaryDirectory.find_last_of("\\/");
660 if (pos == std::string::npos)
661 binaryDirectory = "." + pathSeparator;
663 binaryDirectory.resize(pos + 1);
665 // pattern replacement: "./" at the start of path is replaced by the working directory
666 if (binaryDirectory.find("." + pathSeparator) == 0)
667 binaryDirectory.replace(0, 1, workingDirectory);
671 } // namespace CommandLine
673 } // namespace Stockfish