Temporary patch to show the compiler for TCEC submission
[stockfish] / src / misc.cpp
1 /*
2   Stockfish, a UCI chess playing engine derived from Glaurung 2.1
3   Copyright (C) 2004-2008 Tord Romstad (Glaurung author)
4   Copyright (C) 2008-2015 Marco Costalba, Joona Kiiski, Tord Romstad
5   Copyright (C) 2015-2019 Marco Costalba, Joona Kiiski, Gary Linscott, Tord Romstad
6
7   Stockfish is free software: you can redistribute it and/or modify
8   it under the terms of the GNU General Public License as published by
9   the Free Software Foundation, either version 3 of the License, or
10   (at your option) any later version.
11
12   Stockfish is distributed in the hope that it will be useful,
13   but WITHOUT ANY WARRANTY; without even the implied warranty of
14   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15   GNU General Public License for more details.
16
17   You should have received a copy of the GNU General Public License
18   along with this program.  If not, see <http://www.gnu.org/licenses/>.
19 */
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 typedef bool(*fun1_t)(LOGICAL_PROCESSOR_RELATIONSHIP,
38                       PSYSTEM_LOGICAL_PROCESSOR_INFORMATION_EX, PDWORD);
39 typedef bool(*fun2_t)(USHORT, PGROUP_AFFINITY);
40 typedef bool(*fun3_t)(HANDLE, CONST GROUP_AFFINITY*, PGROUP_AFFINITY);
41 }
42 #endif
43
44 #include <fstream>
45 #include <iomanip>
46 #include <iostream>
47 #include <sstream>
48 #include <vector>
49
50 #include "misc.h"
51 #include "thread.h"
52
53 using namespace std;
54
55 namespace {
56
57 /// Version number. If Version is left empty, then compile date in the format
58 /// DD-MM-YY and show in engine_info.
59 const string Version = "";
60
61 /// Our fancy logging facility. The trick here is to replace cin.rdbuf() and
62 /// cout.rdbuf() with two Tie objects that tie cin and cout to a file stream. We
63 /// can toggle the logging of std::cout and std:cin at runtime whilst preserving
64 /// usual I/O functionality, all without changing a single line of code!
65 /// Idea from http://groups.google.com/group/comp.lang.c++/msg/1d941c0f26ea0d81
66
67 struct Tie: public streambuf { // MSVC requires split streambuf for cin and cout
68
69   Tie(streambuf* b, streambuf* l) : buf(b), logBuf(l) {}
70
71   int sync() override { return logBuf->pubsync(), buf->pubsync(); }
72   int overflow(int c) override { return log(buf->sputc((char)c), "<< "); }
73   int underflow() override { return buf->sgetc(); }
74   int uflow() override { return log(buf->sbumpc(), ">> "); }
75
76   streambuf *buf, *logBuf;
77
78   int log(int c, const char* prefix) {
79
80     static int last = '\n'; // Single log file
81
82     if (last == '\n')
83         logBuf->sputn(prefix, 3);
84
85     return last = logBuf->sputc((char)c);
86   }
87 };
88
89 class Logger {
90
91   Logger() : in(cin.rdbuf(), file.rdbuf()), out(cout.rdbuf(), file.rdbuf()) {}
92  ~Logger() { start(""); }
93
94   ofstream file;
95   Tie in, out;
96
97 public:
98   static void start(const std::string& fname) {
99
100     static Logger l;
101
102     if (!fname.empty() && !l.file.is_open())
103     {
104         l.file.open(fname, ifstream::out);
105         cin.rdbuf(&l.in);
106         cout.rdbuf(&l.out);
107     }
108     else if (fname.empty() && l.file.is_open())
109     {
110         cout.rdbuf(l.out.buf);
111         cin.rdbuf(l.in.buf);
112         l.file.close();
113     }
114   }
115 };
116
117 } // namespace
118
119 /// engine_info() returns the full name of the current Stockfish version. This
120 /// will be either "Stockfish <Tag> DD-MM-YY" (where DD-MM-YY is the date when
121 /// the program was compiled) or "Stockfish <Version>", depending on whether
122 /// Version is empty.
123
124 const string engine_info(bool to_uci) {
125
126   const string months("Jan Feb Mar Apr May Jun Jul Aug Sep Oct Nov Dec");
127   string month, day, year;
128   stringstream ss, date(__DATE__); // From compiler, format is "Sep 21 2008"
129
130   ss << "Stockfish " << Version << setfill('0');
131
132   if (Version.empty())
133   {
134       date >> month >> day >> year;
135       ss << setw(2) << day << setw(2) << (1 + months.find(month) / 4) << year.substr(2);
136   }
137
138   ss << (Is64Bit ? " 64" : "")
139      << (HasPext ? " BMI2" : (HasPopCnt ? " POPCNT" : ""))
140      << (to_uci  ? "\nid author ": " by ")
141      << "T. Romstad, M. Costalba, J. Kiiski, G. Linscott";
142
143   return ss.str();
144 }
145
146
147 /// compiler_info() returns a string trying to describe the compiler we use
148
149 const std::string compiler_info() {
150
151   #define STRINGIFY2(x) #x
152   #define STRINGIFY(x) STRINGIFY2(x)
153   #define VER_STRING(major, minor, patch) STRINGIFY(major) "." STRINGIFY(minor) "." STRINGIFY(patch)
154
155 /// Predefined macros hell:
156 ///
157 /// __GNUC__           Compiler is gcc, Clang or Intel on Linux
158 /// __INTEL_COMPILER   Compiler is Intel
159 /// _MSC_VER           Compiler is MSVC or Intel on Windows
160 /// _WIN32             Building on Windows (any)
161 /// _WIN64             Building on Windows 64 bit
162
163   std::string compiler = "\nCompiled by ";
164
165   #ifdef __clang__
166      compiler += "clang++ ";
167      compiler += VER_STRING(__clang_major__, __clang_minor__, __clang_patchlevel__);
168   #elif __INTEL_COMPILER
169      compiler += "Intel compiler ";
170      compiler += "(version ";
171      compiler += STRINGIFY(__INTEL_COMPILER) " update " STRINGIFY(__INTEL_COMPILER_UPDATE);
172      compiler += ")";
173   #elif _MSC_VER
174      compiler += "MSVC ";
175      compiler += "(version ";
176      compiler += STRINGIFY(_MSC_FULL_VER) "." STRINGIFY(_MSC_BUILD);
177      compiler += ")";
178   #elif __GNUC__
179      compiler += "g++ (GNUC) ";
180      compiler += VER_STRING(__GNUC__, __GNUC_MINOR__, __GNUC_PATCHLEVEL__);
181   #else
182      compiler += "Unknown compiler ";
183      compiler += "(unknown version)";
184   #endif
185
186   #if defined(__APPLE__) 
187      compiler += " on Apple";
188   #elif defined(__CYGWIN__)
189      compiler += " on Cygwin";
190   #elif defined(__MINGW64__)
191      compiler += " on MinGW64";
192   #elif defined(__MINGW32__)
193      compiler += " on MinGW32";
194   #elif defined(__ANDROID__)
195      compiler += " on Android";
196   #elif defined(__linux__)
197      compiler += " on Linux";
198   #elif defined(_WIN64)
199      compiler += " on Microsoft Windows 64-bit";
200   #elif defined(_WIN32)
201      compiler += " on Microsoft Windows 32-bit";
202   #else
203      compiler += " on unknown system";
204   #endif
205
206   compiler += "\n __VERSION__ macro expands to: ";
207   #ifdef __VERSION__
208      compiler += __VERSION__;
209   #else
210      compiler += "(undefined macro)";
211   #endif
212   compiler += "\n";
213
214   return compiler;
215 }
216
217
218 /// Debug functions used mainly to collect run-time statistics
219 static std::atomic<int64_t> hits[2], means[2];
220
221 void dbg_hit_on(bool b) { ++hits[0]; if (b) ++hits[1]; }
222 void dbg_hit_on(bool c, bool b) { if (c) dbg_hit_on(b); }
223 void dbg_mean_of(int v) { ++means[0]; means[1] += v; }
224
225 void dbg_print() {
226
227   if (hits[0])
228       cerr << "Total " << hits[0] << " Hits " << hits[1]
229            << " hit rate (%) " << 100 * hits[1] / hits[0] << endl;
230
231   if (means[0])
232       cerr << "Total " << means[0] << " Mean "
233            << (double)means[1] / means[0] << endl;
234 }
235
236
237 /// Used to serialize access to std::cout to avoid multiple threads writing at
238 /// the same time.
239
240 std::ostream& operator<<(std::ostream& os, SyncCout sc) {
241
242   static Mutex m;
243
244   if (sc == IO_LOCK)
245       m.lock();
246
247   if (sc == IO_UNLOCK)
248       m.unlock();
249
250   return os;
251 }
252
253
254 /// Trampoline helper to avoid moving Logger to misc.h
255 void start_logger(const std::string& fname) { Logger::start(fname); }
256
257
258 /// prefetch() preloads the given address in L1/L2 cache. This is a non-blocking
259 /// function that doesn't stall the CPU waiting for data to be loaded from memory,
260 /// which can be quite slow.
261 #ifdef NO_PREFETCH
262
263 void prefetch(void*) {}
264
265 #else
266
267 void prefetch(void* addr) {
268
269 #  if defined(__INTEL_COMPILER)
270    // This hack prevents prefetches from being optimized away by
271    // Intel compiler. Both MSVC and gcc seem not be affected by this.
272    __asm__ ("");
273 #  endif
274
275 #  if defined(__INTEL_COMPILER) || defined(_MSC_VER)
276   _mm_prefetch((char*)addr, _MM_HINT_T0);
277 #  else
278   __builtin_prefetch(addr);
279 #  endif
280 }
281
282 #endif
283
284 namespace WinProcGroup {
285
286 #ifndef _WIN32
287
288 void bindThisThread(size_t) {}
289
290 #else
291
292 /// best_group() retrieves logical processor information using Windows specific
293 /// API and returns the best group id for the thread with index idx. Original
294 /// code from Texel by Peter Ă–sterlund.
295
296 int best_group(size_t idx) {
297
298   int threads = 0;
299   int nodes = 0;
300   int cores = 0;
301   DWORD returnLength = 0;
302   DWORD byteOffset = 0;
303
304   // Early exit if the needed API is not available at runtime
305   HMODULE k32 = GetModuleHandle("Kernel32.dll");
306   auto fun1 = (fun1_t)(void(*)())GetProcAddress(k32, "GetLogicalProcessorInformationEx");
307   if (!fun1)
308       return -1;
309
310   // First call to get returnLength. We expect it to fail due to null buffer
311   if (fun1(RelationAll, nullptr, &returnLength))
312       return -1;
313
314   // Once we know returnLength, allocate the buffer
315   SYSTEM_LOGICAL_PROCESSOR_INFORMATION_EX *buffer, *ptr;
316   ptr = buffer = (SYSTEM_LOGICAL_PROCESSOR_INFORMATION_EX*)malloc(returnLength);
317
318   // Second call, now we expect to succeed
319   if (!fun1(RelationAll, buffer, &returnLength))
320   {
321       free(buffer);
322       return -1;
323   }
324
325   while (byteOffset < returnLength)
326   {
327       if (ptr->Relationship == RelationNumaNode)
328           nodes++;
329
330       else if (ptr->Relationship == RelationProcessorCore)
331       {
332           cores++;
333           threads += (ptr->Processor.Flags == LTP_PC_SMT) ? 2 : 1;
334       }
335
336       assert(ptr->Size);
337       byteOffset += ptr->Size;
338       ptr = (SYSTEM_LOGICAL_PROCESSOR_INFORMATION_EX*)(((char*)ptr) + ptr->Size);
339   }
340
341   free(buffer);
342
343   std::vector<int> groups;
344
345   // Run as many threads as possible on the same node until core limit is
346   // reached, then move on filling the next node.
347   for (int n = 0; n < nodes; n++)
348       for (int i = 0; i < cores / nodes; i++)
349           groups.push_back(n);
350
351   // In case a core has more than one logical processor (we assume 2) and we
352   // have still threads to allocate, then spread them evenly across available
353   // nodes.
354   for (int t = 0; t < threads - cores; t++)
355       groups.push_back(t % nodes);
356
357   // If we still have more threads than the total number of logical processors
358   // then return -1 and let the OS to decide what to do.
359   return idx < groups.size() ? groups[idx] : -1;
360 }
361
362
363 /// bindThisThread() set the group affinity of the current thread
364
365 void bindThisThread(size_t idx) {
366
367   // Use only local variables to be thread-safe
368   int group = best_group(idx);
369
370   if (group == -1)
371       return;
372
373   // Early exit if the needed API are not available at runtime
374   HMODULE k32 = GetModuleHandle("Kernel32.dll");
375   auto fun2 = (fun2_t)(void(*)())GetProcAddress(k32, "GetNumaNodeProcessorMaskEx");
376   auto fun3 = (fun3_t)(void(*)())GetProcAddress(k32, "SetThreadGroupAffinity");
377
378   if (!fun2 || !fun3)
379       return;
380
381   GROUP_AFFINITY affinity;
382   if (fun2(group, &affinity))
383       fun3(GetCurrentThread(), &affinity, nullptr);
384 }
385
386 #endif
387
388 } // namespace WinProcGroup