2 Stockfish, a UCI chess playing engine derived from Glaurung 2.1
3 Copyright (C) 2004-2020 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);
49 #if defined(__linux__) && !defined(__ANDROID__)
61 /// Version number. If Version is left empty, then compile date in the format
62 /// DD-MM-YY and show in engine_info.
63 const string Version = "";
65 /// Our fancy logging facility. The trick here is to replace cin.rdbuf() and
66 /// cout.rdbuf() with two Tie objects that tie cin and cout to a file stream. We
67 /// can toggle the logging of std::cout and std:cin at runtime whilst preserving
68 /// usual I/O functionality, all without changing a single line of code!
69 /// Idea from http://groups.google.com/group/comp.lang.c++/msg/1d941c0f26ea0d81
71 struct Tie: public streambuf { // MSVC requires split streambuf for cin and cout
73 Tie(streambuf* b, streambuf* l) : buf(b), logBuf(l) {}
75 int sync() override { return logBuf->pubsync(), buf->pubsync(); }
76 int overflow(int c) override { return log(buf->sputc((char)c), "<< "); }
77 int underflow() override { return buf->sgetc(); }
78 int uflow() override { return log(buf->sbumpc(), ">> "); }
80 streambuf *buf, *logBuf;
82 int log(int c, const char* prefix) {
84 static int last = '\n'; // Single log file
87 logBuf->sputn(prefix, 3);
89 return last = logBuf->sputc((char)c);
95 Logger() : in(cin.rdbuf(), file.rdbuf()), out(cout.rdbuf(), file.rdbuf()) {}
96 ~Logger() { start(""); }
102 static void start(const std::string& fname) {
106 if (!fname.empty() && !l.file.is_open())
108 l.file.open(fname, ifstream::out);
110 if (!l.file.is_open())
112 cerr << "Unable to open debug log file " << fname << endl;
119 else if (fname.empty() && l.file.is_open())
121 cout.rdbuf(l.out.buf);
130 /// engine_info() returns the full name of the current Stockfish version. This
131 /// will be either "Stockfish <Tag> DD-MM-YY" (where DD-MM-YY is the date when
132 /// the program was compiled) or "Stockfish <Version>", depending on whether
133 /// Version is empty.
135 const string engine_info(bool to_uci) {
137 const string months("Jan Feb Mar Apr May Jun Jul Aug Sep Oct Nov Dec");
138 string month, day, year;
139 stringstream ss, date(__DATE__); // From compiler, format is "Sep 21 2008"
141 ss << "Stockfish " << Version << setfill('0');
145 date >> month >> day >> year;
146 ss << setw(2) << day << setw(2) << (1 + months.find(month) / 4) << year.substr(2);
150 ss << (to_uci ? "\nid author ": " by ")
151 << "the Stockfish developers (see AUTHORS file)";
157 /// compiler_info() returns a string trying to describe the compiler we use
159 const std::string compiler_info() {
161 #define stringify2(x) #x
162 #define stringify(x) stringify2(x)
163 #define make_version_string(major, minor, patch) stringify(major) "." stringify(minor) "." stringify(patch)
165 /// Predefined macros hell:
167 /// __GNUC__ Compiler is gcc, Clang or Intel on Linux
168 /// __INTEL_COMPILER Compiler is Intel
169 /// _MSC_VER Compiler is MSVC or Intel on Windows
170 /// _WIN32 Building on Windows (any)
171 /// _WIN64 Building on Windows 64 bit
173 std::string compiler = "\nCompiled by ";
176 compiler += "clang++ ";
177 compiler += make_version_string(__clang_major__, __clang_minor__, __clang_patchlevel__);
178 #elif __INTEL_COMPILER
179 compiler += "Intel compiler ";
180 compiler += "(version ";
181 compiler += stringify(__INTEL_COMPILER) " update " stringify(__INTEL_COMPILER_UPDATE);
185 compiler += "(version ";
186 compiler += stringify(_MSC_FULL_VER) "." stringify(_MSC_BUILD);
189 compiler += "g++ (GNUC) ";
190 compiler += make_version_string(__GNUC__, __GNUC_MINOR__, __GNUC_PATCHLEVEL__);
192 compiler += "Unknown compiler ";
193 compiler += "(unknown version)";
196 #if defined(__APPLE__)
197 compiler += " on Apple";
198 #elif defined(__CYGWIN__)
199 compiler += " on Cygwin";
200 #elif defined(__MINGW64__)
201 compiler += " on MinGW64";
202 #elif defined(__MINGW32__)
203 compiler += " on MinGW32";
204 #elif defined(__ANDROID__)
205 compiler += " on Android";
206 #elif defined(__linux__)
207 compiler += " on Linux";
208 #elif defined(_WIN64)
209 compiler += " on Microsoft Windows 64-bit";
210 #elif defined(_WIN32)
211 compiler += " on Microsoft Windows 32-bit";
213 compiler += " on unknown system";
216 compiler += "\nCompilation settings include: ";
217 compiler += (Is64Bit ? " 64bit" : " 32bit");
218 #if defined(USE_AVX512)
219 compiler += " AVX512";
221 #if defined(USE_AVX2)
224 #if defined(USE_SSE42)
225 compiler += " SSE42";
227 #if defined(USE_SSE41)
228 compiler += " SSE41";
230 #if defined(USE_SSSE3)
231 compiler += " SSSE3";
233 #if defined(USE_SSE3)
236 compiler += (HasPext ? " BMI2" : "");
237 compiler += (HasPopCnt ? " POPCNT" : "");
239 compiler += " DEBUG";
242 compiler += "\n__VERSION__ macro expands to: ";
244 compiler += __VERSION__;
246 compiler += "(undefined macro)";
254 /// Debug functions used mainly to collect run-time statistics
255 static std::atomic<int64_t> hits[2], means[2];
257 void dbg_hit_on(bool b) { ++hits[0]; if (b) ++hits[1]; }
258 void dbg_hit_on(bool c, bool b) { if (c) dbg_hit_on(b); }
259 void dbg_mean_of(int v) { ++means[0]; means[1] += v; }
264 cerr << "Total " << hits[0] << " Hits " << hits[1]
265 << " hit rate (%) " << 100 * hits[1] / hits[0] << endl;
268 cerr << "Total " << means[0] << " Mean "
269 << (double)means[1] / means[0] << endl;
273 /// Used to serialize access to std::cout to avoid multiple threads writing at
276 std::ostream& operator<<(std::ostream& os, SyncCout sc) {
290 /// Trampoline helper to avoid moving Logger to misc.h
291 void start_logger(const std::string& fname) { Logger::start(fname); }
294 /// prefetch() preloads the given address in L1/L2 cache. This is a non-blocking
295 /// function that doesn't stall the CPU waiting for data to be loaded from memory,
296 /// which can be quite slow.
299 void prefetch(void*) {}
303 void prefetch(void* addr) {
305 # if defined(__INTEL_COMPILER)
306 // This hack prevents prefetches from being optimized away by
307 // Intel compiler. Both MSVC and gcc seem not be affected by this.
311 # if defined(__INTEL_COMPILER) || defined(_MSC_VER)
312 _mm_prefetch((char*)addr, _MM_HINT_T0);
314 __builtin_prefetch(addr);
320 /// Wrappers for systems where the c++17 implementation doesn't guarantee the availability of aligned_alloc.
321 /// Memory allocated with std_aligned_alloc must be freed with std_aligned_free.
324 void* std_aligned_alloc(size_t alignment, size_t size) {
325 #if defined(__APPLE__)
326 return aligned_alloc(alignment, size);
327 #elif defined(_WIN32)
328 return _mm_malloc(size, alignment);
330 return std::aligned_alloc(alignment, size);
334 void std_aligned_free(void* ptr) {
335 #if defined(__APPLE__)
337 #elif defined(_WIN32)
344 /// aligned_ttmem_alloc() will return suitably aligned memory, and if possible use large pages.
345 /// The returned pointer is the aligned one, while the mem argument is the one that needs
346 /// to be passed to free. With c++17 some of this functionality could be simplified.
348 #if defined(__linux__) && !defined(__ANDROID__)
350 void* aligned_ttmem_alloc(size_t allocSize, void*& mem) {
352 constexpr size_t alignment = 2 * 1024 * 1024; // assumed 2MB page sizes
353 size_t size = ((allocSize + alignment - 1) / alignment) * alignment; // multiple of alignment
354 if (posix_memalign(&mem, alignment, size))
356 madvise(mem, allocSize, MADV_HUGEPAGE);
360 #elif defined(_WIN64)
362 static void* aligned_ttmem_alloc_large_pages(size_t allocSize) {
364 HANDLE hProcessToken { };
368 const size_t largePageSize = GetLargePageMinimum();
372 // We need SeLockMemoryPrivilege, so try to enable it for the process
373 if (!OpenProcessToken(GetCurrentProcess(), TOKEN_ADJUST_PRIVILEGES | TOKEN_QUERY, &hProcessToken))
376 if (LookupPrivilegeValue(NULL, SE_LOCK_MEMORY_NAME, &luid))
378 TOKEN_PRIVILEGES tp { };
379 TOKEN_PRIVILEGES prevTp { };
382 tp.PrivilegeCount = 1;
383 tp.Privileges[0].Luid = luid;
384 tp.Privileges[0].Attributes = SE_PRIVILEGE_ENABLED;
386 // Try to enable SeLockMemoryPrivilege. Note that even if AdjustTokenPrivileges() succeeds,
387 // we still need to query GetLastError() to ensure that the privileges were actually obtained.
388 if (AdjustTokenPrivileges(
389 hProcessToken, FALSE, &tp, sizeof(TOKEN_PRIVILEGES), &prevTp, &prevTpLen) &&
390 GetLastError() == ERROR_SUCCESS)
392 // Round up size to full pages and allocate
393 allocSize = (allocSize + largePageSize - 1) & ~size_t(largePageSize - 1);
395 NULL, allocSize, MEM_RESERVE | MEM_COMMIT | MEM_LARGE_PAGES, PAGE_READWRITE);
397 // Privilege no longer needed, restore previous state
398 AdjustTokenPrivileges(hProcessToken, FALSE, &prevTp, 0, NULL, NULL);
402 CloseHandle(hProcessToken);
407 void* aligned_ttmem_alloc(size_t allocSize, void*& mem) {
409 static bool firstCall = true;
411 // Try to allocate large pages
412 mem = aligned_ttmem_alloc_large_pages(allocSize);
414 // Suppress info strings on the first call. The first call occurs before 'uci'
415 // is received and in that case this output confuses some GUIs.
419 sync_cout << "info string Hash table allocation: Windows large pages used." << sync_endl;
421 sync_cout << "info string Hash table allocation: Windows large pages not used." << sync_endl;
425 // Fall back to regular, page aligned, allocation if necessary
427 mem = VirtualAlloc(NULL, allocSize, MEM_RESERVE | MEM_COMMIT, PAGE_READWRITE);
434 void* aligned_ttmem_alloc(size_t allocSize, void*& mem) {
436 constexpr size_t alignment = 64; // assumed cache line size
437 size_t size = allocSize + alignment - 1; // allocate some extra space
439 void* ret = reinterpret_cast<void*>((uintptr_t(mem) + alignment - 1) & ~uintptr_t(alignment - 1));
446 /// aligned_ttmem_free() will free the previously allocated ttmem
450 void aligned_ttmem_free(void* mem) {
452 if (mem && !VirtualFree(mem, 0, MEM_RELEASE))
454 DWORD err = GetLastError();
455 std::cerr << "Failed to free transposition table. Error code: 0x" <<
456 std::hex << err << std::dec << std::endl;
463 void aligned_ttmem_free(void *mem) {
470 namespace WinProcGroup {
474 void bindThisThread(size_t) {}
478 /// best_group() retrieves logical processor information using Windows specific
479 /// API and returns the best group id for the thread with index idx. Original
480 /// code from Texel by Peter Ă–sterlund.
482 int best_group(size_t idx) {
487 DWORD returnLength = 0;
488 DWORD byteOffset = 0;
490 // Early exit if the needed API is not available at runtime
491 HMODULE k32 = GetModuleHandle("Kernel32.dll");
492 auto fun1 = (fun1_t)(void(*)())GetProcAddress(k32, "GetLogicalProcessorInformationEx");
496 // First call to get returnLength. We expect it to fail due to null buffer
497 if (fun1(RelationAll, nullptr, &returnLength))
500 // Once we know returnLength, allocate the buffer
501 SYSTEM_LOGICAL_PROCESSOR_INFORMATION_EX *buffer, *ptr;
502 ptr = buffer = (SYSTEM_LOGICAL_PROCESSOR_INFORMATION_EX*)malloc(returnLength);
504 // Second call, now we expect to succeed
505 if (!fun1(RelationAll, buffer, &returnLength))
511 while (byteOffset < returnLength)
513 if (ptr->Relationship == RelationNumaNode)
516 else if (ptr->Relationship == RelationProcessorCore)
519 threads += (ptr->Processor.Flags == LTP_PC_SMT) ? 2 : 1;
523 byteOffset += ptr->Size;
524 ptr = (SYSTEM_LOGICAL_PROCESSOR_INFORMATION_EX*)(((char*)ptr) + ptr->Size);
529 std::vector<int> groups;
531 // Run as many threads as possible on the same node until core limit is
532 // reached, then move on filling the next node.
533 for (int n = 0; n < nodes; n++)
534 for (int i = 0; i < cores / nodes; i++)
537 // In case a core has more than one logical processor (we assume 2) and we
538 // have still threads to allocate, then spread them evenly across available
540 for (int t = 0; t < threads - cores; t++)
541 groups.push_back(t % nodes);
543 // If we still have more threads than the total number of logical processors
544 // then return -1 and let the OS to decide what to do.
545 return idx < groups.size() ? groups[idx] : -1;
549 /// bindThisThread() set the group affinity of the current thread
551 void bindThisThread(size_t idx) {
553 // Use only local variables to be thread-safe
554 int group = best_group(idx);
559 // Early exit if the needed API are not available at runtime
560 HMODULE k32 = GetModuleHandle("Kernel32.dll");
561 auto fun2 = (fun2_t)(void(*)())GetProcAddress(k32, "GetNumaNodeProcessorMaskEx");
562 auto fun3 = (fun3_t)(void(*)())GetProcAddress(k32, "SetThreadGroupAffinity");
567 GROUP_AFFINITY affinity;
568 if (fun2(group, &affinity))
569 fun3(GetCurrentThread(), &affinity, nullptr);
574 } // namespace WinProcGroup